Statistics
| Branch: | Tag: | Revision:

amiro-os / modules / PowerManagement_1-1 / module.h @ c53ef0b1

History | View | Annotate | Download (30.4 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 PowerManagement module.
22
 *
23
 * @addtogroup powermanagement_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
 * @brief Makro to store data in the core coupled memory (ccm).
41
 *        Example:
42
 *        int compute_buffer[128] CCM_RAM;
43
 *
44
 * @note The ccm is not connected to any bus system.
45
 */
46
#define CCM_RAM(...)                            __attribute__((section(".ram4"), ##__VA_ARGS__))
47

    
48
/**
49
 * @brief Makro to store data in the ethernet memory (eth).
50
 *        Example:
51
 *        int dma_buffer[128] ETH_RAM;
52
 *
53
 * @note The eth is a dedicated memory block with its own DMA controller.
54
 */
55
#define ETH_RAM(...)                            __attribute__((section(".ram2"), ##__VA_ARGS__))
56

    
57
/**
58
 * @brief Makro to store data in the backup memory (bckp).
59
 *        Example:
60
 *        int backup_buffer[128] BCKP_RAM;
61
 *
62
 * @note The eth is a dedicated memory block with its own DMA controller.
63
 */
64
#define BCKP_RAM(...)                           __attribute__((section(".ram5"), ##__VA_ARGS__))
65

    
66
/** @} */
67

    
68
/*===========================================================================*/
69
/**
70
 * @name ChibiOS/HAL configuration
71
 * @{
72
 */
73
/*===========================================================================*/
74

    
75
/**
76
 * @brief   ADC driver for reading the system voltage.
77
 */
78
#define MODULE_HAL_ADC_VSYS                     ADCD1
79

    
80
/**
81
 * @brief   Configuration for the ADC.
82
 */
83
extern ADCConversionGroup moduleHalAdcVsysConversionGroup;
84

    
85
/**
86
 * @brief   CAN driver to use.
87
 */
88
#define MODULE_HAL_CAN                          CAND1
89

    
90
/**
91
 * @brief   Configuration for the CAN driver.
92
 */
93
extern CANConfig moduleHalCanConfig;
94

    
95
/**
96
 * @brief   I2C driver to access the sensor ring, power monitors for VIO1.8 and VIO3.3, and fuel gauge (rear battery).
97
 * @details Depending on the attached sensor ring, the devices connected to this bus vary:
98
 *          ProximitySensor:
99
 *            - I2C multiplexer (PCA9544A)
100
 *            - proximity sensors (VCNL4020) #1 - #4
101
 *          DistanceSensor (VL53L0X):
102
 *            TODO
103
 *          DistanceSensor (VL53L1X):
104
 *            TODO
105
 */
106
#define MODULE_HAL_I2C_SR_PM18_PM33_GAUGEREAR   I2CD1
107

    
108
/**
109
 * @brief   Configuration for the sensor ring, power monitors for VIO1.8 and VIO3.3, and fuel gauge (rear battery) I2C driver.
110
 * @details Depending on the attached sensor ring, the devices connected to this bus vary:
111
 *          ProximitySensor:
112
 *            - I2C multiplexer (PCA9544A)
113
 *            - proximity sensors (VCNL4020) #1 - #4
114
 *          DistanceSensor (VL53L0X):
115
 *            TODO
116
 *          DistanceSensor (VL53L1X):
117
 *            TODO
118
 */
119
extern I2CConfig moduleHalI2cSrPm18Pm33GaugeRearConfig;
120

    
121
/**
122
 * @brief   I2C driver to access the sensor ring, power monitors for VSYS4.2, VIO5.0 and VDD, EEPROM, and fuel gauge (front battery).
123
 * @details Depending on the attached sensor ring, the devices connected to this bus vary:
124
 *          ProximitySensor:
125
 *            - I2C multiplexer (PCA9544A)
126
 *            - proximity sensors (VCNL4020) #1 - #4
127
 *            - touch sensor (MPR121)
128
 *          DistanceSensor (VL53L0X):
129
 *            TODO
130
 *          DistanceSensor (VL53L1X):
131
 *            TODO
132
 */
133
#define MODULE_HAL_I2C_SR_PM42_PM50_PMVDD_EEPROM_GAUGEFRONT I2CD2
134

    
135
/**
136
 * @brief   Configuration for the sensor ring, power monitors for VSYS4.2, VIO5.0 and VDD, EEPROM, and fuel gauge (front battery) I2C driver.
137
 * @details Depending on the attached sensor ring, the devices connected to this bus vary:
138
 *          ProximitySensor:
139
 *            - I2C multiplexer (PCA9544A)
140
 *            - proximity sensors (VCNL4020) #1 - #4
141
 *            - touch sensor (MPR121)
142
 *          DistanceSensor (VL53L0X):
143
 *            TODO
144
 *          DistanceSensor (VL53L1X):
145
 *            TODO
146
 */
147
extern I2CConfig moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig;
148

    
149
/**
150
 * @brief   PWM driver for the buzzer.
151
 */
152
#define MODULE_HAL_PWM_BUZZER                   PWMD3
153

    
154
/**
155
 * @brief   Configuration of the PWM driver.
156
 */
157
extern PWMConfig moduleHalPwmBuzzerConfig;
158

    
159
/**
160
 * @brief   PWM channel for the buzzer.
161
 */
162
#define MODULE_HAL_PWM_BUZZER_CHANNEL           1
163

    
164
/**
165
 * @brief   Serial driver of the programmer interface.
166
 */
167
#define MODULE_HAL_PROGIF                       SD1
168

    
169
/**
170
 * @brief   Configuration for the programmer serial interface driver.
171
 */
172
extern SerialConfig moduleHalProgIfConfig;
173

    
174
/**
175
 * @brief   Real-Time Clock driver.
176
 */
177
#define MODULE_HAL_RTC                          RTCD1
178

    
179
/** @} */
180

    
181
/*===========================================================================*/
182
/**
183
 * @name GPIO definitions
184
 * @{
185
 */
186
/*===========================================================================*/
187

    
188
/**
189
 * @brief   SYS_REG_EN output signal GPIO.
190
 */
191
extern ROMCONST apalControlGpio_t moduleGpioSysRegEn;
192

    
193
/**
194
 * @brief   IR_INT1 input signal GPIO.
195
 */
196
extern ROMCONST apalControlGpio_t moduleGpioIrInt1;
197

    
198
/**
199
 * @brief   POWER_EN output signal GPIO.
200
 */
201
extern ROMCONST apalControlGpio_t moduleGpioPowerEn;
202

    
203
/**
204
 * @brief   SYS_UART_DN bidirectional signal GPIO.
205
 */
206
extern ROMCONST apalControlGpio_t moduleGpioSysUartDn;
207

    
208
/**
209
 * @brief   CHARGE_STAT2A input signal GPIO.
210
 */
211
extern ROMCONST apalControlGpio_t moduleGpioChargeStat2A;
212

    
213
/**
214
 * @brief   GAUGE_BATLOW2 input signal GPIO.
215
 */
216
extern ROMCONST apalControlGpio_t moduleGpioGaugeBatLow2;
217

    
218
/**
219
 * @brief   GAUGE_BATGD2 input signal GPIO.
220
 */
221
extern ROMCONST apalControlGpio_t moduleGpioGaugeBatGd2;
222

    
223
/**
224
 * @brief   LED output signal GPIO.
225
 */
226
extern ROMCONST apalControlGpio_t moduleGpioLed;
227

    
228
/**
229
 * @brief   SYS_UART_UP bidirectional signal GPIO.
230
 */
231
extern ROMCONST apalControlGpio_t moduleGpioSysUartUp;
232

    
233
/**
234
 * @brief   CHARGE_STAT1A input signal GPIO.
235
 */
236
extern ROMCONST apalControlGpio_t moduleGpioChargeStat1A;
237

    
238
/**
239
 * @brief   GAUGE_BATLOW1 input signal GPIO.
240
 */
241
extern ROMCONST apalControlGpio_t moduleGpioGaugeBatLow1;
242

    
243
/**
244
 * @brief   GAUGE_BATGD1 input signal GPIO.
245
 */
246
extern ROMCONST apalControlGpio_t moduleGpioGaugeBatGd1;
247

    
248
/**
249
 * @brief   CHARGE_EN1 output signal GPIO.
250
 */
251
extern ROMCONST apalControlGpio_t moduleGpioChargeEn1;
252

    
253
/**
254
 * @brief   IR_INT2 input signal GPIO.
255
 */
256
extern ROMCONST apalControlGpio_t moduleGpioIrInt2;
257

    
258
/**
259
 * @brief   TOUCH_INT input signal GPIO.
260
 */
261
extern ROMCONST apalControlGpio_t moduleGpioTouchInt;
262

    
263
/**
264
 * @brief   SYS_DONE input signal GPIO.
265
 */
266
extern ROMCONST apalControlGpio_t moduleGpioSysDone;
267

    
268
/**
269
 * @brief   SYS_PROG output signal GPIO.
270
 */
271
extern ROMCONST apalControlGpio_t moduleGpioSysProg;
272

    
273
/**
274
 * @brief   PATH_DC input signal GPIO.
275
 */
276
extern ROMCONST apalControlGpio_t moduleGpioPathDc;
277

    
278
/**
279
 * @brief   SYS_SPI_DIR bidirectional signal GPIO.
280
 */
281
extern ROMCONST apalControlGpio_t moduleGpioSysSpiDir;
282

    
283
/**
284
 * @brief   SYS_SYNC bidirectional signal GPIO.
285
 */
286
extern ROMCONST apalControlGpio_t moduleGpioSysSync;
287

    
288
/**
289
 * @brief   SYS_PD bidirectional signal GPIO.
290
 */
291
extern ROMCONST apalControlGpio_t moduleGpioSysPd;
292

    
293
/**
294
 * @brief   SYS_WARMRST bidirectional signal GPIO.
295
 */
296
extern ROMCONST apalControlGpio_t moduleGpioSysWarmrst;
297

    
298
/**
299
 * @brief   BT_RST output signal GPIO.
300
 */
301
extern ROMCONST apalControlGpio_t moduleGpioBtRst;
302

    
303
/**
304
 * @brief   CHARGE_EN2 output signal GPIO.
305
 */
306
extern ROMCONST apalControlGpio_t moduleGpioChargeEn2;
307

    
308
/** @} */
309

    
310
/*===========================================================================*/
311
/**
312
 * @name AMiRo-OS core configurations
313
 * @{
314
 */
315
/*===========================================================================*/
316

    
317
/**
318
 * @brief   Event flag to be set on a IR_INT1 / CHARGE_STAT1A interrupt.
319
 */
320
#define MODULE_OS_GPIOEVENTFLAG_IRINT1          AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_IR_INT1_N))
321

    
322
/**
323
 * @brief   Event flag to be set on a GAUGE_BATLOW1 interrupt.
324
 */
325
#define MODULE_OS_GPIOEVENTFLAG_GAUGEBATLOW1    AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_GAUGE_BATLOW1))
326

    
327
/**
328
 * @brief   Event flag to be set on a GAUGE_BATGD1 interrupt.
329
 */
330
#define MODULE_OS_GPIOEVENTFLAG_GAUGEBATGD1     AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_GAUGE_BATGD1_N))
331

    
332
/**
333
 * @brief   Event flag to be set on a SYS_UART_DN interrupt.
334
 */
335
#define MODULE_OS_GPIOEVENTFLAG_SYSUARTDN       AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_SYS_UART_DN))
336

    
337
/**
338
 * @brief   Event flag to be set on a IR_INT2 / CHARGE_STAT2A interrupt.
339
 */
340
#define MODULE_OS_GPIOEVENTFLAG_IRINT2          AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_IR_INT2_N))
341

    
342
/**
343
 * @brief   Event flag to be set on a TOUCH_INT interrupt.
344
 */
345
#define MODULE_OS_GPIOEVENTFLAG_TOUCHINT        AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_TOUCH_INT_N))
346

    
347
/**
348
 * @brief   Event flag to be set on a GAUGE_BATLOW2 interrupt.
349
 */
350
#define MODULE_OS_GPIOEVENTFLAG_GAUGEBATLOW2    AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_GAUGE_BATLOW2))
351

    
352
/**
353
 * @brief   Event flag to be set on a GAUGE_BATGD2 interrupt.
354
 */
355
#define MODULE_OS_GPIOEVENTFLAG_GAUGEBATGD2     AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_GAUGE_BATGD2_N))
356

    
357
/**
358
 * @brief   Event flag to be set on a PATH_DC interrupt.
359
 */
360
#define MODULE_OS_GPIOEVENTFLAG_PATHDC          AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_PATH_DC))
361

    
362
/**
363
 * @brief   Event flag to be set on a SYS_SPI_DIR interrupt.
364
 */
365
#define MODULE_OS_GPIOEVENTFLAG_SYSSPIDIR       AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_SYS_SPI_DIR))
366

    
367
/**
368
 * @brief   Event flag to be set on a SYS_SYNC interrupt.
369
 */
370
#define MODULE_OS_GPIOEVENTFLAG_SYSSYNC         AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_SYS_INT_N))
371

    
372
/**
373
 * @brief   Event flag to be set on a SYS_PD interrupt.
374
 */
375
#define MODULE_OS_GPIOEVENTFLAG_SYSPD           AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_SYS_PD_N))
376

    
377
/**
378
 * @brief   Event flag to be set on a SYS_WARMRST interrupt.
379
 */
380
#define MODULE_OS_GPIOEVENTFLAG_SYSWARMRST      AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_SYS_WARMRST_N))
381

    
382
/**
383
 * @brief   Event flag to be set on a SYS_UART_UP interrupt.
384
 */
385
#define MODULE_OS_GPIOEVENTFLAG_SYSUARTUP       AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_SYS_UART_UP))
386

    
387
#if (AMIROOS_CFG_SHELL_ENABLE == true) || defined(__DOXYGEN__)
388
/**
389
 * @brief   Shell prompt text.
390
 */
391
extern ROMCONST char* moduleShellPrompt;
392
#endif /* (AMIROOS_CFG_SHELL_ENABLE == true) */
393

    
394
/**
395
 * @brief   Interrupt initialization macro.
396
 */
397
#define MODULE_INIT_INTERRUPTS() {                                            \
398
  /* IR_INT1 */                                                               \
399
  palSetLineCallback(moduleGpioIrInt1.gpio->line, aosSysGetStdGpioCallback(), &moduleGpioIrInt1.gpio->line);  \
400
  palEnableLineEvent(moduleGpioIrInt1.gpio->line, APAL2CH_EDGE(moduleGpioIrInt1.meta.edge));                  \
401
  /* GAUGE_BATLOW2 */                                                         \
402
  palSetLineCallback(moduleGpioGaugeBatLow2.gpio->line, aosSysGetStdGpioCallback(), &moduleGpioGaugeBatLow2.gpio->line);  \
403
  palEnableLineEvent(moduleGpioGaugeBatLow2.gpio->line, APAL2CH_EDGE(moduleGpioGaugeBatLow2.meta.edge));                  \
404
  /* GAUGE_BATGD2 */                                                          \
405
  palSetLineCallback(moduleGpioGaugeBatGd2.gpio->line, aosSysGetStdGpioCallback(), &moduleGpioGaugeBatGd2.gpio->line);  \
406
  palEnableLineEvent(moduleGpioGaugeBatGd2.gpio->line, APAL2CH_EDGE(moduleGpioGaugeBatGd2.meta.edge));                  \
407
  /* GAUGE_BATLOW1 */                                                         \
408
  palSetLineCallback(moduleGpioGaugeBatLow1.gpio->line, aosSysGetStdGpioCallback(), &moduleGpioGaugeBatLow1.gpio->line);  \
409
  palEnableLineEvent(moduleGpioGaugeBatLow1.gpio->line, APAL2CH_EDGE(moduleGpioGaugeBatLow1.meta.edge));                  \
410
  /* GAUGE_BATGD1 */                                                          \
411
  palSetLineCallback(moduleGpioGaugeBatGd1.gpio->line, aosSysGetStdGpioCallback(), &moduleGpioGaugeBatGd1.gpio->line);  \
412
  palEnableLineEvent(moduleGpioGaugeBatGd1.gpio->line, APAL2CH_EDGE(moduleGpioGaugeBatGd1.meta.edge));                  \
413
  /* IR_INT2 */                                                               \
414
  palSetLineCallback(moduleGpioIrInt2.gpio->line, aosSysGetStdGpioCallback(), &moduleGpioIrInt2.gpio->line);  \
415
  palEnableLineEvent(moduleGpioIrInt2.gpio->line, APAL2CH_EDGE(moduleGpioIrInt2.meta.edge));                  \
416
  /* TOUCH_INT */                                                             \
417
  palSetLineCallback(moduleGpioTouchInt.gpio->line, aosSysGetStdGpioCallback(), &moduleGpioTouchInt.gpio->line);  \
418
  palEnableLineEvent(moduleGpioTouchInt.gpio->line, APAL2CH_EDGE(moduleGpioTouchInt.meta.edge));                  \
419
  /* PATH_DC */                                                               \
420
  palSetLineCallback(moduleGpioPathDc.gpio->line, aosSysGetStdGpioCallback(), &moduleGpioPathDc.gpio->line);  \
421
  palEnableLineEvent(moduleGpioPathDc.gpio->line, APAL2CH_EDGE(moduleGpioPathDc.meta.edge));                  \
422
  /* SYS_SPI_DIR */                                                           \
423
  palSetLineCallback(moduleGpioSysSpiDir.gpio->line, aosSysGetStdGpioCallback(), &moduleGpioSysSpiDir.gpio->line);  \
424
  palEnableLineEvent(moduleGpioSysSpiDir.gpio->line, APAL2CH_EDGE(moduleGpioSysSpiDir.meta.edge));                  \
425
  /* SYS_WARMRST */                                                           \
426
  palSetLineCallback(moduleGpioSysWarmrst.gpio->line, aosSysGetStdGpioCallback(), &moduleGpioSysWarmrst.gpio->line);  \
427
  palEnableLineEvent(moduleGpioSysWarmrst.gpio->line, APAL2CH_EDGE(moduleGpioSysWarmrst.meta.edge));                  \
428
}
429

    
430
/**
431
 * @brief   Test initialization hook.
432
 */
