Statistics
| Branch: | Tag: | Revision:

amiro-os / modules / PowerManagement_1-1 / module.h @ 6ff06bbf

History | View | Annotate | Download (30.8 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 channeö 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   CHARG_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_IOEVENTFLAGS_IRINT1           AOS_IOEVENT_FLAG(GPIOB_IR_INT1_N)
321

    
322
/**
323
 * @brief   Event flag to be set on a GAUGE_BATLOW1 interrupt.
324
 */
325
#define MODULE_OS_IOEVENTFLAGS_GAUGEBATLOW1     AOS_IOEVENT_FLAG(GPIOC_GAUGE_BATLOW1)
326

    
327
/**
328
 * @brief   Event flag to be set on a GAUGE_BATGD1 interrupt.
329
 */
330
#define MODULE_OS_IOEVENTFLAGS_GAUGEBATGD1      AOS_IOEVENT_FLAG(GPIOC_GAUGE_BATGD1_N)
331

    
332
/**
333
 * @brief   Event flag to be set on a SYS_UART_DN interrupt.
334
 */
335
#define MODULE_OS_IOEVENTFLAGS_SYSUARTDN        AOS_IOEVENT_FLAG(GPIOB_SYS_UART_DN)
336

    
337
/**
338
 * @brief   Event flag to be set on a IR_INT2 / CHARGE_STAT2A interrupt.
339
 */
340
#define MODULE_OS_IOEVENTFLAGS_IRINT2           AOS_IOEVENT_FLAG(GPIOC_IR_INT2_N)
341

    
342
/**
343
 * @brief   Event flag to be set on a TOUCH_INT interrupt.
344
 */
345
#define MODULE_OS_IOEVENTFLAGS_TOUCHINT         AOS_IOEVENT_FLAG(GPIOC_TOUCH_INT_N)
346

    
347
/**
348
 * @brief   Event flag to be set on a GAUGE_BATLOW2 interrupt.
349
 */
350
#define MODULE_OS_IOEVENTFLAGS_GAUGEBATLOW2     AOS_IOEVENT_FLAG(GPIOB_GAUGE_BATLOW2)
351

    
352
/**
353
 * @brief   Event flag to be set on a GAUGE_BATGD2 interrupt.
354
 */
355
#define MODULE_OS_IOEVENTFLAGS_GAUGEBATGD2      AOS_IOEVENT_FLAG(GPIOB_GAUGE_BATGD2_N)
356

    
357
/**
358
 * @brief   Event flag to be set on a PATH_DC interrupt.
359
 */
360
#define MODULE_OS_IOEVENTFLAGS_PATHDC           AOS_IOEVENT_FLAG(GPIOC_PATH_DC)
361

    
362
/**
363
 * @brief   Event flag to be set on a SYS_SPI_DIR interrupt.
364
 */
365
#define MODULE_OS_IOEVENTFLAGS_SYSSPIDIR        AOS_IOEVENT_FLAG(GPIOC_SYS_SPI_DIR)
366

    
367
/**
368
 * @brief   Event flag to be set on a SYS_SYNC interrupt.
369
 */
370
#define MODULE_OS_IOEVENTFLAGS_SYSSYNC          AOS_IOEVENT_FLAG(GPIOC_SYS_INT_N)
371

    
372
/**
373
 * @brief   Event flag to be set on a SYS_PD interrupt.
374
 */
375
#define MODULE_OS_IOEVENTFLAGS_SYSPD            AOS_IOEVENT_FLAG(GPIOC_SYS_PD_N)
376

    
377
/**
378
 * @brief   Event flag to be set on a SYS_WARMRST interrupt.
379
 */
380
#define MODULE_OS_IOEVENTFLAGS_SYSWARMRST       AOS_IOEVENT_FLAG(GPIOC_SYS_WARMRST_N)
381

    
382
/**
383
 * @brief   Event flag to be set on a SYS_UART_UP interrupt.
384
 */
385
#define MODULE_OS_IOEVENTFLAGS_SYSUARTUP        AOS_IOEVENT_FLAG(GPIOB_SYS_UART_UP)
386

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

    
394
/**
395
 * @brief   Interrupt initialization macro.
396
 * @note    SSSP related interrupt signals are already initialized in 'aos_system.c'.
397
 */
398
#define MODULE_INIT_INTERRUPTS() {                                            \
399
  /* IR_INT1 */                                                               \
400
  palSetPadCallback(moduleGpioIrInt1.gpio->port, moduleGpioIrInt1.gpio->pad, _intCallback, &moduleGpioIrInt1.gpio->pad); \
401
  palEnablePadEvent(moduleGpioIrInt1.gpio->port, moduleGpioIrInt1.gpio->pad, APAL2CH_EDGE(moduleGpioIrInt1.meta.edge));  \
402
  /* GAUGE_BATLOW2 */                                                         \
403
  palSetPadCallback(moduleGpioGaugeBatLow2.gpio->port, moduleGpioGaugeBatLow2.gpio->pad, _intCallback, &moduleGpioGaugeBatLow2.gpio->pad);  \
404
  palEnablePadEvent(moduleGpioGaugeBatLow2.gpio->port, moduleGpioGaugeBatLow2.gpio->pad, APAL2CH_EDGE(moduleGpioGaugeBatLow2.meta.edge));   \
405
  /* GAUGE_BATGD2 */                                                          \
406
  palSetPadCallback(moduleGpioGaugeBatGd2.gpio->port, moduleGpioGaugeBatGd2.gpio->pad, _intCallback, &moduleGpioGaugeBatGd2.gpio->pad); \
407
  palEnablePadEvent(moduleGpioGaugeBatGd2.gpio->port, moduleGpioGaugeBatGd2.gpio->pad, APAL2CH_EDGE(moduleGpioGaugeBatGd2.meta.edge));  \
408
  /* GAUGE_BATLOW1 */                                                         \
409
  palSetPadCallback(moduleGpioGaugeBatLow1.gpio->port, moduleGpioGaugeBatLow1.gpio->pad, _intCallback, &moduleGpioGaugeBatLow1.gpio->pad);  \
410
  palEnablePadEvent(moduleGpioGaugeBatLow1.gpio->port, moduleGpioGaugeBatLow1.gpio->pad, APAL2CH_EDGE(moduleGpioGaugeBatLow1.meta.edge));   \
411
  /* GAUGE_BATGD1 */                                                          \
412
  palSetPadCallback(moduleGpioGaugeBatGd1.gpio->port, moduleGpioGaugeBatGd1.gpio->pad, _intCallback, &moduleGpioGaugeBatGd1.gpio->pad); \
413
  palEnablePadEvent(moduleGpioGaugeBatGd1.gpio->port, moduleGpioGaugeBatGd1.gpio->pad, APAL2CH_EDGE(moduleGpioGaugeBatGd1.meta.edge));  \
414
  /* IR_INT2 */                                                               \
415
  palSetPadCallback(moduleGpioIrInt2.gpio->port, moduleGpioIrInt2.gpio->pad, _intCallback, &moduleGpioIrInt2.gpio->pad); \
416
  palEnablePadEvent(moduleGpioIrInt2.gpio->port, moduleGpioIrInt2.gpio->pad, APAL2CH_EDGE(moduleGpioIrInt2.meta.edge));  \
417
  /* TOUCH_INT */                                                             \
418
  palSetPadCallback(moduleGpioTouchInt.gpio->port, moduleGpioTouchInt.gpio->pad, _intCallback, &moduleGpioTouchInt.gpio->pad); \
419
  palEnablePadEvent(moduleGpioTouchInt.gpio->port, moduleGpioTouchInt.gpio->pad, APAL2CH_EDGE(moduleGpioTouchInt.meta.edge));  \
420
  /* PATH_DC */                                                               \
421
  palSetPadCallback(moduleGpioPathDc.gpio->port, moduleGpioPathDc.gpio->pad, _intCallback, &moduleGpioPathDc.gpio->pad);  \
422
  palEnablePadEvent(moduleGpioPathDc.gpio->port, moduleGpioPathDc.gpio->pad, APAL2CH_EDGE(moduleGpioPathDc.meta.edge));   \
423
  /* SYS_SPI_DIR */                                                           \
424
  palSetPadCallback(moduleGpioSysSpiDir.gpio->port, moduleGpioSysSpiDir.gpio->pad, _intCallback, &moduleGpioSysSpiDir.gpio->pad); \
425
  palEnablePadEvent(moduleGpioSysSpiDir.gpio->port, moduleGpioSysSpiDir.gpio->pad, APAL2CH_EDGE(moduleGpioSysSpiDir.meta.edge));  \
426
  /* SYS_WARMRST */                                                           \
427
  palSetPadCallback(moduleGpioSysWarmrst.gpio->port, moduleGpioSysWarmrst.gpio->pad, _intCallback, &moduleGpioSysWarmrst.gpio->pad);  \
428
  palEnablePadEvent(moduleGpioSysWarmrst.gpio->port, moduleGpioSysWarmrst.gpio->pad, APAL2CH_EDGE(moduleGpioSysWarmrst.meta.edge));   \
429
}
430

    
431
/**
432
 * @brief   Unit test initialization hook.
433
 */
