Statistics
| Branch: | Tag: | Revision:

amiro-os / modules / NUCLEO-L476RG / module.h @ 1a8fb642

History | View | Annotate | Download (9.76 KB)

1 27d0378b Simon Welzel
/*
2
AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform.
3 8543d0d9 Thomas Schöpping
Copyright (C) 2016..2019  Thomas Schöpping et al.
4 27d0378b Simon Welzel

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 126ace3c Thomas Schöpping
 * @brief   Structures and constant for the NUCLEO-L476RG module.
22 27d0378b Simon Welzel
 *
23 126ace3c Thomas Schöpping
 * @addtogroup NUCLEO-L476RG_module
24 27d0378b Simon Welzel
 * @{
25
 */
26
27 6ff06bbf Thomas Schöpping
#ifndef AMIROOS_MODULE_H
28
#define AMIROOS_MODULE_H
29 27d0378b Simon Welzel
30 8543d0d9 Thomas Schöpping
#include <amiroos.h>
31
32 27d0378b Simon Welzel
/*===========================================================================*/
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 8543d0d9 Thomas Schöpping
 * @brief   Serial driver of the programmer interface.
50 27d0378b Simon Welzel
 */
51 8543d0d9 Thomas Schöpping
#define MODULE_HAL_PROGIF                       SD2
52 27d0378b Simon Welzel
53
/**
54 8543d0d9 Thomas Schöpping
 * @brief   Configuration for the programmer serial interface driver.
55 27d0378b Simon Welzel
 */
56 8543d0d9 Thomas Schöpping
extern SerialConfig moduleHalProgIfConfig;
57 27d0378b Simon Welzel
58
/**
59
 * @brief   Real-Time Clock driver.
60
 */
61
#define MODULE_HAL_RTC                          RTCD1
62
63 4c72a54c Thomas Schöpping
#if (BOARD_MPU6050_CONNECTED == true) || defined(__DOXYGEN__)
64 126ace3c Thomas Schöpping
65
/**
66
 * @brief   I2C driver to access multiplexer, proximity sensors 5 to 8, power monitors for VSYS4.2, VIO 5.0 and VDD, EEPROM, touch sensor, and fuel gauge (front battery).
67
 */
68
#define MODULE_HAL_I2C3                         I2CD3
69
70
/**
71
 * @brief   Configuration for the I2C driver #3.
72
 */
73
extern I2CConfig moduleHalI2c3Config;
74
75 4c72a54c Thomas Schöpping
#endif /* (BOARD_MPU6050_CONNECTED == true) */
76 126ace3c Thomas Schöpping
77 27d0378b Simon Welzel
/** @} */
78
79
/*===========================================================================*/
80
/**
81
 * @name GPIO definitions
82
 * @{
83
 */
84
/*===========================================================================*/
85
86
/**
87
 * @brief   LED output signal GPIO.
88
 */
89
extern ROMCONST apalControlGpio_t moduleGpioLed;
90
91
/**
92 8543d0d9 Thomas Schöpping
 * @brief   User button input signal.
93 27d0378b Simon Welzel
 */
94 8543d0d9 Thomas Schöpping
extern ROMCONST apalControlGpio_t moduleGpioUserButton;
95 27d0378b Simon Welzel
96 8543d0d9 Thomas Schöpping
/** @} */
97 27d0378b Simon Welzel
98 8543d0d9 Thomas Schöpping
/*===========================================================================*/
99 27d0378b Simon Welzel
/**
100 8543d0d9 Thomas Schöpping
 * @name AMiRo-OS core configurations
101
 * @{
102 27d0378b Simon Welzel
 */
103 8543d0d9 Thomas Schöpping
/*===========================================================================*/
104 27d0378b Simon Welzel
105
/**
106 8543d0d9 Thomas Schöpping
 * @brief   Event flag to be set on a USER_BUTTON interrupt.
107 27d0378b Simon Welzel
 */
