Statistics
| Branch: | Tag: | Revision:

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

History | View | Annotate | Download (5.62 KB)

1 21e5be0b Thomas Schöpping
/*
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-F767ZI module.
22
 *
23
 * @addtogroup NUCLEO-F767ZI_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                       SD3
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   LED1 output signal GPIO.
74
 */
75
extern ROMCONST apalControlGpio_t moduleGpioLed1;
76
77
/**
78
 * @brief   LED2 output signal GPIO.
79
 */
80
extern ROMCONST apalControlGpio_t moduleGpioLed2;
81
82
/**
83
 * @brief   LED3 output signal GPIO.
84
 */
85
extern ROMCONST apalControlGpio_t moduleGpioLed3;
86
87
/**
88
 * @brief   User button input signal.
89
 */
90
extern ROMCONST apalControlGpio_t moduleGpioUserButton;
91
92
/** @} */
93
94
/*===========================================================================*/
95
/**
96
 * @name AMiRo-OS core configurations
97
 * @{
98
 */
99
/*===========================================================================*/
100
101
/**
102
 * @brief   Event flag to be set on a USER_BUTTON interrupt.
103
 */
104 1a8fb642 Thomas Schöpping
#define MODULE_OS_GPIOEVENTFLAG_USERBUTTON      AOS_GPIOEVENT_FLAG(PAL_PAD(LINE_BUTTON))
105 21e5be0b Thomas Schöpping
106 47e89ebf Thomas Schöpping
#if (AMIROOS_CFG_SHELL_ENABLE == true) || defined(__DOXYGEN__)
107 21e5be0b Thomas Schöpping
/**
108
 * @brief   Shell prompt text.
109
 */
110
extern ROMCONST char* moduleShellPrompt;
111 47e89ebf Thomas Schöpping
#endif /* (AMIROOS_CFG_SHELL_ENABLE == true) */
112 21e5be0b Thomas Schöpping
113
/**
114
 * @brief   Interrupt initialization macro.
115
 * @note    SSSP related interrupt signals are already initialized in 'aos_system.c'.
116
 */
117
#define MODULE_INIT_INTERRUPTS() {                                            \
118
  /* user button */                                                           \
119 1a8fb642 Thomas Schöpping
  palSetLineCallback(moduleGpioUserButton.gpio->line, aosSysGetStdGpioCallback(), &moduleGpioUserButton.gpio->line);  \
120 56dc4779 Thomas Schöpping
  palEnableLineEvent(moduleGpioUserButton.gpio->line, APAL2CH_EDGE(moduleGpioUserButton.meta.edge));                  \
121 21e5be0b Thomas Schöpping
}
122
123
/**
124 1a8fb642 Thomas Schöpping
 * @brief   Test initialization hook.
125 21e5be0b Thomas Schöpping
 */
126
#define MODULE_INIT_TESTS() {                                                 \
127 1a8fb642 Thomas Schöpping
  /* add test commands to shell */                                            \
128 21e5be0b Thomas Schöpping
}
129
130
/**
131
 * @brief   Periphery communication interfaces initialization hook.
132
 */
133 4c72a54c Thomas Schöpping
#define MODULE_INIT_PERIPHERY_IF() {                                          \
134 21e5be0b Thomas Schöpping
  /* serial driver */                                                         \
135
  sdStart(&MODULE_HAL_PROGIF, &moduleHalProgIfConfig);                        \
136
}
137
138
/**
139
 * @brief   Periphery communication interface deinitialization hook.
140
 */
141 4c72a54c Thomas Schöpping
#define MODULE_SHUTDOWN_PERIPHERY_IF() {                                      \
142 1a8fb642 Thomas Schöpping
  /* don't stop the serial driver so messages can still be printed */         \
143 21e5be0b Thomas Schöpping
}
144
145
/**
146
 * @brief   HOOK to toggle the LEDs when the user button is pressed.
147
 */
148 1a8fb642 Thomas Schöpping
#define MODULE_MAIN_LOOP_GPIOEVENT(eventflags) {                              \
149
  if (eventflags & MODULE_OS_GPIOEVENTFLAG_USERBUTTON) {                      \
150 21e5be0b Thomas Schöpping
    apalControlGpioState_t buttonstate;                                       \
151
    apalControlGpioGet(&moduleGpioUserButton, &buttonstate);                  \
152
    apalControlGpioSet(&moduleGpioLed1, buttonstate);                         \
153
    apalControlGpioSet(&moduleGpioLed2, buttonstate);                         \
154
    apalControlGpioSet(&moduleGpioLed3, buttonstate);                         \
155
  }                                                                           \
156
}
157
158
/** @} */
159
160
/*===========================================================================*/
161
/**
162
 * @name Startup Shutdown Synchronization Protocol (SSSP)
163
 * @{
164
 */
165
/*===========================================================================*/
166
167
/** @} */
168
169
/*===========================================================================*/
170
/**
171
 * @name Low-level drivers
172
 * @{
173
 */
174
/*===========================================================================*/
175
176
/** @} */
177
178
/*===========================================================================*/
179
/**
180 4c72a54c Thomas Schöpping
 * @name Tests
181 21e5be0b Thomas Schöpping
 * @{
182
 */
183
/*===========================================================================*/
184
#if (AMIROOS_CFG_TESTS_ENABLE == true) || defined(__DOXYGEN__)
185
186
#endif /* (AMIROOS_CFG_TESTS_ENABLE == true) */
187
188
/** @} */
189
190
#endif /* AMIROOS_MODULE_H */
191
192
/** @} */