434
#define MODULE_INIT_TESTS() {                                                 \
435
  /* add unit-test shell commands */                                          \
436
  aosShellAddCommand(&aos.shell, &moduleUtAdcVsys.shellcmd);                  \
437
  aosShellAddCommand(&aos.shell, &moduleUtAlldAt24c01bn.shellcmd);            \
438
  aosShellAddCommand(&aos.shell, &moduleUtAlldBq24103a.shellcmd);             \
439
  aosShellAddCommand(&aos.shell, &moduleUtAlldBq27500.shellcmd);              \
440
  aosShellAddCommand(&aos.shell, &moduleUtAlldBq27500Bq24103a.shellcmd);      \
441
  aosShellAddCommand(&aos.shell, &moduleUtAlldIna219.shellcmd);               \
442
  aosShellAddCommand(&aos.shell, &moduleUtAlldPklcs1212e4001.shellcmd);       \
443
  aosShellAddCommand(&aos.shell, &moduleUtAlldLed.shellcmd);                  \
444
  aosShellAddCommand(&aos.shell, &moduleUtAlldTps62113.shellcmd);             \
445
  aosShellAddCommand(&aos.shell, &moduleUtAlldTps62113Ina219.shellcmd);       \
446
  MODULE_INIT_TEST_SENSORRING();                                              \
