amiro-os / modules / LightRing_1-2 / module.h @ 510b93cc
History | View | Annotate | Download (17.4 KB)
1 | 9ae7c4f3 | Thomas Schöpping | /*
|
---|---|---|---|
2 | AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform.
|
||
3 | Copyright (C) 2016..2019 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 LightRing module.
|
||
22 | *
|
||
23 | * @addtogroup lightring_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 | * @brief CAN driver to use.
|
||
50 | */
|
||
51 | #define MODULE_HAL_CAN CAND1
|
||
52 | |||
53 | /**
|
||
54 | * @brief Configuration for the CAN driver.
|
||
55 | */
|
||
56 | extern CANConfig moduleHalCanConfig;
|
||
57 | |||
58 | /**
|
||
59 | ee884101 | Thomas Schöpping | * @brief I2C driver to access the EEPROM, power monitor and the breakout header.
|
60 | 9ae7c4f3 | Thomas Schöpping | */
|
61 | ee884101 | Thomas Schöpping | #define MODULE_HAL_I2C_EEPROM_PWRMTR_BREAKOUT I2CD2
|
62 | 9ae7c4f3 | Thomas Schöpping | |
63 | /**
|
||
64 | ee884101 | Thomas Schöpping | * @brief Configuration for the EEPROM, power monitor and breakout I2C driver.
|
65 | 9ae7c4f3 | Thomas Schöpping | */
|
66 | ee884101 | Thomas Schöpping | extern I2CConfig moduleHalI2cEepromPwrmtrBreakoutConfig;
|
67 | 9ae7c4f3 | Thomas Schöpping | |
68 | /**
|
||
69 | * @brief Serial driver of the programmer interface.
|
||
70 | */
|
||
71 | #define MODULE_HAL_PROGIF SD1
|
||
72 | |||
73 | /**
|
||
74 | * @brief Configuration for the programmer serial interface driver.
|
||
75 | */
|
||
76 | extern SerialConfig moduleHalProgIfConfig;
|
||
77 | |||
78 | /**
|
||
79 | * @brief SPI interface driver for the motion sensors (gyroscope and accelerometer).
|
||
80 | */
|
||
81 | #define MODULE_HAL_SPI_LIGHT SPID1
|
||
82 | |||
83 | /**
|
||
84 | * @brief Configuration for the SPI interface driver to communicate with the LED driver.
|
||
85 | */
|
||
86 | extern SPIConfig moduleHalSpiLightConfig;
|
||
87 | |||
88 | 0b989911 | Cung Sang | /**
|
89 | f606f432 | Thomas Schöpping | * @brief SPI interface driver for the breakout header.
|
90 | 0b989911 | Cung Sang | */
|
91 | f606f432 | Thomas Schöpping | #define MODULE_HAL_SPI_BREAKOUT SPID2
|
92 | 0b989911 | Cung Sang | |
93 | /**
|
||
94 | f606f432 | Thomas Schöpping | * @brief UART interface driver for the breakout header (alternative to serial).
|
95 | 0b989911 | Cung Sang | */
|
96 | f606f432 | Thomas Schöpping | #define MODULE_HAL_UART_BREAKOUT UARTD2
|
97 | 0b989911 | Cung Sang | |
98 | /**
|
||
99 | f606f432 | Thomas Schöpping | * @brief Real-Time Clock driver.
|
100 | 0b989911 | Cung Sang | */
|
101 | f606f432 | Thomas Schöpping | #define MODULE_HAL_RTC RTCD1
|
102 | 0b989911 | Cung Sang | |
103 | f606f432 | Thomas Schöpping | #if (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10) || defined(__DOXYGEN__)
|
104 | 0b989911 | Cung Sang | |
105 | 9ae7c4f3 | Thomas Schöpping | /**
|
106 | f606f432 | Thomas Schöpping | * @brief SPI interface driver for UWB DW1000 module.
|
107 | 9ae7c4f3 | Thomas Schöpping | */
|
108 | f606f432 | Thomas Schöpping | #define MODULE_HAL_SPI_UWB MODULE_HAL_SPI_BREAKOUT
|
109 | 0b989911 | Cung Sang | |
110 | 9ae7c4f3 | Thomas Schöpping | /**
|
111 | f606f432 | Thomas Schöpping | * @brief Configuration for the high-speed SPI interface driver of DW1000 module.
|
112 | 9ae7c4f3 | Thomas Schöpping | */
|
113 | f606f432 | Thomas Schöpping | extern SPIConfig moduleHalSpiUwbHsConfig;
|
114 | 9ae7c4f3 | Thomas Schöpping | |
115 | /**
|
||
116 | f606f432 | Thomas Schöpping | * @brief Configuration for the low-speed SPI interface driver of DW1000 module.
|
117 | 9ae7c4f3 | Thomas Schöpping | */
|
118 | f606f432 | Thomas Schöpping | extern SPIConfig moduleHalSpiUwbLsConfig;
|
119 | |||
120 | #endif /* (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10) */ |
||
121 | 9ae7c4f3 | Thomas Schöpping | |
122 | /** @} */
|
||
123 | |||
124 | /*===========================================================================*/
|
||
125 | /**
|
||
126 | * @name GPIO definitions
|
||
127 | * @{
|
||
128 | */
|
||
129 | /*===========================================================================*/
|
||
130 | |||
131 | /**
|
||
132 | * @brief LIGHT_BANK output signal GPIO.
|
||
133 | */
|
||
134 | extern ROMCONST apalControlGpio_t moduleGpioLightBlank;
|
||
135 | |||
136 | /**
|
||
137 | * @brief RS232_R_EN_N output signal GPIO.
|
||
138 | */
|
||
139 | extern ROMCONST apalControlGpio_t moduleGpioRs232En;
|
||
140 | |||
141 | /**
|
||
142 | * @brief SW_V33_EN output signal GPIO.
|
||
143 | */
|
||
144 | extern ROMCONST apalControlGpio_t moduleGpioSwV33En;
|
||
145 | |||
146 | 9acb8326 | Thomas Schöpping | // The 4.2V switch is disabled due to a hardware bug.
|
147 | ///**
|
||
148 | // * @brief SW_V42_EN output signal GPIO.
|
||
149 | // */
|
||
150 | //extern ROMCONST apalControlGpio_t moduleGpioSwV42En;
|
||
151 | 9ae7c4f3 | Thomas Schöpping | |
152 | /**
|
||
153 | * @brief SW_V50_EN output signal GPIO.
|
||
154 | */
|
||
155 | extern ROMCONST apalControlGpio_t moduleGpioSwV50En;
|
||
156 | |||
157 | /**
|
||
158 | * @brief IO_3 breakout signal GPIO.
|
||
159 | */
|
||
160 | extern apalControlGpio_t moduleGpioBreakoutIo3;
|
||
161 | |||
162 | /**
|
||
163 | * @brief IO_5 breakout signal GPIO.
|
||
164 | */
|
||
165 | extern apalControlGpio_t moduleGpioBreakoutIo5;
|
||
166 | |||
167 | /**
|
||
168 | * @brief IO_6 breakout signal GPIO.
|
||
169 | */
|
||
170 | extern apalControlGpio_t moduleGpioBreakoutIo6;
|
||
171 | |||
172 | /**
|
||
173 | * @brief SYS_UART_DN bidirectional signal GPIO.
|
||
174 | */
|
||
175 | extern ROMCONST apalControlGpio_t moduleGpioSysUartDn;
|
||
176 | |||
177 | /**
|
||
178 | f606f432 | Thomas Schöpping | * @brief IO_7 breakout signal GPIO.
|
179 | */
|
||
180 | extern apalControlGpio_t moduleGpioBreakoutIo7;
|
||
181 | |||
182 | /**
|
||
183 | * @brief IO_8 breakout signal GPIO.
|
||
184 | */
|
||
185 | extern apalControlGpio_t moduleGpioBreakoutIo8;
|
||
186 | |||
187 | /**
|
||
188 | 9ae7c4f3 | Thomas Schöpping | * @brief IO_4 breakout signal GPIO.
|
189 | */
|
||
190 | extern apalControlGpio_t moduleGpioBreakoutIo4;
|
||
191 | |||
192 | /**
|
||
193 | * @brief IO_1 breakout signal GPIO.
|
||
194 | */
|
||
195 | extern apalControlGpio_t moduleGpioBreakoutIo1;
|
||
196 | |||
197 | /**
|
||
198 | f606f432 | Thomas Schöpping | * @brief IO_2 breakout signal GPIO.
|
199 | */
|
||
200 | extern apalControlGpio_t moduleGpioBreakoutIo2;
|
||
201 | |||
202 | /**
|
||
203 | 9ae7c4f3 | Thomas Schöpping | * @brief LED output signal GPIO.
|
204 | */
|
||
205 | extern ROMCONST apalControlGpio_t moduleGpioLed;
|
||
206 | |||
207 | /**
|
||
208 | c930aa01 | Thomas Schöpping | * @brief LIGHT_XLAT output signal.
|
209 | */
|
||
210 | extern ROMCONST apalControlGpio_t moduleGpioLightXlat;
|
||
211 | |||
212 | /**
|
||
213 | 9ae7c4f3 | Thomas Schöpping | * @brief SW_V18_EN output signal GPIO.
|
214 | */
|
||
215 | extern ROMCONST apalControlGpio_t moduleGpioSwV18En;
|
||
216 | |||
217 | /**
|
||
218 | * @brief SW_VSYS_EN output signal GPIO.
|
||
219 | */
|
||
220 | extern ROMCONST apalControlGpio_t moduleGpioSwVsysEn;
|
||
221 | |||
222 | /**
|
||
223 | * @brief SYS_UART_UP bidirectional signal GPIO.
|
||
224 | */
|
||
225 | extern ROMCONST apalControlGpio_t moduleGpioSysUartUp;
|
||
226 | |||
227 | /**
|
||
228 | * @brief SYS_PD bidirectional signal GPIO.
|
||
229 | */
|
||
230 | extern ROMCONST apalControlGpio_t moduleGpioSysPd;
|
||
231 | |||
232 | /**
|
||
233 | * @brief SYS_SYNC bidirectional signal GPIO.
|
||
234 | */
|
||
235 | extern ROMCONST apalControlGpio_t moduleGpioSysSync;
|
||
236 | |||
237 | /** @} */
|
||
238 | |||
239 | /*===========================================================================*/
|
||
240 | /**
|
||
241 | * @name AMiRo-OS core configurations
|
||
242 | * @{
|
||
243 | */
|
||
244 | /*===========================================================================*/
|
||
245 | |||
246 | /**
|
||
247 | * @brief Event flag to be set on a IO_4 (breakout) interrupt.
|
||
248 | */
|
||
249 | cda14729 | Thomas Schöpping | #define MODULE_OS_GPIOEVENTFLAG_BREAKOUTIO4 AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_IO_4))
|
250 | 9ae7c4f3 | Thomas Schöpping | |
251 | /**
|
||
252 | * @brief Event flag to be set on a IO_1 (breakout) interrupt.
|
||
253 | */
|
||
254 | cda14729 | Thomas Schöpping | #define MODULE_OS_GPIOEVENTFLAG_BREAKOUTIO1 AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_IO_1))
|
255 | 9ae7c4f3 | Thomas Schöpping | |
256 | /**
|
||
257 | * @brief Event flag to be set on a SYS_SYNC interrupt.
|
||
258 | */
|
||
259 | cda14729 | Thomas Schöpping | #define MODULE_OS_GPIOEVENTFLAG_SYSSYNC AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_SYS_INT_N))
|
260 | 9ae7c4f3 | Thomas Schöpping | |
261 | /**
|
||
262 | * @brief Event flag to be set on a IO_3 (breakout) interrupt.
|
||
263 | */
|
||
264 | cda14729 | Thomas Schöpping | #define MODULE_OS_GPIOEVENTFLAG_BREAKOUTIO3 AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_IO_3))
|
265 | 9ae7c4f3 | Thomas Schöpping | |
266 | /**
|
||
267 | * @brief Event flag to be set on a IO_5 (breakout) interrupt.
|
||
268 | */
|
||
269 | cda14729 | Thomas Schöpping | #define MODULE_OS_GPIOEVENTFLAG_BREAKOUTIO5 AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_IO_5))
|
270 | 9ae7c4f3 | Thomas Schöpping | |
271 | /**
|
||
272 | * @brief Event flag to be set on a IO_6 (breakout) interrupt.
|
||
273 | */
|
||
274 | cda14729 | Thomas Schöpping | #define MODULE_OS_GPIOEVENTFLAG_BREAKOUTIO6 AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_IO_6))
|
275 | 9ae7c4f3 | Thomas Schöpping | |
276 | /**
|
||
277 | * @brief Event flag to be set on a SYS_UART_DN interrupt.
|
||
278 | */
|
||
279 | cda14729 | Thomas Schöpping | #define MODULE_OS_GPIOEVENTFLAG_SYSUARTDN AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_SYS_UART_DN))
|
280 | 9ae7c4f3 | Thomas Schöpping | |
281 | /**
|
||
282 | * @brief Event flag to be set on a SYS_UART_UP interrupt.
|
||
283 | */
|
||
284 | cda14729 | Thomas Schöpping | #define MODULE_OS_GPIOEVENTFLAG_SYSUARTUP AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_SYS_UART_UP))
|
285 | 9ae7c4f3 | Thomas Schöpping | |
286 | /**
|
||
287 | * @brief Event flag to be set on a IO_7 (breakout) interrupt.
|
||
288 | */
|
||
289 | cda14729 | Thomas Schöpping | #define MODULE_OS_GPIOEVENTFLAG_BREAKOUTIO7 AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_IO_7))
|
290 | 9ae7c4f3 | Thomas Schöpping | |
291 | /**
|
||
292 | * @brief Event flag to be set on a IO_8 (breakout) interrupt.
|
||
293 | */
|
||
294 | cda14729 | Thomas Schöpping | #define MODULE_OS_GPIOEVENTFLAG_BREAKOUTIO8 AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_IO_8))
|
295 | 9ae7c4f3 | Thomas Schöpping | |
296 | /**
|
||
297 | f606f432 | Thomas Schöpping | * @brief Event flag to be set on a SYS_PD interrupt.
|
298 | 0b989911 | Cung Sang | */
|
299 | cda14729 | Thomas Schöpping | #define MODULE_OS_GPIOEVENTFLAG_SYSPD AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_SYS_PD_N))
|
300 | f606f432 | Thomas Schöpping | |
301 | #if (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10) || defined(__DOXYGEN__)
|
||
302 | 0b989911 | Cung Sang | |
303 | /**
|
||
304 | f606f432 | Thomas Schöpping | * @brief Event flag to be set on a DW1000 interrupt.
|
305 | 9ae7c4f3 | Thomas Schöpping | */
|
306 | cda14729 | Thomas Schöpping | #define MODULE_OS_GPIOEVENTFLAG_DW1000 MODULE_OS_GPIOEVENTFLAGS_BREAKOUTIO8
|
307 | f606f432 | Thomas Schöpping | |
308 | #endif /* (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10) */ |
||
309 | 9ae7c4f3 | Thomas Schöpping | |
310 | cda14729 | Thomas Schöpping | #if (AMIROOS_CFG_SHELL_ENABLE == true) || defined(__DOXYGEN__) |
311 | 9ae7c4f3 | Thomas Schöpping | /**
|
312 | * @brief Shell prompt text.
|
||
313 | */
|
||
314 | extern ROMCONST char* moduleShellPrompt; |
||
315 | cda14729 | Thomas Schöpping | #endif /* (AMIROOS_CFG_SHELL_ENABLE == true) */ |
316 | 9ae7c4f3 | Thomas Schöpping | |
317 | /**
|
||
318 | * @brief Interrupt initialization macro.
|
||
319 | */
|
||
320 | #define MODULE_INIT_INTERRUPTS() { \
|
||
321 | /* breakout interrupts must be enabled explicitely */ \
|
||
322 | f606f432 | Thomas Schöpping | MODULE_INIT_INTERRUPTS_BREAKOUT(); \ |
323 | 9ae7c4f3 | Thomas Schöpping | } |
324 | f606f432 | Thomas Schöpping | #if (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10)
|
325 | #define MODULE_INIT_INTERRUPTS_BREAKOUT() { \
|
||
326 | cda14729 | Thomas Schöpping | palSetLineCallback(moduleLldDw1000.gpio_exti->gpio->line, aosSysGetStdGpioCallback(), &moduleLldDw1000.gpio_exti->gpio->line); \ |
327 | f606f432 | Thomas Schöpping | palEnableLineEvent(moduleLldDw1000.gpio_exti->gpio->line, APAL2CH_EDGE(moduleLldDw1000.gpio_exti->meta.edge)); \ |
328 | 0b989911 | Cung Sang | } |
329 | f606f432 | Thomas Schöpping | #elif (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_NONE)
|
330 | #define MODULE_INIT_INTERRUPTS_BREAKOUT() { \
|
||
331 | 0b989911 | Cung Sang | } |
332 | f606f432 | Thomas Schöpping | #endif
|
333 | 9ae7c4f3 | Thomas Schöpping | |
334 | /**
|
||
335 | cda14729 | Thomas Schöpping | * @brief Test initialization hook.
|
336 | 9ae7c4f3 | Thomas Schöpping | */
|
337 | #define MODULE_INIT_TESTS() { \
|
||
338 | cda14729 | Thomas Schöpping | /* add test commands to shell */ \
|
339 | 4c72a54c | Thomas Schöpping | aosShellAddCommand(&aos.shell, &moduleTestAt24c01bShellCmd); \ |
340 | aosShellAddCommand(&aos.shell, &moduleTestIna219ShellCmd); \ |
||
341 | aosShellAddCommand(&aos.shell, &moduleTestLedShellCmd); \ |
||
342 | aosShellAddCommand(&aos.shell, &moduleTestMic9404xShellCmd); \ |
||
343 | aosShellAddCommand(&aos.shell, &moduleTestTlc5947ShellCmd); \ |
||
344 | aosShellAddCommand(&aos.shell, &moduleTestAllShellCmd); \ |
||
345 | f606f432 | Thomas Schöpping | MODULE_INIT_TESTS_BREAKOUT(); \ |
346 | 9ae7c4f3 | Thomas Schöpping | } |
347 | f606f432 | Thomas Schöpping | #if (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10)
|
348 | #define MODULE_INIT_TESTS_BREAKOUT() { \
|
||
349 | 0b989911 | Cung Sang | aosShellAddCommand(&aos.shell, &moduleTestDw1000ShellCmd); \ |
350 | } |
||
351 | f606f432 | Thomas Schöpping | #elif (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_NONE)
|
352 | #define MODULE_INIT_TESTS_BREAKOUT() { \
|
||
353 | 0b989911 | Cung Sang | } |
354 | f606f432 | Thomas Schöpping | #endif
|
355 | 9ae7c4f3 | Thomas Schöpping | |
356 | /**
|
||
357 | * @brief Periphery communication interfaces initialization hook.
|
||
358 | */
|
||
359 | 4c72a54c | Thomas Schöpping | #define MODULE_INIT_PERIPHERY_IF() { \
|
360 | 9ae7c4f3 | Thomas Schöpping | /* serial driver */ \
|
361 | sdStart(&MODULE_HAL_PROGIF, &moduleHalProgIfConfig); \ |
||
362 | /* I2C */ \
|
||
363 | ee884101 | Thomas Schöpping | moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed = (AT24C01B_LLD_I2C_MAXFREQUENCY < moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed) ? AT24C01B_LLD_I2C_MAXFREQUENCY : moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed; \ |
364 | moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed = (INA219_LLD_I2C_MAXFREQUENCY < moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed) ? INA219_LLD_I2C_MAXFREQUENCY : moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed; \ |
||
365 | moduleHalI2cEepromPwrmtrBreakoutConfig.duty_cycle = (moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed <= 100000) ? STD_DUTY_CYCLE : FAST_DUTY_CYCLE_2; \
|
||
366 | i2cStart(&MODULE_HAL_I2C_EEPROM_PWRMTR_BREAKOUT, &moduleHalI2cEepromPwrmtrBreakoutConfig); \ |
||
367 | 9ae7c4f3 | Thomas Schöpping | /* SPI */ \
|
368 | spiStart(&MODULE_HAL_SPI_LIGHT, &moduleHalSpiLightConfig); \ |
||
369 | cda14729 | Thomas Schöpping | /* CAN */ \
|
370 | canStart(&MODULE_HAL_CAN, &moduleHalCanConfig); \ |
||
371 | f606f432 | Thomas Schöpping | /* breakout module */ \
|
372 | MODULE_INIT_PERIPHERY_COMM_BREAKOUT(); \ |
||
373 | 9ae7c4f3 | Thomas Schöpping | } |
374 | f606f432 | Thomas Schöpping | #if (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10)
|
375 | #define MODULE_INIT_PERIPHERY_COMM_BREAKOUT() { \
|
||
376 | spiStart(&MODULE_HAL_SPI_UWB, &moduleHalSpiUwbLsConfig); \ |
||
377 | 0b989911 | Cung Sang | } |
378 | f606f432 | Thomas Schöpping | #elif (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_NONE)
|
379 | #define MODULE_INIT_PERIPHERY_COMM_BREAKOUT() { \
|
||
380 | 0b989911 | Cung Sang | } |
381 | f606f432 | Thomas Schöpping | #endif
|
382 | 9ae7c4f3 | Thomas Schöpping | |
383 | /**
|
||
384 | * @brief Periphery communication interface deinitialization hook.
|
||
385 | */
|
||
386 | 4c72a54c | Thomas Schöpping | #define MODULE_SHUTDOWN_PERIPHERY_IF() { \
|
387 | cda14729 | Thomas Schöpping | /* breakout module */ \
|
388 | MODULE_SHUTDOWN_PERIPHERY_COMM_BREAKOUT(); \ |
||
389 | /* CAN */ \
|
||
390 | canStop(&MODULE_HAL_CAN); \ |
||
391 | 9ae7c4f3 | Thomas Schöpping | /* SPI */ \
|
392 | spiStop(&MODULE_HAL_SPI_LIGHT); \ |
||
393 | /* I2C */ \
|
||
394 | ee884101 | Thomas Schöpping | i2cStop(&MODULE_HAL_I2C_EEPROM_PWRMTR_BREAKOUT); \ |
395 | 9ae7c4f3 | Thomas Schöpping | /* don't stop the serial driver so messages can still be printed */ \
|
396 | } |
||
397 | f606f432 | Thomas Schöpping | #if (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10)
|
398 | #define MODULE_SHUTDOWN_PERIPHERY_COMM_BREAKOUT() { \
|
||
399 | /* SPI */ \
|
||
400 | spiStop(&MODULE_HAL_SPI_UWB); \ |
||
401 | 0b989911 | Cung Sang | } |
402 | f606f432 | Thomas Schöpping | #elif (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_NONE)
|
403 | #define MODULE_SHUTDOWN_PERIPHERY_COMM_BREAKOUT() { \
|
||
404 | 0b989911 | Cung Sang | } |
405 | f606f432 | Thomas Schöpping | #endif
|
406 | 9ae7c4f3 | Thomas Schöpping | |
407 | /** @} */
|
||
408 | |||
409 | /*===========================================================================*/
|
||
410 | /**
|
||
411 | * @name Startup Shutdown Synchronization Protocol (SSSP)
|
||
412 | * @{
|
||
413 | */
|
||
414 | /*===========================================================================*/
|
||
415 | |||
416 | cda14729 | Thomas Schöpping | #if (AMIROOS_CFG_SSSP_ENABLE == true) || defined(__DOXYGEN__) |
417 | |||
418 | 9ae7c4f3 | Thomas Schöpping | /**
|
419 | * @brief PD signal GPIO.
|
||
420 | */
|
||
421 | cda14729 | Thomas Schöpping | #define moduleSsspGpioPD moduleGpioSysPd
|
422 | 9ae7c4f3 | Thomas Schöpping | |
423 | /**
|
||
424 | cda14729 | Thomas Schöpping | * @brief S signal GPIO.
|
425 | 9ae7c4f3 | Thomas Schöpping | */
|
426 | cda14729 | Thomas Schöpping | #define moduleSsspGpioS moduleGpioSysSync
|
427 | 9ae7c4f3 | Thomas Schöpping | |
428 | /**
|
||
429 | * @brief UP signal GPIO.
|
||
430 | */
|
||
431 | cda14729 | Thomas Schöpping | #define moduleSsspGpioUP moduleGpioSysUartUp
|
432 | 9ae7c4f3 | Thomas Schöpping | |
433 | /**
|
||
434 | * @brief DN signal GPIO.
|
||
435 | */
|
||
436 | cda14729 | Thomas Schöpping | #define moduleSsspGpioDN moduleGpioSysUartDn
|
437 | 9ae7c4f3 | Thomas Schöpping | |
438 | /**
|
||
439 | cda14729 | Thomas Schöpping | * @brief Event flag for PD signal events.
|
440 | 9ae7c4f3 | Thomas Schöpping | */
|
441 | cda14729 | Thomas Schöpping | #define MODULE_SSSP_EVENTFLAG_PD MODULE_OS_GPIOEVENTFLAG_SYSPD
|
442 | 9ae7c4f3 | Thomas Schöpping | |
443 | /**
|
||
444 | cda14729 | Thomas Schöpping | * @brief Event flag for S signal events.
|
445 | 9ae7c4f3 | Thomas Schöpping | */
|
446 | cda14729 | Thomas Schöpping | #define MODULE_SSSP_EVENTFLAG_S MODULE_OS_GPIOEVENTFLAG_SYSSYNC
|
447 | 9ae7c4f3 | Thomas Schöpping | |
448 | /**
|
||
449 | cda14729 | Thomas Schöpping | * @brief Event flag for UP signal events.
|
450 | 9ae7c4f3 | Thomas Schöpping | */
|
451 | cda14729 | Thomas Schöpping | #define MODULE_SSSP_EVENTFLAG_UP MODULE_OS_GPIOEVENTFLAGS_SYSUARTUP
|
452 | 9ae7c4f3 | Thomas Schöpping | |
453 | /**
|
||
454 | cda14729 | Thomas Schöpping | * @brief Event flag for DN signal events.
|
455 | 9ae7c4f3 | Thomas Schöpping | */
|
456 | cda14729 | Thomas Schöpping | #define MODULE_SSSP_EVENTFLAG_DN MODULE_OS_GPIOEVENTFLAG_SYSUARTDN
|
457 | |||
458 | #endif /* (AMIROOS_CFG_SSSP_ENABLE == true) */ |
||
459 | 9ae7c4f3 | Thomas Schöpping | |
460 | /** @} */
|
||
461 | |||
462 | /*===========================================================================*/
|
||
463 | /**
|
||
464 | * @name Low-level drivers
|
||
465 | * @{
|
||
466 | */
|
||
467 | /*===========================================================================*/
|
||
468 | #include <alld_AT24C01B.h> |
||
469 | ee884101 | Thomas Schöpping | #include <alld_INA219.h> |
470 | 9ae7c4f3 | Thomas Schöpping | #include <alld_LED.h> |
471 | ee884101 | Thomas Schöpping | #include <alld_MIC9404x.h> |
472 | 4c72a54c | Thomas Schöpping | // TODO: add SNx5C3221E
|
473 | 9ae7c4f3 | Thomas Schöpping | #include <alld_TLC5947.h> |
474 | |||
475 | /**
|
||
476 | * @brief EEPROM driver.
|
||
477 | */
|
||
478 | extern AT24C01BDriver moduleLldEeprom;
|
||
479 | |||
480 | /**
|
||
481 | ee884101 | Thomas Schöpping | * @brief Power monitor (VLED 4.2) driver.
|
482 | */
|
||
483 | extern INA219Driver moduleLldPowerMonitorVled;
|
||
484 | |||
485 | /**
|
||
486 | 9ae7c4f3 | Thomas Schöpping | * @brief Status LED driver.
|
487 | */
|
||
488 | extern LEDDriver moduleLldStatusLed;
|
||
489 | |||
490 | /**
|
||
491 | ee884101 | Thomas Schöpping | * @brief Power switch driver (1.8V).
|
492 | */
|
||
493 | extern MIC9404xDriver moduleLldPowerSwitchV18;
|
||
494 | |||
495 | /**
|
||
496 | * @brief Power switch driver (3.3V).
|
||
497 | */
|
||
498 | extern MIC9404xDriver moduleLldPowerSwitchV33;
|
||
499 | |||
500 | /**
|
||
501 | * @brief Power switch driver (4.2V).
|
||
502 | */
|
||
503 | extern MIC9404xDriver moduleLldPowerSwitchV42;
|
||
504 | |||
505 | /**
|
||
506 | * @brief Power switch driver (5.0V).
|
||
507 | */
|
||
508 | extern MIC9404xDriver moduleLldPowerSwitchV50;
|
||
509 | |||
510 | /**
|
||
511 | * @brief Pseudo power switch driver (VSYS).
|
||
512 | * @details There is no actual MIC9040x device, but the swicthable circuit behaves analogous.
|
||
513 | */
|
||
514 | extern MIC9404xDriver moduleLldPowerSwitchVsys;
|
||
515 | |||
516 | 4c72a54c | Thomas Schöpping | // TODO: add SNx5C3221E
|
517 | |||
518 | ee884101 | Thomas Schöpping | /**
|
519 | 4c72a54c | Thomas Schöpping | * @brief 24 channel PWM LED driver.
|
520 | 9ae7c4f3 | Thomas Schöpping | */
|
521 | extern TLC5947Driver moduleLldLedPwm;
|
||
522 | |||
523 | f606f432 | Thomas Schöpping | #if (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10) || defined(__DOXYGEN__)
|
524 | |||
525 | #include <alld_DW1000.h> |
||
526 | |||
527 | 0b989911 | Cung Sang | /**
|
528 | f606f432 | Thomas Schöpping | * @brief Alias for the DW1000 driver object.
|
529 | * @note The dw1000 struct is defined as external variable (singleton) by the
|
||
530 | * driver, since the Decawave software stacks assumes no more than a
|
||
531 | * single device in a system.
|
||
532 | 0b989911 | Cung Sang | */
|
533 | f606f432 | Thomas Schöpping | #define moduleLldDw1000 dw1000
|
534 | |||
535 | #endif /* (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10) */ |
||
536 | 0b989911 | Cung Sang | |
537 | 9ae7c4f3 | Thomas Schöpping | /** @} */
|
538 | |||
539 | /*===========================================================================*/
|
||
540 | /**
|
||
541 | 4c72a54c | Thomas Schöpping | * @name Tests
|
542 | 9ae7c4f3 | Thomas Schöpping | * @{
|
543 | */
|
||
544 | /*===========================================================================*/
|
||
545 | #if (AMIROOS_CFG_TESTS_ENABLE == true) || defined(__DOXYGEN__) |
||
546 | |||
547 | /**
|
||
548 | 4c72a54c | Thomas Schöpping | * @brief AT24C01BN-SH-B (EEPROM) test command.
|
549 | 9ae7c4f3 | Thomas Schöpping | */
|
550 | 4c72a54c | Thomas Schöpping | extern aos_shellcommand_t moduleTestAt24c01bShellCmd;
|
551 | 9ae7c4f3 | Thomas Schöpping | |
552 | /**
|
||
553 | 4c72a54c | Thomas Schöpping | * @brief INA219 (power monitor) test command.
|
554 | ee884101 | Thomas Schöpping | */
|
555 | 4c72a54c | Thomas Schöpping | extern aos_shellcommand_t moduleTestIna219ShellCmd;
|
556 | ee884101 | Thomas Schöpping | |
557 | /**
|
||
558 | 4c72a54c | Thomas Schöpping | * @brief Status LED test command.
|
559 | ee884101 | Thomas Schöpping | */
|
560 | 4c72a54c | Thomas Schöpping | extern aos_shellcommand_t moduleTestLedShellCmd;
|
561 | |||
562 | /**
|
||
563 | * @brief MIC9404x (power switch) test command.
|
||
564 | */
|
||
565 | extern aos_shellcommand_t moduleTestMic9404xShellCmd;
|
||
566 | |||
567 | // TODO: add SNx5C3221E
|
||
568 | ee884101 | Thomas Schöpping | |
569 | /**
|
||
570 | 4c72a54c | Thomas Schöpping | * @brief TLC5947 (24 channel PWM LED driver) test command.
|
571 | ee884101 | Thomas Schöpping | */
|
572 | 4c72a54c | Thomas Schöpping | extern aos_shellcommand_t moduleTestTlc5947ShellCmd;
|
573 | ee884101 | Thomas Schöpping | |
574 | /**
|
||
575 | 4c72a54c | Thomas Schöpping | * @brief Entire module test command.
|
576 | 9ae7c4f3 | Thomas Schöpping | */
|
577 | 4c72a54c | Thomas Schöpping | extern aos_shellcommand_t moduleTestAllShellCmd;
|
578 | 9ae7c4f3 | Thomas Schöpping | |
579 | 0b989911 | Cung Sang | |
580 | f606f432 | Thomas Schöpping | #if (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10) || defined(__DOXYGEN__)
|
581 | |||
582 | 0b989911 | Cung Sang | /**
|
583 | * @brief DW1000 (UWB transmitter) test command.
|
||
584 | */
|
||
585 | extern aos_shellcommand_t moduleTestDw1000ShellCmd;
|
||
586 | f606f432 | Thomas Schöpping | |
587 | #endif /* (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10) */ |
||
588 | 0b989911 | Cung Sang | |
589 | 9ae7c4f3 | Thomas Schöpping | #endif /* (AMIROOS_CFG_TESTS_ENABLE == true) */ |
590 | |||
591 | /** @} */
|
||
592 | |||
593 | #endif /* AMIROOS_MODULE_H */ |
||
594 | |||
595 | /** @} */ |