433
#define MODULE_INIT_TESTS() {                                                 \
434
  /* add test commands to shell */                                            \
435
  aosShellAddCommand(&aos.shell, &moduleTestAdcShellCmd);                     \
436
  aosShellAddCommand(&aos.shell, &moduleTestAt24c01bShellCmd);                \
437
  aosShellAddCommand(&aos.shell, &moduleTestBq241xxShellCmd);                 \
438
  aosShellAddCommand(&aos.shell, &moduleTestBq27500ShellCmd);                 \
439
  aosShellAddCommand(&aos.shell, &moduleTestBq27500Bq241xxShellCmd);          \
440
  aosShellAddCommand(&aos.shell, &moduleTestIna219ShellCmd);                  \
441
  aosShellAddCommand(&aos.shell, &moduleTestLedShellCmd);                     \
442
  aosShellAddCommand(&aos.shell, &moduleTestPkxxxexxxShellCmd);               \
443
  aosShellAddCommand(&aos.shell, &moduleTestTps6211xShellCmd);                \
444
  aosShellAddCommand(&aos.shell, &moduleTestTps6211xIna219ShellCmd);          \
445
  MODULE_INIT_TEST_SENSORRING();                                              \
446
  aosShellAddCommand(&aos.shell, &moduleTestAllShellCmd);                     \