447
}
448
#if (BOARD_SENSORRING == BOARD_PROXIMITYSENSOR) || defined(__DOXYGEN__)
449
  #define MODULE_INIT_TEST_SENSORRING() {                                     \
450
    aosShellAddCommand(&aos.shell, &moduleUtAlldPca9544a.shellcmd);           \
451
    aosShellAddCommand(&aos.shell, &moduleUtAlldMpr121.shellcmd);             \
452
    aosShellAddCommand(&aos.shell, &moduleUtAlldVcnl4020.shellcmd);           \
453
  }
454
#elif (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L0X) || defined(__DOXYGEN__)
455
  #define MODULE_INIT_TEST_SENSORRING() {                                     \
456
    aosShellAddCommand(&aos.shell, &moduleUtAlldPcal6524.shellcmd);           \
457
    aosShellAddCommand(&aos.shell, &moduleUtAlldAt42qt1050.shellcmd);         \
458
  }
459
#elif (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L1X) || defined(__DOXYGEN__)
460
  #define MODULE_INIT_TEST_SENSORRING() {                                     \
461
    aosShellAddCommand(&aos.shell, &moduleUtAlldPcal6524.shellcmd);           \
462
    aosShellAddCommand(&aos.shell, &moduleUtAlldAt42qt1050.shellcmd);         \
463
  }
464
#else
465
  #define MODULE_INIT_TEST_SENSORRING()         {}
466
#endif
467

    
468
/**
469
 * @brief   Periphery communication interfaces initialization hook.
470
 */
471
#define MODULE_INIT_PERIPHERY_COMM() {                                        \
472
  MODULE_INIT_PERIPHERY_COMM_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 = (AT24C01BN_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed) ? AT24C01BN_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 / PKLCS1212E4001_LLD_FREQUENCY_SPEC; \
492
  pwmStart(&MODULE_HAL_PWM_BUZZER, &moduleHalPwmBuzzerConfig);                \
493
}
494
#if (BOARD_SENSORRING == BOARD_PROXIMITYSENSOR) || defined(__DOXYGEN__)
495
  #define MODULE_INIT_PERIPHERY_COMM_SENSORRING() {                           \
496
    moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed = (PCA9544A_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed) ? PCA9544A_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed;  \
497
    moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed = (VCNL4020_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed) ? VCNL4020_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed;  \
