Statistics
| Branch: | Tag: | Revision:

amiro-os / modules / NUCLEO-F767ZI / module.h @ 56dc4779

History | View | Annotate | Download (5.62 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-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
#define MODULE_OS_IOEVENTFLAGS_USERBUTTON       AOS_IOEVENT_FLAG(PAL_PAD(LINE_BUTTON))
105

    
106
#if (AMIROOS_CFG_SHELL_ENABLE == true) || (AMIROOS_CFG_TESTS_ENABLE == true) || defined(__DOXYGEN__)
107
/**
108
 * @brief   Shell prompt text.
109
 */
110
extern ROMCONST char* moduleShellPrompt;
111
#endif /* (AMIROOS_CFG_SHELL_ENABLE == true) || (AMIROOS_CFG_TESTS_ENABLE == true) */
112

    
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
  palSetLineCallback(moduleGpioUserButton.gpio->line, aosSysGetStdExtiCallback(), &moduleGpioUserButton.gpio->line);  \
120
  palEnableLineEvent(moduleGpioUserButton.gpio->line, APAL2CH_EDGE(moduleGpioUserButton.meta.edge));                  \
121
}
122

    
123
/**
124
 * @brief   Unit test initialization hook.
125
 */
126
#define MODULE_INIT_TESTS() {                                                 \
127
  /* add unit-test shell commands */                                          \
128
}
129

    
130
/**
131
 * @brief   Periphery communication interfaces initialization hook.
132
 */
133
#define MODULE_INIT_PERIPHERY_IF() {                                          \
134
  /* serial driver */                                                         \
135
  sdStart(&MODULE_HAL_PROGIF, &moduleHalProgIfConfig);                        \
136
}
137

    
138
/**
139
 * @brief   Periphery communication interface deinitialization hook.
140
 */
141
#define MODULE_SHUTDOWN_PERIPHERY_IF() {                                      \
142
}
143

    
144
/**
145
 * @brief   HOOK to toggle the LEDs when the user button is pressed.
146
 */
147
#define MODULE_MAIN_LOOP_IO_EVENT(eventflags) {                               \
148
  if (eventflags & MODULE_OS_IOEVENTFLAGS_USERBUTTON) {                       \
149
    apalControlGpioState_t buttonstate;                                       \
150
    apalControlGpioGet(&moduleGpioUserButton, &buttonstate);                  \
151
    apalControlGpioSet(&moduleGpioLed1, buttonstate);                         \
152
    apalControlGpioSet(&moduleGpioLed2, buttonstate);                         \
153
    apalControlGpioSet(&moduleGpioLed3, buttonstate);                         \
154
  }                                                                           \
155
}
156

    
157
/** @} */
158

    
159
/*===========================================================================*/
160
/**
161
 * @name Startup Shutdown Synchronization Protocol (SSSP)
162
 * @{
163
 */
164
/*===========================================================================*/
165

    
166
/** @} */
167

    
168
/*===========================================================================*/
169
/**
170
 * @name Low-level drivers
171
 * @{
172
 */
173
/*===========================================================================*/
174

    
175
/** @} */
176

    
177
/*===========================================================================*/
178
/**
179
 * @name Tests
180
 * @{
181
 */
182
/*===========================================================================*/
183
#if (AMIROOS_CFG_TESTS_ENABLE == true) || defined(__DOXYGEN__)
184

    
185
#endif /* (AMIROOS_CFG_TESTS_ENABLE == true) */
186

    
187
/** @} */
188

    
189
#endif /* AMIROOS_MODULE_H */
190

    
191
/** @} */