amiro-os / modules / PowerManagement_1-1 / aosconf.h @ 4df853e0
History | View | Annotate | Download (6.44 KB)
1 | e545e620 | Thomas Schöpping | /*
|
---|---|---|---|
2 | AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform.
|
||
3 | Copyright (C) 2016..2018 Thomas Schöpping et al.
|
||
4 | |||
5 | This program is free software: you can redistribute it and/or modify
|
||
6 | it under the terms of the GNU General Public License as published by
|
||
7 | the Free Software Foundation, either version 3 of the License, or
|
||
8 | (at your option) any later version.
|
||
9 | |||
10 | This program is distributed in the hope that it will be useful,
|
||
11 | but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
13 | GNU General Public License for more details.
|
||
14 | |||
15 | You should have received a copy of the GNU General Public License
|
||
16 | along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
17 | */
|
||
18 | |||
19 | 53710ca3 | Marc Rothmann | /**
|
20 | * @file
|
||
21 | * @brief AMiRo-OS Configuration file for the PowerManagement v1.1 module.
|
||
22 | * @details Contains the application specific AMiRo-OS settings.
|
||
23 | *
|
||
24 | * @addtogroup powermanagement_aos_config
|
||
25 | * @{
|
||
26 | */
|
||
27 | |||
28 | e545e620 | Thomas Schöpping | #ifndef _AOSCONF_H_
|
29 | #define _AOSCONF_H_
|
||
30 | |||
31 | /*
|
||
32 | * compatibility guards
|
||
33 | */
|
||
34 | #define _AMIRO_OS_CFG_
|
||
35 | #define _AMIRO_OS_CFG_VERSION_MAJOR_ 2 |
||
36 | #define _AMIRO_OS_CFG_VERSION_MINOR_ 0 |
||
37 | |||
38 | #include <stdbool.h> |
||
39 | |||
40 | /*
|
||
41 | * Include an external configuration file to override the following default settings only if required.
|
||
42 | */
|
||
43 | #if defined(AMIRO_APPS) && (AMIRO_APPS == true) |
||
44 | #include <osconf.h> |
||
45 | #endif
|
||
46 | |||
47 | 6b53f6bf | Thomas Schöpping | /*===========================================================================*/
|
48 | e545e620 | Thomas Schöpping | /**
|
49 | 6b53f6bf | Thomas Schöpping | * @name Kernel parameters and options
|
50 | * @{
|
||
51 | e545e620 | Thomas Schöpping | */
|
52 | 6b53f6bf | Thomas Schöpping | /*===========================================================================*/
|
53 | e545e620 | Thomas Schöpping | |
54 | /**
|
||
55 | 3e1a9c79 | Thomas Schöpping | * @brief Flag to enable/disable debug API and logic.
|
56 | e545e620 | Thomas Schöpping | */
|
57 | #if !defined(OS_CFG_DBG)
|
||
58 | #define AMIROOS_CFG_DBG true |
||
59 | #else
|
||
60 | #define AMIROOS_CFG_DBG OS_CFG_DBG
|
||
61 | #endif
|
||
62 | |||
63 | /**
|
||
64 | * @brief Flag to enable/disable unit tests.
|
||
65 | */
|
||
66 | #if !defined(OS_CFG_TESTS_ENABLE)
|
||
67 | #define AMIROOS_CFG_TESTS_ENABLE true |
||
68 | #else
|
||
69 | #define AMIROOS_CFG_TESTS_ENABLE OS_CFG_TESTS_ENABLE
|
||
70 | #endif
|
||
71 | |||
72 | /**
|
||
73 | 3e1a9c79 | Thomas Schöpping | * @brief Flag to enable/disable profiling API and logic.
|
74 | e545e620 | Thomas Schöpping | */
|
75 | #if !defined(OS_CFG_PROFILE)
|
||
76 | #define AMIROOS_CFG_PROFILE true |
||
77 | #else
|
||
78 | #define AMIROOS_CFG_PROFILE OS_CFG_PROFILE
|
||
79 | #endif
|
||
80 | |||
81 | /**
|
||
82 | * @brief Timeout value when waiting for events in the main loop in microseconds.
|
||
83 | * @details A value of 0 deactivates the timeout.
|
||
84 | */
|
||
85 | #if !defined(OS_CFG_MAIN_LOOP_TIMEOUT)
|
||
86 | #define AMIROOS_CFG_MAIN_LOOP_TIMEOUT 0 |
||
87 | #else
|
||
88 | #define AMIROOS_CFG_MAIN_LOOP_TIMEOUT OS_CFG_MAIN_LOOP_TIMEOUT
|
||
89 | #endif
|
||
90 | |||
91 | /** @} */
|
||
92 | |||
93 | /*===========================================================================*/
|
||
94 | 6b53f6bf | Thomas Schöpping | /**
|
95 | * @name SSSP (Startup Shutdown Synchronization Protocol) configuration.
|
||
96 | * @{
|
||
97 | */
|
||
98 | /*===========================================================================*/
|
||
99 | |||
100 | /**
|
||
101 | * @brief Flag to set the module as SSSP master.
|
||
102 | * @details There must be only one module with this flag set to true in a system.
|
||
103 | */
|
||
104 | #if !defined(OS_CFG_SSSP_MASTER)
|
||
105 | #define AMIROOS_CFG_SSSP_MASTER true |
||
106 | #else
|
||
107 | #define AMIROOS_CFG_SSSP_MASTER OS_CFG_SSSP_MASTER
|
||
108 | #endif
|
||
109 | |||
110 | /**
|
||
111 | 933df08e | Thomas Schöpping | * @brief Flag to set the module to be the first in the stack.
|
112 | * @details There must be only one module with this flag set to true in a system.
|
||
113 | */
|
||
114 | #if !defined(OS_CFG_SSSP_STACK_START)
|
||
115 | #define AMIROOS_CFG_SSSP_STACK_START false |
||
116 | #else
|
||
117 | #define AMIROOS_CFG_SSSP_STACK_START OS_CFG_SSSP_STACK_START
|
||
118 | #endif
|
||
119 | |||
120 | /**
|
||
121 | * @brief Flag to set the module to be the last in the stack.
|
||
122 | * @details There must be only one module with this flag set to true in a system.
|
||
123 | */
|
||
124 | #if !defined(OS_CFG_SSSP_STACK_END)
|
||
125 | #define AMIROOS_CFG_SSSP_STACK_END false |
||
126 | #else
|
||
127 | #define AMIROOS_CFG_SSSP_STACK_END OS_CFG_SSSP_STACK_END
|
||
128 | #endif
|
||
129 | |||
130 | /**
|
||
131 | * @brief Delay time (in microseconds) how long a SSSP signal must be active.
|
||
132 | */
|
||
133 | #if !defined(OS_CFG_SSSP_SIGNALDELAY)
|
||
134 | #define AMIROOS_CFG_SSSP_SIGNALDELAY 1000 |
||
135 | #else
|
||
136 | #define AMIROOS_CFG_SSSP_SIGNALDELAY OS_CFG_SSSP_SIGNALDELAY
|
||
137 | #endif
|
||
138 | |||
139 | /**
|
||
140 | 6b53f6bf | Thomas Schöpping | * @brief Time boundary for robot wide clock synchronization in microseconds.
|
141 | * @details Whenever the SSSP S (snychronization) signal gets logically deactivated,
|
||
142 | * All modules need to align their local uptime to the nearest multiple of this value.
|
||
143 | */
|
||
144 | #if !defined(OS_CFG_SSSP_SYSSYNCPERIOD)
|
||
145 | #define AMIROOS_CFG_SSSP_SYSSYNCPERIOD 1000000 |
||
146 | #else
|
||
147 | #define AMIROOS_CFG_SSSP_SYSSYNCPERIOD OS_CFG_SSSP_SYSSYNCPERIOD
|
||
148 | #endif
|
||
149 | |||
150 | /** @} */
|
||
151 | |||
152 | /*===========================================================================*/
|
||
153 | e545e620 | Thomas Schöpping | /**
|
154 | * @name System shell options
|
||
155 | * @{
|
||
156 | */
|
||
157 | /*===========================================================================*/
|
||
158 | |||
159 | /**
|
||
160 | * @brief Shell enable flag.
|
||
161 | */
|
||
162 | 3e1a9c79 | Thomas Schöpping | #if !defined(OS_CFG_SHELL_ENABLE) && (AMIROOS_CFG_TESTS_ENABLE != true) |
163 | e545e620 | Thomas Schöpping | #define AMIROOS_CFG_SHELL_ENABLE true |
164 | #elif (AMIROOS_CFG_TESTS_ENABLE == true) |
||
165 | #define AMIROOS_CFG_SHELL_ENABLE true |
||
166 | #else
|
||
167 | #define AMIROOS_CFG_SHELL_ENABLE OS_CFG_SHELL_ENABLE
|
||
168 | #endif
|
||
169 | |||
170 | /**
|
||
171 | * @brief Shell thread stack size.
|
||
172 | */
|
||
173 | #if !defined(OS_CFG_SHELL_STACKSIZE)
|
||
174 | #define AMIROOS_CFG_SHELL_STACKSIZE 1024 |
||
175 | #else
|
||
176 | #define AMIROOS_CFG_SHELL_STACKSIZE OS_CFG_SHELL_STACKSIZE
|
||
177 | #endif
|
||
178 | |||
179 | /**
|
||
180 | 20205a98 | Thomas Schöpping | * @brief Shell thread priority.
|
181 | 512abac1 | Thomas Schöpping | * @details Thread priorities are specified as an integer value.
|
182 | * Predefined ranges are:
|
||
183 | * lowest ┌ THD_LOWPRIO_MIN
|
||
184 | * │ ...
|
||
185 | * └ THD_LOWPRIO_MAX
|
||
186 | * ┌ THD_NORMALPRIO_MIN
|
||
187 | * │ ...
|
||
188 | * └ THD_NORMALPRIO_MAX
|
||
189 | * ┌ THD_HIGHPRIO_MIN
|
||
190 | * │ ...
|
||
191 | * └ THD_HIGHPRIO_MAX
|
||
192 | * ┌ THD_RTPRIO_MIN
|
||
193 | * │ ...
|
||
194 | * highest └ THD_RTPRIO_MAX
|
||
195 | 20205a98 | Thomas Schöpping | */
|
196 | #if !defined(OS_CFG_SHELL_THREADPRIO)
|
||
197 | 512abac1 | Thomas Schöpping | #define AMIROOS_CFG_SHELL_THREADPRIO AOS_THD_NORMALPRIO_MIN
|
198 | 20205a98 | Thomas Schöpping | #else
|
199 | #define AMIROOS_CFG_SHELL_THREADPRIO OS_CFG_SHELL_THREADPRIO
|
||
200 | #endif
|
||
201 | |||
202 | /**
|
||
203 | e545e620 | Thomas Schöpping | * @brief Shell maximum input line length.
|
204 | */
|
||
205 | #if !defined(OS_CFG_SHELL_LINEWIDTH)
|
||
206 | #define AMIROOS_CFG_SHELL_LINEWIDTH 64 |
||
207 | #else
|
||
208 | #define AMIROOS_CFG_SHELL_LINEWIDTH OS_CFG_SHELL_LINEWIDTH
|
||
209 | #endif
|
||
210 | |||
211 | /**
|
||
212 | * @brief Shell maximum number of arguments.
|
||
213 | */
|
||
214 | #if !defined(OS_CFG_SHELL_MAXARGS)
|
||
215 | #define AMIROOS_CFG_SHELL_MAXARGS 4 |
||
216 | #else
|
||
217 | #define AMIROOS_CFG_SHELL_MAXARGS OS_CFG_SHELL_MAXARGS
|
||
218 | #endif
|
||
219 | |||
220 | /** @} */
|
||
221 | |||
222 | cb835a3e | Thomas Schöpping | #endif /* _AOSCONF_H_ */ |
223 | e545e620 | Thomas Schöpping | |
224 | 53710ca3 | Marc Rothmann | /** @} */ |