DM 00122015

UM1785
User manual
Description of STM32F0xx HAL drivers
Introduction
TM
STMCube is an STMicroelectronics original initiative to ease developers life by reducing development

efforts, time and cost. STM32Cube covers STM32 portfolio.
STM32Cube Version 1.x includes:
The STM32CubeMX, a graphical software configuration tool that allows generating C initialization
code using graphical wizards.
A comprehensive embedded software platform, delivered per series (such as STM32CubeF0 for
STM32F0 series)
The STM32Cube HAL, an STM32 abstraction layer embedded software, ensuring maximized
portability across STM32 portfolio
A consistent set of middleware components such as RTOS, USB, TCP/IP, Graphics
All embedded software utilities coming with a full set of examples.
The HAL drivers layer provides a generic multi instance simple set of APIs (application programming
interfaces) to interact with the upper layer (application, libraries and stacks). It is composed of generic
and extension APIs. It is directly built around a generic architecture and allows the built-upon layers,
such as the middleware layer, to implement their functions without knowing in-depth how to use the
MCU. This structure improves the library code reusability and guarantees an easy portability on other
devices.
The HAL drivers include a complete set of ready-to-use APIs which simplify the user application
implementation. As an example, the communication peripherals contain APIs to initialize and configure
the peripheral, to manage data transfers based on polling, to handle interrupts or DMA, and to manage
communication errors.
The HAL drivers APIs are split into two categories: generic APIs which provide common and generic
functions for all the STM32 series and extension APIs which include specific and customized functions
for a given family or part number.
The HAL drivers are feature-oriented instead of IP-oriented. As an example, the timer APIs are split into
several categories following the functions offered by the IP: basic timer, capture, pulse width modulation
(PWM), etc..
The drivers source code is developed in Strict ANSI-C which makes it independent from the
TM
development tools. It is checked with CodeSonar static analysis tool. It is fully documented and is
MISRA-C 2004 compliant.
The HAL drivers layer implements run-time failure detection by checking the input values of all
functions. Such dynamic checking contributes to enhance the firmware robustness. Run-time detection
is also suitable for user application development and debugging.
This user manual is structured as follows:
Overview of the HAL drivers

Detailed description of each peripheral driver: configuration structures, functions, and how to use
the given API to build your application.
November 2014
DocID026525 Rev 1
1/692
www.st.com
Contents
UM1785
Contents
1
Acronyms and definitions............................................................. 35
Overview of HAL drivers ............................................................... 37

2.1
2.2
2/692
2.1.1
HAL driver files ................................................................................. 37
2.1.2
User-application files ........................................................................ 38
HAL data structures ........................................................................ 40

2.2.1
Peripheral handle structures ............................................................ 40
2.2.2
Initialization and configuration structure ........................................... 41
2.2.3
Specific process structures .............................................................. 42
2.3
API classification ............................................................................. 42
2.4
Devices supported by HAL drivers .................................................. 43
2.5
HAL drivers rules............................................................................. 45

2.5.1
HAL API naming rules ...................................................................... 45
2.5.2
HAL general naming rules ................................................................ 46
2.5.3
HAL interrupt handler and callback functions ................................... 47
2.6
HAL generic APIs ............................................................................ 48
2.7
HAL extension APIs ........................................................................ 49

2.7.1
HAL extension model overview ........................................................ 49
2.7.2
HAL extension model cases ............................................................. 49
2.8
File inclusion model......................................................................... 51
2.9
HAL common resources .................................................................. 52
2.10
HAL configuration............................................................................ 53
2.11
HAL system peripheral handling ..................................................... 54
2.12
HAL and user-application files......................................................... 37
2.11.1
Clock ................................................................................................. 54
2.11.2
GPIOs ............................................................................................... 55
2.11.3
Cortex NVIC and SysTick timer........................................................ 56
2.11.4
PWR ................................................................................................. 57
2.11.5
EXTI .................................................................................................. 57
2.11.6
DMA .................................................................................................. 58
How to use HAL drivers .................................................................. 60

2.12.1
HAL usage models ........................................................................... 60
2.12.2
HAL initialization ............................................................................... 60
2.12.3
HAL IO operation process ................................................................ 62
2.12.4
Timeout and error management ....................................................... 65
HAL System Driver ........................................................................ 70

DocID026525 Rev 1
UM1785
Contents
3.1
3.2
HAL Firmware driver API description .............................................. 70

3.1.1
How to use this driver ....................................................................... 70
3.1.2
Initialization and de-initialization functions ....................................... 70
3.1.3
HAL Control functions....................................................................... 70
3.1.4
HAL_Init ............................................................................................ 71
3.1.5
HAL_DeInit ....................................................................................... 71
3.1.6
HAL_MspInit ..................................................................................... 72
3.1.7
HAL_MspDeInit ................................................................................ 72
3.1.8
HAL_InitTick ..................................................................................... 72
3.1.9
HAL_IncTick ..................................................................................... 73
3.1.10
HAL_GetTick .................................................................................... 73
3.1.11
HAL_SuspendTick ............................................................................ 73
3.1.12
HAL_ResumeTick............................................................................. 74
3.1.13
HAL_Delay ....................................................................................... 74
3.1.14
HAL_GetHalVersion ......................................................................... 75
3.1.15
HAL_GetREVID ................................................................................ 75
3.1.16
HAL_GetDEVID ................................................................................ 75
3.1.17
HAL_EnableDBGStopMode ............................................................. 75
3.1.18
HAL_DisableDBGStopMode ............................................................ 76
3.1.19
HAL_EnableDBGStandbyMode ....................................................... 76
3.1.20
HAL_DisableDBGStandbyMode ...................................................... 76
HAL Firmware driver defines ........................................................... 77

3.2.1
HAL ................................................................................................... 77
HAL ADC Generic Driver ............................................................... 81

4.1
4.2
ADC Firmware driver registers structures ....................................... 81

4.1.1
ADC_InitTypeDef .............................................................................. 81
4.1.2
ADC_ChannelConfTypeDef ............................................................. 82
4.1.3
ADC_AnalogWDGConfTypeDef ....................................................... 83
4.1.4
ADC_HandleTypeDef ....................................................................... 84
ADC Firmware driver API description.............................................. 84

4.2.1
ADC specific features ....................................................................... 84
4.2.2
How to use this driver ....................................................................... 85
4.2.3
Initialization and de-initialization functions ....................................... 85
4.2.4
IO operation functions ...................................................................... 86
4.2.5
Peripheral Control functions ............................................................. 86
4.2.6
Peripheral State and Errors functions .............................................. 86
4.2.7
HAL_ADC_Init .................................................................................. 87
4.2.8
HAL_ADC_DeInit .............................................................................. 87
DocID026525 Rev 1
3/692
Contents
4.3
4.2.9
UM1785
HAL_ADC_MspInit ........................................................................... 88
4.2.10
HAL_ADC_MspDeInit ....................................................................... 88
4.2.11
HAL_ADC_Start ............................................................................... 88
4.2.12
HAL_ADC_Stop ................................................................................ 89
4.2.13
HAL_ADC_PollForConversion ......................................................... 89
4.2.14
HAL_ADC_PollForEvent .................................................................. 89
4.2.15
HAL_ADC_Start_IT .......................................................................... 90
4.2.16
HAL_ADC_Stop_IT .......................................................................... 90
4.2.17
HAL_ADC_Start_DMA ..................................................................... 90
4.2.18
HAL_ADC_Stop_DMA...................................................................... 91
4.2.19
HAL_ADC_GetValue ........................................................................ 91
4.2.20
HAL_ADC_IRQHandler .................................................................... 92
4.2.21
HAL_ADC_ConvCpltCallback .......................................................... 92
4.2.22
HAL_ADC_ConvHalfCpltCallback .................................................... 92
4.2.23
HAL_ADC_LevelOutOfWindowCallback .......................................... 93
4.2.24
HAL_ADC_ErrorCallback ................................................................. 93
4.2.25
HAL_ADC_ConfigChannel ............................................................... 93
4.2.26
HAL_ADC_AnalogWDGConfig ........................................................ 94
4.2.27
HAL_ADC_GetState ......................................................................... 94
4.2.28
HAL_ADC_GetError ......................................................................... 95
ADC Firmware driver defines .......................................................... 95

4.3.1
HAL ADC Extension Driver ......................................................... 106

5.1
5.2
ADCEx Firmware driver API description ....................................... 106

5.1.1
ADC specific features ..................................................................... 106
5.1.2
How to use this driver ..................................................................... 106
5.1.3
IO operation functions .................................................................... 107
5.1.4
HAL_ADCEx_Calibration_Start ...................................................... 107
ADCEx Firmware driver defines .................................................... 107

5.2.1
ADCEx ............................................................................................ 107
HAL CAN Generic Driver ............................................................. 109

6.1
6.2
4/692
ADC .................................................................................................. 95
CAN Firmware driver registers structures ..................................... 109

6.1.1
CAN_InitTypeDef ............................................................................ 109
6.1.2
CAN_FilterConfTypeDef ................................................................. 109
6.1.3
CanTxMsgTypeDef......................................................................... 110
6.1.4
CanRxMsgTypeDef ........................................................................ 111
6.1.5
CAN_HandleTypeDef ..................................................................... 112
CAN Firmware driver API description............................................ 112

DocID026525 Rev 1
UM1785
Contents
6.3
6.2.1
6.2.2
Initialization and de-initialization functions ..................................... 113
6.2.3
6.2.4
Peripheral State and Error functions .............................................. 114
6.2.5
HAL_CAN_Init ................................................................................ 114
6.2.6
HAL_CAN_ConfigFilter................................................................... 114
6.2.7
HAL_CAN_DeInit ............................................................................ 115
6.2.8
HAL_CAN_MspInit ......................................................................... 115
6.2.9
HAL_CAN_MspDeInit ..................................................................... 115
6.2.10
HAL_CAN_Transmit ....................................................................... 116
6.2.11
HAL_CAN_Transmit_IT .................................................................. 116
6.2.12
HAL_CAN_Receive ........................................................................ 117
6.2.13
HAL_CAN_Receive_IT ................................................................... 117
6.2.14
HAL_CAN_Sleep ............................................................................ 117
6.2.15
HAL_CAN_WakeUp ....................................................................... 118
6.2.16
HAL_CAN_IRQHandler .................................................................. 118
6.2.17
HAL_CAN_TxCpltCallback ............................................................. 118
6.2.18
HAL_CAN_RxCpltCallback ............................................................ 119
6.2.19
HAL_CAN_ErrorCallback ............................................................... 119
6.2.20
HAL_CAN_GetState ....................................................................... 119
6.2.21
HAL_CAN_GetError ....................................................................... 120
CAN Firmware driver defines ........................................................ 120

6.3.1
CAN ................................................................................................ 120
HAL CEC Generic Driver ............................................................. 129

7.1
7.2
CEC Firmware driver registers structures ..................................... 129

7.1.1
CEC_InitTypeDef ............................................................................ 129
7.1.2
CEC_HandleTypeDef ..................................................................... 130
CEC Firmware driver API description............................................ 130

7.2.1
7.2.2
Initialization and Configuration functions ........................................ 131
7.2.3
IO operation function ...................................................................... 131
7.2.4
Peripheral Control function ............................................................. 132
7.2.5
HAL_CEC_Init ................................................................................ 132
7.2.6
HAL_CEC_DeInit ............................................................................ 132
7.2.7
HAL_CEC_MspInit ......................................................................... 132
7.2.8
HAL_CEC_MspDeInit ..................................................................... 133
7.2.9
HAL_CEC_Transmit ....................................................................... 133
7.2.10
HAL_CEC_Receive ........................................................................ 134

DocID026525 Rev 1
5/692
Contents
7.3
7.2.11
UM1785
HAL_CEC_Transmit_IT .................................................................. 134
7.2.12
HAL_CEC_Receive_IT ................................................................... 134
7.2.13
HAL_CEC_IRQHandler .................................................................. 135
7.2.14
HAL_CEC_TxCpltCallback ............................................................. 135
7.2.15
HAL_CEC_RxCpltCallback ............................................................ 136
7.2.16
HAL_CEC_ErrorCallback ............................................................... 136
7.2.17
HAL_CEC_GetState ....................................................................... 136
7.2.18
HAL_CEC_GetError ....................................................................... 137
CEC Firmware driver defines ........................................................ 137

7.3.1
HAL COMP Generic Driver .......................................................... 146

8.1
8.2
8.3
COMP Firmware driver registers structures .................................. 146

8.1.1
COMP_InitTypeDef ........................................................................ 146
8.1.2
COMP_HandleTypeDef .................................................................. 146
COMP Firmware driver API description ........................................ 147

8.2.1
COMP Peripheral features ............................................................. 147
8.2.2
8.2.3
8.2.4
8.2.5
Peripheral Control functions ........................................................... 149
8.2.6
Peripheral State functions .............................................................. 149
8.2.7
HAL_COMP_Init ............................................................................. 149
8.2.8
HAL_COMP_DeInit ........................................................................ 149
8.2.9
HAL_COMP_MspInit ...................................................................... 150
8.2.10
HAL_COMP_MspDeInit.................................................................. 150
8.2.11
HAL_COMP_Start .......................................................................... 150
8.2.12
HAL_COMP_Stop .......................................................................... 151
8.2.13
HAL_COMP_Start_IT ..................................................................... 151
8.2.14
HAL_COMP_Stop_IT ..................................................................... 151
8.2.15
HAL_COMP_IRQHandler ............................................................... 152
8.2.16
HAL_COMP_Lock .......................................................................... 152
8.2.17
HAL_COMP_GetOutputLevel ........................................................ 152
8.2.18
HAL_COMP_TriggerCallback ........................................................ 153
8.2.19
HAL_COMP_GetState.................................................................... 153
COMP Firmware driver defines ..................................................... 153

8.3.1
COMP ............................................................................................. 153
HAL CORTEX Generic Driver...................................................... 159

9.1
6/692
CEC ................................................................................................ 137
CORTEX Firmware driver API description .................................... 159

DocID026525 Rev 1
UM1785
Contents
9.2
9.1.1
9.1.2
9.1.3
9.1.4
HAL_NVIC_SetPriority ................................................................... 160
9.1.5
HAL_NVIC_EnableIRQ .................................................................. 160
9.1.6
HAL_NVIC_DisableIRQ.................................................................. 161
9.1.7
HAL_NVIC_SystemReset............................................................... 161
9.1.8
HAL_SYSTICK_Config ................................................................... 162
9.1.9
HAL_NVIC_GetPriority ................................................................... 162
9.1.10
HAL_NVIC_SetPendingIRQ ........................................................... 162
9.1.11
HAL_NVIC_GetPendingIRQ .......................................................... 163
9.1.12
HAL_NVIC_ClearPendingIRQ ........................................................ 163
9.1.13
HAL_SYSTICK_CLKSourceConfig ................................................ 163
9.1.14
HAL_SYSTICK_IRQHandler .......................................................... 164
9.1.15
HAL_SYSTICK_Callback ............................................................... 164
CORTEX Firmware driver defines ................................................. 164

9.2.1
10
CORTEX ......................................................................................... 164
HAL CRC Generic Driver ............................................................. 166

10.1
10.2
CRC Firmware driver registers structures ..................................... 166

10.1.1
CRC_InitTypeDef ........................................................................... 166
10.1.2
CRC_HandleTypeDef ..................................................................... 167
CRC Firmware driver API description ........................................... 167

10.2.1
10.2.2
10.2.3
10.2.4
10.2.5
HAL_CRC_Init ................................................................................ 168
10.2.6
HAL_CRC_DeInit ........................................................................... 169
10.2.7
HAL_CRC_MspInit ......................................................................... 169
10.2.8
HAL_CRC_MspDeInit..................................................................... 169
10.2.9
HAL_CRC_Accumulate .................................................................. 170
10.2.10 HAL_CRC_Calculate ...................................................................... 170

10.2.11 HAL_CRC_GetState....................................................................... 170
10.3
CRC Firmware driver defines ........................................................ 171

10.3.1
11
CRC ................................................................................................ 171
HAL CRC Extension Driver ......................................................... 173

11.1
CRCEx Firmware driver API description ....................................... 173

DocID026525 Rev 1
7/692
Contents
11.2
11.1.1
UM1785
Product specific features ................................................................ 173
11.1.2
11.1.3
11.1.4
HAL_CRCEx_Init ............................................................................ 173
11.1.5
HAL_CRCEx_Input_Data_Reverse ............................................... 173
11.1.6
HAL_CRCEx_Output_Data_Reverse............................................. 174
11.1.7
HAL_CRCEx_Polynomial_Set ....................................................... 174
CRCEx Firmware driver defines .................................................... 175

11.2.1
12
CRCEx ............................................................................................ 175
HAL DAC Generic Driver ............................................................. 177

12.1
12.2
DAC Firmware driver registers structures ..................................... 177

12.1.1
DAC_HandleTypeDef ..................................................................... 177
12.1.2
DAC_ChannelConfTypeDef ........................................................... 177
DAC Firmware driver API description............................................ 177

12.2.1
DAC Peripheral features................................................................. 178
12.2.2
12.2.3
12.2.4
12.2.5
12.2.6
Peripheral State and Errors functions ............................................ 180
12.2.7
HAL_DAC_Init ................................................................................ 181
12.2.8
HAL_DAC_DeInit ............................................................................ 181
12.2.9
HAL_DAC_MspInit ......................................................................... 181
12.2.10 HAL_DAC_MspDeInit ..................................................................... 182

12.2.11 HAL_DAC_Start ............................................................................. 182
12.2.12 HAL_DAC_Stop .............................................................................. 182
12.2.13 HAL_DAC_Start_DMA ................................................................... 183
12.2.14 HAL_DAC_Stop_DMA.................................................................... 183
12.2.15 HAL_DAC_ConvCpltCallbackCh1.................................................. 184
12.2.16 HAL_DAC_ConvHalfCpltCallbackCh1 ........................................... 184
12.2.17 HAL_DAC_ErrorCallbackCh1 ........................................................ 185
12.2.18 HAL_DAC_DMAUnderrunCallbackCh1 ......................................... 185
12.2.19 HAL_DAC_ConfigChannel ............................................................. 185
12.2.20 HAL_DAC_SetValue ...................................................................... 186
12.2.21 HAL_DAC_GetValue ...................................................................... 186
12.2.22 HAL_DAC_GetState ....................................................................... 187
12.2.23 HAL_DAC_GetError ....................................................................... 187
12.2.24 HAL_DAC_IRQHandler .................................................................. 187
8/692
DocID026525 Rev 1
UM1785
Contents
12.3
DAC Firmware driver defines ........................................................ 188

12.3.1
13
DAC ................................................................................................ 188
HAL DAC Extension Driver ......................................................... 192

13.1
DACEx Firmware driver API description ....................................... 192

13.1.1
13.1.2
Extended features functions ........................................................... 192
13.1.3
HAL_DAC_ConfigChannel ............................................................. 192
13.1.4
HAL_DAC_GetValue ...................................................................... 193
13.1.5
HAL_DAC_Start ............................................................................. 193
13.1.6
HAL_DAC_Start_DMA ................................................................... 194
13.1.7
HAL_DAC_IRQHandler .................................................................. 194
13.1.8
HAL_DACEx_DualGetValue .......................................................... 195
13.1.9
HAL_DACEx_TriangleWaveGenerate ........................................... 195
13.1.10 HAL_DACEx_NoiseWaveGenerate ............................................... 196

13.1.11 HAL_DACEx_DualSetValue ........................................................... 197
13.1.12 HAL_DACEx_ConvCpltCallbackCh2 ............................................. 197
13.1.13 HAL_DACEx_ConvHalfCpltCallbackCh2 ....................................... 198
13.1.14 HAL_DACEx_ErrorCallbackCh2 .................................................... 198
13.1.15 HAL_DACEx_DMAUnderrunCallbackCh2 ..................................... 198
13.1.16 DAC_DMAConvCpltCh2................................................................. 199
13.1.17 DAC_DMAHalfConvCpltCh2 .......................................................... 199
13.1.18 DAC_DMAErrorCh2 ....................................................................... 200
13.2
DACEx Firmware driver defines .................................................... 200

13.2.1
14
DACEx ............................................................................................ 200
HAL DMA Generic Driver ............................................................ 202

14.1
14.2
DMA Firmware driver registers structures ..................................... 202

14.1.1
DMA_InitTypeDef ........................................................................... 202
14.1.2
__DMA_HandleTypeDef................................................................. 202
DMA Firmware driver API description ........................................... 203

14.2.1
14.2.2
14.2.3
14.2.4
State and Errors functions .............................................................. 205
14.2.5
HAL_DMA_Init ................................................................................ 205
14.2.6
HAL_DMA_DeInit ........................................................................... 205
14.2.7
HAL_DMA_Start ............................................................................. 205
14.2.8
HAL_DMA_Start_IT ........................................................................ 206

DocID026525 Rev 1
9/692
Contents
14.2.9
UM1785
HAL_DMA_Abort ............................................................................ 206
14.2.10 HAL_DMA_PollForTransfer ............................................................ 207

14.2.11 HAL_DMA_IRQHandler.................................................................. 207
14.2.12 HAL_DMA_GetState ...................................................................... 208
14.2.13 HAL_DMA_GetError ....................................................................... 208
14.3
DMA Firmware driver defines ........................................................ 208

14.3.1
15
HAL DMA Extension Driver......................................................... 213

15.1
DMAEx Firmware driver defines.................................................... 213

15.1.1
16
DMA ................................................................................................ 208
DMAEx............................................................................................ 213
HAL FLASH Generic Driver......................................................... 220

16.1
16.2
FLASH Firmware driver registers structures ................................. 220

16.1.1
FLASH_EraseInitTypeDef .............................................................. 220
16.1.2
FLASH_OBProgramInitTypeDef .................................................... 220
16.1.3
FLASH_ProcessTypeDef ............................................................... 221
FLASH Firmware driver API description ........................................ 221

16.2.1
FLASH peripheral features ............................................................. 221
16.2.2
16.2.3
16.2.4
16.2.5
Peripheral Errors functions ............................................................. 223
16.2.6
HAL_FLASH_Program ................................................................... 223
16.2.7
HAL_FLASH_Program_IT .............................................................. 223
16.2.8
HAL_FLASH_IRQHandler .............................................................. 224
16.2.9
HAL_FLASH_EndOfOperationCallback ......................................... 224
16.2.10 HAL_FLASH_OperationErrorCallback ........................................... 225

16.2.11 HAL_FLASH_Unlock ...................................................................... 225
16.2.12 HAL_FLASH_Lock ......................................................................... 225
16.2.13 HAL_FLASH_OB_Unlock ............................................................... 226
16.2.14 HAL_FLASH_OB_Lock .................................................................. 226
16.2.15 HAL_FLASH_OB_Launch .............................................................. 226
16.2.16 HAL_FLASH_GetError ................................................................... 226
16.3
FLASH Firmware driver defines .................................................... 227

16.3.1
17
HAL FLASH Extension Driver ..................................................... 231

17.1
FLASHEx Firmware driver API description.................................... 231

17.1.1
10/692
FLASH ............................................................................................ 227
Flash peripheral extended features ................................................ 231

DocID026525 Rev 1
UM1785
Contents
17.2
17.1.2
17.1.3
17.1.4
17.1.5
HAL_FLASHEx_Erase ................................................................... 231
17.1.6
HAL_FLASHEx_Erase_IT .............................................................. 232
17.1.7
HAL_FLASHEx_OBErase .............................................................. 232
17.1.8
HAL_FLASHEx_OBProgram .......................................................... 233
17.1.9
HAL_FLASHEx_OBGetConfig ....................................................... 233
FLASHEx Firmware driver defines ................................................ 233

17.2.1
18
FLASHEx ........................................................................................ 233
HAL GPIO Generic Driver............................................................ 236

18.1
GPIO Firmware driver registers structures .................................... 236

18.1.1
18.2
GPIO_InitTypeDef .......................................................................... 236
GPIO Firmware driver API description .......................................... 236

18.2.1
GPIO Peripheral features ............................................................... 236
18.2.2
18.2.3
18.2.4
18.2.5
HAL_GPIO_Init ............................................................................... 238
18.2.6
HAL_GPIO_DeInit .......................................................................... 238
18.2.7
HAL_GPIO_ReadPin ...................................................................... 239
18.2.8
HAL_GPIO_WritePin ...................................................................... 239
18.2.9
HAL_GPIO_TogglePin ................................................................... 240
18.2.10 HAL_GPIO_LockPin ....................................................................... 240

18.2.11 HAL_GPIO_EXTI_IRQHandler ...................................................... 241
18.2.12 HAL_GPIO_EXTI_Callback ............................................................ 241
18.3
GPIO Firmware driver defines ....................................................... 241

18.3.1
19
HAL GPIO Extension Driver ........................................................ 245

19.1
GPIOEx Firmware driver defines................................................... 245

19.1.1
20
GPIO ............................................................................................... 241
GPIOEx .......................................................................................... 245
HAL I2C Generic Driver ............................................................... 248

20.1
20.2
I2C Firmware driver registers structures ....................................... 248

20.1.1
I2C_InitTypeDef .............................................................................. 248
20.1.2
I2C_HandleTypeDef ....................................................................... 248
I2C Firmware driver API description.............................................. 249

20.2.1

DocID026525 Rev 1
11/692
Contents
20.2.2
UM1785
20.2.3
20.2.4
20.2.5
HAL_I2C_Init .................................................................................. 254
20.2.6
HAL_I2C_DeInit .............................................................................. 254
20.2.7
HAL_I2C_MspInit ........................................................................... 254
20.2.8
HAL_I2C_MspDeInit ....................................................................... 255
20.2.9
HAL_I2C_Master_Transmit ............................................................ 255
20.2.10 HAL_I2C_Master_Receive ............................................................. 256

20.2.11 HAL_I2C_Slave_Transmit .............................................................. 256
20.2.12 HAL_I2C_Slave_Receive ............................................................... 256
20.2.13 HAL_I2C_Master_Transmit_IT ....................................................... 257
20.2.14 HAL_I2C_Master_Receive_IT ........................................................ 257
20.2.15 HAL_I2C_Slave_Transmit_IT ......................................................... 258
20.2.16 HAL_I2C_Slave_Receive_IT .......................................................... 258
20.2.17 HAL_I2C_Master_Transmit_DMA .................................................. 259
20.2.18 HAL_I2C_Master_Receive_DMA ................................................... 259
20.2.19 HAL_I2C_Slave_Transmit_DMA .................................................... 259
20.2.20 HAL_I2C_Slave_Receive_DMA ..................................................... 260
20.2.21 HAL_I2C_Mem_Write..................................................................... 260
20.2.22 HAL_I2C_Mem_Read .................................................................... 261
20.2.23 HAL_I2C_Mem_Write_IT ............................................................... 261
20.2.24 HAL_I2C_Mem_Read_IT ............................................................... 262
20.2.25 HAL_I2C_Mem_Write_DMA .......................................................... 262
20.2.26 HAL_I2C_Mem_Read_DMA .......................................................... 263
20.2.27 HAL_I2C_IsDeviceReady ............................................................... 263
20.2.28 HAL_I2C_EV_IRQHandler ............................................................. 264
20.2.29 HAL_I2C_ER_IRQHandler ............................................................. 264
20.2.30 HAL_I2C_MasterTxCpltCallback .................................................... 264
20.2.31 HAL_I2C_MasterRxCpltCallback ................................................... 265
20.2.32 HAL_I2C_SlaveTxCpltCallback ...................................................... 265
20.2.33 HAL_I2C_SlaveRxCpltCallback ..................................................... 265
20.2.34 HAL_I2C_MemTxCpltCallback ....................................................... 266
20.2.35 HAL_I2C_MemRxCpltCallback ...................................................... 266
20.2.36 HAL_I2C_ErrorCallback ................................................................. 267
20.2.37 HAL_I2C_GetState ......................................................................... 267
20.2.38 HAL_I2C_GetError ......................................................................... 267
20.3
I2C Firmware driver defines .......................................................... 268

20.3.1
12/692
I2C .................................................................................................. 268

DocID026525 Rev 1
UM1785
21
Contents
HAL I2C Extension Driver ........................................................... 273

21.1
21.2
I2CEx Firmware driver API description ......................................... 273

21.1.1
I2C peripheral extension features .................................................. 273
21.1.2
21.1.3
Extension features functions .......................................................... 273
21.1.4
HAL_I2CEx_AnalogFilter_Config ................................................... 273
21.1.5
HAL_I2CEx_DigitalFilter_Config .................................................... 274
21.1.6
HAL_I2CEx_EnableWakeUp .......................................................... 274
21.1.7
HAL_I2CEx_DisableWakeUp ......................................................... 274
I2CEx Firmware driver defines ...................................................... 275

21.2.1
22
I2CEx .............................................................................................. 275
HAL I2S Generic Driver ............................................................... 276

22.1
22.2
I2S Firmware driver registers structures ....................................... 276

22.1.1
I2S_InitTypeDef .............................................................................. 276
22.1.2
I2S_HandleTypeDef ....................................................................... 276
I2S Firmware driver API description .............................................. 277

22.2.1
22.2.2
22.2.3
22.2.4
22.2.5
HAL_I2S_Init .................................................................................. 280
22.2.6
HAL_I2S_DeInit .............................................................................. 280
22.2.7
HAL_I2S_MspInit............................................................................ 281
22.2.8
HAL_I2S_MspDeInit ....................................................................... 281
22.2.9
HAL_I2S_Transmit ......................................................................... 281
22.2.10 HAL_I2S_Receive .......................................................................... 282

22.2.11 HAL_I2S_Transmit_IT .................................................................... 283
22.2.12 HAL_I2S_Receive_IT ..................................................................... 283
22.2.13 HAL_I2S_Transmit_DMA ............................................................... 284
22.2.14 HAL_I2S_Receive_DMA ................................................................ 284
22.2.15 HAL_I2S_DMAPause ..................................................................... 285
22.2.16 HAL_I2S_DMAResume .................................................................. 285
22.2.17 HAL_I2S_DMAStop ........................................................................ 286
22.2.18 HAL_I2S_IRQHandler .................................................................... 286
22.2.19 HAL_I2S_TxHalfCpltCallback ........................................................ 286
22.2.20 HAL_I2S_TxCpltCallback ............................................................... 287
22.2.21 HAL_I2S_RxHalfCpltCallback ........................................................ 287
DocID026525 Rev 1
13/692
Contents
UM1785
22.2.22 HAL_I2S_RxCpltCallback .............................................................. 287
22.2.23 HAL_I2S_ErrorCallback ................................................................. 288
22.2.24 HAL_I2S_GetState ......................................................................... 288
22.2.25 HAL_I2S_GetError ......................................................................... 288
22.3
I2S Firmware driver defines .......................................................... 289

22.3.1
23
I2S .................................................................................................. 289
HAL IRDA Generic Driver ............................................................ 293

23.1
23.2
IRDA Firmware driver registers structures .................................... 293

23.1.1
IRDA_InitTypeDef ........................................................................... 293
23.1.2
IRDA_HandleTypeDef .................................................................... 293
IRDA Firmware driver API description........................................... 294

23.2.1
23.2.2
23.2.3
23.2.4
23.2.5
HAL_IRDA_Init ............................................................................... 297
23.2.6
HAL_IRDA_DeInit........................................................................... 298
23.2.7
HAL_IRDA_MspInit ........................................................................ 298
23.2.8
HAL_IRDA_MspDeInit .................................................................... 298
23.2.9
HAL_IRDA_Transmit ...................................................................... 299
23.2.10 HAL_IRDA_Receive ....................................................................... 299

23.2.11 HAL_IRDA_Transmit_IT ................................................................. 300
23.2.12 HAL_IRDA_Receive_IT .................................................................. 300
23.2.13 HAL_IRDA_Transmit_DMA ............................................................ 300
23.2.14 HAL_IRDA_Receive_DMA ............................................................. 301
23.2.15 HAL_IRDA_IRQHandler ................................................................. 301
23.2.16 HAL_IRDA_TxCpltCallback ............................................................ 301
23.2.17 HAL_IRDA_RxCpltCallback ........................................................... 302
23.2.18 HAL_IRDA_ErrorCallback .............................................................. 302
23.2.19 HAL_IRDA_GetState ...................................................................... 302
23.2.20 HAL_IRDA_GetError ...................................................................... 303
23.3
IRDA Firmware driver defines ....................................................... 303

23.3.1
24
HAL IRDA Extension Driver ........................................................ 311

24.1
IRDAEx Firmware driver defines ................................................... 311

24.1.1
25
14/692
IRDA ............................................................................................... 303
IRDAEx ........................................................................................... 311
HAL IWDG Generic Driver ........................................................... 312

DocID026525 Rev 1
UM1785
Contents
25.1
25.2
IWDG Firmware driver registers structures ................................... 312

25.1.1
IWDG_InitTypeDef ......................................................................... 312
25.1.2
IWDG_HandleTypeDef ................................................................... 312
IWDG Firmware driver API description ......................................... 312

25.2.1
IWDG Specific features .................................................................. 312
25.2.2
25.2.3
Initialization functions ..................................................................... 314
25.2.4
25.2.5
25.2.6
HAL_IWDG_Init .............................................................................. 314
25.2.7
HAL_IWDG_MspInit ....................................................................... 315
25.2.8
HAL_IWDG_Start ........................................................................... 315
25.2.9
HAL_IWDG_Refresh ...................................................................... 315
25.2.10 HAL_IWDG_GetState..................................................................... 316
25.3
IWDG Firmware driver defines ...................................................... 316

25.3.1
26
IWDG .............................................................................................. 316
HAL PCD Generic Driver ............................................................. 319

26.1
26.2
PCD Firmware driver registers structures ..................................... 319

26.1.1
PCD_InitTypeDef ............................................................................ 319
26.1.2
PCD_EPTypeDef ............................................................................ 319
26.1.3
PCD_HandleTypeDef ..................................................................... 320
PCD Firmware driver API description............................................ 321

26.2.1
26.2.2
26.2.3
26.2.4
26.2.5
26.2.6
HAL_PCD_Init ................................................................................ 322
26.2.7
HAL_PCD_DeInit ............................................................................ 323
26.2.8
HAL_PCD_MspInit ......................................................................... 323
26.2.9
HAL_PCD_MspDeInit ..................................................................... 323
26.2.10 HAL_PCD_Start ............................................................................. 324

26.2.11 HAL_PCD_Stop .............................................................................. 324
26.2.12 HAL_PCD_IRQHandler .................................................................. 324
26.2.13 HAL_PCD_DataOutStageCallback ................................................ 325
26.2.14 HAL_PCD_DataInStageCallback ................................................... 325
26.2.15 HAL_PCD_SetupStageCallback .................................................... 325
DocID026525 Rev 1
15/692
Contents
UM1785
26.2.16 HAL_PCD_SOFCallback ................................................................ 326
26.2.17 HAL_PCD_ResetCallback .............................................................. 326
26.2.18 HAL_PCD_SuspendCallback ......................................................... 326
26.2.19 HAL_PCD_ResumeCallback .......................................................... 327
26.2.20 HAL_PCD_ISOOUTIncompleteCallback........................................ 327
26.2.21 HAL_PCD_ISOINIncompleteCallback............................................ 327
26.2.22 HAL_PCD_ConnectCallback .......................................................... 328
26.2.23 HAL_PCD_DisconnectCallback ..................................................... 328
26.2.24 HAL_PCD_DevConnect ................................................................. 328
26.2.25 HAL_PCD_DevDisconnect ............................................................. 329
26.2.26 HAL_PCD_SetAddress .................................................................. 329
26.2.27 HAL_PCD_EP_Open ..................................................................... 329
26.2.28 HAL_PCD_EP_Close ..................................................................... 330
26.2.29 HAL_PCD_EP_Receive ................................................................. 330
26.2.30 HAL_PCD_EP_GetRxCount .......................................................... 331
26.2.31 HAL_PCD_EP_Transmit ................................................................ 331
26.2.32 HAL_PCD_EP_SetStall .................................................................. 331
26.2.33 HAL_PCD_EP_ClrStall................................................................... 332
26.2.34 HAL_PCD_EP_Flush ..................................................................... 332
26.2.35 HAL_PCD_ActiveRemoteWakeup ................................................. 332
26.2.36 HAL_PCD_DeActiveRemoteWakeup............................................. 333
26.2.37 HAL_PCD_GetState ....................................................................... 333
26.3
PCD Firmware driver defines ........................................................ 334

26.3.1
27
HAL PCD Extension Driver ......................................................... 343

27.1
28
PCDEx Firmware driver API description ....................................... 343

27.1.1
Peripheral extended features methods .......................................... 343
27.1.2
HAL_PCDEx_PMAConfig .............................................................. 343
HAL PWR Generic Driver ............................................................ 344

28.1
16/692
PCD ................................................................................................ 334
PWR Firmware driver API description ........................................... 344

28.1.1
28.1.2
28.1.3
HAL_PWR_EnableBkUpAccess .................................................... 346
28.1.4
HAL_PWR_DisableBkUpAccess.................................................... 346
28.1.5
HAL_PWR_EnableWakeUpPin ...................................................... 347
28.1.6
HAL_PWR_DisableWakeUpPin ..................................................... 347
28.1.7
HAL_PWR_EnterSLEEPMode ....................................................... 347
28.1.8
HAL_PWR_EnterSTOPMode ......................................................... 348

DocID026525 Rev 1
UM1785
Contents
28.1.9
HAL_PWR_EnterSTANDBYMode ................................................. 348
28.1.10 HAL_PWR_EnableSleepOnExit ..................................................... 349

28.1.11 HAL_PWR_DisableSleepOnExit .................................................... 349
28.1.12 HAL_PWR_EnableSEVOnPend .................................................... 350
28.1.13 HAL_PWR_DisableSEVOnPend .................................................... 350
28.1.14 HAL_PWR_EnableBkUpAccess .................................................... 350
28.1.15 HAL_PWR_DisableBkUpAccess.................................................... 351
28.2
PWR Firmware driver defines ....................................................... 351

28.2.1
29
PWR ............................................................................................... 351
HAL PWR Extension Driver ........................................................ 353

29.1
PWREx Firmware driver registers structures ................................ 353

29.1.1
29.2
PWR_PVDTypeDef ........................................................................ 353
PWREx Firmware driver API description ....................................... 353

29.2.1
Peripheral extended control functions ............................................ 353
29.2.2
HAL_PWR_PVDConfig .................................................................. 354
29.2.3
HAL_PWR_EnablePVD.................................................................. 354
29.2.4
HAL_PWR_DisablePVD ................................................................. 354
29.2.5
HAL_PWR_PVD_IRQHandler ........................................................ 355
29.2.6
HAL_PWR_PVDCallback ............................................................... 355
29.2.7
HAL_PWR_EnableVddio2Monitor .................................................. 355
29.2.8
HAL_PWR_DisableVddio2Monitor ................................................. 356
29.2.9
HAL_PWR_Vddio2Monitor_IRQHandler ........................................ 356
29.2.10 HAL_PWR_Vddio2MonitorCallback ............................................... 356
29.3
PWREx Firmware driver defines ................................................... 356

29.3.1
30
PWREx ........................................................................................... 356
HAL RCC Generic Driver ............................................................. 361

30.1
30.2
RCC Firmware driver registers structures ..................................... 361

30.1.1
RCC_PLLInitTypeDef ..................................................................... 361
30.1.2
RCC_OscInitTypeDef ..................................................................... 361
30.1.3
RCC_ClkInitTypeDef ...................................................................... 362
RCC Firmware driver API description ........................................... 362

30.2.1
RCC specific features ..................................................................... 362
30.2.2
RCC Limitations .............................................................................. 363
30.2.3
Initialization and de-initialization function ....................................... 363
30.2.4
30.2.5
HAL_RCC_DeInit ........................................................................... 365
30.2.6
HAL_RCC_OscConfig .................................................................... 365

DocID026525 Rev 1
17/692
Contents
30.2.7
UM1785
HAL_RCC_ClockConfig ................................................................. 365
30.2.8
HAL_RCC_MCOConfig .................................................................. 366
30.2.9
HAL_RCC_EnableCSS .................................................................. 367
30.2.10 HAL_RCC_DisableCSS ................................................................. 367

30.2.11 HAL_RCC_GetSysClockFreq ........................................................ 368
30.2.12 HAL_RCC_GetHCLKFreq .............................................................. 368
30.2.13 HAL_RCC_GetPCLK1Freq ............................................................ 369
30.2.14 HAL_RCC_GetOscConfig .............................................................. 369
30.2.15 HAL_RCC_GetClockConfig ........................................................... 369
30.2.16 HAL_RCC_NMI_IRQHandler ......................................................... 370
30.2.17 HAL_RCC_CCSCallback ............................................................... 370
30.3
RCC Firmware driver defines ........................................................ 370

30.3.1
31
RCC ................................................................................................ 370
HAL RCC Extension Driver ......................................................... 387

31.1
31.2
RCCEx Firmware driver registers structures ................................. 387

31.1.1
RCC_PeriphCLKInitTypeDef .......................................................... 387
31.1.2
RCC_CRSInitTypeDef .................................................................... 387
31.1.3
RCC_CRSSynchroInfoTypeDef ..................................................... 388
RCCEx Firmware driver API description ....................................... 388

31.2.1
31.2.2
Extended Peripheral Control functions ........................................... 389
31.2.3
HAL_RCC_OscConfig .................................................................... 389
31.2.4
HAL_RCC_ClockConfig ................................................................. 389
31.2.5
HAL_RCC_GetSysClockFreq ........................................................ 390
31.2.6
HAL_RCCEx_PeriphCLKConfig ..................................................... 391
31.2.7
HAL_RCCEx_GetPeriphCLKConfig ............................................... 391
31.2.8
HAL_RCCEx_CRSConfig............................................................... 392
31.2.9
HAL_RCCEx_CRSSoftwareSynchronizationGenerate .................. 392
31.2.10 HAL_RCCEx_CRSGetSynchronizationInfo ................................... 392

31.2.11 HAL_RCCEx_CRSWaitSynchronization ........................................ 393
31.3
RCCEx Firmware driver defines .................................................... 393

31.3.1
32
HAL RTC Generic Driver ............................................................. 405

32.1
18/692
RCCEx ............................................................................................ 393
RTC Firmware driver registers structures ..................................... 405

32.1.1
RTC_InitTypeDef ............................................................................ 405
32.1.2
RTC_TimeTypeDef......................................................................... 405
32.1.3
RTC_DateTypeDef ......................................................................... 406
32.1.4
RTC_AlarmTypeDef ....................................................................... 406

DocID026525 Rev 1
UM1785
Contents
32.1.5
32.2
RTC_HandleTypeDef ..................................................................... 407
RTC Firmware driver API description ............................................ 407

32.2.1
RTC Operating Condition ............................................................... 407
32.2.2
Backup Domain Reset .................................................................... 408
32.2.3
Backup Domain Access.................................................................. 408
32.2.4
How to use RTC Driver................................................................... 408
32.2.5
RTC and low power modes ............................................................ 409
32.2.6
32.2.7
RTC Time and Date functions ........................................................ 409
32.2.8
RTC Alarm functions ...................................................................... 410
32.2.9
32.2.10 Peripheral State functions .............................................................. 410

32.2.11 HAL_RTC_Init ................................................................................ 410
32.2.12 HAL_RTC_DeInit ............................................................................ 411
32.2.13 HAL_RTC_MspInit.......................................................................... 411
32.2.14 HAL_RTC_MspDeInit ..................................................................... 411
32.2.15 HAL_RTC_SetTime ........................................................................ 412
32.2.16 HAL_RTC_GetTime ....................................................................... 412
32.2.17 HAL_RTC_SetDate ........................................................................ 412
32.2.18 HAL_RTC_GetDate ........................................................................ 413
32.2.19 HAL_RTC_SetAlarm ...................................................................... 413
32.2.20 HAL_RTC_SetAlarm_IT ................................................................. 414
32.2.21 HAL_RTC_DeactivateAlarm ........................................................... 414
32.2.22 HAL_RTC_GetAlarm ...................................................................... 415
32.2.23 HAL_RTC_AlarmIRQHandler ......................................................... 415
32.2.24 HAL_RTC_AlarmAEventCallback .................................................. 416
32.2.25 HAL_RTC_PollForAlarmAEvent ..................................................... 416
32.2.26 HAL_RTC_WaitForSynchro ........................................................... 416
32.2.27 HAL_RTC_GetState ....................................................................... 417
32.3
RTC Firmware driver defines ........................................................ 417

32.3.1
33
RTC ................................................................................................ 417
HAL RTC Extension Driver ......................................................... 426

33.1
RTCEx Firmware driver registers structures ................................. 426

33.1.1
33.2
RTC_TamperTypeDef .................................................................... 426
RTCEx Firmware driver API description ........................................ 426

33.2.1
33.2.2
RTC TimeStamp and Tamper functions ......................................... 427
33.2.3
RTC Wake-up functions ................................................................. 428

DocID026525 Rev 1
19/692
Contents
33.2.4
UM1785
Extension Peripheral Control functions .......................................... 428
33.2.5
HAL_RTCEx_SetTimeStamp ......................................................... 428
33.2.6
HAL_RTCEx_SetTimeStamp_IT .................................................... 429
33.2.7
HAL_RTCEx_DeactivateTimeStamp ............................................. 429
33.2.8
HAL_RTCEx_GetTimeStamp......................................................... 430
33.2.9
HAL_RTCEx_SetTamper ............................................................... 430
33.2.10 HAL_RTCEx_SetTamper_IT .......................................................... 431

33.2.11 HAL_RTCEx_DeactivateTamper ................................................... 431
33.2.12 HAL_RTCEx_TamperTimeStampIRQHandler ............................... 431
33.2.13 HAL_RTCEx_TimeStampEventCallback ....................................... 432
33.2.14 HAL_RTCEx_Tamper1EventCallback ........................................... 432
33.2.17 HAL_RTCEx_PollForTimeStampEvent .......................................... 433
33.2.18 HAL_RTCEx_PollForTamper1Event .............................................. 433
33.2.21 HAL_RTCEx_SetWakeUpTimer .................................................... 434
33.2.22 HAL_RTCEx_SetWakeUpTimer_IT ............................................... 435
33.2.23 HAL_RTCEx_DeactivateWakeUpTimer ......................................... 435
33.2.24 HAL_RTCEx_GetWakeUpTimer .................................................... 436
33.2.25 HAL_RTCEx_WakeUpTimerIRQHandler ....................................... 436
33.2.26 HAL_RTCEx_WakeUpTimerEventCallback ................................... 436
33.2.27 HAL_RTCEx_PollForWakeUpTimerEvent ..................................... 437
33.2.28 HAL_RTCEx_BKUPWrite ............................................................... 437
33.2.29 HAL_RTCEx_BKUPRead .............................................................. 437
33.2.30 HAL_RTCEx_SetSmoothCalib ....................................................... 438
33.2.31 HAL_RTCEx_SetSynchroShift ....................................................... 438
33.2.32 HAL_RTCEx_SetCalibrationOutPut ............................................... 439
33.2.33 HAL_RTCEx_DeactivateCalibrationOutPut ................................... 439
33.2.34 HAL_RTCEx_SetRefClock ............................................................. 440
33.2.35 HAL_RTCEx_DeactivateRefClock ................................................. 440
33.2.36 HAL_RTCEx_EnableBypassShadow ............................................. 440
33.2.37 HAL_RTCEx_DisableBypassShadow ............................................ 441
33.3
RTCEx Firmware driver defines .................................................... 441

33.3.1
34
HAL SMARTCARD Generic Driver.............................................. 451

34.1
20/692
RTCEx ............................................................................................ 441
SMARTCARD Firmware driver registers structures ...................... 451

DocID026525 Rev 1
UM1785
Contents
34.2
34.1.1
SMARTCARD_InitTypeDef ............................................................ 451
34.1.2
SMARTCARD_AdvFeatureInitTypeDef.......................................... 452
34.1.3
SMARTCARD_HandleTypeDef ...................................................... 453
SMARTCARD Firmware driver API description............................. 454

34.2.1
34.2.2
34.2.3
34.2.4
34.2.5
HAL_SMARTCARD_Init ................................................................. 458
34.2.6
HAL_SMARTCARD_DeInit ............................................................ 458
34.2.7
HAL_SMARTCARD_MspInit .......................................................... 458
34.2.8
HAL_SMARTCARD_MspDeInit ..................................................... 459
34.2.9
HAL_SMARTCARD_Transmit........................................................ 459
34.2.10 HAL_SMARTCARD_Receive ......................................................... 459

34.2.11 HAL_SMARTCARD_Transmit_IT .................................................. 460
34.2.12 HAL_SMARTCARD_Receive_IT ................................................... 460
34.2.13 HAL_SMARTCARD_Transmit_DMA.............................................. 461
34.2.14 HAL_SMARTCARD_Receive_DMA............................................... 461
34.2.15 HAL_SMARTCARD_IRQHandler ................................................... 461
34.2.16 HAL_SMARTCARD_TxCpltCallback ............................................. 462
34.2.17 HAL_SMARTCARD_RxCpltCallback ............................................. 462
34.2.18 HAL_SMARTCARD_ErrorCallback ................................................ 462
34.2.19 HAL_SMARTCARD_GetState ....................................................... 463
34.2.20 HAL_SMARTCARD_GetError ........................................................ 463
34.3
SMARTCARD Firmware driver defines ......................................... 464

34.3.1
35
HAL SMARTCARD Extension Driver .......................................... 474

35.1
35.2
SMARTCARDEx Firmware driver API description ........................ 474

35.1.1
35.1.2
HAL_SMARTCARDEx_BlockLength_Config ................................. 474
35.1.3
HAL_SMARTCARDEx_TimeOut_Config ....................................... 474
35.1.4
HAL_SMARTCARDEx_EnableReceiverTimeOut .......................... 475
35.1.5
HAL_SMARTCARDEx_DisableReceiverTimeOut ......................... 475
SMARTCARDEx Firmware driver defines ..................................... 476

35.2.1
36
SMARTCARD ................................................................................. 464
SMARTCARDEx ............................................................................. 476
HAL SMBUS Generic Driver........................................................ 477

36.1
SMBUS Firmware driver registers structures ................................ 477

DocID026525 Rev 1
21/692
Contents
36.2
36.1.1
UM1785
SMBUS_InitTypeDef ...................................................................... 477
36.1.2
SMBUS_HandleTypeDef ................................................................ 478
SMBUS Firmware driver API description ...................................... 478

36.2.1
36.2.2
36.2.3
36.2.4
HAL_SMBUS_Init ........................................................................... 480
36.2.5
HAL_SMBUS_DeInit ...................................................................... 480
36.2.6
HAL_SMBUS_MspInit .................................................................... 481
36.2.7
HAL_SMBUS_MspDeInit................................................................ 481
36.2.8
HAL_SMBUS_Master_Transmit_IT ............................................... 481
36.2.9
HAL_SMBUS_Master_Receive_IT ................................................ 482
36.2.10 HAL_SMBUS_Master_Abort_IT ..................................................... 482

36.2.11 HAL_SMBUS_Slave_Transmit_IT ................................................. 483
36.2.12 HAL_SMBUS_Slave_Receive_IT .................................................. 483
36.2.13 HAL_SMBUS_Slave_Listen_IT ...................................................... 484
36.2.14 HAL_SMBUS_DisableListen_IT ..................................................... 484
36.2.15 HAL_SMBUS_EnableAlert_IT ........................................................ 485
36.2.16 HAL_SMBUS_DisableAlert_IT ....................................................... 485
36.2.17 HAL_SMBUS_IsDeviceReady ....................................................... 485
36.2.18 HAL_SMBUS_EV_IRQHandler ...................................................... 486
36.2.19 HAL_SMBUS_ER_IRQHandler ...................................................... 486
36.2.20 HAL_SMBUS_MasterTxCpltCallback ............................................ 486
36.2.21 HAL_SMBUS_MasterRxCpltCallback ............................................ 487
36.2.22 HAL_SMBUS_SlaveTxCpltCallback .............................................. 487
36.2.23 HAL_SMBUS_SlaveRxCpltCallback .............................................. 488
36.2.24 HAL_SMBUS_SlaveAddrCallback ................................................. 488
36.2.25 HAL_SMBUS_SlaveListenCpltCallback ......................................... 488
36.2.26 HAL_SMBUS_ErrorCallback .......................................................... 489
36.2.27 HAL_SMBUS_GetState.................................................................. 489
36.2.28 HAL_SMBUS_GetError .................................................................. 489
36.3
SMBUS Firmware driver defines ................................................... 490

36.3.1
37
HAL SPI Generic Driver ............................................................... 497

37.1
37.2
22/692
SMBUS ........................................................................................... 490
SPI Firmware driver registers structures ....................................... 497

37.1.1
SPI_InitTypeDef ............................................................................. 497
37.1.2
__SPI_HandleTypeDef ................................................................... 498
SPI Firmware driver API description ............................................. 499

DocID026525 Rev 1
UM1785
Contents
37.2.1
37.2.2
37.2.3
37.2.4
37.2.5
HAL_SPI_Init .................................................................................. 502
37.2.6
HAL_SPI_DeInit ............................................................................. 502
37.2.7
HAL_SPI_MspInit ........................................................................... 502
37.2.8
HAL_SPI_MspDeInit....................................................................... 503
37.2.9
HAL_SPI_InitExtended ................................................................... 503
37.2.10 HAL_SPI_Transmit ......................................................................... 503

37.2.11 HAL_SPI_Receive .......................................................................... 504
37.2.12 HAL_SPI_TransmitReceive ............................................................ 504
37.2.13 HAL_SPI_Transmit_IT.................................................................... 505
37.2.14 HAL_SPI_Receive_IT..................................................................... 505
37.2.15 HAL_SPI_TransmitReceive_IT ...................................................... 505
37.2.16 HAL_SPI_Transmit_DMA ............................................................... 506
37.2.17 HAL_SPI_Receive_DMA ................................................................ 506
37.2.18 HAL_SPI_TransmitReceive_DMA .................................................. 507
37.2.19 HAL_SPI_DMAPause..................................................................... 507
37.2.20 HAL_SPI_DMAResume ................................................................. 507
37.2.21 HAL_SPI_DMAStop ....................................................................... 508
37.2.22 HAL_SPI_IRQHandler .................................................................... 508
37.2.23 HAL_SPI_FlushRxFifo.................................................................... 508
37.2.24 HAL_SPI_TxCpltCallback .............................................................. 509
37.2.25 HAL_SPI_RxCpltCallback .............................................................. 509
37.2.26 HAL_SPI_TxRxCpltCallback .......................................................... 509
37.2.27 HAL_SPI_TxHalfCpltCallback ........................................................ 510
37.2.28 HAL_SPI_RxHalfCpltCallback ........................................................ 510
37.2.29 HAL_SPI_TxRxHalfCpltCallback .................................................... 510
37.2.30 HAL_SPI_ErrorCallback ................................................................. 511
37.2.31 HAL_SPI_GetState......................................................................... 511
37.2.32 HAL_SPI_GetError ......................................................................... 512
37.3
SPI Firmware driver defines .......................................................... 512

37.3.1
38
SPI .................................................................................................. 512
HAL TIM Generic Driver .............................................................. 519

38.1
TIM Firmware driver registers structures ....................................... 519

38.1.1
TIM_Base_InitTypeDef ................................................................... 519
38.1.2
TIM_OC_InitTypeDef...................................................................... 519
DocID026525 Rev 1
23/692
Contents
38.2
38.1.3
UM1785
TIM_OnePulse_InitTypeDef ........................................................... 520
38.1.4
TIM_IC_InitTypeDef ....................................................................... 521
38.1.5
TIM_Encoder_InitTypeDef ............................................................. 521
38.1.6
TIM_ClockConfigTypeDef .............................................................. 522
38.1.7
TIM_ClearInputConfigTypeDef ....................................................... 522
38.1.8
TIM_SlaveConfigTypeDef .............................................................. 523
38.1.9
TIM_HandleTypeDef ...................................................................... 523
TIM Firmware driver API description ............................................. 524

38.2.1
TIMER Generic features ................................................................. 524
38.2.2
38.2.3
Time Base functions ....................................................................... 525
38.2.4
Time Output Compare functions .................................................... 525
38.2.5
Time PWM functions ...................................................................... 526
38.2.6
Time Input Capture functions ......................................................... 526
38.2.7
Time One Pulse functions .............................................................. 527
38.2.8
Time Encoder functions .................................................................. 527
38.2.9
IRQ handler management .............................................................. 528
38.2.10 Peripheral Control functions ........................................................... 528

38.2.11 TIM Callbacks functions ................................................................. 528
38.2.12 Peripheral State functions .............................................................. 529
38.2.13 HAL_TIM_Base_Init ....................................................................... 529
38.2.14 HAL_TIM_Base_DeInit ................................................................... 529
38.2.15 HAL_TIM_Base_MspInit................................................................. 529
38.2.16 HAL_TIM_Base_MspDeInit ............................................................ 530
38.2.17 HAL_TIM_Base_Start..................................................................... 530
38.2.18 HAL_TIM_Base_Stop ..................................................................... 530
38.2.19 HAL_TIM_Base_Start_IT ............................................................... 531
38.2.20 HAL_TIM_Base_Stop_IT................................................................ 531
38.2.21 HAL_TIM_Base_Start_DMA .......................................................... 531
38.2.22 HAL_TIM_Base_Stop_DMA ........................................................... 532
38.2.23 HAL_TIM_OC_Init .......................................................................... 532
38.2.24 HAL_TIM_OC_DeInit...................................................................... 532
38.2.25 HAL_TIM_OC_MspInit ................................................................... 533
38.2.26 HAL_TIM_OC_MspDeInit ............................................................... 533
38.2.27 HAL_TIM_OC_Start ....................................................................... 533
38.2.28 HAL_TIM_OC_Stop........................................................................ 534
38.2.29 HAL_TIM_OC_Start_IT .................................................................. 534
38.2.30 HAL_TIM_OC_Stop_IT .................................................................. 535
38.2.31 HAL_TIM_OC_Start_DMA ............................................................. 535
24/692
DocID026525 Rev 1
UM1785
Contents
38.2.32 HAL_TIM_OC_Stop_DMA ............................................................. 536
38.2.33 HAL_TIM_PWM_Init ....................................................................... 536
38.2.34 HAL_TIM_PWM_DeInit .................................................................. 537
38.2.35 HAL_TIM_PWM_MspInit ................................................................ 537
38.2.36 HAL_TIM_PWM_MspDeInit ........................................................... 537
38.2.37 HAL_TIM_PWM_Start .................................................................... 538
38.2.38 HAL_TIM_PWM_Stop .................................................................... 538
38.2.39 HAL_TIM_PWM_Start_IT ............................................................... 538
38.2.40 HAL_TIM_PWM_Stop_IT ............................................................... 539
38.2.41 HAL_TIM_PWM_Start_DMA .......................................................... 539
38.2.42 HAL_TIM_PWM_Stop_DMA .......................................................... 540
38.2.43 HAL_TIM_IC_Init ............................................................................ 540
38.2.44 HAL_TIM_IC_DeInit ....................................................................... 541
38.2.45 HAL_TIM_IC_MspInit ..................................................................... 541
38.2.46 HAL_TIM_IC_MspDeInit................................................................. 541
38.2.47 HAL_TIM_IC_Start ......................................................................... 542
38.2.48 HAL_TIM_IC_Stop ......................................................................... 542
38.2.49 HAL_TIM_IC_Start_IT .................................................................... 543
38.2.50 HAL_TIM_IC_Stop_IT .................................................................... 543
38.2.51 HAL_TIM_IC_Start_DMA ............................................................... 543
38.2.52 HAL_TIM_IC_Stop_DMA ............................................................... 544
38.2.53 HAL_TIM_OnePulse_Init ................................................................ 544
38.2.54 HAL_TIM_OnePulse_DeInit ........................................................... 545
38.2.55 HAL_TIM_OnePulse_MspInit ......................................................... 545
38.2.56 HAL_TIM_OnePulse_MspDeInit .................................................... 546
38.2.57 HAL_TIM_OnePulse_Start ............................................................. 546
38.2.58 HAL_TIM_OnePulse_Stop ............................................................. 546
38.2.59 HAL_TIM_OnePulse_Start_IT ........................................................ 547
38.2.60 HAL_TIM_OnePulse_Stop_IT ........................................................ 547
38.2.61 HAL_TIM_Encoder_Init .................................................................. 548
38.2.62 HAL_TIM_Encoder_DeInit ............................................................. 548
38.2.63 HAL_TIM_Encoder_MspInit ........................................................... 548
38.2.64 HAL_TIM_Encoder_MspDeInit ....................................................... 549
38.2.65 HAL_TIM_Encoder_Start ............................................................... 549
38.2.66 HAL_TIM_Encoder_Stop ............................................................... 549
38.2.67 HAL_TIM_Encoder_Start_IT .......................................................... 550
38.2.68 HAL_TIM_Encoder_Stop_IT .......................................................... 550
38.2.69 HAL_TIM_Encoder_Start_DMA ..................................................... 551
DocID026525 Rev 1
25/692
Contents
UM1785
38.2.70 HAL_TIM_Encoder_Stop_DMA ..................................................... 551
38.2.71 HAL_TIM_IRQHandler ................................................................... 551
38.2.72 HAL_TIM_OC_ConfigChannel ....................................................... 552
38.2.73 HAL_TIM_IC_ConfigChannel ......................................................... 552
38.2.74 HAL_TIM_PWM_ConfigChannel .................................................... 553
38.2.75 HAL_TIM_OnePulse_ConfigChannel............................................. 553
38.2.76 HAL_TIM_DMABurst_WriteStart .................................................... 554
38.2.77 HAL_TIM_DMABurst_WriteStop .................................................... 555
38.2.78 HAL_TIM_DMABurst_ReadStart .................................................... 555
38.2.79 HAL_TIM_DMABurst_ReadStop .................................................... 556
38.2.80 HAL_TIM_GenerateEvent .............................................................. 557
38.2.81 HAL_TIM_ConfigOCrefClear .......................................................... 557
38.2.82 HAL_TIM_ConfigClockSource ....................................................... 558
38.2.83 HAL_TIM_ConfigTI1Input ............................................................... 558
38.2.84 HAL_TIM_SlaveConfigSynchronization ......................................... 559
38.2.85 HAL_TIM_SlaveConfigSynchronization_IT .................................... 559
38.2.86 HAL_TIM_ReadCapturedValue ...................................................... 560
38.2.87 HAL_TIM_PeriodElapsedCallback ................................................. 560
38.2.88 HAL_TIM_OC_DelayElapsedCallback ........................................... 560
38.2.89 HAL_TIM_IC_CaptureCallback ...................................................... 561
38.2.90 HAL_TIM_PWM_PulseFinishedCallback ....................................... 561
38.2.91 HAL_TIM_TriggerCallback ............................................................. 561
38.2.92 HAL_TIM_ErrorCallback................................................................. 562
38.2.93 HAL_TIM_Base_GetState .............................................................. 562
38.2.94 HAL_TIM_OC_GetState ................................................................. 562
38.2.95 HAL_TIM_PWM_GetState ............................................................. 563
38.2.96 HAL_TIM_IC_GetState................................................................... 563
38.2.97 HAL_TIM_OnePulse_GetState ...................................................... 563
38.2.98 HAL_TIM_Encoder_GetState ......................................................... 564
38.3
TIM Firmware driver defines.......................................................... 564

38.3.1
39
HAL TIM Extension Driver........................................................... 579

39.1
39.2
TIMEx Firmware driver registers structures................................... 579

39.1.1
TIM_HallSensor_InitTypeDef ......................................................... 579
39.1.2
TIM_MasterConfigTypeDef ............................................................ 579
39.1.3
TIM_BreakDeadTimeConfigTypeDef ............................................. 579
TIMEx Firmware driver API description ......................................... 580

39.2.1
26/692
TIM.................................................................................................. 564
TIMER Extended features .............................................................. 580

DocID026525 Rev 1
UM1785
Contents
39.2.2
39.2.3
Timer Hall Sensor functions ........................................................... 581
39.2.4
Timer Complementary Output Compare functions ......................... 582
39.2.5
Timer Complementary PWM functions ........................................... 582
39.2.6
Timer Complementary One Pulse functions................................... 582
39.2.7
39.2.8
HAL_TIMEx_HallSensor_Init .......................................................... 583
39.2.9
HAL_TIMEx_HallSensor_DeInit ..................................................... 583
39.2.10 HAL_TIMEx_HallSensor_MspInit ................................................... 584

39.2.11 HAL_TIMEx_HallSensor_MspDeInit .............................................. 584
39.2.12 HAL_TIMEx_HallSensor_Start ....................................................... 584
39.2.13 HAL_TIMEx_HallSensor_Stop ....................................................... 585
39.2.14 HAL_TIMEx_HallSensor_Start_IT .................................................. 585
39.2.15 HAL_TIMEx_HallSensor_Stop_IT .................................................. 585
39.2.16 HAL_TIMEx_HallSensor_Start_DMA ............................................. 586
39.2.17 HAL_TIMEx_HallSensor_Stop_DMA ............................................. 586
39.2.18 HAL_TIMEx_OCN_Start................................................................. 586
39.2.19 HAL_TIMEx_OCN_Stop ................................................................. 587
39.2.20 HAL_TIMEx_OCN_Start_IT ........................................................... 587
39.2.21 HAL_TIMEx_OCN_Stop_IT ........................................................... 588
39.2.22 HAL_TIMEx_OCN_Start_DMA ...................................................... 588
39.2.23 HAL_TIMEx_OCN_Stop_DMA ....................................................... 589
39.2.24 HAL_TIMEx_PWMN_Start ............................................................. 589
39.2.25 HAL_TIMEx_PWMN_Stop ............................................................. 590
39.2.26 HAL_TIMEx_PWMN_Start_IT ........................................................ 590
39.2.27 HAL_TIMEx_PWMN_Stop_IT ........................................................ 591
39.2.28 HAL_TIMEx_PWMN_Start_DMA ................................................... 591
39.2.29 HAL_TIMEx_PWMN_Stop_DMA ................................................... 592
39.2.30 HAL_TIMEx_OnePulseN_Start ...................................................... 592
39.2.31 HAL_TIMEx_OnePulseN_Stop ...................................................... 593
39.2.32 HAL_TIMEx_OnePulseN_Start_IT ................................................. 593
39.2.33 HAL_TIMEx_OnePulseN_Stop_IT ................................................. 593
39.2.34 HAL_TIMEx_ConfigCommutationEvent ......................................... 594
39.2.35 HAL_TIMEx_ConfigCommutationEvent_IT .................................... 595
39.2.36 HAL_TIMEx_ConfigCommutationEvent_DMA ............................... 595
39.2.37 HAL_TIMEx_MasterConfigSynchronization ................................... 596
39.2.38 HAL_TIMEx_ConfigBreakDeadTime.............................................. 597
39.2.39 HAL_TIMEx_RemapConfig ............................................................ 597
DocID026525 Rev 1
27/692
Contents
UM1785
39.2.40 HAL_TIMEx_CommutationCallback ............................................... 597
39.2.41 HAL_TIMEx_BreakCallback ........................................................... 598
39.2.42 HAL_TIMEx_DMACommutationCplt .............................................. 598
39.2.43 HAL_TIMEx_HallSensor_GetState ................................................ 598
39.3
TIMEx Firmware driver defines ..................................................... 599

39.3.1
40
TIMEx ............................................................................................. 599
HAL TSC Generic Driver ............................................................. 600

40.1
40.2
TSC Firmware driver registers structures ...................................... 600

40.1.1
TSC_InitTypeDef ............................................................................ 600
40.1.2
TSC_IOConfigTypeDef................................................................... 600
40.1.3
TSC_HandleTypeDef ..................................................................... 601
TSC Firmware driver API description ............................................ 601

40.2.1
TSC specific features ..................................................................... 601
40.2.2
40.2.3
40.2.4
40.2.5
State functions ................................................................................ 602
40.2.6
HAL_TSC_Init ................................................................................. 603
40.2.7
HAL_TSC_DeInit ............................................................................ 603
40.2.8
HAL_TSC_MspInit .......................................................................... 603
40.2.9
HAL_TSC_MspDeInit ..................................................................... 604
40.2.10 HAL_TSC_Start .............................................................................. 604

40.2.11 HAL_TSC_Start_IT......................................................................... 604
40.2.12 HAL_TSC_Stop .............................................................................. 605
40.2.13 HAL_TSC_Stop_IT ......................................................................... 605
40.2.14 HAL_TSC_GroupGetStatus ........................................................... 605
40.2.15 HAL_TSC_GroupGetValue ............................................................ 606
40.2.16 HAL_TSC_IOConfig ....................................................................... 606
40.2.17 HAL_TSC_IODischarge ................................................................. 607
40.2.18 HAL_TSC_GetState ....................................................................... 607
40.2.19 HAL_TSC_PollForAcquisition ........................................................ 607
40.2.20 HAL_TSC_IRQHandler .................................................................. 608
40.2.21 HAL_TSC_ConvCpltCallback ......................................................... 608
40.2.22 HAL_TSC_ErrorCallback................................................................ 608
40.3
TSC Firmware driver defines......................................................... 609

40.3.1
41
HAL UART Generic Driver........................................................... 618

41.1
28/692
TSC................................................................................................. 609
UART Firmware driver registers structures ................................... 618

DocID026525 Rev 1
UM1785
Contents
41.2
41.1.1
UART_InitTypeDef ......................................................................... 618
41.1.2
UART_AdvFeatureInitTypeDef ....................................................... 619
41.1.3
UART_WakeUpTypeDef ................................................................ 619
41.1.4
UART_HandleTypeDef ................................................................... 620
UART Firmware driver API description ......................................... 621

41.2.1
41.2.2
41.2.3
41.2.4
41.2.5
HAL_UART_Init .............................................................................. 625
41.2.6
HAL_HalfDuplex_Init ...................................................................... 626
41.2.7
HAL_MultiProcessor_Init ................................................................ 626
41.2.8
HAL_UART_DeInit ......................................................................... 627
41.2.9
HAL_UART_MspInit ....................................................................... 627
41.2.10 HAL_UART_MspDeInit................................................................... 627

41.2.11 HAL_UART_Transmit ..................................................................... 628
41.2.12 HAL_UART_Receive ...................................................................... 628
41.2.13 HAL_UART_Transmit_IT................................................................ 628
41.2.14 HAL_UART_Receive_IT................................................................. 629
41.2.15 HAL_UART_Transmit_DMA ........................................................... 629
41.2.16 HAL_UART_Receive_DMA ............................................................ 630
41.2.17 HAL_UART_DMAPause................................................................. 630
41.2.18 HAL_UART_DMAResume ............................................................. 630
41.2.19 HAL_UART_DMAStop ................................................................... 631
41.2.20 HAL_UART_TxCpltCallback .......................................................... 631
41.2.21 HAL_UART_TxHalfCpltCallback .................................................... 631
41.2.22 HAL_UART_RxCpltCallback .......................................................... 632
41.2.23 HAL_UART_RxHalfCpltCallback .................................................... 632
41.2.24 HAL_UART_ErrorCallback ............................................................. 632
41.2.25 HAL_MultiProcessor_EnableMuteMode ........................................ 633
41.2.26 HAL_MultiProcessor_DisableMuteMode........................................ 633
41.2.27 HAL_MultiProcessor_EnterMuteMode ........................................... 633
41.2.28 HAL_HalfDuplex_EnableTransmitter ............................................. 634
41.2.29 HAL_HalfDuplex_EnableReceiver ................................................. 634
41.2.30 HAL_UART_GetState..................................................................... 634
41.2.31 HAL_UART_GetError ..................................................................... 635
41.3
UART Firmware driver defines ...................................................... 635

41.3.1
UART .............................................................................................. 635

DocID026525 Rev 1
29/692
Contents
42
UM1785
HAL UART Extension Driver ....................................................... 648

42.1
UARTEx Firmware driver API description ..................................... 648

42.1.1
42.1.2
IO operation function ...................................................................... 648
42.1.3
42.1.4
HAL_RS485Ex_Init......................................................................... 649
42.1.5
HAL_LIN_Init .................................................................................. 650
42.1.6
HAL_UART_IRQHandler ................................................................ 650
42.1.7
HAL_UART_WakeupCallback ........................................................ 651
42.1.8
HAL_UARTEx_StopModeWakeUpSourceConfig .......................... 651
42.1.9
HAL_UARTEx_EnableStopMode ................................................... 651
42.1.10 HAL_UARTEx_DisableStopMode .................................................. 652

42.1.11 HAL_MultiProcessorEx_AddressLength_Set ................................. 652
42.1.12 HAL_LIN_SendBreak ..................................................................... 652
42.2
UARTEx Firmware driver defines .................................................. 653

42.2.1
43
UARTEx .......................................................................................... 653
HAL USART Generic Driver ........................................................ 655

43.1
43.2
USART Firmware driver registers structures ................................. 655

43.1.1
USART_InitTypeDef ....................................................................... 655
43.1.2
USART_HandleTypeDef ................................................................ 655
USART Firmware driver API description ....................................... 656

43.2.1
43.2.2
43.2.3
43.2.4
43.2.5
HAL_USART_Init ............................................................................ 660
43.2.6
HAL_USART_DeInit ....................................................................... 661
43.2.7
HAL_USART_MspInit ..................................................................... 661
43.2.8
HAL_USART_MspDeInit ................................................................ 661
43.2.9
HAL_USART_CheckIdleState ........................................................ 662
43.2.10 HAL_USART_Transmit .................................................................. 662

43.2.11 HAL_USART_Receive ................................................................... 662
43.2.12 HAL_USART_TransmitReceive ..................................................... 663
43.2.13 HAL_USART_Transmit_IT ............................................................. 663
43.2.14 HAL_USART_Receive_IT .............................................................. 664
43.2.15 HAL_USART_TransmitReceive_IT ................................................ 664
43.2.16 HAL_USART_Transmit_DMA ........................................................ 665
43.2.17 HAL_USART_Receive_DMA ......................................................... 665
30/692
DocID026525 Rev 1
UM1785
Contents
43.2.18 HAL_USART_TransmitReceive_DMA ........................................... 665
43.2.19 HAL_USART_DMAPause .............................................................. 666
43.2.20 HAL_USART_DMAResume ........................................................... 666
43.2.21 HAL_USART_DMAStop ................................................................. 667
43.2.22 HAL_USART_IRQHandler ............................................................. 667
43.2.23 HAL_USART_TxCpltCallback ........................................................ 667
43.2.24 HAL_USART_TxHalfCpltCallback .................................................. 668
43.2.25 HAL_USART_RxCpltCallback ........................................................ 668
43.2.26 HAL_USART_RxHalfCpltCallback ................................................. 668
43.2.27 HAL_USART_TxRxCpltCallback .................................................... 669
43.2.28 HAL_USART_ErrorCallback .......................................................... 669
43.2.29 HAL_USART_GetState .................................................................. 669
43.2.30 HAL_USART_GetError................................................................... 670
43.3
USART Firmware driver defines.................................................... 670

43.3.1
44
HAL USART Extension Driver .................................................... 677

44.1
USARTEx Firmware driver defines ............................................... 677

44.1.1
45
USART............................................................................................ 670
USARTEx ....................................................................................... 677
HAL WWDG Generic Driver ........................................................ 678

45.1
45.2
WWDG Firmware driver registers structures ................................. 678

45.1.1
WWDG_InitTypeDef ....................................................................... 678
45.1.2
WWDG_HandleTypeDef ................................................................ 678
WWDG Firmware driver API description ....................................... 678

45.2.1
WWDG specific features ................................................................ 678
45.2.2
45.2.3
45.2.4
45.2.5
45.2.6
HAL_WWDG_Init............................................................................ 680
45.2.7
HAL_WWDG_DeInit ....................................................................... 681
45.2.8
HAL_WWDG_MspInit ..................................................................... 681
45.2.9
HAL_WWDG_MspDeInit ................................................................ 681
45.2.10 HAL_WWDG_WakeupCallback ..................................................... 682

45.2.11 HAL_WWDG_Start ......................................................................... 682
45.2.12 HAL_WWDG_Start_IT.................................................................... 682
45.2.13 HAL_WWDG_Refresh .................................................................... 683
45.2.14 HAL_WWDG_IRQHandler ............................................................. 683
DocID026525 Rev 1
31/692
Contents
UM1785
45.2.15 HAL_WWDG_WakeupCallback ..................................................... 684
45.2.16 HAL_WWDG_GetState .................................................................. 684
45.3
WWDG Firmware driver defines.................................................... 684

45.3.1
WWDG............................................................................................ 684
46
FAQs............................................................................................. 687
47
Revision history .......................................................................... 691
32/692
DocID026525 Rev 1
UM1785
List of tables
List of tables
Table 1: Acronyms and definitions ............................................................................................................ 35
Table 2: HAL drivers files .......................................................................................................................... 37
Table 3: User-application files .................................................................................................................. 38
Table 4: APis classification ....................................................................................................................... 43
Table 5: List of devices supported by HAL drivers ................................................................................... 43
Table 6: HAL API naming rules ................................................................................................................ 45
Table 7: Macros handling interrupts and specific clock configurations .................................................... 46
Table 8: Callback functions ....................................................................................................................... 47
Table 9: HAL generic APIs ....................................................................................................................... 48
Table 10: HAL extension APIs .................................................................................................................. 49
Table 11: Define statements used for HAL configuration ......................................................................... 53
Table 12: Description of GPIO_InitTypeDef structure .............................................................................. 55
Table 13: Description of EXTI configuration macros ................................................................................ 57
Table 14: MSP functions ........................................................................................................................... 62
Table 15: Timeout values ......................................................................................................................... 66
Table 16: COMP Inputs for STM32F05xx, STM32F07x and STM32F09x devices ................................ 147
Table 17: COMP outputs for STM32F05xx, STM32F07x and STM32F09x devices .............................. 147
Table 18: Redirection of COMP outputs to embedded timers for STM32F05xx, STM32F07x and
STM32F09x devices ............................................................................................................................... 148
Table 19: IRDA frame formats ................................................................................................................ 296
Table 20: Number of wait states (WS) according to system clock (SYSCLK) frequency....................... 364
Table 21: USART frame formats ............................................................................................................ 456
Table 22: Maximum SPI frequency vs data size .................................................................................... 499
Table 23: UART frame formats ............................................................................................................... 623
Table 24: USART frame formats ............................................................................................................ 659
Table 25: Document revision history ...................................................................................................... 691
DocID026525 Rev 1
33/692
List of figures
UM1785
List of figures
Figure 1: Example of project template ...................................................................................................... 40
Figure 2: Adding device-specific functions ............................................................................................... 50
Figure 3: Adding family-specific functions ................................................................................................ 50
Figure 4: Adding new peripherals ............................................................................................................. 51
Figure 5: Updating existing APIs .............................................................................................................. 51
Figure 6: File inclusion model ................................................................................................................... 52
Figure 7: HAL driver model ....................................................................................................................... 60
34/692
DocID026525 Rev 1
UM1785
Acronyms and definitions

Table 1: Acronyms and definitions
Acronym
Definition
ADC
Analog-to-digital converter
ANSI
American National Standards Institute
API
Application Programming Interface
BSP
Board Support Package
COMP
Comparator
CMSIS
Cortex Microcontroller Software Interface Standard
CPU
CRYP
Central Processing Unit

Cryptographic processor unit
CRC
CRC calculation unit
DAC
Digital to analog converter
DMA
Direct Memory Access
EXTI
External interrupt/event controller
FLASH
Flash memory
GPIO
General purpose I/Os
HAL
Hardware abstraction layer
I2C
Inter-integrated circuit
I2S
Inter-integrated sound
IRDA
InfraRed Data Association
IWDG
Independent watchdog
LCD
Liquid Crystal Display Controler
MSP
MCU Specific Package
NVIC
Nested Vectored Interrupt Controller
PCD
USB Peripheral Controller Driver
PWR
Power controller
RCC
Reset and clock controller
RNG
Random Number Generator
RTC
Real-time clock
SD
SRAM
SMARTCARD
SPI
SysTick
Secure Digital
SRAM external memory
Smartcard IC
Serial Peripheral interface
System tick timer
TIM
Advanced-control, general-purpose or basic timer
TSC
Touch Sensing Controller
DocID026525 Rev 1
35/692
UM1785
Acronym
36/692
Definition
UART
Universal asynchronous receiver/transmitter
USART
Universal synchronous receiver/transmitter
WWDG
Window watchdog
USB
Universal Serial Bus
PPP
STM32 peripheral or block
DocID026525 Rev 1
UM1785
Overview of HAL drivers

The HAL drivers were designed to offer a rich set of APIs and to interact easily with the
application upper layers.
Each driver consists of a set of functions covering the most common peripheral features.
The development of each driver is driven by a common API which standardizes the driver
structure, the functions and the parameter names.
The HAL drivers consist of a set of driver modules, each module being linked to a
standalone peripheral. However, in some cases, the module is linked to a peripheral
functional mode. As an example, several modules exist for the USART peripheral: UART
driver module, USART driver module, SMARTCARD driver module and IRDA driver
module.
The HAL main features are the folllowing:
Cross-family portable set of APIs covering the common peripheral features as well as
extension APIs in case of specific peripheral features.
Three API programming models: polling, interrupt and DMA.
APIs are RTOS compliant:
Fully reentrant APIs
Systematic usage of timeouts in polling mode.

Peripheral multi-instance support allowing concurrent API calls for multiple instances
of a given peripheral (USART1, USART2...)
All HAL APIs implement user-callback functions mechanism:
Peripheral Init/DeInit HAL APIs can call user-callback functions to perform

peripheral system level Initialization/De-Initialization (clock, GPIOs, interrupt,
DMA)
Peripherals interrupt events
Error events.
Object locking mechanism: safe hardware access to prevent multiple spurious
accesses to shared resources.
Timeout used for all blocking processes: the timeout can be a simple counter or a
timebase.
2.1
HAL and user-application files
2.1.1
HAL driver files

A HAL drivers are composed of the following set of files:
Table 2: HAL drivers files
File
Description
stm32f0xx_hal_ppp.c
Main peripheral/module driver file.

It includes the APIs that are common to all STM32 devices.
Example: stm32f0xx_hal_adc.c, stm32f0xx_hal_irda.c,
stm32f0xx_hal_ppp.h
Header file of the main driver C file

It includes common data, handle and enumeration structures,
define statements and macros, as well as the exported generic
APIs.
Example: stm32f0xx_hal_adc.h, stm32f0xx_hal_irda.h,
DocID026525 Rev 1
37/692
UM1785
File
Description
stm32f0xx_hal_ppp_ex.c
Extension file of a peripheral/module driver. It includes the specific

APIs for a given part number or family, as well as the newly
defined APIs that overwrite the default generic APIs if the internal
process is implemented in different way.
Example: stm32f0xx_hal_adc_ex.c, stm32f0xx_hal_dma_ex.c,
stm32f0xx_hal_ppp_ex.h
Header file of the extension C file.

It includes the specific data and enumeration structures, define
statements and macros, as well as the exported device part
number specific APIs
Example: stm32f0xx_hal_adc_ex.h, stm32f0xx_hal_dma_ex.h,
stm32f0xx_hal.c
This file is used for HAL initialization and contains DBGMCU,

Remap and Time Delay based on systick APIs.
stm32f0xx_hal.h
stm32f0xx_hal.c header file
stm32f0xx_hal_msp_template.c
Template file to be copied to the user application folder.

It contains the MSP initialization and de-initialization (main routine
and callbacks) of the peripheral used in the user application.
stm32f0xx_hal_conf_template.h
Template file allowing to customize the drivers for a given

application.
stm32f0xx_hal_def.h
2.1.2
Common HAL resources such as common define statements,

enumerations, structures and macros.
User-application files
The minimum files required to build an application using the HAL are listed in the table
below:
Table 3: User-application files
File
system_stm32f0xx.c
Description
This file contains SystemInit() which is called at startup just after reset and
before branching to the main program. It does not configure the system
clock at startup (contrary to the standard library). This is to be done using
the HAL APIs in the user files.
It allows to :
38/692
relocate the vector table in internal SRAM.
startup_stm32f0xx.s
Toolchain specific file that contains reset handler and exception vectors.
For some toolchains, it allows adapting the stack/heap size to fit the
application requirements.
stm32f0xx_flash.icf
(optional)
Linker file for EWARM toolchain allowing mainly to adapt the stack/heap
size to fit the application requirements.
stm32f0xx_hal_msp.c
This file contains the MSP initialization and de-initialization (main routine
and callbacks) of the peripheral used in the user application.
stm32f0xx_hal_conf.h
This file allows the user to customize the HAL drivers for a specific
application.
It is not mandatory to modify this configuration. The application can use the
default configuration without any modification.
DocID026525 Rev 1
UM1785

File
stm32f0xx_it.c/.h
Description
This file contains the exceptions handler and peripherals interrupt service
routine, and calls HAL_IncTick() at regular time intervals to increment a
local variable (declared in stm32f0xx_hal.c) used as HAL timebase. By
default, this function is called each 1ms in Systick ISR. .
The PPP_IRQHandler() routine must call HAL_PPP_IRQHandler() if an
interrupt based process is used within the application.
This file contains the main program routine, mainly:
main.c/.h
the call to HAL_Init()

assert_failed() implementation
system clock configuration
peripheral HAL initialization and user application code.
The STM32Cube package comes with ready-to-use project templates, one for each
supported board. Each project contains the files listed above and a preconfigured project
for the supported toolchains.
Each project template provides empty main loop function and can be used as a starting
point to get familiar with project settings for STM32Cube. Their characteristics are the
following:
It contains sources of HAL, CMSIS and BSP drivers which are the minimal
components to develop a code on a given board.
It contains the include paths for all the firmware components.
It defines the STM32 device supported, and allows to configure the CMSIS and HAL
drivers accordingly.
It provides ready to use user files preconfigured as defined below:
HAL is initialized
SysTick ISR implemented for HAL_Delay()
System clock configured with the maximum frequency of the device

If an existing project is copied to another location, then include paths must be
updated.
DocID026525 Rev 1
39/692
UM1785
Figure 1: Example of project template
2.2
HAL data structures

Each HAL driver can contain the following data structures:
2.2.1
Peripheral handle structures

Initialization and configuration structures
Specific process structures.
Peripheral handle structures

The APIs have a modular generic multi-instance architecture that allows working with
several IP instances simultaneously.
PPP_HandleTypeDef *handle is the main structure that is implemented in the HAL
drivers. It handles the peripheral/module configuration and registers and embeds all the
structures and variables needed to follow the peripheral device flow.
The peripheral handle is used for the following purposes:
Multi instance support: each peripheral/module instance has its own handle. As a
result instance resources are independent.
Peripheral process intercommunication: the handle is used to manage shared data
resources between the process routines.
Example: global pointers, DMA handles, state machine.
Storage : this handle is used also to manage global variables within a given HAL
driver.
An example of peripheral structure is shown below:

typedef struct
{
USART_TypeDef *Instance; /* USART registers base address */
USART_InitTypeDef Init; /* Usart communication parameters */
uint8_t *pTxBuffPtr;/* Pointer to Usart Tx transfer Buffer */
uint16_t TxXferSize; /* Usart Tx Transfer size */
__IO uint16_t TxXferCount;/* Usart Tx Transfer Counter */
uint8_t *pRxBuffPtr;/* Pointer to Usart Rx transfer Buffer */
uint16_t RxXferSize; /* Usart Rx Transfer size */
__IO uint16_t RxXferCount; /* Usart Rx Transfer Counter */
DMA_HandleTypeDef *hdmatx; /* Usart Tx DMA Handle parameters */
DMA_HandleTypeDef *hdmarx; /* Usart Rx DMA Handle parameters */
HAL_LockTypeDef Lock; /* Locking object */
40/692
DocID026525 Rev 1
UM1785

__IO HAL_USART_StateTypeDef State; /* Usart communication state */
__IO HAL_USART_ErrorTypeDef ErrorCode;/* USART Error code */
}USART_HandleTypeDef;
1) The multi-instance feature implies that all the APIs used in the application are
re-entrant and avoid using global variables because subroutines can fail to be reentrant if they rely on a global variable to remain unchanged but that variable is
modified when the subroutine is recursively invoked. For this reason, the following
rules are respected:
Re-entrant code does not hold any static (or global) non-constant data: reentrant functions can work with global data. For example, a re-entrant
interrupt service routine can grab a piece of hardware status to work with
(e.g. serial port read buffer) which is not only global, but volatile. Still, typical
use of static variables and global data is not advised, in the sense that only
atomic read-modify-write instructions should be used in these variables. It
should not be possible for an interrupt or signal to occur during the execution
of such an instruction.
Reentrant code does not modify its own code.
2) When a peripheral can manage several processes simultaneously using the

DMA (full duplex case), the DMA interface handle for each process is added in the
PPP_HandleTypeDef.
3) For the shared and system peripherals, no handle or instance object is used.
The peripherals concerned by this exception are the following:
2.2.2
GPIO
SYSTICK
NVIC
PWR
RCC
FLASH.
Initialization and configuration structure

These structures are defined in the generic driver header file when it is common to all part
numbers. When they can change from one part number to another, the structures are
defined in the extension header file for each part number.
typedef struct
{
uint32_t BaudRate; /*!< This member configures the UART communication baudrate.*/
uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received
in a frame.*/
uint32_t StopBits; /*!< Specifies the number of stop bits transmitted.*/
uint32_t Parity; /*!< Specifies the parity mode. */
uint32_t Mode; /*!< Specifies wether the Receive or Transmit mode is enabled or
disabled.*/
uint32_t HwFlowCtl; /*!< Specifies wether the hardware flow control mode is enabled
or disabled.*/
uint32_t OverSampling; /*!< Specifies wether the Over sampling 8 is enabled or
disabled,
to achieve higher speed (up to fPCLK/8).*/
}UART_InitTypeDef;
DocID026525 Rev 1
41/692
UM1785
The config structure is used to initialize the sub-modules or sub-instances. See

below example:
HAL_ADC_ConfigChannel (ADC_HandleTypeDef* hadc, ADC_ChannelConfTypeDef*
sConfig)
2.2.3
Specific process structures

The specific process structures are used for specific process (common APIs). They are
defined in the generic driver header file.
Example:
HAL_PPP_Process (PPP_HandleTypeDef* hadc,PPP_ProcessConfig* sConfig)
2.3
API classification
The HAL APIs are classified into three categories:
Generic APIs:common generic APIs applying to all STM32 devices. These APIs are
consequently present in the generic HAL drivers files of all STM32 microcontrollers.
HAL_StatusTypeDef HAL_ADC_Init(ADC_HandleTypeDef* hadc);

HAL_StatusTypeDef HAL_ADC_DeInit(ADC_HandleTypeDef *hadc);
HAL_StatusTypeDef HAL_ADC_Start(ADC_HandleTypeDef* hadc);
HAL_StatusTypeDef HAL_ADC_Stop(ADC_HandleTypeDef* hadc);
HAL_StatusTypeDef HAL_ADC_Start_IT(ADC_HandleTypeDef* hadc);
HAL_StatusTypeDef HAL_ADC_Stop_IT(ADC_HandleTypeDef* hadc);
void HAL_ADC_IRQHandler(ADC_HandleTypeDef* hadc);
Extension APIs:This set of API is divided into two sub-categories :
Family specific APIs: APIs applying to a given family. They are located in the
extension HAL driver file (see example below related to the ADC).
HAL_StatusTypeDef HAL_ADCEx_Calibration_Start(ADC_HandleTypeDef* hadc, uint32_t

SingleDiff);
uint32_t HAL_ADCEx_Calibration_GetValue(ADC_HandleTypeDef* hadc, uint32_t
SingleDiff);
Device part number specific APIs:These APIs are implemented in the

extension file and delimited by specific define statements relative to a given part
number.
#if defined(STM32F042x6) || defined(STM32F048xx) || defined(STM32F072xB) ||

defined(STM32F078xx) || \
defined(STM32F091xC) || defined(STM32F098xx)
#endif /* STM32F042x6 || STM32F048xx || STM32F072xB || STM32F078xx || */
/* STM32F091xC || STM32F098xx */
The data structure related to the specific APIs is delimited by the device part
number define statement. It is located in the corresponding extension header C
file.
42/692
DocID026525 Rev 1
UM1785

The following table summarizes the location of the different categories of HAL APIs in the
driver files.
Table 4: APis classification
Generic file
Common APIs
Extension file
X
(1)
Family specific APIs
Device specific APIs
Notes:
(1)
In some cases, the implementation for a specific device part number may change . In this case the generic API
is declared as weak function in the extension file. The API is implemented again to overwrite the default function
Family specific APIs are only related to a given family. This means that if a
specific API is implemented in another family, and the arguments of this latter
family are different, additional structures and arguments might need to be added.
The IRQ handlers are used for common and family specific processes.
2.4
Devices supported by HAL drivers
IP/Module
STM32F030x6
STM32F030x8
STM32F070x6
STM32F070x8
STM32F030xC
STM32F031x6
STM32F051x8
STM32F071xB
STM32F091xC
STM32F042x6
STM32F072xB
STM32F048xx
STM32F058xx
STM32F078xx
STM32F098xx
Table 5: List of devices supported by HAL drivers
stm32f0xx_hal.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_adc.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_adc_ex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_can.c
No
No
No
No
No
No
No
No
Yes
Yes
Yes
Yes
No
Yes
Yes
stm32f0xx_hal_cec.c
No
No
No
No
No
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_comp.c
No
No
No
No
No
No
Yes
Yes
Yes
No
Yes
No
Yes
Yes
Yes
stm32f0xx_hal_cortex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_crc.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_crc_ex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_dac.c
No
No
No
No
No
No
Yes
Yes
Yes
No
Yes
No
Yes
Yes
Yes
stm32f0xx_hal_dac_ex.c
No
No
No
No
No
No
Yes
Yes
Yes
No
Yes
No
Yes
Yes
Yes
stm32f0xx_hal_dma.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_flash.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
DocID026525 Rev 1
43/692
IP/Module
STM32F030x8
STM32F070x6
STM32F070x8
STM32F030xC
STM32F031x6
STM32F051x8
STM32F071xB
STM32F091xC
STM32F042x6
STM32F072xB
STM32F048xx
STM32F058xx
STM32F078xx
STM32F098xx
UM1785
STM32F030x6
stm32f0xx_hal_flash_ex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_gpio.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_i2c.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_i2c_ex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_i2s.c
No
No
No
No
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_irda.c
No
No
No
No
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_iwdg.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_msp_template.c
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
stm32f0xx_hal_pcd.c
No
No
Yes
Yes
No
No
No
No
No
Yes
Yes
Yes
No
Yes
No
stm32f0xx_hal_pcd_ex.c
No
No
Yes
Yes
No
No
No
No
No
Yes
Yes
Yes
No
Yes
No
stm32f0xx_hal_pwr.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_pwr_ex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
No
No
No
No
stm32f0xx_hal_rcc.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_rcc_ex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_rtc.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_rtc_ex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_smartcard.c
No
No
No
No
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_smartcard_ex.c
No
No
No
No
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_smbus.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_spi.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_tim.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_tim_ex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_tsc.c
No
No
No
No
No
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_uart.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_uart_ex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_usart.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_wwdg.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
44/692
DocID026525 Rev 1
UM1785
2.5
HAL drivers rules
2.5.1
HAL API naming rules

The following naming rules are used in HAL drivers:
Table 6: HAL API naming rules
File names
Generic
Family specific
Device specific
stm32f0xx_hal_ppp (c/h)
stm32f0xx_hal_ppp_ex (c/h)
stm32f0xx_ hal_ppp_ex (c/h)
Module
name
HAL_PPP_ MODULE
Function
name
HAL_PPP_Function
HAL_PPP_FeatureFunction_M
ODE
HAL_PPPEx_Function
HAL_PPPEx_FeatureFunction_
MODE
HAL_PPPEx_Function
HAL_PPPEx_FeatureFunction_MO
DE
Handle
name
PPP_HandleTypedef
NA
NA
Init
structure
name
PPP_InitTypeDef
NA
PPP_InitTypeDef
Enum
name
HAL_PPP_StructnameTypeDef
NA
NA
The PPP prefix refers to the peripheral functional mode and not to the peripheral itself.
For example, if the USART, PPP can be USART, IRDA, UART or SMARTCARD
depending on the peripheral mode.
The constants used in one file are defined within this file. A constant used in several
files is defined in a header file. All constants are written in uppercase, except for
peripheral driver function parameters.
typedef variable names should be suffixed with _TypeDef.
Registers are considered as constants. In most cases, their name is in uppercase and
uses the same acronyms as in the STM32F0xx reference manuals.
Peripheral registers are declared in the PPP_TypeDef structure (e.g. ADC_TypeDef)
in the CMSIS header file corresponding to the selected platform: stm32f030x6.h,
stm32f030x8.h, stm32f031x6.h, stm32f038xx.h, stm32f042x6.h, stm32f048xx.h,
stm32f051x8.h, stm32f058xx.h, stm32f071xB.h, stm32f072xB.h, stm32f078xx.h,
stm32f091xC.h and stm32f098xx.h. The platform is selected by enabling the
compilation switch in the compilation toolchain directive or in the stm32f0xx.h file.
Peripheral function names are prefixed by HAL_, then the corresponding peripheral
acronym in uppercase followed by an underscore. The first letter of each word is in
uppercase (e.g. HAL_UART_Transmit()). Only one underscore is allowed in a function
name to separate the peripheral acronym from the rest of the function name.
The structure containing the PPP peripheral initialization parameters are named
PPP_InitTypeDef (e.g. ADC_InitTypeDef).
The structure containing the Specific configuration parameters for the PPP peripheral
are named PPP_xxxxConfTypeDef (e.g. ADC_ChannelConfTypeDef).
Peripheral handle structures are named PPP_HandleTypedef (e.g
DMA_HandleTypeDef)
The functions used to initialize the PPP peripheral according to parameters specified
in PPP_InitTypeDef are named HAL_PPP_Init (e.g. HAL_TIM_Init()).
DocID026525 Rev 1
45/692
2.5.2
UM1785
The functions used to reset the PPP peripheral registers to their default values are
named PPP_DeInit, e.g. TIM_DeInit.
The MODE suffix refers to the process mode, which can be polling, interrupt or DMA.
As an example, when the DMA is used in addition to the native resources, the function
should be called: HAL_PPP_Function_DMA ().
The Feature prefix should refer to the new feature.
Example: HAL_ADC_Start() refers to the injection mode
HAL general naming rules
For the shared and system peripherals, no handle or instance object is used. This rule
applies to the following peripherals:
GPIO
SYSTICK
NVIC
RCC
FLASH.
Example: The HAL_GPIO_Init() requires only the GPIO address and its configuration
parameters.
HAL_StatusTypeDef HAL_GPIO_Init (GPIO_TypeDef* GPIOx, GPIO_InitTypeDef *Init)
{
/*GPIO Initialization body */
}
The macros that handle interrupts and specific clock configurations are defined in
each peripheral/module driver. These macros are exported in the peripheral driver
header files so that they can be used by the extension file. The list of these macros is
defined below: This list is not exhaustive and other macros related to peripheral
features can be added, so that they can be used in the user application.
Table 7: Macros handling interrupts and specific clock configurations
Macros
__HAL_PPP_ENABLE_IT(__HANDLE__, __INTERRUPT__)
Enables a specific peripheral

interrupt
__HAL_PPP_DISABLE_IT(__HANDLE__, __INTERRUPT__)
Disables a specific peripheral

interrupt
__HAL_PPP_GET_IT (__HANDLE__, __ INTERRUPT __)

__HAL_PPP_CLEAR_IT (__HANDLE__, __ INTERRUPT __)
__HAL_PPP_GET_FLAG (__HANDLE__, __FLAG__)
__HAL_PPP_CLEAR_FLAG (__HANDLE__, __FLAG__)
46/692
Description
Gets a specific peripheral interrupt

status
Clears a specific peripheral
interrupt status
Gets a specific peripheral flag
status
Clears a specific peripheral flag
status
__HAL_PPP_ENABLE(__HANDLE__)
Enables a peripheral
__HAL_PPP_DISABLE(__HANDLE__)
Disables a peripheral
__HAL_PPP_XXXX (__HANDLE__, __PARAM__)
Specific PPP HAL driver macro
__HAL_PPP_GET_ IT_SOURCE (__HANDLE__, __

INTERRUPT __)
Checks the source of specified

interrupt
DocID026525 Rev 1
UM1785
NVIC and SYSTICK are two ARM Cortex core features. The APIs related to these
features are located in the stm32f0xx_hal_cortex.c file.
When a status bit or a flag is read from registers, it is composed of shifted values
depending on the number of read values and of their size. In this case, the returned
status width is 32 bits. Example : STATUS = XX | (YY << 16) or STATUS = XX | (YY
<< 8) | (YY << 16) | (YY << 24)".
The PPP handles are valid before using the HAL_PPP_Init() API. The init function
performs a check before modifying the handle fields.
HAL_PPP_Init(PPP_HandleTypeDef)
if(hppp == NULL)
{
return HAL_ERROR;
}
The macros defined below are used:
Conditional macro: #define ABS(x) (((x) > 0) ? (x) : -(x))
Pseudo-code macro (multiple instructions macro):
#define __HAL_LINKDMA(__HANDLE__, __PPP_DMA_FIELD_, __DMA_HANDLE_) \

do{ \
(__HANDLE__)->__PPP_DMA_FIELD_ = &(__DMA_HANDLE_); \
(__DMA_HANDLE_).Parent = (__HANDLE__); \
} while(0)
2.5.3
HAL interrupt handler and callback functions

Besides the APIs, HAL peripheral drivers include:
HAL_PPP_IRQHandler() peripheral interrupt handler that should be called from

stm32f0xx_it.c
User callback functions.
The user callback functions are defined as empty functions with weak attribute. They
have to be defined in the user code.
There are three types of user callbacks functions:
Peripheral system level initialization/ de-Initialization callbacks: HAL_PPP_MspInit()

and HAL_PPP_MspDeInit
Process complete callbacks : HAL_PPP_ProcessCpltCallback
Error callback: HAL_PPP_ErrorCallback.
Table 8: Callback functions
Callback functions
Example
HAL_PPP_MspInit() / _DeInit()
Ex: HAL_USART_MspInit()
Called from HAL_PPP_Init() API function to perform peripheral
system level initialization (GPIOs, clock, DMA, interrupt)
HAL_PPP_ProcessCpltCallback
Ex: HAL_USART_TxCpltCallback
Called by peripheral or DMA interrupt handler when the process
completes
HAL_PPP_ErrorCallback
Ex: HAL_USART_ErrorCallback
Called by peripheral or DMA interrupt handler when an error
occurs
DocID026525 Rev 1
47/692
2.6
UM1785
HAL generic APIs

The generic APIs provide common generic functions applying to all STM32 devices. They
are composed of four APIs groups:
Initialization and de-initialization functions:HAL_PPP_Init(), HAL_PPP_DeInit()

IO operation functions: HAL_PPP_Read(), HAL_PPP_Write(),HAL_PPP_Transmit(),
HAL_PPP_Receive()
Control functions: HAL_PPP_Set (), HAL_PPP_Get ().
State and Errors functions: HAL_PPP_GetState (), HAL_PPP_GetError ().
For some peripheral/module drivers, these groups are modified depending on the
peripheral/module implementation.
Example: in the timer driver, the API grouping is based on timer features (PWM, OC, IC...).
The initialization and de-initialization functions allow initializing a peripheral and configuring
the low-level resources, mainly clocks, GPIO, alternate functions (AF) and possibly DMA
and interrupts. The HAL_DeInit()function restores the peripheral default state, frees the
low-level resources and removes any direct dependency with the hardware.
The IO operation functions perform a row access to the peripheral payload data in write
and read modes.
The control functions are used to change dynamically the peripheral configuration and set
another operating mode.
The peripheral state and errors functions allow retrieving in runtime the peripheral and data
flow states, and identifying the type of errors that occurred. The example below is based on
the ADC peripheral. The list of generic APIs is not exhaustive. It is only given as an
example.
Table 9: HAL generic APIs
Function
Group
Common API Name
Description
HAL_ADC_Init()
This function initializes the peripheral and

configures the low -level resources (clocks,
GPIO, AF..)
HAL_ADC_DeInit()
This function restores the peripheral default state,

frees the low-level resources and removes any
direct dependency with the hardware.
HAL_ADC_Start ()
This function starts ADC conversions when the

polling method is used
HAL_ADC_Stop ()
This function stops ADC conversions when the

polling method is used
HAL_ADC_PollForConversion()
This function allows waiting for the end of

conversions when the polling method is used. In
this case, a timout value is specified by the user
according to the application.
HAL_ADC_Start_IT()
This function starts ADC conversions when the

interrupt method is used
HAL_ADC_Stop_IT()
This function stops ADC conversions when the

interrupt method is used
Initialization
group
IO operation
group
HAL_ADC_IRQHandler()
48/692
This function handles ADC interrupt requests
DocID026525 Rev 1
UM1785

Function
Group
Common API Name
Description
HAL_ADC_ConvCpltCallback()
Callback function called in the IT subroutine to

indicate the end of the current process or when a
DMA transfer has completed
HAL_ADC_ErrorCallback()
Callback function called in the IT subroutine if a

peripheral error or a DMA transfer error occurred
HAL_ADC_ConfigChannel()
This function configures the selected ADC regular

channel, the corresponding rank in the sequencer
and the sample time
HAL_ADC_AnalogWDGConfig
This function configures the analog watchdog for

the selected ADC
HAL_ADC_GetState()
This function allows getting in runtime the

peripheral and the data flow states.
HAL_ADC_GetError()
This fuction allows getting in runtime the error

that occurred during IT routine
Control group
State and
Errors group
2.7
HAL extension APIs
2.7.1
HAL extension model overview

The extension APIs provide specific functions or overwrite modified APIs for a specific
family (series) or specific part number within the same family.
The extension model consists of an additional file, stm32f0xx_hal_ppp_ex.c, that includes
all the specific functions and define statements (stm32f0xx_hal_ppp_ex.h) for a given part
number.
Below an example based on the ADC peripheral:
Table 10: HAL extension APIs
Function Group
Common API Name
HAL_ADCEx_CalibrationStart()
2.7.2
This function is used to start the automatic ADC calibration
HAL_ADCEx_Calibration_GetValue()
This function is used to get the ADC calibration factor
HAL_ADCEx_Calibration_SetValue()
This function is used to set the calibration factor to overwrite

automatic conversion result
HAL extension model cases

The specific IP features can be handled by the HAL drivers in five different ways. They are
described below.
Case1: Adding a part number-specific function

When a new feature specific to a given device is required, the new APIs are added in the
stm32f0xx_hal_ppp_ex.c extension file. They are named HAL_PPPEx_Function().
DocID026525 Rev 1
49/692
UM1785
Figure 2: Adding device-specific functions
Example: stm32f0xx_hal_rcc_ex.c/h
#if defined(STM32F042x6) || defined(STM32F048xx) || \
defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) || \
defined(STM32F091xC) || defined(STM32F098xx)
void HAL_RCCEx_CRSConfig(RCC_CRSInitTypeDef *pInit);
void HAL_RCCEx_CRSSoftwareSynchronizationGenerate(void);
void HAL_RCCEx_CRSGetSynchronizationInfo(RCC_CRSSynchroInfoTypeDef *pSynchroInfo);
RCC_CRSStatusTypeDef HAL_RCCEx_CRSWaitSynchronization(uint32_t Timeout);
#endif /* STM32F042x6 || STM32F048xx || */
/* STM32F071xB || STM32F072xB || STM32F078xx || */
/* STM32F091xC || STM32F098xx */
Case2: Adding a family-specific function

In this case, the API is added in the extension driver C file and named
HAL_PPPEx_Function ().
Figure 3: Adding family-specific functions
Case3 : Adding a new peripheral (specific to a device belonging to a given

family)
When a peripheral which is available only in a specific device is required, the APIs
corresponding to this new peripheral/module are added in stm32f0xx_hal_newppp.c.
However the inclusion of this file is selected in the stm32lxx_hal_conf.h using the macro:
#define HAL_NEWPPP_MODULE_ENABLED
50/692
DocID026525 Rev 1
UM1785

Figure 4: Adding new peripherals
Example: stm32f0xx_hal_lcd.c/h
Case4: Updating existing common APIs

In this case, the routines are defined with the same names in the stm32f0xx_hal_ppp_ex.c
extension file, while the generic API is defined as weak, so that the compiler will overwrite
the original routine by the new defined function.
Figure 5: Updating existing APIs
Case5 : Updating existing data structures

The data structure for a specific device part number (e.g. PPP_InitTypeDef) can have
different fields. In this case, the data structure is defined in the extension header file and
delimited by the specific part number define statement.
Example:
#if defined (STM32F072xB)
typedef struct
{
()
}PPP_InitTypeDef;
#endif /* STM32F072xB */
2.8
File inclusion model

The header of the common HAL driver file (stm32f0xx_hal.h) includes the common
configurations for the whole HAL library. It is the only header file that is included in the user
sources and the HAL C sources files to be able to use the HAL resources.
DocID026525 Rev 1
51/692
UM1785
Figure 6: File inclusion model
A PPP driver is a standalone module which is used in a project. The user must enable the
corresponding USE_HAL_PPP_MODULE define statement in the configuration file.
/*********************************************************************
* @file stm32f0xx_hal_conf.h
* @author MCD Application Team
* @version VX.Y.Z * @date dd-mm-yyyy
* @brief This file contains the modules to be used
**********************************************************************
()
#define USE_HAL_USART_MODULE
#define USE_HAL_IRDA_MODULE
#define USE_HAL_DMA_MODULE
#define USE_HAL_RCC_MODULE
()
2.9
HAL common resources

The common HAL resources, such as common define enumerations, structures and
macros, are defined in stm32f0xx_hal_def.h.The main common define enumeration is
HAL_StatusTypeDef.
HAL Status The HAL status is used by almost all HAL APIs, except for boolean
functions and IRQ handler. It returns the status of the current API operations. It has
four possible values as described below:
Typedef enum
{
HAL_OK = 0x00,
HAL_ERROR = 0x01,
HAL_BUSY = 0x02,
HAL_TIMEOUT = 0x03
} HAL_StatusTypeDef;
52/692
DocID026525 Rev 1
UM1785
HAL Locked The HAL lock is used by all HAL APIs to prevent accessing by accident
shared resources.
typedef enum
{
HAL_UNLOCKED = 0x00, /*!<Resources unlocked */
HAL_LOCKED = 0x01 /*!< Resources locked */
} HAL_LockTypeDef;In addition to common resources, the stm32f0xx_hal_def.h file
calls the stm32f0xx.h file in CMSIS library to get the data structures and the
address mapping for all peripherals:
Declarations of peripheral registers and bits definition.

Macros to access peripheral registers hardware (Write register, Read
registeretc.).
Common macros
Macros defining NULL and HAL_MAX_DELAY
#ifndef NULL
#define NULL (void *) 0
#endif
#define HAL_MAX_DELAY 0xFFFFFFFF
Macro linking a PPP peripheral to a DMA structure pointer:
__HAL_LINKDMA();#define __HAL_LINKDMA(__HANDLE__, __PPP_DMA_FIELD_, __DMA_HANDLE_) \

do{ \
(__HANDLE__)->__PPP_DMA_FIELD_ = &(__DMA_HANDLE_); \
(__DMA_HANDLE_).Parent = (__HANDLE__); \
} while(0)
2.10
HAL configuration
The configuration file, stm32f0xx_hal_conf.h, allows customizing the drivers for the user
application. Modifying this configuration is not mandatory: the application can use the
default configuration without any modification.
To configure these parameters, the user should enable, disable or modify some options by
uncommenting, commenting or modifying the values of the related define statements as
described in the table below:
Table 11: Define statements used for HAL configuration
Configuration item
HSE_VALUE
HSE_STARTUP_TIMEOUT
HSI_VALUE
HSI_STARTUP_TIMEOUT
LSE_VALUE
HSI14_VALUE
Description
Defines the value of the external oscillator (HSE)
expressed in Hz. The user must adjust this define
statement when using a different crystal value.
Timeout for HSE start up, expressed in ms
Defines the value of the internal oscillator (HSI)
expressed in Hz.
Timeout for HSI start up, expressed in ms
Default
Value
8 000 000
(Hz)
5000
16 000 000
(Hz)
5000
Defines the value of the external oscillator (HSE)

expressed in Hz. The user must adjust this define
statement when using a different crystal value.
32768 (Hz)
Defines the value of the Internal High Speed oscillator

for ADC expressed in Hz. The real value may vary
depending on the variations in voltage and
temperature.
14 000 000
(Hz)
DocID026525 Rev 1
53/692
UM1785
Configuration item
Description
Default
Value
HSI48_VALUE
Defines the value of the Internal High Speed oscillator

for USB expressed in Hz. The real value may vary
depending on the variations in voltage and
temperature.
48 000 000
(Hz)
LSI_VALUE
Defines the value of the Internal Low Speed oscillator

expressed in Hz. The real value may vary depending
on the variations in voltage and temperature.
40 000 (Hz)
VDD_VALUE
VDD value
3300 (mV)
USE_RTOS
Enables the use of RTOS
FALSE (for
future use)
PREFETCH_ENABLE
Enables prefetch feature
TRUE
The stm32f0xx_hal_conf_template.h file is located in the HAL drivers Inc folder. It

should be copied to the user folder, renamed and modified as described above.
By default, the values defined in the stm32f0xx_hal_conf_template.h file are the

same as the ones used for the examples and demonstrations. All HAL include
files are enabled so that they can be used in the user code without modifications.
2.11
HAL system peripheral handling

This chapter gives an overview of how the system peripherals are handled by the HAL
drivers. The full API list is provided within each peripheral driver description section.
2.11.1
Clock
Two main functions can be used to configure the system clock:
HAL_RCC_OscConfig (RCC_OscInitTypeDef *RCC_OscInitStruct). This function

configures/enables multiple clock sources (HSE, HSI, LSE, LSI, PLL).
HAL_RCC_ClockConfig (RCC_ClkInitTypeDef *RCC_ClkInitStruct, uint32_t
FLatency). This function
Selects the system clock source
Configures AHB and APB clock dividers
Configures the number of Flash memory wait states
Updates the SysTick configuration when HCLK clock changes.
Some peripheral clocks are not derived from the system clock (RTC, USB). In this case,
the clock configuration is performed by an extended API defined in
stm32f0xx_hal_rcc_ex.c: HAL_RCCEx_PeriphCLKConfig(RCC_PeriphCLKInitTypeDef
*PeriphClkInit).
Additional RCC HAL driver functions are available:
54/692
HAL_RCC_DeInit() Clock de-init function that return clock configuration to reset state
Get clock functions that allow retreiving various clock configurations (system clock,
HCLK, PCLK1, )
MCO and CSS configuration functions
DocID026525 Rev 1
UM1785

A set of macros are defined in stm32f0xx_hal_rcc.h and stm32f0xx_hal_rcc_ex.h. They
allow executing elementary operations on RCC block registers, such as peripherals clock
gating/reset control:
2.11.2
__PPP_CLK_ENABLE/__PPP_CLK_DISABLE to enable/disable the peripheral clock

__PPP_FORCE_RESET/__PPP_RELEASE_RESET to force/release peripheral reset
__PPP_CLK_SLEEP_ENABLE/__PPP_CLK_SLEEP_DISABLE to enable/disable the
peripheral clock during low power (Sleep) mode.
GPIOs
GPIO HAL APIs are the following:
HAL_GPIO_Init() / HAL_GPIO_DeInit()
HAL_GPIO_ReadPin() / HAL_GPIO_WritePin()
HAL_GPIO_TogglePin ().
In addition to standard GPIO modes (input, output, analog), pin mode can be configured as
EXTI with interrupt or event generation.
When selecting EXTI mode with interrupt generation, the user must call
HAL_GPIO_EXTI_IRQHandler() from stm32f0xx_it.c and implement
HAL_GPIO_EXTI_Callback()
The table below describes the GPIO_InitTypeDef structure field.
Table 12: Description of GPIO_InitTypeDef structure
Structure
field
Pin
Description
Specifies the GPIO pins to be configured.
Possible values: GPIO_PIN_x or GPIO_PIN_All, where x[0..15]
Specifies the operating mode for the selected pins: GPIO mode or EXTI mode.
Possible values are:
Mode
GPIO mode
GPIO_MODE_INPUT : Input Floating
GPIO_MODE_OUTPUT_PP : Output Push Pull
GPIO_MODE_OUTPUT_OD : Output Open Drain
GPIO_MODE_AF_PP : Alternate Function Push Pull
GPIO_MODE_AF_OD : Alternate Function Open Drain
GPIO_MODE_ANALOG : Analog mode

External Interrupt Mode
GPIO_MODE_IT_RISING : Rising edge trigger detection
GPIO_MODE_IT_FALLING : Falling edge trigger detection
GPIO_MODE_IT_RISING_FALLING : Rising/Falling edge trigger

detection
External Event Mode
GPIO_MODE_EVT_RISING : Rising edge trigger detection
GPIO_MODE_EVT_FALLING : Falling edge trigger detection
GPIO_MODE_EVT_RISING_FALLING: Rising/Falling edge trigger

detection
DocID026525 Rev 1
55/692
UM1785
Structure
field
Pull
Speed
Alternate
Description
Specifies the Pull-up or Pull-down activation for the selected pins.
GPIO_NOPULL
GPIO_PULLUP
GPIO_PULLDOWN
Specifies the speed for the selected pins
GPIO_SPEED_LOW
GPIO_SPEED_MEDIUM
GPIO_SPEED_HIGH
Peripheral to be connected to the selected pins.
Possible values: GPIO_AFx_PPP, where
AFx: is the alternate function index
PPP: is the peripheral instance
Example: use GPIO_AF1_TIM2 to connect TIM2 IOs on AF1.
These values are defined in the GPIO extended driver, since the AF mapping may
change between product lines.
Refer to the Alternate function mapping table in the datasheets
for the detailed description of the system and peripheral I/O
alternate functions.
Please find below typical GPIO configuration examples:
Configuring GPIOs as output push-pull to drive external LEDs
GPIO_InitStruct.Pin = GPIO_PIN_12 | GPIO_PIN_13 | GPIO_PIN_14 | GPIO_PIN_15;

GPIO_InitStruct.Mode = GPIO_MODE_OUTPUT_PP;
GPIO_InitStruct.Pull = GPIO_PULLUP;
GPIO_InitStruct.Speed = GPIO_SPEED_MEDIUM;
HAL_GPIO_Init(GPIOD, &GPIO_InitStruct);
Configuring PA0 as external interrupt with falling edge sensitivity:
GPIO_InitStructure.Mode = GPIO_MODE_IT_FALLING;
GPIO_InitStructure.Pull = GPIO_NOPULL;
GPIO_InitStructure.Pin = GPIO_PIN_0;
HAL_GPIO_Init(GPIOA, &GPIO_InitStructure);
Configuring USART1 Tx (PA9, mapped on AF4) as alternate function:
GPIO_InitStruct.Pin = GPIO_PIN_9;
GPIO_InitStruct.Mode = GPIO_MODE_AF_PP;
GPIO_InitStruct.Pull = GPIO_PULLUP;
GPIO_InitStruct.Speed = GPIO_SPEED_FAST;
GPIO_InitStruct.Alternate = GPIO_AF4_USART1;
HAL_GPIO_Init(GPIOA, &GPIO_InitStruct);
2.11.3
Cortex NVIC and SysTick timer

The Cortex HAL driver, stm32f0xx_hal_cortex.c, provides APIs to handle NVIC and
Systick. The supported APIs include:
56/692
HAL_NVIC_SetPriority()
DocID026525 Rev 1
UM1785
2.11.4
HAL_NVIC_EnableIRQ()/HAL_NVIC_DisableIRQ()
HAL_NVIC_SystemReset()
HAL_SYSTICK_IRQHandler()
HAL_NVIC_GetPendingIRQ() / HAL_NVIC_SetPendingIRQ () /
HAL_NVIC_ClearPendingIRQ()
HAL_SYSTICK_Config()
HAL_SYSTICK_CLKSourceConfig()
HAL_SYSTICK_Callback()
PWR
The PWR HAL driver handles power management. The features shared between all
STM32 Series are listed below:
2.11.5
PVD configuration, enabling/disabling and interrupt handling
HAL_PWR_PVDConfig()
HAL_PWR_EnablePVD() / HAL_PWR_DisablePVD()
HAL_PWR_PVD_IRQHandler()
HAL_PWR_PVDCallback()
Wakeup pin configuration
HAL_PWR_EnableWakeUpPin() / HAL_PWR_DisableWakeUpPin()
Low power mode entry
HAL_PWR_EnterSLEEPMode()
HAL_PWR_EnterSTOPMode()
HAL_PWR_EnterSTANDBYMode()
Backup domain configuration
HAL_PWR_EnableBkUpAccess()/ HAL_PWR_DisableBkUpAccess()
EXTI
The EXTI is not considered as a standalone peripheral but rather as a service used by
other peripheral. As a result there are no EXTI APIs but each peripheral HAL driver
implements the associated EXTI configuration and EXTI function are implemented as
macros in its header file.
The first 16 EXTI lines connected to the GPIOs are managed within the GPIO driver. The
GPIO_InitTypeDef structure allows configuring an I/O as external interrupt or external
event.
The EXTI lines connected internally to the PVD, RTC, USB, and COMP are configured
within the HAL drivers of these peripheral through the macros given in the table below. The
EXTI internal connections depend on the targeted STM32 microcontroller (refer to the
product datasheet for more details):
Table 13: Description of EXTI configuration macros
Macros
Description
Defines the EXTI line connected to the internal peripheral.
Example:
#define PWR_EXTI_LINE_PVD ((uint32_t)0x00010000) /*!<External
interrupt line 16 Connected to the PVD EXTI Line */
PPP_EXTI_LINE_FUNCTION
__HAL_PPP_EXTI_ENABLE_IT
Enables a given EXTI line

Example:
__HAL_PWR_PVD_EXTI_ENABLE_IT()
DocID026525 Rev 1
57/692
UM1785
Macros
Description
__HAL_PPP_EXTI_DISABLE_IT
Disables a given EXTI line.

Example:
__HAL_PWR_PVD_EXTI_DISABLE_IT()
__HAL_PPP_EXTI_GET_FLAG
Gets a given EXTI line interrupt flag pending bit status.

Example:
__HAL_PWR_PVD_EXTI_GET_FLAG()
__HAL_PPP_EXTI_CLEAR_FLAG
__HAL_PPP_EXTI_GENERATE_SWIT
Clears a given EXTI line interrupt flag pending bit.

Example;
__HAL_PWR_PVD_EXTI_CLEAR_FLAG()
Generates a software interrupt for a given EXTI line.
Example:
__HAL_PWR_PVD_EXTI_GENERATE_SWIT()
__HAL_PPP_EXTI_ENABLE_EVENT
Enables event on a given EXTI Line

Example:
_HAL_PWR_PVD_EXTI_ENABLE_EVENT()
__HAL_PPP_EXTI_DISABLE_EVENT
Disables event on a given EXTI line

Example:
__HAL_PWR_PVD_EXTI_DISABLE_EVENT()
If the EXTI interrupt mode is selected, the user application must call
HAL_PPP_FUNCTION_IRQHandler() (for example HAL_PWR_PVD_IRQHandler()), from
stm32f0xx_it.c file, and implement HAL_PPP_FUNCTIONCallback() callback function (for
example HAL_PWR_PVDCallback().
2.11.6
DMA
The DMA HAL driver allows enabling and configuring the peripheral to be connected to the
DMA Channels (except for internal SRAM/FLASH memory which do not require any
initialization). Refer to the product reference manual for details on the DMA request
corresponding to each peripheral.
For a given channel, HAL_DMA_Init() API allows programming the required configuration
through the following parameters:
Transfer Direction
Source and Destination data formats
Circular, Normal or peripheral flow control mode
Channels Priority level
Source and Destination Increment mode
FIFO mode and its Threshold (if needed)
Burst mode for Source and/or Destination (if needed).
Two operating modes are available:
58/692
Polling mode I/O operation

a. Use HAL_DMA_Start() to start DMA transfer when the source and destination
addresses and the Length of data to be transferred have been configured.
b.
Use HAL_DMA_PollForTransfer() to poll for the end of current transfer. In this
case a fixed timeout can be configured depending on the user application.
DocID026525 Rev 1
UM1785
Interrupt mode I/O operation

a.
Configure the DMA interrupt priority using HAL_NVIC_SetPriority()
b.
Enable the DMA IRQ handler using HAL_NVIC_EnableIRQ()
c.
Use HAL_DMA_Start_IT() to start DMA transfer when the source and destination
addresses and the length of data to be transferred have been confgured. In this
case the DMA interrupt is configured.
d.
Use HAL_DMA_IRQHandler() called under DMA_IRQHandler() Interrupt
subroutine
e.
When data transfer is complete, HAL_DMA_IRQHandler() function is executed
and a user function can be called by customizing XferCpltCallback and
XferErrorCallback function pointer (i.e. a member of DMA handle structure).
Additional functions and macros are available to ensure efficient DMA management:
Use HAL_DMA_GetState() function to return the DMA state and

HAL_DMA_GetError() in case of error detection.
Use HAL_DMA_Abort() function to abort the current transfer
The most used DMA HAL driver macros are the following:
__HAL_DMA_ENABLE: enablse the specified DMA Channels.

__HAL_DMA_DISABLE: disables the specified DMA Channels.
__HAL_DMA_GET_FLAG: gets the DMA Channels pending flags.
__HAL_DMA_CLEAR_FLAG: clears the DMA Channels pending flags.
__HAL_DMA_ENABLE_IT: enables the specified DMA Channels interrupts.
__HAL_DMA_DISABLE_IT: disables the specified DMA Channels interrupts.
__HAL_DMA_GET_IT_SOURCE: checks whether the specified DMA channel
interrupt has occurred or not.
When a peripheral is used in DMA mode, the DMA initialization should be done in
the HAL_PPP_MspInit() callback. In addition, the user application should
associate the DMA handle to the PPP handle (refer to section HAL IO operation
functions).
DMA channel callbacks need to be initialized by the user application only in case
of memory-to-memory transfer. However when peripheral-to-memory transfers
are used, these callbacks are automatically initialized by calling a process API
function that uses the DMA.
DocID026525 Rev 1
59/692
UM1785
2.12
How to use HAL drivers
2.12.1
HAL usage models

The following figure shows the typical use of the HAL driver and the interaction between
the application user, the HAL driver and the interrupts.
Figure 7: HAL driver model
Basically, the HAL driver APIs are called from user files and optionally from interrupt
handlers file when the APIs based on the DMA or the PPP peripheral dedicated interrupts
are used.
When DMA or PPP peripheral interrupts are used, the PPP process complete callbacks are
called to inform the user about the process completion in real-time event mode (interrupts).
Note that the same process completion callbacks are used for DMA in interrupt mode.
2.12.2
HAL initialization
2.12.2.1
HAL global initialization

In addition to the peripheral initialization and de-initialization functions, a set of APIs are
provided to initialize the HAL core implemented in file stm32f0xx_hal.c.
60/692
HAL_Init(): this function must be called at application startup to
Initialize data/instruction cache and pre-fetch queue

DocID026525 Rev 1
UM1785
2.12.2.2
Set Systick timer to generate an interrupt each 1ms (based on HSI clock) with the
lowest priority
Call HAL_MspInit() user callback function to perform system level initializations

(Clock, GPIOs, DMA, interrupts). HAL_MspInit() is defined as weak empty
function in the HAL drivers.
HAL_DeInit()
Resets all peripherals
Calls function HAL_MspDeInit() which a is user callback function to do system

level De-Initalizations.
HAL_GetTick(): this function gets current SysTick counter value (incremented in
SysTick interrupt) used by peripherals drivers to handle timeouts.
HAL_Delay(). this function implements a delay (expressed in milliseconds) using the
SysTick timer.
Care must be taken when using HAL_Delay() since this function provides an accurate
delay (expressed in milliseconds) based on a variable incremented in SysTick ISR.
This means that if HAL_Delay() is called from a peripheral ISR, then the SysTick
interrupt must have highest priority (numerically lower) than the peripheral interrupt,
otherwise the caller ISR will be blocked.
System clock initialization

The clock configuration is done at the beginning of the user code. However the user can
change the configuration of the clock in his own code. Please find below the typical Clock
configuration sequence:
static void SystemClock_Config(void)
{
RCC_ClkInitTypeDef RCC_ClkInitStruct;
RCC_OscInitTypeDef RCC_OscInitStruct;
/* Enable HSE Oscillator and Activate PLL with HSE as source */
RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_HSE;
RCC_OscInitStruct.HSEState = RCC_HSE_ON;
RCC_OscInitStruct.PLL.PLLState = RCC_PLL_ON;
RCC_OscInitStruct.PLL.PLLSource = RCC_PLLSOURCE_HSE;
RCC_OscInitStruct.PLL.PREDIV = RCC_PREDIV_DIV1;
RCC_OscInitStruct.PLL.PLLMUL = RCC_PLL_MUL6;
if (HAL_RCC_OscConfig(&RCC_OscInitStruct)!= HAL_OK)
{
Error_Handler();
}
/* Select PLL as system clock source and configure the HCLK, PCLK1 clocks dividers
*/
RCC_ClkInitStruct.ClockType = (RCC_CLOCKTYPE_SYSCLK | RCC_CLOCKTYPE_HCLK |
RCC_CLOCKTYPE_PCLK1);
RCC_ClkInitStruct.SYSCLKSource = RCC_SYSCLKSOURCE_PLLCLK;
RCC_ClkInitStruct.AHBCLKDivider = RCC_SYSCLK_DIV1;
RCC_ClkInitStruct.APB1CLKDivider = RCC_HCLK_DIV1;
if (HAL_RCC_ClockConfig(&RCC_ClkInitStruct, FLASH_LATENCY_1)!= HAL_OK)
{
Error_Handler();
}
}
2.12.2.3
HAL MSP initialization process

The peripheral initialization is done through HAL_PPP_Init() while the hardware resources
initialization used by a peripheral (PPP) is performed during this initialization by calling
MSP callback function HAL_PPP_MspInit().
The MspInit callback performs the low level initialization related to the different additional
hardware resources: RCC, GPIO, NVIC and DMA.
DocID026525 Rev 1
61/692

UM1785
All the HAL drivers with handles include two MSP callbacks for initialization and deinitialization:
/**
* @brief Initializes the PPP MSP.
* @param hppp: PPP handle
* @retval None */
void __weak HAL_PPP_MspInit(PPP_HandleTypeDef *hppp) {
/* NOTE : This function Should not be modified, when the callback is needed,
the HAL_PPP_MspInit could be implemented in the user file */
}
/**
* @brief DeInitializes PPP MSP.
* @param hppp: PPP handle
* @retval None */
void __weak HAL_PPP_MspDeInit(PPP_HandleTypeDef *hppp) {
/* NOTE : This function Should not be modified, when the callback is needed,
the HAL_PPP_MspDeInit could be implemented in the user file */
}
The MSP callbacks are declared empty as weak functions in each peripheral driver. The
user can use them to set the low level initialization code or omit them and use his own
initialization routine.
The HAL MSP callback is implemented inside the stm32f0xx_hal_msp.c file in the user
folders. An stm32f0xx_hal_msp_template.c file is located in the HAL folder and should be
copied to the user folder. It can be generated automatically by STM32CubeMX tool and
further modified. Note that all the routines are declared as weak functions and could be
overwritten or removed to use user low level initialization code.
stm32f0xx_hal_msp.c file contains the following functions:
Table 14: MSP functions
Routine
Description
void HAL_MspInit()
void HAL_MspDeInit()
void HAL_PPP_MspInit()
void HAL_PPP_MspDeInit()
Global MSP initialization routine

Global MSP de-initialization routine
PPP MSP initialization routine
PPP MSP de-initialization routine
By default, if no peripheral needs to be de-initialized during the program execution, the

whole MSP initialization is done in Hal_MspInit() and MSP De-Initialization in the
Hal_MspDeInit(). In this case the HAL_PPP_MspInit() and HAL_PPP_MspDeInit() are not
implemented.
When one or more peripherals needs to be de-initialized in run time and the low level
resources of a given peripheral need to be released and used by another peripheral,
HAL_PPP_MspDeInit() and HAL_PPP_MspInit() are implemented for the concerned
peripheral and other peripherals initialization and de-Initialization are kept in the global
HAL_MspInit() and the HAL_MspDeInit().
If there is nothing to be initialized by the global HAL_MspInit() and HAL_MspDeInit(), the
two routines can simply be omitted.
2.12.3
HAL IO operation process

The HAL functions with internal data processing like Transmit, Receive, Write and Read
are generally provided with three data processing modes as follows:
62/692
Polling mode
Interrupt mode
DocID026525 Rev 1
UM1785
2.12.3.1
DMA mode
Polling mode
In polling mode, the HAL functions return the process status when the data processing in
blocking mode is complete. The operation is considered complete when the function
returns the HAL_OK status, otherwise an error status is returned. The user can get more
information through the HAL_PPP_GetState() function. The data processing is handled
internally in a loop. A timeout (expressed in ms) is used to prevent process hanging.
The example below shows the typical polling mode processing sequence :
HAL_StatusTypeDef HAL_PPP_Transmit ( PPP_HandleTypeDef * phandle, uint8_t pData,
int16_tSize,uint32_tTimeout)
{
if((pData == NULL ) || (Size == 0))
{
return HAL_ERROR;
}
() while (data processing is running)
{
if( timeout reached )
{
return HAL_TIMEOUT;
}
}
()
return HAL_OK; }
2.12.3.2
Interrupt mode
In Interrupt mode, the HAL function returns the process status after starting the data
processing and enabling the appropriate interruption. The end of the operation is indicated
by a callback declared as a weak function. It can be customized by the user to be informed
in real-time about the process completion. The user can also get the process status
through the HAL_PPP_GetState() function.
In interrupt mode, four functions are declared in the driver:
HAL_PPP_Process_IT(): launch the process

HAL_PPP_IRQHandler(): the global PPP peripheral interruption
__weak HAL_PPP_ProcessCpltCallback (): the callback relative to the process
completion.
__weak HAL_PPP_ProcessErrorCallback(): the callback relative to the process Error.
To use a process in interrupt mode, HAL_PPP_Process_IT() is called in the user file and
HAL_PPP_IRQHandler in stm32f0xx_it.c.
The HAL_PPP_ProcessCpltCallback() function is declared as weak function in the driver.
This means that the user can declare it again in the application. The function in the driver is
not modified.
An example of use is illustrated below:
main.c file:
UART_HandleTypeDef UartHandle;
int main(void)
{
/* Set User Parameters */
UartHandle.Init.BaudRate = 9600;
UartHandle.Init.WordLength = UART_DATABITS_8;
UartHandle.Init.StopBits = UART_STOPBITS_1;
UartHandle.Init.Parity = UART_PARITY_NONE;
DocID026525 Rev 1
63/692
UM1785
UartHandle.Init.HwFlowCtl = UART_HWCONTROL_NONE;
UartHandle.Init.Mode = UART_MODE_TX_RX;
UartHandle.Init.Instance = USART1;
HAL_UART_Init(&UartHandle);
HAL_UART_SendIT(&UartHandle, TxBuffer, sizeof(TxBuffer));
while (1);
}
void HAL_UART_TxCpltCallback(UART_HandleTypeDef *huart)
{
}
void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart)
{
}
stm32f0xx_it.cfile:
extern UART_HandleTypeDef UartHandle;
void USART1_IRQHandler(void)
{
HAL_UART_IRQHandler(&UartHandle);
}
2.12.3.3
DMA mode
In DMA mode, the HAL function returns the process status after starting the data
processing through the DMA and after enabling the appropriate DMA interruption. The end
of the operation is indicated by a callback declared as a weak function and can be
customized by the user to be informed in real-time about the process completion. The user
can also get the process status through the HAL_PPP_GetState() function. For the DMA
mode, three functions are declared in the driver:
HAL_PPP_Process_DMA(): launch the process

HAL_PPP_DMA_IRQHandler(): the DMA interruption used by the PPP peripheral
__weak HAL_PPP_ProcessCpltCallback(): the callback relative to the process
completion.
__weak HAL_PPP_ErrorCpltCallback(): the callback relative to the process Error.
To use a process in DMA mode, HAL_PPP_Process_DMA() is called in the user file and
the HAL_PPP_DMA_IRQHandler() is placed in the stm32f0xx_it.c. When DMA mode is
used, the DMA initialization is done in the HAL_PPP_MspInit() callback. The user should
also associate the DMA handle to the PPP handle. For this purpose, the handles of all the
peripheral drivers that use the DMA must be declared as follows:
typedef struct
{
PPP_TypeDef *Instance; /* Register base address */
PPP_InitTypeDef Init; /* PPP communication parameters */
HAL_StateTypeDef State; /* PPP communication state */
()
DMA_HandleTypeDef *hdma; /* associated DMA handle */
} PPP_HandleTypeDef;
The initialization is done as follows (UART example):

int main(void)
{
/* Set User Parameters */
UartHandle.Init.Mode = UART_MODE_TX_RX;
UartHandle.Init.Instance = UART1;
(..)
}
64/692
DocID026525 Rev 1
UM1785

void HAL_USART_MspInit (UART_HandleTypeDef * huart)
{
static DMA_HandleTypeDef hdma_tx;
static DMA_HandleTypeDef hdma_rx;
()
__HAL_LINKDMA(UartHandle, DMA_Handle_tx, hdma_tx);
__HAL_LINKDMA(UartHandle, DMA_Handle_rx, hdma_rx);
()
}
The HAL_PPP_ProcessCpltCallback() function is declared as weak function in the driver

that means, the user can declare it again in the application code. The function in the driver
should not be modified.
An example of use is illustrated below:
main.c file:
UART_HandleTypeDef UartHandle;
int main(void)
{
/* Set User Paramaters */
UartHandle.Init.Mode = UART_MODE_TX_RX; UartHandle.Init.Instance = USART1;
HAL_UART_Send_DMA(&UartHandle, TxBuffer, sizeof(TxBuffer));
while (1);
}
void HAL_UART_TxCpltCallback(UART_HandleTypeDef *phuart)
{
}
void HAL_UART_TxErrorCallback(UART_HandleTypeDef *phuart)
{
}
stm32f0xx_it.c file:
extern UART_HandleTypeDef UartHandle;
void DMAx_IRQHandler(void)
{
HAL_DMA_IRQHandler(&UartHandle.DMA_Handle_tx);
}
HAL_USART_TxCpltCallback() and HAL_USART_ErrorCallback() should be linked in the

HAL_PPP_Process_DMA() function to the DMA transfer complete callback and the DMA
transfer Error callback by using the following statement:
HAL_PPP_Process_DMA (PPP_HandleTypeDef *hppp, Params.)
{
()
hppp->DMA_Handle->XferCpltCallback = HAL_UART_TxCpltCallback ;
hppp->DMA_Handle->XferErrorCallback = HAL_UART_ErrorCallback ;
()
}
2.12.4
Timeout and error management
2.12.4.1
Timeout management
The timeout is often used for the APIs that operate in polling mode. It defines the delay
during which a blocking process should wait till an error is returned. An example is provided
below:
HAL_StatusTypeDef HAL_DMA_PollForTransfer(DMA_HandleTypeDef *hdma, uint32_t
CompleteLevel, uint32_t Timeout)
DocID026525 Rev 1
65/692

The timeout possible value are the following:
UM1785
Table 15: Timeout values

Timeout value
Description
No poll : Immediate process check and exit
1 ... (HAL_MAX_DELAY -1)

HAL_MAX_DELAY
(1)
Timeout in ms
Infinite poll till process is successful
Notes:
(1)
HAL_MAX_DELAY is defined in the stm32fxxx_hal_def.h as 0xFFFFFFFF
However, in some cases, a fixed timeout is used for system peripherals or internal HAL
driver processes. In these cases, the timeout has the same meaning and is used in the
same way, except when it is defined locally in the drivers and cannot be modified or
introduced as an argument in the user application.
Example of fixed timeout:
#define LOCAL_PROCESS_TIMEOUT 100
HAL_StatusTypeDef HAL_PPP_Process(PPP_HandleTypeDef)
{
()
timeout = HAL_GetTick() + LOCAL_PROCESS_TIMEOUT;
()
while(ProcessOngoing)
{
()
if(HAL_GetTick() >= timeout)
{
/* Process unlocked */
__HAL_UNLOCK(hppp);
hppp->State= HAL_PPP_STATE_TIMEOUT;
return HAL_PPP_STATE_TIMEOUT;
}
}
()
}
The following example shows how to use the timeout inside the polling functions:
HAL_PPP_StateTypeDef HAL_PPP_Poll (PPP_HandleTypeDef *hppp, uint32_t Timeout)
{
()
timeout = HAL_GetTick() + Timeout;
()
while(ProcessOngoing)
{
()
if(Timeout != HAL_MAX_DELAY)
{
if(HAL_GetTick() >= timeout)
{
/* Process unlocked */
__HAL_UNLOCK(hppp);
hppp->State= HAL_PPP_STATE_TIMEOUT;
return hppp->State;
}
}
()
}
66/692
DocID026525 Rev 1
UM1785
2.12.4.2
Error management
The HAL drivers implement a check for the following items:
Valid parameters: for some process the used parameters should be valid and already
defined, otherwise the system can crash or go into an undefined state. These critical
parameters are checked before they are used (see example below).
HAL_StatusTypeDef HAL_PPP_Process(PPP_HandleTypeDef* hppp, uint32_t *pdata, uint32

Size)
{
if ((pData == NULL ) || (Size == 0))
{
return HAL_ERROR;
}
}
Valid handle: the PPP peripheral handle is the most important argument since it keeps
the PPP driver vital parameters. It is always checked in the beginning of the
HAL_PPP_Init() function.
HAL_StatusTypeDef HAL_PPP_Init(PPP_HandleTypeDef* hppp)

{
if (hppp == NULL) //the handle should be already allocated
{
return HAL_ERROR;
}
}
Timeout error: the following statement is used when a timeout error occurs:
while (Process ongoing)

{
timeout = HAL_GetTick() + Timeout; while (data processing is running)
{
if(timeout) { return HAL_TIMEOUT;
}
}
When an error occurs during a peripheral process, HAL_PPP_Process () returns with a

HAL_ERROR status. The HAL PPP driver implements the HAL_PPP_GetError () to allow
retrieving the origin of the error.
HAL_PPP_ErrorTypeDef HAL_PPP_GetError (PPP_HandleTypeDef *hppp);
In all peripheral handles, a HAL_PPP_ErrorTypeDef is defined and used to store the last
error code.
typedef struct
{
PPP_TypeDef * Instance; /* PPP registers base address */
PPP_InitTypeDef Init; /* PPP initialization parameters */
HAL_LockTypeDef Lock; /* PPP locking object */
__IO HAL_PPP_StateTypeDef State; /* PPP state */
__IO HAL_PPP_ErrorTypeDef ErrorCode; /* PPP Error code */
()
/* PPP specific parameters */
}
PPP_HandleTypeDef;
The error state and the peripheral global state are always updated before returning an
error:
PPP->State = HAL_PPP_READY; /* Set the peripheral ready */
PP->ErrorCode = HAL_ERRORCODE ; /* Set the error code */
_HAL_UNLOCK(PPP) ; /* Unlock the PPP resources */
return HAL_ERROR; /*return with HAL error */
HAL_PPP_GetError () must be used in interrupt mode in the error callback:

DocID026525 Rev 1
67/692
UM1785
void HAL_PPP_ProcessCpltCallback(PPP_HandleTypeDef *hspi)

{
ErrorCode = HAL_PPP_GetError (hppp); /* retreive error code */
}
2.12.4.3
Run-time checking
The HAL implements run-time failure detection by checking the input values of all HAL
drivers functions. The run-time checking is achieved by using an assert_param macro. This
macro is used in all the HAL drivers' functions which have an input parameter. It allows
verifying that the input value lies within the parameter allowed values.
To enable the run-time checking, use the assert_param macro, and leave the define
USE_FULL_ASSERT uncommented in stm32f0xx_hal_conf.h file.
void HAL_UART_Init(UART_HandleTypeDef *huart)
{
(..) /* Check the parameters */
assert_param(IS_UART_INSTANCE(huart->Instance));
assert_param(IS_UART_BAUDRATE(huart->Init.BaudRate));
assert_param(IS_UART_WORD_LENGTH(huart->Init.WordLength));
assert_param(IS_UART_STOPBITS(huart->Init.StopBits));
assert_param(IS_UART_PARITY(huart->Init.Parity));
assert_param(IS_UART_MODE(huart->Init.Mode));
assert_param(IS_UART_HARDWARE_FLOW_CONTROL(huart->Init.HwFlowCtl));
(..)
/** @defgroup UART_Word_Length *
@{
*/
#define UART_WORDLENGTH_8B ((uint32_t)0x00000000)
#define UART_WORDLENGTH_9B ((uint32_t)USART_CR1_M)
#define IS_UART_WORD_LENGTH(LENGTH) (((LENGTH) == UART_WORDLENGTH_8B) ||
\ ((LENGTH) == UART_WORDLENGTH_9B))
If the expression passed to the assert_param macro is false, theassert_failed function is

called and returns the name of the source file and the source line number of the call that
failed. If the expression is true, no value is returned.
The assert_param macro is implemented in stm32f0xx_hal_conf.h:
/* Exported macro ------------------------------------------------------------*/
#ifdef USE_FULL_ASSERT
/**
* @brief The assert_param macro is used for function's parameters check.
* @param expr: If expr is false, it calls assert_failed function
* which reports the name of the source file and the source
* line number of the call that failed.
* If expr is true, it returns no value.
* @retval None */
#define assert_param(expr) ((expr)?(void)0:assert_failed((uint8_t *)__FILE__,
__LINE__))
/* Exported functions --------------------------------------*/
void assert_failed(uint8_t* file, uint32_t line);
#else
#define assert_param(expr)((void)0)
#endif /* USE_FULL_ASSERT */
The assert_failed function is implemented in the main.c file or in any other user C file:
#ifdef USE_FULL_ASSERT /**
* @brief Reports the name of the source file and the source line number
* where the assert_param error has occurred.
* @param file: pointer to the source file name
* @param line: assert_param error line source number
* @retval None */
void assert_failed(uint8_t* file, uint32_t line)
{
/* User can add his own implementation to report the file name and line number,
ex: printf("Wrong parameters value: file %s on line %d\r\n", file, line) */
68/692
DocID026525 Rev 1
UM1785

/* Infinite loop */
while (1)
{
}
}
Because of the overhead run-time checking introduces, it is recommended

to use it during application code development and debugging, and to
remove it from the final application to improve code size and speed.
DocID026525 Rev 1
69/692
HAL System Driver
UM1785
HAL System Driver
3.1
HAL Firmware driver API description

The following section lists the various functions of the HAL library.
3.1.1
How to use this driver

The common HAL driver contains a set of generic and common APIs that can be used by
the PPP peripheral drivers and the user to start using the HAL.
The HAL contains two APIs categories:
3.1.2
HAL Initialization and de-initialization functions

HAL Control functions
Initialization and de-initialization functions

This section provides functions allowing to:
3.1.3
Initializes the Flash interface, the NVIC allocation and initial clock configuration. It
initializes the source of time base also when timeout is needed and the backup
domain when enabled.
de-Initializes common part of the HAL.
Configure The time base source to have 1ms time base with a dedicated Tick
interrupt priority.
Systick timer is used by default as source of time base, but user can eventually
implement his proper time base source (a general purpose timer for example or
other time source), keeping in mind that Time base duration should be kept 1ms
since PPP_TIMEOUT_VALUEs are defined and handled in milliseconds basis.
Time base configuration function (HAL_InitTick ()) is called automatically at the

beginning of the program after reset by HAL_Init() or at any time when clock is
configured, by HAL_RCC_ClockConfig().
Source of time base is configured to generate interrupts at regular time intervals.

Care must be taken if HAL_Delay() is called from a peripheral ISR process, the
Tick interrupt line must have higher priority (numerically lower) than the
peripheral interrupt. Otherwise the caller ISR process will be blocked.
functions affecting time base configurations are declared as __Weak to make

override possible in case of other implementations in user file.
HAL_Init()
HAL_DeInit()
HAL_MspInit()
HAL_MspDeInit()
HAL_InitTick()
HAL Control functions

70/692
Provide a tick value in millisecond

Provide a blocking delay in millisecond
DocID026525 Rev 1
UM1785
HAL System Driver
3.1.4
Suspend the time base source interrupt

Resume the time base source interrupt
Get the HAL API driver version
Get the device identifier
Get the device revision identifier
Enable/Disable Debug module during Sleep mode
Enable/Disable Debug module during STOP mode
Enable/Disable Debug module during STANDBY mode
HAL_IncTick()
HAL_GetTick()
HAL_SuspendTick()
HAL_ResumeTick()
HAL_Delay()
HAL_GetHalVersion()
HAL_GetREVID()
HAL_GetDEVID()
HAL_EnableDBGStopMode()
HAL_DisableDBGStopMode()
HAL_EnableDBGStandbyMode()
HAL_DisableDBGStandbyMode()
HAL_Init
Function Name
HAL_StatusTypeDef HAL_Init ( void )
Function Description
This function configures the Flash prefetch, Configures time base

source, NVIC and Low level hardware.
Return values
HAL status
Notes
This function is called at the beginning of program after reset

and before the clock configuration
The time base configuration is based on HSI clock when
exiting from Reset. Once done, time base tick start
incrementing. In the default implementation,Systick is used as
source of time base. The tick variable is incremented each
1ms in its ISR.
3.1.5
HAL_DeInit
Function Name
HAL_StatusTypeDef HAL_DeInit ( void )
This function de-Initializes common part of the HAL and stops the
source of time base.
Return values
HAL status
DocID026525 Rev 1
71/692
HAL System Driver

Notes
3.1.6
3.1.7
3.1.8
UM1785
HAL_MspInit
Function Name
void HAL_MspInit ( void )
Initializes the MSP.
Return values
None.
Notes
None.
HAL_MspDeInit
Function Name
void HAL_MspDeInit ( void )
DeInitializes the MSP.
Return values
None.
Notes
None.
HAL_InitTick
Function Name
HAL_StatusTypeDef HAL_InitTick ( uint32_t TickPriority)
This function configures the source of the time base.
Parameters
TickPriority : Tick interrupt priority.
Return values
HAL status
Notes
This function is called automatically at the beginning of

program after reset by HAL_Init() or at any time when clock is
reconfigured by HAL_RCC_ClockConfig().
In the default implementation, SysTick timer is the source of
time base. It is used to generate interrupts at regular time
intervals. Care must be taken if HAL_Delay() is called from a
72/692
This function is optional.
DocID026525 Rev 1
UM1785
3.1.9
HAL System Driver

peripheral ISR process, The the SysTick interrupt must have
higher priority (numerically lower) than the peripheral
interrupt. Otherwise the caller ISR process will be blocked.
The function is declared as __Weak to be overwritten in case
of other implementation in user file.
HAL_IncTick
Function Name
void HAL_IncTick ( void )
This function is called to increment a global variable "uwTick"

used as application time base.
Return values
None.
Notes
In the default implementation, this variable is incremented

each 1ms in Systick ISR.
This function is declared as __weak to be overwritten in case
of other implementations in user file.
3.1.10
3.1.11
HAL_GetTick
Function Name
uint32_t HAL_GetTick ( void )
Povides a tick value in millisecond.
Return values
tick value
Notes

HAL_SuspendTick
Function Name
void HAL_SuspendTick ( void )
Suspend Tick increment.
DocID026525 Rev 1
73/692
HAL System Driver

Return values
Notes
UM1785
None.
In the default implementation , SysTick timer is the source of

intervals. Once HAL_SuspendTick() is called, the the SysTick
interrupt will be disabled and so Tick increment is suspended.
This function is declared as __weak to be overwritten in case
3.1.12
3.1.13
HAL_ResumeTick
Function Name
void HAL_ResumeTick ( void )
Resume Tick increment.
Return values
None.
Notes

intervals. Once HAL_ResumeTick() is called, the the SysTick
interrupt will be enabled and so Tick increment is resumed.
HAL_Delay
Function Name
void HAL_Delay ( __IO uint32_t Delay)
This function provides accurate delay (in milliseconds) based on

variable incremented.
Parameters
Delay : specifies the delay time length, in milliseconds.
Return values
None.
Notes

intervals where uwTick is incremented.
ThiS function is declared as __weak to be overwritten in case
74/692
DocID026525 Rev 1
UM1785
3.1.14
3.1.15
3.1.16
3.1.17
HAL System Driver
HAL_GetHalVersion
Function Name
uint32_t HAL_GetHalVersion ( void )
This method returns the HAL revision.
Return values
version : 0xXYZR (8bits for each decimal, R for RC)
Notes
None.
HAL_GetREVID
Function Name
uint32_t HAL_GetREVID ( void )
Returns the device revision identifier.
Return values
Device revision identifier
Notes
None.
HAL_GetDEVID
Function Name
uint32_t HAL_GetDEVID ( void )
Returns the device identifier.
Return values
Device identifier
Notes
None.
HAL_EnableDBGStopMode
Function Name
void HAL_EnableDBGStopMode ( void )
Enable the Debug Module during STOP mode.
DocID026525 Rev 1
75/692
HAL System Driver

Return values
Notes
3.1.18
3.1.19
3.1.20
76/692
UM1785
None.
None.
HAL_DisableDBGStopMode
Function Name
void HAL_DisableDBGStopMode ( void )
Disable the Debug Module during STOP mode.
Return values
None.
Notes
None.
HAL_EnableDBGStandbyMode
Function Name
void HAL_EnableDBGStandbyMode ( void )
Enable the Debug Module during STANDBY mode.
Return values
None.
Notes
None.
HAL_DisableDBGStandbyMode
Function Name
void HAL_DisableDBGStandbyMode ( void )
Disable the Debug Module during STANDBY mode.
Return values
None.
Notes
None.
DocID026525 Rev 1
UM1785
HAL System Driver
3.2
HAL Firmware driver defines
3.2.1
HAL
HAL
HAL FastModePlus I2C
IS_HAL_SYSCFG_FASTMODEPLUS_CONFIG
HAL Fast mode plus driving cap
__HAL_SYSCFG_FASTMODEPLUS_ENABLE
__HAL_SYSCFG_FASTMODEPLUS_DISABLE
HAL IRDA Enveloppe Selection
HAL_SYSCFG_IRDA_ENV_SEL_TIM16
HAL_SYSCFG_IRDA_ENV_SEL_USART1
HAL_SYSCFG_IRDA_ENV_SEL_USART4
IS_HAL_SYSCFG_IRDA_ENV_SEL
HAL ISR Wrapper
HAL_SYSCFG_ITLINE0
HAL_SYSCFG_ITLINE1
HAL_SYSCFG_ITLINE2
HAL_SYSCFG_ITLINE3
HAL_SYSCFG_ITLINE4
HAL_SYSCFG_ITLINE5
HAL_SYSCFG_ITLINE6
HAL_SYSCFG_ITLINE7
HAL_SYSCFG_ITLINE8
HAL_SYSCFG_ITLINE9
HAL_SYSCFG_ITLINE10
HAL_SYSCFG_ITLINE11
HAL_SYSCFG_ITLINE12
HAL_SYSCFG_ITLINE13
HAL_SYSCFG_ITLINE14
HAL_SYSCFG_ITLINE15
HAL_SYSCFG_ITLINE16
HAL_SYSCFG_ITLINE17
HAL_SYSCFG_ITLINE18
HAL_SYSCFG_ITLINE19
HAL_SYSCFG_ITLINE20
HAL_SYSCFG_ITLINE21
DocID026525 Rev 1
77/692
HAL System Driver

HAL_SYSCFG_ITLINE22
UM1785
HAL_SYSCFG_ITLINE23
HAL_SYSCFG_ITLINE24
HAL_SYSCFG_ITLINE25
HAL_SYSCFG_ITLINE26
HAL_SYSCFG_ITLINE27
HAL_SYSCFG_ITLINE28
HAL_SYSCFG_ITLINE29
HAL_SYSCFG_ITLINE30
HAL_SYSCFG_ITLINE31
HAL_ITLINE_EWDG
HAL_ITLINE_PVDOUT
HAL_ITLINE_VDDIO2
HAL_ITLINE_RTC_WAKEUP
HAL_ITLINE_RTC_TSTAMP
HAL_ITLINE_RTC_ALRA
HAL_ITLINE_FLASH_ITF
HAL_ITLINE_CRS
HAL_ITLINE_CLK_CTRL
HAL_ITLINE_EXTI0
HAL_ITLINE_EXTI1
HAL_ITLINE_EXTI2
HAL_ITLINE_EXTI3
HAL_ITLINE_EXTI4
HAL_ITLINE_EXTI5
HAL_ITLINE_EXTI6
HAL_ITLINE_EXTI7
HAL_ITLINE_EXTI8
HAL_ITLINE_EXTI9
HAL_ITLINE_EXTI10
HAL_ITLINE_EXTI11
HAL_ITLINE_EXTI12
HAL_ITLINE_EXTI13
HAL_ITLINE_EXTI14
HAL_ITLINE_EXTI15
HAL_ITLINE_TSC_EOA
78/692
DocID026525 Rev 1
UM1785
HAL System Driver

HAL_ITLINE_TSC_MCE
HAL_ITLINE_DMA1_CH1
HAL_ITLINE_DMA1_CH2
HAL_ITLINE_DMA1_CH3
HAL_ITLINE_DMA2_CH1
HAL_ITLINE_DMA2_CH2
HAL_ITLINE_DMA1_CH4
HAL_ITLINE_DMA1_CH5
HAL_ITLINE_DMA1_CH6
HAL_ITLINE_DMA1_CH7
HAL_ITLINE_DMA2_CH3
HAL_ITLINE_DMA2_CH4
HAL_ITLINE_DMA2_CH5
HAL_ITLINE_ADC
HAL_ITLINE_COMP1
HAL_ITLINE_COMP2
HAL_ITLINE_TIM1_BRK
HAL_ITLINE_TIM1_UPD
HAL_ITLINE_TIM1_TRG
HAL_ITLINE_TIM1_CCU
HAL_ITLINE_TIM1_CC
HAL_ITLINE_TIM2
HAL_ITLINE_TIM3
HAL_ITLINE_DAC
HAL_ITLINE_TIM6
HAL_ITLINE_TIM7
HAL_ITLINE_TIM14
HAL_ITLINE_TIM15
HAL_ITLINE_TIM16
HAL_ITLINE_TIM17
HAL_ITLINE_I2C1
HAL_ITLINE_I2C2
HAL_ITLINE_SPI1
HAL_ITLINE_SPI2
HAL_ITLINE_USART1
USART1 GLB Interrupt -> exti[25]
HAL_ITLINE_USART2
USART2 GLB Interrupt -> exti[26]
DocID026525 Rev 1
79/692
HAL System Driver

HAL_ITLINE_USART3
UM1785
HAL_ITLINE_USART4
HAL_ITLINE_USART5
HAL_ITLINE_USART6
HAL_ITLINE_USART7
HAL_ITLINE_USART8
HAL_ITLINE_CAN
HAL_ITLINE_CEC
HAL ISR wrapper check
__HAL_GET_PENDING_IT
Constants
__STM32F0xx_HAL_VERSION_MAIN
[31:24] main version
__STM32F0xx_HAL_VERSION_SUB1
[23:16] sub1 version
__STM32F0xx_HAL_VERSION_SUB2
[15:8] sub2 version
__STM32F0xx_HAL_VERSION_RC
[7:0] release candidate
__STM32F0xx_HAL_VERSION
IDCODE_DEVID_MASK
HAL SYSCFG IRDA modulation envelope selection
__HAL_SYSCFG_IRDA_ENV_SELECTION
__HAL_SYSCFG_GET_IRDA_ENV_SELECTION
80/692
DocID026525 Rev 1
UM1785
HAL ADC Generic Driver
4.1
ADC Firmware driver registers structures
4.1.1
ADC_InitTypeDef
ADC_InitTypeDef is defined in the stm32f0xx_hal_adc.h
Data Fields
uint32_t ClockPrescaler
uint32_t Resolution
uint32_t DataAlign
uint32_t ScanConvMode
uint32_t EOCSelection
uint32_t LowPowerAutoWait
uint32_t LowPowerAutoPowerOff
uint32_t ContinuousConvMode
uint32_t DiscontinuousConvMode
uint32_t ExternalTrigConv
uint32_t ExternalTrigConvEdge
uint32_t DMAContinuousRequests
uint32_t Overrun
Field Documentation
uint32_t ADC_InitTypeDef::ClockPrescaler Select ADC clock source (synchronous

clock derived from APB clock or asynchronous clock derived from ADC dedicated HSI
RC oscillator 14MHz) and clock prescaler. This parameter can be a value of
ADC_ClockPrescaler Note: In case of usage of the ADC dedicated HSI RC oscillator,
it must be preliminarily enabled at RCC top level. Note: This parameter can be
modified only if the ADC is disabled
uint32_t ADC_InitTypeDef::Resolution Configures the ADC resolution. This
parameter can be a value of ADC_Resolution
uint32_t ADC_InitTypeDef::DataAlign Specifies whether the ADC data alignment is
left or right. This parameter can be a value of ADC_Data_align
uint32_t ADC_InitTypeDef::ScanConvMode Configures the sequencer of regular
group. This parameter can be associated to parameter 'DiscontinuousConvMode' to
have main sequence subdivided in successive parts. Sequencer is automatically
enabled if several channels are set (sequencer cannot be disabled, as it can be the
case on other STM32 devices): If only 1 channel is set: Conversion is performed in
single mode. If several channels are set: Conversions are performed in sequence
mode (ranks defined by each channel number: channel 0 fixed on rank 0, channel 1
fixed on rank1, ...). Scan direction can be set to forward (from channel 0 to channel
18) or backward (from channel 18 to channel 0). This parameter can be a value of
ADC_Scan_mode
uint32_t ADC_InitTypeDef::EOCSelection Specifies what EOC (End Of Conversion)
flag is used for conversion by polling and interruption: end of conversion of each rank
or complete sequence. This parameter can be a value of ADC_EOCSelection.
uint32_t ADC_InitTypeDef::LowPowerAutoWait Selects the dynamic low power
Auto Delay: new conversion start only when the previous conversion (for regular
group) or previous sequence (for injected group) has been treated by user software.
DocID026525 Rev 1
81/692

UM1785
This feature automatically adapts the speed of ADC to the speed of the system that
reads the data. Moreover, this avoids risk of overrun for low frequency applications.
This parameter can be set to ENABLE or DISABLE. Note: Do not use with interruption
or DMA (HAL_ADC_Start_IT(), HAL_ADC_Start_DMA()) since they have to clear
immediately the EOC flag to free the IRQ vector sequencer. Do use with polling: 1.
Start conversion with HAL_ADC_Start(), 2. Later on, when conversion data is
needed: use HAL_ADC_PollForConversion() to ensure that conversion is completed
and use HAL_ADC_GetValue() to retrieve conversion result and trig another
conversion.
uint32_t ADC_InitTypeDef::LowPowerAutoPowerOff Selects the auto-off mode:

the ADC automatically powers-off after a conversion and automatically wakes-up
when a new conversion is triggered (with startup time between trigger and start of
sampling). This feature can be combined with automatic wait mode (parameter
'LowPowerAutoWait'). This parameter can be set to ENABLE or DISABLE. Note: If
enabled, this feature also turns off the ADC dedicated 14 MHz RC oscillator (HSI14)
uint32_t ADC_InitTypeDef::ContinuousConvMode Specifies whether the

conversion is performed in single mode (one conversion) or continuous mode for
regular group, after the selected trigger occurred (software start or external trigger).
This parameter can be set to ENABLE or DISABLE.
uint32_t ADC_InitTypeDef::DiscontinuousConvMode Specifies whether the

conversions sequence of regular group is performed in Completesequence/Discontinuous-sequence (main sequence subdivided in successive parts).
Discontinuous mode is used only if sequencer is enabled (parameter
'ScanConvMode'). If sequencer is disabled, this parameter is discarded.
Discontinuous mode can be enabled only if continuous mode is disabled. If continuous
mode is enabled, this parameter setting is discarded. This parameter can be set to
ENABLE or DISABLE Note: Number of discontinuous ranks increment is fixed to oneby-one.
uint32_t ADC_InitTypeDef::ExternalTrigConv Selects the external event used to

trigger the conversion start of regular group. If set to ADC_SOFTWARE_START,
external triggers are disabled. This parameter can be a value of
ADC_External_trigger_source_Regular
uint32_t ADC_InitTypeDef::ExternalTrigConvEdge Selects the external trigger

edge of regular group. If trigger is set to ADC_SOFTWARE_START, this parameter is
discarded. This parameter can be a value of ADC_External_trigger_edge_Regular
uint32_t ADC_InitTypeDef::DMAContinuousRequests Specifies whether the DMA

requests are performed in one shot mode (DMA transfer stop when number of
conversions is reached) or in Continuous mode (DMA transfer unlimited, whatever
number of conversions). Note: In continuous mode, DMA must be configured in
circular mode. Otherwise an overrun will be triggered when DMA buffer maximum
pointer is reached. This parameter can be set to ENABLE or DISABLE.
uint32_t ADC_InitTypeDef::Overrun Select the behaviour in case of overrun: data

preserved or overwritten This parameter has an effect on regular group only, including
in DMA mode. This parameter can be a value of ADC_Overrun
4.1.2
ADC_ChannelConfTypeDef
ADC_ChannelConfTypeDef is defined in the stm32f0xx_hal_adc.h
Data Fields
82/692
uint32_t Channel
uint32_t Rank
uint32_t SamplingTime
DocID026525 Rev 1
UM1785

Field Documentation
4.1.3
uint32_t ADC_ChannelConfTypeDef::Channel Specifies the channel to configure

into ADC regular group. This parameter can be a value of ADC_channels Note:
Depending on devices, some channels may not be available on package pins. Refer
to device datasheet for channels availability.
uint32_t ADC_ChannelConfTypeDef::Rank Add or remove the channel from ADC
regular group sequencer. On STM32F0 devices, rank is defined by each channel
number (channel 0 fixed on rank 0, channel 1 fixed on rank1, ...). Despite the channel
rank is fixed, this parameter allow an additional possibility: to remove the selected
rank (selected channel) from sequencer. This parameter can be a value of ADC_rank
uint32_t ADC_ChannelConfTypeDef::SamplingTime Sampling time value to be set
for the selected channel. Unit: ADC clock cycles Conversion time is the addition of
sampling time and processing time (12.5 ADC clock cycles at ADC resolution 12 bits,
10.5 cycles at 10 bits, 8.5 cycles at 8 bits, 6.5 cycles at 6 bits). This parameter can be
a value of ADC_sampling_times Caution: this setting impacts the entire regular
group. Therefore, call of HAL_ADC_ConfigChannel() to configure a channel can
impact the configuration of other channels previously set. Note: In case of usage of
internal measurement channels (VrefInt/Vbat/TempSensor), sampling time constraints
must be respected (sampling time can be adjusted in function of ADC clock frequency
and sampling time setting) Refer to device datasheet for timings values, parameters
TS_vrefint, TS_vbat, TS_temp (values rough order: 5us to 17us).
ADC_AnalogWDGConfTypeDef
ADC_AnalogWDGConfTypeDef is defined in the stm32f0xx_hal_adc.h
Data Fields
uint32_t WatchdogMode
uint32_t Channel
uint32_t ITMode
uint32_t HighThreshold
uint32_t LowThreshold
Field Documentation
uint32_t ADC_AnalogWDGConfTypeDef::WatchdogMode Configures the ADC

analog watchdog mode: single/all/none channels. This parameter can be a value of
ADC_analog_watchdog_mode.
uint32_t ADC_AnalogWDGConfTypeDef::Channel Selects which ADC channel to
monitor by analog watchdog. This parameter has an effect only if parameter
'WatchdogMode' is configured on single channel. Only 1 channel can be monitored.
This parameter can be a value of ADC_channels.
uint32_t ADC_AnalogWDGConfTypeDef::ITMode Specifies whether the analog
watchdog is configured in interrupt or polling mode. This parameter can be set to
ENABLE or DISABLE
uint32_t ADC_AnalogWDGConfTypeDef::HighThreshold Configures the ADC
analog watchdog High threshold value. Depending of ADC resolution selected (12, 10,
8 or 6 bits), this parameter must be a number between Min_Data = 0x000 and
Max_Data = 0xFFF, 0x3FF, 0xFF or 0x3F respectively.
uint32_t ADC_AnalogWDGConfTypeDef::LowThreshold Configures the ADC
analog watchdog High threshold value. Depending of ADC resolution selected (12, 10,
DocID026525 Rev 1
83/692

UM1785
8 or 6 bits), this parameter must be a number between Min_Data = 0x000 and
Max_Data = 0xFFF, 0x3FF, 0xFF or 0x3F respectively.
4.1.4
ADC_HandleTypeDef
ADC_HandleTypeDef is defined in the stm32f0xx_hal_adc.h
Data Fields
ADC_TypeDef * Instance
ADC_InitTypeDef Init
__IO uint32_t NbrOfConversionRank
DMA_HandleTypeDef * DMA_Handle
HAL_LockTypeDef Lock
__IO HAL_ADC_StateTypeDef State
__IO uint32_t ErrorCode
Field Documentation
4.2
ADC_TypeDef* ADC_HandleTypeDef::Instance Register base address

ADC_InitTypeDef ADC_HandleTypeDef::Init ADC required parameters
__IO uint32_t ADC_HandleTypeDef::NbrOfConversionRank ADC conversion rank
counter
DMA_HandleTypeDef* ADC_HandleTypeDef::DMA_Handle Pointer DMA Handler
HAL_LockTypeDef ADC_HandleTypeDef::Lock ADC locking object
__IO HAL_ADC_StateTypeDef ADC_HandleTypeDef::State ADC communication
state
__IO uint32_t ADC_HandleTypeDef::ErrorCode ADC Error code
ADC Firmware driver API description

The following section lists the various functions of the ADC library.
4.2.1
ADC specific features
1.
2.
12-bit, 10-bit, 8-bit or 6-bit configurable resolution

Interrupt generation at the end of regular conversion and in case of analog watchdog
or overrun events.
3.
Single and continuous conversion modes.
4.
Scan mode for automatic conversion of channel 0 to channel 'n'.
5.
Data alignment with in-built data coherency.
6.
Programmable sampling time.
7.
ADC conversion group Regular.
8.
External trigger (timer or EXTI) with configurable polarity.
9.
DMA request generation for transfer of conversions data of regular group.
10. ADC calibration
11. ADC supply requirements: 2.4 V to 3.6 V at full speed and down to 1.8 V at slower
speed.
12. ADC input range: from Vref minus (connected to Vssa) to Vref plus (connected to
Vdda or to an external voltage reference).
84/692
DocID026525 Rev 1
UM1785
4.2.2
1.
2.
3.
4.
Enable the ADC interface
As prerequisite, into HAL_ADC_MspInit(), ADC clock must be configured at RCC

top level: clock source and clock prescaler.
Two possible clock sources: synchronous clock derived from APB clock or
asynchronous clock derived from ADC dedicated HSI RC oscillator 14MHz.
Example: __ADC1_CLK_ENABLE(); (mandatory) HI14 enable or let under

control of ADC: (optional) RCC_OscInitTypeDef RCC_OscInitStructure;
RCC_OscInitStructure.OscillatorType = RCC_OSCILLATORTYPE_HSI14;
RCC_OscInitStructure.HSI14CalibrationValue =
RCC_HSI14CALIBRATION_DEFAULT; RCC_OscInitStructure.HSI14State =
RCC_HSI14_ADC_CONTROL; RCC_OscInitStructure.PLL... (optional if used for
system clock) HAL_RCC_OscConfig(&RCC_OscInitStructure); Parameter
"HSI14State" must be set either: - to "...HSI14State =
RCC_HSI14_ADC_CONTROL" to let the ADC control the HSI14 oscillator
enable/disable (if not used to supply the main system clock): feature used if ADC
mode LowPowerAutoPowerOff is enabled. - to "...HSI14State =
RCC_HSI14_ON" to maintain the HSI14 oscillator always enabled: can be used
to supply the main system clock.
ADC pins configuration
Enable the clock for the ADC GPIOs using the following function:
__GPIOx_CLK_ENABLE();
Configure these ADC pins in analog mode using HAL_GPIO_Init();

Configure the ADC parameters (conversion resolution, data alignment, continuous
mode, ...) using the HAL_ADC_Init() function.
Activate the ADC peripheral using one of the start functions: HAL_ADC_Start(),
HAL_ADC_Start_IT(), HAL_ADC_Start_DMA().
Channels configuration to regular group
To configure the ADC regular group features, use HAL_ADC_Init() and

HAL_ADC_ConfigChannel() functions.
To activate the continuous mode, use the HAL_ADC_Init() function.
To read the ADC converted values, use the HAL_ADC_GetValue() function.
DMA for regular configuration
4.2.3
To enable the DMA mode for regular group, use the HAL_ADC_Start_DMA() function.
To enable the generation of DMA requests continuously at the end of the last DMA
transfer, use the HAL_ADC_Init() function.

Initialize and configure the ADC.

De-initialize the ADC
HAL_ADC_Init()
DocID026525 Rev 1
85/692
4.2.4
UM1785
HAL_ADC_DeInit()
HAL_ADC_MspInit()
HAL_ADC_MspDeInit()
IO operation functions
4.2.5
Start conversion of regular group.

Stop conversion of regular group.
Poll for conversion complete on regular group.
Poll for conversion event.
Get result of regular channel conversion.
Start conversion of regular group and enable interruptions.
Stop conversion of regular group and disable interruptions.
Handle ADC interrupt request
Start conversion of regular group and enable DMA transfer.
Stop conversion of regular group and disable ADC DMA transfer.
HAL_ADC_Start()
HAL_ADC_Stop()
HAL_ADC_PollForConversion()
HAL_ADC_PollForEvent()
HAL_ADC_Start_IT()
HAL_ADC_Stop_IT()
HAL_ADC_Start_DMA()
HAL_ADC_Stop_DMA()
HAL_ADC_GetValue()
HAL_ADC_IRQHandler()
HAL_ADC_ConvCpltCallback()
HAL_ADC_ConvHalfCpltCallback()
HAL_ADC_LevelOutOfWindowCallback()
HAL_ADC_ErrorCallback()
Peripheral Control functions

4.2.6
Configure channels on regular group

Configure the analog watchdog
HAL_ADC_ConfigChannel()
HAL_ADC_AnalogWDGConfig()
Peripheral State and Errors functions

This subsection provides functions to get in run-time the status of the peripheral.
86/692
Check the ADC state

Check the ADC error code
HAL_ADC_GetState()
HAL_ADC_GetError()
DocID026525 Rev 1
UM1785
4.2.7
HAL_ADC_Init
Function Name
HAL_StatusTypeDef HAL_ADC_Init ( ADC_HandleTypeDef *

hadc)
Initializes the ADC peripheral and regular group according to

parameters specified in structure "ADC_InitTypeDef".
Parameters
hadc : ADC handle
Return values
HAL status
Notes
As prerequisite, ADC clock must be configured at RCC top

level depending on both possible clock sources: APB clock of
HSI clock. See commented example code below that can be
copied and uncommented into HAL_ADC_MspInit().
Possibility to update parameters on the fly: This function
initializes the ADC MSP (HAL_ADC_MspInit()) only when
coming from ADC state reset. Following calls to this function
can be used to reconfigure some parameters of
ADC_InitTypeDef structure on the fly, without modifying MSP
configuration. If ADC MSP has to be modified again,
HAL_ADC_DeInit() must be called before HAL_ADC_Init().
The setting of these parameters is conditioned to ADC state.
For parameters constraints, see comments of structure
"ADC_InitTypeDef".
This function configures the ADC within 2 scopes: scope of
entire ADC and scope of regular group. For parameters
details, see comments of structure "ADC_InitTypeDef".
4.2.8
HAL_ADC_DeInit
Function Name
HAL_StatusTypeDef HAL_ADC_DeInit ( ADC_HandleTypeDef *

hadc)
Deinitialize the ADC peripheral registers to their default reset

values, with deinitialization of the ADC MSP.
Parameters
hadc : ADC handle
Return values
HAL status
Notes
For devices with several ADCs: reset of ADC common

registers is done only if all ADCs sharing the same common
group are disabled. If this is not the case, reset of these
common parameters reset is bypassed without error
reporting: it can be the intended behaviour in case of reset of
a single ADC while the other ADCs sharing the same
DocID026525 Rev 1
87/692
UM1785
common group is still running.
4.2.9
4.2.10
4.2.11
88/692
HAL_ADC_MspInit
Function Name
void HAL_ADC_MspInit ( ADC_HandleTypeDef * hadc)
Initializes the ADC MSP.
Parameters
hadc : ADC handle
Return values
None.
Notes
None.
HAL_ADC_MspDeInit
Function Name
void HAL_ADC_MspDeInit ( ADC_HandleTypeDef * hadc)
DeInitializes the ADC MSP.
Parameters
hadc : ADC handle
Return values
None.
Notes
None.
HAL_ADC_Start
Function Name
HAL_StatusTypeDef HAL_ADC_Start ( ADC_HandleTypeDef *

hadc)
Enables ADC, starts conversion of regular group.
Parameters
hadc : ADC handle
Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
4.2.12
4.2.13
4.2.14
HAL_ADC_Stop
Function Name
HAL_StatusTypeDef HAL_ADC_Stop ( ADC_HandleTypeDef *

hadc)
Stop ADC conversion of regular group, disable ADC peripheral.
Parameters
hadc : ADC handle
Return values
HAL status.
Notes
None.
HAL_ADC_PollForConversion
Function Name
HAL_StatusTypeDef HAL_ADC_PollForConversion (
ADC_HandleTypeDef * hadc, uint32_t Timeout)
Wait for regular group conversion to be completed.
Parameters
hadc : ADC handle

Timeout : Timeout value in millisecond.
Return values
HAL status
Notes
None.
HAL_ADC_PollForEvent
Function Name
HAL_StatusTypeDef HAL_ADC_PollForEvent (
ADC_HandleTypeDef * hadc, uint32_t EventType, uint32_t
Timeout)
Poll for conversion event.
Parameters
hadc : ADC handle

EventType : the ADC event type. This parameter can be one
of the following values:
AWD_EVENT ADC Analog watchdog event

DocID026525 Rev 1
89/692
4.2.15
4.2.16
4.2.17
Return values
HAL status
Notes
None.
HAL_ADC_Start_IT
Function Name
HAL_StatusTypeDef HAL_ADC_Start_IT (
ADC_HandleTypeDef * hadc)
Enables ADC, starts conversion of regular group with interruption.
Parameters
hadc : ADC handle
Return values
HAL status
Notes
None.
HAL_ADC_Stop_IT
Function Name
HAL_StatusTypeDef HAL_ADC_Stop_IT (
Stop ADC conversion of regular group, disable interruption of endof-conversion, disable ADC peripheral.
Parameters
hadc : ADC handle
Return values
HAL status.
Notes
None.
HAL_ADC_Start_DMA
Function Name
90/692
UM1785
OVR_EVENT ADC Overrun event

Timeout : Timeout value in millisecond.
HAL_StatusTypeDef HAL_ADC_Start_DMA (
ADC_HandleTypeDef * hadc, uint32_t * pData, uint32_t
DocID026525 Rev 1
UM1785

Length)
4.2.18
4.2.19
Enables ADC, starts conversion of regular group and transfers

result through DMA.
Parameters
hadc : ADC handle

pData : The destination Buffer address.
Length : The length of data to be transferred from ADC
peripheral to memory.
Return values
None.
Notes
None.
HAL_ADC_Stop_DMA
Function Name
HAL_StatusTypeDef HAL_ADC_Stop_DMA (
Stop ADC conversion of regular group, disable ADC DMA

transfer, disable ADC peripheral.
Parameters
hadc : ADC handle
Return values
HAL status.
Notes
None.
HAL_ADC_GetValue
Function Name
uint32_t HAL_ADC_GetValue ( ADC_HandleTypeDef * hadc)
Get ADC regular group conversion result.
Parameters
hadc : ADC handle
Return values
Converted value
Notes
None.
DocID026525 Rev 1
91/692
4.2.20
4.2.21
4.2.22
92/692
UM1785
HAL_ADC_IRQHandler
Function Name
void HAL_ADC_IRQHandler ( ADC_HandleTypeDef * hadc)
Handles ADC interrupt request.
Parameters
hadc : ADC handle
Return values
None.
Notes
None.
HAL_ADC_ConvCpltCallback
Function Name
void HAL_ADC_ConvCpltCallback ( ADC_HandleTypeDef *

hadc)
Conversion complete callback in non blocking mode.
Parameters
hadc : ADC handle
Return values
None.
Notes
None.
HAL_ADC_ConvHalfCpltCallback
Function Name
void HAL_ADC_ConvHalfCpltCallback ( ADC_HandleTypeDef

* hadc)
Conversion DMA half-transfer callback in non blocking mode.
Parameters
hadc : ADC handle
Return values
None.
Notes
None.
DocID026525 Rev 1
UM1785
4.2.23
4.2.24
4.2.25
HAL_ADC_LevelOutOfWindowCallback
Function Name
void HAL_ADC_LevelOutOfWindowCallback (
Analog watchdog callback in non blocking mode.
Parameters
hadc : ADC handle
Return values
None.
Notes
None.
HAL_ADC_ErrorCallback
Function Name
void HAL_ADC_ErrorCallback ( ADC_HandleTypeDef * hadc)
ADC error callback in non blocking mode (ADC conversion with

interruption or transfer by DMA)
Parameters
hadc : ADC handle
Return values
None.
Notes
None.
HAL_ADC_ConfigChannel
Function Name
HAL_StatusTypeDef HAL_ADC_ConfigChannel (
ADC_HandleTypeDef * hadc, ADC_ChannelConfTypeDef *
sConfig)
Configures the the selected channel to be linked to the regular

group.
Parameters
hadc : ADC handle

sConfig : Structure of ADC channel for regular group.
Return values
HAL status
Notes
In case of usage of internal measurement channels:

VrefInt/Vbat/TempSensor. Sampling time constraints must be
respected (sampling time can be adjusted in function of ADC
clock frequency and sampling time setting). Refer to device
DocID026525 Rev 1
93/692
4.2.26
4.2.27
94/692
UM1785
datasheet for timings values, parameters TS_vrefint, TS_vbat,
TS_temp (values rough order: 5us to 17us). These internal
paths can be be disabled using function HAL_ADC_DeInit().
initializes channel into regular group, following calls to this
function can be used to reconfigure some parameters of
structure "ADC_ChannelConfTypeDef" on the fly, without
reseting the ADC. The setting of these parameters is
conditioned to ADC state. For parameters constraints, see
comments of structure "ADC_ChannelConfTypeDef".
HAL_ADC_AnalogWDGConfig
Function Name
HAL_StatusTypeDef HAL_ADC_AnalogWDGConfig (
ADC_HandleTypeDef * hadc, ADC_AnalogWDGConfTypeDef *
AnalogWDGConfig)
Configures the analog watchdog.
Parameters
hadc : ADC handle

AnalogWDGConfig : Structure of ADC analog watchdog
configuration
Return values
HAL status
Notes

initializes the selected analog watchdog, following calls to this
function can be used to reconfigure some parameters of
structure "ADC_AnalogWDGConfTypeDef" on the fly, without
reseting the ADC. The setting of these parameters is
conditioned to ADC state. For parameters constraints, see
comments of structure "ADC_AnalogWDGConfTypeDef".
HAL_ADC_GetState
Function Name
HAL_ADC_StateTypeDef HAL_ADC_GetState (
return the ADC state
Parameters
hadc : ADC handle
Return values
HAL state
DocID026525 Rev 1
UM1785

Notes
4.2.28
None.
HAL_ADC_GetError
Function Name
uint32_t HAL_ADC_GetError ( ADC_HandleTypeDef * hadc)
Return the ADC error code.
Parameters
hadc : ADC handle
Return values
ADC Error Code
Notes
None.
4.3
ADC Firmware driver defines
4.3.1
ADC
ADC
ADC analog watchdog mode
ADC_ANALOGWATCHDOG_NONE
ADC_ANALOGWATCHDOG_SINGLE_REG
ADC_ANALOGWATCHDOG_ALL_REG
IS_ADC_ANALOG_WATCHDOG_MODE
ADC channels
ADC_CHANNEL_0
ADC_CHANNEL_1
ADC_CHANNEL_2
ADC_CHANNEL_3
ADC_CHANNEL_4
ADC_CHANNEL_5
ADC_CHANNEL_6
ADC_CHANNEL_7
ADC_CHANNEL_8
ADC_CHANNEL_9
ADC_CHANNEL_10
DocID026525 Rev 1
95/692

ADC_CHANNEL_11
UM1785
ADC_CHANNEL_12
ADC_CHANNEL_13
ADC_CHANNEL_14
ADC_CHANNEL_15
ADC_CHANNEL_16
ADC_CHANNEL_17
ADC_CHANNEL_18
ADC_CHANNEL_TEMPSENSOR
ADC_CHANNEL_VREFINT
ADC_CHANNEL_VBAT
IS_ADC_CHANNEL
ADC ClockPrescaler
ADC_CLOCK_ASYNC
ADC asynchronous clock derived from ADC

dedicated HSI
ADC_CLOCK_SYNC_PCLK_DIV2
ADC synchronous clock derived from AHB

clock divided by a prescaler of 2
ADC_CLOCK_SYNC_PCLK_DIV4
ADC synchronous clock derived from AHB

clock divided by a prescaler of 4
ADC_CLOCKPRESCALER_PCLK_DIV2
ADC_CLOCKPRESCALER_PCLK_DIV4
IS_ADC_CLOCKPRESCALER
ADC Data_align
ADC_DATAALIGN_RIGHT
ADC_DATAALIGN_LEFT
IS_ADC_DATA_ALIGN
ADC EOCSelection
EOC_SINGLE_CONV
EOC_SEQ_CONV
EOC_SINGLE_SEQ_CONV
reserved for future use
IS_ADC_EOC_SELECTION
ADC Error Code
HAL_ADC_ERROR_NONE
No error
HAL_ADC_ERROR_INTERNAL
ADC IP internal error: if problem of clocking,

enable/disable, erroneous state
HAL_ADC_ERROR_OVR
Overrun error
HAL_ADC_ERROR_DMA
DMA transfer error
ADC Event type

96/692
DocID026525 Rev 1
UM1785

AWD_EVENT
ADC Analog watchdog 1 event
OVR_EVENT
ADC overrun event
IS_ADC_EVENT_TYPE
ADC Exported Macros
__HAL_ADC_RESET_HANDLE_STATE
Description:
Reset ADC handle state.
Parameters:
__HANDLE__: ADC
handle
Return value:
None:
Description:
__HAL_ADC_IS_ENABLED
Verification of ADC state:

enabled or disabled.
Parameters:
__HANDLE__: ADC
handle
Return value:
__HAL_ADC_IS_SOFTWARE_START_REGULAR
SET: (ADC enabled) or

RESET (ADC disabled)
Description:
Test if conversion trigger

of regular group is
software start or external
trigger.
Parameters:
__HANDLE__: ADC
handle
Return value:
__HAL_ADC_IS_CONVERSION_ONGOING_REGULAR
SET: (software start) or

RESET (external trigger)
Description:
Check if no conversion on
going on regular group.
Parameters:
__HANDLE__: ADC
handle
Return value:
DocID026525 Rev 1
SET: (conversion is on
going) or RESET (no
97/692
UM1785
conversion is on going)
__HAL_ADC_GET_RESOLUTION
Description:
Returns resolution bits in

CFGR1 register: RES[1:0].
Parameters:
__HANDLE__: ADC
handle
Return value:
__HAL_ADC_GET_SAMPLINGTIME
None:
Description:
Returns ADC sample time

bits in SMPR register:
SMP[2:0].
Parameters:
__HANDLE__: ADC
handle
Return value:
__HAL_ADC_GET_IT_SOURCE
None:
Description:
Checks if the specified

ADC interrupt source is
enabled or disabled.
Parameters:
__HANDLE__: ADC
handle
__INTERRUPT__: ADC
interrupt source to check
Return value:
State: ofinterruption (SET

or RESET)
Description:
__HAL_ADC_ENABLE_IT
Enable the ADC end of

conversion interrupt.
Parameters:
__HANDLE__: ADC
handle
__INTERRUPT__: ADC
Interrupt
Return value:
Description:
__HAL_ADC_DISABLE_IT
98/692
None:
DocID026525 Rev 1
UM1785
Disable the ADC end of

conversion interrupt.
Parameters:
__HANDLE__: ADC
handle
__INTERRUPT__: ADC
Interrupt
Return value:
None:
Description:
__HAL_ADC_GET_FLAG
Get the selected ADC's

flag status.
Parameters:
__HANDLE__: ADC
handle
__FLAG__: ADC flag
Return value:
None:
Description:
__HAL_ADC_CLEAR_FLAG
Clear the ADC's pending

flags.
Parameters:
__HANDLE__: ADC
handle
__FLAG__: ADC flag
Return value:
__HAL_ADC_CLEAR_ERRORCODE
None:
Description:
Clear ADC error code (set

it to error code: "no error")
Parameters:
__HANDLE__: ADC
handle
Return value:
__HAL_ADC_CHSELR_CHANNEL
None:
Description:
Configure the channel

number into channel
selection register.
Parameters:
DocID026525 Rev 1
_CHANNEL_: ADC
99/692
UM1785
Channel
Return value:
None:
ADC Exported Macro internal HAL driver

__HAL_ADC_CFGR_AWDCH
Description:
Set the Analog Watchdog 1

channel.
Parameters:
_CHANNEL_: channel to be
monitored by Analog Watchdog
1.
Return value:
__HAL_ADC_CFGR1_REG_DISCCONTINUOUS
None:
Description:
Enable ADC discontinuous

conversion mode for regular
group.
Parameters:
_REG_DISCONTINUOUS_MO
DE_: Regulat discontinuous
mode.
Return value:
__HAL_ADC_CFGR1_AUTOOFF
None:
Description:
Enable the ADC auto off mode.
Parameters:
_AUTOOFF_: Auto off bit

enable or disable.
Return value:
__HAL_ADC_CFGR1_AUTOWAIT
None:
Description:
Enable the ADC auto delay

mode.
Parameters:
_AUTOWAIT_: Auto delay bit

enable or disable.
Return value:
__HAL_ADC_CFGR1_CONTINUOUS
Description:
100/692
DocID026525 Rev 1
None:
Enable ADC continuous
UM1785

conversion mode.
Parameters:
_CONTINUOUS_MODE_:
Continuous mode.
Return value:
__HAL_ADC_CFGR1_OVERRUN
None:
Description:
Enable ADC overrun mode.
Parameters:
_OVERRUN_MODE_: Overrun
mode.
Return value:
__HAL_ADC_CFGR1_SCANDIR
Overun: bit setting to be

programmed into CFGR
register
Description:
Enable ADC scan mode to

convert multiple ranks with
sequencer.
Parameters:
_SCAN_MODE_: Scan
conversion mode.
Return value:
__HAL_ADC_CFGR1_DMACONTREQ
None:
Description:
Enable the ADC DMA

continuous request.
Parameters:
_DMACONTREQ_MODE_:
DMA continuous request mode.
Return value:
__HAL_ADC_OFR_CHANNEL
None:
Description:
Configure the channel number

into offset OFRx register.
Parameters:
_CHANNEL_: ADC Channel
Return value:
DocID026525 Rev 1
None:
101/692

__HAL_ADC_TRX_HIGHTHRESHOLD
UM1785
Description:
Configure the analog watchdog

high threshold into register TR.
Parameters:
_Threshold_: Threshold value
Return value:
None:
Description:
__HAL_ADC_ENABLE
Enable the ADC peripheral.
Parameters:
__HANDLE__: ADC handle
Return value:
__HAL_ADC_ENABLING_CONDITIONS
None:
Description:
Verification of hardware
constraints before ADC can be
enabled.
Parameters:
Return value:
SET: (ADC can be enabled) or

RESET (ADC cannot be
enabled)
Description:
__HAL_ADC_DISABLE
Disable the ADC peripheral.
Parameters:
Return value:
__HAL_ADC_DISABLING_CONDITIONS
None:
Description:
Verification of hardware
constraints before ADC can be
disabled.
Parameters:
Return value:
102/692
DocID026525 Rev 1
SET: (ADC can be disabled) or

RESET (ADC cannot be
disabled)
UM1785
__HAL_ADC_AWD1THRESHOLD_SHIFT_RESOL
UTION

Description:
Shift the AWD threshold in

function of the selected ADC
resolution.
Parameters:

_Threshold_: Value to be
shifted
Return value:
None:
ADC External trigger edge Regular

ADC_EXTERNALTRIGCONVEDGE_NONE
ADC_EXTERNALTRIGCONVEDGE_RISING
ADC_EXTERNALTRIGCONVEDGE_FALLING
ADC_EXTERNALTRIGCONVEDGE_RISINGFALLING
IS_ADC_EXTTRIG_EDGE
ADC External trigger source Regular
ADC_EXTERNALTRIGCONV_T1_TRGO
ADC_EXTERNALTRIGCONV_T1_CC4
ADC_SOFTWARE_START
IS_ADC_EXTTRIG
ADC flags definition
ADC_FLAG_AWD
ADC Analog watchdog flag
ADC_FLAG_OVR
ADC overrun flag
ADC_FLAG_EOS
ADC End of Regular sequence of Conversions flag
ADC_FLAG_EOC
ADC End of Regular Conversion flag
ADC_FLAG_EOSMP
ADC End of Sampling flag
ADC_FLAG_RDY
ADC Ready flag
ADC_FLAG_ALL
ADC_FLAG_POSTCONV_ALL
ADC Internal HAL driver Ext trig src Regular
ADC1_2_EXTERNALTRIG_T1_TRGO
ADC1_2_EXTERNALTRIG_T1_CC4
DocID026525 Rev 1
103/692

UM1785
ADC interrupts definition

ADC_IT_AWD
ADC Analog watchdog interrupt source
ADC_IT_OVR
ADC overrun interrupt source
ADC_IT_EOS
ADC End of Regular sequence of Conversions interrupt source
ADC_IT_EOC
ADC End of Regular Conversion interrupt source
ADC_IT_EOSMP
ADC End of Sampling interrupt source
ADC_IT_RDY
ADC Ready interrupt source
ADC Overrun
OVR_DATA_OVERWRITTEN
OVR_DATA_PRESERVED
IS_ADC_OVERRUN
ADC Private Constants
ADC_ENABLE_TIMEOUT
ADC_DISABLE_TIMEOUT
ADC_STOP_CONVERSION_TIMEOUT
ADC_TEMPSENSOR_DELAY_CPU_CYCLES
ADC_STAB_DELAY_CPU_CYCLES
ADC range verification
IS_ADC_RANGE
ADC rank
ADC_RANK_CHANNEL_NUMBER
Enable the rank of the selected channels. Rank is

defined by each channel number (channel 0 fixed on
rank 0, channel 1 fixed on rank1, ...)
ADC_RANK_NONE
Disable the selected rank (selected channel) from

sequencer
IS_ADC_RANK
ADC regular rank verification
IS_ADC_REGULAR_RANK
ADC Resolution
ADC_RESOLUTION12b
ADC 12-bit resolution
ADC_RESOLUTION10b
ADC_RESOLUTION8b
ADC_RESOLUTION6b
IS_ADC_RESOLUTION
ADC sampling times
ADC_SAMPLETIME_1CYCLE_5
104/692
Sampling time 1.5 ADC clock cycle
DocID026525 Rev 1
UM1785
ADC_SAMPLETIME_7CYCLES_5

Sampling time 7.5 ADC clock cycles
IS_ADC_SAMPLE_TIME
ADC Scan mode
ADC_SCAN_DIRECTION_FORWARD
Scan direction forward: from channel 0 to

channel 18
ADC_SCAN_DIRECTION_BACKWARD
Scan direction backward: from channel 18 to

channel 0
ADC_SCAN_ENABLE
IS_ADC_SCAN_MODE
DocID026525 Rev 1
105/692
HAL ADC Extension Driver
UM1785
5.1
ADCEx Firmware driver API description

The following section lists the various functions of the ADCEx library.
5.1.1
ADC specific features
1.
2.
12-bit, 10-bit, 8-bit or 6-bit configurable resolution

Interrupt generation at the end of regular conversion and in case of analog watchdog
or overrun events.
3.
Single and continuous conversion modes.
4.
Scan mode for automatic conversion of channel 0 to channel 'n'.
5.
Data alignment with in-built data coherency.
6.
Programmable sampling time.
7.
ADC conversion group Regular.
8.
External trigger (timer or EXTI) with configurable polarity.
9.
DMA request generation for transfer of conversions data of regular group.
10. ADC calibration
11. ADC supply requirements: 2.4 V to 3.6 V at full speed and down to 1.8 V at slower
speed.
12. ADC input range: from Vref minud (connected to Vssa) to Vref plus(connected to
Vdda or to an external voltage reference).
5.1.2
1.
2.
3.
106/692
Enable the ADC interface As prerequisite, into HAL_ADC_MspInit(), ADC clock must
be configured at RCC top level: clock source and clock prescaler. Two possible clock
sources: synchronous clock derived from APB clock or asynchronous clock derived
from ADC dedicated HSI RC oscillator 14MHz. Example: __ADC1_CLK_ENABLE();
(mandatory) HI14 enable or let under control of ADC: (optional) RCC_OscInitTypeDef
RCC_OscInitStructure; RCC_OscInitStructure.OscillatorType =
RCC_OSCILLATORTYPE_HSI14; RCC_OscInitStructure.HSI14CalibrationValue =
RCC_HSI14CALIBRATION_DEFAULT; RCC_OscInitStructure.HSI14State =
RCC_HSI14_ADC_CONTROL; RCC_OscInitStructure.PLL... (optional if used for
system clock) HAL_RCC_OscConfig(&RCC_OscInitStructure); Parameter
"HSI14State" must be set either: - to "...HSI14State = RCC_HSI14_ADC_CONTROL"
to let the ADC control the HSI14 oscillator enable/disable (if not used to supply the
main system clock): feature used if ADC mode LowPowerAutoPowerOff is enabled. to "...HSI14State = RCC_HSI14_ON" to maintain the HSI14 oscillator always enabled:
can be used to supply the main system clock.
ADC pins configuration
Enable the clock for the ADC GPIOs using the following function:
Configure these ADC pins in analog mode using HAL_GPIO_Init();

Configure the ADC parameters (conversion resolution, data alignment, continuous
mode, ...) using the HAL_ADC_Init() function.
DocID026525 Rev 1
UM1785
4.

Activate the ADC peripheral using one of the start functions: HAL_ADC_Start(),
HAL_ADC_Start_IT(), HAL_ADC_Start_DMA().
Regular channels group configuration
To configure the ADC regular channels group features, use HAL_ADC_Init() and
HAL_ADC_ConfigChannel() functions.
To activate the continuous mode, use the HAL_ADC_Init() function.
To read the ADC converted values, use the HAL_ADC_GetValue() function.
DMA for Regular channels group features configuration
5.1.3
To enable the DMA mode for regular channels group, use the
HAL_ADC_Start_DMA() function.
To enable the generation of DMA requests continuously at the end of the last DMA
transfer, use the HAL_ADC_Init() function.
5.1.4
Perform the ADC calibration.

HAL_ADCEx_Calibration_Start()
HAL_ADCEx_Calibration_Start
Function Name
HAL_StatusTypeDef HAL_ADCEx_Calibration_Start (
Perform an ADC automatic self-calibration Calibration

prerequisite: ADC must be disabled (execute this function before
HAL_ADC_Start() or after HAL_ADC_Stop() ).
Parameters
hadc : ADC handle
Return values
HAL status
Notes
Calibration factor can be read after calibration, using function

HAL_ADC_GetValue() (value on 7 bits: from DR[6;0]).
5.2
ADCEx Firmware driver defines
5.2.1
ADCEx
ADCEx
ADCEx Private Constants
DocID026525 Rev 1
107/692

ADC_DISABLE_TIMEOUT
UM1785
ADC_CALIBRATION_TIMEOUT
108/692
DocID026525 Rev 1
UM1785
HAL CAN Generic Driver
6.1
CAN Firmware driver registers structures
6.1.1
CAN_InitTypeDef
CAN_InitTypeDef is defined in the stm32f0xx_hal_can.h
Data Fields
uint32_t Prescaler
uint32_t Mode
uint32_t SJW
uint32_t BS1
uint32_t BS2
uint32_t TTCM
uint32_t ABOM
uint32_t AWUM
uint32_t NART
uint32_t RFLM
uint32_t TXFP
Field Documentation
6.1.2
uint32_t CAN_InitTypeDef::Prescaler Specifies the length of a time quantum. This

parameter must be a number between Min_Data = 1 and Max_Data = 1024.
uint32_t CAN_InitTypeDef::Mode Specifies the CAN operating mode. This
parameter can be a value of CAN_operating_mode
uint32_t CAN_InitTypeDef::SJW Specifies the maximum number of time quanta the
CAN hardware is allowed to lengthen or shorten a bit to perform resynchronization.
This parameter can be a value of CAN_synchronisation_jump_width
uint32_t CAN_InitTypeDef::BS1 Specifies the number of time quanta in Bit Segment
1. This parameter can be a value of CAN_time_quantum_in_bit_segment_1
uint32_t CAN_InitTypeDef::BS2 Specifies the number of time quanta in Bit Segment
2. This parameter can be a value of CAN_time_quantum_in_bit_segment_2
uint32_t CAN_InitTypeDef::TTCM Enable or disable the time triggered
communication mode. This parameter can be set to ENABLE or DISABLE.
uint32_t CAN_InitTypeDef::ABOM Enable or disable the automatic bus-off
management. This parameter can be set to ENABLE or DISABLE.
uint32_t CAN_InitTypeDef::AWUM Enable or disable the automatic wake-up mode.
This parameter can be set to ENABLE or DISABLE.
uint32_t CAN_InitTypeDef::NART Enable or disable the non-automatic
retransmission mode. This parameter can be set to ENABLE or DISABLE.
uint32_t CAN_InitTypeDef::RFLM Enable or disable the Receive FIFO Locked
mode. This parameter can be set to ENABLE or DISABLE.
uint32_t CAN_InitTypeDef::TXFP Enable or disable the transmit FIFO priority. This
parameter can be set to ENABLE or DISABLE.
CAN_FilterConfTypeDef
CAN_FilterConfTypeDef is defined in the stm32f0xx_hal_can.h
DocID026525 Rev 1
109/692

Data Fields
UM1785
uint32_t FilterIdHigh
uint32_t FilterIdLow
uint32_t FilterMaskIdHigh
uint32_t FilterMaskIdLow
uint32_t FilterFIFOAssignment
uint32_t FilterNumber
uint32_t FilterMode
uint32_t FilterScale
uint32_t FilterActivation
uint32_t BankNumber
Field Documentation
6.1.3
uint32_t CAN_FilterConfTypeDef::FilterIdHigh Specifies the filter identification

number (MSBs for a 32-bit configuration, first one for a 16-bit configuration). This
parameter must be a number between Min_Data = 0x0000 and Max_Data = 0xFFFF.
uint32_t CAN_FilterConfTypeDef::FilterIdLow Specifies the filter identification
number (LSBs for a 32-bit configuration, second one for a 16-bit configuration). This
parameter must be a number between Min_Data = 0x0000 and Max_Data = 0xFFFF.
uint32_t CAN_FilterConfTypeDef::FilterMaskIdHigh Specifies the filter mask
number or identification number, according to the mode (MSBs for a 32-bit
configuration, first one for a 16-bit configuration). This parameter must be a number
between Min_Data = 0x0000 and Max_Data = 0xFFFF.
uint32_t CAN_FilterConfTypeDef::FilterMaskIdLow Specifies the filter mask
number or identification number, according to the mode (LSBs for a 32-bit
configuration, second one for a 16-bit configuration). This parameter must be a
number between Min_Data = 0x0000 and Max_Data = 0xFFFF.
uint32_t CAN_FilterConfTypeDef::FilterFIFOAssignment Specifies the FIFO (0 or
1) which will be assigned to the filter. This parameter can be a value of
CAN_filter_FIFO
uint32_t CAN_FilterConfTypeDef::FilterNumber Specifies the filter which will be
initialized. This parameter must be a number between Min_Data = 0 and Max_Data =
27.
uint32_t CAN_FilterConfTypeDef::FilterMode Specifies the filter mode to be
initialized. This parameter can be a value of CAN_filter_mode
uint32_t CAN_FilterConfTypeDef::FilterScale Specifies the filter scale. This
parameter can be a value of CAN_filter_scale
uint32_t CAN_FilterConfTypeDef::FilterActivation Enable or disable the filter. This
parameter can be set to ENABLE or DISABLE.
uint32_t CAN_FilterConfTypeDef::BankNumber Select the start slave bank filter
This parameter must be a number between Min_Data = 0 and Max_Data = 28.
CanTxMsgTypeDef
CanTxMsgTypeDef is defined in the stm32f0xx_hal_can.h
Data Fields
110/692
uint32_t StdId
uint32_t ExtId
uint32_t IDE
uint32_t RTR
DocID026525 Rev 1
UM1785
uint32_t DLC
uint32_t Data
Field Documentation
6.1.4
uint32_t CanTxMsgTypeDef::StdId Specifies the standard identifier. This parameter

must be a number between Min_Data = 0 and Max_Data = 0x7FF.
uint32_t CanTxMsgTypeDef::ExtId Specifies the extended identifier. This parameter
must be a number between Min_Data = 0 and Max_Data = 0x1FFFFFFF.
uint32_t CanTxMsgTypeDef::IDE Specifies the type of identifier for the message that
will be transmitted. This parameter can be a value of CAN_identifier_type
uint32_t CanTxMsgTypeDef::RTR Specifies the type of frame for the message that
will be transmitted. This parameter can be a value of
CAN_remote_transmission_request
uint32_t CanTxMsgTypeDef::DLC Specifies the length of the frame that will be
transmitted. This parameter must be a number between Min_Data = 0 and Max_Data
= 8.
uint32_t CanTxMsgTypeDef::Data[8] Contains the data to be transmitted. This
parameter must be a number between Min_Data = 0 and Max_Data = 0xFF.
CanRxMsgTypeDef
CanRxMsgTypeDef is defined in the stm32f0xx_hal_can.h
Data Fields
uint32_t StdId
uint32_t ExtId
uint32_t IDE
uint32_t RTR
uint32_t DLC
uint32_t Data
uint32_t FMI
uint32_t FIFONumber
Field Documentation
uint32_t CanRxMsgTypeDef::StdId Specifies the standard identifier. This parameter

must be a number between Min_Data = 0 and Max_Data = 0x7FF.
uint32_t CanRxMsgTypeDef::ExtId Specifies the extended identifier. This parameter
must be a number between Min_Data = 0 and Max_Data = 0x1FFFFFFF.
uint32_t CanRxMsgTypeDef::IDE Specifies the type of identifier for the message
that will be received. This parameter can be a value of CAN_identifier_type
uint32_t CanRxMsgTypeDef::RTR Specifies the type of frame for the received
message. This parameter can be a value of CAN_remote_transmission_request
uint32_t CanRxMsgTypeDef::DLC Specifies the length of the frame that will be
received. This parameter must be a number between Min_Data = 0 and Max_Data =
8.
uint32_t CanRxMsgTypeDef::Data[8] Contains the data to be received. This
parameter must be a number between Min_Data = 0 and Max_Data = 0xFF.
uint32_t CanRxMsgTypeDef::FMI Specifies the index of the filter the message
stored in the mailbox passes through. This parameter must be a number between
Min_Data = 0 and Max_Data = 0xFF.
DocID026525 Rev 1
111/692
6.1.5
UM1785
uint32_t CanRxMsgTypeDef::FIFONumber Specifies the receive FIFO number. This

parameter can be CAN_FIFO0 or CAN_FIFO1
CAN_HandleTypeDef
CAN_HandleTypeDef is defined in the stm32f0xx_hal_can.h
Data Fields
CAN_TypeDef * Instance
CAN_InitTypeDef Init
CanTxMsgTypeDef * pTxMsg
CanRxMsgTypeDef * pRxMsg
__IO HAL_CAN_StateTypeDef State
__IO HAL_CAN_ErrorTypeDef ErrorCode
Field Documentation
6.2
CAN_TypeDef* CAN_HandleTypeDef::Instance Register base address

CAN_InitTypeDef CAN_HandleTypeDef::Init CAN required parameters
CanTxMsgTypeDef* CAN_HandleTypeDef::pTxMsg Pointer to transmit structure
CanRxMsgTypeDef* CAN_HandleTypeDef::pRxMsg Pointer to reception structure
HAL_LockTypeDef CAN_HandleTypeDef::Lock CAN locking object
__IO HAL_CAN_StateTypeDef CAN_HandleTypeDef::State CAN communication
state
__IO HAL_CAN_ErrorTypeDef CAN_HandleTypeDef::ErrorCode CAN Error code
CAN Firmware driver API description

The following section lists the various functions of the CAN library.
6.2.1
1.
2.
3.
4.
5.
Enable the CAN controller interface clock using __CAN_CLK_ENABLE();

CAN pins configuration
Enable the clock for the CAN GPIOs using the following function:
Connect and configure the involved CAN pins to AF9 using the following function
HAL_GPIO_Init();
Initialise and configure the CAN using HAL_CAN_Init() function.
Transmit the desired CAN frame using HAL_CAN_Transmit() function.
Receive a CAN frame using HAL_CAN_Receive() function.
Polling mode IO operation
112/692
DocID026525 Rev 1
UM1785
Start the CAN peripheral transmission and wait the end of this operation using
HAL_CAN_Transmit(), at this stage user can specify the value of timeout according to
his end application
Start the CAN peripheral reception and wait the end of this operation using
HAL_CAN_Receive(), at this stage user can specify the value of timeout according to
his end application
Interrupt mode IO operation
Start the CAN peripheral transmission using HAL_CAN_Transmit_IT()

Start the CAN peripheral reception using HAL_CAN_Receive_IT()
Use HAL_CAN_IRQHandler() called under the used CAN Interrupt subroutine
At CAN end of transmission HAL_CAN_TxCpltCallback() function is executed and
user can add his own code by customization of function pointer
HAL_CAN_TxCpltCallback
In case of CAN Error, HAL_CAN_ErrorCallback() function is executed and user can
add his own code by customization of function pointer HAL_CAN_ErrorCallback
CAN HAL driver macros list

Below the list of most used macros in CAN HAL driver.
__HAL_CAN_ENABLE_IT: Enable the specified CAN interrupts

__HAL_CAN_DISABLE_IT: Disable the specified CAN interrupts
__HAL_CAN_GET_IT_SOURCE: Check if the specified CAN interrupt source is
enabled or disabled
__HAL_CAN_CLEAR_FLAG: Clear the CAN's pending flags
__HAL_CAN_GET_FLAG: Get the selected CAN's flag status
You can refer to the CAN HAL driver header file for more useful macros
6.2.2

6.2.3
Initialize and configure the CAN.

De-initialize the CAN.
HAL_CAN_Init()
HAL_CAN_ConfigFilter()
HAL_CAN_DeInit()
HAL_CAN_MspInit()
HAL_CAN_MspDeInit()
Transmit a CAN frame message.

Receive a CAN frame message.
DocID026525 Rev 1
113/692
6.2.4
UM1785
Enter CAN peripheral in sleep mode.

Wake up the CAN peripheral from sleep mode.
HAL_CAN_Transmit()
HAL_CAN_Transmit_IT()
HAL_CAN_Receive()
HAL_CAN_Receive_IT()
HAL_CAN_Sleep()
HAL_CAN_WakeUp()
HAL_CAN_IRQHandler()
HAL_CAN_TxCpltCallback()
HAL_CAN_RxCpltCallback()
HAL_CAN_ErrorCallback()
Peripheral State and Error functions

This subsection provides functions allowing to :
6.2.5
6.2.6
114/692
Check the CAN state.

Check CAN Errors detected during interrupt process
HAL_CAN_GetState()
HAL_CAN_GetError()
HAL_CAN_Init
Function Name
HAL_StatusTypeDef HAL_CAN_Init ( CAN_HandleTypeDef *

hcan)
Initializes the CAN peripheral according to the specified

parameters in the CAN_InitStruct.
Parameters
hcan : pointer to a CAN_HandleTypeDef structure that

contains the configuration information for the specified CAN.
Return values
HAL status
Notes
None.
HAL_CAN_ConfigFilter
Function Name
HAL_StatusTypeDef HAL_CAN_ConfigFilter (
CAN_HandleTypeDef * hcan, CAN_FilterConfTypeDef *
sFilterConfig)
Configures the CAN reception filter according to the specified

parameters in the CAN_FilterInitStruct.
DocID026525 Rev 1
UM1785

Parameters
6.2.7
6.2.8
6.2.9

sFilterConfig : pointer to a CAN_FilterConfTypeDef
structure that contains the filter configuration information.
Return values
None.
Notes
None.
HAL_CAN_DeInit
Function Name
HAL_StatusTypeDef HAL_CAN_DeInit ( CAN_HandleTypeDef *

hcan)
Deinitializes the CANx peripheral registers to their default reset

values.
Parameters

Return values
HAL status
Notes
None.
HAL_CAN_MspInit
Function Name
void HAL_CAN_MspInit ( CAN_HandleTypeDef * hcan)
Initializes the CAN MSP.
Parameters

Return values
None.
Notes
None.
HAL_CAN_MspDeInit
DocID026525 Rev 1
115/692

Function Name
6.2.10
6.2.11
116/692
UM1785
void HAL_CAN_MspDeInit ( CAN_HandleTypeDef * hcan)
DeInitializes the CAN MSP.
Parameters

Return values
None.
Notes
None.
HAL_CAN_Transmit
Function Name
HAL_StatusTypeDef HAL_CAN_Transmit (
CAN_HandleTypeDef * hcan, uint32_t Timeout)
Initiates and transmits a CAN frame message.
Parameters

Timeout : Timeout duration.
Return values
HAL status
Notes
None.
HAL_CAN_Transmit_IT
Function Name
HAL_StatusTypeDef HAL_CAN_Transmit_IT (
CAN_HandleTypeDef * hcan)
Initiates and transmits a CAN frame message.
Parameters

Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
6.2.12
6.2.13
6.2.14
HAL_CAN_Receive
Function Name
HAL_StatusTypeDef HAL_CAN_Receive (
CAN_HandleTypeDef * hcan, uint8_t FIFONumber, uint32_t
Timeout)
Receives a correct CAN frame.
Parameters

FIFONumber : FIFO number.
Return values
HAL.
Notes
None.
HAL_CAN_Receive_IT
Function Name
HAL_StatusTypeDef HAL_CAN_Receive_IT (
CAN_HandleTypeDef * hcan, uint8_t FIFONumber)
Receives a correct CAN frame.
Parameters

FIFONumber : FIFO number.
Return values
HAL.
Notes
None.
HAL_CAN_Sleep
Function Name
HAL_StatusTypeDef HAL_CAN_Sleep ( CAN_HandleTypeDef *

hcan)
Enters the Sleep (low power) mode.
Parameters

DocID026525 Rev 1
117/692

Return values
Notes
6.2.15
6.2.16
6.2.17
118/692
UM1785
HAL status.
None.
HAL_CAN_WakeUp
Function Name
HAL_StatusTypeDef HAL_CAN_WakeUp (
Wakes up the CAN peripheral from sleep mode, after that the
CAN peripheral is in the normal mode.
Parameters

Return values
HAL status.
Notes
None.
HAL_CAN_IRQHandler
Function Name
void HAL_CAN_IRQHandler ( CAN_HandleTypeDef * hcan)
Handles CAN interrupt request.
Parameters

Return values
None.
Notes
None.
HAL_CAN_TxCpltCallback
Function Name
void HAL_CAN_TxCpltCallback ( CAN_HandleTypeDef *

hcan)
Transmission complete callback in non blocking mode.

DocID026525 Rev 1
UM1785
6.2.18
6.2.19
6.2.20

Parameters

Return values
None.
Notes
None.
HAL_CAN_RxCpltCallback
Function Name
void HAL_CAN_RxCpltCallback ( CAN_HandleTypeDef *

hcan)
Transmission complete callback in non blocking mode.
Parameters

Return values
None.
Notes
None.
HAL_CAN_ErrorCallback
Function Name
void HAL_CAN_ErrorCallback ( CAN_HandleTypeDef * hcan)
Error CAN callback.
Parameters

Return values
None.
Notes
None.
HAL_CAN_GetState
Function Name
HAL_CAN_StateTypeDef HAL_CAN_GetState (
DocID026525 Rev 1
119/692

6.2.21
UM1785
return the CAN state
Parameters

Return values
HAL state
Notes
None.
HAL_CAN_GetError
Function Name
uint32_t HAL_CAN_GetError ( CAN_HandleTypeDef * hcan)
Return the CAN error code.
Parameters

Return values
CAN Error Code
Notes
None.
6.3
CAN Firmware driver defines
6.3.1
CAN
CAN
CAN clock prescaler
IS_CAN_PRESCALER
CAN Exported Macros
__HAL_CAN_RESET_HANDLE_STATE
Description:
Reset CAN handle state.
Parameters:
__HANDLE__: CAN handle.
Return value:
__HAL_CAN_ENABLE_IT
None:
Description:
Enable the specified CAN interrupts.
Parameters:
120/692
DocID026525 Rev 1
UM1785
__INTERRUPT__: CAN Interrupt
Return value:
None:
Description:
__HAL_CAN_DISABLE_IT
Disable the specified CAN interrupts.
Parameters:

__INTERRUPT__: CAN Interrupt
Return value:
__HAL_CAN_MSG_PENDING
None:
Description:
Return the number of pending received

messages.
Parameters:

__FIFONUMBER__: Receive FIFO
number, CAN_FIFO0 or CAN_FIFO1.
Return value:
CAN_FLAG_MASK
The: number of pending message.
Description:
Check whether the specified CAN flag is

set or not.
Parameters:
__HANDLE__: specifies the CAN Handle.

__FLAG__: specifies the flag to check.
This parameter can be one of the following
values:
CAN_TSR_RQCP0: Request
MailBox0 Flag
MailBox1 Flag
MailBox2 Flag
CAN_FLAG_TXOK0: Transmission
OK MailBox0 Flag
OK MailBox1 Flag
OK MailBox2 Flag
CAN_FLAG_TME0: Transmit mailbox

0 empty Flag

1 empty Flag

2 empty Flag
DocID026525 Rev 1
121/692
UM1785
CAN_FLAG_FMP0: FIFO 0 Message

Pending Flag
CAN_FLAG_FF0: FIFO 0 Full Flag
CAN_FLAG_FOV0: FIFO 0 Overrun
Flag
Pending Flag
Flag
CAN_FLAG_WKU: Wake up Flag
CAN_FLAG_SLAK: Sleep
acknowledge Flag
CAN_FLAG_SLAKI: Sleep
acknowledge Flag
CAN_FLAG_EWG: Error Warning
Flag
CAN_FLAG_EPV: Error Passive Flag
CAN_FLAG_BOF: Bus-Off Flag
Return value:
The: new state of __FLAG__ (TRUE or

FALSE).
__HAL_CAN_GET_FLAG
__HAL_CAN_CLEAR_FLAG
Description:
Clear the specified CAN pending flag.
Parameters:
122/692

values:
MailBox0 Flag
MailBox1 Flag
MailBox2 Flag
OK MailBox0 Flag
OK MailBox1 Flag
OK MailBox2 Flag

0 empty Flag

1 empty Flag

2 empty Flag

Pending Flag
DocID026525 Rev 1
UM1785

Flag
Pending Flag
Flag
CAN_FLAG_WKU: Wake up Flag
CAN_FLAG_SLAKI: Sleep
acknowledge Flag
CAN_FLAG_EWG: Error Warning
Flag
CAN_FLAG_EPV: Error Passive Flag
CAN_FLAG_BOF: Bus-Off Flag
Return value:
__HAL_CAN_GET_IT_SOURCE

FALSE).
Description:
Check if the specified CAN interrupt source

is enabled or disabled.
Parameters:

__INTERRUPT__: specifies the CAN
interrupt source to check. This parameter
can be one of the following values:
CAN_IT_TME: Transmit mailbox

empty interrupt enable
CAN_IT_FMP0: FIFO0 message

pending interrupt enablev
CAN_IT_FMP1: FIFO1 message

pending interrupt enable
Return value:
__HAL_CAN_TRANSMIT_STATUS
The: new state of __IT__ (TRUE or

FALSE).
Description:
Check the transmission status of a CAN

Frame.
Parameters:

__TRANSMITMAILBOX__: the number of
the mailbox that is used for transmission.
Return value:
__HAL_CAN_FIFO_RELEASE
The: new status of transmission (TRUE or

FALSE).
Description:
DocID026525 Rev 1
123/692
UM1785
Release the specified receive FIFO.
Parameters:

__FIFONUMBER__: Receive FIFO
number, CAN_FIFO0 or CAN_FIFO1.
Return value:
__HAL_CAN_CANCEL_TRANSMIT
None:
Description:
Cancel a transmit request.
Parameters:

__TRANSMITMAILBOX__: the number of
the mailbox that is used for transmission.
Return value:
__HAL_CAN_DBG_FREEZE
None:
Description:
Enable or disables the DBG Freeze for

CAN.
Parameters:

__NEWSTATE__: new state of the CAN
peripheral. This parameter can be:
ENABLE (CAN reception/transmission is
frozen during debug. Reception FIFOs can
still be accessed/controlled normally) or
DISABLE (CAN is working during debug).
Return value:
None:
CAN filter FIFO

CAN_FILTER_FIFO0
Filter FIFO 0 assignment for filter x
CAN_FILTER_FIFO1
Filter FIFO 1 assignment for filter x
IS_CAN_FILTER_FIFO
CAN_FilterFIFO0
CAN_FilterFIFO1
CAN filter mode
CAN_FILTERMODE_IDMASK
Identifier mask mode
CAN_FILTERMODE_IDLIST
Identifier list mode
IS_CAN_FILTER_MODE
CAN filter number
IS_CAN_FILTER_NUMBER
124/692
DocID026525 Rev 1
UM1785

CAN filter scale
CAN_FILTERSCALE_16BIT
Two 16-bit filters
CAN_FILTERSCALE_32BIT
One 32-bit filter
IS_CAN_FILTER_SCALE
CAN flags
CAN_FLAG_RQCP0
Request MailBox0 flag
CAN_FLAG_RQCP1
CAN_FLAG_RQCP2
CAN_FLAG_TXOK0
Transmission OK MailBox0 flag
CAN_FLAG_TXOK1
CAN_FLAG_TXOK2
CAN_FLAG_TME0
Transmit mailbox 0 empty flag
CAN_FLAG_TME1
CAN_FLAG_TME2
CAN_FLAG_FF0
FIFO 0 Full flag
CAN_FLAG_FOV0
FIFO 0 Overrun flag
CAN_FLAG_FF1
FIFO 1 Full flag
CAN_FLAG_FOV1
FIFO 1 Overrun flag
CAN_FLAG_WKU
Wake up flag
CAN_FLAG_SLAK
Sleep acknowledge flag
CAN_FLAG_SLAKI
Sleep acknowledge flag
CAN_FLAG_EWG
Error warning flag
CAN_FLAG_EPV
Error passive flag
CAN_FLAG_BOF
Bus-Off flag
CAN identifier type

CAN_ID_STD
Standard Id
CAN_ID_EXT
Extended Id
IS_CAN_IDTYPE
CAN InitStatus
CAN_INITSTATUS_FAILED
CAN initialization failed
CAN_INITSTATUS_SUCCESS
CAN initialization OK
CAN interrupts
CAN_IT_TME
Transmit mailbox empty interrupt
CAN_IT_FMP0
FIFO 0 message pending interrupt
CAN_IT_FF0
FIFO 0 full interrupt
CAN_IT_FOV0
FIFO 0 overrun interrupt
DocID026525 Rev 1
125/692

CAN_IT_FMP1
UM1785
FIFO 1 message pending interrupt
CAN_IT_FF1
FIFO 1 full interrupt
CAN_IT_FOV1
FIFO 1 overrun interrupt
CAN_IT_WKU
Wake-up interrupt
CAN_IT_SLK
Sleep acknowledge interrupt
CAN_IT_EWG
Error warning interrupt
CAN_IT_EPV
Error passive interrupt
CAN_IT_BOF
Bus-off interrupt
CAN_IT_LEC
Last error code interrupt
CAN_IT_ERR
Error Interrupt
CAN_IT_RQCP0
CAN_IT_RQCP1
CAN_IT_RQCP2
CAN Mailboxes
CAN_TXMAILBOX_0
CAN_TXMAILBOX_1
CAN_TXMAILBOX_2
CAN operating mode
CAN_MODE_NORMAL
Normal mode
CAN_MODE_LOOPBACK
Loopback mode
CAN_MODE_SILENT
Silent mode
CAN_MODE_SILENT_LOOPBACK
Loopback combined with silent mode
IS_CAN_MODE
CAN Private Constants
HAL_CAN_DEFAULT_TIMEOUT
CAN receive FIFO number constants
CAN_FIFO0
CAN FIFO 0 used to receive
CAN_FIFO1
CAN FIFO 1 used to receive
IS_CAN_FIFO
CAN remote transmission request
CAN_RTR_DATA
Data frame
CAN_RTR_REMOTE
Remote frame
IS_CAN_RTR
CAN Start bank filter for slave CAN
IS_CAN_BANKNUMBER
CAN synchronisation jump width
126/692
DocID026525 Rev 1
UM1785

CAN_SJW_1TQ
1 time quantum
CAN_SJW_2TQ
2 time quantum
CAN_SJW_3TQ
3 time quantum
CAN_SJW_4TQ
4 time quantum
IS_CAN_SJW
CAN Timeouts
INAK_TIMEOUT
SLAK_TIMEOUT
CAN time quantum in bit segment 1
CAN_BS1_1TQ
1 time quantum
CAN_BS1_2TQ
2 time quantum
CAN_BS1_3TQ
3 time quantum
CAN_BS1_4TQ
4 time quantum
CAN_BS1_5TQ
5 time quantum
CAN_BS1_6TQ
6 time quantum
CAN_BS1_7TQ
7 time quantum
CAN_BS1_8TQ
8 time quantum
CAN_BS1_9TQ
9 time quantum
CAN_BS1_10TQ
10 time quantum
CAN_BS1_11TQ
11 time quantum
CAN_BS1_12TQ
12 time quantum
CAN_BS1_13TQ
13 time quantum
CAN_BS1_14TQ
14 time quantum
CAN_BS1_15TQ
15 time quantum
CAN_BS1_16TQ
16 time quantum
IS_CAN_BS1
CAN time quantum in bit segment 2
CAN_BS2_1TQ
1 time quantum
CAN_BS2_2TQ
2 time quantum
CAN_BS2_3TQ
3 time quantum
CAN_BS2_4TQ
4 time quantum
CAN_BS2_5TQ
5 time quantum
CAN_BS2_6TQ
6 time quantum
CAN_BS2_7TQ
7 time quantum
CAN_BS2_8TQ
8 time quantum
IS_CAN_BS2
CAN transmit constants
DocID026525 Rev 1
127/692

CAN_TXSTATUS_FAILED
UM1785
CAN transmission failed
CAN_TXSTATUS_OK
CAN transmission succeeded
CAN_TXSTATUS_PENDING
CAN transmission pending
CAN_TXSTATUS_NOMAILBOX
CAN cell did not provide CAN_TxStatus_NoMailBox
CAN Tx
IS_CAN_TRANSMITMAILBOX
IS_CAN_STDID
IS_CAN_EXTID
IS_CAN_DLC
128/692
DocID026525 Rev 1
UM1785
HAL CEC Generic Driver
7.1
CEC Firmware driver registers structures
7.1.1
CEC_InitTypeDef
CEC_InitTypeDef is defined in the stm32f0xx_hal_cec.h
Data Fields
uint32_t SignalFreeTime
uint32_t Tolerance
uint32_t BRERxStop
uint32_t BREErrorBitGen
uint32_t LBPEErrorBitGen
uint32_t BroadcastMsgNoErrorBitGen
uint32_t SignalFreeTimeOption
uint32_t OwnAddress
uint32_t ListenMode
uint8_t InitiatorAddress
Field Documentation
uint32_t CEC_InitTypeDef::SignalFreeTime Set SFT field, specifies the Signal Free

Time. It can be one of CEC_Signal_Free_Time and belongs to the set {0,...,7} where
0x0 is the default configuration else means 0.5 + (SignalFreeTime - 1) nominal data
bit periods
uint32_t CEC_InitTypeDef::Tolerance Set RXTOL bit, specifies the tolerance
accepted on the received waveforms, it can be a value of CEC_Tolerance : it is either
CEC_STANDARD_TOLERANCE or CEC_EXTENDED_TOLERANCE
uint32_t CEC_InitTypeDef::BRERxStop Set BRESTP bit CEC_BRERxStop :
specifies whether or not a Bit Rising Error stops the reception.
CEC_NO_RX_STOP_ON_BRE: reception is not stopped. CEC_RX_STOP_ON_BRE:
reception is stopped.
uint32_t CEC_InitTypeDef::BREErrorBitGen Set BREGEN bit
CEC_BREErrorBitGen : specifies whether or not an Error-Bit is generated on the
CEC line upon Bit Rising Error detection.
CEC_BRE_ERRORBIT_NO_GENERATION: no error-bit generation.
CEC_BRE_ERRORBIT_GENERATION: error-bit generation if BRESTP is set.
uint32_t CEC_InitTypeDef::LBPEErrorBitGen Set LBPEGEN bit
CEC_LBPEErrorBitGen : specifies whether or not an Error-Bit is generated on the
CEC line upon Long Bit Period Error detection.
CEC_LBPE_ERRORBIT_NO_GENERATION: no error-bit generation.
CEC_LBPE_ERRORBIT_GENERATION: error-bit generation.
uint32_t CEC_InitTypeDef::BroadcastMsgNoErrorBitGen Set BRDNOGEN bit
CEC_BroadCastMsgErrorBitGen : allows to avoid an Error-Bit generation on the
CEC line upon an error detected on a broadcast message.It supersedes BREGEN
and LBPEGEN bits for a broadcast message error handling. It can take two values:1)
CEC_BROADCASTERROR_ERRORBIT_GENERATION. a) BRE detection: error-bit
generation on the CEC line if BRESTP=CEC_RX_STOP_ON_BRE and
BREGEN=CEC_BRE_ERRORBIT_NO_GENERATION. b) LBPE detection: error-bit
generation on the CEC line if
DocID026525 Rev 1
129/692

UM1785
LBPGEN=CEC_LBPE_ERRORBIT_NO_GENERATION.2)
CEC_BROADCASTERROR_NO_ERRORBIT_GENERATION. no error-bit generation
in case neither a) nor b) are satisfied. Additionally, there is no error-bit generation in
case of Short Bit Period Error detection in a broadcast message while LSTN bit is set.
uint32_t CEC_InitTypeDef::SignalFreeTimeOption Set SFTOP bit

CEC_SFT_Option : specifies when SFT timer starts. CEC_SFT_START_ON_TXSOM
SFT: timer starts when TXSOM is set by software.
CEC_SFT_START_ON_TX_RX_END: SFT timer starts automatically at the end of
message transmission/reception.
uint32_t CEC_InitTypeDef::OwnAddress Set OAR field, specifies CEC device

address within a 15-bit long field
uint32_t CEC_InitTypeDef::ListenMode Set LSTN bit CEC_Listening_Mode :

specifies device listening mode. It can take two
values:CEC_REDUCED_LISTENING_MODE: CEC peripheral receives only message
addressed to its own address (OAR). Messages addressed to different destination are
ignored. Broadcast messages are always received.CEC_FULL_LISTENING_MODE:
CEC peripheral receives messages addressed to its own address (OAR) with positive
acknowledge. Messages addressed to different destination are received, but without
interfering with the CEC bus: no acknowledge sent.
uint8_t CEC_InitTypeDef::InitiatorAddress
7.1.2
CEC_HandleTypeDef
CEC_HandleTypeDef is defined in the stm32f0xx_hal_cec.h
Data Fields
CEC_TypeDef * Instance
CEC_InitTypeDef Init
uint8_t * pTxBuffPtr
uint16_t TxXferCount
uint8_t * pRxBuffPtr
uint16_t RxXferSize
uint32_t ErrorCode
HAL_CEC_StateTypeDef State
Field Documentation
7.2
CEC_TypeDef* CEC_HandleTypeDef::Instance
CEC_InitTypeDef CEC_HandleTypeDef::Init
uint8_t* CEC_HandleTypeDef::pTxBuffPtr
uint16_t CEC_HandleTypeDef::TxXferCount
uint8_t* CEC_HandleTypeDef::pRxBuffPtr
uint16_t CEC_HandleTypeDef::RxXferSize
uint32_t CEC_HandleTypeDef::ErrorCode
HAL_LockTypeDef CEC_HandleTypeDef::Lock
HAL_CEC_StateTypeDef CEC_HandleTypeDef::State
CEC Firmware driver API description

The following section lists the various functions of the CEC library.
130/692
DocID026525 Rev 1
UM1785
7.2.1

The CEC HAL driver can be used as follows:
1.
2.
3.
4.
7.2.2
Declare a CEC_HandleTypeDef handle structure.

Initialize the CEC low level resources by implementing the HAL_CEC_MspInit ()API:
Enable the CEC interface clock.
CEC pins configuration:
Enable the clock for the CEC GPIOs.
Configure these CEC pins as alternate function pull-up.
NVIC configuration if you need to use interrupt process

(HAL_CEC_Transmit_IT() and HAL_CEC_Receive_IT() APIs):
Configure the CEC interrupt priority.
Enable the NVIC CEC IRQ handle.

Program the Signal Free Time (SFT) and SFT option, Tolerance, reception stop in in
case of Bit Rising Error, Error-Bit generation conditions, device logical address and
Listen mode in the hcec Init structure.
Initialize the CEC registers by calling the HAL_CEC_Init() API.
This API configures also the low level Hardware GPIO, CLOCK, CORTEX...etc)
by calling the customed HAL_CEC_MspInit() API. The specific CEC interrupts
(Transmission complete interrupt, RXNE interrupt and Error Interrupts) will be
managed using the macros __HAL_CEC_ENABLE_IT() and
__HAL_CEC_DISABLE_IT() inside the transmit and receive process.
Initialization and Configuration functions

This subsection provides a set of functions allowing to initialize the CEC
7.2.3
The following parameters need to be configured:
SignalFreeTime
Tolerance
BRERxStop (RX stopped or not upon Bit Rising Error)
BREErrorBitGen (Error-Bit generation in case of Bit Rising Error)
LBPEErrorBitGen (Error-Bit generation in case of Long Bit Period Error)
BroadcastMsgNoErrorBitGen (Error-bit generation in case of broadcast message

error)
SignalFreeTimeOption (SFT Timer start definition)
OwnAddress (CEC device address)
ListenMode
HAL_CEC_Init()
HAL_CEC_DeInit()
HAL_CEC_MspInit()
HAL_CEC_MspDeInit()
IO operation function
HAL_CEC_Transmit()
HAL_CEC_Receive()
HAL_CEC_Transmit_IT()
HAL_CEC_Receive_IT()
HAL_CEC_IRQHandler()
DocID026525 Rev 1
131/692
7.2.4
UM1785
HAL_CEC_TxCpltCallback()
HAL_CEC_RxCpltCallback()
HAL_CEC_ErrorCallback()
Peripheral Control function

This subsection provides a set of functions allowing to control the CEC.
7.2.5
7.2.6
7.2.7
132/692
HAL_CEC_GetState() API can be helpful to check in run-time the state of the CEC
peripheral.
HAL_CEC_GetState()
HAL_CEC_GetError()
HAL_CEC_Init
Function Name
HAL_StatusTypeDef HAL_CEC_Init ( CEC_HandleTypeDef *

hcec)
Initializes the CEC mode according to the specified parameters in

the CEC_InitTypeDef and creates the associated handle .
Parameters
hcec : CEC handle
Return values
HAL status
Notes
None.
HAL_CEC_DeInit
Function Name
HAL_StatusTypeDef HAL_CEC_DeInit ( CEC_HandleTypeDef *

hcec)
DeInitializes the CEC peripheral.
Parameters
hcec : CEC handle
Return values
HAL status
Notes
None.
HAL_CEC_MspInit
DocID026525 Rev 1
UM1785
7.2.8
7.2.9
Function Name

void HAL_CEC_MspInit ( CEC_HandleTypeDef * hcec)
CEC MSP Init.
Parameters
hcec : CEC handle
Return values
None.
Notes
None.
HAL_CEC_MspDeInit
Function Name
void HAL_CEC_MspDeInit ( CEC_HandleTypeDef * hcec)
CEC MSP DeInit.
Parameters
hcec : CEC handle
Return values
None.
Notes
None.
HAL_CEC_Transmit
Function Name
HAL_StatusTypeDef HAL_CEC_Transmit (
CEC_HandleTypeDef * hcec, uint8_t DestinationAddress,
uint8_t * pData, uint32_t Size, uint32_t Timeout)
Send data in blocking mode.
Parameters
hcec : CEC handle

DestinationAddress : destination logical address
pData : pointer to input byte data buffer
Size : amount of data to be sent in bytes (without counting
the header). 0 means only the header is sent (ping operation).
Maximum TX size is 15 bytes (1 opcode and up to 14
operands).
Return values
HAL status
Notes
None.
DocID026525 Rev 1
133/692
7.2.10
7.2.11
7.2.12
134/692
UM1785
HAL_CEC_Receive
Function Name
HAL_StatusTypeDef HAL_CEC_Receive (
CEC_HandleTypeDef * hcec, uint8_t * pData, uint32_t
Timeout)
Receive data in blocking mode.
Parameters
hcec : CEC handle

pData : pointer to received data buffer.
Timeout : Timeout duration. Note that the received data size
is not known beforehand, the latter is known when the
reception is complete and is stored in hcec->RxXferSize.
hcec->RxXferSize is the sum of opcodes + operands (0 to 14
operands max). If only a header is received, hcec>RxXferSize = 0
Return values
HAL status
Notes
None.
HAL_CEC_Transmit_IT
Function Name
HAL_StatusTypeDef HAL_CEC_Transmit_IT (
CEC_HandleTypeDef * hcec, uint8_t DestinationAddress,
uint8_t * pData, uint32_t Size)
Send data in interrupt mode.
Parameters
hcec : CEC handle

DestinationAddress : destination logical address
pData : pointer to input byte data buffer
Size : amount of data to be sent in bytes (without counting
the header). 0 means only the header is sent (ping operation).
Maximum TX size is 15 bytes (1 opcode and up to 14
operands).
Return values
HAL status
Notes
None.
HAL_CEC_Receive_IT
DocID026525 Rev 1
UM1785
7.2.13
7.2.14

Function Name
HAL_StatusTypeDef HAL_CEC_Receive_IT (
CEC_HandleTypeDef * hcec, uint8_t * pData)
Receive data in interrupt mode.
Parameters
hcec : CEC handle

pData : pointer to received data buffer. Note that the
received data size is not known beforehand, the latter is
known when the reception is complete and is stored in hcec>RxXferSize. hcec->RxXferSize is the sum of opcodes +
operands (0 to 14 operands max). If only a header is
received, hcec->RxXferSize = 0
Return values
HAL status
Notes
None.
HAL_CEC_IRQHandler
Function Name
void HAL_CEC_IRQHandler ( CEC_HandleTypeDef * hcec)
This function handles CEC interrupt requests.
Parameters
hcec : CEC handle
Return values
None.
Notes
None.
HAL_CEC_TxCpltCallback
Function Name
void HAL_CEC_TxCpltCallback ( CEC_HandleTypeDef * hcec)
Tx Transfer completed callback.
Parameters
hcec : CEC handle
Return values
None.
Notes
None.
DocID026525 Rev 1
135/692
7.2.15
7.2.16
7.2.17
136/692
UM1785
HAL_CEC_RxCpltCallback
Function Name
void HAL_CEC_RxCpltCallback ( CEC_HandleTypeDef * hcec)
Rx Transfer completed callback.
Parameters
hcec : CEC handle
Return values
None.
Notes
None.
HAL_CEC_ErrorCallback
Function Name
void HAL_CEC_ErrorCallback ( CEC_HandleTypeDef * hcec)
CEC error callbacks.
Parameters
hcec : CEC handle
Return values
None.
Notes
None.
HAL_CEC_GetState
Function Name
HAL_CEC_StateTypeDef HAL_CEC_GetState (
CEC_HandleTypeDef * hcec)
return the CEC state
Parameters
hcec : CEC handle
Return values
HAL state
Notes
None.
DocID026525 Rev 1
UM1785
7.2.18
HAL_CEC_GetError
Function Name
uint32_t HAL_CEC_GetError ( CEC_HandleTypeDef * hcec)
Return the CEC error code.
Parameters
hcec : : pointer to a CEC_HandleTypeDef structure that

contains the configuration information for the specified CEC.
Return values
CEC Error Code
Notes
None.
7.3
CEC Firmware driver defines
7.3.1
CEC
CEC
all RX or TX errors flags in CEC ISR register
CEC_ISR_ALL_ERROR
Error Bit Generation if Bit Rise Error reported
CEC_BRE_ERRORBIT_NO_GENERATION
CEC_BRE_ERRORBIT_GENERATION
IS_CEC_BREERRORBITGEN
Reception Stop on Error
CEC_NO_RX_STOP_ON_BRE
CEC_RX_STOP_ON_BRE
IS_CEC_BRERXSTOP
Error Bit Generation on Broadcast message
CEC_BROADCASTERROR_ERRORBIT_GENERATION
CEC_BROADCASTERROR_NO_ERRORBIT_GENERATION
IS_CEC_BROADCASTERROR_NO_ERRORBIT_GENERATION
CEC Exported Macros
__HAL_CEC_RESET_HANDLE_STATE
Description:
Reset CEC handle state.
Parameters:
__HANDLE__: CEC handle.
Return value:
DocID026525 Rev 1
137/692
UM1785
None:
Description:
__HAL_CEC_GET_IT
Checks whether or not the

specified CEC interrupt flag is
set.
Parameters:
__HANDLE__: specifies the

CEC Handle.
__INTERRUPT__: specifies
the interrupt to check. This
parameter can be one of the
following values:
CEC_ISR_RXBR : RxByte Received
CEC_ISR_RXEND : End
of Reception
CEC_ISR_RXOVR : Rx
Overrun
CEC_ISR_BRE : Rx Bit
Rising Error
CEC_ISR_SBPE : Rx
Short Bit Period Error
CEC_ISR_LBPE : Rx
Long Bit Period Error
CEC_ISR_RXACKE : Rx
Missing Acknowledge
CEC_ISR_ARBLST :
Arbitration lost
CEC_ISR_TXBR : Tx-Byte
Request
CEC_ISR_TXEND : End
of Transmission
CEC_ISR_TXUDR : Txbuffer Underrun
CEC_ISR_TXERR : Tx
Error
CEC_ISR_TXACKE : Tx
Missing Acknowledge
Return value:
ITStatus:
Description:
__HAL_CEC_CLEAR_FLAG
Clears the interrupt or status

flag when raised (write at 1)
Parameters:
138/692
DocID026525 Rev 1

CEC Handle.
__FLAG__: specifies the
interrupt/status flag to clear.
This parameter can be one of
UM1785

the following values:
CEC_ISR_RXBR : RxByte Received
CEC_ISR_RXEND : End
of Reception
CEC_ISR_RXOVR : Rx
Overrun
CEC_ISR_BRE : Rx Bit
Rising Error
CEC_ISR_SBPE : Rx
Short Bit Period Error
CEC_ISR_LBPE : Rx
Long Bit Period Error
CEC_ISR_RXACKE : Rx
Missing Acknowledge
CEC_ISR_ARBLST :
Arbitration lost
CEC_ISR_TXBR : Tx-Byte
Request
CEC_ISR_TXEND : End
of Transmission
CEC_ISR_TXUDR : Txbuffer Underrun
CEC_ISR_TXERR : Tx
Error
CEC_ISR_TXACKE : Tx
Missing Acknowledge
Return value:
none:
Description:
__HAL_CEC_ENABLE_IT
Enables the specified CEC

interrupt.
Parameters:
DocID026525 Rev 1

CEC Handle.
the CEC interrupt to enable.
CEC_IER_RXBRIE : RxByte Received IT Enable
CEC_IER_RXENDIE :
End Of Reception IT
Enable
CEC_IER_RXOVRIE : RxOverrun IT Enable
CEC_IER_BREIE : Rx Bit
Rising Error IT Enable
CEC_IER_SBPEIE : Rx
Short Bit period Error IT
Enable
139/692
UM1785
CEC_IER_LBPEIE : Rx
Long Bit period Error IT
Enable
CEC_IER_RXACKEIE :
Rx Missing Acknowledge
IT Enable
CEC_IER_ARBLSTIE :
Arbitration Lost IT Enable
CEC_IER_TXBRIE : Tx
Byte Request IT Enable
CEC_IER_TXENDIE : End
of Transmission IT Enable
CEC_IER_TXUDRIE : TxBuffer Underrun IT Enable
CEC_IER_TXERRIE : TxError IT Enable
CEC_IER_TXACKEIE : Tx
Missing Acknowledge IT
Enable
Return value:
none:
Description:
__HAL_CEC_DISABLE_IT
Disables the specified CEC

interrupt.
Parameters:
140/692
DocID026525 Rev 1

CEC Handle.
the CEC interrupt to disable.
CEC_IER_RXENDIE :
End Of Reception IT
Enable
CEC_IER_SBPEIE : Rx
Enable
CEC_IER_LBPEIE : Rx
Enable
CEC_IER_RXACKEIE :
IT Enable
CEC_IER_ARBLSTIE :
UM1785
CEC_IER_TXBRIE : Tx
CEC_IER_TXERRIE : TxError IT Enable
Enable
Return value:
__HAL_CEC_GET_IT_SOURCE
none:
Description:
Checks whether or not the

specified CEC interrupt is
enabled.
Parameters:
DocID026525 Rev 1

CEC Handle.
the CEC interrupt to check.
CEC_IER_RXENDIE :
End Of Reception IT
Enable
CEC_IER_SBPEIE : Rx
Enable
CEC_IER_LBPEIE : Rx
Enable
CEC_IER_RXACKEIE :
IT Enable
CEC_IER_ARBLSTIE :
CEC_IER_TXBRIE : Tx
CEC_IER_TXERRIE : Tx141/692
UM1785
Error IT Enable
Enable
Return value:
FlagStatus:
Description:
__HAL_CEC_ENABLE
Enables the CEC device.
Parameters:

CEC Handle.
Return value:
none:
Description:
__HAL_CEC_DISABLE
Disables the CEC device.
Parameters:

CEC Handle.
Return value:
__HAL_CEC_FIRST_BYTE_TX_SET
none:
Description:
Set Transmission Start flag.
Parameters:

CEC Handle.
Return value:
__HAL_CEC_LAST_BYTE_TX_SET
none:
Description:
Set Transmission End flag.
Parameters:

CEC Handle.
Return value:
__HAL_CEC_GET_TRANSMISSION_START_FLA
G
142/692
DocID026525 Rev 1
none: If the CEC message

consists of only one byte,
TXEOM must be set before of
TXSOM.
Description:
Get Transmission Start flag.
UM1785

Parameters:

CEC Handle.
Return value:
__HAL_CEC_GET_TRANSMISSION_END_FLAG
FlagStatus:
Description:
Get Transmission End flag.
Parameters:

CEC Handle.
Return value:
FlagStatus:
Description:
__HAL_CEC_CLEAR_OAR
Clear OAR register.
Parameters:

CEC Handle.
Return value:
none:
Description:
__HAL_CEC_SET_OAR
Set OAR register (without

resetting previously set
address in case of multiaddress mode) To reset OAR,
Parameters:

CEC Handle.
__ADDRESS__: Own Address
value (CEC logical address is
identified by bit position)
Return value:
none:
Description:
IS_CEC_OAR_ADDRESS
Check CEC device Own

Address Register (OAR)
setting.
Parameters:
__ADDRESS__: CEC own

address.
Return value:
DocID026525 Rev 1
143/692
UM1785
Test: result (TRUE or FALSE).
Description:
IS_CEC_ADDRESS
Check CEC initiator or

destination logical address
setting.
Parameters:
__ADDRESS__: CEC initiator

or logical address.
Return value:
Description:
IS_CEC_MSGSIZE
Check CEC message size.
Parameters:
__SIZE__: CEC message size.
Return value:
all RX errors interrupts enabling flag

CEC_IER_RX_ALL_ERR
all TX errors interrupts enabling flag
CEC_IER_TX_ALL_ERR
Initiator logical address position in message header
CEC_INITIATOR_LSB_POS
Error Bit Generation if Long Bit Period Error reported
CEC_LBPE_ERRORBIT_NO_GENERATION
CEC_LBPE_ERRORBIT_GENERATION
IS_CEC_LBPEERRORBITGEN
Listening mode option
CEC_REDUCED_LISTENING_MODE
CEC_FULL_LISTENING_MODE
IS_CEC_LISTENING_MODE
Device Own Address position in CEC CFGR register
CEC_CFGR_OAR_LSB_POS
CEC Private Constants
CEC_CFGR_FIELDS
Signal Free Time start option
CEC_SFT_START_ON_TXSOM
CEC_SFT_START_ON_TX_RX_END
144/692
DocID026525 Rev 1
UM1785

IS_CEC_SFTOP
Signal Free Time setting parameter
CEC_DEFAULT_SFT
CEC_0_5_BITPERIOD_SFT
IS_CEC_SIGNALFREETIME
Receiver Tolerance
CEC_STANDARD_TOLERANCE
CEC_EXTENDED_TOLERANCE
IS_CEC_TOLERANCE
DocID026525 Rev 1
145/692
HAL COMP Generic Driver
UM1785
8.1
COMP Firmware driver registers structures
8.1.1
COMP_InitTypeDef
COMP_InitTypeDef is defined in the stm32f0xx_hal_comp.h
Data Fields
uint32_t InvertingInput
uint32_t NonInvertingInput
uint32_t Output
uint32_t OutputPol
uint32_t Hysteresis
uint32_t Mode
uint32_t WindowMode
uint32_t TriggerMode
Field Documentation
8.1.2
uint32_t COMP_InitTypeDef::InvertingInput Selects the inverting input of the

comparator. This parameter can be a value of COMP_InvertingInput
uint32_t COMP_InitTypeDef::NonInvertingInput Selects the non inverting input of
the comparator. This parameter can be a value of COMP_NonInvertingInput
uint32_t COMP_InitTypeDef::Output Selects the output redirection of the
comparator. This parameter can be a value of COMP_Output
uint32_t COMP_InitTypeDef::OutputPol Selects the output polarity of the
comparator. This parameter can be a value of COMP_OutputPolarity
uint32_t COMP_InitTypeDef::Hysteresis Selects the hysteresis voltage of the
comparator. This parameter can be a value of COMP_Hysteresis
uint32_t COMP_InitTypeDef::Mode Selects the operating comsumption mode of the
comparator to adjust the speed/consumption. This parameter can be a value of
COMP_Mode
uint32_t COMP_InitTypeDef::WindowMode Selects the window mode of the
comparator 1 & 2. This parameter can be a value of COMP_WindowMode
uint32_t COMP_InitTypeDef::TriggerMode Selects the trigger mode of the
comparator (interrupt mode). This parameter can be a value of COMP_TriggerMode
COMP_HandleTypeDef
COMP_HandleTypeDef is defined in the stm32f0xx_hal_comp.h
Data Fields
COMP_TypeDef * Instance
COMP_InitTypeDef Init
__IO HAL_COMP_StateTypeDef State
Field Documentation
146/692
DocID026525 Rev 1
UM1785
8.2
COMP_TypeDef* COMP_HandleTypeDef::Instance Register base address

COMP_InitTypeDef COMP_HandleTypeDef::Init COMP required parameters
HAL_LockTypeDef COMP_HandleTypeDef::Lock Locking object
__IO HAL_COMP_StateTypeDef COMP_HandleTypeDef::State COMP
communication state
COMP Firmware driver API description

The following section lists the various functions of the COMP library.
8.2.1
COMP Peripheral features

The STM32F0xx device family integrates up to 2 analog comparators COMP1 and
COMP2:
1.
2.
3.
4.
5.
The non inverting input and inverting input can be set to GPIO pins as shown in
table1. COMP Inputs below.
The COMP output is available using HAL_COMP_GetOutputLevel() and can be set
on GPIO pins. Refer to table 2. COMP Outputs below.
The COMP output can be redirected to embedded timers (TIM1, TIM2 and TIM3)
Refer to table 3. COMP Outputs redirection to embedded timers below.
The comparators COMP1 and COMP2 can be combined in window mode.
The comparators have interrupt capability with wake-up from Sleep and Stop modes
(through the EXTI controller):
COMP1 is internally connected to EXTI Line 21
COMP2 is internally connected to EXTI Line 22 From the corresponding IRQ

handler, the right interrupt source can be retrieved with the macro
__HAL_COMP_EXTI_GET_FLAG(). Possible values are:
COMP_EXTI_LINE_COMP1_EVENT
Table 16: COMP Inputs for STM32F05xx, STM32F07x and STM32F09x devices
Inverting inputs
1/4 VREFINT
1/2 VREFINT
3/4 VREFINT
VREFINT
DAC1 OUT (PA4)
DAC2 OUT (PA5)
I/O1
Non-inverting inputs
COMP1
COMP2
OK
OK
OK
OK
OK
OK
PA0
OK
OK
OK
OK
OK
OK
PA2
PA1
PA3
Table 17: COMP outputs for STM32F05xx, STM32F07x and STM32F09x devices
COMP1
COMP2
PA0
PA2
PA6
PA7
PA11
PA12
DocID026525 Rev 1
147/692
UM1785
Table 18: Redirection of COMP outputs to embedded timers for STM32F05xx, STM32F07x and
STM32F09x devices
8.2.2
COMP1
COMP2
TIM1 BKIN
TIM1 BKIN
TIM1 OCREFCLR
TIM1 OCREFCLR
TIM1 IC1
TIM1 IC1
TIM2 IC4
TIM2 IC4
TIM2 OCREFCLR
TIM2 OCREFCLR
TIM3 IC1
TIM3 IC3
TIM3 OCREFCLR
TIM3 OCREFCLR

This driver provides functions to configure and program the Comparators of STM32F05x,
STM32F07x and STM32F09x devices. To use the comparator, perform the following steps:
1.
2.
3.
4.
8.2.3
Fill in the HAL_COMP_MspInit() to
Configure the comparator input in analog mode using HAL_GPIO_Init()
Configure the comparator output in alternate function mode using

HAL_GPIO_Init() to map the comparator output to the GPIO pin
If required enable the COMP interrupt by configuring and enabling EXTI line in
Interrupt mode and selecting the desired sensitivity level using HAL_GPIO_Init()
function. After that enable the comparator interrupt vector using
HAL_NVIC_EnableIRQ() function.
Configure the comparator using HAL_COMP_Init() function:
Select the inverting input
Select the non inverting input
Select the output polarity
Select the output redirection
Select the hysteresis level
Select the power mode
Select the event/interrupt mode

Enable the comparator using HAL_COMP_Start() function or HAL_COMP_Start_IT()
function for interrupt mode
Read the comparator output level with HAL_COMP_GetOutputLevel()

This section provides functions to initialize and de-initialize comparators
8.2.4
HAL_COMP_Init()
HAL_COMP_DeInit()
HAL_COMP_MspInit()
HAL_COMP_MspDeInit()
This subsection provides a set of functions allowing to manage the COMP data transfers.
148/692
DocID026525 Rev 1
UM1785
8.2.5
HAL_COMP_Start()
HAL_COMP_Stop()
HAL_COMP_Start_IT()
HAL_COMP_Stop_IT()
HAL_COMP_IRQHandler()

This subsection provides a set of functions allowing to control the COMP data transfers.
8.2.6
HAL_COMP_Lock()
HAL_COMP_GetOutputLevel()
HAL_COMP_TriggerCallback()
Peripheral State functions

This subsection permit to get in run-time the status of the peripheral and the data flow.
8.2.7
8.2.8
HAL_COMP_GetState()
HAL_COMP_Init
Function Name
HAL_StatusTypeDef HAL_COMP_Init ( COMP_HandleTypeDef

* hcomp)
Initializes the COMP according to the specified parameters in the

COMP_InitTypeDef and create the associated handle.
Parameters
hcomp : COMP handle
Return values
HAL status
Notes
If the selected comparator is locked, initialization can't be

performed. To unlock the configuration, perform a system
reset.
HAL_COMP_DeInit
Function Name
HAL_StatusTypeDef HAL_COMP_DeInit (
COMP_HandleTypeDef * hcomp)
DeInitializes the COMP peripheral.
Parameters
hcomp : COMP handle
Return values
HAL status
DocID026525 Rev 1
149/692

Notes
8.2.9
8.2.10
8.2.11
150/692
UM1785
Deinitialization can't be performed if the COMP configuration

is locked. To unlock the configuration, perform a system
reset.
HAL_COMP_MspInit
Function Name
void HAL_COMP_MspInit ( COMP_HandleTypeDef * hcomp)
Initializes the COMP MSP.
Parameters
hcomp : COMP handle
Return values
None.
Notes
None.
HAL_COMP_MspDeInit
Function Name
void HAL_COMP_MspDeInit ( COMP_HandleTypeDef *

hcomp)
DeInitializes COMP MSP.
Parameters
hcomp : COMP handle
Return values
None.
Notes
None.
HAL_COMP_Start
Function Name
HAL_StatusTypeDef HAL_COMP_Start (
Start the comparator.
Parameters
hcomp : COMP handle
DocID026525 Rev 1
UM1785
8.2.12
8.2.13
8.2.14

Return values
HAL status
Notes
None.
HAL_COMP_Stop
Function Name
HAL_StatusTypeDef HAL_COMP_Stop (
Stop the comparator.
Parameters
hcomp : COMP handle
Return values
HAL status
Notes
None.
HAL_COMP_Start_IT
Function Name
HAL_StatusTypeDef HAL_COMP_Start_IT (
Enables the interrupt and starts the comparator.
Parameters
hcomp : COMP handle
Return values
HAL status.
Notes
None.
HAL_COMP_Stop_IT
Function Name
HAL_StatusTypeDef HAL_COMP_Stop_IT (
Disable the interrupt and Stop the comparator.
Parameters
hcomp : COMP handle
DocID026525 Rev 1
151/692

Return values
Notes
8.2.15
8.2.16
8.2.17
152/692
UM1785
HAL status
None.
HAL_COMP_IRQHandler
Function Name
void HAL_COMP_IRQHandler ( COMP_HandleTypeDef *

hcomp)
Comparator IRQ Handler.
Parameters
hcomp : COMP handle
Return values
HAL status
Notes
None.
HAL_COMP_Lock
Function Name
HAL_StatusTypeDef HAL_COMP_Lock (
Lock the selected comparator configuration.
Parameters
hcomp : COMP handle
Return values
HAL status
Notes
None.
HAL_COMP_GetOutputLevel
Function Name
uint32_t HAL_COMP_GetOutputLevel ( COMP_HandleTypeDef

* hcomp)
Return the output level (high or low) of the selected comparator.
Notes
None.
DocID026525 Rev 1
UM1785
8.2.18
8.2.19
HAL_COMP_TriggerCallback
Function Name
void HAL_COMP_TriggerCallback ( COMP_HandleTypeDef *

hcomp)
Comparator callback.
Parameters
hcomp : COMP handle
Return values
None.
Notes
None.
HAL_COMP_GetState
Function Name
HAL_COMP_StateTypeDef HAL_COMP_GetState (
Return the COMP state.
Parameters
hcomp : : COMP handle
Return values
HAL state
Notes
None.
8.3
COMP Firmware driver defines
8.3.1
COMP
COMP
COMP Exported Macros
__HAL_COMP_RESET_HANDLE_STATE
Description:
Reset COMP handle state.
Parameters:
DocID026525 Rev 1
__HANDLE__: COMP handle.
153/692
UM1785
Return value:
__HAL_COMP_EXTI_GET_FLAG
None:
Description:
Checks whether the specified EXTI

line flag is set or not.
Parameters:
__FLAG__: specifies the COMP Exti

sources to be checked. This
parameter can be a value of
Return value:
__HAL_COMP_EXTI_CLEAR_FLAG
The: state of __FLAG__ (SET or

RESET).
Description:
Clear the COMP Exti flags.
Parameters:
__FLAG__: specifies the COMP Exti

sources to be cleared. This
Return value:
__HAL_COMP_EXTI_ENABLE_IT
None.:
Description:
Enable the COMP Exti Line.
Parameters:
__EXTILINE__: specifies the COMP

Exti sources to be enabled. This
Return value:
__HAL_COMP_EXTI_DISABLE_IT
None.:
Description:
Disable the COMP Exti Line.
Parameters:

Exti sources to be disabled. This
Return value:
__HAL_COMP_EXTI_RISING_IT_ENABLE
None.:
Description:
Enable the Exti Line rising edge

trigger.
Parameters:
154/692
DocID026525 Rev 1
UM1785

Return value:
__HAL_COMP_EXTI_RISING_IT_DISABLE
None.:
Description:
Disable the Exti Line rising edge

trigger.
Parameters:

Return value:
__HAL_COMP_EXTI_FALLING_IT_ENABLE
None.:
Description:
Enable the Exti Line falling edge

trigger.
Parameters:

Return value:
__HAL_COMP_EXTI_FALLING_IT_DISABLE
None.:
Description:
Disable the Exti Line falling edge

trigger.
Parameters:

Return value:
__HAL_COMP_GET_EXTI_LINE
None.:
Description:
Get the specified EXTI line for a

comparator instance.
Parameters:
__INSTANCE__: specifies the COMP

instance.
Return value:
value: of
COMP ExtiLineEvent
DocID026525 Rev 1
155/692

UM1785
External interrupt line 21 Connected to COMP1
External interrupt line 22 Connected to COMP2
COMP Hysteresis
COMP_HYSTERESIS_NONE
No hysteresis
COMP_HYSTERESIS_LOW
Hysteresis level low
COMP_HYSTERESIS_MEDIUM
Hysteresis level medium
COMP_HYSTERESIS_HIGH
Hysteresis level high
IS_COMP_HYSTERESIS
COMP InvertingInput
COMP_INVERTINGINPUT_1_4VREFINT
1/4 VREFINT connected to

comparator inverting input


COMP_INVERTINGINPUT_VREFINT
VREFINT connected to comparator

inverting input
COMP_INVERTINGINPUT_DAC1
DAC_OUT1 (PA4) connected to

COMP_INVERTINGINPUT_DAC1SWITCHCLOSED

comparator inverting input and
close switch (PA0 for COMP1 only)
COMP_INVERTINGINPUT_DAC2

COMP_INVERTINGINPUT_IO1
IO (PA0 for COMP1 and PA2 for

COMP2) connected to comparator
inverting input
IS_COMP_INVERTINGINPUT
COMP Lock
COMP_LOCK_DISABLE
COMP_LOCK_ENABLE
COMP_STATE_BIT_LOCK
COMP Mode
COMP_MODE_HIGHSPEED
High Speed
COMP_MODE_MEDIUMSPEED
Medium Speed
COMP_MODE_LOWPOWER
Low power mode
COMP_MODE_ULTRALOWPOWER
Ultra-low power mode
IS_COMP_MODE
COMP NonInvertingInput
COMP_NONINVERTINGINPUT_IO1
156/692
DocID026525 Rev 1
I/O1 (PA1 for COMP1, PA3 for
UM1785

COMP2) connected to
comparator non inverting input
COMP_NONINVERTINGINPUT_DAC1SWITCHCLOSED
DAC ouput connected to

comparator COMP1 non
inverting input
IS_COMP_NONINVERTINGINPUT
COMP Output
COMP_OUTPUT_NONE
COMP output isn't connected to other peripherals
COMP_OUTPUT_TIM1BKIN
COMP output connected to TIM1 Break Input (BKIN)
COMP_OUTPUT_TIM1IC1
COMP output connected to TIM1 Input Capture 1
COMP_OUTPUT_TIM1OCREFCLR
COMP output connected to TIM1 OCREF Clear
COMP_OUTPUT_TIM2IC4
COMP_OUTPUT_TIM3IC1
IS_COMP_OUTPUT
COMP OutputLevel
COMP_OUTPUTLEVEL_LOW
COMP_OUTPUTLEVEL_HIGH
COMP OutputPolarity
COMP_OUTPUTPOL_NONINVERTED
COMP output on GPIO isn't inverted
COMP_OUTPUTPOL_INVERTED
COMP output on GPIO is inverted
IS_COMP_OUTPUTPOL
COMP Private Constants
COMP_CSR_RESET_VALUE
COMP_CSR_RESET_PARAMETERS_MASK
COMP_CSR_UPDATE_PARAMETERS_MASK
COMP_CSR_COMPxNONINSEL_MASK
COMP_CSR_COMP1_SHIFT
COMP_CSR_COMP2_SHIFT
COMP TriggerMode
COMP_TRIGGERMODE_NONE
No External Interrupt trigger detection
COMP_TRIGGERMODE_IT_RISING
External Interrupt Mode with Rising

edge trigger detection
COMP_TRIGGERMODE_IT_FALLING
External Interrupt Mode with Falling

COMP_TRIGGERMODE_IT_RISING_FALLING
External Interrupt Mode with

Rising/Falling edge trigger detection
DocID026525 Rev 1
157/692

IS_COMP_TRIGGERMODE
UM1785
COMP WindowMode
COMP_WINDOWMODE_DISABLED
Window mode disabled
COMP_WINDOWMODE_ENABLED
Window mode enabled: non inverting input of

comparator 2 is connected to the non inverting
input of comparator 1 (PA1)
IS_COMP_WINDOWMODE
158/692
DocID026525 Rev 1
UM1785
HAL CORTEX Generic Driver
9.1
CORTEX Firmware driver API description

The following section lists the various functions of the CORTEX library.
9.1.1
How to configure Interrupts using CORTEX HAL driver

This section provides functions allowing to configure the NVIC interrupts (IRQ). The
Cortex-M0 exceptions are managed by CMSIS functions.
1.
2.
3.
Enable and Configure the priority of the selected IRQ Channels. The priority can be
0..3. Lower priority values gives higher priority. Priority Order: Lowest priority.
Lowest hardware priority (IRQn position).
Configure the priority of the selected IRQ Channels using HAL_NVIC_SetPriority()
Enable the selected IRQ Channels using HAL_NVIC_EnableIRQ()
How to configure Systick using CORTEX HAL driver

Setup SysTick Timer for time base
9.1.2
The HAL_SYSTICK_Config()function calls the SysTick_Config() function which is a

CMSIS function that:
Configures the SysTick Reload register with value passed as function parameter.
Configures the SysTick IRQ priority to the lowest value (0x03).
Resets the SysTick Counter register.
Configures the SysTick Counter clock source to be Core Clock Source (HCLK).
Enables the SysTick Interrupt.
Starts the SysTick Counter.

You can change the SysTick Clock source to be HCLK_Div8 by calling the macro
__HAL_CORTEX_SYSTICKCLK_CONFIG(SYSTICK_CLKSOURCE_HCLK_DIV8)
just after the HAL_SYSTICK_Config() function call. The
__HAL_CORTEX_SYSTICKCLK_CONFIG() macro is defined inside the
stm32f0xx_hal_cortex.h file.
You can change the SysTick IRQ priority by calling the
HAL_NVIC_SetPriority(SysTick_IRQn,...) function just after the
HAL_SYSTICK_Config() function call. The HAL_NVIC_SetPriority() call the
NVIC_SetPriority() function which is a CMSIS function.
To adjust the SysTick time base, use the following formula: Reload Value = SysTick
Counter Clock (Hz) x Desired Time base (s)
Reload Value is the parameter to be passed for HAL_SYSTICK_Config()

function
Reload Value should not exceed 0xFFFFFF
DocID026525 Rev 1
159/692

UM1785
This section provides the CORTEX HAL driver functions allowing to configure Interrupts
Systick functionalities
9.1.3
HAL_NVIC_SetPriority()
HAL_NVIC_EnableIRQ()
HAL_NVIC_DisableIRQ()
HAL_NVIC_SystemReset()
HAL_SYSTICK_Config()

This subsection provides a set of functions allowing to control the CORTEX (NVIC,
SYSTICK) functionalities.
9.1.4
HAL_NVIC_GetPriority()
HAL_NVIC_SetPendingIRQ()
HAL_NVIC_GetPendingIRQ()
HAL_NVIC_ClearPendingIRQ()
HAL_SYSTICK_CLKSourceConfig()
HAL_SYSTICK_IRQHandler()
HAL_SYSTICK_Callback()
HAL_NVIC_SetPriority
Function Name
void HAL_NVIC_SetPriority ( IRQn_Type IRQn, uint32_t

PreemptPriority, uint32_t SubPriority)
Sets the priority of an interrupt.
Parameters
9.1.5
160/692
IRQn : External interrupt number . This parameter can be an

enumerator of IRQn_Type enumeration (For the complete
STM32 Devices IRQ Channels list, please refer to
stm32l0xx.h file)
PreemptPriority : The pre-emption priority for the IRQn
channel. This parameter can be a value between 0 and 3. A
lower priority value indicates a higher priority
SubPriority : The subpriority level for the IRQ channel. with
stm32f0xx devices, this parameter is a dummy value and it is
ignored, because no subpriority supported in Cortex M0
based products.
Return values
None.
Notes
None.
HAL_NVIC_EnableIRQ
DocID026525 Rev 1
UM1785
9.1.6
9.1.7
Function Name

void HAL_NVIC_EnableIRQ ( IRQn_Type IRQn)
Enables a device specific interrupt in the NVIC interrupt controller.
Parameters
IRQn : External interrupt number This parameter can be an

STM32 Devices IRQ Channels list, please refer to the
appropriate CMSIS device file (stm32f0xxxx.h))
Return values
None.
Notes
To configure interrupts priority correctly, the

NVIC_PriorityGroupConfig() function should be called before.
HAL_NVIC_DisableIRQ
Function Name
void HAL_NVIC_DisableIRQ ( IRQn_Type IRQn)
Disables a device specific interrupt in the NVIC interrupt

controller.
Parameters

Return values
None.
Notes
None.
HAL_NVIC_SystemReset
Function Name
void HAL_NVIC_SystemReset ( void )
Initiates a system reset request to reset the MCU.
Return values
None.
Notes
None.
DocID026525 Rev 1
161/692
9.1.8
9.1.9
9.1.10
162/692
UM1785
HAL_SYSTICK_Config
Function Name
uint32_t HAL_SYSTICK_Config ( uint32_t TicksNumb)
Initializes the System Timer and its interrupt, and starts the
System Tick Timer.
Parameters
TicksNumb : Specifies the ticks Number of ticks between

two interrupts.
Return values
status : - 0 Function succeeded.
1 Function failed.
Notes
None.
HAL_NVIC_GetPriority
Function Name
uint32_t HAL_NVIC_GetPriority ( IRQn_Type IRQn)
Gets the priority of an interrupt.
Parameters

Return values
None.
Notes
None.
HAL_NVIC_SetPendingIRQ
Function Name
void HAL_NVIC_SetPendingIRQ ( IRQn_Type IRQn)
Sets Pending bit of an external interrupt.
Parameters

Return values
None.
DocID026525 Rev 1
UM1785

Notes
9.1.11
9.1.12
9.1.13
None.
HAL_NVIC_GetPendingIRQ
Function Name
uint32_t HAL_NVIC_GetPendingIRQ ( IRQn_Type IRQn)
Gets Pending Interrupt (reads the pending register in the NVIC

and returns the pending bit for the specified interrupt).
Parameters

Return values
status : - 0 Interrupt status is not pending.
1 Interrupt status is pending.
Notes
None.
HAL_NVIC_ClearPendingIRQ
Function Name
void HAL_NVIC_ClearPendingIRQ ( IRQn_Type IRQn)
Clears the pending bit of an external interrupt.
Parameters

Return values
None.
Notes
None.
HAL_SYSTICK_CLKSourceConfig
Function Name
void HAL_SYSTICK_CLKSourceConfig ( uint32_t CLKSource)

DocID026525 Rev 1
163/692

9.1.14
9.1.15
UM1785
Configures the SysTick clock source.
Parameters
CLKSource : specifies the SysTick clock source. This

parameter can be one of the following values:
SYSTICK_CLKSOURCE_HCLK_DIV8 AHB clock

divided by 8 selected as SysTick clock source.
SYSTICK_CLKSOURCE_HCLK AHB clock selected as

SysTick clock source.
Return values
None.
Notes
None.
HAL_SYSTICK_IRQHandler
Function Name
void HAL_SYSTICK_IRQHandler ( void )
This function handles SYSTICK interrupt request.
Return values
None.
Notes
None.
HAL_SYSTICK_Callback
Function Name
void HAL_SYSTICK_Callback ( void )
SYSTICK callback.
Return values
None.
Notes
None.
9.2
CORTEX Firmware driver defines
9.2.1
CORTEX
CORTEX
CORTEX Exported Macro
164/692
DocID026525 Rev 1
UM1785

__HAL_CORTEX_SYSTICKCLK_CON
FIG
Description:
Configures the SysTick clock source.
Parameters:
__CLKSRC__: specifies the SysTick clock

source. This parameter can be one of the
following values:
SYSTICK_CLKSOURCE_HCLK_DIV8:
AHB clock divided by 8 selected as
SysTick clock source.
SYSTICK_CLKSOURCE_HCLK: AHB
clock selected as SysTick clock source.
Return value:
None:
CORTEX Priority
IS_NVIC_PREEMPTION_PRIORITY
CORTEX SysTick clock source
SYSTICK_CLKSOURCE_HCLK_DIV8
SYSTICK_CLKSOURCE_HCLK
IS_SYSTICK_CLK_SOURCE
DocID026525 Rev 1
165/692
HAL CRC Generic Driver
UM1785
10
10.1
CRC Firmware driver registers structures
10.1.1
CRC_InitTypeDef
CRC_InitTypeDef is defined in the stm32f0xx_hal_crc.h
Data Fields
uint8_t DefaultPolynomialUse
uint8_t DefaultInitValueUse
uint32_t GeneratingPolynomial
uint32_t CRCLength
uint32_t InitValue
uint32_t InputDataInversionMode
uint32_t OutputDataInversionMode
Field Documentation
166/692
uint8_t CRC_InitTypeDef::DefaultPolynomialUse This parameter is a value of

CRC_Default_Polynomial and indicates if default polynomial is used. If set to
DEFAULT_POLYNOMIAL_ENABLE, resort to default X^32 + X^26 + X^23 + X^22 +
X^16 + X^12 + X^11 + X^10 +X^8 + X^7 + X^5 + X^4 + X^2+ X +1. In that case, there
is no need to set GeneratingPolynomial field. If otherwise set to
DEFAULT_POLYNOMIAL_DISABLE, GeneratingPolynomial and CRCLength fields
must be set
uint8_t CRC_InitTypeDef::DefaultInitValueUse This parameter is a value of
CRC_Default_InitValue_Use and indicates if default init value is used. If set to
DEFAULT_INIT_VALUE_ENABLE, resort to default 0xFFFFFFFF value. In that case,
there is no need to set InitValue field. If otherwise set to
DEFAULT_INIT_VALUE_DISABLE, InitValue field must be set
uint32_t CRC_InitTypeDef::GeneratingPolynomial Set CRC generating polynomial.
7, 8, 16 or 32-bit long value for a polynomial degree respectively equal to 7, 8, 16 or
32. This field is written in normal representation, e.g., for a polynomial of degree 7,
X^7 + X^6 + X^5 + X^2 + 1 is written 0x65. No need to specify it if
DefaultPolynomialUse is set to DEFAULT_POLYNOMIAL_ENABLE
uint32_t CRC_InitTypeDef::CRCLength This parameter is a value of
CRCEx_Polynomial_Size_Definitions and indicates CRC length. Value can be
either one of CRC_POLYLENGTH_32B (32-bit CRC) CRC_POLYLENGTH_16B (16bit CRC) CRC_POLYLENGTH_8B (8-bit CRC) CRC_POLYLENGTH_7B (7-bit CRC)
uint32_t CRC_InitTypeDef::InitValue Init value to initiate CRC computation. No need
to specify it if DefaultInitValueUse is set to DEFAULT_INIT_VALUE_ENABLE
uint32_t CRC_InitTypeDef::InputDataInversionMode This parameter is a value of
CRCEx_Input_Data_Inversion and specifies input data inversion mode. Can be
either one of the following values CRC_INPUTDATA_INVERSION_NONE no input
data inversion CRC_INPUTDATA_INVERSION_BYTE byte-wise inversion,
0x1A2B3C4D becomes 0x58D43CB2 CRC_INPUTDATA_INVERSION_HALFWORD
halfword-wise inversion, 0x1A2B3C4D becomes 0xD458B23C
CRC_INPUTDATA_INVERSION_WORD word-wise inversion, 0x1A2B3C4D becomes
0xB23CD458
DocID026525 Rev 1
UM1785
10.1.2
uint32_t CRC_InitTypeDef::OutputDataInversionMode This parameter is a value of

CRCEx_Output_Data_Inversion and specifies output data (i.e. CRC) inversion
mode. Can be either CRC_OUTPUTDATA_INVERSION_DISABLED no CRC
inversion, or CRC_OUTPUTDATA_INVERSION_ENABLED CRC 0x11223344 is
converted into 0x22CC4488
CRC_HandleTypeDef
CRC_HandleTypeDef is defined in the stm32f0xx_hal_crc.h
Data Fields
CRC_TypeDef * Instance
CRC_InitTypeDef Init
__IO HAL_CRC_StateTypeDef State
uint32_t InputDataFormat
Field Documentation
10.2
CRC_TypeDef* CRC_HandleTypeDef::Instance Register base address

CRC_InitTypeDef CRC_HandleTypeDef::Init CRC configuration parameters
HAL_LockTypeDef CRC_HandleTypeDef::Lock CRC Locking object
__IO HAL_CRC_StateTypeDef CRC_HandleTypeDef::State CRC communication
state
uint32_t CRC_HandleTypeDef::InputDataFormat This parameter is a value of
CRC_Input_Buffer_Format and specifies input data format. Can be either
CRC_INPUTDATA_FORMAT_BYTES input data is a stream of bytes (8-bit data)
CRC_INPUTDATA_FORMAT_HALFWORDS input data is a stream of half-words (16bit data) CRC_INPUTDATA_FORMAT_WORDS input data is a stream of words (32bits data) Note that constant CRC_INPUT_FORMAT_UNDEFINED is defined but an
initialization error must occur if InputBufferFormat is not one of the three values listed
above
CRC Firmware driver API description

The following section lists the various functions of the CRC library.
10.2.1
1.
2.
3.
Enable CRC AHB clock using __CRC_CLK_ENABLE();

Initialize CRC calculator
specify generating polynomial (IP default or non-default one)
specify initialization value (IP default or non-default one)
specify input data format
specify input or output data inversion mode if any

Use HAL_CRC_Accumulate() function to compute the CRC value of the input data
buffer starting with the previously computed CRC as initialization value
DocID026525 Rev 1
167/692

UM1785
4.
Use HAL_CRC_Calculate() function to compute the CRC value of the input data
buffer starting with the defined initialization value (default or non-default) to initiate
CRC calculation
10.2.2

10.2.3
Initialize the CRC according to the specified parameters in the CRC_InitTypeDef and
create the associated handle
DeInitialize the CRC peripheral
Initialize the CRC MSP
DeInitialize CRC MSP
HAL_CRC_Init()
HAL_CRC_DeInit()
HAL_CRC_MspInit()
HAL_CRC_MspDeInit()

10.2.4
Compute the 7, 8, 16 or 32-bit CRC value of an 8, 16 or 32-bit data buffer using

combination of the previous CRC value and the new one. or
Compute the 7, 8, 16 or 32-bit CRC value of an 8, 16 or 32-bit data buffer
independently of the previous CRC value.
HAL_CRC_Accumulate()
HAL_CRC_Calculate()

This subsection permits to get in run-time the status of the peripheral and the data flow.
10.2.5
168/692
HAL_CRC_GetState()
HAL_CRC_Init
Function Name
HAL_StatusTypeDef HAL_CRC_Init ( CRC_HandleTypeDef *

hcrc)
Initializes the CRC according to the specified parameters in the

CRC_InitTypeDef and creates the associated handle.
Parameters
hcrc : CRC handle
Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
10.2.6
10.2.7
10.2.8
HAL_CRC_DeInit
Function Name
HAL_StatusTypeDef HAL_CRC_DeInit ( CRC_HandleTypeDef *

hcrc)
DeInitializes the CRC peripheral.
Parameters
hcrc : CRC handle
Return values
HAL status
Notes
None.
HAL_CRC_MspInit
Function Name
void HAL_CRC_MspInit ( CRC_HandleTypeDef * hcrc)
Initializes the CRC MSP.
Parameters
hcrc : CRC handle
Return values
None.
Notes
None.
HAL_CRC_MspDeInit
Function Name
void HAL_CRC_MspDeInit ( CRC_HandleTypeDef * hcrc)
DeInitializes the CRC MSP.
Parameters
hcrc : CRC handle
Return values
None.
Notes
None.
DocID026525 Rev 1
169/692
10.2.9
UM1785
HAL_CRC_Accumulate
Function Name
uint32_t HAL_CRC_Accumulate ( CRC_HandleTypeDef * hcrc,

uint32_t pBuffer, uint32_t BufferLength)
Compute the 7, 8, 16 or 32-bit CRC value of an 8, 16 or 32-bit

data buffer starting with the previously computed CRC as
initialization value.
Parameters
10.2.10
Return values
uint32_t CRC (returned value LSBs for CRC shorter than

32 bits)
Notes
None.
HAL_CRC_Calculate
Function Name
uint32_t HAL_CRC_Calculate ( CRC_HandleTypeDef * hcrc,

uint32_t pBuffer, uint32_t BufferLength)
Compute the 7, 8, 16 or 32-bit CRC value of an 8, 16 or 32-bit

data buffer starting with hcrc->Instance->INIT as initialization
value.
Parameters
10.2.11
hcrc : CRC handle

pBuffer : pointer to the input data buffer, exact input data
format is provided by hcrc->InputDataFormat.
BufferLength : input data buffer length
Return values
uint32_t CRC (returned value LSBs for CRC shorter than

32 bits)
Notes
None.
HAL_CRC_GetState
Function Name
170/692
hcrc : CRC handle

pBuffer : pointer to the input data buffer, exact input data
format is provided by hcrc->InputDataFormat.
BufferLength : input data buffer length
HAL_CRC_StateTypeDef HAL_CRC_GetState (
DocID026525 Rev 1
UM1785

CRC_HandleTypeDef * hcrc)
Returns the CRC state.
Parameters
hcrc : CRC handle
Return values
HAL state
Notes
None.
10.3
CRC Firmware driver defines
10.3.1
CRC
CRC
Aliases for inter STM32 series compatibility
HAL_CRC_Input_Data_Reverse
HAL_CRC_Output_Data_Reverse
Default CRC computation initialization value
DEFAULT_CRC_INITVALUE
Indicates whether or not default init value is used
DEFAULT_INIT_VALUE_ENABLE
DEFAULT_INIT_VALUE_DISABLE
IS_DEFAULT_INIT_VALUE
Indicates whether or not default polynomial is used
DEFAULT_POLYNOMIAL_ENABLE
DEFAULT_POLYNOMIAL_DISABLE
IS_DEFAULT_POLYNOMIAL
Default CRC generating polynomial
DEFAULT_CRC32_POLY
CRC Exported Macros
__HAL_CRC_RESET_HANDLE_STATE
Description:
Reset CRC handle state.
Parameters:
__HANDLE__: CRC handle.
Return value:
__HAL_CRC_DR_RESET
None:
Description:
DocID026525 Rev 1
Reset CRC Data Register.
171/692
UM1785
Parameters:
__HANDLE__: CRC handle
Return value:
__HAL_CRC_INITIALCRCVALUE_CONFIG
None.:
Description:
Set CRC INIT non-default value.
Parameters:
__HANDLE__: : CRC handle

__INIT__: : 32-bit initial value
Return value:
Input Buffer Format

CRC_INPUTDATA_FORMAT_UNDEFINED
CRC_INPUTDATA_FORMAT_BYTES
CRC_INPUTDATA_FORMAT_HALFWORDS
CRC_INPUTDATA_FORMAT_WORDS
IS_CRC_INPUTDATA_FORMAT
172/692
DocID026525 Rev 1
None.:
UM1785
HAL CRC Extension Driver
11
11.1
CRCEx Firmware driver API description

The following section lists the various functions of the CRCEx library.
11.1.1
Product specific features
11.1.2
11.1.3
Extended initialization
Set or not user-defined generating polynomial other than default one

11.1.4
11.1.5
Initialize the CRC generating polynomial: if programmable polynomial feature is

applicable to device, set default or non-default generating polynomial according to
hcrc->Init.DefaultPolynomialUse parameter. If feature is non-applicable to device in
use, HAL_CRCEx_Init straight away reports HAL_OK.
Set the generating polynomial
HAL_CRCEx_Init()
HAL_CRCEx_Input_Data_Reverse()
HAL_CRCEx_Output_Data_Reverse()
HAL_CRCEx_Polynomial_Set()
HAL_CRCEx_Init
Function Name
HAL_StatusTypeDef HAL_CRCEx_Init ( CRC_HandleTypeDef *

hcrc)
Extended initialization to set generating polynomial.
Parameters
hcrc : CRC handle
Return values
HAL status
Notes
None.
HAL_CRCEx_Input_Data_Reverse
DocID026525 Rev 1
173/692
11.1.6
11.1.7
174/692
UM1785
Function Name
HAL_StatusTypeDef HAL_CRCEx_Input_Data_Reverse (
CRC_HandleTypeDef * hcrc, uint32_t InputReverseMode)
Set the Reverse Input data mode.
Parameters
hcrc : CRC handle

InputReverseMode : Input Data inversion mode This
CRC_INPUTDATA_NOINVERSION no change in bit

order (default value)
CRC_INPUTDATA_INVERSION_BYTE Byte-wise bit

reversal
CRC_INPUTDATA_INVERSION_HALFWORD
HalfWord-wise bit reversal
CRC_INPUTDATA_INVERSION_WORD Word-wise bit

reversal
Return values
HAL status
Notes
None.
HAL_CRCEx_Output_Data_Reverse
Function Name
HAL_StatusTypeDef HAL_CRCEx_Output_Data_Reverse (
CRC_HandleTypeDef * hcrc, uint32_t OutputReverseMode)
Set the Reverse Output data mode.
Parameters
hcrc : CRC handle

OutputReverseMode : Output Data inversion mode This
CRC_OUTPUTDATA_INVERSION_DISABLED no CRC
inversion (default value)
CRC_OUTPUTDATA_INVERSION_ENABLED bit-level
inversion (e.g for a 8-bit CRC: 0xB5 becomes 0xAD)
Return values
HAL status
Notes
None.
HAL_CRCEx_Polynomial_Set
DocID026525 Rev 1
UM1785
Function Name

HAL_StatusTypeDef HAL_CRCEx_Polynomial_Set (
CRC_HandleTypeDef * hcrc, uint32_t Pol, uint32_t
PolyLength)
Initializes the CRC polynomial if different from default one.
Parameters
hcrc : CRC handle

Pol : CRC generating polynomial (7, 8, 16 or 32-bit long)
This parameter is written in normal representation, e.g. for a
polynomial of degree 7, X^7 + X^6 + X^5 + X^2 + 1 is written
0x65 for a polynomial of degree 16, X^16 + X^12 + X^5 + 1 is
written 0x1021
PolyLength : CRC polynomial length This parameter can be
one of the following values:
CRC_POLYLENGTH_7B 7-bit long CRC (generating

polynomial of degree 7)



Return values
HAL status
Notes
None.
11.2
CRCEx Firmware driver defines
11.2.1
CRCEx
CRCEx
CRCEx Exported Macros
__HAL_CRC_OUTPUTREVERSAL_ENABLE
Description:
Set CRC output reversal.
Parameters:
Return value:
__HAL_CRC_OUTPUTREVERSAL_DISABLE
None.:
Description:
Unset CRC output reversal.
Parameters:
Return value:
DocID026525 Rev 1
None.:
175/692

__HAL_CRC_POLYNOMIAL_CONFIG
UM1785
Description:
Set CRC non-default polynomial.
Parameters:

__POLYNOMIAL__: 7, 8, 16 or 32-bit
polynomial
Return value:
Input Data Inversion Modes

CRC_INPUTDATA_INVERSION_NONE
CRC_INPUTDATA_INVERSION_BYTE
CRC_INPUTDATA_INVERSION_HALFWORD
CRC_INPUTDATA_INVERSION_WORD
IS_CRC_INPUTDATA_INVERSION_MODE
Output Data Inversion Modes
CRC_OUTPUTDATA_INVERSION_DISABLED
CRC_OUTPUTDATA_INVERSION_ENABLED
IS_CRC_OUTPUTDATA_INVERSION_MODE
Polynomial sizes to configure the IP
CRC_POLYLENGTH_32B
CRC_POLYLENGTH_16B
CRC_POLYLENGTH_8B
CRC_POLYLENGTH_7B
IS_CRC_POL_LENGTH
CRC polynomial possible sizes actual definitions
HAL_CRC_LENGTH_32B
HAL_CRC_LENGTH_16B
HAL_CRC_LENGTH_8B
HAL_CRC_LENGTH_7B
176/692
DocID026525 Rev 1
None.:
UM1785
HAL DAC Generic Driver
12
12.1
DAC Firmware driver registers structures
12.1.1
DAC_HandleTypeDef
DAC_HandleTypeDef is defined in the stm32f0xx_hal_dac.h
Data Fields
DAC_TypeDef * Instance
__IO HAL_DAC_StateTypeDef State
DMA_HandleTypeDef * DMA_Handle1
DMA_HandleTypeDef * DMA_Handle2
Field Documentation
12.1.2
DAC_TypeDef* DAC_HandleTypeDef::Instance Register base address

__IO HAL_DAC_StateTypeDef DAC_HandleTypeDef::State DAC communication
state
HAL_LockTypeDef DAC_HandleTypeDef::Lock DAC locking object
DMA_HandleTypeDef* DAC_HandleTypeDef::DMA_Handle1 Pointer DMA handler
for channel 1
DMA_HandleTypeDef* DAC_HandleTypeDef::DMA_Handle2 Pointer DMA handler
for channel 2
__IO uint32_t DAC_HandleTypeDef::ErrorCode DAC Error code
DAC_ChannelConfTypeDef
DAC_ChannelConfTypeDef is defined in the stm32f0xx_hal_dac.h
Data Fields
uint32_t DAC_Trigger
uint32_t DAC_OutputBuffer
Field Documentation
12.2
uint32_t DAC_ChannelConfTypeDef::DAC_Trigger Specifies the external trigger for

the selected DAC channel. This parameter can be a value of DAC_trigger_selection
uint32_t DAC_ChannelConfTypeDef::DAC_OutputBuffer Specifies whether the
DAC channel output buffer is enabled or disabled. This parameter can be a value of
DAC_output_buffer
DAC Firmware driver API description

The following section lists the various functions of the DAC library.
DocID026525 Rev 1
177/692
12.2.1
UM1785
DAC Peripheral features
DAC Channels
STM32F0 devices integrates no, one or two 12-bit Digital Analog Converters. STM32F05x
devices have one converter (channel1) STM32F07x & STM32F09x devices have two
converters (i.e. channel1 & channel2) When 2 converters are present (i.e. channel1 &
channel2) they can be used independently or simultaneously (dual mode):
1.
2.
DAC channel1 with DAC_OUT1 (PA4) as output

DAC channel2 with DAC_OUT2 (PA5) as output
DAC Triggers
Digital to Analog conversion can be non-triggered using DAC_Trigger_None and
DAC_OUT1/DAC_OUT2 is available once writing to DHRx register.
Digital to Analog conversion can be triggered by:
1.
2.
3.
External event: EXTI Line 9 (any GPIOx_Pin9) using DAC_Trigger_Ext_IT9. The

used pin (GPIOx_Pin9) must be configured in input mode.
Timers TRGO: TIM2, TIM3, TIM6, and TIM15 (DAC_Trigger_T2_TRGO,
DAC_Trigger_T3_TRGO...)
Software using DAC_Trigger_Software
DAC Buffer mode feature

Each DAC channel integrates an output buffer that can be used to reduce the output
impedance, and to drive external loads directly without having to add an external
operational amplifier. To enable, the output buffer use sConfig.DAC_OutputBuffer =
DAC_OutputBuffer_Enable;
Refer to the device datasheet for more details about output impedance value with
and without output buffer.
DAC wave generation feature

Both DAC channels can be used to generate
1.
2.
Noise wave
Triangle wave
DAC data format

The DAC data format can be:
1.
2.
3.
8-bit right alignment using DAC_ALIGN_8B_R

12-bit left alignment using DAC_ALIGN_12B_L
12-bit right alignment using DAC_ALIGN_12B_R
DAC data value to voltage correspondence

The analog output voltage on each DAC channel pin is determined by the following
equation: DAC_OUTx = VREF+ * DOR / 4095 with DOR is the Data Output Register VEF+
178/692
DocID026525 Rev 1
UM1785

is the input voltage reference (refer to the device datasheet) e.g. To set DAC_OUT1 to
0.7V, use Assuming that VREF+ = 3.3V, DAC_OUT1 = (3.3 * 868) / 4095 = 0.7V
DMA requests
A DMA1 request can be generated when an external trigger (but not a software trigger)
occurs if DMA1 requests are enabled using HAL_DAC_Start_DMA()
DMA1 requests are mapped as following:
1.
2.
12.2.2
DAC channel1 : mapped on DMA1 channel3 which must be already configured

DAC channel2 : mapped on DMA1 channel4 which must be already configured For
Dual mode and specific signal (Triangle and noise) generation please refer to
Extension Features Driver description STM32F0 devices with one channel (one
converting capability) does not support Dual mode and specific signal (Triangle and
noise) generation.
DAC APB clock must be enabled to get write access to DAC registers using
HAL_DAC_Init()
Configure DAC_OUTx (DAC_OUT1: PA4, DAC_OUT2: PA5) in analog mode.
Configure the DAC channel using HAL_DAC_ConfigChannel() function.
Enable the DAC channel using HAL_DAC_Start() or HAL_DAC_Start_DMA functions
Start the DAC peripheral using HAL_DAC_Start()

To read the DAC last data output value value, use the HAL_DAC_GetValue()
function.
Stop the DAC peripheral using HAL_DAC_Stop()
DMA mode IO operation
Start the DAC peripheral using HAL_DAC_Start_DMA(), at this stage the user specify
the length of data to be transfered at each end of conversion
At The end of data transfer HAL_DAC_ConvCpltCallbackCh1()or
HAL_DAC_ConvCpltCallbackCh2() function is executed and user can add his own
code by customization of function pointer HAL_DAC_ConvCpltCallbackCh1 or
HAL_DAC_ConvCpltCallbackCh2
In case of transfer Error, HAL_DAC_ErrorCallbackCh1() function is executed and
HAL_DAC_ErrorCallbackCh1
Stop the DAC peripheral using HAL_DAC_Stop_DMA()
DAC HAL driver macros list

Below the list of most used macros in DAC HAL driver.
__HAL_DAC_ENABLE : Enable the DAC peripheral

__HAL_DAC_DISABLE : Disable the DAC peripheral
__HAL_DAC_CLEAR_FLAG: Clear the DAC's pending flags
DocID026525 Rev 1
179/692
UM1785
__HAL_DAC_GET_FLAG: Get the selected DAC's flag status

You can refer to the DAC HAL driver header file for more useful macros
12.2.3

12.2.4
Initialize and configure the DAC.

De-initialize the DAC.
HAL_DAC_Init()
HAL_DAC_DeInit()
HAL_DAC_MspInit()
HAL_DAC_MspDeInit()
12.2.5
Start conversion.
Stop conversion.
Start conversion and enable DMA transfer.
Stop conversion and disable DMA transfer.
Get result of conversion.
HAL_DAC_Start()
HAL_DAC_Stop()
HAL_DAC_Start_DMA()
HAL_DAC_Stop_DMA()
HAL_DAC_ConvCpltCallbackCh1()
HAL_DAC_ConvHalfCpltCallbackCh1()
HAL_DAC_ErrorCallbackCh1()
HAL_DAC_DMAUnderrunCallbackCh1()

12.2.6
Configure channels.
Set the specified data holding register value for DAC channel.
HAL_DAC_ConfigChannel()
HAL_DAC_SetValue()
HAL_DAC_GetValue()

This subsection provides functions allowing to
180/692
Check the DAC state.

DocID026525 Rev 1
UM1785
12.2.7
12.2.8
12.2.9
Check the DAC Errors.

HAL_DAC_GetState()
HAL_DAC_GetError()
HAL_DAC_IRQHandler()
HAL_DAC_Init
Function Name
HAL_StatusTypeDef HAL_DAC_Init ( DAC_HandleTypeDef *

hdac)
Initializes the DAC peripheral according to the specified

parameters in the DAC_InitStruct.
Parameters
hdac : pointer to a DAC_HandleTypeDef structure that

contains the configuration information for the specified DAC.
Return values
HAL status
Notes
None.
HAL_DAC_DeInit
Function Name
HAL_StatusTypeDef HAL_DAC_DeInit ( DAC_HandleTypeDef *

hdac)
Deinitializes the DAC peripheral registers to their default reset

values.
Parameters

Return values
HAL status
Notes
None.
HAL_DAC_MspInit
Function Name
void HAL_DAC_MspInit ( DAC_HandleTypeDef * hdac)
Initializes the DAC MSP.
Parameters
DocID026525 Rev 1
181/692
12.2.10
12.2.11
UM1785
Return values
None.
Notes
None.
HAL_DAC_MspDeInit
Function Name
void HAL_DAC_MspDeInit ( DAC_HandleTypeDef * hdac)
DeInitializes the DAC MSP.
Parameters

Return values
None.
Notes
None.
HAL_DAC_Start
Function Name
HAL_StatusTypeDef HAL_DAC_Start ( DAC_HandleTypeDef *

hdac, uint32_t Channel)
Enables DAC and starts conversion of channel.
Parameters
12.2.12
182/692

Channel : The selected DAC channel. This parameter can
be one of the following values:
DAC_CHANNEL_1 DAC Channel1 selected
Return values
HAL status
Notes
None.
HAL_DAC_Stop
DocID026525 Rev 1
UM1785
Function Name

HAL_StatusTypeDef HAL_DAC_Stop ( DAC_HandleTypeDef *
Disables DAC and stop conversion of channel.
Parameters
12.2.13
Return values
HAL status
Notes
None.
HAL_DAC_Start_DMA
Function Name
HAL_StatusTypeDef HAL_DAC_Start_DMA (
DAC_HandleTypeDef * hdac, uint32_t Channel, uint32_t *
pData, uint32_t Length, uint32_t Alignment)
Parameters
12.2.14



pData : The destination peripheral Buffer address.
Length : The length of data to be transferred from memory to
DAC peripheral
Alignment : Specifies the data alignment for DAC channel.
This parameter can be one of the following values:
DAC_ALIGN_8B_R 8bit right data alignment selected
DAC_ALIGN_12B_L 12bit left data alignment selected
Return values
HAL status
Notes
None.
HAL_DAC_Stop_DMA
DocID026525 Rev 1
183/692
UM1785
Function Name
HAL_StatusTypeDef HAL_DAC_Stop_DMA (
DAC_HandleTypeDef * hdac, uint32_t Channel)
Disables DAC and stop conversion of channel.
Parameters
12.2.15
12.2.16
184/692

Return values
HAL status
Notes
None.
HAL_DAC_ConvCpltCallbackCh1
Function Name
void HAL_DAC_ConvCpltCallbackCh1 ( DAC_HandleTypeDef

* hdac)
Conversion complete callback in non blocking mode for Channel1.
Parameters

Return values
None.
Notes
None.
HAL_DAC_ConvHalfCpltCallbackCh1
Function Name
void HAL_DAC_ConvHalfCpltCallbackCh1 (
DAC_HandleTypeDef * hdac)
Conversion half DMA transfer callback in non blocking mode for

Channel1.
Parameters

Return values
None.
Notes
None.
DocID026525 Rev 1
UM1785
12.2.17
12.2.18
12.2.19
HAL_DAC_ErrorCallbackCh1
Function Name
void HAL_DAC_ErrorCallbackCh1 ( DAC_HandleTypeDef *

hdac)
Error DAC callback for Channel1.
Parameters

Return values
None.
Notes
None.
HAL_DAC_DMAUnderrunCallbackCh1
Function Name
void HAL_DAC_DMAUnderrunCallbackCh1 (
DMA underrun DAC callback for channel1.
Parameters

Return values
None.
Notes
None.
HAL_DAC_ConfigChannel
Function Name
HAL_StatusTypeDef HAL_DAC_ConfigChannel (
DAC_HandleTypeDef * hdac, DAC_ChannelConfTypeDef *
sConfig, uint32_t Channel)
Configures the selected DAC channel.
Parameters

DocID026525 Rev 1
185/692
12.2.20
UM1785
sConfig : DAC configuration structure.

Return values
HAL status
Notes
None.
HAL_DAC_SetValue
Function Name
HAL_StatusTypeDef HAL_DAC_SetValue (
DAC_HandleTypeDef * hdac, uint32_t Channel, uint32_t
Alignment, uint32_t Data)
Set the specified data holding register value for DAC channel.
Parameters
12.2.21
186/692


Alignment : Specifies the data alignment. This parameter

Data : Data to be loaded in the selected data holding
register.
Return values
HAL status
Notes
None.
HAL_DAC_GetValue
Function Name
uint32_t HAL_DAC_GetValue ( DAC_HandleTypeDef * hdac,

uint32_t Channel)
Returns the last data output value of the selected DAC channel.
DocID026525 Rev 1
UM1785

Parameters
12.2.22
12.2.23
12.2.24

Return values
The selected DAC channel data output value.
Notes
None.
HAL_DAC_GetState
Function Name
HAL_DAC_StateTypeDef HAL_DAC_GetState (
return the DAC state
Parameters

Return values
HAL state
Notes
None.
HAL_DAC_GetError
Function Name
uint32_t HAL_DAC_GetError ( DAC_HandleTypeDef * hdac)
Return the DAC error code.
Parameters

Return values
DAC Error Code
Notes
None.
HAL_DAC_IRQHandler
DocID026525 Rev 1
187/692
UM1785
Function Name
void HAL_DAC_IRQHandler ( DAC_HandleTypeDef * hdac)
Handles DAC interrupt request.
Parameters

Return values
None.
Notes
None.
12.3
DAC Firmware driver defines
12.3.1
DAC
DAC
DAC Channel selection
DAC_CHANNEL_1
DAC_CHANNEL_2
IS_DAC_CHANNEL
DAC data
IS_DAC_DATA
DAC data alignement
DAC_ALIGN_12B_R
DAC_ALIGN_12B_L
DAC_ALIGN_8B_R
IS_DAC_ALIGN
DAC Error Code
HAL_DAC_ERROR_NONE
No error
HAL_DAC_ERROR_DMAUNDERRUNCH1
DAC channel1 DAM underrun error
HAL_DAC_ERROR_DMAUNDERRUNCH2
DAC channel2 DAM underrun error
HAL_DAC_ERROR_DMA
DMA error
DAC Exported Macros

__HAL_DAC_RESET_HANDLE_STATE
Description:
Reset DAC handle state.
Parameters:
__HANDLE__: specifies the DAC handle.
Return value:
188/692
DocID026525 Rev 1
UM1785
None:
Description:
__HAL_DAC_ENABLE
Enable the DAC channel.
Parameters:

__DAC_Channel__: specifies the DAC
channel
Return value:
None:
Description:
__HAL_DAC_DISABLE
Disable the DAC channel.
Parameters:
__HANDLE__: specifies the DAC handle

__DAC_Channel__: specifies the DAC
channel.
Return value:
__HAL_DHR12R1_ALIGNEMENT
None:
Description:
Set DHR12R1 alignment.
Parameters:
__ALIGNEMENT__: specifies the DAC

alignement
Return value:
__HAL_DHR12R2_ALIGNEMENT
None:
Description:
Set DHR12R2 alignment.
Parameters:

alignement
Return value:
__HAL_DHR12RD_ALIGNEMENT
None:
Description:
Set DHR12RD alignment.
Parameters:

alignement
Return value:
None:
DocID026525 Rev 1
189/692

__HAL_DAC_ENABLE_IT
UM1785
Description:
Enable the DAC interrupt.
Parameters:

__INTERRUPT__: specifies the DAC
interrupt.
Return value:
None:
Description:
__HAL_DAC_DISABLE_IT
Disable the DAC interrupt.
Parameters:

__INTERRUPT__: specifies the DAC
interrupt.
Return value:
None:
Description:
__HAL_DAC_GET_FLAG
Get the selected DAC's flag status.
Parameters:

__FLAG__: specifies the FLAG.
Return value:
None:
Description:
__HAL_DAC_CLEAR_FLAG
Clear the DAC's flag.
Parameters:

__FLAG__: specifies the FLAG.
Return value:
None:
DAC flags definition

DAC_FLAG_DMAUDR1
DAC_FLAG_DMAUDR2
DAC IT definition
DAC_IT_DMAUDR1
DAC_IT_DMAUDR2
DAC output buffer
DAC_OUTPUTBUFFER_ENABLE
190/692
DocID026525 Rev 1
UM1785

DAC_OUTPUTBUFFER_DISABLE
IS_DAC_OUTPUT_BUFFER_STATE
DAC trigger selection
DAC_TRIGGER_NONE
Conversion is automatic once the DAC1_DHRxxxx

register has been loaded, and not by external trigger
DAC_TRIGGER_T2_TRGO
TIM2 TRGO selected as external conversion trigger for

DAC channel
DAC_TRIGGER_T3_TRGO

DAC channel
DAC_TRIGGER_T6_TRGO

DAC channel
DAC_TRIGGER_T7_TRGO

DAC channel
DAC_TRIGGER_T15_TRGO

DAC channel
DAC_TRIGGER_EXT_IT9
EXTI Line9 event selected as external conversion trigger

for DAC channel
DAC_TRIGGER_SOFTWARE
Conversion started by software trigger for DAC channel
IS_DAC_TRIGGER
DocID026525 Rev 1
191/692
HAL DAC Extension Driver
UM1785
13
13.1
DACEx Firmware driver API description

The following section lists the various functions of the DACEx library.
13.1.1
13.1.2
When Dual mode is enabled (i.e DAC Channel1 and Channel2 are used
simultaneously) : Use HAL_DACEx_DualGetValue() to get digital data to be converted
and use HAL_DACEx_DualSetValue() to set digital value to converted simultaneously
in Channel 1 and Channel 2.
Use HAL_DACEx_TriangleWaveGenerate() to generate Triangle signal.
Use HAL_DACEx_NoiseWaveGenerate() to generate Noise signal.
Extended features functions

13.1.3
Start conversion.
Stop conversion.
Start conversion and enable DMA transfer.
Stop conversion and disable DMA transfer.
Get result of conversion.
Get result of dual mode conversion.
HAL_DAC_ConfigChannel()
HAL_DAC_GetValue()
HAL_DAC_Start()
HAL_DAC_Start_DMA()
HAL_DAC_IRQHandler()
HAL_DACEx_DualGetValue()
HAL_DACEx_TriangleWaveGenerate()
HAL_DACEx_NoiseWaveGenerate()
HAL_DACEx_DualSetValue()
HAL_DACEx_ConvCpltCallbackCh2()
HAL_DACEx_ConvHalfCpltCallbackCh2()
HAL_DACEx_ErrorCallbackCh2()
HAL_DACEx_DMAUnderrunCallbackCh2()
DAC_DMAConvCpltCh2()
DAC_DMAHalfConvCpltCh2()
DAC_DMAErrorCh2()
HAL_DAC_ConfigChannel
Function Name
192/692
HAL_StatusTypeDef HAL_DAC_ConfigChannel (
DAC_HandleTypeDef * hdac, DAC_ChannelConfTypeDef *
DocID026525 Rev 1
UM1785

sConfig, uint32_t Channel)
Configures the selected DAC channel.
Parameters
13.1.4
Return values
HAL status
Notes
None.
HAL_DAC_GetValue
Function Name
uint32_t HAL_DAC_GetValue ( DAC_HandleTypeDef * hdac,

uint32_t Channel)
Parameters
13.1.5

sConfig : DAC configuration structure.

Return values
Notes
None.
HAL_DAC_Start
Function Name
HAL_StatusTypeDef HAL_DAC_Start ( DAC_HandleTypeDef *

Parameters

DocID026525 Rev 1
193/692
UM1785
13.1.6
Return values
HAL status
Notes
None.
HAL_DAC_Start_DMA
Function Name
HAL_StatusTypeDef HAL_DAC_Start_DMA (
DAC_HandleTypeDef * hdac, uint32_t Channel, uint32_t *
pData, uint32_t Length, uint32_t Alignment)
Parameters
13.1.7
194/692



pData : The destination peripheral Buffer address.
Length : The length of data to be transferred from memory to
DAC peripheral
Alignment : Specifies the data alignment for DAC channel.
Return values
HAL status
Notes
None.
HAL_DAC_IRQHandler
Function Name
void HAL_DAC_IRQHandler ( DAC_HandleTypeDef * hdac)
Handles DAC interrupt request.
Parameters

Return values
None.
DocID026525 Rev 1
UM1785

Notes
13.1.8
13.1.9
None.
HAL_DACEx_DualGetValue
Function Name
uint32_t HAL_DACEx_DualGetValue ( DAC_HandleTypeDef *

hdac)
Parameters

Return values
Notes
None.
HAL_DACEx_TriangleWaveGenerate
Function Name
HAL_StatusTypeDef HAL_DACEx_TriangleWaveGenerate (
Amplitude)
Enables or disables the selected DAC channel wave generation.
Parameters

be one of the following values: DAC_CHANNEL_1 /
DAC_CHANNEL_2
Amplitude : Select max triangle amplitude. This parameter
DAC_TRIANGLEAMPLITUDE_1 Select max triangle

amplitude of 1

amplitude of 3

amplitude of 7

amplitude of 15

amplitude of 31

amplitude of 63
DocID026525 Rev 1
195/692
UM1785
13.1.10
Return values
HAL status
Notes
None.
HAL_DACEx_NoiseWaveGenerate
Function Name
HAL_StatusTypeDef HAL_DACEx_NoiseWaveGenerate (
Amplitude)
Enables or disables the selected DAC channel wave generation.
Parameters
196/692

amplitude of 127
amplitude of 255
amplitude of 511
amplitude of 1023
amplitude of 2047
amplitude of 4095

be one of the following values: DAC_CHANNEL_1 /
DAC_CHANNEL_2
Amplitude : Unmask DAC channel LFSR for noise wave
generation. This parameter can be one of the following
values:
DAC_LFSRUNMASK_BIT0 Unmask DAC channel

LFSR bit0 for noise wave generation
DAC_LFSRUNMASK_BITS1_0 Unmask DAC channel

LFSR bit[1:0] for noise wave generation






DocID026525 Rev 1
UM1785
13.1.11
Return values
HAL status
Notes
None.
HAL_DACEx_DualSetValue
Function Name
HAL_StatusTypeDef HAL_DACEx_DualSetValue (
DAC_HandleTypeDef * hdac, uint32_t Alignment, uint32_t
Data1, uint32_t Data2)
Set the specified data holding register value for dual DAC
channel.
Parameters
13.1.12


Alignment : Specifies the data alignment for dual channel
DAC. This parameter can be one of the following values:
DAC_ALIGN_8B_R: 8bit right data alignment selected
DAC_ALIGN_12B_L: 12bit left data alignment selected
DAC_ALIGN_12B_R: 12bit right data alignment selected
Data1 : Data for DAC Channel2 to be loaded in the selected
data holding register.
Data2 : Data for DAC Channel1 to be loaded in the selected
data holding register.
Return values
HAL status
Notes
In dual mode, a unique register access is required to write in

both DAC channels at the same time.
HAL_DACEx_ConvCpltCallbackCh2
Function Name
void HAL_DACEx_ConvCpltCallbackCh2 (
DocID026525 Rev 1
197/692

13.1.13
13.1.14
13.1.15
198/692
UM1785
Conversion complete callback in non blocking mode for Channel2.
Parameters

Return values
None.
Notes
None.
HAL_DACEx_ConvHalfCpltCallbackCh2
Function Name
void HAL_DACEx_ConvHalfCpltCallbackCh2 (
Conversion half DMA transfer callback in non blocking mode for

Channel2.
Parameters

Return values
None.
Notes
None.
HAL_DACEx_ErrorCallbackCh2
Function Name
void HAL_DACEx_ErrorCallbackCh2 ( DAC_HandleTypeDef *

hdac)
Error DAC callback for Channel2.
Parameters

Return values
None.
Notes
None.
HAL_DACEx_DMAUnderrunCallbackCh2
DocID026525 Rev 1
UM1785
13.1.16
13.1.17

Function Name
void HAL_DACEx_DMAUnderrunCallbackCh2 (
DMA underrun DAC callback for channel2.
Parameters

Return values
None.
Notes
None.
DAC_DMAConvCpltCh2
Function Name
void DAC_DMAConvCpltCh2 ( DMA_HandleTypeDef * hdma)
DMA conversion complete callback.
Parameters
hdma : pointer to a DMA_HandleTypeDef structure that

contains the configuration information for the specified DMA
module.
Return values
None.
Notes
None.
DAC_DMAHalfConvCpltCh2
Function Name
void DAC_DMAHalfConvCpltCh2 ( DMA_HandleTypeDef *

hdma)
DMA half transfer complete callback.
Parameters

module.
Return values
None.
Notes
None.
DocID026525 Rev 1
199/692
13.1.18
UM1785
DAC_DMAErrorCh2
Function Name
void DAC_DMAErrorCh2 ( DMA_HandleTypeDef * hdma)
DMA error callback.
Parameters

module.
Return values
None.
Notes
None.
13.2
DACEx Firmware driver defines
13.2.1
DACEx
DACEx
DACEx lfsrunmask triangleamplitude
200/692
DAC_LFSRUNMASK_BIT0
Unmask DAC channel LFSR bit0

for noise wave generation
DAC_LFSRUNMASK_BITS1_0
Unmask DAC channel LFSR

bit[1:0] for noise wave generation









DocID026525 Rev 1
UM1785

DAC_TRIANGLEAMPLITUDE_1
Select max triangle amplitude of 1
Select max triangle amplitude of

127

255

511

1023

2047

4095
IS_DAC_LFSR_UNMASK_TRIANGLE_AMPLITUDE
DACEx wave generation
DAC_WAVEGENERATION_NONE
DAC_WAVEGENERATION_NOISE
DAC_WAVEGENERATION_TRIANGLE
IS_DAC_GENERATE_WAVE
DACEx wave generation bis
DAC_WAVE_NOISE
DAC_WAVE_TRIANGLE
IS_DAC_WAVE
DocID026525 Rev 1
201/692
HAL DMA Generic Driver
UM1785
14
14.1
DMA Firmware driver registers structures
14.1.1
DMA_InitTypeDef
DMA_InitTypeDef is defined in the stm32f0xx_hal_dma.h
Data Fields
uint32_t Direction
uint32_t PeriphInc
uint32_t MemInc
uint32_t PeriphDataAlignment
uint32_t MemDataAlignment
uint32_t Mode
uint32_t Priority
Field Documentation
14.1.2
uint32_t DMA_InitTypeDef::Direction Specifies if the data will be transferred from

memory to peripheral, from memory to memory or from peripheral to memory. This
parameter can be a value of DMA_Data_transfer_direction
uint32_t DMA_InitTypeDef::PeriphInc Specifies whether the Peripheral address
register should be incremented or not. This parameter can be a value of
DMA_Peripheral_incremented_mode
uint32_t DMA_InitTypeDef::MemInc Specifies whether the memory address register
should be incremented or not. This parameter can be a value of
DMA_Memory_incremented_mode
uint32_t DMA_InitTypeDef::PeriphDataAlignment Specifies the Peripheral data
width. This parameter can be a value of DMA_Peripheral_data_size
uint32_t DMA_InitTypeDef::MemDataAlignment Specifies the Memory data width.
This parameter can be a value of DMA_Memory_data_size
uint32_t DMA_InitTypeDef::Mode Specifies the operation mode of the DMAy
Channelx. This parameter can be a value of DMA_mode
Note:The circular buffer mode cannot be used if the memory-to-memory data transfer
is configured on the selected Channel
uint32_t DMA_InitTypeDef::Priority Specifies the software priority for the DMAy
Channelx. This parameter can be a value of DMA_Priority_level
__DMA_HandleTypeDef
__DMA_HandleTypeDef is defined in the stm32f0xx_hal_dma.h
Data Fields
202/692
DMA_Channel_TypeDef * Instance
DMA_InitTypeDef Init
HAL_DMA_StateTypeDef State
void * Parent
void(* XferCpltCallback
DocID026525 Rev 1
UM1785
void(* XferHalfCpltCallback
void(* XferErrorCallback
Field Documentation
14.2
DMA_Channel_TypeDef* __DMA_HandleTypeDef::Instance Register base address

DMA_InitTypeDef __DMA_HandleTypeDef::Init DMA communication parameters
HAL_LockTypeDef __DMA_HandleTypeDef::Lock DMA locking object
HAL_DMA_StateTypeDef __DMA_HandleTypeDef::State DMA transfer state
void* __DMA_HandleTypeDef::Parent Parent object state
void(* __DMA_HandleTypeDef::XferCpltCallback)(struct __DMA_HandleTypeDef
*hdma) DMA transfer complete callback
void(* __DMA_HandleTypeDef::XferHalfCpltCallback)(struct
__DMA_HandleTypeDef *hdma) DMA Half transfer complete callback
void(* __DMA_HandleTypeDef::XferErrorCallback)(struct
__DMA_HandleTypeDef *hdma) DMA transfer error callback
__IO uint32_t __DMA_HandleTypeDef::ErrorCode DMA Error code
DMA Firmware driver API description

The following section lists the various functions of the DMA library.
14.2.1
1.
2.
3.
4.
Enable and configure the peripheral to be connected to the DMA Channel (except for
internal SRAM / FLASH memories: no initialization is necessary) please refer to
Reference manual for connection between peripherals and DMA requests .
For a given Channel, program the required configuration through the following
parameters: Transfer Direction, Source and Destination data formats, Circular or
Normal mode, Channel Priority level, Source and Destination Increment mode, using
HAL_DMA_Init() function.
Use HAL_DMA_GetState() function to return the DMA state and
HAL_DMA_GetError() in case of error detection.
Use HAL_DMA_Abort() function to abort the current transfer In Memory-to-Memory
transfer mode, Circular mode is not allowed.
Use HAL_DMA_Start() to start DMA transfer after the configuration of Source address
and destination address and the Length of data to be transferred
Use HAL_DMA_PollForTransfer() to poll for the end of current transfer, in this case a
fixed Timeout can be configured by User depending from his application.
Configure the DMA interrupt priority using HAL_NVIC_SetPriority()

Enable the DMA IRQ handler using HAL_NVIC_EnableIRQ()
DocID026525 Rev 1
203/692
UM1785
Use HAL_DMA_Start_IT() to start DMA transfer after the configuration of Source

address and destination address and the Length of data to be transferred. In this case
the DMA interrupt is configured
Use HAL_DMAy_Channelx_IRQHandler() called under DMA_IRQHandler() Interrupt
subroutine
At the end of data transfer HAL_DMA_IRQHandler() function is executed and user
can add his own function by customization of function pointer XferCpltCallback and
XferErrorCallback (i.e a member of DMA handle structure).
DMA HAL driver macros list

Below the list of most used macros in DMA HAL driver.
__HAL_DMA_ENABLE: Enable the specified DMA Channel.

__HAL_DMA_DISABLE: Disable the specified DMA Channel.
__HAL_DMA_GET_FLAG: Get the DMA Channel pending flags.
__HAL_DMA_CLEAR_FLAG: Clear the DMA Channel pending flags.
__HAL_DMA_ENABLE_IT: Enable the specified DMA Channel interrupts.
__HAL_DMA_DISABLE_IT: Disable the specified DMA Channel interrupts.
__HAL_DMA_GET_IT_SOURCE: Check whether the specified DMA Channel
You can refer to the DMA HAL driver header file for more useful macros
14.2.2

This section provides functions allowing to initialize the DMA Channel source and
destination addresses, incrementation and data sizes, transfer direction, circular/normal
mode selection, memory-to-memory mode selection and Channel priority value.
The HAL_DMA_Init() function follows the DMA configuration procedures as described in
reference manual.
14.2.3
HAL_DMA_Init()
HAL_DMA_DeInit()
204/692
Configure the source, destination address and data length and Start DMA transfer
Configure the source, destination address and data length and Start DMA transfer
with interrupt
Abort DMA transfer
Poll for transfer complete
Handle DMA interrupt request
HAL_DMA_Start()
HAL_DMA_Start_IT()
HAL_DMA_Abort()
HAL_DMA_PollForTransfer()
HAL_DMA_IRQHandler()
DocID026525 Rev 1
UM1785
14.2.4
State and Errors functions

14.2.5
14.2.6
14.2.7
Check the DMA state

Get error code
HAL_DMA_GetState()
HAL_DMA_GetError()
HAL_DMA_Init
Function Name
HAL_StatusTypeDef HAL_DMA_Init ( DMA_HandleTypeDef *

hdma)
Initializes the DMA according to the specified parameters in the

DMA_InitTypeDef and create the associated handle.
Parameters
hdma : Pointer to a DMA_HandleTypeDef structure that

Channel.
Return values
HAL status
Notes
None.
HAL_DMA_DeInit
Function Name
HAL_StatusTypeDef HAL_DMA_DeInit ( DMA_HandleTypeDef

* hdma)
DeInitializes the DMA peripheral.
Parameters

Channel.
Return values
HAL status
Notes
None.
HAL_DMA_Start
DocID026525 Rev 1
205/692

Function Name
UM1785
HAL_StatusTypeDef HAL_DMA_Start ( DMA_HandleTypeDef *
hdma, uint32_t SrcAddress, uint32_t DstAddress, uint32_t
DataLength)
Starts the DMA Transfer.
Parameters
14.2.8
Return values
HAL status
Notes
None.
HAL_DMA_Start_IT
Function Name
HAL_StatusTypeDef HAL_DMA_Start_IT (
DMA_HandleTypeDef * hdma, uint32_t SrcAddress, uint32_t
DstAddress, uint32_t DataLength)
Start the DMA Transfer with interrupt enabled.
Parameters
14.2.9
206/692
hdma : : pointer to a DMA_HandleTypeDef structure that

Channel.
SrcAddress : The source memory Buffer address
DstAddress : The destination memory Buffer address
DataLength : The length of data to be transferred from
source to destination

Channel.
SrcAddress : The source memory Buffer address
DstAddress : The destination memory Buffer address
DataLength : The length of data to be transferred from
source to destination
Return values
HAL status
Notes
None.
HAL_DMA_Abort
Function Name
HAL_StatusTypeDef HAL_DMA_Abort ( DMA_HandleTypeDef

* hdma)
Aborts the DMA Transfer.
DocID026525 Rev 1
UM1785
14.2.10
14.2.11

Parameters

Channel.
Return values
HAL status
Notes
After disabling a DMA Channel, a check for wait until the DMA
Channel is effectively disabled is added. If a Channel is
disabled while a data transfer is ongoing, the current data will
be transferred and the Channel will be effectively disabled
only after the transfer of this single data is finished.
HAL_DMA_PollForTransfer
Function Name
HAL_StatusTypeDef HAL_DMA_PollForTransfer (
DMA_HandleTypeDef * hdma, uint32_t CompleteLevel,
uint32_t Timeout)
Polling for transfer complete.
Parameters

Channel.
CompleteLevel : Specifies the DMA level complete.
Return values
HAL status
Notes
None.
HAL_DMA_IRQHandler
Function Name
void HAL_DMA_IRQHandler ( DMA_HandleTypeDef * hdma)
Handles DMA interrupt request.
Parameters

Channel.
Return values
None.
Notes
None.
DocID026525 Rev 1
207/692
14.2.12
14.2.13
UM1785
HAL_DMA_GetState
Function Name
HAL_DMA_StateTypeDef HAL_DMA_GetState (
DMA_HandleTypeDef * hdma)
Returns the DMA state.
Parameters

Channel.
Return values
HAL state
Notes
None.
HAL_DMA_GetError
Function Name
uint32_t HAL_DMA_GetError ( DMA_HandleTypeDef * hdma)
Return the DMA error code.
Parameters

Channel.
Return values
DMA Error Code
Notes
None.
14.3
DMA Firmware driver defines
14.3.1
DMA
DMA
DMA Data buffer size
IS_DMA_BUFFER_SIZE
DMA Data transfer direction
DMA_PERIPH_TO_MEMORY
208/692
Peripheral to memory direction
DocID026525 Rev 1
UM1785

DMA_MEMORY_TO_PERIPH
Memory to peripheral direction
DMA_MEMORY_TO_MEMORY
Memory to memory direction
IS_DMA_DIRECTION
DMA Error Code
HAL_DMA_ERROR_NONE
No error
HAL_DMA_ERROR_TE
Transfer error
HAL_DMA_ERROR_TIMEOUT
Timeout error
DMA Exported Macros

__HAL_DMA_RESET_HANDLE_STATE
Description:
Reset DMA handle state.
Parameters:
__HANDLE__: DMA handle.
Return value:
__HAL_DMA_ENABLE
None:
Description:
Enable the specified DMA Channel.
Parameters:
__HANDLE__: DMA handle
Return value:
__HAL_DMA_DISABLE
None.:
Description:
Disable the specified DMA Channel.
Parameters:
Return value:
__HAL_DMA_ENABLE_IT
None.:
Description:
Enables the specified DMA Channel

interrupts.
Parameters:

__INTERRUPT__: specifies the DMA
interrupt sources to be enabled or
disabled. This parameter can be any
combination of the following values:
DMA_IT_TC: Transfer complete

interrupt mask
DMA_IT_HT: Half transfer complete

interrupt mask
DMA_IT_TE: Transfer error interrupt
DocID026525 Rev 1
209/692
UM1785
mask
Return value:
None:
Description:
__HAL_DMA_DISABLE_IT
Disables the specified DMA Channel

interrupts.
Parameters:

interrupt sources to be enabled or
disabled. This parameter can be any

interrupt mask

interrupt mask

mask
Return value:
__HAL_DMA_GET_IT_SOURCE
None:
Description:
Checks whether the specified DMA

Channel interrupt has occurred or not.
Parameters:


interrupt mask

interrupt mask

mask
Return value:
The: state of DMA_IT (SET or RESET).
DMA flag definitions

DMA_FLAG_GL1
DMA_FLAG_TC1
DMA_FLAG_HT1
DMA_FLAG_TE1
DMA_FLAG_GL2
DMA_FLAG_TC2
210/692
DocID026525 Rev 1
UM1785

DMA_FLAG_HT2
DMA_FLAG_TE2
DMA_FLAG_GL3
DMA_FLAG_TC3
DMA_FLAG_HT3
DMA_FLAG_TE3
DMA_FLAG_GL4
DMA_FLAG_TC4
DMA_FLAG_HT4
DMA_FLAG_TE4
DMA_FLAG_GL5
DMA_FLAG_TC5
DMA_FLAG_HT5
DMA_FLAG_TE5
DMA_FLAG_GL6
DMA_FLAG_TC6
DMA_FLAG_HT6
DMA_FLAG_TE6
DMA_FLAG_GL7
DMA_FLAG_TC7
DMA_FLAG_HT7
DMA_FLAG_TE7
DMA interrupt enable definitions
DMA_IT_TC
DMA_IT_HT
DMA_IT_TE
DMA Memory data size
DMA_MDATAALIGN_BYTE
Memory data alignment : Byte
DMA_MDATAALIGN_HALFWORD
Memory data alignment : HalfWord
DMA_MDATAALIGN_WORD
Memory data alignment : Word
IS_DMA_MEMORY_DATA_SIZE
DMA Memory incremented mode
DMA_MINC_ENABLE
Memory increment mode Enable
DMA_MINC_DISABLE
Memory increment mode Disable
IS_DMA_MEMORY_INC_STATE
DMA mode
DocID026525 Rev 1
211/692

DMA_NORMAL
DMA_CIRCULAR
UM1785
Normal Mode
Circular Mode
IS_DMA_MODE
DMA Peripheral data size
DMA_PDATAALIGN_BYTE
Peripheral data alignment : Byte
DMA_PDATAALIGN_HALFWORD
Peripheral data alignment : HalfWord
DMA_PDATAALIGN_WORD
Peripheral data alignment : Word
IS_DMA_PERIPHERAL_DATA_SIZE
DMA Peripheral incremented mode
DMA_PINC_ENABLE
Peripheral increment mode Enable
DMA_PINC_DISABLE
Peripheral increment mode Disable
IS_DMA_PERIPHERAL_INC_STATE
DMA Priority level
DMA_PRIORITY_LOW
Priority level : Low
DMA_PRIORITY_MEDIUM
Priority level : Medium
DMA_PRIORITY_HIGH
Priority level : High
DMA_PRIORITY_VERY_HIGH
Priority level : Very_High
IS_DMA_PRIORITY
DMA Private Constants
HAL_TIMEOUT_DMA_ABORT
212/692
DocID026525 Rev 1
UM1785
HAL DMA Extension Driver
15
15.1
DMAEx Firmware driver defines
15.1.1
DMAEx
DMAEx
DMAEx Exported Constants
DMA1_CHANNEL1_RMP
DMA1_CHANNEL2_RMP
DMA1_CHANNEL3_RMP
DMA1_CHANNEL4_RMP
DMA1_CHANNEL5_RMP
DMA1_CHANNEL6_RMP
DMA1_CHANNEL7_RMP
DMA2_CHANNEL1_RMP
DMA2_CHANNEL2_RMP
DMA2_CHANNEL3_RMP
DMA2_CHANNEL4_RMP
DMA2_CHANNEL5_RMP
HAL_DMA1_CH1_DEFAULT
Default remap position for DMA1
HAL_DMA1_CH1_ADC
Remap ADC on DMA1 Channel 1
HAL_DMA1_CH1_TIM17_CH1
Remap TIM17 channel 1 on DMA1 channel 1
HAL_DMA1_CH1_TIM17_UP
Remap TIM17 up on DMA1 channel 1
HAL_DMA1_CH1_USART1_RX
Remap USART1 Rx on DMA1 channel 1
HAL_DMA1_CH2_ADC
Remap ADC on DMA1 channel 2
HAL_DMA1_CH2_I2C1_TX
Remap I2C1 Tx on DMA1 channel 2
HAL_DMA1_CH2_SPI1_RX
Remap SPI1 Rx on DMA1 channel 2
DocID026525 Rev 1
213/692

214/692
UM1785
HAL_DMA1_CH2_USART1_TX
Remap USART1 Tx on DMA1 channel 2
HAL_DMA1_CH3_DAC_CH1
Remap DAC Channel 1on DMA1 channel 3
HAL_DMA1_CH3_I2C1_RX
Remap I2C1 Rx on DMA1 channel 3
HAL_DMA1_CH3_SPI1_TX
Remap SPI1 Tx on DMA1 channel 3
Remap DAC Channel 2 on DMA1 channel 4
HAL_DMA1_CH4_TIM3_TRIG
Remap TIM3 Trig on DMA1 channel 4
DocID026525 Rev 1
UM1785

HAL_DMA1_CH6_TIM3_TRIG
Remap TIM3 Trig on DMA1 channel 6
DocID026525 Rev 1
215/692

Remap I2C2 TX on DMA2 channel 1
216/692
UM1785
DocID026525 Rev 1
UM1785

Remap DAC channel 1 on DMA2 channel 3
Remap DAC channel 2 on DMA2 channel 4
HAL_DMA2_CH5_ADC
Remap ADC on DMA2 channel 5
DocID026525 Rev 1
217/692

IS_HAL_DMA1_REMAP
UM1785
IS_HAL_DMA2_REMAP
DMAEx Exported Macros
__HAL_DMA_GET_TC_FLAG_INDEX
Description:
Returns the current DMA Channel transfer

complete flag.
Parameters:
Return value:
__HAL_DMA_GET_HT_FLAG_INDEX
The: specified transfer complete flag index.
Description:
Returns the current DMA Channel half

transfer complete flag.
Parameters:
Return value:
__HAL_DMA_GET_TE_FLAG_INDEX
The: specified half transfer complete flag

index.
Description:
Returns the current DMA Channel transfer

error flag.
Parameters:
Return value:
__HAL_DMA_GET_FLAG
The: specified transfer error flag index.
Description:
Get the DMA Channel pending flags.
Parameters:

__FLAG__: Get the specified flag. This
parameter can be any combination of the
following values:
DMA_FLAG_TCIFx: Transfer complete

flag
DMA_FLAG_HTIFx: Half transfer

complete flag
DMA_FLAG_TEIFx: Transfer error flag

Where x can be 0_4, 1_5, 2_6 or 3_7 to
select the DMA Channel flag.
Return value:
218/692
The: state of FLAG (SET or RESET).
DocID026525 Rev 1
UM1785

__HAL_DMA_CLEAR_FLAG
Description:
Clears the DMA Channel pending flags.
Parameters:

__FLAG__: specifies the flag to clear. This
following values:
DMA_FLAG_TCIFx: Transfer complete

flag
DMA_FLAG_HTIFx: Half transfer

complete flag
DMA_FLAG_TEIFx: Transfer error flag

Where x can be 0_4, 1_5, 2_6 or 3_7 to
select the DMA Channel flag.
Return value:
None:
__HAL_DMA1_REMAP
__HAL_DMA2_REMAP
DocID026525 Rev 1
219/692
HAL FLASH Generic Driver
UM1785
16
16.1
FLASH Firmware driver registers structures
16.1.1
FLASH_EraseInitTypeDef
FLASH_EraseInitTypeDef is defined in the stm32f0xx_hal_flash.h
Data Fields
uint32_t TypeErase
uint32_t PageAddress
uint32_t NbPages
Field Documentation
16.1.2
uint32_t FLASH_EraseInitTypeDef::TypeErase TypeErase: Mass erase or page

erase. This parameter can be a value of FLASH_Type_Erase
uint32_t FLASH_EraseInitTypeDef::PageAddress PageAdress: Initial FLASH page
address to erase when mass erase is disabled This parameter must be a value of
FLASHEx_Address
uint32_t FLASH_EraseInitTypeDef::NbPages NbPages: Number of pagess to be
erased. This parameter must be a value between 1 and (max number of pages - value
of initial page)
FLASH_OBProgramInitTypeDef
FLASH_OBProgramInitTypeDef is defined in the stm32f0xx_hal_flash.h
Data Fields
uint32_t OptionType
uint32_t WRPState
uint32_t WRPPage
uint8_t RDPLevel
uint8_t USERConfig
uint32_t DATAAddress
uint8_t DATAData
Field Documentation
220/692
uint32_t FLASH_OBProgramInitTypeDef::OptionType OptionType: Option byte to

be configured. This parameter can be a value of FLASH_OB_Type
uint32_t FLASH_OBProgramInitTypeDef::WRPState WRPState: Write protection
activation or deactivation. This parameter can be a value of FLASH_OB_WRP_State
uint32_t FLASH_OBProgramInitTypeDef::WRPPage WRPSector: specifies the
page(s) to be write protected This parameter can be a value of
FLASHEx_OB_Write_Protection
uint8_t FLASH_OBProgramInitTypeDef::RDPLevel RDPLevel: Set the read
protection level.. This parameter can be a value of FLASH_OB_Read_Protection
DocID026525 Rev 1
UM1785
16.1.3
uint8_t FLASH_OBProgramInitTypeDef::USERConfig USERConfig: Program the

FLASH User Option Byte: IWDG / STOP / STDBY / BOOT1 / VDDA_ANALOG /
SRAM_PARITY This parameter can be a combination of FLASH_OB_Watchdog,
FLASH_OB_nRST_STOP, FLASH_OB_nRST_STDBY, FLASH_OB_BOOT1,
FLASH_OB_VDDA_Analog_Monitoring and
FLASH_OB_RAM_Parity_Check_Enable
uint32_t FLASH_OBProgramInitTypeDef::DATAAddress DATAAddress: Address
of the option byte DATA to be prgrammed This parameter can be a value of
FLASH_OB_Data_Address
uint8_t FLASH_OBProgramInitTypeDef::DATAData DATAData: Data to be stored
in the option byte DATA This parameter can have any value
FLASH_ProcessTypeDef
FLASH_ProcessTypeDef is defined in the stm32f0xx_hal_flash.h
Data Fields
__IO FLASH_ProcedureTypeDef ProcedureOnGoing

__IO uint32_t DataRemaining
__IO uint32_t Address
__IO uint64_t Data
__IO FLASH_ErrorTypeDef ErrorCode
Field Documentation
16.2
__IO FLASH_ProcedureTypeDef FLASH_ProcessTypeDef::ProcedureOnGoing

__IO uint32_t FLASH_ProcessTypeDef::DataRemaining
__IO uint32_t FLASH_ProcessTypeDef::Address
__IO uint64_t FLASH_ProcessTypeDef::Data
HAL_LockTypeDef FLASH_ProcessTypeDef::Lock
__IO FLASH_ErrorTypeDef FLASH_ProcessTypeDef::ErrorCode
FLASH Firmware driver API description

The following section lists the various functions of the FLASH library.
16.2.1
FLASH peripheral features

The Flash memory interface manages CPU AHB I-Code and D-Code accesses to the
Flash memory. It implements the erase and program Flash memory operations and the
read and write protection mechanisms.
The Flash memory interface accelerates code execution with a system of instruction
prefetch.
The FLASH main features are:
Flash memory read operations

Flash memory program/erase operations
Read / write protections
Prefetch on I-Code
DocID026525 Rev 1
221/692
16.2.2
UM1785
Option Bytes programming

This driver provides functions and macros to configure and program the FLASH memory of
all STM32F0xx devices. These functions are split in 3 groups:
1.
2.
3.
FLASH Memory I/O Programming functions: this group includes all needed functions
to erase and program the main memory:
Lock and Unlock the FLASH interface
Erase function: Erase page, erase all pages
Program functions: half word, word and doubleword

Option Bytes Programming functions: this group includes all needed functions to
manage the Option Bytes:
Lock and Unlock the Option Bytes
Erase Option Bytes
Set/Reset the write protection
Set the Read protection Level
Program the user Option Bytes
Program the data Option Bytes
Launch the Option Bytes loader

Interrupts and flags management functions : this group includes all needed functions
to:
Handle FLASH interrupts
Wait for last FLASH operation according to its status
Get error flag status
In addition to these function, this driver includes a set of macros allowing to handle the
following operations:
16.2.3
Set the latency

Enable/Disable the prefetch buffer
Enable/Disable the FLASH interrupts
Monitor the FLASH flags status
This subsection provides a set of functions allowing to manage the FLASH program
operations (write/erase).
16.2.4
HAL_FLASH_Program()
HAL_FLASH_Program_IT()
HAL_FLASH_IRQHandler()
HAL_FLASH_EndOfOperationCallback()
HAL_FLASH_OperationErrorCallback()

This subsection provides a set of functions allowing to control the FLASH memory
operations.
222/692
HAL_FLASH_Unlock()
HAL_FLASH_Lock()
DocID026525 Rev 1
UM1785
16.2.5
HAL_FLASH_OB_Unlock()
HAL_FLASH_OB_Lock()
HAL_FLASH_OB_Launch()
Peripheral Errors functions

This subsection permit to get in run-time Errors of the FLASH peripheral.
16.2.6
HAL_FLASH_GetError()
HAL_FLASH_Program
Function Name
HAL_StatusTypeDef HAL_FLASH_Program ( uint32_t

TypeProgram, uint32_t Address, uint64_t Data)
Program halfword, word or double word at a specified address.
Parameters
TypeProgram : Indicate the way to program at a specified

address. This parameter can be a value of FLASH Type
Program
Address : Specifies the address to be programmed.
Data : Specifies the data to be programmed
Return values
HAL_StatusTypeDef HAL Status
Notes
The function HAL_FLASH_Unlock() should be called before

to unlock the FLASH interface The function
HAL_FLASH_Lock() should be called after to lock the FLASH
interface
If an erase and a program operations are requested
simultaneously, the erase operation is performed before the
program one.
FLASH should be previously erased before new
programmation (only exception to this is when 0x0000 is
programmed)
16.2.7
HAL_FLASH_Program_IT
Function Name
HAL_StatusTypeDef HAL_FLASH_Program_IT ( uint32_t

TypeProgram, uint32_t Address, uint64_t Data)
Program halfword, word or double word at a specified address

with interrupt enabled.
Parameters
TypeProgram : Indicate the way to program at a specified

address. This parameter can be a value of FLASH Type
Program
DocID026525 Rev 1
223/692
UM1785
Address : Specifies the address to be programmed.

Data : Specifies the data to be programmed
Return values
Notes

interface
If an erase and a program operations are requested
simultaneously, the erase operation is performed before the
program one.
16.2.8
16.2.9
224/692
HAL_FLASH_IRQHandler
Function Name
void HAL_FLASH_IRQHandler ( void )
This function handles FLASH interrupt request.
Return values
None.
Notes
None.
HAL_FLASH_EndOfOperationCallback
Function Name
void HAL_FLASH_EndOfOperationCallback ( uint32_t

ReturnValue)
FLASH end of operation interrupt callback.
Parameters
ReturnValue : The value saved in this parameter depends

on the ongoing procedure
Mass Erase No return value expected
Pages Erase Address of the page which has been

erased
Program Address which was selected for data program
Return values
none
Notes
None.
DocID026525 Rev 1
UM1785
16.2.10
16.2.11
16.2.12
HAL_FLASH_OperationErrorCallback
Function Name
void HAL_FLASH_OperationErrorCallback ( uint32_t

ReturnValue)
FLASH operation error interrupt callback.
Parameters
ReturnValue : The value saved in this parameter depends

on the ongoing procedure
Mass Erase No return value expected
Pages Erase Address of the page which returned an

error
Program Address which was selected for data program
Return values
none
Notes
None.
HAL_FLASH_Unlock
Function Name
HAL_StatusTypeDef HAL_FLASH_Unlock ( void )
Unlock the FLASH control register access.
Return values
HAL Status
Notes
None.
HAL_FLASH_Lock
Function Name
HAL_StatusTypeDef HAL_FLASH_Lock ( void )
Locks the FLASH control register access.
Return values
HAL Status
Notes
None.
DocID026525 Rev 1
225/692
16.2.13
16.2.14
16.2.15
16.2.16
226/692
UM1785
HAL_FLASH_OB_Unlock
Function Name
HAL_StatusTypeDef HAL_FLASH_OB_Unlock ( void )
Unlock the FLASH Option Control Registers access.
Return values
HAL Status
Notes
None.
HAL_FLASH_OB_Lock
Function Name
HAL_StatusTypeDef HAL_FLASH_OB_Lock ( void )
Lock the FLASH Option Control Registers access.
Return values
HAL Status
Notes
None.
HAL_FLASH_OB_Launch
Function Name
HAL_StatusTypeDef HAL_FLASH_OB_Launch ( void )
Launch the option byte loading.
Return values
HAL status
Notes
None.
HAL_FLASH_GetError
Function Name
FLASH_ErrorTypeDef HAL_FLASH_GetError ( void )
Get the specific FLASH error flag.
DocID026525 Rev 1
UM1785

Return values
FLASH_ErrorCode : The returned value can be:
FLASH_ERROR_PG: FLASH Programming error flag
FLASH_ERROR_WRP: FLASH Write protected error

flag
Notes
None.
16.3
FLASH Firmware driver defines
16.3.1
FLASH
FLASH
FLASH Flag definition
FLASH_FLAG_BSY
FLASH Busy flag
FLASH_FLAG_PGERR
FLASH Programming error flag
FLASH_FLAG_WRPERR
FLASH Write protected error flag
FLASH_FLAG_EOP
FLASH End of Operation flag
FLASH Interrupt
Description:
__HAL_FLASH_ENABLE_IT
Enable the specified FLASH interrupt.
Parameters:
__INTERRUPT__: : FLASH interrupt This parameter

can be any combination of the following values:
FLASH_IT_EOP: End of FLASH Operation

Interrupt
FLASH_IT_ERR: Error Interrupt
Return value:
__HAL_FLASH_DISABLE_IT
none:
Description:
Disable the specified FLASH interrupt.
Parameters:
__INTERRUPT__: : FLASH interrupt This parameter

can be any combination of the following values:
FLASH_IT_EOP: End of FLASH Operation

Interrupt
FLASH_IT_ERR: Error Interrupt
Return value:
__HAL_FLASH_GET_FLAG
none:
Description:
Get the specified FLASH flag status.
DocID026525 Rev 1
227/692
UM1785
Parameters:
__FLAG__: specifies the FLASH flag to check. This

FLASH_FLAG_EOP : FLASH End of Operation

flag
FLASH_FLAG_WRPERR: FLASH Write

protected error flag
FLASH_FLAG_PGERR : FLASH Programming

error flag
FLASH_FLAG_BSY : FLASH Busy flag
Return value:
__HAL_FLASH_CLEAR_FLAG
The: new state of __FLAG__ (SET or RESET).
Description:
Clear the specified FLASH flag.
Parameters:
__FLAG__: specifies the FLASH flags to clear. This

parameter can be any combination of the following
values:
FLASH_FLAG_EOP : FLASH End of Operation

flag
FLASH_FLAG_WRPERR: FLASH Write

protected error flag
FLASH_FLAG_PGERR : FLASH Programming

error flag
Return value:
none:
FLASH Interrupt definition

FLASH_IT_EOP
End of FLASH Operation Interrupt source
FLASH_IT_ERR
Error Interrupt source
FLASH Latency
FLASH_LATENCY_0
FLASH Zero Latency cycle
FLASH_LATENCY_1
FLASH One Latency cycle
IS_FLASH_LATENCY
__HAL_FLASH_SET_LATENCY
Description:
Set the FLASH Latency.
Parameters:
__LATENCY__: FLASH Latency The value of this

parameter depend on device used within the same
series
Return value:
None:
FLASH OB BOOT1
228/692
DocID026525 Rev 1
UM1785

OB_BOOT1_RESET
BOOT1 Reset
OB_BOOT1_SET
BOOT1 Set
IS_OB_BOOT1
FLASH OB Data Address
IS_OB_DATA_ADDRESS
FLASH OB nRST STDBY
OB_STDBY_NO_RST
No reset generated when entering in STANDBY
OB_STDBY_RST
Reset generated when entering in STANDBY
IS_OB_STDBY_SOURCE
FLASH OB nRST STOP
OB_STOP_NO_RST
No reset generated when entering in STOP
OB_STOP_RST
Reset generated when entering in STOP
IS_OB_STOP_SOURCE
FLASH OB RAM Parity Check Enable
OB_RAM_PARITY_CHECK_SET
RAM parity check enable set
OB_RAM_PARITY_CHECK_RESET
RAM parity check enable reset
IS_OB_SRAM_PARITY
FLASH OB Read Protection
OB_RDP_LEVEL_0
OB_RDP_LEVEL_1
OB_RDP_LEVEL_2
Warning: When enabling read protection level 2 it's no more

possible to go back to level 1 or 0
IS_OB_RDP_LEVEL
FLASH Option Bytes Type
OPTIONBYTE_WRP
WRP option byte configuration
OPTIONBYTE_RDP
RDP option byte configuration
OPTIONBYTE_USER
USER option byte configuration
OPTIONBYTE_DATA
DATA option byte configuration
IS_OPTIONBYTE
FLASH OB VDDA Analog Monitoring
OB_VDDA_ANALOG_ON
Analog monitoring on VDDA Power source ON
OB_VDDA_ANALOG_OFF
Analog monitoring on VDDA Power source OFF
IS_OB_VDDA_ANALOG
FLASH OB Watchdog
OB_WDG_SW
Software WDG selected
OB_WDG_HW
Hardware WDG selected
IS_OB_WDG_SOURCE
DocID026525 Rev 1
229/692

FLASH WRP State
UM1785
WRPSTATE_DISABLE
Disable the write protection of the desired pages
WRPSTATE_ENABLE
Enable the write protection of the desired pagess
IS_WRPSTATE
FLASH Prefetch
__HAL_FLASH_PREFETCH_BUFFER_ENABLE
Description:
Enable the FLASH prefetch

buffer.
Return value:
__HAL_FLASH_PREFETCH_BUFFER_DISABLE
None:
Description:
Disable the FLASH prefetch

buffer.
Return value:
None:
FLASH Timeout definition

HAL_FLASH_TIMEOUT_VALUE
FLASH Type Erase
TYPEERASE_PAGES
Pages erase only
TYPEERASE_MASSERASE
Flash mass erase activation
IS_TYPEERASE
FLASH Type Program
TYPEPROGRAM_HALFWORD
Program a half-word (16-bit) at a specified address.
TYPEPROGRAM_WORD
Program a word (32-bit) at a specified address.
TYPEPROGRAM_DOUBLEWORD
Program a double word (64-bit) at a specified

address
IS_TYPEPROGRAM
230/692
DocID026525 Rev 1
UM1785
HAL FLASH Extension Driver
17
17.1
FLASHEx Firmware driver API description

The following section lists the various functions of the FLASHEx library.
17.1.1
Flash peripheral extended features
17.1.2

This driver provides functions to configure and program the FLASH memory of all
STM32F0xxx devices. It includes
17.1.3
17.1.4
Set/Reset the write protection

Program the user Option Bytes
Get the Read protection Level
HAL_FLASHEx_Erase()
HAL_FLASHEx_Erase_IT()

This subsection provides a set of functions allowing to control the FLASH memory
operations.
17.1.5
HAL_FLASHEx_OBErase()
HAL_FLASHEx_OBProgram()
HAL_FLASHEx_OBGetConfig()
HAL_FLASHEx_Erase
Function Name
HAL_StatusTypeDef HAL_FLASHEx_Erase (
FLASH_EraseInitTypeDef * pEraseInit, uint32_t * PageError)
Perform a mass erase or erase the specified FLASH memory

pages.
Parameters
pEraseInit : pointer to an FLASH_EraseInitTypeDef

structure that contains the configuration information for the
erasing.
PageError : pointer to variable that contains the
configuration information on faulty page in case of error
(0xFFFFFFFF means that all the pages have been correctly
erased)
DocID026525 Rev 1
231/692

Return values
Notes
17.1.6
17.1.7
232/692
UM1785

interface
HAL_FLASHEx_Erase_IT
Function Name
HAL_StatusTypeDef HAL_FLASHEx_Erase_IT (
FLASH_EraseInitTypeDef * pEraseInit)
Perform a mass erase or erase the specified FLASH memory

sectors with interrupt enabled.
Parameters
pEraseInit : pointer to an FLASH_EraseInitTypeDef

erasing.
Return values
Notes

interface
HAL_FLASHEx_OBErase
Function Name
HAL_StatusTypeDef HAL_FLASHEx_OBErase ( void )
Erases the FLASH option bytes.
Return values
HAL status
Notes
This functions erases all option bytes except the Read

protection (RDP). The function HAL_FLASH_Unlock() should
be called before to unlock the FLASH interface The function
HAL_FLASH_OB_Unlock() should be called before to unlock
the options bytes The function HAL_FLASH_OB_Launch()
should be called after to force the reload of the options bytes
(system reset will occur)
DocID026525 Rev 1
UM1785
17.1.8
17.1.9
HAL_FLASHEx_OBProgram
Function Name
HAL_StatusTypeDef HAL_FLASHEx_OBProgram (
FLASH_OBProgramInitTypeDef * pOBInit)
Program option bytes.
Parameters
pOBInit : pointer to an FLASH_OBInitStruct structure that

contains the configuration information for the programming.
Return values
Notes

HAL_FLASH_OB_Unlock() should be called before to unlock
the options bytes The function HAL_FLASH_OB_Launch()
should be called after to force the reload of the options bytes
(system reset will occur)
HAL_FLASHEx_OBGetConfig
Function Name
void HAL_FLASHEx_OBGetConfig (
FLASH_OBProgramInitTypeDef * pOBInit)
Get the Option byte configuration.
Parameters
pOBInit : pointer to an FLASH_OBInitStruct structure that

contains the configuration information for the programming.
Return values
None.
Notes
None.
17.2
FLASHEx Firmware driver defines
17.2.1
FLASHEx
FLASHEx
FLASHEx Address
IS_FLASH_PROGRAM_ADDRESS
FLASHEx Nb Pages
DocID026525 Rev 1
233/692

IS_FLASH_NB_PAGES
UM1785
FLASHEx OB BOOT0
OB_BOOT0_RESET
BOOT0 Reset
OB_BOOT0_SET
BOOT0 Set
IS_OB_BOOT0
FLASHEx OB BOOT SEL
OB_BOOT_SEL_RESET
BOOT_SEL Reset
OB_BOOT_SEL_SET
BOOT_SEL Set
IS_OB_BOOT_SEL
FLASHEx OB Write Protection
OB_WRP_PAGES0TO1
OB_WRP_PAGES2TO3
OB_WRP_PAGES4TO5
OB_WRP_PAGES6TO7
OB_WRP_PAGES8TO9
OB_WRP_PAGES10TO11
OB_WRP_PAGES12TO13
OB_WRP_PAGES14TO15
OB_WRP_PAGES16TO17
OB_WRP_PAGES18TO19
OB_WRP_PAGES20TO21
OB_WRP_PAGES22TO23
OB_WRP_PAGES24TO25
OB_WRP_PAGES26TO27
OB_WRP_PAGES28TO29
OB_WRP_PAGES30TO31
OB_WRP_PAGES32TO33
OB_WRP_PAGES34TO35
OB_WRP_PAGES36TO37
OB_WRP_PAGES38TO39
OB_WRP_PAGES40TO41
OB_WRP_PAGES42TO43
OB_WRP_PAGES44TO45
OB_WRP_PAGES46TO47
OB_WRP_PAGES48TO49
OB_WRP_PAGES50TO51
234/692
DocID026525 Rev 1
UM1785

OB_WRP_PAGES52TO53
OB_WRP_PAGES54TO55
OB_WRP_PAGES56TO57
OB_WRP_PAGES58TO59
OB_WRP_PAGES60TO61
OB_WRP_PAGES62TO127
OB_WRP_PAGES0TO15MASK
OB_WRP_ALLPAGES
Write protection of all pages
IS_OB_WRP
FLASHEx Page Size
FLASH_PAGE_SIZE
FLASHEx Private Constants
HAL_FLASH_TIMEOUT_VALUE
DocID026525 Rev 1
235/692
HAL GPIO Generic Driver
UM1785
18
18.1
GPIO Firmware driver registers structures
18.1.1
GPIO_InitTypeDef
GPIO_InitTypeDef is defined in the stm32f0xx_hal_gpio.h
Data Fields
uint32_t Pin
uint32_t Mode
uint32_t Pull
uint32_t Speed
uint32_t Alternate
Field Documentation
18.2
uint32_t GPIO_InitTypeDef::Pin Specifies the GPIO pins to be configured. This

parameter can be any value of GPIO_pins
uint32_t GPIO_InitTypeDef::Mode Specifies the operating mode for the selected
pins. This parameter can be a value of GPIO_mode
uint32_t GPIO_InitTypeDef::Pull Specifies the Pull-up or Pull-Down activation for the
selected pins. This parameter can be a value of GPIO_pull
uint32_t GPIO_InitTypeDef::Speed Specifies the speed for the selected pins. This
parameter can be a value of GPIO_speed
uint32_t GPIO_InitTypeDef::Alternate Peripheral to be connected to the selected
pins This parameter can be a value of GPIOEx_Alternate_function_selection
GPIO Firmware driver API description

The following section lists the various functions of the GPIO library.
18.2.1
GPIO Peripheral features

Each port bit of the general-purpose I/O (GPIO) ports can be individually configured by
software in several modes:
Input mode
Analog mode
Output mode
Alternate function mode
External interrupt/event lines
During and just after reset, the alternate functions and external interrupt lines are not
active and the I/O ports are configured in input floating mode.
All GPIO pins have weak internal pull-up and pull-down resistors, which can be activated
or not.
In Output or Alternate mode, each IO can be configured on open-drain or push-pull type
and the IO speed can be selected depending on the VDD value.
236/692
DocID026525 Rev 1
UM1785

The microcontroller IO pins are connected to onboard peripherals/modules through a
multiplexer that allows only one peripheral s alternate function (AF) connected to an IO pin
at a time. In this way, there can be no conflict between peripherals sharing the same IO
pin.
All ports have external interrupt/event capability. To use external interrupt lines, the port
must be configured in input mode. All available GPIO pins are connected to the 16 external
interrupt/event lines from EXTI0 to EXTI15.
The external interrupt/event controller consists of up to 28 edge detectors (depending on
products 16 lines are connected to GPIO) for generating event/interrupt requests (each
input line can be independently configured to select the type (interrupt or event) and the
corresponding trigger event (rising or falling or both). Each line can also be masked
independently.
18.2.2
1.
2.
Enable the GPIO AHB clock using the following function : __GPIOx_CLK_ENABLE().
Configure the GPIO pin(s) using HAL_GPIO_Init().
Configure the IO mode using "Mode" member from GPIO_InitTypeDef structure
Activate Pull-up, Pull-down resistor using "Pull" member from GPIO_InitTypeDef

structure.
In case of Output or alternate function mode selection: the speed is configured

through "Speed" member from GPIO_InitTypeDef structure, the speed is
configurable: Low, Medium and High.
If alternate mode is selected, the alternate function connected to the IO is

configured through "Alternate" member from GPIO_InitTypeDef structure
Analog mode is required when a pin is to be used as ADC channel or DAC

output.
In case of external interrupt/event selection the "Mode" member from

GPIO_InitTypeDef structure select the type (interrupt or event) and the
corresponding trigger event (rising or falling or both).
3.
In case of external interrupt/event mode selection, configure NVIC IRQ priority
mapped to the EXTI line using HAL_NVIC_SetPriority() and enable it using
HAL_NVIC_EnableIRQ().
4.
HAL_GPIO_DeInit allows to set register values to their reset value. It's also to use it
to unconfigure pin which was used as an external interrupt or in event mode. That's
the only way to reset corresponding bit in EXTI & SYSCFG registers.
5.
To get the level of a pin configured in input mode use HAL_GPIO_ReadPin().
6.
To set/reset the level of a pin configured in output mode use
HAL_GPIO_WritePin()/HAL_GPIO_TogglePin().
7.
To lock pin configuration until next reset use HAL_GPIO_LockPin().
8.
During and just after reset, the alternate functions are not active and the GPIO pins
are configured in input floating mode (except JTAG pins).
9.
The LSE oscillator pins OSC32_IN and OSC32_OUT can be used as general
purpose (PC14 and PC15, respectively) when the LSE oscillator is off. The LSE has
priority over the GPIO function.
10. The HSE oscillator pins OSC_IN/OSC_OUT can be used as general purpose PD0
and PD1, respectively, when the HSE oscillator is off. The HSE has priority over the
GPIO function.
18.2.3
DocID026525 Rev 1
237/692
18.2.4
18.2.5
UM1785
HAL_GPIO_Init()
HAL_GPIO_DeInit()
HAL_GPIO_ReadPin()
HAL_GPIO_WritePin()
HAL_GPIO_TogglePin()
HAL_GPIO_LockPin()
HAL_GPIO_EXTI_IRQHandler()
HAL_GPIO_EXTI_Callback()
HAL_GPIO_Init
Function Name
void HAL_GPIO_Init ( GPIO_TypeDef * GPIOx,

GPIO_InitTypeDef * GPIO_Init)
Initializes the GPIOx peripheral according to the specified

parameters in the GPIO_Init.
Parameters
GPIOx : where x can be (A..F) to select the GPIO peripheral

for STM32F0 family
Parameters
GPIO_Init : pointer to a GPIO_InitTypeDef structure that

contains the configuration information for the specified GPIO
peripheral.
Return values
None.
Notes
GPIOD is only available on STM32F05xx, STM32F07xx and

STM32F09xx
GPIOE is only available on STM32F07xx and STM32F09xx
18.2.6
238/692
HAL_GPIO_DeInit
Function Name
void HAL_GPIO_DeInit ( GPIO_TypeDef * GPIOx, uint32_t

GPIO_Pin)
De-initializes the GPIOx peripheral registers to their default reset

values.
Parameters

for STM32F0 family
Parameters
GPIO_Pin : specifies the port bit to be written. This

parameter can be one of GPIO_PIN_x where x can be (0..15).
DocID026525 Rev 1
UM1785

Return values
None.
Notes

STM32F09xx
18.2.7
HAL_GPIO_ReadPin
Function Name
GPIO_PinState HAL_GPIO_ReadPin ( GPIO_TypeDef * GPIOx,

uint16_t GPIO_Pin)
Reads the specified input port pin.
Parameters

for STM32F0 family
Parameters
GPIO_Pin : specifies the port bit to read. This parameter can

be GPIO_PIN_x where x can be (0..15).
Return values
The input port pin value.
Notes

STM32F09xx
18.2.8
HAL_GPIO_WritePin
Function Name
void HAL_GPIO_WritePin ( GPIO_TypeDef * GPIOx, uint16_t

GPIO_Pin, GPIO_PinState PinState)
Sets or clears the selected data port bit.
Parameters

for STM32F0 family
Parameters
GPIO_Pin : specifies the port bit to be written. This

parameter can be one of GPIO_PIN_x where x can be (0..15).
PinState : specifies the value to be written to the selected
bit. This parameter can be one of the GPIO_PinState enum
values:
GPIO_PIN_RESET to clear the port pin
GPIO_PIN_SET to set the port pin
Return values
None.
DocID026525 Rev 1
239/692

Notes
UM1785
18.2.9
HAL_GPIO_TogglePin
Function Name
void HAL_GPIO_TogglePin ( GPIO_TypeDef * GPIOx, uint16_t

GPIO_Pin)
Toggles the specified GPIO pin.
Parameters

for STM32F0 family
Parameters
GPIO_Pin : specifies the pins to be toggled.
Return values
None.
Notes

STM32F09xx
18.2.10
HAL_GPIO_LockPin
Function Name
HAL_StatusTypeDef HAL_GPIO_LockPin ( GPIO_TypeDef *

GPIOx, uint16_t GPIO_Pin)
Locks GPIO Pins configuration registers.
Parameters

for STM32F0 family
Parameters
GPIO_Pin : specifies the port bit to be locked. This

parameter can be any combination of GPIO_Pin_x where x
can be (0..15).
Return values
None.
Notes
The locked registers are GPIOx_MODER, GPIOx_OTYPER,

GPIOx_OSPEEDR, GPIOx_PUPDR, GPIOx_AFRL and
GPIOx_AFRH.
The configuration of the locked GPIO pins can no longer be
240/692
This function uses GPIOx_BSRR register to allow atomic

read/modify accesses. In this way, there is no risk of an IRQ
occurring between the read and the modify access.
STM32F09xx
DocID026525 Rev 1
UM1785
18.2.11
18.2.12

modified until the next reset.
STM32F09xx
HAL_GPIO_EXTI_IRQHandler
Function Name
void HAL_GPIO_EXTI_IRQHandler ( uint16_t GPIO_Pin)
This function handles EXTI interrupt request.
Parameters
GPIO_Pin : Specifies the port pin connected to

corresponding EXTI line.
Return values
None.
Notes
None.
HAL_GPIO_EXTI_Callback
Function Name
void HAL_GPIO_EXTI_Callback ( uint16_t GPIO_Pin)
EXTI line detection callbacks.
Parameters
GPIO_Pin : Specifies the port pin connected to

corresponding EXTI line.
Return values
None.
Notes
None.
18.3
GPIO Firmware driver defines
18.3.1
GPIO
GPIO
GPIO Exported Macros
__HAL_GPIO_EXTI_GET_FLAG
Description:
DocID026525 Rev 1
241/692
UM1785
Checks whether the specified EXTI line

flag is set or not.
Parameters:
__EXTI_LINE__: specifies the EXTI line

flag to check. This parameter can be
GPIO_PIN_x where x can be(0..15)
Return value:
__HAL_GPIO_EXTI_CLEAR_FLAG
The: new state of __EXTI_LINE__ (SET or

RESET).
Description:
Clears the EXTI's line pending flags.
Parameters:
__EXTI_LINE__: specifies the EXTI lines

flags to clear. This parameter can be any
combination of GPIO_PIN_x where x can
be (0..15)
Return value:
__HAL_GPIO_EXTI_GET_IT
None:
Description:
Checks whether the specified EXTI line is

asserted or not.
Parameters:
__EXTI_LINE__: specifies the EXTI line to

check. This parameter can be
Return value:
__HAL_GPIO_EXTI_CLEAR_IT
The: new state of __EXTI_LINE__ (SET or

RESET).
Description:
Clears the EXTI's line pending bits.
Parameters:
__EXTI_LINE__: specifies the EXTI lines

to clear. This parameter can be any
combination of GPIO_PIN_x where x can
be (0..15)
Return value:
__HAL_GPIO_EXTI_GENERATE_SWIT
None:
Description:
Generates a Software interrupt on selected

EXTI line.
Parameters:
242/692
DocID026525 Rev 1
UM1785
__EXTI_LINE__: specifies the EXTI line to

check. This parameter can be
Return value:
None:
GPIO mode
GPIO_MODE_INPUT
Input Floating Mode
GPIO_MODE_OUTPUT_PP
Output Push Pull Mode
GPIO_MODE_OUTPUT_OD
Output Open Drain Mode
GPIO_MODE_AF_PP
Alternate Function Push Pull Mode
GPIO_MODE_AF_OD
Alternate Function Open Drain Mode
GPIO_MODE_ANALOG
Analog Mode
GPIO_MODE_IT_RISING
External Interrupt Mode with Rising edge trigger

detection
GPIO_MODE_IT_FALLING
External Interrupt Mode with Falling edge trigger

detection
GPIO_MODE_IT_RISING_FALLING
External Interrupt Mode with Rising/Falling edge

trigger detection
GPIO_MODE_EVT_RISING
External Event Mode with Rising edge trigger

detection
GPIO_MODE_EVT_FALLING
External Event Mode with Falling edge trigger

detection
GPIO_MODE_EVT_RISING_FALLING
External Event Mode with Rising/Falling edge

trigger detection
IS_GPIO_MODE
GPIO pins
GPIO_PIN_0
GPIO_PIN_1
GPIO_PIN_2
GPIO_PIN_3
GPIO_PIN_4
GPIO_PIN_5
GPIO_PIN_6
GPIO_PIN_7
GPIO_PIN_8
GPIO_PIN_9
GPIO_PIN_10
GPIO_PIN_11
GPIO_PIN_12
DocID026525 Rev 1
243/692

GPIO_PIN_13
UM1785
GPIO_PIN_14
GPIO_PIN_15
GPIO_PIN_All
GPIO_PIN_MASK
IS_GPIO_PIN
GPIO pin actions
IS_GPIO_PIN_ACTION
GPIO Private Define
GPIO_MODE
EXTI_MODE
GPIO_MODE_IT
GPIO_MODE_EVT
RISING_EDGE
FALLING_EDGE
GPIO_OUTPUT_TYPE
GPIO_NUMBER
GPIO pull
GPIO_NOPULL
No Pull-up or Pull-down activation
GPIO_PULLUP
Pull-up activation
GPIO_PULLDOWN
Pull-down activation
IS_GPIO_PULL
GPIO speed
GPIO_SPEED_LOW
Low speed
GPIO_SPEED_MEDIUM
Medium speed
GPIO_SPEED_HIGH
High speed
IS_GPIO_SPEED
244/692
DocID026525 Rev 1
UM1785
HAL GPIO Extension Driver
19
19.1
GPIOEx Firmware driver defines
19.1.1
GPIOEx
GPIOEx
GPIOEx Alternate function selection
GPIO_AF0_EVENTOUT
AF0: EVENTOUT Alternate Function mapping
GPIO_AF0_SWDIO
AF0: SWDIO Alternate Function mapping
GPIO_AF0_SWCLK
AF0: SWCLK Alternate Function mapping
GPIO_AF0_MCO
AF0: MCO Alternate Function mapping
GPIO_AF0_CEC
AF0: CEC Alternate Function mapping
GPIO_AF0_CRS
AF0: CRS Alternate Function mapping
GPIO_AF0_IR
AF0: IR Alternate Function mapping
GPIO_AF0_SPI1
AF0: SPI1/I2S1 Alternate Function mapping
GPIO_AF0_SPI2
AF0: SPI2/I2S2 Alternate Function mapping
GPIO_AF0_TIM1
AF0: TIM1 Alternate Function mapping
GPIO_AF0_TIM3
GPIO_AF0_TIM14
GPIO_AF0_TIM15
GPIO_AF0_TIM16
GPIO_AF0_TIM17
GPIO_AF0_TSC
AF0: TSC Alternate Function mapping
GPIO_AF0_USART1
AF0: USART1 Alternate Function mapping
GPIO_AF0_USART2
GPIO_AF0_USART3
GPIO_AF0_USART4
GPIO_AF0_USART8
GPIO_AF0_CAN
AF0: CAN Alternate Function mapping
GPIO_AF1_TIM3
GPIO_AF1_TIM15
GPIO_AF1_USART1
GPIO_AF1_USART2
GPIO_AF1_USART3
GPIO_AF1_USART4
GPIO_AF1_USART5

DocID026525 Rev 1
245/692

GPIO_AF1_USART6
GPIO_AF1_USART7
GPIO_AF1_USART8
GPIO_AF1_IR
AF1: IR Alternate Function mapping
GPIO_AF1_CEC
AF1: CEC Alternate Function mapping
GPIO_AF1_EVENTOUT
GPIO_AF1_I2C1
AF1: I2C1 Alternate Function mapping
GPIO_AF1_I2C2
GPIO_AF1_TSC
GPIO_AF1_SPI1
AF1: SPI1 Alternate Function mapping
GPIO_AF1_SPI2
GPIO_AF2_TIM1
GPIO_AF2_TIM2
GPIO_AF2_TIM16
GPIO_AF2_TIM17
GPIO_AF2_EVENTOUT
GPIO_AF2_USART5
GPIO_AF2_USART6
GPIO_AF2_USART7
GPIO_AF2_USART8
GPIO_AF3_EVENTOUT
GPIO_AF3_TSC
GPIO_AF3_TIM15
GPIO_AF3_I2C1
GPIO_AF4_TIM14
GPIO_AF4_USART4
GPIO_AF4_USART3
GPIO_AF4_CRS
AF4: CRS Alternate Function mapping
GPIO_AF4_CAN
AF4: CAN Alternate Function mapping
GPIO_AF4_I2C1
GPIO_AF4_USART5
GPIO_AF5_TIM15
GPIO_AF5_TIM16
GPIO_AF5_TIM17
GPIO_AF5_SPI2
GPIO_AF5_I2C2
246/692
UM1785
DocID026525 Rev 1
UM1785
GPIO_AF5_MCO

AF5: MCO Alternate Function mapping
GPIO_AF5_USART6
GPIO_AF6_EVENTOUT
GPIO_AF7_COMP1
AF7: COMP1 Alternate Function mapping
GPIO_AF7_COMP2
AF7: COMP2 Alternate Function mapping
IS_GPIO_AF
GPIOEx_Get Port Index
GET_GPIO_INDEX
DocID026525 Rev 1
247/692
HAL I2C Generic Driver
UM1785
20
20.1
I2C Firmware driver registers structures
20.1.1
I2C_InitTypeDef
I2C_InitTypeDef is defined in the stm32f0xx_hal_i2c.h
Data Fields
uint32_t Timing
uint32_t OwnAddress1
uint32_t AddressingMode
uint32_t DualAddressMode
uint32_t OwnAddress2Masks
uint32_t GeneralCallMode
uint32_t NoStretchMode
Field Documentation
20.1.2
uint32_t I2C_InitTypeDef::Timing Specifies the I2C_TIMINGR_register value. This

parameter calculated by referring to I2C initialization section in Reference manual
uint32_t I2C_InitTypeDef::OwnAddress1 Specifies the first device own address.
This parameter can be a 7-bit or 10-bit address.
uint32_t I2C_InitTypeDef::AddressingMode Specifies if 7-bit or 10-bit addressing
mode is selected. This parameter can be a value of I2C_addressing_mode
uint32_t I2C_InitTypeDef::DualAddressMode Specifies if dual addressing mode is
selected. This parameter can be a value of I2C_dual_addressing_mode
uint32_t I2C_InitTypeDef::OwnAddress2 Specifies the second device own address
if dual addressing mode is selected This parameter can be a 7-bit address.
uint32_t I2C_InitTypeDef::OwnAddress2Masks Specifies the acknoledge mask
address second device own address if dual addressing mode is selected This
parameter can be a value of I2C_own_address2_masks.
uint32_t I2C_InitTypeDef::GeneralCallMode Specifies if general call mode is
selected. This parameter can be a value of I2C_general_call_addressing_mode.
uint32_t I2C_InitTypeDef::NoStretchMode Specifies if nostretch mode is selected.
This parameter can be a value of I2C_nostretch_mode
I2C_HandleTypeDef
I2C_HandleTypeDef is defined in the stm32f0xx_hal_i2c.h
Data Fields
248/692
I2C_TypeDef * Instance
I2C_InitTypeDef Init
uint8_t * pBuffPtr
uint16_t XferSize
__IO uint16_t XferCount
DMA_HandleTypeDef * hdmatx
DMA_HandleTypeDef * hdmarx
DocID026525 Rev 1
UM1785
__IO HAL_I2C_StateTypeDef State
__IO HAL_I2C_ErrorTypeDef ErrorCode
Field Documentation
20.2
I2C_TypeDef* I2C_HandleTypeDef::Instance I2C registers base address

I2C_InitTypeDef I2C_HandleTypeDef::Init I2C communication parameters
uint8_t* I2C_HandleTypeDef::pBuffPtr Pointer to I2C transfer buffer
uint16_t I2C_HandleTypeDef::XferSize I2C transfer size
__IO uint16_t I2C_HandleTypeDef::XferCount I2C transfer counter
DMA_HandleTypeDef* I2C_HandleTypeDef::hdmatx I2C Tx DMA handle
parameters
DMA_HandleTypeDef* I2C_HandleTypeDef::hdmarx I2C Rx DMA handle
parameters
HAL_LockTypeDef I2C_HandleTypeDef::Lock I2C locking object
__IO HAL_I2C_StateTypeDef I2C_HandleTypeDef::State I2C communication state
__IO HAL_I2C_ErrorTypeDef I2C_HandleTypeDef::ErrorCode
I2C Firmware driver API description

The following section lists the various functions of the I2C library.
20.2.1

The I2C HAL driver can be used as follows:
1.
2.
3.
4.
Declare a I2C_HandleTypeDef handle structure, for example: I2C_HandleTypeDef

hi2c;
Initialize the I2C low level resources by implement the HAL_I2C_MspInit ()API:
Enable the I2Cx interface clock
I2C pins configuration
Enable the clock for the I2C GPIOs
Configure I2C pins as alternate function open-drain
Configure the I2Cx interrupt priority
Enable the NVIC I2C IRQ Channel
DMA Configuration if you need to use DMA process
Declare a DMA_HandleTypeDef handle structure for the transmit or receive

channel
Enable the DMAx interface clock using
Configure the DMA handle parameters
Configure the DMA Tx or Rx channel
Associate the initilalized DMA handle to the hi2c DMA Tx or Rx handle
Configure the priority and enable the NVIC for the transfer complete
interrupt on the DMA Tx or Rx channel
Configure the Communication Clock Timing, Own Address1, Master Adressing Mode,
Dual Addressing mode, Own Address2, Own Address2 Mask, General call and
Nostretch mode in the hi2c Init structure.
Initialize the I2C registers by calling the HAL_I2C_Init() API:
DocID026525 Rev 1
249/692
UM1785
5.
6.
These API s configures also the low level Hardware GPIO, CLOCK,
CORTEX...etc) by calling the customed HAL_I2C_MspInit(&hi2c) API.
To check if target device is ready for communication, use the function
HAL_I2C_IsDeviceReady()
For I2C IO and IO MEM operations, three modes of operations are available within
this driver :
Transmit in master mode an amount of data in blocking mode using

HAL_I2C_Master_Transmit()
Receive in master mode an amount of data in blocking mode using
HAL_I2C_Master_Receive()
Transmit in slave mode an amount of data in blocking mode using
HAL_I2C_Slave_Transmit()
Receive in slave mode an amount of data in blocking mode using
HAL_I2C_Slave_Receive()
Polling mode IO MEM operation
Write an amount of data in blocking mode to a specific memory address using

HAL_I2C_Mem_Write()
Read an amount of data in blocking mode from a specific memory address using
HAL_I2C_Mem_Read()
250/692
Transmit in master mode an amount of data in non blocking mode using

HAL_I2C_Master_Transmit_IT()
At transmission end of transfer HAL_I2C_MasterTxCpltCallback is executed and user
can add his own code by customization of function pointer
HAL_I2C_MasterTxCpltCallback
Receive in master mode an amount of data in non blocking mode using
HAL_I2C_Master_Receive_IT()
At reception end of transfer HAL_I2C_MasterRxCpltCallback is executed and user
HAL_I2C_MasterRxCpltCallback
Transmit in slave mode an amount of data in non blocking mode using
HAL_I2C_Slave_Transmit_IT()
At transmission end of transfer HAL_I2C_SlaveTxCpltCallback is executed and user
HAL_I2C_SlaveTxCpltCallback
Receive in slave mode an amount of data in non blocking mode using
HAL_I2C_Slave_Receive_IT()
At reception end of transfer HAL_I2C_SlaveRxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_I2C_SlaveRxCpltCallback
In case of transfer Error, HAL_I2C_ErrorCallback() function is executed and user can
add his own code by customization of function pointer HAL_I2C_ErrorCallback
DocID026525 Rev 1
UM1785
Interrupt mode IO MEM operation
Write an amount of data in no-blocking mode with Interrupt to a specific memory

address using HAL_I2C_Mem_Write_IT()
At MEM end of write transfer HAL_I2C_MemTxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_I2C_MemTxCpltCallback
Read an amount of data in no-blocking mode with Interrupt from a specific memory
address using HAL_I2C_Mem_Read_IT()
At MEM end of read transfer HAL_I2C_MemRxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_I2C_MemRxCpltCallback
Transmit in master mode an amount of data in non blocking mode (DMA) using
HAL_I2C_Master_Transmit_DMA()
At transmission end of transfer HAL_I2C_MasterTxCpltCallback is executed and user
Receive in master mode an amount of data in non blocking mode (DMA) using
HAL_I2C_Master_Receive_DMA()
At reception end of transfer HAL_I2C_MasterRxCpltCallback is executed and user
Transmit in slave mode an amount of data in non blocking mode (DMA) using
HAL_I2C_Slave_Transmit_DMA()
At transmission end of transfer HAL_I2C_SlaveTxCpltCallback is executed and user
Receive in slave mode an amount of data in non blocking mode (DMA) using
HAL_I2C_Slave_Receive_DMA()
At reception end of transfer HAL_I2C_SlaveRxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_I2C_SlaveRxCpltCallback
DMA mode IO MEM operation
Write an amount of data in no-blocking mode with DMA to a specific memory address
using HAL_I2C_Mem_Write_DMA()
At MEM end of write transfer HAL_I2C_MemTxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_I2C_MemTxCpltCallback
Read an amount of data in no-blocking mode with DMA from a specific memory
address using HAL_I2C_Mem_Read_DMA()
At MEM end of read transfer HAL_I2C_MemRxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_I2C_MemRxCpltCallback
DocID026525 Rev 1
251/692
UM1785
I2C HAL driver macros list

Below the list of most used macros in I2C HAL driver.
__HAL_I2C_ENABLE: Enable the I2C peripheral

__HAL_I2C_DISABLE: Disable the I2C peripheral
__HAL_I2C_GET_FLAG : Checks whether the specified I2C flag is set or not
__HAL_I2C_CLEAR_FLAG : Clears the specified I2C pending flag
__HAL_I2C_ENABLE_IT: Enables the specified I2C interrupt
__HAL_I2C_DISABLE_IT: Disables the specified I2C interrupt
You can refer to the I2C HAL driver header file for more useful macros
20.2.2

This subsection provides a set of functions allowing to initialize and de-initialiaze the I2Cx
peripheral:
20.2.3
User must Implement HAL_I2C_MspInit() function in which he configures all related

peripherals resources (CLOCK, GPIO, DMA, IT and NVIC ).
Call the function HAL_I2C_Init() to configure the selected device with the selected
configuration:
Clock Timing
Own Address 1
Addressing mode (Master, Slave)
Dual Addressing mode
Own Address 2
Own Address 2 Mask
General call mode
Nostretch mode
Call the function HAL_I2C_DeInit() to restore the default configuration of the selected
I2Cx periperal.
HAL_I2C_Init()
HAL_I2C_DeInit()
HAL_I2C_MspInit()
HAL_I2C_MspDeInit()
This subsection provides a set of functions allowing to manage the I2C data transfers.
1.
2.
252/692
There is two mode of transfer:
Blocking mode : The communication is performed in the polling mode. The

status of all data processing is returned by the same function after finishing
transfer.
No-Blocking mode : The communication is performed using Interrupts or DMA.

These functions return the status of the transfer startup. The end of the data
processing will be indicated through the dedicated I2C IRQ when using Interrupt
mode or the DMA IRQ when using DMA mode.
Blocking mode functions are :
DocID026525 Rev 1
UM1785
3.
4.
5.
HAL_I2C_Mem_Write()
HAL_I2C_Mem_Read()
No-Blocking mode functions with Interrupt are :
HAL_I2C_Mem_Write_IT()
HAL_I2C_Mem_Read_IT()
No-Blocking mode functions with DMA are :
HAL_I2C_Mem_Write_DMA()
HAL_I2C_Mem_Read_DMA()
A set of Transfer Complete Callbacks are provided in No_Blocking mode:
HAL_I2C_MemTxCpltCallback()
HAL_I2C_MemRxCpltCallback()
HAL_I2C_MasterTxCpltCallback()
HAL_I2C_MasterRxCpltCallback()
HAL_I2C_SlaveTxCpltCallback()
HAL_I2C_SlaveRxCpltCallback()
HAL_I2C_ErrorCallback()
HAL_I2C_Mem_Write()
HAL_I2C_Mem_Read()
HAL_I2C_Mem_Write_IT()
HAL_I2C_Mem_Read_IT()
HAL_I2C_Mem_Write_DMA()
HAL_I2C_Mem_Read_DMA()
HAL_I2C_EV_IRQHandler()
HAL_I2C_ER_IRQHandler()
HAL_I2C_MasterTxCpltCallback()
HAL_I2C_MasterRxCpltCallback()
HAL_I2C_SlaveTxCpltCallback()
DocID026525 Rev 1
253/692
20.2.4
UM1785
HAL_I2C_SlaveRxCpltCallback()
HAL_I2C_MemTxCpltCallback()
HAL_I2C_MemRxCpltCallback()
HAL_I2C_ErrorCallback()

20.2.5
20.2.6
20.2.7
254/692
HAL_I2C_GetState()
HAL_I2C_GetError()
HAL_I2C_Init
Function Name
HAL_StatusTypeDef HAL_I2C_Init ( I2C_HandleTypeDef *

hi2c)
Initializes the I2C according to the specified parameters in the

I2C_InitTypeDef and create the associated handle.
Parameters
hi2c : : Pointer to a I2C_HandleTypeDef structure that

contains the configuration information for the specified I2C.
Return values
HAL status
Notes
None.
HAL_I2C_DeInit
Function Name
HAL_StatusTypeDef HAL_I2C_DeInit ( I2C_HandleTypeDef *

hi2c)
DeInitializes the I2C peripheral.
Parameters

Return values
HAL status
Notes
None.
HAL_I2C_MspInit
DocID026525 Rev 1
UM1785
20.2.8
20.2.9

Function Name
void HAL_I2C_MspInit ( I2C_HandleTypeDef * hi2c)
I2C MSP Init.
Parameters

Return values
None.
Notes
None.
HAL_I2C_MspDeInit
Function Name
void HAL_I2C_MspDeInit ( I2C_HandleTypeDef * hi2c)
I2C MSP DeInit.
Parameters

Return values
None.
Notes
None.
HAL_I2C_Master_Transmit
Function Name
HAL_StatusTypeDef HAL_I2C_Master_Transmit (
I2C_HandleTypeDef * hi2c, uint16_t DevAddress, uint8_t *
pData, uint16_t Size, uint32_t Timeout)
Transmits in master mode an amount of data in blocking mode.
Parameters

DevAddress : Target device address
pData : Pointer to data buffer
Size : Amount of data to be sent
Timeout : Timeout duration
Return values
HAL status
Notes
None.
DocID026525 Rev 1
255/692
20.2.10
20.2.11
20.2.12
256/692
UM1785
HAL_I2C_Master_Receive
Function Name
HAL_StatusTypeDef HAL_I2C_Master_Receive (
pData, uint16_t Size, uint32_t Timeout)
Receives in master mode an amount of data in blocking mode.
Parameters

Return values
HAL status
Notes
None.
HAL_I2C_Slave_Transmit
Function Name
HAL_StatusTypeDef HAL_I2C_Slave_Transmit (
I2C_HandleTypeDef * hi2c, uint8_t * pData, uint16_t Size,
uint32_t Timeout)
Transmits in slave mode an amount of data in blocking mode.
Parameters

Return values
HAL status
Notes
None.
HAL_I2C_Slave_Receive
DocID026525 Rev 1
UM1785
20.2.13
20.2.14
Function Name

HAL_StatusTypeDef HAL_I2C_Slave_Receive (
I2C_HandleTypeDef * hi2c, uint8_t * pData, uint16_t Size,
uint32_t Timeout)
Receive in slave mode an amount of data in blocking mode.
Parameters

Return values
HAL status
Notes
None.
HAL_I2C_Master_Transmit_IT
Function Name
HAL_StatusTypeDef HAL_I2C_Master_Transmit_IT (
pData, uint16_t Size)
Transmit in master mode an amount of data in no-blocking mode

with Interrupt.
Parameters

Return values
HAL status
Notes
None.
HAL_I2C_Master_Receive_IT
Function Name
HAL_StatusTypeDef HAL_I2C_Master_Receive_IT (
Receive in master mode an amount of data in no-blocking mode

with Interrupt.
Parameters

DocID026525 Rev 1
257/692
20.2.15
20.2.16
258/692
UM1785
Return values
HAL status
Notes
None.
HAL_I2C_Slave_Transmit_IT
Function Name
HAL_StatusTypeDef HAL_I2C_Slave_Transmit_IT (
I2C_HandleTypeDef * hi2c, uint8_t * pData, uint16_t Size)
Transmit in slave mode an amount of data in no-blocking mode

with Interrupt.
Parameters

Return values
HAL status
Notes
None.
HAL_I2C_Slave_Receive_IT
Function Name
HAL_StatusTypeDef HAL_I2C_Slave_Receive_IT (
Receive in slave mode an amount of data in no-blocking mode

with Interrupt.
Parameters

Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
20.2.17
20.2.18
20.2.19
HAL_I2C_Master_Transmit_DMA
Function Name
HAL_StatusTypeDef HAL_I2C_Master_Transmit_DMA (
Transmit in master mode an amount of data in no-blocking mode

with DMA.
Parameters

Return values
HAL status
Notes
None.
HAL_I2C_Master_Receive_DMA
Function Name
HAL_StatusTypeDef HAL_I2C_Master_Receive_DMA (
Receive in master mode an amount of data in no-blocking mode

with DMA.
Parameters

Return values
HAL status
Notes
None.
HAL_I2C_Slave_Transmit_DMA
DocID026525 Rev 1
259/692

Function Name
20.2.20
20.2.21
UM1785
HAL_StatusTypeDef HAL_I2C_Slave_Transmit_DMA (
Transmit in slave mode an amount of data in no-blocking mode

with DMA.
Parameters

Return values
HAL status
Notes
None.
HAL_I2C_Slave_Receive_DMA
Function Name
HAL_StatusTypeDef HAL_I2C_Slave_Receive_DMA (
Receive in slave mode an amount of data in no-blocking mode

with DMA.
Parameters

Return values
HAL status
Notes
None.
HAL_I2C_Mem_Write
Function Name
HAL_StatusTypeDef HAL_I2C_Mem_Write (
I2C_HandleTypeDef * hi2c, uint16_t DevAddress, uint16_t
MemAddress, uint16_t MemAddSize, uint8_t * pData, uint16_t
Size, uint32_t Timeout)
Write an amount of data in blocking mode to a specific memory

address.
Parameters
260/692

DocID026525 Rev 1
UM1785
20.2.22
20.2.23
MemAddress : Internal memory address

MemAddSize : Size of internal memory address
Return values
HAL status
Notes
None.
HAL_I2C_Mem_Read
Function Name
HAL_StatusTypeDef HAL_I2C_Mem_Read (
Read an amount of data in blocking mode from a specific memory

address.
Parameters

Return values
HAL status
Notes
None.
HAL_I2C_Mem_Write_IT
Function Name
HAL_StatusTypeDef HAL_I2C_Mem_Write_IT (
Size)
Write an amount of data in no-blocking mode with Interrupt to a

specific memory address.
Parameters

DocID026525 Rev 1
261/692
20.2.24
20.2.25
262/692
UM1785
Return values
HAL status
Notes
None.
HAL_I2C_Mem_Read_IT
Function Name
HAL_StatusTypeDef HAL_I2C_Mem_Read_IT (
Size)
Read an amount of data in no-blocking mode with Interrupt from a

Parameters

Return values
HAL status
Notes
None.
HAL_I2C_Mem_Write_DMA
Function Name
HAL_StatusTypeDef HAL_I2C_Mem_Write_DMA (
Size)
Write an amount of data in no-blocking mode with DMA to a

Parameters

DocID026525 Rev 1
UM1785
20.2.26
20.2.27

Return values
HAL status
Notes
None.
HAL_I2C_Mem_Read_DMA
Function Name
HAL_StatusTypeDef HAL_I2C_Mem_Read_DMA (
Size)
Reads an amount of data in no-blocking mode with DMA from a

Parameters

Size : Amount of data to be read
Return values
HAL status
Notes
None.
HAL_I2C_IsDeviceReady
Function Name
HAL_StatusTypeDef HAL_I2C_IsDeviceReady (
Trials, uint32_t Timeout)
Checks if target device is ready for communication.
Parameters

DocID026525 Rev 1
263/692
20.2.28
20.2.29
20.2.30
Trials : Number of trials

Return values
HAL status
Notes
This function is used with Memory devices
HAL_I2C_EV_IRQHandler
Function Name
void HAL_I2C_EV_IRQHandler ( I2C_HandleTypeDef * hi2c)
This function handles I2C event interrupt request.
Parameters

Return values
None.
Notes
None.
HAL_I2C_ER_IRQHandler
Function Name
void HAL_I2C_ER_IRQHandler ( I2C_HandleTypeDef * hi2c)
This function handles I2C error interrupt request.
Parameters

Return values
None.
Notes
None.
Function Name
264/692
UM1785
void HAL_I2C_MasterTxCpltCallback ( I2C_HandleTypeDef *

hi2c)
DocID026525 Rev 1
UM1785
20.2.31
20.2.32
20.2.33

Master Tx Transfer completed callbacks.
Parameters

Return values
None.
Notes
None.
Function Name
void HAL_I2C_MasterRxCpltCallback ( I2C_HandleTypeDef *

hi2c)
Master Rx Transfer completed callbacks.
Parameters

Return values
None.
Notes
None.
Function Name
void HAL_I2C_SlaveTxCpltCallback ( I2C_HandleTypeDef *

hi2c)
Slave Tx Transfer completed callbacks.
Parameters

Return values
None.
Notes
None.
HAL_I2C_SlaveRxCpltCallback
DocID026525 Rev 1
265/692

Function Name
20.2.34
20.2.35
266/692
UM1785
void HAL_I2C_SlaveRxCpltCallback ( I2C_HandleTypeDef *
hi2c)
Slave Rx Transfer completed callbacks.
Parameters

Return values
None.
Notes
None.
HAL_I2C_MemTxCpltCallback
Function Name
void HAL_I2C_MemTxCpltCallback ( I2C_HandleTypeDef *

hi2c)
Memory Tx Transfer completed callbacks.
Parameters

Return values
None.
Notes
None.
HAL_I2C_MemRxCpltCallback
Function Name
void HAL_I2C_MemRxCpltCallback ( I2C_HandleTypeDef *

hi2c)
Memory Rx Transfer completed callbacks.
Parameters

Return values
None.
Notes
None.
DocID026525 Rev 1
UM1785
20.2.36
20.2.37
20.2.38
HAL_I2C_ErrorCallback
Function Name
void HAL_I2C_ErrorCallback ( I2C_HandleTypeDef * hi2c)
I2C error callbacks.
Parameters

Return values
None.
Notes
None.
HAL_I2C_GetState
Function Name
HAL_I2C_StateTypeDef HAL_I2C_GetState (
I2C_HandleTypeDef * hi2c)
Returns the I2C state.
Parameters
hi2c : : I2C handle
Return values
HAL state
Notes
None.
HAL_I2C_GetError
Function Name
uint32_t HAL_I2C_GetError ( I2C_HandleTypeDef * hi2c)
Return the I2C error code.
Parameters
hi2c : : pointer to a I2C_HandleTypeDef structure that

Return values
I2C Error Code
Notes
None.
DocID026525 Rev 1
267/692
UM1785
20.3
I2C Firmware driver defines
20.3.1
I2C
I2C
I2C addressing mode
I2C_ADDRESSINGMODE_7BIT
I2C_ADDRESSINGMODE_10BIT
IS_I2C_ADDRESSING_MODE
I2C dual addressing mode
I2C_DUALADDRESS_DISABLED
I2C_DUALADDRESS_ENABLED
IS_I2C_DUAL_ADDRESS
I2C Exported Macros
__HAL_I2C_RESET_HANDLE_STATE
Description:
Reset I2C handle state.
Parameters:
__HANDLE__: I2C handle.
Return value:
__HAL_I2C_ENABLE_IT
None:
Description:
Enables or disables the specified I2C

interrupts.
Parameters:
__HANDLE__: specifies the I2C Handle.

This parameter can be I2Cx where x: 1 or 2
to select the I2C peripheral.
__INTERRUPT__: specifies the interrupt
source to enable or disable. This parameter
I2C_IT_ERRI: Errors interrupt enable
I2C_IT_TCI: Transfer complete

interrupt enable
I2C_IT_STOPI: STOP detection

interrupt enable
I2C_IT_NACKI: NACK received

interrupt enable
I2C_IT_ADDRI: Address match

interrupt enable
I2C_IT_RXI: RX interrupt enable
I2C_IT_TXI: TX interrupt enable
Return value:
268/692
None:
DocID026525 Rev 1
UM1785

__HAL_I2C_DISABLE_IT
__HAL_I2C_GET_IT_SOURCE
Description:
Checks if the specified I2C interrupt source

Parameters:

__INTERRUPT__: specifies the I2C
I2C_IT_ERRI: Errors interrupt enable
I2C_IT_TCI: Transfer complete

interrupt enable
I2C_IT_STOPI: STOP detection

interrupt enable
I2C_IT_NACKI: NACK received

interrupt enable
I2C_IT_ADDRI: Address match

interrupt enable
I2C_IT_RXI: RX interrupt enable
I2C_IT_TXI: TX interrupt enable
Return value:
__HAL_I2C_GET_FLAG
The: new state of __IT__ (TRUE or FALSE).
Description:
Checks whether the specified I2C flag is set

or not.
Parameters:

__FLAG__: specifies the flag to check. This
parameter can be one of the following
values:
I2C_FLAG_TXE: Transmit data register

empty
I2C_FLAG_TXIS: Transmit interrupt

status
I2C_FLAG_RXNE: Receive data

register not empty
I2C_FLAG_ADDR: Address matched

(slave mode)
I2C_FLAG_AF: Acknowledge failure

received flag
I2C_FLAG_STOPF: STOP detection

flag
I2C_FLAG_TC: Transfer complete

(master mode)
I2C_FLAG_TCR: Transfer complete
DocID026525 Rev 1
269/692
UM1785
reload
I2C_FLAG_BERR: Bus error
I2C_FLAG_ARLO: Arbitration lost
I2C_FLAG_OVR: Overrun/Underrun
I2C_FLAG_PECERR: PEC error in
reception
I2C_FLAG_TIMEOUT: Timeout or Tlow
detection flag
I2C_FLAG_ALERT: SMBus alert
I2C_FLAG_BUSY: Bus busy
I2C_FLAG_DIR: Transfer direction
(slave mode)
Return value:

FALSE).
Description:
__HAL_I2C_CLEAR_FLAG
Clears the I2C pending flags which are

cleared by writing 1 in a specific bit.
Parameters:

__FLAG__: specifies the flag to clear. This
following values:
I2C_FLAG_ADDR: Address matched

(slave mode)
I2C_FLAG_AF: Acknowledge failure

flag
I2C_FLAG_STOPF: STOP detection

flag
I2C_FLAG_BERR: Bus error
I2C_FLAG_ARLO: Arbitration lost
I2C_FLAG_OVR: Overrun/Underrun
I2C_FLAG_PECERR: PEC error in

reception
I2C_FLAG_TIMEOUT: Timeout or Tlow

detection flag
I2C_FLAG_ALERT: SMBus alert
Return value:
None:
__HAL_I2C_ENABLE
__HAL_I2C_DISABLE
__HAL_I2C_RESET_CR2
__HAL_I2C_MEM_ADD_MSB
__HAL_I2C_MEM_ADD_LSB
270/692
DocID026525 Rev 1
UM1785

__HAL_I2C_GENERATE_START
IS_I2C_OWN_ADDRESS1
IS_I2C_OWN_ADDRESS2
I2C Flag definition
I2C_FLAG_TXE
I2C_FLAG_TXIS
I2C_FLAG_RXNE
I2C_FLAG_ADDR
I2C_FLAG_AF
I2C_FLAG_STOPF
I2C_FLAG_TC
I2C_FLAG_TCR
I2C_FLAG_BERR
I2C_FLAG_ARLO
I2C_FLAG_OVR
I2C_FLAG_PECERR
I2C_FLAG_TIMEOUT
I2C_FLAG_ALERT
I2C_FLAG_BUSY
I2C_FLAG_DIR
I2C general call addressing mode
I2C_GENERALCALL_DISABLED
I2C_GENERALCALL_ENABLED
IS_I2C_GENERAL_CALL
I2C Interrupt configuration definition
I2C_IT_ERRI
I2C_IT_TCI
I2C_IT_STOPI
I2C_IT_NACKI
I2C_IT_ADDRI
I2C_IT_RXI
I2C_IT_TXI
I2C Memory Address Size
I2C_MEMADD_SIZE_8BIT
I2C_MEMADD_SIZE_16BIT
IS_I2C_MEMADD_SIZE
I2C nostretch mode
DocID026525 Rev 1
271/692

I2C_NOSTRETCH_DISABLED
I2C_NOSTRETCH_ENABLED
IS_I2C_NO_STRETCH
I2C own address2 masks
I2C_OA2_NOMASK
I2C_OA2_MASK01
I2C_OA2_MASK02
I2C_OA2_MASK03
I2C_OA2_MASK04
I2C_OA2_MASK05
I2C_OA2_MASK06
I2C_OA2_MASK07
IS_I2C_OWN_ADDRESS2_MASK
I2C Private Define
TIMING_CLEAR_MASK
I2C_TIMEOUT_ADDR
I2C_TIMEOUT_BUSY
I2C_TIMEOUT_DIR
I2C_TIMEOUT_RXNE
I2C_TIMEOUT_STOPF
I2C_TIMEOUT_TC
I2C_TIMEOUT_TCR
I2C_TIMEOUT_TXIS
I2C_TIMEOUT_FLAG
I2C ReloadEndMode definition
I2C_RELOAD_MODE
I2C_AUTOEND_MODE
I2C_SOFTEND_MODE
IS_TRANSFER_MODE
I2C StartStopMode definition
I2C_NO_STARTSTOP
I2C_GENERATE_STOP
I2C_GENERATE_START_READ
I2C_GENERATE_START_WRITE
IS_TRANSFER_REQUEST
272/692
DocID026525 Rev 1
UM1785
UM1785
HAL I2C Extension Driver
21
21.1
I2CEx Firmware driver API description

The following section lists the various functions of the I2CEx library.
21.1.1
I2C peripheral extension features

Comparing to other previous devices, the I2C interface for STM32F0XX devices contains
the following additional features
21.1.2
Possibility to disable or enable Analog Noise Filter

Use of a configured Digital Noise Filter
Disable or enable wakeup from Stop mode

This driver provides functions to configure Noise Filter
1.
2.
3.
21.1.3
Configure I2C Analog noise filter using the function

HAL_I2CEx_AnalogFilter_Config()
Configure I2C Digital noise filter using the function HAL_I2CEx_DigitalFilter_Config()
Configure the enabling or disabling of I2C Wake Up Mode using the functions :
HAL_I2CEx_EnableWakeUp()
HAL_I2CEx_DisableWakeUp()
Extension features functions

21.1.4
Configure Noise Filters

HAL_I2CEx_AnalogFilter_Config()
HAL_I2CEx_DigitalFilter_Config()
HAL_I2CEx_EnableWakeUp()
HAL_I2CEx_DisableWakeUp()
HAL_I2CEx_AnalogFilter_Config
Function Name
HAL_StatusTypeDef HAL_I2CEx_AnalogFilter_Config (
I2C_HandleTypeDef * hi2c, uint32_t AnalogFilter)
Configures I2C Analog noise filter.
Parameters
Return values

contains the configuration information for the specified I2Cx
peripheral.
AnalogFilter : : new state of the Analog filter.
HAL status
DocID026525 Rev 1
273/692

Notes
21.1.5
UM1785
HAL_I2CEx_DigitalFilter_Config
Function Name
HAL_StatusTypeDef HAL_I2CEx_DigitalFilter_Config (
I2C_HandleTypeDef * hi2c, uint32_t DigitalFilter)
Configures I2C Digital noise filter.
Parameters
21.1.6
21.1.7

peripheral.
DigitalFilter : : Coefficient of digital noise filter between 0x00
and 0x0F.
Return values
HAL status
Notes
None.
HAL_I2CEx_EnableWakeUp
Function Name
HAL_StatusTypeDef HAL_I2CEx_EnableWakeUp (
Enables I2C wakeup from stop mode.
Parameters

peripheral.
Return values
HAL status
Notes
None.
HAL_I2CEx_DisableWakeUp
Function Name
274/692
None.
HAL_StatusTypeDef HAL_I2CEx_DisableWakeUp (
DocID026525 Rev 1
UM1785

Disables I2C wakeup from stop mode.
Parameters

peripheral.
Return values
HAL status
Notes
None.
21.2
I2CEx Firmware driver defines
21.2.1
I2CEx
I2CEx
I2CEx Analog Filter
I2C_ANALOGFILTER_ENABLED
I2C_ANALOGFILTER_DISABLED
IS_I2C_ANALOG_FILTER
I2CEx Digital Filter
IS_I2C_DIGITAL_FILTER
DocID026525 Rev 1
275/692
HAL I2S Generic Driver
UM1785
22
22.1
I2S Firmware driver registers structures
22.1.1
I2S_InitTypeDef
I2S_InitTypeDef is defined in the stm32f0xx_hal_i2s.h
Data Fields
uint32_t Mode
uint32_t Standard
uint32_t DataFormat
uint32_t MCLKOutput
uint32_t AudioFreq
uint32_t CPOL
Field Documentation
22.1.2
uint32_t I2S_InitTypeDef::Mode Specifies the I2S operating mode. This parameter

can be a value of I2S_Mode
uint32_t I2S_InitTypeDef::Standard Specifies the standard used for the I2S
communication. This parameter can be a value of I2S_Standard
uint32_t I2S_InitTypeDef::DataFormat Specifies the data format for the I2S
communication. This parameter can be a value of I2S_Data_Format
uint32_t I2S_InitTypeDef::MCLKOutput Specifies whether the I2S MCLK output is
enabled or not. This parameter can be a value of I2S_MCLK_Output
uint32_t I2S_InitTypeDef::AudioFreq Specifies the frequency selected for the I2S
communication. This parameter can be a value of I2S_Audio_Frequency
uint32_t I2S_InitTypeDef::CPOL Specifies the idle state of the I2S clock. This
parameter can be a value of I2S_Clock_Polarity
I2S_HandleTypeDef
I2S_HandleTypeDef is defined in the stm32f0xx_hal_i2s.h
Data Fields
276/692
SPI_TypeDef * Instance
I2S_InitTypeDef Init
__IO uint16_t TxXferSize
__IO uint16_t TxXferCount
__IO uint16_t RxXferSize
__IO uint16_t RxXferCount
__IO HAL_LockTypeDef Lock
__IO HAL_I2S_StateTypeDef State
__IO HAL_I2S_ErrorTypeDef ErrorCode
DocID026525 Rev 1
UM1785

Field Documentation
22.2
SPI_TypeDef* I2S_HandleTypeDef::Instance
I2S_InitTypeDef I2S_HandleTypeDef::Init
uint16_t* I2S_HandleTypeDef::pTxBuffPtr
__IO uint16_t I2S_HandleTypeDef::TxXferSize
__IO uint16_t I2S_HandleTypeDef::TxXferCount
uint16_t* I2S_HandleTypeDef::pRxBuffPtr
__IO uint16_t I2S_HandleTypeDef::RxXferSize
__IO uint16_t I2S_HandleTypeDef::RxXferCount
DMA_HandleTypeDef* I2S_HandleTypeDef::hdmatx
DMA_HandleTypeDef* I2S_HandleTypeDef::hdmarx
__IO HAL_LockTypeDef I2S_HandleTypeDef::Lock
__IO HAL_I2S_StateTypeDef I2S_HandleTypeDef::State
__IO HAL_I2S_ErrorTypeDef I2S_HandleTypeDef::ErrorCode
I2S Firmware driver API description

The following section lists the various functions of the I2S library.
22.2.1

The I2S HAL driver can be used as follow:
1.
2.
3.
Declare a I2S_HandleTypeDef handle structure.

Initialize the I2S low level resources by implement the HAL_I2S_MspInit() API:
a.
Enable the SPIx interface clock.
b.
I2S pins configuration:
Enable the clock for the I2S GPIOs.
Configure these I2S pins as alternate function pull-up.

c.
NVIC configuration if you need to use interrupt process (HAL_I2S_Transmit_IT()
and HAL_I2S_Receive_IT() APIs).
Configure the I2Sx interrupt priority.
Enable the NVIC I2S IRQ handle.

d.
DMA Configuration if you need to use DMA process (HAL_I2S_Transmit_DMA()
and HAL_I2S_Receive_DMA() APIs:
Declare a DMA handle structure for the Tx/Rx Channel.
Enable the DMAx interface clock.
Configure the declared DMA handle structure with the required Tx/Rx
parameters.
Configure the DMA Tx/Rx Channel.
Associate the initilalized DMA handle to the I2S DMA Tx/Rx handle.
interrupt on the DMA Tx/Rx Channel.
Program the Mode, Standard, Data Format, MCLK Output, Audio frequency and
Polarity using HAL_I2S_Init() function. The specific I2S interrupts (Transmission
complete interrupt, RXNE interrupt and Error Interrupts) will be managed using the
macros __HAL_I2S_ENABLE_IT() and __HAL_I2S_DISABLE_IT() inside the transmit
and receive process. Make sure that either: External clock source is configured after
setting correctly the define constant EXTERNAL_CLOCK_VALUE in the
stm32f0xx_hal_conf.h file.
DocID026525 Rev 1
277/692

4.
Three mode of operations are available within this driver :
UM1785
Send an amount of data in blocking mode using HAL_I2S_Transmit()

Receive an amount of data in blocking mode using HAL_I2S_Receive()
Send an amount of data in non blocking mode using HAL_I2S_Transmit_IT()

At transmission end of half transfer HAL_I2S_TxHalfCpltCallback is executed and
HAL_I2S_TxHalfCpltCallback
At transmission end of transfer HAL_I2S_TxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_I2S_TxCpltCallback
Receive an amount of data in non blocking mode using HAL_I2S_Receive_IT()
At reception end of half transfer HAL_I2S_RxHalfCpltCallback is executed and user
HAL_I2S_RxHalfCpltCallback
At reception end of transfer HAL_I2S_RxCpltCallback is executed and user can add
his own code by customization of function pointer HAL_I2S_RxCpltCallback
In case of transfer Error, HAL_I2S_ErrorCallback() function is executed and user can
add his own code by customization of function pointer HAL_I2S_ErrorCallback
Send an amount of data in non blocking mode (DMA) using

HAL_I2S_Transmit_DMA()
At transmission end of half transfer HAL_I2S_TxHalfCpltCallback is executed and
At transmission end of transfer HAL_I2S_TxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_I2S_TxCpltCallback
Receive an amount of data in non blocking mode (DMA) using
HAL_I2S_Receive_DMA()
At reception end of half transfer HAL_I2S_RxHalfCpltCallback is executed and user
At reception end of transfer HAL_I2S_RxCpltCallback is executed and user can add
his own code by customization of function pointer HAL_I2S_RxCpltCallback
In case of transfer Error, HAL_I2S_ErrorCallback() function is executed and user can
add his own code by customization of function pointer HAL_I2S_ErrorCallback
Pause the DMA Transfer using HAL_I2S_DMAPause()
Resume the DMA Transfer using HAL_I2S_DMAResume()
Stop the DMA Transfer using HAL_I2S_DMAStop()
I2S HAL driver macros list

Below the list of most used macros in USART HAL driver.
278/692
__HAL_I2S_ENABLE: Enable the specified SPI peripheral (in I2S mode)

__HAL_I2S_DISABLE: Disable the specified SPI peripheral (in I2S mode)
DocID026525 Rev 1
UM1785
__HAL_I2S_ENABLE_IT : Enable the specified I2S interrupts

__HAL_I2S_DISABLE_IT : Disable the specified I2S interrupts
__HAL_I2S_GET_FLAG: Check whether the specified I2S flag is set or not
You can refer to the I2S HAL driver header file for more useful macros
22.2.2

This subsection provides a set of functions allowing to initialize and de-initialiaze the I2Sx
peripheral in simplex mode:
22.2.3
User must Implement HAL_I2S_MspInit() function in which he configures all related

Call the function HAL_I2S_Init() to configure the selected device with the selected
configuration:
Mode
Standard
Data Format
MCLK Output
Audio frequency
Polarity
Call the function HAL_I2S_DeInit() to restore the default configuration of the selected
I2Sx periperal.
HAL_I2S_Init()
HAL_I2S_DeInit()
HAL_I2S_MspInit()
HAL_I2S_MspDeInit()
This subsection provides a set of functions allowing to manage the I2S data transfers.
1.
2.
3.
4.
There are two modes of transfer:
Blocking mode : The communication is performed in the polling mode. The

transfer.
No-Blocking mode : The communication is performed using Interrupts or DMA.

These functions return the status of the transfer startup. The end of the data
processing will be indicated through the dedicated I2S IRQ when using Interrupt
mode or the DMA IRQ when using DMA mode.
Blocking mode functions are :
HAL_I2S_Transmit()
HAL_I2S_Receive()
HAL_I2S_Transmit_IT()
HAL_I2S_Receive_IT()
No-Blocking mode functions with DMA are :
DocID026525 Rev 1
279/692

5.
A set of Transfer Complete Callbacks are provided in non Blocking mode:
HAL_I2S_TxCpltCallback()
HAL_I2S_RxCpltCallback()
HAL_I2S_ErrorCallback()
HAL_I2S_Transmit()
HAL_I2S_Receive()
HAL_I2S_Transmit_IT()
HAL_I2S_Receive_IT()
HAL_I2S_DMAPause()
HAL_I2S_DMAResume()
HAL_I2S_DMAStop()
HAL_I2S_IRQHandler()
HAL_I2S_TxHalfCpltCallback()
HAL_I2S_TxCpltCallback()
HAL_I2S_RxHalfCpltCallback()
HAL_I2S_RxCpltCallback()
HAL_I2S_ErrorCallback()
22.2.4
UM1785

22.2.5
22.2.6
HAL_I2S_GetState()
HAL_I2S_GetError()
HAL_I2S_Init
Function Name
HAL_StatusTypeDef HAL_I2S_Init ( I2S_HandleTypeDef *

hi2s)
Initializes the I2S according to the specified parameters in the

I2S_InitTypeDef and create the associated handle.
Parameters
hi2s : pointer to a I2S_HandleTypeDef structure that

contains the configuration information for I2S module
Return values
HAL status
Notes
None.
HAL_I2S_DeInit
Function Name
280/692
HAL_StatusTypeDef HAL_I2S_DeInit ( I2S_HandleTypeDef *
DocID026525 Rev 1
UM1785

hi2s)
22.2.7
22.2.8
22.2.9
DeInitializes the I2S peripheral.
Parameters

Return values
HAL status
Notes
None.
HAL_I2S_MspInit
Function Name
void HAL_I2S_MspInit ( I2S_HandleTypeDef * hi2s)
I2S MSP Init.
Parameters

Return values
None.
Notes
None.
HAL_I2S_MspDeInit
Function Name
void HAL_I2S_MspDeInit ( I2S_HandleTypeDef * hi2s)
I2S MSP DeInit.
Parameters

Return values
None.
Notes
None.
HAL_I2S_Transmit
DocID026525 Rev 1
281/692

Function Name
UM1785
HAL_StatusTypeDef HAL_I2S_Transmit ( I2S_HandleTypeDef
* hi2s, uint16_t * pData, uint16_t Size, uint32_t Timeout)
Transmit an amount of data in blocking mode.
Parameters

pData : a 16-bit pointer to data buffer.
Size : number of data sample to be sent:
Parameters
Return values
HAL status
Notes
When a 16-bit data frame or a 16-bit data frame extended is

selected during the I2S configuration phase, the Size
parameter means the number of 16-bit data length in the
transaction and when a 24-bit data frame or a 32-bit data
frame is selected the Size parameter means the number of
16-bit data length.
The I2S is kept enabled at the end of transaction to avoid the
clock de-synchronization between Master and Slave(example:
audio streaming).
22.2.10
HAL_I2S_Receive
Function Name
HAL_StatusTypeDef HAL_I2S_Receive ( I2S_HandleTypeDef *

hi2s, uint16_t * pData, uint16_t Size, uint32_t Timeout)
Receive an amount of data in blocking mode.
Parameters

Parameters
Return values
HAL status
Notes

16-bit data length.
audio streaming).
In I2S Master Receiver mode, just after enabling the
peripheral the clock will be generate in continouse way and as
the I2S is not disabled at the end of the I2S transaction.
282/692
DocID026525 Rev 1
UM1785
22.2.11
HAL_I2S_Transmit_IT
Function Name
HAL_StatusTypeDef HAL_I2S_Transmit_IT (
I2S_HandleTypeDef * hi2s, uint16_t * pData, uint16_t Size)
Transmit an amount of data in non-blocking mode with Interrupt.
Parameters

Return values
HAL status
Notes

16-bit data length.
audio streaming).
22.2.12
HAL_I2S_Receive_IT
Function Name
HAL_StatusTypeDef HAL_I2S_Receive_IT (
Receive an amount of data in non-blocking mode with Interrupt.
Parameters

pData : a 16-bit pointer to the Receive data buffer.
Return values
HAL status
Notes

16-bit data length.
DocID026525 Rev 1
283/692
UM1785
22.2.13
HAL_I2S_Transmit_DMA
Function Name
HAL_StatusTypeDef HAL_I2S_Transmit_DMA (
Transmit an amount of data in non-blocking mode with DMA.
Parameters

pData : a 16-bit pointer to the Transmit data buffer.
Return values
HAL status
Notes

16-bit data length.
audio streaming).
22.2.14
HAL_I2S_Receive_DMA
Function Name
HAL_StatusTypeDef HAL_I2S_Receive_DMA (
Receive an amount of data in non-blocking mode with DMA.
Parameters
284/692

audio streaming).
It is recommended to use DMA for the I2S receiver to avoid
de-synchronisation between Master and Slave otherwise the
I2S interrupt should be optimized.

pData : a 16-bit pointer to the Receive data buffer.
DocID026525 Rev 1
UM1785

Return values
HAL status
Notes

16-bit data length.
audio streaming).
22.2.15
22.2.16
HAL_I2S_DMAPause
Function Name
HAL_StatusTypeDef HAL_I2S_DMAPause (
I2S_HandleTypeDef * hi2s)
Pauses the audio stream playing from the Media.
Parameters

Return values
HAL status
Notes
None.
HAL_I2S_DMAResume
Function Name
HAL_StatusTypeDef HAL_I2S_DMAResume (
Resumes the audio stream playing from the Media.
Parameters

Return values
HAL status
Notes
None.
DocID026525 Rev 1
285/692
22.2.17
22.2.18
22.2.19
286/692
UM1785
HAL_I2S_DMAStop
Function Name
HAL_StatusTypeDef HAL_I2S_DMAStop ( I2S_HandleTypeDef

* hi2s)
Resumes the audio stream playing from the Media.
Parameters

Return values
HAL status
Notes
None.
HAL_I2S_IRQHandler
Function Name
void HAL_I2S_IRQHandler ( I2S_HandleTypeDef * hi2s)
This function handles I2S interrupt request.
Parameters

Return values
None.
Notes
None.
Function Name
void HAL_I2S_TxHalfCpltCallback ( I2S_HandleTypeDef *

hi2s)
Tx Transfer Half completed callbacks.
Parameters

Return values
None.
Notes
None.
DocID026525 Rev 1
UM1785
22.2.20
22.2.21
22.2.22
HAL_I2S_TxCpltCallback
Function Name
void HAL_I2S_TxCpltCallback ( I2S_HandleTypeDef * hi2s)
Tx Transfer completed callbacks.
Parameters

Return values
None.
Notes
None.
Function Name
void HAL_I2S_RxHalfCpltCallback ( I2S_HandleTypeDef *

hi2s)
Rx Transfer half completed callbacks.
Parameters

Return values
None.
Notes
None.
HAL_I2S_RxCpltCallback
Function Name
void HAL_I2S_RxCpltCallback ( I2S_HandleTypeDef * hi2s)
Rx Transfer completed callbacks.
Parameters

Return values
None.
Notes
None.
DocID026525 Rev 1
287/692
22.2.23
22.2.24
22.2.25
288/692
UM1785
HAL_I2S_ErrorCallback
Function Name
void HAL_I2S_ErrorCallback ( I2S_HandleTypeDef * hi2s)
I2S error callbacks.
Parameters

Return values
None.
Notes
None.
HAL_I2S_GetState
Function Name
HAL_I2S_StateTypeDef HAL_I2S_GetState (
Return the I2S state.
Parameters

Return values
HAL state
Notes
None.
HAL_I2S_GetError
Function Name
HAL_I2S_ErrorTypeDef HAL_I2S_GetError (
Return the I2S error code.
Parameters

Return values
I2S Error Code
Notes
None.
DocID026525 Rev 1
UM1785
22.3
I2S Firmware driver defines
22.3.1
I2S
I2S
I2S Audio Frequency
I2S_AUDIOFREQ_192K
I2S_AUDIOFREQ_96K
I2S_AUDIOFREQ_48K
I2S_AUDIOFREQ_44K
I2S_AUDIOFREQ_32K
I2S_AUDIOFREQ_22K
I2S_AUDIOFREQ_16K
I2S_AUDIOFREQ_11K
I2S_AUDIOFREQ_8K
I2S_AUDIOFREQ_DEFAULT
IS_I2S_AUDIO_FREQ
I2S Clock Polarity
I2S_CPOL_LOW
I2S_CPOL_HIGH
IS_I2S_CPOL
I2S Data Format
I2S_DATAFORMAT_16B
I2S_DATAFORMAT_16B_EXTENDED
I2S_DATAFORMAT_24B
I2S_DATAFORMAT_32B
IS_I2S_DATA_FORMAT
I2S Exported Macros
__HAL_I2S_RESET_HANDLE_STATE
Description:
Reset I2S handle state.
Parameters:
__HANDLE__: I2S handle.
Return value:
__HAL_I2S_ENABLE
None:
Description:
Enable or disable the specified SPI
DocID026525 Rev 1
289/692
UM1785
peripheral (in I2S mode).
Parameters:
__HANDLE__: specifies the I2S Handle.
Return value:
None:
__HAL_I2S_DISABLE
Description:
__HAL_I2S_ENABLE_IT
Enable or disable the specified I2S

interrupts.
Parameters:

I2S_IT_TXE: Tx buffer empty interrupt

enable
I2S_IT_RXNE: RX buffer not empty

interrupt enable
I2S_IT_ERR: Error interrupt enable
Return value:
None:
__HAL_I2S_DISABLE_IT
__HAL_I2S_GET_IT_SOURCE
Description:
Checks if the specified I2S interrupt source

Parameters:

This parameter can be I2S where x: 1, 2, or
3 to select the I2S peripheral.
__INTERRUPT__: specifies the I2S
I2S_IT_TXE: Tx buffer empty interrupt

enable
I2S_IT_RXNE: RX buffer not empty

interrupt enable
I2S_IT_ERR: Error interrupt enable
Return value:
__HAL_I2S_GET_FLAG
Description:
Checks whether the specified I2S flag is set

or not.
Parameters:
290/692
DocID026525 Rev 1
UM1785

values:
I2S_FLAG_RXNE: Receive buffer not

empty flag
I2S_FLAG_TXE: Transmit buffer empty

flag
I2S_FLAG_UDR: Underrun flag
I2S_FLAG_OVR: Overrun flag
I2S_FLAG_FRE: Frame error flag
I2S_FLAG_CHSIDE: Channel Side flag
I2S_FLAG_BSY: Busy flag
Return value:
__HAL_I2S_CLEAR_OVRFLAG

FALSE).
Description:
Clears the I2S OVR pending flag.
Parameters:
Return value:
__HAL_I2S_CLEAR_UDRFLAG
None:
Description:
Clears the I2S UDR pending flag.
Parameters:
Return value:
None:
I2S Flag definition

I2S_FLAG_TXE
I2S_FLAG_RXNE
I2S_FLAG_UDR
I2S_FLAG_OVR
I2S_FLAG_FRE
I2S_FLAG_CHSIDE
I2S_FLAG_BSY
I2S Interrupt configuration definition
I2S_IT_TXE
I2S_IT_RXNE
I2S_IT_ERR
I2S MCLK Output
DocID026525 Rev 1
291/692

I2S_MCLKOUTPUT_ENABLE
I2S_MCLKOUTPUT_DISABLE
IS_I2S_MCLK_OUTPUT
I2S Mode
I2S_MODE_SLAVE_TX
I2S_MODE_SLAVE_RX
I2S_MODE_MASTER_TX
I2S_MODE_MASTER_RX
IS_I2S_MODE
I2S Standard
I2S_STANDARD_PHILIPS
I2S_STANDARD_MSB
I2S_STANDARD_LSB
I2S_STANDARD_PCM_SHORT
I2S_STANDARD_PCM_LONG
IS_I2S_STANDARD
292/692
DocID026525 Rev 1
UM1785
UM1785
HAL IRDA Generic Driver
23
23.1
IRDA Firmware driver registers structures
23.1.1
IRDA_InitTypeDef
IRDA_InitTypeDef is defined in the stm32f0xx_hal_irda.h
Data Fields
uint32_t BaudRate
uint32_t WordLength
uint16_t Parity
uint16_t Mode
uint8_t Prescaler
uint16_t PowerMode
Field Documentation
23.1.2
uint32_t IRDA_InitTypeDef::BaudRate This member configures the IRDA

communication baud rate. The baud rate register is computed using the following
formula: Baud Rate Register = ((PCLKx) / ((hirda->Init.BaudRate)))
uint32_t IRDA_InitTypeDef::WordLength Specifies the number of data bits
transmitted or received in a frame. This parameter can be a value of
IRDAEx_Word_Length
uint16_t IRDA_InitTypeDef::Parity Specifies the parity mode. This parameter can be
a value of IRDA_Parity
Note:When parity is enabled, the computed parity is inserted at the MSB position of
the transmitted data (9th bit when the word length is set to 9 data bits; 8th bit when the
word length is set to 8 data bits).
uint16_t IRDA_InitTypeDef::Mode Specifies whether the Receive or Transmit mode
is enabled or disabled. This parameter can be a value of IRDA_Mode
uint8_t IRDA_InitTypeDef::Prescaler Specifies the Prescaler value for dividing the
UART/USART source clock to achieve low-power frequency.
Note:Prescaler value 0 is forbidden
uint16_t IRDA_InitTypeDef::PowerMode Specifies the IRDA power mode. This
parameter can be a value of IRDA_Low_Power
IRDA_HandleTypeDef
IRDA_HandleTypeDef is defined in the stm32f0xx_hal_irda.h
Data Fields
USART_TypeDef * Instance
IRDA_InitTypeDef Init
uint16_t TxXferSize
uint16_t RxXferSize
uint16_t RxXferCount
DocID026525 Rev 1
293/692
UM1785
uint16_t Mask
HAL_IRDA_StateTypeDef State
HAL_IRDA_ErrorTypeDef ErrorCode
Field Documentation
23.2
USART_TypeDef* IRDA_HandleTypeDef::Instance
IRDA_InitTypeDef IRDA_HandleTypeDef::Init
uint8_t* IRDA_HandleTypeDef::pTxBuffPtr
uint16_t IRDA_HandleTypeDef::TxXferSize
uint16_t IRDA_HandleTypeDef::TxXferCount
uint8_t* IRDA_HandleTypeDef::pRxBuffPtr
uint16_t IRDA_HandleTypeDef::RxXferSize
uint16_t IRDA_HandleTypeDef::RxXferCount
uint16_t IRDA_HandleTypeDef::Mask
DMA_HandleTypeDef* IRDA_HandleTypeDef::hdmatx
DMA_HandleTypeDef* IRDA_HandleTypeDef::hdmarx
HAL_LockTypeDef IRDA_HandleTypeDef::Lock
HAL_IRDA_StateTypeDef IRDA_HandleTypeDef::State
HAL_IRDA_ErrorTypeDef IRDA_HandleTypeDef::ErrorCode
IRDA Firmware driver API description

The following section lists the various functions of the IRDA library.
23.2.1

The IRDA HAL driver can be used as follows:
1.
2.
294/692
Declare a IRDA_HandleTypeDef handle structure.

Initialize the IRDA low level resources by implementing the HAL_IRDA_MspInit() API:
a.
Enable the USARTx interface clock.
b.
IRDA pins configuration:
Enable the clock for the IRDA GPIOs.
Configure these IRDA pins as alternate function pull-up.

c.
(HAL_IRDA_Transmit_IT() and HAL_IRDA_Receive_IT() APIs):
Configure the USARTx interrupt priority.
Enable the NVIC USART IRQ handle.

d.
(HAL_IRDA_Transmit_DMA() and HAL_IRDA_Receive_DMA() APIs):
Declare a DMA handle structure for the Tx/Rx channel.
parameters.
Configure the DMA Tx/Rx channel.
Associate the initilalized DMA handle to the IRDA DMA Tx/Rx handle.
DocID026525 Rev 1
UM1785
3.
4.
5.
interrupt on the DMA Tx/Rx channel.
Program the Baud Rate, Word Length and Parity and Mode(Receiver/Transmitter),
the normal or low power mode and the clock prescaler in the hirda Init structure.
Initialize the IRDA registers by calling the HAL_IRDA_Init() API:
This API configures also the low level Hardware (GPIO, CLOCK, CORTEX...etc)
by calling the customed HAL_IRDA_MspInit() API. The specific IRDA interrupts
(Transmission complete interrupt, RXNE interrupt and Error Interrupts) will be
managed using the macros __HAL_IRDA_ENABLE_IT() and
__HAL_IRDA_DISABLE_IT() inside the transmit and receive process.
Three operation modes are available within this driver :
Send an amount of data in blocking mode using HAL_IRDA_Transmit()

Receive an amount of data in blocking mode using HAL_IRDA_Receive()
Send an amount of data in non blocking mode using HAL_IRDA_Transmit_IT()

At transmission end of transfer HAL_IRDA_TxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_IRDA_TxCpltCallback
Receive an amount of data in non blocking mode using HAL_IRDA_Receive_IT()
At reception end of transfer HAL_IRDA_RxCpltCallback is executed and user can add
his own code by customization of function pointer HAL_IRDA_RxCpltCallback
In case of transfer Error, HAL_IRDA_ErrorCallback() function is executed and user
can add his own code by customization of function pointer HAL_IRDA_ErrorCallback

HAL_IRDA_Transmit_DMA()
At transmission end of transfer HAL_IRDA_TxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_IRDA_TxCpltCallback
HAL_IRDA_Receive_DMA()
At reception end of transfer HAL_IRDA_RxCpltCallback is executed and user can add
his own code by customization of function pointer HAL_IRDA_RxCpltCallback
In case of transfer Error, HAL_IRDA_ErrorCallback() function is executed and user
can add his own code by customization of function pointer HAL_IRDA_ErrorCallback
IRDA HAL driver macros list

Below the list of most used macros in IRDA HAL driver.
__HAL_IRDA_ENABLE: Enable the IRDA peripheral

__HAL_IRDA_DISABLE: Disable the IRDA peripheral
__HAL_IRDA_GET_FLAG : Check whether the specified IRDA flag is set or not
__HAL_IRDA_CLEAR_FLAG : Clear the specified IRDA pending flag
__HAL_IRDA_ENABLE_IT: Enable the specified IRDA interrupt
__HAL_IRDA_DISABLE_IT: Disable the specified IRDA interrupt
DocID026525 Rev 1
295/692
UM1785
You can refer to the IRDA HAL driver header file for more useful macros
23.2.2

This subsection provides a set of functions allowing to initialize the USARTx in IRDA
mode.
For the asynchronous mode only these parameters can be configured:
Baud Rate
Word Length
Parity: If the parity is enabled, then the MSB bit of the data written in the data
register is transmitted but is changed by the parity bit. Depending on the frame
length defined by the M bit (8-bits or 9-bits) or by the M1 and M0 bits (7-bit, 8-bit
or 9-bit), the possible IRDA frame formats are as listed in the following table
Power mode
Prescaler setting
Receiver/transmitter modes
Table 19: IRDA frame formats
M bit
PCE bit
IRDA frame
| SB | 8-bit data | STB |
| SB | 7-bit data | PB | STB |
| SB | 8-bit data | PB | STB |
M1, M0 bits
PCE bit
IRDA frame
10
10
SB | 6-bit data | PB | STB |
The HAL_IRDA_Init() function follows IRDA configuration procedures (details for the
procedures are available in reference manual).
23.2.3
HAL_IRDA_Init()
HAL_IRDA_DeInit()
HAL_IRDA_MspInit()
HAL_IRDA_MspDeInit()
This subsection provides a set of functions allowing to manage the IRDA data transfers.
IrDA is a half duplex communication protocol. If the Transmitter is busy, any data on the
IrDA receive line will be ignored by the IrDA decoder and if the Receiver is busy, data on
the TX from the USART to IrDA will not be encoded by IrDA. While receiving data,
transmission should be avoided as the data to be transmitted could be corrupted.
1.
296/692
DocID026525 Rev 1
UM1785
2.
3.
4.
5.
23.2.4
Blocking mode: The communication is performed in polling mode. The HAL

transfer.
Non Blocking mode: The communication is performed using Interrupts or DMA,

these API s return the HAL status. The end of the data processing will be
indicated through the dedicated IRDA IRQ when using Interrupt mode or the
DMA IRQ when using DMA mode. The HAL_IRDA_TxCpltCallback(),
HAL_IRDA_RxCpltCallback() user callbacks will be executed respectivelly at the
end of the Transmit or Receive process The HAL_IRDA_ErrorCallback() user
callback will be executed when a communication error is detected
Blocking mode API s are :
HAL_IRDA_Transmit()
HAL_IRDA_Receive()
Non Blocking mode API s with Interrupt are :
HAL_IRDA_Transmit_IT()
HAL_IRDA_Receive_IT()
HAL_IRDA_IRQHandler()
IRDA_Transmit_IT()
IRDA_Receive_IT()
Non Blocking mode functions with DMA are :
A set of Transfer Complete Callbacks are provided in Non Blocking mode:
HAL_IRDA_TxCpltCallback()
HAL_IRDA_RxCpltCallback()
HAL_IRDA_ErrorCallback()
HAL_IRDA_Transmit()
HAL_IRDA_Receive()
HAL_IRDA_Transmit_IT()
HAL_IRDA_Receive_IT()
HAL_IRDA_IRQHandler()
HAL_IRDA_TxCpltCallback()
HAL_IRDA_RxCpltCallback()
HAL_IRDA_ErrorCallback()

This subsection provides a set of functions allowing to control the IRDA.
23.2.5
HAL_IRDA_GetState() API can be helpful to check in run-time the state of the IRDA
peripheral.
IRDA_SetConfig() API is used to configure the IRDA communications parameters.
HAL_IRDA_GetState()
HAL_IRDA_GetError()
HAL_IRDA_Init
Function Name
HAL_StatusTypeDef HAL_IRDA_Init ( IRDA_HandleTypeDef *
DocID026525 Rev 1
297/692
UM1785
hirda)
23.2.6
23.2.7
23.2.8
Initializes the IRDA mode according to the specified parameters in

the IRDA_InitTypeDef and creates the associated handle .
Parameters
hirda : IRDA handle
Return values
HAL status
Notes
None.
HAL_IRDA_DeInit
Function Name
HAL_StatusTypeDef HAL_IRDA_DeInit ( IRDA_HandleTypeDef

* hirda)
DeInitializes the IRDA peripheral.
Parameters
hirda : IRDA handle
Return values
HAL status
Notes
None.
HAL_IRDA_MspInit
Function Name
void HAL_IRDA_MspInit ( IRDA_HandleTypeDef * hirda)
IRDA MSP Init.
Parameters
hirda : IRDA handle
Return values
None.
Notes
None.
HAL_IRDA_MspDeInit
Function Name
298/692
void HAL_IRDA_MspDeInit ( IRDA_HandleTypeDef * hirda)

DocID026525 Rev 1
UM1785
23.2.9
23.2.10

IRDA MSP DeInit.
Parameters
hirda : IRDA handle
Return values
None.
Notes
None.
HAL_IRDA_Transmit
Function Name
HAL_StatusTypeDef HAL_IRDA_Transmit (
IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size,
uint32_t Timeout)
Send an amount of data in blocking mode.
Parameters
hirda : IRDA handle

pData : pointer to data buffer
Size : amount of data to be sent
Timeout : Duration of the timeout
Return values
HAL status
Notes
None.
HAL_IRDA_Receive
Function Name
HAL_StatusTypeDef HAL_IRDA_Receive (
IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size,
uint32_t Timeout)
Parameters
hirda : IRDA handle

Size : amount of data to be received
Return values
HAL status
Notes
None.
DocID026525 Rev 1
299/692
23.2.11
23.2.12
23.2.13
300/692
UM1785
HAL_IRDA_Transmit_IT
Function Name
HAL_StatusTypeDef HAL_IRDA_Transmit_IT (
IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size)
Send an amount of data in interrupt mode.
Parameters
hirda : IRDA handle

Return values
HAL status
Notes
None.
HAL_IRDA_Receive_IT
Function Name
HAL_StatusTypeDef HAL_IRDA_Receive_IT (
Receive an amount of data in interrupt mode.
Parameters
hirda : IRDA handle

Return values
HAL status
Notes
None.
HAL_IRDA_Transmit_DMA
Function Name
HAL_StatusTypeDef HAL_IRDA_Transmit_DMA (
Send an amount of data in DMA mode.
Parameters
hirda : IRDA handle

Return values
HAL status
DocID026525 Rev 1
UM1785

Notes
23.2.14
23.2.15
23.2.16
None.
HAL_IRDA_Receive_DMA
Function Name
HAL_StatusTypeDef HAL_IRDA_Receive_DMA (
Receive an amount of data in DMA mode.
Parameters
hirda : IRDA handle

Return values
HAL status
Notes
When the IRDA parity is enabled (PCE = 1), the received data
contain the parity bit (MSB position)
HAL_IRDA_IRQHandler
Function Name
void HAL_IRDA_IRQHandler ( IRDA_HandleTypeDef * hirda)
This function handles IRDA interrupt request.
Parameters
hirda : IRDA handle
Return values
None.
Notes
None.
HAL_IRDA_TxCpltCallback
Function Name
void HAL_IRDA_TxCpltCallback ( IRDA_HandleTypeDef *

hirda)
Tx Transfer completed callback.
Parameters
hirda : irda handle

DocID026525 Rev 1
301/692

Return values
Notes
23.2.17
23.2.18
23.2.19
302/692
UM1785
None.
None.
HAL_IRDA_RxCpltCallback
Function Name
void HAL_IRDA_RxCpltCallback ( IRDA_HandleTypeDef *

hirda)
Rx Transfer completed callback.
Parameters
hirda : irda handle
Return values
None.
Notes
None.
HAL_IRDA_ErrorCallback
Function Name
void HAL_IRDA_ErrorCallback ( IRDA_HandleTypeDef *

hirda)
IRDA error callback.
Parameters
hirda : IRDA handle
Return values
None.
Notes
None.
HAL_IRDA_GetState
Function Name
HAL_IRDA_StateTypeDef HAL_IRDA_GetState (
IRDA_HandleTypeDef * hirda)
return the IRDA state
Parameters
hirda : irda handle
DocID026525 Rev 1
UM1785
23.2.20

Return values
HAL state
Notes
None.
HAL_IRDA_GetError
Function Name
uint32_t HAL_IRDA_GetError ( IRDA_HandleTypeDef * hirda)
Return the IRDA error code.
Parameters
hirda : : pointer to a IRDA_HandleTypeDef structure that

contains the configuration information for the specified IRDA.
Return values
IRDA Error Code
Notes
None.
23.3
IRDA Firmware driver defines
23.3.1
IRDA
IRDA
IRDA DMA Rx
IRDA_DMA_RX_DISABLE
IRDA_DMA_RX_ENABLE
IS_IRDA_DMA_RX
IRDA DMA Tx
IRDA_DMA_TX_DISABLE
IRDA_DMA_TX_ENABLE
IS_IRDA_DMA_TX
IRDA Exported Macros
__HAL_IRDA_RESET_HANDLE_STA
TE
Description:
Reset IRDA handle state.
Parameters:
__HANDLE__: IRDA handle.
Return value:
None:
DocID026525 Rev 1
303/692

__HAL_IRDA_GET_FLAG
UM1785
Description:
Checks whether the specified IRDA flag is

set or not.
Parameters:
__HANDLE__: specifies the IRDA Handle.

The Handle Instance can be UARTx where
x: 1, 2, 3, 4, 5 to select the USART or UART
peripheral
values:
IRDA_FLAG_REACK: Receive enable

ackowledge flag
IRDA_FLAG_TEACK: Transmit enable

ackowledge flag
IRDA_FLAG_BUSY: Busy flag
IRDA_FLAG_ABRF: Auto Baud rate

detection flag
IRDA_FLAG_ABRE: Auto Baud rate

detection error flag
IRDA_FLAG_TXE: Transmit data

register empty flag
IRDA_FLAG_TC: Transmission
Complete flag
IRDA_FLAG_RXNE: Receive data

register not empty flag
IRDA_FLAG_IDLE: Idle Line detection

flag
IRDA_FLAG_ORE: OverRun Error flag
IRDA_FLAG_NE: Noise Error flag
IRDA_FLAG_FE: Framing Error flag
IRDA_FLAG_PE: Parity Error flag
Return value:
__HAL_IRDA_ENABLE_IT

FALSE).
Description:
Enables the specified IRDA interrupt.
Parameters:
304/692

peripheral
__INTERRUPT__: specifies the IRDA
interrupt source to enable. This parameter
IRDA_IT_TXE: Transmit Data Register

empty interrupt
IRDA_IT_TC: Transmission complete

interrupt
IRDA_IT_RXNE: Receive Data register
DocID026525 Rev 1
UM1785

not empty interrupt
IRDA_IT_IDLE: Idle line detection
interrupt
IRDA_IT_PE: Parity Error interrupt
IRDA_IT_ERR: Error interrupt(Frame
error, noise error, overrun error)
Return value:
__HAL_IRDA_DISABLE_IT
None:
Description:
Disables the specified IRDA interrupt.
Parameters:

peripheral
__INTERRUPT__: specifies the IRDA
interrupt source to disable. This parameter

empty interrupt

interrupt

not empty interrupt

interrupt
IRDA_IT_ERR: Error interrupt(Frame

Return value:
__HAL_IRDA_GET_IT
None:
Description:
Checks whether the specified IRDA interrupt

has occurred or not.
Parameters:

peripheral
__IT__: specifies the IRDA interrupt source
to check. This parameter can be one of the
following values:

empty interrupt

interrupt

not empty interrupt
DocID026525 Rev 1
305/692
UM1785

interrupt
IRDA_IT_ORE: OverRun Error interrupt
IRDA_IT_NE: Noise Error interrupt
IRDA_IT_FE: Framing Error interrupt
Return value:
__HAL_IRDA_GET_IT_SOURCE
Description:
Checks whether the specified IRDA interrupt

source is enabled.
Parameters:

peripheral
__IT__: specifies the IRDA interrupt source
following values:

empty interrupt

interrupt

not empty interrupt

interrupt
IRDA_IT_ORE: OverRun Error interrupt
IRDA_IT_NE: Noise Error interrupt
IRDA_IT_FE: Framing Error interrupt
Return value:
__HAL_IRDA_CLEAR_IT
Description:
Clears the specified IRDA ISR flag, in

setting the proper ICR register flag.
Parameters:
306/692

peripheral
__IT_CLEAR__: specifies the interrupt clear
register flag that needs to be set to clear the
corresponding interrupt This parameter can
IRDA_CLEAR_PEF: Parity Error Clear

Flag
IRDA_CLEAR_FEF: Framing Error
DocID026525 Rev 1
UM1785

Clear Flag
IRDA_CLEAR_NEF: Noise detected
Clear Flag
IRDA_CLEAR_OREF: OverRun Error
Clear Flag
IRDA_CLEAR_TCF: Transmission
Complete Clear Flag
Return value:
__HAL_IRDA_SEND_REQ
None:
Description:
Set a specific IRDA request flag.
Parameters:

peripheral
__REQ__: specifies the request flag to set
values:
IRDA_AUTOBAUD_REQUEST: AutoBaud Rate Request
IRDA_RXDATA_FLUSH_REQUEST:
Receive Data flush Request
IRDA_TXDATA_FLUSH_REQUEST:
Transmit data flush Request
Return value:
__HAL_IRDA_ENABLE
None:
Description:
Enable UART/USART associated to IRDA

Handle.
Parameters:

peripheral
Return value:
__HAL_IRDA_DISABLE
None:
Description:
Disable UART/USART associated to IRDA

Handle.
Parameters:

peripheral
DocID026525 Rev 1
307/692
UM1785
Return value:
None:
Description:
IS_IRDA_BAUDRATE
Ensure that IRDA Baud rate is less or equal

to maximum value.
Parameters:
__BAUDRATE__: specifies the IRDA

Baudrate set by the user.
Return value:
True: or False
Description:
IS_IRDA_PRESCALER
Ensure that IRDA prescaler value is strictly

larger than 0.
Parameters:
__PRESCALER__: specifies the IRDA

prescaler value set by the user.
Return value:
True: or False
IRDA Flags
IRDA_FLAG_REACK
IRDA_FLAG_TEACK
IRDA_FLAG_BUSY
IRDA_FLAG_ABRF
IRDA_FLAG_ABRE
IRDA_FLAG_TXE
IRDA_FLAG_TC
IRDA_FLAG_RXNE
IRDA_FLAG_ORE
IRDA_FLAG_NE
IRDA_FLAG_FE
IRDA_FLAG_PE
IRDA interruptions flag mask
IRDA_IT_MASK
IRDA Interrupt Definition
IRDA_IT_PE
IRDA_IT_TXE
IRDA_IT_TC
308/692
DocID026525 Rev 1
UM1785

IRDA_IT_RXNE
IRDA_IT_IDLE
IRDA_IT_ERR
IRDA_IT_ORE
IRDA_IT_NE
IRDA_IT_FE
IRDA Interruption Clear Flags
IRDA_CLEAR_PEF
Parity Error Clear Flag
IRDA_CLEAR_FEF
Framing Error Clear Flag
IRDA_CLEAR_NEF
Noise detected Clear Flag
IRDA_CLEAR_OREF
OverRun Error Clear Flag
IRDA_CLEAR_TCF
Transmission Complete Clear Flag
IRDA Low Power

IRDA_POWERMODE_NORMAL
IRDA_POWERMODE_LOWPOWER
IS_IRDA_POWERMODE
IRDA Mode
IRDA_MODE_DISABLE
IRDA_MODE_ENABLE
IS_IRDA_MODE
IRDA One Bit Sampling
IRDA_ONE_BIT_SAMPLE_DISABLED
IRDA_ONE_BIT_SAMPLE_ENABLED
IS_IRDA_ONEBIT_SAMPLE
IRDA Parity
IRDA_PARITY_NONE
IRDA_PARITY_EVEN
IRDA_PARITY_ODD
IS_IRDA_PARITY
IRDA Private Constants
TEACK_REACK_TIMEOUT
IRDA_TXDMA_TIMEOUTVALUE
IRDA_TIMEOUT_VALUE
IRDA_CR1_FIELDS
IRDA Request Parameters
IRDA_AUTOBAUD_REQUEST
Auto-Baud Rate Request
DocID026525 Rev 1
309/692

IRDA_RXDATA_FLUSH_REQUEST
UM1785
IRDA_TXDATA_FLUSH_REQUEST
IS_IRDA_REQUEST_PARAMETER
IRDA State
IRDA_STATE_DISABLE
IRDA_STATE_ENABLE
IS_IRDA_STATE
IRDA Transfer Mode
IRDA_MODE_RX
IRDA_MODE_TX
IRDA_MODE_TX_RX
IS_IRDA_TX_RX_MODE
310/692
DocID026525 Rev 1
UM1785
HAL IRDA Extension Driver
24
HAL IRDA Extension Driver
24.1
IRDAEx Firmware driver defines
24.1.1
IRDAEx
IRDAEx
IRDAEx Exported Macros
__HAL_IRDA_GETCLOCKSOURCE
Description:
Reports the IRDA clock source.
Parameters:
__HANDLE__: specifies the IRDA Handle

__CLOCKSOURCE__: : output variable
Return value:
__HAL_IRDA_MASK_COMPUTATION
IRDA: clocking source, written in

__CLOCKSOURCE__.
Description:
Computes the mask to apply to retrieve the

received data according to the word length
and to the parity bits activation.
Parameters:
__HANDLE__: specifies the IRDA Handle
Return value:
none:
IRDA Word Length

IRDA_WORDLENGTH_7B
IRDA_WORDLENGTH_8B
IRDA_WORDLENGTH_9B
IS_IRDA_WORD_LENGTH
DocID026525 Rev 1
311/692
HAL IWDG Generic Driver
UM1785
25
25.1
IWDG Firmware driver registers structures
25.1.1
IWDG_InitTypeDef
IWDG_InitTypeDef is defined in the stm32f0xx_hal_iwdg.h
Data Fields
uint32_t Prescaler
uint32_t Reload
uint32_t Window
Field Documentation
25.1.2
uint32_t IWDG_InitTypeDef::Prescaler Select the prescaler of the IWDG. This

parameter can be a value of IWDG_Prescaler
uint32_t IWDG_InitTypeDef::Reload Specifies the IWDG down-counter reload value.
This parameter must be a number between Min_Data = 0 and Max_Data = 0x0FFF
uint32_t IWDG_InitTypeDef::Window Specifies the window value to be compared to
the down-counter. This parameter must be a number between Min_Data = 0 and
Max_Data = 0x0FFF
IWDG_HandleTypeDef
IWDG_HandleTypeDef is defined in the stm32f0xx_hal_iwdg.h
Data Fields
IWDG_TypeDef * Instance
IWDG_InitTypeDef Init
__IO HAL_IWDG_StateTypeDef State
Field Documentation
25.2
IWDG_TypeDef* IWDG_HandleTypeDef::Instance Register base address

IWDG_InitTypeDef IWDG_HandleTypeDef::Init IWDG required parameters
HAL_LockTypeDef IWDG_HandleTypeDef::Lock IWDG Locking object
__IO HAL_IWDG_StateTypeDef IWDG_HandleTypeDef::State IWDG
communication state
IWDG Firmware driver API description

The following section lists the various functions of the IWDG library.
25.2.1
312/692
IWDG Specific features
DocID026525 Rev 1
UM1785
25.2.2
The IWDG can be started by either software or hardware (configurable through option
byte).
The IWDG is clocked by its own dedicated Low-Speed clock (LSI) and thus stays
active even if the main clock fails.
Once the IWDG is started, the LSI is forced ON and cannot be disabled (LSI cannot
be disabled too), and the counter starts counting down from the reset value of 0xFFF.
When it reaches the end of count value (0x000) a system reset is generated.
The IWDG counter should be refreshed at regular intervals, otherwise the watchdog
generates an MCU reset when the counter reaches 0.
The IWDG is implemented in the VDD voltage domain that is still functional in STOP
and STANDBY mode (IWDG reset can wake-up from STANDBY).
IWDGRST flag in RCC_CSR register can be used to inform when an IWDG reset
occurs.
Min-max timeout value @41KHz (LSI): ~0.1ms / ~25.5s The IWDG timeout may vary
due to LSI frequency dispersion. STM32F0x devices provide the capability to measure
the LSI frequency (LSI clock connected internally to TIM16 CH1 input capture). The
measured value can be used to have an IWDG timeout with an acceptable accuracy.
For more information, please refer to the STM32F0x Reference manual.
1.
2.
if Window option is disabled
Use IWDG using HAL_IWDG_Init() function to :
Enable write access to IWDG_PR, IWDG_RLR.
Configure the IWDG prescaler, counter reload value. This reload value will
be loaded in the IWDG counter each time the counter is reloaded, then the
IWDG will start counting down from this value.
Use IWDG using HAL_IWDG_Start() function to :
Reload IWDG counter with value defined in the IWDG_RLR register.
Start the IWDG, when the IWDG is used in software mode (no need to
enable the LSI, it will be enabled by hardware).
Then the application program must refresh the IWDG counter at regular intervals
during normal operation to prevent an MCU reset, using HAL_IWDG_Refresh()
function.
if Window option is enabled:
Use IWDG using HAL_IWDG_Start() function to enable IWDG downcounter
Use IWDG using HAL_IWDG_Init() function to :
Enable write access to IWDG_PR, IWDG_RLR and IWDG_WINR registers.
Configure the IWDG prescaler, reload value and window value.
Then the application program must refresh the IWDG counter at regular intervals
during normal operation to prevent an MCU reset, using HAL_IWDG_Refresh()
function.
IWDG HAL driver macros list

Below the list of most used macros in IWDG HAL driver.
__HAL_IWDG_START: Enable the IWDG peripheral

__HAL_IWDG_RELOAD_COUNTER: Reloads IWDG counter with value defined in
the reload register
DocID026525 Rev 1
313/692
25.2.3
UM1785
__HAL_IWDG_ENABLE_WRITE_ACCESS : Enable write access to IWDG_PR and

IWDG_RLR registers
__HAL_IWDG_DISABLE_WRITE_ACCESS : Disable write access to IWDG_PR and
IWDG_RLR registers
__HAL_IWDG_GET_FLAG: Get the selected IWDG's flag status
Initialization functions
25.2.4
Initialize the IWDG according to the specified parameters in the IWDG_InitTypeDef

and create the associated handle
Manage Window option
Initialize the IWDG MSP
DeInitialize IWDG MSP
HAL_IWDG_Init()
HAL_IWDG_MspInit()
25.2.5
Start the IWDG.

Refresh the IWDG.
HAL_IWDG_Start()
HAL_IWDG_Refresh()

25.2.6
314/692
HAL_IWDG_GetState()
HAL_IWDG_Init
Function Name
HAL_StatusTypeDef HAL_IWDG_Init ( IWDG_HandleTypeDef *

hiwdg)
Initializes the IWDG according to the specified parameters in the

IWDG_InitTypeDef and creates the associated handle.
Parameters
hiwdg : pointer to a IWDG_HandleTypeDef structure that

contains the configuration information for the specified IWDG
module.
Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
25.2.7
25.2.8
25.2.9
HAL_IWDG_MspInit
Function Name
void HAL_IWDG_MspInit ( IWDG_HandleTypeDef * hiwdg)
Initializes the IWDG MSP.
Parameters

module.
Return values
None.
Notes
None.
HAL_IWDG_Start
Function Name
HAL_StatusTypeDef HAL_IWDG_Start ( IWDG_HandleTypeDef

* hiwdg)
Starts the IWDG.
Parameters

module.
Return values
HAL status
Notes
None.
HAL_IWDG_Refresh
Function Name
HAL_StatusTypeDef HAL_IWDG_Refresh (
IWDG_HandleTypeDef * hiwdg)
Refreshes the IWDG.
Parameters

module.
Return values
HAL status
DocID026525 Rev 1
315/692

Notes
25.2.10
UM1785
None.
HAL_IWDG_GetState
Function Name
HAL_IWDG_StateTypeDef HAL_IWDG_GetState (
IWDG_HandleTypeDef * hiwdg)
Returns the IWDG state.
Parameters

module.
Return values
HAL state
Notes
None.
25.3
IWDG Firmware driver defines
25.3.1
IWDG
IWDG
IWDG CounterWindow Value
IS_IWDG_WINDOW
IWDG Exported Macros
__HAL_IWDG_RESET_HANDLE_STATE
Description:
Reset IWDG handle state.
Parameters:
__HANDLE__: IWDG handle.
Return value:
__HAL_IWDG_START
None:
Description:
Enables the IWDG peripheral.
Parameters:
__HANDLE__: IWDG handle
Return value:
316/692
DocID026525 Rev 1
None:
UM1785

__HAL_IWDG_RELOAD_COUNTER
Description:
Reloads IWDG counter with value

defined in the reload register (write
access to IWDG_PR and IWDG_RLR
registers disabled).
Parameters:
Return value:
__HAL_IWDG_ENABLE_WRITE_ACCESS
None:
Description:
Enable write access to IWDG_PR,

IWDG_RLR and IWDG_WINR
registers.
Parameters:
Return value:
__HAL_IWDG_DISABLE_WRITE_ACCESS
None:
Description:
Disable write access to IWDG_PR,

IWDG_RLR and IWDG_WINR
registers.
Parameters:
Return value:
__HAL_IWDG_GET_FLAG
None:
Description:
Gets the selected IWDG's flag status.
Parameters:

This parameter can be one of the
following values:
IWDG_FLAG_PVU: Watchdog
counter reload value update flag
IWDG_FLAG_RVU: Watchdog
counter prescaler value flag
IWDG_FLAG_WVU: Watchdog
counter window value flag
Return value:

FALSE).
IWDG Flag definition

DocID026525 Rev 1
317/692

IWDG_FLAG_PVU
UM1785
Watchdog counter prescaler value update Flag
IWDG_FLAG_RVU
Watchdog counter reload value update Flag
IWDG_FLAG_WVU
Watchdog counter window value update Flag
IWDG Prescaler
IWDG_PRESCALER_4
IWDG prescaler set to 4
IWDG_PRESCALER_8
IWDG_PRESCALER_16
IWDG_PRESCALER_32
IWDG_PRESCALER_64
IWDG_PRESCALER_128
IWDG_PRESCALER_256
IS_IWDG_PRESCALER
IWDG Private Defines
HAL_IWDG_DEFAULT_TIMEOUT
IWDG Registers BitMask
KR_KEY_RELOAD
IWDG Reload Counter Enable
KR_KEY_ENABLE
IWDG Peripheral Enable
KR_KEY_EWA
IWDG KR Write Access Enable
KR_KEY_DWA
IWDG KR Write Access Disable
IS_IWDG_KR
IWDG Reload Value
IS_IWDG_RELOAD
IWDG Window option
IWDG_WINDOW_DISABLE
318/692
DocID026525 Rev 1
UM1785
HAL PCD Generic Driver
26
26.1
PCD Firmware driver registers structures
26.1.1
PCD_InitTypeDef
PCD_InitTypeDef is defined in the stm32f0xx_hal_pcd.h
Data Fields
uint32_t dev_endpoints
uint32_t speed
uint32_t ep0_mps
uint32_t phy_itface
uint32_t Sof_enable
uint32_t low_power_enable
uint32_t lpm_enable
uint32_t battery_charging_enable
Field Documentation
26.1.2
uint32_t PCD_InitTypeDef::dev_endpoints Device Endpoints number. This

parameter depends on the used USB core. This parameter must be a number
between Min_Data = 1 and Max_Data = 15
uint32_t PCD_InitTypeDef::speed USB Core speed. This parameter can be any
value of PCD_Core_Speed
uint32_t PCD_InitTypeDef::ep0_mps Set the Endpoint 0 Max Packet size. This
parameter can be any value of PCD_EP0_MPS
uint32_t PCD_InitTypeDef::phy_itface Select the used PHY interface. This
parameter can be any value of PCD_Core_PHY
uint32_t PCD_InitTypeDef::Sof_enable Enable or disable the output of the SOF
signal. This parameter can be set to ENABLE or DISABLE
uint32_t PCD_InitTypeDef::low_power_enable Enable or disable Low Power mode
This parameter can be set to ENABLE or DISABLE
uint32_t PCD_InitTypeDef::lpm_enable Enable or disable the Link Power
Management . This parameter can be set to ENABLE or DISABLE
uint32_t PCD_InitTypeDef::battery_charging_enable Enable or disable Battery
charging. This parameter can be set to ENABLE or DISABLE
PCD_EPTypeDef
PCD_EPTypeDef is defined in the stm32f0xx_hal_pcd.h
Data Fields
uint8_t num
uint8_t is_in
uint8_t is_stall
uint8_t type
uint16_t pmaadress
uint16_t pmaaddr0
uint16_t pmaaddr1
DocID026525 Rev 1
319/692
UM1785
uint8_t doublebuffer
uint32_t maxpacket
uint8_t * xfer_buff
uint32_t xfer_len
uint32_t xfer_count
Field Documentation
26.1.3
uint8_t PCD_EPTypeDef::num Endpoint number This parameter must be a number

uint8_t PCD_EPTypeDef::is_in Endpoint direction This parameter must be a number
uint8_t PCD_EPTypeDef::is_stall Endpoint stall condition This parameter must be a
number between Min_Data = 0 and Max_Data = 1
uint8_t PCD_EPTypeDef::type Endpoint type This parameter can be any value of
PCD_EP_Type
uint16_t PCD_EPTypeDef::pmaadress PMA Address This parameter can be any
value between Min_addr = 0 and Max_addr = 1K
uint16_t PCD_EPTypeDef::pmaaddr0 PMA Address0 This parameter can be any
uint16_t PCD_EPTypeDef::pmaaddr1 PMA Address1 This parameter can be any
uint8_t PCD_EPTypeDef::doublebuffer Double buffer enable This parameter can be
0 or 1
uint32_t PCD_EPTypeDef::maxpacket Endpoint Max packet size This parameter
must be a number between Min_Data = 0 and Max_Data = 64KB
uint8_t* PCD_EPTypeDef::xfer_buff Pointer to transfer buffer
uint32_t PCD_EPTypeDef::xfer_len Current transfer length
uint32_t PCD_EPTypeDef::xfer_count Partial transfer length in case of multi packet
transfer
PCD_HandleTypeDef
PCD_HandleTypeDef is defined in the stm32f0xx_hal_pcd.h
Data Fields
PCD_TypeDef * Instance
PCD_InitTypeDef Init
__IO uint8_t USB_Address
PCD_EPTypeDef IN_ep
PCD_EPTypeDef OUT_ep
__IO PCD_StateTypeDef State
uint32_t Setup
void * pData
Field Documentation
320/692
PCD_TypeDef* PCD_HandleTypeDef::Instance Register base address

PCD_InitTypeDef PCD_HandleTypeDef::Init PCD required parameters
__IO uint8_t PCD_HandleTypeDef::USB_Address USB Address
PCD_EPTypeDef PCD_HandleTypeDef::IN_ep[8] IN endpoint parameters
DocID026525 Rev 1
UM1785
26.2
PCD_EPTypeDef PCD_HandleTypeDef::OUT_ep[8] OUT endpoint parameters

HAL_LockTypeDef PCD_HandleTypeDef::Lock PCD peripheral status
__IO PCD_StateTypeDef PCD_HandleTypeDef::State PCD communication state
uint32_t PCD_HandleTypeDef::Setup[12] Setup packet buffer
void* PCD_HandleTypeDef::pData Pointer to upper stack Handler
PCD Firmware driver API description

The following section lists the various functions of the PCD library.
26.2.1

The PCD HAL driver can be used as follows:
1.
2.
3.
4.
5.
6.
26.2.2
Declare a PCD_HandleTypeDef handle structure, for example: PCD_HandleTypeDef

hpcd;
Fill parameters of Init structure in HCD handle
Call HAL_PCD_Init() API to initialize the HCD peripheral (Core, Device core, ...)
Initialize the PCD low level resources through the HAL_PCD_MspInit() API:
a.
Enable the PCD/USB Low Level interface clock using
__USB_CLK_ENABLE);
b.
Initialize the related GPIO clocks
c.
Configure PCD pin-out
d.
Configure PCD NVIC interrupt
Associate the Upper USB device stack to the HAL PCD Driver:
a.
hpcd.pData = pdev;
Enable HCD transmission and reception:
a.
HAL_PCD_Start();

26.2.2.1
HAL_PCD_Init()
HAL_PCD_DeInit()
HAL_PCD_MspInit()
HAL_PCD_MspDeInit()
HAL_PCD_Init
Function Name
HAL_StatusTypeDef HAL_PCD_Init ( PCD_HandleTypeDef *

hpcd)
Initializes the PCD according to the specified parameters in the

PCD_InitTypeDef and create the associated handle.
Parameters
hpcd : PCD handle
Return values
HAL status
Notes
None.
DocID026525 Rev 1
321/692
26.2.3
UM1785
This subsection provides a set of functions allowing to manage the PCD data transfers.
26.2.4
HAL_PCD_Start()
HAL_PCD_Stop()
HAL_PCD_IRQHandler()
HAL_PCD_DataOutStageCallback()
HAL_PCD_DataInStageCallback()
HAL_PCD_SetupStageCallback()
HAL_PCD_SOFCallback()
HAL_PCD_ResetCallback()
HAL_PCD_SuspendCallback()
HAL_PCD_ResumeCallback()
HAL_PCD_ISOOUTIncompleteCallback()
HAL_PCD_ISOINIncompleteCallback()
HAL_PCD_ConnectCallback()
HAL_PCD_DisconnectCallback()

This subsection provides a set of functions allowing to control the PCD data transfers.
26.2.5
HAL_PCD_DevConnect()
HAL_PCD_DevDisconnect()
HAL_PCD_SetAddress()
HAL_PCD_EP_Open()
HAL_PCD_EP_Close()
HAL_PCD_EP_Receive()
HAL_PCD_EP_GetRxCount()
HAL_PCD_EP_Transmit()
HAL_PCD_EP_SetStall()
HAL_PCD_EP_ClrStall()
HAL_PCD_EP_Flush()
HAL_PCD_ActiveRemoteWakeup()
HAL_PCD_DeActiveRemoteWakeup()

26.2.6
322/692
HAL_PCD_GetState()
HAL_PCD_Init
DocID026525 Rev 1
UM1785
Function Name
26.2.7
26.2.8
26.2.9

HAL_StatusTypeDef HAL_PCD_Init ( PCD_HandleTypeDef *
hpcd)
Initializes the PCD according to the specified parameters in the

PCD_InitTypeDef and create the associated handle.
Parameters
hpcd : PCD handle
Return values
HAL status
Notes
None.
HAL_PCD_DeInit
Function Name
HAL_StatusTypeDef HAL_PCD_DeInit ( PCD_HandleTypeDef *

hpcd)
DeInitializes the PCD peripheral.
Parameters
hpcd : PCD handle
Return values
HAL status
Notes
None.
HAL_PCD_MspInit
Function Name
void HAL_PCD_MspInit ( PCD_HandleTypeDef * hpcd)
Initializes the PCD MSP.
Parameters
hpcd : PCD handle
Return values
None.
Notes
None.
HAL_PCD_MspDeInit
DocID026525 Rev 1
323/692

Function Name
26.2.10
26.2.11
26.2.12
DeInitializes PCD MSP.
Parameters
hpcd : PCD handle
Return values
None.
Notes
None.
HAL_PCD_Start
Function Name
HAL_StatusTypeDef HAL_PCD_Start ( PCD_HandleTypeDef *

hpcd)
Start The USB OTG Device.
Parameters
hpcd : PCD handle
Return values
HAL status
Notes
None.
HAL_PCD_Stop
Function Name
HAL_StatusTypeDef HAL_PCD_Stop ( PCD_HandleTypeDef *

hpcd)
Stop The USB OTG Device.
Parameters
hpcd : PCD handle
Return values
HAL status
Notes
None.
HAL_PCD_IRQHandler
Function Name
324/692
UM1785
void HAL_PCD_MspDeInit ( PCD_HandleTypeDef * hpcd)
void HAL_PCD_IRQHandler ( PCD_HandleTypeDef * hpcd)

DocID026525 Rev 1
UM1785
26.2.13
26.2.14
26.2.15

This function handles PCD interrupt request.
Parameters
hpcd : PCD handle
Return values
HAL status
Notes
None.
HAL_PCD_DataOutStageCallback
Function Name
void HAL_PCD_DataOutStageCallback ( PCD_HandleTypeDef

* hpcd, uint8_t epnum)
Data out stage callbacks.
Parameters
hpcd : PCD handle

epnum : endpoint number
Return values
None.
Notes
None.
HAL_PCD_DataInStageCallback
Function Name
void HAL_PCD_DataInStageCallback ( PCD_HandleTypeDef *

hpcd, uint8_t epnum)
Data IN stage callbacks.
Parameters
hpcd : PCD handle

Return values
None.
Notes
None.
HAL_PCD_SetupStageCallback
DocID026525 Rev 1
325/692

Function Name
26.2.16
26.2.17
26.2.18
Setup stage callback.
Parameters
hpcd : ppp handle
Return values
None.
Notes
None.
HAL_PCD_SOFCallback
Function Name
void HAL_PCD_SOFCallback ( PCD_HandleTypeDef * hpcd)
USB Start Of Frame callbacks.
Parameters
hpcd : PCD handle
Return values
None.
Notes
None.
HAL_PCD_ResetCallback
Function Name
void HAL_PCD_ResetCallback ( PCD_HandleTypeDef * hpcd)
USB Reset callbacks.
Parameters
hpcd : PCD handle
Return values
None.
Notes
None.
HAL_PCD_SuspendCallback
Function Name
326/692
UM1785
void HAL_PCD_SetupStageCallback ( PCD_HandleTypeDef *
hpcd)
void HAL_PCD_SuspendCallback ( PCD_HandleTypeDef *

hpcd)
DocID026525 Rev 1
UM1785
26.2.19
26.2.20
26.2.21

Suspend event callbacks.
Parameters
hpcd : PCD handle
Return values
None.
Notes
None.
HAL_PCD_ResumeCallback
Function Name
void HAL_PCD_ResumeCallback ( PCD_HandleTypeDef *

hpcd)
Resume event callbacks.
Parameters
hpcd : PCD handle
Return values
None.
Notes
None.
HAL_PCD_ISOOUTIncompleteCallback
Function Name
void HAL_PCD_ISOOUTIncompleteCallback (
PCD_HandleTypeDef * hpcd, uint8_t epnum)
Incomplete ISO OUT callbacks.
Parameters
hpcd : PCD handle

Return values
None.
Notes
None.
HAL_PCD_ISOINIncompleteCallback
Function Name
void HAL_PCD_ISOINIncompleteCallback (
DocID026525 Rev 1
327/692
UM1785
PCD_HandleTypeDef * hpcd, uint8_t epnum)
26.2.22
26.2.23
26.2.24
328/692
Incomplete ISO IN callbacks.
Parameters
hpcd : PCD handle

Return values
None.
Notes
None.
HAL_PCD_ConnectCallback
Function Name
void HAL_PCD_ConnectCallback ( PCD_HandleTypeDef *

hpcd)
Connection event callbacks.
Parameters
hpcd : PCD handle
Return values
None.
Notes
None.
HAL_PCD_DisconnectCallback
Function Name
void HAL_PCD_DisconnectCallback ( PCD_HandleTypeDef *

hpcd)
Disconnection event callbacks.
Parameters
hpcd : ppp handle
Return values
None.
Notes
None.
HAL_PCD_DevConnect
DocID026525 Rev 1
UM1785
26.2.25
26.2.26
26.2.27
Function Name

HAL_StatusTypeDef HAL_PCD_DevConnect (
PCD_HandleTypeDef * hpcd)
Parameters
hpcd : PCD handle
Return values
HAL status
Notes
None.
HAL_PCD_DevDisconnect
Function Name
HAL_StatusTypeDef HAL_PCD_DevDisconnect (
Parameters
hpcd : PCD handle
Return values
HAL status
Notes
None.
HAL_PCD_SetAddress
Function Name
HAL_StatusTypeDef HAL_PCD_SetAddress (
PCD_HandleTypeDef * hpcd, uint8_t address)
Set the USB Device address.
Parameters
hpcd : PCD handle

address : new device address
Return values
HAL status
Notes
None.
HAL_PCD_EP_Open
DocID026525 Rev 1
329/692

Function Name
26.2.28
26.2.29
330/692
UM1785
HAL_StatusTypeDef HAL_PCD_EP_Open (
PCD_HandleTypeDef * hpcd, uint8_t ep_addr, uint16_t
ep_mps, uint8_t ep_type)
Open and configure an endpoint.
Parameters
hpcd : PCD handle

ep_addr : endpoint address
ep_mps : endpoint max packert size
ep_type : endpoint type
Return values
HAL status
Notes
None.
HAL_PCD_EP_Close
Function Name
HAL_StatusTypeDef HAL_PCD_EP_Close (
PCD_HandleTypeDef * hpcd, uint8_t ep_addr)
Deactivate an endpoint.
Parameters
hpcd : PCD handle

Return values
HAL status
Notes
None.
HAL_PCD_EP_Receive
Function Name
HAL_StatusTypeDef HAL_PCD_EP_Receive (
PCD_HandleTypeDef * hpcd, uint8_t ep_addr, uint8_t * pBuf,
uint32_t len)
Receive an amount of data.
Parameters
hpcd : PCD handle

pBuf : pointer to the reception buffer
len : amount of data to be received
Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
26.2.30
26.2.31
26.2.32
HAL_PCD_EP_GetRxCount
Function Name
uint16_t HAL_PCD_EP_GetRxCount ( PCD_HandleTypeDef *

hpcd, uint8_t ep_addr)
Get Received Data Size.
Parameters
hpcd : PCD handle

Return values
Data Size
Notes
None.
HAL_PCD_EP_Transmit
Function Name
HAL_StatusTypeDef HAL_PCD_EP_Transmit (
PCD_HandleTypeDef * hpcd, uint8_t ep_addr, uint8_t * pBuf,
uint32_t len)
Send an amount of data.
Parameters
hpcd : PCD handle

pBuf : pointer to the transmission buffer
len : amount of data to be sent
Return values
HAL status
Notes
None.
HAL_PCD_EP_SetStall
Function Name
HAL_StatusTypeDef HAL_PCD_EP_SetStall (
Set a STALL condition over an endpoint.

DocID026525 Rev 1
331/692

Parameters
26.2.33
26.2.34
26.2.35
hpcd : PCD handle

Return values
HAL status
Notes
None.
HAL_PCD_EP_ClrStall
Function Name
HAL_StatusTypeDef HAL_PCD_EP_ClrStall (
Clear a STALL condition over in an endpoint.
Parameters
hpcd : PCD handle

Return values
HAL status
Notes
None.
HAL_PCD_EP_Flush
Function Name
HAL_StatusTypeDef HAL_PCD_EP_Flush (
Flush an endpoint.
Parameters
hpcd : PCD handle

Return values
HAL status
Notes
None.
HAL_PCD_ActiveRemoteWakeup
Function Name
332/692
UM1785
HAL_StatusTypeDef HAL_PCD_ActiveRemoteWakeup (
DocID026525 Rev 1
UM1785

26.2.36
26.2.37
HAL_PCD_ActiveRemoteWakeup : active remote wakeup

signalling.
Parameters
hpcd : PCD handle
Return values
status
Notes
None.
HAL_PCD_DeActiveRemoteWakeup
Function Name
HAL_StatusTypeDef HAL_PCD_DeActiveRemoteWakeup (
HAL_PCD_DeActiveRemoteWakeup : de-active remote wakeup

signalling.
Parameters
hpcd : PCD handle
Return values
status
Notes
None.
HAL_PCD_GetState
Function Name
PCD_StateTypeDef HAL_PCD_GetState ( PCD_HandleTypeDef

* hpcd)
Return the PCD state.
Parameters
hpcd : : PCD handle
Return values
HAL state
Notes
None.
DocID026525 Rev 1
333/692
UM1785
26.3
PCD Firmware driver defines
26.3.1
PCD
PCD
PCD Core PHY
PCD_PHY_EMBEDDED
PCD Core Speed
PCD_SPEED_HIGH
PCD_SPEED_FULL
PCD_ENDP_Type
PCD_ENDP0
PCD_ENDP1
PCD_ENDP2
PCD_ENDP3
PCD_ENDP4
PCD_ENDP5
PCD_ENDP6
PCD_ENDP7
PCD_SNG_BUF
PCD_DBL_BUF
IS_PCD_ALL_INSTANCE
PCD EP0 MPS
DEP0CTL_MPS_64
DEP0CTL_MPS_32
DEP0CTL_MPS_16
DEP0CTL_MPS_8
PCD_EP0MPS_64
PCD_EP0MPS_32
PCD_EP0MPS_16
PCD_EP0MPS_08
PCD EP Type
PCD_EP_TYPE_CTRL
PCD_EP_TYPE_ISOC
PCD_EP_TYPE_BULK
PCD_EP_TYPE_INTR
PCD Exported Macros
__HAL_PCD_GET_FLAG
334/692
DocID026525 Rev 1
UM1785

__HAL_PCD_CLEAR_FLAG
USB_EXTI_LINE_WAKEUP
External interrupt line 18 Connected to the USB

FS EXTI Line
__HAL_USB_EXTI_ENABLE_IT
__HAL_USB_EXTI_DISABLE_IT
__HAL_USB_EXTI_GENERATE_SWIT
PCD Private Define
BTABLE_ADDRESS
PCD Private Macros
PCD_SET_ENDPOINT
PCD_GET_ENDPOINT
PCD_SET_EPTYPE
Description:
sets the type in the endpoint register(bits

EP_TYPE[1:0])
Parameters:
USBx: USB peripheral instance register

address.
bEpNum: Endpoint Number.
wType: Endpoint Type.
Return value:
PCD_GET_EPTYPE
None:
Description:
gets the type in the endpoint register(bits

EP_TYPE[1:0])
Parameters:

address.
Return value:
PCD_FreeUserBuffer
Endpoint: Type
Description:
free buffer used from the application realizing

it to the line toggles bit SW_BUF in the double
buffered endpoint register
Parameters:

address.
bDir: Direction
Return value:
DocID026525 Rev 1
335/692
UM1785
None:
Description:
PCD_GET_DB_DIR
gets direction of the double buffered endpoint
Parameters:

address.
Return value:
EP_DBUF_OUT: if the endpoint counter not

yet programmed.
Description:
PCD_SET_EP_TX_STATUS
sets the status for tx transfer (bits

STAT_TX[1:0]).
Parameters:

address.
wState: new state
Return value:
PCD_SET_EP_RX_STATUS
None:
Description:
sets the status for rx transfer (bits

STAT_TX[1:0])
Parameters:

address.
wState: new state
Return value:
PCD_SET_EP_TXRX_STATUS
None:
Description:
sets the status for rx & tx (bits STAT_TX[1:0]

& STAT_RX[1:0])
Parameters:

address.
wStaterx: new state.
wStatetx: new state.
Return value:
336/692
None:
DocID026525 Rev 1
UM1785

PCD_GET_EP_TX_STATUS
Description:
gets the status for tx/rx transfer (bits

STAT_TX[1:0] /STAT_RX[1:0])
Parameters:

address.
Return value:
status:
PCD_GET_EP_RX_STATUS
Description:
PCD_SET_EP_TX_VALID
sets directly the VALID tx/rx-status into the

endpoint register
Parameters:

address.
Return value:
None:
PCD_SET_EP_RX_VALID
PCD_GET_EP_TX_STALL_STATUS
Description:
checks stall condition in an endpoint.
Parameters:

address.
Return value:
TRUE: = endpoint in stall condition.
PCD_GET_EP_RX_STALL_STATUS
PCD_SET_EP_KIND
Description:
set & clear EP_KIND bit.
Parameters:

address.
Return value:
None:
PCD_CLEAR_EP_KIND
PCD_SET_OUT_STATUS
Description:
DocID026525 Rev 1
337/692
UM1785
Sets/clears directly STATUS_OUT bit in the

endpoint register.
Parameters:

address.
Return value:
None:
PCD_CLEAR_OUT_STATUS
PCD_SET_EP_DBUF
Description:
Sets/clears directly EP_KIND bit in the

endpoint register.
Parameters:

address.
Return value:
None:
PCD_CLEAR_EP_DBUF
PCD_CLEAR_RX_EP_CTR
Description:
Clears bit CTR_RX / CTR_TX in the endpoint

register.
Parameters:

address.
Return value:
None:
PCD_CLEAR_TX_EP_CTR
PCD_RX_DTOG
Description:
Toggles DTOG_RX / DTOG_TX bit in the

endpoint register.
Parameters:

address.
Return value:
None:
PCD_TX_DTOG
PCD_CLEAR_RX_DTOG
338/692
Description:
DocID026525 Rev 1
UM1785
Clears DTOG_RX / DTOG_TX bit in the

endpoint register.
Parameters:

address.
Return value:
None:
PCD_CLEAR_TX_DTOG
Description:
PCD_SET_EP_ADDRESS
Sets address in an endpoint register.
Parameters:

address.
bAddr: Address.
Return value:
None:
Description:
PCD_GET_EP_ADDRESS
Gets address in an endpoint register.
Parameters:

address.
Return value:
None:
PCD_EP_TX_ADDRESS
PCD_EP_TX_CNT
PCD_EP_RX_ADDRESS
PCD_EP_RX_CNT
PCD_SET_EP_TX_ADDRESS
Description:
sets address of the tx/rx buffer.
Parameters:

address.
wAddr: address to be set (must be word
aligned).
Return value:
None:
DocID026525 Rev 1
339/692

PCD_SET_EP_RX_ADDRESS
PCD_GET_EP_TX_ADDRESS
UM1785
Description:
Gets address of the tx/rx buffer.
Parameters:

address.
Return value:
address: of the buffer.
PCD_GET_EP_RX_ADDRESS
Description:
PCD_CALC_BLK32
Sets counter of rx buffer with no.
Parameters:
dwReg: Register
wCount: Counter.
wNBlocks: no. of Blocks.
Return value:
None:
PCD_CALC_BLK2
PCD_SET_EP_CNT_RX_REG
PCD_SET_EP_RX_DBUF0_CNT
PCD_SET_EP_TX_CNT
Description:
sets counter for the tx/rx buffer.
Parameters:

address.
wCount: Counter value.
Return value:
None:
PCD_SET_EP_RX_CNT
PCD_GET_EP_TX_CNT
Description:
gets counter of the tx buffer.
Parameters:

address.
Return value:
340/692
Counter: value
DocID026525 Rev 1
UM1785

PCD_GET_EP_RX_CNT
PCD_SET_EP_DBUF0_ADDR
Description:
Sets buffer 0/1 address in a double buffer

endpoint.
Parameters:

address.
wBuf0Addr: buffer 0 address.
Return value:
Counter: value
PCD_SET_EP_DBUF1_ADDR
PCD_SET_EP_DBUF_ADDR
Description:
Sets addresses in a double buffer endpoint.
Parameters:

address.
wBuf0Addr: buffer 0 address.
wBuf1Addr: = buffer 1 address.
Return value:
PCD_GET_EP_DBUF0_ADDR
None:
Description:
Gets buffer 0/1 address of a double buffer

endpoint.
Parameters:

address.
Return value:
None:
PCD_GET_EP_DBUF1_ADDR
PCD_SET_EP_DBUF0_CNT
Description:
Gets buffer 0/1 address of a double buffer

endpoint.
Parameters:

address.
bDir: endpoint dir EP_DBUF_OUT = OUT
EP_DBUF_IN = IN
DocID026525 Rev 1
341/692
UM1785
wCount: Counter value
Return value:
None:
PCD_SET_EP_DBUF1_CNT
PCD_SET_EP_DBUF_CNT
PCD_GET_EP_DBUF0_CNT
Description:
Gets buffer 0/1 rx/tx counter for double

buffering.
Parameters:

address.
Return value:
None:
PCD_GET_EP_DBUF1_CNT
342/692
DocID026525 Rev 1
UM1785
HAL PCD Extension Driver
27
HAL PCD Extension Driver
27.1
PCDEx Firmware driver API description

The following section lists the various functions of the PCDEx library.
27.1.1
Peripheral extended features methods
27.1.2
HAL_PCDEx_PMAConfig()
HAL_PCDEx_PMAConfig
Function Name
HAL_StatusTypeDef HAL_PCDEx_PMAConfig (
PCD_HandleTypeDef * hpcd, uint16_t ep_addr, uint16_t
ep_kind, uint32_t pmaadress)
Configure PMA for EP.
Parameters
hpcd : PCD handle

ep_kind : endpoint Kind
USB_SNG_BUF Single Buffer used
USB_DBL_BUF Double Buffer used

pmaadress : EP address in The PMA: In case of single
buffer endpoint this parameter is 16-bit value providing the
address in PMA allocated to endpoint. In case of double
buffer endpoint this parameter is a 32-bit value providing the
endpoint buffer 0 address in the LSB part of 32-bit value and
endpoint buffer 1 address in the MSB part of 32-bit value.
Return values
: status
Notes
None.
DocID026525 Rev 1
343/692
HAL PWR Generic Driver
UM1785
28
28.1
PWR Firmware driver API description

The following section lists the various functions of the PWR library.
28.1.1

After reset, the backup domain (RTC registers, RTC backup data registers) is protected
against possible unwanted write accesses. To enable access to the RTC Domain and RTC
registers, proceed as follows:
28.1.2
Enable the Power Controller (PWR) APB1 interface clock using the
__PWR_CLK_ENABLE() macro.
Enable access to RTC domain using the HAL_PWR_EnableBkUpAccess() function.
WakeUp pin configuration
WakeUp pin is used to wakeup the system from Standby mode. This pin is forced in
input pull down configuration and is active on rising edges.
There are two WakeUp pins, and up to eight Wakeup pins on STM32F07x &
STM32F09x devices.
WakeUp Pin 1 on PA.00.
WakeUp Pin 2 on PC.13.
WakeUp Pin 3 on PE.06.(STM32F07x/STM32F09x)
WakeUp Pin 4 on PA.02.(STM32F07x/STM32F09x)
WakeUp Pin 5 on PC.05.(STM32F07x/STM32F09x)
WakeUp Pin 6 on PB.05.(STM32F07x/STM32F09x)
WakeUp Pin 7 on PB.15.(STM32F07x/STM32F09x)
WakeUp Pin 8 on PF.02.(STM32F07x/STM32F09x)
Low Power modes configuration

The devices feature 3 low-power modes:
Sleep mode: Cortex-M0 core stopped, peripherals kept running.

Stop mode: all clocks are stopped, regulator running, regulator in low power mode
Standby mode: 1.2V domain powered off (mode not available on STM32F0x8
devices).
Sleep mode
344/692
Entry: The Sleep mode is entered by using the

HAL_PWR_EnterSLEEPMode(PWR_MAINREGULATOR_ON,
PWR_SLEEPENTRY_WFx) functions with
PWR_SLEEPENTRY_WFI: enter SLEEP mode with WFI instruction
PWR_SLEEPENTRY_WFE: enter SLEEP mode with WFE instruction

DocID026525 Rev 1
UM1785
Exit:
Any peripheral interrupt acknowledged by the nested vectored interrupt controller

(NVIC) can wake up the device from Sleep mode.
Stop mode
In Stop mode, all clocks in the 1.8V domain are stopped, the PLL, the HSI, and the HSE
RC oscillators are disabled. Internal SRAM and register contents are preserved. The
voltage regulator can be configured either in normal or low-power mode. To minimize the
consumption.
Entry: The Stop mode is entered using the

HAL_PWR_EnterSTOPMode(PWR_MAINREGULATOR_ON,
PWR_STOPENTRY_WFI ) function with:
Main regulator ON.
Low Power regulator ON.
PWR_STOPENTRY_WFI: enter STOP mode with WFI instruction
PWR_STOPENTRY_WFE: enter STOP mode with WFE instruction

Exit:
Any EXTI Line (Internal or External) configured in Interrupt/Event mode.
Some specific communication peripherals (CEC, USART, I2C) interrupts, when

programmed in wakeup mode (the peripheral must be programmed in wakeup
mode and the corresponding interrupt vector must be enabled in the NVIC)
Standby mode
The Standby mode allows to achieve the lowest power consumption. It is based on the
Cortex-M0 deep sleep mode, with the voltage regulator disabled. The 1.8V domain is
consequently powered off. The PLL, the HSI oscillator and the HSE oscillator are also
switched off. SRAM and register contents are lost except for the RTC registers, RTC
backup registers and Standby circuitry. The voltage regulator is OFF.
Entry:
The Standby mode is entered using the HAL_PWR_EnterSTANDBYMode()

function.
Exit:
WKUP pin rising edge, RTC alarm (Alarm A), RTC wakeup, tamper event, timestamp event, external reset in NRST pin, IWDG reset.
Auto-wakeup (AWU) from low-power mode

The MCU can be woken up from low-power mode by an RTC Alarm event, an RTC
Wakeup event, a tamper event, a time-stamp event, or a comparator event, without
depending on an external interrupt (Auto-wakeup mode).
RTC auto-wakeup (AWU) from the Stop and Standby modes
To wake up from the Stop mode with an RTC alarm event, it is necessary to
configure the RTC to generate the RTC alarm using the
HAL_RTC_SetAlarm_IT() function.
To wake up from the Stop mode with an RTC Tamper or time stamp event, it is
necessary to configure the RTC to detect the tamper or time stamp event using
the HAL_RTC_SetTimeStamp_IT() or HAL_RTC_SetTamper_IT() functions.
To wake up from the Stop mode with an RTC WakeUp event, it is necessary to
configure the RTC to generate the RTC WakeUp event using the
HAL_RTC_SetWakeUpTimer_IT() function.
Comparator auto-wakeup (AWU) from the Stop mode
DocID026525 Rev 1
345/692
UM1785
28.1.3
28.1.4
346/692
To wake up from the Stop mode with a comparator wakeup event, it is necessary
to:
Configure the EXTI Line associated with the comparator (example EXTI
Line 22 for comparator 2) to be sensitive to to the selected edges (falling,
rising or falling and rising) (Interrupt or Event modes) using the EXTI_Init()
function.
Configure the comparator to generate the event.

HAL_PWR_EnableWakeUpPin()
HAL_PWR_DisableWakeUpPin()
HAL_PWR_EnterSLEEPMode()
HAL_PWR_EnterSTOPMode()
HAL_PWR_EnterSTANDBYMode()
HAL_PWR_EnableSleepOnExit()
HAL_PWR_DisableSleepOnExit()
HAL_PWR_EnableSEVOnPend()
HAL_PWR_DisableSEVOnPend()
HAL_PWR_EnableBkUpAccess()
HAL_PWR_DisableBkUpAccess()
HAL_PWR_EnableBkUpAccess
Function Name
void HAL_PWR_EnableBkUpAccess ( void )
Enables access to the backup domain (RTC registers, RTC

backup data registers).
Return values
None.
Notes
If the HSE divided by 32 is used as the RTC clock, the

Backup Domain Access should be kept enabled.
HAL_PWR_DisableBkUpAccess
Function Name
void HAL_PWR_DisableBkUpAccess ( void )
Disables access to the backup domain (RTC registers, RTC

Return values
None.
Notes

DocID026525 Rev 1
UM1785
28.1.5
28.1.6
28.1.7
HAL_PWR_EnableWakeUpPin
Function Name
void HAL_PWR_EnableWakeUpPin ( uint32_t WakeUpPinx)
Enables the WakeUp PINx functionality.
Parameters
WakeUpPinx : Specifies the Power Wake-Up pin to enable.

This parameter can be value of : PWREx Wakeup Pins
Return values
None.
Notes
None.
HAL_PWR_DisableWakeUpPin
Function Name
void HAL_PWR_DisableWakeUpPin ( uint32_t WakeUpPinx)
Disables the WakeUp PINx functionality.
Parameters
WakeUpPinx : Specifies the Power Wake-Up pin to disable.

This parameter can be values of : PWREx Wakeup Pins
Return values
None.
Notes
None.
HAL_PWR_EnterSLEEPMode
Function Name
void HAL_PWR_EnterSLEEPMode ( uint32_t Regulator,

uint8_t SLEEPEntry)
Enters Sleep mode.
Parameters
Regulator : Specifies the regulator state in SLEEP mode. On

STM32F0 devices, this parameter is a dummy value and it is
ignored as regulator can't be modified in this mode.
Parameter is kept for platform compatibility.
SLEEPEntry : Specifies if SLEEP mode is entered with WFI
or WFE instruction. When WFI entry is used, tick interrupt
have to be disabled if not desired as the interrupt wake up
source. This parameter can be one of the following values:
PWR_SLEEPENTRY_WFI enter SLEEP mode with WFI

instruction
DocID026525 Rev 1
347/692
UM1785
28.1.8
Return values
None.
Notes
In Sleep mode, all I/O pins keep the same state as in Run
mode.
HAL_PWR_EnterSTOPMode
Function Name
void HAL_PWR_EnterSTOPMode ( uint32_t Regulator, uint8_t

STOPEntry)
Enters STOP mode.
Parameters
Regulator : Specifies the regulator state in STOP mode.

PWR_MAINREGULATOR_ON STOP mode with

regulator ON
PWR_LOWPOWERREGULATOR_ON STOP mode with

low power regulator ON
STOPEntry : specifies if STOP mode in entered with WFI or
WFE instruction. This parameter can be one of the following
values:
PWR_STOPENTRY_WFIEnter STOP mode with WFI

instruction
PWR_STOPENTRY_WFE Enter STOP mode with WFE

instruction
Return values
None.
Notes
In Stop mode, all I/O pins keep the same state as in Run
mode.
When exiting Stop mode by issuing an interrupt or a wakeup
event, the HSI RC oscillator is selected as system clock.
When the voltage regulator operates in low power mode, an
additional startup delay is incurred when waking up from Stop
mode. By keeping the internal regulator ON during Stop
mode, the consumption is higher although the startup time is
reduced.
28.1.9
348/692
PWR_SLEEPENTRY_WFE enter SLEEP mode with

WFE instruction
HAL_PWR_EnterSTANDBYMode
DocID026525 Rev 1
UM1785
28.1.10
28.1.11
Function Name

void HAL_PWR_EnterSTANDBYMode ( void )
Enters STANDBY mode.
Return values
None.
Notes
In Standby mode, all I/O pins are high impedance except for:
Reset pad (still available)RTC alternate function pins if
configured for tamper, time-stamp, RTC Alarm out, or RTC
clock calibration out.WKUP pins if enabled. STM32F0x8
devices, the Stop mode is available, but it is aningless to
distinguish between voltage regulator in Low power mode and
voltage regulator in Run mode because the regulator not used
and the core is supplied directly from an external source.
Consequently, the Standby mode is not available on those
devices.
HAL_PWR_EnableSleepOnExit
Function Name
void HAL_PWR_EnableSleepOnExit ( void )
Indicates Sleep-On-Exit when returning from Handler mode to

Thread mode.
Return values
None.
Notes
Set SLEEPONEXIT bit of SCR register. When this bit is set,

the processor re-enters SLEEP mode when an interruption
handling is over. Setting this bit is useful when the processor
is expected to run only on interruptions handling.
HAL_PWR_DisableSleepOnExit
Function Name
void HAL_PWR_DisableSleepOnExit ( void )
Disables Sleep-On-Exit feature when returning from Handler

mode to Thread mode.
Return values
None.
Notes
Clears SLEEPONEXIT bit of SCR register. When this bit is

set, the processor re-enters SLEEP mode when an
interruption handling is over.
DocID026525 Rev 1
349/692
28.1.12
28.1.13
28.1.14
350/692
UM1785
HAL_PWR_EnableSEVOnPend
Function Name
void HAL_PWR_EnableSEVOnPend ( void )
Enables CORTEX M4 SEVONPEND bit.
Return values
None.
Notes
Sets SEVONPEND bit of SCR register. When this bit is set,

this causes WFE to wake up when an interrupt moves from
inactive to pended.
HAL_PWR_DisableSEVOnPend
Function Name
void HAL_PWR_DisableSEVOnPend ( void )
Disables CORTEX M4 SEVONPEND bit.
Return values
None.
Notes
Clears SEVONPEND bit of SCR register. When this bit is set,

this causes WFE to wake up when an interrupt moves from
inactive to pended.
HAL_PWR_EnableBkUpAccess
Function Name
void HAL_PWR_EnableBkUpAccess ( void )
Enables access to the backup domain (RTC registers, RTC

Return values
None.
Notes

DocID026525 Rev 1
UM1785
28.1.15
HAL_PWR_DisableBkUpAccess
Function Name
void HAL_PWR_DisableBkUpAccess ( void )
Disables access to the backup domain (RTC registers, RTC

Return values
None.
Notes

28.2
PWR Firmware driver defines
28.2.1
PWR
PWR
PWR Exported Macro
__HAL_PWR_GET_FLAG
Description:
Check PWR flag is set or not.
Parameters:
__FLAG__: specifies the flag to check. This parameter

PWR_FLAG_WU: Wake Up flag. This flag

indicates that a wakeup event was received from
the WKUP pin or from the RTC alarm (Alarm A),
RTC Tamper event, RTC TimeStamp event or
RTC Wakeup. An additional wakeup event is
detected if the WKUP pin is enabled (by setting
the EWUP bit) when the WKUP pin level is
already high.
PWR_FLAG_SB: StandBy flag. This flag

indicates that the system was resumed from
StandBy mode.
PWR_FLAG_PVDO: PVD Output. This flag is

valid only if PVD is enabled by the
HAL_PWR_EnablePVD() function. The PVD is
stopped by Standby mode For this reason, this bit
is equal to 0 after Standby or reset until the
PVDE bit is set. Warning: this Flag is not
available on STM32F030x8 products
PWR_FLAG_VREFINTRDY: This flag indicates

that the internal reference voltage VREFINT is
ready. Warning: this Flag is not available on
DocID026525 Rev 1
351/692
UM1785
STM32F030x8 products
Return value:
__HAL_PWR_CLEAR_FLAG
The: new state of __FLAG__ (TRUE or FALSE).
Description:
Clear the PWR's pending flags.
Parameters:
__FLAG__: specifies the flag to clear. This parameter

PWR_FLAG_WU: Wake Up flag
PWR_FLAG_SB: StandBy flag
PWR Regulator state in STOP mode

PWR_MAINREGULATOR_ON
PWR_LOWPOWERREGULATOR_ON
IS_PWR_REGULATOR
PWR SLEEP mode entry
PWR_SLEEPENTRY_WFI
PWR_SLEEPENTRY_WFE
IS_PWR_SLEEP_ENTRY
PWR STOP mode entry
PWR_STOPENTRY_WFI
PWR_STOPENTRY_WFE
IS_PWR_STOP_ENTRY
352/692
DocID026525 Rev 1
UM1785
HAL PWR Extension Driver
29
29.1
PWREx Firmware driver registers structures
29.1.1
PWR_PVDTypeDef
PWR_PVDTypeDef is defined in the stm32f0xx_hal_pwr_ex.h
Data Fields
uint32_t PVDLevel
uint32_t Mode
Field Documentation
29.2
uint32_t PWR_PVDTypeDef::PVDLevel PVDLevel: Specifies the PVD detection

level This parameter can be a value of PWREx_PVD_detection_level
uint32_t PWR_PVDTypeDef::Mode Mode: Specifies the operating mode for the
selected pins. This parameter can be a value of PWREx_PVD_Mode
PWREx Firmware driver API description

The following section lists the various functions of the PWREx library.
29.2.1
Peripheral extended control functions
PVD configuration
The PVD is used to monitor the VDD power supply by comparing it to a threshold
selected by the PVD Level (PLS[2:0] bits in the PWR_CR).
A PVDO flag is available to indicate if VDD/VDDA is higher or lower than the PVD
threshold. This event is internally connected to the EXTI line16 and can generate an
interrupt if enabled. This is done through HAL_PWR_PVDConfig(),
HAL_PWR_EnablePVD() functions.
The PVD is stopped in Standby mode. PVD is not available on STM32F030x4/x6/x8
VDDIO2 Monitor Configuration
VDDIO2 monitor is used to monitor the VDDIO2 power supply by comparing it to

VREFInt Voltage
This monitor is internally connected to the EXTI line31 and can generate an interrupt
if enabled. This is done through HAL_PWR_EnableVddio2Monitor() function. VDDIO2
is available on STM32F07x/09x/04x
HAL_PWR_PVDConfig()
HAL_PWR_EnablePVD()
HAL_PWR_DisablePVD()
HAL_PWR_PVD_IRQHandler()
DocID026525 Rev 1
353/692
29.2.2
29.2.3
29.2.4
354/692
UM1785
HAL_PWR_PVDCallback()
HAL_PWR_EnableVddio2Monitor()
HAL_PWR_DisableVddio2Monitor()
HAL_PWR_Vddio2Monitor_IRQHandler()
HAL_PWR_Vddio2MonitorCallback()
HAL_PWR_PVDConfig
Function Name
void HAL_PWR_PVDConfig ( PWR_PVDTypeDef *

sConfigPVD)
Configures the voltage threshold detected by the Power Voltage

Detector(PVD).
Parameters
sConfigPVD : pointer to an PWR_PVDTypeDef structure

that contains the configuration information for the PVD.
Return values
None.
Notes
Refer to the electrical characteristics of your device datasheet

for more details about the voltage threshold corresponding to
each detection level.
HAL_PWR_EnablePVD
Function Name
void HAL_PWR_EnablePVD ( void )
Enables the Power Voltage Detector(PVD).
Return values
None.
Notes
None.
HAL_PWR_DisablePVD
Function Name
void HAL_PWR_DisablePVD ( void )
Disables the Power Voltage Detector(PVD).
Return values
None.
Notes
None.
DocID026525 Rev 1
UM1785
29.2.5
29.2.6
29.2.7
HAL_PWR_PVD_IRQHandler
Function Name
void HAL_PWR_PVD_IRQHandler ( void )
This function handles the PWR PVD interrupt request.
Return values
None.
Notes
This API should be called under the PVD_IRQHandler() or

PVD_VDDIO2_IRQHandler().
HAL_PWR_PVDCallback
Function Name
void HAL_PWR_PVDCallback ( void )
PWR PVD interrupt callback.
Return values
None.
Notes
None.
HAL_PWR_EnableVddio2Monitor
Function Name
void HAL_PWR_EnableVddio2Monitor ( void )
Enable VDDIO2 monitor: enable Exti 31 and falling edge

detection.
Return values
None.
Notes
If Exti 31 is enable correlty and VDDIO2 voltage goes below

Vrefint, an interrupt is generated Irq line 1. NVIS has to be
enable by user.
DocID026525 Rev 1
355/692
29.2.8
29.2.9
29.2.10
UM1785
HAL_PWR_DisableVddio2Monitor
Function Name
void HAL_PWR_DisableVddio2Monitor ( void )
Disable the Vddio2 Monitor.
Return values
None.
Notes
None.
HAL_PWR_Vddio2Monitor_IRQHandler
Function Name
void HAL_PWR_Vddio2Monitor_IRQHandler ( void )
This function handles the PWR Vddio2 monitor interrupt request.
Return values
None.
Notes
This API should be called under the VDDIO2_IRQHandler()

PVD_VDDIO2_IRQHandler().
HAL_PWR_Vddio2MonitorCallback
Function Name
void HAL_PWR_Vddio2MonitorCallback ( void )
PWR Vddio2 Monitor interrupt callback.
Return values
None.
Notes
None.
29.3
PWREx Firmware driver defines
29.3.1
PWREx
PWREx
PWREx Exported Macros
356/692
DocID026525 Rev 1
UM1785
__HAL_PWR_PVD_EXTI_ENABLE_IT

Description:
Enable interrupt
on PVD Exti Line
16.
Return value:
__HAL_PWR_PVD_EXTI_DISABLE_IT
None.:
Description:
Disable interrupt
on PVD Exti Line
16.
Return value:
__HAL_PWR_PVD_EXTI_ENABLE_EVENT
None.:
Description:
Enable event on
PVD Exti Line 16.
Return value:
__HAL_PWR_PVD_EXTI_DISABLE_EVENT
None.:
Description:
Disable event on
PVD Exti Line 16.
Return value:
__HAL_PWR_PVD_EXTI_CLEAR_EGDE_TRIGGER
None.:
Description:
PVD EXTI line

configuration: clear
falling edge and
rising edge trigger.
Return value:
__HAL_PWR_PVD_EXTI_SET_FALLING_EGDE_TRIGGER
None.:
Description:
PVD EXTI line

configuration: set
falling edge
trigger.
Return value:
__HAL_PWR_PVD_EXTI_SET_RISING_EDGE_TRIGGER
None.:
Description:
PVD EXTI line

configuration: set
Return value:
DocID026525 Rev 1
357/692
UM1785
__HAL_PWR_PVD_EXTI_GET_FLAG
None.:
Description:
Check whether the

specified PVD
EXTI interrupt flag
is set or not.
Return value:
__HAL_PWR_PVD_EXTI_CLEAR_FLAG
EXTI: PVD Line

Status.
Description:
Clear the PVD

EXTI flag.
Return value:
__HAL_PWR_PVD_EXTI_GENERATE_SWIT
None.:
Description:
Generate a
Software interrupt
on selected EXTI
line.
Return value:
__HAL_PWR_VDDIO2_EXTI_ENABLE_IT
None.:
Description:
Enable interrupt
on Vddio2 Monitor
Exti Line 31.
Return value:
__HAL_PWR_VDDIO2_EXTI_DISABLE_IT
None.:
Description:
Disable interrupt
on Vddio2 Monitor
Exti Line 31.
Return value:
__HAL_PWR_VDDIO2_EXTI_CLEAR_EGDE_TRIGGER
None.:
Description:
Vddio2 Monitor
EXTI line
configuration: clear
falling edge and
Return value:
358/692
DocID026525 Rev 1
None.:
UM1785

__HAL_PWR_VDDIO2_EXTI_SET_FALLING_EGDE_TRIGGER Description:
Vddio2 Monitor
EXTI line
configuration: set
falling edge
trigger.
Return value:
__HAL_PWR_VDDIO2_EXTI_GET_FLAG
None.:
Description:
Check whether the

specified VDDIO2
monitor EXTI
interrupt flag is set
or not.
Return value:
__HAL_PWR_VDDIO2_EXTI_CLEAR_FLAG
EXTI: VDDIO2
Monitor Line
Status.
Description:
Clear the VDDIO2

Monitor EXTI flag.
Return value:
__HAL_PWR_VDDIO2_EXTI_GENERATE_SWIT
None.:
Description:
Generate a
Software interrupt
on selected EXTI
line.
Return value:
None.:
PWREx EXTI Line

PWR_EXTI_LINE_PVD
External interrupt line 16 Connected to the PVD EXTI Line
PWR_EXTI_LINE_VDDIO2
External interrupt line 31 Connected to the Vddio2 Monitor

EXTI Line
PWREx Flag
PWR_FLAG_WU
PWR_FLAG_SB
PWR_FLAG_PVDO
PWR_FLAG_VREFINTRDY
PWREx Private Constants
PVD_MODE_IT
DocID026525 Rev 1
359/692

PVD_MODE_EVT
UM1785
PVD_RISING_EDGE
PVD_FALLING_EDGE
PWREx PVD detection level
PWR_PVDLEVEL_0
PWR_PVDLEVEL_1
PWR_PVDLEVEL_2
PWR_PVDLEVEL_3
PWR_PVDLEVEL_4
PWR_PVDLEVEL_5
PWR_PVDLEVEL_6
PWR_PVDLEVEL_7
IS_PWR_PVD_LEVEL
PWREx PVD Mode
PWR_PVD_MODE_NORMAL
basic mode is used
PWR_PVD_MODE_IT_RISING
External Interrupt Mode with Rising edge

trigger detection
PWR_PVD_MODE_IT_FALLING
External Interrupt Mode with Falling

PWR_PVD_MODE_IT_RISING_FALLING
External Interrupt Mode with

Rising/Falling edge trigger detection
PWR_PVD_MODE_EVENT_RISING
Event Mode with Rising edge trigger

detection
PWR_PVD_MODE_EVENT_FALLING
Event Mode with Falling edge trigger

detection
PWR_PVD_MODE_EVENT_RISING_FALLING
Event Mode with Rising/Falling edge

trigger detection
IS_PWR_PVD_MODE
PWREx Wakeup Pins
PWR_WAKEUP_PIN1
PWR_WAKEUP_PIN2
PWR_WAKEUP_PIN3
PWR_WAKEUP_PIN4
PWR_WAKEUP_PIN5
PWR_WAKEUP_PIN6
PWR_WAKEUP_PIN7
PWR_WAKEUP_PIN8
IS_PWR_WAKEUP_PIN
360/692
DocID026525 Rev 1
UM1785
HAL RCC Generic Driver
30
30.1
RCC Firmware driver registers structures
30.1.1
RCC_PLLInitTypeDef
RCC_PLLInitTypeDef is defined in the stm32f0xx_hal_rcc.h
Data Fields
uint32_t PLLState
uint32_t PLLSource
uint32_t PREDIV
uint32_t PLLMUL
Field Documentation
30.1.2
uint32_t RCC_PLLInitTypeDef::PLLState PLLState: The new state of the PLL. This

parameter can be a value of RCC_PLL_Config
uint32_t RCC_PLLInitTypeDef::PLLSource PLLSource: PLL entry clock source.
This parameter must be a value of RCC_PLL_Clock_Source
uint32_t RCC_PLLInitTypeDef::PREDIV PREDIV: Predivision factor for PLL VCO
input clock This parameter must be a value of RCC_PLL_Prediv_Factor
uint32_t RCC_PLLInitTypeDef::PLLMUL PLLMUL: Multiplication factor for PLL VCO
input clock This parameter must be a value of RCC_PLL_Multiplication_Factor
RCC_OscInitTypeDef
RCC_OscInitTypeDef is defined in the stm32f0xx_hal_rcc.h
Data Fields
uint32_t OscillatorType
uint32_t HSEState
uint32_t LSEState
uint32_t HSIState
uint32_t HSICalibrationValue
uint32_t HSI14State
uint32_t HSI14CalibrationValue
uint32_t HSI48State
uint32_t LSIState
RCC_PLLInitTypeDef PLL
Field Documentation
uint32_t RCC_OscInitTypeDef::OscillatorType The Oscillators to be configured.

This parameter can be a value of RCC_Oscillator_Type
uint32_t RCC_OscInitTypeDef::HSEState The new state of the HSE. This
parameter can be a value of RCC_HSE_Config
uint32_t RCC_OscInitTypeDef::LSEState The new state of the LSE. This parameter
can be a value of RCC_LSE_Config
DocID026525 Rev 1
361/692
30.1.3
UM1785
uint32_t RCC_OscInitTypeDef::HSIState The new state of the HSI. This parameter

can be a value of RCC_HSI_Config
uint32_t RCC_OscInitTypeDef::HSICalibrationValue The HSI calibration trimming
value (default is RCC_HSICALIBRATION_DEFAULT). This parameter must be a
number between Min_Data = 0x00 and Max_Data = 0x1F
uint32_t RCC_OscInitTypeDef::HSI14State The new state of the HSI14. This
parameter can be a value of RCC_HSI14_Config
uint32_t RCC_OscInitTypeDef::HSI14CalibrationValue The HSI14 calibration
trimming value (default is RCC_HSI14CALIBRATION_DEFAULT). This parameter
must be a number between Min_Data = 0x00 and Max_Data = 0x1F
uint32_t RCC_OscInitTypeDef::HSI48State The new state of the HSI48 (only
applicable to STM32F07x, STM32F0x2 and STM32F09x devices). This parameter can
be a value of RCCEx_HSI48_Config
uint32_t RCC_OscInitTypeDef::LSIState The new state of the LSI. This parameter
can be a value of RCC_LSI_Config
RCC_PLLInitTypeDef RCC_OscInitTypeDef::PLL PLL structure parameters
RCC_ClkInitTypeDef
RCC_ClkInitTypeDef is defined in the stm32f0xx_hal_rcc.h
Data Fields
uint32_t ClockType
uint32_t SYSCLKSource
uint32_t AHBCLKDivider
uint32_t APB1CLKDivider
Field Documentation
30.2
uint32_t RCC_ClkInitTypeDef::ClockType The clock to be configured. This

parameter can be a value of RCC_System_Clock_Type
uint32_t RCC_ClkInitTypeDef::SYSCLKSource The clock source (SYSCLK) used
as system clock. This parameter can be a value of RCC_System_Clock_Source
uint32_t RCC_ClkInitTypeDef::AHBCLKDivider The AHB clock (HCLK) divider.
This clock is derived from the system clock (SYSCLK). This parameter can be a value
of RCC_AHB_Clock_Source
uint32_t RCC_ClkInitTypeDef::APB1CLKDivider The APB1 clock (PCLK1) divider.
This clock is derived from the AHB clock (HCLK). This parameter can be a value of
RCC_APB1_Clock_Source
RCC Firmware driver API description

The following section lists the various functions of the RCC library.
30.2.1
RCC specific features

After reset the device is running from Internal High Speed oscillator (HSI 8MHz) with Flash
0 wait state, Flash prefetch buffer is disabled, and all peripherals are off except internal
SRAM, Flash and JTAG.
362/692
DocID026525 Rev 1
UM1785
There is no prescaler on High speed (AHB) and Low speed (APB) busses; all
peripherals mapped on these busses are running at HSI speed.
The clock for all peripherals is switched off, except the SRAM and FLASH.
All GPIOs are in input floating state, except the JTAG pins which are assigned to be
used for debug purpose.
Once the device started from reset, the user application has to:
30.2.2
Configure the clock source to be used to drive the System clock (if the application
needs higher frequency/performance)
Configure the System clock frequency and Flash settings
Configure the AHB and APB busses prescalers
Enable the clock for the peripheral(s) to be used
Configure the clock source(s) for peripherals which clocks are not derived from the
System clock (RTC, ADC, I2C, USART, TIM, USB FS, etc..)
RCC Limitations
A delay between an RCC peripheral clock enable and the effective peripheral enabling
should be taken into account in order to manage the peripheral read/write from/to
registeres.
This delay depends on the peripheral mapping.

If peripheral is mapped on AHB: the delay is 2 AHB clock cycle after the clock enable
bit is set on the hardware register
If peripheral is mapped on APB: the delay is 2 APB clock cycle after the clock enable
bit is set on the hardware register
Possible Workarounds:
1.
2.
3.
30.2.3
Enable the peripheral clock sometimes before the peripheral read/write register is
required.
For AHB peripheral, insert two dummy read to the peripheral register.
For APB peripheral, insert a dummy read to the peripheral register.
Initialization and de-initialization function

This section provide functions allowing to configure the internal/external oscillators (HSE,
HSI, HSI14, HSI48, LSE, LSI, PLL, CSS and MCO) and the System busses clocks
(SYSCLK, AHB and APB1).
Internal/external clock and PLL configuration
1.
2.
3.
4.
5.
6.
HSI (high-speed internal), 8 MHz factory-trimmed RC used directly or through the PLL
as System clock source. The HSI clock can be used also to clock the USART and I2C
peripherals.
HSI14 (high-speed internal), 14 MHz factory-trimmed RC used directly to clock the
ADC peripheral.
LSI (low-speed internal), 40 KHz low consumption RC used as IWDG and/or RTC
clock source.
HSE (high-speed external), 4 to 32 MHz crystal oscillator used directly or through the
PLL as System clock source. Can be used also as RTC clock source.
LSE (low-speed external), 32 KHz oscillator used as RTC clock source.
PLL (clocked by HSI, HSI48 or HSE), featuring different output clocks:
The first output is used to generate the high speed system clock (up to 48 MHz)
The second output is used to generate the clock for the USB FS (48 MHz)
DocID026525 Rev 1
363/692
UM1785
7.
8.
The third output may be used to generate the clock for the TIM, I2C and USART
peripherals (up to 48 MHz)
CSS (Clock security system), once enable using the macro
__HAL_RCC_CSS_ENABLE() and if a HSE clock failure occurs(HSE used directly or
through PLL as System clock source), the System clockis automatically switched to
HSI and an interrupt is generated if enabled. The interrupt is linked to the Cortex-M0
NMI (Non-Maskable Interrupt) exception vector.
MCO (microcontroller clock output), used to output SYSCLK, HSI, HSE, LSI, LSE or
PLL clock (divided by 2) output on pin (such as PA8 pin).
System, AHB and APB busses clocks configuration

1.
2.
3.
4.
Several clock sources can be used to drive the System clock (SYSCLK): HSI, HSE
and PLL. The AHB clock (HCLK) is derived from System clock through configurable
prescaler and used to clock the CPU, memory and peripherals mapped on AHB bus
(DMA, GPIO...). APB1 (PCLK1) clock is derived from AHB clock through configurable
prescalers and used to clock the peripherals mapped on these busses. You can use
"HAL_RCC_GetSysClockFreq()" function to retrieve the frequencies of these clocks.
All the peripheral clocks are derived from the System clock (SYSCLK) except:
The FLASH program/erase clock which is always HSI 8MHz clock.
The USB 48 MHz clock which is derived from the PLL VCO clock.
The USART clock which can be derived as well from HSI 8MHz, LSI or LSE.
The I2C clock which can be derived as well from HSI 8MHz clock.
The ADC clock which is derived from PLL output.
The RTC clock which is derived from the LSE, LSI or 1 MHz HSE_RTC (HSE
divided by a programmable prescaler). The System clock (SYSCLK) frequency
must be higher or equal to the RTC clock frequency.
IWDG clock which is always the LSI clock.

For the STM32F0xx devices, the maximum frequency of the SYSCLK, HCLK and
PCLK1 is 48 MHz, Depending on the SYSCLK frequency, the flash latency should be
adapted according to the below table.
After reset, the System clock source is the HSI (8 MHz) with 0 WS and prefetch is
disabled.
Table 20: Number of wait states (WS) according to system clock (SYSCLK) frequency
Latency
SYSCLK clock frequency (MHz)
0WS (1CPU cycle)
0 SYSCLK 24
1WS (2CPU cycles)
24 < HCLK 48
30.2.4
HAL_RCC_DeInit()
HAL_RCC_OscConfig()
HAL_RCC_ClockConfig()

This subsection provides a set of functions allowing to control the RCC Clocks
frequencies.
364/692
HAL_RCC_MCOConfig()
HAL_RCC_EnableCSS()
HAL_RCC_DisableCSS()
HAL_RCC_GetSysClockFreq()
HAL_RCC_GetHCLKFreq()
HAL_RCC_GetPCLK1Freq()
DocID026525 Rev 1
UM1785
30.2.5
HAL_RCC_GetOscConfig()
HAL_RCC_GetClockConfig()
HAL_RCC_NMI_IRQHandler()
HAL_RCC_CCSCallback()
HAL_RCC_DeInit
Function Name
void HAL_RCC_DeInit ( void )
Resets the RCC clock configuration to the default reset state.
Return values
None.
Notes
The default reset state of the clock configuration is given

below: HSI ON and used as system clock sourceHSE and
PLL OFFAHB, APB1 prescaler set to 1.CSS, MCO OFFAll
interrupts disabled
This function doesn't modify the configuration of the
Peripheral clocksLSI, LSE and RTC clocks
30.2.6
30.2.7
HAL_RCC_OscConfig
Function Name
HAL_StatusTypeDef HAL_RCC_OscConfig (
RCC_OscInitTypeDef * RCC_OscInitStruct)
Initializes the RCC Oscillators according to the specified

parameters in the RCC_OscInitTypeDef.
Parameters
RCC_OscInitStruct : pointer to an RCC_OscInitTypeDef

RCC Oscillators.
Return values
HAL status
Notes
The PLL is not disabled when used as system clock.
HAL_RCC_ClockConfig
Function Name
HAL_StatusTypeDef HAL_RCC_ClockConfig (
RCC_ClkInitTypeDef * RCC_ClkInitStruct, uint32_t FLatency)
DocID026525 Rev 1
365/692

Parameters
UM1785
Initializes the CPU, AHB and APB busses clocks according to the
specified parameters in the RCC_ClkInitStruct.
RCC_ClkInitStruct : pointer to an RCC_ClkInitTypeDef

RCC peripheral.
FLatency : FLASH Latency This parameter can be one of
FLASH_LATENCY_0 FLASH 0 Latency cycle
Return values
HAL status
Notes
The SystemCoreClock CMSIS variable is used to store

System Clock Frequency and updated by
HAL_RCC_GetHCLKFreq() function called within this function
The HSI is used (enabled by hardware) as system clock
source after startup from Reset, wake-up from STOP and
STANDBY mode, or in case of failure of the HSE used
directly or indirectly as system clock (if the Clock Security
System CSS is enabled).
A switch from one clock source to another occurs only if the
target clock source is ready (clock stable after startup delay or
PLL locked). If a clock source which is not yet ready is
selected, the switch will occur when the clock source will be
ready.
30.2.8
HAL_RCC_MCOConfig
Function Name
void HAL_RCC_MCOConfig ( uint32_t RCC_MCOx, uint32_t

RCC_MCOSource, uint32_t RCC_MCODiv)
Selects the clock source to output on MCO pin(such as PA8).
Parameters
366/692
RCC_MCOx : specifies the output direction for the clock

source. This parameter can be one of the following values:
RCC_MCO Clock source to output on MCO pin(such as

PA8).
RCC_MCOSource : specifies the clock source to output.
RCC_MCOSOURCE_LSI LSI clock selected as MCO

source
RCC_MCOSOURCE_HSI HSI clock selected as MCO

source
RCC_MCOSOURCE_LSE LSE clock selected as MCO

source
RCC_MCOSOURCE_HSE HSE clock selected as MCO

source
RCC_MCOSOURCE_PLLCLK_NODIV main PLL clock

not divided selected as MCO source (not applicable to
DocID026525 Rev 1
UM1785
30.2.9
30.2.10

STM32F05x devices)
RCC_MCOSOURCE_PLLCLK_DIV2 main PLL clock

divided by 2 selected as MCO source
RCC_MCOSOURCE_SYSCLK System clock (SYSCLK)

selected as MCO source
RCC_MCODiv : specifies the MCOx prescaler. This
RCC_MCO_NODIV no division applied to MCO clock
Return values
None.
Notes
MCO pin (such as PA8) should be configured in alternate

function mode.
HAL_RCC_EnableCSS
Function Name
void HAL_RCC_EnableCSS ( void )
Enables the Clock Security System.
Return values
None.
Notes
If a failure is detected on the HSE oscillator clock, this

oscillator is automatically disabled and an interrupt is
generated to inform the software about the failure (Clock
Security System Interrupt, CSSI), allowing the MCU to
perform rescue operations. The CSSI is linked to the CortexM0 NMI (Non-Maskable Interrupt) exception vector.
HAL_RCC_DisableCSS
Function Name
void HAL_RCC_DisableCSS ( void )
Disables the Clock Security System.
Return values
None.
Notes
None.
DocID026525 Rev 1
367/692
30.2.11
UM1785
HAL_RCC_GetSysClockFreq
Function Name
uint32_t HAL_RCC_GetSysClockFreq ( void )
Returns the SYSCLK frequency.
Return values
SYSCLK frequency
Notes
The system frequency computed by this function is not the

real frequency in the chip. It is calculated based on the
predefined constant and the selected clock source:
If SYSCLK source is HSI, function returns a value based on
HSI_VALUE(*)
If SYSCLK source is HSI48, function returns a value based on
HSI48_VALUE(*)
If SYSCLK source is HSE, function returns a value based on
HSE_VALUE divided by PREDIV factor(**)
If SYSCLK source is PLL, function returns a value based on
HSE_VALUE divided by PREDIV factor(**) or depending on
STM32F0xx devices either a value based on HSI_VALUE
divided by 2 or HSI_VALUE divided by PREDIV factor(*)
multiplied by the PLL factor .
(*) HSI_VALUE & HSI48_VALUE are constants defined in
stm32f0xx_hal_conf.h file (default values 8 MHz and 48MHz).
(**) HSE_VALUE is a constant defined in
stm32f0xx_hal_conf.h file (default value 8 MHz), user has to
ensure that HSE_VALUE is same as the real frequency of the
crystal used. Otherwise, this function may have wrong result.
The result of this function could be not correct when using
fractional value for HSE crystal.
This function can be used by the user application to compute
the baudrate for the communication peripherals or configure
other parameters.
Each time SYSCLK changes, this function must be called to
update the right SYSCLK value. Otherwise, any configuration
based on this function will be incorrect.
30.2.12
368/692
HAL_RCC_GetHCLKFreq
Function Name
uint32_t HAL_RCC_GetHCLKFreq ( void )
Returns the HCLK frequency.
Return values
HCLK frequency
Notes
Each time HCLK changes, this function must be called to

update the right HCLK value. Otherwise, any configuration
DocID026525 Rev 1
UM1785
30.2.13
30.2.14
30.2.15

System Clock Frequency and updated within this function
HAL_RCC_GetPCLK1Freq
Function Name
uint32_t HAL_RCC_GetPCLK1Freq ( void )
Returns the PCLK1 frequency.
Return values
PCLK1 frequency
Notes
Each time PCLK1 changes, this function must be called to

update the right PCLK1 value. Otherwise, any configuration
HAL_RCC_GetOscConfig
Function Name
void HAL_RCC_GetOscConfig ( RCC_OscInitTypeDef *

RCC_OscInitStruct)
Configures the RCC_OscInitStruct according to the internal RCC

configuration registers.
Parameters

structure that will be configured.
Return values
None.
Notes
None.
HAL_RCC_GetClockConfig
Function Name
void HAL_RCC_GetClockConfig ( RCC_ClkInitTypeDef *

RCC_ClkInitStruct, uint32_t * pFLatency)
Get the RCC_ClkInitStruct according to the internal RCC

DocID026525 Rev 1
369/692

Parameters
30.2.16
30.2.17
UM1785

structure that contains the current clock configuration.
pFLatency : Pointer on the Flash Latency.
Return values
None.
Notes
None.
HAL_RCC_NMI_IRQHandler
Function Name
void HAL_RCC_NMI_IRQHandler ( void )
This function handles the RCC CSS interrupt request.
Return values
None.
Notes
This API should be called under the NMI_Handler().
HAL_RCC_CCSCallback
Function Name
void HAL_RCC_CCSCallback ( void )
RCC Clock Security System interrupt callback.
Return values
none
Notes
None.
30.3
RCC Firmware driver defines
30.3.1
RCC
RCC
RCC AHB Clock Enable Disable
__GPIOA_CLK_ENABLE
__GPIOB_CLK_ENABLE
__GPIOC_CLK_ENABLE
370/692
DocID026525 Rev 1
UM1785

__GPIOF_CLK_ENABLE
__CRC_CLK_ENABLE
__DMA1_CLK_ENABLE
__SRAM_CLK_ENABLE
__FLITF_CLK_ENABLE
__GPIOA_CLK_DISABLE
__GPIOB_CLK_DISABLE
__GPIOC_CLK_DISABLE
__GPIOF_CLK_DISABLE
__CRC_CLK_DISABLE
__DMA1_CLK_DISABLE
__SRAM_CLK_DISABLE
__FLITF_CLK_DISABLE
RCC AHB Clock Source
RCC_SYSCLK_DIV1
RCC_SYSCLK_DIV2
RCC_SYSCLK_DIV4
RCC_SYSCLK_DIV8
RCC_SYSCLK_DIV16
RCC_SYSCLK_DIV64
RCC_SYSCLK_DIV128
RCC_SYSCLK_DIV256
RCC_SYSCLK_DIV512
IS_RCC_SYSCLK_DIV
RCC AHB Force Release Reset
__AHB_FORCE_RESET
__GPIOA_FORCE_RESET
__GPIOB_FORCE_RESET
__GPIOC_FORCE_RESET
__GPIOF_FORCE_RESET
__AHB_RELEASE_RESET
__GPIOA_RELEASE_RESET
__GPIOB_RELEASE_RESET
__GPIOC_RELEASE_RESET
__GPIOF_RELEASE_RESET
RCC APB1 Clock Enable Disable
DocID026525 Rev 1
371/692

__TIM3_CLK_ENABLE
UM1785
__TIM14_CLK_ENABLE
__WWDG_CLK_ENABLE
__I2C1_CLK_ENABLE
__PWR_CLK_ENABLE
__TIM3_CLK_DISABLE
__TIM14_CLK_DISABLE
__WWDG_CLK_DISABLE
__I2C1_CLK_DISABLE
__PWR_CLK_DISABLE
RCC APB1 Clock Source
RCC_HCLK_DIV1
RCC_HCLK_DIV2
RCC_HCLK_DIV4
RCC_HCLK_DIV8
RCC_HCLK_DIV16
IS_RCC_HCLK_DIV
RCC APB1 Force Release Reset
__APB1_FORCE_RESET
__TIM3_FORCE_RESET
__TIM14_FORCE_RESET
__WWDG_FORCE_RESET
__I2C1_FORCE_RESET
__PWR_FORCE_RESET
__APB1_RELEASE_RESET
__TIM3_RELEASE_RESET
__WWDG_RELEASE_RESET
__I2C1_RELEASE_RESET
__PWR_RELEASE_RESET
RCC APB2 Clock Enable Disable
__SYSCFG_CLK_ENABLE
__ADC1_CLK_ENABLE
__TIM1_CLK_ENABLE
__SPI1_CLK_ENABLE
__TIM16_CLK_ENABLE
372/692
DocID026525 Rev 1
UM1785

__TIM17_CLK_ENABLE
__USART1_CLK_ENABLE
__DBGMCU_CLK_ENABLE
__SYSCFG_CLK_DISABLE
__ADC1_CLK_DISABLE
__TIM1_CLK_DISABLE
__SPI1_CLK_DISABLE
__TIM16_CLK_DISABLE
__TIM17_CLK_DISABLE
__USART1_CLK_DISABLE
__DBGMCU_CLK_DISABLE
RCC APB2 Force Release Reset
__APB2_FORCE_RESET
__SYSCFG_FORCE_RESET
__ADC1_FORCE_RESET
__TIM1_FORCE_RESET
__SPI1_FORCE_RESET
__USART1_FORCE_RESET
__TIM16_FORCE_RESET
__TIM17_FORCE_RESET
__DBGMCU_FORCE_RESET
__APB2_RELEASE_RESET
__SYSCFG_RELEASE_RESET
__ADC1_RELEASE_RESET
__SPI1_RELEASE_RESET
__USART1_RELEASE_RESET
__DBGMCU_RELEASE_RESET
RCC BitAddress AliasRegion
RCC_OFFSET
RCC_CR_OFFSET
RCC_CFGR_OFFSET
RCC_CIR_OFFSET
RCC_BDCR_OFFSET
DocID026525 Rev 1
373/692

RCC_CSR_OFFSET
UM1785
RCC_CR2_OFFSET
RCC_CR_BYTE2_ADDRESS
RCC_CIR_BYTE1_ADDRESS
RCC_CIR_BYTE2_ADDRESS
RCC_CSR_BYTE1_ADDRESS
RCC_BDCR_BYTE0_ADDRESS
RCC_CFGR_PLLMUL_BITNUMBER
RCC_CFGR2_PREDIV_BITNUMBER
RCC Calibration values
IS_RCC_CALIBRATION_VALUE
RCC Flag
CR_REG_INDEX
CR2_REG_INDEX
BDCR_REG_INDEX
CSR_REG_INDEX
RCC_CR_HSIRDY_BitNumber
RCC_CR_HSERDY_BitNumber
RCC_CR_PLLRDY_BitNumber
RCC_FLAG_HSIRDY
RCC_FLAG_HSERDY
RCC_FLAG_PLLRDY
RCC_CR2_HSI14RDY_BitNumber
RCC_FLAG_HSI14RDY
RCC_BDCR_LSERDY_BitNumber
RCC_FLAG_LSERDY
RCC_CSR_LSIRDY_BitNumber
RCC_CSR_V18PWRRSTF_BitNumber
RCC_CSR_RMVF_BitNumber
RCC_CSR_OBLRSTF_BitNumber
RCC_CSR_PINRSTF_BitNumber
RCC_CSR_PORRSTF_BitNumber
RCC_CSR_SFTRSTF_BitNumber
RCC_CSR_IWDGRSTF_BitNumber
RCC_CSR_WWDGRSTF_BitNumber
RCC_CSR_LPWRRSTF_BitNumber
374/692
DocID026525 Rev 1
UM1785

RCC_FLAG_LSIRDY
RCC_FLAG_V18PWRRST
RCC_FLAG_RMV
RCC_FLAG_OBLRST
RCC_FLAG_PINRST
RCC_FLAG_PORRST
RCC_FLAG_SFTRST
RCC_FLAG_IWDGRST
RCC_FLAG_WWDGRST
RCC_FLAG_LPWRRST
RCC Flags Interrupts Management
__HAL_RCC_ENABLE_IT
Description:
Enable RCC interrupt (Perform Byte access

to RCC_CIR[12:8] bits to enable the
selected interrupts.).
Parameters:
__HAL_RCC_DISABLE_IT
__INTERRUPT__: specifies the RCC

interrupt sources to be enabled. This
following values:
RCC_IT_LSIRDY: LSI ready interrupt

enable
RCC_IT_LSERDY: LSE ready interrupt

enable
RCC_IT_HSIRDY: HSI ready interrupt

enable
RCC_IT_HSERDY: HSE ready

interrupt enable
RCC_IT_PLLRDY: PLL ready interrupt

enable
RCC_IT_HSI14RDY: HSI14 ready

interrupt enable

interrupt enable (only applicable to
STM32F0X2 USB devices)
Description:
Disable RCC interrupt (Perform Byte access

to RCC_CIR[12:8] bits to disable the
selected interrupts.).
Parameters:
__INTERRUPT__: specifies the RCC

interrupt sources to be disabled. This
following values:
DocID026525 Rev 1
375/692
__HAL_RCC_CLEAR_IT
UM1785
enable
enable
enable
interrupt enable
enable
interrupt enable
interrupt enable (only applicable to
Description:
Clear the RCC's interrupt pending bits (

Perform Byte access to RCC_CIR[23:16]
bits to clear the selected interrupt pending
bits.
Parameters:
__HAL_RCC_GET_IT
__IT__: specifies the interrupt pending bit to

clear. This parameter can be any

clear

clear

clear

interrupt clear

clear

interrupt clear

interrupt clear (only applicable to
RCC_IT_CSS: Clock Security System

interrupt clear
Description:
Check the RCC's interrupt has occurred or

not.
Parameters:
376/692
__IT__: specifies the RCC interrupt source

following values:

flag
DocID026525 Rev 1
UM1785

flag
flag
interrupt flag
flag
interrupt flag
interrupt flag (only applicable to
RCC_IT_CSS: Clock Security System
interrupt flag
Return value:
__HAL_RCC_CLEAR_RESET_FLAGS
RCC_FLAG_MASK
Description:
Check RCC flag is set or not.
Parameters:

values:
RCC_FLAG_HSIRDY: HSI oscillator

clock ready
RCC_FLAG_HSERDY: HSE oscillator

clock ready
RCC_FLAG_PLLRDY: PLL clock ready
RCC_FLAG_HSI14RDY: HSI14
oscillator clock ready
RCC_FLAG_HSI48RDY: HSI48
oscillator clock ready (only applicable to
RCC_FLAG_LSERDY: LSE oscillator

clock ready
RCC_FLAG_LSIRDY: LSI oscillator

clock ready
RCC_FLAG_OBLRST: Option Byte

Load reset
RCC_FLAG_PINRST: Pin reset
RCC_FLAG_PORRST: POR/PDR
reset
RCC_FLAG_SFTRST: Software reset
RCC_FLAG_IWDGRST: Independent
Watchdog reset
RCC_FLAG_WWDGRST: Window
Watchdog reset
RCC_FLAG_LPWRRST: Low Power

reset
Return value:
DocID026525 Rev 1
377/692
UM1785

FALSE).
__HAL_RCC_GET_FLAG
RCC Force Release Backup
__HAL_RCC_BACKUPRESET_FORCE
__HAL_RCC_BACKUPRESET_RELEASE
RCC Get Clock source
__HAL_RCC_GET_SYSCLK_SOU
RCE
Description:
Macro to get the clock source used as system

clock.
Return value:
__HAL_RCC_GET_PLL_OSCSOU
RCE
The: clock source used as system clock. The

returned value can be one of the following
value:
RCC_SYSCLKSOURCE_STATUS_HSI:
HSI used as system clock
RCC_SYSCLKSOURCE_STATUS_HSE:
HSE used as system clock
RCC_SYSCLKSOURCE_STATUS_PLLCL
K: PLL used as system clock
Description:
Macro to get the oscillator used as PLL clock

source.
Return value:
The: oscillator used as PLL clock source. The

returned value can be one of the following:
RCC_PLLSOURCE_HSI: HSI oscillator is

used as PLL clock source.
RCC_PLLSOURCE_HSE: HSE oscillator is

used as PLL clock source.
RCC HSE Config

RCC_HSE_OFF
RCC_HSE_ON
RCC_HSE_BYPASS
IS_RCC_HSE
RCC HSE Configuration
__HAL_RCC_HSE_CONFIG
Description:
Macro to configure the External High Speed

oscillator (HSE).
Parameters:
378/692
__STATE__: specifies the new state of the

HSE. This parameter can be one of the
following values:
DocID026525 Rev 1
UM1785
__HAL_RCC_HSE_PREDIV_CONFIG
RCC_HSE_OFF: turn OFF the HSE

oscillator, HSERDY flag goes low after 6
HSE oscillator clock cycles.
RCC_HSE_ON: turn ON the HSE
oscillator
RCC_HSE_BYPASS: HSE oscillator
bypassed with external clock
Description:
Macro to configure the External High Speed

oscillator (HSE) Predivision factor for PLL.
Parameters:
__HSEPredivValue__: specifies the division

value applied to HSE. This parameter must
be a number between
RCC_HSE_PREDIV_DIV1 and
RCC_HSE_PREDIV_DIV16.
RCC HSI14 Config

RCC_HSI14_OFF
RCC_HSI14_ON
RCC_HSI14_ADC_CONTROL
IS_RCC_HSI14
RCC_HSI14CALIBRATION_DEFAULT
RCC_HSI14_Configuration
__HAL_RCC_HSI14_ENABLE
__HAL_RCC_HSI14_DISABLE
__HAL_RCC_HSI14ADC_ENABLE
__HAL_RCC_HSI14ADC_DISABLE
RCC_CR2_HSI14TRIM_BitNumber
Description:
Macro to adjust the Internal

14Mhz High Speed oscillator
(HSI) calibration value.
Parameters:
__HSI14CalibrationValue__:
specifies the calibration trimming
value (default is
RCC_HSI14CALIBRATION_DE
FAULT). This parameter must be
a number between 0 and 0x1F.
__HAL_RCC_HSI14_CALIBRATIONVALUE_ADJ
UST
RCC HSI Config
RCC_HSI_OFF
RCC_HSI_ON
DocID026525 Rev 1
379/692

IS_RCC_HSI
UM1785
RCC_HSICALIBRATION_DEFAULT
RCC HSI Configuration
__HAL_RCC_HSI_ENABLE
__HAL_RCC_HSI_DISABLE
Description:
RCC_CR_HSITRIM_BitNumber
Macro to adjust the Internal High

Speed oscillator (HSI)
calibration value.
Parameters:
__HSICalibrationValue__:
specifies the calibration
trimming value (default is
RCC_HSICALIBRATION_DEFA
ULT). This parameter must be a
number between 0 and 0x1F.
__HAL_RCC_HSI_CALIBRATIONVALUE_ADJUS
T
RCC I2C1 Clock Source
RCC_I2C1CLKSOURCE_HSI
RCC_I2C1CLKSOURCE_SYSCLK
IS_RCC_I2C1CLKSOURCE
RCC I2Cx Clock Config
__HAL_RCC_I2C1_CONFIG
Description:
Macro to configure the I2C1 clock (I2C1CLK).
Parameters:
__HAL_RCC_GET_I2C1_SOURCE
__I2C1CLKSource__: specifies the I2C1 clock

following values:
RCC_I2C1CLKSOURCE_HSI: HSI
selected as I2C1 clock
RCC_I2C1CLKSOURCE_SYSCLK:
System Clock selected as I2C1 clock
Description:
Macro to get the I2C1 clock source.
Return value:
The: clock source can be one of the following

values:
RCC_I2C1CLKSOURCE_HSI: HSI
selected as I2C1 clock
RCC_I2C1CLKSOURCE_SYSCLK:
System Clock selected as I2C1 clock
RCC Interrupt
380/692
DocID026525 Rev 1
UM1785

RCC_IT_LSIRDY
RCC_IT_LSERDY
RCC_IT_HSIRDY
RCC_IT_HSERDY
RCC_IT_PLLRDY
RCC_IT_HSI14
RCC_IT_CSS
RCC_LSE_Config
RCC_LSE_OFF
RCC_LSE_ON
RCC_LSE_BYPASS
IS_RCC_LSE
RCC LSE Configuration
__HAL_RCC_LSE_CONFIG
Description:
Macro to configure the External Low Speed oscillator

(LSE).
Parameters:
__STATE__: specifies the new state of the LSE. This

RCC_LSE_OFF: turn OFF the LSE oscillator,

LSERDY flag goes low after 6 LSE oscillator clock
cycles.
RCC_LSE_ON: turn ON the LSE oscillator
RCC_LSE_BYPASS: LSE oscillator bypassed

with external clock
RCC LSI Config

RCC_LSI_OFF
RCC_LSI_ON
IS_RCC_LSI
RCC LSI Configuration
__HAL_RCC_LSI_ENABLE
__HAL_RCC_LSI_DISABLE
RCC MCOx Index
RCC_MCO
IS_RCC_MCO
RCC MCO Clock Source
RCC_MCOSOURCE_NONE
RCC_MCOSOURCE_LSI
RCC_MCOSOURCE_LSE
DocID026525 Rev 1
381/692

RCC_MCOSOURCE_SYSCLK
UM1785
RCC_MCOSOURCE_HSI
RCC_MCOSOURCE_HSE
RCC_MCOSOURCE_PLLCLK_DIV2
RCC_MCOSOURCE_HSI14
RCC Oscillator Type
RCC_OSCILLATORTYPE_NONE
RCC_OSCILLATORTYPE_HSE
RCC_OSCILLATORTYPE_HSI
RCC_OSCILLATORTYPE_LSE
RCC_OSCILLATORTYPE_LSI
RCC_OSCILLATORTYPE_HSI14
RCC_OSCILLATORTYPE_HSI48
IS_RCC_OSCILLATORTYPE
RCC PLL Clock Source
RCC_PLLSOURCE_HSE
RCC PLL Config
RCC_PLL_NONE
RCC_PLL_OFF
RCC_PLL_ON
IS_RCC_PLL
RCC PLL Configuration
__HAL_RCC_PLL_ENABLE
__HAL_RCC_PLL_DISABLE
__HAL_RCC_PLL_CONFIG
Description:
Macro to configure the PLL clock source, multiplication

and division factors.
Parameters:
382/692
__RCC_PLLSource__: specifies the PLL entry clock

source. This parameter can be one of the following
values:
RCC_PLLSOURCE_HSI: HSI oscillator clock

selected as PLL clock entry
RCC_PLLSOURCE_HSE: HSE oscillator clock

selected as PLL clock entry
__PREDIV__: specifies the predivider factor for PLL
VCO input clock This parameter must be a number
between RCC_PREDIV_DIV1 and
RCC_PREDIV_DIV16.
__PLLMUL__: specifies the multiplication factor for
PLL VCO input clock This parameter must be a
DocID026525 Rev 1
UM1785

number between RCC_PLL_MUL2 and
RCC_PLL_MUL16.
RCC PLL Multiplication Factor
RCC_PLL_MUL2
RCC_PLL_MUL3
RCC_PLL_MUL4
RCC_PLL_MUL5
RCC_PLL_MUL6
RCC_PLL_MUL7
RCC_PLL_MUL8
RCC_PLL_MUL9
RCC_PLL_MUL10
RCC_PLL_MUL11
RCC_PLL_MUL12
RCC_PLL_MUL13
RCC_PLL_MUL14
RCC_PLL_MUL15
RCC_PLL_MUL16
IS_RCC_PLL_MUL
RCC PLL Prediv Factor
RCC_PREDIV_DIV1
RCC_PREDIV_DIV2
RCC_PREDIV_DIV3
RCC_PREDIV_DIV4
RCC_PREDIV_DIV5
RCC_PREDIV_DIV6
RCC_PREDIV_DIV7
RCC_PREDIV_DIV8
RCC_PREDIV_DIV9
RCC_PREDIV_DIV10
RCC_PREDIV_DIV11
RCC_PREDIV_DIV12
RCC_PREDIV_DIV13
RCC_PREDIV_DIV14
RCC_PREDIV_DIV15
RCC_PREDIV_DIV16
IS_RCC_PREDIV
DocID026525 Rev 1
383/692

RCC Private Define
UM1785
RCC_CFGR_HPRE_BITNUMBER
RCC_CFGR_PPRE_BITNUMBER
RCC Private Macros
__MCO_CLK_ENABLE
MCO_GPIO_PORT
MCO_PIN
RCC RTC Clock Configuration
__HAL_RCC_RTC_ENABLE
__HAL_RCC_RTC_DISABLE
Description:
__HAL_RCC_RTC_CONFIG
Macro to configure the RTC clock (RTCCLK).
Parameters:
__HAL_RCC_GET_RTC_SOURC
E
__RTCCLKSource__: specifies the RTC clock

following values:
RCC_RTCCLKSOURCE_NONE: No clock
selected as RTC clock
RCC_RTCCLKSOURCE_LSE: LSE
RCC_RTCCLKSOURCE_LSI: LSI selected

as RTC clock
RCC_RTCCLKSOURCE_HSE_DIV32:
HSE clock divided by 32
Description:
Macro to get the RTC clock source.
Return value:

values:
RCC_RTCCLKSOURCE_NONE: No clock
RCC_RTCCLKSOURCE_LSE: LSE
RCC_RTCCLKSOURCE_LSI: LSI selected

as RTC clock
RCC_RTCCLKSOURCE_HSE_DIV32:
HSE clock divided by 32 selected as RTC
clock
RCC RTC Clock Source

RCC_RTCCLKSOURCE_NONE
RCC_RTCCLKSOURCE_LSE
RCC_RTCCLKSOURCE_LSI
RCC_RTCCLKSOURCE_HSE_DIV32
384/692
DocID026525 Rev 1
UM1785

IS_RCC_RTCCLKSOURCE
RCC System Clock Source
RCC_SYSCLKSOURCE_HSI
RCC_SYSCLKSOURCE_HSE
RCC_SYSCLKSOURCE_PLLCLK
RCC System Clock Source Status
RCC_SYSCLKSOURCE_STATUS_HSI
RCC_SYSCLKSOURCE_STATUS_HSE
RCC_SYSCLKSOURCE_STATUS_PLLCLK
RCC System Clock Type
RCC_CLOCKTYPE_SYSCLK
RCC_CLOCKTYPE_HCLK
RCC_CLOCKTYPE_PCLK1
IS_RCC_CLOCKTYPE
RCC Timeout
LSE_TIMEOUT_VALUE
LSE_TIMEOUT_VALUE
DBP_TIMEOUT_VALUE
HSE_TIMEOUT_VALUE
HSI_TIMEOUT_VALUE
LSI_TIMEOUT_VALUE
HSI14_TIMEOUT_VALUE
HSI48_TIMEOUT_VALUE
PLL_TIMEOUT_VALUE
CLOCKSWITCH_TIMEOUT_VALUE
RCC USART1 Clock Source
RCC_USART1CLKSOURCE_PCLK1
RCC_USART1CLKSOURCE_SYSCLK
RCC_USART1CLKSOURCE_LSE
RCC_USART1CLKSOURCE_HSI
IS_RCC_USART1CLKSOURCE
RCC USARTx Clock Config
__HAL_RCC_USART1_CONFIG
Description:
Macro to configure the USART1 clock

(USART1CLK).
Parameters:
__USART1CLKSource__: specifies the
DocID026525 Rev 1
385/692
UM1785
USART1 clock source. This parameter can be
RCC_USART1CLKSOURCE_PCLK1:
PCLK1 selected as USART1 clock
RCC_USART1CLKSOURCE_HSI: HSI
selected as USART1 clock
RCC_USART1CLKSOURCE_SYSCLK:
System Clock selected as USART1 clock
RCC_USART1CLKSOURCE_LSE: LSE
__HAL_RCC_GET_USART1_SOUR
CE
Description:
Macro to get the USART1 clock source.
Return value:
386/692

values:
DocID026525 Rev 1
UM1785
HAL RCC Extension Driver
31
31.1
RCCEx Firmware driver registers structures
31.1.1
RCC_PeriphCLKInitTypeDef
RCC_PeriphCLKInitTypeDef is defined in the stm32f0xx_hal_rcc_ex.h
Data Fields
uint32_t PeriphClockSelection
uint32_t RTCClockSelection
uint32_t Usart1ClockSelection
uint32_t I2c1ClockSelection
uint32_t CecClockSelection
Field Documentation
31.1.2
uint32_t RCC_PeriphCLKInitTypeDef::PeriphClockSelection The Extended Clock

to be configured. This parameter can be a value of RCCEx_Periph_Clock_Selection
uint32_t RCC_PeriphCLKInitTypeDef::RTCClockSelection Specifies RTC Clock
Prescalers Selection This parameter can be a value of RCC_RTC_Clock_Source
uint32_t RCC_PeriphCLKInitTypeDef::Usart1ClockSelection USART1 clock
source This parameter can be a value of RCC_USART1_Clock_Source
source This parameter can be a value of RCCEx_USART2_Clock_Source
source This parameter can be a value of RCCEx_USART3_Clock_Source
uint32_t RCC_PeriphCLKInitTypeDef::I2c1ClockSelection I2C1 clock source This
parameter can be a value of RCC_I2C1_Clock_Source
uint32_t RCC_PeriphCLKInitTypeDef::CecClockSelection HDMI CEC clock source
This parameter can be a value of RCCEx_CEC_Clock_Source
RCC_CRSInitTypeDef
RCC_CRSInitTypeDef is defined in the stm32f0xx_hal_rcc_ex.h
Data Fields
uint32_t Prescaler
uint32_t Source
uint32_t Polarity
uint32_t ReloadValue
uint32_t ErrorLimitValue
Field Documentation
DocID026525 Rev 1
387/692
31.1.3
UM1785
uint32_t RCC_CRSInitTypeDef::Prescaler Specifies the division factor of the SYNC

signal. This parameter can be a value of RCCEx_CRS_SynchroDivider
uint32_t RCC_CRSInitTypeDef::Source Specifies the SYNC signal source. This
parameter can be a value of RCCEx_CRS_SynchroSource
uint32_t RCC_CRSInitTypeDef::Polarity Specifies the input polarity for the SYNC
signal source. This parameter can be a value of RCCEx_CRS_SynchroPolarity
uint32_t RCC_CRSInitTypeDef::ReloadValue Specifies the value to be loaded in the
frequency error counter with each SYNC event. It can be calculated in using macro
__HAL_RCC_CRS_CALCULATE_RELOADVALUE(_FTARGET_, _FSYNC_) This
parameter must be a number between 0 and 0xFFFF or a value of
RCCEx_CRS_ReloadValueDefault .
uint32_t RCC_CRSInitTypeDef::ErrorLimitValue Specifies the value to be used to
evaluate the captured frequency error value. This parameter must be a number
between 0 and 0xFF or a value of RCCEx_CRS_ErrorLimitDefault
uint32_t RCC_CRSInitTypeDef::HSI48CalibrationValue Specifies a userprogrammable trimming value to the HSI48 oscillator. This parameter must be a
number between 0 and 0x3F or a value of RCCEx_CRS_HSI48CalibrationDefault
RCC_CRSSynchroInfoTypeDef
RCC_CRSSynchroInfoTypeDef is defined in the stm32f0xx_hal_rcc_ex.h
Data Fields
uint32_t ReloadValue
uint32_t FreqErrorCapture
uint32_t FreqErrorDirection
Field Documentation
31.2
uint32_t RCC_CRSSynchroInfoTypeDef::ReloadValue Specifies the value loaded

in the Counter reload value. This parameter must be a number between 0 and 0xFFFF
uint32_t RCC_CRSSynchroInfoTypeDef::HSI48CalibrationValue Specifies value
loaded in HSI48 oscillator smooth trimming. This parameter must be a number
between 0 and 0x3F
uint32_t RCC_CRSSynchroInfoTypeDef::FreqErrorCapture Specifies the value
loaded in the .FECAP, the frequency error counter value latched in the time of the last
SYNC event. This parameter must be a number between 0 and 0xFFFF
uint32_t RCC_CRSSynchroInfoTypeDef::FreqErrorDirection Specifies the value
loaded in the .FEDIR, the counting direction of the frequency error counter latched in
the time of the last SYNC event. It shows whether the actual frequency is below or
above the target. This parameter must be a value of
RCCEx_CRS_FreqErrorDirection
RCCEx Firmware driver API description

The following section lists the various functions of the RCCEx library.
31.2.1
388/692
DocID026525 Rev 1
UM1785
31.2.2
Extended Peripheral Control functions

This subsection provides a set of functions allowing to control the RCC Clocks
frequencies.
Important note: Care must be taken when HAL_RCCEx_PeriphCLKConfig() is
used to select the RTC clock source; in this case the Backup domain will be reset
in order to modify the RTC Clock source, as consequence RTC registers
(including the backup registers) and RCC_BDCR register are set to their reset
values.
31.2.3
31.2.4
HAL_RCC_OscConfig()
HAL_RCC_ClockConfig()
HAL_RCC_GetSysClockFreq()
HAL_RCCEx_PeriphCLKConfig()
HAL_RCCEx_GetPeriphCLKConfig()
HAL_RCCEx_CRSConfig()
HAL_RCCEx_CRSSoftwareSynchronizationGenerate()
HAL_RCCEx_CRSGetSynchronizationInfo()
HAL_RCCEx_CRSWaitSynchronization()
HAL_RCC_OscConfig
Function Name
HAL_StatusTypeDef HAL_RCC_OscConfig (
RCC_OscInitTypeDef * RCC_OscInitStruct)
Initializes the RCC Oscillators according to the specified

parameters in the RCC_OscInitTypeDef.
Parameters

RCC Oscillators.
Return values
HAL status
Notes
The PLL is not disabled when used as system clock.
HAL_RCC_ClockConfig
Function Name
HAL_StatusTypeDef HAL_RCC_ClockConfig (
RCC_ClkInitTypeDef * RCC_ClkInitStruct, uint32_t FLatency)
Initializes the CPU, AHB and APB busses clocks according to the
specified parameters in the RCC_ClkInitStruct.
DocID026525 Rev 1
389/692

Parameters
UM1785

RCC peripheral.
FLatency : FLASH Latency This parameter can be one of
Return values
HAL status
Notes

System Clock Frequency and updated by
HAL_RCC_GetHCLKFreq() function called within this function
The HSI is used (enabled by hardware) as system clock
source after startup from Reset, wake-up from STOP and
STANDBY mode, or in case of failure of the HSE used
directly or indirectly as system clock (if the Clock Security
System CSS is enabled).
A switch from one clock source to another occurs only if the
target clock source is ready (clock stable after startup delay or
PLL locked). If a clock source which is not yet ready is
selected, the switch will occur when the clock source will be
ready.
31.2.5
HAL_RCC_GetSysClockFreq
Function Name
uint32_t HAL_RCC_GetSysClockFreq ( void )
Returns the SYSCLK frequency.
Return values
SYSCLK frequency
Notes
The system frequency computed by this function is not the

real frequency in the chip. It is calculated based on the
predefined constant and the selected clock source:
If SYSCLK source is HSI, function returns a value based on
HSI_VALUE(*)
If SYSCLK source is HSI48, function returns a value based on
HSI48_VALUE(*)
If SYSCLK source is HSE, function returns a value based on
HSE_VALUE divided by PREDIV factor(**)
If SYSCLK source is PLL, function returns a value based on
HSE_VALUE divided by PREDIV factor(**) or depending on
STM32F0xx devices either a value based on HSI_VALUE
divided by 2 or HSI_VALUE divided by PREDIV factor(*)
multiplied by the PLL factor .
(*) HSI_VALUE & HSI48_VALUE are constants defined in
stm32f0xx_hal_conf.h file (default values 8 MHz and 48MHz).
(**) HSE_VALUE is a constant defined in
stm32f0xx_hal_conf.h file (default value 8 MHz), user has to
390/692
DocID026525 Rev 1
UM1785
31.2.6
31.2.7

ensure that HSE_VALUE is same as the real frequency of the
crystal used. Otherwise, this function may have wrong result.
The result of this function could be not correct when using
fractional value for HSE crystal.
This function can be used by the user application to compute
the baudrate for the communication peripherals or configure
other parameters.
Each time SYSCLK changes, this function must be called to
update the right SYSCLK value. Otherwise, any configuration
HAL_RCCEx_PeriphCLKConfig
Function Name
HAL_StatusTypeDef HAL_RCCEx_PeriphCLKConfig (
RCC_PeriphCLKInitTypeDef * PeriphClkInit)
Initializes the RCC extended peripherals clocks according to the

specified parameters in the RCC_PeriphCLKInitTypeDef.
Parameters
PeriphClkInit : pointer to an RCC_PeriphCLKInitTypeDef

Extended Peripherals clocks (USART, RTC, I2C, CEC and
USB).
Return values
None.
Notes
Care must be taken when HAL_RCCEx_PeriphCLKConfig() is

used to select the RTC clock source; in this case the Backup
domain will be reset in order to modify the RTC Clock source,
as consequence RTC registers (including the backup
registers) and RCC_BDCR register are set to their reset
values.
HAL_RCCEx_GetPeriphCLKConfig
Function Name
void HAL_RCCEx_GetPeriphCLKConfig (
RCC_PeriphCLKInitTypeDef * PeriphClkInit)
Get the RCC_ClkInitStruct according to the internal RCC

Parameters
PeriphClkInit : pointer to an RCC_PeriphCLKInitTypeDef

structure that returns the configuration information for the
Extended Peripherals clocks (USART, RTC, I2C, CEC and
DocID026525 Rev 1
391/692
UM1785
USB).
31.2.8
31.2.9
31.2.10
392/692
Return values
None.
Notes
None.
HAL_RCCEx_CRSConfig
Function Name
void HAL_RCCEx_CRSConfig ( RCC_CRSInitTypeDef * pInit)
Start automatic synchronization using polling mode.
Parameters
pInit : Pointer on RCC_CRSInitTypeDef structure
Return values
None.
Notes
None.
HAL_RCCEx_CRSSoftwareSynchronizationGenerate
Function Name
void HAL_RCCEx_CRSSoftwareSynchronizationGenerate (
void )
Generate the software synchronization event.
Return values
None.
Notes
None.
HAL_RCCEx_CRSGetSynchronizationInfo
Function Name
void HAL_RCCEx_CRSGetSynchronizationInfo (
RCC_CRSSynchroInfoTypeDef * pSynchroInfo)
Function to return synchronization info.
Parameters
pSynchroInfo : Pointer on RCC_CRSSynchroInfoTypeDef

structure
DocID026525 Rev 1
UM1785
31.2.11

Return values
None.
Notes
None.
HAL_RCCEx_CRSWaitSynchronization
Function Name
RCC_CRSStatusTypeDef
HAL_RCCEx_CRSWaitSynchronization ( uint32_t Timeout)
This function handles CRS Synchronization Timeout.
Parameters
Return values
Combination of Synchronization status This parameter

can be a combination of the following values:
RCC_CRS_TIMEOUT
RCC_CRS_SYNCOK
RCC_CRS_SYNCWARM
RCC_CRS_SYNCERR
RCC_CRS_SYNCMISS
RCC_CRS_TRIMOV
Notes
Timeout is based on the maximum time to receive a SYNC

event based on synchronization frequency.
If Timeout set to HAL_MAX_DELAY, HAL_TIMEOUT will be
never returned.
31.3
RCCEx Firmware driver defines
31.3.1
RCCEx
RCCEx
RCCEx CEC Clock Source
RCC_CECCLKSOURCE_HSI
RCC_CECCLKSOURCE_LSE
IS_RCC_CECCLKSOURCE
RCCEx CRS ErrorLimitDefault
RCC_CRS_ERRORLIMIT_DEFAULT
Default Frequency error limit
IS_RCC_CRS_ERRORLIMIT
RCCEx CRS Extended Features
DocID026525 Rev 1
393/692

__HAL_RCC_CRS_ENABLE_FREQ_ERROR_COUNTER
UM1785
Description:
Enables the oscillator

clock for frequency error
counter.
Return value:
__HAL_RCC_CRS_DISABLE_FREQ_ERROR_COUNTER
None:
Description:
Disables the oscillator

clock for frequency error
counter.
Return value:
__HAL_RCC_CRS_ENABLE_AUTOMATIC_CALIB
None:
Description:
Enables the automatic

hardware adjustement
of TRIM bits.
Return value:
__HAL_RCC_CRS_DISABLE_AUTOMATIC_CALIB
None:
Description:
Enables or disables the

automatic hardware
adjustement of TRIM
bits.
Return value:
__HAL_RCC_CRS_CALCULATE_RELOADVALUE
None:
Description:
Macro to calculate
reload value to be set in
CRS register according
to target and sync
frequencies.
Parameters:
_FTARGET_: Target
frequency (value in Hz)
_FSYNC_:
Synchronization signal
frequency (value in Hz)
Return value:
RCCEx CRS Flags

RCC_CRS_FLAG_SYNCOK
RCC_CRS_FLAG_SYNCWARN
394/692
DocID026525 Rev 1
None:
UM1785

RCC_CRS_FLAG_ERR
RCC_CRS_FLAG_ESYNC
RCC_CRS_FLAG_TRIMOVF
Trimming overflow or underflow
RCC_CRS_FLAG_SYNCERR
SYNC error
RCC_CRS_FLAG_SYNCMISS
SYNC missed
RCCEx CRS FreqErrorDirection

RCC_CRS_FREQERRORDIR_UP
Upcounting direction, the actual frequency is

above the target
RCC_CRS_FREQERRORDIR_DOWN
Downcounting direction, the actual frequency is

below the target
IS_RCC_CRS_FREQERRORDIR
RCCEx CRS HSI48CalibrationDefault
RCC_CRS_HSI48CALIBRATION_DEFAULT
The default value is 32, which corresponds

to the middle of the trimming interval. The
trimming step is around 67 kHz between
two consecutive TRIM steps. A higher
TRIM value corresponds to a higher output
frequency
IS_RCC_CRS_HSI48CALIBRATION
RCCEx CRS Interrupt Sources
RCC_CRS_IT_SYNCOK
SYNC event OK
RCC_CRS_IT_SYNCWARN
SYNC warning
RCC_CRS_IT_ERR
error
RCC_CRS_IT_ESYNC
Expected SYNC
RCC_CRS_IT_TRIMOVF
Trimming overflow or underflow
RCC_CRS_IT_SYNCERR
SYNC error
RCC_CRS_IT_SYNCMISS
SYNC missed
RCCEx CRS ReloadValueDefault

RCC_CRS_RELOADVALUE_DEFAULT
The reset value of the RELOAD field

corresponds to a target frequency of 48 MHz
and a synchronization signal frequency of 1 kHz
(SOF signal from USB).
IS_RCC_CRS_RELOADVALUE
RCCEx CRS SynchroDivider
RCC_CRS_SYNC_DIV1
Synchro Signal not divided (default)
RCC_CRS_SYNC_DIV2
Synchro Signal divided by 2
RCC_CRS_SYNC_DIV4
RCC_CRS_SYNC_DIV8
RCC_CRS_SYNC_DIV16
RCC_CRS_SYNC_DIV32

DocID026525 Rev 1
395/692

RCC_CRS_SYNC_DIV64
UM1785
RCC_CRS_SYNC_DIV128
IS_RCC_CRS_SYNC_DIV
RCCEx CRS SynchroPolarity
RCC_CRS_SYNC_POLARITY_RISING
Synchro Active on rising edge (default)
RCC_CRS_SYNC_POLARITY_FALLING
Synchro Active on falling edge
IS_RCC_CRS_SYNC_POLARITY
RCCEx CRS SynchroSource
RCC_CRS_SYNC_SOURCE_GPIO
Synchro Signal soucre GPIO
RCC_CRS_SYNC_SOURCE_LSE
Synchro Signal source LSE
RCC_CRS_SYNC_SOURCE_USB
Synchro Signal source USB SOF (default)
IS_RCC_CRS_SYNC_SOURCE
RCCEx Force Release Peripheral Reset
__GPIOD_FORCE_RESET
__GPIOD_RELEASE_RESET
__GPIOE_FORCE_RESET
__GPIOE_RELEASE_RESET
__TSC_FORCE_RESET
__TSC_RELEASE_RESET
__SPI2_FORCE_RESET
__SPI2_RELEASE_RESET
__TIM2_FORCE_RESET
__TIM6_FORCE_RESET
__I2C2_FORCE_RESET
__I2C2_RELEASE_RESET
__DAC1_FORCE_RESET
__DAC1_RELEASE_RESET
__CEC_FORCE_RESET
__CEC_RELEASE_RESET
__TIM7_FORCE_RESET
396/692
DocID026525 Rev 1
UM1785

__CAN_FORCE_RESET
__CAN_RELEASE_RESET
__CRS_FORCE_RESET
__CRS_RELEASE_RESET
__TIM15_FORCE_RESET
RCCEx HSI48 Config
RCC_HSI48_OFF
RCC_HSI48_ON
IS_RCC_HSI48
RCCEx HSI48 Enable Disable
__HAL_RCC_HSI48_ENABLE
__HAL_RCC_HSI48_DISABLE
__HAL_RCC_GET_HSI48_STATE
Description:
Macro to get the Internal 48Mhz High Speed

oscillator (HSI48) state.
Return value:

values:
RCC_HSI48_ON: HSI48 enabled
RCC_HSI48_OFF: HSI48 disabled
RCCEx IT and Flag

__HAL_RCC_CRS_ENABLE_IT
Description:
Enables the specified CRS interrupts.
Parameters:
__INTERRUPT__: specifies the CRS

interrupt sources to be enabled. This
DocID026525 Rev 1
397/692
UM1785
following values:
RCC_CRS_IT_SYNCOK
RCC_CRS_IT_SYNCWARN
RCC_CRS_IT_ERR
RCC_CRS_IT_ESYNC
Return value:
__HAL_RCC_CRS_DISABLE_IT
None:
Description:
Disables the specified CRS interrupts.
Parameters:

interrupt sources to be disabled. This
following values:
RCC_CRS_IT_SYNCOK
RCC_CRS_IT_SYNCWARN
RCC_CRS_IT_ERR
RCC_CRS_IT_ESYNC
Return value:
__HAL_RCC_CRS_GET_IT_SOURCE
None:
Description:
Check the CRS's interrupt has occurred or

not.
Parameters:

RCC_CRS_IT_SYNCOK
RCC_CRS_IT_SYNCWARN
RCC_CRS_IT_ERR
RCC_CRS_IT_ESYNC
Return value:
RCC_CRS_IT_ERROR_MASK
The: new state of __INTERRUPT__ (SET or

RESET).
Description:
Clear the CRS's interrupt pending bits bits to

clear the selected interrupt pending bits.
Parameters:
398/692

pending bit to clear. This parameter can be
any combination of the following values:
RCC_CRS_IT_SYNCOK
RCC_CRS_IT_SYNCWARN
RCC_CRS_IT_ERR
RCC_CRS_IT_ESYNC
DocID026525 Rev 1
UM1785
RCC_CRS_IT_TRIMOVF
RCC_CRS_IT_SYNCERR
RCC_CRS_IT_SYNCMISS
__HAL_RCC_CRS_CLEAR_IT
__HAL_RCC_CRS_GET_FLAG
Description:
Checks whether the specified CRS flag is

set or not.
Parameters:
_FLAG_: specifies the flag to check. This

values:
RCC_CRS_FLAG_SYNCOK
RCC_CRS_FLAG_ERR
RCC_CRS_FLAG_ESYNC
Return value:
RCC_CRS_FLAG_ERROR_MASK
The: new state of _FLAG_ (TRUE or

FALSE).
Description:
Clears the CRS specified FLAG.
Parameters:
_FLAG_: specifies the flag to clear. This

values:
RCC_CRS_FLAG_SYNCOK
RCC_CRS_FLAG_ERR
RCC_CRS_FLAG_ESYNC
Return value:
None:
__HAL_RCC_CRS_CLEAR_FLAG
RCCEx MCOx Clock Prescaler
RCC_MCO_DIV1
RCC_MCO_DIV2
RCC_MCO_DIV4
RCC_MCO_DIV8
RCC_MCO_DIV16
DocID026525 Rev 1
399/692

RCC_MCO_DIV32
UM1785
RCC_MCO_DIV64
RCC_MCO_DIV128
IS_RCC_MCODIV
RCCEx MCO Clock Source
RCC_MCOSOURCE_HSI48
RCC_MCOSOURCE_PLLCLK_NODIV
IS_RCC_MCOSOURCE
RCC_IT_HSI48
RCC_CR2_HSI48RDY_BitNumber
RCC_FLAG_HSI48RDY
RCCEx_Peripheral_Clock_Enable_Disable
__GPIOD_CLK_ENABLE
__GPIOD_CLK_DISABLE
__GPIOE_CLK_ENABLE
__GPIOE_CLK_DISABLE
__TSC_CLK_ENABLE
__TSC_CLK_DISABLE
__DMA2_CLK_ENABLE
__DMA2_CLK_DISABLE
__USART2_CLK_ENABLE
__SPI2_CLK_ENABLE
__SPI2_CLK_DISABLE
__TIM2_CLK_ENABLE
__TIM2_CLK_DISABLE
__TIM6_CLK_ENABLE
__I2C2_CLK_ENABLE
__TIM6_CLK_DISABLE
__I2C2_CLK_DISABLE
__DAC1_CLK_ENABLE
__DAC1_CLK_DISABLE
__CEC_CLK_ENABLE
__CEC_CLK_DISABLE
__TIM7_CLK_ENABLE
__USART3_CLK_ENABLE
400/692
DocID026525 Rev 1
UM1785

__USART4_CLK_ENABLE
__TIM7_CLK_DISABLE
__CAN_CLK_ENABLE
__CAN_CLK_DISABLE
__CRS_CLK_ENABLE
__CRS_CLK_DISABLE
__USART5_CLK_ENABLE
__TIM15_CLK_ENABLE
__TIM15_CLK_DISABLE
__USART6_CLK_ENABLE
__USART7_CLK_ENABLE
__USART8_CLK_ENABLE
RCCEx Peripheral Clock Source Config
__HAL_RCC_CEC_CONFIG
Description:
Macro to configure the CEC clock.
Parameters:
__HAL_RCC_GET_CEC_SOURCE
__CECCLKSource__: specifies the CEC clock

following values:
RCC_CECCLKSOURCE_HSI: HSI
selected as CEC clock
RCC_CECCLKSOURCE_LSE: LSE
Description:
Macro to get the HDMI CEC clock source.
Return value:
__HAL_RCC_MCO_CONFIG

values:
RCC_CECCLKSOURCE_HSI: HSI
RCC_CECCLKSOURCE_LSE: LSE
Description:
Macro to configure the MCO clock.
DocID026525 Rev 1
401/692
UM1785
Parameters:
__MCOCLKSource__: specifies the MCO

clock source. This parameter can be one of
RCC_MCOSOURCE_HSI: HSI selected

as MCO clock
RCC_MCOSOURCE_HSE: HSE
selected as MCO clock
RCC_MCOSOURCE_LSI: LSI selected

as MCO clock
RCC_MCOSOURCE_LSE: LSE selected

as MCO clock
RCC_MCOSOURCE_PLLCLK_NODIV:
PLLCLK selected as MCO clock
RCC_MCOSOURCE_PLLCLK_DIV2:
PLLCLK Divided by 2 selected as MCO
clock
RCC_MCOSOURCE_SYSCLK: System
Clock selected as MCO clock
RCC_MCOSOURCE_HSI14: HSI14
RCC_MCOSOURCE_HSI48: HSI48
__MCODiv__: specifies the MCO clock
prescaler. This parameter can be one of the
following values:
RCC_MCO_DIV1: MCO clock source is

divided by 1

divided by 2

divided by 4

divided by 8

divided by 16

divided by 32

divided by 64
RCC_MCO_DIV128: MCO clock source

is divided by 128
Description:

(USART2CLK).
Parameters:
402/692

DocID026525 Rev 1
UM1785
CE

Description:
Return value:

values:
Description:

(USART3CLK).
Parameters:
CE

Description:
Return value:

values:
RCCEx Periph Clock Selection

DocID026525 Rev 1
403/692

RCC_PERIPHCLK_USART1
RCC_PERIPHCLK_I2C1
RCC_PERIPHCLK_CEC
RCC_PERIPHCLK_RTC
IS_RCC_PERIPHCLK
RCCEx PLL Clock Source
RCC_PLLSOURCE_HSI
RCC_PLLSOURCE_HSI48
IS_RCC_PLLSOURCE
RCCEx Private Define
HSI48_TIMEOUT_VALUE
CRS_CFGR_FELIM_BITNUMBER
CRS_CR_TRIM_BITNUMBER
CRS_ISR_FECAP_BITNUMBER
RCCEx System Clock Source
RCC_SYSCLKSOURCE_HSI48
IS_RCC_SYSCLKSOURCE
RCC_SYSCLKSOURCE_STATUS_HSI48
IS_RCC_SYSCLKSOURCE_STATUS
RCCEx USART2 Clock Source
RCCEx USART3 Clock Source
404/692
DocID026525 Rev 1
UM1785
UM1785
HAL RTC Generic Driver
32
32.1
RTC Firmware driver registers structures
32.1.1
RTC_InitTypeDef
RTC_InitTypeDef is defined in the stm32f0xx_hal_rtc.h
Data Fields
uint32_t HourFormat
uint32_t AsynchPrediv
uint32_t SynchPrediv
uint32_t OutPut
uint32_t OutPutPolarity
uint32_t OutPutType
Field Documentation
32.1.2
uint32_t RTC_InitTypeDef::HourFormat Specifies the RTC Hour Format. This

parameter can be a value of RTC_Hour_Formats
uint32_t RTC_InitTypeDef::AsynchPrediv Specifies the RTC Asynchronous
Predivider value. This parameter must be a number between Min_Data = 0x00 and
Max_Data = 0x7F
uint32_t RTC_InitTypeDef::SynchPrediv Specifies the RTC Synchronous Predivider
value. This parameter must be a number between Min_Data = 0x00 and Max_Data =
0x7FFF
uint32_t RTC_InitTypeDef::OutPut Specifies which signal will be routed to the RTC
output. This parameter can be a value of RTCEx_Output_selection_Definitions
uint32_t RTC_InitTypeDef::OutPutPolarity Specifies the polarity of the output
signal. This parameter can be a value of RTC_Output_Polarity_Definitions
uint32_t RTC_InitTypeDef::OutPutType Specifies the RTC Output Pin mode. This
parameter can be a value of RTC_Output_Type_ALARM_OUT
RTC_TimeTypeDef
RTC_TimeTypeDef is defined in the stm32f0xx_hal_rtc.h
Data Fields
uint8_t Hours
uint8_t Minutes
uint8_t Seconds
uint32_t SubSeconds
uint8_t TimeFormat
uint32_t DayLightSaving
uint32_t StoreOperation
Field Documentation
DocID026525 Rev 1
405/692
32.1.3
UM1785
uint8_t RTC_TimeTypeDef::Hours Specifies the RTC Time Hour. This parameter

must be a number between Min_Data = 0 and Max_Data = 12 if the
RTC_HourFormat_12 is selected. This parameter must be a number between
Min_Data = 0 and Max_Data = 23 if the RTC_HourFormat_24 is selected
uint8_t RTC_TimeTypeDef::Minutes Specifies the RTC Time Minutes. This
parameter must be a number between Min_Data = 0 and Max_Data = 59
uint8_t RTC_TimeTypeDef::Seconds Specifies the RTC Time Seconds. This
parameter must be a number between Min_Data = 0 and Max_Data = 59
uint32_t RTC_TimeTypeDef::SubSeconds Specifies the RTC Time SubSeconds.
This parameter must be a number between Min_Data = 0 and Max_Data = 59
uint8_t RTC_TimeTypeDef::TimeFormat Specifies the RTC AM/PM Time. This
parameter can be a value of RTC_AM_PM_Definitions
uint32_t RTC_TimeTypeDef::DayLightSaving Specifies
RTC_DayLightSaveOperation: the value of hour adjustment. This parameter can be a
value of RTC_DayLightSaving_Definitions
uint32_t RTC_TimeTypeDef::StoreOperation Specifies RTC_StoreOperation value
to be written in the BCK bit in CR register to store the operation. This parameter can
be a value of RTC_StoreOperation_Definitions
RTC_DateTypeDef
RTC_DateTypeDef is defined in the stm32f0xx_hal_rtc.h
Data Fields
uint8_t WeekDay
uint8_t Month
uint8_t Date
uint8_t Year
Field Documentation
32.1.4
uint8_t RTC_DateTypeDef::WeekDay Specifies the RTC Date WeekDay. This

parameter can be a value of RTC_WeekDay_Definitions
uint8_t RTC_DateTypeDef::Month Specifies the RTC Date Month (in BCD format).
This parameter can be a value of RTC_Month_Date_Definitions
uint8_t RTC_DateTypeDef::Date Specifies the RTC Date. This parameter must be a
number between Min_Data = 1 and Max_Data = 31
uint8_t RTC_DateTypeDef::Year Specifies the RTC Date Year. This parameter must
be a number between Min_Data = 0 and Max_Data = 99
RTC_AlarmTypeDef
RTC_AlarmTypeDef is defined in the stm32f0xx_hal_rtc.h
Data Fields
406/692
RTC_TimeTypeDef AlarmTime
uint32_t AlarmMask
uint32_t AlarmSubSecondMask
uint32_t AlarmDateWeekDaySel
uint8_t AlarmDateWeekDay
uint32_t Alarm
DocID026525 Rev 1
UM1785

Field Documentation
32.1.5
RTC_TimeTypeDef RTC_AlarmTypeDef::AlarmTime Specifies the RTC Alarm Time

members
uint32_t RTC_AlarmTypeDef::AlarmMask Specifies the RTC Alarm Masks. This
parameter can be a value of RTC_AlarmMask_Definitions
uint32_t RTC_AlarmTypeDef::AlarmSubSecondMask Specifies the RTC Alarm
SubSeconds Masks. This parameter can be a value of
RTC_Alarm_Sub_Seconds_Masks_Definitions
uint32_t RTC_AlarmTypeDef::AlarmDateWeekDaySel Specifies the RTC Alarm is
on Date or WeekDay. This parameter can be a value of
RTC_AlarmDateWeekDay_Definitions
uint8_t RTC_AlarmTypeDef::AlarmDateWeekDay Specifies the RTC Alarm
Date/WeekDay. If the Alarm Date is selected, this parameter must be set to a value in
the 1-31 range. If the Alarm WeekDay is selected, this parameter can be a value of
RTC_WeekDay_Definitions
uint32_t RTC_AlarmTypeDef::Alarm Specifies the alarm . This parameter can be a
value of RTC_Alarms_Definitions
RTC_HandleTypeDef
RTC_HandleTypeDef is defined in the stm32f0xx_hal_rtc.h
Data Fields
RTC_TypeDef * Instance
RTC_InitTypeDef Init
__IO HAL_RTCStateTypeDef State
Field Documentation
32.2
RTC_TypeDef* RTC_HandleTypeDef::Instance Register base address

RTC_InitTypeDef RTC_HandleTypeDef::Init RTC required parameters
HAL_LockTypeDef RTC_HandleTypeDef::Lock RTC locking object
__IO HAL_RTCStateTypeDef RTC_HandleTypeDef::State Time communication
state
RTC Firmware driver API description

The following section lists the various functions of the RTC library.
32.2.1
RTC Operating Condition

The real-time clock (RTC) and the RTC backup registers can be powered from the VBAT
voltage when the main VDD supply is powered off. To retain the content of the RTC backup
registers and supply the RTC when VDD is turned off, VBAT pin can be connected to an
optional standby voltage supplied by a battery or by another source.
To allow the RTC to operate even when the main digital supply (VDD) is turned off, the
VBAT pin powers the following blocks:
DocID026525 Rev 1
407/692

1.
The RTC
2.
The LSE oscillator
3.
PC13 to PC15 I/Os (when available)
UM1785
When the backup domain is supplied by VDD (analog switch connected to VDD), the
following functions are available:
1.
2.
PC14 and PC15 can be used as either GPIO or LSE pins

PC13 can be used as a GPIO or as the RTC_OUT pin
When the backup domain is supplied by VBAT (analog switch connected to VBAT
because VDD is not present), the following functions are available:
1.
2.
32.2.2
PC14 and PC15 can be used as LSE pins only

PC13 can be used as the RTC_OUT pin
Backup Domain Reset

The backup domain reset sets all RTC registers and the RCC_BDCR register to their reset
values. A backup domain reset is generated when one of the following events occurs:
1.
2.
32.2.3
Software reset, triggered by setting the BDRST bit in the RCC Backup domain control
register (RCC_BDCR).
VDD or VBAT power on, if both supplies have previously been powered off.
Backup Domain Access

After reset, the backup domain (RTC registers, RTC backup data registers and backup
SRAM) is protected against possible unwanted write accesses.
To enable access to the RTC Domain and RTC registers, proceed as follows:
1.
2.
3.
4.
32.2.4
Enable the Power Controller (PWR) APB1 interface clock using the
__PWR_CLK_ENABLE() function.
Enable access to RTC domain using the HAL_PWR_EnableBkUpAccess() function.
Select the RTC clock source using the __HAL_RCC_RTC_CONFIG() function.
Enable RTC Clock using the __HAL_RCC_RTC_ENABLE() function.
How to use RTC Driver
Enable the RTC domain access (see description in the section above).
Configure the RTC Prescaler (Asynchronous and Synchronous) and RTC hour format
using the HAL_RTC_Init() function.
Time and Date configuration
408/692
To configure the RTC Calendar (Time and Date) use the HAL_RTC_SetTime() and
HAL_RTC_SetDate() functions.
To read the RTC Calendar, use the HAL_RTC_GetTime() and HAL_RTC_GetDate()
functions.
DocID026525 Rev 1
UM1785
Alarm configuration
32.2.5
To configure the RTC Alarm use the HAL_RTC_SetAlarm() function. You can also
configure the RTC Alarm with interrupt mode using the HAL_RTC_SetAlarm_IT()
function.
To read the RTC Alarm, use the HAL_RTC_GetAlarm() function.
RTC and low power modes

The MCU can be woken up from a low power mode by an RTC alternate function.
The RTC alternate functions are the RTC alarm (Alarm A), RTC wakeup, RTC tamper
event detection and RTC time stamp event detection. These RTC alternate functions can
wake up the system from the Stop and Standby low power modes.
The system can also wake up from low power modes without depending on an external
interrupt (Auto-wakeup mode), by using the RTC alarm or the RTC wakeup events.
The RTC provides a programmable time base for waking up from the Stop or Standby
mode at regular intervals. Wakeup from STOP and Standby modes is possible only when
the RTC clock source is LSE or LSI.
32.2.6

This section provide functions allowing to initialize and configure the RTC Prescaler
(Synchronous and Asynchronous), RTC Hour format, disable RTC registers Write
protection, enter and exit the RTC initialization mode, RTC registers synchronization check
and reference clock detection enable.
1.
2.
3.
4.
32.2.7
The RTC Prescaler is programmed to generate the RTC 1Hz time base. It is split into
2 programmable prescalers to minimize power consumption.
A 7-bit asynchronous prescaler and A 15-bit synchronous prescaler.
When both prescalers are used, it is recommended to configure the

asynchronous prescaler to a high value to minimize consumption.
All RTC registers are Write protected. Writing to the RTC registers is enabled by
writing a key into the Write Protection register, RTC_WPR.
To Configure the RTC Calendar, user application should enter initialization mode. In
this mode, the calendar counter is stopped and its value can be updated. When the
initialization sequence is complete, the calendar restarts counting after 4 RTCCLK
cycles.
To read the calendar through the shadow registers after Calendar initialization,
calendar update or after wakeup from low power modes the software must first clear
the RSF flag. The software must then wait until it is set again before reading the
calendar, which means that the calendar registers have been correctly copied into the
RTC_TR and RTC_DR shadow registers.The HAL_RTC_WaitForSynchro() function
implements the above software sequence (RSF clear and RSF check).
HAL_RTC_Init()
HAL_RTC_DeInit()
HAL_RTC_MspInit()
HAL_RTC_MspDeInit()
RTC Time and Date functions
DocID026525 Rev 1
409/692

This section provide functions allowing to configure Time and Date features
32.2.8
UM1785
HAL_RTC_SetTime()
HAL_RTC_GetTime()
HAL_RTC_SetDate()
HAL_RTC_GetDate()
RTC Alarm functions

This section provide functions allowing to configure Alarm feature
32.2.9
HAL_RTC_SetAlarm()
HAL_RTC_SetAlarm_IT()
HAL_RTC_DeactivateAlarm()
HAL_RTC_GetAlarm()
HAL_RTC_AlarmIRQHandler()
HAL_RTC_AlarmAEventCallback()
HAL_RTC_PollForAlarmAEvent()

32.2.10
Wait for RTC Time and Date Synchronization

HAL_RTC_WaitForSynchro()

32.2.11
410/692
Get RTC state

HAL_RTC_GetState()
HAL_RTC_Init
Function Name
HAL_StatusTypeDef HAL_RTC_Init ( RTC_HandleTypeDef *

hrtc)
Initializes the RTC peripheral.
Parameters
hrtc : RTC handle
Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
32.2.12
32.2.13
32.2.14
HAL_RTC_DeInit
Function Name
HAL_StatusTypeDef HAL_RTC_DeInit ( RTC_HandleTypeDef *

hrtc)
DeInitializes the RTC peripheral.
Parameters
hrtc : RTC handle
Return values
HAL status
Notes
This function doesn't reset the RTC Backup Data registers.
HAL_RTC_MspInit
Function Name
void HAL_RTC_MspInit ( RTC_HandleTypeDef * hrtc)
Initializes the RTC MSP.
Parameters
hrtc : RTC handle
Return values
None.
Notes
None.
HAL_RTC_MspDeInit
Function Name
void HAL_RTC_MspDeInit ( RTC_HandleTypeDef * hrtc)
DeInitializes the RTC MSP.
Parameters
hrtc : RTC handle
Return values
None.
Notes
None.
DocID026525 Rev 1
411/692
32.2.15
32.2.16
32.2.17
412/692
UM1785
HAL_RTC_SetTime
Function Name
HAL_StatusTypeDef HAL_RTC_SetTime (
RTC_HandleTypeDef * hrtc, RTC_TimeTypeDef * sTime,
uint32_t Format)
Sets RTC current time.
Parameters
hrtc : RTC handle

sTime : Pointer to Time structure
Format : Specifies the format of the entered parameters.
Format_BIN Binary data format
Format_BCD BCD data format
Return values
HAL status
Notes
None.
HAL_RTC_GetTime
Function Name
HAL_StatusTypeDef HAL_RTC_GetTime (
RTC_HandleTypeDef * hrtc, RTC_TimeTypeDef * sTime,
uint32_t Format)
Gets RTC current time.
Parameters
hrtc : RTC handle

sTime : Pointer to Time structure
Return values
HAL status
Notes
Call HAL_RTC_GetDate() after HAL_RTC_GetTime() to

unlock the values in the higher-order calendar shadow
registers.
HAL_RTC_SetDate
DocID026525 Rev 1
UM1785
32.2.18
32.2.19
Function Name

HAL_StatusTypeDef HAL_RTC_SetDate ( RTC_HandleTypeDef
* hrtc, RTC_DateTypeDef * sDate, uint32_t Format)
Sets RTC current date.
Parameters
hrtc : RTC handle

sDate : Pointer to date structure
Format : specifies the format of the entered parameters. This
Return values
HAL status
Notes
None.
HAL_RTC_GetDate
Function Name
HAL_StatusTypeDef HAL_RTC_GetDate (
RTC_HandleTypeDef * hrtc, RTC_DateTypeDef * sDate,
uint32_t Format)
Gets RTC current date.
Parameters
hrtc : RTC handle

sDate : Pointer to Date structure
Return values
HAL status
Notes
None.
HAL_RTC_SetAlarm
Function Name
HAL_StatusTypeDef HAL_RTC_SetAlarm (
RTC_HandleTypeDef * hrtc, RTC_AlarmTypeDef * sAlarm,
uint32_t Format)
Sets the specified RTC Alarm.
Parameters
hrtc : RTC handle

sAlarm : Pointer to Alarm structure
DocID026525 Rev 1
413/692
32.2.20
UM1785

Return values
HAL status
Notes
None.
HAL_RTC_SetAlarm_IT
Function Name
HAL_StatusTypeDef HAL_RTC_SetAlarm_IT (
uint32_t Format)
Sets the specified RTC Alarm with Interrupt.
Parameters
hrtc : RTC handle

sAlarm : Pointer to Alarm structure
Return values
HAL status
Notes
The Alarm register can only be written when the

corresponding Alarm is disabled (Use the
HAL_RTC_DeactivateAlarm()).
The HAL_RTC_SetTime() must be called before enabling the
Alarm feature.
32.2.21
414/692
HAL_RTC_DeactivateAlarm
Function Name
HAL_StatusTypeDef HAL_RTC_DeactivateAlarm (
RTC_HandleTypeDef * hrtc, uint32_t Alarm)
Deactive the specified RTC Alarm.
Parameters
hrtc : RTC handle

Alarm : Specifies the Alarm. This parameter can be one of
ALARM_A AlarmA
DocID026525 Rev 1
UM1785
32.2.22

Return values
HAL status
Notes
None.
HAL_RTC_GetAlarm
Function Name
HAL_StatusTypeDef HAL_RTC_GetAlarm (
uint32_t Alarm, uint32_t Format)
Gets the RTC Alarm value and masks.
Parameters
32.2.23
hrtc : RTC handle

sAlarm : Pointer to Date structure
Alarm : Specifies the Alarm This parameter can be one of
ALARM_A AlarmA
Return values
HAL status
Notes
None.
HAL_RTC_AlarmIRQHandler
Function Name
void HAL_RTC_AlarmIRQHandler ( RTC_HandleTypeDef *

hrtc)
This function handles Alarm interrupt request.
Parameters
hrtc : RTC handle
Return values
None.
Notes
None.
DocID026525 Rev 1
415/692
32.2.24
32.2.25
32.2.26
UM1785
HAL_RTC_AlarmAEventCallback
Function Name
void HAL_RTC_AlarmAEventCallback ( RTC_HandleTypeDef *

hrtc)
Alarm A callback.
Parameters
hrtc : RTC handle
Return values
None.
Notes
None.
HAL_RTC_PollForAlarmAEvent
Function Name
HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent (
RTC_HandleTypeDef * hrtc, uint32_t Timeout)
This function handles AlarmA Polling request.
Parameters
hrtc : RTC handle

Return values
HAL status
Notes
None.
HAL_RTC_WaitForSynchro
Function Name
HAL_StatusTypeDef HAL_RTC_WaitForSynchro (
RTC_HandleTypeDef * hrtc)
Waits until the RTC Time and Date registers (RTC_TR and
RTC_DR) are synchronized with RTC APB clock.
Parameters
hrtc : RTC handle
Return values
HAL status
Notes
The RTC Resynchronization mode is write protected, use the

__HAL_RTC_WRITEPROTECTION_DISABLE() before
calling this function.
To read the calendar through the shadow registers after
416/692
DocID026525 Rev 1
UM1785
32.2.27

Calendar initialization, calendar update or after wakeup from
low power modes the software must first clear the RSF flag.
The software must then wait until it is set again before reading
the calendar, which means that the calendar registers have
been correctly copied into the RTC_TR and RTC_DR shadow
registers.
HAL_RTC_GetState
Function Name
HAL_RTCStateTypeDef HAL_RTC_GetState (
Returns the Alarm state.
Parameters
hrtc : RTC handle
Return values
HAL state
Notes
None.
32.3
RTC Firmware driver defines
32.3.1
RTC
RTC
RTC AlarmDateWeekDay Definitions
RTC_ALARMDATEWEEKDAYSEL_DATE
RTC_ALARMDATEWEEKDAYSEL_WEEKDAY
IS_RTC_ALARM_DATE_WEEKDAY_SEL
RTC AlarmMask Definitions
RTC_ALARMMASK_NONE
RTC_ALARMMASK_DATEWEEKDAY
RTC_ALARMMASK_HOURS
RTC_ALARMMASK_MINUTES
RTC_ALARMMASK_SECONDS
RTC_ALARMMASK_ALL
IS_ALARM_MASK
RTC Alarms Definitions
DocID026525 Rev 1
417/692

RTC_ALARM_A
UM1785
IS_ALARM
RTC Alarm Definitions
IS_RTC_ALARM_DATE_WEEKDAY_DATE
IS_RTC_ALARM_DATE_WEEKDAY_WEEKDAY
RTC Alarm Sub Seconds Masks Definitions
RTC_ALARMSUBSECONDMASK_ALL
All Alarm SS fields are masked. There is no

comparison on sub seconds for Alarm
RTC_ALARMSUBSECONDMASK_SS14_1
SS[14:1] are don't care in Alarm

comparison. Only SS[0] is compared.

comparison. Only SS[1:0] are compared










comparison.Only SS[11:0] are compared

RTC_ALARMSUBSECONDMASK_SS14
SS[14] is don't care in Alarm

comparison.Only SS[13:0] are compared
RTC_ALARMSUBSECONDMASK_None
SS[14:0] are compared and must match to

activate alarm.
IS_RTC_ALARM_SUB_SECOND_MASK
RTC Alarm Sub Seconds Value
IS_RTC_ALARM_SUB_SECOND_VALUE
RTC AM PM Definitions
418/692
DocID026525 Rev 1
UM1785

RTC_HOURFORMAT12_AM
RTC_HOURFORMAT12_PM
IS_RTC_HOURFORMAT12
RTC Asynchronous Predivider
IS_RTC_ASYNCH_PREDIV
RTC DayLightSaving Definitions
RTC_DAYLIGHTSAVING_SUB1H
RTC_DAYLIGHTSAVING_ADD1H
RTC_DAYLIGHTSAVING_NONE
IS_RTC_DAYLIGHT_SAVING
RTC Exported Macros
__HAL_RTC_RESET_HANDLE_STA
TE
Description:
Reset RTC handle state.
Parameters:
__HANDLE__: RTC handle.
Return value:
__HAL_RTC_WRITEPROTECTION_
DISABLE
None:
Description:
Disable the write protection for RTC

registers.
Parameters:
__HANDLE__: specifies the RTC handle.
Return value:
__HAL_RTC_WRITEPROTECTION_
ENABLE
None:
Description:
Enable the write protection for RTC

registers.
Parameters:
Return value:
__HAL_RTC_ALARMA_ENABLE
None:
Description:
Enable the RTC ALARMA peripheral.
Parameters:
Return value:
None:
DocID026525 Rev 1
419/692

__HAL_RTC_ALARMA_DISABLE
UM1785
Description:
Disable the RTC ALARMA peripheral.
Parameters:
Return value:
__HAL_RTC_ALARM_ENABLE_IT
None:
Description:
Enable the RTC Alarm interrupt.
Parameters:

__INTERRUPT__: specifies the RTC Alarm
interrupt sources to be enabled or disabled.
This parameter can be any combination of
RTC_IT_ALRA: Alarm A interrupt
Return value:
__HAL_RTC_ALARM_DISABLE_IT
None:
Description:
Disable the RTC Alarm interrupt.
Parameters:

__INTERRUPT__: specifies the RTC Alarm
This parameter can be any combination of
Return value:
__HAL_RTC_ALARM_GET_IT
None:
Description:
Check whether the specified RTC Alarm

Parameters:

__FLAG__: specifies the RTC Alarm
This parameter can be:
Return value:
__HAL_RTC_ALARM_GET_FLAG
Description:
420/692
None:
Get the selected RTC Alarm's flag status.
DocID026525 Rev 1
UM1785

Parameters:

__FLAG__: specifies the RTC Alarm Flag
sources to be enabled or disabled. This
parameter can be:
RTC_FLAG_ALRAF
RTC_FLAG_ALRAWF
Return value:
__HAL_RTC_ALARM_CLEAR_FLAG
None:
Description:
Clear the RTC Alarm's pending flags.
Parameters:

__FLAG__: specifies the RTC Alarm Flag
parameter can be:
RTC_FLAG_ALRAF
Return value:
None:
RTC_EXTI_LINE_ALARM_EVENT
External interrupt line 17 Connected to the RTC

Alarm event
RTC_EXTI_LINE_TAMPER_TIMEST
AMP_EVENT

Tamper and Time Stamp events
RTC_EXTI_LINE_WAKEUPTIMER_E
VENT

Wakeup event
__HAL_RTC_EXTI_ENABLE_IT
Description:
Enable the RTC Exti line.
Parameters:
__EXTILINE__: specifies the RTC Exti

parameter can be:
RTC_EXTI_LINE_TAMPER_TIMESTA
MP_EVENT
RTC_EXTI_LINE_WAKEUPTIMER_EV
ENT
Return value:
None:
__HAL_RTC_ENABLE_IT
__HAL_RTC_EXTI_DISABLE_IT
Description:
Disable the RTC Exti line.
Parameters:
DocID026525 Rev 1
421/692
UM1785

parameter can be:
MP_EVENT
ENT
Return value:
None:
__HAL_RTC_DISABLE_IT
__HAL_RTC_EXTI_GENERATE_SWI
T
Description:
Generates a Software interrupt on selected

EXTI line.
Parameters:

parameter can be:
MP_EVENT
ENT
Return value:
__HAL_RTC_EXTI_CLEAR_FLAG
None:
Description:
Clear the RTC Exti flags.
Parameters:
__FLAG__: specifies the RTC Exti sources

to be enabled or disabled. This parameter
can be:
MP_EVENT
ENT
Return value:
None:
__HAL_RTC_CLEAR_FLAG
RTC Flags Definitions
RTC_FLAG_RECALPF
RTC_FLAG_TAMP3F
RTC_FLAG_TAMP2F
422/692
DocID026525 Rev 1
UM1785

RTC_FLAG_TAMP1F
RTC_FLAG_TSOVF
RTC_FLAG_TSF
RTC_FLAG_WUTF
RTC_FLAG_ALRAF
RTC_FLAG_INITF
RTC_FLAG_RSF
RTC_FLAG_INITS
RTC_FLAG_SHPF
RTC_FLAG_WUTWF
RTC_FLAG_ALRAWF
RTC Hour Formats
RTC_HOURFORMAT_24
RTC_HOURFORMAT_12
IS_RTC_HOUR_FORMAT
RTC Input parameter format definitions
FORMAT_BIN
FORMAT_BCD
IS_RTC_FORMAT
RTC Interrupts Definitions
RTC_IT_TS
RTC_IT_WUT
RTC_IT_ALRA
RTC_IT_TAMP
RTC_IT_TAMP1
RTC_IT_TAMP2
RTC_IT_TAMP3
RTC Mask Definition
RTC_TR_RESERVED_MASK
RTC_DR_RESERVED_MASK
RTC_INIT_MASK
RTC_RSF_MASK
RTC_TIMEOUT_VALUE
RTC Month Date Definitions
RTC_MONTH_JANUARY
RTC_MONTH_FEBRUARY
DocID026525 Rev 1
423/692

RTC_MONTH_MARCH
UM1785
RTC_MONTH_APRIL
RTC_MONTH_MAY
RTC_MONTH_JUNE
RTC_MONTH_JULY
RTC_MONTH_AUGUST
RTC_MONTH_SEPTEMBER
RTC_MONTH_OCTOBER
RTC_MONTH_NOVEMBER
RTC_MONTH_DECEMBER
IS_RTC_MONTH
IS_RTC_DATE
RTC Output Polarity Definitions
RTC_OUTPUT_POLARITY_HIGH
RTC_OUTPUT_POLARITY_LOW
IS_RTC_OUTPUT_POL
RTC Output Type ALARM OUT
RTC_OUTPUT_TYPE_OPENDRAIN
RTC_OUTPUT_TYPE_PUSHPULL
IS_RTC_OUTPUT_TYPE
RTC StoreOperation Definitions
RTC_STOREOPERATION_RESET
RTC_STOREOPERATION_SET
IS_RTC_STORE_OPERATION
RTC Synchronous Predivider
IS_RTC_SYNCH_PREDIV
RTC Time Definitions
IS_RTC_HOUR12
IS_RTC_HOUR24
IS_RTC_MINUTES
IS_RTC_SECONDS
RTC WeekDay Definitions
RTC_WEEKDAY_MONDAY
RTC_WEEKDAY_TUESDAY
RTC_WEEKDAY_WEDNESDAY
RTC_WEEKDAY_THURSDAY
424/692
DocID026525 Rev 1
UM1785

RTC_WEEKDAY_FRIDAY
RTC_WEEKDAY_SATURDAY
RTC_WEEKDAY_SUNDAY
IS_RTC_WEEKDAY
RTC Year Date Definitions
IS_RTC_YEAR
DocID026525 Rev 1
425/692
HAL RTC Extension Driver
UM1785
33
33.1
RTCEx Firmware driver registers structures
33.1.1
RTC_TamperTypeDef
RTC_TamperTypeDef is defined in the stm32f0xx_hal_rtc_ex.h
Data Fields
uint32_t Tamper
uint32_t Trigger
uint32_t Filter
uint32_t SamplingFrequency
uint32_t PrechargeDuration
uint32_t TamperPullUp
uint32_t TimeStampOnTamperDetection
Field Documentation
33.2
uint32_t RTC_TamperTypeDef::Tamper Specifies the Tamper Pin. This parameter

can be a value of RTCEx_Tamper_Pins_Definitions
uint32_t RTC_TamperTypeDef::Trigger Specifies the Tamper Trigger. This
parameter can be a value of RTCEx_Tamper_Trigger_Definitions
uint32_t RTC_TamperTypeDef::Filter Specifies the RTC Filter Tamper. This
parameter can be a value of RTCEx_Tamper_Filter_Definitions
uint32_t RTC_TamperTypeDef::SamplingFrequency Specifies the sampling
frequency. This parameter can be a value of
RTCEx_Tamper_Sampling_Frequencies_Definitions
uint32_t RTC_TamperTypeDef::PrechargeDuration Specifies the Precharge
Duration . This parameter can be a value of
RTCEx_Tamper_Pin_Precharge_Duration_Definitions
uint32_t RTC_TamperTypeDef::TamperPullUp Specifies the Tamper PullUp . This
parameter can be a value of RTCEx_Tamper_Pull_UP_Definitions
uint32_t RTC_TamperTypeDef::TimeStampOnTamperDetection Specifies the
TimeStampOnTamperDetection. This parameter can be a value of
RTCEx_Tamper_TimeStampOnTamperDetection_Definitions
RTCEx Firmware driver API description

The following section lists the various functions of the RTCEx library.
33.2.1
426/692
Enable the RTC domain access (see description in the section above).
Configure the RTC Prescaler (Asynchronous and Synchronous) and RTC hour format
using the HAL_RTC_Init() function.
DocID026525 Rev 1
UM1785
RTC Wakeup configuration

Not available on F030x6/x8/xC and F070x6/xB
TimeStamp configuration
Configure the RTC_AF trigger and enables the RTC TimeStamp using the
HAL_RTCEx_SetTimeStamp() function. You can also configure the RTC TimeStamp
with interrupt mode using the HAL_RTCEx_SetTimeStamp_IT() function.
To read the RTC TimeStamp Time and Date register, use the
HAL_RTCEx_GetTimeStamp() function.
Tamper configuration
Enable the RTC Tamper and Configure the Tamper filter count, trigger Edge or Level
according to the Tamper filter (if equal to 0 Edge else Level) value, sampling
frequency, precharge or discharge and Pull-UP using the HAL_RTCEx_SetTamper()
function. You can configure RTC Tamper with interrupt mode using
HAL_RTCEx_SetTamper_IT() function.
Backup Data Registers configuration

Not available on F030x6/x8/xC and F070x6/xB
33.2.2
RTC TimeStamp and Tamper functions

This section provide functions allowing to configure TimeStamp feature
HAL_RTCEx_SetTimeStamp()
HAL_RTCEx_SetTimeStamp_IT()
HAL_RTCEx_DeactivateTimeStamp()
HAL_RTCEx_GetTimeStamp()
HAL_RTCEx_SetTamper()
HAL_RTCEx_SetTamper_IT()
HAL_RTCEx_DeactivateTamper()
HAL_RTCEx_TamperTimeStampIRQHandler()
HAL_RTCEx_TimeStampEventCallback()
HAL_RTCEx_Tamper1EventCallback()
HAL_RTCEx_PollForTimeStampEvent()
HAL_RTCEx_PollForTamper1Event()
DocID026525 Rev 1
427/692
33.2.3
UM1785
RTC Wake-up functions

This section provide functions allowing to configure Wake-up feature
33.2.4
HAL_RTCEx_SetWakeUpTimer()
HAL_RTCEx_SetWakeUpTimer_IT()
HAL_RTCEx_DeactivateWakeUpTimer()
HAL_RTCEx_GetWakeUpTimer()
HAL_RTCEx_WakeUpTimerIRQHandler()
HAL_RTCEx_WakeUpTimerEventCallback()
HAL_RTCEx_PollForWakeUpTimerEvent()
Extension Peripheral Control functions

33.2.5
428/692
Writes a data in a specified RTC Backup data register

Read a data in a specified RTC Backup data register
Sets the Coarse calibration parameters.
Deactivates the Coarse calibration parameters
Sets the Smooth calibration parameters.
Configures the Synchronization Shift Control Settings.
Configures the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz).
Deactivates the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz).
Enables the RTC reference clock detection.
Disable the RTC reference clock detection.
Enables the Bypass Shadow feature.
Disables the Bypass Shadow feature.
HAL_RTCEx_BKUPWrite()
HAL_RTCEx_BKUPRead()
HAL_RTCEx_SetSmoothCalib()
HAL_RTCEx_SetSynchroShift()
HAL_RTCEx_SetCalibrationOutPut()
HAL_RTCEx_DeactivateCalibrationOutPut()
HAL_RTCEx_SetRefClock()
HAL_RTCEx_DeactivateRefClock()
HAL_RTCEx_EnableBypassShadow()
HAL_RTCEx_DisableBypassShadow()
HAL_RTCEx_SetTimeStamp
Function Name
HAL_StatusTypeDef HAL_RTCEx_SetTimeStamp (
RTC_HandleTypeDef * hrtc, uint32_t TimeStampEdge,
uint32_t RTC_TimeStampPin)
Sets TimeStamp.
Parameters
hrtc : RTC handle

TimeStampEdge : Specifies the pin edge on which the
TimeStamp is activated. This parameter can be one of the
following:
DocID026525 Rev 1
UM1785
33.2.6
TimeStampEdge_Rising the Time stamp event occurs

on the rising edge of the related pin.
TimeStampEdge_Falling the Time stamp event occurs

on the falling edge of the related pin.
RTC_TimeStampPin : specifies the RTC TimeStamp Pin.
RTC_TIMESTAMPPIN_PC13 PC13 is selected as RTC

TimeStamp Pin.
Return values
HAL status
Notes
This API must be called before enabling the TimeStamp

feature.
HAL_RTCEx_SetTimeStamp_IT
Function Name
HAL_StatusTypeDef HAL_RTCEx_SetTimeStamp_IT (
RTC_HandleTypeDef * hrtc, uint32_t TimeStampEdge,
uint32_t RTC_TimeStampPin)
Sets TimeStamp with Interrupt.
Parameters
hrtc : RTC handle
Parameters
TimeStampEdge : Specifies the pin edge on which the

TimeStamp is activated. This parameter can be one of the
following:
TimeStampEdge_Rising the Time stamp event occurs

on the rising edge of the related pin.
TimeStampEdge_Falling the Time stamp event occurs

on the falling edge of the related pin.
RTC_TimeStampPin : Specifies the RTC TimeStamp Pin.
RTC_TIMESTAMPPIN_PC13 PC13 is selected as RTC

TimeStamp Pin.
33.2.7
Return values
HAL status
Notes
This API must be called before enabling the TimeStamp

feature.
HAL_RTCEx_DeactivateTimeStamp
DocID026525 Rev 1
429/692

Function Name
33.2.8
33.2.9
430/692
UM1785
HAL_StatusTypeDef HAL_RTCEx_DeactivateTimeStamp (
Deactivates TimeStamp.
Parameters
hrtc : RTC handle
Return values
HAL status
Notes
None.
HAL_RTCEx_GetTimeStamp
Function Name
HAL_StatusTypeDef HAL_RTCEx_GetTimeStamp (
RTC_HandleTypeDef * hrtc, RTC_TimeTypeDef *
sTimeStamp, RTC_DateTypeDef * sTimeStampDate, uint32_t
Format)
Gets the RTC TimeStamp value.
Parameters
hrtc : RTC handle

sTimeStamp : Pointer to Time structure
sTimeStampDate : Pointer to Date structure
Format : specifies the format of the entered parameters. This
Return values
HAL status
Notes
None.
HAL_RTCEx_SetTamper
Function Name
HAL_StatusTypeDef HAL_RTCEx_SetTamper (
RTC_HandleTypeDef * hrtc, RTC_TamperTypeDef * sTamper)
Sets Tamper.
Parameters
hrtc : RTC handle

sTamper : Pointer to Tamper Structure.
Return values
HAL status
Notes
By calling this API we disable the tamper interrupt for all
DocID026525 Rev 1
UM1785

tampers.
33.2.10
33.2.11
33.2.12
HAL_RTCEx_SetTamper_IT
Function Name
HAL_StatusTypeDef HAL_RTCEx_SetTamper_IT (
RTC_HandleTypeDef * hrtc, RTC_TamperTypeDef * sTamper)
Sets Tamper with interrupt.
Parameters
hrtc : RTC handle

sTamper : Pointer to RTC Tamper.
Return values
HAL status
Notes
By calling this API we force the tamper interrupt for all

tampers.
HAL_RTCEx_DeactivateTamper
Function Name
HAL_StatusTypeDef HAL_RTCEx_DeactivateTamper (
RTC_HandleTypeDef * hrtc, uint32_t Tamper)
Deactivates Tamper.
Parameters
hrtc : RTC handle

Tamper : Selected tamper pin. This parameter can be any
combination of RTC_TAMPER_1, RTC_TAMPER_2 and
RTC_TAMPER_3.
Return values
HAL status
Notes
None.
HAL_RTCEx_TamperTimeStampIRQHandler
Function Name
void HAL_RTCEx_TamperTimeStampIRQHandler (
DocID026525 Rev 1
431/692

33.2.13
33.2.14
33.2.15
Parameters
hrtc : RTC handle
Return values
None.
Notes
None.
HAL_RTCEx_TimeStampEventCallback
Function Name
void HAL_RTCEx_TimeStampEventCallback (
TimeStamp callback.
Parameters
hrtc : RTC handle
Return values
None.
Notes
None.
HAL_RTCEx_Tamper1EventCallback
Function Name
void HAL_RTCEx_Tamper1EventCallback (
Tamper 1 callback.
Parameters
hrtc : RTC handle
Return values
None.
Notes
None.
Function Name
432/692
UM1785
This function handles TimeStamp interrupt request.
DocID026525 Rev 1
UM1785
33.2.16
33.2.17
33.2.18

Tamper 2 callback.
Parameters
hrtc : RTC handle
Return values
None.
Notes
None.
Function Name
Tamper 3 callback.
Parameters
hrtc : RTC handle
Return values
None.
Notes
None.
HAL_RTCEx_PollForTimeStampEvent
Function Name
HAL_StatusTypeDef HAL_RTCEx_PollForTimeStampEvent (
This function handles TimeStamp polling request.
Parameters
hrtc : RTC handle

Return values
HAL status
Notes
None.
HAL_RTCEx_PollForTamper1Event
Function Name
HAL_StatusTypeDef HAL_RTCEx_PollForTamper1Event (
DocID026525 Rev 1
433/692
UM1785
33.2.19
33.2.20
33.2.21
434/692
This function handles Tamper1 Polling.
Parameters
hrtc : RTC handle

Return values
HAL status
Notes
None.
Function Name
Parameters
hrtc : RTC handle

Return values
HAL status
Notes
None.
Function Name
Parameters
hrtc : RTC handle

Return values
HAL status
Notes
None.
HAL_RTCEx_SetWakeUpTimer
DocID026525 Rev 1
UM1785
33.2.22
33.2.23

Function Name
HAL_StatusTypeDef HAL_RTCEx_SetWakeUpTimer (
RTC_HandleTypeDef * hrtc, uint32_t WakeUpCounter,
uint32_t WakeUpClock)
Sets wake up timer.
Parameters
hrtc : RTC handle

WakeUpCounter : Wake up counter
WakeUpClock : Wake up clock
Return values
HAL status
Notes
None.
HAL_RTCEx_SetWakeUpTimer_IT
Function Name
HAL_StatusTypeDef HAL_RTCEx_SetWakeUpTimer_IT (
RTC_HandleTypeDef * hrtc, uint32_t WakeUpCounter,
uint32_t WakeUpClock)
Sets wake up timer with interrupt.
Parameters
hrtc : RTC handle

WakeUpCounter : wake up counter
WakeUpClock : wake up clock
Return values
HAL status
Notes
None.
HAL_RTCEx_DeactivateWakeUpTimer
Function Name
uint32_t HAL_RTCEx_DeactivateWakeUpTimer (
Deactivates wake up timer counter.
Parameters
hrtc : RTC handle
Return values
HAL status
Notes
None.
DocID026525 Rev 1
435/692
33.2.24
33.2.25
33.2.26
436/692
UM1785
HAL_RTCEx_GetWakeUpTimer
Function Name
uint32_t HAL_RTCEx_GetWakeUpTimer (
Gets wake up timer counter.
Parameters
hrtc : RTC handle
Return values
Counter value
Notes
None.
HAL_RTCEx_WakeUpTimerIRQHandler
Function Name
void HAL_RTCEx_WakeUpTimerIRQHandler (
This function handles Wake Up Timer interrupt request.
Parameters
hrtc : RTC handle
Return values
None.
Notes
None.
HAL_RTCEx_WakeUpTimerEventCallback
Function Name
void HAL_RTCEx_WakeUpTimerEventCallback (
Wake Up Timer callback.
Parameters
hrtc : RTC handle
Return values
None.
Notes
None.
DocID026525 Rev 1
UM1785
33.2.27
33.2.28
HAL_RTCEx_PollForWakeUpTimerEvent
Function Name
HAL_StatusTypeDef HAL_RTCEx_PollForWakeUpTimerEvent
( RTC_HandleTypeDef * hrtc, uint32_t Timeout)
This function handles Wake Up Timer Polling.
Parameters
hrtc : RTC handle

Return values
HAL status
Notes
None.
HAL_RTCEx_BKUPWrite
Function Name
void HAL_RTCEx_BKUPWrite ( RTC_HandleTypeDef * hrtc,

uint32_t BackupRegister, uint32_t Data)
Writes a data in a specified RTC Backup data register.
Parameters
33.2.29
hrtc : RTC handle

BackupRegister : RTC Backup data Register number. This
parameter can be: RTC_BKP_DRx where x can be from 0 to
4 to specify the register.
Data : Data to be written in the specified RTC Backup data
register.
Return values
None.
Notes
None.
HAL_RTCEx_BKUPRead
Function Name
uint32_t HAL_RTCEx_BKUPRead ( RTC_HandleTypeDef *

hrtc, uint32_t BackupRegister)
Reads data from the specified RTC Backup data Register.
Parameters
hrtc : RTC handle

BackupRegister : RTC Backup data Register number. This
DocID026525 Rev 1
437/692
33.2.30
UM1785
parameter can be: RTC_BKP_DRx where x can be from 0 to
4 to specify the register.
Return values
Read value
Notes
None.
HAL_RTCEx_SetSmoothCalib
Function Name
HAL_StatusTypeDef HAL_RTCEx_SetSmoothCalib (
RTC_HandleTypeDef * hrtc, uint32_t SmoothCalibPeriod,
uint32_t SmoothCalibPlusPulses, uint32_t
SmouthCalibMinusPulsesValue)
Sets the Smooth calibration parameters.
Parameters
33.2.31
438/692
hrtc : RTC handle

SmoothCalibPeriod : Select the Smooth Calibration Period.
This parameter can be can be one of the following values :
RTC_SMOOTHCALIB_PERIOD_32SEC The smooth

calibration periode is 32s.

calibration periode is 16s.

calibartion periode is 8s.
SmoothCalibPlusPulses : Select to Set or reset the CALP
bit. This parameter can be one of the following values:
RTC_SMOOTHCALIB_PLUSPULSES_SET Add one

RTCCLK puls every 2*11 pulses.
RTC_SMOOTHCALIB_PLUSPULSES_RESET No
RTCCLK pulses are added.
SmouthCalibMinusPulsesValue : Select the value of
CALM[8:0] bits. This parameter can be one any value from 0
to 0x000001FF.
Return values
HAL status
Notes
To deactivate the smooth calibration, the field

SmoothCalibPlusPulses must be equal to
SMOOTHCALIB_PLUSPULSES_RESET and the field
SmouthCalibMinusPulsesValue mut be equal to 0.
HAL_RTCEx_SetSynchroShift
DocID026525 Rev 1
UM1785
Function Name

HAL_StatusTypeDef HAL_RTCEx_SetSynchroShift (
RTC_HandleTypeDef * hrtc, uint32_t ShiftAdd1S, uint32_t
ShiftSubFS)
Configures the Synchronization Shift Control Settings.
Parameters
33.2.32
33.2.33
hrtc : RTC handle

ShiftAdd1S : Select to add or not 1 second to the time
calendar. This parameter can be one of the following values :
RTC_SHIFTADD1S_SET Add one second to the clock

calendar.
RTC_SHIFTADD1S_RESET No effect.
ShiftSubFS : Select the number of Second Fractions to
substitute. This parameter can be one any value from 0 to
0x7FFF.
Return values
HAL status
Notes
When REFCKON is set, firmware must not write to Shift

control register.
HAL_RTCEx_SetCalibrationOutPut
Function Name
HAL_StatusTypeDef HAL_RTCEx_SetCalibrationOutPut (
RTC_HandleTypeDef * hrtc, uint32_t CalibOutput)
Configures the Calibration Pinout (RTC_CALIB) Selection (1Hz or

512Hz).
Parameters
hrtc : RTC handle

CalibOutput : : Select the Calibration output Selection . This
RTC_CALIBOUTPUT_512HZ A signal has a regular

waveform at 512Hz.
RTC_CALIBOUTPUT_1HZ A signal has a regular

waveform at 1Hz.
Return values
HAL status
Notes
None.
HAL_RTCEx_DeactivateCalibrationOutPut
Function Name
HAL_StatusTypeDef
DocID026525 Rev 1
439/692
UM1785
HAL_RTCEx_DeactivateCalibrationOutPut (
33.2.34
33.2.35
33.2.36
440/692
Deactivates the Calibration Pinout (RTC_CALIB) Selection (1Hz

or 512Hz).
Parameters
hrtc : RTC handle
Return values
HAL status
Notes
None.
HAL_RTCEx_SetRefClock
Function Name
HAL_StatusTypeDef HAL_RTCEx_SetRefClock (
Enables the RTC reference clock detection.
Parameters
hrtc : RTC handle
Return values
HAL status
Notes
None.
HAL_RTCEx_DeactivateRefClock
Function Name
HAL_StatusTypeDef HAL_RTCEx_DeactivateRefClock (
Disable the RTC reference clock detection.
Parameters
hrtc : RTC handle
Return values
HAL status
Notes
None.
HAL_RTCEx_EnableBypassShadow
DocID026525 Rev 1
UM1785
33.2.37
Function Name

HAL_StatusTypeDef HAL_RTCEx_EnableBypassShadow (
Enables the Bypass Shadow feature.
Parameters
hrtc : RTC handle
Return values
HAL status
Notes
When the Bypass Shadow is enabled the calendar value are

taken directly from the Calendar counter.
HAL_RTCEx_DisableBypassShadow
Function Name
HAL_StatusTypeDef HAL_RTCEx_DisableBypassShadow (
Disables the Bypass Shadow feature.
Parameters
hrtc : RTC handle
Return values
HAL status
Notes
When the Bypass Shadow is enabled the calendar value are

taken directly from the Calendar counter.
33.3
RTCEx Firmware driver defines
33.3.1
RTCEx
RTCEx
RTCEx Add 1 Second Parameter Definition
RTC_SHIFTADD1S_RESET
RTC_SHIFTADD1S_SET
IS_RTC_SHIFT_ADD1S
RTCEx Backup Registers Definition
RTC_BKP_DR0
RTC_BKP_DR1
RTC_BKP_DR2
RTC_BKP_DR3
RTC_BKP_DR4
DocID026525 Rev 1
441/692

IS_RTC_BKP
UM1785
RTCEx Calib Output selection Definition

RTC_CALIBOUTPUT_512HZ
RTC_CALIBOUTPUT_1HZ
IS_RTC_CALIB_OUTPUT
RTCEx Exported Macros
__HAL_RTC_WAKEUPTIMER_ENABLE
Description:
Enable the RTC WakeUp Timer

peripheral.
Parameters:

RTC handle.
Return value:
__HAL_RTC_TIMESTAMP_ENABLE
None:
Description:
Enable the RTC TimeStamp

peripheral.
Parameters:

RTC handle.
Return value:
__HAL_RTC_WAKEUPTIMER_DISABLE
None:
Description:
Disable the RTC WakeUp Timer

peripheral.
Parameters:

RTC handle.
Return value:
__HAL_RTC_TIMESTAMP_DISABLE
None:
Description:
Disable the RTC TimeStamp

peripheral.
Parameters:

RTC handle.
Return value:
__HAL_RTC_CALIBRATION_OUTPUT_ENABLE
442/692
DocID026525 Rev 1
None:
Description:
UM1785
Enable the RTC calibration

output.
Parameters:

RTC handle.
Return value:
__HAL_RTC_CALIBRATION_OUTPUT_DISABLE
None:
Description:
Disable the calibration output.
Parameters:

RTC handle.
Return value:
__HAL_RTC_CLOCKREF_DETECTION_ENABLE
None:
Description:
Enable the clock reference

detection.
Parameters:

RTC handle.
Return value:
__HAL_RTC_CLOCKREF_DETECTION_DISABLE
None:
Description:
Disable the clock reference

detection.
Parameters:

RTC handle.
Return value:
__HAL_RTC_TIMESTAMP_ENABLE_IT
None:
Description:
Enable the RTC TimeStamp

interrupt.
Parameters:
DocID026525 Rev 1

RTC handle.
__INTERRUPT__: specifies the
RTC TimeStamp interrupt
sources to be enabled or
disabled. This parameter can
be:
443/692
UM1785
RTC_IT_TS: TimeStamp
interrupt
Return value:
__HAL_RTC_WAKEUPTIMER_ENABLE_IT
None:
Description:
Enable the RTC WakeUpTimer

interrupt.
Parameters:

RTC handle.
RTC WakeUpTimer interrupt
be:
RTC_IT_WUT:
WakeUpTimer A interrupt
Return value:
__HAL_RTC_TIMESTAMP_DISABLE_IT
None:
Description:
Disable the RTC TimeStamp

interrupt.
Parameters:

RTC handle.
RTC TimeStamp interrupt
be:
interrupt
Return value:
__HAL_RTC_WAKEUPTIMER_DISABLE_IT
None:
Description:
Disable the RTC WakeUpTimer

interrupt.
Parameters:
444/692
DocID026525 Rev 1

RTC handle.
be:
UM1785
RTC_IT_WUT:
Return value:
__HAL_RTC_TAMPER_GET_IT
None:
Description:
Check whether the specified

RTC Tamper interrupt has
occurred or not.
Parameters:

RTC handle.
__FLAG__: specifies the RTC
Tamper interrupt sources to be
enabled or disabled. This
parameter can be:
RTC_IT_TAMP1
Return value:
__HAL_RTC_WAKEUPTIMER_GET_IT
None:
Description:

has occurred or not.
Parameters:

RTC handle.
WakeUpTimer interrupt sources
to be enabled or disabled. This
parameter can be:
RTC_IT_WUT:
Return value:
__HAL_RTC_TIMESTAMP_GET_IT
None:
Description:

RTC TimeStamp interrupt has
occurred or not.
Parameters:
DocID026525 Rev 1

RTC handle.
TimeStamp interrupt sources to
be enabled or disabled. This
parameter can be:
445/692
UM1785
interrupt
Return value:
__HAL_RTC_TIMESTAMP_GET_FLAG
None:
Description:
Get the selected RTC

TimeStamp's flag status.
Parameters:

RTC handle.
TimeStamp Flag sources to be
parameter can be:
RTC_FLAG_TSF
RTC_FLAG_TSOVF
Return value:
__HAL_RTC_WAKEUPTIMER_GET_FLAG
None:
Description:
Get the selected RTC

WakeUpTimer's flag status.
Parameters:

RTC handle.
WakeUpTimer Flag sources to
be enabled or disabled. This
parameter can be:
RTC_FLAG_WUTF
RTC_FLAG_WUTWF
Return value:
__HAL_RTC_TAMPER_GET_FLAG
None:
Description:
Get the selected RTC Tamper's

flag status.
Parameters:

RTC handle.
Tamper Flag sources to be
parameter can be:
RTC_FLAG_TAMP1F
Return value:
446/692
DocID026525 Rev 1
None:
UM1785
__HAL_RTC_SHIFT_GET_FLAG

Description:
Get the selected RTC shift

operation's flag status.
Parameters:

RTC handle.
shift operation Flag is pending
or not. This parameter can be:
RTC_FLAG_SHPF
Return value:
__HAL_RTC_TIMESTAMP_CLEAR_FLAG
None:
Description:
Clear the RTC Time Stamp's

pending flags.
Parameters:

RTC handle.
Alarm Flag sources to be
parameter can be:
RTC_FLAG_TSF
Return value:
__HAL_RTC_TAMPER_CLEAR_FLAG
None:
Description:
Clear the RTC Tamper's

pending flags.
Parameters:

RTC handle.
parameter can be:
RTC_FLAG_TAMP1F
Return value:
__HAL_RTC_WAKEUPTIMER_CLEAR_FLAG
None:
Description:
Clear the RTC Wake Up timer's

pending flags.
Parameters:
DocID026525 Rev 1

RTC handle.
447/692
UM1785

parameter can be:
RTC_FLAG_WUTF
Return value:
None:
RTCEx Output Selection Definition

RTC_OUTPUT_DISABLE
RTC_OUTPUT_ALARMA
RTC_OUTPUT_WAKEUP
IS_RTC_OUTPUT
RTCEx Smooth calib Minus pulses Definition
IS_RTC_SMOOTH_CALIB_MINUS
RTCEx Smooth calib period Definition
RTC_SMOOTHCALIB_PERIOD_32SEC
If RTCCLK = 32768 Hz, Smooth calibation

period is 32s, else 2exp20 RTCCLK seconds


IS_RTC_SMOOTH_CALIB_PERIOD
RTCEx Smooth calib Plus pulses Definition
RTC_SMOOTHCALIB_PLUSPULSES_SET
The number of RTCCLK pulses added

during a X -second window = Y CALM[8:0] with Y = 512, 256, 128 when
X = 32, 16, 8
RTC_SMOOTHCALIB_PLUSPULSES_RESET
The number of RTCCLK pulses

subbstited during a 32-second window =
CALM[8:0]
IS_RTC_SMOOTH_CALIB_PLUS
RTCEx Substract Fraction Of Second Value
IS_RTC_SHIFT_SUBFS
RTCEx Tamper Filter Definition
448/692
RTC_TAMPERFILTER_DISABLE
Tamper filter is disabled
RTC_TAMPERFILTER_2SAMPLE
Tamper is activated after 2 consecutive samples at

the active level

the active level

the active level.
DocID026525 Rev 1
UM1785

IS_TAMPER_FILTER
RTCEx Tamper Pins Definition
RTC_TAMPER_1
RTC_TAMPER_2
RTC_TAMPER_3
IS_TAMPER
RTCEx Tamper Pin Precharge Duration Definition
RTC_TAMPERPRECHARGEDURATION_1RTCCLK
Tamper pins are pre-charged

before sampling during 1 RTCCLK
cycle

cycles

cycles

cycles
IS_TAMPER_PRECHARGE_DURATION
RTCEx Tamper Pull UP Definition
RTC_TAMPER_PULLUP_ENABLE
TimeStamp on Tamper Detection event saved
RTC_TAMPER_PULLUP_DISABLE
TimeStamp on Tamper Detection event is not saved
IS_TAMPER_PULLUP_STATE
RTCEx Tamper Sampling Frequencies Definition
RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV32768
Each of the tamper inputs are

sampled with a frequency =
RTCCLK / 32768

RTCCLK / 16384

RTCCLK / 8192

RTCCLK / 4096

RTCCLK / 2048

RTCCLK / 1024
DocID026525 Rev 1
449/692

UM1785
RTCCLK / 512
RTCCLK / 256
IS_TAMPER_SAMPLING_FREQ
RTCEx Tamper TimeStampOnTamperDetection Definition
RTC_TIMESTAMPONTAMPERDETECTION_ENABLE
TimeStamp on Tamper
Detection event saved
RTC_TIMESTAMPONTAMPERDETECTION_DISABLE
TimeStamp on Tamper
Detection event is not saved
IS_TAMPER_TIMESTAMPONTAMPER_DETECTION
RTCEx Tamper Trigger Definition
RTC_TAMPERTRIGGER_RISINGEDGE
RTC_TAMPERTRIGGER_FALLINGEDGE
RTC_TAMPERTRIGGER_LOWLEVEL
RTC_TAMPERTRIGGER_HIGHLEVEL
IS_TAMPER_TRIGGER
RTCEx TimeStamp Pin Selection
RTC_TIMESTAMPPIN_PC13
IS_RTC_TIMESTAMP_PIN
RTCEx Time Stamp Edges definition
RTC_TIMESTAMPEDGE_RISING
RTC_TIMESTAMPEDGE_FALLING
IS_TIMESTAMP_EDGE
RTCEx Wakeup Timer Definition
RTC_WAKEUPCLOCK_RTCCLK_DIV16
RTC_WAKEUPCLOCK_CK_SPRE_16BITS
RTC_WAKEUPCLOCK_CK_SPRE_17BITS
IS_WAKEUP_CLOCK
IS_WAKEUP_COUNTER
450/692
DocID026525 Rev 1
UM1785
HAL SMARTCARD Generic Driver
34
34.1
SMARTCARD Firmware driver registers structures
34.1.1
SMARTCARD_InitTypeDef
SMARTCARD_InitTypeDef is defined in the stm32f0xx_hal_smartcard.h
Data Fields
uint32_t BaudRate
uint32_t WordLength
uint32_t StopBits
uint16_t Parity
uint16_t Mode
uint16_t CLKPolarity
uint16_t CLKPhase
uint16_t CLKLastBit
uint16_t OneBitSampling
uint8_t Prescaler
uint8_t GuardTime
uint16_t NACKEnable
uint32_t TimeOutEnable
uint32_t TimeOutValue
uint8_t BlockLength
uint8_t AutoRetryCount
Field Documentation
uint32_t SMARTCARD_InitTypeDef::BaudRate Configures the SmartCard

formula: Baud Rate Register = ((PCLKx) / ((hsmartcard->Init.BaudRate)))
uint32_t SMARTCARD_InitTypeDef::WordLength Specifies the number of data bits
transmitted or received in a frame. This parameter SMARTCARD_Word_Length can
only be set to 9 (8 data + 1 parity bits).
uint32_t SMARTCARD_InitTypeDef::StopBits Specifies the number of stop bits
SMARTCARD_Stop_Bits. Only 1.5 stop bits are authorized in SmartCard mode.
uint16_t SMARTCARD_InitTypeDef::Parity Specifies the parity mode. This
parameter can be a value of SMARTCARD_Parity
Note:The parity is enabled by default (PCE is forced to 1). Since the WordLength is
forced to 8 bits + parity, M is forced to 1 and the parity bit is the 9th bit.
uint16_t SMARTCARD_InitTypeDef::Mode Specifies whether the Receive or
Transmit mode is enabled or disabled. This parameter can be a value of
SMARTCARD_Mode
uint16_t SMARTCARD_InitTypeDef::CLKPolarity Specifies the steady state of the
serial clock. This parameter can be a value of SMARTCARD_Clock_Polarity
uint16_t SMARTCARD_InitTypeDef::CLKPhase Specifies the clock transition on
which the bit capture is made. This parameter can be a value of
SMARTCARD_Clock_Phase
uint16_t SMARTCARD_InitTypeDef::CLKLastBit Specifies whether the clock pulse
corresponding to the last transmitted data bit (MSB) has to be output on the SCLK pin
in synchronous mode. This parameter can be a value of SMARTCARD_Last_Bit
DocID026525 Rev 1
451/692
34.1.2
UM1785
uint16_t SMARTCARD_InitTypeDef::OneBitSampling Specifies whether a single

sample or three samples' majority vote is selected. Selecting the single sample
method increases the receiver tolerance to clock deviations. This parameter can be a
value of SMARTCARD_OneBit_Sampling.
uint8_t SMARTCARD_InitTypeDef::Prescaler Specifies the SmartCard Prescaler
uint8_t SMARTCARD_InitTypeDef::GuardTime Specifies the SmartCard Guard
Time
uint16_t SMARTCARD_InitTypeDef::NACKEnable Specifies whether the
SmartCard NACK transmission is enabled in case of parity error. This parameter can
be a value of SMARTCARD_NACK_State
uint32_t SMARTCARD_InitTypeDef::TimeOutEnable Specifies whether the receiver
timeout is enabled. This parameter can be a value of
SMARTCARD_Timeout_Enable
uint32_t SMARTCARD_InitTypeDef::TimeOutValue Specifies the receiver time out
value in number of baud blocks: it is used to implement the Character Wait Time
(CWT) and Block Wait Time (BWT). It is coded over 24 bits.
uint8_t SMARTCARD_InitTypeDef::BlockLength Specifies the SmartCard Block
Length in T=1 Reception mode. This parameter can be any value from 0x0 to 0xFF
uint8_t SMARTCARD_InitTypeDef::AutoRetryCount Specifies the SmartCard autoretry count (number of retries in receive and transmit mode). When set to 0,
retransmission is disabled. Otherwise, its maximum value is 7 (before signalling an
error)
SMARTCARD_AdvFeatureInitTypeDef
SMARTCARD_AdvFeatureInitTypeDef is defined in the stm32f0xx_hal_smartcard.h
Data Fields
uint32_t AdvFeatureInit
uint32_t TxPinLevelInvert
uint32_t RxPinLevelInvert
uint32_t DataInvert
uint32_t Swap
uint32_t OverrunDisable
uint32_t DMADisableonRxError
uint32_t MSBFirst
Field Documentation
452/692
uint32_t SMARTCARD_AdvFeatureInitTypeDef::AdvFeatureInit Specifies which

advanced SMARTCARD features is initialized. Several advanced features may be
initialized at the same time. This parameter can be a value of
SMARTCARD_Advanced_Features_Initialization_Type
uint32_t SMARTCARD_AdvFeatureInitTypeDef::TxPinLevelInvert Specifies
whether the TX pin active level is inverted. This parameter can be a value of
SMARTCARD_Tx_Inv
uint32_t SMARTCARD_AdvFeatureInitTypeDef::RxPinLevelInvert Specifies
whether the RX pin active level is inverted. This parameter can be a value of
SMARTCARD_Rx_Inv
uint32_t SMARTCARD_AdvFeatureInitTypeDef::DataInvert Specifies whether data
are inverted (positive/direct logic vs negative/inverted logic). This parameter can be a
value of SMARTCARD_Data_Inv
DocID026525 Rev 1
UM1785
34.1.3
uint32_t SMARTCARD_AdvFeatureInitTypeDef::Swap Specifies whether TX and

RX pins are swapped. This parameter can be a value of SMARTCARD_Rx_Tx_Swap
uint32_t SMARTCARD_AdvFeatureInitTypeDef::OverrunDisable Specifies
whether the reception overrun detection is disabled. This parameter can be a value of
SMARTCARD_Overrun_Disable
uint32_t SMARTCARD_AdvFeatureInitTypeDef::DMADisableonRxError Specifies
whether the DMA is disabled in case of reception error. This parameter can be a value
of SMARTCARD_DMA_Disable_on_Rx_Error
uint32_t SMARTCARD_AdvFeatureInitTypeDef::MSBFirst Specifies whether MSB
is sent first on UART line. This parameter can be a value of
SMARTCARD_MSB_First
SMARTCARD_HandleTypeDef
SMARTCARD_HandleTypeDef is defined in the stm32f0xx_hal_smartcard.h
Data Fields
SMARTCARD_InitTypeDef Init
SMARTCARD_AdvFeatureInitTypeDef AdvancedInit
uint16_t TxXferSize
uint16_t RxXferSize
HAL_SMARTCARD_StateTypeDef State
HAL_SMARTCARD_ErrorTypeDef ErrorCode
Field Documentation
USART_TypeDef* SMARTCARD_HandleTypeDef::Instance
SMARTCARD_InitTypeDef SMARTCARD_HandleTypeDef::Init
SMARTCARD_AdvFeatureInitTypeDef
SMARTCARD_HandleTypeDef::AdvancedInit
uint8_t* SMARTCARD_HandleTypeDef::pTxBuffPtr
uint16_t SMARTCARD_HandleTypeDef::TxXferSize
uint16_t SMARTCARD_HandleTypeDef::TxXferCount
uint8_t* SMARTCARD_HandleTypeDef::pRxBuffPtr
uint16_t SMARTCARD_HandleTypeDef::RxXferSize
uint16_t SMARTCARD_HandleTypeDef::RxXferCount
DMA_HandleTypeDef* SMARTCARD_HandleTypeDef::hdmatx
DMA_HandleTypeDef* SMARTCARD_HandleTypeDef::hdmarx
HAL_LockTypeDef SMARTCARD_HandleTypeDef::Lock
HAL_SMARTCARD_StateTypeDef SMARTCARD_HandleTypeDef::State
HAL_SMARTCARD_ErrorTypeDef SMARTCARD_HandleTypeDef::ErrorCode
DocID026525 Rev 1
453/692
34.2
UM1785
SMARTCARD Firmware driver API description

The following section lists the various functions of the SMARTCARD library.
34.2.1

The SMARTCARD HAL driver can be used as follows:
1.
2.
3.
4.
5.
6.
Declare a SMARTCARD_HandleTypeDef handle structure.

Initialize the SMARTCARD low level resources by implementing the
HAL_SMARTCARD_MspInit ()API:
SMARTCARD pins configuration:
Enable the clock for the SMARTCARD GPIOs.
Configure these SMARTCARD pins as alternate function pull-up.

(HAL_SMARTCARD_Transmit_IT() and HAL_SMARTCARD_Receive_IT() APIs):

(HAL_SMARTCARD_Transmit_DMA() and HAL_SMARTCARD_Receive_DMA()
APIs):
parameters.
Associate the initialized DMA handle to the SMARTCARD DMA Tx/Rx

handle.
Program the Baud Rate, Parity, Mode(Receiver/Transmitter), clock enabling/disabling
and accordingly, the clock parameters (parity, phase, last bit), prescaler value, guard
time and NACK on transmission error enabling or disabling in the hsmartcard Init
structure.
If required, program SMARTCARD advanced features (TX/RX pins swap, TimeOut,
auto-retry counter,...) in the hsmartcard AdvancedInit structure.
Initialize the SMARTCARD associated USART registers by calling the
HAL_SMARTCARD_Init() API:
This API configures also the low level Hardware GPIO, CLOCK, CORTEX...etc)
by calling the customed HAL_SMARTCARD_MspInit() API. The specific
SMARTCARD interrupts (Transmission complete interrupt, RXNE interrupt and
Error Interrupts) will be managed using the macros
__HAL_SMARTCARD_ENABLE_IT() and __HAL_SMARTCARD_DISABLE_IT()
inside the transmit and receive process.
454/692
Send an amount of data in blocking mode using HAL_SMARTCARD_Transmit()

Receive an amount of data in blocking mode using HAL_SMARTCARD_Receive()
DocID026525 Rev 1
UM1785
Send an amount of data in non blocking mode using

HAL_SMARTCARD_Transmit_IT()
At transmission end of transfer HAL_SMARTCARD_TxCpltCallback is executed and
HAL_SMARTCARD_TxCpltCallback
Receive an amount of data in non blocking mode using
HAL_SMARTCARD_Receive_IT()
At reception end of transfer HAL_SMARTCARD_RxCpltCallback is executed and
HAL_SMARTCARD_RxCpltCallback
In case of transfer Error, HAL_SMARTCARD_ErrorCallback() function is executed
and user can add his own code by customization of function pointer
HAL_SMARTCARD_ErrorCallback

HAL_SMARTCARD_Transmit_DMA()
At transmission end of transfer HAL_SMARTCARD_TxCpltCallback is executed and
HAL_SMARTCARD_Receive_DMA()
At reception end of transfer HAL_SMARTCARD_RxCpltCallback is executed and
In case of transfer Error, HAL_SMARTCARD_ErrorCallback() function is executed
and user can add his own code by customization of function pointer
SMARTCARD HAL driver macros list

Below the list of most used macros in SMARTCARD HAL driver.
__HAL_SMARTCARD_ENABLE: Enable the SMARTCARD peripheral

__HAL_SMARTCARD_DISABLE: Disable the SMARTCARD peripheral
__HAL_SMARTCARD_GET_FLAG : Check whether the specified SMARTCARD flag
is set or not
__HAL_SMARTCARD_CLEAR_FLAG : Clear the specified SMARTCARD pending
flag
__HAL_SMARTCARD_ENABLE_IT: Enable the specified SMARTCARD interrupt
__HAL_SMARTCARD_DISABLE_IT: Disable the specified SMARTCARD interrupt
You can refer to the SMARTCARD HAL driver header file for more useful macros
34.2.2
DocID026525 Rev 1
455/692

UM1785
This subsection provides a set of functions allowing to initialize the USART in Smartcard
mode.
The Smartcard interface is designed to support asynchronous protocol Smartcards as
defined in the ISO 7816-3 standard.
The USART can provide a clock to the smartcard through the SCLK output. In smartcard
mode, SCLK is not associated to the communication but is simply derived from the internal
peripheral input clock through a 5-bit prescaler.
For the Smartcard mode only these parameters can be configured:
Baud Rate
Parity: parity should be enabled, Frame Length is fixed to 8 bits plus parity: the
USART frame format is given in the tables below.
Synchronous mode (and if enabled, phase, polarity and last bit parameters)
Prescaler value
Guard bit time
NACK enabling or disabling on transmission error

The following advanced features can be configured as well:
TX and/or RX pin level inversion
data logical level inversion
RX and TX pins swap
RX overrun detection disabling
DMA disabling on RX error
MSB first on communication line
Time out enabling (and if activated, timeout value)
Block length
Auto-retry counter
Table 21: USART frame formats
M bit
PCE bit
USART frame
| SB | 8 bit data | PB | STB |
or
M1, M0 bits
PCE bit
USART frame
01
The HAL_SMARTCARD_Init() API follow respectively the USART (a)synchronous

configuration procedures (details for the procedures are available in reference manual).
34.2.3
HAL_SMARTCARD_Init()
HAL_SMARTCARD_DeInit()
HAL_SMARTCARD_MspInit()
HAL_SMARTCARD_MspDeInit()
This subsection provides a set of functions allowing to manage the SMARTCARD data
transfers.
456/692
DocID026525 Rev 1
UM1785

Smartcard is a single wire half duplex communication protocol. The Smartcard interface is
designed to support asynchronous protocol Smartcards as defined in the ISO 7816-3
standard. The USART should be configured as: - 8 bits plus parity: where M=1 and PCE=1
in the USART_CR1 register - 1.5 stop bits when transmitting and receiving: where
STOP=11 in the USART_CR2 register.
1.
2.
3.
4.
5.
34.2.4

transfer.
No-Blocking mode: The communication is performed using Interrupts or DMA,

These API s return the HAL status. The end of the data processing will be
indicated through the dedicated SMARTCARD IRQ when using Interrupt mode or
the DMA IRQ when using DMA mode. The
HAL_SMARTCARD_TxCpltCallback(), HAL_SMARTCARD_RxCpltCallback()
user callbacks will be executed respectivelly at the end of the transmit or Receive
process The HAL_SMARTCARD_ErrorCallback()user callback will be executed
when a communication error is detected
Blocking mode API s are :
HAL_SMARTCARD_Transmit()
HAL_SMARTCARD_Receive()
Non Blocking mode API s with Interrupt are :
HAL_SMARTCARD_IRQHandler()
HAL_SMARTCARD_TxCpltCallback()
HAL_SMARTCARD_RxCpltCallback()
HAL_SMARTCARD_ErrorCallback()
HAL_SMARTCARD_Transmit()
HAL_SMARTCARD_Receive()
HAL_SMARTCARD_IRQHandler()
HAL_SMARTCARD_TxCpltCallback()
HAL_SMARTCARD_RxCpltCallback()
HAL_SMARTCARD_ErrorCallback()

This subsection provides a set of functions allowing to return the State of SmartCard
communication process and also return Peripheral Errors occurred during communication
process
HAL_SMARTCARD_GetState() API can be helpful to check in run-time the state of

the SMARTCARD peripheral
HAL_SMARTCARD_GetError() check in run-time errors that could be occurred during
communication.
SMARTCARD_SetConfig() API configures the SMARTCARD peripheral
DocID026525 Rev 1
457/692
34.2.5
34.2.6
34.2.7
458/692
UM1785
SMARTCARD_AdvFeatureConfig() API optionally configures the SMARTCARD

advanced features
SMARTCARD_CheckIdleState() API ensures that TEACK and/or REACK are set
after initialization
HAL_SMARTCARD_GetState()
HAL_SMARTCARD_GetError()
HAL_SMARTCARD_Init
Function Name
HAL_StatusTypeDef HAL_SMARTCARD_Init (
SMARTCARD_HandleTypeDef * hsmartcard)
Initializes the SMARTCARD mode according to the specified

parameters in the SMARTCARD_InitTypeDef and creates the
associated handle .
Parameters
hsmartcard : SMARTCARD handle
Return values
HAL status
Notes
None.
HAL_SMARTCARD_DeInit
Function Name
HAL_StatusTypeDef HAL_SMARTCARD_DeInit (
DeInitializes the SMARTCARD peripheral.
Parameters
Return values
HAL status
Notes
None.
HAL_SMARTCARD_MspInit
Function Name
void HAL_SMARTCARD_MspInit (
SMARTCARD MSP Init.
DocID026525 Rev 1
UM1785
34.2.8
34.2.9
34.2.10

Parameters
Return values
None.
Notes
None.
HAL_SMARTCARD_MspDeInit
Function Name
void HAL_SMARTCARD_MspDeInit (
SMARTCARD MSP DeInit.
Parameters
Return values
None.
Notes
None.
HAL_SMARTCARD_Transmit
Function Name
HAL_StatusTypeDef HAL_SMARTCARD_Transmit (
SMARTCARD_HandleTypeDef * hsmartcard, uint8_t * pData,
uint16_t Size, uint32_t Timeout)
Parameters

Timeout : : Timeout duration
Return values
HAL status
Notes
None.
HAL_SMARTCARD_Receive
DocID026525 Rev 1
459/692

Function Name
34.2.11
34.2.12
460/692
UM1785
HAL_StatusTypeDef HAL_SMARTCARD_Receive (
uint16_t Size, uint32_t Timeout)
Parameters

Return values
HAL status
Notes
None.
HAL_SMARTCARD_Transmit_IT
Function Name
HAL_StatusTypeDef HAL_SMARTCARD_Transmit_IT (
uint16_t Size)
Parameters

Return values
HAL status
Notes
None.
HAL_SMARTCARD_Receive_IT
Function Name
HAL_StatusTypeDef HAL_SMARTCARD_Receive_IT (
uint16_t Size)
Parameters

Return values
HAL status
DocID026525 Rev 1
UM1785

Notes
34.2.13
34.2.14
34.2.15
None.
HAL_SMARTCARD_Transmit_DMA
Function Name
HAL_StatusTypeDef HAL_SMARTCARD_Transmit_DMA (
uint16_t Size)
Parameters

Return values
HAL status
Notes
None.
HAL_SMARTCARD_Receive_DMA
Function Name
HAL_StatusTypeDef HAL_SMARTCARD_Receive_DMA (
uint16_t Size)
Parameters

Return values
HAL status
Notes
The SMARTCARD-associated USART parity is enabled (PCE

= 1), the received data contain the parity bit (MSB position)
HAL_SMARTCARD_IRQHandler
DocID026525 Rev 1
461/692

Function Name
34.2.16
34.2.17
34.2.18
462/692
UM1785
void HAL_SMARTCARD_IRQHandler (
SMARTCARD interrupt requests handling.
Parameters
Return values
None.
Notes
None.
Function Name
void HAL_SMARTCARD_TxCpltCallback (
Parameters
Return values
None.
Notes
None.
Function Name
void HAL_SMARTCARD_RxCpltCallback (
Parameters
Return values
None.
Notes
None.
DocID026525 Rev 1
UM1785
34.2.19
34.2.20
Function Name

void HAL_SMARTCARD_ErrorCallback (
SMARTCARD error callbacks.
Parameters
Return values
None.
Notes
None.
HAL_SMARTCARD_GetState
Function Name
HAL_SMARTCARD_StateTypeDef
HAL_SMARTCARD_GetState ( SMARTCARD_HandleTypeDef *
hsmartcard)
return the SMARTCARD state
Parameters
Return values
HAL state
Notes
None.
HAL_SMARTCARD_GetError
Function Name
uint32_t HAL_SMARTCARD_GetError (
Return the SMARTCARD error code.
Parameters
hsmartcard : : pointer to a SMARTCARD_HandleTypeDef

specified SMARTCARD.
Return values
SMARTCARD Error Code
Notes
None.
DocID026525 Rev 1
463/692
UM1785
34.3
SMARTCARD Firmware driver defines
34.3.1
SMARTCARD
SMARTCARD
SMARTCARD advanced feature initialization type
SMARTCARD_ADVFEATURE_NO_INIT
SMARTCARD_ADVFEATURE_TXINVERT_INIT
SMARTCARD_ADVFEATURE_RXINVERT_INIT
SMARTCARD_ADVFEATURE_DATAINVERT_INIT
SMARTCARD_ADVFEATURE_SWAP_INIT
SMARTCARD_ADVFEATURE_RXOVERRUNDISABLE_INIT
SMARTCARD_ADVFEATURE_DMADISABLEONERROR_INIT
SMARTCARD_ADVFEATURE_MSBFIRST_INIT
IS_SMARTCARD_ADVFEATURE_INIT
SMARTCARD Clock Phase
SMARTCARD_PHASE_1EDGE
SMARTCARD_PHASE_2EDGE
IS_SMARTCARD_PHASE
SMARTCARD Clock Polarity
SMARTCARD_POLARITY_LOW
SMARTCARD_POLARITY_HIGH
IS_SMARTCARD_POLARITY
SMARTCARD auto retry counter LSB position in CR3 register
SMARTCARD_CR3_SCARCNT_LSB_POS
SMARTCARD advanced feature Binary Data inversion
SMARTCARD_ADVFEATURE_DATAINV_DISABLE
SMARTCARD_ADVFEATURE_DATAINV_ENABLE
IS_SMARTCARD_ADVFEATURE_DATAINV
SMARTCARD advanced feature DMA Disable on Rx Error
SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR
SMARTCARD_ADVFEATURE_DMA_DISABLEONRXERROR
IS_SMARTCARD_ADVFEATURE_DMAONRXERROR
SMARTCARD Exported Macros
__HAL_SMARTCARD_RESET_HANDL
E_STATE
Description:
Reset SMARTCARD handle state.
Parameters:
464/692
__HANDLE__: SMARTCARD handle.
DocID026525 Rev 1
UM1785

Return value:
__HAL_SMARTCARD_GET_FLAG
None:
Description:
Checks whether the specified Smartcard

flag is set or not.
Parameters:
__HANDLE__: specifies the SMARTCARD

Handle. The Handle Instance can be
USARTx where x: 1, 2 or 3 to select the
USART peripheral.
values:
SMARTCARD_FLAG_REACK:
Receive enable ackowledge flag
SMARTCARD_FLAG_TEACK:
Transmit enable ackowledge flag
SMARTCARD_FLAG_BUSY: Busy
flag
SMARTCARD_FLAG_EOBF: End of
block flag
SMARTCARD_FLAG_RTOF:
Receiver timeout flag
SMARTCARD_FLAG_TXE: Transmit
data register empty flag
SMARTCARD_FLAG_TC:
Transmission Complete flag
SMARTCARD_FLAG_RXNE: Receive
data register not empty flag
SMARTCARD_FLAG_ORE: OverRun
Error flag
SMARTCARD_FLAG_NE: Noise Error

flag
SMARTCARD_FLAG_FE: Framing
Error flag
SMARTCARD_FLAG_PE: Parity Error

flag
Return value:
__HAL_SMARTCARD_ENABLE_IT

FALSE).
Description:
Enables the specified SmartCard interrupt.
Parameters:

USART peripheral.
SMARTCARD interrupt to enable. This
DocID026525 Rev 1
465/692
UM1785
values:
SMARTCARD_IT_EOBF: End Of
Block interrupt
SMARTCARD_IT_RTOF: Receive
TimeOut interrupt
SMARTCARD_IT_TXE: Transmit Data

Register empty interrupt
SMARTCARD_IT_TC: Transmission
complete interrupt
SMARTCARD_IT_RXNE: Receive
Data register not empty interrupt
SMARTCARD_IT_PE: Parity Error

interrupt
SMARTCARD_IT_ERR: Error
interrupt(Frame error, noise error,
overrun error)
Return value:
__HAL_SMARTCARD_DISABLE_IT
None:
Description:
Disables the specified SmartCard interrupt.
Parameters:

USART peripheral.
SMARTCARD interrupt to disable. This
values:
Block interrupt
TimeOut interrupt

complete interrupt

interrupt
SMARTCARD_IT_ERR: Error
interrupt(Frame error, noise error,
overrun error)
Return value:
__HAL_SMARTCARD_GET_IT
Description:
466/692
None:
Checks whether the specified SmartCard
DocID026525 Rev 1
UM1785

Parameters:

USART peripheral.
__IT__: specifies the SMARTCARD
interrupt to check. This parameter can be
Block interrupt
TimeOut interrupt

complete interrupt
SMARTCARD_IT_ORE: OverRun
Error interrupt
SMARTCARD_IT_NE: Noise Error

interrupt
SMARTCARD_IT_FE: Framing Error

interrupt

interrupt
Return value:
__HAL_SMARTCARD_GET_IT_SOUR
CE

FALSE).
Description:
Checks whether the specified SmartCard

interrupt interrupt source is enabled.
Parameters:

USART peripheral.
__IT__: specifies the SMARTCARD
Block interrupt
TimeOut interrupt

complete interrupt
DocID026525 Rev 1
467/692
UM1785
SMARTCARD_IT_ORE: OverRun
Error interrupt
SMARTCARD_IT_NE: Noise Error
interrupt
SMARTCARD_IT_FE: Framing Error
interrupt
interrupt
Return value:
__HAL_SMARTCARD_CLEAR_IT

FALSE).
Description:
Clears the specified SMARTCARD ISR

flag, in setting the proper ICR register flag.
Parameters:

USART peripheral.
__IT_CLEAR__: specifies the interrupt
clear register flag that needs to be set to
clear the corresponding interrupt This
values:
USART_CLEAR_PEF: Parity Error

Clear Flag
USART_CLEAR_FEF: Framing Error

Clear Flag
USART_CLEAR_NEF: Noise detected

Clear Flag
USART_CLEAR_OREF: OverRun
Error Clear Flag
USART_CLEAR_TCF: Transmission
Complete Clear Flag
USART_CLEAR_RTOF: Receiver
Time Out Clear Flag
USART_CLEAR_EOBF: End Of Block

Clear Flag
Return value:
__HAL_SMARTCARD_SEND_REQ
None:
Description:
Set a specific SMARTCARD request flag.
Parameters:
468/692

USART peripheral.
DocID026525 Rev 1
UM1785

values:
SMARTCARD_RXDATA_FLUSH_RE
QUEST: Receive Data flush Request
SMARTCARD_TXDATA_FLUSH_RE
QUEST: Transmit data flush Request
Return value:
__HAL_SMARTCARD_ENABLE
None:
Description:
Enable the USART associated to the

SMARTCARD Handle.
Parameters:

UARTx where x: 1, 2, 3 to select the
USART peripheral
Return value:
__HAL_SMARTCARD_DISABLE
None:
Description:
Disable the USART associated to the

SMARTCARD Handle.
Parameters:

UARTx where x: 1, 2, 3 to select the
USART peripheral
Return value:
IS_SMARTCARD_BAUDRATE
None:
Description:
Check the Baud rate range.
Parameters:
__BAUDRATE__: Baud rate set by the

configuration function.
Return value:
IS_SMARTCARD_BLOCKLENGTH
Test: result (TRUE or FALSE)
Description:
Check the block length range.
Parameters:
__LENGTH__: block length.
Return value:
DocID026525 Rev 1
469/692
UM1785
IS_SMARTCARD_TIMEOUT_VALUE
Description:
Check the receiver timeout value.
Parameters:
__TIMEOUTVALUE__: receiver timeout

value.
Return value:
IS_SMARTCARD_AUTORETRY_COU
NT
Description:
Check the SMARTCARD autoretry counter

value.
Parameters:
__COUNT__: number of retransmissions
Return value:
SMARTCARDEx Exported Macros

__HAL_SMARTCARD_GETCLOCKSOURCE
Description:
Reports the SMARTCARD clock

source.
Parameters:

SMARTCARD Handle
__CLOCKSOURCE__: : output
variable
Return value:
SMARTCARD Flags
SMARTCARD_FLAG_REACK
SMARTCARD_FLAG_TEACK
SMARTCARD_FLAG_BUSY
SMARTCARD_FLAG_EOBF
SMARTCARD_FLAG_RTOF
SMARTCARD_FLAG_TXE
SMARTCARD_FLAG_TC
SMARTCARD_FLAG_RXNE
SMARTCARD_FLAG_ORE
SMARTCARD_FLAG_NE
470/692
DocID026525 Rev 1
the: SMARTCARD clocking source,

written in __CLOCKSOURCE__.
UM1785

SMARTCARD_FLAG_FE
SMARTCARD_FLAG_PE
SMARTCARD guard time value LSB position in GTPR register
SMARTCARD_GTPR_GT_LSB_POS
SMARTCARD interruptions flag mask
SMARTCARD_IT_MASK
SMARTCARD Interrupts Definition
SMARTCARD_IT_PE
SMARTCARD_IT_TXE
SMARTCARD_IT_TC
SMARTCARD_IT_RXNE
SMARTCARD_IT_ERR
SMARTCARD_IT_ORE
SMARTCARD_IT_NE
SMARTCARD_IT_FE
SMARTCARD_IT_EOB
SMARTCARD_IT_RTO
SMARTCARD Interruption Clear Flags
SMARTCARD_CLEAR_PEF
SMARTCARD_CLEAR_FEF
SMARTCARD_CLEAR_NEF
SMARTCARD_CLEAR_OREF
SMARTCARD_CLEAR_TCF
SMARTCARD_CLEAR_RTOF
Receiver Time Out Clear Flag
SMARTCARD_CLEAR_EOBF
End Of Block Clear Flag
SMARTCARD Last Bit

SMARTCARD_LASTBIT_DISABLED
SMARTCARD_LASTBIT_ENABLED
IS_SMARTCARD_LASTBIT
SMARTCARD Transfer Mode
SMARTCARD_MODE_RX
SMARTCARD_MODE_TX
SMARTCARD_MODE_TX_RX
IS_SMARTCARD_MODE
SMARTCARD advanced feature MSB first
SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE
DocID026525 Rev 1
471/692

SMARTCARD_ADVFEATURE_MSBFIRST_ENABLE
IS_SMARTCARD_ADVFEATURE_MSBFIRST
SMARTCARD NACK State
SMARTCARD_NACK_ENABLED
SMARTCARD_NACK_DISABLED
IS_SMARTCARD_NACK
SMARTCARD One Bit Sampling Method
SMARTCARD_ONEBIT_SAMPLING_DISABLED
SMARTCARD_ONEBIT_SAMPLING_ENABLED
IS_SMARTCARD_ONEBIT_SAMPLING
SMARTCARD advanced feature Overrun Disable
SMARTCARD_ADVFEATURE_OVERRUN_ENABLE
SMARTCARD_ADVFEATURE_OVERRUN_DISABLE
IS_SMARTCARD_OVERRUN
SMARTCARD Parity
SMARTCARD_PARITY_EVEN
SMARTCARD_PARITY_ODD
IS_SMARTCARD_PARITY
SMARTCARD Private Constants
TEACK_REACK_TIMEOUT
SMARTCARD_TXDMA_TIMEOUTVALUE
SMARTCARD_TIMEOUT_VALUE
USART_CR1_FIELDS
USART_CR2_CLK_FIELDS
USART_CR2_FIELDS
USART_CR3_FIELDS
SMARTCARD Request Parameters
SMARTCARD_RXDATA_FLUSH_REQUEST
SMARTCARD_TXDATA_FLUSH_REQUEST
IS_SMARTCARD_REQUEST_PARAMETER
SMARTCARD block length LSB position in RTOR register
SMARTCARD_RTOR_BLEN_LSB_POS
SMARTCARD advanced feature RX pin active level inversion
SMARTCARD_ADVFEATURE_RXINV_DISABLE
SMARTCARD_ADVFEATURE_RXINV_ENABLE
IS_SMARTCARD_ADVFEATURE_RXINV
SMARTCARD advanced feature RX TX pins swap
472/692
DocID026525 Rev 1
UM1785
UM1785

SMARTCARD_ADVFEATURE_SWAP_DISABLE
SMARTCARD_ADVFEATURE_SWAP_ENABLE
IS_SMARTCARD_ADVFEATURE_SWAP
SMARTCARD Stop Bits
SMARTCARD_STOPBITS_1_5
IS_SMARTCARD_STOPBITS
SMARTCARD Timeout Enable
SMARTCARD_TIMEOUT_DISABLED
SMARTCARD_TIMEOUT_ENABLED
IS_SMARTCARD_TIMEOUT
SMARTCARD advanced feature TX pin active level inversion
SMARTCARD_ADVFEATURE_TXINV_DISABLE
SMARTCARD_ADVFEATURE_TXINV_ENABLE
IS_SMARTCARD_ADVFEATURE_TXINV
SMARTCARD Word Length
SMARTCARD_WORDLENGTH_9B
IS_SMARTCARD_WORD_LENGTH
DocID026525 Rev 1
473/692
HAL SMARTCARD Extension Driver
UM1785
35
35.1
SMARTCARDEx Firmware driver API description

The following section lists the various functions of the SMARTCARDEx library.
35.1.1

This subsection provides a set of functions allowing to initialize the SMARTCARD.
35.1.2
35.1.3
HAL_SMARTCARDEx_BlockLength_Config() API allows to configure the Block

Length on the fly
HAL_SMARTCARDEx_TimeOut_Config() API allows to configure the receiver
timeout value on the fly
HAL_SMARTCARDEx_EnableReceiverTimeOut() API enables the receiver timeout
feature
HAL_SMARTCARDEx_DisableReceiverTimeOut() API disables the receiver timeout
feature
HAL_SMARTCARDEx_BlockLength_Config()
HAL_SMARTCARDEx_TimeOut_Config()
HAL_SMARTCARDEx_EnableReceiverTimeOut()
HAL_SMARTCARDEx_DisableReceiverTimeOut()
HAL_SMARTCARDEx_BlockLength_Config
Function Name
void HAL_SMARTCARDEx_BlockLength_Config (
SMARTCARD_HandleTypeDef * hsmartcard, uint8_t
BlockLength)
Update on the fly the SMARTCARD block length in RTOR

register.
Parameters

BlockLength : SMARTCARD block length (8-bit long at
most)
Return values
None.
Notes
None.
HAL_SMARTCARDEx_TimeOut_Config
Function Name
474/692
void HAL_SMARTCARDEx_TimeOut_Config (
SMARTCARD_HandleTypeDef * hsmartcard, uint32_t
DocID026525 Rev 1
UM1785

TimeOutValue)
35.1.4
35.1.5
Update on the fly the receiver timeout value in RTOR register.
Parameters

TimeOutValue : receiver timeout value in number of baud
blocks. The timeout value must be less or equal to
0x0FFFFFFFF.
Return values
None.
Notes
None.
HAL_SMARTCARDEx_EnableReceiverTimeOut
Function Name
HAL_StatusTypeDef
HAL_SMARTCARDEx_EnableReceiverTimeOut (
Enable the SMARTCARD receiver timeout feature.
Parameters
Return values
HAL status
Notes
None.
HAL_SMARTCARDEx_DisableReceiverTimeOut
Function Name
HAL_StatusTypeDef
HAL_SMARTCARDEx_DisableReceiverTimeOut (
Disable the SMARTCARD receiver timeout feature.
Parameters
Return values
HAL status
Notes
None.
DocID026525 Rev 1
475/692
UM1785
35.2
SMARTCARDEx Firmware driver defines
35.2.1
SMARTCARDEx
SMARTCARDEx
476/692
DocID026525 Rev 1
UM1785
HAL SMBUS Generic Driver
36
36.1
SMBUS Firmware driver registers structures
36.1.1
SMBUS_InitTypeDef
SMBUS_InitTypeDef is defined in the stm32f0xx_hal_smbus.h
Data Fields
uint32_t Timing
uint32_t AnalogFilter
uint32_t AddressingMode
uint32_t DualAddressMode
uint32_t OwnAddress2Masks
uint32_t GeneralCallMode
uint32_t NoStretchMode
uint32_t PacketErrorCheckMode
uint32_t PeripheralMode
uint32_t SMBusTimeout
Field Documentation
uint32_t SMBUS_InitTypeDef::Timing Specifies the SMBUS_TIMINGR_register

value. This parameter calculated by referring to SMBUS initialization section in
Reference manual
uint32_t SMBUS_InitTypeDef::AnalogFilter Specifies if Analog Filter is enable or
not. This parameter can be a a value of SMBUS_Analog_Filter
uint32_t SMBUS_InitTypeDef::OwnAddress1 Specifies the first device own
address. This parameter can be a 7-bit or 10-bit address.
uint32_t SMBUS_InitTypeDef::AddressingMode Specifies if 7-bit or 10-bit
addressing mode for master is selected. This parameter can be a value of
SMBUS_addressing_mode
uint32_t SMBUS_InitTypeDef::DualAddressMode Specifies if dual addressing
mode is selected. This parameter can be a value of
SMBUS_dual_addressing_mode
uint32_t SMBUS_InitTypeDef::OwnAddress2 Specifies the second device own
address if dual addressing mode is selected This parameter can be a 7-bit address.
uint32_t SMBUS_InitTypeDef::OwnAddress2Masks Specifies the acknoledge mask
address second device own address if dual addressing mode is selected This
parameter can be a value of SMBUS_own_address2_masks.
uint32_t SMBUS_InitTypeDef::GeneralCallMode Specifies if general call mode is
selected. This parameter can be a value of
SMBUS_general_call_addressing_mode.
uint32_t SMBUS_InitTypeDef::NoStretchMode Specifies if nostretch mode is
selected. This parameter can be a value of SMBUS_nostretch_mode
uint32_t SMBUS_InitTypeDef::PacketErrorCheckMode Specifies if Packet Error
Check mode is selected. This parameter can be a value of
SMBUS_packet_error_check_mode
DocID026525 Rev 1
477/692
36.1.2
UM1785
uint32_t SMBUS_InitTypeDef::PeripheralMode Specifies which mode of Periphal is

selected. This parameter can be a value of SMBUS_peripheral_mode
uint32_t SMBUS_InitTypeDef::SMBusTimeout Specifies the content of the 32 Bits
SMBUS_TIMEOUT_register value. (Enable bits and different timeout values) This
parameter calculated by referring to SMBUS initialization section in Reference manual
SMBUS_HandleTypeDef
SMBUS_HandleTypeDef is defined in the stm32f0xx_hal_smbus.h
Data Fields
I2C_TypeDef * Instance
SMBUS_InitTypeDef Init
uint8_t * pBuffPtr
uint16_t XferSize
__IO uint16_t XferCount
__IO uint32_t XferOptions
__IO HAL_SMBUS_StateTypeDef PreviousState
__IO HAL_SMBUS_StateTypeDef State
__IO HAL_SMBUS_ErrorTypeDef ErrorCode
Field Documentation
36.2
I2C_TypeDef* SMBUS_HandleTypeDef::Instance SMBUS registers base address

SMBUS_InitTypeDef SMBUS_HandleTypeDef::Init SMBUS communication
parameters
uint8_t* SMBUS_HandleTypeDef::pBuffPtr Pointer to SMBUS transfer buffer
uint16_t SMBUS_HandleTypeDef::XferSize SMBUS transfer size
__IO uint16_t SMBUS_HandleTypeDef::XferCount SMBUS transfer counter
__IO uint32_t SMBUS_HandleTypeDef::XferOptions SMBUS transfer options
__IO HAL_SMBUS_StateTypeDef SMBUS_HandleTypeDef::PreviousState
SMBUS communication Previous tate
HAL_LockTypeDef SMBUS_HandleTypeDef::Lock SMBUS locking object
__IO HAL_SMBUS_StateTypeDef SMBUS_HandleTypeDef::State SMBUS
communication state
__IO HAL_SMBUS_ErrorTypeDef SMBUS_HandleTypeDef::ErrorCode SMBUS
Error code
SMBUS Firmware driver API description

The following section lists the various functions of the SMBUS library.
36.2.1

This subsection provides a set of functions allowing to initialize and de-initialiaze the
SMBUSx peripheral:
478/692
User must Implement HAL_SMBUS_MspInit() function in which he configures all

related peripherals resources (CLOCK, GPIO, IT and NVIC ).
DocID026525 Rev 1
UM1785
36.2.2
Call the function HAL_SMBUS_Init() to configure the selected device with the
selected configuration:
Clock Timing
Bus Timeout
Analog Filer mode
Own Address 1
Addressing mode (Master, Slave)
Dual Addressing mode
Own Address 2
Own Address 2 Mask
General call mode
Nostretch mode
Packet Error Check mode
Peripheral mode
Call the function HAL_SMBUS_DeInit() to restore the default configuration of the
selected SMBUSx periperal.
HAL_SMBUS_Init()
HAL_SMBUS_DeInit()
HAL_SMBUS_MspInit()
HAL_SMBUS_MspDeInit()
This subsection provides a set of functions allowing to manage the SMBUS data transfers.
1.
2.
3.
4.
Blocking mode function to check if device is ready for usage is :
HAL_SMBUS_IsDeviceReady()
There is only one mode of transfer:
No-Blocking mode : The communication is performed using Interrupts. These

functions return the status of the transfer startup. The end of the data processing
will be indicated through the dedicated SMBUS IRQ when using Interrupt mode.
HAL_SMBUS_Master_Transmit_IT()
HAL_SMBUS_Master_Receive_IT()
HAL_SMBUS_Slave_Transmit_IT()
HAL_SMBUS_Slave_Receive_IT()
HAL_SMBUS_Slave_Listen_IT() or alias HAL_SMBUS_EnableListen_IT()
HAL_SMBUS_DisableListen_IT()
HAL_SMBUS_EnableAlert_IT()
HAL_SMBUS_DisableAlert_IT()
A set of Transfer Complete Callbacks are provided in No_Blocking mode:
HAL_SMBUS_MasterTxCpltCallback()
HAL_SMBUS_MasterRxCpltCallback()
HAL_SMBUS_SlaveTxCpltCallback()
HAL_SMBUS_SlaveRxCpltCallback()
HAL_SMBUS_SlaveAddrCallback() or alias HAL_SMBUS_AddrCallback()
HAL_SMBUS_SlaveListenCpltCallback() or alias
HAL_SMBUS_ListenCpltCallback()
HAL_SMBUS_ErrorCallback()
HAL_SMBUS_Master_Transmit_IT()
HAL_SMBUS_Master_Receive_IT()
HAL_SMBUS_Master_Abort_IT()
HAL_SMBUS_Slave_Transmit_IT()
DocID026525 Rev 1
479/692
36.2.3
UM1785
HAL_SMBUS_Slave_Receive_IT()
HAL_SMBUS_Slave_Listen_IT()
HAL_SMBUS_DisableListen_IT()
HAL_SMBUS_EnableAlert_IT()
HAL_SMBUS_DisableAlert_IT()
HAL_SMBUS_IsDeviceReady()
HAL_SMBUS_EV_IRQHandler()
HAL_SMBUS_ER_IRQHandler()
HAL_SMBUS_MasterTxCpltCallback()
HAL_SMBUS_MasterRxCpltCallback()
HAL_SMBUS_SlaveTxCpltCallback()
HAL_SMBUS_SlaveRxCpltCallback()
HAL_SMBUS_SlaveAddrCallback()
HAL_SMBUS_SlaveListenCpltCallback()
HAL_SMBUS_ErrorCallback()

36.2.4
36.2.5
480/692
HAL_SMBUS_GetState()
HAL_SMBUS_GetError()
HAL_SMBUS_Init
Function Name
HAL_StatusTypeDef HAL_SMBUS_Init (
SMBUS_HandleTypeDef * hsmbus)
Initializes the SMBUS according to the specified parameters in the

SMBUS_InitTypeDef and create the associated handle.
Parameters
hsmbus : : Pointer to a SMBUS_HandleTypeDef structure

that contains the configuration information for the specified
SMBUS.
Return values
HAL status
Notes
None.
HAL_SMBUS_DeInit
Function Name
HAL_StatusTypeDef HAL_SMBUS_DeInit (
DeInitializes the SMBUS peripheral.
DocID026525 Rev 1
UM1785
36.2.6
36.2.7
36.2.8

Parameters

SMBUS.
Return values
HAL status
Notes
None.
HAL_SMBUS_MspInit
Function Name
void HAL_SMBUS_MspInit ( SMBUS_HandleTypeDef *

hsmbus)
SMBUS MSP Init.
Parameters

SMBUS.
Return values
None.
Notes
None.
HAL_SMBUS_MspDeInit
Function Name
void HAL_SMBUS_MspDeInit ( SMBUS_HandleTypeDef *

hsmbus)
SMBUS MSP DeInit.
Parameters

SMBUS.
Return values
None.
Notes
None.
HAL_SMBUS_Master_Transmit_IT
DocID026525 Rev 1
481/692
UM1785
Function Name
HAL_StatusTypeDef HAL_SMBUS_Master_Transmit_IT (
SMBUS_HandleTypeDef * hsmbus, uint16_t DevAddress,
uint8_t * pData, uint16_t Size, uint32_t XferOptions)
Transmit in master/host SMBUS mode an amount of data in noblocking mode with Interrupt.
Parameters
36.2.9
Return values
HAL status
Notes
None.
HAL_SMBUS_Master_Receive_IT
Function Name
HAL_StatusTypeDef HAL_SMBUS_Master_Receive_IT (
uint8_t * pData, uint16_t Size, uint32_t XferOptions)
Receive in master/host SMBUS mode an amount of data in noblocking mode with Interrupt.
Parameters
36.2.10
482/692

SMBUS.
XferOptions : Options of Transfer, value of SMBUS
XferOptions definition

SMBUS.
Return values
HAL status
Notes
None.
HAL_SMBUS_Master_Abort_IT
DocID026525 Rev 1
UM1785
36.2.11

Function Name
HAL_StatusTypeDef HAL_SMBUS_Master_Abort_IT (
SMBUS_HandleTypeDef * hsmbus, uint16_t DevAddress)
Abort a master/host SMBUS process commnunication with

Interrupt.
Parameters

SMBUS.
Return values
HAL status
Notes
: This abort can be called only if state is ready
HAL_SMBUS_Slave_Transmit_IT
Function Name
HAL_StatusTypeDef HAL_SMBUS_Slave_Transmit_IT (
SMBUS_HandleTypeDef * hsmbus, uint8_t * pData, uint16_t
Size, uint32_t XferOptions)
Transmit in slave/device SMBUS mode an amount of data in noblocking mode with Interrupt.
Parameters
36.2.12

SMBUS.
Return values
HAL status
Notes
None.
HAL_SMBUS_Slave_Receive_IT
Function Name
HAL_StatusTypeDef HAL_SMBUS_Slave_Receive_IT (
SMBUS_HandleTypeDef * hsmbus, uint8_t * pData, uint16_t
Size, uint32_t XferOptions)
Receive in slave/device SMBUS mode an amount of data in noDocID026525 Rev 1
483/692
UM1785
blocking mode with Interrupt.
Parameters
36.2.13
36.2.14
484/692

SMBUS.
Return values
HAL status
Notes
None.
HAL_SMBUS_Slave_Listen_IT
Function Name
HAL_StatusTypeDef HAL_SMBUS_Slave_Listen_IT (
This function enable the Address listen mode.
Parameters

SMBUS.
Return values
HAL status
Notes
None.
HAL_SMBUS_DisableListen_IT
Function Name
HAL_StatusTypeDef HAL_SMBUS_DisableListen_IT (
This function disable the Address listen mode.
Parameters

SMBUS.
Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
36.2.15
36.2.16
36.2.17
HAL_SMBUS_EnableAlert_IT
Function Name
HAL_StatusTypeDef HAL_SMBUS_EnableAlert_IT (
This function enable the SMBUS alert mode.
Parameters
hsmbus : : pointer to a SMBUS_HandleTypeDef structure

SMBUSx peripheral.
Return values
HAL status
Notes
None.
HAL_SMBUS_DisableAlert_IT
Function Name
HAL_StatusTypeDef HAL_SMBUS_DisableAlert_IT (
This function disable the SMBUS alert mode.
Parameters

SMBUSx peripheral.
Return values
HAL status
Notes
None.
HAL_SMBUS_IsDeviceReady
Function Name
HAL_StatusTypeDef HAL_SMBUS_IsDeviceReady (
uint32_t Trials, uint32_t Timeout)
Checks if target device is ready for communication.
Parameters

SMBUS.
DocID026525 Rev 1
485/692
36.2.18
36.2.19
36.2.20
486/692
UM1785

Trials : Number of trials
Return values
HAL status
Notes
This function is used with Memory devices
HAL_SMBUS_EV_IRQHandler
Function Name
void HAL_SMBUS_EV_IRQHandler ( SMBUS_HandleTypeDef *

hsmbus)
This function handles SMBUS event interrupt request.
Parameters

SMBUS.
Return values
None.
Notes
None.
HAL_SMBUS_ER_IRQHandler
Function Name
void HAL_SMBUS_ER_IRQHandler ( SMBUS_HandleTypeDef *

hsmbus)
This function handles SMBUS error interrupt request.
Parameters

SMBUS.
Return values
None.
Notes
None.
HAL_SMBUS_MasterTxCpltCallback
DocID026525 Rev 1
UM1785
36.2.21
36.2.22

Function Name
void HAL_SMBUS_MasterTxCpltCallback (
Master Tx Transfer completed callbacks.
Parameters

SMBUS.
Return values
None.
Notes
None.
HAL_SMBUS_MasterRxCpltCallback
Function Name
void HAL_SMBUS_MasterRxCpltCallback (
Master Rx Transfer completed callbacks.
Parameters

SMBUS.
Return values
None.
Notes
None.
HAL_SMBUS_SlaveTxCpltCallback
Function Name
void HAL_SMBUS_SlaveTxCpltCallback (
Slave Tx Transfer completed callbacks.
Parameters

SMBUS.
Return values
None.
Notes
None.
DocID026525 Rev 1
487/692
36.2.23
36.2.24
UM1785
HAL_SMBUS_SlaveRxCpltCallback
Function Name
void HAL_SMBUS_SlaveRxCpltCallback (
Slave Rx Transfer completed callbacks.
Parameters

SMBUS.
Return values
None.
Notes
None.
HAL_SMBUS_SlaveAddrCallback
Function Name
void HAL_SMBUS_SlaveAddrCallback (
SMBUS_HandleTypeDef * hsmbus, uint8_t TransferDirection,
uint16_t AddrMatchCode)
Slave Address Match callbacks.
Parameters

SMBUS.
TransferDirection : Master request Transfer Direction
(Write/Read)
AddrMatchCode : Address Match Code
Return values
None.
Notes
None.
36.2.25
488/692
HAL_SMBUS_SlaveListenCpltCallback
Function Name
void HAL_SMBUS_SlaveListenCpltCallback (
Listen Complete callbacks.

DocID026525 Rev 1
UM1785
36.2.26
36.2.27
36.2.28

Parameters

SMBUS.
Return values
None.
Notes
None.
HAL_SMBUS_ErrorCallback
Function Name
void HAL_SMBUS_ErrorCallback ( SMBUS_HandleTypeDef *

hsmbus)
SMBUS error callbacks.
Parameters

SMBUS.
Return values
None.
Notes
None.
HAL_SMBUS_GetState
Function Name
HAL_SMBUS_StateTypeDef HAL_SMBUS_GetState (
Returns the SMBUS state.
Parameters
hsmbus : : SMBUS handle
Return values
HAL state
Notes
None.
HAL_SMBUS_GetError
DocID026525 Rev 1
489/692

Function Name
UM1785
uint32_t HAL_SMBUS_GetError ( SMBUS_HandleTypeDef *
hsmbus)
Return the SMBUS error code.
Parameters

SMBUS.
Return values
SMBUS Error Code
Notes
None.
36.3
SMBUS Firmware driver defines
36.3.1
SMBUS
SMBUS
SMBUS addressing mode
SMBUS_ADDRESSINGMODE_7BIT
SMBUS_ADDRESSINGMODE_10BIT
IS_SMBUS_ADDRESSING_MODE
SMBUS Analog Filter
SMBUS_ANALOGFILTER_ENABLED
SMBUS_ANALOGFILTER_DISABLED
IS_SMBUS_ANALOG_FILTER
SMBUS dual addressing mode
SMBUS_DUALADDRESS_DISABLED
SMBUS_DUALADDRESS_ENABLED
IS_SMBUS_DUAL_ADDRESS
Input and Output operation functions
HAL_SMBUS_EnableListen_IT
HAL_SMBUS_AddrCallback
HAL_SMBUS_ListenCpltCallback
SMBUS Exported Macros
__HAL_SMBUS_RESET_HANDLE_STATE
Description:
Reset SMBUS handle state.
Parameters:
__HANDLE__: SMBUS handle.
Return value:
490/692
DocID026525 Rev 1
UM1785
__HAL_SMBUS_ENABLE_IT
None:
Description:
Enable or disable the specified SMBUS

interrupts.
Parameters:
__HANDLE__: specifies the SMBUS

Handle. This parameter can be SMBUS
where x: 1 or 2 to select the SMBUS
peripheral.
interrupt source to enable or disable.
following values:
SMBUS_IT_ERRI: Errors interrupt

enable
SMBUS_IT_TCI: Transfer
complete interrupt enable
SMBUS_IT_STOPI: STOP
detection interrupt enable
SMBUS_IT_NACKI: NACK
received interrupt enable
SMBUS_IT_ADDRI: Address
match interrupt enable
SMBUS_IT_RXI: RX interrupt
enable
SMBUS_IT_TXI: TX interrupt
enable
Return value:
None:
__HAL_SMBUS_DISABLE_IT
__HAL_SMBUS_GET_IT_SOURCE
Description:
Checks if the specified SMBUS

interrupt source is enabled or disabled.
Parameters:
DocID026525 Rev 1

peripheral.
SMBUS interrupt source to check. This
values:
SMBUS_IT_ERRI: Errors interrupt

enable
SMBUS_IT_TCI: Transfer
complete interrupt enable
SMBUS_IT_STOPI: STOP
detection interrupt enable
SMBUS_IT_NACKI: NACK
491/692
UM1785
received interrupt enable
SMBUS_IT_ADDRI: Address
match interrupt enable
SMBUS_IT_RXI: RX interrupt
enable
SMBUS_IT_TXI: TX interrupt
enable
Return value:
SMBUS_FLAG_MASK

FALSE).
Description:
Checks whether the specified SMBUS

flag is set or not.
Parameters:
492/692
DocID026525 Rev 1

peripheral.
following values:
SMBUS_FLAG_TXE: Transmit
data register empty
SMBUS_FLAG_TXIS: Transmit
interrupt status
SMBUS_FLAG_RXNE: Receive
data register not empty
SMBUS_FLAG_ADDR: Address
matched (slave mode)
SMBUS_FLAG_AF: NACK
received flag
SMBUS_FLAG_STOPF: STOP
detection flag
SMBUS_FLAG_TC: Transfer
complete (master mode)
SMBUS_FLAG_TCR: Transfer
complete reload
SMBUS_FLAG_BERR: Bus error
SMBUS_FLAG_ARLO: Arbitration
lost
SMBUS_FLAG_OVR:
Overrun/Underrun
SMBUS_FLAG_PECERR: PEC
error in reception
SMBUS_FLAG_TIMEOUT:
Timeout or Tlow detection flag
SMBUS_FLAG_ALERT: SMBus
alert
SMBUS_FLAG_BUSY: Bus busy
SMBUS_FLAG_DIR: Transfer
direction (slave mode)
UM1785

Return value:

FALSE).
__HAL_SMBUS_GET_FLAG
__HAL_SMBUS_CLEAR_FLAG
Description:
Clears the SMBUS pending flags which

are cleared by writing 1 in a specific bit.
Parameters:

peripheral.
__FLAG__: specifies the flag to clear.
This parameter can be any combination
SMBUS_FLAG_ADDR: Address
matched (slave mode)
SMBUS_FLAG_AF: NACK
received flag
SMBUS_FLAG_STOPF: STOP
detection flag
SMBUS_FLAG_BERR: Bus error
SMBUS_FLAG_ARLO: Arbitration
lost
SMBUS_FLAG_OVR:
Overrun/Underrun
SMBUS_FLAG_PECERR: PEC
error in reception
SMBUS_FLAG_TIMEOUT:
Timeout or Tlow detection flag
SMBUS_FLAG_ALERT: SMBus
alert
Return value:
None:
__HAL_SMBUS_ENABLE
__HAL_SMBUS_DISABLE
__HAL_SMBUS_RESET_CR1
__HAL_SMBUS_RESET_CR2
__HAL_SMBUS_GENERATE_START
__HAL_SMBUS_GET_ADDR_MATCH
__HAL_SMBUS_GET_DIR
__HAL_SMBUS_GET_STOP_MODE
__HAL_SMBUS_GET_PEC_MODE
__HAL_SMBUS_GET_ALERT_ENABLED
DocID026525 Rev 1
493/692

__HAL_SMBUS_GENERATE_NACK
IS_SMBUS_OWN_ADDRESS1
IS_SMBUS_OWN_ADDRESS2
SMBUS Flag definition
SMBUS_FLAG_TXE
SMBUS_FLAG_TXIS
SMBUS_FLAG_RXNE
SMBUS_FLAG_ADDR
SMBUS_FLAG_AF
SMBUS_FLAG_STOPF
SMBUS_FLAG_TC
SMBUS_FLAG_TCR
SMBUS_FLAG_BERR
SMBUS_FLAG_ARLO
SMBUS_FLAG_OVR
SMBUS_FLAG_PECERR
SMBUS_FLAG_TIMEOUT
SMBUS_FLAG_ALERT
SMBUS_FLAG_BUSY
SMBUS_FLAG_DIR
SMBUS general call addressing mode
SMBUS_GENERALCALL_DISABLED
SMBUS_GENERALCALL_ENABLED
IS_SMBUS_GENERAL_CALL
SMBUS Interrupt configuration definition
SMBUS_IT_ERRI
SMBUS_IT_TCI
SMBUS_IT_STOPI
SMBUS_IT_NACKI
SMBUS_IT_ADDRI
SMBUS_IT_RXI
SMBUS_IT_TXI
SMBUS_IT_TX
SMBUS_IT_RX
SMBUS_IT_ALERT
SMBUS_IT_ADDR
SMBUS nostretch mode
494/692
DocID026525 Rev 1
UM1785
UM1785

SMBUS_NOSTRETCH_DISABLED
SMBUS_NOSTRETCH_ENABLED
IS_SMBUS_NO_STRETCH
SMBUS ownaddress2 masks
SMBUS_OA2_NOMASK
SMBUS_OA2_MASK01
SMBUS_OA2_MASK02
SMBUS_OA2_MASK03
SMBUS_OA2_MASK04
SMBUS_OA2_MASK05
SMBUS_OA2_MASK06
SMBUS_OA2_MASK07
IS_SMBUS_OWN_ADDRESS2_MASK
SMBUS packet error check mode
SMBUS_PEC_DISABLED
SMBUS_PEC_ENABLED
IS_SMBUS_PEC
SMBUS peripheral mode
SMBUS_PERIPHERAL_MODE_SMBUS_HOST
SMBUS_PERIPHERAL_MODE_SMBUS_SLAVE
SMBUS_PERIPHERAL_MODE_SMBUS_SLAVE_ARP
IS_SMBUS_PERIPHERAL_MODE
SMBUS Private Define
TIMING_CLEAR_MASK
HAL_TIMEOUT_ADDR
HAL_TIMEOUT_BUSY
HAL_TIMEOUT_DIR
HAL_TIMEOUT_RXNE
HAL_TIMEOUT_STOPF
HAL_TIMEOUT_TC
HAL_TIMEOUT_TCR
HAL_TIMEOUT_TXIS
MAX_NBYTE_SIZE
SMBUS Private Macros
__SMBUS_GET_ISR_REG
__SMBUS_CHECK_FLAG
SMBUS ReloadEndMode definition
DocID026525 Rev 1
495/692

SMBUS_SOFTEND_MODE
UM1785
SMBUS_RELOAD_MODE
SMBUS_AUTOEND_MODE
SMBUS_SENDPEC_MODE
IS_SMBUS_TRANSFER_MODE
SMBUS StartStopMode definition
SMBUS_NO_STARTSTOP
SMBUS_GENERATE_STOP
SMBUS_GENERATE_START_READ
SMBUS_GENERATE_START_WRITE
IS_SMBUS_TRANSFER_REQUEST
SMBUS XferOptions definition
SMBUS_FIRST_FRAME
SMBUS_NEXT_FRAME
SMBUS_FIRST_AND_LAST_FRAME_NO_PEC
SMBUS_LAST_FRAME_NO_PEC
SMBUS_FIRST_AND_LAST_FRAME_WITH_PEC
SMBUS_LAST_FRAME_WITH_PEC
IS_SMBUS_TRANSFER_OPTIONS_REQUEST
496/692
DocID026525 Rev 1
UM1785
HAL SPI Generic Driver
37
37.1
SPI Firmware driver registers structures
37.1.1
SPI_InitTypeDef
SPI_InitTypeDef is defined in the stm32f0xx_hal_spi.h
Data Fields
uint32_t Mode
uint32_t Direction
uint32_t DataSize
uint32_t CLKPhase
uint32_t NSS
uint32_t BaudRatePrescaler
uint32_t FirstBit
uint32_t TIMode
uint32_t CRCCalculation
uint32_t CRCPolynomial
uint32_t CRCLength
uint32_t NSSPMode
Field Documentation
uint32_t SPI_InitTypeDef::Mode Specifies the SPI operating mode. This parameter

can be a value of SPI_mode
uint32_t SPI_InitTypeDef::Direction Specifies the SPI bidirectional mode state. This
parameter can be a value of SPI_Direction
uint32_t SPI_InitTypeDef::DataSize Specifies the SPI data size. This parameter can
be a value of SPI_data_size
uint32_t SPI_InitTypeDef::CLKPolarity Specifies the serial clock steady state. This
parameter can be a value of SPI_Clock_Polarity
uint32_t SPI_InitTypeDef::CLKPhase Specifies the clock active edge for the bit
capture. This parameter can be a value of SPI_Clock_Phase
uint32_t SPI_InitTypeDef::NSS Specifies whether the NSS signal is managed by
hardware (NSS pin) or by software using the SSI bit. This parameter can be a value of
SPI_Slave_Select_management
uint32_t SPI_InitTypeDef::BaudRatePrescaler Specifies the Baud Rate prescaler
value which will be used to configure the transmit and receive SCK clock. This
parameter can be a value of SPI_BaudRate_Prescaler
Note:The communication clock is derived from the master clock. The slave clock does
not need to be set.
uint32_t SPI_InitTypeDef::FirstBit Specifies whether data transfers start from MSB
or LSB bit. This parameter can be a value of SPI_MSB_LSB_transmission
uint32_t SPI_InitTypeDef::TIMode Specifies if the TI mode is enabled or not . This
parameter can be a value of SPI_TI_mode
uint32_t SPI_InitTypeDef::CRCCalculation Specifies if the CRC calculation is
enabled or not. This parameter can be a value of SPI_CRC_Calculation
DocID026525 Rev 1
497/692
37.1.2
UM1785
uint32_t SPI_InitTypeDef::CRCPolynomial Specifies the polynomial used for the

CRC calculation. This parameter must be a number between Min_Data = 0 and
Max_Data = 65535
uint32_t SPI_InitTypeDef::CRCLength Specifies the CRC Length used for the CRC
calculation. CRC Length is only used with Data8 and Data16, not other data size This
parameter must 0 or 1 or 2
uint32_t SPI_InitTypeDef::NSSPMode Specifies whether the NSSP signal is
enabled or not . This parameter can be a value of SPI_NSSP_Mode This mode is
activated by the NSSP bit in the SPIx_CR2 register and it takes effect only if the SPI
interface is configured as Motorola SPI master (FRF=0) with capture on the first edge
(SPIx_CR1 CPHA = 0, CPOL setting is ignored)..
__SPI_HandleTypeDef
__SPI_HandleTypeDef is defined in the stm32f0xx_hal_spi.h
Data Fields
SPI_TypeDef * Instance
SPI_InitTypeDef Init
uint16_t TxXferSize
uint16_t RxXferSize
uint32_t CRCSize
void(* RxISR
void(* TxISR
HAL_SPI_StateTypeDef State
HAL_SPI_ErrorTypeDef ErrorCode
Field Documentation
498/692
SPI_TypeDef* __SPI_HandleTypeDef::Instance
SPI_InitTypeDef __SPI_HandleTypeDef::Init
uint8_t* __SPI_HandleTypeDef::pTxBuffPtr
uint16_t __SPI_HandleTypeDef::TxXferSize
uint16_t __SPI_HandleTypeDef::TxXferCount
uint8_t* __SPI_HandleTypeDef::pRxBuffPtr
uint16_t __SPI_HandleTypeDef::RxXferSize
uint16_t __SPI_HandleTypeDef::RxXferCount
uint32_t __SPI_HandleTypeDef::CRCSize
void(* __SPI_HandleTypeDef::RxISR)(struct __SPI_HandleTypeDef *hspi)
void(* __SPI_HandleTypeDef::TxISR)(struct __SPI_HandleTypeDef *hspi)
DMA_HandleTypeDef* __SPI_HandleTypeDef::hdmatx
DMA_HandleTypeDef* __SPI_HandleTypeDef::hdmarx
HAL_LockTypeDef __SPI_HandleTypeDef::Lock
HAL_SPI_StateTypeDef __SPI_HandleTypeDef::State
HAL_SPI_ErrorTypeDef __SPI_HandleTypeDef::ErrorCode
DocID026525 Rev 1
UM1785
37.2
SPI Firmware driver API description

The following section lists the various functions of the SPI library.
37.2.1

The SPI HAL driver can be used as follows:
1.
2.
3.
4.
Declare a SPI_HandleTypeDef handle structure, for example: SPI_HandleTypeDef

hspi;
Initialize the SPI low level resources by implement the HAL_SPI_MspInit ()API:
a.
Enable the SPIx interface clock
b.
SPI pins configuration
Enable the clock for the SPI GPIOs
Configure these SPI pins as alternate function push-pull

c.
Configure the SPIx interrupt priority
Enable the NVIC SPI IRQ handle

d.
Declare a DMA_HandleTypeDef handle structure for the transmit or receive

channel
Enable the DMAx interface clock using
Configure the DMA handle parameters
Configure the DMA Tx or Rx channel
Associate the initilalized hdma_tx handle to the hspi DMA Tx or Rx handle
interrupt on the DMA Tx or Rx channel
Program the Mode, BidirectionalMode , Data size, Baudrate Prescaler, NSS
management, Clock polarity and phase, FirstBit and CRC configuration in the hspi Init
structure.
Initialize the SPI registers by calling the HAL_SPI_Init() API:
These APIs configures also the low level Hardware GPIO, CLOCK,
CORTEX...etc) by calling the customed HAL_SPI_MspInit(&hspi) API.
Using the HAL it is not possible to reach all supported SPI frequency with the differents
SPI Modes, the following table resume the max SPI frequency reached with 8- or 16-bit
data size:
Table 22: Maximum SPI frequency vs data size
Process
Tx/Rx
Rx
Tx
Transfer mode
2 lines, fullduplex
1 line, Rx only
1 line
Polling
fCPU/32
fCPU/32
NA
NA
NA
NA
Interrupt
fCPU/32
fCPU/32
NA
NA
NA
NA
DMA
fCPU/32
fCPU/16
NA
NA
NA
NA
Polling
fCPU/32
fCPU/16
fCPU/16
fCPU/16
fCPU/16
fCPU/16
Interrupt
fCPU/16
fCPU/16
fCPU/16
fCPU/16
fCPU/16
fCPU/16
DMA
fCPU/4
fCPU/8
fCPU/4
fCPU/4
fCPU/8
fCPU/16
Polling
fCPU/16
fCPU/16
NA
NA
fCPU/16
fCPU/16
Interrupt
fCPU/32
fCPU/16
NA
NA
fCPU/16
fCPU/16
DMA
fCPU/2
fCPU/16
NA
NA
fCPU/8
fCPU/16
DocID026525 Rev 1
499/692
UM1785
@note The max SPI frequency depend on SPI data size (4bits, 5bits,..., 8bits,...15bits,
16bits), SPI mode(2 Lines fullduplex, 2 lines RxOnly, 1 line TX/RX) and Process mode
(Polling, IT, DMA).
@note
1.
2.
3.
37.2.2
TX/RX processes are HAL_SPI_TransmitReceive(), HAL_SPI_TransmitReceive_IT()

and HAL_SPI_TransmitReceive_DMA()
RX processes are HAL_SPI_Receive(), HAL_SPI_Receive_IT() and
HAL_SPI_Receive_DMA()
TX processes are HAL_SPI_Transmit(), HAL_SPI_Transmit_IT() and
HAL_SPI_Transmit_DMA()

This subsection provides a set of functions allowing to initialize and de-initialiaze the SPIx
peripheral:
37.2.3
User must Implement HAL_SPI_MspInit() function in which he configures all related

Call the function HAL_SPI_Init() to configure the selected device with the selected
configuration:
Mode
Direction
Data Size
Clock Polarity and Phase
NSS Management
BaudRate Prescaler
FirstBit
TIMode
CRC Calculation
CRC Polynomial if CRC enabled
CRC Length, used only with Data8 and Data16
FIFO reception threshold

Call the function HAL_SPI_DeInit() to restore the default configuration of the selected
SPIx periperal.
HAL_SPI_Init()
HAL_SPI_DeInit()
HAL_SPI_MspInit()
HAL_SPI_MspDeInit()
HAL_SPI_InitExtended()
The SPI supports master and slave mode :
1.
500/692

transfer.

These APIs return the HAL status. The end of the data processing will be
DocID026525 Rev 1
UM1785
2.
3.
4.
5.
37.2.4

indicated through the dedicated SPI IRQ when using Interrupt mode or the DMA
IRQ when using DMA mode. The HAL_SPI_TxCpltCallback(),
HAL_SPI_RxCpltCallback() and HAL_SPI_TxRxCpltCallback() user callbacks will
be executed respectivelly at the end of the transmit or Receive process The
HAL_SPI_ErrorCallback()user callback will be executed when a communication
error is detected
Blocking mode APIs are :
HAL_SPI_Transmit()in 1Line (simplex) and 2Lines (full duplex) mode
HAL_SPI_Receive() in 1Line (simplex) and 2Lines (full duplex) mode
HAL_SPI_TransmitReceive() in full duplex mode

Non Blocking mode APIs with Interrupt are :
HAL_SPI_Transmit_IT()in 1Line (simplex) and 2Lines (full duplex) mode
HAL_SPI_Receive_IT() in 1Line (simplex) and 2Lines (full duplex) mode
HAL_SPI_TransmitReceive_IT()in full duplex mode
HAL_SPI_IRQHandler()
HAL_SPI_Transmit_DMA()in 1Line (simplex) and 2Lines (full duplex) mode
HAL_SPI_Receive_DMA() in 1Line (simplex) and 2Lines (full duplex) mode
HAL_SPI_TransmitReceie_DMA() in full duplex mode

A set of Transfer Complete Callbacks are provided in Non Blocking mode:
HAL_SPI_TxCpltCallback()
HAL_SPI_RxCpltCallback()
HAL_SPI_ErrorCallback()
HAL_SPI_TxRxCpltCallback()
HAL_SPI_Transmit()
HAL_SPI_Receive()
HAL_SPI_TransmitReceive()
HAL_SPI_Transmit_IT()
HAL_SPI_Receive_IT()
HAL_SPI_TransmitReceive_IT()
HAL_SPI_Transmit_DMA()
HAL_SPI_Receive_DMA()
HAL_SPI_TransmitReceive_DMA()
HAL_SPI_DMAPause()
HAL_SPI_DMAResume()
HAL_SPI_DMAStop()
HAL_SPI_IRQHandler()
HAL_SPI_FlushRxFifo()
HAL_SPI_TxCpltCallback()
HAL_SPI_RxCpltCallback()
HAL_SPI_TxRxCpltCallback()
HAL_SPI_TxHalfCpltCallback()
HAL_SPI_RxHalfCpltCallback()
HAL_SPI_TxRxHalfCpltCallback()
HAL_SPI_ErrorCallback()

This subsection provides a set of functions allowing to control the SPI.
HAL_SPI_GetState() API can be helpful to check in run-time the state of the SPI
peripheral.
HAL_SPI_GetError() check in run-time Errors occurring during communication
DocID026525 Rev 1
501/692
37.2.5
37.2.6
37.2.7
502/692
UM1785
HAL_SPI_GetState()
HAL_SPI_GetError()
HAL_SPI_Init
Function Name
HAL_StatusTypeDef HAL_SPI_Init ( SPI_HandleTypeDef *

hspi)
Initializes the SPI according to the specified parameters in the

SPI_InitTypeDef and create the associated handle.
Parameters
hspi : : pointer to a SPI_HandleTypeDef structure that

contains the configuration information for SPI module.
Return values
HAL status
Notes
None.
HAL_SPI_DeInit
Function Name
HAL_StatusTypeDef HAL_SPI_DeInit ( SPI_HandleTypeDef *

hspi)
DeInitializes the SPI peripheral.
Parameters

Return values
HAL status
Notes
None.
HAL_SPI_MspInit
Function Name
void HAL_SPI_MspInit ( SPI_HandleTypeDef * hspi)
SPI MSP Init.
Parameters

Return values
None.
DocID026525 Rev 1
UM1785

Notes
37.2.8
37.2.9
None.
HAL_SPI_MspDeInit
Function Name
void HAL_SPI_MspDeInit ( SPI_HandleTypeDef * hspi)
SPI MSP DeInit.
Parameters

Return values
None.
Notes
None.
HAL_SPI_InitExtended
Function Name
HAL_StatusTypeDef HAL_SPI_InitExtended (
SPI_HandleTypeDef * hspi)
Notes
37.2.10
None.
HAL_SPI_Transmit
Function Name
HAL_StatusTypeDef HAL_SPI_Transmit ( SPI_HandleTypeDef

* hspi, uint8_t * pData, uint16_t Size, uint32_t Timeout)
Transmit an amount of data in blocking mode.
Parameters

pData : : pointer to data buffer
Size : : amount of data to be sent
DocID026525 Rev 1
503/692

Return values
Notes
37.2.11
37.2.12
504/692
UM1785
HAL status
None.
HAL_SPI_Receive
Function Name
HAL_StatusTypeDef HAL_SPI_Receive ( SPI_HandleTypeDef *

hspi, uint8_t * pData, uint16_t Size, uint32_t Timeout)
Parameters

Return values
HAL status
Notes
None.
HAL_SPI_TransmitReceive
Function Name
HAL_StatusTypeDef HAL_SPI_TransmitReceive (
SPI_HandleTypeDef * hspi, uint8_t * pTxData, uint8_t *
pRxData, uint16_t Size, uint32_t Timeout)
Transmit and Receive an amount of data in blocking mode.
Parameters

pTxData : : pointer to transmission data buffer
pRxData : : pointer to reception data buffer to be
Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
37.2.13
37.2.14
37.2.15
HAL_SPI_Transmit_IT
Function Name
HAL_StatusTypeDef HAL_SPI_Transmit_IT (
SPI_HandleTypeDef * hspi, uint8_t * pData, uint16_t Size)
Transmit an amount of data in no-blocking mode with Interrupt.
Parameters

Return values
HAL status
Notes
None.
HAL_SPI_Receive_IT
Function Name
HAL_StatusTypeDef HAL_SPI_Receive_IT (
Receive an amount of data in no-blocking mode with Interrupt.
Parameters

Return values
HAL status
Notes
None.
HAL_SPI_TransmitReceive_IT
Function Name
HAL_StatusTypeDef HAL_SPI_TransmitReceive_IT (
pRxData, uint16_t Size)
Transmit and Receive an amount of data in no-blocking mode

with Interrupt.
Parameters

DocID026525 Rev 1
505/692
37.2.16
37.2.17
506/692
UM1785

pRxData : : pointer to reception data buffer to be
Return values
HAL status
Notes
None.
HAL_SPI_Transmit_DMA
Function Name
HAL_StatusTypeDef HAL_SPI_Transmit_DMA (
Transmit an amount of data in no-blocking mode with DMA.
Parameters

Return values
HAL status
Notes
None.
HAL_SPI_Receive_DMA
Function Name
HAL_StatusTypeDef HAL_SPI_Receive_DMA (
Receive an amount of data in no-blocking mode with DMA.
Parameters

Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
37.2.18
37.2.19
37.2.20
HAL_SPI_TransmitReceive_DMA
Function Name
HAL_StatusTypeDef HAL_SPI_TransmitReceive_DMA (
Transmit and Receive an amount of data in no-blocking mode

with DMA.
Parameters

pRxData : : pointer to reception data buffer
Return values
HAL status
Notes
None.
HAL_SPI_DMAPause
Function Name
HAL_StatusTypeDef HAL_SPI_DMAPause (
Pauses the DMA Transfer.
Parameters

contains the configuration information for the specified SPI
module.
Return values
HAL status
Notes
None.
HAL_SPI_DMAResume
Function Name
HAL_StatusTypeDef HAL_SPI_DMAResume (
Resumes the DMA Transfer.
Parameters

DocID026525 Rev 1
507/692
UM1785
module.
37.2.21
37.2.22
37.2.23
Return values
HAL status
Notes
None.
HAL_SPI_DMAStop
Function Name
HAL_StatusTypeDef HAL_SPI_DMAStop ( SPI_HandleTypeDef

* hspi)
Stops the DMA Transfer.
Parameters

module.
Return values
HAL status
Notes
None.
HAL_SPI_IRQHandler
Function Name
void HAL_SPI_IRQHandler ( SPI_HandleTypeDef * hspi)
This function handles SPI interrupt request.
Parameters

module.
Return values
None.
Notes
None.
HAL_SPI_FlushRxFifo
Function Name
508/692
HAL_StatusTypeDef HAL_SPI_FlushRxFifo (
DocID026525 Rev 1
UM1785

37.2.24
37.2.25
37.2.26
Flush the RX fifo.
Parameters

module.
Return values
HAL status
Notes
None.
HAL_SPI_TxCpltCallback
Function Name
void HAL_SPI_TxCpltCallback ( SPI_HandleTypeDef * hspi)
Parameters

Return values
None.
Notes
None.
HAL_SPI_RxCpltCallback
Function Name
void HAL_SPI_RxCpltCallback ( SPI_HandleTypeDef * hspi)
Parameters

Return values
None.
Notes
None.
HAL_SPI_TxRxCpltCallback
DocID026525 Rev 1
509/692

Function Name
37.2.27
37.2.28
37.2.29
510/692
UM1785
void HAL_SPI_TxRxCpltCallback ( SPI_HandleTypeDef * hspi)
Tx and Rx Transfer completed callbacks.
Parameters

Return values
None.
Notes
None.
HAL_SPI_TxHalfCpltCallback
Function Name
void HAL_SPI_TxHalfCpltCallback ( SPI_HandleTypeDef *

hspi)
Tx Half Transfer completed callbacks.
Parameters

Return values
None.
Notes
None.
HAL_SPI_RxHalfCpltCallback
Function Name
void HAL_SPI_RxHalfCpltCallback ( SPI_HandleTypeDef *

hspi)
Rx Half Transfer completed callbacks.
Parameters

Return values
None.
Notes
None.
HAL_SPI_TxRxHalfCpltCallback
DocID026525 Rev 1
UM1785
37.2.30
37.2.31

Function Name
void HAL_SPI_TxRxHalfCpltCallback ( SPI_HandleTypeDef *

hspi)
Tx and Rx Transfer completed callbacks.
Parameters

Return values
None.
Notes
None.
HAL_SPI_ErrorCallback
Function Name
void HAL_SPI_ErrorCallback ( SPI_HandleTypeDef * hspi)
SPI error callbacks.
Parameters

Return values
None.
Notes
None.
HAL_SPI_GetState
Function Name
HAL_SPI_StateTypeDef HAL_SPI_GetState (
Return the SPI state.
Parameters

Return values
SPI state
Notes
None.
DocID026525 Rev 1
511/692
37.2.32
UM1785
HAL_SPI_GetError
Function Name
HAL_SPI_ErrorTypeDef HAL_SPI_GetError (
Return the SPI error code.
Parameters

Return values
SPI Error Code
Notes
None.
37.3
SPI Firmware driver defines
37.3.1
SPI
SPI
SPI BaudRate Prescaler
SPI_BAUDRATEPRESCALER_2
IS_SPI_BAUDRATE_PRESCALER
SPI Clock Phase
SPI_PHASE_1EDGE
SPI_PHASE_2EDGE
IS_SPI_CPHA
SPI Clock Polarity
SPI_POLARITY_LOW
SPI_POLARITY_HIGH
IS_SPI_CPOL
SPI CRC Calculation
SPI_CRCCALCULATION_DISABLED
512/692
DocID026525 Rev 1
UM1785

SPI_CRCCALCULATION_ENABLED
IS_SPI_CRC_CALCULATION
SPI CRC length
SPI_CRC_LENGTH_DATASIZE
SPI_CRC_LENGTH_8BIT
SPI_CRC_LENGTH_16BIT
IS_SPI_CRC_LENGTH
SPI Data size
SPI_DATASIZE_4BIT
SPI_DATASIZE_5BIT
SPI_DATASIZE_6BIT
SPI_DATASIZE_7BIT
SPI_DATASIZE_8BIT
SPI_DATASIZE_9BIT
SPI_DATASIZE_10BIT
SPI_DATASIZE_11BIT
SPI_DATASIZE_12BIT
SPI_DATASIZE_13BIT
SPI_DATASIZE_14BIT
SPI_DATASIZE_15BIT
SPI_DATASIZE_16BIT
IS_SPI_DATASIZE
SPI Direction
SPI_DIRECTION_2LINES
SPI_DIRECTION_2LINES_RXONLY
SPI_DIRECTION_1LINE
IS_SPI_DIRECTION
IS_SPI_DIRECTION_2LINES
IS_SPI_DIRECTION_2LINES_OR_1LINE
SPI Exported Macros
__HAL_SPI_RESET_HANDLE_STATE
Description:
Reset SPI handle state.
Parameters:
__HANDLE__: SPI handle.
Return value:
None:
DocID026525 Rev 1
513/692

__HAL_SPI_ENABLE_IT
UM1785
Description:
Enables or disables the specified SPI

interrupts.
Parameters:
__HANDLE__: : specifies the SPI Handle.

This parameter can be SPI where x: 1, 2, or
3 to select the SPI peripheral.
__INTERRUPT__: : specifies the interrupt
SPI_IT_TXE: Tx buffer empty interrupt

enable
SPI_IT_RXNE: RX buffer not empty

interrupt enable
SPI_IT_ERR: Error interrupt enable
Return value:
None:
__HAL_SPI_DISABLE_IT
__HAL_SPI_GET_IT_SOURCE
Description:
Checks if the specified SPI interrupt source

Parameters:

__INTERRUPT__: : specifies the SPI
SPI_IT_TXE: Tx buffer empty interrupt

enable
SPI_IT_RXNE: RX buffer not empty

interrupt enable
SPI_IT_ERR: Error interrupt enable
Return value:
__HAL_SPI_GET_FLAG
Description:
Checks whether the specified SPI flag is set

or not.
Parameters:
514/692

__FLAG__: : specifies the flag to check.
values:
SPI_FLAG_RXNE: Receive buffer not
DocID026525 Rev 1
UM1785

empty flag
SPI_FLAG_TXE: Transmit buffer
empty flag
SPI_FLAG_CRCERR: CRC error flag
SPI_FLAG_MODF: Mode fault flag
SPI_FLAG_OVR: Overrun flag
SPI_FLAG_BSY: Busy flag
SPI_FLAG_FRE: Frame format error
flag
SPI_FLAG_FTLVL: SPI fifo
transmission level
SPI_FLAG_FRLVL: SPI fifo reception
level
Return value:
__HAL_SPI_CLEAR_CRCERRFLAG

FALSE).
Description:
Clears the SPI CRCERR pending flag.
Parameters:

Return value:
__HAL_SPI_CLEAR_MODFFLAG
None:
Description:
Clears the SPI MODF pending flag.
Parameters:

Return value:
__HAL_SPI_CLEAR_OVRFLAG
None:
Description:
Clears the SPI OVR pending flag.
Parameters:

Return value:
__HAL_SPI_CLEAR_FREFLAG
None:
Description:
Clears the SPI FRE pending flag.
DocID026525 Rev 1
515/692
UM1785
Parameters:

Return value:
__HAL_SPI_ENABLE
None:
Description:
Enables the SPI.
Parameters:

Return value:
__HAL_SPI_DISABLE
None:
Description:
Disables the SPI.
Parameters:

Return value:
__HAL_SPI_1LINE_TX
None:
Description:
Sets the SPI transmit-only mode.
Parameters:

Return value:
__HAL_SPI_1LINE_RX
None:
Description:
Sets the SPI receive-only mode.
Parameters:

Return value:
__HAL_SPI_RESET_CRC
516/692
None:
Description:
DocID026525 Rev 1
UM1785
Resets the CRC calculation of the SPI.
Parameters:

Return value:
None:
IS_SPI_CRC_POLYNOMIAL
SPI FIFO reception threshold
SPI_RXFIFO_THRESHOLD
SPI_RXFIFO_THRESHOLD_QF
SPI_RXFIFO_THRESHOLD_HF
SPI Flag definition
SPI_FLAG_RXNE
SPI_FLAG_TXE
SPI_FLAG_BSY
SPI_FLAG_CRCERR
SPI_FLAG_MODF
SPI_FLAG_OVR
SPI_FLAG_FRE
SPI_FLAG_FTLVL
SPI_FLAG_FRLVL
SPI Interrupt configuration definition
SPI_IT_TXE
SPI_IT_RXNE
SPI_IT_ERR
SPI mode
SPI_MODE_SLAVE
SPI_MODE_MASTER
IS_SPI_MODE
SPI MSB LSB transmission
SPI_FIRSTBIT_MSB
SPI_FIRSTBIT_LSB
IS_SPI_FIRST_BIT
SPI NSS pulse management
SPI_NSS_PULSE_ENABLED
SPI_NSS_PULSE_DISABLED
DocID026525 Rev 1
517/692

IS_SPI_NSSP
UM1785
SPI Private Constants

SPI_DEFAULT_TIMEOUT
SPI_FIFO_SIZE
SPI reception fifo status level
SPI_FRLVL_EMPTY
SPI_FRLVL_QUARTER_FULL
SPI_FRLVL_HALF_FULL
SPI_FRLVL_FULL
SPI Slave Select management
SPI_NSS_SOFT
SPI_NSS_HARD_INPUT
SPI_NSS_HARD_OUTPUT
IS_SPI_NSS
SPI TI mode
SPI_TIMODE_DISABLED
SPI_TIMODE_ENABLED
IS_SPI_TIMODE
SPI transmission fifo status level
SPI_FTLVL_EMPTY
SPI_FTLVL_QUARTER_FULL
SPI_FTLVL_HALF_FULL
SPI_FTLVL_FULL
518/692
DocID026525 Rev 1
UM1785
HAL TIM Generic Driver
38
38.1
TIM Firmware driver registers structures
38.1.1
TIM_Base_InitTypeDef
TIM_Base_InitTypeDef is defined in the stm32f0xx_hal_tim.h
Data Fields
uint32_t Prescaler
uint32_t CounterMode
uint32_t Period
uint32_t ClockDivision
uint32_t RepetitionCounter
Field Documentation
38.1.2
uint32_t TIM_Base_InitTypeDef::Prescaler Specifies the prescaler value used to

divide the TIM clock. This parameter can be a number between Min_Data = 0x0000
and Max_Data = 0xFFFF
uint32_t TIM_Base_InitTypeDef::CounterMode Specifies the counter mode. This
parameter can be a value of TIM_Counter_Mode
uint32_t TIM_Base_InitTypeDef::Period Specifies the period value to be loaded into
the active Auto-Reload Register at the next update event. This parameter can be a
number between Min_Data = 0x0000 and Max_Data = 0xFFFF.
uint32_t TIM_Base_InitTypeDef::ClockDivision Specifies the clock division. This
parameter can be a value of TIM_ClockDivision
uint32_t TIM_Base_InitTypeDef::RepetitionCounter Specifies the repetition counter
value. Each time the RCR downcounter reaches zero, an update event is generated
and counting restarts from the RCR value (N). This means in PWM mode that (N+1)
corresponds to:
the number of PWM periods in edge-aligned mode
the number of half PWM period in center-aligned mode This parameter must be a
number between Min_Data = 0x00 and Max_Data = 0xFF.
Note:This parameter is valid only for TIM1 and TIM8.
TIM_OC_InitTypeDef
TIM_OC_InitTypeDef is defined in the stm32f0xx_hal_tim.h
Data Fields
uint32_t OCMode
uint32_t Pulse
uint32_t OCPolarity
uint32_t OCNPolarity
uint32_t OCFastMode
uint32_t OCIdleState
uint32_t OCNIdleState
DocID026525 Rev 1
519/692

Field Documentation
38.1.3
UM1785
uint32_t TIM_OC_InitTypeDef::OCMode Specifies the TIM mode. This parameter

can be a value of TIM_Output_Compare_and_PWM_modes
uint32_t TIM_OC_InitTypeDef::Pulse Specifies the pulse value to be loaded into the
Capture Compare Register. This parameter can be a number between Min_Data =
0x0000 and Max_Data = 0xFFFF
uint32_t TIM_OC_InitTypeDef::OCPolarity Specifies the output polarity. This
parameter can be a value of TIM_Output_Compare_Polarity
uint32_t TIM_OC_InitTypeDef::OCNPolarity Specifies the complementary output
polarity. This parameter can be a value of TIM_Output_Compare_N_Polarity
uint32_t TIM_OC_InitTypeDef::OCFastMode Specifies the Fast mode state. This
parameter can be a value of TIM_Output_Fast_State
Note:This parameter is valid only in PWM1 and PWM2 mode.
uint32_t TIM_OC_InitTypeDef::OCIdleState Specifies the TIM Output Compare pin
state during Idle state. This parameter can be a value of
TIM_Output_Compare_Idle_State
uint32_t TIM_OC_InitTypeDef::OCNIdleState Specifies the TIM Output Compare pin
state during Idle state. This parameter can be a value of
TIM_Output_Compare_N_Idle_State
TIM_OnePulse_InitTypeDef
TIM_OnePulse_InitTypeDef is defined in the stm32f0xx_hal_tim.h
Data Fields
uint32_t OCMode
uint32_t Pulse
uint32_t OCPolarity
uint32_t OCNPolarity
uint32_t OCIdleState
uint32_t OCNIdleState
uint32_t ICPolarity
uint32_t ICSelection
uint32_t ICFilter
Field Documentation
520/692
uint32_t TIM_OnePulse_InitTypeDef::OCMode Specifies the TIM mode. This

parameter can be a value of TIM_Output_Compare_and_PWM_modes
uint32_t TIM_OnePulse_InitTypeDef::Pulse Specifies the pulse value to be loaded
into the Capture Compare Register. This parameter can be a number between
Min_Data = 0x0000 and Max_Data = 0xFFFF
uint32_t TIM_OnePulse_InitTypeDef::OCPolarity Specifies the output polarity. This
parameter can be a value of TIM_Output_Compare_Polarity
uint32_t TIM_OnePulse_InitTypeDef::OCNPolarity Specifies the complementary
output polarity. This parameter can be a value of TIM_Output_Compare_N_Polarity
uint32_t TIM_OnePulse_InitTypeDef::OCIdleState Specifies the TIM Output
Compare pin state during Idle state. This parameter can be a value of
DocID026525 Rev 1
UM1785
38.1.4

TIM_Output_Compare_Idle_State
uint32_t TIM_OnePulse_InitTypeDef::OCNIdleState Specifies the TIM Output
Compare pin state during Idle state. This parameter can be a value of
TIM_Output_Compare_N_Idle_State
uint32_t TIM_OnePulse_InitTypeDef::ICPolarity Specifies the active edge of the
input signal. This parameter can be a value of TIM_Input_Capture_Polarity
uint32_t TIM_OnePulse_InitTypeDef::ICSelection Specifies the input. This
parameter can be a value of TIM_Input_Capture_Selection
uint32_t TIM_OnePulse_InitTypeDef::ICFilter Specifies the input capture filter. This
parameter can be a number between Min_Data = 0x0 and Max_Data = 0xF
TIM_IC_InitTypeDef
TIM_IC_InitTypeDef is defined in the stm32f0xx_hal_tim.h
Data Fields
uint32_t ICPolarity
uint32_t ICSelection
uint32_t ICPrescaler
uint32_t ICFilter
Field Documentation
38.1.5
uint32_t TIM_IC_InitTypeDef::ICPolarity Specifies the active edge of the input

signal. This parameter can be a value of TIM_Input_Capture_Polarity
uint32_t TIM_IC_InitTypeDef::ICSelection Specifies the input. This parameter can
be a value of TIM_Input_Capture_Selection
uint32_t TIM_IC_InitTypeDef::ICPrescaler Specifies the Input Capture Prescaler.
This parameter can be a value of TIM_Input_Capture_Prescaler
uint32_t TIM_IC_InitTypeDef::ICFilter Specifies the input capture filter. This
TIM_Encoder_InitTypeDef
TIM_Encoder_InitTypeDef is defined in the stm32f0xx_hal_tim.h
Data Fields
uint32_t EncoderMode
uint32_t IC1Polarity
uint32_t IC1Selection
uint32_t IC1Prescaler
uint32_t IC1Filter
uint32_t IC2Selection
uint32_t IC2Filter
Field Documentation
DocID026525 Rev 1
521/692
38.1.6
UM1785
uint32_t TIM_Encoder_InitTypeDef::EncoderMode Specifies the active edge of the

input signal. This parameter can be a value of TIM_Encoder_Mode
uint32_t TIM_Encoder_InitTypeDef::IC1Polarity Specifies the active edge of the
uint32_t TIM_Encoder_InitTypeDef::IC1Selection Specifies the input. This
uint32_t TIM_Encoder_InitTypeDef::IC1Prescaler Specifies the Input Capture
Prescaler. This parameter can be a value of TIM_Input_Capture_Prescaler
uint32_t TIM_Encoder_InitTypeDef::IC1Filter Specifies the input capture filter. This
uint32_t TIM_Encoder_InitTypeDef::IC2Polarity Specifies the active edge of the
uint32_t TIM_Encoder_InitTypeDef::IC2Selection Specifies the input. This
uint32_t TIM_Encoder_InitTypeDef::IC2Prescaler Specifies the Input Capture
uint32_t TIM_Encoder_InitTypeDef::IC2Filter Specifies the input capture filter. This
TIM_ClockConfigTypeDef
TIM_ClockConfigTypeDef is defined in the stm32f0xx_hal_tim.h
Data Fields
uint32_t ClockSource
uint32_t ClockPolarity
uint32_t ClockPrescaler
uint32_t ClockFilter
Field Documentation
38.1.7
uint32_t TIM_ClockConfigTypeDef::ClockSource TIM clock sources This

parameter can be a value of TIM_Clock_Source
uint32_t TIM_ClockConfigTypeDef::ClockPolarity TIM clock polarity This
parameter can be a value of TIM_Clock_Polarity
uint32_t TIM_ClockConfigTypeDef::ClockPrescaler TIM clock prescaler This
parameter can be a value of TIM_Clock_Prescaler
uint32_t TIM_ClockConfigTypeDef::ClockFilter TIM clock filter This parameter can
be a value of TIM_Clock_Filter
TIM_ClearInputConfigTypeDef
TIM_ClearInputConfigTypeDef is defined in the stm32f0xx_hal_tim.h
Data Fields
522/692
uint32_t ClearInputState
uint32_t ClearInputSource
uint32_t ClearInputPolarity
uint32_t ClearInputPrescaler
uint32_t ClearInputFilter
DocID026525 Rev 1
UM1785

Field Documentation
38.1.8
uint32_t TIM_ClearInputConfigTypeDef::ClearInputState TIM clear Input state This

parameter can be ENABLE or DISABLE
uint32_t TIM_ClearInputConfigTypeDef::ClearInputSource TIM clear Input sources
This parameter can be a value of TIM_ClearInput_Source
uint32_t TIM_ClearInputConfigTypeDef::ClearInputPolarity TIM Clear Input
polarity This parameter can be a value of TIM_ClearInput_Polarity
uint32_t TIM_ClearInputConfigTypeDef::ClearInputPrescaler TIM Clear Input
prescaler This parameter can be a value of TIM_ClearInput_Prescaler
uint32_t TIM_ClearInputConfigTypeDef::ClearInputFilter TIM Clear Input filter This
parameter can be a value of TIM_ClearInput_Filter
TIM_SlaveConfigTypeDef
TIM_SlaveConfigTypeDef is defined in the stm32f0xx_hal_tim.h
Data Fields
uint32_t SlaveMode
uint32_t InputTrigger
uint32_t TriggerPolarity
uint32_t TriggerPrescaler
uint32_t TriggerFilter
Field Documentation
38.1.9
uint32_t TIM_SlaveConfigTypeDef::SlaveMode Slave mode selection This

parameter can be a value of TIM_Slave_Mode
uint32_t TIM_SlaveConfigTypeDef::InputTrigger Input Trigger source This
parameter can be a value of TIM_Trigger_Selection
uint32_t TIM_SlaveConfigTypeDef::TriggerPolarity Input Trigger polarity This
parameter can be a value of TIM_Trigger_Polarity
uint32_t TIM_SlaveConfigTypeDef::TriggerPrescaler Input trigger prescaler This
parameter can be a value of TIM_Trigger_Prescaler
uint32_t TIM_SlaveConfigTypeDef::TriggerFilter Input trigger filter This parameter
can be a value of TIM_Trigger_Filter
TIM_HandleTypeDef
TIM_HandleTypeDef is defined in the stm32f0xx_hal_tim.h
Data Fields
TIM_TypeDef * Instance
TIM_Base_InitTypeDef Init
HAL_TIM_ActiveChannel Channel
DMA_HandleTypeDef * hdma
__IO HAL_TIM_StateTypeDef State
Field Documentation
DocID026525 Rev 1
523/692
38.2
UM1785
TIM_TypeDef* TIM_HandleTypeDef::Instance Register base address

TIM_Base_InitTypeDef TIM_HandleTypeDef::Init TIM Time Base required
parameters
HAL_TIM_ActiveChannel TIM_HandleTypeDef::Channel Active channel
DMA_HandleTypeDef* TIM_HandleTypeDef::hdma[7] DMA Handlers array This
array is accessed by a TIM_DMA_Handle_index
HAL_LockTypeDef TIM_HandleTypeDef::Lock Locking object
__IO HAL_TIM_StateTypeDef TIM_HandleTypeDef::State TIM operation state
TIM Firmware driver API description

The following section lists the various functions of the TIM library.
38.2.1
TIMER Generic features

The Timer features include:
1.
2.
3.
38.2.2
1.
2.
3.
4.
524/692
16-bit up, down, up/down auto-reload counter.

16-bit programmable prescaler allowing dividing (also on the fly) the counter clock
frequency either by any factor between 1 and 65536.
Up to 4 independent channels for:
Input Capture
Output Compare
PWM generation (Edge and Center-aligned Mode)
One-pulse mode output
Initialize the TIM low level resources by implementing the following functions
depending from feature used :
Time Base : HAL_TIM_Base_MspInit()
Input Capture : HAL_TIM_IC_MspInit()
Output Compare : HAL_TIM_OC_MspInit()
PWM generation : HAL_TIM_PWM_MspInit()
One-pulse mode output : HAL_TIM_OnePulse_MspInit()
Encoder mode output : HAL_TIM_Encoder_MspInit()

Initialize the TIM low level resources :
a.
Enable the TIM interface clock using __TIMx_CLK_ENABLE();
b.
TIM pins configuration
Enable the clock for the TIM GPIOs using the following function:
Configure these TIM pins in Alternate function mode using

HAL_GPIO_Init();
The external Clock can be configured, if needed (the default clock is the internal clock
from the APBx), using the following function: HAL_TIM_ConfigClockSource, the clock
configuration should be done before any start function.
Configure the TIM in the desired functioning mode using one of the Initialization
function of this driver:
HAL_TIM_Base_Init: to use the Timer to generate a simple time base
DocID026525 Rev 1
UM1785
5.
6.
38.2.3
HAL_TIM_OC_Init and HAL_TIM_OC_ConfigChannel: to use the Timer to

generate an Output Compare signal.
HAL_TIM_PWM_Init and HAL_TIM_PWM_ConfigChannel: to use the Timer to

generate a PWM signal.
HAL_TIM_IC_Init and HAL_TIM_IC_ConfigChannel: to use the Timer to

measure an external signal.
HAL_TIM_OnePulse_Init and HAL_TIM_OnePulse_ConfigChannel: to use the

Timer in One Pulse Mode.
HAL_TIM_Encoder_Init: to use the Timer Encoder Interface.

Activate the TIM peripheral using one of the start functions depending from the
feature used:
Time Base : HAL_TIM_Base_Start(), HAL_TIM_Base_Start_DMA(),

HAL_TIM_Base_Start_IT()
Input Capture : HAL_TIM_IC_Start(), HAL_TIM_IC_Start_DMA(),

HAL_TIM_IC_Start_IT()
Output Compare : HAL_TIM_OC_Start(), HAL_TIM_OC_Start_DMA(),

HAL_TIM_OC_Start_IT()
PWM generation : HAL_TIM_PWM_Start(), HAL_TIM_PWM_Start_DMA(),

HAL_TIM_PWM_Start_IT()
One-pulse mode output : HAL_TIM_OnePulse_Start(),

HAL_TIM_OnePulse_Start_IT()
Encoder mode output : HAL_TIM_Encoder_Start(),

HAL_TIM_Encoder_Start_DMA(), HAL_TIM_Encoder_Start_IT().
The DMA Burst is managed with the two following functions:
HAL_TIM_DMABurst_WriteStart() HAL_TIM_DMABurst_ReadStart()
Time Base functions

38.2.4
Initialize and configure the TIM base.

De-initialize the TIM base.
Start the Time Base.
Stop the Time Base.
Start the Time Base and enable interrupt.
Stop the Time Base and disable interrupt.
Start the Time Base and enable DMA transfer.
Stop the Time Base and disable DMA transfer.
HAL_TIM_Base_Init()
HAL_TIM_Base_DeInit()
HAL_TIM_Base_MspInit()
HAL_TIM_Base_MspDeInit()
HAL_TIM_Base_Start()
HAL_TIM_Base_Stop()
HAL_TIM_Base_Start_IT()
HAL_TIM_Base_Stop_IT()
HAL_TIM_Base_Start_DMA()
HAL_TIM_Base_Stop_DMA()
Time Output Compare functions

DocID026525 Rev 1
525/692
38.2.5
UM1785
Initialize and configure the TIM Output Compare.

De-initialize the TIM Output Compare.
Start the Time Output Compare.
Stop the Time Output Compare.
Start the Time Output Compare and enable interrupt.
Stop the Time Output Compare and disable interrupt.
Start the Time Output Compare and enable DMA transfer.
Stop the Time Output Compare and disable DMA transfer.
HAL_TIM_OC_Init()
HAL_TIM_OC_DeInit()
HAL_TIM_OC_MspInit()
HAL_TIM_OC_MspDeInit()
HAL_TIM_OC_Start()
HAL_TIM_OC_Stop()
HAL_TIM_OC_Start_IT()
HAL_TIM_OC_Stop_IT()
HAL_TIM_OC_Start_DMA()
HAL_TIM_OC_Stop_DMA()
Time PWM functions

38.2.6
Initialize and configure the TIM OPWM.

De-initialize the TIM PWM.
Start the Time PWM.
Stop the Time PWM.
Start the Time PWM and enable interrupt.
Stop the Time PWM and disable interrupt.
Start the Time PWM and enable DMA transfer.
Stop the Time PWM and disable DMA transfer.
HAL_TIM_PWM_Init()
HAL_TIM_PWM_DeInit()
HAL_TIM_PWM_MspInit()
HAL_TIM_PWM_MspDeInit()
HAL_TIM_PWM_Start()
HAL_TIM_PWM_Stop()
HAL_TIM_PWM_Start_IT()
HAL_TIM_PWM_Stop_IT()
HAL_TIM_PWM_Start_DMA()
HAL_TIM_PWM_Stop_DMA()
Time Input Capture functions

526/692
Initialize and configure the TIM Input Capture.

De-initialize the TIM Input Capture.
Start the Time Input Capture.
Stop the Time Input Capture.
Start the Time Input Capture and enable interrupt.
Stop the Time Input Capture and disable interrupt.
DocID026525 Rev 1
UM1785
38.2.7
Start the Time Input Capture and enable DMA transfer.

Stop the Time Input Capture and disable DMA transfer.
HAL_TIM_IC_Init()
HAL_TIM_IC_DeInit()
HAL_TIM_IC_MspInit()
HAL_TIM_IC_MspDeInit()
HAL_TIM_IC_Start()
HAL_TIM_IC_Stop()
HAL_TIM_IC_Start_IT()
HAL_TIM_IC_Stop_IT()
HAL_TIM_IC_Start_DMA()
HAL_TIM_IC_Stop_DMA()
Time One Pulse functions

38.2.8
Initialize and configure the TIM One Pulse.

De-initialize the TIM One Pulse.
Start the Time One Pulse.
Stop the Time One Pulse.
Start the Time One Pulse and enable interrupt.
Stop the Time One Pulse and disable interrupt.
Start the Time One Pulse and enable DMA transfer.
Stop the Time One Pulse and disable DMA transfer.
HAL_TIM_OnePulse_Init()
HAL_TIM_OnePulse_DeInit()
HAL_TIM_OnePulse_MspInit()
HAL_TIM_OnePulse_MspDeInit()
HAL_TIM_OnePulse_Start()
HAL_TIM_OnePulse_Stop()
HAL_TIM_OnePulse_Start_IT()
HAL_TIM_OnePulse_Stop_IT()
Time Encoder functions

Initialize and configure the TIM Encoder.

De-initialize the TIM Encoder.
Start the Time Encoder.
Stop the Time Encoder.
Start the Time Encoder and enable interrupt.
Stop the Time Encoder and disable interrupt.
Start the Time Encoder and enable DMA transfer.
Stop the Time Encoder and disable DMA transfer.
HAL_TIM_Encoder_Init()
HAL_TIM_Encoder_DeInit()
HAL_TIM_Encoder_MspInit()
HAL_TIM_Encoder_MspDeInit()
HAL_TIM_Encoder_Start()
HAL_TIM_Encoder_Stop()
DocID026525 Rev 1
527/692
38.2.9
UM1785
HAL_TIM_Encoder_Start_IT()
HAL_TIM_Encoder_Stop_IT()
HAL_TIM_Encoder_Start_DMA()
HAL_TIM_Encoder_Stop_DMA()
IRQ handler management

This section provides Timer IRQ handler function.
38.2.10
HAL_TIM_IRQHandler()

38.2.11
Configure The Input Output channels for OC, PWM, IC or One Pulse mode.
Configure External Clock source.
Configure Complementary channels, break features and dead time.
Configure Master and the Slave synchronization.
Configure the DMA Burst Mode.
HAL_TIM_OC_ConfigChannel()
HAL_TIM_IC_ConfigChannel()
HAL_TIM_PWM_ConfigChannel()
HAL_TIM_OnePulse_ConfigChannel()
HAL_TIM_DMABurst_WriteStart()
HAL_TIM_DMABurst_WriteStop()
HAL_TIM_DMABurst_ReadStart()
HAL_TIM_DMABurst_ReadStop()
HAL_TIM_GenerateEvent()
HAL_TIM_ConfigOCrefClear()
HAL_TIM_ConfigClockSource()
HAL_TIM_ConfigTI1Input()
HAL_TIM_SlaveConfigSynchronization()
HAL_TIM_SlaveConfigSynchronization_IT()
HAL_TIM_ReadCapturedValue()
TIM Callbacks functions

This section provides TIM callback functions:
528/692
Timer Period elapsed callback

Timer Output Compare callback
Timer Input capture callback
Timer Trigger callback
Timer Error callback
HAL_TIM_PeriodElapsedCallback()
HAL_TIM_OC_DelayElapsedCallback()
HAL_TIM_IC_CaptureCallback()
HAL_TIM_PWM_PulseFinishedCallback()
HAL_TIM_TriggerCallback()
HAL_TIM_ErrorCallback()
DocID026525 Rev 1
UM1785
38.2.12

38.2.13
38.2.14
38.2.15
HAL_TIM_Base_GetState()
HAL_TIM_OC_GetState()
HAL_TIM_PWM_GetState()
HAL_TIM_IC_GetState()
HAL_TIM_OnePulse_GetState()
HAL_TIM_Encoder_GetState()
HAL_TIM_Base_Init
Function Name
HAL_StatusTypeDef HAL_TIM_Base_Init (
TIM_HandleTypeDef * htim)
Initializes the TIM Time base Unit according to the specified

parameters in the TIM_HandleTypeDef and create the associated
handle.
Parameters
htim : : TIM Base handle
Return values
HAL status
Notes
None.
HAL_TIM_Base_DeInit
Function Name
HAL_StatusTypeDef HAL_TIM_Base_DeInit (
DeInitializes the TIM Base peripheral.
Parameters
Return values
HAL status
Notes
None.
HAL_TIM_Base_MspInit
DocID026525 Rev 1
529/692

Function Name
38.2.16
38.2.17
38.2.18
Initializes the TIM Base MSP.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
HAL_TIM_Base_MspDeInit
Function Name
void HAL_TIM_Base_MspDeInit ( TIM_HandleTypeDef * htim)
DeInitializes TIM Base MSP.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
HAL_TIM_Base_Start
Function Name
HAL_StatusTypeDef HAL_TIM_Base_Start (
Starts the TIM Base generation.
Parameters
htim : : TIM handle
Return values
HAL status
Notes
None.
HAL_TIM_Base_Stop
Function Name
530/692
UM1785
void HAL_TIM_Base_MspInit ( TIM_HandleTypeDef * htim)
HAL_StatusTypeDef HAL_TIM_Base_Stop (
DocID026525 Rev 1
UM1785
38.2.19
38.2.20
38.2.21

Stops the TIM Base generation.
Parameters
htim : : TIM handle
Return values
HAL status
Notes
None.
HAL_TIM_Base_Start_IT
Function Name
HAL_StatusTypeDef HAL_TIM_Base_Start_IT (
Starts the TIM Base generation in interrupt mode.
Parameters
htim : : TIM handle
Return values
HAL status
Notes
None.
HAL_TIM_Base_Stop_IT
Function Name
HAL_StatusTypeDef HAL_TIM_Base_Stop_IT (
Stops the TIM Base generation in interrupt mode.
Parameters
htim : : TIM handle
Return values
HAL status
Notes
None.
HAL_TIM_Base_Start_DMA
Function Name
HAL_StatusTypeDef HAL_TIM_Base_Start_DMA (
TIM_HandleTypeDef * htim, uint32_t * pData, uint16_t Length)
DocID026525 Rev 1
531/692

38.2.22
38.2.23
38.2.24
532/692
UM1785
Starts the TIM Base generation in DMA mode.
Parameters
htim : : TIM handle

pData : : The source Buffer address.
Length : : The length of data to be transferred from memory
to peripheral.
Return values
HAL status
Notes
None.
HAL_TIM_Base_Stop_DMA
Function Name
HAL_StatusTypeDef HAL_TIM_Base_Stop_DMA (
Stops the TIM Base generation in DMA mode.
Parameters
htim : : TIM handle
Return values
HAL status
Notes
None.
HAL_TIM_OC_Init
Function Name
HAL_StatusTypeDef HAL_TIM_OC_Init ( TIM_HandleTypeDef *

htim)
Initializes the TIM Output Compare according to the specified

handle.
Parameters
htim : : TIM Output Compare handle
Return values
HAL status
Notes
None.
HAL_TIM_OC_DeInit
DocID026525 Rev 1
UM1785
38.2.25
38.2.26
38.2.27

Function Name
HAL_StatusTypeDef HAL_TIM_OC_DeInit (
DeInitializes the TIM peripheral.
Parameters
Return values
HAL status
Notes
None.
HAL_TIM_OC_MspInit
Function Name
void HAL_TIM_OC_MspInit ( TIM_HandleTypeDef * htim)
Initializes the TIM Output Compare MSP.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
HAL_TIM_OC_MspDeInit
Function Name
void HAL_TIM_OC_MspDeInit ( TIM_HandleTypeDef * htim)
DeInitializes TIM Output Compare MSP.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
HAL_TIM_OC_Start
DocID026525 Rev 1
533/692

Function Name
38.2.28
38.2.29
534/692
UM1785
HAL_StatusTypeDef HAL_TIM_OC_Start ( TIM_HandleTypeDef
* htim, uint32_t Channel)
Starts the TIM Output Compare signal generation.
Parameters

Channel : : TIM Channel to be enabled This parameter can
TIM_CHANNEL_1 TIM Channel 1 selected
Return values
HAL status
Notes
None.
HAL_TIM_OC_Stop
Function Name
HAL_StatusTypeDef HAL_TIM_OC_Stop ( TIM_HandleTypeDef

Stops the TIM Output Compare signal generation.
Parameters
htim : : TIM handle

Channel : : TIM Channel to be disabled This parameter can
Return values
HAL status
Notes
None.
HAL_TIM_OC_Start_IT
Function Name
HAL_StatusTypeDef HAL_TIM_OC_Start_IT (
TIM_HandleTypeDef * htim, uint32_t Channel)
Starts the TIM Output Compare signal generation in interrupt

mode.
DocID026525 Rev 1
UM1785
38.2.30
38.2.31

Parameters
htim : : TIM OC handle

Return values
HAL status
Notes
None.
HAL_TIM_OC_Stop_IT
Function Name
HAL_StatusTypeDef HAL_TIM_OC_Stop_IT (
Stops the TIM Output Compare signal generation in interrupt

mode.
Parameters

Return values
HAL status
Notes
None.
HAL_TIM_OC_Start_DMA
Function Name
HAL_StatusTypeDef HAL_TIM_OC_Start_DMA (
TIM_HandleTypeDef * htim, uint32_t Channel, uint32_t *
pData, uint16_t Length)
Starts the TIM Output Compare signal generation in DMA mode.
Parameters


DocID026525 Rev 1
535/692
UM1785
38.2.32
38.2.33
536/692

to TIM peripheral
Return values
HAL status
Notes
None.
HAL_TIM_OC_Stop_DMA
Function Name
HAL_StatusTypeDef HAL_TIM_OC_Stop_DMA (
Stops the TIM Output Compare signal generation in DMA mode.
Parameters

Return values
HAL status
Notes
None.
HAL_TIM_PWM_Init
Function Name
HAL_StatusTypeDef HAL_TIM_PWM_Init (
Initializes the TIM PWM Time Base according to the specified

handle.
Parameters
htim : : TIM handle
Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
38.2.34
38.2.35
38.2.36
HAL_TIM_PWM_DeInit
Function Name
HAL_StatusTypeDef HAL_TIM_PWM_DeInit (
Parameters
htim : : TIM handle
Return values
HAL status
Notes
None.
HAL_TIM_PWM_MspInit
Function Name
void HAL_TIM_PWM_MspInit ( TIM_HandleTypeDef * htim)
Initializes the TIM PWM MSP.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
HAL_TIM_PWM_MspDeInit
Function Name
void HAL_TIM_PWM_MspDeInit ( TIM_HandleTypeDef * htim)
DeInitializes TIM PWM MSP.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
DocID026525 Rev 1
537/692
38.2.37
38.2.38
38.2.39
538/692
UM1785
HAL_TIM_PWM_Start
Function Name
HAL_StatusTypeDef HAL_TIM_PWM_Start (
Starts the PWM signal generation.
Parameters
htim : : TIM handle

Channel : : TIM Channels to be enabled This parameter can
Return values
HAL status
Notes
None.
HAL_TIM_PWM_Stop
Function Name
HAL_StatusTypeDef HAL_TIM_PWM_Stop (
Stops the PWM signal generation.
Parameters
htim : : TIM handle

Channel : : TIM Channels to be disabled This parameter can
Return values
HAL status
Notes
None.
HAL_TIM_PWM_Start_IT
DocID026525 Rev 1
UM1785
38.2.40
38.2.41
Function Name

HAL_StatusTypeDef HAL_TIM_PWM_Start_IT (
Starts the PWM signal generation in interrupt mode.
Parameters
htim : : TIM handle

Return values
HAL status
Notes
None.
HAL_TIM_PWM_Stop_IT
Function Name
HAL_StatusTypeDef HAL_TIM_PWM_Stop_IT (
Stops the PWM signal generation in interrupt mode.
Parameters
htim : : TIM handle

Return values
HAL status
Notes
None.
HAL_TIM_PWM_Start_DMA
Function Name
HAL_StatusTypeDef HAL_TIM_PWM_Start_DMA (
Starts the TIM PWM signal generation in DMA mode.
DocID026525 Rev 1
539/692

Parameters
UM1785
38.2.42
38.2.43
540/692
htim : : TIM handle


to TIM peripheral
Return values
HAL status
Notes
None.
HAL_TIM_PWM_Stop_DMA
Function Name
HAL_StatusTypeDef HAL_TIM_PWM_Stop_DMA (
Stops the TIM PWM signal generation in DMA mode.
Parameters
htim : : TIM handle

Return values
HAL status
Notes
None.
HAL_TIM_IC_Init
Function Name
HAL_StatusTypeDef HAL_TIM_IC_Init ( TIM_HandleTypeDef *

htim)
Initializes the TIM Input Capture Time base according to the

specified parameters in the TIM_HandleTypeDef and create the
associated handle.
DocID026525 Rev 1
UM1785
38.2.44
38.2.45
38.2.46

Parameters
htim : : TIM Input Capture handle
Return values
HAL status
Notes
None.
HAL_TIM_IC_DeInit
Function Name
HAL_StatusTypeDef HAL_TIM_IC_DeInit ( TIM_HandleTypeDef

* htim)
Parameters
Return values
HAL status
Notes
None.
HAL_TIM_IC_MspInit
Function Name
void HAL_TIM_IC_MspInit ( TIM_HandleTypeDef * htim)
Initializes the TIM Input Capture MSP.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
HAL_TIM_IC_MspDeInit
Function Name
void HAL_TIM_IC_MspDeInit ( TIM_HandleTypeDef * htim)
DeInitializes TIM Input Capture MSP.
Parameters
htim : : TIM handle
DocID026525 Rev 1
541/692

Return values
Notes
38.2.47
38.2.48
542/692
UM1785
None.
None.
HAL_TIM_IC_Start
Function Name
HAL_StatusTypeDef HAL_TIM_IC_Start ( TIM_HandleTypeDef

Starts the TIM Input Capture measurement.
Parameters

Return values
HAL status
Notes
None.
HAL_TIM_IC_Stop
Function Name
HAL_StatusTypeDef HAL_TIM_IC_Stop ( TIM_HandleTypeDef

Stops the TIM Input Capture measurement.
Parameters
htim : : TIM handle

Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
38.2.49
38.2.50
38.2.51
HAL_TIM_IC_Start_IT
Function Name
HAL_StatusTypeDef HAL_TIM_IC_Start_IT (
Starts the TIM Input Capture measurement in interrupt mode.
Parameters

Return values
HAL status
Notes
None.
HAL_TIM_IC_Stop_IT
Function Name
HAL_StatusTypeDef HAL_TIM_IC_Stop_IT (
Stops the TIM Input Capture measurement in interrupt mode.
Parameters
htim : : TIM handle

Return values
HAL status
Notes
None.
HAL_TIM_IC_Start_DMA
DocID026525 Rev 1
543/692

Function Name
UM1785
HAL_StatusTypeDef HAL_TIM_IC_Start_DMA (
Starts the TIM Input Capture measurement in DMA mode.
Parameters
38.2.52
38.2.53
Return values
HAL status
Notes
None.
HAL_TIM_IC_Stop_DMA
Function Name
HAL_StatusTypeDef HAL_TIM_IC_Stop_DMA (
Stops the TIM Input Capture measurement in DMA mode.
Parameters

Return values
HAL status
Notes
None.
HAL_TIM_OnePulse_Init
Function Name
544/692


pData : : The destination Buffer address.
Length : : The length of data to be transferred from TIM
HAL_StatusTypeDef HAL_TIM_OnePulse_Init (
DocID026525 Rev 1
UM1785
38.2.54
38.2.55

TIM_HandleTypeDef * htim, uint32_t OnePulseMode)
Initializes the TIM One Pulse Time Base according to the

specified parameters in the TIM_HandleTypeDef and create the
associated handle.
Parameters
htim : : TIM OnePulse handle

OnePulseMode : : Select the One pulse mode. This
TIM_OPMODE_SINGLE Only one pulse will be

generated.
TIM_OPMODE_REPETITIVE Repetitive pulses wil be

generated.
Return values
HAL status
Notes
None.
HAL_TIM_OnePulse_DeInit
Function Name
HAL_StatusTypeDef HAL_TIM_OnePulse_DeInit (
DeInitializes the TIM One Pulse.
Parameters
htim : : TIM One Pulse handle
Return values
HAL status
Notes
None.
HAL_TIM_OnePulse_MspInit
Function Name
void HAL_TIM_OnePulse_MspInit ( TIM_HandleTypeDef *

htim)
Initializes the TIM One Pulse MSP.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
DocID026525 Rev 1
545/692
38.2.56
38.2.57
38.2.58
546/692
UM1785
HAL_TIM_OnePulse_MspDeInit
Function Name
void HAL_TIM_OnePulse_MspDeInit ( TIM_HandleTypeDef *

htim)
DeInitializes TIM One Pulse MSP.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
HAL_TIM_OnePulse_Start
Function Name
HAL_StatusTypeDef HAL_TIM_OnePulse_Start (
TIM_HandleTypeDef * htim, uint32_t OutputChannel)
Starts the TIM One Pulse signal generation.
Parameters

OutputChannel : : TIM Channels to be enabled This
Return values
HAL status
Notes
None.
HAL_TIM_OnePulse_Stop
Function Name
HAL_StatusTypeDef HAL_TIM_OnePulse_Stop (
Stops the TIM One Pulse signal generation.
Parameters

OutputChannel : : TIM Channels to be disable This

DocID026525 Rev 1
UM1785
38.2.59
38.2.60
Return values
HAL status
Notes
None.
HAL_TIM_OnePulse_Start_IT
Function Name
HAL_StatusTypeDef HAL_TIM_OnePulse_Start_IT (
Starts the TIM One Pulse signal generation in interrupt mode.
Parameters

Return values
HAL status
Notes
None.
HAL_TIM_OnePulse_Stop_IT
Function Name
HAL_StatusTypeDef HAL_TIM_OnePulse_Stop_IT (
Stops the TIM One Pulse signal generation in interrupt mode.
Parameters

Return values
HAL status
Notes
None.
DocID026525 Rev 1
547/692
38.2.61
38.2.62
38.2.63
548/692
UM1785
HAL_TIM_Encoder_Init
Function Name
HAL_StatusTypeDef HAL_TIM_Encoder_Init (
TIM_HandleTypeDef * htim, TIM_Encoder_InitTypeDef *
sConfig)
Initializes the TIM Encoder Interface and create the associated

handle.
Parameters
htim : : TIM Encoder Interface handle

sConfig : : TIM Encoder Interface configuration structure
Return values
HAL status
Notes
None.
HAL_TIM_Encoder_DeInit
Function Name
HAL_StatusTypeDef HAL_TIM_Encoder_DeInit (
DeInitializes the TIM Encoder interface.
Parameters
htim : : TIM Encoder handle
Return values
HAL status
Notes
None.
HAL_TIM_Encoder_MspInit
Function Name
void HAL_TIM_Encoder_MspInit ( TIM_HandleTypeDef * htim)
Initializes the TIM Encoder Interface MSP.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
DocID026525 Rev 1
UM1785
38.2.64
38.2.65
38.2.66
HAL_TIM_Encoder_MspDeInit
Function Name
void HAL_TIM_Encoder_MspDeInit ( TIM_HandleTypeDef *

htim)
DeInitializes TIM Encoder Interface MSP.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
HAL_TIM_Encoder_Start
Function Name
HAL_StatusTypeDef HAL_TIM_Encoder_Start (
Starts the TIM Encoder Interface.
Parameters

Return values
HAL status
Notes
None.
HAL_TIM_Encoder_Stop
Function Name
HAL_StatusTypeDef HAL_TIM_Encoder_Stop (
Stops the TIM Encoder Interface.
Parameters


DocID026525 Rev 1
549/692
UM1785
38.2.67
38.2.68
550/692
Return values
HAL status
Notes
None.
HAL_TIM_Encoder_Start_IT
Function Name
HAL_StatusTypeDef HAL_TIM_Encoder_Start_IT (
Starts the TIM Encoder Interface in interrupt mode.
Parameters

Return values
HAL status
Notes
None.
HAL_TIM_Encoder_Stop_IT
Function Name
HAL_StatusTypeDef HAL_TIM_Encoder_Stop_IT (
Stops the TIM Encoder Interface in interrupt mode.
Parameters

Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
38.2.69
HAL_TIM_Encoder_Start_DMA
Function Name
HAL_StatusTypeDef HAL_TIM_Encoder_Start_DMA (
pData1, uint32_t * pData2, uint16_t Length)
Starts the TIM Encoder Interface in DMA mode.
Parameters
38.2.70
38.2.71


pData1 : : The destination Buffer address for IC1.
pData2 : : The destination Buffer address for IC2.
Return values
HAL status
Notes
None.
HAL_TIM_Encoder_Stop_DMA
Function Name
HAL_StatusTypeDef HAL_TIM_Encoder_Stop_DMA (
Stops the TIM Encoder Interface in DMA mode.
Parameters

Return values
HAL status
Notes
None.
HAL_TIM_IRQHandler
DocID026525 Rev 1
551/692

Function Name
38.2.72
38.2.73
552/692
UM1785
void HAL_TIM_IRQHandler ( TIM_HandleTypeDef * htim)
This function handles TIM interrupts requests.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
HAL_TIM_OC_ConfigChannel
Function Name
HAL_StatusTypeDef HAL_TIM_OC_ConfigChannel (
TIM_HandleTypeDef * htim, TIM_OC_InitTypeDef * sConfig,
uint32_t Channel)
Initializes the TIM Output Compare Channels according to the

specified parameters in the TIM_OC_InitTypeDef.
Parameters

sConfig : : TIM Output Compare configuration structure
Return values
HAL status
Notes
None.
HAL_TIM_IC_ConfigChannel
Function Name
HAL_StatusTypeDef HAL_TIM_IC_ConfigChannel (
TIM_HandleTypeDef * htim, TIM_IC_InitTypeDef * sConfig,
uint32_t Channel)
Initializes the TIM Input Capture Channels according to the

specified parameters in the TIM_IC_InitTypeDef.
Parameters
htim : : TIM IC handle

sConfig : : TIM Input Capture configuration structure
DocID026525 Rev 1
UM1785
38.2.74
38.2.75

Return values
HAL status
Notes
None.
HAL_TIM_PWM_ConfigChannel
Function Name
HAL_StatusTypeDef HAL_TIM_PWM_ConfigChannel (
TIM_HandleTypeDef * htim, TIM_OC_InitTypeDef * sConfig,
uint32_t Channel)
Initializes the TIM PWM channels according to the specified

parameters in the TIM_OC_InitTypeDef.
Parameters
htim : : TIM handle

sConfig : : TIM PWM configuration structure
Return values
HAL status
Notes
None.
HAL_TIM_OnePulse_ConfigChannel
Function Name
HAL_StatusTypeDef HAL_TIM_OnePulse_ConfigChannel (
TIM_HandleTypeDef * htim, TIM_OnePulse_InitTypeDef *
sConfig, uint32_t OutputChannel, uint32_t InputChannel)
Initializes the TIM One Pulse Channels according to the specified

parameters in the TIM_OnePulse_InitTypeDef.
Parameters

sConfig : : TIM One Pulse configuration structure
DocID026525 Rev 1
553/692
UM1785
38.2.76
Return values
HAL status
Notes
None.
HAL_TIM_DMABurst_WriteStart
Function Name
HAL_StatusTypeDef HAL_TIM_DMABurst_WriteStart (
TIM_HandleTypeDef * htim, uint32_t BurstBaseAddress,
uint32_t BurstRequestSrc, uint32_t * BurstBuffer, uint32_t
BurstLength)
Configure the DMA Burst to transfer Data from the memory to the
TIM peripheral.
Parameters
554/692

InputChannel : : TIM Channels to be enabled This
htim : : TIM handle

BurstBaseAddress : : TIM Base address from where the
DMA will start the Data write This parameter can be one of
TIM_DMABase_CR1
TIM_DMABase_CR2
TIM_DMABase_SMCR
TIM_DMABase_DIER
TIM_DMABase_SR
TIM_DMABase_EGR
TIM_DMABase_CCMR1
TIM_DMABase_CCMR2
TIM_DMABase_CCER
TIM_DMABase_CNT
TIM_DMABase_PSC
TIM_DMABase_ARR
TIM_DMABase_RCR
TIM_DMABase_CCR1
TIM_DMABase_CCR2
TIM_DMABase_CCR3
TIM_DMABase_CCR4
TIM_DMABase_BDTR
TIM_DMABase_DCR
BurstRequestSrc : : TIM DMA Request sources This
TIM_DMA_UPDATE TIM update Interrupt source
TIM_DMA_CC1 TIM Capture Compare 1 DMA source

DocID026525 Rev 1
UM1785
38.2.77
38.2.78
TIM_DMA_COM TIM Commutation DMA source
TIM_DMA_TRIGGER TIM Trigger DMA source

BurstBuffer : : The Buffer address.
BurstLength : : DMA Burst length. This parameter can be
one value between: TIM_DMABurstLength_1Transfer and
TIM_DMABurstLength_18Transfers.
Return values
HAL status
Notes
None.
HAL_TIM_DMABurst_WriteStop
Function Name
HAL_StatusTypeDef HAL_TIM_DMABurst_WriteStop (
TIM_HandleTypeDef * htim, uint32_t BurstRequestSrc)
Stops the TIM DMA Burst mode.
Parameters
htim : : TIM handle

BurstRequestSrc : : TIM DMA Request sources to disable
Return values
HAL status
Notes
None.
HAL_TIM_DMABurst_ReadStart
Function Name
HAL_StatusTypeDef HAL_TIM_DMABurst_ReadStart (
TIM_HandleTypeDef * htim, uint32_t BurstBaseAddress,
uint32_t BurstRequestSrc, uint32_t * BurstBuffer, uint32_t
BurstLength)
Configure the DMA Burst to transfer Data from the TIM peripheral
to the memory.
Parameters
htim : : TIM handle

BurstBaseAddress : : TIM Base address from where the
DMA will starts the Data read This parameter can be one of
TIM_DMABase_CR1
TIM_DMABase_CR2
DocID026525 Rev 1
555/692
UM1785
38.2.79
556/692
TIM_DMABase_SMCR
TIM_DMABase_DIER
TIM_DMABase_SR
TIM_DMABase_EGR
TIM_DMABase_CCMR1
TIM_DMABase_CCMR2
TIM_DMABase_CCER
TIM_DMABase_CNT
TIM_DMABase_PSC
TIM_DMABase_ARR
TIM_DMABase_RCR
TIM_DMABase_CCR1
TIM_DMABase_CCR2
TIM_DMABase_CCR3
TIM_DMABase_CCR4
TIM_DMABase_BDTR
TIM_DMABase_DCR
BurstRequestSrc : : TIM DMA Request sources This
TIM_DMA_UPDATE TIM update Interrupt source
TIM_DMA_COM TIM Commutation DMA source
TIM_DMA_TRIGGER TIM Trigger DMA source

BurstBuffer : : The Buffer address.
BurstLength : : DMA Burst length. This parameter can be
one value between: TIM_DMABurstLength_1Transfer and
TIM_DMABurstLength_18Transfers.
Return values
HAL status
Notes
None.
HAL_TIM_DMABurst_ReadStop
Function Name
HAL_StatusTypeDef HAL_TIM_DMABurst_ReadStop (
TIM_HandleTypeDef * htim, uint32_t BurstRequestSrc)
Stop the DMA burst reading.
Parameters
htim : : TIM handle

BurstRequestSrc : : TIM DMA Request sources to disable.
Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
38.2.80
38.2.81
HAL_TIM_GenerateEvent
Function Name
HAL_StatusTypeDef HAL_TIM_GenerateEvent (
TIM_HandleTypeDef * htim, uint32_t EventSource)
Generate a software event.
Parameters
htim : : TIM handle

EventSource : : specifies the event source. This parameter
TIM_EventSource_Update Timer update Event source
TIM_EventSource_CC1 Timer Capture Compare 1

Event source

Event source

Event source

Event source
TIM_EventSource_COM Timer COM event source
TIM_EventSource_Trigger Timer Trigger Event source
TIM_EventSource_Break Timer Break event source
Return values
HAL status
Notes
TIM6 and TIM7 can only generate an update event.

TIM_EventSource_COM and TIM_EventSource_Break are
used only with TIM1, TIM15, TIM16 and TIM17.
HAL_TIM_ConfigOCrefClear
Function Name
HAL_StatusTypeDef HAL_TIM_ConfigOCrefClear (
TIM_HandleTypeDef * htim, TIM_ClearInputConfigTypeDef *
sClearInputConfig, uint32_t Channel)
Configures the OCRef clear feature.
Parameters
htim : : TIM handle

sClearInputConfig : : pointer to a
TIM_ClearInputConfigTypeDef structure that contains the
OCREF clear feature and parameters for the TIM peripheral.
Channel : : specifies the TIM Channel This parameter can
TIM_Channel_1 TIM Channel 1

DocID026525 Rev 1
557/692
UM1785
38.2.82
38.2.83
558/692

Return values
HAL status
Notes
None.
HAL_TIM_ConfigClockSource
Function Name
HAL_StatusTypeDef HAL_TIM_ConfigClockSource (
TIM_HandleTypeDef * htim, TIM_ClockConfigTypeDef *
sClockSourceConfig)
Configures the clock source to be used.
Parameters
htim : : TIM handle

sClockSourceConfig : : pointer to a
TIM_ClockConfigTypeDef structure that contains the clock
source information for the TIM peripheral.
Return values
HAL status
Notes
None.
HAL_TIM_ConfigTI1Input
Function Name
HAL_StatusTypeDef HAL_TIM_ConfigTI1Input (
TIM_HandleTypeDef * htim, uint32_t TI1_Selection)
Selects the signal connected to the TI1 input: direct from

CH1_input or a XOR combination between CH1_input, CH2_input
& CH3_input.
Parameters
htim : : TIM handle.

TI1_Selection : : Indicate whether or not channel 1 is
connected to the output of a XOR gate. This parameter can
TIM_TI1SELECTION_CH1 The TIMx_CH1 pin is

connected to TI1 input
TIM_TI1SELECTION_XORCOMBINATION The
TIMx_CH1, CH2 and CH3 pins are connected to the TI1
input (XOR combination)
DocID026525 Rev 1
UM1785
38.2.84
38.2.85

Return values
HAL status
Notes
None.
HAL_TIM_SlaveConfigSynchronization
Function Name
HAL_StatusTypeDef HAL_TIM_SlaveConfigSynchronization (
TIM_HandleTypeDef * htim, TIM_SlaveConfigTypeDef *
sSlaveConfig)
Configures the TIM in Slave mode.
Parameters

sSlaveConfig : : pointer to a TIM_SlaveConfigTypeDef
structure that contains the selected trigger (internal trigger
input, filtered timer input or external trigger input) and the )
and the Slave mode (Disable, Reset, Gated, Trigger, External
clock mode 1).
Return values
HAL status
Notes
None.
HAL_TIM_SlaveConfigSynchronization_IT
Function Name
HAL_StatusTypeDef
HAL_TIM_SlaveConfigSynchronization_IT (
TIM_HandleTypeDef * htim, TIM_SlaveConfigTypeDef *
sSlaveConfig)
Configures the TIM in Slave mode in interrupt mode.
Parameters
htim : TIM handle.

sSlaveConfig : pointer to a TIM_SlaveConfigTypeDef
structure that contains the selected trigger (internal trigger
input, filtered timer input or external trigger input) and the )
and the Slave mode (Disable, Reset, Gated, Trigger, External
clock mode 1).
Return values
HAL status
Notes
None.
DocID026525 Rev 1
559/692
38.2.86
38.2.87
38.2.88
560/692
UM1785
HAL_TIM_ReadCapturedValue
Function Name
uint32_t HAL_TIM_ReadCapturedValue ( TIM_HandleTypeDef *

htim, uint32_t Channel)
Read the captured value from Capture Compare unit.
Parameters

Return values
Captured value
Notes
None.
HAL_TIM_PeriodElapsedCallback
Function Name
void HAL_TIM_PeriodElapsedCallback ( TIM_HandleTypeDef *

htim)
Period elapsed callback in non blocking mode.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
HAL_TIM_OC_DelayElapsedCallback
Function Name
void HAL_TIM_OC_DelayElapsedCallback (
Output Compare callback in non blocking mode.
Parameters

DocID026525 Rev 1
UM1785
38.2.89
38.2.90
38.2.91

Return values
None.
Notes
None.
HAL_TIM_IC_CaptureCallback
Function Name
void HAL_TIM_IC_CaptureCallback ( TIM_HandleTypeDef *

htim)
Input Capture callback in non blocking mode.
Parameters
Return values
None.
Notes
None.
HAL_TIM_PWM_PulseFinishedCallback
Function Name
void HAL_TIM_PWM_PulseFinishedCallback (
PWM Pulse finished callback in non blocking mode.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
HAL_TIM_TriggerCallback
Function Name
void HAL_TIM_TriggerCallback ( TIM_HandleTypeDef * htim)
Hall Trigger detection callback in non blocking mode.
Parameters
htim : : TIM handle
Return values
None.
DocID026525 Rev 1
561/692

Notes
38.2.92
38.2.93
38.2.94
562/692
UM1785
None.
HAL_TIM_ErrorCallback
Function Name
void HAL_TIM_ErrorCallback ( TIM_HandleTypeDef * htim)
Timer error callback in non blocking mode.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
HAL_TIM_Base_GetState
Function Name
HAL_TIM_StateTypeDef HAL_TIM_Base_GetState (
Return the TIM Base state.
Parameters
Return values
HAL state
Notes
None.
HAL_TIM_OC_GetState
Function Name
HAL_TIM_StateTypeDef HAL_TIM_OC_GetState (
Return the TIM OC state.
Parameters
htim : : TIM Ouput Compare handle
Return values
HAL state
Notes
None.
DocID026525 Rev 1
UM1785
38.2.95
38.2.96
38.2.97
HAL_TIM_PWM_GetState
Function Name
HAL_TIM_StateTypeDef HAL_TIM_PWM_GetState (
Return the TIM PWM state.
Parameters
htim : : TIM handle
Return values
HAL state
Notes
None.
HAL_TIM_IC_GetState
Function Name
HAL_TIM_StateTypeDef HAL_TIM_IC_GetState (
Return the TIM Input Capture state.
Parameters
Return values
HAL state
Notes
None.
HAL_TIM_OnePulse_GetState
Function Name
HAL_TIM_StateTypeDef HAL_TIM_OnePulse_GetState (
Return the TIM One Pulse Mode state.
Parameters
htim : : TIM OPM handle
Return values
HAL state
Notes
None.
DocID026525 Rev 1
563/692
38.2.98
UM1785
HAL_TIM_Encoder_GetState
Function Name
HAL_TIM_StateTypeDef HAL_TIM_Encoder_GetState (
Return the TIM Encoder Mode state.
Parameters
htim : : TIM Encoder handle
Return values
HAL state
Notes
None.
38.3
TIM Firmware driver defines
38.3.1
TIM
TIM
TIM Automatic Output Enable
TIM_AUTOMATICOUTPUT_ENABLE
TIM_AUTOMATICOUTPUT_DISABLE
IS_TIM_AUTOMATIC_OUTPUT_STATE
TIM Break Input Enable
TIM_BREAK_ENABLE
TIM_BREAK_DISABLE
IS_TIM_BREAK_STATE
TIM Break Input Polarity
TIM_BREAKPOLARITY_LOW
TIM_BREAKPOLARITY_HIGH
IS_TIM_BREAK_POLARITY
TIM Channel
TIM_CHANNEL_1
TIM_CHANNEL_2
TIM_CHANNEL_3
TIM_CHANNEL_4
564/692
DocID026525 Rev 1
UM1785

TIM_CHANNEL_ALL
IS_TIM_CHANNELS
IS_TIM_PWMI_CHANNELS
IS_TIM_OPM_CHANNELS
IS_TIM_COMPLEMENTARY_CHANNELS
TIM Clear Input Filter
IS_TIM_CLEARINPUT_FILTER
TIM Clear Input Polarity
TIM_CLEARINPUTPOLARITY_INVERTED
Polarity for ETRx pin
TIM_CLEARINPUTPOLARITY_NONINVERTED
Polarity for ETRx pin
IS_TIM_CLEARINPUT_POLARITY
TIM Clear Input Prescaler
TIM_CLEARINPUTPRESCALER_DIV1
No prescaler is used
Prescaler for External ETR pin: Capture

performed once every 2 events.


IS_TIM_CLEARINPUT_PRESCALER
TIM ClearInput Source
TIM_CLEARINPUTSOURCE_ETR
TIM_CLEARINPUTSOURCE_NONE
IS_TIM_CLEARINPUT_SOURCE
TIM Clock Division
TIM_CLOCKDIVISION_DIV1
IS_TIM_CLOCKDIVISION_DIV
TIM Clock Filter
IS_TIM_CLOCKFILTER
IS_TIM_DEADTIME
TIM Clock Polarity
TIM_CLOCKPOLARITY_INVERTED
Polarity for ETRx clock sources
TIM_CLOCKPOLARITY_NONINVERTED
Polarity for ETRx clock sources
TIM_CLOCKPOLARITY_RISING
Polarity for TIx clock sources
TIM_CLOCKPOLARITY_FALLING
DocID026525 Rev 1
565/692

TIM_CLOCKPOLARITY_BOTHEDGE
UM1785
IS_TIM_CLOCKPOLARITY
TIM Clock Prescaler
TIM_CLOCKPRESCALER_DIV1
Prescaler for External ETR Clock: Capture performed

once every 2 events.


IS_TIM_CLOCKPRESCALER
TIM Clock Source
TIM_CLOCKSOURCE_ETRMODE2
TIM_CLOCKSOURCE_INTERNAL
TIM_CLOCKSOURCE_ITR0
TIM_CLOCKSOURCE_TI1ED
TIM_CLOCKSOURCE_TI1
TIM_CLOCKSOURCE_TI2
TIM_CLOCKSOURCE_ETRMODE1
IS_TIM_CLOCKSOURCE
TIM Commutation
TIM_COMMUTATION_TRGI
TIM_COMMUTATION_SOFTWARE
TIM Counter Mode
TIM_COUNTERMODE_UP
TIM_COUNTERMODE_DOWN
TIM_COUNTERMODE_CENTERALIGNED1
IS_TIM_COUNTER_MODE
TIM DMA Base address
TIM_DMABase_CR1
TIM_DMABase_CR2
TIM_DMABase_SMCR
566/692
DocID026525 Rev 1
UM1785

TIM_DMABase_DIER
TIM_DMABase_SR
TIM_DMABase_EGR
TIM_DMABase_CCMR1
TIM_DMABase_CCMR2
TIM_DMABase_CCER
TIM_DMABase_CNT
TIM_DMABase_PSC
TIM_DMABase_ARR
TIM_DMABase_RCR
TIM_DMABase_CCR1
TIM_DMABase_CCR2
TIM_DMABase_CCR3
TIM_DMABase_CCR4
TIM_DMABase_BDTR
TIM_DMABase_DCR
TIM_DMABase_OR
IS_TIM_DMA_BASE
TIM DMA Burst Length
TIM_DMABurstLength_1Transfer
TIM_DMABurstLength_2Transfers
DocID026525 Rev 1
567/692

UM1785
IS_TIM_DMA_LENGTH
TIM DMA Handle Index
TIM_DMA_ID_UPDATE
Index of the DMA handle used for Update DMA requests
TIM_DMA_ID_CC1
Index of the DMA handle used for Capture/Compare 1

DMA requests
TIM_DMA_ID_CC2

DMA requests
TIM_DMA_ID_CC3

DMA requests
TIM_DMA_ID_CC4

DMA requests
TIM_DMA_ID_COMMUTATION
Index of the DMA handle used for Commutation DMA

requests
TIM_DMA_ID_TRIGGER
Index of the DMA handle used for Trigger DMA requests
TIM DMA Sources

TIM_DMA_UPDATE
TIM_DMA_CC1
TIM_DMA_CC2
TIM_DMA_CC3
TIM_DMA_CC4
TIM_DMA_COM
TIM_DMA_TRIGGER
IS_TIM_DMA_SOURCE
TIM Encoder Mode
TIM_ENCODERMODE_TI1
TIM_ENCODERMODE_TI2
TIM_ENCODERMODE_TI12
IS_TIM_ENCODER_MODE
TIM ETR Polarity
TIM_ETRPOLARITY_INVERTED
Polarity for ETR source
TIM_ETRPOLARITY_NONINVERTED
Polarity for ETR source
TIM ETR Prescaler

TIM_ETRPRESCALER_DIV1
ETR input source is divided by 2
TIM Event Source
568/692
DocID026525 Rev 1
UM1785

TIM_EventSource_Update
TIM_EventSource_CC1
TIM_EventSource_CC2
TIM_EventSource_CC3
TIM_EventSource_CC4
TIM_EventSource_COM
TIM_EventSource_Trigger
TIM_EventSource_Break
IS_TIM_EVENT_SOURCE
TIM Exported Macros
__HAL_TIM_RESET_HANDLE_STATE
Description:
Reset TIM handle state.
Parameters:
__HANDLE__: TIM handle.
Return value:
None:
Description:
__HAL_TIM_ENABLE
Enable the TIM peripheral.
Parameters:
__HANDLE__: TIM handle
Return value:
None:
Description:
__HAL_TIM_MOE_ENABLE
Enable the TIM main Output.
Parameters:
Return value:
None:
Description:
__HAL_TIM_DISABLE
Disable the TIM peripheral.
Parameters:
Return value:
__HAL_TIM_MOE_DISABLE
None:
Description:
Disable the TIM main Output.
DocID026525 Rev 1
569/692
UM1785
Parameters:
Return value:
None:
__HAL_TIM_ENABLE_IT
__HAL_TIM_ENABLE_DMA
__HAL_TIM_DISABLE_IT
__HAL_TIM_DISABLE_DMA
__HAL_TIM_GET_FLAG
__HAL_TIM_CLEAR_FLAG
__HAL_TIM_GET_ITSTATUS
__HAL_TIM_CLEAR_IT
__HAL_TIM_DIRECTION_STATUS
__HAL_TIM_PRESCALER
__HAL_TIM_SetICPrescalerValue
__HAL_TIM_ResetICPrescalerValue
__HAL_TIM_SetCompare
Description:
Sets the TIM Capture Compare Register

value on runtime without calling another
time ConfigChannel function.
Parameters:

__CHANNEL__: : TIM Channels to be
configured. This parameter can be one of
TIM_CHANNEL_1: TIM Channel 1

selected

selected

selected

selected
__COMPARE__: specifies the Capture
Compare register new value.
Return value:
__HAL_TIM_GetCompare
None:
Description:
Gets the TIM Capture Compare Register

value on runtime.
Parameters:
570/692
DocID026525 Rev 1
UM1785
__CHANNEL__: : TIM Channel associated

with the capture compare register This
values:
TIM_CHANNEL_1: get
capture/compare 1 register value
TIM_CHANNEL_2: get
TIM_CHANNEL_3: get
TIM_CHANNEL_4: get
Return value:
__HAL_TIM_SetCounter
None:
Description:
Sets the TIM Counter Register value on

runtime.
Parameters:

__COUNTER__: specifies the Counter
register new value.
Return value:
__HAL_TIM_GetCounter
None:
Description:
Gets the TIM Counter Register value on

runtime.
Parameters:
Return value:
__HAL_TIM_SetAutoreload
None:
Description:
Sets the TIM Autoreload Register value on

runtime without calling another time any Init
function.
Parameters:

__AUTORELOAD__: specifies the Counter
register new value.
Return value:
__HAL_TIM_GetAutoreload
None:
Description:
Gets the TIM Autoreload Register value on
DocID026525 Rev 1
571/692
UM1785
runtime.
Parameters:
Return value:
__HAL_TIM_SetClockDivision
None:
Description:
Sets the TIM Clock Division value on

runtime without calling another time any Init
function.
Parameters:

__CKD__: specifies the clock division
value. This parameter can be one of the
following value:
Return value:
__HAL_TIM_GetClockDivision
None:
Description:
Gets the TIM Clock Division value on

runtime.
Parameters:
Return value:
__HAL_TIM_SetICPrescaler
None:
Description:
Sets the TIM Input Capture prescaler on

runtime without calling another time
Parameters:
572/692

__CHANNEL__: : TIM Channels to be

selected

selected

selected

selected
__ICPSC__: specifies the Input Capture4
prescaler new value. This parameter can be
DocID026525 Rev 1
UM1785

TIM_ICPSC_DIV1: no prescaler
TIM_ICPSC_DIV2: capture is done

once every 2 events

once every 4 events

once every 8 events
Return value:
__HAL_TIM_GetICPrescaler
None:
Description:
Gets the TIM Input Capture prescaler on

runtime.
Parameters:

__CHANNEL__: TIM Channels to be
TIM_CHANNEL_1: get input capture 1

prescaler value

prescaler value

prescaler value

prescaler value
Return value:
__HAL_TIM_URS_ENABLE
None:
Description:
Set the Update Request Source (URS) bit

of the TIMx_CR1 register.
Parameters:
Return value:
__HAL_TIM_URS_DISABLE
None:
Description:
Reset the Update Request Source (URS)

bit of the TIMx_CR1 register.
Parameters:
Return value:
None:
TIM Flag Definition

DocID026525 Rev 1
573/692

TIM_FLAG_UPDATE
UM1785
TIM_FLAG_CC1
TIM_FLAG_CC2
TIM_FLAG_CC3
TIM_FLAG_CC4
TIM_FLAG_COM
TIM_FLAG_TRIGGER
TIM_FLAG_BREAK
TIM_FLAG_CC1OF
TIM_FLAG_CC2OF
TIM_FLAG_CC3OF
TIM_FLAG_CC4OF
IS_TIM_FLAG
TIM Input Capture Value
IS_TIM_IC_FILTER
TIM Input Capture Polarity
TIM_ICPOLARITY_RISING
TIM_ICPOLARITY_FALLING
TIM_ICPOLARITY_BOTHEDGE
IS_TIM_IC_POLARITY
TIM Input Capture Prescaler
TIM_ICPSC_DIV1
Capture performed each time an edge is detected on the

capture input
TIM_ICPSC_DIV2
Capture performed once every 2 events
TIM_ICPSC_DIV4
TIM_ICPSC_DIV8
IS_TIM_IC_PRESCALER
TIM Input Capture Selection
TIM_ICSELECTION_DIRECTTI
TIM Input 1, 2, 3 or 4 is selected to be connected to

IC1, IC2, IC3 or IC4, respectively
TIM_ICSELECTION_INDIRECTTI

IC2, IC1, IC4 or IC3, respectively
TIM_ICSELECTION_TRC

TRC
IS_TIM_IC_SELECTION
TIM Input Channel polarity
574/692
TIM_INPUTCHANNELPOLARITY_RISING
Polarity for TIx source
TIM_INPUTCHANNELPOLARITY_FALLING
DocID026525 Rev 1
UM1785
TIM_INPUTCHANNELPOLARITY_BOTHEDGE

TIM interrupt Definition

TIM_IT_UPDATE
TIM_IT_CC1
TIM_IT_CC2
TIM_IT_CC3
TIM_IT_CC4
TIM_IT_COM
TIM_IT_TRIGGER
TIM_IT_BREAK
TIM Lock Configuration
TIM_LOCKLEVEL_OFF
TIM_LOCKLEVEL_1
TIM_LOCKLEVEL_2
TIM_LOCKLEVEL_3
IS_TIM_LOCK_LEVEL
TIM Master Mode Selection
TIM_TRGO_RESET
TIM_TRGO_ENABLE
TIM_TRGO_UPDATE
TIM_TRGO_OC1
TIM_TRGO_OC1REF
TIM_TRGO_OC2REF
TIM_TRGO_OC3REF
TIM_TRGO_OC4REF
IS_TIM_TRGO_SOURCE
TIM Master/Slave Mode
TIM_MASTERSLAVEMODE_ENABLE
TIM_MASTERSLAVEMODE_DISABLE
IS_TIM_MSM_STATE
TIM One Pulse Mode
TIM_OPMODE_SINGLE
TIM_OPMODE_REPETITIVE
IS_TIM_OPM_MODE
TIM Off-state Selection for Idle Mode
TIM_OSSI_ENABLE
DocID026525 Rev 1
575/692

TIM_OSSI_DISABLE
UM1785
IS_TIM_OSSI_STATE
TIM Off-state Selection for Run Mode
TIM_OSSR_ENABLE
TIM_OSSR_DISABLE
IS_TIM_OSSR_STATE
TIM Output Compare & PWM modes
TIM_OCMODE_TIMING
TIM_OCMODE_ACTIVE
TIM_OCMODE_INACTIVE
TIM_OCMODE_TOGGLE
TIM_OCMODE_PWM1
TIM_OCMODE_PWM2
TIM_OCMODE_FORCED_ACTIVE
TIM_OCMODE_FORCED_INACTIVE
IS_TIM_PWM_MODE
IS_TIM_OC_MODE
TIM Output Compare Idle State
TIM_OCIDLESTATE_SET
TIM_OCIDLESTATE_RESET
IS_TIM_OCIDLE_STATE
TIM Complementary Output Compare Idle State
TIM_OCNIDLESTATE_SET
TIM_OCNIDLESTATE_RESET
IS_TIM_OCNIDLE_STATE
TIM Complementary Output Compare Polarity
TIM_OCNPOLARITY_HIGH
TIM_OCNPOLARITY_LOW
IS_TIM_OCN_POLARITY
TIM Complementary Output Compare State
TIM_OUTPUTNSTATE_DISABLE
TIM_OUTPUTNSTATE_ENABLE
IS_TIM_OUTPUTN_STATE
TIM Output Compare Polarity
TIM_OCPOLARITY_HIGH
TIM_OCPOLARITY_LOW
576/692
DocID026525 Rev 1
UM1785

IS_TIM_OC_POLARITY
TIM Output Compare State
TIM_OUTPUTSTATE_DISABLE
TIM_OUTPUTSTATE_ENABLE
IS_TIM_OUTPUT_STATE
TIM Output Fast State
TIM_OCFAST_DISABLE
TIM_OCFAST_ENABLE
IS_TIM_FAST_STATE
TIM Private Macros
CCER_CCxE_MASK
CCER_CCxNE_MASK
TIM Slave Mode
TIM_SLAVEMODE_DISABLE
TIM_SLAVEMODE_RESET
TIM_SLAVEMODE_GATED
TIM_SLAVEMODE_TRIGGER
TIM_SLAVEMODE_EXTERNAL1
IS_TIM_SLAVE_MODE
TIM TI1 Input Selection
TIM_TI1SELECTION_CH1
TIM_TI1SELECTION_XORCOMBINATION
IS_TIM_TI1SELECTION
TIM Trigger Filter
IS_TIM_TRIGGERFILTER
TIM Trigger Polarity
TIM_TRIGGERPOLARITY_INVERTED
Polarity for ETRx trigger sources
TIM_TRIGGERPOLARITY_NONINVERTED
Polarity for ETRx trigger sources
TIM_TRIGGERPOLARITY_RISING
Polarity for TIxFPx or TI1_ED trigger

sources
TIM_TRIGGERPOLARITY_FALLING

sources
TIM_TRIGGERPOLARITY_BOTHEDGE

sources
IS_TIM_TRIGGERPOLARITY
TIM Trigger Prescaler
TIM_TRIGGERPRESCALER_DIV1
DocID026525 Rev 1
577/692

UM1785
Prescaler for External ETR Trigger: Capture


IS_TIM_TRIGGERPRESCALER
TIM Trigger Selection
TIM_TS_ITR0
TIM_TS_ITR1
TIM_TS_ITR2
TIM_TS_ITR3
TIM_TS_TI1F_ED
TIM_TS_TI1FP1
TIM_TS_TI2FP2
TIM_TS_ETRF
TIM_TS_NONE
IS_TIM_TRIGGER_SELECTION
IS_TIM_INTERNAL_TRIGGER_SELECTION
IS_TIM_INTERNAL_TRIGGEREVENT_SELECTION
578/692
DocID026525 Rev 1
UM1785
HAL TIM Extension Driver
39
39.1
TIMEx Firmware driver registers structures
39.1.1
TIM_HallSensor_InitTypeDef
TIM_HallSensor_InitTypeDef is defined in the stm32f0xx_hal_tim_ex.h
Data Fields
uint32_t IC1Filter
uint32_t Commutation_Delay
Field Documentation
39.1.2
uint32_t TIM_HallSensor_InitTypeDef::IC1Polarity Specifies the active edge of the

uint32_t TIM_HallSensor_InitTypeDef::IC1Prescaler Specifies the Input Capture
uint32_t TIM_HallSensor_InitTypeDef::IC1Filter Specifies the input capture filter.
This parameter can be a number between Min_Data = 0x0 and Max_Data = 0xF
uint32_t TIM_HallSensor_InitTypeDef::Commutation_Delay Specifies the pulse
value to be loaded into the Capture Compare Register. This parameter can be a
number between Min_Data = 0x0000 and Max_Data = 0xFFFF
TIM_MasterConfigTypeDef
TIM_MasterConfigTypeDef is defined in the stm32f0xx_hal_tim_ex.h
Data Fields
uint32_t MasterOutputTrigger
uint32_t MasterSlaveMode
Field Documentation
39.1.3
uint32_t TIM_MasterConfigTypeDef::MasterOutputTrigger Trigger output (TRGO)

selection This parameter can be a value of TIM_Master_Mode_Selection
uint32_t TIM_MasterConfigTypeDef::MasterSlaveMode Master/slave mode
selection This parameter can be a value of TIM_Master_Slave_Mode
TIM_BreakDeadTimeConfigTypeDef
TIM_BreakDeadTimeConfigTypeDef is defined in the stm32f0xx_hal_tim_ex.h
Data Fields
uint32_t OffStateRunMode
uint32_t OffStateIDLEMode
DocID026525 Rev 1
579/692
UM1785
uint32_t LockLevel
uint32_t DeadTime
uint32_t BreakState
uint32_t BreakPolarity
uint32_t AutomaticOutput
Field Documentation
39.2
uint32_t TIM_BreakDeadTimeConfigTypeDef::OffStateRunMode TIM off state in

run mode This parameter can be a value of
TIM_OSSR_Off_State_Selection_for_Run_mode_state
uint32_t TIM_BreakDeadTimeConfigTypeDef::OffStateIDLEMode TIM off state in
IDLE mode This parameter can be a value of
TIM_OSSI_Off_State_Selection_for_Idle_mode_state
uint32_t TIM_BreakDeadTimeConfigTypeDef::LockLevel TIM Lock level This
parameter can be a value of TIM_Lock_level
uint32_t TIM_BreakDeadTimeConfigTypeDef::DeadTime TIM dead Time This
parameter can be a number between Min_Data = 0x00 and Max_Data = 0xFF
uint32_t TIM_BreakDeadTimeConfigTypeDef::BreakState TIM Break State This
parameter can be a value of TIM_Break_Input_enable_disable
uint32_t TIM_BreakDeadTimeConfigTypeDef::BreakPolarity TIM Break input
polarity This parameter can be a value of TIM_Break_Polarity
uint32_t TIM_BreakDeadTimeConfigTypeDef::AutomaticOutput TIM Automatic
Output Enable state This parameter can be a value of TIM_AOE_Bit_Set_Reset
TIMEx Firmware driver API description

The following section lists the various functions of the TIMEx library.
39.2.1
TIMER Extended features

The Timer Extended features include:
1.
2.
3.
4.
39.2.2
1.
580/692
Complementary outputs with programmable dead-time for :
Output Compare
PWM generation (Edge and Center-aligned Mode)
One-pulse mode output

Synchronization circuit to control the timer with external signals and to interconnect
several timers together.
Break input to put the timer output signals in reset state or in a known state.
Supports incremental (quadrature) encoder and hall-sensor circuitry for positioning
purposes
Initialize the TIM low level resources by implementing the following functions
depending from feature used :
Complementary Output Compare : HAL_TIM_OC_MspInit()
Complementary PWM generation : HAL_TIM_PWM_MspInit()

DocID026525 Rev 1
UM1785
2.
3.
4.
5.
39.2.3
Complementary One-pulse mode output : HAL_TIM_OnePulse_MspInit()
Hall Sensor output : HAL_TIM_HallSensor_MspInit()

Initialize the TIM low level resources :
a.
Enable the TIM interface clock using __TIMx_CLK_ENABLE();
b.
TIM pins configuration
Enable the clock for the TIM GPIOs using the following function:
Configure these TIM pins in Alternate function mode using

HAL_GPIO_Init();
The external Clock can be configured, if needed (the default clock is the internal clock
from the APBx), using the following function: HAL_TIM_ConfigClockSource, the clock
configuration should be done before any start function.
Configure the TIM in the desired functioning mode using one of the initialization
function of this driver:
HAL_TIMEx_HallSensor_Init and HAL_TIMEx_ConfigCommutationEvent: to use

the Timer Hall Sensor Interface and the commutation event with the
corresponding Interrupt and DMA request if needed (Note that One Timer is used
to interface with the Hall sensor Interface and another Timer should be used to
use the commutation event).
Activate the TIM peripheral using one of the start functions:
Complementary Output Compare : HAL_TIMEx_OCN_Start(),

HAL_TIMEx_OCN_Start_DMA(), HAL_TIMEx_OCN_Start_IT()
Complementary PWM generation : HAL_TIMEx_PWMN_Start(),

HAL_TIMEx_PWMN_Start_DMA(), HAL_TIMEx_PWMN_Start_IT()
Complementary One-pulse mode output : HAL_TIMEx_OnePulseN_Start(),

HAL_TIMEx_OnePulseN_Start_IT()
Hall Sensor output : HAL_TIMEx_HallSensor_Start(),

HAL_TIMEx_HallSensor_Start_DMA(), HAL_TIMEx_HallSensor_Start_IT().
Timer Hall Sensor functions

Initialize and configure TIM HAL Sensor.

De-initialize TIM HAL Sensor.
Start the Hall Sensor Interface.
Stop the Hall Sensor Interface.
Start the Hall Sensor Interface and enable interrupts.
Stop the Hall Sensor Interface and disable interrupts.
Start the Hall Sensor Interface and enable DMA transfers.
Stop the Hall Sensor Interface and disable DMA transfers.
HAL_TIMEx_HallSensor_Init()
HAL_TIMEx_HallSensor_DeInit()
HAL_TIMEx_HallSensor_MspInit()
HAL_TIMEx_HallSensor_MspDeInit()
HAL_TIMEx_HallSensor_Start()
HAL_TIMEx_HallSensor_Stop()
HAL_TIMEx_HallSensor_Start_IT()
HAL_TIMEx_HallSensor_Stop_IT()
HAL_TIMEx_HallSensor_Start_DMA()
HAL_TIMEx_HallSensor_Stop_DMA()
DocID026525 Rev 1
581/692
39.2.4
UM1785
Timer Complementary Output Compare functions

39.2.5
Start the Complementary Output Compare/PWM.

Stop the Complementary Output Compare/PWM.
Start the Complementary Output Compare/PWM and enable interrupts.
Stop the Complementary Output Compare/PWM and disable interrupts.
Start the Complementary Output Compare/PWM and enable DMA transfers.
Stop the Complementary Output Compare/PWM and disable DMA transfers.
HAL_TIMEx_OCN_Start()
HAL_TIMEx_OCN_Stop()
HAL_TIMEx_OCN_Start_IT()
HAL_TIMEx_OCN_Stop_IT()
HAL_TIMEx_OCN_Start_DMA()
HAL_TIMEx_OCN_Stop_DMA()
Timer Complementary PWM functions

39.2.6
Start the Complementary PWM.

Stop the Complementary PWM.
Start the Complementary PWM and enable interrupts.
Stop the Complementary PWM and disable interrupts.
Start the Complementary PWM and enable DMA transfers.
Stop the Complementary PWM and disable DMA transfers.
Start the Complementary Input Capture measurement.
Stop the Complementary Input Capture.
Start the Complementary Input Capture and enable interrupts.
Stop the Complementary Input Capture and disable interrupts.
Start the Complementary Input Capture and enable DMA transfers.
Stop the Complementary Input Capture and disable DMA transfers.
Start the Complementary One Pulse generation.
Stop the Complementary One Pulse.
Start the Complementary One Pulse and enable interrupts.
Stop the Complementary One Pulse and disable interrupts.
HAL_TIMEx_PWMN_Start()
HAL_TIMEx_PWMN_Stop()
HAL_TIMEx_PWMN_Start_IT()
HAL_TIMEx_PWMN_Stop_IT()
HAL_TIMEx_PWMN_Start_DMA()
HAL_TIMEx_PWMN_Stop_DMA()
Timer Complementary One Pulse functions

582/692
Start the Complementary One Pulse generation.

Stop the Complementary One Pulse.
Start the Complementary One Pulse and enable interrupts.
DocID026525 Rev 1
UM1785
39.2.7
Stop the Complementary One Pulse and disable interrupts.

HAL_TIMEx_OnePulseN_Start()
HAL_TIMEx_OnePulseN_Stop()
HAL_TIMEx_OnePulseN_Start_IT()
HAL_TIMEx_OnePulseN_Stop_IT()

39.2.8
39.2.9
Configure the commutation event in case of use of the Hall sensor interface.
Configure Complementary channels, break features and dead time.
Configure Master synchronization.
Configure timer remapping capabilities.
HAL_TIMEx_ConfigCommutationEvent()
HAL_TIMEx_ConfigCommutationEvent_IT()
HAL_TIMEx_ConfigCommutationEvent_DMA()
HAL_TIMEx_MasterConfigSynchronization()
HAL_TIMEx_ConfigBreakDeadTime()
HAL_TIMEx_RemapConfig()
HAL_TIMEx_HallSensor_Init
Function Name
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Init (
TIM_HandleTypeDef * htim, TIM_HallSensor_InitTypeDef *
sConfig)
Initializes the TIM Hall Sensor Interface and create the associated
handle.
Parameters

sConfig : : TIM Hall Sensor configuration structure
Return values
HAL status
Notes
None.
HAL_TIMEx_HallSensor_DeInit
Function Name
HAL_StatusTypeDef HAL_TIMEx_HallSensor_DeInit (
DeInitializes the TIM Hall Sensor interface.
Parameters
htim : : TIM Hall Sensor handle
Return values
HAL status
DocID026525 Rev 1
583/692

Notes
39.2.10
39.2.11
39.2.12
584/692
UM1785
None.
HAL_TIMEx_HallSensor_MspInit
Function Name
void HAL_TIMEx_HallSensor_MspInit ( TIM_HandleTypeDef *

htim)
Initializes the TIM Hall Sensor MSP.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
HAL_TIMEx_HallSensor_MspDeInit
Function Name
void HAL_TIMEx_HallSensor_MspDeInit ( TIM_HandleTypeDef

* htim)
DeInitializes TIM Hall Sensor MSP.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
HAL_TIMEx_HallSensor_Start
Function Name
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start (
Starts the TIM Hall Sensor Interface.
Parameters
Return values
HAL status
DocID026525 Rev 1
UM1785

Notes
39.2.13
39.2.14
39.2.15
None.
HAL_TIMEx_HallSensor_Stop
Function Name
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop (
Stops the TIM Hall sensor Interface.
Parameters
Return values
HAL status
Notes
None.
HAL_TIMEx_HallSensor_Start_IT
Function Name
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start_IT (
Starts the TIM Hall Sensor Interface in interrupt mode.
Parameters
Return values
HAL status
Notes
None.
HAL_TIMEx_HallSensor_Stop_IT
Function Name
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_IT (
Stops the TIM Hall Sensor Interface in interrupt mode.
Parameters
htim : : TIM handle
Return values
HAL status
DocID026525 Rev 1
585/692

Notes
39.2.16
39.2.17
39.2.18
586/692
UM1785
None.
HAL_TIMEx_HallSensor_Start_DMA
Function Name
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start_DMA (
TIM_HandleTypeDef * htim, uint32_t * pData, uint16_t Length)
Starts the TIM Hall Sensor Interface in DMA mode.
Parameters

pData : : The destination Buffer address.
Return values
HAL status
Notes
None.
HAL_TIMEx_HallSensor_Stop_DMA
Function Name
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_DMA (
Stops the TIM Hall Sensor Interface in DMA mode.
Parameters
htim : : TIM handle
Return values
HAL status
Notes
None.
HAL_TIMEx_OCN_Start
Function Name
HAL_StatusTypeDef HAL_TIMEx_OCN_Start (
Starts the TIM Output Compare signal generation on the
DocID026525 Rev 1
UM1785

complementary output.
39.2.19
39.2.20
Parameters

Return values
HAL status
Notes
None.
HAL_TIMEx_OCN_Stop
Function Name
HAL_StatusTypeDef HAL_TIMEx_OCN_Stop (
Stops the TIM Output Compare signal generation on the

Parameters
htim : : TIM handle

Return values
HAL status
Notes
None.
HAL_TIMEx_OCN_Start_IT
Function Name
HAL_StatusTypeDef HAL_TIMEx_OCN_Start_IT (
Starts the TIM Output Compare signal generation in interrupt

mode on the complementary output.
Parameters

DocID026525 Rev 1
587/692
UM1785
39.2.21
39.2.22
588/692
Return values
HAL status
Notes
None.
HAL_TIMEx_OCN_Stop_IT
Function Name
HAL_StatusTypeDef HAL_TIMEx_OCN_Stop_IT (
Stops the TIM Output Compare signal generation in interrupt

mode on the complementary output.
Parameters

Return values
HAL status
Notes
None.
HAL_TIMEx_OCN_Start_DMA
Function Name
HAL_StatusTypeDef HAL_TIMEx_OCN_Start_DMA (
Starts the TIM Output Compare signal generation in DMA mode

on the complementary output.
Parameters


DocID026525 Rev 1
UM1785
39.2.23
39.2.24

to TIM peripheral
Return values
HAL status
Notes
None.
HAL_TIMEx_OCN_Stop_DMA
Function Name
HAL_StatusTypeDef HAL_TIMEx_OCN_Stop_DMA (
Stops the TIM Output Compare signal generation in DMA mode

on the complementary output.
Parameters

Return values
HAL status
Notes
None.
HAL_TIMEx_PWMN_Start
Function Name
HAL_StatusTypeDef HAL_TIMEx_PWMN_Start (
Starts the PWM signal generation on the complementary output.
Parameters
htim : : TIM handle

DocID026525 Rev 1
589/692
UM1785
39.2.25
39.2.26
590/692
Return values
HAL status
Notes
None.
HAL_TIMEx_PWMN_Stop
Function Name
HAL_StatusTypeDef HAL_TIMEx_PWMN_Stop (
Stops the PWM signal generation on the complementary output.
Parameters
htim : : TIM handle

Return values
HAL status
Notes
None.
HAL_TIMEx_PWMN_Start_IT
Function Name
HAL_StatusTypeDef HAL_TIMEx_PWMN_Start_IT (
Starts the PWM signal generation in interrupt mode on the

Parameters
htim : : TIM handle

Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
39.2.27
39.2.28
HAL_TIMEx_PWMN_Stop_IT
Function Name
HAL_StatusTypeDef HAL_TIMEx_PWMN_Stop_IT (
Stops the PWM signal generation in interrupt mode on the

Parameters
htim : : TIM handle

Return values
HAL status
Notes
None.
HAL_TIMEx_PWMN_Start_DMA
Function Name
HAL_StatusTypeDef HAL_TIMEx_PWMN_Start_DMA (
Starts the TIM PWM signal generation in DMA mode on the

Parameters
htim : : TIM handle


to TIM peripheral
Return values
HAL status
Notes
None.
DocID026525 Rev 1
591/692
39.2.29
39.2.30
592/692
UM1785
HAL_TIMEx_PWMN_Stop_DMA
Function Name
HAL_StatusTypeDef HAL_TIMEx_PWMN_Stop_DMA (
Stops the TIM PWM signal generation in DMA mode on the

Parameters
htim : : TIM handle

Return values
HAL status
Notes
None.
HAL_TIMEx_OnePulseN_Start
Function Name
HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Start (
Starts the TIM One Pulse signal generation on the complemetary

output.
Parameters

OutputChannel : : TIM Channel to be enabled This
Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
39.2.31
39.2.32
39.2.33
HAL_TIMEx_OnePulseN_Stop
Function Name
HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Stop (
Stops the TIM One Pulse signal generation on the complementary

output.
Parameters

OutputChannel : : TIM Channel to be disabled This
Return values
HAL status
Notes
None.
HAL_TIMEx_OnePulseN_Start_IT
Function Name
HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Start_IT (
Starts the TIM One Pulse signal generation in interrupt mode on

the complementary channel.
Parameters

OutputChannel : : TIM Channel to be enabled This
Return values
HAL status
Notes
None.
HAL_TIMEx_OnePulseN_Stop_IT
Function Name
HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Stop_IT (
DocID026525 Rev 1
593/692

39.2.34
UM1785
Stops the TIM One Pulse signal generation in interrupt mode on
the complementary channel.
Parameters

OutputChannel : : TIM Channel to be disabled This
Return values
HAL status
Notes
None.
HAL_TIMEx_ConfigCommutationEvent
Function Name
HAL_StatusTypeDef HAL_TIMEx_ConfigCommutationEvent (
TIM_HandleTypeDef * htim, uint32_t InputTrigger, uint32_t
CommutationSource)
Configure the TIM commutation event sequence.
Parameters
594/692
htim : : TIM handle

InputTrigger : : the Internal trigger corresponding to the
Timer Interfacing with the Hall sensor This parameter can be
TIM_TS_ITR0 Internal trigger 0 selected
TIM_TS_NONE No trigger is needed

CommutationSource : : the Commutation Event source This
TIM_COMMUTATION_TRGI Commutation source is the

TRGI of the Interface Timer
TIM_COMMUTATION_SOFTWARE Commutation
source is set by software using the COMG bit
Return values
HAL status
Notes
: this function is mandatory to use the commutation event in

order to update the configuration at each commutation
detection on the TRGI input of the Timer, the typical use of
this feature is with the use of another Timer(interface Timer)
configured in Hall sensor interface, this interface Timer will
generate the commutation at its TRGO output (connected to
Timer used in this function) each time the TI1 of the Interface
Timer detect a commutation at its input TI1.
DocID026525 Rev 1
UM1785
39.2.35
HAL_TIMEx_ConfigCommutationEvent_IT
Function Name
HAL_StatusTypeDef
HAL_TIMEx_ConfigCommutationEvent_IT (
CommutationSource)
Configure the TIM commutation event sequence with interrupt.
Parameters
39.2.36
htim : : TIM handle



Return values
HAL status
Notes

HAL_TIMEx_ConfigCommutationEvent_DMA
Function Name
HAL_StatusTypeDef
HAL_TIMEx_ConfigCommutationEvent_DMA (
CommutationSource)
Configure the TIM commutation event sequence with DMA.
DocID026525 Rev 1
595/692

Parameters
UM1785
Return values
HAL status
Notes

: The user should configure the DMA in his own software, in
This function only the COMDE bit is set
39.2.37
596/692
htim : : TIM handle



HAL_TIMEx_MasterConfigSynchronization
Function Name
HAL_StatusTypeDef
HAL_TIMEx_MasterConfigSynchronization (
TIM_HandleTypeDef * htim, TIM_MasterConfigTypeDef *
sMasterConfig)
Configures the TIM in master mode.
Parameters

sMasterConfig : : pointer to a TIM_MasterConfigTypeDef
structure that contains the selected trigger output (TRGO) and
the Master/Slave mode.
Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
39.2.38
39.2.39
39.2.40
HAL_TIMEx_ConfigBreakDeadTime
Function Name
HAL_StatusTypeDef HAL_TIMEx_ConfigBreakDeadTime (
TIM_HandleTypeDef * htim,
TIM_BreakDeadTimeConfigTypeDef *
sBreakDeadTimeConfig)
Configures the Break feature, dead time, Lock level, OSSI/OSSR

State and the AOE(automatic output enable).
Parameters
htim : : TIM handle

sBreakDeadTimeConfig : : pointer to a
TIM_ConfigBreakDeadConfigTypeDef structure that contains
the BDTR Register configuration information for the TIM
peripheral.
Return values
HAL status
Notes
None.
HAL_TIMEx_RemapConfig
Function Name
HAL_StatusTypeDef HAL_TIMEx_RemapConfig (
TIM_HandleTypeDef * htim, uint32_t Remap)
Configures the TIM14 Remapping input capabilities.
Parameters

Remap : : specifies the TIM remapping source. This
TIM_TIM14_GPIO TIM14 TI1 is connected to GPIO
TIM_TIM14_RTC TIM14 TI1 is connected to RTC_clock
TIM_TIM14_HSE TIM14 TI1 is connected to HSE/32
TIM_TIM14_MCO TIM14 TI1 is connected to MCO
Return values
HAL status
Notes
None.
HAL_TIMEx_CommutationCallback
DocID026525 Rev 1
597/692

Function Name
39.2.41
39.2.42
39.2.43
Hall commutation changed callback in non blocking mode.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
HAL_TIMEx_BreakCallback
Function Name
void HAL_TIMEx_BreakCallback ( TIM_HandleTypeDef * htim)
Hall Break detection callback in non blocking mode.
Parameters
htim : : TIM handle
Return values
None.
Notes
None.
HAL_TIMEx_DMACommutationCplt
Function Name
void HAL_TIMEx_DMACommutationCplt (
DMA_HandleTypeDef * hdma)
TIM DMA Commutation callback.
Parameters
hdma : : pointer to DMA handle.
Return values
None.
Notes
None.
HAL_TIMEx_HallSensor_GetState
Function Name
598/692
UM1785
void HAL_TIMEx_CommutationCallback ( TIM_HandleTypeDef
* htim)
HAL_TIM_StateTypeDef HAL_TIMEx_HallSensor_GetState (
DocID026525 Rev 1
UM1785

Return the TIM Hall Sensor interface state.
Parameters
Return values
HAL state
Notes
None.
39.3
TIMEx Firmware driver defines
39.3.1
TIMEx
TIMEx
TIMEx Remap
TIM_TIM14_GPIO
TIM14 TI1 is connected to GPIO
TIM_TIM14_RTC
TIM14 TI1 is connected to RTC_clock
TIM_TIM14_HSE
TIM14 TI1 is connected to HSE/32
TIM_TIM14_MCO
TIM14 TI1 is connected to MCO
IS_TIM_REMAP
DocID026525 Rev 1
599/692
HAL TSC Generic Driver
UM1785
40
40.1
TSC Firmware driver registers structures
40.1.1
TSC_InitTypeDef
TSC_InitTypeDef is defined in the stm32f0xx_hal_tsc.h
Data Fields
uint32_t CTPulseHighLength
uint32_t CTPulseLowLength
uint32_t SpreadSpectrum
uint32_t SpreadSpectrumDeviation
uint32_t SpreadSpectrumPrescaler
uint32_t PulseGeneratorPrescaler
uint32_t MaxCountValue
uint32_t IODefaultMode
uint32_t SynchroPinPolarity
uint32_t AcquisitionMode
uint32_t MaxCountInterrupt
uint32_t ChannelIOs
uint32_t ShieldIOs
uint32_t SamplingIOs
Field Documentation
40.1.2
uint32_t TSC_InitTypeDef::CTPulseHighLength Charge-transfer high pulse length

uint32_t TSC_InitTypeDef::CTPulseLowLength Charge-transfer low pulse length
uint32_t TSC_InitTypeDef::SpreadSpectrum Spread spectrum activation
uint32_t TSC_InitTypeDef::SpreadSpectrumDeviation Spread spectrum deviation
uint32_t TSC_InitTypeDef::SpreadSpectrumPrescaler Spread spectrum prescaler
uint32_t TSC_InitTypeDef::PulseGeneratorPrescaler Pulse generator prescaler
uint32_t TSC_InitTypeDef::MaxCountValue Max count value
uint32_t TSC_InitTypeDef::IODefaultMode IO default mode
uint32_t TSC_InitTypeDef::SynchroPinPolarity Synchro pin polarity
uint32_t TSC_InitTypeDef::AcquisitionMode Acquisition mode
uint32_t TSC_InitTypeDef::MaxCountInterrupt Max count interrupt activation
uint32_t TSC_InitTypeDef::ChannelIOs Channel IOs mask
uint32_t TSC_InitTypeDef::ShieldIOs Shield IOs mask
uint32_t TSC_InitTypeDef::SamplingIOs Sampling IOs mask
TSC_IOConfigTypeDef
TSC_IOConfigTypeDef is defined in the stm32f0xx_hal_tsc.h
Data Fields
600/692
uint32_t ChannelIOs
uint32_t ShieldIOs
uint32_t SamplingIOs
DocID026525 Rev 1
UM1785

Field Documentation
40.1.3
uint32_t TSC_IOConfigTypeDef::ChannelIOs Channel IOs mask

uint32_t TSC_IOConfigTypeDef::ShieldIOs Shield IOs mask
uint32_t TSC_IOConfigTypeDef::SamplingIOs Sampling IOs mask
TSC_HandleTypeDef
TSC_HandleTypeDef is defined in the stm32f0xx_hal_tsc.h
Data Fields
TSC_TypeDef * Instance
TSC_InitTypeDef Init
__IO HAL_TSC_StateTypeDef State
Field Documentation
40.2
TSC_TypeDef* TSC_HandleTypeDef::Instance Register base address

TSC_InitTypeDef TSC_HandleTypeDef::Init Initialization parameters
__IO HAL_TSC_StateTypeDef TSC_HandleTypeDef::State Peripheral state
HAL_LockTypeDef TSC_HandleTypeDef::Lock Lock feature
TSC Firmware driver API description

The following section lists the various functions of the TSC library.
40.2.1
TSC specific features
1.
2.
3.
Proven and robust surface charge transfer acquisition principle

Supports up to 3 capacitive sensing channels per group
Capacitive sensing channels can be acquired in parallel offering a very good
response time
4.
Spread spectrum feature to improve system robustness in noisy environments
5.
Full hardware management of the charge transfer acquisition sequence
6.
Programmable charge transfer frequency
7.
Programmable sampling capacitor I/O pin
8.
Programmable channel I/O pin
9.
Programmable max count value to avoid long acquisition when a channel is faulty
10. Dedicated end of acquisition and max count error flags with interrupt capability
11. One sampling capacitor for up to 3 capacitive sensing channels to reduce the system
components
12. Compatible with proximity, touchkey, linear and rotary touch sensor implementation
40.2.2
DocID026525 Rev 1
601/692

UM1785
1.
Enable the TSC interface clock using __TSC_CLK_ENABLE() macro.
2.
GPIO pins configuration
Enable the clock for the TSC GPIOs using __GPIOx_CLK_ENABLE() macro.
Configure the TSC pins used as sampling IOs in alternate function output OpenDrain mode, and TSC pins used as channel/shield IOs in alternate function
output Push-Pull mode using HAL_GPIO_Init() function.
Configure the alternate function on all the TSC pins using HAL_xxxx() function.
3.
Interrupts configuration
Configure the NVIC (if the interrupt model is used) using HAL_xxx() function.
4.
TSC configuration
Configure all TSC parameters and used TSC IOs using HAL_TSC_Init() function.
Acquisition sequence
40.2.3
Discharge all IOs using HAL_TSC_IODischarge() function.

Wait a certain time allowing a good discharge of all capacitors. This delay depends of
the sampling capacitor and electrodes design.
Select the channel IOs to be acquired using HAL_TSC_IOConfig() function.
Launch the acquisition using either HAL_TSC_Start() or HAL_TSC_Start_IT()
function. If the synchronized mode is selected, the acquisition will start as soon as the
signal is received on the synchro pin.
Wait the end of acquisition using either HAL_TSC_PollForAcquisition() or
HAL_TSC_GetState() function or using WFI instruction for example.
Check the group acquisition status using HAL_TSC_GroupGetStatus() function.
Read the acquisition value using HAL_TSC_GroupGetValue() function.

40.2.4
Initialize and configure the TSC.

De-initialize the TSC.
HAL_TSC_Init()
HAL_TSC_DeInit()
HAL_TSC_MspInit()
HAL_TSC_MspDeInit()

40.2.5
Configure TSC IOs

Discharge TSC IOs
HAL_TSC_IOConfig()
HAL_TSC_IODischarge()
State functions
602/692
Get TSC state.

DocID026525 Rev 1
UM1785
40.2.6
40.2.7
40.2.8
Poll for acquisition completed.

Handles TSC interrupt request.
HAL_TSC_GetState()
HAL_TSC_PollForAcquisition()
HAL_TSC_IRQHandler()
HAL_TSC_Init
Function Name
HAL_StatusTypeDef HAL_TSC_Init ( TSC_HandleTypeDef *

htsc)
Initializes the TSC peripheral according to the specified

parameters in the TSC_InitTypeDef structure.
Parameters
htsc : TSC handle
Return values
HAL status
Notes
None.
HAL_TSC_DeInit
Function Name
HAL_StatusTypeDef HAL_TSC_DeInit ( TSC_HandleTypeDef *

htsc)
Deinitializes the TSC peripheral registers to their default reset

values.
Parameters
htsc : TSC handle
Return values
HAL status
Notes
None.
HAL_TSC_MspInit
Function Name
void HAL_TSC_MspInit ( TSC_HandleTypeDef * htsc)
Initializes the TSC MSP.
Parameters
htsc : pointer to a TSC_HandleTypeDef structure that

contains the configuration information for the specified TSC.
DocID026525 Rev 1
603/692

Return values
Notes
40.2.9
40.2.10
40.2.11
604/692
UM1785
None.
None.
HAL_TSC_MspDeInit
Function Name
void HAL_TSC_MspDeInit ( TSC_HandleTypeDef * htsc)
DeInitializes the TSC MSP.
Parameters

Return values
None.
Notes
None.
HAL_TSC_Start
Function Name
HAL_StatusTypeDef HAL_TSC_Start ( TSC_HandleTypeDef *

htsc)
Starts the acquisition.
Parameters

Return values
HAL status
Notes
None.
HAL_TSC_Start_IT
Function Name
HAL_StatusTypeDef HAL_TSC_Start_IT ( TSC_HandleTypeDef

* htsc)
Enables the interrupt and starts the acquisition.
DocID026525 Rev 1
UM1785
40.2.12
40.2.13
40.2.14

Parameters

Return values
HAL status.
Notes
None.
HAL_TSC_Stop
Function Name
HAL_StatusTypeDef HAL_TSC_Stop ( TSC_HandleTypeDef *

htsc)
Stops the acquisition previously launched in polling mode.
Parameters

Return values
HAL status
Notes
None.
HAL_TSC_Stop_IT
Function Name
HAL_StatusTypeDef HAL_TSC_Stop_IT ( TSC_HandleTypeDef

* htsc)
Stops the acquisition previously launched in interrupt mode.
Parameters

Return values
HAL status
Notes
None.
HAL_TSC_GroupGetStatus
Function Name
TSC_GroupStatusTypeDef HAL_TSC_GroupGetStatus (
DocID026525 Rev 1
605/692
UM1785
TSC_HandleTypeDef * htsc, uint32_t gx_index)
40.2.15
40.2.16
606/692
Gets the acquisition status for a group.
Parameters

gx_index : Index of the group
Return values
Group status
Notes
None.
HAL_TSC_GroupGetValue
Function Name
uint32_t HAL_TSC_GroupGetValue ( TSC_HandleTypeDef *

htsc, uint32_t gx_index)
Gets the acquisition measure for a group.
Parameters

gx_index : Index of the group
Return values
Acquisition measure
Notes
None.
HAL_TSC_IOConfig
Function Name
HAL_StatusTypeDef HAL_TSC_IOConfig (
TSC_HandleTypeDef * htsc, TSC_IOConfigTypeDef * config)
Configures TSC IOs.
Parameters

config : pointer to the configuration structure.
Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
40.2.17
40.2.18
40.2.19
HAL_TSC_IODischarge
Function Name
HAL_StatusTypeDef HAL_TSC_IODischarge (
TSC_HandleTypeDef * htsc, uint32_t choice)
Discharge TSC IOs.
Parameters

choice : enable or disable
Return values
HAL status
Notes
None.
HAL_TSC_GetState
Function Name
HAL_TSC_StateTypeDef HAL_TSC_GetState (
TSC_HandleTypeDef * htsc)
Return the TSC state.
Parameters

Return values
HAL state
Notes
None.
HAL_TSC_PollForAcquisition
Function Name
HAL_StatusTypeDef HAL_TSC_PollForAcquisition (
TSC_HandleTypeDef * htsc)
Start acquisition and wait until completion.
Parameters

Return values
HAL state
Notes
There is no need of a timeout parameter as the max count

error is already managed by the TSC peripheral.
DocID026525 Rev 1
607/692
40.2.20
40.2.21
40.2.22
608/692
UM1785
HAL_TSC_IRQHandler
Function Name
void HAL_TSC_IRQHandler ( TSC_HandleTypeDef * htsc)
Handles TSC interrupt request.
Parameters

Return values
None.
Notes
None.
HAL_TSC_ConvCpltCallback
Function Name
void HAL_TSC_ConvCpltCallback ( TSC_HandleTypeDef *

htsc)
Acquisition completed callback in non blocking mode.
Parameters

Return values
None.
Notes
None.
HAL_TSC_ErrorCallback
Function Name
void HAL_TSC_ErrorCallback ( TSC_HandleTypeDef * htsc)
Error callback in non blocking mode.
Parameters

Return values
None.
DocID026525 Rev 1
UM1785

Notes
None.
40.3
TSC Firmware driver defines
40.3.1
TSC
TSC
TSC Acquisition mode
TSC_ACQ_MODE_NORMAL
TSC_ACQ_MODE_SYNCHRO
IS_TSC_ACQ_MODE
TSC Charge Transfer Pulse High
TSC_CTPH_1CYCLE
TSC_CTPH_2CYCLES
TSC_CTPH_3CYCLES
TSC_CTPH_4CYCLES
TSC_CTPH_5CYCLES
TSC_CTPH_6CYCLES
TSC_CTPH_7CYCLES
TSC_CTPH_8CYCLES
TSC_CTPH_9CYCLES
TSC_CTPH_10CYCLES
TSC_CTPH_11CYCLES
TSC_CTPH_12CYCLES
TSC_CTPH_13CYCLES
TSC_CTPH_14CYCLES
TSC_CTPH_15CYCLES
TSC_CTPH_16CYCLES
IS_TSC_CTPH
TSC Charge Transfer Pulse Low
TSC_CTPL_1CYCLE
TSC_CTPL_2CYCLES
TSC_CTPL_3CYCLES
TSC_CTPL_4CYCLES
TSC_CTPL_5CYCLES
DocID026525 Rev 1
609/692

TSC_CTPL_6CYCLES
UM1785
TSC_CTPL_7CYCLES
TSC_CTPL_8CYCLES
TSC_CTPL_9CYCLES
TSC_CTPL_10CYCLES
TSC_CTPL_11CYCLES
TSC_CTPL_12CYCLES
TSC_CTPL_13CYCLES
TSC_CTPL_14CYCLES
TSC_CTPL_15CYCLES
TSC_CTPL_16CYCLES
IS_TSC_CTPL
TSC Exported Macros
__HAL_TSC_RESET_HANDLE_STATE
Description:
Reset TSC handle state.
Parameters:
__HANDLE__: TSC handle.
Return value:
__HAL_TSC_ENABLE
None:
Description:
Enable the TSC peripheral.
Parameters:
__HANDLE__: TSC handle
Return value:
__HAL_TSC_DISABLE
None:
Description:
Disable the TSC peripheral.
Parameters:
Return value:
__HAL_TSC_START_ACQ
None:
Description:
Start acquisition.
Parameters:
Return value:
610/692
DocID026525 Rev 1
UM1785
None:
Description:
__HAL_TSC_STOP_ACQ
Stop acquisition.
Parameters:
Return value:
__HAL_TSC_SET_IODEF_OUTPPLOW
None:
Description:
Set IO default mode to output pushpull low.
Parameters:
Return value:
__HAL_TSC_SET_IODEF_INFLOAT
None:
Description:
Set IO default mode to input floating.
Parameters:
Return value:
__HAL_TSC_SET_SYNC_POL_FALL
None:
Description:
Set synchronization polarity to falling

edge.
Parameters:
Return value:
__HAL_TSC_SET_SYNC_POL_RISE_HIGH
None:
Description:
Set synchronization polarity to rising

edge and high level.
Parameters:
Return value:
__HAL_TSC_ENABLE_IT
None:
Description:
Enable TSC interrupt.
Parameters:
DocID026525 Rev 1
611/692
UM1785

__INTERRUPT__: TSC interrupt
Return value:
None:
Description:
__HAL_TSC_DISABLE_IT
Disable TSC interrupt.
Parameters:

Return value:
__HAL_TSC_GET_IT_SOURCE
None:
Description:
Check if the specified TSC interrupt

source is enabled or disabled.
Parameters:
__HANDLE__: TSC Handle

Return value:
SET: or RESET
Description:
__HAL_TSC_GET_FLAG
Get the selected TSC's flag status.
Parameters:

__FLAG__: TSC flag
Return value:
SET: or RESET
Description:
__HAL_TSC_CLEAR_FLAG
Clear the TSC's pending flag.
Parameters:

__FLAG__: TSC flag
Return value:
__HAL_TSC_ENABLE_HYSTERESIS
None:
Description:
Enable schmitt trigger hysteresis on a

group of IOs.
Parameters:
612/692
DocID026525 Rev 1
UM1785
__GX_IOY_MASK__: IOs mask
Return value:
__HAL_TSC_DISABLE_HYSTERESIS
None:
Description:
Disable schmitt trigger hysteresis on a

group of IOs.
Parameters:

Return value:
__HAL_TSC_OPEN_ANALOG_SWITCH
None:
Description:
Open analog switch on a group of IOs.
Parameters:

Return value:
__HAL_TSC_CLOSE_ANALOG_SWITCH
None:
Description:
Close analog switch on a group of IOs.
Parameters:

Return value:
__HAL_TSC_ENABLE_CHANNEL
None:
Description:
Enable a group of IOs in channel

mode.
Parameters:

Return value:
__HAL_TSC_DISABLE_CHANNEL
None:
Description:
Disable a group of channel IOs.
Parameters:
DocID026525 Rev 1

613/692
UM1785
Return value:
__HAL_TSC_ENABLE_SAMPLING
None:
Description:
Enable a group of IOs in sampling

mode.
Parameters:

Return value:
__HAL_TSC_DISABLE_SAMPLING
None:
Description:
Disable a group of sampling IOs.
Parameters:

Return value:
__HAL_TSC_ENABLE_GROUP
None:
Description:
Enable acquisition groups.
Parameters:

__GX_MASK__: Groups mask
Return value:
__HAL_TSC_DISABLE_GROUP
None:
Description:
Disable acquisition groups.
Parameters:

__GX_MASK__: Groups mask
Return value:
__HAL_TSC_GET_GROUP_STATUS
None:
Description:
Gets acquisition group status.
Parameters:
__HANDLE__: TSC Handle

__GX_INDEX__: Group index
Return value:
614/692
DocID026525 Rev 1
SET: or RESET
UM1785

TSC Flags Definition
TSC_FLAG_EOA
TSC_FLAG_MCE
TSC groups definition
TSC_NB_OF_GROUPS
TSC_GROUP1
TSC_GROUP2
TSC_GROUP3
TSC_GROUP4
TSC_GROUP5
TSC_GROUP6
TSC_GROUP7
TSC_GROUP8
TSC_ALL_GROUPS
TSC_GROUP1_IDX
TSC_GROUP2_IDX
TSC_GROUP3_IDX
TSC_GROUP4_IDX
TSC_GROUP5_IDX
TSC_GROUP6_IDX
TSC_GROUP7_IDX
TSC_GROUP8_IDX
IS_GROUP_INDEX
TSC_GROUP1_IO1
TSC_GROUP1_IO2
TSC_GROUP1_IO3
TSC_GROUP1_IO4
TSC_GROUP1_ALL_IOS
TSC_GROUP2_IO1
TSC_GROUP2_IO2
TSC_GROUP2_IO3
TSC_GROUP2_IO4
TSC_GROUP2_ALL_IOS
TSC_GROUP3_IO1
TSC_GROUP3_IO2
TSC_GROUP3_IO3
DocID026525 Rev 1
615/692

TSC_GROUP3_IO4
UM1785
TSC_GROUP3_ALL_IOS
TSC_GROUP4_IO1
TSC_GROUP4_IO2
TSC_GROUP4_IO3
TSC_GROUP4_IO4
TSC_GROUP4_ALL_IOS
TSC_GROUP5_IO1
TSC_GROUP5_IO2
TSC_GROUP5_IO3
TSC_GROUP5_IO4
TSC_GROUP5_ALL_IOS
TSC_GROUP6_IO1
TSC_GROUP6_IO2
TSC_GROUP6_IO3
TSC_GROUP6_IO4
TSC_GROUP6_ALL_IOS
TSC_GROUP7_IO1
TSC_GROUP7_IO2
TSC_GROUP7_IO3
TSC_GROUP7_IO4
TSC_GROUP7_ALL_IOS
TSC_GROUP8_IO1
TSC_GROUP8_IO2
TSC_GROUP8_IO3
TSC_GROUP8_IO4
TSC_GROUP8_ALL_IOS
TSC_ALL_GROUPS_ALL_IOS
TSC interrupts definition
TSC_IT_EOA
TSC_IT_MCE
IS_TSC_MCE_IT
TSC I/O default mode definition
TSC_IODEF_OUT_PP_LOW
TSC_IODEF_IN_FLOAT
IS_TSC_IODEF
TSC I/O mode definition
616/692
DocID026525 Rev 1
UM1785

TSC_IOMODE_UNUSED
TSC_IOMODE_CHANNEL
TSC_IOMODE_SHIELD
TSC_IOMODE_SAMPLING
IS_TSC_IOMODE
TSC Max Count Value definition
TSC_MCV_255
TSC_MCV_511
TSC_MCV_1023
TSC_MCV_2047
TSC_MCV_4095
TSC_MCV_8191
TSC_MCV_16383
IS_TSC_MCV
TSC Pulse Generator prescaler definition
TSC_PG_PRESC_DIV1
TSC_PG_PRESC_DIV2
TSC_PG_PRESC_DIV4
TSC_PG_PRESC_DIV8
TSC_PG_PRESC_DIV16
TSC_PG_PRESC_DIV32
TSC_PG_PRESC_DIV64
TSC_PG_PRESC_DIV128
IS_TSC_PG_PRESC
TSC Spread Spectrum
IS_TSC_SS
IS_TSC_SSD
TSC Spread spectrum prescaler definition
TSC_SS_PRESC_DIV1
TSC_SS_PRESC_DIV2
IS_TSC_SS_PRESC
TSC Synchronization pin polarity
TSC_SYNC_POL_FALL
TSC_SYNC_POL_RISE_HIGH
IS_TSC_SYNC_POL
DocID026525 Rev 1
617/692
HAL UART Generic Driver
UM1785
41
41.1
UART Firmware driver registers structures
41.1.1
UART_InitTypeDef
UART_InitTypeDef is defined in the stm32f0xx_hal_uart.h
Data Fields
uint32_t BaudRate
uint32_t WordLength
uint32_t StopBits
uint32_t Parity
uint32_t Mode
uint32_t HwFlowCtl
uint32_t OverSampling
uint32_t OneBitSampling
Field Documentation
618/692
uint32_t UART_InitTypeDef::BaudRate This member configures the UART

formula:
If oversampling is 16 or in LIN mode (LIN mode not available on F030xx devices),

Baud Rate Register = ((PCLKx) / ((huart->Init.BaudRate)))
If oversampling is 8, Baud Rate Register[15:4] = ((2 * PCLKx) / ((huart>Init.BaudRate)))[15:4] Baud Rate Register[3] = 0 Baud Rate Register[2:0] = (((2
* PCLKx) / ((huart->Init.BaudRate)))[3:0]) >> 1
uint32_t UART_InitTypeDef::WordLength Specifies the number of data bits
UARTEx_Word_Length
uint32_t UART_InitTypeDef::StopBits Specifies the number of stop bits transmitted.
This parameter can be a value of UART_Stop_Bits
uint32_t UART_InitTypeDef::Parity Specifies the parity mode. This parameter can
be a value of UART_Parity
uint32_t UART_InitTypeDef::Mode Specifies whether the Receive or Transmit mode
is enabled or disabled. This parameter can be a value of UART_Mode
uint32_t UART_InitTypeDef::HwFlowCtl Specifies whether the hardware flow
control mode is enabled or disabled. This parameter can be a value of
UART_Hardware_Flow_Control
uint32_t UART_InitTypeDef::OverSampling Specifies whether the Over sampling 8
is enabled or disabled, to achieve higher speed (up to fPCLK/8). This parameter can
be a value of UART_Over_Sampling
uint32_t UART_InitTypeDef::OneBitSampling Specifies whether a single sample or
three samples' majority vote is selected. Selecting the single sample method
increases the receiver tolerance to clock deviations. This parameter can be a value of
UART_OneBit_Sampling.
DocID026525 Rev 1
UM1785
41.1.2
UART_AdvFeatureInitTypeDef
UART_AdvFeatureInitTypeDef is defined in the stm32f0xx_hal_uart.h
Data Fields
uint32_t AdvFeatureInit
uint32_t TxPinLevelInvert
uint32_t RxPinLevelInvert
uint32_t DataInvert
uint32_t Swap
uint32_t OverrunDisable
uint32_t DMADisableonRxError
uint32_t AutoBaudRateEnable
uint32_t AutoBaudRateMode
uint32_t MSBFirst
Field Documentation
41.1.3
uint32_t UART_AdvFeatureInitTypeDef::AdvFeatureInit Specifies which advanced

UART features is initialized. Several Advanced Features may be initialized at the
same time . This parameter can be a value of
UART_Advanced_Features_Initialization_Type
uint32_t UART_AdvFeatureInitTypeDef::TxPinLevelInvert Specifies whether the
TX pin active level is inverted. This parameter can be a value of UART_Tx_Inv
uint32_t UART_AdvFeatureInitTypeDef::RxPinLevelInvert Specifies whether the
RX pin active level is inverted. This parameter can be a value of UART_Rx_Inv
uint32_t UART_AdvFeatureInitTypeDef::DataInvert Specifies whether data are
inverted (positive/direct logic vs negative/inverted logic). This parameter can be a
value of UART_Data_Inv
uint32_t UART_AdvFeatureInitTypeDef::Swap Specifies whether TX and RX pins
are swapped. This parameter can be a value of UART_Rx_Tx_Swap
uint32_t UART_AdvFeatureInitTypeDef::OverrunDisable Specifies whether the
reception overrun detection is disabled. This parameter can be a value of
UART_Overrun_Disable
uint32_t UART_AdvFeatureInitTypeDef::DMADisableonRxError Specifies whether
the DMA is disabled in case of reception error. This parameter can be a value of
UART_DMA_Disable_on_Rx_Error
uint32_t UART_AdvFeatureInitTypeDef::AutoBaudRateEnable Specifies whether
auto Baud rate detection is enabled. This parameter can be a value of
UART_AutoBaudRate_Enable
uint32_t UART_AdvFeatureInitTypeDef::AutoBaudRateMode If auto Baud rate
detection is enabled, specifies how the rate detection is carried out. This parameter
can be a value of UARTEx_AutoBaud_Rate_Mode
uint32_t UART_AdvFeatureInitTypeDef::MSBFirst Specifies whether MSB is sent
first on UART line. This parameter can be a value of UART_MSB_First
UART_WakeUpTypeDef
UART_WakeUpTypeDef is defined in the stm32f0xx_hal_uart.h
Data Fields
uint32_t WakeUpEvent
uint16_t AddressLength
DocID026525 Rev 1
619/692
UM1785
uint8_t Address
Field Documentation
41.1.4
uint32_t UART_WakeUpTypeDef::WakeUpEvent Specifies which event will activat

the Wakeup from Stop mode flag (WUF). This parameter can be a value of
UART_WakeUp_from_Stop_Selection. If set to UART_WAKEUP_ON_ADDRESS,
the two other fields below must be filled up.
uint16_t UART_WakeUpTypeDef::AddressLength Specifies whether the address is
4 or 7-bit long. This parameter can be a value of UART_WakeUp_Address_Length
uint8_t UART_WakeUpTypeDef::Address UART/USART node address (7-bit long
max)
UART_HandleTypeDef
UART_HandleTypeDef is defined in the stm32f0xx_hal_uart.h
Data Fields
UART_InitTypeDef Init
UART_AdvFeatureInitTypeDef AdvancedInit
uint16_t TxXferSize
uint16_t RxXferSize
uint16_t Mask
HAL_UART_StateTypeDef State
HAL_UART_ErrorTypeDef ErrorCode
Field Documentation
620/692
USART_TypeDef* UART_HandleTypeDef::Instance
UART_InitTypeDef UART_HandleTypeDef::Init
UART_AdvFeatureInitTypeDef UART_HandleTypeDef::AdvancedInit
uint8_t* UART_HandleTypeDef::pTxBuffPtr
uint16_t UART_HandleTypeDef::TxXferSize
uint16_t UART_HandleTypeDef::TxXferCount
uint8_t* UART_HandleTypeDef::pRxBuffPtr
uint16_t UART_HandleTypeDef::RxXferSize
uint16_t UART_HandleTypeDef::RxXferCount
uint16_t UART_HandleTypeDef::Mask
DMA_HandleTypeDef* UART_HandleTypeDef::hdmatx
DMA_HandleTypeDef* UART_HandleTypeDef::hdmarx
HAL_LockTypeDef UART_HandleTypeDef::Lock
HAL_UART_StateTypeDef UART_HandleTypeDef::State
HAL_UART_ErrorTypeDef UART_HandleTypeDef::ErrorCode
DocID026525 Rev 1
UM1785
41.2
UART Firmware driver API description

The following section lists the various functions of the UART library.
41.2.1

The UART HAL driver can be used as follows:
1.
2.
3.
4.
5.
6.
7.
8.
Declare a UART_HandleTypeDef handle structure.

Initialize the UART low level resources by implementing the HAL_UART_MspInit
()API:
a.
b.
UART pins configuration:
Enable the clock for the UART GPIOs.
Configure these UART pins as alternate function pull-up.

c.
(HAL_UART_Transmit_IT() and HAL_UART_Receive_IT() APIs):

d.
(HAL_UART_Transmit_DMA() and HAL_UART_Receive_DMA() APIs):
parameters.
Associate the initilalized DMA handle to the UART DMA Tx/Rx handle.
Program the Baud Rate, Word Length , Stop Bit, Parity, Hardware flow control and
Mode(Receiver/Transmitter) in the huart Init structure.
If required, program UART advanced features (TX/RX pins swap, auto Baud rate
detection,...) in the huart AdvancedInit structure.
For the UART asynchronous mode, initialize the UART registers by calling the
HAL_UART_Init() API.
For the UART Half duplex mode, initialize the UART registers by calling the
HAL_HalfDuplex_Init() API.
For the UART Multiprocessor mode, initialize the UART registers by calling the
HAL_MultiProcessor_Init() API.
For the UART RS485 Driver Enabled mode, initialize the UART registers by calling
the HAL_RS485Ex_Init() API.
The specific UART interrupts (Transmission complete interrupt, RXNE interrupt
and Error Interrupts) will be managed using the macros
__HAL_UART_ENABLE_IT() and __HAL_UART_DISABLE_IT() inside the
transmit and receive process.
These APIs(HAL_UART_Init(), HAL_HalfDuplex_Init(),

HAL_MultiProcessor_Init(), also configure also the low level Hardware GPIO,
CLOCK, CORTEX...etc) by calling the customed HAL_UART_MspInit() API.
DocID026525 Rev 1
621/692
UM1785
Send an amount of data in blocking mode using HAL_UART_Transmit()

Receive an amount of data in blocking mode using HAL_UART_Receive()
Send an amount of data in non blocking mode using HAL_UART_Transmit_IT()

At transmission end of half transfer HAL_UART_TxHalfCpltCallback is executed and
HAL_UART_TxHalfCpltCallback
At transmission end of transfer HAL_UART_TxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_UART_TxCpltCallback
Receive an amount of data in non blocking mode using HAL_UART_Receive_IT()
At reception end of half transfer HAL_UART_RxHalfCpltCallback is executed and
HAL_UART_RxHalfCpltCallback
At reception end of transfer HAL_UART_RxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_UART_RxCpltCallback
In case of transfer Error, HAL_UART_ErrorCallback() function is executed and user
can add his own code by customization of function pointer HAL_UART_ErrorCallback

HAL_UART_Transmit_DMA()
At transmission end of half transfer HAL_UART_TxHalfCpltCallback is executed and
At transmission end of transfer HAL_UART_TxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_UART_TxCpltCallback
HAL_UART_Receive_DMA()
At reception end of half transfer HAL_UART_RxHalfCpltCallback is executed and
At reception end of transfer HAL_UART_RxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_UART_RxCpltCallback
In case of transfer Error, HAL_UART_ErrorCallback() function is executed and user
can add his own code by customization of function pointer HAL_UART_ErrorCallback
Pause the DMA Transfer using HAL_UART_DMAPause()
Resume the DMA Transfer using HAL_UART_DMAResume()
Stop the DMA Transfer using HAL_UART_DMAStop()
UART HAL driver macros list

Below the list of most used macros in UART HAL driver.
622/692
DocID026525 Rev 1
UM1785
__HAL_UART_ENABLE: Enable the UART peripheral

__HAL_UART_DISABLE: Disable the UART peripheral
__HAL_UART_GET_FLAG : Check whether the specified UART flag is set or not
__HAL_UART_CLEAR_FLAG : Clear the specified UART pending flag
__HAL_UART_ENABLE_IT: Enable the specified UART interrupt
__HAL_UART_DISABLE_IT: Disable the specified UART interrupt
You can refer to the UART HAL driver header file for more useful macros
41.2.2

This subsection provides a set of functions allowing to initialize the USARTx or the UARTy
in asynchronous mode.
Baud Rate
Word Length
Stop Bit
length defined by the M bit (8-bits or 9-bits), the possible UART frame formats are
as listed in the below table.
Hardware flow control
Over Sampling Method
One-Bit Sampling Method

For the asynchronous mode, the following advanced features can be configured as
well:
RX and TX pins swap
auto Baud rate detection

Table 23: UART frame formats
M1, M0 bits
PCE bit
UART frame
00
| SB | 8 bit data | STB |
00
01
01
10
10
DocID026525 Rev 1
623/692

UM1785
The HAL_UART_Init(), HAL_HalfDuplex_Init() and HAL_MultiProcessor_Init() API follow
respectively the UART asynchronous, UART Half duplex and multiprocessor configuration
procedures (details for the procedures are available in reference manual).
41.2.3
HAL_UART_Init()
HAL_HalfDuplex_Init()
HAL_MultiProcessor_Init()
HAL_UART_DeInit()
HAL_UART_MspInit()
HAL_UART_MspDeInit()
This subsection provides a set of functions allowing to manage the UART asynchronous
and Half duplex data transfers.
1.
2.
3.
4.
5.
There are two mode of transfer:

transfer.
No-Blocking mode: The communication is performed using Interrupts or DMA,

indicated through the dedicated UART IRQ when using Interrupt mode or the
DMA IRQ when using DMA mode. The HAL_UART_TxCpltCallback(),
HAL_UART_RxCpltCallback() user callbacks will be executed respectivelly at the
end of the transmit or Receive process The HAL_UART_ErrorCallback()user
callback will be executed when a communication error is detected
HAL_UART_Transmit()
HAL_UART_Receive()
HAL_UART_Transmit_IT()
HAL_UART_Receive_IT()
HAL_UART_IRQHandler()
UART_Transmit_IT()
UART_Receive_IT()
Non Blocking mode APIs with DMA are :
HAL_UART_DMAPause()
HAL_UART_DMAResume()
HAL_UART_DMAStop()
A set of Transfer Complete Callbacks are provided in non blocking mode:
HAL_UART_TxHalfCpltCallback()
HAL_UART_TxCpltCallback()
HAL_UART_RxHalfCpltCallback()
HAL_UART_RxCpltCallback()
HAL_UART_ErrorCallback()
In the Half duplex communication, it is forbidden to run the transmit and receive
process in parallel, the UART state HAL_UART_STATE_BUSY_TX_RX can't be
useful.
624/692
DocID026525 Rev 1
UM1785
41.2.4
HAL_UART_Transmit()
HAL_UART_Receive()
HAL_UART_Transmit_IT()
HAL_UART_Receive_IT()
HAL_UART_DMAPause()
HAL_UART_DMAResume()
HAL_UART_DMAStop()
HAL_UART_TxCpltCallback()
HAL_UART_TxHalfCpltCallback()
HAL_UART_RxCpltCallback()
HAL_UART_RxHalfCpltCallback()
HAL_UART_ErrorCallback()

This subsection provides a set of functions allowing to control the UART.
41.2.5
HAL_UART_GetState() API is helpful to check in run-time the state of the UART

peripheral.
HAL_MultiProcessor_EnableMuteMode() API enables mute mode
HAL_MultiProcessor_DisableMuteMode() API disables mute mode
HAL_MultiProcessor_EnterMuteMode() API enters mute mode
HAL_MultiProcessor_EnableMuteMode() API enables mute mode
HAL_UART_EnableStopMode() API enables the UART to wake up the MCU from
stop mode
HAL_UART_DisableStopMode() API disables the above functionality
UART_SetConfig() API configures the UART peripheral
UART_AdvFeatureConfig() API optionally configures the UART advanced features
UART_CheckIdleState() API ensures that TEACK and/or REACK are set after
initialization
UART_Wakeup_AddressConfig() API configures the wake-up from stop mode
parameters
HAL_HalfDuplex_EnableTransmitter() API disables receiver and enables transmitter
HAL_HalfDuplex_EnableReceiver() API disables transmitter and enables receiver
HAL_MultiProcessor_EnableMuteMode()
HAL_MultiProcessor_DisableMuteMode()
HAL_MultiProcessor_EnterMuteMode()
HAL_HalfDuplex_EnableTransmitter()
HAL_HalfDuplex_EnableReceiver()
HAL_UART_Init
Function Name
HAL_StatusTypeDef HAL_UART_Init ( UART_HandleTypeDef *

huart)
Initializes the UART mode according to the specified parameters

in the UART_InitTypeDef and creates the associated handle .
Parameters
huart : uart handle

DocID026525 Rev 1
625/692

Return values
Notes
41.2.6
41.2.7
UM1785
HAL status
None.
HAL_HalfDuplex_Init
Function Name
HAL_StatusTypeDef HAL_HalfDuplex_Init (
UART_HandleTypeDef * huart)
Initializes the half-duplex mode according to the specified

parameters in the UART_InitTypeDef and creates the associated
handle .
Parameters
huart : uart handle
Return values
HAL status
Notes
None.
HAL_MultiProcessor_Init
Function Name
HAL_StatusTypeDef HAL_MultiProcessor_Init (
UART_HandleTypeDef * huart, uint8_t Address, uint32_t
WakeUpMethod)
Initializes the multiprocessor mode according to the specified

parameters in the UART_InitTypeDef and creates the associated
handle.
Parameters
huart : UART handle

Address : UART node address (4-, 6-, 7- or 8-bit long)
WakeUpMethod : specifies the UART wakeup method. This
UART_WAKEUPMETHOD_IDLELINE WakeUp by an
idle line detection
UART_WAKEUPMETHOD_ADDRESSMARK WakeUp
by an address mark
Return values
HAL status
Notes
If the user resorts to idle line detection wake up, the Address
parameter is useless and ignored by the initialization function.
If the user resorts to address mark wake up, the address
length detection is configured by default to 4 bits only. For the
UART to be able to manage 6-, 7- or 8-bit long addresses
626/692
DocID026525 Rev 1
UM1785
41.2.8
41.2.9
41.2.10

detection, the API
HAL_MultiProcessorEx_AddressLength_Set() must be called
after HAL_MultiProcessor_Init().
HAL_UART_DeInit
Function Name
HAL_StatusTypeDef HAL_UART_DeInit (
DeInitializes the UART peripheral.
Parameters
huart : uart handle
Return values
HAL status
Notes
None.
HAL_UART_MspInit
Function Name
void HAL_UART_MspInit ( UART_HandleTypeDef * huart)
UART MSP Init.
Parameters
huart : uart handle
Return values
None.
Notes
None.
HAL_UART_MspDeInit
Function Name
void HAL_UART_MspDeInit ( UART_HandleTypeDef * huart)
UART MSP DeInit.
Parameters
huart : uart handle
Return values
None.
DocID026525 Rev 1
627/692

Notes
41.2.11
41.2.12
41.2.13
628/692
UM1785
None.
HAL_UART_Transmit
Function Name
HAL_StatusTypeDef HAL_UART_Transmit (
UART_HandleTypeDef * huart, uint8_t * pData, uint16_t Size,
uint32_t Timeout)
Parameters
huart : uart handle

Return values
HAL status
Notes
None.
HAL_UART_Receive
Function Name
HAL_StatusTypeDef HAL_UART_Receive (
UART_HandleTypeDef * huart, uint8_t * pData, uint16_t Size,
uint32_t Timeout)
Parameters
huart : uart handle

Return values
HAL status
Notes
None.
HAL_UART_Transmit_IT
DocID026525 Rev 1
UM1785
41.2.14
41.2.15
Function Name

HAL_StatusTypeDef HAL_UART_Transmit_IT (
UART_HandleTypeDef * huart, uint8_t * pData, uint16_t Size)
Parameters
huart : uart handle

Return values
HAL status
Notes
None.
HAL_UART_Receive_IT
Function Name
HAL_StatusTypeDef HAL_UART_Receive_IT (
Parameters
huart : uart handle

Return values
HAL status
Notes
None.
HAL_UART_Transmit_DMA
Function Name
HAL_StatusTypeDef HAL_UART_Transmit_DMA (
Parameters
huart : uart handle

Return values
HAL status
Notes
None.
DocID026525 Rev 1
629/692
41.2.16
41.2.17
41.2.18
630/692
UM1785
HAL_UART_Receive_DMA
Function Name
HAL_StatusTypeDef HAL_UART_Receive_DMA (
Parameters
huart : uart handle

Return values
HAL status
Notes
When the UART parity is enabled (PCE = 1), the received

data contain the parity bit (MSB position)
HAL_UART_DMAPause
Function Name
HAL_StatusTypeDef HAL_UART_DMAPause (
Parameters
huart : UART handle
Return values
None.
Notes
None.
HAL_UART_DMAResume
Function Name
HAL_StatusTypeDef HAL_UART_DMAResume (
Parameters
huart : UART handle
Return values
None.
Notes
None.
DocID026525 Rev 1
UM1785
41.2.19
41.2.20
41.2.21
HAL_UART_DMAStop
Function Name
HAL_StatusTypeDef HAL_UART_DMAStop (
Parameters
huart : UART handle
Return values
None.
Notes
None.
HAL_UART_TxCpltCallback
Function Name
void HAL_UART_TxCpltCallback ( UART_HandleTypeDef *

huart)
Parameters
huart : uart handle
Return values
None.
Notes
None.
Function Name
void HAL_UART_TxHalfCpltCallback ( UART_HandleTypeDef *

huart)
Parameters
huart : UART handle
Return values
None.
Notes
None.
DocID026525 Rev 1
631/692
41.2.22
41.2.23
41.2.24
632/692
UM1785
HAL_UART_RxCpltCallback
Function Name
void HAL_UART_RxCpltCallback ( UART_HandleTypeDef *

huart)
Parameters
huart : uart handle
Return values
None.
Notes
None.
Function Name
void HAL_UART_RxHalfCpltCallback ( UART_HandleTypeDef

* huart)
Parameters
huart : UART handle
Return values
None.
Notes
None.
HAL_UART_ErrorCallback
Function Name
void HAL_UART_ErrorCallback ( UART_HandleTypeDef *

huart)
UART error callbacks.
Parameters
huart : uart handle
Return values
None.
Notes
None.
DocID026525 Rev 1
UM1785
41.2.25
41.2.26
41.2.27
HAL_MultiProcessor_EnableMuteMode
Function Name
HAL_StatusTypeDef HAL_MultiProcessor_EnableMuteMode (
Enable UART in mute mode (doesn't mean UART enters mute

mode; to enter mute mode,
HAL_MultiProcessor_EnterMuteMode() API must be called)
Parameters
huart : UART handle
Return values
HAL status
Notes
None.
HAL_MultiProcessor_DisableMuteMode
Function Name
HAL_StatusTypeDef HAL_MultiProcessor_DisableMuteMode (
Disable UART mute mode (doesn't mean it actually wakes up the

software, as it may not have been in mute mode at this very
moment).
Parameters
huart : uart handle
Return values
HAL status
Notes
None.
HAL_MultiProcessor_EnterMuteMode
Function Name
void HAL_MultiProcessor_EnterMuteMode (
Enter UART mute mode (means UART actually enters mute

mode).
DocID026525 Rev 1
633/692

Parameters
41.2.28
41.2.29
41.2.30
634/692
UM1785
huart : uart handle
Return values
HAL status
Notes
None.
HAL_HalfDuplex_EnableTransmitter
Function Name
HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter (
Enables the UART transmitter and disables the UART receiver.
Parameters
huart : UART handle
Return values
HAL.
Notes
None.
HAL_HalfDuplex_EnableReceiver
Function Name
HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver (
Enables the UART receiver and disables the UART transmitter.
Parameters
huart : UART handle
Return values
HAL status
Notes
None.
HAL_UART_GetState
Function Name
HAL_UART_StateTypeDef HAL_UART_GetState (
return the UART state
DocID026525 Rev 1
UM1785
41.2.31

Parameters
huart : uart handle
Return values
HAL state
Notes
None.
HAL_UART_GetError
Function Name
uint32_t HAL_UART_GetError ( UART_HandleTypeDef *

huart)
Return the UART error code.
Parameters
huart : : pointer to a UART_HandleTypeDef structure that

contains the configuration information for the specified UART.
Return values
UART Error Code
Notes
None.
41.3
UART Firmware driver defines
41.3.1
UART
UART
UART Advanced Feature Initialization Type
UART_ADVFEATURE_NO_INIT
UART_ADVFEATURE_TXINVERT_INIT
UART_ADVFEATURE_RXINVERT_INIT
UART_ADVFEATURE_DATAINVERT_INIT
UART_ADVFEATURE_SWAP_INIT
UART_ADVFEATURE_RXOVERRUNDISABLE_INIT
UART_ADVFEATURE_DMADISABLEONERROR_INIT
UART_ADVFEATURE_AUTOBAUDRATE_INIT
UART_ADVFEATURE_MSBFIRST_INIT
IS_UART_ADVFEATURE_INIT
UART Advanced Feature Auto BaudRate Enable
UART_ADVFEATURE_AUTOBAUDRATE_DISABLE
DocID026525 Rev 1
635/692

UART_ADVFEATURE_AUTOBAUDRATE_ENABLE
UM1785
IS_UART_ADVFEATURE_AUTOBAUDRATE
UART Driver Enable Assertion Time LSB Position In CR1 Register
UART_CR1_DEAT_ADDRESS_LSB_POS
UART Driver Enable DeAssertion Time LSB Position In CR1 Register
UART_CR1_DEDT_ADDRESS_LSB_POS
UART Address-matching LSB Position In CR2 Register
UART_CR2_ADDRESS_LSB_POS
UART Advanced Feature Binary Data Inversion
UART_ADVFEATURE_DATAINV_DISABLE
UART_ADVFEATURE_DATAINV_ENABLE
IS_UART_ADVFEATURE_DATAINV
UART Advanced Feature DMA Disable On Rx Error
UART_ADVFEATURE_DMA_ENABLEONRXERROR
UART_ADVFEATURE_DMA_DISABLEONRXERROR
IS_UART_ADVFEATURE_DMAONRXERROR
UART DMA Rx
UART_DMA_RX_DISABLE
UART_DMA_RX_ENABLE
IS_UART_DMA_RX
UART DMA Tx
UART_DMA_TX_DISABLE
UART_DMA_TX_ENABLE
IS_UART_DMA_TX
UART DriverEnable Polarity
UART_DE_POLARITY_HIGH
UART_DE_POLARITY_LOW
IS_UART_DE_POLARITY
UART Exported Macros
__HAL_UART_RESET_HANDLE_STA
TE
Description:
Reset UART handle state.
Parameters:
__HANDLE__: UART handle.
Return value:
__HAL_UART_GET_FLAG
Description:
636/692
None:
Checks whether the specified UART flag is
DocID026525 Rev 1
UM1785

set or not.
Parameters:
__HANDLE__: specifies the UART Handle.

This parameter can be UARTx where x: 1,
2, 3 or 4 to select the USART or UART
peripheral (datasheet: up to four
USART/UARTs)
values:
UART_FLAG_REACK: Receive enable

ackowledge flag
UART_FLAG_TEACK: Transmit enable

ackowledge flag
UART_FLAG_WUF: Wake up from

stop mode flag (not available on
F030xx devices)
UART_FLAG_RWU: Receiver wake up

flag (not available on F030xx devices)
UART_FLAG_SBKF: Send Break flag
UART_FLAG_CMF: Character match

flag
UART_FLAG_BUSY: Busy flag
UART_FLAG_ABRF: Auto Baud rate

detection flag
UART_FLAG_ABRE: Auto Baud rate

detection error flag
UART_FLAG_EOBF: End of block flag

(not available on F030xx devices)
UART_FLAG_RTOF: Receiver timeout

flag
UART_FLAG_CTS: CTS Change flag
UART_FLAG_LBD: LIN Break

detection flag (not available on F030xx
devices)
UART_FLAG_TXE: Transmit data

register empty flag
UART_FLAG_TC: Transmission
Complete flag
UART_FLAG_RXNE: Receive data

UART_FLAG_IDLE: Idle Line detection

flag
UART_FLAG_ORE: OverRun Error

flag
UART_FLAG_NE: Noise Error flag
UART_FLAG_FE: Framing Error flag
UART_FLAG_PE: Parity Error flag
Return value:

FALSE).
DocID026525 Rev 1
637/692

__HAL_UART_ENABLE_IT
UM1785
Description:
Enables the specified UART interrupt.
Parameters:

peripheral. (datasheet: up to four
USART/UARTs)
__INTERRUPT__: specifies the UART
UART_IT_WUF: Wakeup from stop

mode interrupt (not available on
F030xx devices)
UART_IT_CM: Character match

interrupt
UART_IT_CTS: CTS change interrupt
UART_IT_LBD: LIN Break detection

interrupt (not available on F030xx
devices)
UART_IT_TXE: Transmit Data Register

empty interrupt
UART_IT_TC: Transmission complete

interrupt
UART_IT_RXNE: Receive Data

register not empty interrupt
UART_IT_IDLE: Idle line detection

interrupt
UART_IT_PE: Parity Error interrupt
UART_IT_ERR: Error interrupt(Frame

Return value:
__HAL_UART_DISABLE_IT
None:
Description:
Disables the specified UART interrupt.
Parameters:
638/692

USART/UARTs)
__INTERRUPT__: specifies the UART

F030xx devices)

interrupt
DocID026525 Rev 1
UM1785

devices)
empty interrupt
interrupt
interrupt
UART_IT_ERR: Error interrupt(Frame
Return value:
__HAL_UART_GET_IT
None:
Description:
Checks whether the specified UART

Parameters:

USART/UARTs)
__IT__: specifies the UART interrupt to
check. This parameter can be one of the
following values:

F030xx devices)

interrupt

devices)

empty interrupt

interrupt


interrupt
UART_IT_ORE: OverRun Error

interrupt
UART_IT_NE: Noise Error interrupt
UART_IT_FE: Framing Error interrupt
DocID026525 Rev 1
639/692
UM1785
Return value:
__HAL_UART_GET_IT_SOURCE
Description:
Checks whether the specified UART

interrupt source is enabled.
Parameters:

USART/UARTs)
__IT__: specifies the UART interrupt source
following values:

F030xx devices)

interrupt

devices)

empty interrupt

interrupt


interrupt
UART_IT_ORE: OverRun Error

interrupt
UART_IT_NE: Noise Error interrupt
UART_IT_FE: Framing Error interrupt
Return value:
__HAL_UART_CLEAR_IT
Description:
Clears the specified UART ISR flag, in

Parameters:
640/692

USART/UARTs)
DocID026525 Rev 1
UM1785

UART_CLEAR_PEF: Parity Error Clear

Flag
UART_CLEAR_FEF: Framing Error

Clear Flag
UART_CLEAR_NEF: Noise detected

Clear Flag
UART_CLEAR_OREF: OverRun Error

Clear Flag
UART_CLEAR_IDLEF: IDLE line

detected Clear Flag
UART_CLEAR_TCF: Transmission
Complete Clear Flag
UART_CLEAR_LBDF: LIN Break

Detection Clear Flag (not available on
F030xx devices)
UART_CLEAR_CTSF: CTS Interrupt

Clear Flag
UART_CLEAR_RTOF: Receiver Time

Out Clear Flag
UART_CLEAR_EOBF: End Of Block

Clear Flag (not available on F030xx
devices)
UART_CLEAR_CMF: Character Match

Clear Flag
UART_CLEAR_WUF: Wake Up from

stop mode Clear Flag (not available on
F030xx devices)
Return value:
__HAL_UART_SEND_REQ
None:
Description:
Set a specific UART request flag.
Parameters:

USART/UARTs)
values:
UART_AUTOBAUD_REQUEST: AutoBaud Rate Request
UART_SENDBREAK_REQUEST:
Send Break Request
UART_MUTE_MODE_REQUEST:
Mute Mode Request
UART_RXDATA_FLUSH_REQUEST:
UART_TXDATA_FLUSH_REQUEST:
DocID026525 Rev 1
641/692
UM1785
Transmit data flush Request (not
available on F030xx devices)
Return value:
__HAL_UART_ENABLE
None:
Description:
Enable UART.
Parameters:

x: 1, 2, 3, 4 or 5 to select the UART
peripheral
Return value:
__HAL_UART_DISABLE
None:
Description:
Disable UART.
Parameters:

x: 1, 2, 3, 4 or 5 to select the UART
peripheral
Return value:
None:
UARTEx Status Flags

UART_FLAG_REACK
UART_FLAG_TEACK
UART_FLAG_WUF
UART_FLAG_RWU
UART_FLAG_SBKF
UART_FLAG_CMF
UART_FLAG_BUSY
UART_FLAG_ABRF
UART_FLAG_ABRE
UART_FLAG_EOBF
UART_FLAG_RTOF
UART_FLAG_CTS
UART_FLAG_CTSIF
UART_FLAG_LBDF
UART_FLAG_TXE
642/692
DocID026525 Rev 1
UM1785

UART_FLAG_TC
UART_FLAG_RXNE
UART_FLAG_IDLE
UART_FLAG_ORE
UART_FLAG_NE
UART_FLAG_FE
UART_FLAG_PE
UART Half Duplex Selection
UART_HALF_DUPLEX_DISABLE
UART_HALF_DUPLEX_ENABLE
IS_UART_HALF_DUPLEX
UART Hardware Flow Control
UART_HWCONTROL_NONE
UART_HWCONTROL_RTS
UART_HWCONTROL_CTS
UART_HWCONTROL_RTS_CTS
IS_UART_HARDWARE_FLOW_CONTROL
UART Interruptions Flag Mask
UART_IT_MASK
UARTEx Interrupts Definition
UART_IT_PE
UART_IT_TXE
UART_IT_TC
UART_IT_RXNE
UART_IT_IDLE
UART_IT_LBD
UART_IT_CTS
UART_IT_CM
UART_IT_WUF
UART IT
UART_IT_ERR
UART_IT_ORE
UART_IT_NE
UART_IT_FE
UARTEx Interruption Clear Flags
UART_CLEAR_PEF
DocID026525 Rev 1
643/692

UART_CLEAR_FEF
UM1785
UART_CLEAR_NEF
UART_CLEAR_OREF
UART_CLEAR_IDLEF
IDLE line detected Clear Flag
UART_CLEAR_TCF
UART_CLEAR_LBDF
LIN Break Detection Clear Flag (not available on F030xx devices)
UART_CLEAR_CTSF
CTS Interrupt Clear Flag
UART_CLEAR_RTOF
Receiver Time Out Clear Flag
UART_CLEAR_EOBF
End Of Block Clear Flag
UART_CLEAR_CMF
Character Match Clear Flag
UART_CLEAR_WUF
Wake Up from stop mode Clear Flag
UART Transfer Mode

UART_MODE_RX
UART_MODE_TX
UART_MODE_TX_RX
IS_UART_MODE
UART Advanced Feature MSB First
UART_ADVFEATURE_MSBFIRST_DISABLE
UART_ADVFEATURE_MSBFIRST_ENABLE
IS_UART_ADVFEATURE_MSBFIRST
UART Advanced Feature Mute Mode Enable
UART_ADVFEATURE_MUTEMODE_DISABLE
UART_ADVFEATURE_MUTEMODE_ENABLE
IS_UART_MUTE_MODE
UART One Bit Sampling Method
UART_ONEBIT_SAMPLING_DISABLED
UART_ONEBIT_SAMPLING_ENABLED
IS_UART_ONEBIT_SAMPLING
UART One Bit sampling
UART_ONE_BIT_SAMPLE_DISABLED
UART_ONE_BIT_SAMPLE_ENABLED
IS_UART_ONEBIT_SAMPLE
UART Advanced Feature Overrun Disable
UART_ADVFEATURE_OVERRUN_ENABLE
UART_ADVFEATURE_OVERRUN_DISABLE
IS_UART_OVERRUN
UART Over Sampling
644/692
DocID026525 Rev 1
UM1785

UART_OVERSAMPLING_16
UART_OVERSAMPLING_8
IS_UART_OVERSAMPLING
UART Parity
UART_PARITY_NONE
UART_PARITY_EVEN
UART_PARITY_ODD
IS_UART_PARITY
UART Private Constants
HAL_UART_TXDMA_TIMEOUTVALUE
UART_CR1_FIELDS
UART Private Macros
Description:
__DIV_SAMPLING8
BRR division operation to set BRR register in 8-bit

oversampling mode.
Parameters:
_PCLK_: UART clock

_BAUD_: Baud rate set by the user
Return value:
Division: result
Description:
__DIV_SAMPLING16
BRR division operation to set BRR register in 16-bit

oversampling mode.
Parameters:
_PCLK_: UART clock

_BAUD_: Baud rate set by the user
Return value:
Division: result
Description:
IS_UART_BAUDRATE
Check UART Baud rate.
Parameters:
BAUDRATE: Baudrate specified by the user The

maximum Baud Rate is derived from the maximum
clock on F0 (i.e. 48 MHz) divided by the smallest
oversampling used on the USART (i.e. 8)
Return value:
IS_UART_ASSERTIONTIME
Description:
DocID026525 Rev 1
645/692
UM1785
Check UART assertion time.
Parameters:
TIME: 5-bit value assertion time
Return value:
IS_UART_DEASSERTIONTIME
Description:
Check UART deassertion time.
Parameters:
TIME: 5-bit value deassertion time
Return value:
UART Receiver TimeOut

UART_RECEIVER_TIMEOUT_DISABLE
UART_RECEIVER_TIMEOUT_ENABLE
IS_UART_RECEIVER_TIMEOUT
UARTEx Request Parameters
UART_AUTOBAUD_REQUEST
Auto-Baud Rate Request
UART_SENDBREAK_REQUEST
Send Break Request
UART_MUTE_MODE_REQUEST
Mute Mode Request
UART_RXDATA_FLUSH_REQUEST
UART_TXDATA_FLUSH_REQUEST
IS_UART_REQUEST_PARAMETER
UART Advanced Feature RX Pin Active Level Inversion
UART_ADVFEATURE_RXINV_DISABLE
UART_ADVFEATURE_RXINV_ENABLE
IS_UART_ADVFEATURE_RXINV
UART Advanced Feature RX TX Pins Swap
UART_ADVFEATURE_SWAP_DISABLE
UART_ADVFEATURE_SWAP_ENABLE
IS_UART_ADVFEATURE_SWAP
UART State
UART_STATE_DISABLE
UART_STATE_ENABLE
IS_UART_STATE
UART Number of Stop Bits
UART_STOPBITS_1
646/692
DocID026525 Rev 1
UM1785

UART_STOPBITS_2
UART_STOPBITS_1_5
IS_UART_STOPBITS
UARTEx Advanced Feature Stop Mode Enable
UART_ADVFEATURE_STOPMODE_DISABLE
UART_ADVFEATURE_STOPMODE_ENABLE
IS_UART_ADVFEATURE_STOPMODE
UART polling-based communications time-out value
HAL_UART_TIMEOUT_VALUE
UART Advanced Feature TX Pin Active Level Inversion
UART_ADVFEATURE_TXINV_DISABLE
UART_ADVFEATURE_TXINV_ENABLE
IS_UART_ADVFEATURE_TXINV
UART WakeUp Address Length
UART_ADDRESS_DETECT_4B
UART_ADDRESS_DETECT_7B
IS_UART_ADDRESSLENGTH_DETECT
UART WakeUp From Stop Selection
UART_WAKEUP_ON_ADDRESS
UART_WAKEUP_ON_STARTBIT
UART_WAKEUP_ON_READDATA_NONEMPTY
IS_UART_WAKEUP_SELECTION
UART WakeUp Methods
UART_WAKEUPMETHOD_IDLELINE
UART_WAKEUPMETHOD_ADDRESSMARK
IS_UART_WAKEUPMETHOD
DocID026525 Rev 1
647/692
HAL UART Extension Driver
UM1785
42
42.1
UARTEx Firmware driver API description

The following section lists the various functions of the UARTEx library.
42.1.1

This subsection provides a set of functions allowing to initialize the USARTx or the UARTy
in asynchronous mode.
Baud Rate
Word Length (Fixed to 8-bits only for LIN mode)
Stop Bit
length defined by the M bit (8-bits or 9-bits), the possible UART frame formats are
as listed in the following table: |-----------|-----------|---------------------------------------| |
M1M0 bits | PCE bit | UART frame | |-----------------------|--------------------------------------| | 00 | 0 | | SB | 8-bit data | STB | | |-----------|-----------|--------------------------------------| | 00 | 1 | | SB | 7-bit data | PB | STB | | |-----------|-----------|--------------------------------------| | 01 | 0 | | SB | 9-bit data | STB | | |-----------|-----------|--------------------------------------| | 01 | 1 | | SB | 8-bit data | PB | STB | | +--------------------------------------------------------------+ | 10 | 0 | | SB | 7-bit data | STB | | |-----------|-----------|--------------------------------------| | 10 | 1 | | SB | 6-bit data | PB | STB | | +--------------------------------------------------------------+
Hardware flow control
Over Sampling Method
One-Bit Sampling Method

For the asynchronous mode, the following advanced features can be configured as
well:
RX and TX pins swap
auto Baud rate detection
The HAL_LIN_Init() and HAL_RS485Ex_Init() APIs follows respectively the LIN and the
UART RS485 mode configuration procedures (details for the procedures are available in
reference manual).
42.1.2
648/692
HAL_RS485Ex_Init()
HAL_LIN_Init()
IO operation function
DocID026525 Rev 1
UM1785

This subsection provides functions allowing to manage the UART interrupts and to handle
Wake up interrupt call-back.
1.
2.
42.1.3
Non-Blocking mode API with Interrupt is :
Callback provided in No_Blocking mode:
HAL_UART_WakeupCallback()
HAL_UART_WakeupCallback()

This subsection provides extended functions allowing to control the UART.
42.1.4
HAL_MultiProcessorEx_AddressLength_Set() API optionally sets the UART node

address detection length to more than 4 bits for multiprocessor address mark wake
up.
HAL_UARTEx_StopModeWakeUpSourceConfig() API sets Wakeup from Stop mode
interrupt flag selection
HAL_UARTEx_EnableStopMode() API allows the UART to wake up the MCU from
Stop mode as long as UART clock is HSI or LSE
HAL_UARTEx_DisableStopMode() API disables the above feature
HAL_LIN_SendBreak() API transmits the break characters
HAL_UARTEx_StopModeWakeUpSourceConfig()
HAL_UARTEx_EnableStopMode()
HAL_UARTEx_DisableStopMode()
HAL_MultiProcessorEx_AddressLength_Set()
HAL_LIN_SendBreak()
HAL_RS485Ex_Init
Function Name
HAL_StatusTypeDef HAL_RS485Ex_Init (
UART_HandleTypeDef * huart, uint32_t UART_DEPolarity,
uint32_t UART_DEAssertionTime, uint32_t
UART_DEDeassertionTime)
Initializes the RS485 Driver enable feature according to the

specified parameters in the UART_InitTypeDef and creates the
associated handle .
Parameters
huart : uart handle

UART_DEPolarity : select the driver enable polarity This
UART_DE_POLARITY_HIGH DE signal is active high
UART_DE_POLARITY_LOW DE signal is active low

UART_DEAssertionTime : Driver Enable assertion time 5bit value defining the time between the activation of the DE
(Driver Enable) signal and the beginning of the start bit. It is
expressed in sample time units (1/8 or 1/16 bit time,
depending on the oversampling rate)
UART_DEDeassertionTime : Driver Enable deassertion
time 5-bit value defining the time between the end of the last
stop bit, in a transmitted message, and the de-activation of
DocID026525 Rev 1
649/692
42.1.5
42.1.6
650/692
UM1785
the DE (Driver Enable) signal. It is expressed in sample time
units (1/8 or 1/16 bit time, depending on the oversampling
rate).
Return values
HAL status
Notes
None.
HAL_LIN_Init
Function Name
HAL_StatusTypeDef HAL_LIN_Init ( UART_HandleTypeDef *

huart, uint32_t BreakDetectLength)
Initializes the LIN mode according to the specified parameters in

the UART_InitTypeDef and creates the associated handle.
Parameters
huart : uart handle

BreakDetectLength : specifies the LIN break detection
length. This parameter can be one of the following values:
UART_LINBREAKDETECTLENGTH_10B 10-bit break

detection
UART_LINBREAKDETECTLENGTH_11B 11-bit break

detection
Return values
HAL status
Notes
None.
HAL_UART_IRQHandler
Function Name
void HAL_UART_IRQHandler ( UART_HandleTypeDef * huart)
This function handles UART interrupt request.
Parameters
huart : uart handle
Return values
None.
Notes
None.
DocID026525 Rev 1
UM1785
42.1.7
42.1.8
42.1.9
HAL_UART_WakeupCallback
Function Name
void HAL_UART_WakeupCallback ( UART_HandleTypeDef *

huart)
UART wakeup from Stop mode callback.
Parameters
huart : uart handle
Return values
None.
Notes
None.
HAL_UARTEx_StopModeWakeUpSourceConfig
Function Name
HAL_StatusTypeDef
HAL_UARTEx_StopModeWakeUpSourceConfig (
UART_HandleTypeDef * huart, UART_WakeUpTypeDef
WakeUpSelection)
Set Wakeup from Stop mode interrupt flag selection.
Parameters
huart : uart handle,

WakeUpSelection : address match, Start Bit detection or
RXNE bit status. This parameter can be one of the following
values:
UART_WAKEUP_ON_ADDRESS
UART_WAKEUP_ON_STARTBIT
UART_WAKEUP_ON_READDATA_NONEMPTY
Return values
HAL status
Notes
None.
HAL_UARTEx_EnableStopMode
Function Name
HAL_StatusTypeDef HAL_UARTEx_EnableStopMode (
Enable UART Stop Mode The UART is able to wake up the MCU
from Stop mode as long as UART clock is HSI or LSE.
DocID026525 Rev 1
651/692

Parameters
42.1.10
42.1.11
42.1.12
652/692
UM1785
huart : uart handle
Return values
HAL status
Notes
None.
HAL_UARTEx_DisableStopMode
Function Name
HAL_StatusTypeDef HAL_UARTEx_DisableStopMode (
Disable UART Stop Mode.
Parameters
huart : uart handle
Return values
HAL status
Notes
None.
HAL_MultiProcessorEx_AddressLength_Set
Function Name
HAL_StatusTypeDef
HAL_MultiProcessorEx_AddressLength_Set (
UART_HandleTypeDef * huart, uint32_t AddressLength)
By default in multiprocessor mode, when the wake up method is

set to address mark, the UART handles only 4-bit long addresses
detection.
Notes
None.
HAL_LIN_SendBreak
Function Name
HAL_StatusTypeDef HAL_LIN_SendBreak (
Transmits break characters.
DocID026525 Rev 1
UM1785

Parameters
huart : UART handle
Return values
HAL status
Notes
None.
42.2
UARTEx Firmware driver defines
42.2.1
UARTEx
UARTEx
UARTEx Advanced Feature AutoBaud Rate Mode
UART_ADVFEATURE_AUTOBAUDRATE_ONSTARTBIT
UART_ADVFEATURE_AUTOBAUDRATE_ONFALLINGEDGE
UART_ADVFEATURE_AUTOBAUDRATE_ON0X7FFRAME
UART_ADVFEATURE_AUTOBAUDRATE_ON0X55FRAME
IS_UART_ADVFEATURE_AUTOBAUDRATEMODE
UARTEx Exported Macros
__HAL_UART_GETCLOCKSOURCE
Description:
Reports the UART clock source.
Parameters:
__HANDLE__: specifies the UART Handle

Return value:
__HAL_UART_MASK_COMPUTATION
UART: clocking source, written in

__CLOCKSOURCE__.
Description:
Computes the UART mask to apply to

retrieve the received data according to the
word length and to the parity bits activation.
Parameters:
__HANDLE__: specifies the UART Handle
Return value:
none:
UARTEx Local Interconnection Network mode

UART_LIN_DISABLE
UART_LIN_ENABLE
IS_UART_LIN
UARTEx LIN Break Detection
DocID026525 Rev 1
653/692

UART_LINBREAKDETECTLENGTH_10B
UART_LINBREAKDETECTLENGTH_11B
IS_UART_LIN_BREAK_DETECT_LENGTH
UARTEx Word Length
UART_WORDLENGTH_7B
UART_WORDLENGTH_8B
UART_WORDLENGTH_9B
IS_UART_WORD_LENGTH
654/692
DocID026525 Rev 1
UM1785
UM1785
HAL USART Generic Driver
43
43.1
USART Firmware driver registers structures
43.1.1
USART_InitTypeDef
USART_InitTypeDef is defined in the stm32f0xx_hal_usart.h
Data Fields
uint32_t BaudRate
uint32_t WordLength
uint32_t StopBits
uint32_t Parity
uint32_t Mode
uint32_t CLKPhase
uint32_t CLKLastBit
Field Documentation
43.1.2
uint32_t USART_InitTypeDef::BaudRate This member configures the Usart

communication baud rate. The baud rate is computed using the following formula:
Baud Rate Register = ((PCLKx) / ((huart->Init.BaudRate)))
uint32_t USART_InitTypeDef::WordLength Specifies the number of data bits
USARTEx_Word_Length
uint32_t USART_InitTypeDef::StopBits Specifies the number of stop bits
transmitted. This parameter can be a value of USART_Stop_Bits
uint32_t USART_InitTypeDef::Parity Specifies the parity mode. This parameter can
be a value of USART_Parity
uint32_t USART_InitTypeDef::Mode Specifies whether the Receive or Transmit
mode is enabled or disabled. This parameter can be a value of USART_Mode
uint32_t USART_InitTypeDef::CLKPolarity Specifies the steady state of the serial
clock. This parameter can be a value of USART_Clock_Polarity
uint32_t USART_InitTypeDef::CLKPhase Specifies the clock transition on which the
bit capture is made. This parameter can be a value of USART_Clock_Phase
uint32_t USART_InitTypeDef::CLKLastBit Specifies whether the clock pulse
corresponding to the last transmitted data bit (MSB) has to be output on the SCLK pin
in synchronous mode. This parameter can be a value of USART_Last_Bit
USART_HandleTypeDef
USART_HandleTypeDef is defined in the stm32f0xx_hal_usart.h
Data Fields
USART_InitTypeDef Init
DocID026525 Rev 1
655/692
UM1785
uint16_t TxXferSize
uint16_t RxXferSize
uint16_t Mask
HAL_USART_StateTypeDef State
HAL_USART_ErrorTypeDef ErrorCode
Field Documentation
43.2
USART_TypeDef* USART_HandleTypeDef::Instance USART registers base

address
USART_InitTypeDef USART_HandleTypeDef::Init USART communication
parameters
uint8_t* USART_HandleTypeDef::pTxBuffPtr Pointer to USART Tx transfer Buffer
uint16_t USART_HandleTypeDef::TxXferSize USART Tx Transfer size
uint16_t USART_HandleTypeDef::TxXferCount USART Tx Transfer Counter
uint8_t* USART_HandleTypeDef::pRxBuffPtr Pointer to USART Rx transfer Buffer
uint16_t USART_HandleTypeDef::RxXferSize USART Rx Transfer size
uint16_t USART_HandleTypeDef::RxXferCount USART Rx Transfer Counter
uint16_t USART_HandleTypeDef::Mask USART Rx RDR register mask
DMA_HandleTypeDef* USART_HandleTypeDef::hdmatx USART Tx DMA Handle
parameters
DMA_HandleTypeDef* USART_HandleTypeDef::hdmarx USART Rx DMA Handle
parameters
HAL_LockTypeDef USART_HandleTypeDef::Lock Locking object
HAL_USART_StateTypeDef USART_HandleTypeDef::State USART
communication state
HAL_USART_ErrorTypeDef USART_HandleTypeDef::ErrorCode USART Error
code
USART Firmware driver API description

The following section lists the various functions of the USART library.
43.2.1

The USART HAL driver can be used as follows:
1.
2.
656/692
Declare a USART_HandleTypeDef handle structure.

Initialize the USART low level resources by implementing the HAL_USART_MspInit
()API:
a.
b.
USART pins configuration:
Enable the clock for the USART GPIOs.
Configure these USART pins as alternate function pull-up.

DocID026525 Rev 1
UM1785

(HAL_USART_Transmit_IT(), HAL_USART_Receive_IT() and
HAL_USART_TransmitReceive_IT() APIs):

d.
(HAL_USART_Transmit_DMA() HAL_USART_Receive_DMA() and
HAL_USART_TransmitReceive_DMA() APIs):
parameters.
Associate the initilalized DMA handle to the USART DMA Tx/Rx handle.
Program the Baud Rate, Word Length , Stop Bit, Parity, Hardware flow control and
Mode(Receiver/Transmitter) in the husart Init structure.
Initialize the USART registers by calling the HAL_USART_Init() API:
These APIs configures also the low level Hardware GPIO, CLOCK,
CORTEX...etc) by calling the customed HAL_USART_MspInit(&husart) API. The
specific USART interrupts (Transmission complete interrupt, RXNE interrupt and
Error Interrupts) will be managed using the macros
__HAL_USART_ENABLE_IT() and __HAL_USART_DISABLE_IT() inside the
transmit and receive process.
c.
3.
4.
5.
Send an amount of data in blocking mode using HAL_USART_Transmit()

Receive an amount of data in blocking mode using HAL_USART_Receive()
Send an amount of data in non blocking mode using HAL_USART_Transmit_IT()

At transmission end of half transfer HAL_USART_TxHalfCpltCallback is executed and
HAL_USART_TxHalfCpltCallback
At transmission end of transfer HAL_USART_TxCpltCallback is executed and user
HAL_USART_TxCpltCallback
Receive an amount of data in non blocking mode using HAL_USART_Receive_IT()
At reception end of half transfer HAL_USART_RxHalfCpltCallback is executed and
HAL_USART_RxHalfCpltCallback
At reception end of transfer HAL_USART_RxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_USART_RxCpltCallback
In case of transfer Error, HAL_USART_ErrorCallback() function is executed and user
HAL_USART_ErrorCallback
DocID026525 Rev 1
657/692
UM1785

HAL_USART_Transmit_DMA()
At transmission end of half transfer HAL_USART_TxHalfCpltCallback is executed and
At transmission end of transfer HAL_USART_TxCpltCallback is executed and user
HAL_USART_Receive_DMA()
At reception end of half transfer HAL_USART_RxHalfCpltCallback is executed and
At reception end of transfer HAL_USART_RxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_USART_RxCpltCallback
In case of transfer Error, HAL_USART_ErrorCallback() function is executed and user
Pause the DMA Transfer using HAL_USART_DMAPause()
Resume the DMA Transfer using HAL_USART_DMAResume()
Stop the DMA Transfer using HAL_USART_DMAStop()
USART HAL driver macros list

Below the list of most used macros in USART HAL driver.
__HAL_USART_ENABLE: Enable the USART peripheral

__HAL_USART_DISABLE: Disable the USART peripheral
__HAL_USART_GET_FLAG : Check whether the specified USART flag is set or not
__HAL_USART_CLEAR_FLAG : Clear the specified USART pending flag
__HAL_USART_ENABLE_IT: Enable the specified USART interrupt
__HAL_USART_DISABLE_IT: Disable the specified USART interrupt
You can refer to the USART HAL driver header file for more useful macros
43.2.2

This subsection provides a set of functions allowing to initialize the USART in
asynchronous and in synchronous modes.
658/692
Baud Rate
Word Length
Stop Bit
length defined by the M bit (8-bits or 9-bits) or by the M1 and M0 bits (7-bit, 8-bit
or 9-bit), the possible USART frame formats are as listed in the below table.
DocID026525 Rev 1
UM1785
USART polarity
USART phase
USART LastBit
Table 24: USART frame formats
M bit
PCE bit
USART frame
M1, M0 bits
PCE bit
USART frame
10
10
The HAL_USART_Init() function follows the USART synchronous configuration procedure

(details for the procedure are available in reference manual).
43.2.3
HAL_USART_Init()
HAL_USART_DeInit()
HAL_USART_MspInit()
HAL_USART_MspDeInit()
HAL_USART_CheckIdleState()
This subsection provides a set of functions allowing to manage the USART synchronous
data transfers.
The USART supports master mode only: it cannot receive or send data related to an input
clock (SCLK is always an output).
1.
2.
3.

transfer.

indicated through the dedicated USART IRQ when using Interrupt mode or the
DMA IRQ when using DMA mode. The HAL_USART_TxCpltCallback(),
HAL_USART_RxCpltCallback() and HAL_USART_TxRxCpltCallback() user
callbacks will be executed respectivelly at the end of the transmit or Receive
process The HAL_USART_ErrorCallback()user callback will be executed when a
communication error is detected
HAL_USART_Transmit()in simplex mode
HAL_USART_Receive() in full duplex receive only
HAL_USART_TransmitReceive() in full duplex mode

HAL_USART_Transmit_IT()in simplex mode
HAL_USART_Receive_IT() in full duplex receive only

DocID026525 Rev 1
659/692
4.
5.
43.2.4
UM1785
HAL_USART_TransmitReceive_IT()in full duplex mode
HAL_USART_IRQHandler()
HAL_USART_Transmit_DMA()in simplex mode
HAL_USART_Receive_DMA() in full duplex receive only
HAL_USART_TransmitReceive_DMA() in full duplex mode
HAL_USART_DMAPause()
HAL_USART_DMAResume()
HAL_USART_DMAStop()
HAL_USART_TxCpltCallback()
HAL_USART_RxCpltCallback()
HAL_USART_TxHalfCpltCallback()
HAL_USART_RxHalfCpltCallback()
HAL_USART_ErrorCallback()
HAL_USART_TxRxCpltCallback()
HAL_USART_Transmit()
HAL_USART_Receive()
HAL_USART_TransmitReceive()
HAL_USART_Transmit_IT()
HAL_USART_Receive_IT()
HAL_USART_TransmitReceive_IT()
HAL_USART_Transmit_DMA()
HAL_USART_Receive_DMA()
HAL_USART_TransmitReceive_DMA()
HAL_USART_DMAPause()
HAL_USART_DMAResume()
HAL_USART_DMAStop()
HAL_USART_IRQHandler()
HAL_USART_TxCpltCallback()
HAL_USART_TxHalfCpltCallback()
HAL_USART_RxCpltCallback()
HAL_USART_RxHalfCpltCallback()
HAL_USART_TxRxCpltCallback()
HAL_USART_ErrorCallback()

This subsection provides a set of functions allowing to control the USART.
43.2.5
660/692
HAL_USART_GetState() API can be helpful to check in run-time the state of the

USART peripheral.
USART_SetConfig() API is used to set the USART communication parameters.
USART_CheckIdleState() APi ensures that TEACK and/or REACK bits are set after
initialization
HAL_USART_GetState()
HAL_USART_GetError()
HAL_USART_Init
DocID026525 Rev 1
UM1785
Function Name
43.2.6
43.2.7
43.2.8

HAL_StatusTypeDef HAL_USART_Init (
USART_HandleTypeDef * husart)
Initializes the USART mode according to the specified parameters

in the USART_InitTypeDef and create the associated handle .
Parameters
husart : usart handle
Return values
HAL status
Notes
None.
HAL_USART_DeInit
Function Name
HAL_StatusTypeDef HAL_USART_DeInit (
DeInitializes the USART peripheral.
Parameters
Return values
HAL status
Notes
None.
HAL_USART_MspInit
Function Name
void HAL_USART_MspInit ( USART_HandleTypeDef * husart)
USART MSP Init.
Parameters
Return values
None.
Notes
None.
HAL_USART_MspDeInit
DocID026525 Rev 1
661/692

Function Name
43.2.9
UM1785
void HAL_USART_MspDeInit ( USART_HandleTypeDef *
husart)
USART MSP DeInit.
Parameters
Return values
None.
Notes
None.
HAL_USART_CheckIdleState
Function Name
HAL_StatusTypeDef HAL_USART_CheckIdleState (
Notes
43.2.10
43.2.11
662/692
None.
HAL_USART_Transmit
Function Name
HAL_StatusTypeDef HAL_USART_Transmit (
USART_HandleTypeDef * husart, uint8_t * pTxData, uint16_t
Simplex Send an amount of data in blocking mode.
Parameters
husart : USART handle

pTxData : pointer to data buffer
Return values
HAL status
Notes
None.
HAL_USART_Receive
DocID026525 Rev 1
UM1785
Function Name
43.2.12
43.2.13

HAL_StatusTypeDef HAL_USART_Receive (
USART_HandleTypeDef * husart, uint8_t * pRxData, uint16_t
Receive an amount of data in blocking mode To receive

synchronous data, dummy data are simultaneously transmitted.
Parameters

pRxData : pointer to data buffer
Return values
HAL status
Notes
None.
HAL_USART_TransmitReceive
Function Name
HAL_StatusTypeDef HAL_USART_TransmitReceive (
USART_HandleTypeDef * husart, uint8_t * pTxData, uint8_t *
pRxData, uint16_t Size, uint32_t Timeout)
Full-Duplex Send and Receive an amount of data in blocking

mode.
Parameters

pTxData : pointer to TX data buffer
pRxData : pointer to RX data buffer
Size : amount of data to be sent (same amount to be
received)
Return values
HAL status
Notes
None.
HAL_USART_Transmit_IT
Function Name
HAL_StatusTypeDef HAL_USART_Transmit_IT (
Size)
Parameters

DocID026525 Rev 1
663/692
43.2.14
43.2.15
664/692
UM1785

Return values
HAL status
Notes
None.
HAL_USART_Receive_IT
Function Name
HAL_StatusTypeDef HAL_USART_Receive_IT (
Size)
Receive an amount of data in blocking mode To receive

synchronous data, dummy data are simultaneously transmitted.
Parameters

Return values
HAL status
Notes
None.
HAL_USART_TransmitReceive_IT
Function Name
HAL_StatusTypeDef HAL_USART_TransmitReceive_IT (
Full-Duplex Send and Receive an amount of data in interrupt

mode.
Parameters

Size : amount of data to be sent (same amount to be
received)
Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
43.2.16
43.2.17
HAL_USART_Transmit_DMA
Function Name
HAL_StatusTypeDef HAL_USART_Transmit_DMA (
Size)
Parameters

Return values
HAL status
Notes
None.
HAL_USART_Receive_DMA
Function Name
HAL_StatusTypeDef HAL_USART_Receive_DMA (
Size)
Full-Duplex Receive an amount of data in non-blocking mode.
Parameters

Return values
HAL status
Notes
When the USART parity is enabled (PCE = 1), the received

data contain the parity bit (MSB position)
The USART DMA transmit channel must be configured in
order to generate the clock for the slave.
43.2.18
HAL_USART_TransmitReceive_DMA
Function Name
HAL_StatusTypeDef HAL_USART_TransmitReceive_DMA (
DocID026525 Rev 1
665/692
UM1785
43.2.19
43.2.20
666/692
Full-Duplex Transmit Receive an amount of data in non blocking

mode.
Parameters

Size : amount of data to be received/sent
Return values
HAL status
Notes
When the USART parity is enabled (PCE = 1) the data

received contain the parity bit.
HAL_USART_DMAPause
Function Name
HAL_StatusTypeDef HAL_USART_DMAPause (
Parameters
Return values
None.
Notes
None.
HAL_USART_DMAResume
Function Name
HAL_StatusTypeDef HAL_USART_DMAResume (
Parameters
Return values
None.
Notes
None.
DocID026525 Rev 1
UM1785
43.2.21
43.2.22
43.2.23
HAL_USART_DMAStop
Function Name
HAL_StatusTypeDef HAL_USART_DMAStop (
Parameters
Return values
None.
Notes
None.
HAL_USART_IRQHandler
Function Name
void HAL_USART_IRQHandler ( USART_HandleTypeDef *

husart)
This function handles USART interrupt request.
Parameters
Return values
None.
Notes
None.
Function Name
void HAL_USART_TxCpltCallback ( USART_HandleTypeDef *

husart)
Parameters
Return values
None.
Notes
None.
DocID026525 Rev 1
667/692
43.2.24
43.2.25
43.2.26
668/692
UM1785
Function Name
void HAL_USART_TxHalfCpltCallback (
Parameters
Return values
None.
Notes
None.
HAL_USART_RxCpltCallback
Function Name
void HAL_USART_RxCpltCallback ( USART_HandleTypeDef *

husart)
Parameters
Return values
None.
Notes
None.
Function Name
void HAL_USART_RxHalfCpltCallback (
Parameters
Return values
None.
Notes
None.
DocID026525 Rev 1
UM1785
43.2.27
43.2.28
43.2.29
HAL_USART_TxRxCpltCallback
Function Name
void HAL_USART_TxRxCpltCallback ( USART_HandleTypeDef

* husart)
Tx/Rx Transfers completed callback for the non-blocking process.
Parameters
Return values
None.
Notes
None.
Function Name
void HAL_USART_ErrorCallback ( USART_HandleTypeDef *

husart)
USART error callbacks.
Parameters
Return values
None.
Notes
None.
HAL_USART_GetState
Function Name
HAL_USART_StateTypeDef HAL_USART_GetState (
return the USART state
Parameters
Return values
HAL state
Notes
None.
DocID026525 Rev 1
669/692
43.2.30
UM1785
HAL_USART_GetError
Function Name
uint32_t HAL_USART_GetError ( USART_HandleTypeDef *

husart)
Return the USART error code.
Parameters
husart : : pointer to a USART_HandleTypeDef structure that

contains the configuration information for the specified
USART.
Return values
USART Error Code
Notes
None.
43.3
USART Firmware driver defines
43.3.1
USART
USART
USART Clock
USART_CLOCK_DISABLED
USART_CLOCK_ENABLED
IS_USART_CLOCK
USART Clock Phase
USART_PHASE_1EDGE
USART_PHASE_2EDGE
IS_USART_PHASE
USART Clock Polarity
USART_POLARITY_LOW
USART_POLARITY_HIGH
IS_USART_POLARITY
USART Exported Macros
__HAL_USART_RESET_HANDLE_ST
ATE
Description:
Reset USART handle state.
Parameters:
__HANDLE__: USART handle.
Return value:
670/692
None:
DocID026525 Rev 1
UM1785

Description:
__HAL_USART_GET_FLAG
Checks whether the specified USART flag is

set or not.
Parameters:
__HANDLE__: specifies the USART Handle

values:
USART_FLAG_REACK: Receive
enable ackowledge flag
USART_FLAG_TEACK: Transmit
enable ackowledge flag
USART_FLAG_BUSY: Busy flag
USART_FLAG_CTS: CTS Change flag
USART_FLAG_TXE: Transmit data

register empty flag
USART_FLAG_TC: Transmission
Complete flag
USART_FLAG_RXNE: Receive data

USART_FLAG_IDLE: Idle Line

detection flag
USART_FLAG_ORE: OverRun Error

flag
USART_FLAG_NE: Noise Error flag
USART_FLAG_FE: Framing Error flag
USART_FLAG_PE: Parity Error flag
Return value:
__HAL_USART_ENABLE_IT

FALSE).
Description:
Enables the specified USART interrupt.
Parameters:

__INTERRUPT__: specifies the USART
USART_IT_TXE: Transmit Data

USART_IT_TC: Transmission
complete interrupt
USART_IT_RXNE: Receive Data

USART_IT_IDLE: Idle line detection

interrupt
USART_IT_PE: Parity Error interrupt
USART_IT_ERR: Error interrupt(Frame

DocID026525 Rev 1
671/692
UM1785
Return value:
__HAL_USART_DISABLE_IT
None:
Description:
Disables the specified USART interrupt.
Parameters:
__HANDLE__: specifies the USART

Handle.
__INTERRUPT__: specifies the USART

complete interrupt


interrupt
USART_IT_ERR: Error interrupt(Frame

Return value:
__HAL_USART_GET_IT
None:
Description:
Checks whether the specified USART

Parameters:

__IT__: specifies the USART interrupt
source to check. This parameter can be one

complete interrupt


interrupt
USART_IT_ORE: OverRun Error

interrupt
USART_IT_NE: Noise Error interrupt
USART_IT_FE: Framing Error interrupt
Return value:
672/692
DocID026525 Rev 1
UM1785

__HAL_USART_GET_IT_SOURCE
Description:
Checks whether the specified USART

interrupt source is enabled.
Parameters:

Handle.
__IT__: specifies the USART interrupt
source to check. This parameter can be one

complete interrupt


interrupt
USART_IT_ORE: OverRun Error

interrupt
USART_IT_NE: Noise Error interrupt
USART_IT_FE: Framing Error interrupt
Return value:
__HAL_USART_CLEAR_IT
Description:
Clears the specified USART ISR flag, in

Parameters:

Handle.
USART_CLEAR_PEF: Parity Error

Clear Flag
USART_CLEAR_FEF: Framing Error

Clear Flag
USART_CLEAR_NEF: Noise detected

Clear Flag
USART_CLEAR_OREF: OverRun
Error Clear Flag
USART_CLEAR_IDLEF: IDLE line

detected Clear Flag
USART_CLEAR_TCF: Transmission
Complete Clear Flag
USART_CLEAR_CTSF: CTS Interrupt

Clear Flag
Return value:
DocID026525 Rev 1
673/692
UM1785
__HAL_USART_SEND_REQ
None:
Description:
Set a specific USART request flag.
Parameters:

Handle.
values:
USART_RXDATA_FLUSH_REQUEST
: Receive Data flush Request
USART_TXDATA_FLUSH_REQUEST:
Return value:
__HAL_USART_ENABLE
None:
Description:
Enable USART.
Parameters:

Handle.
Return value:
__HAL_USART_DISABLE
None:
Description:
Disable USART.
Parameters:

Handle.
Return value:
None:
USART Flags
USART_FLAG_REACK
USART_FLAG_TEACK
USART_FLAG_BUSY
USART_FLAG_CTS
USART_FLAG_CTSIF
USART_FLAG_LBDF
USART_FLAG_TXE
USART_FLAG_TC
USART_FLAG_RXNE
674/692
DocID026525 Rev 1
UM1785

USART_FLAG_IDLE
USART_FLAG_ORE
USART_FLAG_NE
USART_FLAG_FE
USART_FLAG_PE
USART interruptions flag mask
USART_IT_MASK
USART Interrupts Definition
USART_IT_PE
USART_IT_TXE
USART_IT_TC
USART_IT_RXNE
USART_IT_IDLE
USART_IT_ERR
USART_IT_ORE
USART_IT_NE
USART_IT_FE
USART Interruption Clear Flags
USART_CLEAR_PEF
USART_CLEAR_FEF
USART_CLEAR_NEF
USART_CLEAR_OREF
USART_CLEAR_IDLEF
IDLE line detected Clear Flag
USART_CLEAR_TCF
USART_CLEAR_CTSF
CTS Interrupt Clear Flag
USART Last Bit

USART_LASTBIT_DISABLE
USART_LASTBIT_ENABLE
IS_USART_LASTBIT
USART Mode
USART_MODE_RX
USART_MODE_TX
USART_MODE_TX_RX
IS_USART_MODE
USART Parity
USART_PARITY_NONE
DocID026525 Rev 1
675/692

USART_PARITY_EVEN
UM1785
USART_PARITY_ODD
IS_USART_PARITY
USART Private Constants
DUMMY_DATA
TEACK_REACK_TIMEOUT
USART_TXDMA_TIMEOUTVALUE
USART_TIMEOUT_VALUE
USART_CR1_FIELDS
USART_CR2_FIELDS
USART Private Macros
IS_USART_BAUDRATE
Description:
Check USART Baud rate.
Parameters:
BAUDRATE: Baudrate specified by the user The maximum

Baud Rate is derived from the maximum clock on F0 (i.e.
48 MHz) divided by the smallest oversampling used on the
USART (i.e. 8)
Return value:
USART Request Parameters

USART_RXDATA_FLUSH_REQUEST
USART_TXDATA_FLUSH_REQUEST
IS_USART_REQUEST_PARAMETER
USART Number of Stop Bits
USART_STOPBITS_1
USART_STOPBITS_2
USART_STOPBITS_1_5
IS_USART_STOPBITS
676/692
DocID026525 Rev 1
UM1785
HAL USART Extension Driver
44
HAL USART Extension Driver
44.1
USARTEx Firmware driver defines
44.1.1
USARTEx
USARTEx
USARTEx Exported Macros
__HAL_USART_GETCLOCKSOURCE
Description:
Reports the USART clock source.
Parameters:

Handle
Return value:
__HAL_USART_MASK_COMPUTATION
the: USART clocking source, written in

__CLOCKSOURCE__.
Description:
Reports the USART mask to apply to

retrieve the received data according to the
word length and to the parity bits
activation.
Parameters:

Handle
Return value:
none:
USARTEx Word Length

USART_WORDLENGTH_7B
USART_WORDLENGTH_8B
USART_WORDLENGTH_9B
IS_USART_WORD_LENGTH
DocID026525 Rev 1
677/692
HAL WWDG Generic Driver
UM1785
45
45.1
WWDG Firmware driver registers structures
45.1.1
WWDG_InitTypeDef
WWDG_InitTypeDef is defined in the stm32f0xx_hal_wwdg.h
Data Fields
uint32_t Prescaler
uint32_t Window
uint32_t Counter
Field Documentation
45.1.2
uint32_t WWDG_InitTypeDef::Prescaler Specifies the prescaler value of the

WWDG. This parameter can be a value of WWDG_Prescaler
uint32_t WWDG_InitTypeDef::Window Specifies the WWDG window value to be
compared to the downcounter. This parameter must be a number lower than
Max_Data = 0x80
uint32_t WWDG_InitTypeDef::Counter Specifies the WWDG free-running
downcounter value. This parameter must be a number between Min_Data = 0x40 and
Max_Data = 0x7F
WWDG_HandleTypeDef
WWDG_HandleTypeDef is defined in the stm32f0xx_hal_wwdg.h
Data Fields
WWDG_TypeDef * Instance
WWDG_InitTypeDef Init
__IO HAL_WWDG_StateTypeDef State
Field Documentation
45.2
WWDG_TypeDef* WWDG_HandleTypeDef::Instance Register base address

WWDG_InitTypeDef WWDG_HandleTypeDef::Init WWDG required parameters
HAL_LockTypeDef WWDG_HandleTypeDef::Lock WWDG locking object
__IO HAL_WWDG_StateTypeDef WWDG_HandleTypeDef::State WWDG
communication state
WWDG Firmware driver API description

The following section lists the various functions of the WWDG library.
45.2.1
678/692
WWDG specific features
DocID026525 Rev 1
UM1785

Once enabled the WWDG generates a system reset on expiry of a programmed time
period, unless the program refreshes the Counter (T[6;0] downcounter) before reaching
0x3F value (i.e. a reset is generated when the counter value rolls over from 0x40 to 0x3F).
45.2.2
An MCU reset is also generated if the counter value is refreshed before the counter
has reached the refresh window value. This implies that the counter must be refreshed
in a limited window.
Once enabled the WWDG cannot be disabled except by a system reset.
WWDGRST flag in RCC_CSR register can be used to inform when a WWDG reset
occurs.
The WWDG counter input clock is derived from the APB clock divided by a
programmable prescaler.
WWDG clock (Hz) = PCLK / (4096 * Prescaler)
WWDG timeout (mS) = 1000 * (T[5;0] + 1) / WWDG clock where T[5;0] are the lowest
6 bits of Counter.
WWDG Counter refresh is allowed between the following limits :
min time (mS) = 1000 * (Counter-Window) / WWDG clock
max time (mS) = 1000 * (Counter-0x40) / WWDG clock

Min-max timeout value @48 MHz(PCLK): ~85,3us / ~5,46 ms.
Enable WWDG APB1 clock using __WWDG_CLK_ENABLE().

Set the WWDG prescaler, refresh window and counter value using
HAL_WWDG_Init() function.
Start the WWDG using HAL_WWDG_Start() function. When the WWDG is enabled
the counter value should be configured to a value greater than 0x40 to prevent
generating an immediate reset.
Optionally you can enable the Early Wakeup Interrupt (EWI) which is generated when
the counter reaches 0x40, and then start the WWDG using HAL_WWDG_Start_IT().
At EWI HAL_WWDG_WakeupCallback is executed and user can add his own code by
customization of function pointer HAL_WWDG_WakeupCallback Once enabled, EWI
interrupt cannot be disabled except by a system reset.
Then the application program must refresh the WWDG counter at regular intervals
during normal operation to prevent an MCU reset, using HAL_WWDG_Refresh()
function. This operation must occur only when the counter is lower than the refresh
window value already programmed.
WWDG HAL driver macros list

Below the list of most used macros in WWDG HAL driver.
45.2.3
__HAL_WWDG_ENABLE: Enable the WWDG peripheral

__HAL_WWDG_GET_FLAG: Get the selected WWDG's flag status
__HAL_WWDG_CLEAR_FLAG: Clear the WWDG's pending flags
__HAL_WWDG_ENABLE_IT: Enables the WWDG early wakeup interrupt

DocID026525 Rev 1
679/692
45.2.4
UM1785
Initialize the WWDG according to the specified parameters in the WWDG_InitTypeDef

and create the associated handle
DeInitialize the WWDG peripheral
Initialize the WWDG MSP
DeInitialize the WWDG MSP
HAL_WWDG_Init()
HAL_WWDG_DeInit()
HAL_WWDG_MspInit()
HAL_WWDG_MspDeInit()
HAL_WWDG_WakeupCallback()
45.2.5
Start the WWDG.

Refresh the WWDG.
Handle WWDG interrupt request.
HAL_WWDG_Start()
HAL_WWDG_Start_IT()
HAL_WWDG_Refresh()
HAL_WWDG_IRQHandler()
HAL_WWDG_WakeupCallback()

45.2.6
680/692
HAL_WWDG_GetState()
HAL_WWDG_Init
Function Name
HAL_StatusTypeDef HAL_WWDG_Init (
WWDG_HandleTypeDef * hwwdg)
Initializes the WWDG according to the specified parameters in the

WWDG_InitTypeDef and creates the associated handle.
Parameters
hwwdg : pointer to a WWDG_HandleTypeDef structure that

WWDG module.
Return values
HAL status
Notes
None.
DocID026525 Rev 1
UM1785
45.2.7
45.2.8
45.2.9
HAL_WWDG_DeInit
Function Name
HAL_StatusTypeDef HAL_WWDG_DeInit (
DeInitializes the WWDG peripheral.
Parameters

WWDG module.
Return values
HAL status
Notes
None.
HAL_WWDG_MspInit
Function Name
void HAL_WWDG_MspInit ( WWDG_HandleTypeDef * hwwdg)
Initializes the WWDG MSP.
Parameters

WWDG module.
Return values
None.
Notes
None.
HAL_WWDG_MspDeInit
Function Name
void HAL_WWDG_MspDeInit ( WWDG_HandleTypeDef *

hwwdg)
DeInitializes the WWDG MSP.
Parameters

WWDG module.
Return values
None.
Notes
None.
DocID026525 Rev 1
681/692
45.2.10
45.2.11
45.2.12
682/692
UM1785
HAL_WWDG_WakeupCallback
Function Name
void HAL_WWDG_WakeupCallback ( WWDG_HandleTypeDef *

hwwdg)
Early Wakeup WWDG callback.
Parameters

WWDG module.
Return values
None.
Notes
None.
HAL_WWDG_Start
Function Name
HAL_StatusTypeDef HAL_WWDG_Start (
Starts the WWDG.
Parameters

WWDG module.
Return values
HAL status
Notes
None.
HAL_WWDG_Start_IT
Function Name
HAL_StatusTypeDef HAL_WWDG_Start_IT (
Starts the WWDG with interrupt enabled.
DocID026525 Rev 1
UM1785
45.2.13
45.2.14

Parameters

WWDG module.
Return values
HAL status
Notes
None.
HAL_WWDG_Refresh
Function Name
HAL_StatusTypeDef HAL_WWDG_Refresh (
WWDG_HandleTypeDef * hwwdg, uint32_t Counter)
Refreshes the WWDG.
Parameters

WWDG module.
Counter : value of counter to put in WWDG counter
Return values
HAL status
Notes
None.
HAL_WWDG_IRQHandler
Function Name
void HAL_WWDG_IRQHandler ( WWDG_HandleTypeDef *

hwwdg)
Handles WWDG interrupt request.
Parameters

WWDG module.
Return values
None.
Notes
The Early Wakeup Interrupt (EWI) can be used if specific

safety operations or data logging must be performed before
the actual reset is generated. The EWI interrupt is enabled
using __HAL_WWDG_ENABLE_IT() macro. When the
downcounter reaches the value 0x40, and EWI interrupt is
generated and the corresponding Interrupt Service Routine
(ISR) can be used to trigger specific actions (such as
communications or data logging), before resetting the device.
DocID026525 Rev 1
683/692
45.2.15
45.2.16
UM1785
HAL_WWDG_WakeupCallback
Function Name
void HAL_WWDG_WakeupCallback ( WWDG_HandleTypeDef *

hwwdg)
Early Wakeup WWDG callback.
Parameters

WWDG module.
Return values
None.
Notes
None.
HAL_WWDG_GetState
Function Name
HAL_WWDG_StateTypeDef HAL_WWDG_GetState (
Returns the WWDG state.
Parameters

WWDG module.
Return values
HAL state
Notes
None.
45.3
WWDG Firmware driver defines
45.3.1
WWDG
WWDG
WWDG BitAddress AliasRegion
CFR_BASE
WWDG Counter
684/692
DocID026525 Rev 1
UM1785

IS_WWDG_COUNTER
WWDG Exported Macros
__HAL_WWDG_RESET_HANDLE_STATE
Description:
Reset WWDG handle state.
Parameters:
__HANDLE__: WWDG handle
Return value:
None:
Description:
__HAL_WWDG_ENABLE
Enables the WWDG peripheral.
Parameters:
Return value:
None:
Description:
__HAL_WWDG_GET_FLAG
Gets the selected WWDG's flag status.
Parameters:

following values:
WWDG_FLAG_EWIF: Early
wakeup interrupt flag
Return value:
__HAL_WWDG_CLEAR_FLAG
The: new state of WWDG_FLAG (SET

or RESET).
Description:
Clears the WWDG's pending flags.
Parameters:

__FLAG__: specifies the flag to clear.
following values:
Return value:
__HAL_WWDG_ENABLE_IT
None:
Description:
DocID026525 Rev 1
Enables the WWDG early wakeup

interrupt.
685/692
UM1785
Parameters:

interrupt to enable. This parameter can
WWDG_IT_EWI: Early wakeup

interrupt
Return value:
__HAL_WWDG_CLEAR_IT
None:
Description:
Clear the WWDG's interrupt pending

bits bits to clear the selected interrupt
pending bits.
Parameters:

interrupt pending bit to clear. This
values:
WWDG Flag definition

WWDG_FLAG_EWIF
Early wakeup interrupt flag
WWDG Interrupt definition

WWDG_IT_EWI
WWDG Prescaler
WWDG_PRESCALER_1
WWDG counter clock = (PCLK1/4096)/1
WWDG_PRESCALER_2
WWDG_PRESCALER_4
WWDG_PRESCALER_8
IS_WWDG_PRESCALER
WWDG Window
IS_WWDG_WINDOW
686/692
DocID026525 Rev 1
UM1785
46
FAQs
FAQs
General subjects
Why should I use the HAL drivers?
There are many advantages in using the HAL drivers:
Ease of use: you can use the HAL drivers to configure and control any peripheral
embedded within your STM32 MCU without prior in-depth knowledge of the product.
HAL drivers provide intuitive and ready-to-use APIs to configure the peripherals and
support polling, interrupt and DMA programming model to accommodate all
application requirements, thus allowing the end-user to build a complete application by
calling a few APIs.
Higher level of abstraction than a standard peripheral library allowing to transparently
manage:
Data transfers and processing using blocking mode (polling) or non-blocking

mode (interrupt or DMA)
Error management through peripheral error detection and timeout mechanism.

Generic architecture speeding up initialization and porting, thus allowing customers to
focus on innovation.
Generic set of APIs with full compatibility across the STM32 series/lines, to ease the
porting task between STM32 MCUs.
The APIs provided within the HAL drivers are feature-oriented and do not required indepth knowledge of peripheral operation.
The APIs provided are modular. They include initialization, IO operation and control
functions. The end-user has to call init function, then start the process by calling one
IO operation functions (write, read, transmit, receive, ). Most of the peripherals have
the same architecture.
The number of functions required to build a complete and useful application is very
reduced. As an example, to build a UART communication process, the user only has
to call HAL_UART_Init() then HAL_UART_Transmit() or HAL_UART_Receive().
Which STM32F0 devices are supported by the HAL drivers?

The HAL drivers are developed to support all STM32F0 devices. To ensure compatibility
between all devices and portability with others series and lines, the API is split into the
generic and the extension APIs . For more details, please refer to Section 4.4: "Devices
supported by HAL drivers".
What is the cost of using HAL drivers in term of code size and performance?
Like generic architecture drivers, the HAL drivers may induce firmware overhead.
This is due to the high abstraction level and ready-to-use APIs which allow data transfers,
errors management and offloads the user application from implementation details.
Architecture
How many files should I modify to configure the HAL drivers?
Only one file needs to be modified: stm32f0xx_hal_conf.h. You can modify this file by
disabling unused modules, or adjusting some parameters (i.e. HSE value, System
configuration, )
DocID026525 Rev 1
687/692
FAQs
UM1785
A template is provided in the HAL drivers folders (stm32f0xx_hal_conf_template.c).
Which header files should I include in my application to use the HAL

drivers?
Only stm32f0xx_hal.h file has to be included.
What is the difference between stm32f0xx_hal_ppp.c/.h and

stm32f0xx_hal_ppp_ex.c/.h?
The HAL driver architecture supports common features across STM32 series/lines. To
support specific features, the drivers are split into two groups.
The generic APIs (stm32f0xx_hal_ppp.c): It includes the common set of APIs across
all the STM32 product lines
The extension APIs (stm32f0xx_hal_ppp_ex.c): It includes the specific APIs for
specific device part number or family.
Initialization and I/O operation functions

How do I configure the system clock?
Unlike the standard library, the system clock configuration is not performed in CMSIS
drivers file (system_stm32f0xx.c) but in the main user application by calling the two main
functions, HAL_RCC_OscConfig() and HAL_RCC_ClockConfig(). It can be modified in any
user application section.
What is the purpose of the PPP_HandleTypeDef *pHandle structure located

in each driver in addition to the Initialization structure
PPP_HandleTypeDef *pHandle is the main structure implemented in the HAL drivers. It
handles the peripheral configuration and registers, and embeds all the structures and
variables required to follow the peripheral device flow (pointer to buffer, Error code,
State,...)
However, this structure is not required to service peripherals such as GPIO, SYSTICK,
PWR, and RCC.
What is the purpose of HAL_PPP_MspInit() and HAL_PPP_MspDeInit()

functions?
These function are called within HAL_PPP_Init() and HAL_PPP_DeInit(), respectively.
They are used to perform the low level Initialization/de-initialization related to the additional
hardware resources (RCC, GPIO, NVIC and DMA).
These functions are declared in stm32f0xx_hal_msp.c. A template is provided in the HAL
driver folders (stm32f0xx_hal_msp_template.c).
When and how should I use callbacks functions (functions declared with the
attribute __weak)?
Use callback functions for the I/O operations used in DMA or interrupt mode. The PPP
process complete callbacks are called to inform the user about process completion in realtime event mode (interrupts).
The Errors callbacks are called when a processing error occurs in DMA or interrupt mode.
These callbacks are customized by the user to add user proprietary code. They can be
declared in the application. Note that the same process completion callbacks are used for
DMA and interrupt mode.
688/692
DocID026525 Rev 1
UM1785
FAQs
Is it mandatory to use HAL_Init() function at the beginning of the user

application?
It is mandatory to use HAL_Init() function to enable the system configuration (Prefetch,
Data instruction cache,), configure the systTick and the NVIC priority grouping and the
hardware low level initialization.
The sysTick configuration shall be adjusted by calling HAL_RCC_ClockConfig() function,
to obtain 1 ms whatever the system clock.
Why do I need to configure the SysTick timer to use the HAL drivers?
The SysTick timer is configured to be used to generate variable increments by calling
HAL_IncTick() function in Systick ISR and retrieve the value of this variable by calling
HAL_GetTick() function.
The call HAL_GetTick() function is mandatory when using HAL drivers with Polling
Process or when using HAL_Delay().
Why is the SysTick timer configured to have 1 ms?

This is mandatory to ensure correct IO operation in particular for polling mode operation
where the 1 ms is required as timebase.
Could HAL_Delay() function block my application under certain conditions?

Care must be taken when using HAL_Delay() since this function provides accurate delay
based on a variable incremented in SysTick ISR. This implies that if HAL_Delay() is called
from a peripheral ISR process, then the SysTick interrupt must have higher priority
(numerically lower) than the peripheral interrupt, otherwise the caller ISR process will be
blocked. Use HAL_NVIC_SetPriority() function to change the SysTick interrupt priority.
What programming model sequence should I follow to use HAL drivers ?

Follow the sequence below to use the APIs provided in the HAL drivers:
1.
2.
3.
4.
5.
6.
Call HAL_Init() function to initialize the system (data cache, NVIC priority,).
Initialize the system clock by calling HAL_RCC_OscConfig() followed by
HAL_RCC_ClockConfig().
Add HAL_IncTick() function under SysTick_Handler() ISR function to enable polling
process when using HAL_Delay() function
Start initializing your peripheral by calling HAL_PPP_Init().
Implement the hardware low level initialization (Peripheral clock, GPIO, DMA,..) by
calling HAL_PPP_MspInit() in stm32f0xx_hal_msp.c
Start your process operation by calling IO operation functions.
What is the purpose of HAL_PPP_IRQHandler() function and when should I

use it?
HAL_PPP_IRQHandler() is used to handle interrupt process. It is called under
PPP_IRQHandler() function in stm32f0xx_it.c. In this case, the end-user has to implement
only the callbacks functions (prefixed by __weak) to perform the appropriate action when
an interrupt is detected. Advanced users can implement their own code in
PPP_IRQHandler() without calling HAL_PPP_IRQHandler().
Can I use directly the macros defined in stm32f0xx_hal_ppp.h ?

Yes, you can: a set of macros is provided with the APIs. They allow accessing directly
some specific features using peripheral flags.
DocID026525 Rev 1
689/692
FAQs
UM1785
Where must PPP_HandleTypedef structure peripheral handler be declared?

PPP_HandleTypedef structure peripheral handler must be declared as a global variable, so
that all the structure fields are set to 0 by default. In this way, the peripheral handler default
state are set to HAL_PPP_STATE_RESET, which is the default state for each peripheral
after a system reset.
690/692
DocID026525 Rev 1
UM1785
47
Revision history
Revision history
Table 25: Document revision history
Date
Revision
Changes
21-Nov-2014
Initial release.
DocID026525 Rev 1
691/692
UM1785
IMPORTANT NOTICE PLEASE READ CAREFULLY
STMicroelectronics NV and its subsidiaries (ST) reserve the right to make changes, corrections, enhancements, modifications, and
improvements to ST products and/or to this document at any time without notice. Purchasers should obtain the latest relevant information on ST
products before placing orders. ST products are sold pursuant to STs terms and conditions of sale in place at the time of order
acknowledgement.
Purchasers are solely responsible for the choice, selection, and use of ST products and ST assumes no liability for application assistance or the
design of Purchasers products.
No license, express or implied, to any intellectual property right is granted by ST herein.
Resale of ST products with provisions different from the information set forth herein shall void any warranty granted by ST for such product.
ST and the ST logo are trademarks of ST. All other product or service names are the property of their respective owners.
Information in this document supersedes and replaces information previously supplied in any prior versions of this document.
2014 STMicroelectronics All rights reserved
692/692
DocID026525 Rev 1

DM 00122015

Uploaded by

Document Informationclick to expand document informationDescription of STM32F0xx HAL drivers

Document Informationclick to expand document information

Copyright:

Available Formats

DM 00122015

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

DM 00122015

Uploaded by

Copyright:

Available Formats

UM1785

STMCube is an STMicroelectronics original initiative to ease developers life by reducing development

A consistent set of middleware components such as RTOS, USB, TCP/IP, Graphics

All embedded software utilities coming with a full set of examples.

Overview of the HAL drivers

Acronyms and definitions............................................................. 35

Overview of HAL drivers ............................................................... 37

HAL driver files ................................................................................. 37

User-application files ........................................................................ 38

HAL data structures ........................................................................ 40

Peripheral handle structures ............................................................ 40

Initialization and configuration structure ........................................... 41

Specific process structures .............................................................. 42

API classification ............................................................................. 42

Devices supported by HAL drivers .................................................. 43

HAL drivers rules............................................................................. 45

HAL API naming rules ...................................................................... 45

HAL general naming rules ................................................................ 46

HAL interrupt handler and callback functions ................................... 47

HAL generic APIs ............................................................................ 48

HAL extension APIs ........................................................................ 49

HAL extension model overview ........................................................ 49

HAL extension model cases ............................................................. 49

File inclusion model......................................................................... 51

HAL common resources .................................................................. 52

HAL system peripheral handling ..................................................... 54

HAL and user-application files......................................................... 37

Cortex NVIC and SysTick timer........................................................ 56

How to use HAL drivers .................................................................. 60

HAL usage models ........................................................................... 60

HAL initialization ............................................................................... 60

HAL IO operation process ................................................................ 62

Timeout and error management ....................................................... 65

HAL System Driver ........................................................................ 70

HAL Firmware driver API description .............................................. 70

How to use this driver ....................................................................... 70

Initialization and de-initialization functions ....................................... 70

HAL Control functions....................................................................... 70

HAL Firmware driver defines ........................................................... 77

HAL ADC Generic Driver ............................................................... 81

ADC Firmware driver registers structures ....................................... 81

ADC Firmware driver API description.............................................. 84

ADC specific features ....................................................................... 84

How to use this driver ....................................................................... 85

Initialization and de-initialization functions ....................................... 85

IO operation functions ...................................................................... 86

Peripheral Control functions ............................................................. 86

Peripheral State and Errors functions .............................................. 86

ADC Firmware driver defines .......................................................... 95

HAL ADC Extension Driver ......................................................... 106

ADCEx Firmware driver API description ....................................... 106

ADC specific features ..................................................................... 106

How to use this driver ..................................................................... 106

IO operation functions .................................................................... 107

HAL_ADCEx_Calibration_Start ...................................................... 107

ADCEx Firmware driver defines .................................................... 107

ADCEx ............................................................................................ 107