amiro-os / modules / LightRing_1-2 / module.h @ 4d8d8663
History | View | Annotate | Download (13.473 KB)
1 |
/*
|
---|---|
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 |
* @brief I2C driver to access the EEPROM, power monitor and the breakout header.
|
60 |
*/
|
61 |
#define MODULE_HAL_I2C_EEPROM_PWRMTR_BREAKOUT I2CD2
|
62 |
|
63 |
/**
|
64 |
* @brief Configuration for the EEPROM, power monitor and breakout I2C driver.
|
65 |
*/
|
66 |
extern I2CConfig moduleHalI2cEepromPwrmtrBreakoutConfig;
|
67 |
|
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 |
/**
|
89 |
* @brief SPI interface driver for the breakout header.
|
90 |
*/
|
91 |
#define MODULE_HAL_SPI_BREAKOUT SPID2
|
92 |
|
93 |
/**
|
94 |
* @brief UART interface driver for the breakout header (alternative to serial).
|
95 |
*/
|
96 |
#define MODULE_HAL_UART_BREAKOUT UARTD2
|
97 |
|
98 |
/**
|
99 |
* @brief Real-Time Clock driver.
|
100 |
*/
|
101 |
#define MODULE_HAL_RTC RTCD1
|
102 |
|
103 |
/** @} */
|
104 |
|
105 |
/*===========================================================================*/
|
106 |
/**
|
107 |
* @name GPIO definitions
|
108 |
* @{
|
109 |
*/
|
110 |
/*===========================================================================*/
|
111 |
|
112 |
/**
|
113 |
* @brief LIGHT_BANK output signal GPIO.
|
114 |
*/
|
115 |
extern ROMCONST apalControlGpio_t moduleGpioLightBlank;
|
116 |
|
117 |
/**
|
118 |
* @brief RS232_R_EN_N output signal GPIO.
|
119 |
*/
|
120 |
extern ROMCONST apalControlGpio_t moduleGpioRs232En;
|
121 |
|
122 |
/**
|
123 |
* @brief SW_V33_EN output signal GPIO.
|
124 |
*/
|
125 |
extern ROMCONST apalControlGpio_t moduleGpioSwV33En;
|
126 |
|
127 |
// The 4.2V switch is disabled due to a hardware bug.
|
128 |
///**
|
129 |
// * @brief SW_V42_EN output signal GPIO.
|
130 |
// */
|
131 |
//extern ROMCONST apalControlGpio_t moduleGpioSwV42En;
|
132 |
|
133 |
/**
|
134 |
* @brief SW_V50_EN output signal GPIO.
|
135 |
*/
|
136 |
extern ROMCONST apalControlGpio_t moduleGpioSwV50En;
|
137 |
|
138 |
/**
|
139 |
* @brief IO_3 breakout signal GPIO.
|
140 |
*/
|
141 |
extern apalControlGpio_t moduleGpioBreakoutIo3;
|
142 |
|
143 |
/**
|
144 |
* @brief IO_5 breakout signal GPIO.
|
145 |
*/
|
146 |
extern apalControlGpio_t moduleGpioBreakoutIo5;
|
147 |
|
148 |
/**
|
149 |
* @brief IO_6 breakout signal GPIO.
|
150 |
*/
|
151 |
extern apalControlGpio_t moduleGpioBreakoutIo6;
|
152 |
|
153 |
/**
|
154 |
* @brief SYS_UART_DN bidirectional signal GPIO.
|
155 |
*/
|
156 |
extern ROMCONST apalControlGpio_t moduleGpioSysUartDn;
|
157 |
|
158 |
/**
|
159 |
* @brief IO_7 breakout signal GPIO.
|
160 |
*/
|
161 |
extern apalControlGpio_t moduleGpioBreakoutIo7;
|
162 |
|
163 |
/**
|
164 |
* @brief IO_8 breakout signal GPIO.
|
165 |
*/
|
166 |
extern apalControlGpio_t moduleGpioBreakoutIo8;
|
167 |
|
168 |
/**
|
169 |
* @brief IO_4 breakout signal GPIO.
|
170 |
*/
|
171 |
extern apalControlGpio_t moduleGpioBreakoutIo4;
|
172 |
|
173 |
/**
|
174 |
* @brief IO_1 breakout signal GPIO.
|
175 |
*/
|
176 |
extern apalControlGpio_t moduleGpioBreakoutIo1;
|
177 |
|
178 |
/**
|
179 |
* @brief IO_2 breakout signal GPIO.
|
180 |
*/
|
181 |
extern apalControlGpio_t moduleGpioBreakoutIo2;
|
182 |
|
183 |
/**
|
184 |
* @brief LED output signal GPIO.
|
185 |
*/
|
186 |
extern ROMCONST apalControlGpio_t moduleGpioLed;
|
187 |
|
188 |
/**
|
189 |
* @brief LIGHT_XLAT output signal.
|
190 |
*/
|
191 |
extern ROMCONST apalControlGpio_t moduleGpioLightXlat;
|
192 |
|
193 |
/**
|
194 |
* @brief SW_V18_EN output signal GPIO.
|
195 |
*/
|
196 |
extern ROMCONST apalControlGpio_t moduleGpioSwV18En;
|
197 |
|
198 |
/**
|
199 |
* @brief SW_VSYS_EN output signal GPIO.
|
200 |
*/
|
201 |
extern ROMCONST apalControlGpio_t moduleGpioSwVsysEn;
|
202 |
|
203 |
/**
|
204 |
* @brief SYS_UART_UP bidirectional signal GPIO.
|
205 |
*/
|
206 |
extern ROMCONST apalControlGpio_t moduleGpioSysUartUp;
|
207 |
|
208 |
/**
|
209 |
* @brief SYS_PD bidirectional signal GPIO.
|
210 |
*/
|
211 |
extern ROMCONST apalControlGpio_t moduleGpioSysPd;
|
212 |
|
213 |
/**
|
214 |
* @brief SYS_SYNC bidirectional signal GPIO.
|
215 |
*/
|
216 |
extern ROMCONST apalControlGpio_t moduleGpioSysSync;
|
217 |
|
218 |
/** @} */
|
219 |
|
220 |
/*===========================================================================*/
|
221 |
/**
|
222 |
* @name AMiRo-OS core configurations
|
223 |
* @{
|
224 |
*/
|
225 |
/*===========================================================================*/
|
226 |
|
227 |
/**
|
228 |
* @brief Event flag to be set on a IO_4 (breakout) interrupt.
|
229 |
*/
|
230 |
#define MODULE_OS_IOEVENTFLAGS_BREAKOUTIO4 AOS_IOEVENT_FLAG(PAL_PAD(LINE_IO_4))
|
231 |
|
232 |
/**
|
233 |
* @brief Event flag to be set on a IO_1 (breakout) interrupt.
|
234 |
*/
|
235 |
#define MODULE_OS_IOEVENTFLAGS_BREAKOUTIO1 AOS_IOEVENT_FLAG(PAL_PAD(LINE_IO_1))
|
236 |
|
237 |
/**
|
238 |
* @brief Event flag to be set on a SYS_SYNC interrupt.
|
239 |
*/
|
240 |
#define MODULE_OS_IOEVENTFLAGS_SYSSYNC AOS_IOEVENT_FLAG(PAL_PAD(LINE_SYS_INT_N))
|
241 |
|
242 |
/**
|
243 |
* @brief Event flag to be set on a IO_3 (breakout) interrupt.
|
244 |
*/
|
245 |
#define MODULE_OS_IOEVENTFLAGS_BREAKOUTIO3 AOS_IOEVENT_FLAG(PAL_PAD(LINE_IO_3))
|
246 |
|
247 |
/**
|
248 |
* @brief Event flag to be set on a IO_5 (breakout) interrupt.
|
249 |
*/
|
250 |
#define MODULE_OS_IOEVENTFLAGS_BREAKOUTIO5 AOS_IOEVENT_FLAG(PAL_PAD(LINE_IO_5))
|
251 |
|
252 |
/**
|
253 |
* @brief Event flag to be set on a IO_6 (breakout) interrupt.
|
254 |
*/
|
255 |
#define MODULE_OS_IOEVENTFLAGS_BREAKOUTIO6 AOS_IOEVENT_FLAG(PAL_PAD(LINE_IO_6))
|
256 |
|
257 |
/**
|
258 |
* @brief Event flag to be set on a SYS_UART_DN interrupt.
|
259 |
*/
|
260 |
#define MODULE_OS_IOEVENTFLAGS_SYSUARTDN AOS_IOEVENT_FLAG(PAL_PAD(LINE_SYS_UART_DN))
|
261 |
|
262 |
/**
|
263 |
* @brief Event flag to be set on a SYS_UART_UP interrupt.
|
264 |
*/
|
265 |
#define MODULE_OS_IOEVENTFLAGS_SYSUARTUP AOS_IOEVENT_FLAG(PAL_PAD(LINE_SYS_UART_UP))
|
266 |
|
267 |
/**
|
268 |
* @brief Event flag to be set on a IO_7 (breakout) interrupt.
|
269 |
*/
|
270 |
#define MODULE_OS_IOEVENTFLAGS_BREAKOUTIO7 AOS_IOEVENT_FLAG(PAL_PAD(LINE_IO_7))
|
271 |
|
272 |
/**
|
273 |
* @brief Event flag to be set on a IO_8 (breakout) interrupt.
|
274 |
*/
|
275 |
#define MODULE_OS_IOEVENTFLAGS_BREAKOUTIO8 AOS_IOEVENT_FLAG(PAL_PAD(LINE_IO_8))
|
276 |
|
277 |
/**
|
278 |
* @brief Event flag to be set on a SYS_PD interrupt.
|
279 |
*/
|
280 |
#define MODULE_OS_IOEVENTFLAGS_SYSPD AOS_IOEVENT_FLAG(PAL_PAD(LINE_SYS_PD_N))
|
281 |
|
282 |
#if (AMIROOS_CFG_SHELL_ENABLE == true) || (AMIROOS_CFG_TESTS_ENABLE == true) || defined(__DOXYGEN__) |
283 |
/**
|
284 |
* @brief Shell prompt text.
|
285 |
*/
|
286 |
extern ROMCONST char* moduleShellPrompt; |
287 |
#endif /* (AMIROOS_CFG_SHELL_ENABLE == true) || (AMIROOS_CFG_TESTS_ENABLE == true) */ |
288 |
|
289 |
/**
|
290 |
* @brief Interrupt initialization macro.
|
291 |
* @note SSSP related interrupt signals are already initialized in 'aos_system.c'.
|
292 |
*/
|
293 |
#define MODULE_INIT_INTERRUPTS() { \
|
294 |
/* breakout interrupts must be enabled explicitely */ \
|
295 |
} |
296 |
|
297 |
/**
|
298 |
* @brief Unit test initialization hook.
|
299 |
*/
|
300 |
#define MODULE_INIT_TESTS() { \
|
301 |
/* initialize tests and add to shell */ \
|
302 |
aosShellAddCommand(&aos.shell, &moduleTestAt24c01bShellCmd); \ |
303 |
aosShellAddCommand(&aos.shell, &moduleTestIna219ShellCmd); \ |
304 |
aosShellAddCommand(&aos.shell, &moduleTestLedShellCmd); \ |
305 |
aosShellAddCommand(&aos.shell, &moduleTestMic9404xShellCmd); \ |
306 |
aosShellAddCommand(&aos.shell, &moduleTestTlc5947ShellCmd); \ |
307 |
aosShellAddCommand(&aos.shell, &moduleTestAllShellCmd); \ |
308 |
} |
309 |
|
310 |
/**
|
311 |
* @brief Periphery communication interfaces initialization hook.
|
312 |
*/
|
313 |
#define MODULE_INIT_PERIPHERY_IF() { \
|
314 |
/* serial driver */ \
|
315 |
sdStart(&MODULE_HAL_PROGIF, &moduleHalProgIfConfig); \ |
316 |
/* I2C */ \
|
317 |
moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed = (AT24C01B_LLD_I2C_MAXFREQUENCY < moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed) ? AT24C01B_LLD_I2C_MAXFREQUENCY : moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed; \ |
318 |
moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed = (INA219_LLD_I2C_MAXFREQUENCY < moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed) ? INA219_LLD_I2C_MAXFREQUENCY : moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed; \ |
319 |
moduleHalI2cEepromPwrmtrBreakoutConfig.duty_cycle = (moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed <= 100000) ? STD_DUTY_CYCLE : FAST_DUTY_CYCLE_2; \
|
320 |
i2cStart(&MODULE_HAL_I2C_EEPROM_PWRMTR_BREAKOUT, &moduleHalI2cEepromPwrmtrBreakoutConfig); \ |
321 |
/* SPI */ \
|
322 |
spiStart(&MODULE_HAL_SPI_LIGHT, &moduleHalSpiLightConfig); \ |
323 |
} |
324 |
|
325 |
/**
|
326 |
* @brief Periphery communication interface deinitialization hook.
|
327 |
*/
|
328 |
#define MODULE_SHUTDOWN_PERIPHERY_IF() { \
|
329 |
/* SPI */ \
|
330 |
spiStop(&MODULE_HAL_SPI_LIGHT); \ |
331 |
/* I2C */ \
|
332 |
i2cStop(&MODULE_HAL_I2C_EEPROM_PWRMTR_BREAKOUT); \ |
333 |
/* don't stop the serial driver so messages can still be printed */ \
|
334 |
} |
335 |
|
336 |
/** @} */
|
337 |
|
338 |
/*===========================================================================*/
|
339 |
/**
|
340 |
* @name Startup Shutdown Synchronization Protocol (SSSP)
|
341 |
* @{
|
342 |
*/
|
343 |
/*===========================================================================*/
|
344 |
|
345 |
/**
|
346 |
* @brief PD signal GPIO.
|
347 |
*/
|
348 |
#define moduleSsspGpioPd moduleGpioSysPd
|
349 |
|
350 |
/**
|
351 |
* @brief SYNC signal GPIO.
|
352 |
*/
|
353 |
#define moduleSsspGpioSync moduleGpioSysSync
|
354 |
|
355 |
/**
|
356 |
* @brief UP signal GPIO.
|
357 |
*/
|
358 |
#define moduleSsspGpioUp moduleGpioSysUartUp
|
359 |
|
360 |
/**
|
361 |
* @brief DN signal GPIO.
|
362 |
*/
|
363 |
#define moduleSsspGpioDn moduleGpioSysUartDn
|
364 |
|
365 |
/**
|
366 |
* @brief Event flags for PD signal events.
|
367 |
*/
|
368 |
#define MODULE_SSSP_EVENTFLAGS_PD MODULE_OS_IOEVENTFLAGS_SYSPD
|
369 |
|
370 |
/**
|
371 |
* @brief Event flags for SYNC signal events.
|
372 |
*/
|
373 |
#define MODULE_SSSP_EVENTFLAGS_SYNC MODULE_OS_IOEVENTFLAGS_SYSSYNC
|
374 |
|
375 |
/**
|
376 |
* @brief Event flags for UP signal events.
|
377 |
*/
|
378 |
#define MODULE_SSSP_EVENTFLAGS_UP MODULE_OS_IOEVENTFLAGS_SYSUARTUP
|
379 |
|
380 |
/**
|
381 |
* @brief Event flags for DN signal events.
|
382 |
*/
|
383 |
#define MODULE_SSSP_EVENTFLAGS_DN MODULE_OS_IOEVENTFLAGS_SYSUARTDN
|
384 |
|
385 |
/** @} */
|
386 |
|
387 |
/*===========================================================================*/
|
388 |
/**
|
389 |
* @name Low-level drivers
|
390 |
* @{
|
391 |
*/
|
392 |
/*===========================================================================*/
|
393 |
#include <alld_AT24C01B.h> |
394 |
#include <alld_INA219.h> |
395 |
#include <alld_LED.h> |
396 |
#include <alld_MIC9404x.h> |
397 |
// TODO: add SNx5C3221E
|
398 |
#include <alld_TLC5947.h> |
399 |
|
400 |
/**
|
401 |
* @brief EEPROM driver.
|
402 |
*/
|
403 |
extern AT24C01BDriver moduleLldEeprom;
|
404 |
|
405 |
/**
|
406 |
* @brief Power monitor (VLED 4.2) driver.
|
407 |
*/
|
408 |
extern INA219Driver moduleLldPowerMonitorVled;
|
409 |
|
410 |
/**
|
411 |
* @brief Status LED driver.
|
412 |
*/
|
413 |
extern LEDDriver moduleLldStatusLed;
|
414 |
|
415 |
/**
|
416 |
* @brief Power switch driver (1.8V).
|
417 |
*/
|
418 |
extern MIC9404xDriver moduleLldPowerSwitchV18;
|
419 |
|
420 |
/**
|
421 |
* @brief Power switch driver (3.3V).
|
422 |
*/
|
423 |
extern MIC9404xDriver moduleLldPowerSwitchV33;
|
424 |
|
425 |
/**
|
426 |
* @brief Power switch driver (4.2V).
|
427 |
*/
|
428 |
extern MIC9404xDriver moduleLldPowerSwitchV42;
|
429 |
|
430 |
/**
|
431 |
* @brief Power switch driver (5.0V).
|
432 |
*/
|
433 |
extern MIC9404xDriver moduleLldPowerSwitchV50;
|
434 |
|
435 |
/**
|
436 |
* @brief Pseudo power switch driver (VSYS).
|
437 |
* @details There is no actual MIC9040x device, but the swicthable circuit behaves analogous.
|
438 |
*/
|
439 |
extern MIC9404xDriver moduleLldPowerSwitchVsys;
|
440 |
|
441 |
// TODO: add SNx5C3221E
|
442 |
|
443 |
/**
|
444 |
* @brief 24 channel PWM LED driver.
|
445 |
*/
|
446 |
extern TLC5947Driver moduleLldLedPwm;
|
447 |
|
448 |
/** @} */
|
449 |
|
450 |
/*===========================================================================*/
|
451 |
/**
|
452 |
* @name Tests
|
453 |
* @{
|
454 |
*/
|
455 |
/*===========================================================================*/
|
456 |
#if (AMIROOS_CFG_TESTS_ENABLE == true) || defined(__DOXYGEN__) |
457 |
|
458 |
/**
|
459 |
* @brief AT24C01BN-SH-B (EEPROM) test command.
|
460 |
*/
|
461 |
extern aos_shellcommand_t moduleTestAt24c01bShellCmd;
|
462 |
|
463 |
/**
|
464 |
* @brief INA219 (power monitor) test command.
|
465 |
*/
|
466 |
extern aos_shellcommand_t moduleTestIna219ShellCmd;
|
467 |
|
468 |
/**
|
469 |
* @brief Status LED test command.
|
470 |
*/
|
471 |
extern aos_shellcommand_t moduleTestLedShellCmd;
|
472 |
|
473 |
/**
|
474 |
* @brief MIC9404x (power switch) test command.
|
475 |
*/
|
476 |
extern aos_shellcommand_t moduleTestMic9404xShellCmd;
|
477 |
|
478 |
// TODO: add SNx5C3221E
|
479 |
|
480 |
/**
|
481 |
* @brief TLC5947 (24 channel PWM LED driver) test command.
|
482 |
*/
|
483 |
extern aos_shellcommand_t moduleTestTlc5947ShellCmd;
|
484 |
|
485 |
/**
|
486 |
* @brief Entire module test command.
|
487 |
*/
|
488 |
extern aos_shellcommand_t moduleTestAllShellCmd;
|
489 |
|
490 |
#endif /* (AMIROOS_CFG_TESTS_ENABLE == true) */ |
491 |
|
492 |
/** @} */
|
493 |
|
494 |
#endif /* AMIROOS_MODULE_H */ |
495 |
|
496 |
/** @} */
|