Statistics
| Branch: | Tag: | Revision:

amiro-os / core / inc / aos_confcheck.h @ a7e54ea4

History | View | Annotate | Download (8.269 KB)

1 e545e620 Thomas Schöpping
/*
2
AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform.
3 96621a83 Thomas Schöpping
Copyright (C) 2016..2020  Thomas Schöpping et al.
4 e545e620 Thomas Schöpping

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    aos_confcheck.h
21
 * @brief   Header that checks whether all necessary configurations are correct.
22
 *
23
 * @addtogroup aos_system
24
 * @{
25
 */
26
27 6ff06bbf Thomas Schöpping
#ifndef AMIROOS_CONFCHECK_H
28
#define AMIROOS_CONFCHECK_H
29 e545e620 Thomas Schöpping
30 3940ba8a Thomas Schöpping
#include <amiroos.h>
31 e545e620 Thomas Schöpping
32 f3ac1c96 Thomas Schöpping
/******************************************************************************/
33
/* CONSTANTS                                                                  */
34
/******************************************************************************/
35
36
/******************************************************************************/
37
/* SETTINGS                                                                   */
38
/******************************************************************************/
39
40
/******************************************************************************/
41
/* CHECKS                                                                     */
42
/******************************************************************************/
43
44
/* kernel parameters and options */
45 e545e620 Thomas Schöpping
46 7de0cc90 Thomas Schöpping
#if !defined(AMIROOS_CFG_DBG)
47 cb835a3e Thomas Schöpping
  #error "AMIROOS_CFG_DBG not defined in aosconf.h"
48 7de0cc90 Thomas Schöpping
#endif /* !defined(AMIROOS_CFG_DBG) */
49 cb835a3e Thomas Schöpping
50 7de0cc90 Thomas Schöpping
#if !defined(AMIROOS_CFG_TESTS_ENABLE)
51 e545e620 Thomas Schöpping
  #error "AMIROOS_CFG_TESTS_ENABLE not defined in aosconf.h"
52 7de0cc90 Thomas Schöpping
#endif /* !defined(AMIROOS_CFG_TESTS_ENABLE) */
53 e545e620 Thomas Schöpping
54 7de0cc90 Thomas Schöpping
#if !defined(AMIROOS_CFG_PROFILE)
55 e545e620 Thomas Schöpping
  #error "AMIROOS_CFG_PROFILE not defined in aosconf.h"
56 7de0cc90 Thomas Schöpping
#endif /* !defined(AMIROOS_CFG_PROFILE) */
57 e545e620 Thomas Schöpping
58 7de0cc90 Thomas Schöpping
#if !defined(AMIROOS_CFG_MAIN_LOOP_TIMEOUT)
59 e545e620 Thomas Schöpping
  #error "AMIROOS_CFG_MAIN_LOOP_TIMEOUT not defined in aosconf.h"
60 7de0cc90 Thomas Schöpping
#endif /* !defined(AMIROOS_CFG_MAIN_LOOP_TIMEOUT) */
61 e545e620 Thomas Schöpping
62 cda14729 Thomas Schöpping
/* bootloader parameters and options */
63
64
#if !defined(AMIROOS_CFG_BOOTLOADER)
65
  #error "AMIROOS_CFG_BOOTLOADER not defined in aosconf.h"
66
#endif /* !defined(AMIROOS_CFG_BOOTLOADER)*/
67
68 f3ac1c96 Thomas Schöpping
/* SSSP parameters and options */
69 6b53f6bf Thomas Schöpping
70 7de0cc90 Thomas Schöpping
#if !defined(AMIROOS_CFG_SSSP_ENABLE)
71 9ebb11a9 Thomas Schöpping
  #error "AMIROOS_CFG_SSSP_ENABLE not defined in aosconf.h"
72 7de0cc90 Thomas Schöpping
#endif /* !defined(AMIROOS_CFG_SSSP_ENABLE) */
73 6b53f6bf Thomas Schöpping
74 cda14729 Thomas Schöpping
#if (AMIROOS_CFG_SSSP_ENABLE == true)
75
76
  #if !defined(AMIROOS_CFG_SSSP_STARTUP)
77
    #error "AMIROOS_CFG_SSSP_STARTUP not defined in aosconf.h"
78
  #else /* !defined(AMIROOS_CFG_SSSP_STARTUP) */
79
    #if (AMIROOS_CFG_SSSP_STARTUP == true)
80
      #if (AMIROOS_CFG_BOOTLOADER == AOS_BOOTLOADER_AMiRoBLT)
81
        #error "AMIROOS_CFG_SSSP_STARTUP is enabled in aosconf.h, but SSSP startup phase is already handled by AMiRo-BLT."
82
      #endif /* (AMIROOS_CFG_BOOTLOADER == AOS_BOOTLOADER_AMiRoBLT) */
83
    #else /* (AMIROOS_CFG_SSSP_STARTUP == true) */
84
      #if (AMIROOS_CFG_BOOTLOADER == AOS_BOOTLOADER_NONE)