498
    moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed = (PCA9544A_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed) ? PCA9544A_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed; \
499
    moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed = (VCNL4020_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed) ? VCNL4020_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed; \
500
    moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed = (MPR121_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed) ? MPR121_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed; \
501
  }
502
#elif (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L0X) || defined(__DOXYGEN__)
503
  #define MODULE_INIT_PERIPHERY_COMM_SENSORRING() {                           \
504
    moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed = (PCAL6524_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed) ? PCAL6524_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed;  \
505
    moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed = (PCAL6524_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed) ? PCAL6524_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed;  \
506
    moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed = (AT42QT1050_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed) ? AT42QT1050_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed;  \
507
  }
508
#elif (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L1X) || defined(__DOXYGEN__)
509
  #define MODULE_INIT_PERIPHERY_COMM_SENSORRING() {                           \
510
    moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed = (PCAL6524_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed) ? PCAL6524_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm18Pm33GaugeRearConfig.clock_speed;  \
511
    moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed = (PCAL6524_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed) ? PCAL6524_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed;  \
512
    moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed = (AT42QT1050_LLD_I2C_MAXFREQUENCY < moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed) ? AT42QT1050_LLD_I2C_MAXFREQUENCY : moduleHalI2cSrPm42Pm50PmVddEepromGaugeFrontConfig.clock_speed;  \
513
  }
514
#else
515
  #define MODULE_INIT_PERIPHERY_COMM_SENSORRING() {}
516
#endif
517

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

    
532
/** @} */
533

    
534
/*===========================================================================*/
535
/**
536
 * @name Startup Shutdown Synchronization Protocol (SSSP)
537
 * @{
538
 */
539
/*===========================================================================*/
540

    
541
/**
542
 * @brief   PD signal GPIO.
543
 */
544
#define moduleSsspGpioPd                        moduleGpioSysPd
545

    
546
/**
547
 * @brief   SYNC signal GPIO.
548
 */
549
#define moduleSsspGpioSync                       moduleGpioSysSync
550

    
551
/**
552
 * @brief   DN signal GPIO.
553
 */
554
#define moduleSsspGpioDn                        moduleGpioSysUartDn
555

    
556
/**
557
 * @brief   UP signal GPIO.
558
 */
559
#define moduleSsspGpioUp                        moduleGpioSysUartUp
560

    
561
/**
562
 * @brief   Event flags for PD signal events.
563
 */
564
#define MODULE_SSSP_EVENTFLAGS_PD               MODULE_OS_IOEVENTFLAGS_SYSPD
565

    
566
/**
567
 * @brief   Event flags for SYNC signal events.
568
 */
569
#define MODULE_SSSP_EVENTFLAGS_SYNC             MODULE_OS_IOEVENTFLAGS_SYSSYNC
570

    
571
/**
572
 * @brief   Event flags for UP signal events.
573
 */
574
#define MODULE_SSSP_EVENTFLAGS_UP               MODULE_OS_IOEVENTFLAGS_SYSUARTUP
575

    
576
/**
577
 * @brief   Event flags for DN signal events.
578
 */
579
#define MODULE_SSSP_EVENTFLAGS_DN               MODULE_OS_IOEVENTFLAGS_SYSUARTDN
580

    
581
/** @} */
582

    
583
/*===========================================================================*/
584
/**
585
 * @name Low-level drivers
586
 * @{
587
 */
588
/*===========================================================================*/
589
#include <alld_at24c01bn-sh-b.h>
590
#include <alld_bq24103a.h>
591
#include <alld_bq27500.h>
592
#include <alld_ina219.h>
593
#include <alld_led.h>
594
#include <alld_pklcs1212e4001.h>
595
#include <alld_tps62113.h>
596

    
597
/**
598
 * @brief   EEPROM driver.
599
 */
600
extern AT24C01BNDriver moduleLldEeprom;
601

    
602
/**
603
 * @brief   Battery charger (front battery) driver.
604
 */
605
extern BQ24103ADriver moduleLldBatteryChargerFront;
606

    
607
/**
608
 * @brief   Battery charger (rear battery) driver.
609
 */
610
extern BQ24103ADriver moduleLldBatteryChargerRear;
611

    
612
/**
613
 * @brief   Fuel gauge (front battery) driver.
614
 */
