STM32F4xx-Nucleo
Select one of the symbols to view example projects that use it.
Symbol previews are coming soon...
Outline
#define __STM32F4XX_NUCLEO_H
#include "stm32f4xx_hal.h"
#define ADAFRUIT_TFT_JOY_SD_ID802
Led_TypeDef
LED2
Button_TypeDef
BUTTON_USER
BUTTON_KEY
ButtonMode_TypeDef
BUTTON_MODE_GPIO
BUTTON_MODE_EXTI
JOYState_TypeDef
JOY_NONE
JOY_SEL
JOY_DOWN
JOY_LEFT
JOY_RIGHT
JOY_UP
#define USE_STM32F4XX_NUCLEO
#define LEDn
#define LED2_PIN
#define LED2_GPIO_PORT
#define LED2_GPIO_CLK_ENABLE
#define LED2_GPIO_CLK_DISABLE
#define LEDx_GPIO_CLK_ENABLE
#define LEDx_GPIO_CLK_DISABLE
#define BUTTONn
#define USER_BUTTON_PIN
#define USER_BUTTON_GPIO_PORT
#define USER_BUTTON_GPIO_CLK_ENABLE
#define USER_BUTTON_GPIO_CLK_DISABLE
#define USER_BUTTON_EXTI_LINE
#define USER_BUTTON_EXTI_IRQn
#define BUTTONx_GPIO_CLK_ENABLE
#define BUTTONx_GPIO_CLK_DISABLE
#define KEY_BUTTON_PIN
#define KEY_BUTTON_GPIO_PORT
#define KEY_BUTTON_GPIO_CLK_ENABLE
#define KEY_BUTTON_GPIO_CLK_DISABLE
#define KEY_BUTTON_EXTI_LINE
#define KEY_BUTTON_EXTI_IRQn
#define NUCLEO_SPIx
#define NUCLEO_SPIx_CLK_ENABLE
#define NUCLEO_SPIx_SCK_AF
#define NUCLEO_SPIx_SCK_GPIO_PORT
#define NUCLEO_SPIx_SCK_PIN
#define NUCLEO_SPIx_SCK_GPIO_CLK_ENABLE
#define NUCLEO_SPIx_SCK_GPIO_CLK_DISABLE
#define NUCLEO_SPIx_MISO_MOSI_AF
#define NUCLEO_SPIx_MISO_MOSI_GPIO_PORT
#define NUCLEO_SPIx_MISO_MOSI_GPIO_CLK_ENABLE
#define NUCLEO_SPIx_MISO_MOSI_GPIO_CLK_DISABLE
#define NUCLEO_SPIx_MISO_PIN
#define NUCLEO_SPIx_MOSI_PIN
#define NUCLEO_SPIx_TIMEOUT_MAX
#define SD_CS_LOW
#define SD_CS_HIGH
#define LCD_CS_LOW
#define LCD_CS_HIGH
#define LCD_DC_LOW
#define LCD_DC_HIGH
#define SD_CS_PIN
#define SD_CS_GPIO_PORT
#define SD_CS_GPIO_CLK_ENABLE
#define SD_CS_GPIO_CLK_DISABLE
#define LCD_CS_PIN
#define LCD_CS_GPIO_PORT
#define LCD_CS_GPIO_CLK_ENABLE
#define LCD_CS_GPIO_CLK_DISABLE
#define LCD_DC_PIN
#define LCD_DC_GPIO_PORT
#define LCD_DC_GPIO_CLK_ENABLE
#define LCD_DC_GPIO_CLK_DISABLE
#define NUCLEO_ADCx
#define NUCLEO_ADCx_CLK_ENABLE
#define NUCLEO_ADCx_CLK_DISABLE
#define NUCLEO_ADCx_CHANNEL
#define NUCLEO_ADCx_GPIO_PORT
#define NUCLEO_ADCx_GPIO_PIN
#define NUCLEO_ADCx_GPIO_CLK_ENABLE
#define NUCLEO_ADCx_GPIO_CLK_DISABLE
BSP_GetVersion();
BSP_LED_Init(Led_TypeDef);
BSP_LED_DeInit(Led_TypeDef);
BSP_LED_On(Led_TypeDef);
BSP_LED_Off(Led_TypeDef);
BSP_LED_Toggle(Led_TypeDef);
BSP_PB_Init(Button_TypeDef, ButtonMode_TypeDef);
BSP_PB_DeInit(Button_TypeDef);
BSP_PB_GetState(Button_TypeDef);
BSP_JOY_Init();
BSP_JOY_GetState();
BSP_JOY_DeInit();
Files
loading...
SourceVu
STM32 Libraries and Samples
STM32F4xx-Nucleo
stm32f4xx_nucleo.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
/**
******************************************************************************
* @file stm32f4xx_nucleo.h
* @author MCD Application Team
* @brief This file contains definitions for:
* - LEDs and push-button available on STM32F4XX-Nucleo Kit
* from STMicroelectronics
* - LCD, joystick and microSD available on Adafruit 1.8" TFT LCD
* shield (reference ID 802)
******************************************************************************
* @attention
*
* Copyright (c) 2017 STMicroelectronics.
* All rights reserved.
*
* This software is licensed under terms that can be found in the LICENSE file
* in the root directory of this software component.
* If no LICENSE file comes with this software, it is provided AS-IS.
*
******************************************************************************
*/
/* ... */
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef
__STM32F4XX_NUCLEO_H
#define
__STM32F4XX_NUCLEO_H
#ifdef
__cplusplus
extern
"C"
{
#endif
/* Includes ------------------------------------------------------------------*/
#include
"
stm32f4xx_hal.h"
/* To be defined only if the board is provided with the related shield */
/* https://www.adafruit.com/products/802 */
#define
ADAFRUIT_TFT_JOY_SD_ID802
/** @addtogroup BSP
* @{
*/
/* ... */
/** @addtogroup STM32F4XX_NUCLEO
* @{
*/
/* ... */
/** @addtogroup STM32F4XX_NUCLEO_LOW_LEVEL
* @{
*/
/* ... */
/** @defgroup STM32F4XX_NUCLEO_LOW_LEVEL_Exported_Types STM32F4XX NUCLEO LOW LEVEL Exported Types
* @{
*/
/* ... */
typedef
enum
{
LED2
=
0
...
}
Led_TypeDef
;
typedef
enum
{
BUTTON_USER
=
0
,
/* Alias */
BUTTON_KEY
=
BUTTON_USER
...
}
Button_TypeDef
;
typedef
enum
{
BUTTON_MODE_GPIO
=
0
,
BUTTON_MODE_EXTI
=
1
...
}
ButtonMode_TypeDef
;
typedef
enum
{
JOY_NONE
=
0
,
JOY_SEL
=
1
,
JOY_DOWN
=
2
,
JOY_LEFT
=
3
,
JOY_RIGHT
=
4
,
JOY_UP
=
5
...
}
JOYState_TypeDef
;
/**
* @}
*/
/* ... */
/** @defgroup STM32F4XX_NUCLEO_LOW_LEVEL_Exported_Constants STM32F4XX NUCLEO LOW LEVEL Exported Constants
* @{
*/
/* ... */
/**
* @brief Define for STM32F4XX_NUCLEO board
*/
/* ... */
#if
!
defined
(
USE_STM32F4XX_NUCLEO
)
#define
USE_STM32F4XX_NUCLEO
#endif
/** @defgroup STM32F4XX_NUCLEO_LOW_LEVEL_LED STM32F4XX NUCLEO LOW LEVEL LED
* @{
*/
/* ... */
#define
LEDn
1
#define
LED2_PIN
GPIO_PIN_5
#define
LED2_GPIO_PORT
GPIOA
#define
LED2_GPIO_CLK_ENABLE
(
)
__HAL_RCC_GPIOA_CLK_ENABLE
(
)
#define
LED2_GPIO_CLK_DISABLE
(
)
__HAL_RCC_GPIOA_CLK_DISABLE
(
)
#define
LEDx_GPIO_CLK_ENABLE
(
__INDEX__
)
LED2_GPIO_CLK_ENABLE
(
)
#define
LEDx_GPIO_CLK_DISABLE
(
__INDEX__
)
LED2_GPIO_CLK_DISABLE
(
)
/**
* @}
*/
/* ... */
/** @defgroup STM32F4XX_NUCLEO_LOW_LEVEL_BUTTON STM32F4XX NUCLEO LOW LEVEL BUTTON
* @{
*/
/* ... */
#define
BUTTONn
1
/**
* @brief Key push-button
*/
/* ... */
#define
USER_BUTTON_PIN
GPIO_PIN_13
#define
USER_BUTTON_GPIO_PORT
GPIOC
#define
USER_BUTTON_GPIO_CLK_ENABLE
(
)
__HAL_RCC_GPIOC_CLK_ENABLE
(
)
#define
USER_BUTTON_GPIO_CLK_DISABLE
(
)
__HAL_RCC_GPIOC_CLK_DISABLE
(
)
#define
USER_BUTTON_EXTI_LINE
GPIO_PIN_13
#define
USER_BUTTON_EXTI_IRQn
EXTI15_10_IRQn
#define
BUTTONx_GPIO_CLK_ENABLE
(
__INDEX__
)
USER_BUTTON_GPIO_CLK_ENABLE
(
)
#define
BUTTONx_GPIO_CLK_DISABLE
(
__INDEX__
)
USER_BUTTON_GPIO_CLK_DISABLE
(
)
/* Aliases */
#define
KEY_BUTTON_PIN
USER_BUTTON_PIN
#define
KEY_BUTTON_GPIO_PORT
USER_BUTTON_GPIO_PORT
#define
KEY_BUTTON_GPIO_CLK_ENABLE
(
)
USER_BUTTON_GPIO_CLK_ENABLE
(
)
#define
KEY_BUTTON_GPIO_CLK_DISABLE
(
)
USER_BUTTON_GPIO_CLK_DISABLE
(
)
#define
KEY_BUTTON_EXTI_LINE
USER_BUTTON_EXTI_LINE
#define
KEY_BUTTON_EXTI_IRQn
USER_BUTTON_EXTI_IRQn
22 defines
/**
* @}
*/
/* ... */
/** @defgroup STM32F4XX_NUCLEO_LOW_LEVEL_BUS STM32F4XX NUCLEO LOW LEVEL BUS
* @{
*/
/* ... */
/*############################### SPI1 #######################################*/
#ifdef
HAL_SPI_MODULE_ENABLED
#define
NUCLEO_SPIx
SPI1
#define
NUCLEO_SPIx_CLK_ENABLE
(
)
__HAL_RCC_SPI1_CLK_ENABLE
(
)
#define
NUCLEO_SPIx_SCK_AF
GPIO_AF5_SPI1
#define
NUCLEO_SPIx_SCK_GPIO_PORT
GPIOA
#define
NUCLEO_SPIx_SCK_PIN
GPIO_PIN_5
#define
NUCLEO_SPIx_SCK_GPIO_CLK_ENABLE
(
)
__HAL_RCC_GPIOA_CLK_ENABLE
(
)
#define
NUCLEO_SPIx_SCK_GPIO_CLK_DISABLE
(
)
__HAL_RCC_GPIOA_CLK_DISABLE
(
)
#define
NUCLEO_SPIx_MISO_MOSI_AF
GPIO_AF5_SPI1
#define
NUCLEO_SPIx_MISO_MOSI_GPIO_PORT
GPIOA
#define
NUCLEO_SPIx_MISO_MOSI_GPIO_CLK_ENABLE
(
)
__HAL_RCC_GPIOA_CLK_ENABLE
(
)
#define
NUCLEO_SPIx_MISO_MOSI_GPIO_CLK_DISABLE
(
)
__HAL_RCC_GPIOA_CLK_DISABLE
(
)
#define
NUCLEO_SPIx_MISO_PIN
GPIO_PIN_6
#define
NUCLEO_SPIx_MOSI_PIN
GPIO_PIN_7
/* Maximum Timeout values for flags waiting loops. These timeouts are not based
on accurate values, they just guarantee that the application will not remain
stuck if the SPI communication is corrupted.
You may modify these timeout values depending on CPU frequency and application
conditions (interrupts routines ...). */
/* ... */
#define
NUCLEO_SPIx_TIMEOUT_MAX
1000
/**
* @brief SD Control Lines management
*/
/* ... */
#define
SD_CS_LOW
(
)
HAL_GPIO_WritePin
(
SD_CS_GPIO_PORT
,
SD_CS_PIN
,
GPIO_PIN_RESET
)
#define
SD_CS_HIGH
(
)
HAL_GPIO_WritePin
(
SD_CS_GPIO_PORT
,
SD_CS_PIN
,
GPIO_PIN_SET
)
/**
* @brief LCD Control Lines management
*/
/* ... */
#define
LCD_CS_LOW
(
)
HAL_GPIO_WritePin
(
LCD_CS_GPIO_PORT
,
LCD_CS_PIN
,
GPIO_PIN_RESET
)
#define
LCD_CS_HIGH
(
)
HAL_GPIO_WritePin
(
LCD_CS_GPIO_PORT
,
LCD_CS_PIN
,
GPIO_PIN_SET
)
#define
LCD_DC_LOW
(
)
HAL_GPIO_WritePin
(
LCD_DC_GPIO_PORT
,
LCD_DC_PIN
,
GPIO_PIN_RESET
)
#define
LCD_DC_HIGH
(
)
HAL_GPIO_WritePin
(
LCD_DC_GPIO_PORT
,
LCD_DC_PIN
,
GPIO_PIN_SET
)
/**
* @brief SD Control Interface pins (shield D4)
*/
/* ... */
#define
SD_CS_PIN
GPIO_PIN_5
#define
SD_CS_GPIO_PORT
GPIOB
#define
SD_CS_GPIO_CLK_ENABLE
(
)
__HAL_RCC_GPIOB_CLK_ENABLE
(
)
#define
SD_CS_GPIO_CLK_DISABLE
(
)
__HAL_RCC_GPIOB_CLK_DISABLE
(
)
/**
* @brief LCD Control Interface pins (shield D10)
*/
/* ... */
#define
LCD_CS_PIN
GPIO_PIN_6
#define
LCD_CS_GPIO_PORT
GPIOB
#define
LCD_CS_GPIO_CLK_ENABLE
(
)
__HAL_RCC_GPIOB_CLK_ENABLE
(
)
#define
LCD_CS_GPIO_CLK_DISABLE
(
)
__HAL_RCC_GPIOB_CLK_DISABLE
(
)
/**
* @brief LCD Data/Command Interface pins (shield D8)
*/
/* ... */
#define
LCD_DC_PIN
GPIO_PIN_9
#define
LCD_DC_GPIO_PORT
GPIOA
#define
LCD_DC_GPIO_CLK_ENABLE
(
)
__HAL_RCC_GPIOA_CLK_ENABLE
(
)
#define
LCD_DC_GPIO_CLK_DISABLE
(
)
__HAL_RCC_GPIOA_CLK_DISABLE
(
)
32 defines
/* ... */
#endif
/* HAL_SPI_MODULE_ENABLED */
/*################################ ADC1 ######################################*/
/**
* @brief ADC Interface pins
* used to detect motion of Joystick available on Adafruit 1.8" TFT shield
*/
/* ... */
#ifdef
HAL_ADC_MODULE_ENABLED
#define
NUCLEO_ADCx
ADC1
#define
NUCLEO_ADCx_CLK_ENABLE
(
)
__HAL_RCC_ADC1_CLK_ENABLE
(
)
#define
NUCLEO_ADCx_CLK_DISABLE
(
)
__HAL_RCC_ADC1_CLK_DISABLE
(
)
#define
NUCLEO_ADCx_CHANNEL
ADC_CHANNEL_8
#define
NUCLEO_ADCx_GPIO_PORT
GPIOB
#define
NUCLEO_ADCx_GPIO_PIN
GPIO_PIN_0
#define
NUCLEO_ADCx_GPIO_CLK_ENABLE
(
)
__HAL_RCC_GPIOB_CLK_ENABLE
(
)
#define
NUCLEO_ADCx_GPIO_CLK_DISABLE
(
)
__HAL_RCC_GPIOB_CLK_DISABLE
(
)
8 defines
#endif
/* ... */
/* HAL_ADC_MODULE_ENABLED */
/**
* @}
*/
/* ... */
/**
* @}
*/
/* ... */
/** @defgroup STM32F4XX_NUCLEO_LOW_LEVEL_Exported_Macros STM32F4XX NUCLEO LOW LEVEL Exported Macros
* @{
*/
/* ... */
/**
* @}
*/
/* ... */
/** @defgroup STM32F4XX_NUCLEO_LOW_LEVEL_Exported_Functions STM32F4XX NUCLEO LOW LEVEL Exported Functions
* @{
*/
/* ... */
uint32_t
BSP_GetVersion
(
void
)
;
void
BSP_LED_Init
(
Led_TypeDef
Led
)
;
void
BSP_LED_DeInit
(
Led_TypeDef
Led
)
;
void
BSP_LED_On
(
Led_TypeDef
Led
)
;
void
BSP_LED_Off
(
Led_TypeDef
Led
)
;
void
BSP_LED_Toggle
(
Led_TypeDef
Led
)
;
void
BSP_PB_Init
(
Button_TypeDef
Button
,
ButtonMode_TypeDef
ButtonMode
)
;
void
BSP_PB_DeInit
(
Button_TypeDef
Button
)
;
uint32_t
BSP_PB_GetState
(
Button_TypeDef
Button
)
;
#ifdef
HAL_ADC_MODULE_ENABLED
uint8_t
BSP_JOY_Init
(
void
)
;
JOYState_TypeDef
BSP_JOY_GetState
(
void
)
;
void
BSP_JOY_DeInit
(
void
)
;
/* ... */
#endif
/* HAL_ADC_MODULE_ENABLED */
/**
* @}
*/
/* ... */
/**
* @}
*/
/* ... */
/**
* @}
*/
/* ... */
/**
* @}
*/
/* ... */
#ifdef
__cplusplus
}
extern "C" { ... }
#endif
/* ... */
#endif
/* __STM32F4XX_NUCLEO_H */
Details
Show:
from
Types:
Columns:
All items filtered out
All items filtered out
This file uses the notable symbols shown below. Click anywhere in the file to view more details.
BSP_LED_Init()
BSP_LED_On()
BSP_LED_Toggle()
BSP_LED_Off()
BSP_PB_GetState()
BSP_PB_Init()
HAL_GPIO_WritePin()
BSP_JOY_GetState()
BSP_JOY_Init()
BSP_GetVersion()
BSP_LED_DeInit()
BSP_PB_DeInit()
BSP_JOY_DeInit()
GPIOA
Led_TypeDef::LED2
GPIOB
__HAL_RCC_GPIOA_CLK_ENABLE
GPIOC
__HAL_RCC_GPIOB_CLK_ENABLE
Button_TypeDef::BUTTON_KEY
GPIO_PIN_0
GPIO_PIN_5
JOYState_TypeDef
GPIO_PIN_9
__HAL_RCC_GPIOC_CLK_ENABLE
GPIO_PIN_6
GPIO_PIN_7
GPIO_PIN_13
Led_TypeDef
LED2_PIN
LED2_GPIO_PORT
ADC1
USER_BUTTON_PIN
USER_BUTTON_EXTI_LINE
GPIO_PinState::GPIO_PIN_SET
ButtonMode_TypeDef::BUTTON_MODE_EXTI
GPIO_PinState::GPIO_PIN_RESET
KEY_BUTTON_PIN
ButtonMode_TypeDef::BUTTON_MODE_GPIO
Button_TypeDef
USER_BUTTON_GPIO_PORT
IRQn_Type::EXTI15_10_IRQn
USER_BUTTON_EXTI_IRQn
LED2_GPIO_CLK_ENABLE
JOYState_TypeDef::JOY_DOWN
SPI1
BSP_PB_Init()::Button
JOYState_TypeDef::JOY_NONE
USER_BUTTON_GPIO_CLK_ENABLE
JOYState_TypeDef::JOY_UP
Button_TypeDef::BUTTON_USER
ButtonMode_TypeDef
JOYState_TypeDef::JOY_SEL
JOYState_TypeDef::JOY_RIGHT
JOYState_TypeDef::JOY_LEFT
BSP_LED_Init()::Led
BSP_LED_On()::Led
BSP_LED_Off()::Led
BSP_LED_Toggle()::Led
BUTTONn
BSP_PB_GetState()::Button
GPIO_AF5_SPI1
BSP_LED_DeInit()::Led
LEDn
BSP_PB_DeInit()::Button
__HAL_RCC_ADC1_CLK_ENABLE
BSP_PB_Init()::ButtonMode
LEDx_GPIO_CLK_ENABLE
NUCLEO_ADCx_GPIO_PORT
NUCLEO_ADCx_GPIO_PIN
ADAFRUIT_TFT_JOY_SD_ID802
BUTTONx_GPIO_CLK_ENABLE
KEY_BUTTON_GPIO_PORT
KEY_BUTTON_EXTI_IRQn
KEY_BUTTON_GPIO_CLK_ENABLE
__HAL_RCC_SPI1_CLK_ENABLE
LCD_CS_HIGH
NUCLEO_ADCx_GPIO_CLK_ENABLE
LCD_CS_LOW
ADC_CHANNEL_8
LEDx_GPIO_CLK_DISABLE
BUTTONx_GPIO_CLK_DISABLE
KEY_BUTTON_GPIO_CLK_DISABLE
LCD_CS_GPIO_PORT
LCD_CS_PIN
SD_CS_GPIO_PORT
SD_CS_PIN
LCD_DC_GPIO_PORT
LCD_DC_PIN
NUCLEO_ADCx
NUCLEO_SPIx_MISO_MOSI_GPIO_PORT
SD_CS_HIGH
LCD_DC_HIGH
LED2_GPIO_CLK_DISABLE
LCD_CS_GPIO_CLK_ENABLE
NUCLEO_ADCx_CLK_ENABLE
NUCLEO_ADCx_CLK_DISABLE
NUCLEO_ADCx_CHANNEL
NUCLEO_SPIx
NUCLEO_SPIx_CLK_ENABLE
NUCLEO_SPIx_SCK_AF
NUCLEO_SPIx_SCK_GPIO_PORT
NUCLEO_SPIx_SCK_PIN
NUCLEO_SPIx_SCK_GPIO_CLK_ENABLE
NUCLEO_SPIx_MISO_MOSI_AF
NUCLEO_SPIx_MISO_MOSI_GPIO_CLK_ENABLE
NUCLEO_SPIx_MISO_PIN
NUCLEO_SPIx_MOSI_PIN
NUCLEO_SPIx_TIMEOUT_MAX
SD_CS_LOW
LCD_DC_LOW
SD_CS_GPIO_CLK_ENABLE
LCD_DC_GPIO_CLK_ENABLE
USER_BUTTON_GPIO_CLK_DISABLE
__HAL_RCC_ADC1_CLK_DISABLE
NUCLEO_ADCx_GPIO_CLK_DISABLE
USE_STM32F4XX_NUCLEO
KEY_BUTTON_EXTI_LINE
NUCLEO_SPIx_SCK_GPIO_CLK_DISABLE
NUCLEO_SPIx_MISO_MOSI_GPIO_CLK_DISABLE
SD_CS_GPIO_CLK_DISABLE
LCD_CS_GPIO_CLK_DISABLE
LCD_DC_GPIO_CLK_DISABLE
__STM32F4XX_NUCLEO_H
Led_TypeDef
Button_TypeDef
ButtonMode_TypeDef
JOYState_TypeDef