447
}
448
#if (BOARD_SENSORRING == BOARD_PROXIMITYSENSOR) || defined(__DOXYGEN__)
449
  #define MODULE_INIT_TEST_SENSORRING() {                                     \
450
    aosShellAddCommand(&aos.shell, &moduleTestPca9544aShellCmd);              \
451
    aosShellAddCommand(&aos.shell, &moduleTestMpr121ShellCmd);                \
452
    aosShellAddCommand(&aos.shell, &moduleTestVcnl4020ShellCmd);              \
453
  }
454
#elif (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L0X) || defined(__DOXYGEN__)
455
  #define MODULE_INIT_TEST_SENSORRING() {                                     \
456
    aosShellAddCommand(&aos.shell, &moduleTestPcal6524ShellCmd);              \
457
    aosShellAddCommand(&aos.shell, &moduleTestAt42qt1050ShellCmd);            \
458
  }
459
#elif (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L1X) || defined(__DOXYGEN__)
460
  #define MODULE_INIT_TEST_SENSORRING() {                                     \
461
    aosShellAddCommand(&aos.shell, &moduleTestPcal6524ShellCmd);              \
462
    aosShellAddCommand(&aos.shell, &moduleTestAt42qt1050ShellCmd);            \
463
  }
464
#else /* (BOARD_SENSORRING == ?) */
465
  #define MODULE_INIT_TEST_SENSORRING()         {}