108 1a8fb642 Thomas Schöpping
#define MODULE_OS_GPIOEVENTFLAG_USERBUTTON      AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_BUTTON))
109 27d0378b Simon Welzel
110 47e89ebf Thomas Schöpping
#if (AMIROOS_CFG_SHELL_ENABLE == true) || defined(__DOXYGEN__)
111 27d0378b Simon Welzel
/**
112 8543d0d9 Thomas Schöpping
 * @brief   Shell prompt text.
113 27d0378b Simon Welzel
 */
114 8543d0d9 Thomas Schöpping
extern ROMCONST char* moduleShellPrompt;
115 47e89ebf Thomas Schöpping
#endif /* (AMIROOS_CFG_SHELL_ENABLE == true) */
116 27d0378b Simon Welzel
117
/**
118 8543d0d9 Thomas Schöpping
 * @brief   Interrupt initialization macro.
119
 * @note    SSSP related interrupt signals are already initialized in 'aos_system.c'.
120 27d0378b Simon Welzel
 */
121 8543d0d9 Thomas Schöpping
#define MODULE_INIT_INTERRUPTS() {                                            \
122
  /* user button */                                                           \
123 1a8fb642 Thomas Schöpping
  palSetLineCallback(moduleGpioUserButton.gpio->line, aosSysGetStdGpioCallback(), &moduleGpioUserButton.gpio->line);  \
124 56dc4779 Thomas Schöpping
  palEnableLineEvent(moduleGpioUserButton.gpio->line, APAL2CH_EDGE(moduleGpioUserButton.meta.edge));                  \
125 8543d0d9 Thomas Schöpping
}
126 27d0378b Simon Welzel
127
/**
128 4c72a54c Thomas Schöpping
 * @brief   Test initialization hook.
129 27d0378b Simon Welzel
 */
130 8543d0d9 Thomas Schöpping
#define MODULE_INIT_TESTS() {                                                 \
131 1a8fb642 Thomas Schöpping
  /* add test commands to shell */                                            \
132 4c72a54c Thomas Schöpping
  aosShellAddCommand(&aos.shell, &moduleTestLedShellCmd);                     \
133
  aosShellAddCommand(&aos.shell, &moduleTestButtonShellCmd);                  \
134 126ace3c Thomas Schöpping
  MODULE_INIT_TEST_MPU6050();                                                 \
135 4c72a54c Thomas Schöpping
  aosShellAddCommand(&aos.shell, &moduleTestAllShellCmd);                     \
136 8543d0d9 Thomas Schöpping
}
137 4c72a54c Thomas Schöpping
#if (BOARD_MPU6050_CONNECTED == true)
138 126ace3c Thomas Schöpping
  #define MODULE_INIT_TEST_MPU6050() {                                        \
139 4c72a54c Thomas Schöpping
    aosShellAddCommand(&aos.shell, &moduleTestMpu6050ShellCmd);               \
140 126ace3c Thomas Schöpping
  }
141 4c72a54c Thomas Schöpping
#else /* (BOARD_MPU6050_CONNECTED == true) */
142 126ace3c Thomas Schöpping
  #define MODULE_INIT_TEST_MPU6050() {}
143 4c72a54c Thomas Schöpping
#endif /* (BOARD_MPU6050_CONNECTED == true) */
144 27d0378b Simon Welzel
145
/**
146 8543d0d9 Thomas Schöpping
 * @brief   Periphery communication interfaces initialization hook.
147 27d0378b Simon Welzel
 */
148 4c72a54c Thomas Schöpping
#define MODULE_INIT_PERIPHERY_IF() {                                          \
149 8543d0d9 Thomas Schöpping
  /* serial driver */                                                         \
150
  sdStart(&MODULE_HAL_PROGIF, &moduleHalProgIfConfig);                        \
151 126ace3c Thomas Schöpping
  /* MPU6050 demo */                                                          \
152 4c72a54c Thomas Schöpping
  MODULE_INIT_PERIPHERY_IF_MPU6050();                                         \
153 8543d0d9 Thomas Schöpping
}
154 4c72a54c Thomas Schöpping
#if (BOARD_MPU6050_CONNECTED == true)
155
  #define MODULE_INIT_PERIPHERY_IF_MPU6050() {                                \
156 126ace3c Thomas Schöpping
    /* maximum I2C frequency is 1MHz for this MCU */                          \
