Statistics
| Branch: | Tag: | Revision:

amiro-os / modules / LightRing_1-2 / module.h @ e4379628

History | View | Annotate | Download (17.083 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
#if (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10) || defined(__DOXYGEN__)
104

    
105
/**
106
 * @brief   SPI interface driver for UWB DW1000 module.
107
 */
108
#define MODULE_HAL_SPI_UWB                      MODULE_HAL_SPI_BREAKOUT
109

    
110
/**
111
 * @brief   Configuration for the high-speed SPI interface driver of DW1000 module.
112
 */
113
extern SPIConfig moduleHalSpiUwbHsConfig;
114

    
115
/**
116
 * @brief   Configuration for the low-speed SPI interface driver of DW1000 module.
117
 */
118
extern SPIConfig moduleHalSpiUwbLsConfig;
119

    
120
#endif /* (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10) */
121

    
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
// 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

    
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
 * @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
 * @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
 * @brief   IO_2 breakout signal GPIO.
199
 */
200
extern apalControlGpio_t moduleGpioBreakoutIo2;
201

    
202
/**
203
 * @brief   LED output signal GPIO.
204
 */
205
extern ROMCONST apalControlGpio_t moduleGpioLed;
206

    
207
/**
208
 * @brief   LIGHT_XLAT output signal.
209
 */
210
extern ROMCONST apalControlGpio_t moduleGpioLightXlat;
211

    
212
/**
213
 * @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
#define MODULE_OS_GPIOEVENTFLAG_BREAKOUTIO4     AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_IO_4))
250

    
251
/**
252
 * @brief   Event flag to be set on a IO_1 (breakout) interrupt.
253
 */
254
#define MODULE_OS_GPIOEVENTFLAG_BREAKOUTIO1     AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_IO_1))
255

    
256
/**
257
 * @brief   Event flag to be set on a SYS_SYNC interrupt.
258
 */
259
#define MODULE_OS_GPIOEVENTFLAG_SYSSYNC         AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_SYS_INT_N))
260

    
261
/**
262
 * @brief   Event flag to be set on a IO_3 (breakout) interrupt.
263
 */
264
#define MODULE_OS_GPIOEVENTFLAG_BREAKOUTIO3     AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_IO_3))
265

    
266
/**
267
 * @brief   Event flag to be set on a IO_5 (breakout) interrupt.
268
 */
269
#define MODULE_OS_GPIOEVENTFLAG_BREAKOUTIO5     AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_IO_5))
270

    
271
/**
272
 * @brief   Event flag to be set on a IO_6 (breakout) interrupt.
273
 */
274
#define MODULE_OS_GPIOEVENTFLAG_BREAKOUTIO6     AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_IO_6))
275

    
276
/**
277
 * @brief   Event flag to be set on a SYS_UART_DN interrupt.
278
 */
279
#define MODULE_OS_GPIOEVENTFLAG_SYSUARTDN       AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_SYS_UART_DN))
280

    
281
/**
282
 * @brief   Event flag to be set on a SYS_UART_UP interrupt.
283
 */
284
#define MODULE_OS_GPIOEVENTFLAG_SYSUARTUP       AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_SYS_UART_UP))
285

    
286
/**
287
 * @brief   Event flag to be set on a IO_7 (breakout) interrupt.
288
 */
289
#define MODULE_OS_GPIOEVENTFLAG_BREAKOUTIO7     AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_IO_7))
290

    
291
/**
292
 * @brief   Event flag to be set on a IO_8 (breakout) interrupt.
293
 */
294
#define MODULE_OS_GPIOEVENTFLAG_BREAKOUTIO8     AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_IO_8))
295

    
296
/**
297
 * @brief   Event flag to be set on a SYS_PD interrupt.
298
 */
299
#define MODULE_OS_GPIOEVENTFLAG_SYSPD           AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_SYS_PD_N))
300

    
301
#if (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10) || defined(__DOXYGEN__)
302

    
303
/**
304
 * @brief   Event flag to be set on a DW1000 interrupt.
305
 */
306
#define MODULE_OS_GPIOEVENTFLAG_DW1000          MODULE_OS_GPIOEVENTFLAGS_BREAKOUTIO8
307

    
308
#endif /* (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10) */
309

    
310
#if (AMIROOS_CFG_SHELL_ENABLE == true) || defined(__DOXYGEN__)
311
/**
312
 * @brief   Shell prompt text.
313
 */
314
extern ROMCONST char* moduleShellPrompt;
315
#endif /* (AMIROOS_CFG_SHELL_ENABLE == true) */
316

    
317
/**
318
 * @brief   Interrupt initialization macro.
319
 * @note    SSSP related interrupt signals are already initialized in 'aos_system.c'.
320
 */
321
#define MODULE_INIT_INTERRUPTS() {                                            \
322
  /* breakout interrupts must be enabled explicitely */                       \
323
  MODULE_INIT_INTERRUPTS_BREAKOUT();                                          \
324
}
325
#if (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10)
326
  #define MODULE_INIT_INTERRUPTS_BREAKOUT() {                                 \