466
#endif /* (BOARD_SENSORRING == ?) */
467

    
468
/**
469
 * @brief   Periphery communication interfaces initialization hook.
470
 */
471
#define MODULE_INIT_PERIPHERY_IF() {                                          \
472
  MODULE_INIT_PERIPHERY_IF_SENSORRING();                                      \
473
  /* serial driver */                                                         \
474
  sdStart(&MODULE_HAL_PROGIF, &moduleHalProgIfConfig);                        \
475
  /* I2C */                                                                   \
476
  moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed = (INA219_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed) ? INA219_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed;  \
477
  moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed = (BQ27500_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed) ? BQ27500_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed;  \
478
  moduleHalI2cSrPm18Pm33GaugeRearConfig.duty_cycle = (moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed <= 100000) ? STD_DUTY_CYCLE : FAST_DUTY_CYCLE_2;  \
479
  i2cStart(&MODULE_HAL_I2C_SR_PM18_PM33_GAUGEREAR, &moduleHalI2cSrPm18Pm33GaugeRearConfig); \
480
  moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed = (INA219_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed) ? INA219_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed; \
481
  moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed = (AT24C01B_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed) ? AT24C01B_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed; \
482
  moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed = (BQ27500_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed) ? BQ27500_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed; \
