amiro-os / modules / NUCLEO-F401RE / module.h @ 21e5be0b
History | View | Annotate | Download (5.28 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 NUCLEO-F401RE module.
|
22 |
*
|
23 |
* @addtogroup NUCLEO-F401RE_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 Serial driver of the programmer interface.
|
50 |
*/
|
51 |
#define MODULE_HAL_PROGIF SD2
|
52 |
|
53 |
/**
|
54 |
* @brief Configuration for the programmer serial interface driver.
|
55 |
*/
|
56 |
extern SerialConfig moduleHalProgIfConfig;
|
57 |
|
58 |
/**
|
59 |
* @brief Real-Time Clock driver.
|
60 |
*/
|
61 |
#define MODULE_HAL_RTC RTCD1
|
62 |
|
63 |
/** @} */
|
64 |
|
65 |
/*===========================================================================*/
|
66 |
/**
|
67 |
* @name GPIO definitions
|
68 |
* @{
|
69 |
*/
|
70 |
/*===========================================================================*/
|
71 |
|
72 |
/**
|
73 |
* @brief LED output signal GPIO.
|
74 |
*/
|
75 |
extern ROMCONST apalControlGpio_t moduleGpioLed;
|
76 |
|
77 |
/**
|
78 |
* @brief User button input signal.
|
79 |
*/
|
80 |
extern ROMCONST apalControlGpio_t moduleGpioUserButton;
|
81 |
|
82 |
/** @} */
|
83 |
|
84 |
/*===========================================================================*/
|
85 |
/**
|
86 |
* @name AMiRo-OS core configurations
|
87 |
* @{
|
88 |
*/
|
89 |
/*===========================================================================*/
|
90 |
|
91 |
/**
|
92 |
* @brief Event flag to be set on a USER_BUTTON interrupt.
|
93 |
*/
|
94 |
#define MODULE_OS_IOEVENTFLAGS_USERBUTTON AOS_IOEVENT_FLAG(PAL_PAD(LINE_BUTTON))
|
95 |
|
96 |
#if (AMIROOS_CFG_SHELL_ENABLE == true) || (AMIROOS_CFG_TESTS_ENABLE == true) || defined(__DOXYGEN__) |
97 |
/**
|
98 |
* @brief Shell prompt text.
|
99 |
*/
|
100 |
extern ROMCONST char* moduleShellPrompt; |
101 |
#endif /* (AMIROOS_CFG_SHELL_ENABLE == true) || (AMIROOS_CFG_TESTS_ENABLE == true) */ |
102 |
|
103 |
/**
|
104 |
* @brief Interrupt initialization macro.
|
105 |
* @note SSSP related interrupt signals are already initialized in 'aos_system.c'.
|
106 |
*/
|
107 |
#define MODULE_INIT_INTERRUPTS() { \
|
108 |
/* user button */ \
|
109 |
palSetLineCallback(moduleGpioUserButton.gpio->line, aosSysGetStdIntCallback(), &moduleGpioUserButton.gpio->line); \ |
110 |
palEnableLineEvent(moduleGpioUserButton.gpio->line, APAL2CH_EDGE(moduleGpioUserButton.meta.edge)); \ |
111 |
} |
112 |
|
113 |
/**
|
114 |
* @brief Unit test initialization hook.
|
115 |
*/
|
116 |
#define MODULE_INIT_TESTS() { \
|
117 |
/* add unit-test shell commands */ \
|
118 |
} |
119 |
|
120 |
/**
|
121 |
* @brief Periphery communication interfaces initialization hook.
|
122 |
*/
|
123 |
#define MODULE_INIT_PERIPHERY_COMM() { \
|
124 |
/* serial driver */ \
|
125 |
sdStart(&MODULE_HAL_PROGIF, &moduleHalProgIfConfig); \ |
126 |
} |
127 |
|
128 |
/**
|
129 |
* @brief Periphery communication interface deinitialization hook.
|
130 |
*/
|
131 |
#define MODULE_SHUTDOWN_PERIPHERY_COMM() { \
|
132 |
} |
133 |
|
134 |
/**
|
135 |
* @brief HOOK to toggle the LEDs when the user button is pressed.
|
136 |
*/
|
137 |
#define MODULE_MAIN_LOOP_IO_EVENT(eventflags) { \
|
138 |
if (eventflags & MODULE_OS_IOEVENTFLAGS_USERBUTTON) { \
|
139 |
apalControlGpioState_t buttonstate; \ |
140 |
apalControlGpioGet(&moduleGpioUserButton, &buttonstate); \ |
141 |
apalControlGpioSet(&moduleGpioLed, buttonstate); \ |
142 |
} \ |
143 |
} |
144 |
|
145 |
/** @} */
|
146 |
|
147 |
/*===========================================================================*/
|
148 |
/**
|
149 |
* @name Startup Shutdown Synchronization Protocol (SSSP)
|
150 |
* @{
|
151 |
*/
|
152 |
/*===========================================================================*/
|
153 |
|
154 |
/** @} */
|
155 |
|
156 |
/*===========================================================================*/
|
157 |
/**
|
158 |
* @name Low-level drivers
|
159 |
* @{
|
160 |
*/
|
161 |
/*===========================================================================*/
|
162 |
|
163 |
/** @} */
|
164 |
|
165 |
/*===========================================================================*/
|
166 |
/**
|
167 |
* @name Unit tests (UT)
|
168 |
* @{
|
169 |
*/
|
170 |
/*===========================================================================*/
|
171 |
#if (AMIROOS_CFG_TESTS_ENABLE == true) || defined(__DOXYGEN__) |
172 |
|
173 |
#endif /* (AMIROOS_CFG_TESTS_ENABLE == true) */ |
174 |
|
175 |
/** @} */
|
176 |
|
177 |
#endif /* AMIROOS_MODULE_H */ |
178 |
|
179 |
/** @} */
|