85
        #error "AMIROOS_CFG_SSSP_STARTUP is disabled in aosconf.h, but no bootloader is defined to handle SSSP startup phase instead."
86
      #endif /* (AMIROOS_CFG_BOOTLOADER == AOS_BOOTLOADER_NONE) */
87
    #endif /* (AMIROOS_CFG_SSSP_STARTUP == true) */
88
  #endif /* !defined(AMIROOS_CFG_SSSP_STARTUP) */
89
90
  #if !defined(AMIROOS_CFG_SSSP_SHUTDOWN)
91
    #error "AMIROOS_CFG_SSSP_SHUTDOWN not defined in aosconf.h"
92
  #else /* !defined(AMIROOS_CFG_SSSP_SHUTDOWN) */
93
    #if (AMIROOS_CFG_SSSP_SHUTDOWN != true)
94
      #if (AMIROOS_CFG_BOOTLOADER == AOS_BOOTLOADER_NONE)
95
        #error "AMIROOS_CFG_SSSP_SHUTDOWN is disabled in aosconf.h, but no bootloader is defined to handle SSSP shutdown phase instead."
96
      #endif /* (AMIROOS_CFG_BOOTLOADER == AOS_BOOTLOADER_NONE) */
97
    #endif /* (AMIROOS_CFG_SSSP_SHUTDOWN != true) && (AMIROOS_CFG_BOOTLOADER == AOS_BOOTLOADER_NONE) */
98
  #endif /* !defined(AMIROOS_CFG_SSSP_SHUTDOWN) */
99
100
  #if !defined(AMIROOS_CFG_SSSP_MSI)
101
    #error "AMIROOS_CFG_SSSP_MSI not defined in aosconf.h"
102
  #endif /* !defined(AMIROOS_CFG_SSSP_MSI) */
103
104
  #if !defined(AMIROOS_CFG_SSSP_MODULEIDWIDTH)
105
    #error "AMIROOS_CFG_SSSP_MODULEIDWIDTH not defined in aosconf.h"
106
  #endif /* !defined(AMIROOS_CFG_SSSP_MODULEIDWIDTH) */
107 933df08e Thomas Schöpping
108 7de0cc90 Thomas Schöpping
  #if !defined(AMIROOS_CFG_SSSP_MASTER)
109 9ebb11a9 Thomas Schöpping
    #error "AMIROOS_CFG_SSSP_MASTER not defined in aosconf.h"
110 7de0cc90 Thomas Schöpping
  #endif /* !defined(AMIROOS_CFG_SSSP_MASTER) */
111 933df08e Thomas Schöpping
112 7de0cc90 Thomas Schöpping
  #if !defined(AMIROOS_CFG_SSSP_STACK_START)
113 9ebb11a9 Thomas Schöpping
    #error "AMIROOS_CFG_SSSP_STACK_START not defined in aosconf.h"
114 7de0cc90 Thomas Schöpping
  #endif /* !defined(AMIROOS_CFG_SSSP_STACK_START) */
115 933df08e Thomas Schöpping
116 7de0cc90 Thomas Schöpping
  #if !defined(AMIROOS_CFG_SSSP_STACK_END)
117 9ebb11a9 Thomas Schöpping
    #error "AMIROOS_CFG_SSSP_STACK_END not defined in aosconf.h"
118 7de0cc90 Thomas Schöpping
  #endif /* !defined(AMIROOS_CFG_SSSP_STACK_END) */
119 9ebb11a9 Thomas Schöpping
120
  #if (AMIROOS_CFG_SSSP_STACK_START == true) && (AMIROOS_CFG_SSSP_STACK_END == true)
121
    #warning "AMIROOS_CFG_SSSP_STACK_START and AMIROOS_CFG_SSSP_STACK_END both enabled in aosconf.h"
122
    #if (AMIROOS_CFG_SSSP_MASTER != true)
123
      #error "AMIROOS_CFG_SSSP_MASTER must be enabled in this case"
124 7de0cc90 Thomas Schöpping
    #endif /* (AMIROOS_CFG_SSSP_MASTER != true) */
125
  #endif /* (AMIROOS_CFG_SSSP_STACK_START == true) && (AMIROOS_CFG_SSSP_STACK_END == true) */
126 9ebb11a9 Thomas Schöpping
127 7de0cc90 Thomas Schöpping
  #if !defined(AMIROOS_CFG_SSSP_SIGNALDELAY)
128 9ebb11a9 Thomas Schöpping
    #error "AMIROOS_CFG_SSSP_SIGNALDELAY not defined in aosconf.h"
129 7de0cc90 Thomas Schöpping
  #endif /* !defined(AMIROOS_CFG_SSSP_SIGNALDELAY) */
130 9ebb11a9 Thomas Schöpping
131 7de0cc90 Thomas Schöpping
  #if !defined(AMIROOS_CFG_SSSP_SYSSYNCPERIOD)
132 9ebb11a9 Thomas Schöpping
    #error "AMIROOS_CFG_SSSP_SYSSYNCPERIOD not defined in aosconf.h"