483
  moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.duty_cycle = (moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed <= 100000) ? STD_DUTY_CYCLE : FAST_DUTY_CYCLE_2;  \
484
  i2cStart(&MODULE_HAL_I2C_SR_PM42_PM50_PMVDD_EEPROM_GAUGEFRONT, &moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig);  \
485
  /* ADC */                                                                   \
486
  adcStart(&MODULE_HAL_ADC_VSYS, NULL);                                       \
487
  /* PWM */                                                                   \
488
  pwmStart(&MODULE_HAL_PWM_BUZZER, &moduleHalPwmBuzzerConfig);                \
489
  moduleHalPwmBuzzerConfig.frequency = MODULE_HAL_PWM_BUZZER.clock;           \
490
  pwmStop(&MODULE_HAL_PWM_BUZZER);                                            \
491
  moduleHalPwmBuzzerConfig.period = moduleHalPwmBuzzerConfig.frequency / PKxxxExxx_LLD_FREQUENCY_SPEC; \
492
  pwmStart(&MODULE_HAL_PWM_BUZZER, &moduleHalPwmBuzzerConfig);                \
493
  /* CAN */                                                                   \
494
  canStart(&MODULE_HAL_CAN, &moduleHalCanConfig);                             \
495
}
496
#if (BOARD_SENSORRING == BOARD_PROXIMITYSENSOR) || defined(__DOXYGEN__)
497
  #define MODULE_INIT_PERIPHERY_IF_SENSORRING() {                             \