157
    uint32_t i2c3_freq = 1000000;                                             \
158
    /* find minimum amon all devices connected to this bus */                 \
159
    i2c3_freq = (MPU6050_LLD_I2C_MAXFREQUENCY < i2c3_freq) ? MPU6050_LLD_I2C_MAXFREQUENCY : i2c3_freq;  \
160
    /* calculate PRESC (prescaler):                                           \
161
     *   target is 1/(I2CXCLK * (PRESC + 1)) = 125ns                          \
162
     */                                                                       \
163
    moduleHalI2c3Config.timingr = ((uint8_t)((0.000000125f * STM32_I2C3CLK) - 1)) << I2C_TIMINGR_PRESC_Pos; \
164
    /* SCL shall be low half of the time. */                                  \
165
    moduleHalI2c3Config.timingr |= ((uint8_t)((1.f / i2c3_freq / 2 / 0.000000125f) - 1)) << I2C_TIMINGR_SCLL_Pos; \
166
    /* SCL shall be high half the time of low or slightly longer. */          \
167
    moduleHalI2c3Config.timingr |= (uint8_t)(ceilf(((moduleHalI2c3Config.timingr & I2C_TIMINGR_SCLL_Msk) >> I2C_TIMINGR_SCLL_Pos) / 2.f)) << I2C_TIMINGR_SCLH_Pos;  \
168
    /* SDA shall be delayed 1/10 of SCL low, or shorter */                    \
169
    moduleHalI2c3Config.timingr |= (uint8_t)(((moduleHalI2c3Config.timingr & I2C_TIMINGR_SCLL_Msk) >> I2C_TIMINGR_SCLL_Pos) * 0.1f) << I2C_TIMINGR_SDADEL_Pos;  \
170
    /* SCL shall be delyed twice as long as SDA, but longer than 0. */        \
171
    moduleHalI2c3Config.timingr |= ((((moduleHalI2c3Config.timingr & I2C_TIMINGR_SDADEL_Msk) >> I2C_TIMINGR_SDADEL_Pos) * 2) + 1) << I2C_TIMINGR_SCLDEL_Pos;  \
172
    /* now we can start the I2C driver */                                     \
173 97017dbb Thomas Schöpping
    chSysLock();                                                              \
174 4c72a54c Thomas Schöpping
    palSetLineMode(LINE_ARD_A4, PAL_MODE_ALTERNATE(4));                       \
175
    palSetLineMode(LINE_ARD_A5, PAL_MODE_ALTERNATE(4));                       \
176 97017dbb Thomas Schöpping
    chSysUnlock();                                                            \
177 126ace3c Thomas Schöpping
    i2cStart(&MODULE_HAL_I2C3, &moduleHalI2c3Config);                         \
178
  }
179 4c72a54c Thomas Schöpping
#else /* (BOARD_MPU6050_CONNECTED == true) */
180
  #define MODULE_INIT_PERIPHERY_IF_MPU6050() {}
181
#endif /* (BOARD_MPU6050_CONNECTED == true) */
182 27d0378b Simon Welzel
183
/**
184 8543d0d9 Thomas Schöpping
 * @brief   Periphery communication interface deinitialization hook.
185 27d0378b Simon Welzel
 */
186 4c72a54c Thomas Schöpping
#define MODULE_SHUTDOWN_PERIPHERY_IF() {                                      \
187 1a8fb642 Thomas Schöpping
  /* don't stop the serial driver so messages can still be printed */         \
188 8543d0d9 Thomas Schöpping
}
189 27d0378b Simon Welzel
190
/**
191 8543d0d9 Thomas Schöpping
 * @brief   HOOK to toggle the LEDs when the user button is pressed.
192 27d0378b Simon Welzel
 */
193 1a8fb642 Thomas Schöpping
#define MODULE_MAIN_LOOP_GPIOEVENT(eventflags) {                              \
194
  if (eventflags & MODULE_OS_GPIOEVENTFLAG_USERBUTTON) {                      \
195 4c72a54c Thomas Schöpping
    button_lld_state_t buttonstate;                                           \
196
    button_lld_get(&moduleLldUserButton, &buttonstate);                       \
197
    led_lld_set(&moduleLldLed, (buttonstate == BUTTON_LLD_STATE_PRESSED) ? LED_LLD_STATE_ON : LED_LLD_STATE_OFF); \
198 8543d0d9 Thomas Schöpping
  }                                                                           \