615
extern BQ27500Driver moduleLldFuelGaugeFront;
616

    
617
/**
618
 * @brief   Fuel gauge (rear battery) driver.
619
 */
620
extern BQ27500Driver moduleLldFuelGaugeRear;
621

    
622
/**
623
 * @brief   Power monitor (VDD) driver.
624
 */
625
extern INA219Driver moduleLldPowerMonitorVdd;
626

    
627
/**
628
 * @brief   Power monitor (VIO 1.8) driver.
629
 */
630
extern INA219Driver moduleLldPowerMonitorVio18;
631

    
632
/**
633
 * @brief   Power monitor (VIO 3.3) driver.
634
 */
635
extern INA219Driver moduleLldPowerMonitorVio33;
636

    
637
/**
638
 * @brief   Power monitor (VSYS 4.2) driver.
639
 */
640
extern INA219Driver moduleLldPowerMonitorVsys42;
641

    
642
/**
643
 * @brief   Power monitor (VIO 5.0) driver.
644
 */
645
extern INA219Driver moduleLldPowerMonitorVio50;
646

    
647
/**
648
 * @brief   Status LED driver.
649
 */
650
extern LEDDriver moduleLldStatusLed;
651

    
652
/**
653
 * @brief   Step down converter driver.
654
 * @note    Although there multiple TPS62113, those are completely identical from driver few (share the same signals).
655
 */
656
extern TPS62113Driver moduleLldStepDownConverter;
657

    
658
#if (BOARD_SENSORRING == BOARD_PROXIMITYSENSOR) || defined(__DOXYGEN__)
659

    
660
#include <alld_mpr121.h>
661
#include <alld_pca9544a.h>
662
#include <alld_vcnl4020.h>
663

    
664
/**
665
 * @brief   Touch sensor driver.
666
 */
667
extern MPR121Driver moduleLldTouch;
668

    
669
/**
670
 * @brief   I2C multiplexer (I2C #1) driver.
671
 */
672
extern PCA9544ADriver moduleLldI2cMultiplexer1;
673

    
674
/**
675
 * @brief   I2C multiplexer (I2C #2) driver.
676
 */
677
extern PCA9544ADriver moduleLldI2cMultiplexer2;
678

    
679
/**
680
 * @brief   Proximity sensor (I2C #1) driver.
681
 */
682
extern VCNL4020Driver moduleLldProximity1;
683

    
684
/**
685
 * @brief   Proximity sensor (I2C #2) driver.
686
 */
687
extern VCNL4020Driver moduleLldProximity2;
688

    
689
#endif /* BOARD_SENSORRING == BOARD_PROXIMITYSENSOR */
690

    
691
#if (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L0X) || defined(__DOXYGEN__)
692

    
693
#include <alld_pcal6524.h>
694
#include <alld_at42qt1050.h>
695

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

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

    
706
/**
707
 * @brief   Touch sensor driver.
708
 */
709
extern AT42QT1050Driver moduleLldTouch;
710

    
711
#endif /* BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L0X */
712

    
713
#if (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L1X) || defined(__DOXYGEN__)
714

    
715
#include <alld_pcal6524.h>
716
#include <alld_at42qt1050.h>
717

    
718
/**
719
 * @brief   GPIO extender (I2C #1) driver.
720
 */
721
extern PCAL6524Driver moduleLldGpioExtender1;
722

    
723
/**
724
 * @brief   GPIO extender (I2C #2) driver.
725
 */
726
extern PCAL6524Driver moduleLldGpioExtender2;
727

    
728
/**
729
 * @brief   Touch sensor driver.
730
 */
731
extern AT42QT1050Driver moduleLldTouch;
732

    
733
#endif /* BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L1X */
734

    
735
/** @} */
736

    
737
/*===========================================================================*/
738
/**
739
 * @name Unit tests (UT)
740
 * @{
741
 */
742
/*===========================================================================*/
743
#if (AMIROOS_CFG_TESTS_ENABLE == true) || defined(__DOXYGEN__)
744
#include <ut_lld_adc.h>
745
#include <ut_alld_at24c01bn-sh-b.h>
746
#include <ut_alld_bq24103a.h>
747
#include <ut_alld_bq27500.h>
748
#include <ut_alld_bq27500_bq24103a.h>
749
#include <ut_alld_ina219.h>
750
#include <ut_alld_led.h>
751
#include <ut_alld_pklcs1212e4001.h>
752
#include <ut_alld_tps62113.h>
753
#include <ut_alld_tps62113_ina219.h>
754

    
755
/**
756
 * @brief   ADC unit test object.
757
 */