498
    moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed = (PCA9544A_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed) ? PCA9544A_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed;  \
499
    moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed = (VCNL4020_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed) ? VCNL4020_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed;  \
500
    moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed = (PCA9544A_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed) ? PCA9544A_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed; \
501
    moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed = (VCNL4020_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed) ? VCNL4020_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed; \
502
    moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed = (MPR121_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed) ? MPR121_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed; \
503
  }
504
#elif (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L0X) || defined(__DOXYGEN__)
505
  #define MODULE_INIT_PERIPHERY_IF_SENSORRING() {                             \
506
    moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed = (PCAL6524_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed) ? PCAL6524_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed;  \
507
    moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed = (PCAL6524_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed) ? PCAL6524_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed;  \
508
    moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed = (AT42QT1050_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed) ? AT42QT1050_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed;  \
509
  }
510
#elif (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L1X) || defined(__DOXYGEN__)
511
  #define MODULE_INIT_PERIPHERY_IF_SENSORRING() {                             \
512
    moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed = (PCAL6524_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed) ? PCAL6524_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed;  \
513
    moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed = (PCAL6524_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed) ? PCAL6524_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed;  \
514
    moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed = (AT42QT1050_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed) ? AT42QT1050_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed;  \
515
  }
516
#else /* (BOARD_SENSORRING == ?) */
517
  #define MODULE_INIT_PERIPHERY_IF_SENSORRING() {}
518
#endif /* (BOARD_SENSORRING == ?) */
519

    
520
/**
521
 * @brief   Periphery communication interface deinitialization hook.
522
 */
523
#define MODULE_SHUTDOWN_PERIPHERY_IF() {                                      \
524
  /* CAN */                                                                   \
525
  canStop(&MODULE_HAL_CAN);                                                   \
526
  /* PWM */                                                                   \
527
  pwmStop(&MODULE_HAL_PWM_BUZZER);                                            \
528
  /* ADC */                                                                   \
529
  adcStop(&MODULE_HAL_ADC_VSYS);                                              \
530
  /* I2C */                                                                   \
531
  i2cStop(&MODULE_HAL_I2C_SR_PM18_PM33_GAUGEREAR);                            \
532
  i2cStop(&MODULE_HAL_I2C_SR_PM42_PM50_PMVDD_EEPROM_GAUGEFRONT);              \
533
  /* don't stop the serial driver so messages can still be printed */         \
534
}
535

    
536
/** @} */
537

    
538
/*===========================================================================*/
539
/**
540
 * @name Startup Shutdown Synchronization Protocol (SSSP)
541
 * @{
542
 */
543
/*===========================================================================*/
544

    
545
#define moduleSsspSignalPD()                    (&moduleGpioSysPd)
546
#define moduleSsspEventflagPD()                 MODULE_OS_GPIOEVENTFLAG_SYSPD
547

    
548
#define moduleSsspSignalS()                     (&moduleGpioSysSync)
549
#define moduleSsspEventflagS()                  MODULE_OS_GPIOEVENTFLAG_SYSSYNC
550

    
551
#define moduleSsspSignalUP()                    (&moduleGpioSysUartUp)
552
#define moduleSsspEventflagUP()                 MODULE_OS_GPIOEVENTFLAG_SYSUARTUP
553

    
554
#define moduleSsspSignalDN()                    (&moduleGpioSysUartDn)
555
#define moduleSsspEventflagDN()                 MODULE_OS_GPIOEVENTFLAG_SYSUARTDN
556

    
557
/** @} */
558

    
559
/*===========================================================================*/
560
/**
561
 * @name Low-level drivers
562
 * @{
563
 */