199
}
200 27d0378b Simon Welzel
201
/** @} */
202
203
/*===========================================================================*/
204
/**
205 8543d0d9 Thomas Schöpping
 * @name Startup Shutdown Synchronization Protocol (SSSP)
206 27d0378b Simon Welzel
 * @{
207
 */
208
/*===========================================================================*/
209
210 8543d0d9 Thomas Schöpping
/** @} */
211 27d0378b Simon Welzel
212 8543d0d9 Thomas Schöpping
/*===========================================================================*/
213 27d0378b Simon Welzel
/**
214 8543d0d9 Thomas Schöpping
 * @name Low-level drivers
215
 * @{
216 27d0378b Simon Welzel
 */
217 8543d0d9 Thomas Schöpping
/*===========================================================================*/
218 4c72a54c Thomas Schöpping
#include <alld_LED.h>
219
#include <alld_button.h>
220 27d0378b Simon Welzel
221 4c72a54c Thomas Schöpping
/**
222
 * @brief   LED driver.
223
 */
224
extern LEDDriver moduleLldLed;
225
226
/**
227
 * @brief   Button driver.
228
 */
229
extern ButtonDriver moduleLldUserButton;
230
231
#if (BOARD_MPU6050_CONNECTED == true) || defined(__DOXYGEN__)
232 126ace3c Thomas Schöpping
233
#include <alld_MPU6050.h>
234
235
/**
236
 * @brief   Accelerometer (MPU6050) driver.
237
 */
238
extern MPU6050Driver moduleLldMpu6050;
239
240 4c72a54c Thomas Schöpping
#endif /* (BOARD_MPU6050_CONNECTED == true) */
241 126ace3c Thomas Schöpping
242 8543d0d9 Thomas Schöpping
/** @} */
243 1678f270 Simon Welzel
244 8543d0d9 Thomas Schöpping
/*===========================================================================*/
245 1678f270 Simon Welzel
/**
246 4c72a54c Thomas Schöpping
 * @name Tests
247 8543d0d9 Thomas Schöpping
 * @{
248 1678f270 Simon Welzel
 */
249 8543d0d9 Thomas Schöpping
/*===========================================================================*/
250
#if (AMIROOS_CFG_TESTS_ENABLE == true) || defined(__DOXYGEN__)
251 1678f270 Simon Welzel
252 4c72a54c Thomas Schöpping
/**
253
 * @brief   LED test command.
254
 */
255
extern aos_shellcommand_t moduleTestLedShellCmd;
256
257
/**
258
 * @brief   User button test command.
259
 */
260
extern aos_shellcommand_t moduleTestButtonShellCmd;
261 126ace3c Thomas Schöpping
262 4c72a54c Thomas Schöpping
#if (BOARD_MPU6050_CONNECTED == true) || defined(__DOXYGEN__)
263 126ace3c Thomas Schöpping
264
/**
265 4c72a54c Thomas Schöpping
 * @brief   MPU6050 (Accelerometer & Gyroscope) test command.
266 126ace3c Thomas Schöpping
 */
267 4c72a54c Thomas Schöpping
extern aos_shellcommand_t moduleTestMpu6050ShellCmd;
268 126ace3c Thomas Schöpping
269 4c72a54c Thomas Schöpping
#endif /* (BOARD_MPU6050_CONNECTED == true) */
270
271
/**
272
 * @brief   Entire module test command.
273
 */
274
extern aos_shellcommand_t moduleTestAllShellCmd;
275 126ace3c Thomas Schöpping
276 7de0cc90 Thomas Schöpping
#endif /* (AMIROOS_CFG_TESTS_ENABLE == true) */
277 8543d0d9 Thomas Schöpping
278
/** @} */
279
280 6ff06bbf Thomas Schöpping
#endif /* AMIROOS_MODULE_H */
281 27d0378b Simon Welzel
282
/** @} */