Statistics
| Branch: | Tag: | Revision:

amiro-os / modules / STM32F4Discovery / aosconf.h @ 07ff44a7

History | View | Annotate | Download (6.64 KB)

1
/*
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
/**
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
#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
/*===========================================================================*/
48
/**
49
 * @name Kernel parameters and options
50
 * @{
51
 */
52
/*===========================================================================*/
53

    
54
/**
55
 * @brief   Flag to enable/disable debug API and logic.
56
 */
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
 * @brief   Flag to enable/disable profiling API and logic.
74
 */
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
/**
95
 * @name SSSP (Startup Shutdown Synchronization Protocol) configuration.
96
 * @{
97
 */
98
/*===========================================================================*/
99

    
100
/**
101
 * @brief   Flag to enable SSSP.
102
 */
103
#if !defined(OS_CFG_SSSP_ENABLE)
104
  #define AMIROOS_CFG_SSSP_ENABLE               false
105
#else
106
  #define AMIROOS_CFG_SSSP_ENABLE               OS_CFG_SSSP_ENABLE
107
#endif
108

    
109
/**
110
 * @brief   Flag to set the module as SSSP master.
111
 * @details There must be only one module with this flag set to true in a system.
112
 */
113
#if !defined(OS_CFG_SSSP_MASTER)
114
  #define AMIROOS_CFG_SSSP_MASTER               false
115
#else
116
  #define AMIROOS_CFG_SSSP_MASTER               OS_CFG_SSSP_MASTER
117
#endif
118

    
119
/**
120
 * @brief   Flag to set the module to be the first in the stack.
121
 * @details There must be only one module with this flag set to true in a system.
122
 */
123
#if !defined(OS_CFG_SSSP_STACK_START)
124
  #define AMIROOS_CFG_SSSP_STACK_START          false
125
#else
126
  #define AMIROOS_CFG_SSSP_STACK_START          OS_CFG_SSSP_STACK_START
127
#endif
128

    
129
/**
130
 * @brief   Flag to set the module to be the last in the stack.
131
 * @details There must be only one module with this flag set to true in a system.
132
 */
133
#if !defined(OS_CFG_SSSP_STACK_END)
134
  #define AMIROOS_CFG_SSSP_STACK_END            false
135
#else
136
  #define AMIROOS_CFG_SSSP_STACK_END            OS_CFG_SSSP_STACK_END
137
#endif
138

    
139
/**
140
 * @brief   Delay time (in microseconds) how long a SSSP signal must be active.
141
 */
142
#if !defined(OS_CFG_SSSP_SIGNALDELAY)
143
  #define AMIROOS_CFG_SSSP_SIGNALDELAY          1000
144
#else
145
  #define AMIROOS_CFG_SSSP_SIGNALDELAY          OS_CFG_SSSP_SIGNALDELAY
146
#endif
147

    
148
/**
149
 * @brief   Time boundary for robot wide clock synchronization in microseconds.
150
 * @details Whenever the SSSP S (snychronization) signal gets logically deactivated,
151
 *          All modules need to align their local uptime to the nearest multiple of this value.
152
 */
153
#if !defined(OS_CFG_SSSP_SYSSYNCPERIOD)
154
  #define AMIROOS_CFG_SSSP_SYSSYNCPERIOD        1000000
155
#else
156
  #define AMIROOS_CFG_SSSP_SYSSYNCPERIOD        OS_CFG_SSSP_SYSSYNCPERIOD
157
#endif
158

    
159
/** @} */
160

    
161
/*===========================================================================*/
162
/**
163
 * @name System shell options
164
 * @{
165
 */
166
/*===========================================================================*/
167

    
168
/**
169
 * @brief   Shell enable flag.
170
 */
171
#if !defined(OS_CFG_SHELL_ENABLE) && (AMIROOS_CFG_TESTS_ENABLE != true)
172
  #define AMIROOS_CFG_SHELL_ENABLE              true
173
#elif (AMIROOS_CFG_TESTS_ENABLE == true)
174
  #define AMIROOS_CFG_SHELL_ENABLE              true
175
#else
176
  #define AMIROOS_CFG_SHELL_ENABLE              OS_CFG_SHELL_ENABLE
177
#endif
178

    
179
/**
180
 * @brief   Shell thread stack size.
181
 */
182
#if !defined(OS_CFG_SHELL_STACKSIZE)
183
  #define AMIROOS_CFG_SHELL_STACKSIZE           1024
184
#else
185
  #define AMIROOS_CFG_SHELL_STACKSIZE           OS_CFG_SHELL_STACKSIZE
186
#endif
187

    
188
/**
189
 * @brief   Shell thread priority.
190
 * @details Thread priorities are specified as an integer value.
191
 *          Predefined ranges are:
192
 *            lowest  ┌ THD_LOWPRIO_MIN
193
 *                    │ ...
194
 *                    └ THD_LOWPRIO_MAX
195
 *                    ┌ THD_NORMALPRIO_MIN
196
 *                    │ ...
197
 *                    └ THD_NORMALPRIO_MAX
198
 *                    ┌ THD_HIGHPRIO_MIN
199
 *                    │ ...
200
 *                    └ THD_HIGHPRIO_MAX
201
 *                    ┌ THD_RTPRIO_MIN
202
 *                    │ ...
203
 *            highest └ THD_RTPRIO_MAX
204
 */
205
#if !defined(OS_CFG_SHELL_THREADPRIO)
206
  #define AMIROOS_CFG_SHELL_THREADPRIO          AOS_THD_NORMALPRIO_MIN
207
#else
208
  #define AMIROOS_CFG_SHELL_THREADPRIO          OS_CFG_SHELL_THREADPRIO
209
#endif
210

    
211
/**
212
 * @brief   Shell maximum input line length.
213
 */
214
#if !defined(OS_CFG_SHELL_LINEWIDTH)
215
  #define AMIROOS_CFG_SHELL_LINEWIDTH           64
216
#else
217
  #define AMIROOS_CFG_SHELL_LINEWIDTH           OS_CFG_SHELL_LINEWIDTH
218
#endif
219

    
220
/**
221
 * @brief   Shell maximum number of arguments.
222
 */
223
#if !defined(OS_CFG_SHELL_MAXARGS)
224
  #define AMIROOS_CFG_SHELL_MAXARGS             4
225
#else
226
  #define AMIROOS_CFG_SHELL_MAXARGS             OS_CFG_SHELL_MAXARGS
227
#endif
228

    
229
/** @} */
230

    
231
#endif /* _AOSCONF_H_ */
232

    
233
/** @} */