564
/*===========================================================================*/
565
#include <alld_AT24C01B.h>
566
#include <alld_bq241xx.h>
567
#include <alld_bq27500.h>
568
#include <alld_INA219.h>
569
#include <alld_LED.h>
570
#include <alld_PKxxxExxx.h>
571
#include <alld_TPS6211x.h>
572

    
573
/**
574
 * @brief   EEPROM driver.
575
 */
576
extern AT24C01BDriver moduleLldEeprom;
577

    
578
/**
579
 * @brief   Battery charger (front battery) driver.
580
 */
581
extern BQ241xxDriver moduleLldBatteryChargerFront;
582

    
583
/**
584
 * @brief   Battery charger (rear battery) driver.
585
 */
586
extern BQ241xxDriver moduleLldBatteryChargerRear;
587

    
588
/**
589
 * @brief   Fuel gauge (front battery) driver.
590
 */
591
extern BQ27500Driver moduleLldFuelGaugeFront;
592

    
593
/**
594
 * @brief   Fuel gauge (rear battery) driver.
595
 */
596
extern BQ27500Driver moduleLldFuelGaugeRear;
597

    
598
/**
599
 * @brief   Power monitor (VDD) driver.
600
 */
601
extern INA219Driver moduleLldPowerMonitorVdd;
602

    
603
/**
604
 * @brief   Power monitor (VIO 1.8) driver.
605
 */
606
extern INA219Driver moduleLldPowerMonitorVio18;
607

    
608
/**
609
 * @brief   Power monitor (VIO 3.3) driver.
610
 */
611
extern INA219Driver moduleLldPowerMonitorVio33;
612

    
613
/**
614
 * @brief   Power monitor (VSYS 4.2) driver.
615
 */
616
extern INA219Driver moduleLldPowerMonitorVsys42;
617

    
618
/**
619
 * @brief   Power monitor (VIO 5.0) driver.
620
 */
621
extern INA219Driver moduleLldPowerMonitorVio50;
622

    
623
/**
624
 * @brief   Status LED driver.
625
 */
626
extern LEDDriver moduleLldStatusLed;
627

    
628
/**
629
 * @brief   Step down converter driver.
630
 * @note    Although there multiple TPS6211x, those are completely identical from driver few (share the same signals).
631
 */
632
extern TPS6211xDriver moduleLldStepDownConverter;
633

    
634
#if (BOARD_SENSORRING == BOARD_PROXIMITYSENSOR) || defined(__DOXYGEN__)
635

    
636
#include <alld_MPR121.h>
637
#include <alld_PCA9544A.h>
638
#include <alld_VCNL4020.h>
639

    
640
/**
641
 * @brief   Touch sensor driver.
642
 */
643
extern MPR121Driver moduleLldTouch;
644

    
645
/**
646
 * @brief   I2C multiplexer (I2C #1) driver.
647
 */
648
extern PCA9544ADriver moduleLldI2cMultiplexer1;
649

    
650
/**
651
 * @brief   I2C multiplexer (I2C #2) driver.
652
 */
653
extern PCA9544ADriver moduleLldI2cMultiplexer2;
654

    
655
/**
656
 * @brief   Proximity sensor (I2C #1) driver.
657
 */
658
extern VCNL4020Driver moduleLldProximity1;
659

    
660
/**
661
 * @brief   Proximity sensor (I2C #2) driver.
662
 */
663
extern VCNL4020Driver moduleLldProximity2;
664

    
665
#endif /* (BOARD_SENSORRING == BOARD_PROXIMITYSENSOR) */
666

    
667
#if (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L0X) || defined(__DOXYGEN__)
668

    
669
#include <alld_PCAL6524.h>
670
#include <alld_AT42QT1050.h>
671

    
672
/**
673
 * @brief   GPIO extender (I2C #1) driver.
674
 */
675
extern PCAL6524Driver moduleLldGpioExtender1;
676

    
677
/**
678
 * @brief   GPIO extender (I2C #2) driver.
679
 */
680
extern PCAL6524Driver moduleLldGpioExtender2;
681

    
682
/**
683
 * @brief   Touch sensor driver.
684
 */
685
extern AT42QT1050Driver moduleLldTouch;
686

    
687
#endif /* (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L0X) */
688

    
689
#if (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L1X) || defined(__DOXYGEN__)
690

    
691
#include <alld_PCAL6524.h>
692
#include <alld_AT42QT1050.h>
693

    
694
/**
695
 * @brief   GPIO extender (I2C #1) driver.
696
 */
