amiro-os / modules / BI-Vital_5-1 / module.h @ e1eb72da
History | View | Annotate | Download (3.815 KB)
1 | e1eb72da | Thomas Schöpping | /*
|
---|---|---|---|
2 | AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform.
|
||
3 | Copyright (C) 2016..2020 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 Structures and constant for the BI-Vital (BG v5.1) module.
|
||
22 | *
|
||
23 | * @addtogroup BIVITAL_51_module
|
||
24 | * @{
|
||
25 | */
|
||
26 | |||
27 | #ifndef AMIROOS_MODULE_H
|
||
28 | #define AMIROOS_MODULE_H
|
||
29 | |||
30 | #include <amiroos.h> |
||
31 | |||
32 | /*===========================================================================*/
|
||
33 | /**
|
||
34 | * @name Module specific functions
|
||
35 | * @{
|
||
36 | */
|
||
37 | /*===========================================================================*/
|
||
38 | |||
39 | /** @} */
|
||
40 | |||
41 | /*===========================================================================*/
|
||
42 | /**
|
||
43 | * @name ChibiOS/HAL configuration
|
||
44 | * @{
|
||
45 | */
|
||
46 | /*===========================================================================*/
|
||
47 | |||
48 | /** @} */
|
||
49 | |||
50 | /*===========================================================================*/
|
||
51 | /**
|
||
52 | * @name GPIO definitions
|
||
53 | * @{
|
||
54 | */
|
||
55 | /*===========================================================================*/
|
||
56 | |||
57 | /** @} */
|
||
58 | |||
59 | /*===========================================================================*/
|
||
60 | /**
|
||
61 | * @name AMiRo-OS core configurations
|
||
62 | * @{
|
||
63 | */
|
||
64 | /*===========================================================================*/
|
||
65 | |||
66 | #if (AMIROOS_CFG_SHELL_ENABLE == true) || defined(__DOXYGEN__) |
||
67 | /**
|
||
68 | * @brief Shell prompt text.
|
||
69 | */
|
||
70 | extern ROMCONST char* moduleShellPrompt; |
||
71 | #endif /* (AMIROOS_CFG_SHELL_ENABLE == true) */ |
||
72 | |||
73 | /**
|
||
74 | * @brief Interrupt initialization macro.
|
||
75 | */
|
||
76 | #define MODULE_INIT_INTERRUPTS() { \
|
||
77 | } |
||
78 | |||
79 | /**
|
||
80 | * @brief Test initialization hook.
|
||
81 | */
|
||
82 | #define MODULE_INIT_TESTS() { \
|
||
83 | /* add test commands to shell */ \
|
||
84 | } |
||
85 | |||
86 | /**
|
||
87 | * @brief Periphery communication interfaces initialization hook.
|
||
88 | */
|
||
89 | #define MODULE_INIT_PERIPHERY_IF() { \
|
||
90 | } |
||
91 | |||
92 | /**
|
||
93 | * @brief Periphery communication interface deinitialization hook.
|
||
94 | */
|
||
95 | #define MODULE_SHUTDOWN_PERIPHERY_IF() { \
|
||
96 | /* don't stop the serial driver so messages can still be printed */ \
|
||
97 | } |
||
98 | |||
99 | /**
|
||
100 | * @brief HOOK to toggle the LEDs when the user button is pressed.
|
||
101 | */
|
||
102 | #define MODULE_MAIN_LOOP_GPIOEVENT(eventflags) { \
|
||
103 | } |
||
104 | |||
105 | /** @} */
|
||
106 | |||
107 | /*===========================================================================*/
|
||
108 | /**
|
||
109 | * @name Startup Shutdown Synchronization Protocol (SSSP)
|
||
110 | * @{
|
||
111 | */
|
||
112 | /*===========================================================================*/
|
||
113 | |||
114 | #if (AMIROOS_CFG_SSSP_ENABLE == true) || defined(__DOXYGEN__) |
||
115 | #error "SSSP is not supported on this module." |
||
116 | #endif /* (AMIROOS_CFG_SSSP_ENABLE == true) */ |
||
117 | |||
118 | /** @} */
|
||
119 | |||
120 | /*===========================================================================*/
|
||
121 | /**
|
||
122 | * @name Low-level drivers
|
||
123 | * @{
|
||
124 | */
|
||
125 | /*===========================================================================*/
|
||
126 | |||
127 | /** @} */
|
||
128 | |||
129 | /*===========================================================================*/
|
||
130 | /**
|
||
131 | * @name Tests
|
||
132 | * @{
|
||
133 | */
|
||
134 | /*===========================================================================*/
|
||
135 | #if (AMIROOS_CFG_TESTS_ENABLE == true) || defined(__DOXYGEN__) |
||
136 | |||
137 | #endif /* (AMIROOS_CFG_TESTS_ENABLE == true) */ |
||
138 | |||
139 | /** @} */
|
||
140 | |||
141 | #endif /* AMIROOS_MODULE_H */ |
||
142 | |||
143 | /** @} */ |