327
    palSetLineCallback(moduleLldDw1000.gpio_exti->gpio->line, aosSysGetStdGpioCallback(), &moduleLldDw1000.gpio_exti->gpio->line);  \
328
    palEnableLineEvent(moduleLldDw1000.gpio_exti->gpio->line, APAL2CH_EDGE(moduleLldDw1000.gpio_exti->meta.edge));                  \
329
  }
330
#elif (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_NONE)
331
  #define MODULE_INIT_INTERRUPTS_BREAKOUT() {                                 \
332
  }
333
#endif
334

    
335
/**
336
 * @brief   Test initialization hook.
337
 */
338
#define MODULE_INIT_TESTS() {                                                 \
339
  /* add test commands to shell */                                            \
340
  aosShellAddCommand(&aos.shell, &moduleTestAt24c01bShellCmd);                \
341
  aosShellAddCommand(&aos.shell, &moduleTestIna219ShellCmd);                  \
342
  aosShellAddCommand(&aos.shell, &moduleTestLedShellCmd);                     \
343
  aosShellAddCommand(&aos.shell, &moduleTestMic9404xShellCmd);                \
344
  aosShellAddCommand(&aos.shell, &moduleTestTlc5947ShellCmd);                 \
345
  aosShellAddCommand(&aos.shell, &moduleTestAllShellCmd);                     \
346
  MODULE_INIT_TESTS_BREAKOUT();                                               \
347
}
348
#if (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10)
349
  #define MODULE_INIT_TESTS_BREAKOUT() {                                      \
350
    aosShellAddCommand(&aos.shell, &moduleTestDw1000ShellCmd);                \
351
  }
352
#elif (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_NONE)
353
  #define MODULE_INIT_TESTS_BREAKOUT() {                                      \
354
  }
355
#endif
356

    
357
/**
358
 * @brief   Periphery communication interfaces initialization hook.
359
 */
360
#define MODULE_INIT_PERIPHERY_IF() {                                          \
361
  /* serial driver */                                                         \
362
  sdStart(&MODULE_HAL_PROGIF, &moduleHalProgIfConfig);                        \
363
  /* I2C */                                                                   \
364
  moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed = (AT24C01B_LLD_I2C_MAXFREQUENCY < moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed) ? AT24C01B_LLD_I2C_MAXFREQUENCY : moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed; \
365
  moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed = (INA219_LLD_I2C_MAXFREQUENCY < moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed) ? INA219_LLD_I2C_MAXFREQUENCY : moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed; \
366
  moduleHalI2cEepromPwrmtrBreakoutConfig.duty_cycle = (moduleHalI2cEepromPwrmtrBreakoutConfig.clock_speed <= 100000) ? STD_DUTY_CYCLE : FAST_DUTY_CYCLE_2;  \
367
  i2cStart(&MODULE_HAL_I2C_EEPROM_PWRMTR_BREAKOUT, &moduleHalI2cEepromPwrmtrBreakoutConfig);  \