697
extern PCAL6524Driver moduleLldGpioExtender1;
698

    
699
/**
700
 * @brief   GPIO extender (I2C #2) driver.
701
 */
702
extern PCAL6524Driver moduleLldGpioExtender2;
703

    
704
/**
705
 * @brief   Touch sensor driver.
706
 */
707
extern AT42QT1050Driver moduleLldTouch;
708

    
709
#endif /* (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L1X) */
710

    
711
/** @} */
712

    
713
/*===========================================================================*/
714
/**
715
 * @name Tests
716
 * @{
717
 */
718
/*===========================================================================*/
719
#if (AMIROOS_CFG_TESTS_ENABLE == true) || defined(__DOXYGEN__)
720

    
721
/**
722
 * @brief   ADC test command.
723
 */
724
extern aos_shellcommand_t moduleTestAdcShellCmd;
725

    
726
/**
727
 * @brief   AT24C01BN-SH-B (EEPROM) test command.
728
 */
729
extern aos_shellcommand_t moduleTestAt24c01bShellCmd;
730

    
731
/**
732
 * @brief   bq24103a (battery charger) test command.
733
 */
734
extern aos_shellcommand_t moduleTestBq241xxShellCmd;
735

    
736
/**
737
 * @brief   bq27500 (fuel gauge) test command.
738
 */
739
extern aos_shellcommand_t moduleTestBq27500ShellCmd;
740

    
741
/**
742
 * @brief   bq27500 (fuel gauge) in combination with bq24103a (battery charger) test command.
743
 */
744
extern aos_shellcommand_t moduleTestBq27500Bq241xxShellCmd;
745

    
746
/**
747
 * @brief   INA219 (power monitor) test command.
748
 */
749
extern aos_shellcommand_t moduleTestIna219ShellCmd;
750

    
751
/**
752
 * @brief   Status LED test command.
753
 */
754
extern aos_shellcommand_t moduleTestLedShellCmd;
755

    
756
/**
757
 * @brief   PKLCS1212E4001 (buzzer) test command.
758
 */
759
extern aos_shellcommand_t moduleTestPkxxxexxxShellCmd;
760

    
761
/**
762
 * @brief   TPS62113 (step-down converter) test command.
763
 */
764
extern aos_shellcommand_t moduleTestTps6211xShellCmd;
765

    
766
/**
767
 * @brief   TPS62113 (step-sown converter) in combination with INA219 (power monitor) test command.
768
 */
769
extern aos_shellcommand_t moduleTestTps6211xIna219ShellCmd;
770

    
771
#if (BOARD_SENSORRING == BOARD_PROXIMITYSENSOR) || defined(__DOXYGEN__)
772

    
773
/**
774
 * @brief   MPR121 (touch sensor) test command.
775
 */
776
extern aos_shellcommand_t moduleTestMpr121ShellCmd;
777

    
778
/**
779
 * @brief   PCA9544A (I2C multiplexer) test command.
780
 */
781
extern aos_shellcommand_t moduleTestPca9544aShellCmd;
782

    
783
/**
784
 * @brief   VCNL4020 (proximity sensor) test command.
785
 */
786
extern aos_shellcommand_t moduleTestVcnl4020ShellCmd;
787

    
788
#endif /* (BOARD_SENSORRING == BOARD_PROXIMITYSENSOR) */
789

    
790
#if (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L0X) || defined(__DOXYGEN__)
791

    
792
/**
793
 * @brief   PCAL6524 (GPIO extender) test command.
794
 */
795
extern aos_shellcommand_t moduleTestPcal6524ShellCmd;
796

    
797
/**
798
 * @brief   AT42QT1050 (touch sensor) test command.
799
 */
800
extern aos_shellcommand_t moduleTestAt42qt1050ShellCmd;
801

    
802
#endif /* (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L0X) */
803

    
804
#if (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L1X) || defined(__DOXYGEN__)
805

    
806
/**
807
 * @brief   PCAL6524 (GPIO extender) test command.
808
 */
809
extern aos_shellcommand_t moduleTestPcal6524ShellCmd;
810

    
811
/**
812
 * @brief   AT42QT1050 (touch sensor) test command.
813
 */
814
extern aos_shellcommand_t moduleTestAt42qt1050ShellCmd;
815

    
816
#endif /* (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L1X) */
817

    
818
/**
819
 * @brief   Entire module test command.
820
 */
821
extern aos_shellcommand_t moduleTestAllShellCmd;
822

    
823
#endif /* (AMIROOS_CFG_TESTS_ENABLE == true) */
824

    
825
/** @} */
826

    
827
#endif /* AMIROOS_MODULE_H */
828

    
829
/** @} */