758
extern aos_unittest_t moduleUtAdcVsys;
759

    
760
/**
761
 * @brief   AT24C01BN-SH-B (EEPROM) unit test object.
762
 */
763
extern aos_unittest_t moduleUtAlldAt24c01bn;
764

    
765
/**
766
 * @brief   BQ24103A (battery charger) unit test object.
767
 */
768
extern aos_unittest_t moduleUtAlldBq24103a;
769

    
770
/**
771
 * @brief   BQ27500 (fuel gauge) unit test object.
772
 */
773
extern aos_unittest_t moduleUtAlldBq27500;
774

    
775
/**
776
 * @brief   BQ27500 (fuela gauge) in combination with BQ24103A (battery charger) unit test object.
777
 */
778
extern aos_unittest_t moduleUtAlldBq27500Bq24103a;
779

    
780
/**
781
 * @brief   INA219 (power monitor) unit test object.
782
 */
783
extern aos_unittest_t moduleUtAlldIna219;
784

    
785
/**
786
 * @brief   Status LED unit test object.
787
 */
788
extern aos_unittest_t moduleUtAlldLed;
789

    
790
/**
791
 * @brief   PKLCS1212E4001 (buzzer) unit test object.
792
 */
793
extern aos_unittest_t moduleUtAlldPklcs1212e4001;
794

    
795
/**
796
 * @brief   TPS62113 (step-down converter) unit test object.
797
 */
798
extern aos_unittest_t moduleUtAlldTps62113;
799

    
800
/**
801
 * @brief   TPS62113 (step-sown converter) in combination with INA219 (power monitor) unit test object.
802
 */
803
extern aos_unittest_t moduleUtAlldTps62113Ina219;
804

    
805
#if (BOARD_SENSORRING == BOARD_PROXIMITYSENSOR) || defined(__DOXYGEN__)
806

    
807
#include <ut_alld_mpr121.h>
808
#include <ut_alld_pca9544a.h>
809
#include <ut_alld_vcnl4020.h>
810

    
811
/**
812
 * @brief   MPR121 (touch sensor) unit test object.
813
 */
814
extern aos_unittest_t moduleUtAlldMpr121;
815

    
816
/**
817
 * @brief   PCA9544A (I2C multiplexer) unit test object.
818
 */
819
extern aos_unittest_t moduleUtAlldPca9544a;
820

    
821
/**
822
 * @brief   VCNL4020 (proximity sensor) unit test object.
823
 */
824
extern aos_unittest_t moduleUtAlldVcnl4020;
825

    
826
#endif /* BOARD_SENSORRING == BOARD_PROXIMITYSENSOR */
827

    
828
#if (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L0X) || defined(__DOXYGEN__)
829

    
830
#include <ut_alld_pcal6524.h>
831
#include <ut_alld_at42qt1050.h>
832

    
833
/**
834
 * @brief   PCAL6524 (GPIO extender) unit test object.
835
 */
836
extern aos_unittest_t moduleUtAlldPcal6524;
837

    
838
/**
839
 * @brief   AT42QT1050 (touch sensor) unit test object.
840
 */
841
extern aos_unittest_t moduleUtAlldAt42qt1050;
842

    
843
#endif /* BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L0X */
844

    
845
#if (BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L1X) || defined(__DOXYGEN__)
846

    
847
#include <ut_alld_pcal6524.h>
848
#include <ut_alld_at42qt1050.h>
849

    
850
/**
851
 * @brief   PCAL6524 (GPIO extender) unit test object.
852
 */
853
extern aos_unittest_t moduleUtAlldPcal6524;
854

    
855
/**
856
 * @brief   AT42QT1050 (touch sensor) unit test object.
857
 */
858
extern aos_unittest_t moduleUtAlldAt42qt1050;
859

    
860
#endif /* BOARD_SENSORRING == BOARD_DISTANCESENSOR_VL53L1X */
861

    
862
#endif /* AMIROOS_CFG_TESTS_ENABLE == true */
863

    
864
/** @} */
865

    
866
#endif /* AMIROOS_MODULE_H */
867

    
868
/** @} */