368
  /* SPI */                                                                   \
369
  spiStart(&MODULE_HAL_SPI_LIGHT, &moduleHalSpiLightConfig);                  \
370
  /* breakout module */                                                       \
371
  MODULE_INIT_PERIPHERY_COMM_BREAKOUT();                                      \
372
}
373
#if (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10)
374
  #define MODULE_INIT_PERIPHERY_COMM_BREAKOUT() {                             \
375
    spiStart(&MODULE_HAL_SPI_UWB, &moduleHalSpiUwbLsConfig);                  \
376
  }
377
#elif (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_NONE)
378
  #define MODULE_INIT_PERIPHERY_COMM_BREAKOUT() {                             \
379
  }
380
#endif
381

    
382
/**
383
 * @brief   Periphery communication interface deinitialization hook.
384
 */
385
#define MODULE_SHUTDOWN_PERIPHERY_IF() {                                      \
386
  /* breakout module */                                                       \
387
  MODULE_SHUTDOWN_PERIPHERY_COMM_BREAKOUT();                                  \
388
  /* SPI */                                                                   \
389
  spiStop(&MODULE_HAL_SPI_LIGHT);                                             \
390
  /* I2C */                                                                   \
391
  i2cStop(&MODULE_HAL_I2C_EEPROM_PWRMTR_BREAKOUT);                            \
392
  /* don't stop the serial driver so messages can still be printed */         \
393
}
394
#if (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10)
395
  #define MODULE_SHUTDOWN_PERIPHERY_COMM_BREAKOUT() {                         \
396
    /* SPI */                                                                 \
397
    spiStop(&MODULE_HAL_SPI_UWB);                                             \
398
  }
399
#elif (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_NONE)
400
  #define MODULE_SHUTDOWN_PERIPHERY_COMM_BREAKOUT() {                         \
401
  }
402
#endif
403

    
404
/** @} */
405

    
406
/*===========================================================================*/
407
/**
408
 * @name Startup Shutdown Synchronization Protocol (SSSP)
409
 * @{
410
 */
411
/*===========================================================================*/
412

    
413
/**
414
 * @brief   PD signal GPIO.
415
 */
416
#define moduleSsspGpioPD                        moduleGpioSysPd
417

    
418
/**
419
 * @brief   S signal GPIO.
420
 */
421
#define moduleSsspGpioS                         moduleGpioSysSync
422

    
423
/**
424
 * @brief   UP signal GPIO.
425
 */
426
#define moduleSsspGpioUP                        moduleGpioSysUartUp
427

    
428
/**
429
 * @brief   DN signal GPIO.
430
 */
431
#define moduleSsspGpioDN                        moduleGpioSysUartDn
432

    
433
/**
434
 * @brief   Event flag for PD signal events.
435
 */
436
#define MODULE_SSSP_EVENTFLAG_PD                MODULE_OS_GPIOEVENTFLAG_SYSPD
437

    
438
/**
439
 * @brief   Event flag for S signal events.
440
 */
441
#define MODULE_SSSP_EVENTFLAG_S                 MODULE_OS_GPIOEVENTFLAG_SYSSYNC
442

    
443
/**
444
 * @brief   Event flag for UP signal events.
445
 */
446
#define MODULE_SSSP_EVENTFLAG_UP                MODULE_OS_GPIOEVENTFLAGS_SYSUARTUP
447

    
448
/**
449
 * @brief   Event flag for DN signal events.
450
 */
451
#define MODULE_SSSP_EVENTFLAG_DN                MODULE_OS_GPIOEVENTFLAG_SYSUARTDN
452

    
453
/** @} */
454

    
455
/*===========================================================================*/
456
/**
457
 * @name Low-level drivers
458
 * @{
459
 */
460
/*===========================================================================*/
461
#include <alld_AT24C01B.h>
462
#include <alld_INA219.h>
463
#include <alld_LED.h>
464
#include <alld_MIC9404x.h>
465
// TODO: add SNx5C3221E
466
#include <alld_TLC5947.h>
467

    
468
/**
469
 * @brief   EEPROM driver.
470
 */