133 7de0cc90 Thomas Schöpping
  #endif /* !defined(AMIROOS_CFG_SSSP_SYSSYNCPERIOD) */
134 933df08e Thomas Schöpping
135 cda14729 Thomas Schöpping
#else /* (AMIROOS_CFG_SSSP_ENABLE == true) */
136
137
  #if (AMIROOS_CFG_BOOTLOADER == AOS_BOOTLOADER_AMiRoBLT)
138
    #warning "SSSP is disabled in aosconf.h, but AMiRo-BLT implements it nevertheless."
139
  #endif /* (AMIROOS_CFG_BOOTLOADER == AOS_BOOTLOADER_AMiRoBLT) */
140
141 7de0cc90 Thomas Schöpping
#endif /* (AMIROOS_CFG_SSSP_ENABLE == true) */
142 6b53f6bf Thomas Schöpping
143 f3ac1c96 Thomas Schöpping
/* system shell options */
144 e545e620 Thomas Schöpping
145 7de0cc90 Thomas Schöpping
#if !defined(AMIROOS_CFG_SHELL_ENABLE)
146 e545e620 Thomas Schöpping
  #error "AMIROOS_CFG_SHELL_ENABLE not defined in aosconf.h"
147 7de0cc90 Thomas Schöpping
#endif /* !defined(AMIROOS_CFG_SHELL_ENABLE) */
148 e545e620 Thomas Schöpping
149
#if (AMIROOS_CFG_SHELL_ENABLE == true)
150
151 7de0cc90 Thomas Schöpping
  #if !defined(AMIROOS_CFG_SHELL_STACKSIZE)
152 e545e620 Thomas Schöpping
    #error "AMIROOS_CFG_SHELL_STACKSIZE not defined in aosconf.h"
153 7de0cc90 Thomas Schöpping
  #endif /* !defined(AMIROOS_CFG_SHELL_STACKSIZE) */
154 e545e620 Thomas Schöpping
155 7de0cc90 Thomas Schöpping
  #if !defined(AMIROOS_CFG_SHELL_THREADPRIO)
156 cb835a3e Thomas Schöpping
    #error "AMIROOS_CFG_SHELL_THREADPRIO not defined in aosconf.h"
157 7de0cc90 Thomas Schöpping
  #endif /* !defined(AMIROOS_CFG_SHELL_THREADPRIO) */
158 cb835a3e Thomas Schöpping
159 7de0cc90 Thomas Schöpping
  #if !defined(AMIROOS_CFG_SHELL_LINEWIDTH)
160 e545e620 Thomas Schöpping
    #error "AMIROOS_CFG_SHELL_LINEWIDTH not defined in aosconf.h"
161 7de0cc90 Thomas Schöpping
  #endif /* !defined(AMIROOS_CFG_SHELL_LINEWIDTH) */
162 e545e620 Thomas Schöpping
163 7de0cc90 Thomas Schöpping
  #if !defined(AMIROOS_CFG_SHELL_MAXARGS)
164 e545e620 Thomas Schöpping
    #error "AMIROOS_CFG_SHELL_MAXARGS not defined in aosconf.h"
165 7de0cc90 Thomas Schöpping
  #endif /* !defined(AMIROOS_CFG_SHELL_MAXARGS) */
166 e545e620 Thomas Schöpping
167 697dba3c Thomas Schöpping
  #if !defined(AMIROOS_CFG_SHELL_HISTLENGTH)
168
    #error "AMIROOS_CFG_SHELL_HISTLENGTH not defined in aosconf.h"
169
  #endif /* !defined(AMIROOS_CFG_SHELL_HISTLENGTH) */
170
171 7de0cc90 Thomas Schöpping
#else /* (AMIROOS_CFG_SHELL_ENABLE == true) */
172 2dd2e257 Thomas Schöpping
173
  #if (AMIROOS_CFG_TESTS_ENABLE == true)
174 cda14729 Thomas Schöpping
    #error "Enabling AMIROOS_CFG_TESTS_ENABLE in aosconf.h requires AMIROOS_CFG_SHELL_ENABLE to be enabled as well."
175 7de0cc90 Thomas Schöpping
  #endif /* (AMIROOS_CFG_TESTS_ENABLE == true) */
176 2dd2e257 Thomas Schöpping
177 7de0cc90 Thomas Schöpping
#endif /* (AMIROOS_CFG_SHELL_ENABLE == true) */
178 e545e620 Thomas Schöpping
179 f3ac1c96 Thomas Schöpping
/******************************************************************************/
180
/* DATA STRUCTURES AND TYPES                                                  */
181
/******************************************************************************/
182
183
/******************************************************************************/
184
/* MACROS                                                                     */
185
/******************************************************************************/
186
187
/******************************************************************************/
188
/* EXTERN DECLARATIONS                                                        */
189
/******************************************************************************/
190
191
/******************************************************************************/
192
/* INLINE FUNCTIONS                                                           */
193
/******************************************************************************/
194
195 6ff06bbf Thomas Schöpping
#endif /* AMIROOS_CONFCHECK_H */
196 53710ca3 Marc Rothmann
197
/** @} */