471
extern AT24C01BDriver moduleLldEeprom;
472

    
473
/**
474
 * @brief   Power monitor (VLED 4.2) driver.
475
 */
476
extern INA219Driver moduleLldPowerMonitorVled;
477

    
478
/**
479
 * @brief   Status LED driver.
480
 */
481
extern LEDDriver moduleLldStatusLed;
482

    
483
/**
484
 * @brief   Power switch driver (1.8V).
485
 */
486
extern MIC9404xDriver moduleLldPowerSwitchV18;
487

    
488
/**
489
 * @brief   Power switch driver (3.3V).
490
 */
491
extern MIC9404xDriver moduleLldPowerSwitchV33;
492

    
493
/**
494
 * @brief   Power switch driver (4.2V).
495
 */
496
extern MIC9404xDriver moduleLldPowerSwitchV42;
497

    
498
/**
499
 * @brief   Power switch driver (5.0V).
500
 */
501
extern MIC9404xDriver moduleLldPowerSwitchV50;
502

    
503
/**
504
 * @brief   Pseudo power switch driver (VSYS).
505
 * @details There is no actual MIC9040x device, but the swicthable circuit behaves analogous.
506
 */
507
extern MIC9404xDriver moduleLldPowerSwitchVsys;
508

    
509
// TODO: add SNx5C3221E
510

    
511
/**
512
 * @brief   24 channel PWM LED driver.
513
 */
514
extern TLC5947Driver moduleLldLedPwm;
515

    
516
#if (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10) || defined(__DOXYGEN__)
517

    
518
#include <alld_DW1000.h>
519

    
520
/**
521
 * @brief   Alias for the DW1000 driver object.
522
 * @note    The dw1000 struct is defined as external variable (singleton) by the
523
 *          driver, since the Decawave software stacks assumes no more than a
524
 *          single device in a system.
525
 */
526
#define moduleLldDw1000                         dw1000
527

    
528
#endif /* (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10) */
529

    
530
/** @} */
531

    
532
/*===========================================================================*/
533
/**
534
 * @name Tests
535
 * @{
536
 */
537
/*===========================================================================*/
538
#if (AMIROOS_CFG_TESTS_ENABLE == true) || defined(__DOXYGEN__)
539

    
540
/**
541
 * @brief   AT24C01BN-SH-B (EEPROM) test command.
542
 */
543
extern aos_shellcommand_t moduleTestAt24c01bShellCmd;
544

    
545
/**
546
 * @brief   INA219 (power monitor) test command.
547
 */
548
extern aos_shellcommand_t moduleTestIna219ShellCmd;
549

    
550
/**
551
 * @brief   Status LED test command.
552
 */
553
extern aos_shellcommand_t moduleTestLedShellCmd;
554

    
555
/**
556
 * @brief   MIC9404x (power switch) test command.
557
 */
558
extern aos_shellcommand_t moduleTestMic9404xShellCmd;
559

    
560
// TODO: add SNx5C3221E
561

    
562
/**
563
 * @brief   TLC5947 (24 channel PWM LED driver) test command.
564
 */
565
extern aos_shellcommand_t moduleTestTlc5947ShellCmd;
566

    
567
/**
568
 * @brief   Entire module test command.
569
 */
570
extern aos_shellcommand_t moduleTestAllShellCmd;
571

    
572

    
573
#if (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10) || defined(__DOXYGEN__)
574

    
575
/**
576
 * @brief   DW1000 (UWB transmitter) test command.
577
 */
578
extern aos_shellcommand_t moduleTestDw1000ShellCmd;
579

    
580
#endif /* (BOARD_BREAKOUT_MODULE == BOARD_BREAKOUT_UWBv10) */
581

    
582
#endif /* (AMIROOS_CFG_TESTS_ENABLE == true) */
583

    
584
/** @} */
585

    
586
#endif /* AMIROOS_MODULE_H */
587

    
588
/** @} */