dm00223149

UM1940
User Manual
Description of STM32F2xx 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 asSTM32CubeF2 for
stm32f2 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.
October 2015
DOCID028236 Rev 1
1/692
www.st.com
Contents
UM1940
Contents
1
Acronyms and definitions............................................................. 41
2
Overview of HAL drivers ............................................................... 43
2.1
2.2
2/692
2.1.1
HAL driver files ................................................................................. 43
2.1.2
User-application files ........................................................................ 45
HAL data structures ........................................................................ 46
2.2.1
Peripheral handle structures ............................................................ 46
2.2.2
Initialization and configuration structure ........................................... 48
2.2.3
Specific process structures .............................................................. 48
2.3
API classification ............................................................................. 48
2.4
Devices supported by HAL drivers .................................................. 49
2.5
HAL drivers rules............................................................................. 50
2.5.1
HAL API naming rules ...................................................................... 50
2.5.2
HAL general naming rules ................................................................ 51
2.5.3
HAL interrupt handler and callback functions ................................... 53
2.6
HAL generic APIs ............................................................................ 53
2.7
HAL extension APIs ........................................................................ 55
2.7.1
HAL extension model overview ........................................................ 55
2.7.2
HAL extension model cases ............................................................. 55
2.8
File inclusion model......................................................................... 57
2.9
HAL common resources .................................................................. 57
2.10
HAL configuration............................................................................ 58
2.11
HAL system peripheral handling ..................................................... 60
2.12
3
HAL and user-application files......................................................... 43
2.11.1
Clock ................................................................................................. 60
2.11.2
GPIOs ............................................................................................... 60
2.11.3
Cortex NVIC and SysTick timer........................................................ 62
2.11.4
PWR ................................................................................................. 62
2.11.5
EXTI .................................................................................................. 62
2.11.6
DMA .................................................................................................. 63
How to use HAL drivers .................................................................. 65
2.12.1
HAL usage models ........................................................................... 65
2.12.2
HAL initialization ............................................................................... 66
2.12.3
HAL IO operation process ................................................................ 68
2.12.4
Timeout and error management ....................................................... 71
HAL System Driver ........................................................................ 75
DOCID028236 Rev 1
UM1940
Contents
3.1
3.2
HAL Firmware driver API description .............................................. 75
3.1.1
How to use this driver ....................................................................... 75
3.1.2
Initialization and de-initialization functions ....................................... 75
3.1.3
HAL Control functions....................................................................... 75
3.1.4
HAL_Init ............................................................................................ 76
3.1.5
HAL_DeInit ....................................................................................... 76
3.1.6
HAL_MspInit ..................................................................................... 76
3.1.7
HAL_MspDeInit ................................................................................ 76
3.1.8
HAL_InitTick ..................................................................................... 77
3.1.9
HAL_IncTick ..................................................................................... 77
3.1.10
HAL_GetTick .................................................................................... 77
3.1.11
HAL_Delay ....................................................................................... 77
3.1.12
HAL_SuspendTick ............................................................................ 78
3.1.13
HAL_ResumeTick............................................................................. 78
3.1.14
HAL_GetHalVersion ......................................................................... 78
3.1.15
HAL_GetREVID ................................................................................ 78
3.1.16
HAL_GetDEVID ................................................................................ 78
3.1.17
HAL_DBGMCU_EnableDBGSleepMode ......................................... 79
3.1.18
HAL_DBGMCU_DisableDBGSleepMode ........................................ 79
3.1.19
HAL_DBGMCU_EnableDBGStopMode ........................................... 79
3.1.20
HAL_DBGMCU_DisableDBGStopMode .......................................... 79
3.1.21
HAL_DBGMCU_EnableDBGStandbyMode ..................................... 79
3.1.22
HAL_DBGMCU_DisableDBGStandbyMode .................................... 79
3.1.23
HAL_EnableCompensationCell ........................................................ 79
3.1.24
HAL_DisableCompensationCell ....................................................... 80
HAL Firmware driver defines ........................................................... 80
3.2.1
4
HAL ................................................................................................... 80
HAL ADC Generic Driver ............................................................... 83
4.1
4.2
ADC Firmware driver registers structures ....................................... 83
4.1.1
ADC_InitTypeDef .............................................................................. 83
4.1.2
ADC_ChannelConfTypeDef ............................................................. 84
4.1.3
ADC_AnalogWDGConfTypeDef ....................................................... 85
4.1.4
ADC_HandleTypeDef ....................................................................... 86
ADC Firmware driver API description.............................................. 86
4.2.1
ADC Peripheral features................................................................... 86
4.2.2
How to use this driver ....................................................................... 87
4.2.3
Initialization and de-initialization functions ....................................... 89
4.2.4
IO operation functions ...................................................................... 89
DOCID028236 Rev 1
3/692
Contents
4.3
4.2.5
UM1940
Peripheral Control functions ............................................................. 90
4.2.6
Peripheral State and errors functions ............................................... 90
4.2.7
HAL_ADC_Init .................................................................................. 90
4.2.8
HAL_ADC_DeInit .............................................................................. 90
4.2.9
HAL_ADC_MspInit ........................................................................... 91
4.2.10
HAL_ADC_MspDeInit ....................................................................... 91
4.2.11
HAL_ADC_Start ............................................................................... 91
4.2.12
HAL_ADC_Stop ................................................................................ 91
4.2.13
HAL_ADC_PollForConversion ......................................................... 91
4.2.14
HAL_ADC_PollForEvent .................................................................. 92
4.2.15
HAL_ADC_Start_IT .......................................................................... 92
4.2.16
HAL_ADC_Stop_IT .......................................................................... 92
4.2.17
HAL_ADC_IRQHandler .................................................................... 93
4.2.18
HAL_ADC_Start_DMA ..................................................................... 93
4.2.19
HAL_ADC_Stop_DMA...................................................................... 93
4.2.20
HAL_ADC_GetValue ........................................................................ 93
4.2.21
HAL_ADC_ConvCpltCallback .......................................................... 93
4.2.22
HAL_ADC_ConvHalfCpltCallback .................................................... 94
4.2.23
HAL_ADC_LevelOutOfWindowCallback .......................................... 94
4.2.24
HAL_ADC_ErrorCallback ................................................................. 94
4.2.25
HAL_ADC_ConfigChannel ............................................................... 94
4.2.26
HAL_ADC_AnalogWDGConfig ........................................................ 95
4.2.27
HAL_ADC_GetState ......................................................................... 95
4.2.28
HAL_ADC_GetError ......................................................................... 95
ADC Firmware driver defines .......................................................... 95
4.3.1
5
HAL ADC Extension Driver ......................................................... 106
5.1
5.2
4/692
ADC .................................................................................................. 95
ADCEx Firmware driver registers structures ................................. 106
5.1.1
ADC_InjectionConfTypeDef ........................................................... 106
5.1.2
ADC_MultiModeTypeDef ................................................................ 107
ADCEx Firmware driver API description ....................................... 108
5.2.1
How to use this driver ..................................................................... 108
5.2.2
Extended features functions ........................................................... 109
5.2.3
HAL_ADCEx_InjectedStart ............................................................ 110
5.2.4
HAL_ADCEx_InjectedStart_IT ....................................................... 110
5.2.5
HAL_ADCEx_InjectedStop ............................................................. 110
5.2.6
HAL_ADCEx_InjectedPollForConversion ...................................... 110
5.2.7
HAL_ADCEx_InjectedStop_IT ....................................................... 111
DOCID028236 Rev 1
UM1940
Contents
5.3
5.2.8
HAL_ADCEx_InjectedGetValue ..................................................... 111
5.2.9
HAL_ADCEx_MultiModeStart_DMA .............................................. 111
5.2.10
HAL_ADCEx_MultiModeStop_DMA ............................................... 112
5.2.11
HAL_ADCEx_MultiModeGetValue ................................................. 112
5.2.12
HAL_ADCEx_InjectedConvCpltCallback ....................................... 112
5.2.13
HAL_ADCEx_InjectedConfigChannel ............................................ 112
5.2.14
HAL_ADCEx_MultiModeConfigChannel ........................................ 113
ADCEx Firmware driver defines .................................................... 113
5.3.1
6
ADCEx ............................................................................................ 113
HAL CAN Generic Driver ............................................................. 116
6.1
6.2
CAN Firmware driver registers structures ..................................... 116
6.1.1
CAN_InitTypeDef ............................................................................ 116
6.1.2
CAN_FilterConfTypeDef ................................................................. 117
6.1.3
CanTxMsgTypeDef......................................................................... 118
6.1.4
CanRxMsgTypeDef ........................................................................ 118
6.1.5
CAN_HandleTypeDef ..................................................................... 119
CAN Firmware driver API description ............................................ 120
6.2.1
How to use this driver ..................................................................... 120
6.2.2
Initialization and de-initialization functions ..................................... 121
6.2.3
IO operation functions .................................................................... 121
6.2.4
Peripheral State and Error functions .............................................. 121
6.2.5
HAL_CAN_Init ................................................................................ 122
6.2.6
HAL_CAN_ConfigFilter................................................................... 122
6.2.7
HAL_CAN_DeInit ............................................................................ 122
6.2.8
HAL_CAN_MspInit ......................................................................... 122
6.2.9
HAL_CAN_MspDeInit ..................................................................... 122
6.2.10
HAL_CAN_Transmit ....................................................................... 123
6.2.11
HAL_CAN_Transmit_IT .................................................................. 123
6.2.12
HAL_CAN_Receive ........................................................................ 123
6.2.13
HAL_CAN_Receive_IT ................................................................... 123
6.2.14
HAL_CAN_Sleep ............................................................................ 123
6.2.15
HAL_CAN_WakeUp ....................................................................... 124
6.2.16
HAL_CAN_IRQHandler .................................................................. 124
6.2.17
HAL_CAN_TxCpltCallback ............................................................. 124
6.2.18
HAL_CAN_RxCpltCallback ............................................................ 124
6.2.19
HAL_CAN_ErrorCallback ............................................................... 124
6.2.20
HAL_CAN_GetState ....................................................................... 125
6.2.21
HAL_CAN_GetError ....................................................................... 125
DOCID028236 Rev 1
5/692
Contents
UM1940
6.3
CAN Firmware driver defines ........................................................ 125
6.3.1
7
HAL CORTEX Generic Driver ...................................................... 133
7.1
CORTEX Firmware driver registers structures .............................. 133
7.1.1
7.2
7.3
7.2.1
How to use this driver ..................................................................... 134
7.2.2
Initialization and de-initialization functions ..................................... 135
7.2.3
Peripheral Control functions ........................................................... 135
7.2.4
HAL_NVIC_SetPriorityGrouping .................................................... 135
7.2.5
HAL_NVIC_SetPriority ................................................................... 135
7.2.6
HAL_NVIC_EnableIRQ .................................................................. 136
7.2.7
HAL_NVIC_DisableIRQ.................................................................. 136
7.2.8
HAL_NVIC_SystemReset............................................................... 136
7.2.9
HAL_SYSTICK_Config ................................................................... 136
7.2.10
HAL_MPU_ConfigRegion ............................................................... 137
7.2.11
HAL_NVIC_GetPriorityGrouping .................................................... 137
7.2.12
HAL_NVIC_GetPriority ................................................................... 137
7.2.13
HAL_NVIC_SetPendingIRQ ........................................................... 137
7.2.14
HAL_NVIC_GetPendingIRQ .......................................................... 138
7.2.15
HAL_NVIC_ClearPendingIRQ ........................................................ 138
7.2.16
HAL_NVIC_GetActive .................................................................... 138
7.2.17
HAL_SYSTICK_CLKSourceConfig ................................................ 138
7.2.18
HAL_SYSTICK_IRQHandler .......................................................... 139
7.2.19
HAL_SYSTICK_Callback ............................................................... 139
CORTEX Firmware driver defines ................................................. 139
CORTEX ......................................................................................... 139
HAL CRC Generic Driver ............................................................. 143
8.1
CRC Firmware driver registers structures ..................................... 143
8.1.1
8.2
6/692
MPU_Region_InitTypeDef .............................................................. 133
CORTEX Firmware driver API description .................................... 134
7.3.1
8
CAN ................................................................................................ 125
CRC_HandleTypeDef ..................................................................... 143
CRC Firmware driver API description ........................................... 143
8.2.1
How to use this driver ..................................................................... 143
8.2.2
Initialization and de-initialization functions ..................................... 143
8.2.3
Peripheral Control functions ........................................................... 144
8.2.4
Peripheral State functions .............................................................. 144
8.2.5
HAL_CRC_Init ................................................................................ 144
8.2.6
HAL_CRC_DeInit ........................................................................... 144
DOCID028236 Rev 1
UM1940
Contents
8.3
8.2.7
HAL_CRC_MspInit ......................................................................... 144
8.2.8
HAL_CRC_MspDeInit..................................................................... 144
8.2.9
HAL_CRC_Accumulate .................................................................. 145
8.2.10
HAL_CRC_Calculate ...................................................................... 145
8.2.11
HAL_CRC_GetState....................................................................... 145
CRC Firmware driver defines ........................................................ 145
8.3.1
9
CRC ................................................................................................ 145
HAL CRYP Generic Driver........................................................... 147
9.1
9.2
CRYP Firmware driver registers structures ................................... 147
9.1.1
CRYP_InitTypeDef ......................................................................... 147
9.1.2
CRYP_HandleTypeDef................................................................... 147
CRYP Firmware driver API description ......................................... 148
9.2.1
How to use this driver ..................................................................... 148
9.2.2
Initialization and de-initialization functions ..................................... 149
9.2.3
AES processing functions .............................................................. 149
9.2.4
DES processing functions .............................................................. 150
9.2.5
TDES processing functions ............................................................ 150
9.2.6
DMA callback functions .................................................................. 151
9.2.7
CRYP IRQ handler management ................................................... 151
9.2.8
Peripheral State functions .............................................................. 151
9.2.9
HAL_CRYP_Init .............................................................................. 151
9.2.10
HAL_CRYP_DeInit ......................................................................... 152
9.2.11
HAL_CRYP_MspInit ....................................................................... 152
9.2.12
HAL_CRYP_MspDeInit .................................................................. 152
9.2.13
HAL_CRYP_AESECB_Encrypt ...................................................... 152
9.2.14
HAL_CRYP_AESCBC_Encrypt ..................................................... 152
9.2.15
HAL_CRYP_AESCTR_Encrypt ...................................................... 153
9.2.16
HAL_CRYP_AESECB_Decrypt ..................................................... 153
9.2.17
HAL_CRYP_AESCBC_Decrypt ..................................................... 153
9.2.18
HAL_CRYP_AESCTR_Decrypt ..................................................... 154
9.2.19
HAL_CRYP_AESECB_Encrypt_IT ................................................ 154
9.2.20
HAL_CRYP_AESCBC_Encrypt_IT ................................................ 154
9.2.21
HAL_CRYP_AESCTR_Encrypt_IT ................................................ 155
9.2.22
HAL_CRYP_AESECB_Decrypt_IT ................................................ 155
9.2.23
HAL_CRYP_AESCBC_Decrypt_IT ................................................ 155
9.2.24
HAL_CRYP_AESCTR_Decrypt_IT ................................................ 156
9.2.25
HAL_CRYP_AESECB_Encrypt_DMA ............................................ 156
9.2.26
HAL_CRYP_AESCBC_Encrypt_DMA ........................................... 156
DOCID028236 Rev 1
7/692
Contents
9.3
9.2.27
UM1940
HAL_CRYP_AESCTR_Encrypt_DMA ............................................ 156
9.2.28
HAL_CRYP_AESECB_Decrypt_DMA ........................................... 157
9.2.29
HAL_CRYP_AESCBC_Decrypt_DMA ........................................... 157
9.2.30
HAL_CRYP_AESCTR_Decrypt_DMA ........................................... 157
9.2.31
HAL_CRYP_DESECB_Encrypt ..................................................... 158
9.2.32
HAL_CRYP_DESECB_Decrypt ..................................................... 158
9.2.33
HAL_CRYP_DESCBC_Encrypt ..................................................... 158
9.2.34
HAL_CRYP_DESCBC_Decrypt ..................................................... 158
9.2.35
HAL_CRYP_DESECB_Encrypt_IT ................................................ 159
9.2.36
HAL_CRYP_DESCBC_Encrypt_IT ................................................ 159
9.2.37
HAL_CRYP_DESECB_Decrypt_IT ................................................ 159
9.2.38
HAL_CRYP_DESCBC_Decrypt_IT ................................................ 160
9.2.39
HAL_CRYP_DESECB_Encrypt_DMA ........................................... 160
9.2.40
HAL_CRYP_DESCBC_Encrypt_DMA ........................................... 160
9.2.41
HAL_CRYP_DESECB_Decrypt_DMA ........................................... 160
9.2.42
HAL_CRYP_DESCBC_Decrypt_DMA ........................................... 161
9.2.43
HAL_CRYP_TDESECB_Encrypt ................................................... 161
9.2.44
HAL_CRYP_TDESECB_Decrypt ................................................... 161
9.2.45
HAL_CRYP_TDESCBC_Encrypt ................................................... 162
9.2.46
HAL_CRYP_TDESCBC_Decrypt ................................................... 162
9.2.47
HAL_CRYP_TDESECB_Encrypt_IT .............................................. 162
9.2.48
HAL_CRYP_TDESCBC_Encrypt_IT .............................................. 163
9.2.49
HAL_CRYP_TDESECB_Decrypt_IT .............................................. 163
9.2.50
HAL_CRYP_TDESCBC_Decrypt_IT .............................................. 163
9.2.51
HAL_CRYP_TDESECB_Encrypt_DMA ......................................... 163
9.2.52
HAL_CRYP_TDESCBC_Encrypt_DMA ......................................... 164
9.2.53
HAL_CRYP_TDESECB_Decrypt_DMA ......................................... 164
9.2.54
HAL_CRYP_TDESCBC_Decrypt_DMA ......................................... 164
9.2.55
HAL_CRYP_InCpltCallback ........................................................... 165
9.2.56
HAL_CRYP_OutCpltCallback ........................................................ 165
9.2.57
HAL_CRYP_ErrorCallback ............................................................. 165
9.2.58
HAL_CRYP_IRQHandler................................................................ 165
9.2.59
HAL_CRYP_GetState .................................................................... 165
CRYP Firmware driver defines ...................................................... 166
9.3.1
10
HAL DAC Generic Driver ............................................................. 170
10.1
DAC Firmware driver registers structures ..................................... 170
10.1.1
8/692
CRYP .............................................................................................. 166
DAC_HandleTypeDef ..................................................................... 170
DOCID028236 Rev 1
UM1940
Contents
10.1.2
10.2
10.3
DAC Firmware driver API description ............................................ 171
10.2.1
DAC Peripheral features................................................................. 171
10.2.2
How to use this driver ..................................................................... 172
10.2.3
Initialization and de-initialization functions ..................................... 173
10.2.4
IO operation functions .................................................................... 173
10.2.5
Peripheral Control functions ........................................................... 173
10.2.6
Peripheral State and Errors functions ............................................ 173
10.2.7
HAL_DAC_Init ................................................................................ 174
10.2.8
HAL_DAC_DeInit ............................................................................ 174
10.2.9
HAL_DAC_MspInit ......................................................................... 174
10.2.10
HAL_DAC_MspDeInit ..................................................................... 174
10.2.11
HAL_DAC_Start ............................................................................. 174
10.2.12
HAL_DAC_Stop .............................................................................. 175
10.2.13
HAL_DAC_Start_DMA ................................................................... 175
10.2.14
HAL_DAC_Stop_DMA.................................................................... 175
10.2.15
HAL_DAC_GetValue ...................................................................... 176
10.2.16
HAL_DAC_IRQHandler .................................................................. 176
10.2.17
HAL_DAC_ConvCpltCallbackCh1 .................................................. 176
10.2.18
HAL_DAC_ConvHalfCpltCallbackCh1 ........................................... 176
10.2.19
HAL_DAC_ErrorCallbackCh1 ........................................................ 177
10.2.20
HAL_DAC_DMAUnderrunCallbackCh1 ......................................... 177
10.2.21
HAL_DAC_ConfigChannel ............................................................. 177
10.2.22
HAL_DAC_SetValue ...................................................................... 177
10.2.23
HAL_DAC_GetState ....................................................................... 178
10.2.24
HAL_DAC_GetError ....................................................................... 178
10.2.25
HAL_DAC_IRQHandler .................................................................. 178
10.2.26
HAL_DAC_ConvCpltCallbackCh1 .................................................. 178
10.2.27
HAL_DAC_ConvHalfCpltCallbackCh1 ........................................... 178
10.2.28
HAL_DAC_ErrorCallbackCh1 ........................................................ 179
10.2.29
HAL_DAC_DMAUnderrunCallbackCh1 ......................................... 179
DAC Firmware driver defines ........................................................ 179
10.3.1
11
DAC_ChannelConfTypeDef ........................................................... 170
DAC ................................................................................................ 179
HAL DAC Extension Driver ......................................................... 184
11.1
DACEx Firmware driver API description ....................................... 184
11.1.1
How to use this driver ..................................................................... 184
11.1.2
Extended features functions ........................................................... 184
11.1.3
HAL_DACEx_DualGetValue .......................................................... 184
DOCID028236 Rev 1
9/692
Contents
11.2
11.1.4
UM1940
HAL_DACEx_TriangleWaveGenerate ........................................... 184
11.1.5
HAL_DACEx_NoiseWaveGenerate ............................................... 185
11.1.6
HAL_DACEx_DualSetValue ........................................................... 186
11.1.7
HAL_DACEx_ConvCpltCallbackCh2 ............................................. 186
11.1.8
HAL_DACEx_ConvHalfCpltCallbackCh2 ....................................... 186
11.1.9
HAL_DACEx_ErrorCallbackCh2 .................................................... 187
11.1.10
HAL_DACEx_DMAUnderrunCallbackCh2 ..................................... 187
DACEx Firmware driver defines .................................................... 187
11.2.1
12
HAL DCMI Generic Driver ........................................................... 189
12.1
12.2
12.3
DCMI Firmware driver registers structures .................................... 189
12.1.1
DCMI_CodesInitTypeDef................................................................ 189
12.1.2
DCMI_InitTypeDef .......................................................................... 189
12.1.3
DCMI_HandleTypeDef ................................................................... 190
DCMI Firmware driver API description .......................................... 191
12.2.1
How to use this driver ..................................................................... 191
12.2.2
Initialization and Configuration functions ........................................ 191
12.2.3
IO operation functions .................................................................... 192
12.2.4
Peripheral Control functions ........................................................... 192
12.2.5
Peripheral State and Errors functions ............................................ 192
12.2.6
HAL_DCMI_Init ............................................................................... 192
12.2.7
HAL_DCMI_DeInit .......................................................................... 193
12.2.8
HAL_DCMI_MspInit ........................................................................ 193
12.2.9
HAL_DCMI_MspDeInit ................................................................... 193
12.2.10
HAL_DCMI_Start_DMA .................................................................. 193
12.2.11
HAL_DCMI_Stop ............................................................................ 193
12.2.12
HAL_DCMI_IRQHandler ................................................................ 194
12.2.13
HAL_DCMI_ErrorCallback ............................................................. 194
12.2.14
HAL_DCMI_LineEventCallback ..................................................... 194
12.2.15
HAL_DCMI_VsyncEventCallback .................................................. 194
12.2.16
HAL_DCMI_FrameEventCallback .................................................. 194
12.2.17
HAL_DCMI_ConfigCROP............................................................... 195
12.2.18
HAL_DCMI_DisableCROP ............................................................. 195
12.2.19
HAL_DCMI_EnableCROP .............................................................. 195
12.2.20
HAL_DCMI_GetState ..................................................................... 195
12.2.21
HAL_DCMI_GetError...................................................................... 195
DCMI Firmware driver defines....................................................... 196
12.3.1
10/692
DACEx ............................................................................................ 187
DCMI............................................................................................... 196
DOCID028236 Rev 1
UM1940
13
Contents
HAL DMA Generic Driver ............................................................ 201
13.1
13.2
13.3
DMA Firmware driver registers structures ..................................... 201
13.1.1
DMA_InitTypeDef ........................................................................... 201
13.1.2
__DMA_HandleTypeDef................................................................. 202
DMA Firmware driver API description ........................................... 203
13.2.1
How to use this driver ..................................................................... 203
13.2.2
Initialization and de-initialization functions ..................................... 204
13.2.3
IO operation functions .................................................................... 204
13.2.4
State and Errors functions .............................................................. 205
13.2.5
HAL_DMA_Init ................................................................................ 205
13.2.6
HAL_DMA_DeInit ........................................................................... 205
13.2.7
HAL_DMA_Start ............................................................................. 205
13.2.8
HAL_DMA_Start_IT ........................................................................ 206
13.2.9
HAL_DMA_Abort ............................................................................ 206
13.2.10
HAL_DMA_PollForTransfer ............................................................ 206
13.2.11
HAL_DMA_IRQHandler.................................................................. 206
13.2.12
HAL_DMA_GetState ...................................................................... 207
13.2.13
HAL_DMA_GetError ....................................................................... 207
DMA Firmware driver defines ........................................................ 207
13.3.1
14
HAL DMA Extension Driver......................................................... 211
14.1
15
DMA ................................................................................................ 207
DMAEx Firmware driver API description ....................................... 211
14.1.1
How to use this driver ..................................................................... 211
14.1.2
Extended features functions ........................................................... 211
14.1.3
HAL_DMAEx_MultiBufferStart ....................................................... 211
14.1.4
HAL_DMAEx_MultiBufferStart_IT .................................................. 211
14.1.5
HAL_DMAEx_ChangeMemory ....................................................... 212
HAL ETH Generic Driver ............................................................. 213
15.1
15.2
ETH Firmware driver registers structures ...................................... 213
15.1.1
ETH_InitTypeDef ............................................................................ 213
15.1.2
ETH_MACInitTypeDef .................................................................... 213
15.1.3
ETH_DMAInitTypeDef .................................................................... 216
15.1.4
ETH_DMADescTypeDef................................................................. 217
15.1.5
ETH_DMARxFrameInfos ................................................................ 218
15.1.6
ETH_HandleTypeDef ..................................................................... 219
ETH Firmware driver API description ............................................ 219
15.2.1
How to use this driver ..................................................................... 219
DOCID028236 Rev 1
11/692
Contents
15.2.2
UM1940
Initialization and de-initialization functions ..................................... 220
15.2.3
IO operation functions .................................................................... 220
15.2.4
Peripheral Control functions ........................................................... 221
15.2.5
Peripheral State functions .............................................................. 221
15.2.6
HAL_ETH_Init ................................................................................. 221
15.2.7
HAL_ETH_DeInit ............................................................................ 221
15.2.8
HAL_ETH_DMATxDescListInit ....................................................... 221
15.2.9
HAL_ETH_DMARxDescListInit ...................................................... 222
15.2.10
HAL_ETH_MspInit .......................................................................... 222
15.2.11
HAL_ETH_MspDeInit ..................................................................... 222
15.2.12
HAL_ETH_TransmitFrame ............................................................. 222
15.2.13
HAL_ETH_GetReceivedFrame ...................................................... 222
15.2.14
HAL_ETH_GetReceivedFrame_IT ................................................. 223
15.2.15
HAL_ETH_IRQHandler .................................................................. 223
15.2.16
HAL_ETH_TxCpltCallback ............................................................. 223
15.2.17
HAL_ETH_RxCpltCallback ............................................................. 223
15.2.18
HAL_ETH_ErrorCallback................................................................ 223
15.2.19
HAL_ETH_ReadPHYRegister ........................................................ 224
15.2.20
HAL_ETH_WritePHYRegister ........................................................ 224
15.2.21
HAL_ETH_Start .............................................................................. 224
15.2.22
HAL_ETH_Stop .............................................................................. 224
15.2.23 HAL_ETH_ConfigMAC ................................................................... 225
15.3
15.2.24
HAL_ETH_ConfigDMA ................................................................... 225
15.2.25
HAL_ETH_GetState ....................................................................... 225
ETH Firmware driver defines......................................................... 225
15.3.1
16
HAL FLASH Generic Driver......................................................... 257
16.1
FLASH Firmware driver registers structures ................................. 257
16.1.1
16.2
12/692
ETH................................................................................................. 225
FLASH_ProcessTypeDef ............................................................... 257
FLASH Firmware driver API description ........................................ 257
16.2.1
FLASH peripheral features ............................................................. 257
16.2.2
How to use this driver ..................................................................... 258
16.2.3
Programming operation functions .................................................. 258
16.2.4
Peripheral Control functions ........................................................... 258
16.2.5
Peripheral Errors functions ............................................................. 258
16.2.6
HAL_FLASH_Program ................................................................... 259
16.2.7
HAL_FLASH_Program_IT .............................................................. 259
16.2.8
HAL_FLASH_IRQHandler .............................................................. 259
DOCID028236 Rev 1
UM1940
Contents
16.3
16.2.9
HAL_FLASH_EndOfOperationCallback ......................................... 259
16.2.10
HAL_FLASH_OperationErrorCallback ........................................... 259
16.2.11
HAL_FLASH_Unlock ...................................................................... 260
16.2.12
HAL_FLASH_Lock ......................................................................... 260
16.2.13
HAL_FLASH_OB_Unlock ............................................................... 260
16.2.14
HAL_FLASH_OB_Lock .................................................................. 260
16.2.15
HAL_FLASH_OB_Launch .............................................................. 260
16.2.16
HAL_FLASH_GetError ................................................................... 260
16.2.17
FLASH_WaitForLastOperation ....................................................... 261
FLASH Firmware driver defines .................................................... 261
16.3.1
17
HAL FLASH Extension Driver ..................................................... 267
17.1
17.2
17.3
FLASHEx Firmware driver registers structures ............................. 267
17.1.1
FLASH_EraseInitTypeDef .............................................................. 267
17.1.2
FLASH_OBProgramInitTypeDef .................................................... 267
FLASHEx Firmware driver API description.................................... 268
17.2.1
Flash Extension features ................................................................ 268
17.2.2
How to use this driver ..................................................................... 268
17.2.3
Extended programming operation functions .................................. 268
17.2.4
HAL_FLASHEx_Erase ................................................................... 268
17.2.5
HAL_FLASHEx_Erase_IT .............................................................. 269
17.2.6
HAL_FLASHEx_OBProgram .......................................................... 269
17.2.7
HAL_FLASHEx_OBGetConfig ....................................................... 269
FLASHEx Firmware driver defines ................................................ 269
17.3.1
18
FLASH ............................................................................................ 261
FLASHEx ........................................................................................ 269
HAL GPIO Generic Driver............................................................ 273
18.1
GPIO Firmware driver registers structures .................................... 273
18.1.1
18.2
GPIO_InitTypeDef .......................................................................... 273
GPIO Firmware driver API description .......................................... 273
18.2.1
GPIO Peripheral features ............................................................... 273
18.2.2
How to use this driver ..................................................................... 274
18.2.3
Initialization and de-initialization functions ..................................... 274
18.2.4
IO operation functions .................................................................... 275
18.2.5
HAL_GPIO_Init ............................................................................... 275
18.2.6
HAL_GPIO_DeInit .......................................................................... 275
18.2.7
HAL_GPIO_ReadPin ...................................................................... 275
18.2.8
HAL_GPIO_WritePin ...................................................................... 275
DOCID028236 Rev 1
13/692
Contents
18.3
18.2.9
UM1940
HAL_GPIO_TogglePin ................................................................... 276
18.2.10
HAL_GPIO_LockPin ....................................................................... 276
18.2.11
HAL_GPIO_EXTI_IRQHandler ...................................................... 276
18.2.12
HAL_GPIO_EXTI_Callback ............................................................ 276
GPIO Firmware driver defines ....................................................... 277
18.3.1
19
HAL GPIO Extension Driver ........................................................ 282
19.1
GPIOEx Firmware driver defines................................................... 282
19.1.1
20
GPIOEx .......................................................................................... 282
HAL HASH Generic Driver .......................................................... 283
20.1
20.2
14/692
GPIO ............................................................................................... 277
HASH Firmware driver registers structures ................................... 283
20.1.1
HASH_InitTypeDef ......................................................................... 283
20.1.2
HASH_HandleTypeDef................................................................... 283
HASH Firmware driver API description ......................................... 284
20.2.1
How to use this driver ..................................................................... 284
20.2.2
HASH processing using polling mode functions ............................ 285
20.2.3
HASH processing using interrupt mode functions .......................... 285
20.2.4
HASH processing using DMA mode functions ............................... 285
20.2.5
HMAC processing using polling mode functions ............................ 286
20.2.6
HMAC processing using DMA mode functions .............................. 286
20.2.7
Peripheral State functions .............................................................. 286
20.2.8
Initialization and de-initialization functions ..................................... 286
20.2.9
HAL_HASH_MD5_Start ................................................................. 287
20.2.10
HAL_HASH_MD5_Accumulate ...................................................... 287
20.2.11
HAL_HASH_SHA1_Start................................................................ 287
20.2.12
HAL_HASH_SHA1_Accumulate .................................................... 288
20.2.13
HAL_HASH_MD5_Start_IT ............................................................ 288
20.2.14
HAL_HASH_SHA1_Start_IT .......................................................... 288
20.2.15
HAL_HASH_IRQHandler................................................................ 289
20.2.16
HAL_HMAC_SHA1_Start ............................................................... 289
20.2.17
HAL_HMAC_MD5_Start ................................................................. 289
20.2.18
HAL_HASH_MD5_Start_DMA ....................................................... 289
20.2.19
HAL_HASH_MD5_Finish ............................................................... 290
20.2.20
HAL_HASH_SHA1_Start_DMA ..................................................... 290
20.2.21
HAL_HASH_SHA1_Finish ............................................................. 290
20.2.22
HAL_HASH_SHA1_Start_IT .......................................................... 291
20.2.23
HAL_HASH_MD5_Start_IT ............................................................ 291
20.2.24
HAL_HMAC_MD5_Start ................................................................. 291
DOCID028236 Rev 1
UM1940
Contents
20.3
20.2.25
HAL_HMAC_SHA1_Start ............................................................... 292
20.2.26
HAL_HASH_SHA1_Start_DMA ..................................................... 292
20.2.27
HAL_HASH_SHA1_Finish ............................................................. 292
20.2.28
HAL_HASH_MD5_Start_DMA ....................................................... 292
20.2.29
HAL_HASH_MD5_Finish ............................................................... 293
20.2.30
HAL_HMAC_MD5_Start_DMA ....................................................... 293
20.2.31
HAL_HMAC_SHA1_Start_DMA ..................................................... 293
20.2.32
HAL_HASH_GetState .................................................................... 294
20.2.33
HAL_HASH_IRQHandler................................................................ 294
20.2.34
HAL_HASH_Init .............................................................................. 294
20.2.35
HAL_HASH_DeInit ......................................................................... 294
20.2.36
HAL_HASH_MspInit ....................................................................... 294
20.2.37
HAL_HASH_MspDeInit .................................................................. 295
20.2.38
HAL_HASH_InCpltCallback ........................................................... 295
20.2.39
HAL_HASH_ErrorCallback ............................................................. 295
20.2.40
HAL_HASH_DgstCpltCallback ....................................................... 295
20.2.41
HAL_HASH_GetState .................................................................... 295
20.2.42
HAL_HASH_MspInit ....................................................................... 296
20.2.43
HAL_HASH_MspDeInit .................................................................. 296
20.2.44
HAL_HASH_InCpltCallback ........................................................... 296
20.2.45
HAL_HASH_DgstCpltCallback ....................................................... 296
20.2.46
HAL_HASH_ErrorCallback ............................................................. 296
HASH Firmware driver defines ...................................................... 297
20.3.1
21
HASH .............................................................................................. 297
HAL HCD Generic Driver ............................................................. 299
21.1
HCD Firmware driver registers structures ..................................... 299
21.1.1
21.2
HCD_HandleTypeDef ..................................................................... 299
HCD Firmware driver API description ........................................... 299
21.2.1
How to use this driver ..................................................................... 299
21.2.2
Initialization and de-initialization functions ..................................... 300
21.2.3
IO operation functions .................................................................... 300
21.2.4
Peripheral Control functions ........................................................... 300
21.2.5
Peripheral State functions .............................................................. 300
21.2.6
HAL_HCD_Init ................................................................................ 300
21.2.7
HAL_HCD_HC_Init ......................................................................... 301
21.2.8
HAL_HCD_HC_Halt ....................................................................... 301
21.2.9
HAL_HCD_DeInit ........................................................................... 301
21.2.10
HAL_HCD_MspInit ......................................................................... 301
DOCID028236 Rev 1
15/692
Contents
21.3
21.2.11
UM1940
HAL_HCD_MspDeInit..................................................................... 302
21.2.12
HAL_HCD_HC_SubmitRequest ..................................................... 302
21.2.13
HAL_HCD_IRQHandler .................................................................. 302
21.2.14
HAL_HCD_SOF_Callback ............................................................. 302
21.2.15
HAL_HCD_Connect_Callback ....................................................... 303
21.2.16
HAL_HCD_Disconnect_Callback ................................................... 303
21.2.17
HAL_HCD_HC_NotifyURBChange_Callback ................................ 303
21.2.18
HAL_HCD_Start ............................................................................. 303
21.2.19
HAL_HCD_Stop ............................................................................. 303
21.2.20
HAL_HCD_ResetPort ..................................................................... 304
21.2.21
HAL_HCD_GetState....................................................................... 304
21.2.22
HAL_HCD_HC_GetURBState ........................................................ 304
21.2.23
HAL_HCD_HC_GetXferCount ....................................................... 304
21.2.24
HAL_HCD_HC_GetState ............................................................... 304
21.2.25
HAL_HCD_GetCurrentFrame ........................................................ 305
21.2.26
HAL_HCD_GetCurrentSpeed ........................................................ 305
HCD Firmware driver defines ........................................................ 305
21.3.1
22
HAL I2C Generic Driver ............................................................... 307
22.1
22.2
16/692
HCD ................................................................................................ 305
I2C Firmware driver registers structures ....................................... 307
22.1.1
I2C_InitTypeDef .............................................................................. 307
22.1.2
I2C_HandleTypeDef ....................................................................... 307
I2C Firmware driver API description .............................................. 308
22.2.1
How to use this driver ..................................................................... 308
22.2.2
Initialization and de-initialization functions ..................................... 311
22.2.3
IO operation functions .................................................................... 311
22.2.4
Peripheral State and Errors functions ............................................ 313
22.2.5
HAL_I2C_Init .................................................................................. 313
22.2.6
HAL_I2C_DeInit .............................................................................. 313
22.2.7
HAL_I2C_MspInit ........................................................................... 313
22.2.8
HAL_I2C_MspDeInit ....................................................................... 313
22.2.9
HAL_I2C_Master_Transmit ............................................................ 314
22.2.10
HAL_I2C_Master_Receive ............................................................. 314
22.2.11
HAL_I2C_Slave_Transmit .............................................................. 314
22.2.12
HAL_I2C_Slave_Receive ............................................................... 315
22.2.13
HAL_I2C_Master_Transmit_IT ....................................................... 315
22.2.14
HAL_I2C_Master_Receive_IT ........................................................ 315
22.2.15
HAL_I2C_Slave_Transmit_IT ......................................................... 315
DOCID028236 Rev 1
UM1940
Contents
22.3
22.2.16
HAL_I2C_Slave_Receive_IT .......................................................... 316
22.2.17
HAL_I2C_Master_Transmit_DMA .................................................. 316
22.2.18
HAL_I2C_Master_Receive_DMA ................................................... 316
22.2.19
HAL_I2C_Slave_Transmit_DMA .................................................... 316
22.2.20
HAL_I2C_Slave_Receive_DMA ..................................................... 317
22.2.21
HAL_I2C_Mem_Write..................................................................... 317
22.2.22
HAL_I2C_Mem_Read .................................................................... 317
22.2.23
HAL_I2C_Mem_Write_IT ............................................................... 318
22.2.24
HAL_I2C_Mem_Read_IT ............................................................... 318
22.2.25
HAL_I2C_Mem_Write_DMA .......................................................... 318
22.2.26
HAL_I2C_Mem_Read_DMA .......................................................... 319
22.2.27
HAL_I2C_IsDeviceReady ............................................................... 319
22.2.28
HAL_I2C_EV_IRQHandler ............................................................. 319
22.2.29
HAL_I2C_ER_IRQHandler ............................................................. 320
22.2.30
HAL_I2C_MasterTxCpltCallback .................................................... 320
22.2.31
HAL_I2C_MasterRxCpltCallback ................................................... 320
22.2.32
HAL_I2C_SlaveTxCpltCallback ...................................................... 320
22.2.33
HAL_I2C_SlaveRxCpltCallback ..................................................... 320
22.2.34
HAL_I2C_MemTxCpltCallback ....................................................... 320
22.2.35
HAL_I2C_MemRxCpltCallback ...................................................... 321
22.2.36
HAL_I2C_ErrorCallback ................................................................. 321
22.2.37
HAL_I2C_GetState ......................................................................... 321
22.2.38
HAL_I2C_GetError ......................................................................... 321
I2C Firmware driver defines .......................................................... 321
22.3.1
23
I2C .................................................................................................. 321
HAL I2S Generic Driver ............................................................... 328
23.1
23.2
I2S Firmware driver registers structures ....................................... 328
23.1.1
I2S_InitTypeDef .............................................................................. 328
23.1.2
I2S_HandleTypeDef ....................................................................... 328
I2S Firmware driver API description .............................................. 329
23.2.1
How to use this driver ..................................................................... 329
23.2.2
Initialization and de-initialization functions ..................................... 331
23.2.3
IO operation functions .................................................................... 331
23.2.4
Peripheral State and Errors functions ............................................ 332
23.2.5
HAL_I2S_Init .................................................................................. 332
23.2.6
HAL_I2S_DeInit .............................................................................. 332
23.2.7
HAL_I2S_MspInit............................................................................ 333
23.2.8
HAL_I2S_MspDeInit ....................................................................... 333
DOCID028236 Rev 1
17/692
Contents
23.3
23.2.9
UM1940
HAL_I2S_Transmit ......................................................................... 333
23.2.10
HAL_I2S_Receive .......................................................................... 333
23.2.11
HAL_I2S_Transmit_IT .................................................................... 334
23.2.12
HAL_I2S_Receive_IT ..................................................................... 334
23.2.13
HAL_I2S_Transmit_DMA ............................................................... 335
23.2.14
HAL_I2S_Receive_DMA ................................................................ 335
23.2.15
HAL_I2S_DMAPause ..................................................................... 336
23.2.16
HAL_I2S_DMAResume .................................................................. 336
23.2.17
HAL_I2S_DMAStop ........................................................................ 336
23.2.18
HAL_I2S_IRQHandler .................................................................... 336
23.2.19
HAL_I2S_TxHalfCpltCallback ........................................................ 336
23.2.20
HAL_I2S_TxCpltCallback ............................................................... 336
23.2.21
HAL_I2S_RxHalfCpltCallback ........................................................ 337
23.2.22
HAL_I2S_RxCpltCallback .............................................................. 337
23.2.23
HAL_I2S_ErrorCallback ................................................................. 337
23.2.24
HAL_I2S_GetState ......................................................................... 337
23.2.25
HAL_I2S_GetError ......................................................................... 337
23.2.26
HAL_I2S_GetState ......................................................................... 338
23.2.27
HAL_I2S_GetError ......................................................................... 338
I2S Firmware driver defines .......................................................... 338
23.3.1
24
HAL IRDA Generic Driver ............................................................ 343
24.1
24.2
18/692
I2S .................................................................................................. 338
IRDA Firmware driver registers structures .................................... 343
24.1.1
IRDA_InitTypeDef ........................................................................... 343
24.1.2
IRDA_HandleTypeDef .................................................................... 343
IRDA Firmware driver API description ........................................... 344
24.2.1
How to use this driver ..................................................................... 344
24.2.2
Initialization and Configuration functions ........................................ 345
24.2.3
IO operation functions .................................................................... 346
24.2.4
Peripheral State and Errors functions ............................................ 347
24.2.5
HAL_IRDA_Init ............................................................................... 347
24.2.6
HAL_IRDA_DeInit........................................................................... 347
24.2.7
HAL_IRDA_MspInit ........................................................................ 347
24.2.8
HAL_IRDA_MspDeInit .................................................................... 348
24.2.9
HAL_IRDA_Transmit ...................................................................... 348
24.2.10
HAL_IRDA_Receive ....................................................................... 348
24.2.11
HAL_IRDA_Transmit_IT ................................................................. 348
24.2.12
HAL_IRDA_Receive_IT .................................................................. 349
DOCID028236 Rev 1
UM1940
Contents
24.3
24.2.13
HAL_IRDA_Transmit_DMA ............................................................ 349
24.2.14
HAL_IRDA_Receive_DMA ............................................................. 349
24.2.15
HAL_IRDA_DMAPause .................................................................. 350
24.2.16
HAL_IRDA_DMAResume............................................................... 350
24.2.17
HAL_IRDA_DMAStop..................................................................... 350
24.2.18
HAL_IRDA_IRQHandler ................................................................. 350
24.2.19
HAL_IRDA_TxCpltCallback ............................................................ 350
24.2.20
HAL_IRDA_TxHalfCpltCallback ..................................................... 351
24.2.21
HAL_IRDA_RxCpltCallback ........................................................... 351
24.2.22
HAL_IRDA_RxHalfCpltCallback ..................................................... 351
24.2.23
HAL_IRDA_ErrorCallback .............................................................. 351
24.2.24
HAL_IRDA_GetState ...................................................................... 351
24.2.25
HAL_IRDA_GetError ...................................................................... 352
IRDA Firmware driver defines ....................................................... 352
24.3.1
25
HAL IWDG Generic Driver ........................................................... 359
25.1
25.2
25.3
IWDG Firmware driver registers structures ................................... 359
25.1.1
IWDG_InitTypeDef ......................................................................... 359
25.1.2
IWDG_HandleTypeDef ................................................................... 359
IWDG Firmware driver API description ......................................... 359
25.2.1
IWDG Specific features .................................................................. 359
25.2.2
How to use this driver ..................................................................... 360
25.2.3
Initialization and de-initialization functions ..................................... 360
25.2.4
IO operation functions .................................................................... 361
25.2.5
Peripheral State functions .............................................................. 361
25.2.6
HAL_IWDG_Init .............................................................................. 361
25.2.7
HAL_IWDG_MspInit ....................................................................... 361
25.2.8
HAL_IWDG_Start ........................................................................... 361
25.2.9
HAL_IWDG_Refresh ...................................................................... 362
25.2.10
HAL_IWDG_GetState..................................................................... 362
IWDG Firmware driver defines ...................................................... 362
25.3.1
26
IRDA ............................................................................................... 352
IWDG .............................................................................................. 362
HAL NAND Generic Driver .......................................................... 365
26.1
NAND Firmware driver registers structures ................................... 365
26.1.1
NAND_IDTypeDef .......................................................................... 365
26.1.2
NAND_AddressTypeDef................................................................. 365
26.1.3
NAND_InfoTypeDef ........................................................................ 365
DOCID028236 Rev 1
19/692
Contents
26.1.4
26.2
26.3
NAND Firmware driver API description ......................................... 366
26.2.1
How to use this driver ..................................................................... 366
26.2.2
NAND Initialization and de-initialization functions .......................... 367
26.2.3
NAND Input and Output functions .................................................. 367
26.2.4
NAND Control functions ................................................................. 368
26.2.5
NAND State functions..................................................................... 368
26.2.6
HAL_NAND_Init .............................................................................. 368
26.2.7
HAL_NAND_DeInit ......................................................................... 368
26.2.8
HAL_NAND_MspInit ....................................................................... 368
26.2.9
HAL_NAND_MspDeInit .................................................................. 369
26.2.10
HAL_NAND_IRQHandler ............................................................... 369
26.2.11
HAL_NAND_ITCallback ................................................................. 369
26.2.12
HAL_NAND_Read_ID .................................................................... 369
26.2.13
HAL_NAND_Reset ......................................................................... 369
26.2.14
HAL_NAND_Read_Page ............................................................... 369
26.2.15
HAL_NAND_Write_Page................................................................ 370
26.2.16
HAL_NAND_Read_SpareArea ...................................................... 370
26.2.17
HAL_NAND_Write_SpareArea ....................................................... 370
26.2.18
HAL_NAND_Erase_Block .............................................................. 371
26.2.19
HAL_NAND_Read_Status ............................................................. 371
26.2.20
HAL_NAND_Address_Inc .............................................................. 371
26.2.21
HAL_NAND_ECC_Enable ............................................................. 371
26.2.22
HAL_NAND_ECC_Disable ............................................................. 371
26.2.23
HAL_NAND_GetECC ..................................................................... 372
26.2.24
HAL_NAND_GetState .................................................................... 372
26.2.25
HAL_NAND_Read_Status ............................................................. 372
NAND Firmware driver defines...................................................... 372
26.3.1
27
NAND.............................................................................................. 372
HAL NOR Generic Driver............................................................. 375
27.1
27.2
20/692
UM1940
NAND_HandleTypeDef .................................................................. 366
NOR Firmware driver registers structures ..................................... 375
27.1.1
NOR_IDTypeDef ............................................................................ 375
27.1.2
NOR_CFITypeDef .......................................................................... 375
27.1.3
NOR_HandleTypeDef..................................................................... 375
NOR Firmware driver API description ........................................... 376
27.2.1
How to use this driver ..................................................................... 376
27.2.2
NOR Initialization and de_initialization functions ........................... 377
27.2.3
NOR Input and Output functions .................................................... 377
DOCID028236 Rev 1
UM1940
Contents
27.3
27.2.4
NOR Control functions.................................................................... 377
27.2.5
NOR State functions ....................................................................... 377
27.2.6
HAL_NOR_Init ................................................................................ 377
27.2.7
HAL_NOR_DeInit ........................................................................... 378
27.2.8
HAL_NOR_MspInit ......................................................................... 378
27.2.9
HAL_NOR_MspDeInit .................................................................... 378
27.2.10
HAL_NOR_MspWait....................................................................... 378
27.2.11
HAL_NOR_Read_ID ...................................................................... 378
27.2.12
HAL_NOR_ReturnToReadMode .................................................... 379
27.2.13
HAL_NOR_Read ............................................................................ 379
27.2.14
HAL_NOR_Program ....................................................................... 379
27.2.15
HAL_NOR_ReadBuffer .................................................................. 379
27.2.16
HAL_NOR_ProgramBuffer ............................................................. 379
27.2.17
HAL_NOR_Erase_Block ................................................................ 380
27.2.18
HAL_NOR_Erase_Chip .................................................................. 380
27.2.19
HAL_NOR_Read_CFI .................................................................... 380
27.2.20
HAL_NOR_WriteOperation_Enable ............................................... 380
27.2.21
HAL_NOR_WriteOperation_Disable .............................................. 381
27.2.22
HAL_NOR_GetState ...................................................................... 381
27.2.23
HAL_NOR_GetStatus..................................................................... 381
NOR Firmware driver defines ........................................................ 381
27.3.1
28
NOR ................................................................................................ 381
HAL PCCARD Generic Driver ..................................................... 384
28.1
PCCARD Firmware driver registers structures .............................. 384
28.1.1
28.2
PCCARD_HandleTypeDef ............................................................. 384
PCCARD Firmware driver API description .................................... 384
28.2.1
How to use this driver ..................................................................... 384
28.2.2
PCCARD Initialization and de-initialization functions ..................... 385
28.2.3
PCCARD Input and Output functions ............................................. 385
28.2.4
PCCARD State functions................................................................ 385
28.2.5
HAL_PCCARD_Init......................................................................... 385
28.2.6
HAL_PCCARD_DeInit .................................................................... 386
28.2.7
HAL_PCCARD_MspInit .................................................................. 386
28.2.8
HAL_PCCARD_MspDeInit ............................................................. 386
28.2.9
HAL_PCCARD_Read_ID ............................................................... 386
28.2.10
HAL_PCCARD_Read_Sector ........................................................ 386
28.2.11
HAL_PCCARD_Write_Sector ........................................................ 387
28.2.12
HAL_PCCARD_Erase_Sector ....................................................... 387
DOCID028236 Rev 1
21/692
Contents
28.3
28.2.13
UM1940
HAL_PCCARD_Reset .................................................................... 387
28.2.14
HAL_PCCARD_IRQHandler .......................................................... 387
28.2.15
HAL_PCCARD_ITCallback ............................................................ 388
28.2.16
HAL_PCCARD_GetState ............................................................... 388
28.2.17
HAL_PCCARD_GetStatus ............................................................. 388
28.2.18
HAL_PCCARD_ReadStatus .......................................................... 388
PCCARD Firmware driver defines................................................. 389
28.3.1
29
HAL PCD Generic Driver ............................................................. 391
29.1
PCD Firmware driver registers structures ..................................... 391
29.1.1
29.2
22/692
PCCARD ........................................................................................ 389
PCD_HandleTypeDef ..................................................................... 391
PCD Firmware driver API description ............................................ 391
29.2.1
How to use this driver ..................................................................... 391
29.2.2
Initialization and de-initialization functions ..................................... 392
29.2.3
IO operation functions .................................................................... 392
29.2.4
Peripheral Control functions ........................................................... 392
29.2.5
Peripheral State functions .............................................................. 393
29.2.6
HAL_PCD_Init ................................................................................ 393
29.2.7
HAL_PCD_DeInit ............................................................................ 393
29.2.8
HAL_PCD_MspInit ......................................................................... 393
29.2.9
HAL_PCD_MspDeInit ..................................................................... 393
29.2.10
HAL_PCD_Start ............................................................................. 393
29.2.11
HAL_PCD_Stop .............................................................................. 394
29.2.12
HAL_PCD_IRQHandler .................................................................. 394
29.2.13
HAL_PCD_DataOutStageCallback ................................................ 394
29.2.14
HAL_PCD_DataInStageCallback ................................................... 394
29.2.15
HAL_PCD_SetupStageCallback .................................................... 394
29.2.16
HAL_PCD_SOFCallback ................................................................ 394
29.2.17
HAL_PCD_ResetCallback .............................................................. 395
29.2.18
HAL_PCD_SuspendCallback ......................................................... 395
29.2.19
HAL_PCD_ResumeCallback .......................................................... 395
29.2.20
HAL_PCD_ISOOUTIncompleteCallback ........................................ 395
29.2.21
HAL_PCD_ISOINIncompleteCallback ............................................ 395
29.2.22
HAL_PCD_ConnectCallback .......................................................... 396
29.2.23
HAL_PCD_DisconnectCallback ..................................................... 396
29.2.24
HAL_PCD_DevConnect ................................................................. 396
29.2.25
HAL_PCD_DevDisconnect ............................................................. 396
29.2.26
HAL_PCD_SetAddress .................................................................. 396
DOCID028236 Rev 1
UM1940
Contents
29.3
29.2.27
HAL_PCD_EP_Open ..................................................................... 396
29.2.28
HAL_PCD_EP_Close ..................................................................... 397
29.2.29
HAL_PCD_EP_Receive ................................................................. 397
29.2.30
HAL_PCD_EP_GetRxCount .......................................................... 397
29.2.31
HAL_PCD_EP_Transmit ................................................................ 397
29.2.32
HAL_PCD_EP_SetStall .................................................................. 398
29.2.33
HAL_PCD_EP_ClrStall................................................................... 398
29.2.34
HAL_PCD_EP_Flush ..................................................................... 398
29.2.35
HAL_PCD_ActivateRemoteWakeup .............................................. 398
29.2.36
HAL_PCD_DeActivateRemoteWakeup.......................................... 398
29.2.37
HAL_PCD_GetState ....................................................................... 398
PCD Firmware driver defines ........................................................ 399
29.3.1
30
HAL PCD Extension Driver ......................................................... 401
30.1
31
PCD ................................................................................................ 399
PCDEx Firmware driver API description ....................................... 401
30.1.1
Extended features functions ........................................................... 401
30.1.2
HAL_PCDEx_SetTxFiFo ................................................................ 401
30.1.3
HAL_PCDEx_SetRxFiFo ................................................................ 401
HAL PWR Generic Driver ............................................................ 402
31.1
PWR Firmware driver registers structures .................................... 402
31.1.1
31.2
PWR_PVDTypeDef ........................................................................ 402
PWR Firmware driver API description ........................................... 402
31.2.1
Initialization and de-initialization functions ..................................... 402
31.2.2
Peripheral Control functions ........................................................... 402
31.2.3
HAL_PWR_DeInit ........................................................................... 404
31.2.4
HAL_PWR_EnableBkUpAccess .................................................... 404
31.2.5
HAL_PWR_DisableBkUpAccess.................................................... 405
31.2.6
HAL_PWR_ConfigPVD .................................................................. 405
31.2.7
HAL_PWR_EnablePVD.................................................................. 405
31.2.8
HAL_PWR_DisablePVD ................................................................. 405
31.2.9
HAL_PWR_EnableWakeUpPin ...................................................... 405
31.2.10
HAL_PWR_DisableWakeUpPin ..................................................... 405
31.2.11
HAL_PWR_EnterSLEEPMode ....................................................... 406
31.2.12
HAL_PWR_EnterSTOPMode ......................................................... 406
31.2.13
HAL_PWR_EnterSTANDBYMode ................................................. 407
31.2.14
HAL_PWR_PVD_IRQHandler ........................................................ 407
31.2.15
HAL_PWR_PVDCallback ............................................................... 407
DOCID028236 Rev 1
23/692
Contents
31.3
31.2.16
UM1940
HAL_PWR_EnableSleepOnExit ..................................................... 407
31.2.17
HAL_PWR_DisableSleepOnExit .................................................... 407
31.2.18
HAL_PWR_EnableSEVOnPend .................................................... 408
31.2.19
HAL_PWR_DisableSEVOnPend .................................................... 408
PWR Firmware driver defines ....................................................... 408
31.3.1
32
HAL PWR Extension Driver ........................................................ 413
32.1
32.2
PWREx Firmware driver API description ....................................... 413
32.1.1
Peripheral extended features functions .......................................... 413
32.1.2
HAL_PWREx_EnableBkUpReg ..................................................... 413
32.1.3
HAL_PWREx_DisableBkUpReg .................................................... 413
32.1.4
HAL_PWREx_EnableFlashPowerDown ........................................ 414
32.1.5
HAL_PWREx_DisableFlashPowerDown........................................ 414
PWREx Firmware driver defines ................................................... 414
32.2.1
33
PWREx ........................................................................................... 414
HAL RCC Generic Driver ............................................................. 415
33.1
33.2
24/692
PWR ............................................................................................... 408
RCC Firmware driver registers structures ..................................... 415
33.1.1
RCC_PLLInitTypeDef ..................................................................... 415
33.1.2
RCC_OscInitTypeDef ..................................................................... 415
33.1.3
RCC_ClkInitTypeDef ...................................................................... 416
RCC Firmware driver API description ........................................... 417
33.2.1
RCC specific features ..................................................................... 417
33.2.2
RCC Limitations .............................................................................. 417
33.2.3
Initialization and de-initialization functions ..................................... 417
33.2.4
Peripheral Control functions ........................................................... 419
33.2.5
HAL_RCC_DeInit ........................................................................... 419
33.2.6
HAL_RCC_OscConfig .................................................................... 419
33.2.7
HAL_RCC_ClockConfig ................................................................. 420
33.2.8
HAL_RCC_MCOConfig .................................................................. 420
33.2.9
HAL_RCC_EnableCSS .................................................................. 421
33.2.10
HAL_RCC_DisableCSS ................................................................. 421
33.2.11
HAL_RCC_GetSysClockFreq ........................................................ 421
33.2.12
HAL_RCC_GetHCLKFreq .............................................................. 422
33.2.13
HAL_RCC_GetPCLK1Freq ............................................................ 422
33.2.14
HAL_RCC_GetPCLK2Freq ............................................................ 422
33.2.15
HAL_RCC_GetOscConfig .............................................................. 422
33.2.16
HAL_RCC_GetClockConfig ........................................................... 423
33.2.17
HAL_RCC_NMI_IRQHandler ......................................................... 423
DOCID028236 Rev 1
UM1940
Contents
33.2.18
33.3
RCC Firmware driver defines ........................................................ 423
33.3.1
34
34.2
34.3
RCCEx Firmware driver registers structures ................................. 448
34.1.1
RCC_PLLI2SInitTypeDef................................................................ 448
34.1.2
RCC_PeriphCLKInitTypeDef .......................................................... 448
RCCEx Firmware driver API description ....................................... 449
34.2.1
Extended Peripheral Control functions ........................................... 449
34.2.2
HAL_RCCEx_PeriphCLKConfig ..................................................... 449
34.2.3
HAL_RCCEx_GetPeriphCLKConfig ............................................... 449
RCCEx Firmware driver defines .................................................... 449
34.3.1
RCCEx ............................................................................................ 449
HAL RNG Generic Driver............................................................. 453
35.1
RNG Firmware driver registers structures ..................................... 453
35.1.1
35.2
35.3
RNG_HandleTypeDef..................................................................... 453
RNG Firmware driver API description ........................................... 453
35.2.1
How to use this driver ..................................................................... 453
35.2.2
Initialization and de-initialization functions ..................................... 453
35.2.3
Peripheral Control functions ........................................................... 454
35.2.4
Peripheral State functions .............................................................. 454
35.2.5
HAL_RNG_Init ................................................................................ 454
35.2.6
HAL_RNG_DeInit ........................................................................... 454
35.2.7
HAL_RNG_MspInit ......................................................................... 454
35.2.8
HAL_RNG_MspDeInit .................................................................... 455
35.2.9
HAL_RNG_GenerateRandomNumber ........................................... 455
35.2.10
HAL_RNG_GenerateRandomNumber_IT ...................................... 455
35.2.11
HAL_RNG_IRQHandler.................................................................. 455
35.2.12
HAL_RNG_GetRandomNumber .................................................... 456
35.2.13
HAL_RNG_GetRandomNumber_IT ............................................... 456
35.2.14
HAL_RNG_ReadLastRandomNumber........................................... 456
35.2.15
HAL_RNG_ReadyDataCallback ..................................................... 456
35.2.16
HAL_RNG_ErrorCallback ............................................................... 457
35.2.17
HAL_RNG_GetState ...................................................................... 457
RNG Firmware driver defines ........................................................ 457
35.3.1
36
RCC ................................................................................................ 423
HAL RCC Extension Driver ......................................................... 448
34.1
35
HAL_RCC_CSSCallback................................................................ 423
RNG ................................................................................................ 457
HAL RTC Generic Driver ............................................................. 461
DOCID028236 Rev 1
25/692
Contents
UM1940
36.1
36.2
36.3
RTC Firmware driver registers structures ..................................... 461
36.1.1
RTC_InitTypeDef ............................................................................ 461
36.1.2
RTC_TimeTypeDef......................................................................... 461
36.1.3
RTC_DateTypeDef ......................................................................... 462
36.1.4
RTC_AlarmTypeDef ....................................................................... 462
36.1.5
RTC_HandleTypeDef ..................................................................... 463
RTC Firmware driver API description ............................................ 464
36.2.1
Backup Domain Operating Condition ............................................. 464
36.2.2
Backup Domain Reset .................................................................... 464
36.2.3
Backup Domain Access.................................................................. 464
36.2.4
How to use this driver ..................................................................... 464
36.2.5
RTC and low power modes ............................................................ 465
36.2.6
Initialization and de-initialization functions ..................................... 465
36.2.7
RTC Time and Date functions ........................................................ 466
36.2.8
RTC Alarm functions ...................................................................... 466
36.2.9
Peripheral Control functions ........................................................... 466
36.2.10
Peripheral State functions .............................................................. 466
36.2.11
HAL_RTC_Init ................................................................................ 466
36.2.12
HAL_RTC_DeInit ............................................................................ 467
36.2.13
HAL_RTC_MspInit.......................................................................... 467
36.2.14
HAL_RTC_MspDeInit ..................................................................... 467
36.2.15
HAL_RTC_SetTime ........................................................................ 467
36.2.16
HAL_RTC_GetTime ....................................................................... 467
36.2.17
HAL_RTC_SetDate ........................................................................ 468
36.2.18
HAL_RTC_GetDate ........................................................................ 468
36.2.19
HAL_RTC_SetAlarm ...................................................................... 469
36.2.20
HAL_RTC_SetAlarm_IT ................................................................. 469
36.2.21
HAL_RTC_DeactivateAlarm ........................................................... 469
36.2.22
HAL_RTC_GetAlarm ...................................................................... 469
36.2.23
HAL_RTC_AlarmIRQHandler ......................................................... 470
36.2.24
HAL_RTC_AlarmAEventCallback .................................................. 470
36.2.25
HAL_RTC_PollForAlarmAEvent ..................................................... 470
36.2.26
HAL_RTC_WaitForSynchro ........................................................... 470
36.2.27
HAL_RTC_GetState ....................................................................... 471
RTC Firmware driver defines ........................................................ 471
36.3.1
37
HAL RTC Extension Driver ......................................................... 480
37.1
26/692
RTC ................................................................................................ 471
RTCEx Firmware driver registers structures ................................. 480
DOCID028236 Rev 1
UM1940
Contents
37.1.1
37.2
37.3
RTC_TamperTypeDef .................................................................... 480
RTCEx Firmware driver API description ........................................ 480
37.2.1
How to use this driver ..................................................................... 480
37.2.2
RTC TimeStamp and Tamper functions ......................................... 481
37.2.3
RTC Wake-up functions ................................................................. 481
37.2.4
Extension Peripheral Control functions .......................................... 482
37.2.5
Extended features functions ........................................................... 482
37.2.6
HAL_RTCEx_SetTimeStamp ......................................................... 482
37.2.7
HAL_RTCEx_SetTimeStamp_IT .................................................... 483
37.2.8
HAL_RTCEx_DeactivateTimeStamp ............................................. 483
37.2.9
HAL_RTCEx_GetTimeStamp ......................................................... 483
37.2.10
HAL_RTCEx_SetTamper ............................................................... 484
37.2.11
HAL_RTCEx_SetTamper_IT .......................................................... 484
37.2.12
HAL_RTCEx_DeactivateTamper ................................................... 484
37.2.13
HAL_RTCEx_TamperTimeStampIRQHandler ............................... 484
37.2.14
HAL_RTCEx_TimeStampEventCallback ....................................... 485
37.2.15
HAL_RTCEx_Tamper1EventCallback ........................................... 485
37.2.16
HAL_RTCEx_PollForTimeStampEvent .......................................... 485
37.2.17
HAL_RTCEx_PollForTamper1Event .............................................. 485
37.2.18
HAL_RTCEx_SetWakeUpTimer .................................................... 485
37.2.19
HAL_RTCEx_SetWakeUpTimer_IT ............................................... 486
37.2.20
HAL_RTCEx_DeactivateWakeUpTimer ......................................... 486
37.2.21
HAL_RTCEx_GetWakeUpTimer .................................................... 486
37.2.22
HAL_RTCEx_WakeUpTimerIRQHandler ....................................... 486
37.2.23
HAL_RTCEx_WakeUpTimerEventCallback ................................... 486
37.2.24
HAL_RTCEx_PollForWakeUpTimerEvent ..................................... 487
37.2.25
HAL_RTCEx_BKUPWrite ............................................................... 487
37.2.26
HAL_RTCEx_BKUPRead .............................................................. 487
37.2.27
HAL_RTCEx_SetCoarseCalib ........................................................ 487
37.2.28
HAL_RTCEx_DeactivateCoarseCalib ............................................ 488
37.2.29
HAL_RTCEx_SetCalibrationOutPut ............................................... 488
37.2.30
HAL_RTCEx_DeactivateCalibrationOutPut ................................... 488
37.2.31
HAL_RTCEx_SetRefClock ............................................................. 488
37.2.32
HAL_RTCEx_DeactivateRefClock ................................................. 489
37.2.33
HAL_RTCEx_AlarmBEventCallback .............................................. 489
37.2.34
HAL_RTCEx_PollForAlarmBEvent ................................................ 489
RTCEx Firmware driver defines .................................................... 489
37.3.1
RTCEx ............................................................................................ 489
DOCID028236 Rev 1
27/692
Contents
38
UM1940
HAL SD Generic Driver ............................................................... 503
38.1
38.2
28/692
SD Firmware driver registers structures ........................................ 503
38.1.1
SD_HandleTypeDef........................................................................ 503
38.1.2
HAL_SD_CSDTypedef ................................................................... 504
38.1.3
HAL_SD_CIDTypedef .................................................................... 506
38.1.4
HAL_SD_CardStatusTypedef ........................................................ 507
38.1.5
HAL_SD_CardInfoTypedef ............................................................. 507
SD Firmware driver API description .............................................. 508
38.2.1
How to use this driver ..................................................................... 508
38.2.2
Initialization and de-initialization functions ..................................... 510
38.2.3
IO operation functions .................................................................... 510
38.2.4
Peripheral Control functions ........................................................... 510
38.2.5
Peripheral State functions .............................................................. 511
38.2.6
HAL_SD_Init ................................................................................... 511
38.2.7
HAL_SD_DeInit .............................................................................. 511
38.2.8
HAL_SD_MspInit ............................................................................ 511
38.2.9
HAL_SD_MspDeInit ....................................................................... 511
38.2.10
HAL_SD_ReadBlocks .................................................................... 512
38.2.11
HAL_SD_WriteBlocks..................................................................... 512
38.2.12
HAL_SD_ReadBlocks_DMA .......................................................... 512
38.2.13
HAL_SD_WriteBlocks_DMA .......................................................... 513
38.2.14
HAL_SD_CheckReadOperation ..................................................... 513
38.2.15
HAL_SD_CheckWriteOperation ..................................................... 513
38.2.16
HAL_SD_Erase .............................................................................. 513
38.2.17
HAL_SD_IRQHandler..................................................................... 513
38.2.18
HAL_SD_XferCpltCallback ............................................................. 514
38.2.19
HAL_SD_XferErrorCallback ........................................................... 514
38.2.20
HAL_SD_DMA_RxCpltCallback ..................................................... 514
38.2.21
HAL_SD_DMA_RxErrorCallback ................................................... 514
38.2.22
HAL_SD_DMA_TxCpltCallback ..................................................... 514
38.2.23
HAL_SD_DMA_TxErrorCallback .................................................... 515
38.2.24
HAL_SD_Get_CardInfo .................................................................. 515
38.2.25
HAL_SD_WideBusOperation_Config ............................................. 515
38.2.26
HAL_SD_StopTransfer ................................................................... 515
38.2.27
HAL_SD_HighSpeed ...................................................................... 516
38.2.28
HAL_SD_SendSDStatus ................................................................ 516
38.2.29
HAL_SD_GetStatus........................................................................ 516
38.2.30
HAL_SD_GetCardStatus ................................................................ 516
DOCID028236 Rev 1
UM1940
Contents
38.3
SD Firmware driver defines ........................................................... 516
38.3.1
39
HAL SMARTCARD Generic Driver.............................................. 529
39.1
39.2
39.3
SMARTCARD Firmware driver registers structures ...................... 529
39.1.1
SMARTCARD_InitTypeDef ............................................................ 529
39.1.2
SMARTCARD_HandleTypeDef ...................................................... 530
SMARTCARD Firmware driver API description............................. 531
39.2.1
How to use this driver ..................................................................... 531
39.2.2
Initialization and Configuration functions ........................................ 532
39.2.3
IO operation functions .................................................................... 533
39.2.4
Peripheral State and Errors functions ............................................ 535
39.2.5
HAL_SMARTCARD_Init ................................................................. 535
39.2.6
HAL_SMARTCARD_DeInit ............................................................ 535
39.2.7
HAL_SMARTCARD_MspInit .......................................................... 535
39.2.8
HAL_SMARTCARD_MspDeInit ..................................................... 536
39.2.9
HAL_SMARTCARD_ReInit ............................................................ 536
39.2.10
HAL_SMARTCARD_Transmit ........................................................ 536
39.2.11
HAL_SMARTCARD_Receive ......................................................... 536
39.2.12
HAL_SMARTCARD_Transmit_IT .................................................. 537
39.2.13
HAL_SMARTCARD_Receive_IT ................................................... 537
39.2.14
HAL_SMARTCARD_Transmit_DMA.............................................. 537
39.2.15
HAL_SMARTCARD_Receive_DMA ............................................... 537
39.2.16
HAL_SMARTCARD_IRQHandler ................................................... 538
39.2.17
HAL_SMARTCARD_TxCpltCallback ............................................. 538
39.2.18
HAL_SMARTCARD_RxCpltCallback ............................................. 538
39.2.19
HAL_SMARTCARD_ErrorCallback ................................................ 538
39.2.20
HAL_SMARTCARD_GetState ....................................................... 539
39.2.21
HAL_SMARTCARD_GetError ........................................................ 539
SMARTCARD Firmware driver defines ......................................... 539
39.3.1
40
SD ................................................................................................... 516
SMARTCARD ................................................................................. 539
HAL SPI Generic Driver ............................................................... 548
40.1
40.2
SPI Firmware driver registers structures ....................................... 548
40.1.1
SPI_InitTypeDef ............................................................................. 548
40.1.2
__SPI_HandleTypeDef ................................................................... 549
SPI Firmware driver API description ............................................. 550
40.2.1
How to use this driver ..................................................................... 550
40.2.2
Initialization and de-initialization functions ..................................... 550
DOCID028236 Rev 1
29/692
Contents
40.3
40.2.3
UM1940
IO operation functions .................................................................... 551
40.2.4
Peripheral State and Errors functions ............................................ 551
40.2.5
HAL_SPI_Init .................................................................................. 552
40.2.6
HAL_SPI_DeInit ............................................................................. 552
40.2.7
HAL_SPI_MspInit ........................................................................... 552
40.2.8
HAL_SPI_MspDeInit ....................................................................... 552
40.2.9
HAL_SPI_Transmit ......................................................................... 552
40.2.10
HAL_SPI_Receive .......................................................................... 553
40.2.11
HAL_SPI_TransmitReceive ............................................................ 553
40.2.12
HAL_SPI_Transmit_IT.................................................................... 553
40.2.13
HAL_SPI_Receive_IT..................................................................... 553
40.2.14
HAL_SPI_TransmitReceive_IT ...................................................... 554
40.2.15
HAL_SPI_Transmit_DMA ............................................................... 554
40.2.16
HAL_SPI_Receive_DMA ................................................................ 554
40.2.17
HAL_SPI_TransmitReceive_DMA .................................................. 554
40.2.18
HAL_SPI_DMAPause..................................................................... 555
40.2.19
HAL_SPI_DMAResume ................................................................. 555
40.2.20
HAL_SPI_DMAStop ....................................................................... 555
40.2.21
HAL_SPI_IRQHandler .................................................................... 555
40.2.22
HAL_SPI_TxCpltCallback .............................................................. 556
40.2.23
HAL_SPI_RxCpltCallback .............................................................. 556
40.2.24
HAL_SPI_TxRxCpltCallback .......................................................... 556
40.2.25
HAL_SPI_TxHalfCpltCallback ........................................................ 556
40.2.26
HAL_SPI_RxHalfCpltCallback ........................................................ 556
40.2.27
HAL_SPI_TxRxHalfCpltCallback .................................................... 556
40.2.28
HAL_SPI_ErrorCallback ................................................................. 557
40.2.29
HAL_SPI_GetState......................................................................... 557
40.2.30
HAL_SPI_GetError ......................................................................... 557
SPI Firmware driver defines .......................................................... 557
40.3.1
41
HAL SRAM Generic Driver .......................................................... 563
41.1
SRAM Firmware driver registers structures................................... 563
41.1.1
41.2
30/692
SPI .................................................................................................. 557
SRAM_HandleTypeDef .................................................................. 563
SRAM Firmware driver API description ......................................... 563
41.2.1
How to use this driver ..................................................................... 563
41.2.2
SRAM Initialization and de_initialization functions ......................... 564
41.2.3
SRAM Input and Output functions .................................................. 564
41.2.4
SRAM Control functions ................................................................. 564
DOCID028236 Rev 1
UM1940
Contents
41.3
41.2.5
SRAM State functions .................................................................... 565
41.2.6
HAL_SRAM_Init ............................................................................. 565
41.2.7
HAL_SRAM_DeInit ......................................................................... 565
41.2.8
HAL_SRAM_MspInit....................................................................... 565
41.2.9
HAL_SRAM_MspDeInit .................................................................. 565
41.2.10
HAL_SRAM_DMA_XferCpltCallback ............................................. 566
41.2.11
HAL_SRAM_DMA_XferErrorCallback ............................................ 566
41.2.12
HAL_SRAM_Read_8b.................................................................... 566
41.2.13
HAL_SRAM_Write_8b .................................................................... 566
41.2.14
HAL_SRAM_Read_16b.................................................................. 566
41.2.15
HAL_SRAM_Write_16b .................................................................. 567
41.2.16
HAL_SRAM_Read_32b.................................................................. 567
41.2.17
HAL_SRAM_Write_32b .................................................................. 567
41.2.18
HAL_SRAM_Read_DMA................................................................ 568
41.2.19
HAL_SRAM_Write_DMA ................................................................ 568
41.2.20
HAL_SRAM_WriteOperation_Enable ............................................. 568
41.2.21
HAL_SRAM_WriteOperation_Disable ............................................ 568
41.2.22
HAL_SRAM_GetState .................................................................... 568
SRAM Firmware driver defines ..................................................... 569
41.3.1
42
SRAM ............................................................................................. 569
HAL TIM Generic Driver .............................................................. 570
42.1
42.2
TIM Firmware driver registers structures ....................................... 570
42.1.1
TIM_Base_InitTypeDef ................................................................... 570
42.1.2
TIM_OC_InitTypeDef...................................................................... 570
42.1.3
TIM_OnePulse_InitTypeDef ........................................................... 571
42.1.4
TIM_IC_InitTypeDef ....................................................................... 572
42.1.5
TIM_Encoder_InitTypeDef ............................................................. 572
42.1.6
TIM_ClockConfigTypeDef .............................................................. 573
42.1.7
TIM_ClearInputConfigTypeDef ....................................................... 574
42.1.8
TIM_SlaveConfigTypeDef .............................................................. 574
42.1.9
TIM_HandleTypeDef ...................................................................... 575
TIM Firmware driver API description ............................................. 575
42.2.1
TIMER Generic features ................................................................. 575
42.2.2
How to use this driver ..................................................................... 576
42.2.3
Time Base functions ....................................................................... 576
42.2.4
Time Output Compare functions .................................................... 577
42.2.5
Time PWM functions ...................................................................... 577
42.2.6
Time Input Capture functions ......................................................... 578
DOCID028236 Rev 1
31/692
Contents
32/692
42.2.7
UM1940
Time One Pulse functions .............................................................. 578
42.2.8
Time Encoder functions .................................................................. 579
42.2.9
IRQ handler management .............................................................. 579
42.2.10
Peripheral Control functions ........................................................... 579
42.2.11
TIM Callbacks functions ................................................................. 580
42.2.12
Peripheral State functions .............................................................. 580
42.2.13
HAL_TIM_Base_Init ....................................................................... 580
42.2.14
HAL_TIM_Base_DeInit ................................................................... 581
42.2.15
HAL_TIM_Base_MspInit................................................................. 581
42.2.16
HAL_TIM_Base_MspDeInit ............................................................ 581
42.2.17
HAL_TIM_Base_Start..................................................................... 581
42.2.18
HAL_TIM_Base_Stop ..................................................................... 581
42.2.19
HAL_TIM_Base_Start_IT ............................................................... 581
42.2.20
HAL_TIM_Base_Stop_IT................................................................ 582
42.2.21
HAL_TIM_Base_Start_DMA .......................................................... 582
42.2.22
HAL_TIM_Base_Stop_DMA ........................................................... 582
42.2.23
HAL_TIM_OC_Init .......................................................................... 582
42.2.24
HAL_TIM_OC_DeInit...................................................................... 583
42.2.25
HAL_TIM_OC_MspInit ................................................................... 583
42.2.26
HAL_TIM_OC_MspDeInit ............................................................... 583
42.2.27
HAL_TIM_OC_Start ....................................................................... 583
42.2.28
HAL_TIM_OC_Stop........................................................................ 583
42.2.29
HAL_TIM_OC_Start_IT .................................................................. 584
42.2.30
HAL_TIM_OC_Stop_IT .................................................................. 584
42.2.31
HAL_TIM_OC_Start_DMA ............................................................. 584
42.2.32
HAL_TIM_OC_Stop_DMA ............................................................. 585
42.2.33
HAL_TIM_PWM_Init ....................................................................... 585
42.2.34
HAL_TIM_PWM_DeInit .................................................................. 585
42.2.35
HAL_TIM_PWM_MspInit ................................................................ 585
42.2.36
HAL_TIM_PWM_MspDeInit ........................................................... 585
42.2.37
HAL_TIM_PWM_Start .................................................................... 586
42.2.38
HAL_TIM_PWM_Stop .................................................................... 586
42.2.39
HAL_TIM_PWM_Start_IT ............................................................... 586
42.2.40
HAL_TIM_PWM_Stop_IT ............................................................... 587
42.2.41
HAL_TIM_PWM_Start_DMA .......................................................... 587
42.2.42
HAL_TIM_PWM_Stop_DMA .......................................................... 587
42.2.43
HAL_TIM_IC_Init ............................................................................ 587
42.2.44
HAL_TIM_IC_DeInit ....................................................................... 588
42.2.45
HAL_TIM_IC_MspInit ..................................................................... 588
DOCID028236 Rev 1
UM1940
Contents
42.2.46
HAL_TIM_IC_MspDeInit................................................................. 588
42.2.47
HAL_TIM_IC_Start ......................................................................... 588
42.2.48
HAL_TIM_IC_Stop ......................................................................... 588
42.2.49
HAL_TIM_IC_Start_IT .................................................................... 589
42.2.50
HAL_TIM_IC_Stop_IT .................................................................... 589
42.2.51
HAL_TIM_IC_Start_DMA ............................................................... 589
42.2.52
HAL_TIM_IC_Stop_DMA ............................................................... 590
42.2.53
HAL_TIM_OnePulse_Init ................................................................ 590
42.2.54
HAL_TIM_OnePulse_DeInit ........................................................... 590
42.2.55
HAL_TIM_OnePulse_MspInit ......................................................... 590
42.2.56
HAL_TIM_OnePulse_MspDeInit .................................................... 591
42.2.57
HAL_TIM_OnePulse_Start ............................................................. 591
42.2.58
HAL_TIM_OnePulse_Stop ............................................................. 591
42.2.59
HAL_TIM_OnePulse_Start_IT ........................................................ 591
42.2.60
HAL_TIM_OnePulse_Stop_IT ........................................................ 592
42.2.61
HAL_TIM_Encoder_Init .................................................................. 592
42.2.62
HAL_TIM_Encoder_DeInit ............................................................. 592
42.2.63
HAL_TIM_Encoder_MspInit ........................................................... 592
42.2.64
HAL_TIM_Encoder_MspDeInit ....................................................... 593
42.2.65
HAL_TIM_Encoder_Start ............................................................... 593
42.2.66
HAL_TIM_Encoder_Stop ............................................................... 593
42.2.67
HAL_TIM_Encoder_Start_IT .......................................................... 593
42.2.68
HAL_TIM_Encoder_Stop_IT .......................................................... 594
42.2.69
HAL_TIM_Encoder_Start_DMA ..................................................... 594
42.2.70
HAL_TIM_Encoder_Stop_DMA ..................................................... 594
42.2.71
HAL_TIM_IRQHandler ................................................................... 595
42.2.72
HAL_TIM_OC_ConfigChannel ....................................................... 595
42.2.73
HAL_TIM_IC_ConfigChannel ......................................................... 595
42.2.74
HAL_TIM_PWM_ConfigChannel .................................................... 595
42.2.75
HAL_TIM_OnePulse_ConfigChannel ............................................. 596
42.2.76
HAL_TIM_DMABurst_WriteStart .................................................... 596
42.2.77
HAL_TIM_DMABurst_WriteStop .................................................... 597
42.2.78
HAL_TIM_DMABurst_ReadStart .................................................... 597
42.2.79
HAL_TIM_DMABurst_ReadStop .................................................... 598
42.2.80
HAL_TIM_GenerateEvent .............................................................. 598
42.2.81
HAL_TIM_ConfigOCrefClear .......................................................... 599
42.2.82
HAL_TIM_ConfigClockSource ....................................................... 599
42.2.83
HAL_TIM_ConfigTI1Input ............................................................... 599
DOCID028236 Rev 1
33/692
Contents
42.3
42.2.84
UM1940
HAL_TIM_SlaveConfigSynchronization ......................................... 600
42.2.85
HAL_TIM_SlaveConfigSynchronization_IT .................................... 600
42.2.86
HAL_TIM_ReadCapturedValue ...................................................... 600
42.2.87
HAL_TIM_PeriodElapsedCallback ................................................. 601
42.2.88
HAL_TIM_OC_DelayElapsedCallback ........................................... 601
42.2.89
HAL_TIM_IC_CaptureCallback ...................................................... 601
42.2.90
HAL_TIM_PWM_PulseFinishedCallback ....................................... 601
42.2.91
HAL_TIM_TriggerCallback ............................................................. 601
42.2.92
HAL_TIM_ErrorCallback................................................................. 602
42.2.93
HAL_TIM_Base_GetState .............................................................. 602
42.2.94
HAL_TIM_OC_GetState ................................................................. 602
42.2.95
HAL_TIM_PWM_GetState ............................................................. 602
42.2.96
HAL_TIM_IC_GetState................................................................... 602
42.2.97
HAL_TIM_OnePulse_GetState ...................................................... 602
42.2.98
HAL_TIM_Encoder_GetState ......................................................... 603
TIM Firmware driver defines.......................................................... 603
42.3.1
43
HAL TIM Extension Driver........................................................... 618
43.1
43.2
34/692
TIM.................................................................................................. 603
TIMEx Firmware driver registers structures................................... 618
43.1.1
TIM_HallSensor_InitTypeDef ......................................................... 618
43.1.2
TIM_MasterConfigTypeDef ............................................................ 618
43.1.3
TIM_BreakDeadTimeConfigTypeDef ............................................. 618
TIMEx Firmware driver API description ......................................... 619
43.2.1
TIMER Extended features .............................................................. 619
43.2.2
How to use this driver ..................................................................... 619
43.2.3
Timer Hall Sensor functions ........................................................... 620
43.2.4
Timer Complementary Output Compare functions ......................... 621
43.2.5
Timer Complementary PWM functions ........................................... 621
43.2.6
Timer Complementary One Pulse functions................................... 621
43.2.7
Peripheral Control functions ........................................................... 622
43.2.8
Extension Callbacks functions ........................................................ 622
43.2.9
Extension Peripheral State functions ............................................. 622
43.2.10
HAL_TIMEx_HallSensor_Init .......................................................... 622
43.2.11
HAL_TIMEx_HallSensor_DeInit ..................................................... 623
43.2.12
HAL_TIMEx_HallSensor_MspInit ................................................... 623
43.2.13
HAL_TIMEx_HallSensor_MspDeInit .............................................. 623
43.2.14
HAL_TIMEx_HallSensor_Start ....................................................... 623
43.2.15
HAL_TIMEx_HallSensor_Stop ....................................................... 623
DOCID028236 Rev 1
UM1940
Contents
43.3
43.2.16
HAL_TIMEx_HallSensor_Start_IT .................................................. 624
43.2.17
HAL_TIMEx_HallSensor_Stop_IT .................................................. 624
43.2.18
HAL_TIMEx_HallSensor_Start_DMA ............................................. 624
43.2.19
HAL_TIMEx_HallSensor_Stop_DMA ............................................. 624
43.2.20
HAL_TIMEx_OCN_Start................................................................. 624
43.2.21
HAL_TIMEx_OCN_Stop ................................................................. 625
43.2.22
HAL_TIMEx_OCN_Start_IT ........................................................... 625
43.2.23
HAL_TIMEx_OCN_Stop_IT ........................................................... 625
43.2.24
HAL_TIMEx_OCN_Start_DMA ...................................................... 626
43.2.25
HAL_TIMEx_OCN_Stop_DMA ....................................................... 626
43.2.26
HAL_TIMEx_PWMN_Start ............................................................. 626
43.2.27
HAL_TIMEx_PWMN_Stop ............................................................. 627
43.2.28
HAL_TIMEx_PWMN_Start_IT ........................................................ 627
43.2.29
HAL_TIMEx_PWMN_Stop_IT ........................................................ 627
43.2.30
HAL_TIMEx_PWMN_Start_DMA ................................................... 628
43.2.31
HAL_TIMEx_PWMN_Stop_DMA ................................................... 628
43.2.32
HAL_TIMEx_OnePulseN_Start ...................................................... 628
43.2.33
HAL_TIMEx_OnePulseN_Stop ...................................................... 628
43.2.34
HAL_TIMEx_OnePulseN_Start_IT ................................................. 629
43.2.35
HAL_TIMEx_OnePulseN_Stop_IT ................................................. 629
43.2.36
HAL_TIMEx_ConfigCommutationEvent ......................................... 629
43.2.37
HAL_TIMEx_ConfigCommutationEvent_IT .................................... 630
43.2.38
HAL_TIMEx_ConfigCommutationEvent_DMA ............................... 631
43.2.39
HAL_TIMEx_MasterConfigSynchronization ................................... 631
43.2.40
HAL_TIMEx_ConfigBreakDeadTime.............................................. 631
43.2.41
HAL_TIMEx_RemapConfig ............................................................ 632
43.2.42
HAL_TIMEx_CommutationCallback ............................................... 632
43.2.43
HAL_TIMEx_BreakCallback ........................................................... 632
43.2.44
TIMEx_DMACommutationCplt ....................................................... 633
43.2.45
HAL_TIMEx_HallSensor_GetState ................................................ 633
TIMEx Firmware driver defines ..................................................... 633
43.3.1
44
TIMEx ............................................................................................. 633
HAL UART Generic Driver........................................................... 635
44.1
44.2
UART Firmware driver registers structures ................................... 635
44.1.1
UART_InitTypeDef ......................................................................... 635
44.1.2
UART_HandleTypeDef ................................................................... 635
UART Firmware driver API description ......................................... 636
44.2.1
How to use this driver ..................................................................... 636
DOCID028236 Rev 1
35/692
Contents
44.3
44.2.2
UM1940
Initialization and Configuration functions ........................................ 638
44.2.3
IO operation functions .................................................................... 639
44.2.4
Peripheral Control functions ........................................................... 640
44.2.5
Peripheral State and Errors functions ............................................ 640
44.2.6
HAL_UART_Init .............................................................................. 640
44.2.7
HAL_HalfDuplex_Init ...................................................................... 641
44.2.8
HAL_LIN_Init .................................................................................. 641
44.2.9
HAL_MultiProcessor_Init ................................................................ 641
44.2.10
HAL_UART_DeInit ......................................................................... 642
44.2.11
HAL_UART_MspInit ....................................................................... 642
44.2.12
HAL_UART_MspDeInit................................................................... 642
44.2.13
HAL_UART_Transmit ..................................................................... 642
44.2.14
HAL_UART_Receive ...................................................................... 643
44.2.15
HAL_UART_Transmit_IT................................................................ 643
44.2.16
HAL_UART_Receive_IT................................................................. 643
44.2.17
HAL_UART_Transmit_DMA ........................................................... 643
44.2.18
HAL_UART_Receive_DMA ............................................................ 644
44.2.19
HAL_UART_DMAPause................................................................. 644
44.2.20
HAL_UART_DMAResume ............................................................. 644
44.2.21
HAL_UART_DMAStop ................................................................... 644
44.2.22
HAL_UART_IRQHandler ................................................................ 645
44.2.23
HAL_UART_TxCpltCallback .......................................................... 645
44.2.24
HAL_UART_TxHalfCpltCallback .................................................... 645
44.2.25
HAL_UART_RxCpltCallback .......................................................... 645
44.2.26
HAL_UART_RxHalfCpltCallback .................................................... 645
44.2.27
HAL_UART_ErrorCallback ............................................................. 646
44.2.28
HAL_LIN_SendBreak ..................................................................... 646
44.2.29
HAL_MultiProcessor_EnterMuteMode ........................................... 646
44.2.30
HAL_MultiProcessor_ExitMuteMode .............................................. 646
44.2.31
HAL_HalfDuplex_EnableTransmitter ............................................. 646
44.2.32
HAL_HalfDuplex_EnableReceiver ................................................. 647
44.2.33
HAL_UART_GetState..................................................................... 647
44.2.34
HAL_UART_GetError ..................................................................... 647
UART Firmware driver defines ...................................................... 647
44.3.1
45
HAL USART Generic Driver ........................................................ 659
45.1
USART Firmware driver registers structures ................................. 659
45.1.1
36/692
UART .............................................................................................. 647
USART_InitTypeDef ....................................................................... 659
DOCID028236 Rev 1
UM1940
Contents
45.1.2
45.2
45.3
USART Firmware driver API description ....................................... 660
45.2.1
How to use this driver ..................................................................... 660
45.2.2
Initialization and Configuration functions ........................................ 662
45.2.3
IO operation functions .................................................................... 663
45.2.4
Peripheral State and Errors functions ............................................ 664
45.2.5
HAL_USART_Init ............................................................................ 664
45.2.6
HAL_USART_DeInit ....................................................................... 664
45.2.7
HAL_USART_MspInit ..................................................................... 664
45.2.8
HAL_USART_MspDeInit ................................................................ 665
45.2.9
HAL_USART_Transmit .................................................................. 665
45.2.10
HAL_USART_Receive ................................................................... 665
45.2.11
HAL_USART_TransmitReceive ..................................................... 665
45.2.12
HAL_USART_Transmit_IT ............................................................. 666
45.2.13
HAL_USART_Receive_IT .............................................................. 666
45.2.14
HAL_USART_TransmitReceive_IT ................................................ 666
45.2.15
HAL_USART_Transmit_DMA ........................................................ 667
45.2.16
HAL_USART_Receive_DMA ......................................................... 667
45.2.17
HAL_USART_TransmitReceive_DMA ........................................... 667
45.2.18
HAL_USART_DMAPause .............................................................. 668
45.2.19
HAL_USART_DMAResume ........................................................... 668
45.2.20
HAL_USART_DMAStop ................................................................. 668
45.2.21
HAL_USART_IRQHandler ............................................................. 668
45.2.22
HAL_USART_TxCpltCallback ........................................................ 668
45.2.23
HAL_USART_TxHalfCpltCallback .................................................. 669
45.2.24
HAL_USART_RxCpltCallback ........................................................ 669
45.2.25
HAL_USART_RxHalfCpltCallback ................................................. 669
45.2.26
HAL_USART_TxRxCpltCallback .................................................... 669
45.2.27
HAL_USART_ErrorCallback .......................................................... 669
45.2.28
HAL_USART_GetState .................................................................. 670
45.2.29
HAL_USART_GetError................................................................... 670
USART Firmware driver defines.................................................... 670
45.3.1
46
USART_HandleTypeDef ................................................................ 660
USART............................................................................................ 670
HAL WWDG Generic Driver ........................................................ 678
46.1
46.2
WWDG Firmware driver registers structures ................................. 678
46.1.1
WWDG_InitTypeDef ....................................................................... 678
46.1.2
WWDG_HandleTypeDef ................................................................ 678
WWDG Firmware driver API description ....................................... 679
DOCID028236 Rev 1
37/692
Contents
46.3
46.2.1
UM1940
WWDG specific features ................................................................ 679
46.2.2
How to use this driver ..................................................................... 679
46.2.3
Initialization and de-initialization functions ..................................... 679
46.2.4
IO operation functions .................................................................... 680
46.2.5
Peripheral State functions .............................................................. 680
46.2.6
HAL_WWDG_Init............................................................................ 680
46.2.7
HAL_WWDG_DeInit ....................................................................... 680
46.2.8
HAL_WWDG_MspInit ..................................................................... 681
46.2.9
HAL_WWDG_MspDeInit ................................................................ 681
46.2.10
HAL_WWDG_WakeupCallback ..................................................... 681
46.2.11
HAL_WWDG_Start ......................................................................... 681
46.2.12
HAL_WWDG_Start_IT.................................................................... 681
46.2.13
HAL_WWDG_Refresh .................................................................... 682
46.2.14
HAL_WWDG_IRQHandler ............................................................. 682
46.2.15
HAL_WWDG_WakeupCallback ..................................................... 682
46.2.16
HAL_WWDG_GetState .................................................................. 682
WWDG Firmware driver defines.................................................... 683
46.3.1
WWDG............................................................................................ 683
47
FAQs............................................................................................. 687
48
Revision history .......................................................................... 691
38/692
DOCID028236 Rev 1
UM1940
List of tables
List of tables
Table 1: Acronyms and definitions ............................................................................................................ 41
Table 2: HAL drivers files .......................................................................................................................... 43
Table 3: User-application files .................................................................................................................. 45
Table 4: APis classification ....................................................................................................................... 49
Table 5: List of devices supported by the HAL drivers ............................................................................. 49
Table 6: HAL API naming rules ................................................................................................................ 50
Table 7: Macros handling interrupts and specific clock configurations .................................................... 52
Table 8: Callback functions ....................................................................................................................... 53
Table 9: HAL generic APIs ....................................................................................................................... 54
Table 10: HAL extension APIs .................................................................................................................. 55
Table 11: Define statements used for HAL configuration ......................................................................... 58
Table 12: Description of GPIO_InitTypeDef structure .............................................................................. 61
Table 13: Description of EXTI configuration macros ................................................................................ 63
Table 14: MSP functions ........................................................................................................................... 67
Table 15: Timeout values ......................................................................................................................... 71
Table 16: Number of wait states (WS) according to CPU clock (HCLK) frequency ............................... 418
Table 17: USART frame formats ............................................................................................................ 533
Table 18: Document revision history ...................................................................................................... 691
DOCID028236 Rev 1
39/692
List of figures
UM1940
List of figures
Figure 1: Example of project template ...................................................................................................... 46
Figure 2: Adding family-specific functions ................................................................................................ 55
Figure 3: Adding new peripherals ............................................................................................................. 56
Figure 4: Updating existing APIs .............................................................................................................. 56
Figure 5: File inclusion model ................................................................................................................... 57
Figure 6: HAL driver model ....................................................................................................................... 65
40/692
DOCID028236 Rev 1
UM1940
1
Acronyms and definitions
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
CAN
Controller area network
CMSIS
Cortex Microcontroller Software Interface Standard
CPU
Central Processing Unit
CRC
CRC calculation unit
DAC
Digital to analog converter
DCMI
Digital Camera Module Interface
DMA
Direct Memory Access
ETH
Ethernet controller
EXTI
External interrupt/event controller
FLASH
Flash memory
FSMC
Flexible Static Memory controller
GPIO
General purpose I/Os
HAL
Hardware abstraction layer
HASH
Hash processor
HCD
USB Host Controller Driver
I2C
Inter-integrated circuit
I2S
Inter-integrated sound
IRDA
InfraRed Data Association
IWDG
Independent watchdog
MSP
MCU Specific Package
NAND
NAND Flash memory
NOR
Nor Flash memory
NVIC
Nested Vectored Interrupt Controller
PCCARD
PCCARD external memory
PCD
USB Peripheral Controller Driver
PWR
Power controller
RCC
Reset and clock controller
RNG
Random Number Generator
RTC
Real-time clock
SD
Secure Digital
DOCID028236 Rev 1
41/692
Acronyms and definitions
42/692
UM1940
Acronym
Definition
SRAM
SRAM external memory
SMARTCARD
Smartcard IC
SPI
Serial Peripheral interface
SysTick
System tick timer
TIM
Advanced-control, general-purpose or basic timer
UART
Universal asynchronous receiver/transmitter
USART
Universal synchronous receiver/transmitter
WWDG
Window watchdog
USB
Universal Serial Bus
PPP
STM32 peripheral or block
DOCID028236 Rev 1
UM1940
2
Overview of HAL drivers
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 following:







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
stm32f2xx_hal_ppp.c
Main peripheral/module driver file.
It includes the APIs that are common to all STM32 devices.
Example: stm32f2xx_hal_adc.c, stm32f2xx_hal_irda.c, …
stm32f2xx_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: stm32f2xx_hal_adc.h, stm32f2xx_hal_irda.h, …
DOCID028236 Rev 1
43/692
Overview of HAL drivers
UM1940
File
Description
stm32f2xx_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: stm32f2xx_hal_adc_ex.c, stm32f2xx_hal_dma_ex.c, …
stm32f2xx_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: stm32f2xx_hal_adc_ex.h, stm32f2xx_hal_dma_ex.h, …
stm32f2xx_ll_ppp.c
Peripheral low-layer driver that can be accessed from one or more
HAL drivers. It offers a set of APIs and services used by the upper
driver. From the user point of view, low-level drivers are not
accessible directly. They are used only by the HAL drivers built
upon them.
Example: stm32f2xx_ll_fsmc.c offers a set of APIs used by
stm32f2xx_hal_sram.c, stm32f2xx_hal_nor.c,
stm32f2xx_hal_nand.c …
stm32f2xx_ll_ppp.h
Header file of the low-layer C file.
It is included in the HAL driver header file, thus making the lowlevel driver an intrinsic add-on of the HAL driver that is not visible
from the application.
Example: stm32f2xx_ll_fsmc.h, stm32f2xx_ll_usb.h, …
stm32f2xx_hal.c
This file is used for HAL initialization and contains DBGMCU,
Remap and Time Delay based on systick APIs.
stm32f2xx_hal.h
xx_hal.c header file
stm32f2xx_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.
stm32f2xx_hal_conf_template.h
Template file allowing to customize the drivers for a given
application.
stm32f2xx_hal_def.h
Common HAL resources such as common define statements,
enumerations, structures and macros.
Since the low-level drivers are only used by the HAL drivers built upon them, the
APIs provided by these drivers will not be described in this document.
44/692
DOCID028236 Rev 1
UM1940
2.1.2
Overview of HAL drivers
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
Description
system_stm32f2xx.c
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 :


relocate the vector table in internal SRAM.
configure FSMC peripheral to use as data memory the
external SRAM mounted on the evaluation board.
startup_stm32f2xx.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.
stm32f2xx_flash.icf
(optional)
Linker file for EWARM toolchain allowing mainly to adapt the stack/heap
size to fit the application requirements.
stm32f2xx_hal_msp.c
This file contains the MSP initialization and de-initialization (main routine
and callbacks) of the peripheral used in the user application.
stm32f2xx_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.
stm32f2xx_it.c/.h
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 stm32f2xx_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.
DOCID028236 Rev 1
45/692
Overview of HAL drivers

UM1940
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.
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:

46/692
Multi instance support: each peripheral/module instance has its own handle. As a
result instance resources are independent.
DOCID028236 Rev 1
UM1940
Overview of HAL drivers


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 */
__IO HAL_USART_StateTypeDef State; /* Usart communication state */
__IO uint32_t 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:






GPIO
SYSTICK
NVIC
PWR
RCC
FLASH.
DOCID028236 Rev 1
47/692
Overview of HAL drivers
2.2.2
UM1940
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;
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_InjectedStop(ADC_HandleTypeDef* hadc); HAL_StatusTypeDef
HAL_ADCEx_InjectedStop_IT(ADC_HandleTypeDef* hadc); HAL_StatusTypeDef
HAL_ADCEx_InjectedStart(ADC_HandleTypeDef* hadc); HAL_StatusTypeDef
HAL_ADCEx_InjectedStart_IT(ADC_HandleTypeDef* hadc);
48/692
DOCID028236 Rev 1
UM1940
Overview of HAL drivers
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
X
(1)
Family specific APIs
X
Device specific APIs
X
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
2.4
Devices supported by HAL drivers
Table 5: List of devices supported by the HAL drivers
IP/Module
STM32F205xx
STM32F215xx
STM32F207xx
STM32f217xx
stm32F2xx_hal.c
Yes
Yes
Yes
Yes
stm32F2xx_adc.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_adc_ex.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_can.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_cortex.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_crc.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_cryp.c
No
Yes
No
Yes
stm32f2xx_hal_dac.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_dac_ex.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_dcmi.c
No
No
Yes
Yes
stm32f2xx_hal_dma.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_dma_ex.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_eth.c
No
No
Yes
Yes
stm32f2xx_hal_flash.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_flash_ex.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_gpio.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_hash.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_hcd.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_i2c.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_i2s.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_irda.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_iwdg.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_nand.c
Yes
Yes
Yes
Yes
DOCID028236 Rev 1
49/692
Overview of HAL drivers
UM1940
IP/Module
STM32F205xx
STM32F215xx
STM32F207xx
STM32f217xx
stm32f2xx_hal_nor.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_pccard.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_pcd.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_pcd_ex.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_pwr.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_pwr_ex.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_rcc.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_rcc_ex.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_rng.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_rtc.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_rtc_ex.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_sd.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_smartcard.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_spi.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_sram.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_tim.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_tim_ex.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_uart.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_usart.c
Yes
Yes
Yes
Yes
stm32f2xx_hal_wwdg.c
Yes
Yes
Yes
Yes
stm32f2xx_ll_fsmc.c
Yes
Yes
Yes
Yes
stm32f2xx_ll_sdmmc.c
Yes
Yes
Yes
Yes
stm32f2xx_ll_usb.c
Yes
Yes
Yes
Yes
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
stm32f2xx_hal_ppp (c/h)
stm32f2xx_hal_ppp_ex (c/h)
stm32f2xx_ hal_ppp_ex (c/h)
Module
name
50/692
HAL_PPP_ MODULE
Functio
n name
HAL_PPP_Function
HAL_PPP_FeatureFunction_
MODE
HAL_PPPEx_Function
HAL_PPPEx_FeatureFunction_
MODE
HAL_PPPEx_Function
HAL_PPPEx_FeatureFunction_
MODE
Handle
name
PPP_HandleTypedef
NA
NA
DOCID028236 Rev 1
UM1940
Overview of HAL drivers
Generic
Family specific
Device specific
Init
structu
re
name
PPP_InitTypeDef
NA
PPP_InitTypeDef
Enum
name
HAL_PPP_StructnameTypeD
ef
NA
NA













2.5.2
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 stm32f2xx reference manuals.
Peripheral registers are declared in the PPP_TypeDef structure (e.g. ADC_TypeDef)
in stm32f2xxx.h header file.stm32f2xxx.h corresponds to stm32f205xx.h , stm32f215.h
, stm32f207xx.h or stm32f217xx.h.
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()).
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.
DOCID028236 Rev 1
51/692
Overview of HAL drivers
UM1940
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
Description
__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 __)
Gets a specific peripheral interrupt
status
__HAL_PPP_CLEAR_IT (__HANDLE__, __ INTERRUPT __)
Clears a specific peripheral
interrupt status
__HAL_PPP_GET_FLAG (__HANDLE__, __FLAG__)
Gets a specific peripheral flag
status
__HAL_PPP_CLEAR_FLAG (__HANDLE__, __FLAG__)
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



NVIC and SYSTICK are two ARM Cortex core features. The APIs related to these
features are located in the stm32f2xx_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))
52/692
DOCID028236 Rev 1
UM1940
Overview of HAL drivers

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
stm32f2xx_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
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
2.6
Example
Ex: HAL_USART_ErrorCallback
Called by peripheral or DMA interrupt handler when an error
occurs
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.
DOCID028236 Rev 1
53/692
Overview of HAL drivers
UM1940
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
HAL_ADC_Init()
Initialization
group
IO operation
group
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
HAL_ADC_IRQHandler()
This function handles ADC interrupt requests
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
Control group
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
State and
Errors group
54/692
Description
DOCID028236 Rev 1
UM1940
Overview of HAL drivers
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, stm32f2xx_hal_ppp_ex.c, that includes
all the specific functions and define statements (stm32f2xx_hal_ppp_ex.h) for a given part
number.
Below an example based on the ADC peripheral:
Table 10: HAL extension APIs
2.7.2
Function Group
Common API Name
HAL_ADCEx_InjectedStart()
This function starts injected channel ADC conversions when
the polling method is used
HAL_ADCEx_InjectedStop()
This function stops injected channel ADC conversions when
the polling method is used
HAL_ADCEx_InjectedStart_IT()
This function starts injected channel ADC conversions when
the interrupt method is used
HAL_ADCEx_InjectedStop_IT()
This function stops injected channel ADC conversions when
the interrupt method is used
HAL_ADCEx_InjectedConfigChannel()
This function configures the selected ADC Injected channel
(corresponding rank in the sequencer and sample time)
HAL extension model cases
The specific IP features can be handled by the HAL drivers in five different ways. They are
described below.
Case 1: Adding a family-specific function
In this case, the API is added in the extension driver C file and named
HAL_PPPEx_Function ().
Figure 2: Adding family-specific functions
Example: stm32f2xx_hal_adc_ex.c/h
HAL_StatusTypeDef
HAL_StatusTypeDef
HAL_StatusTypeDef
HAL_StatusTypeDef
HAL_ADCEx_InjectedStop(ADC_HandleTypeDef* hadc);
HAL_ADCEx_InjectedStop_IT(ADC_HandleTypeDef* hadc);
HAL_ADCEx_InjectedStart(ADC_HandleTypeDef* hadc);
HAL_ADCEx_InjectedStart_IT(ADC_HandleTypeDef* hadc);
DOCID028236 Rev 1
55/692
Overview of HAL drivers
UM1940
Case 2 : 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 stm32f2xx_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
Figure 3: Adding new peripherals
Example: stm32f2xx_hal_dcmi.c/h
Case 3: Updating existing common APIs
In this case, the routines are defined with the same names in the stm32f2xx_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 4: Updating existing APIs
Case 4 : 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 (STM32F205xx)
typedef struct
{
(…)
}PPP_InitTypeDef;
#endif /* STM32F205xx */
56/692
DOCID028236 Rev 1
UM1940
2.8
Overview of HAL drivers
File inclusion model
The header of the common HAL driver file (stm32f2xx_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.
Figure 5: 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 stm32f2xx_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 stm32f2xx_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,
DOCID028236 Rev 1
57/692
Overview of HAL drivers
UM1940
HAL_TIMEOUT = 0x03
} HAL_StatusTypeDef;

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 stm32f2xx_hal_def.h file calls the stm32f2xx.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
register…etc.).
Common macros

Macro defining HAL_MAX_DELAY
#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, stm32f2xx_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
58/692
Configuration item
Description
Default Value
HSE_VALUE
Defines the value of the external
oscillator (HSE) expressed in Hz.
The user must adjust this define
statement when using a different
crystal value.
25 000 000 (Hz)
HSE_STARTUP_TIMEOUT
Timeout for HSE start up,
expressed in ms
5000
HSI_VALUE
Defines the value of the internal
oscillator (HSI) expressed in Hz.
16 000 000 (Hz)
EXTERNAL_CLOCK_VALUE
This value is used by the I2S
HAL module to compute the I2S
clock source frequency, this
source is inserted directly
through I2S_CKIN pad.
12288000 (Hz)
VDD_VALUE
VDD value
3300 (mV)
USE_RTOS
Enables the use of RTOS
FALSE (for future use)
DOCID028236 Rev 1
UM1940
Overview of HAL drivers
Configuration item
Description
Default Value
PREFETCH_ENABLE
Enables prefetch feature
TRUE
Enables instruction cache
TRUE
DATA_CACHE_ENABLE
Enables data cache
TRUE
USE HAL_PPP_MODULE
Enables module to be used in
the HAL driver
MAC_ADDRx
Ethernet peripheral
configuration : MAC address
ETH_RX_BUF_SIZE
Ethernet buffer size for receive
ETH_TX_BUF_SIZE
Ethernet buffer size for trasmit
ETH_RXBUFNB
The number of Rx buffers of
size ETH_RX_BUF_SIZE
4
ETH_TXBUFNB
The number of Tx buffers of size
ETH_RX_BUF_SIZE
4
DP83848_PHY_ADDRESS
DB83848 Ethernet PHY
Address
0x01
PHY_RESET_DELAY
PHY Reset delay these values
are based on a 1 ms Systick
interrupt
0x000000FF
PHY_CONFIG_DELAY
PHY Configuration delay
0x00000FFF
PHY_BCR PHY_BSR
Common PHY Registers
PHY_SR PHY_MICR PHY_MISR
Extended PHY registers
INSTRUCTION_CACHE_ENABLE
ETH_MAX_PACKET_SIZE
ETH_MAX_PACKET_SIZE
The stm32f2xx_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 stm32f2xx_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.
DOCID028236 Rev 1
59/692
Overview of HAL drivers
2.11
UM1940
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, APB1 and APB2 clock dividers

Configures the number od Flash memory wait states

Updates the SysTick configuration when HCLK clock changes.
Some peripheral clocks are not derived from the system clock (RTC, SDIO, I2S, Audio,
PLL…). In this case, the clock configuration is performed by an extended API defined in
stm32f2xx_hal_rcc_ex.c: HAL_RCCEx_PeriphCLKConfig(RCC_PeriphCLKInitTypeDef
*PeriphClkInit).
Additional RCC HAL driver functions are available:



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, PCLK2, …)
MCO and CSS configuration functions
A set of macros are defined in stm32f2xx_hal_rcc.h and stm32f2xx_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 stm32f2xx_it.c and implement
HAL_GPIO_EXTI_Callback()
The table below describes the GPIO_InitTypeDef structure field.
60/692
DOCID028236 Rev 1
UM1940
Overview of HAL drivers
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


Pull
Speed
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
Specifies the Pull-up or Pull-down activation for the selected pins.
Possible values are:
GPIO_NOPULL
GPIO_PULLUP
GPIO_PULLDOWN
Specifies the speed for the selected pins
Possible values are:
GPIO_SPEED_LOW
GPIO_SPEED_MEDIUM
GPIO_SPEED_HIGH
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);
DOCID028236 Rev 1
61/692
Overview of HAL drivers
2.11.3
UM1940
Cortex NVIC and SysTick timer
The Cortex HAL driver, stm32f2xx_hal_cortex.c, provides APIs to handle NVIC and
Systick. The supported APIs include:










2.11.4
HAL_NVIC_SetPriority()/ HAL_NVIC_SetPriorityGrouping()
HAL_NVIC_GetPriority() / HAL_NVIC_GetPriorityGrouping()
HAL_NVIC_EnableIRQ()/HAL_NVIC_DisableIRQ()
HAL_NVIC_SystemReset()
HAL_SYSTICK_IRQHandler()
HAL_NVIC_GetPendingIRQ() / HAL_NVIC_SetPendingIRQ () /
HAL_NVIC_ClearPendingIRQ()
HAL_NVIC_GetActive(IRQn)
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:



PVD configuration, enabling/disabling and interrupt handling

HAL_PWR_ConfigPVD()

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()
Depending on the STM32 Series, extension functions are available in
stm32f2xx_hal_pwr_ex. Here are a few examples (the list is not exhaustive)


2.11.5
Backup domain registers enable/disable

HAL_PWREx_EnableBkUpReg() / HAL_PWREx_DisableBkUpReg()
Flash power-down control:

HAL_PWREx_EnableFlashPowerDown()

HAL_PWREx_DisableFlashPowerDown().
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 Ethernet 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):
62/692
DOCID028236 Rev 1
UM1940
Overview of HAL drivers
Table 13: Description of EXTI configuration macros
Macros
Description
PPP_EXTI_LINE_FUNCTION
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 */
__HAL_PPP_EXTI_ENABLE_IT(__EXTI_LINE__)
Enables a given EXTI line
Example:
__HAL_PVD_EXTI_ENABLE_IT(PWR_EXTI_LINE_PVD)
__HAL_PPP_EXTI_DISABLE_IT(__EXTI_LINE__)
Disables a given EXTI line.
Example:
__HAL_PVD_EXTI_DISABLE_IT(PWR_EXTI_LINE_PVD)
__HAL_PPP_EXTI_GET_FLAG(__EXTI_LINE__)
Gets a given EXTI line interrupt flag pending bit status.
Example:
__HAL_PVD_EXTI_GET_FLAG(PWR_EXTI_LINE_PVD)
__HAL_PPP_EXTI_CLEAR_FLAG(__EXTI_LINE_
_)
Clears a given EXTI line interrupt flag pending bit.
Example;
__HAL_PVD_EXTI_CLEAR_FLAG(PWR_EXTI_LINE_PV
D)
__HAL_PPP_EXTI_GENERATE_SWIT
(__EXTI_LINE__)
Generates a software interrupt for a given EXTI line.
Example:
__HAL_PVD_EXTI_ GENERATE_SWIT
(PWR_EXTI_LINE_PVD)
If the EXTI interrupt mode is selected, the user application must call
HAL_PPP_FUNCTION_IRQHandler() (for example HAL_PWR_PVD_IRQHandler()), from
stm32f2xx_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
Stream Priority level
Source and Destination Increment mode
FIFO mode and its Threshold (if needed)
burst mode for Source and/or Destination (if needed).
DOCID028236 Rev 1
63/692
Overview of HAL drivers
UM1940
Two operating modes are available:


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.
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_FS: returns the current DMA Stream FIFO filled level.
__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 stream 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 double-buffering feature is handled as an extension API.
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.
64/692
DOCID028236 Rev 1
UM1940
Overview of HAL drivers
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 6: HAL driver model
The functions implemented in the HAL driver are shown in green, the functions
called from interrupt handlers in dotted lines, and the msp functions implemented
in the user application in red. Non-dotted lines represent the interactions between
the user application functions.
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.
DOCID028236 Rev 1
65/692
Overview of HAL drivers
2.12.2
HAL initialization
2.12.2.1
HAL global initialization
UM1940
In addition to the peripheral initialization and de-initialization functions, a set of APIs are
provided to initialize the HAL core implemented in file stm32f2xx_hal.c.




2.12.2.2
HAL_Init(): this function must be called at application startup to

Initialize data/instruction cache and pre-fetch queue

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.PLLM = 25; RCC_OscInitStruct.PLL.PLLN = 240;
RCC_OscInitStruct.PLL.PLLP = RCC_PLLP_DIV2;
RCC_OscInitStruct.PLL.PLLQ = 5;
HAL_RCC_OscConfig(&RCC_OscInitStruct);
/* Select PLL as system clock source and configure the HCLK, PCLK1 and PCLK2 clocks
dividers */
RCC_ClkInitStruct.ClockType = (RCC_CLOCKTYPE_SYSCLK | RCC_CLOCKTYPE_HCLK |
RCC_CLOCKTYPE_PCLK1 | RCC_CLOCKTYPE_PCLK2);
RCC_ClkInitStruct.SYSCLKSource = RCC_SYSCLKSOURCE_PLLCLK;
RCC_ClkInitStruct.AHBCLKDivider = RCC_SYSCLK_DIV1;
RCC_ClkInitStruct.APB1CLKDivider = RCC_HCLK_DIV4;
RCC_ClkInitStruct.APB2CLKDivider = RCC_HCLK_DIV2;
HAL_RCC_ClockConfig(&RCC_ClkInitStruct, FLASH_LATENCY_3); }
66/692
DOCID028236 Rev 1
UM1940
2.12.2.3
Overview of HAL drivers
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.
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 stm32f2xx_hal_msp.c file in the user
folders. An stm32f2xx_hal_msp.c file template 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.
stm32f2xx_hal_msp.c file contains the following functions:
Table 14: MSP functions
Routine
Description
void HAL_MspInit()
Global MSP initialization routine
void HAL_MspDeInit()
Global MSP de-initialization routine
void HAL_PPP_MspInit()
PPP MSP initialization routine
void HAL_PPP_MspDeInit()
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().
DOCID028236 Rev 1
67/692
Overview of HAL drivers
UM1940
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:



2.12.3.1
Polling mode
Interrupt mode
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 HELIAC; }
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 stm32f2xx_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.
68/692
DOCID028236 Rev 1
UM1940
Overview of HAL drivers
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;
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)
{
}
stm32f2xx_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 stm32f2xx_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):
DOCID028236 Rev 1
69/692
Overview of HAL drivers
UM1940
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;
UartHandle.Init.HwFlowCtl = UART_HWCONTROL_NONE;
UartHandle.Init.Mode = UART_MODE_TX_RX;
UartHandle.Init.Instance = UART1;
HAL_UART_Init(&UartHandle);
(..)
}
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.BaudRate = 9600;
UartHandle.Init.WordLength = UART_DATABITS_8;
UartHandle.Init.StopBits = UART_STOPBITS_1;
UartHandle.Init.Parity = UART_PARITY_NONE;
UartHandle.Init.HwFlowCtl = UART_HWCONTROL_NONE;
UartHandle.Init.Mode = UART_MODE_TX_RX; UartHandle.Init.Instance = USART1;
HAL_UART_Init(&UartHandle);
HAL_UART_Send_DMA(&UartHandle, TxBuffer, sizeof(TxBuffer));
while (1);
}
void HAL_UART_TxCpltCallback(UART_HandleTypeDef *phuart)
{
}
void HAL_UART_TxErrorCallback(UART_HandleTypeDef *phuart)
{
}
stm32f2xx_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 ;
(…)
}
70/692
DOCID028236 Rev 1
UM1940
Overview of HAL drivers
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)
The timeout possible value are the following:
Table 15: Timeout values
Timeout value
Description
0
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 stm32f2xx_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 */
DOCID028236 Rev 1
71/692
Overview of HAL drivers
UM1940
__HAL_UNLOCK(hppp);
hppp->State= HAL_PPP_STATE_TIMEOUT;
return hppp->State;
}
}
(…)
}
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:
{
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:
72/692
DOCID028236 Rev 1
UM1940
Overview of HAL drivers
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:
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 stm32f2xx_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 stm32f2xx_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
DOCID028236 Rev 1
73/692
Overview of HAL drivers
UM1940
* @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) */
/* 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.
74/692
DOCID028236 Rev 1
UM1940
HAL System Driver
3
HAL System Driver
3.1
HAL Firmware driver API description
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
Common HAL APIs
Services HAL APIs
Initialization and de-initialization functions
This section provides functions allowing to:



Initializes the Flash interface the NVIC allocation and initial clock configuration. It
initializes the systick 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.
This section contains the following APIs:





3.1.3
HAL_Init()
HAL_DeInit()
HAL_MspInit()
HAL_MspDeInit()
HAL_InitTick()
HAL Control functions
This section provides functions allowing to:






Provide a tick value in millisecond
Provide a blocking delay in millisecond
Suspend the time base source interrupt
Resume the time base source interrupt
Get the HAL API driver version
Get the device identifier
DOCID028236 Rev 1
75/692
HAL System Driver




UM1940
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
This section contains the following APIs:
















3.1.4
3.1.5
3.1.6
3.1.7
76/692
HAL_IncTick()
HAL_GetTick()
HAL_Delay()
HAL_SuspendTick()
HAL_ResumeTick()
HAL_GetHalVersion()
HAL_GetREVID()
HAL_GetDEVID()
HAL_DBGMCU_EnableDBGSleepMode()
HAL_DBGMCU_DisableDBGSleepMode()
HAL_DBGMCU_EnableDBGStopMode()
HAL_DBGMCU_DisableDBGStopMode()
HAL_DBGMCU_EnableDBGStandbyMode()
HAL_DBGMCU_DisableDBGStandbyMode()
HAL_EnableCompensationCell()
HAL_DisableCompensationCell()
HAL_Init
Function Name
HAL_StatusTypeDef HAL_Init (void )
Function Description
This function is used to initialize the HAL Library; it must be the
first instruction to be executed in the main program (before to call
any other HAL function), it performs the following: Configure the
Flash prefetch, instruction and Data caches.
Return values

HAL status
Notes

SysTick is used as time base for the HAL_Delay() function,
the application need to ensure that the SysTick time base is
always set to 1 millisecond to have correct HAL operation.
HAL_DeInit
Function Name
HAL_StatusTypeDef HAL_DeInit (void )
Function Description
This function de-Initializes common part of the HAL and stops the
systick.
Return values

HAL status
HAL_MspInit
Function Name
void HAL_MspInit (void )
Function Description
Initializes the MSP.
Return values

None
HAL_MspDeInit
DOCID028236 Rev 1
UM1940
3.1.8
HAL System Driver
Function Name
void HAL_MspDeInit (void )
Function Description
DeInitializes the MSP.
Return values

HAL_InitTick
Function Name
HAL_StatusTypeDef HAL_InitTick (uint32_t TickPriority)
Function Description
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
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.

3.1.9
HAL_IncTick
Function Name
void HAL_IncTick (void )
Function Description
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
None
HAL_GetTick
Function Name
uint32_t HAL_GetTick (void )
Function Description
Provides a tick value in millisecond.
Return values

tick value
Notes

This function is declared as __weak to be overwritten in case
of other implementations in user file.
HAL_Delay
Function Name
void HAL_Delay (__IO uint32_t Delay)
Function Description
This function provides accurate delay (in milliseconds) based on
variable incremented.
Parameters

Delay: specifies the delay time length, in milliseconds.
DOCID028236 Rev 1
77/692
HAL System Driver
Return values
Notes
UM1940

None

In the default implementation , SysTick timer is the source of
time base. It is used to generate interrupts at regular time
intervals where uwTick is incremented.
This function is declared as __weak to be overwritten in case
of other implementations in user file.

3.1.12
HAL_SuspendTick
Function Name
void HAL_SuspendTick (void )
Function Description
Suspend Tick increment.
Return values

None
Notes

In the default implementation , SysTick timer is the source of
time base. It is used to generate interrupts at regular time
intervals. Once HAL_SuspendTick() is called, the SysTick
interrupt will be disabled and so Tick increment is suspended.
This function is declared as __weak to be overwritten in case
of other implementations in user file.

3.1.13
HAL_ResumeTick
Function Name
void HAL_ResumeTick (void )
Function Description
Resume Tick increment.
Return values

None
Notes

In the default implementation , SysTick timer is the source of
time base. It is used to generate interrupts at regular time
intervals. Once HAL_ResumeTick() is called, the SysTick
interrupt will be enabled and so Tick increment is resumed.
This function is declared as __weak to be overwritten in case
of other implementations in user file.

3.1.14
3.1.15
3.1.16
78/692
HAL_GetHalVersion
Function Name
uint32_t HAL_GetHalVersion (void )
Function Description
Returns the HAL revision.
Return values

version : 0xXYZR (8bits for each decimal, R for RC)
HAL_GetREVID
Function Name
uint32_t HAL_GetREVID (void )
Function Description
Returns the device revision identifier.
Return values

Device revision identifier
HAL_GetDEVID
Function Name
uint32_t HAL_GetDEVID (void )
Function Description
Returns the device identifier.
DOCID028236 Rev 1
UM1940
HAL System Driver
Return values
3.1.17
3.1.18
3.1.19
3.1.20
3.1.21
3.1.22
3.1.23

Device identifier
HAL_DBGMCU_EnableDBGSleepMode
Function Name
void HAL_DBGMCU_EnableDBGSleepMode (void )
Function Description
Enable the Debug Module during SLEEP mode.
Return values

None
HAL_DBGMCU_DisableDBGSleepMode
Function Name
void HAL_DBGMCU_DisableDBGSleepMode (void )
Function Description
Disable the Debug Module during SLEEP mode.
Return values

None
HAL_DBGMCU_EnableDBGStopMode
Function Name
void HAL_DBGMCU_EnableDBGStopMode (void )
Function Description
Enable the Debug Module during STOP mode.
Return values

None
HAL_DBGMCU_DisableDBGStopMode
Function Name
void HAL_DBGMCU_DisableDBGStopMode (void )
Function Description
Disable the Debug Module during STOP mode.
Return values

None
HAL_DBGMCU_EnableDBGStandbyMode
Function Name
void HAL_DBGMCU_EnableDBGStandbyMode (void )
Function Description
Enable the Debug Module during STANDBY mode.
Return values

None
HAL_DBGMCU_DisableDBGStandbyMode
Function Name
void HAL_DBGMCU_DisableDBGStandbyMode (void )
Function Description
Disable the Debug Module during STANDBY mode.
Return values

None
HAL_EnableCompensationCell
Function Name
void HAL_EnableCompensationCell (void )
Function Description
Enables the I/O Compensation Cell.
Return values

None
Notes

The I/O compensation cell can be used only when the device
supply voltage ranges from 2.4 to 3.6 V.
DOCID028236 Rev 1
79/692
HAL System Driver
3.1.24
UM1940
HAL_DisableCompensationCell
Function Name
void HAL_DisableCompensationCell (void )
Function Description
Power-down the I/O Compensation Cell.
Return values

None
Notes

The I/O compensation cell can be used only when the device
supply voltage ranges from 2.4 to 3.6 V.
3.2
HAL Firmware driver defines
3.2.1
HAL
HAL CAN Error Code
HAL_CAN_ERROR_NONE
No error
HAL_CAN_ERROR_EWG
EWG error
HAL_CAN_ERROR_EPV
EPV error
HAL_CAN_ERROR_BOF
BOF error
HAL_CAN_ERROR_STF
Stuff error
HAL_CAN_ERROR_FOR
Form error
HAL_CAN_ERROR_ACK
Acknowledgment error
HAL_CAN_ERROR_BR
Bit recessive
HAL_CAN_ERROR_BD
LEC dominant
HAL_CAN_ERROR_CRC
LEC transfer error
HAL Exported Macros
__HAL_DBGMCU_FREEZE_TIM2
__HAL_DBGMCU_FREEZE_TIM3
__HAL_DBGMCU_FREEZE_TIM4
__HAL_DBGMCU_FREEZE_TIM5
__HAL_DBGMCU_FREEZE_TIM6
__HAL_DBGMCU_FREEZE_TIM7
__HAL_DBGMCU_FREEZE_TIM12
__HAL_DBGMCU_FREEZE_TIM13
__HAL_DBGMCU_FREEZE_TIM14
__HAL_DBGMCU_FREEZE_RTC
__HAL_DBGMCU_FREEZE_WWDG
__HAL_DBGMCU_FREEZE_IWDG
__HAL_DBGMCU_FREEZE_I2C1_TIMEOUT
__HAL_DBGMCU_FREEZE_I2C2_TIMEOUT
__HAL_DBGMCU_FREEZE_I2C3_TIMEOUT
80/692
DOCID028236 Rev 1
UM1940
HAL System Driver
__HAL_DBGMCU_FREEZE_CAN1
__HAL_DBGMCU_FREEZE_CAN2
__HAL_DBGMCU_FREEZE_TIM1
__HAL_DBGMCU_FREEZE_TIM8
__HAL_DBGMCU_FREEZE_TIM9
__HAL_DBGMCU_FREEZE_TIM10
__HAL_DBGMCU_FREEZE_TIM11
__HAL_DBGMCU_UNFREEZE_TIM2
__HAL_DBGMCU_UNFREEZE_TIM3
__HAL_DBGMCU_UNFREEZE_TIM4
__HAL_DBGMCU_UNFREEZE_TIM5
__HAL_DBGMCU_UNFREEZE_TIM6
__HAL_DBGMCU_UNFREEZE_TIM7
__HAL_DBGMCU_UNFREEZE_TIM12
__HAL_DBGMCU_UNFREEZE_TIM13
__HAL_DBGMCU_UNFREEZE_TIM14
__HAL_DBGMCU_UNFREEZE_RTC
__HAL_DBGMCU_UNFREEZE_WWDG
__HAL_DBGMCU_UNFREEZE_IWDG
__HAL_DBGMCU_UNFREEZE_I2C1_TIMEOUT
__HAL_DBGMCU_UNFREEZE_I2C2_TIMEOUT
__HAL_DBGMCU_UNFREEZE_I2C3_TIMEOUT
__HAL_DBGMCU_UNFREEZE_CAN1
__HAL_DBGMCU_UNFREEZE_CAN2
__HAL_DBGMCU_UNFREEZE_TIM1
__HAL_DBGMCU_UNFREEZE_TIM8
__HAL_DBGMCU_UNFREEZE_TIM9
__HAL_DBGMCU_UNFREEZE_TIM10
__HAL_DBGMCU_UNFREEZE_TIM11
__HAL_SYSCFG_REMAPMEMORY_FLASH
__HAL_SYSCFG_REMAPMEMORY_SYSTEMFLASH
__HAL_SYSCFG_REMAPMEMORY_SRAM
__HAL_SYSCFG_REMAPMEMORY_FSMC
HAL Private Constants
__STM32F2xx_HAL_VERSION_MAIN
[31:24] main version
__STM32F2xx_HAL_VERSION_SUB1
[23:16] sub1 version
DOCID028236 Rev 1
81/692
HAL System Driver
__STM32F2xx_HAL_VERSION_SUB2
__STM32F2xx_HAL_VERSION_RC
UM1940
[15:8] sub2 version
[7:0] release candidate
__STM32F2xx_HAL_VERSION
IDCODE_DEVID_MASK
SYSCFG_OFFSET
MEMRMP_OFFSET
UFB_MODE_BIT_NUMBER
UFB_MODE_BB
CMPCR_OFFSET
CMP_PD_BIT_NUMBER
CMPCR_CMP_PD_BB
82/692
DOCID028236 Rev 1
UM1940
HAL ADC Generic Driver
4
HAL ADC Generic Driver
4.1
ADC Firmware driver registers structures
4.1.1
ADC_InitTypeDef
Data Fields












uint32_t ClockPrescaler
uint32_t Resolution
uint32_t DataAlign
uint32_t ScanConvMode
uint32_t EOCSelection
uint32_t ContinuousConvMode
uint32_t NbrOfConversion
uint32_t DiscontinuousConvMode
uint32_t NbrOfDiscConversion
uint32_t ExternalTrigConv
uint32_t ExternalTrigConvEdge
uint32_t DMAContinuousRequests
Field Documentation





uint32_t ADC_InitTypeDef::ClockPrescaler
Select ADC clock prescaler. The clock is common for all the ADCs. This parameter
can be a value of ADC_ClockPrescaler
uint32_t ADC_InitTypeDef::Resolution
Configures the ADC resolution. This parameter can be a value of ADC_Resolution
uint32_t ADC_InitTypeDef::DataAlign
Specifies ADC data alignment to right (MSB on register bit 11 and LSB on register bit
0) (default setting) or to left (if regular group: MSB on register bit 15 and LSB on
register bit 4, if injected group (MSB kept as signed value due to potential negative
value after offset application): MSB on register bit 14 and LSB on register bit 3). This
parameter can be a value of ADC_Data_align
uint32_t ADC_InitTypeDef::ScanConvMode
Configures the sequencer of regular and injected groups. This parameter can be
associated to parameter 'DiscontinuousConvMode' to have main sequence subdivided
in successive parts. If disabled: Conversion is performed in single mode (one channel
converted, the one defined in rank 1). Parameters 'NbrOfConversion' and
'InjectedNbrOfConversion' are discarded (equivalent to set to 1). If enabled:
Conversions are performed in sequence mode (multiple ranks defined by
'NbrOfConversion'/'InjectedNbrOfConversion' and each channel rank). Scan direction
is upward: from rank1 to rank 'n'. This parameter can be set to ENABLE or DISABLE
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. Note: For injected group, end of conversion
(flag&IT) is raised only at the end of the sequence. Therefore, if end of conversion is
set to end of each conversion, injected group should not be used with interruption
(HAL_ADCEx_InjectedStart_IT) or polling (HAL_ADCEx_InjectedStart and
DOCID028236 Rev 1
83/692
HAL ADC Generic Driver
UM1940
HAL_ADCEx_InjectedPollForConversion). By the way, polling is still possible since
driver will use an estimated timing for end of injected conversion. Note: If overrun
feature is intended to be used, use ADC in mode 'interruption' (function
HAL_ADC_Start_IT() ) with parameter EOCSelection set to end of each conversion
or in mode 'transfer by DMA' (function HAL_ADC_Start_DMA()). If overrun feature is
intended to be bypassed, use ADC in mode 'polling' or 'interruption' with parameter
EOCSelection must be set to end of sequence

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::NbrOfConversion
Specifies the number of ranks that will be converted within the regular group
sequencer. To use regular group sequencer and convert several ranks, parameter
'ScanConvMode' must be enabled. This parameter must be a number between
Min_Data = 1 and Max_Data = 16.

uint32_t ADC_InitTypeDef::DiscontinuousConvMode
Specifies whether the conversions sequence of regular group is performed in
Complete-sequence/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.

uint32_t ADC_InitTypeDef::NbrOfDiscConversion
Specifies the number of discontinuous conversions in which the main sequence of
regular group (parameter NbrOfConversion) will be subdivided. If parameter
'DiscontinuousConvMode' is disabled, this parameter is discarded. This parameter
must be a number between Min_Data = 1 and Max_Data = 8.

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. If set to external trigger
source, triggering is on event rising edge by default. 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. Note: This parameter must be modified when no
conversion is on going on both regular and injected groups (ADC disabled, or ADC
enabled without continuous mode or external trigger that could launch a conversion).
This parameter can be set to ENABLE or DISABLE.
4.1.2
ADC_ChannelConfTypeDef
Data Fields

84/692
uint32_t Channel
DOCID028236 Rev 1
UM1940
HAL ADC Generic Driver



uint32_t Rank
uint32_t SamplingTime
uint32_t Offset
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
uint32_t ADC_ChannelConfTypeDef::Rank
Specifies the rank in the regular group sequencer. This parameter must be a number
between Min_Data = 1 and Max_Data = 16
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 ADC clock
cycles at ADC resolution 12 bits, 11 cycles at 10 bits, 9 cycles at 8 bits, 7 cycles at 6
bits). This parameter can be a value of ADC_sampling_times Caution: This
parameter updates the parameter property of the channel, that can be used into
regular and/or injected groups. If this same channel has been previously configured in
the other group (regular/injected), it will be updated to last setting. 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_temp (values rough order: 4us min).
uint32_t ADC_ChannelConfTypeDef::Offset
Reserved for future use, can be set to 0
ADC_AnalogWDGConfTypeDef
Data Fields






uint32_t WatchdogMode
uint32_t HighThreshold
uint32_t LowThreshold
uint32_t Channel
uint32_t ITMode
uint32_t WatchdogNumber
Field Documentation




uint32_t ADC_AnalogWDGConfTypeDef::WatchdogMode
Configures the ADC analog watchdog mode. This parameter can be a value of
ADC_analog_watchdog_selection
uint32_t ADC_AnalogWDGConfTypeDef::HighThreshold
Configures the ADC analog watchdog High threshold value. This parameter must be
a 12-bit value.
uint32_t ADC_AnalogWDGConfTypeDef::LowThreshold
Configures the ADC analog watchdog High threshold value. This parameter must be
a 12-bit value.
uint32_t ADC_AnalogWDGConfTypeDef::Channel
Configures ADC channel for the analog watchdog. This parameter has an effect only
DOCID028236 Rev 1
85/692
HAL ADC Generic Driver
UM1940
if watchdog mode is configured on single channel This parameter can be a value of
ADC_channels

uint32_t ADC_AnalogWDGConfTypeDef::ITMode
Specifies whether the analog watchdog is configured is interrupt mode or in polling
mode. This parameter can be set to ENABLE or DISABLE

uint32_t ADC_AnalogWDGConfTypeDef::WatchdogNumber
Reserved for future use, can be set to 0
4.1.4
ADC_HandleTypeDef
Data Fields







ADC_TypeDef * Instance
ADC_InitTypeDef Init
__IO uint32_t NbrOfCurrentConversionRank
DMA_HandleTypeDef * DMA_Handle
HAL_LockTypeDef Lock
__IO uint32_t State
__IO uint32_t ErrorCode
Field Documentation







ADC_TypeDef* ADC_HandleTypeDef::Instance
Register base address
ADC_InitTypeDef ADC_HandleTypeDef::Init
ADC required parameters
__IO uint32_t ADC_HandleTypeDef::NbrOfCurrentConversionRank
ADC number of current conversion rank
DMA_HandleTypeDef* ADC_HandleTypeDef::DMA_Handle
Pointer DMA Handler
HAL_LockTypeDef ADC_HandleTypeDef::Lock
ADC locking object
__IO uint32_t ADC_HandleTypeDef::State
ADC communication state
__IO uint32_t ADC_HandleTypeDef::ErrorCode
ADC Error code
4.2
ADC Firmware driver API description
4.2.1
ADC Peripheral features
1.
2.
3.
4.
5.
6.
86/692
12-bit, 10-bit, 8-bit or 6-bit configurable resolution.
Interrupt generation at the end of conversion, end of injected conversion, and in case
of analog watchdog or overrun events
Single and continuous conversion modes.
Scan mode for automatic conversion of channel 0 to channel x.
Data alignment with in-built data coherency.
Channel-wise programmable sampling time.
DOCID028236 Rev 1
UM1940
7.
8.
9.
10.
11.
12.
13.
14.
4.2.2
HAL ADC Generic Driver
External trigger option with configurable polarity for both regular and injected
conversion.
Dual/Triple mode (on devices with 2 ADCs or more).
Configurable DMA data storage in Dual/Triple ADC mode.
Configurable delay between conversions in Dual/Triple interleaved mode.
ADC conversion type (refer to the datasheets).
ADC supply requirements: 2.4 V to 3.6 V at full speed and down to 1.8 V at slower
speed.
ADC input range: VREF(minus) = VIN = VREF(plus).
DMA request generation during regular channel conversion.
How to use this driver
1.
Initialize the ADC low level resources by implementing the HAL_ADC_MspInit():
a.
Enable the ADC interface clock using __HAL_RCC_ADC_CLK_ENABLE()
b.
ADC pins configuration

Enable the clock for the ADC GPIOs using the following function:
__HAL_RCC_GPIOx_CLK_ENABLE()

Configure these ADC pins in analog mode using HAL_GPIO_Init()
c.
In case of using interrupts (e.g. HAL_ADC_Start_IT())

Configure the ADC interrupt priority using HAL_NVIC_SetPriority()

Enable the ADC IRQ handler using HAL_NVIC_EnableIRQ()

In ADC IRQ handler, call HAL_ADC_IRQHandler()
d.
In case of using DMA to control data transfer (e.g. HAL_ADC_Start_DMA())

Enable the DMAx interface clock using
__HAL_RCC_DMAx_CLK_ENABLE()

Configure and enable two DMA streams stream for managing data transfer
from peripheral to memory (output stream)

Associate the initialized DMA handle to the CRYP DMA handle using
__HAL_LINKDMA()

Configure the priority and enable the NVIC for the transfer complete
interrupt on the two DMA Streams. The output stream should have higher
priority than the input stream.
Configuration of ADC, groups regular/injected, channels parameters
1.
2.
3.
4.
5.
Configure the ADC parameters (resolution, data alignment, ...) and regular group
parameters (conversion trigger, sequencer, ...) using function HAL_ADC_Init().
Configure the channels for regular group parameters (channel number, channel rank
into sequencer, ..., into regular group) using function HAL_ADC_ConfigChannel().
Optionally, configure the injected group parameters (conversion trigger, sequencer,
..., of injected group) and the channels for injected group parameters (channel
number, channel rank into sequencer, ..., into injected group) using function
HAL_ADCEx_InjectedConfigChannel().
Optionally, configure the analog watchdog parameters (channels monitored,
thresholds, ...) using function HAL_ADC_AnalogWDGConfig().
Optionally, for devices with several ADC instances: configure the multimode
parameters using function HAL_ADCEx_MultiModeConfigChannel().
Execution of ADC conversions
1.
ADC driver can be used among three modes: polling, interruption, transfer by DMA.
DOCID028236 Rev 1
87/692
HAL ADC Generic Driver
UM1940
Polling mode IO operation




Start the ADC peripheral using HAL_ADC_Start()
Wait for end of conversion using HAL_ADC_PollForConversion(), at this stage user
can specify the value of timeout according to his end application
To read the ADC converted values, use the HAL_ADC_GetValue() function.
Stop the ADC peripheral using HAL_ADC_Stop()
Interrupt mode IO operation





Start the ADC peripheral using HAL_ADC_Start_IT()
Use HAL_ADC_IRQHandler() called under ADC_IRQHandler() Interrupt subroutine
At ADC end of conversion HAL_ADC_ConvCpltCallback() function is executed and
user can add his own code by customization of function pointer
HAL_ADC_ConvCpltCallback
In case of ADC Error, HAL_ADC_ErrorCallback() function is executed and user can
add his own code by customization of function pointer HAL_ADC_ErrorCallback
Stop the ADC peripheral using HAL_ADC_Stop_IT()
DMA mode IO operation




Start the ADC peripheral using HAL_ADC_Start_DMA(), at this stage the user specify
the length of data to be transferred at each end of conversion
At The end of data transfer by HAL_ADC_ConvCpltCallback() function is executed
and user can add his own code by customization of function pointer
HAL_ADC_ConvCpltCallback
In case of transfer Error, HAL_ADC_ErrorCallback() function is executed and user
can add his own code by customization of function pointer HAL_ADC_ErrorCallback
Stop the ADC peripheral using HAL_ADC_Stop_DMA()
ADC HAL driver macros list
Below the list of most used macros in ADC HAL driver.








__HAL_ADC_ENABLE : Enable the ADC peripheral
__HAL_ADC_DISABLE : Disable the ADC peripheral
__HAL_ADC_ENABLE_IT: Enable the ADC end of conversion interrupt
__HAL_ADC_DISABLE_IT: Disable the ADC end of conversion interrupt
__HAL_ADC_GET_IT_SOURCE: Check if the specified ADC interrupt source is
enabled or disabled
__HAL_ADC_CLEAR_FLAG: Clear the ADC's pending flags
__HAL_ADC_GET_FLAG: Get the selected ADC's flag status
ADC_GET_RESOLUTION: Return resolution bits in CR1 register
You can refer to the ADC HAL driver header file for more useful macros
88/692
DOCID028236 Rev 1
UM1940
HAL ADC Generic Driver
Deinitialization of ADC
1.
2.
3.
4.
4.2.3
Disable the ADC interface

ADC clock can be hard reset and disabled at RCC top level.

Hard reset of ADC peripherals using macro
__HAL_RCC_ADC_FORCE_RESET(), __HAL_RCC_ADC_RELEASE_RESET().

ADC clock disable using the equivalent macro/functions as configuration step.

Example: Into HAL_ADC_MspDeInit() (recommended code location) or with
other device clock parameters configuration:

HAL_RCC_GetOscConfig(&RCC_OscInitStructure);

RCC_OscInitStructure.OscillatorType = RCC_OSCILLATORTYPE_HSI;

RCC_OscInitStructure.HSIState = RCC_HSI_OFF; (if not used for system
clock)

HAL_RCC_OscConfig(&RCC_OscInitStructure);
ADC pins configuration

Disable the clock for the ADC GPIOs using macro
__HAL_RCC_GPIOx_CLK_DISABLE()
Optionally, in case of usage of ADC with interruptions:

Disable the NVIC for ADC using function HAL_NVIC_DisableIRQ(ADCx_IRQn)
Optionally, in case of usage of DMA:

Deinitialize the DMA using function HAL_DMA_DeInit().

Disable the NVIC for DMA using function
HAL_NVIC_DisableIRQ(DMAx_Channelx_IRQn)
Initialization and de-initialization functions
This section provides functions allowing to:


Initialize and configure the ADC.
De-initialize the ADC.
This section contains the following APIs:




4.2.4
HAL_ADC_Init()
HAL_ADC_DeInit()
HAL_ADC_MspInit()
HAL_ADC_MspDeInit()
IO operation functions
This section provides functions allowing to:







Start conversion of regular channel.
Stop conversion of regular channel.
Start conversion of regular channel and enable interrupt.
Stop conversion of regular channel and disable interrupt.
Start conversion of regular channel and enable DMA transfer.
Stop conversion of regular channel and disable DMA transfer.
Handle ADC interrupt request.
This section contains the following APIs:




HAL_ADC_Start()
HAL_ADC_Stop()
HAL_ADC_PollForConversion()
HAL_ADC_PollForEvent()
DOCID028236 Rev 1
89/692
HAL ADC Generic Driver










4.2.5
UM1940
HAL_ADC_Start_IT()
HAL_ADC_Stop_IT()
HAL_ADC_IRQHandler()
HAL_ADC_Start_DMA()
HAL_ADC_Stop_DMA()
HAL_ADC_GetValue()
HAL_ADC_ConvCpltCallback()
HAL_ADC_ConvHalfCpltCallback()
HAL_ADC_LevelOutOfWindowCallback()
HAL_ADC_ErrorCallback()
Peripheral Control functions
This section provides functions allowing to:




Configure regular channels.
Configure injected channels.
Configure multimode.
Configure the analog watch dog.
This section contains the following APIs:


4.2.6
HAL_ADC_ConfigChannel()
HAL_ADC_AnalogWDGConfig()
Peripheral State and errors functions
This subsection provides functions allowing to


Check the ADC state
Check the ADC Error
This section contains the following APIs:


4.2.7
4.2.8
90/692
HAL_ADC_GetState()
HAL_ADC_GetError()
HAL_ADC_Init
Function Name
HAL_StatusTypeDef HAL_ADC_Init (ADC_HandleTypeDef *
hadc)
Function Description
Initializes the ADCx peripheral according to the specified
parameters in the ADC_InitStruct and initializes the ADC MSP.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

HAL status
Notes

This function is used to configure the global features of the
ADC ( ClockPrescaler, Resolution, Data Alignment and
number of conversion), however, the rest of the configuration
parameters are specific to the regular channels group (scan
mode activation, continuous mode activation, External trigger
source and edge, DMA continuous request after the last
transfer and End of conversion selection).
HAL_ADC_DeInit
DOCID028236 Rev 1
UM1940
Function Name
4.2.9
4.2.10
4.2.11
4.2.12
4.2.13
HAL ADC Generic Driver
HAL_StatusTypeDef HAL_ADC_DeInit (ADC_HandleTypeDef *
hadc)
Function Description
Deinitializes the ADCx peripheral registers to their default reset
values.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

HAL status
HAL_ADC_MspInit
Function Name
void HAL_ADC_MspInit (ADC_HandleTypeDef * hadc)
Function Description
Initializes the ADC MSP.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

None
HAL_ADC_MspDeInit
Function Name
void HAL_ADC_MspDeInit (ADC_HandleTypeDef * hadc)
Function Description
DeInitializes the ADC MSP.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

None
HAL_ADC_Start
Function Name
HAL_StatusTypeDef HAL_ADC_Start (ADC_HandleTypeDef *
hadc)
Function Description
Enables ADC and starts conversion of the regular channels.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

HAL status
HAL_ADC_Stop
Function Name
HAL_StatusTypeDef HAL_ADC_Stop (ADC_HandleTypeDef *
hadc)
Function Description
Disables ADC and stop conversion of regular channels.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

HAL status.
Notes

Caution: This function will stop also injected channels.
HAL_ADC_PollForConversion
DOCID028236 Rev 1
91/692
HAL ADC Generic Driver
Function Name
UM1940
HAL_StatusTypeDef HAL_ADC_PollForConversion
(ADC_HandleTypeDef * hadc, uint32_t Timeout)
Function Description
Poll for regular conversion complete.
Parameters


hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Timeout: Timeout value in millisecond.
Return values

HAL status
Notes

ADC conversion flags EOS (end of sequence) and EOC (end
of conversion) are cleared by this function.
This function cannot be used in a particular setup: ADC
configured in DMA mode and polling for end of each
conversion (ADC init parameter "EOCSelection" set to
ADC_EOC_SINGLE_CONV). In this case, DMA resets the
flag EOC and polling cannot be performed on each
conversion. Nevertheless, polling can still be performed on
the complete sequence.

4.2.14
HAL_ADC_PollForEvent
Function Name
HAL_StatusTypeDef HAL_ADC_PollForEvent
(ADC_HandleTypeDef * hadc, uint32_t EventType, uint32_t
Timeout)
Function Description
Poll for conversion event.
Parameters


hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
EventType: the ADC event type. This parameter can be one
of the following values: ADC_AWD_EVENT: ADC Analog
watch Dog event.ADC_OVR_EVENT: ADC Overrun event.
Timeout: Timeout value in millisecond.

HAL status

Return values
4.2.15
4.2.16
92/692
HAL_ADC_Start_IT
Function Name
HAL_StatusTypeDef HAL_ADC_Start_IT (ADC_HandleTypeDef
* hadc)
Function Description
Enables the interrupt and starts ADC conversion of regular
channels.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

HAL status.
HAL_ADC_Stop_IT
Function Name
HAL_StatusTypeDef HAL_ADC_Stop_IT (ADC_HandleTypeDef
* hadc)
Function Description
Disables the interrupt and stop ADC conversion of regular
channels.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
DOCID028236 Rev 1
UM1940
4.2.17
4.2.18
HAL ADC Generic Driver
contains the configuration information for the specified ADC.
Return values

HAL status.
Notes

Caution: This function will stop also injected channels.
HAL_ADC_IRQHandler
Function Name
void HAL_ADC_IRQHandler (ADC_HandleTypeDef * hadc)
Function Description
Handles ADC interrupt request.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

None
HAL_ADC_Start_DMA
Function Name
HAL_StatusTypeDef HAL_ADC_Start_DMA
(ADC_HandleTypeDef * hadc, uint32_t * pData, uint32_t
Length)
Function Description
Enables ADC DMA request after last transfer (Single-ADC mode)
and enables ADC peripheral.
Parameters

Return values
4.2.19
4.2.20
4.2.21


hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
pData: The destination Buffer address.
Length: The length of data to be transferred from ADC
peripheral to memory.

HAL status
HAL_ADC_Stop_DMA
Function Name
HAL_StatusTypeDef HAL_ADC_Stop_DMA
(ADC_HandleTypeDef * hadc)
Function Description
Disables ADC DMA (Single-ADC mode) and disables ADC
peripheral.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

HAL status
HAL_ADC_GetValue
Function Name
uint32_t HAL_ADC_GetValue (ADC_HandleTypeDef * hadc)
Function Description
Gets the converted value from data register of regular channel.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

Converted value
HAL_ADC_ConvCpltCallback
DOCID028236 Rev 1
93/692
HAL ADC Generic Driver
Function Name
4.2.22
4.2.23
4.2.24
4.2.25
Function Description
Regular conversion complete callback in non blocking mode.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

None
HAL_ADC_ConvHalfCpltCallback
Function Name
void HAL_ADC_ConvHalfCpltCallback (ADC_HandleTypeDef *
hadc)
Function Description
Regular conversion half DMA transfer callback in non blocking
mode.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

None
HAL_ADC_LevelOutOfWindowCallback
Function Name
void HAL_ADC_LevelOutOfWindowCallback
(ADC_HandleTypeDef * hadc)
Function Description
Analog watchdog callback in non blocking mode.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

None
HAL_ADC_ErrorCallback
Function Name
void HAL_ADC_ErrorCallback (ADC_HandleTypeDef * hadc)
Function Description
Error ADC callback.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

None
HAL_ADC_ConfigChannel
Function Name
HAL_StatusTypeDef HAL_ADC_ConfigChannel
(ADC_HandleTypeDef * hadc, ADC_ChannelConfTypeDef *
sConfig)
Function Description
Configures for the selected ADC regular channel its corresponding
rank in the sequencer and its sample time.
Parameters

Return values
94/692
UM1940
void HAL_ADC_ConvCpltCallback (ADC_HandleTypeDef *
hadc)

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
sConfig: ADC configuration structure.

HAL status
DOCID028236 Rev 1
UM1940
4.2.26
HAL ADC Generic Driver
HAL_ADC_AnalogWDGConfig
Function Name
HAL_StatusTypeDef HAL_ADC_AnalogWDGConfig
(ADC_HandleTypeDef * hadc, ADC_AnalogWDGConfTypeDef *
AnalogWDGConfig)
Function Description
Configures the analog watchdog.
Parameters

Return values
4.2.27
4.2.28

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
AnalogWDGConfig: : pointer to an
ADC_AnalogWDGConfTypeDef structure that contains the
configuration information of ADC analog watchdog.

HAL status
HAL_ADC_GetState
Function Name
uint32_t HAL_ADC_GetState (ADC_HandleTypeDef * hadc)
Function Description
return the ADC state
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

HAL state
HAL_ADC_GetError
Function Name
uint32_t HAL_ADC_GetError (ADC_HandleTypeDef * hadc)
Function Description
Return the ADC error code.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

ADC Error Code
4.3
ADC Firmware driver defines
4.3.1
ADC
ADC Analog Watchdog Selection
ADC_ANALOGWATCHDOG_SINGLE_REG
ADC_ANALOGWATCHDOG_SINGLE_INJEC
ADC_ANALOGWATCHDOG_SINGLE_REGINJEC
ADC_ANALOGWATCHDOG_ALL_REG
ADC_ANALOGWATCHDOG_ALL_INJEC
ADC_ANALOGWATCHDOG_ALL_REGINJEC
ADC_ANALOGWATCHDOG_NONE
ADC Common Channels
ADC_CHANNEL_0
ADC_CHANNEL_1
DOCID028236 Rev 1
95/692
HAL ADC Generic Driver
ADC_CHANNEL_2
UM1940
ADC_CHANNEL_3
ADC_CHANNEL_4
ADC_CHANNEL_5
ADC_CHANNEL_6
ADC_CHANNEL_7
ADC_CHANNEL_8
ADC_CHANNEL_9
ADC_CHANNEL_10
ADC_CHANNEL_11
ADC_CHANNEL_12
ADC_CHANNEL_13
ADC_CHANNEL_14
ADC_CHANNEL_15
ADC_CHANNEL_16
ADC_CHANNEL_17
ADC_CHANNEL_18
ADC_CHANNEL_VREFINT
ADC_CHANNEL_VBAT
ADC Channels Type
ADC_ALL_CHANNELS
ADC_REGULAR_CHANNELS
reserved for future use
ADC_INJECTED_CHANNELS
reserved for future use
ADC Clock Prescaler
ADC_CLOCK_SYNC_PCLK_DIV2
ADC_CLOCK_SYNC_PCLK_DIV4
ADC_CLOCK_SYNC_PCLK_DIV6
ADC_CLOCK_SYNC_PCLK_DIV8
ADC Data Align
ADC_DATAALIGN_RIGHT
ADC_DATAALIGN_LEFT
ADC Delay Between 2 Sampling Phases
ADC_TWOSAMPLINGDELAY_5CYCLES
ADC_TWOSAMPLINGDELAY_6CYCLES
ADC_TWOSAMPLINGDELAY_7CYCLES
ADC_TWOSAMPLINGDELAY_8CYCLES
96/692
DOCID028236 Rev 1
UM1940
HAL ADC Generic Driver
ADC_TWOSAMPLINGDELAY_9CYCLES
ADC_TWOSAMPLINGDELAY_10CYCLES
ADC_TWOSAMPLINGDELAY_11CYCLES
ADC_TWOSAMPLINGDELAY_12CYCLES
ADC_TWOSAMPLINGDELAY_13CYCLES
ADC_TWOSAMPLINGDELAY_14CYCLES
ADC_TWOSAMPLINGDELAY_15CYCLES
ADC_TWOSAMPLINGDELAY_16CYCLES
ADC_TWOSAMPLINGDELAY_17CYCLES
ADC_TWOSAMPLINGDELAY_18CYCLES
ADC_TWOSAMPLINGDELAY_19CYCLES
ADC_TWOSAMPLINGDELAY_20CYCLES
ADC EOC Selection
ADC_EOC_SEQ_CONV
ADC_EOC_SINGLE_CONV
ADC_EOC_SINGLE_SEQ_CONV
reserved for future use
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
ADC_AWD_EVENT
ADC_OVR_EVENT
ADC Exported Macros
__HAL_ADC_RESET_HANDLE_STATE
Description:

Reset ADC handle state.
Parameters:

__HANDLE__: ADC handle
Return value:

__HAL_ADC_ENABLE
None
Description:

Enable the ADC peripheral.
Parameters:

__HANDLE__: ADC handle
DOCID028236 Rev 1
97/692
HAL ADC Generic Driver
UM1940
Return value:

None
Description:
__HAL_ADC_DISABLE

Disable the ADC peripheral.
Parameters:

__HANDLE__: ADC handle
Return value:

None
Description:
__HAL_ADC_ENABLE_IT

Enable the ADC end of conversion
interrupt.
Parameters:


__HANDLE__: specifies the ADC Handle.
__INTERRUPT__: ADC Interrupt.
Return value:

None
Description:
__HAL_ADC_DISABLE_IT

Disable the ADC end of conversion
interrupt.
Parameters:


__HANDLE__: specifies the ADC Handle.
__INTERRUPT__: ADC interrupt.
Return value:

__HAL_ADC_GET_IT_SOURCE
None
Description:

Check if the specified ADC interrupt source
is enabled or disabled.
Parameters:


__HANDLE__: specifies the ADC Handle.
__INTERRUPT__: specifies the ADC
interrupt source to check.
Return value:

__HAL_ADC_CLEAR_FLAG
The: new state of __IT__ (TRUE or
FALSE).
Description:

Clear the ADC's pending flags.
Parameters:


98/692
__HANDLE__: specifies the ADC Handle.
__FLAG__: ADC flag.
DOCID028236 Rev 1
UM1940
HAL ADC Generic Driver
Return value:

None
Description:
__HAL_ADC_GET_FLAG

Get the selected ADC's flag status.
Parameters:


__HANDLE__: specifies the ADC Handle.
__FLAG__: ADC flag.
Return value:

None
ADC Exported Types
HAL_ADC_STATE_RESET
ADC not yet initialized or disabled
HAL_ADC_STATE_READY
ADC peripheral ready for use
HAL_ADC_STATE_BUSY_INTERNAL
ADC is busy to internal process (initialization,
calibration)
HAL_ADC_STATE_TIMEOUT
TimeOut occurrence
HAL_ADC_STATE_ERROR_INTERNAL
Internal error occurrence
HAL_ADC_STATE_ERROR_CONFIG
Configuration error occurrence
HAL_ADC_STATE_ERROR_DMA
DMA error occurrence
HAL_ADC_STATE_REG_BUSY
A conversion on group regular is ongoing or
can occur (either by continuous mode, external
trigger, low power auto power-on (if feature
available), multimode ADC master control (if
feature available))
HAL_ADC_STATE_REG_EOC
Conversion data available on group regular
HAL_ADC_STATE_REG_OVR
Overrun occurrence
HAL_ADC_STATE_INJ_BUSY
A conversion on group injected is ongoing or
can occur (either by auto-injection mode,
external trigger, low power auto power-on (if
feature available), multimode ADC master
control (if feature available))
HAL_ADC_STATE_INJ_EOC
Conversion data available on group injected
HAL_ADC_STATE_AWD1
Out-of-window occurrence of analog watchdog
1
ADC External Trigger Edge Regular
ADC_EXTERNALTRIGCONVEDGE_NONE
ADC_EXTERNALTRIGCONVEDGE_RISING
ADC_EXTERNALTRIGCONVEDGE_FALLING
ADC_EXTERNALTRIGCONVEDGE_RISINGFALLING
ADC External Trigger Source Regular
ADC_EXTERNALTRIGCONV_T1_CC1
DOCID028236 Rev 1
99/692
HAL ADC Generic Driver
ADC_EXTERNALTRIGCONV_T1_CC2
UM1940
ADC_EXTERNALTRIGCONV_T1_CC3
ADC_EXTERNALTRIGCONV_T2_CC2
ADC_EXTERNALTRIGCONV_T2_CC3
ADC_EXTERNALTRIGCONV_T2_CC4
ADC_EXTERNALTRIGCONV_T2_TRGO
ADC_EXTERNALTRIGCONV_T3_CC1
ADC_EXTERNALTRIGCONV_T3_TRGO
ADC_EXTERNALTRIGCONV_T4_CC4
ADC_EXTERNALTRIGCONV_T5_CC1
ADC_EXTERNALTRIGCONV_T5_CC2
ADC_EXTERNALTRIGCONV_T5_CC3
ADC_EXTERNALTRIGCONV_T8_CC1
ADC_EXTERNALTRIGCONV_T8_TRGO
ADC_EXTERNALTRIGCONV_Ext_IT11
ADC_SOFTWARE_START
ADC Flags Definition
ADC_FLAG_AWD
ADC_FLAG_EOC
ADC_FLAG_JEOC
ADC_FLAG_JSTRT
ADC_FLAG_STRT
ADC_FLAG_OVR
ADC Interrupts Definition
ADC_IT_EOC
ADC_IT_AWD
ADC_IT_JEOC
ADC_IT_OVR
ADC Private Constants
ADC_STAB_DELAY_US
ADC_TEMPSENSOR_DELAY_US
ADC Private Macros
ADC_IS_ENABLE
Description:

Verification of ADC state: enabled or
disabled.
Parameters:

100/692
DOCID028236 Rev 1
__HANDLE__: ADC handle
UM1940
HAL ADC Generic Driver
Return value:

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:

ADC_IS_SOFTWARE_START_INJECTED
SET: (software start) or RESET
(external trigger)
Description:

Test if conversion trigger of injected
group is software start or external
trigger.
Parameters:

__HANDLE__: ADC handle
Return value:

SET: (software start) or RESET
(external trigger)
Description:
ADC_STATE_CLR_SET

Simultaneously clears and sets specific
bits of the handle State.
Return value:

None
Notes:

ADC_CLEAR_ERRORCODE
: ADC_STATE_CLR_SET() macro is
merely aliased to generic macro
MODIFY_REG(), the first parameter is
the ADC handle State, the second
parameter is the bit field to clear, the
third and last parameter is the bit field to
set.
Description:

Clear ADC error code (set it to error
code: "no error")
Parameters:

__HANDLE__: ADC handle
Return value:

DOCID028236 Rev 1
None
101/692
HAL ADC Generic Driver
IS_ADC_CLOCKPRESCALER
UM1940
IS_ADC_SAMPLING_DELAY
IS_ADC_RESOLUTION
IS_ADC_EXT_TRIG_EDGE
IS_ADC_EXT_TRIG
IS_ADC_DATA_ALIGN
IS_ADC_SAMPLE_TIME
IS_ADC_EOCSelection
IS_ADC_EVENT_TYPE
IS_ADC_ANALOG_WATCHDOG
IS_ADC_CHANNELS_TYPE
IS_ADC_THRESHOLD
IS_ADC_REGULAR_LENGTH
IS_ADC_REGULAR_RANK
IS_ADC_REGULAR_DISC_NUMBER
IS_ADC_RANGE
ADC_SQR1
Description:

Set ADC Regular channel sequence
length.
Parameters:

_NbrOfConversion_: Regular channel
sequence length.
Return value:

ADC_SMPR1
None
Description:

Set the ADC's sample time for channel
numbers between 10 and 18.
Parameters:


_SAMPLETIME_: Sample time
parameter.
_CHANNELNB_: Channel number.
Return value:

ADC_SMPR2
None
Description:

Set the ADC's sample time for channel
numbers between 0 and 9.
Parameters:

102/692
DOCID028236 Rev 1
_SAMPLETIME_: Sample time
parameter.
UM1940
HAL ADC Generic Driver

_CHANNELNB_: Channel number.
Return value:

None
Description:
ADC_SQR3_RK

Set the selected regular channel rank for
rank between 1 and 6.
Parameters:


_CHANNELNB_: Channel number.
_RANKNB_: Rank number.
Return value:

None
Description:
ADC_SQR2_RK

Set the selected regular channel rank for
rank between 7 and 12.
Parameters:


_CHANNELNB_: Channel number.
_RANKNB_: Rank number.
Return value:

None
Description:
ADC_SQR1_RK

Set the selected regular channel rank for
rank between 13 and 16.
Parameters:


_CHANNELNB_: Channel number.
_RANKNB_: Rank number.
Return value:

None
Description:
ADC_CR2_CONTINUOUS

Enable ADC continuous conversion
mode.
Parameters:

_CONTINUOUS_MODE_: Continuous
mode.
Return value:

ADC_CR1_DISCONTINUOUS
None
Description:

DOCID028236 Rev 1
Configures the number of discontinuous
conversions for the regular group
channels.
103/692
HAL ADC Generic Driver
UM1940
Parameters:

_NBR_DISCONTINUOUSCONV_:
Number of discontinuous conversions.
Return value:

ADC_CR1_SCANCONV
None
Description:

Enable ADC scan mode.
Parameters:

_SCANCONV_MODE_: Scan
conversion mode.
Return value:

ADC_CR2_EOCSelection
None
Description:

Enable the ADC end of conversion
selection.
Parameters:

_EOCSelection_MODE_: End of
conversion selection mode.
Return value:

ADC_CR2_DMAContReq
None
Description:

Enable the ADC DMA continuous
request.
Parameters:

_DMAContReq_MODE_: DMA
continuous request mode.
Return value:

ADC_GET_RESOLUTION
None
Description:

Return resolution bits in CR1 register.
Parameters:

__HANDLE__: ADC handle
Return value:

ADC Resolution
ADC_RESOLUTION_12B
ADC_RESOLUTION_10B
ADC_RESOLUTION_8B
104/692
DOCID028236 Rev 1
None
UM1940
HAL ADC Generic Driver
ADC_RESOLUTION_6B
ADC Sampling Times
ADC_SAMPLETIME_3CYCLES
ADC_SAMPLETIME_15CYCLES
ADC_SAMPLETIME_28CYCLES
ADC_SAMPLETIME_56CYCLES
ADC_SAMPLETIME_84CYCLES
ADC_SAMPLETIME_112CYCLES
ADC_SAMPLETIME_144CYCLES
ADC_SAMPLETIME_480CYCLES
DOCID028236 Rev 1
105/692
HAL ADC Extension Driver
UM1940
5
HAL ADC Extension Driver
5.1
ADCEx Firmware driver registers structures
5.1.1
ADC_InjectionConfTypeDef
Data Fields









uint32_t InjectedChannel
uint32_t InjectedRank
uint32_t InjectedSamplingTime
uint32_t InjectedOffset
uint32_t InjectedNbrOfConversion
uint32_t InjectedDiscontinuousConvMode
uint32_t AutoInjectedConv
uint32_t ExternalTrigInjecConv
uint32_t ExternalTrigInjecConvEdge
Field Documentation





106/692
uint32_t ADC_InjectionConfTypeDef::InjectedChannel
Selection of ADC channel to configure 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_InjectionConfTypeDef::InjectedRank
Rank in the injected group sequencer This parameter must be a value of
ADCEx_injected_rank Note: In case of need to disable a channel or change order of
conversion sequencer, rank containing a previous channel setting can be overwritten
by the new channel setting (or parameter number of conversions can be adjusted)
uint32_t ADC_InjectionConfTypeDef::InjectedSamplingTime
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 ADC clock
cycles at ADC resolution 12 bits, 11 cycles at 10 bits, 9 cycles at 8 bits, 7 cycles at 6
bits). This parameter can be a value of ADC_sampling_times Caution: This
parameter updates the parameter property of the channel, that can be used into
regular and/or injected groups. If this same channel has been previously configured in
the other group (regular/injected), it will be updated to last setting. 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_temp (values rough order: 4us min).
uint32_t ADC_InjectionConfTypeDef::InjectedOffset
Defines the offset to be subtracted from the raw converted data (for channels set on
injected group only). Offset value must be a positive number. 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_InjectionConfTypeDef::InjectedNbrOfConversion
Specifies the number of ranks that will be converted within the injected group
sequencer. To use the injected group sequencer and convert several ranks,
parameter 'ScanConvMode' must be enabled. This parameter must be a number
DOCID028236 Rev 1
UM1940




5.1.2
HAL ADC Extension Driver
between Min_Data = 1 and Max_Data = 4. Caution: this setting impacts the entire
injected group. Therefore, call of HAL_ADCEx_InjectedConfigChannel() to configure
a channel on injected group can impact the configuration of other channels previously
set.
uint32_t ADC_InjectionConfTypeDef::InjectedDiscontinuousConvMode
Specifies whether the conversions sequence of injected group is performed in
Complete-sequence/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: For injected group, number of discontinuous ranks
increment is fixed to one-by-one. Caution: this setting impacts the entire injected
group. Therefore, call of HAL_ADCEx_InjectedConfigChannel() to configure a
channel on injected group can impact the configuration of other channels previously
set.
uint32_t ADC_InjectionConfTypeDef::AutoInjectedConv
Enables or disables the selected ADC automatic injected group conversion after
regular one This parameter can be set to ENABLE or DISABLE. Note: To use
Automatic injected conversion, discontinuous mode must be disabled
('DiscontinuousConvMode' and 'InjectedDiscontinuousConvMode' set to DISABLE)
Note: To use Automatic injected conversion, injected group external triggers must be
disabled ('ExternalTrigInjecConv' set to ADC_SOFTWARE_START) Note: In case of
DMA used with regular group: if DMA configured in normal mode (single shot) JAUTO
will be stopped upon DMA transfer complete. To maintain JAUTO always enabled,
DMA must be configured in circular mode. Caution: this setting impacts the entire
injected group. Therefore, call of HAL_ADCEx_InjectedConfigChannel() to configure
a channel on injected group can impact the configuration of other channels previously
set.
uint32_t ADC_InjectionConfTypeDef::ExternalTrigInjecConv
Selects the external event used to trigger the conversion start of injected group. If set
to ADC_INJECTED_SOFTWARE_START, external triggers are disabled. If set to
external trigger source, triggering is on event rising edge. This parameter can be a
value of ADCEx_External_trigger_Source_Injected Note: This parameter must be
modified when ADC is disabled (before ADC start conversion or after ADC stop
conversion). If ADC is enabled, this parameter setting is bypassed without error
reporting (as it can be the expected behaviour in case of another parameter update on
the fly) Caution: this setting impacts the entire injected group. Therefore, call of
HAL_ADCEx_InjectedConfigChannel() to configure a channel on injected group can
impact the configuration of other channels previously set.
uint32_t ADC_InjectionConfTypeDef::ExternalTrigInjecConvEdge
Selects the external trigger edge of injected group. This parameter can be a value of
ADCEx_External_trigger_edge_Injected. If trigger is set to
ADC_INJECTED_SOFTWARE_START, this parameter is discarded. Caution: this
setting impacts the entire injected group. Therefore, call of
HAL_ADCEx_InjectedConfigChannel() to configure a channel on injected group can
impact the configuration of other channels previously set.
ADC_MultiModeTypeDef
Data Fields

uint32_t Mode
DOCID028236 Rev 1
107/692
HAL ADC Extension Driver


UM1940
uint32_t DMAAccessMode
uint32_t TwoSamplingDelay
Field Documentation



uint32_t ADC_MultiModeTypeDef::Mode
Configures the ADC to operate in independent or multi mode. This parameter can be
a value of ADCEx_Common_mode
uint32_t ADC_MultiModeTypeDef::DMAAccessMode
Configures the Direct memory access mode for multi ADC mode. This parameter can
be a value of ADCEx_Direct_memory_access_mode_for_multi_mode
uint32_t ADC_MultiModeTypeDef::TwoSamplingDelay
Configures the Delay between 2 sampling phases. This parameter can be a value of
ADC_delay_between_2_sampling_phases
5.2
ADCEx Firmware driver API description
5.2.1
How to use this driver
1.
2.
3.
4.
Initialize the ADC low level resources by implementing the HAL_ADC_MspInit():
a.
Enable the ADC interface clock using __HAL_RCC_ADC_CLK_ENABLE()
b.
ADC pins configuration

Enable the clock for the ADC GPIOs using the following function:
__HAL_RCC_GPIOx_CLK_ENABLE()

Configure these ADC pins in analog mode using HAL_GPIO_Init()
c.
In case of using interrupts (e.g. HAL_ADC_Start_IT())

Configure the ADC interrupt priority using HAL_NVIC_SetPriority()

Enable the ADC IRQ handler using HAL_NVIC_EnableIRQ()

In ADC IRQ handler, call HAL_ADC_IRQHandler()
d.
In case of using DMA to control data transfer (e.g. HAL_ADC_Start_DMA())

Enable the DMAx interface clock using
__HAL_RCC_DMAx_CLK_ENABLE()

Configure and enable two DMA streams stream for managing data transfer
from peripheral to memory (output stream)

Associate the initialized DMA handle to the ADC DMA handle using
__HAL_LINKDMA()

Configure the priority and enable the NVIC for the transfer complete
interrupt on the two DMA Streams. The output stream should have higher
priority than the input stream.
Configure the ADC Prescaler, conversion resolution and data alignment using the
HAL_ADC_Init() function.
Configure the ADC Injected channels group features, use HAL_ADC_Init() and
HAL_ADC_ConfigChannel() functions.
Three operation modes are available within this driver :
Polling mode IO operation


108/692
Start the ADC peripheral using HAL_ADCEx_InjectedStart()
Wait for end of conversion using HAL_ADC_PollForConversion(), at this stage user
can specify the value of timeout according to his end application
DOCID028236 Rev 1
UM1940
HAL ADC Extension Driver


To read the ADC converted values, use the HAL_ADCEx_InjectedGetValue()
function.
Stop the ADC peripheral using HAL_ADCEx_InjectedStop()
Interrupt mode IO operation





Start the ADC peripheral using HAL_ADCEx_InjectedStart_IT()
Use HAL_ADC_IRQHandler() called under ADC_IRQHandler() Interrupt subroutine
At ADC end of conversion HAL_ADCEx_InjectedConvCpltCallback() function is
executed and user can add his own code by customization of function pointer
HAL_ADCEx_InjectedConvCpltCallback
In case of ADC Error, HAL_ADCEx_InjectedErrorCallback() function is executed and
user can add his own code by customization of function pointer
HAL_ADCEx_InjectedErrorCallback
Stop the ADC peripheral using HAL_ADCEx_InjectedStop_IT()
DMA mode IO operation




Start the ADC peripheral using HAL_ADCEx_InjectedStart_DMA(), at this stage the
user specify the length of data to be transferred at each end of conversion
At The end of data transfer ba HAL_ADCEx_InjectedConvCpltCallback() function is
executed and user can add his own code by customization of function pointer
HAL_ADCEx_InjectedConvCpltCallback
In case of transfer Error, HAL_ADCEx_InjectedErrorCallback() function is executed
and user can add his own code by customization of function pointer
HAL_ADCEx_InjectedErrorCallback
Stop the ADC peripheral using HAL_ADCEx_InjectedStop_DMA()
Multi mode ADCs Regular channels configuration



5.2.2
Select the Multi mode ADC regular channels features (dual or triple mode) and
configure the DMA mode using HAL_ADCEx_MultiModeConfigChannel() functions.
Start the ADC peripheral using HAL_ADCEx_MultiModeStart_DMA(), at this stage the
user specify the length of data to be transferred at each end of conversion
Read the ADCs converted values using the HAL_ADCEx_MultiModeGetValue()
function.
Extended features functions
This section provides functions allowing to:








Start conversion of injected channel.
Stop conversion of injected channel.
Start multimode and enable DMA transfer.
Stop multimode and disable DMA transfer.
Get result of injected channel conversion.
Get result of multimode conversion.
Configure injected channels.
Configure multimode.
This section contains the following APIs:
DOCID028236 Rev 1
109/692
HAL ADC Extension Driver












5.2.3
5.2.4
5.2.5
UM1940
HAL_ADCEx_InjectedStart()
HAL_ADCEx_InjectedStart_IT()
HAL_ADCEx_InjectedStop()
HAL_ADCEx_InjectedPollForConversion()
HAL_ADCEx_InjectedStop_IT()
HAL_ADCEx_InjectedGetValue()
HAL_ADCEx_MultiModeStart_DMA()
HAL_ADCEx_MultiModeStop_DMA()
HAL_ADCEx_MultiModeGetValue()
HAL_ADCEx_InjectedConvCpltCallback()
HAL_ADCEx_InjectedConfigChannel()
HAL_ADCEx_MultiModeConfigChannel()
HAL_ADCEx_InjectedStart
Function Name
HAL_StatusTypeDef HAL_ADCEx_InjectedStart
(ADC_HandleTypeDef * hadc)
Function Description
Enables the selected ADC software start conversion of the injected
channels.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

HAL status
HAL_ADCEx_InjectedStart_IT
Function Name
HAL_StatusTypeDef HAL_ADCEx_InjectedStart_IT
(ADC_HandleTypeDef * hadc)
Function Description
Enables the interrupt and starts ADC conversion of injected
channels.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

HAL status.
HAL_ADCEx_InjectedStop
Function Name
HAL_StatusTypeDef HAL_ADCEx_InjectedStop
(ADC_HandleTypeDef * hadc)
Function Description
Stop conversion of injected channels.
Parameters

hadc: ADC handle
Return values

None
Notes

If ADC must be disabled and if conversion is on going on
regular group, function HAL_ADC_Stop must be used to stop
both injected and regular groups, and disable the ADC.
If injected group mode auto-injection is enabled, function
HAL_ADC_Stop must be used.
In case of auto-injection mode, HAL_ADC_Stop must be
used.


5.2.6
110/692
HAL_ADCEx_InjectedPollForConversion
DOCID028236 Rev 1
UM1940
Function Name
HAL ADC Extension Driver
HAL_StatusTypeDef HAL_ADCEx_InjectedPollForConversion
(ADC_HandleTypeDef * hadc, uint32_t Timeout)
Function Description
Poll for injected conversion complete.
Parameters

Return values
5.2.7

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Timeout: Timeout value in millisecond.

HAL status
HAL_ADCEx_InjectedStop_IT
Function Name
HAL_StatusTypeDef HAL_ADCEx_InjectedStop_IT
(ADC_HandleTypeDef * hadc)
Function Description
Stop conversion of injected channels, disable interruption of endof-conversion.
Parameters

hadc: ADC handle
Return values

None
Notes

If ADC must be disabled and if conversion is on going on
regular group, function HAL_ADC_Stop must be used to stop
both injected and regular groups, and disable the ADC.
If injected group mode auto-injection is enabled, function
HAL_ADC_Stop must be used.

5.2.8
HAL_ADCEx_InjectedGetValue
Function Name
uint32_t HAL_ADCEx_InjectedGetValue (ADC_HandleTypeDef
* hadc, uint32_t InjectedRank)
Function Description
Gets the converted value from data register of injected channel.
Parameters


Return values
5.2.9

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
InjectedRank: the ADC injected rank. This parameter can be
one of the following values: ADC_INJECTED_RANK_1:
Injected Channel1 selectedADC_INJECTED_RANK_2:
Injected Channel2 selectedADC_INJECTED_RANK_3:
Injected Channel3 selectedADC_INJECTED_RANK_4:
Injected Channel4 selected
None
HAL_ADCEx_MultiModeStart_DMA
Function Name
HAL_StatusTypeDef HAL_ADCEx_MultiModeStart_DMA
(ADC_HandleTypeDef * hadc, uint32_t * pData, uint32_t
Length)
Function Description
Enables ADC DMA request after last transfer (Multi-ADC mode)
and enables ADC peripheral.
Parameters


hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
pData: Pointer to buffer in which transferred from ADC
peripheral to memory will be stored.
DOCID028236 Rev 1
111/692
HAL ADC Extension Driver
5.2.10
5.2.11
5.2.12
5.2.13
Length: The length of data to be transferred from ADC
peripheral to memory.
Return values

HAL status
Notes

Caution: This function must be used only with the ADC
master.
HAL_ADCEx_MultiModeStop_DMA
Function Name
HAL_StatusTypeDef HAL_ADCEx_MultiModeStop_DMA
(ADC_HandleTypeDef * hadc)
Function Description
Disables ADC DMA (multi-ADC mode) and disables ADC
peripheral.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

HAL status
HAL_ADCEx_MultiModeGetValue
Function Name
uint32_t HAL_ADCEx_MultiModeGetValue
(ADC_HandleTypeDef * hadc)
Function Description
Returns the last ADC1, ADC2 and ADC3 regular conversions
results data in the selected multi mode.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

The converted data value.
HAL_ADCEx_InjectedConvCpltCallback
Function Name
void HAL_ADCEx_InjectedConvCpltCallback
(ADC_HandleTypeDef * hadc)
Function Description
Injected conversion complete callback in non blocking mode.
Parameters

hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
Return values

None
HAL_ADCEx_InjectedConfigChannel
Function Name
HAL_StatusTypeDef HAL_ADCEx_InjectedConfigChannel
(ADC_HandleTypeDef * hadc, ADC_InjectionConfTypeDef *
sConfigInjected)
Function Description
Configures for the selected ADC injected channel its
corresponding rank in the sequencer and its sample time.
Parameters

Return values
112/692
UM1940


hadc: pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
sConfigInjected: ADC configuration structure for injected
channel.

None
DOCID028236 Rev 1
UM1940
5.2.14
HAL ADC Extension Driver
HAL_ADCEx_MultiModeConfigChannel
Function Name
HAL_StatusTypeDef HAL_ADCEx_MultiModeConfigChannel
(ADC_HandleTypeDef * hadc, ADC_MultiModeTypeDef *
multimode)
Function Description
Configures the ADC multi-mode.
Parameters

Return values

hadc: : pointer to a ADC_HandleTypeDef structure that
contains the configuration information for the specified ADC.
multimode: : pointer to an ADC_MultiModeTypeDef
structure that contains the configuration information for
multimode.

HAL status
5.3
ADCEx Firmware driver defines
5.3.1
ADCEx
ADC Specific Channels
ADC_CHANNEL_TEMPSENSOR
ADC Common Mode
ADC_MODE_INDEPENDENT
ADC_DUALMODE_REGSIMULT_INJECSIMULT
ADC_DUALMODE_REGSIMULT_ALTERTRIG
ADC_DUALMODE_INJECSIMULT
ADC_DUALMODE_REGSIMULT
ADC_DUALMODE_INTERL
ADC_DUALMODE_ALTERTRIG
ADC_TRIPLEMODE_REGSIMULT_INJECSIMULT
ADC_TRIPLEMODE_REGSIMULT_AlterTrig
ADC_TRIPLEMODE_INJECSIMULT
ADC_TRIPLEMODE_REGSIMULT
ADC_TRIPLEMODE_INTERL
ADC_TRIPLEMODE_ALTERTRIG
ADC Direct Memory Access Mode For Multi Mode
ADC_DMAACCESSMODE_DISABLED
DMA mode disabled
ADC_DMAACCESSMODE_1
DMA mode 1 enabled (2 / 3 half-words one by
one - 1 then 2 then 3)
ADC_DMAACCESSMODE_2
DMA mode 2 enabled (2 / 3 half-words by pairs 2&1 then 1&3 then 3&2)
ADC_DMAACCESSMODE_3
DMA mode 3 enabled (2 / 3 bytes by pairs - 2&1
then 1&3 then 3&2)
ADC External Trigger Edge Injected
DOCID028236 Rev 1
113/692
HAL ADC Extension Driver
ADC_EXTERNALTRIGINJECCONVEDGE_NONE
ADC_EXTERNALTRIGINJECCONVEDGE_RISING
ADC_EXTERNALTRIGINJECCONVEDGE_FALLING
ADC_EXTERNALTRIGINJECCONVEDGE_RISINGFALLING
ADC External Trigger Source Injected
ADC_EXTERNALTRIGINJECCONV_T1_CC4
ADC_EXTERNALTRIGINJECCONV_T1_TRGO
ADC_EXTERNALTRIGINJECCONV_T2_CC1
ADC_EXTERNALTRIGINJECCONV_T2_TRGO
ADC_EXTERNALTRIGINJECCONV_T3_CC2
ADC_EXTERNALTRIGINJECCONV_T3_CC4
ADC_EXTERNALTRIGINJECCONV_T4_CC1
ADC_EXTERNALTRIGINJECCONV_T4_CC2
ADC_EXTERNALTRIGINJECCONV_T4_CC3
ADC_EXTERNALTRIGINJECCONV_T4_TRGO
ADC_EXTERNALTRIGINJECCONV_T5_CC4
ADC_EXTERNALTRIGINJECCONV_T5_TRGO
ADC_EXTERNALTRIGINJECCONV_T8_CC2
ADC_EXTERNALTRIGINJECCONV_T8_CC3
ADC_EXTERNALTRIGINJECCONV_T8_CC4
ADC_EXTERNALTRIGINJECCONV_EXT_IT15
ADC_INJECTED_SOFTWARE_START
ADC Injected Rank
ADC_INJECTED_RANK_1
ADC_INJECTED_RANK_2
ADC_INJECTED_RANK_3
ADC_INJECTED_RANK_4
ADC Private Macros
IS_ADC_CHANNEL
IS_ADC_MODE
IS_ADC_DMA_ACCESS_MODE
IS_ADC_EXT_INJEC_TRIG_EDGE
IS_ADC_EXT_INJEC_TRIG
IS_ADC_INJECTED_LENGTH
IS_ADC_INJECTED_RANK
ADC_JSQR
114/692
Description:
DOCID028236 Rev 1
UM1940
UM1940
HAL ADC Extension Driver

Set the selected injected Channel rank.
Parameters:



_CHANNELNB_: Channel number.
_RANKNB_: Rank number.
_JSQR_JL_: Sequence length.
Return value:

None
DOCID028236 Rev 1
115/692
HAL CAN Generic Driver
UM1940
6
HAL CAN Generic Driver
6.1
CAN Firmware driver registers structures
6.1.1
CAN_InitTypeDef
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









116/692
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
DOCID028236 Rev 1
UM1940
HAL CAN Generic Driver


6.1.2
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
Data Fields










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








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
DOCID028236 Rev 1
117/692
HAL CAN Generic Driver


6.1.3
UM1940
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
Data Fields






uint32_t StdId
uint32_t ExtId
uint32_t IDE
uint32_t RTR
uint32_t DLC
uint8_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
uint8_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
Data Fields







118/692
uint32_t StdId
uint32_t ExtId
uint32_t IDE
uint32_t RTR
uint32_t DLC
uint8_t Data
uint32_t FMI
DOCID028236 Rev 1
UM1940
HAL CAN Generic Driver

uint32_t FIFONumber
Field Documentation








6.1.5
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
uint8_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
uint32_t CanRxMsgTypeDef::FIFONumber
Specifies the receive FIFO number. This parameter can be CAN_FIFO0 or
CAN_FIFO1
CAN_HandleTypeDef
Data Fields







CAN_TypeDef * Instance
CAN_InitTypeDef Init
CanTxMsgTypeDef * pTxMsg
CanRxMsgTypeDef * pRxMsg
__IO HAL_CAN_StateTypeDef State
HAL_LockTypeDef Lock
__IO uint32_t ErrorCode
Field Documentation




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
DOCID028236 Rev 1
119/692
HAL CAN Generic Driver



UM1940
__IO HAL_CAN_StateTypeDef CAN_HandleTypeDef::State
CAN communication state
HAL_LockTypeDef CAN_HandleTypeDef::Lock
CAN locking object
__IO uint32_t CAN_HandleTypeDef::ErrorCode
CAN Error code
6.2
CAN Firmware driver API description
6.2.1
How to use this driver
1.
2.
3.
4.
5.
Enable the CAN controller interface clock using __HAL_RCC_CAN1_CLK_ENABLE()
for CAN1 and __HAL_RCC_CAN2_CLK_ENABLE() for CAN2 In case you are using
CAN2 only, you have to enable the CAN1 clock.
CAN pins configuration

Enable the clock for the CAN GPIOs using the following function:
__GPIOx_CLK_ENABLE()

Connect and configure the involved CAN pins to AF9 using the following function
HAL_GPIO_Init()
Initialize and configure the CAN using 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


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.


120/692
__HAL_CAN_ENABLE_IT: Enable the specified CAN interrupts
__HAL_CAN_DISABLE_IT: Disable the specified CAN interrupts
DOCID028236 Rev 1
UM1940
HAL CAN Generic Driver



__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
Initialization and de-initialization functions
This section provides functions allowing to:


Initialize and configure the CAN.
De-initialize the CAN.
This section contains the following APIs:





6.2.3
HAL_CAN_Init()
HAL_CAN_ConfigFilter()
HAL_CAN_DeInit()
HAL_CAN_MspInit()
HAL_CAN_MspDeInit()
IO operation functions
This section provides functions allowing to:




Transmit a CAN frame message.
Receive a CAN frame message.
Enter CAN peripheral in sleep mode.
Wake up the CAN peripheral from sleep mode.
This section contains the following APIs:










6.2.4
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 :


Check the CAN state.
Check CAN Errors detected during interrupt process
This section contains the following APIs:


HAL_CAN_GetState()
HAL_CAN_GetError()
DOCID028236 Rev 1
121/692
HAL CAN Generic Driver
6.2.5
6.2.6
HAL_CAN_Init
Function Name
HAL_StatusTypeDef HAL_CAN_Init (CAN_HandleTypeDef *
hcan)
Function Description
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
HAL_CAN_ConfigFilter
Function Name
HAL_StatusTypeDef HAL_CAN_ConfigFilter
(CAN_HandleTypeDef * hcan, CAN_FilterConfTypeDef *
sFilterConfig)
Function Description
Configures the CAN reception filter according to the specified
parameters in the CAN_FilterInitStruct.
Parameters

Return values
6.2.7
6.2.8
6.2.9
122/692
UM1940

hcan: pointer to a CAN_HandleTypeDef structure that
contains the configuration information for the specified CAN.
sFilterConfig: pointer to a CAN_FilterConfTypeDef structure
that contains the filter configuration information.

None
HAL_CAN_DeInit
Function Name
HAL_StatusTypeDef HAL_CAN_DeInit (CAN_HandleTypeDef *
hcan)
Function Description
Deinitializes the CANx peripheral registers to their default reset
values.
Parameters

hcan: pointer to a CAN_HandleTypeDef structure that
contains the configuration information for the specified CAN.
Return values

HAL status
HAL_CAN_MspInit
Function Name
void HAL_CAN_MspInit (CAN_HandleTypeDef * hcan)
Function Description
Initializes the CAN MSP.
Parameters

hcan: pointer to a CAN_HandleTypeDef structure that
contains the configuration information for the specified CAN.
Return values

None
HAL_CAN_MspDeInit
Function Name
void HAL_CAN_MspDeInit (CAN_HandleTypeDef * hcan)
Function Description
DeInitializes the CAN MSP.
Parameters

hcan: pointer to a CAN_HandleTypeDef structure that
contains the configuration information for the specified CAN.
DOCID028236 Rev 1
UM1940
HAL CAN Generic Driver
Return values
6.2.10
6.2.12
Function Name
HAL_StatusTypeDef HAL_CAN_Transmit
(CAN_HandleTypeDef * hcan, uint32_t Timeout)
Function Description
Initiates and transmits a CAN frame message.
Parameters


HAL status
Function Name
HAL_StatusTypeDef HAL_CAN_Transmit_IT
(CAN_HandleTypeDef * hcan)
Function Description
Initiates and transmits a CAN frame message.
Parameters

hcan: pointer to a CAN_HandleTypeDef structure that
contains the configuration information for the specified CAN.
Return values

HAL status
HAL_CAN_Receive
Function Name
HAL_StatusTypeDef HAL_CAN_Receive (CAN_HandleTypeDef
* hcan, uint8_t FIFONumber, uint32_t Timeout)
Function Description
Receives a correct CAN frame.
Parameters



hcan: pointer to a CAN_HandleTypeDef structure that
contains the configuration information for the specified CAN.
FIFONumber: FIFO Number value
Timeout: Specify Timeout value

HAL status
HAL_CAN_Receive_IT
Function Name
HAL_StatusTypeDef HAL_CAN_Receive_IT
(CAN_HandleTypeDef * hcan, uint8_t FIFONumber)
Function Description
Receives a correct CAN frame.
Parameters

Return values
6.2.14

hcan: pointer to a CAN_HandleTypeDef structure that
contains the configuration information for the specified CAN.
Timeout: Specify Timeout value
HAL_CAN_Transmit_IT
Return values
6.2.13
None
HAL_CAN_Transmit
Return values
6.2.11


hcan: Pointer to a CAN_HandleTypeDef structure that
contains the configuration information for the specified CAN.
FIFONumber: Specify the FIFO number

HAL status
HAL_CAN_Sleep
Function Name
HAL_StatusTypeDef HAL_CAN_Sleep (CAN_HandleTypeDef *
hcan)
Function Description
Enters the Sleep (low power) mode.
DOCID028236 Rev 1
123/692
HAL CAN Generic Driver
Parameters
Return values
6.2.15
6.2.16
6.2.17
6.2.18
6.2.19
124/692
UM1940

hcan: pointer to a CAN_HandleTypeDef structure that
contains the configuration information for the specified CAN.

HAL status.
HAL_CAN_WakeUp
Function Name
HAL_StatusTypeDef HAL_CAN_WakeUp
(CAN_HandleTypeDef * hcan)
Function Description
Wakes up the CAN peripheral from sleep mode, after that the CAN
peripheral is in the normal mode.
Parameters

hcan: pointer to a CAN_HandleTypeDef structure that
contains the configuration information for the specified CAN.
Return values

HAL status.
HAL_CAN_IRQHandler
Function Name
void HAL_CAN_IRQHandler (CAN_HandleTypeDef * hcan)
Function Description
Handles CAN interrupt request.
Parameters

hcan: pointer to a CAN_HandleTypeDef structure that
contains the configuration information for the specified CAN.
Return values

None
HAL_CAN_TxCpltCallback
Function Name
void HAL_CAN_TxCpltCallback (CAN_HandleTypeDef * hcan)
Function Description
Transmission complete callback in non blocking mode.
Parameters

hcan: pointer to a CAN_HandleTypeDef structure that
contains the configuration information for the specified CAN.
Return values

None
HAL_CAN_RxCpltCallback
Function Name
void HAL_CAN_RxCpltCallback (CAN_HandleTypeDef * hcan)
Function Description
Transmission complete callback in non blocking mode.
Parameters

hcan: pointer to a CAN_HandleTypeDef structure that
contains the configuration information for the specified CAN.
Return values

None
HAL_CAN_ErrorCallback
Function Name
void HAL_CAN_ErrorCallback (CAN_HandleTypeDef * hcan)
Function Description
Error CAN callback.
Parameters

hcan: pointer to a CAN_HandleTypeDef structure that
contains the configuration information for the specified CAN.
Return values

None
DOCID028236 Rev 1
UM1940
6.2.20
6.2.21
HAL CAN Generic Driver
HAL_CAN_GetState
Function Name
HAL_CAN_StateTypeDef HAL_CAN_GetState
(CAN_HandleTypeDef * hcan)
Function Description
return the CAN state
Parameters

hcan: pointer to a CAN_HandleTypeDef structure that
contains the configuration information for the specified CAN.
Return values

HAL state
HAL_CAN_GetError
Function Name
uint32_t HAL_CAN_GetError (CAN_HandleTypeDef * hcan)
Function Description
Return the CAN error code.
Parameters

hcan: pointer to a CAN_HandleTypeDef structure that
contains the configuration information for the specified CAN.
Return values

CAN Error Code
6.3
CAN Firmware driver defines
6.3.1
CAN
CAN Exported Macros
__HAL_CAN_RESET_HANDLE_STATE
Description:

Reset CAN handle state.
Parameters:

__HANDLE__: specifies the CAN Handle.
Return value:

__HAL_CAN_ENABLE_IT
None
Description:

Enable the specified CAN interrupts.
Parameters:


__HANDLE__: CAN handle
__INTERRUPT__: CAN Interrupt
Return value:

__HAL_CAN_DISABLE_IT
None
Description:

Disable the specified CAN interrupts.
Parameters:


__HANDLE__: CAN handle
__INTERRUPT__: CAN Interrupt
Return value:
DOCID028236 Rev 1
125/692
HAL CAN Generic Driver
UM1940

__HAL_CAN_MSG_PENDING
None
Description:

Return the number of pending received
messages.
Parameters:


__HANDLE__: CAN handle
__FIFONUMBER__: Receive FIFO
number, CAN_FIFO0 or CAN_FIFO1.
Return value:

__HAL_CAN_GET_FLAG
The: number of pending message.
Description:

Check whether the specified CAN flag is
set or not.
Parameters:


126/692
__HANDLE__: CAN Handle
__FLAG__: specifies the flag to check.
This parameter can be one of the following
values:

CAN_TSR_RQCP0: Request
MailBox0 Flag

CAN_TSR_RQCP1: Request
MailBox1 Flag

CAN_TSR_RQCP2: Request
MailBox2 Flag

CAN_FLAG_TXOK0: Transmission
OK MailBox0 Flag

CAN_FLAG_TXOK1: Transmission
OK MailBox1 Flag

CAN_FLAG_TXOK2: Transmission
OK MailBox2 Flag

CAN_FLAG_TME0: Transmit mailbox
0 empty Flag

CAN_FLAG_TME1: Transmit mailbox
1 empty Flag

CAN_FLAG_TME2: Transmit mailbox
2 empty Flag

CAN_FLAG_FMP0: FIFO 0 Message
Pending Flag

CAN_FLAG_FF0: FIFO 0 Full Flag

CAN_FLAG_FOV0: FIFO 0 Overrun
Flag

CAN_FLAG_FMP1: FIFO 1 Message
Pending 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
DOCID028236 Rev 1
UM1940
HAL CAN Generic Driver




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_CLEAR_FLAG
The: new state of __FLAG__ (TRUE or
FALSE).
Description:

Clear the specified CAN pending flag.
Parameters:


__HANDLE__: CAN Handle.
__FLAG__: specifies the flag to check.
This parameter can be one of the following
values:

CAN_TSR_RQCP0: Request
MailBox0 Flag

CAN_TSR_RQCP1: Request
MailBox1 Flag

CAN_TSR_RQCP2: Request
MailBox2 Flag

CAN_FLAG_TXOK0: Transmission
OK MailBox0 Flag

CAN_FLAG_TXOK1: Transmission
OK MailBox1 Flag

CAN_FLAG_TXOK2: Transmission
OK MailBox2 Flag

CAN_FLAG_TME0: Transmit mailbox
0 empty Flag

CAN_FLAG_TME1: Transmit mailbox
1 empty Flag

CAN_FLAG_TME2: Transmit mailbox
2 empty Flag

CAN_FLAG_FMP0: FIFO 0 Message
Pending Flag

CAN_FLAG_FF0: FIFO 0 Full Flag

CAN_FLAG_FOV0: FIFO 0 Overrun
Flag

CAN_FLAG_FMP1: FIFO 1 Message
Pending 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
DOCID028236 Rev 1
127/692
HAL CAN Generic Driver
UM1940


CAN_FLAG_EPV: Error Passive Flag
CAN_FLAG_BOF: Bus-Off Flag
Return value:

__HAL_CAN_GET_IT_SOURCE
The: new state of __FLAG__ (TRUE or
FALSE).
Description:

Check if the specified CAN interrupt source
is enabled or disabled.
Parameters:


__HANDLE__: CAN Handle
__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 enable

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:


__HANDLE__: CAN Handle
__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:

Release the specified receive FIFO.
Parameters:


__HANDLE__: CAN handle
__FIFONUMBER__: Receive FIFO
number, CAN_FIFO0 or CAN_FIFO1.
Return value:

__HAL_CAN_CANCEL_TRANSMIT
Description:

128/692
None
Cancel a transmit request.
DOCID028236 Rev 1
UM1940
HAL CAN Generic Driver
Parameters:


__HANDLE__: CAN Handle
__TRANSMITMAILBOX__: the number of
the mailbox that is used for transmission.
Return value:

None
Description:
__HAL_CAN_DBG_FREEZE

Enable or disable the DBG Freeze for
CAN.
Parameters:


__HANDLE__: CAN Handle
__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
CAN Filter Mode
CAN_FILTERMODE_IDMASK
Identifier mask mode
CAN_FILTERMODE_IDLIST
Identifier list mode
CAN Filter Scale
CAN_FILTERSCALE_16BIT
Two 16-bit filters
CAN_FILTERSCALE_32BIT
One 32-bit filter
CAN Flags
CAN_FLAG_RQCP0
Request MailBox0 flag
CAN_FLAG_RQCP1
Request MailBox1 flag
CAN_FLAG_RQCP2
Request MailBox2 flag
CAN_FLAG_TXOK0
Transmission OK MailBox0 flag
CAN_FLAG_TXOK1
Transmission OK MailBox1 flag
CAN_FLAG_TXOK2
Transmission OK MailBox2 flag
CAN_FLAG_TME0
Transmit mailbox 0 empty flag
CAN_FLAG_TME1
Transmit mailbox 0 empty flag
CAN_FLAG_TME2
Transmit mailbox 0 empty flag
CAN_FLAG_FF0
FIFO 0 Full flag
DOCID028236 Rev 1
129/692
HAL CAN Generic Driver
CAN_FLAG_FOV0
UM1940
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
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
CAN_IT_FMP1
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 Mailboxes Definition
CAN_TXMAILBOX_0
CAN_TXMAILBOX_1
CAN_TXMAILBOX_2
CAN Operating Mode
CAN_MODE_NORMAL
130/692
Normal mode
DOCID028236 Rev 1
UM1940
HAL CAN Generic Driver
CAN_MODE_LOOPBACK
Loopback mode
CAN_MODE_SILENT
Silent mode
CAN_MODE_SILENT_LOOPBACK
Loopback combined with silent mode
CAN Private Constants
CAN_TIMEOUT_VALUE
CAN_TXSTATUS_NOMAILBOX
CAN cell did not provide CAN_TxStatus_NoMailBox
CAN_FLAG_MASK
CAN Private Macros
IS_CAN_MODE
IS_CAN_SJW
IS_CAN_BS1
IS_CAN_BS2
IS_CAN_PRESCALER
IS_CAN_FILTER_NUMBER
IS_CAN_FILTER_MODE
IS_CAN_FILTER_SCALE
IS_CAN_FILTER_FIFO
IS_CAN_BANKNUMBER
IS_CAN_TRANSMITMAILBOX
IS_CAN_STDID
IS_CAN_EXTID
IS_CAN_DLC
IS_CAN_IDTYPE
IS_CAN_RTR
IS_CAN_FIFO
CAN Receive FIFO Number Constants
CAN_FIFO0
CAN FIFO 0 used to receive
CAN_FIFO1
CAN FIFO 1 used to receive
CAN Remote Transmission Request
CAN_RTR_DATA
Data frame
CAN_RTR_REMOTE
Remote frame
CAN Synchronisation Jump Width
CAN_SJW_1TQ
1 time quantum
CAN_SJW_2TQ
2 time quantum
CAN_SJW_3TQ
3 time quantum
CAN_SJW_4TQ
4 time quantum
CAN Time Quantum in bit segment 1
DOCID028236 Rev 1
131/692
HAL CAN Generic Driver
CAN_BS1_1TQ
1 time quantum
UM1940
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
CAN Time Quantum in bit segment 2
132/692
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
DOCID028236 Rev 1
UM1940
HAL CORTEX Generic Driver
7
HAL CORTEX Generic Driver
7.1
CORTEX Firmware driver registers structures
7.1.1
MPU_Region_InitTypeDef
Data Fields











uint8_t Enable
uint8_t Number
uint32_t BaseAddress
uint8_t Size
uint8_t SubRegionDisable
uint8_t TypeExtField
uint8_t AccessPermission
uint8_t DisableExec
uint8_t IsShareable
uint8_t IsCacheable
uint8_t IsBufferable
Field Documentation









uint8_t MPU_Region_InitTypeDef::Enable
Specifies the status of the region. This parameter can be a value of
CORTEX_MPU_Region_Enable
uint8_t MPU_Region_InitTypeDef::Number
Specifies the number of the region to protect. This parameter can be a value of
CORTEX_MPU_Region_Number
uint32_t MPU_Region_InitTypeDef::BaseAddress
Specifies the base address of the region to protect.
uint8_t MPU_Region_InitTypeDef::Size
Specifies the size of the region to protect. This parameter can be a value of
CORTEX_MPU_Region_Size
uint8_t MPU_Region_InitTypeDef::SubRegionDisable
Specifies the number of the subregion protection to disable. This parameter must be
a number between Min_Data = 0x00 and Max_Data = 0xFF
uint8_t MPU_Region_InitTypeDef::TypeExtField
Specifies the TEX field level. This parameter can be a value of
CORTEX_MPU_TEX_Levels
uint8_t MPU_Region_InitTypeDef::AccessPermission
Specifies the region access permission type. This parameter can be a value of
CORTEX_MPU_Region_Permission_Attributes
uint8_t MPU_Region_InitTypeDef::DisableExec
Specifies the instruction access status. This parameter can be a value of
CORTEX_MPU_Instruction_Access
uint8_t MPU_Region_InitTypeDef::IsShareable
Specifies the shareability status of the protected region. This parameter can be a
value of CORTEX_MPU_Access_Shareable
DOCID028236 Rev 1
133/692
HAL CORTEX Generic Driver


UM1940
uint8_t MPU_Region_InitTypeDef::IsCacheable
Specifies the cacheable status of the region protected. This parameter can be a value
of CORTEX_MPU_Access_Cacheable
uint8_t MPU_Region_InitTypeDef::IsBufferable
Specifies the bufferable status of the protected region. This parameter can be a value
of CORTEX_MPU_Access_Bufferable
7.2
CORTEX Firmware driver API description
7.2.1
How to use this driver
How to configure Interrupts using CORTEX HAL driver
This section provides functions allowing to configure the NVIC interrupts (IRQ). The
Cortex-M3 exceptions are managed by CMSIS functions.
1.
2.
3.
4.
Configure the NVIC Priority Grouping using HAL_NVIC_SetPriorityGrouping()
function according to the following table.
Configure the priority of the selected IRQ Channels using HAL_NVIC_SetPriority().
Enable the selected IRQ Channels using HAL_NVIC_EnableIRQ().
please refer to programing manual for details in how to configure priority. When the
NVIC_PRIORITYGROUP_0 is selected, IRQ preemption is no more possible. The
pending IRQ priority will be managed only by the sub priority. IRQ priority order
(sorted by highest to lowest priority): Lowest preemption priority Lowest sub priority
Lowest hardware priority (IRQ number)
How to configure Systick using CORTEX HAL driver
Setup SysTick Timer for time base.




134/692
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 (0x0F).

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
stm32f2xx_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
DOCID028236 Rev 1
UM1940
HAL CORTEX Generic Driver

7.2.2
Reload Value should not exceed 0xFFFFFF
Initialization and de-initialization functions
This section provides the CORTEX HAL driver functions allowing to configure Interrupts
Systick functionalities
This section contains the following APIs:






7.2.3
HAL_NVIC_SetPriorityGrouping()
HAL_NVIC_SetPriority()
HAL_NVIC_EnableIRQ()
HAL_NVIC_DisableIRQ()
HAL_NVIC_SystemReset()
HAL_SYSTICK_Config()
Peripheral Control functions
This subsection provides a set of functions allowing to control the CORTEX (NVIC,
SYSTICK, MPU) functionalities.
This section contains the following APIs:










7.2.4
7.2.5
HAL_MPU_ConfigRegion()
HAL_NVIC_GetPriorityGrouping()
HAL_NVIC_GetPriority()
HAL_NVIC_SetPendingIRQ()
HAL_NVIC_GetPendingIRQ()
HAL_NVIC_ClearPendingIRQ()
HAL_NVIC_GetActive()
HAL_SYSTICK_CLKSourceConfig()
HAL_SYSTICK_IRQHandler()
HAL_SYSTICK_Callback()
HAL_NVIC_SetPriorityGrouping
Function Name
void HAL_NVIC_SetPriorityGrouping (uint32_t PriorityGroup)
Function Description
Sets the priority grouping field (preemption priority and subpriority)
using the required unlock sequence.
Parameters

PriorityGroup: The priority grouping bits length. This
parameter can be one of the following values:
NVIC_PRIORITYGROUP_0: 0 bits for preemption priority 4
bits for subpriorityNVIC_PRIORITYGROUP_1: 1 bits for
preemption priority 3 bits for
subpriorityNVIC_PRIORITYGROUP_2: 2 bits for preemption
priority 2 bits for subpriorityNVIC_PRIORITYGROUP_3: 3 bits
for preemption priority 1 bits for
subpriorityNVIC_PRIORITYGROUP_4: 4 bits for preemption
priority 0 bits for subpriority
Return values

None
Notes

When the NVIC_PriorityGroup_0 is selected, IRQ preemption
is no more possible. The pending IRQ priority will be
managed only by the subpriority.
HAL_NVIC_SetPriority
DOCID028236 Rev 1
135/692
HAL CORTEX Generic Driver
Function Name
UM1940
void HAL_NVIC_SetPriority (IRQn_Type IRQn, uint32_t
PreemptPriority, uint32_t SubPriority)
Function Description
Sets the priority of an interrupt.
Parameters

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 the
appropriate CMSIS device file (stm32f2xxxx.h))
PreemptPriority: The preemption priority for the IRQn
channel. This parameter can be a value between 0 and 15 A
lower priority value indicates a higher priority
SubPriority: the subpriority level for the IRQ channel. This
parameter can be a value between 0 and 15 A lower priority
value indicates a higher priority.


Return values
7.2.6
7.2.7
7.2.8
7.2.9
136/692

None
HAL_NVIC_EnableIRQ
Function Name
void HAL_NVIC_EnableIRQ (IRQn_Type IRQn)
Function Description
Enables a device specific interrupt in the NVIC interrupt controller.
Parameters

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 the
appropriate CMSIS device file (stm32f2xxxx.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)
Function Description
Disables a device specific interrupt in the NVIC interrupt controller.
Parameters

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 the
appropriate CMSIS device file (stm32f2xxxx.h))
Return values

None
HAL_NVIC_SystemReset
Function Name
void HAL_NVIC_SystemReset (void )
Function Description
Initiates a system reset request to reset the MCU.
Return values

None
HAL_SYSTICK_Config
Function Name
uint32_t HAL_SYSTICK_Config (uint32_t TicksNumb)
Function Description
Initializes the System Timer and its interrupt, and starts the System
DOCID028236 Rev 1
UM1940
HAL CORTEX Generic Driver
Tick Timer.
7.2.10
7.2.11
7.2.12
Parameters

TicksNumb: Specifies the ticks Number of ticks between two
interrupts.
Return values

status - 0 Function succeeded. 1 Function failed.
HAL_MPU_ConfigRegion
Function Name
void HAL_MPU_ConfigRegion (MPU_Region_InitTypeDef *
MPU_Init)
Function Description
Initializes and configures the Region and the memory to be
protected.
Parameters

MPU_Init: Pointer to a MPU_Region_InitTypeDef structure
that contains the initialization and configuration information.
Return values

None
HAL_NVIC_GetPriorityGrouping
Function Name
uint32_t HAL_NVIC_GetPriorityGrouping (void )
Function Description
Gets the priority grouping field from the NVIC Interrupt Controller.
Return values

HAL_NVIC_GetPriority
Function Name
void HAL_NVIC_GetPriority (IRQn_Type IRQn, uint32_t
PriorityGroup, uint32_t * pPreemptPriority, uint32_t *
pSubPriority)
Function Description
Gets the priority of an interrupt.
Parameters




Return values
7.2.13
Priority grouping field (SCB->AIRCR [10:8] PRIGROUP field)

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 the
appropriate CMSIS device file (stm32f2xxxx.h))
PriorityGroup: the priority grouping bits length. This
parameter can be one of the following values:
NVIC_PRIORITYGROUP_0: 0 bits for preemption priority 4
bits for subpriorityNVIC_PRIORITYGROUP_1: 1 bits for
preemption priority 3 bits for
subpriorityNVIC_PRIORITYGROUP_2: 2 bits for preemption
priority 2 bits for subpriorityNVIC_PRIORITYGROUP_3: 3 bits
for preemption priority 1 bits for
subpriorityNVIC_PRIORITYGROUP_4: 4 bits for preemption
priority 0 bits for subpriority
pPreemptPriority: Pointer on the Preemptive priority value
(starting from 0).
pSubPriority: Pointer on the Subpriority value (starting from
0).
None
HAL_NVIC_SetPendingIRQ
DOCID028236 Rev 1
137/692
HAL CORTEX Generic Driver
Function Name
7.2.14
7.2.15
7.2.16
7.2.17
138/692
UM1940
void HAL_NVIC_SetPendingIRQ (IRQn_Type IRQn)
Function Description
Sets Pending bit of an external interrupt.
Parameters

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 the
appropriate CMSIS device file (stm32f2xxxx.h))
Return values

None
HAL_NVIC_GetPendingIRQ
Function Name
uint32_t HAL_NVIC_GetPendingIRQ (IRQn_Type IRQn)
Function Description
Gets Pending Interrupt (reads the pending register in the NVIC
and returns the pending bit for the specified interrupt).
Parameters

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 the
appropriate CMSIS device file (stm32f2xxxx.h))
Return values

status - 0 Interrupt status is not pending. 1 Interrupt status is
pending.
HAL_NVIC_ClearPendingIRQ
Function Name
void HAL_NVIC_ClearPendingIRQ (IRQn_Type IRQn)
Function Description
Clears the pending bit of an external interrupt.
Parameters

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 the
appropriate CMSIS device file (stm32f2xxxx.h))
Return values

None
HAL_NVIC_GetActive
Function Name
uint32_t HAL_NVIC_GetActive (IRQn_Type IRQn)
Function Description
Gets active interrupt ( reads the active register in NVIC and returns
the active bit).
Parameters

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 the
appropriate CMSIS device file (stm32f2xxxx.h))
Return values

status - 0 Interrupt status is not pending. 1 Interrupt status is
pending.
HAL_SYSTICK_CLKSourceConfig
Function Name
void HAL_SYSTICK_CLKSourceConfig (uint32_t CLKSource)
Function Description
Configures the SysTick clock source.
Parameters

CLKSource: specifies the SysTick clock source. This
DOCID028236 Rev 1
UM1940
HAL CORTEX Generic Driver
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
7.2.18
7.2.19

None
HAL_SYSTICK_IRQHandler
Function Name
void HAL_SYSTICK_IRQHandler (void )
Function Description
This function handles SYSTICK interrupt request.
Return values

None
HAL_SYSTICK_Callback
Function Name
void HAL_SYSTICK_Callback (void )
Function Description
SYSTICK callback.
Return values

None
7.3
CORTEX Firmware driver defines
7.3.1
CORTEX
CORTEX Exported Macros
__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 MPU Instruction Access Bufferable
MPU_ACCESS_BUFFERABLE
MPU_ACCESS_NOT_BUFFERABLE
CORTEX MPU Instruction Access Cacheable
MPU_ACCESS_CACHEABLE
MPU_ACCESS_NOT_CACHEABLE
CORTEX MPU Instruction Access Shareable
DOCID028236 Rev 1
139/692
HAL CORTEX Generic Driver
MPU_ACCESS_SHAREABLE
MPU_ACCESS_NOT_SHAREABLE
MPU HFNMI and PRIVILEGED Access control
MPU_HFNMI_PRIVDEF_NONE
MPU_HARDFAULT_NMI
MPU_PRIVILEGED_DEFAULT
MPU_HFNMI_PRIVDEF
CORTEX MPU Instruction Access
MPU_INSTRUCTION_ACCESS_ENABLE
MPU_INSTRUCTION_ACCESS_DISABLE
CORTEX MPU Region Enable
MPU_REGION_ENABLE
MPU_REGION_DISABLE
CORTEX MPU Region Number
MPU_REGION_NUMBER0
MPU_REGION_NUMBER1
MPU_REGION_NUMBER2
MPU_REGION_NUMBER3
MPU_REGION_NUMBER4
MPU_REGION_NUMBER5
MPU_REGION_NUMBER6
MPU_REGION_NUMBER7
CORTEX MPU Region Permission Attributes
MPU_REGION_NO_ACCESS
MPU_REGION_PRIV_RW
MPU_REGION_PRIV_RW_URO
MPU_REGION_FULL_ACCESS
MPU_REGION_PRIV_RO
MPU_REGION_PRIV_RO_URO
CORTEX MPU Region Size
MPU_REGION_SIZE_32B
MPU_REGION_SIZE_64B
MPU_REGION_SIZE_128B
MPU_REGION_SIZE_256B
MPU_REGION_SIZE_512B
MPU_REGION_SIZE_1KB
140/692
DOCID028236 Rev 1
UM1940
UM1940
HAL CORTEX Generic Driver
MPU_REGION_SIZE_2KB
MPU_REGION_SIZE_4KB
MPU_REGION_SIZE_8KB
MPU_REGION_SIZE_16KB
MPU_REGION_SIZE_32KB
MPU_REGION_SIZE_64KB
MPU_REGION_SIZE_128KB
MPU_REGION_SIZE_256KB
MPU_REGION_SIZE_512KB
MPU_REGION_SIZE_1MB
MPU_REGION_SIZE_2MB
MPU_REGION_SIZE_4MB
MPU_REGION_SIZE_8MB
MPU_REGION_SIZE_16MB
MPU_REGION_SIZE_32MB
MPU_REGION_SIZE_64MB
MPU_REGION_SIZE_128MB
MPU_REGION_SIZE_256MB
MPU_REGION_SIZE_512MB
MPU_REGION_SIZE_1GB
MPU_REGION_SIZE_2GB
MPU_REGION_SIZE_4GB
MPU TEX Levels
MPU_TEX_LEVEL0
MPU_TEX_LEVEL1
MPU_TEX_LEVEL2
CORTEX Preemption Priority Group
NVIC_PRIORITYGROUP_0
0 bits for pre-emption priority 4 bits for subpriority
NVIC_PRIORITYGROUP_1
1 bits for pre-emption priority 3 bits for subpriority
NVIC_PRIORITYGROUP_2
2 bits for pre-emption priority 2 bits for subpriority
NVIC_PRIORITYGROUP_3
3 bits for pre-emption priority 1 bits for subpriority
NVIC_PRIORITYGROUP_4
4 bits for pre-emption priority 0 bits for subpriority
CORTEX Private Macros
IS_NVIC_PRIORITY_GROUP
IS_NVIC_PREEMPTION_PRIORITY
IS_NVIC_SUB_PRIORITY
DOCID028236 Rev 1
141/692
HAL CORTEX Generic Driver
IS_NVIC_DEVICE_IRQ
UM1940
IS_SYSTICK_CLK_SOURCE
IS_MPU_REGION_ENABLE
IS_MPU_INSTRUCTION_ACCESS
IS_MPU_ACCESS_SHAREABLE
IS_MPU_ACCESS_CACHEABLE
IS_MPU_ACCESS_BUFFERABLE
IS_MPU_TEX_LEVEL
IS_MPU_REGION_PERMISSION_ATTRIBUTE
IS_MPU_REGION_NUMBER
IS_MPU_REGION_SIZE
IS_MPU_SUB_REGION_DISABLE
CORTEX _SysTick clock source
SYSTICK_CLKSOURCE_HCLK_DIV8
SYSTICK_CLKSOURCE_HCLK
142/692
DOCID028236 Rev 1
UM1940
HAL CRC Generic Driver
8
HAL CRC Generic Driver
8.1
CRC Firmware driver registers structures
8.1.1
CRC_HandleTypeDef
Data Fields



CRC_TypeDef * Instance
HAL_LockTypeDef Lock
__IO HAL_CRC_StateTypeDef State
Field Documentation



CRC_TypeDef* CRC_HandleTypeDef::Instance
Register base address
HAL_LockTypeDef CRC_HandleTypeDef::Lock
CRC locking object
__IO HAL_CRC_StateTypeDef CRC_HandleTypeDef::State
CRC communication state
8.2
CRC Firmware driver API description
8.2.1
How to use this driver
The CRC HAL driver can be used as follows:
1.
2.
3.
8.2.2
Enable CRC AHB clock using __HAL_RCC_CRC_CLK_ENABLE();
Use HAL_CRC_Accumulate() function to compute the CRC value of a 32-bit data
buffer using combination of the previous CRC value and the new one.
Use HAL_CRC_Calculate() function to compute the CRC Value of a new 32-bit data
buffer. This function resets the CRC computation unit before starting the computation
to avoid getting wrong CRC values.
Initialization and de-initialization functions
This section provides functions allowing to:




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
This section contains the following APIs:




HAL_CRC_Init()
HAL_CRC_DeInit()
HAL_CRC_MspInit()
HAL_CRC_MspDeInit()
DOCID028236 Rev 1
143/692
HAL CRC Generic Driver
8.2.3
UM1940
Peripheral Control functions
This section provides functions allowing to:


Compute the 32-bit CRC value of 32-bit data buffer, using combination of the
previous CRC value and the new one.
Compute the 32-bit CRC value of 32-bit data buffer, independently of the previous
CRC value.
This section contains the following APIs:


8.2.4
HAL_CRC_Accumulate()
HAL_CRC_Calculate()
Peripheral State functions
This subsection permits to get in run-time the status of the peripheral and the data flow.
This section contains the following APIs:

8.2.5
8.2.6
8.2.7
8.2.8
HAL_CRC_GetState()
HAL_CRC_Init
Function Name
HAL_StatusTypeDef HAL_CRC_Init (CRC_HandleTypeDef *
hcrc)
Function Description
Initializes the CRC according to the specified parameters in the
CRC_InitTypeDef and creates the associated handle.
Parameters

hcrc: pointer to a CRC_HandleTypeDef structure that
contains the configuration information for CRC
Return values

HAL status
HAL_CRC_DeInit
Function Name
HAL_StatusTypeDef HAL_CRC_DeInit (CRC_HandleTypeDef *
hcrc)
Function Description
DeInitializes the CRC peripheral.
Parameters

hcrc: pointer to a CRC_HandleTypeDef structure that
contains the configuration information for CRC
Return values

HAL status
HAL_CRC_MspInit
Function Name
void HAL_CRC_MspInit (CRC_HandleTypeDef * hcrc)
Function Description
Initializes the CRC MSP.
Parameters

hcrc: pointer to a CRC_HandleTypeDef structure that
contains the configuration information for CRC
Return values

None
HAL_CRC_MspDeInit
Function Name
144/692
void HAL_CRC_MspDeInit (CRC_HandleTypeDef * hcrc)
DOCID028236 Rev 1
UM1940
8.2.9
HAL CRC Generic Driver
Function Description
DeInitializes the CRC MSP.
Parameters

hcrc: pointer to a CRC_HandleTypeDef structure that
contains the configuration information for CRC
Return values

None
HAL_CRC_Accumulate
Function Name
uint32_t HAL_CRC_Accumulate (CRC_HandleTypeDef * hcrc,
uint32_t pBuffer, uint32_t BufferLength)
Function Description
Computes the 32-bit CRC of 32-bit data buffer using combination
of the previous CRC value and the new one.
Parameters


hcrc: pointer to a CRC_HandleTypeDef structure that
contains the configuration information for CRC
pBuffer: pointer to the buffer containing the data to be
computed
BufferLength: length of the buffer to be computed

32-bit CRC

Return values
8.2.10
HAL_CRC_Calculate
Function Name
uint32_t HAL_CRC_Calculate (CRC_HandleTypeDef * hcrc,
uint32_t pBuffer, uint32_t BufferLength)
Function Description
Computes the 32-bit CRC of 32-bit data buffer independently of
the previous CRC value.
Parameters


hcrc: pointer to a CRC_HandleTypeDef structure that
contains the configuration information for CRC
pBuffer: Pointer to the buffer containing the data to be
computed
BufferLength: Length of the buffer to be computed

32-bit CRC

Return values
8.2.11
HAL_CRC_GetState
Function Name
HAL_CRC_StateTypeDef HAL_CRC_GetState
(CRC_HandleTypeDef * hcrc)
Function Description
Returns the CRC state.
Parameters

hcrc: pointer to a CRC_HandleTypeDef structure that
contains the configuration information for CRC
Return values

HAL state
8.3
CRC Firmware driver defines
8.3.1
CRC
CRC Exported Macros
__HAL_CRC_RESET_HANDLE_STATE
Description:

Resets CRC handle state.
DOCID028236 Rev 1
145/692
HAL CRC Generic Driver
UM1940
Parameters:

__HANDLE__: CRC handle
Return value:

__HAL_CRC_DR_RESET
None
Description:

Resets CRC Data Register.
Parameters:

__HANDLE__: CRC handle
Return value:

__HAL_CRC_SET_IDR
None
Description:

Stores a 8-bit data in the Independent
Data(ID) register.
Parameters:


__HANDLE__: CRC handle
__VALUE__: 8-bit value to be stored in the
ID register
Return value:

__HAL_CRC_GET_IDR
None
Description:

Returns the 8-bit data stored in the
Independent Data(ID) register.
Parameters:

__HANDLE__: CRC handle
Return value:

146/692
8-bit: value of the ID register
DOCID028236 Rev 1
UM1940
HAL CRYP Generic Driver
9
HAL CRYP Generic Driver
9.1
CRYP Firmware driver registers structures
9.1.1
CRYP_InitTypeDef
Data Fields









uint32_t DataType
uint32_t KeySize
uint8_t * pKey
uint8_t * pInitVect
uint8_t IVSize
uint8_t TagSize
uint8_t * Header
uint32_t HeaderSize
uint8_t * pScratch
Field Documentation









9.1.2
uint32_t CRYP_InitTypeDef::DataType
32-bit data, 16-bit data, 8-bit data or 1-bit string. This parameter can be a value of
CRYP_Data_Type
uint32_t CRYP_InitTypeDef::KeySize
Used only in AES mode only : 128, 192 or 256 bit key length. This parameter can be
a value of CRYP_Key_Size
uint8_t* CRYP_InitTypeDef::pKey
The key used for encryption/decryption
uint8_t* CRYP_InitTypeDef::pInitVect
The initialization vector used also as initialization counter in CTR mode
uint8_t CRYP_InitTypeDef::IVSize
The size of initialization vector. This parameter (called nonce size in CCM) is used
only in AES-128/192/256 encryption/decryption CCM mode
uint8_t CRYP_InitTypeDef::TagSize
The size of returned authentication TAG. This parameter is used only in AES128/192/256 encryption/decryption CCM mode
uint8_t* CRYP_InitTypeDef::Header
The header used in GCM and CCM modes
uint32_t CRYP_InitTypeDef::HeaderSize
The size of header buffer in bytes
uint8_t* CRYP_InitTypeDef::pScratch
Scratch buffer used to append the header. It's size must be equal to header size + 21
bytes. This parameter is used only in AES-128/192/256 encryption/decryption CCM
mode
CRYP_HandleTypeDef
Data Fields
DOCID028236 Rev 1
147/692
HAL CRYP Generic Driver












UM1940
CRYP_TypeDef * Instance
CRYP_InitTypeDef Init
uint8_t * pCrypInBuffPtr
uint8_t * pCrypOutBuffPtr
__IO uint16_t CrypInCount
__IO uint16_t CrypOutCount
HAL_StatusTypeDef Status
HAL_PhaseTypeDef Phase
DMA_HandleTypeDef * hdmain
DMA_HandleTypeDef * hdmaout
HAL_LockTypeDef Lock
__IO HAL_CRYP_STATETypeDef State
Field Documentation












CRYP_TypeDef* CRYP_HandleTypeDef::Instance
CRYP registers base address
CRYP_InitTypeDef CRYP_HandleTypeDef::Init
CRYP required parameters
uint8_t* CRYP_HandleTypeDef::pCrypInBuffPtr
Pointer to CRYP processing (encryption, decryption,...) buffer
uint8_t* CRYP_HandleTypeDef::pCrypOutBuffPtr
Pointer to CRYP processing (encryption, decryption,...) buffer
__IO uint16_t CRYP_HandleTypeDef::CrypInCount
Counter of input data
__IO uint16_t CRYP_HandleTypeDef::CrypOutCount
Counter of outputted data
HAL_StatusTypeDef CRYP_HandleTypeDef::Status
CRYP peripheral status
HAL_PhaseTypeDef CRYP_HandleTypeDef::Phase
CRYP peripheral phase
DMA_HandleTypeDef* CRYP_HandleTypeDef::hdmain
CRYP In DMA handle parameters
DMA_HandleTypeDef* CRYP_HandleTypeDef::hdmaout
CRYP Out DMA handle parameters
HAL_LockTypeDef CRYP_HandleTypeDef::Lock
CRYP locking object
__IO HAL_CRYP_STATETypeDef CRYP_HandleTypeDef::State
CRYP peripheral state
9.2
CRYP Firmware driver API description
9.2.1
How to use this driver
The CRYP HAL driver can be used as follows:
1.
148/692
Initialize the CRYP low level resources by implementing the HAL_CRYP_MspInit():
a.
Enable the CRYP interface clock using __HAL_RCC_CRYP_CLK_ENABLE()
b.
In case of using interrupts (e.g. HAL_CRYP_AESECB_Encrypt_IT())

Configure the CRYP interrupt priority using HAL_NVIC_SetPriority()

Enable the CRYP IRQ handler using HAL_NVIC_EnableIRQ()

In CRYP IRQ handler, call HAL_CRYP_IRQHandler()
DOCID028236 Rev 1
UM1940
HAL CRYP Generic Driver
In case of using DMA to control data transfer (e.g.
HAL_CRYP_AESECB_Encrypt_DMA())

Enable the DMAx interface clock using __DMAx_CLK_ENABLE()

Configure and enable two DMA streams one for managing data transfer
from memory to peripheral (input stream) and another stream for managing
data transfer from peripheral to memory (output stream)

Associate the initialized DMA handle to the CRYP DMA handle using
__HAL_LINKDMA()

Configure the priority and enable the NVIC for the transfer complete
interrupt on the two DMA Streams. The output stream should have higher
priority than the input stream HAL_NVIC_SetPriority() and
HAL_NVIC_EnableIRQ()
Initialize the CRYP HAL using HAL_CRYP_Init(). This function configures mainly:
a.
The data type: 1-bit, 8-bit, 16-bit and 32-bit
b.
The key size: 128, 192 and 256. This parameter is relevant only for AES
c.
The encryption/decryption key. It's size depends on the algorithm used for
encryption/decryption
d.
The initialization vector (counter). It is not used ECB mode.
Three processing (encryption/decryption) functions are available:
a.
Polling mode: encryption and decryption APIs are blocking functions i.e. they
process the data and wait till the processing is finished, e.g.
HAL_CRYP_AESCBC_Encrypt()
b.
Interrupt mode: encryption and decryption APIs are not blocking functions i.e.
they process the data under interrupt, e.g. HAL_CRYP_AESCBC_Encrypt_IT()
c.
DMA mode: encryption and decryption APIs are not blocking functions i.e. the
data transfer is ensured by DMA, e.g. HAL_CRYP_AESCBC_Encrypt_DMA()
When the processing function is called at first time after HAL_CRYP_Init() the CRYP
peripheral is initialized and processes the buffer in input. At second call, the
processing function performs an append of the already processed buffer. When a new
data block is to be processed, call HAL_CRYP_Init() then the processing function.
Call HAL_CRYP_DeInit() to deinitialize the CRYP peripheral.
c.
2.
3.
4.
5.
9.2.2
Initialization and de-initialization functions
This section provides functions allowing to:




Initialize the CRYP according to the specified parameters in the CRYP_InitTypeDef
and creates the associated handle
DeInitialize the CRYP peripheral
Initialize the CRYP MSP
DeInitialize CRYP MSP
This section contains the following APIs:




9.2.3
HAL_CRYP_Init()
HAL_CRYP_DeInit()
HAL_CRYP_MspInit()
HAL_CRYP_MspDeInit()
AES processing functions
This section provides functions allowing to:


Encrypt plaintext using AES-128/192/256 using chaining modes
Decrypt cyphertext using AES-128/192/256 using chaining modes
Three processing functions are available:
DOCID028236 Rev 1
149/692
HAL CRYP Generic Driver



UM1940
Polling mode
Interrupt mode
DMA mode
This section contains the following APIs:


















9.2.4
HAL_CRYP_AESECB_Encrypt()
HAL_CRYP_AESCBC_Encrypt()
HAL_CRYP_AESCTR_Encrypt()
HAL_CRYP_AESECB_Decrypt()
HAL_CRYP_AESCBC_Decrypt()
HAL_CRYP_AESCTR_Decrypt()
HAL_CRYP_AESECB_Encrypt_IT()
HAL_CRYP_AESCBC_Encrypt_IT()
HAL_CRYP_AESCTR_Encrypt_IT()
HAL_CRYP_AESECB_Decrypt_IT()
HAL_CRYP_AESCBC_Decrypt_IT()
HAL_CRYP_AESCTR_Decrypt_IT()
HAL_CRYP_AESECB_Encrypt_DMA()
HAL_CRYP_AESCBC_Encrypt_DMA()
HAL_CRYP_AESCTR_Encrypt_DMA()
HAL_CRYP_AESECB_Decrypt_DMA()
HAL_CRYP_AESCBC_Decrypt_DMA()
HAL_CRYP_AESCTR_Decrypt_DMA()
DES processing functions
This section provides functions allowing to:


Encrypt plaintext using DES using ECB or CBC chaining modes
Decrypt cyphertext using ECB or CBC chaining modes
Three processing functions are available:



Polling mode
Interrupt mode
DMA mode
This section contains the following APIs:












9.2.5
HAL_CRYP_DESECB_Encrypt()
HAL_CRYP_DESECB_Decrypt()
HAL_CRYP_DESCBC_Encrypt()
HAL_CRYP_DESCBC_Decrypt()
HAL_CRYP_DESECB_Encrypt_IT()
HAL_CRYP_DESCBC_Encrypt_IT()
HAL_CRYP_DESECB_Decrypt_IT()
HAL_CRYP_DESCBC_Decrypt_IT()
HAL_CRYP_DESECB_Encrypt_DMA()
HAL_CRYP_DESCBC_Encrypt_DMA()
HAL_CRYP_DESECB_Decrypt_DMA()
HAL_CRYP_DESCBC_Decrypt_DMA()
TDES processing functions
This section provides functions allowing to:

150/692
Encrypt plaintext using TDES based on ECB or CBC chaining modes
DOCID028236 Rev 1
UM1940
HAL CRYP Generic Driver

Decrypt cyphertext using TDES based on ECB or CBC chaining modes
Three processing functions are available:



Polling mode
Interrupt mode
DMA mode
This section contains the following APIs:












9.2.6
HAL_CRYP_TDESECB_Encrypt()
HAL_CRYP_TDESECB_Decrypt()
HAL_CRYP_TDESCBC_Encrypt()
HAL_CRYP_TDESCBC_Decrypt()
HAL_CRYP_TDESECB_Encrypt_IT()
HAL_CRYP_TDESCBC_Encrypt_IT()
HAL_CRYP_TDESECB_Decrypt_IT()
HAL_CRYP_TDESCBC_Decrypt_IT()
HAL_CRYP_TDESECB_Encrypt_DMA()
HAL_CRYP_TDESCBC_Encrypt_DMA()
HAL_CRYP_TDESECB_Decrypt_DMA()
HAL_CRYP_TDESCBC_Decrypt_DMA()
DMA callback functions
This section provides DMA callback functions:



DMA Input data transfer complete
DMA Output data transfer complete
DMA error
This section contains the following APIs:



9.2.7
HAL_CRYP_InCpltCallback()
HAL_CRYP_OutCpltCallback()
HAL_CRYP_ErrorCallback()
CRYP IRQ handler management
This section provides CRYP IRQ handler function.
This section contains the following APIs:

9.2.8
HAL_CRYP_IRQHandler()
Peripheral State functions
This subsection permits to get in run-time the status of the peripheral.
This section contains the following APIs:

9.2.9
HAL_CRYP_GetState()
HAL_CRYP_Init
Function Name
HAL_StatusTypeDef HAL_CRYP_Init (CRYP_HandleTypeDef *
hcryp)
Function Description
Initializes the CRYP according to the specified parameters in the
CRYP_InitTypeDef and creates the associated handle.
DOCID028236 Rev 1
151/692
HAL CRYP Generic Driver
Parameters

hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
Return values

HAL status
9.2.10
9.2.11
9.2.12
9.2.13
HAL_CRYP_DeInit
Function Name
HAL_StatusTypeDef HAL_CRYP_DeInit
(CRYP_HandleTypeDef * hcryp)
Function Description
DeInitializes the CRYP peripheral.
Parameters

hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
Return values

HAL status
HAL_CRYP_MspInit
Function Name
void HAL_CRYP_MspInit (CRYP_HandleTypeDef * hcryp)
Function Description
Initializes the CRYP MSP.
Parameters

hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
Return values

None
HAL_CRYP_MspDeInit
Function Name
void HAL_CRYP_MspDeInit (CRYP_HandleTypeDef * hcryp)
Function Description
DeInitializes CRYP MSP.
Parameters

hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
Return values

None
HAL_CRYP_AESECB_Encrypt
Function Name
HAL_StatusTypeDef HAL_CRYP_AESECB_Encrypt
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData, uint32_t Timeout)
Function Description
Initializes the CRYP peripheral in AES ECB encryption mode then
encrypt pPlainData.
Parameters

Return values
9.2.14




hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 16.
pCypherData: Pointer to the cyphertext buffer
Timeout: Specify Timeout value

HAL status
HAL_CRYP_AESCBC_Encrypt
Function Name
152/692
UM1940
HAL_StatusTypeDef HAL_CRYP_AESCBC_Encrypt
DOCID028236 Rev 1
UM1940
HAL CRYP Generic Driver
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData, uint32_t Timeout)
Function Description
Initializes the CRYP peripheral in AES CBC encryption mode then
encrypt pPlainData.
Parameters

Return values
9.2.15
HAL status
Function Name
HAL_StatusTypeDef HAL_CRYP_AESCTR_Encrypt
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData, uint32_t Timeout)
Function Description
Initializes the CRYP peripheral in AES CTR encryption mode then
encrypt pPlainData.
Parameters





hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 16.
pCypherData: Pointer to the cyphertext buffer
Timeout: Specify Timeout value

HAL status
HAL_CRYP_AESECB_Decrypt
Function Name
HAL_StatusTypeDef HAL_CRYP_AESECB_Decrypt
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData, uint32_t Timeout)
Function Description
Initializes the CRYP peripheral in AES ECB decryption mode then
decrypted pCypherData.
Parameters

Return values
9.2.17

HAL_CRYP_AESCTR_Encrypt
Return values
9.2.16




hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 16.
pCypherData: Pointer to the cyphertext buffer
Timeout: Specify Timeout value




hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pCypherData: Pointer to the cyphertext buffer
Size: Length of the plaintext buffer, must be a multiple of 16.
pPlainData: Pointer to the plaintext buffer
Timeout: Specify Timeout value

HAL status
HAL_CRYP_AESCBC_Decrypt
Function Name
HAL_StatusTypeDef HAL_CRYP_AESCBC_Decrypt
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData, uint32_t Timeout)
Function Description
Initializes the CRYP peripheral in AES ECB decryption mode then
DOCID028236 Rev 1
153/692
HAL CRYP Generic Driver
UM1940
decrypted pCypherData.
Parameters
Return values
9.2.18




hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pCypherData: Pointer to the cyphertext buffer
Size: Length of the plaintext buffer, must be a multiple of 16.
pPlainData: Pointer to the plaintext buffer
Timeout: Specify Timeout value

HAL status
HAL_CRYP_AESCTR_Decrypt
Function Name
HAL_StatusTypeDef HAL_CRYP_AESCTR_Decrypt
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData, uint32_t Timeout)
Function Description
Initializes the CRYP peripheral in AES CTR decryption mode then
decrypted pCypherData.
Parameters

Return values
9.2.19





hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pCypherData: Pointer to the cyphertext buffer
Size: Length of the plaintext buffer, must be a multiple of 16.
pPlainData: Pointer to the plaintext buffer
Timeout: Specify Timeout value

HAL status
HAL_CRYP_AESECB_Encrypt_IT
Function Name
HAL_StatusTypeDef HAL_CRYP_AESECB_Encrypt_IT
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData)
Function Description
Initializes the CRYP peripheral in AES ECB encryption mode using
Interrupt.
Parameters


hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 16
bytes
pCypherData: Pointer to the cyphertext buffer

HAL status


Return values
9.2.20
HAL_CRYP_AESCBC_Encrypt_IT
Function Name
HAL_StatusTypeDef HAL_CRYP_AESCBC_Encrypt_IT
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData)
Function Description
Initializes the CRYP peripheral in AES CBC encryption mode
using Interrupt.
Parameters


154/692
hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
DOCID028236 Rev 1
UM1940
HAL CRYP Generic Driver

Return values
9.2.21

Size: Length of the plaintext buffer, must be a multiple of 16
bytes
pCypherData: Pointer to the cyphertext buffer

HAL status
HAL_CRYP_AESCTR_Encrypt_IT
Function Name
HAL_StatusTypeDef HAL_CRYP_AESCTR_Encrypt_IT
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData)
Function Description
Initializes the CRYP peripheral in AES CTR encryption mode using
Interrupt.
Parameters


hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 16
bytes
pCypherData: Pointer to the cyphertext buffer

HAL status


Return values
9.2.22
HAL_CRYP_AESECB_Decrypt_IT
Function Name
HAL_StatusTypeDef HAL_CRYP_AESECB_Decrypt_IT
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData)
Function Description
Initializes the CRYP peripheral in AES ECB decryption mode using
Interrupt.
Parameters

Return values
9.2.23



hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pCypherData: Pointer to the cyphertext buffer
Size: Length of the plaintext buffer, must be a multiple of 16.
pPlainData: Pointer to the plaintext buffer

HAL status
HAL_CRYP_AESCBC_Decrypt_IT
Function Name
HAL_StatusTypeDef HAL_CRYP_AESCBC_Decrypt_IT
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData)
Function Description
Initializes the CRYP peripheral in AES CBC decryption mode
using IT.
Parameters

Return values



hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pCypherData: Pointer to the cyphertext buffer
Size: Length of the plaintext buffer, must be a multiple of 16
pPlainData: Pointer to the plaintext buffer

HAL status
DOCID028236 Rev 1
155/692
HAL CRYP Generic Driver
9.2.24
HAL_CRYP_AESCTR_Decrypt_IT
Function Name
HAL_StatusTypeDef HAL_CRYP_AESCTR_Decrypt_IT
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData)
Function Description
Initializes the CRYP peripheral in AES CTR decryption mode using
Interrupt.
Parameters

Return values
9.2.25
UM1940



hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pCypherData: Pointer to the cyphertext buffer
Size: Length of the plaintext buffer, must be a multiple of 16
pPlainData: Pointer to the plaintext buffer

HAL status
HAL_CRYP_AESECB_Encrypt_DMA
Function Name
HAL_StatusTypeDef HAL_CRYP_AESECB_Encrypt_DMA
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData)
Function Description
Initializes the CRYP peripheral in AES ECB encryption mode using
DMA.
Parameters


hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 16
bytes
pCypherData: Pointer to the cyphertext buffer

HAL status


Return values
9.2.26
HAL_CRYP_AESCBC_Encrypt_DMA
Function Name
HAL_StatusTypeDef HAL_CRYP_AESCBC_Encrypt_DMA
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData)
Function Description
Initializes the CRYP peripheral in AES CBC encryption mode
using DMA.
Parameters

Return values
9.2.27
156/692



hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 16.
pCypherData: Pointer to the cyphertext buffer

HAL status
HAL_CRYP_AESCTR_Encrypt_DMA
Function Name
HAL_StatusTypeDef HAL_CRYP_AESCTR_Encrypt_DMA
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData)
Function Description
Initializes the CRYP peripheral in AES CTR encryption mode using
DOCID028236 Rev 1
UM1940
HAL CRYP Generic Driver
DMA.
Parameters
Return values
9.2.28




hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 16.
pCypherData: Pointer to the cyphertext buffer

HAL status
HAL_CRYP_AESECB_Decrypt_DMA
Function Name
HAL_StatusTypeDef HAL_CRYP_AESECB_Decrypt_DMA
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData)
Function Description
Initializes the CRYP peripheral in AES ECB decryption mode using
DMA.
Parameters


hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pCypherData: Pointer to the cyphertext buffer
Size: Length of the plaintext buffer, must be a multiple of 16
bytes
pPlainData: Pointer to the plaintext buffer

HAL status


Return values
9.2.29
HAL_CRYP_AESCBC_Decrypt_DMA
Function Name
HAL_StatusTypeDef HAL_CRYP_AESCBC_Decrypt_DMA
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData)
Function Description
Initializes the CRYP peripheral in AES CBC encryption mode
using DMA.
Parameters


hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pCypherData: Pointer to the cyphertext buffer
Size: Length of the plaintext buffer, must be a multiple of 16
bytes
pPlainData: Pointer to the plaintext buffer

HAL status


Return values
9.2.30
HAL_CRYP_AESCTR_Decrypt_DMA
Function Name
HAL_StatusTypeDef HAL_CRYP_AESCTR_Decrypt_DMA
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData)
Function Description
Initializes the CRYP peripheral in AES CTR decryption mode using
DMA.
Parameters



hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pCypherData: Pointer to the cyphertext buffer
Size: Length of the plaintext buffer, must be a multiple of 16
DOCID028236 Rev 1
157/692
HAL CRYP Generic Driver
Return values
9.2.31
Function Description
Initializes the CRYP peripheral in DES ECB encryption mode.
Parameters





hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer
Timeout: Specify Timeout value

HAL status
HAL_CRYP_DESECB_Decrypt
Function Name
HAL_StatusTypeDef HAL_CRYP_DESECB_Decrypt
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData, uint32_t Timeout)
Function Description
Initializes the CRYP peripheral in DES ECB decryption mode.
Parameters





hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer
Timeout: Specify Timeout value

HAL status
HAL_CRYP_DESCBC_Encrypt
Function Name
HAL_StatusTypeDef HAL_CRYP_DESCBC_Encrypt
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData, uint32_t Timeout)
Function Description
Initializes the CRYP peripheral in DES CBC encryption mode.
Parameters





hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer
Timeout: Specify Timeout value

HAL status
HAL_CRYP_DESCBC_Decrypt
Function Name
158/692
HAL status
HAL_StatusTypeDef HAL_CRYP_DESECB_Encrypt
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData, uint32_t Timeout)
Return values
9.2.34

Function Name
Return values
9.2.33
pPlainData: Pointer to the plaintext buffer
HAL_CRYP_DESECB_Encrypt
Return values
9.2.32
UM1940

HAL_StatusTypeDef HAL_CRYP_DESCBC_Decrypt
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
DOCID028236 Rev 1
UM1940
HAL CRYP Generic Driver
Size, uint8_t * pCypherData, uint32_t Timeout)
Function Description
Initializes the CRYP peripheral in DES ECB decryption mode.
Parameters

Return values
9.2.35
HAL status
Function Name
HAL_StatusTypeDef HAL_CRYP_DESECB_Encrypt_IT
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData)
Function Description
Initializes the CRYP peripheral in DES ECB encryption mode
using IT.
Parameters




hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer

HAL status
HAL_CRYP_DESCBC_Encrypt_IT
Function Name
HAL_StatusTypeDef HAL_CRYP_DESCBC_Encrypt_IT
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData)
Function Description
Initializes the CRYP peripheral in DES CBC encryption mode
using interrupt.
Parameters

Return values
9.2.37

HAL_CRYP_DESECB_Encrypt_IT
Return values
9.2.36




hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer
Timeout: Specify Timeout value



hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer

HAL status
HAL_CRYP_DESECB_Decrypt_IT
Function Name
HAL_StatusTypeDef HAL_CRYP_DESECB_Decrypt_IT
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData)
Function Description
Initializes the CRYP peripheral in DES ECB decryption mode
using IT.
Parameters


hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
DOCID028236 Rev 1
159/692
HAL CRYP Generic Driver
Return values
9.2.38
160/692
HAL status
HAL_StatusTypeDef HAL_CRYP_DESCBC_Decrypt_IT
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData)
Function Description
Initializes the CRYP peripheral in DES ECB decryption mode
using interrupt.
Parameters




hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer

HAL status
HAL_CRYP_DESECB_Encrypt_DMA
Function Name
HAL_StatusTypeDef HAL_CRYP_DESECB_Encrypt_DMA
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData)
Function Description
Initializes the CRYP peripheral in DES ECB encryption mode
using DMA.
Parameters




hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer

HAL status
HAL_CRYP_DESCBC_Encrypt_DMA
Function Name
HAL_StatusTypeDef HAL_CRYP_DESCBC_Encrypt_DMA
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData)
Function Description
Initializes the CRYP peripheral in DES CBC encryption mode
using DMA.
Parameters

Return values
9.2.41

Function Name
Return values
9.2.40
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer
HAL_CRYP_DESCBC_Decrypt_IT
Return values
9.2.39
UM1940





hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer

HAL status
HAL_CRYP_DESECB_Decrypt_DMA
DOCID028236 Rev 1
UM1940
Function Name
Function Description
Initializes the CRYP peripheral in DES ECB decryption mode
using DMA.
Parameters

Return values
9.2.42

HAL status
Function Name
HAL_StatusTypeDef HAL_CRYP_DESCBC_Decrypt_DMA
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData)
Function Description
Initializes the CRYP peripheral in DES ECB decryption mode
using DMA.
Parameters




hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer

HAL status
HAL_CRYP_TDESECB_Encrypt
Function Name
HAL_StatusTypeDef HAL_CRYP_TDESECB_Encrypt
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData, uint32_t Timeout)
Function Description
Initializes the CRYP peripheral in TDES ECB encryption mode
then encrypt pPlainData.
Parameters

Return values
9.2.44



hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer
HAL_CRYP_DESCBC_Decrypt_DMA
Return values
9.2.43
HAL CRYP Generic Driver
HAL_StatusTypeDef HAL_CRYP_DESECB_Decrypt_DMA
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData)




hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer
Timeout: Specify Timeout value

HAL status
HAL_CRYP_TDESECB_Decrypt
Function Name
HAL_StatusTypeDef HAL_CRYP_TDESECB_Decrypt
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData, uint32_t Timeout)
Function Description
Initializes the CRYP peripheral in TDES ECB decryption mode
then decrypted pCypherData.
DOCID028236 Rev 1
161/692
HAL CRYP Generic Driver
Parameters
Return values
9.2.45

HAL status
Function Name
HAL_StatusTypeDef HAL_CRYP_TDESCBC_Encrypt
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData, uint32_t Timeout)
Function Description
Initializes the CRYP peripheral in TDES CBC encryption mode
then encrypt pPlainData.
Parameters





hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer
Timeout: Specify Timeout value

HAL status
HAL_CRYP_TDESCBC_Decrypt
Function Name
HAL_StatusTypeDef HAL_CRYP_TDESCBC_Decrypt
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData, uint32_t Timeout)
Function Description
Initializes the CRYP peripheral in TDES CBC decryption mode
then decrypted pCypherData.
Parameters

Return values
9.2.47




hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer
Timeout: Specify Timeout value
HAL_CRYP_TDESCBC_Encrypt
Return values
9.2.46
UM1940





hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pCypherData: Pointer to the cyphertext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pPlainData: Pointer to the plaintext buffer
Timeout: Specify Timeout value

HAL status
HAL_CRYP_TDESECB_Encrypt_IT
Function Name
HAL_StatusTypeDef HAL_CRYP_TDESECB_Encrypt_IT
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData)
Function Description
Initializes the CRYP peripheral in TDES ECB encryption mode
using interrupt.
Parameters



162/692
hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
DOCID028236 Rev 1
UM1940
HAL CRYP Generic Driver
Return values
9.2.48
HAL status
HAL_StatusTypeDef HAL_CRYP_TDESCBC_Encrypt_IT
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData)
Function Description
Initializes the CRYP peripheral in TDES CBC encryption mode.
Parameters




hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer

HAL status
HAL_CRYP_TDESECB_Decrypt_IT
Function Name
HAL_StatusTypeDef HAL_CRYP_TDESECB_Decrypt_IT
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData)
Function Description
Initializes the CRYP peripheral in TDES ECB decryption mode.
Parameters




hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer

HAL status
HAL_CRYP_TDESCBC_Decrypt_IT
Function Name
HAL_StatusTypeDef HAL_CRYP_TDESCBC_Decrypt_IT
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData)
Function Description
Initializes the CRYP peripheral in TDES CBC decryption mode.
Parameters

Return values
9.2.51

Function Name
Return values
9.2.50
pCypherData: Pointer to the cyphertext buffer
HAL_CRYP_TDESCBC_Encrypt_IT
Return values
9.2.49




hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pCypherData: Pointer to the cyphertext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pPlainData: Pointer to the plaintext buffer

HAL status
HAL_CRYP_TDESECB_Encrypt_DMA
Function Name
HAL_StatusTypeDef HAL_CRYP_TDESECB_Encrypt_DMA
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData)
Function Description
Initializes the CRYP peripheral in TDES ECB encryption mode
DOCID028236 Rev 1
163/692
HAL CRYP Generic Driver
UM1940
using DMA.
Parameters
Return values
9.2.52

HAL status
Function Name
HAL_StatusTypeDef HAL_CRYP_TDESCBC_Encrypt_DMA
(CRYP_HandleTypeDef * hcryp, uint8_t * pPlainData, uint16_t
Size, uint8_t * pCypherData)
Function Description
Initializes the CRYP peripheral in TDES CBC encryption mode
using DMA.
Parameters




hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer

HAL status
HAL_CRYP_TDESECB_Decrypt_DMA
Function Name
HAL_StatusTypeDef HAL_CRYP_TDESECB_Decrypt_DMA
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData)
Function Description
Initializes the CRYP peripheral in TDES ECB decryption mode
using DMA.
Parameters

Return values
9.2.54



hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer
HAL_CRYP_TDESCBC_Encrypt_DMA
Return values
9.2.53




hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pPlainData: Pointer to the plaintext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pCypherData: Pointer to the cyphertext buffer

HAL status
HAL_CRYP_TDESCBC_Decrypt_DMA
Function Name
HAL_StatusTypeDef HAL_CRYP_TDESCBC_Decrypt_DMA
(CRYP_HandleTypeDef * hcryp, uint8_t * pCypherData,
uint16_t Size, uint8_t * pPlainData)
Function Description
Initializes the CRYP peripheral in TDES CBC decryption mode
using DMA.
Parameters




164/692
hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
pCypherData: Pointer to the cyphertext buffer
Size: Length of the plaintext buffer, must be a multiple of 8
pPlainData: Pointer to the plaintext buffer
DOCID028236 Rev 1
UM1940
HAL CRYP Generic Driver
Return values
9.2.55
9.2.56
9.2.57
9.2.58
9.2.59

HAL status
HAL_CRYP_InCpltCallback
Function Name
void HAL_CRYP_InCpltCallback (CRYP_HandleTypeDef *
hcryp)
Function Description
Input FIFO transfer completed callbacks.
Parameters

hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
Return values

None
HAL_CRYP_OutCpltCallback
Function Name
void HAL_CRYP_OutCpltCallback (CRYP_HandleTypeDef *
hcryp)
Function Description
Output FIFO transfer completed callbacks.
Parameters

hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
Return values

None
HAL_CRYP_ErrorCallback
Function Name
void HAL_CRYP_ErrorCallback (CRYP_HandleTypeDef *
hcryp)
Function Description
CRYP error callbacks.
Parameters

hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
Return values

None
HAL_CRYP_IRQHandler
Function Name
void HAL_CRYP_IRQHandler (CRYP_HandleTypeDef * hcryp)
Function Description
This function handles CRYP interrupt request.
Parameters

hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
Return values

None
HAL_CRYP_GetState
Function Name
HAL_CRYP_STATETypeDef HAL_CRYP_GetState
(CRYP_HandleTypeDef * hcryp)
Function Description
Returns the CRYP state.
Parameters

hcryp: pointer to a CRYP_HandleTypeDef structure that
contains the configuration information for CRYP module
Return values

HAL state
DOCID028236 Rev 1
165/692
HAL CRYP Generic Driver
UM1940
9.3
CRYP Firmware driver defines
9.3.1
CRYP
CRYP_Key_Size
CRYP_KEYSIZE_128B
CRYP_KEYSIZE_192B
CRYP_KEYSIZE_256B
CRYP_Data_Type
CRYP_DATATYPE_32B
CRYP_DATATYPE_16B
CRYP_DATATYPE_8B
CRYP_DATATYPE_1B
CRYP CRYP_AlgoModeDirection
CRYP_CR_ALGOMODE_DIRECTION
CRYP_CR_ALGOMODE_TDES_ECB_ENCRYPT
CRYP_CR_ALGOMODE_TDES_ECB_DECRYPT
CRYP_CR_ALGOMODE_TDES_CBC_ENCRYPT
CRYP_CR_ALGOMODE_TDES_CBC_DECRYPT
CRYP_CR_ALGOMODE_DES_ECB_ENCRYPT
CRYP_CR_ALGOMODE_DES_ECB_DECRYPT
CRYP_CR_ALGOMODE_DES_CBC_ENCRYPT
CRYP_CR_ALGOMODE_DES_CBC_DECRYPT
CRYP_CR_ALGOMODE_AES_ECB_ENCRYPT
CRYP_CR_ALGOMODE_AES_ECB_DECRYPT
CRYP_CR_ALGOMODE_AES_CBC_ENCRYPT
CRYP_CR_ALGOMODE_AES_CBC_DECRYPT
CRYP_CR_ALGOMODE_AES_CTR_ENCRYPT
CRYP_CR_ALGOMODE_AES_CTR_DECRYPT
CRYP CRYP_Interrupt
CRYP_IT_INI
Input FIFO Interrupt
CRYP_IT_OUTI
Output FIFO Interrupt
CRYP CRYP_Flags
166/692
CRYP_FLAG_BUSY
The CRYP core is currently processing a block of data or a key
preparation (for AES decryption).
CRYP_FLAG_IFEM
Input FIFO is empty
CRYP_FLAG_IFNF
Input FIFO is not Full
CRYP_FLAG_OFNE
Output FIFO is not empty
DOCID028236 Rev 1
UM1940
HAL CRYP Generic Driver
CRYP_FLAG_OFFU
Output FIFO is Full
CRYP_FLAG_OUTRIS
Output FIFO service raw interrupt status
CRYP_FLAG_INRIS
Input FIFO service raw interrupt status
CRYP Exported Macros
__HAL_CRYP_RESET_HANDLE_STATE
Description:

Reset CRYP handle state.
Parameters:

__HANDLE__: specifies the CRYP
handle.
Return value:

None
Description:
__HAL_CRYP_ENABLE

Enable/Disable the CRYP peripheral.
Parameters:

__HANDLE__: specifies the CRYP
handle.
Return value:

None
__HAL_CRYP_DISABLE
__HAL_CRYP_FIFO_FLUSH
Description:

Flush the data FIFO.
Parameters:

__HANDLE__: specifies the CRYP
handle.
Return value:

__HAL_CRYP_SET_MODE
None
Description:

Set the algorithm mode: AES-ECB, AESCBC, AES-CTR, DES-ECB, DES-CBC.
Parameters:


__HANDLE__: specifies the CRYP
handle.
MODE: The algorithm mode.
Return value:

__HAL_CRYP_GET_FLAG
None
Description:

Check whether the specified CRYP flag is
set or not.
DOCID028236 Rev 1
167/692
HAL CRYP Generic Driver
UM1940
Parameters:


__HANDLE__: specifies the CRYP
handle.
__FLAG__: specifies the flag to check.
This parameter can be one of the
following values:

CRYP_FLAG_BUSY: The CRYP
core is currently processing a block
of data or a key preparation (for AES
decryption).

CRYP_FLAG_IFEM: Input FIFO is
empty

CRYP_FLAG_IFNF: Input FIFO is
not full

CRYP_FLAG_INRIS: Input FIFO
service raw interrupt is pending

CRYP_FLAG_OFNE: Output FIFO
is not empty

CRYP_FLAG_OFFU: Output FIFO is
full

CRYP_FLAG_OUTRIS: Input FIFO
service raw interrupt is pending
Return value:

__HAL_CRYP_GET_IT
The: new state of __FLAG__ (TRUE or
FALSE).
Description:

Check whether the specified CRYP
interrupt is set or not.
Parameters:


__HANDLE__: specifies the CRYP
handle.
__INTERRUPT__: specifies the interrupt
to check. This parameter can be one of
the following values:

CRYP_IT_INRIS: Input FIFO service
raw interrupt is pending

CRYP_IT_OUTRIS: Output FIFO
service raw interrupt is pending
Return value:

__HAL_CRYP_ENABLE_IT
The: new state of __INTERRUPT__
(TRUE or FALSE).
Description:

Enable the CRYP interrupt.
Parameters:


168/692
__HANDLE__: specifies the CRYP
handle.
__INTERRUPT__: CRYP Interrupt.
DOCID028236 Rev 1
UM1940
HAL CRYP Generic Driver
Return value:

__HAL_CRYP_DISABLE_IT
None
Description:

Disable the CRYP interrupt.
Parameters:


__HANDLE__: specifies the CRYP
handle.
__INTERRUPT__: CRYP interrupt.
Return value:

None
CRYP Private Constants
CRYP_FLAG_MASK
CRYP Private define
CRYP_TIMEOUT_VALUE
CRYP Private Macros
IS_CRYP_KEYSIZE
IS_CRYP_DATATYPE
DOCID028236 Rev 1
169/692
HAL DAC Generic Driver
UM1940
10
HAL DAC Generic Driver
10.1
DAC Firmware driver registers structures
10.1.1
DAC_HandleTypeDef
Data Fields






DAC_TypeDef * Instance
__IO HAL_DAC_StateTypeDef State
HAL_LockTypeDef Lock
DMA_HandleTypeDef * DMA_Handle1
DMA_HandleTypeDef * DMA_Handle2
__IO uint32_t ErrorCode
Field Documentation






10.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
Data Fields


uint32_t DAC_Trigger
uint32_t DAC_OutputBuffer
Field Documentation


170/692
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
DOCID028236 Rev 1
UM1940
HAL DAC Generic Driver
10.2
DAC Firmware driver API description
10.2.1
DAC Peripheral features
DAC Channels
The device integrates two 12-bit Digital Analog Converters that 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, TIM4, TIM5, TIM6, TIM7 and TIM8
(DAC_TRIGGER_T2_TRGO, DAC_TRIGGER_T4_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+
DOCID028236 Rev 1
171/692
HAL DAC Generic Driver
UM1940
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.
10.2.2
DAC channel1 : mapped on DMA1 Stream5 channel7 which must be already
configured
DAC channel2 : mapped on DMA1 Stream6 channel7 which must be already
configured For Dual mode and specific signal (Triangle and noise) generation please
refer to Extension Features Driver description
How to use this driver




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
Polling mode IO operation



Start the DAC peripheral using HAL_DAC_Start()
To read the DAC last data output 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 transferred 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
user can add his own code by customization of function pointer
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.




172/692
__HAL_DAC_ENABLE : Enable the DAC peripheral
__HAL_DAC_DISABLE : Disable the DAC peripheral
__HAL_DAC_CLEAR_FLAG: Clear the DAC's pending flags
__HAL_DAC_GET_FLAG: Get the selected DAC's flag status
DOCID028236 Rev 1
UM1940
HAL DAC Generic Driver
You can refer to the DAC HAL driver header file for more useful macros
10.2.3
Initialization and de-initialization functions
This section provides functions allowing to:


Initialize and configure the DAC.
De-initialize the DAC.
This section contains the following APIs:




10.2.4
HAL_DAC_Init()
HAL_DAC_DeInit()
HAL_DAC_MspInit()
HAL_DAC_MspDeInit()
IO operation functions
This section provides functions allowing to:





Start conversion.
Stop conversion.
Start conversion and enable DMA transfer.
Stop conversion and disable DMA transfer.
Get result of conversion.
This section contains the following APIs:










10.2.5
HAL_DAC_Start()
HAL_DAC_Stop()
HAL_DAC_Start_DMA()
HAL_DAC_Stop_DMA()
HAL_DAC_GetValue()
HAL_DAC_IRQHandler()
HAL_DAC_ConvCpltCallbackCh1()
HAL_DAC_ConvHalfCpltCallbackCh1()
HAL_DAC_ErrorCallbackCh1()
HAL_DAC_DMAUnderrunCallbackCh1()
Peripheral Control functions
This section provides functions allowing to:


Configure channels.
Set the specified data holding register value for DAC channel.
This section contains the following APIs:


10.2.6
HAL_DAC_ConfigChannel()
HAL_DAC_SetValue()
Peripheral State and Errors functions
This subsection provides functions allowing to


Check the DAC state.
Check the DAC Errors.
DOCID028236 Rev 1
173/692
HAL DAC Generic Driver
This section contains the following APIs:







10.2.7
10.2.8
10.2.9
10.2.10
10.2.11
174/692
UM1940
HAL_DAC_GetState()
HAL_DAC_GetError()
HAL_DAC_IRQHandler()
HAL_DAC_ConvCpltCallbackCh1()
HAL_DAC_ConvHalfCpltCallbackCh1()
HAL_DAC_ErrorCallbackCh1()
HAL_DAC_DMAUnderrunCallbackCh1()
HAL_DAC_Init
Function Name
HAL_StatusTypeDef HAL_DAC_Init (DAC_HandleTypeDef *
hdac)
Function Description
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
HAL_DAC_DeInit
Function Name
HAL_StatusTypeDef HAL_DAC_DeInit (DAC_HandleTypeDef *
hdac)
Function Description
Deinitializes the DAC peripheral registers to their default reset
values.
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

HAL status
HAL_DAC_MspInit
Function Name
void HAL_DAC_MspInit (DAC_HandleTypeDef * hdac)
Function Description
Initializes the DAC MSP.
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

None
HAL_DAC_MspDeInit
Function Name
void HAL_DAC_MspDeInit (DAC_HandleTypeDef * hdac)
Function Description
DeInitializes the DAC MSP.
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

None
HAL_DAC_Start
DOCID028236 Rev 1
UM1940
Function Name
HAL DAC Generic Driver
HAL_StatusTypeDef HAL_DAC_Start (DAC_HandleTypeDef *
hdac, uint32_t Channel)
Function Description
Enables DAC and starts conversion of channel.
Parameters


Return values
10.2.12

Function Name
HAL_StatusTypeDef HAL_DAC_Stop (DAC_HandleTypeDef *
hdac, uint32_t Channel)
Function Description
Disables DAC and stop conversion of channel.
Parameters

Return values

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Channel: The selected DAC channel. This parameter can be
one of the following values: DAC_CHANNEL_1: DAC
Channel1 selectedDAC_CHANNEL_2: DAC Channel2
selected
HAL status
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)
Function Description
Enables DAC and starts conversion of channel.
Parameters





Return values
10.2.14
HAL status
HAL_DAC_Stop

10.2.13
hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Channel: The selected DAC channel. This parameter can be
one of the following values: DAC_CHANNEL_1: DAC
Channel1 selectedDAC_CHANNEL_2: DAC Channel2
selected

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Channel: The selected DAC channel. This parameter can be
one of the following values: DAC_CHANNEL_1: DAC
Channel1 selectedDAC_CHANNEL_2: DAC Channel2
selected
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
selectedDAC_ALIGN_12B_L: 12bit left data alignment
selectedDAC_ALIGN_12B_R: 12bit right data alignment
selected
HAL status
HAL_DAC_Stop_DMA
DOCID028236 Rev 1
175/692
HAL DAC Generic Driver
Function Name
UM1940
HAL_StatusTypeDef HAL_DAC_Stop_DMA
(DAC_HandleTypeDef * hdac, uint32_t Channel)
Function Description
Disables DAC and stop conversion of channel.
Parameters


Return values
10.2.15

Function Name
uint32_t HAL_DAC_GetValue (DAC_HandleTypeDef * hdac,
uint32_t Channel)
Function Description
Returns the last data output value of the selected DAC channel.
Parameters

Return values
10.2.17
10.2.18
176/692
HAL status
HAL_DAC_GetValue

10.2.16
hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Channel: The selected DAC channel. This parameter can be
one of the following values: DAC_CHANNEL_1: DAC
Channel1 selectedDAC_CHANNEL_2: DAC Channel2
selected

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Channel: The selected DAC channel. This parameter can be
one of the following values: DAC_CHANNEL_1: DAC
Channel1 selectedDAC_CHANNEL_2: DAC Channel2
selected
The selected DAC channel data output value.
HAL_DAC_IRQHandler
Function Name
void HAL_DAC_IRQHandler (DAC_HandleTypeDef * hdac)
Function Description
Handles DAC interrupt request.
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

None
HAL_DAC_ConvCpltCallbackCh1
Function Name
void HAL_DAC_ConvCpltCallbackCh1 (DAC_HandleTypeDef *
hdac)
Function Description
Conversion complete callback in non blocking mode for Channel1.
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

None
HAL_DAC_ConvHalfCpltCallbackCh1
Function Name
void HAL_DAC_ConvHalfCpltCallbackCh1
(DAC_HandleTypeDef * hdac)
Function Description
Conversion half DMA transfer callback in non blocking mode for
Channel1.
DOCID028236 Rev 1
UM1940
10.2.19
10.2.20
10.2.21
HAL DAC Generic Driver
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

None
HAL_DAC_ErrorCallbackCh1
Function Name
void HAL_DAC_ErrorCallbackCh1 (DAC_HandleTypeDef *
hdac)
Function Description
Error DAC callback for Channel1.
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

None
HAL_DAC_DMAUnderrunCallbackCh1
Function Name
void HAL_DAC_DMAUnderrunCallbackCh1
(DAC_HandleTypeDef * hdac)
Function Description
DMA underrun DAC callback for channel1.
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

None
HAL_DAC_ConfigChannel
Function Name
HAL_StatusTypeDef HAL_DAC_ConfigChannel
(DAC_HandleTypeDef * hdac, DAC_ChannelConfTypeDef *
sConfig, uint32_t Channel)
Function Description
Configures the selected DAC channel.
Parameters



Return values
10.2.22

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
sConfig: DAC configuration structure.
Channel: The selected DAC channel. This parameter can be
one of the following values: DAC_CHANNEL_1: DAC
Channel1 selectedDAC_CHANNEL_2: DAC Channel2
selected
HAL status
HAL_DAC_SetValue
Function Name
HAL_StatusTypeDef HAL_DAC_SetValue
(DAC_HandleTypeDef * hdac, uint32_t Channel, uint32_t
Alignment, uint32_t Data)
Function Description
Set the specified data holding register value for DAC channel.
Parameters


hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Channel: The selected DAC channel. This parameter can be
one of the following values: DAC_CHANNEL_1: DAC
Channel1 selectedDAC_CHANNEL_2: DAC Channel2
DOCID028236 Rev 1
177/692
HAL DAC Generic Driver

UM1940
selected
Alignment: Specifies the data alignment. This parameter
can be one of the following values: DAC_ALIGN_8B_R: 8bit
right data alignment selectedDAC_ALIGN_12B_L: 12bit left
data alignment selectedDAC_ALIGN_12B_R: 12bit right data
alignment selected
Data: Data to be loaded in the selected data holding register.

HAL status

Return values
10.2.23
10.2.24
10.2.25
10.2.26
10.2.27
HAL_DAC_GetState
Function Name
HAL_DAC_StateTypeDef HAL_DAC_GetState
(DAC_HandleTypeDef * hdac)
Function Description
return the DAC state
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

HAL state
HAL_DAC_GetError
Function Name
uint32_t HAL_DAC_GetError (DAC_HandleTypeDef * hdac)
Function Description
Return the DAC error code.
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

DAC Error Code
HAL_DAC_IRQHandler
Function Name
void HAL_DAC_IRQHandler (DAC_HandleTypeDef * hdac)
Function Description
Handles DAC interrupt request.
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

None
HAL_DAC_ConvCpltCallbackCh1
Function Name
void HAL_DAC_ConvCpltCallbackCh1 (DAC_HandleTypeDef *
hdac)
Function Description
Conversion complete callback in non blocking mode for Channel1.
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

None
HAL_DAC_ConvHalfCpltCallbackCh1
Function Name
178/692
void HAL_DAC_ConvHalfCpltCallbackCh1
(DAC_HandleTypeDef * hdac)
DOCID028236 Rev 1
UM1940
10.2.28
10.2.29
Function Description
HAL DAC Generic Driver
Conversion half DMA transfer callback in non blocking mode for
Channel1.
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

None
HAL_DAC_ErrorCallbackCh1
Function Name
void HAL_DAC_ErrorCallbackCh1 (DAC_HandleTypeDef *
hdac)
Function Description
Error DAC callback for Channel1.
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

None
HAL_DAC_DMAUnderrunCallbackCh1
Function Name
void HAL_DAC_DMAUnderrunCallbackCh1
(DAC_HandleTypeDef * hdac)
Function Description
DMA underrun DAC callback for channel1.
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

None
10.3
DAC Firmware driver defines
10.3.1
DAC
DAC Channel Selection
DAC_CHANNEL_1
DAC_CHANNEL_2
DAC Data Alignment
DAC_ALIGN_12B_R
DAC_ALIGN_12B_L
DAC_ALIGN_8B_R
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:
DOCID028236 Rev 1
179/692
HAL DAC Generic Driver
UM1940

Reset DAC handle state.
Parameters:

__HANDLE__: specifies the DAC handle.
Return value:

None
Description:
__HAL_DAC_ENABLE

Enable the DAC channel.
Parameters:


__HANDLE__: specifies the DAC handle.
__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:

None
Description:
__HAL_DAC_ENABLE_IT

Enable the DAC interrupt.
Parameters:


__HANDLE__: specifies the DAC handle
__INTERRUPT__: specifies the DAC
interrupt.
Return value:

None
Description:
__HAL_DAC_DISABLE_IT

Disable the DAC interrupt.
Parameters:


__HANDLE__: specifies the DAC handle
__INTERRUPT__: specifies the DAC
interrupt.
Return value:

__HAL_DAC_GET_IT_SOURCE
Description:

180/692
None
Checks if the specified DAC interrupt
DOCID028236 Rev 1
UM1940
HAL DAC Generic Driver
source is enabled or disabled.
Parameters:


__HANDLE__: DAC handle
__INTERRUPT__: DAC interrupt source to
check This parameter can be any
combination of the following values:

DAC_IT_DMAUDR1: DAC channel 1
DMA underrun interrupt

DAC_IT_DMAUDR2: DAC channel 2
DMA underrun interrupt
Return value:

State: of interruption (SET or RESET)
Description:
__HAL_DAC_GET_FLAG

Get the selected DAC's flag status.
Parameters:


__HANDLE__: specifies the DAC handle.
__FLAG__: specifies the flag to clear. This
parameter can be any combination of the
following values:

DAC_FLAG_DMAUDR1: DMA
underrun 1 flag

DAC_FLAG_DMAUDR2: DMA
underrun 2 flag
Return value:

__HAL_DAC_CLEAR_FLAG
None
Description:

Clear the DAC's flag.
Parameters:


__HANDLE__: specifies the DAC handle.
__FLAG__: specifies the flag to clear. This
parameter can be any combination of the
following values:

DAC_FLAG_DMAUDR1: DMA
underrun 1 flag

DAC_FLAG_DMAUDR2: DMA
underrun 2 flag
Return value:

None
DAC Flags Definition
DAC_FLAG_DMAUDR1
DAC_FLAG_DMAUDR2
DAC IT Definition
DAC_IT_DMAUDR1
DOCID028236 Rev 1
181/692
HAL DAC Generic Driver
DAC_IT_DMAUDR2
UM1940
DAC Output Buffer
DAC_OUTPUTBUFFER_ENABLE
DAC_OUTPUTBUFFER_DISABLE
DAC Private Macros
IS_DAC_DATA
IS_DAC_ALIGN
IS_DAC_CHANNEL
IS_DAC_OUTPUT_BUFFER_STATE
IS_DAC_TRIGGER
DAC_DHR12R1_ALIGNMENT
Description:

Set DHR12R1 alignment.
Parameters:

__ALIGNMENT__: specifies the DAC
alignment
Return value:

DAC_DHR12R2_ALIGNMENT
None
Description:

Set DHR12R2 alignment.
Parameters:

__ALIGNMENT__: specifies the DAC
alignment
Return value:

DAC_DHR12RD_ALIGNMENT
None
Description:

Set DHR12RD alignment.
Parameters:

__ALIGNMENT__: specifies the DAC
alignment
Return value:

None
DAC Trigger Selection
182/692
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_T4_TRGO
TIM4 TRGO selected as external conversion trigger for
DAC channel
DOCID028236 Rev 1
UM1940
HAL DAC Generic Driver
TIM5 TRGO selected as external conversion trigger for
DAC channel
DAC_TRIGGER_T5_TRGO
DAC_TRIGGER_T6_TRGO
TIM6 TRGO selected as external conversion trigger for
DAC channel
DAC_TRIGGER_T7_TRGO
TIM7 TRGO selected as external conversion trigger for
DAC channel
DAC_TRIGGER_T8_TRGO
TIM8 TRGO selected as external conversion trigger for
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
DOCID028236 Rev 1
183/692
HAL DAC Extension Driver
UM1940
11
HAL DAC Extension Driver
11.1
DACEx Firmware driver API description
11.1.1
How to use this driver



11.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
This section provides functions allowing to:






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.
This section contains the following APIs:








11.1.3
11.1.4
184/692
HAL_DACEx_DualGetValue()
HAL_DACEx_TriangleWaveGenerate()
HAL_DACEx_NoiseWaveGenerate()
HAL_DACEx_DualSetValue()
HAL_DACEx_ConvCpltCallbackCh2()
HAL_DACEx_ConvHalfCpltCallbackCh2()
HAL_DACEx_ErrorCallbackCh2()
HAL_DACEx_DMAUnderrunCallbackCh2()
HAL_DACEx_DualGetValue
Function Name
uint32_t HAL_DACEx_DualGetValue (DAC_HandleTypeDef *
hdac)
Function Description
Returns the last data output value of the selected DAC channel.
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

The selected DAC channel data output value.
HAL_DACEx_TriangleWaveGenerate
Function Name
HAL_StatusTypeDef HAL_DACEx_TriangleWaveGenerate
(DAC_HandleTypeDef * hdac, uint32_t Channel, uint32_t
Amplitude)
Function Description
Enables or disables the selected DAC channel wave generation.
DOCID028236 Rev 1
UM1940
HAL DAC Extension Driver
Parameters



Return values
11.1.5

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Channel: The selected DAC channel. This parameter can be
one of the following values: DAC_CHANNEL_1 /
DAC_CHANNEL_2
Amplitude: Select max triangle amplitude. This parameter
can be one of the following values:
DAC_TRIANGLEAMPLITUDE_1: Select max triangle
amplitude of 1DAC_TRIANGLEAMPLITUDE_3: Select max
triangle amplitude of 3DAC_TRIANGLEAMPLITUDE_7:
Select max triangle amplitude of
7DAC_TRIANGLEAMPLITUDE_15: Select max triangle
amplitude of 15DAC_TRIANGLEAMPLITUDE_31: Select max
triangle amplitude of 31DAC_TRIANGLEAMPLITUDE_63:
Select max triangle amplitude of
63DAC_TRIANGLEAMPLITUDE_127: Select max triangle
amplitude of 127DAC_TRIANGLEAMPLITUDE_255: Select
max triangle amplitude of
255DAC_TRIANGLEAMPLITUDE_511: Select max triangle
amplitude of 511DAC_TRIANGLEAMPLITUDE_1023: Select
max triangle amplitude of
1023DAC_TRIANGLEAMPLITUDE_2047: Select max triangle
amplitude of 2047DAC_TRIANGLEAMPLITUDE_4095: Select
max triangle amplitude of 4095
HAL status
HAL_DACEx_NoiseWaveGenerate
Function Name
HAL_StatusTypeDef HAL_DACEx_NoiseWaveGenerate
(DAC_HandleTypeDef * hdac, uint32_t Channel, uint32_t
Amplitude)
Function Description
Enables or disables the selected DAC channel wave generation.
Parameters



hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Channel: The selected DAC channel. This parameter can 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
generationDAC_LFSRUNMASK_BITS1_0: Unmask DAC
channel LFSR bit[1:0] for noise wave
generationDAC_LFSRUNMASK_BITS2_0: Unmask DAC
channel LFSR bit[2:0] for noise wave
generationDAC_LFSRUNMASK_BITS3_0: Unmask DAC
channel LFSR bit[3:0] for noise wave
generationDAC_LFSRUNMASK_BITS4_0: Unmask DAC
channel LFSR bit[4:0] for noise wave
generationDAC_LFSRUNMASK_BITS5_0: Unmask DAC
channel LFSR bit[5:0] for noise wave
generationDAC_LFSRUNMASK_BITS6_0: Unmask DAC
channel LFSR bit[6:0] for noise wave
DOCID028236 Rev 1
185/692
HAL DAC Extension Driver
Return values
11.1.6
UM1940
generationDAC_LFSRUNMASK_BITS7_0: Unmask DAC
channel LFSR bit[7:0] for noise wave
generationDAC_LFSRUNMASK_BITS8_0: Unmask DAC
channel LFSR bit[8:0] for noise wave
generationDAC_LFSRUNMASK_BITS9_0: Unmask DAC
channel LFSR bit[9:0] for noise wave
generationDAC_LFSRUNMASK_BITS10_0: Unmask DAC
channel LFSR bit[10:0] for noise wave
generationDAC_LFSRUNMASK_BITS11_0: Unmask DAC
channel LFSR bit[11:0] for noise wave generation

HAL_DACEx_DualSetValue
Function Name
HAL_StatusTypeDef HAL_DACEx_DualSetValue
(DAC_HandleTypeDef * hdac, uint32_t Alignment, uint32_t
Data1, uint32_t Data2)
Function Description
Set the specified data holding register value for dual DAC channel.
Parameters




11.1.7
11.1.8
186/692
HAL status
hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
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
(DAC_HandleTypeDef * hdac)
Function Description
Conversion complete callback in non blocking mode for Channel2.
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

None
HAL_DACEx_ConvHalfCpltCallbackCh2
Function Name
void HAL_DACEx_ConvHalfCpltCallbackCh2
(DAC_HandleTypeDef * hdac)
Function Description
Conversion half DMA transfer callback in non blocking mode for
Channel2.
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
DOCID028236 Rev 1
UM1940
HAL DAC Extension Driver
contains the configuration information for the specified DAC.
Return values
11.1.9
11.1.10

None
HAL_DACEx_ErrorCallbackCh2
Function Name
void HAL_DACEx_ErrorCallbackCh2 (DAC_HandleTypeDef *
hdac)
Function Description
Error DAC callback for Channel2.
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

None
HAL_DACEx_DMAUnderrunCallbackCh2
Function Name
void HAL_DACEx_DMAUnderrunCallbackCh2
(DAC_HandleTypeDef * hdac)
Function Description
DMA underrun DAC callback for channel2.
Parameters

hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values

None
11.2
DACEx Firmware driver defines
11.2.1
DACEx
DAC LFS Run Mask Triangle Amplitude
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
DAC_LFSRUNMASK_BITS2_0
Unmask DAC channel LFSR bit[2:0] for noise wave
generation
DAC_LFSRUNMASK_BITS3_0
Unmask DAC channel LFSR bit[3:0] for noise wave
generation
DAC_LFSRUNMASK_BITS4_0
Unmask DAC channel LFSR bit[4:0] for noise wave
generation
DAC_LFSRUNMASK_BITS5_0
Unmask DAC channel LFSR bit[5:0] for noise wave
generation
DAC_LFSRUNMASK_BITS6_0
Unmask DAC channel LFSR bit[6:0] for noise wave
generation
DAC_LFSRUNMASK_BITS7_0
Unmask DAC channel LFSR bit[7:0] for noise wave
generation
DAC_LFSRUNMASK_BITS8_0
Unmask DAC channel LFSR bit[8:0] for noise wave
generation
DAC_LFSRUNMASK_BITS9_0
Unmask DAC channel LFSR bit[9:0] for noise wave
DOCID028236 Rev 1
187/692
HAL DAC Extension Driver
UM1940
generation
DAC_LFSRUNMASK_BITS10_0
Unmask DAC channel LFSR bit[10:0] for noise
wave generation
DAC_LFSRUNMASK_BITS11_0
Unmask DAC channel LFSR bit[11:0] for noise
wave generation
DAC_TRIANGLEAMPLITUDE_1
Select max triangle amplitude of 1
DAC_TRIANGLEAMPLITUDE_3
Select max triangle amplitude of 3
DAC_TRIANGLEAMPLITUDE_7
Select max triangle amplitude of 7
DAC_TRIANGLEAMPLITUDE_15
Select max triangle amplitude of 15
DAC_TRIANGLEAMPLITUDE_31
Select max triangle amplitude of 31
DAC_TRIANGLEAMPLITUDE_63
Select max triangle amplitude of 63
DAC_TRIANGLEAMPLITUDE_127
Select max triangle amplitude of 127
DAC_TRIANGLEAMPLITUDE_255
Select max triangle amplitude of 255
DAC_TRIANGLEAMPLITUDE_511
Select max triangle amplitude of 511
DAC_TRIANGLEAMPLITUDE_1023
Select max triangle amplitude of 1023
DAC_TRIANGLEAMPLITUDE_2047
Select max triangle amplitude of 2047
DAC_TRIANGLEAMPLITUDE_4095
Select max triangle amplitude of 4095
DAC Private Macros
IS_DAC_LFSR_UNMASK_TRIANGLE_AMPLITUDE
188/692
DOCID028236 Rev 1
UM1940
HAL DCMI Generic Driver
12
HAL DCMI Generic Driver
12.1
DCMI Firmware driver registers structures
12.1.1
DCMI_CodesInitTypeDef
Data Fields




uint8_t FrameStartCode
uint8_t LineStartCode
uint8_t LineEndCode
uint8_t FrameEndCode
Field Documentation




12.1.2
uint8_t DCMI_CodesInitTypeDef::FrameStartCode
Specifies the code of the frame start delimiter.
uint8_t DCMI_CodesInitTypeDef::LineStartCode
Specifies the code of the line start delimiter.
uint8_t DCMI_CodesInitTypeDef::LineEndCode
Specifies the code of the line end delimiter.
uint8_t DCMI_CodesInitTypeDef::FrameEndCode
Specifies the code of the frame end delimiter.
DCMI_InitTypeDef
Data Fields








uint32_t SynchroMode
uint32_t PCKPolarity
uint32_t VSPolarity
uint32_t HSPolarity
uint32_t CaptureRate
uint32_t ExtendedDataMode
DCMI_CodesInitTypeDef SyncroCode
uint32_t JPEGMode
Field Documentation


uint32_t DCMI_InitTypeDef::SynchroMode
Specifies the Synchronization Mode: Hardware or Embedded. This parameter can be
a value of DCMI_Synchronization_Mode
uint32_t DCMI_InitTypeDef::PCKPolarity
Specifies the Pixel clock polarity: Falling or Rising. This parameter can be a value of
DCMI_PIXCK_Polarity
DOCID028236 Rev 1
189/692
HAL DCMI Generic Driver






12.1.3
UM1940
uint32_t DCMI_InitTypeDef::VSPolarity
Specifies the Vertical synchronization polarity: High or Low. This parameter can be a
value of DCMI_VSYNC_Polarity
uint32_t DCMI_InitTypeDef::HSPolarity
Specifies the Horizontal synchronization polarity: High or Low. This parameter can be
a value of DCMI_HSYNC_Polarity
uint32_t DCMI_InitTypeDef::CaptureRate
Specifies the frequency of frame capture: All, 1/2 or 1/4. This parameter can be a
value of DCMI_Capture_Rate
uint32_t DCMI_InitTypeDef::ExtendedDataMode
Specifies the data width: 8-bit, 10-bit, 12-bit or 14-bit. This parameter can be a value
of DCMI_Extended_Data_Mode
DCMI_CodesInitTypeDef DCMI_InitTypeDef::SyncroCode
Specifies the code of the frame start delimiter.
uint32_t DCMI_InitTypeDef::JPEGMode
Enable or Disable the JPEG mode. This parameter can be a value of
DCMI_MODE_JPEG
DCMI_HandleTypeDef
Data Fields










DCMI_TypeDef * Instance
DCMI_InitTypeDef Init
HAL_LockTypeDef Lock
__IO HAL_DCMI_StateTypeDef State
__IO uint32_t XferCount
__IO uint32_t XferSize
uint32_t XferTransferNumber
uint32_t pBuffPtr
DMA_HandleTypeDef * DMA_Handle
__IO uint32_t ErrorCode
Field Documentation








190/692
DCMI_TypeDef* DCMI_HandleTypeDef::Instance
DCMI Register base address
DCMI_InitTypeDef DCMI_HandleTypeDef::Init
DCMI parameters
HAL_LockTypeDef DCMI_HandleTypeDef::Lock
DCMI locking object
__IO HAL_DCMI_StateTypeDef DCMI_HandleTypeDef::State
DCMI state
__IO uint32_t DCMI_HandleTypeDef::XferCount
DMA transfer counter
__IO uint32_t DCMI_HandleTypeDef::XferSize
DMA transfer size
uint32_t DCMI_HandleTypeDef::XferTransferNumber
DMA transfer number
uint32_t DCMI_HandleTypeDef::pBuffPtr
Pointer to DMA output buffer
DOCID028236 Rev 1
UM1940
HAL DCMI Generic Driver


DMA_HandleTypeDef* DCMI_HandleTypeDef::DMA_Handle
Pointer to the DMA handler
__IO uint32_t DCMI_HandleTypeDef::ErrorCode
DCMI Error code
12.2
DCMI Firmware driver API description
12.2.1
How to use this driver
The sequence below describes how to use this driver to capture image from a camera
module connected to the DCMI Interface. This sequence does not take into account the
configuration of the camera module, which should be made before to configure and enable
the DCMI to capture images.
1.
2.
3.
4.
5.
6.
Program the required configuration through following parameters: horizontal and
vertical polarity, pixel clock polarity, Capture Rate, Synchronization Mode, code of the
frame delimiter and data width using HAL_DCMI_Init() function.
Configure the DMA2_Stream1 channel1 to transfer Data from DCMI DR register to
the destination memory buffer.
Program the required configuration through following parameters: DCMI mode,
destination memory Buffer address and the data length and enable capture using
HAL_DCMI_Start_DMA() function.
Optionally, configure and Enable the CROP feature to select a rectangular window
from the received image using HAL_DCMI_ConfigCrop() and
HAL_DCMI_EnableCROP() functions
The capture can be stopped using HAL_DCMI_Stop() function.
To control DCMI state you can use the function HAL_DCMI_GetState().
DCMI HAL driver macros list
Below the list of most used macros in DCMI HAL driver.







__HAL_DCMI_ENABLE: Enable the DCMI peripheral.
__HAL_DCMI_DISABLE: Disable the DCMI peripheral.
__HAL_DCMI_GET_FLAG: Get the DCMI pending flags.
__HAL_DCMI_CLEAR_FLAG: Clear the DCMI pending flags.
__HAL_DCMI_ENABLE_IT: Enable the specified DCMI interrupts.
__HAL_DCMI_DISABLE_IT: Disable the specified DCMI interrupts.
__HAL_DCMI_GET_IT_SOURCE: Check whether the specified DCMI interrupt has
occurred or not.
You can refer to the DCMI HAL driver header file for more useful macros
12.2.2
Initialization and Configuration functions
This section provides functions allowing to:


Initialize and configure the DCMI
De-initialize the DCMI
This section contains the following APIs:

HAL_DCMI_Init()
DOCID028236 Rev 1
191/692
HAL DCMI Generic Driver



12.2.3
UM1940
HAL_DCMI_DeInit()
HAL_DCMI_MspInit()
HAL_DCMI_MspDeInit()
IO operation functions
This section provides functions allowing to:



Configure destination address and data length and Enables DCMI DMA request and
enables DCMI capture
Stop the DCMI capture.
Handles DCMI interrupt request.
This section contains the following APIs:







12.2.4
HAL_DCMI_Start_DMA()
HAL_DCMI_Stop()
HAL_DCMI_IRQHandler()
HAL_DCMI_ErrorCallback()
HAL_DCMI_LineEventCallback()
HAL_DCMI_VsyncEventCallback()
HAL_DCMI_FrameEventCallback()
Peripheral Control functions
This section provides functions allowing to:


Configure the CROP feature.
Enable/Disable the CROP feature.
This section contains the following APIs:



12.2.5
HAL_DCMI_ConfigCROP()
HAL_DCMI_DisableCROP()
HAL_DCMI_EnableCROP()
Peripheral State and Errors functions
This subsection provides functions allowing to


Check the DCMI state.
Get the specific DCMI error flag.
This section contains the following APIs:


12.2.6
192/692
HAL_DCMI_GetState()
HAL_DCMI_GetError()
HAL_DCMI_Init
Function Name
HAL_StatusTypeDef HAL_DCMI_Init (DCMI_HandleTypeDef *
hdcmi)
Function Description
Initializes the DCMI according to the specified parameters in the
DCMI_InitTypeDef and create the associated handle.
Parameters

hdcmi: pointer to a DCMI_HandleTypeDef structure that
contains the configuration information for DCMI.
Return values

HAL status
DOCID028236 Rev 1
UM1940
12.2.7
12.2.8
12.2.9
12.2.10
HAL DCMI Generic Driver
HAL_DCMI_DeInit
Function Name
HAL_StatusTypeDef HAL_DCMI_DeInit (DCMI_HandleTypeDef
* hdcmi)
Function Description
Deinitializes the DCMI peripheral registers to their default reset
values.
Parameters

hdcmi: pointer to a DCMI_HandleTypeDef structure that
contains the configuration information for DCMI.
Return values

HAL status
HAL_DCMI_MspInit
Function Name
void HAL_DCMI_MspInit (DCMI_HandleTypeDef * hdcmi)
Function Description
Initializes the DCMI MSP.
Parameters

hdcmi: pointer to a DCMI_HandleTypeDef structure that
contains the configuration information for DCMI.
Return values

None
HAL_DCMI_MspDeInit
Function Name
void HAL_DCMI_MspDeInit (DCMI_HandleTypeDef * hdcmi)
Function Description
DeInitializes the DCMI MSP.
Parameters

hdcmi: pointer to a DCMI_HandleTypeDef structure that
contains the configuration information for DCMI.
Return values

None
HAL_DCMI_Start_DMA
Function Name
HAL_StatusTypeDef HAL_DCMI_Start_DMA
(DCMI_HandleTypeDef * hdcmi, uint32_t DCMI_Mode, uint32_t
pData, uint32_t Length)
Function Description
Enables DCMI DMA request and enables DCMI capture.
Parameters


hdcmi: pointer to a DCMI_HandleTypeDef structure that
contains the configuration information for DCMI.
DCMI_Mode: DCMI capture mode snapshot or continuous
grab.
pData: The destination memory Buffer address (LCD Frame
buffer).
Length: The length of capture to be transferred.

HAL status


Return values
12.2.11
HAL_DCMI_Stop
Function Name
HAL_StatusTypeDef HAL_DCMI_Stop (DCMI_HandleTypeDef *
hdcmi)
Function Description
Disable DCMI DMA request and Disable DCMI capture.
Parameters

hdcmi: pointer to a DCMI_HandleTypeDef structure that
DOCID028236 Rev 1
193/692
HAL DCMI Generic Driver
UM1940
contains the configuration information for DCMI.
Return values
12.2.12
12.2.13
12.2.14
12.2.15
12.2.16
194/692

HAL status
HAL_DCMI_IRQHandler
Function Name
void HAL_DCMI_IRQHandler (DCMI_HandleTypeDef * hdcmi)
Function Description
Handles DCMI interrupt request.
Parameters

hdcmi: pointer to a DCMI_HandleTypeDef structure that
contains the configuration information for the DCMI.
Return values

None
HAL_DCMI_ErrorCallback
Function Name
void HAL_DCMI_ErrorCallback (DCMI_HandleTypeDef *
hdcmi)
Function Description
Error DCMI callback.
Parameters

hdcmi: pointer to a DCMI_HandleTypeDef structure that
contains the configuration information for DCMI.
Return values

None
HAL_DCMI_LineEventCallback
Function Name
void HAL_DCMI_LineEventCallback (DCMI_HandleTypeDef *
hdcmi)
Function Description
Line Event callback.
Parameters

hdcmi: pointer to a DCMI_HandleTypeDef structure that
contains the configuration information for DCMI.
Return values

None
HAL_DCMI_VsyncEventCallback
Function Name
void HAL_DCMI_VsyncEventCallback (DCMI_HandleTypeDef *
hdcmi)
Function Description
VSYNC Event callback.
Parameters

hdcmi: pointer to a DCMI_HandleTypeDef structure that
contains the configuration information for DCMI.
Return values

None
HAL_DCMI_FrameEventCallback
Function Name
void HAL_DCMI_FrameEventCallback (DCMI_HandleTypeDef *
hdcmi)
Function Description
Frame Event callback.
Parameters

hdcmi: pointer to a DCMI_HandleTypeDef structure that
contains the configuration information for DCMI.
DOCID028236 Rev 1
UM1940
HAL DCMI Generic Driver
Return values
12.2.17
12.2.19
12.2.20
12.2.21
None
HAL_DCMI_ConfigCROP
Function Name
HAL_StatusTypeDef HAL_DCMI_ConfigCROP
(DCMI_HandleTypeDef * hdcmi, uint32_t X0, uint32_t Y0,
uint32_t XSize, uint32_t YSize)
Function Description
Configure the DCMI CROP coordinate.
Parameters

Return values
12.2.18





hdcmi: pointer to a DCMI_HandleTypeDef structure that
contains the configuration information for DCMI.
X0: DCMI window X offset
Y0: DCMI window Y offset
XSize: DCMI Pixel per line
YSize: DCMI Line number

HAL status
HAL_DCMI_DisableCROP
Function Name
HAL_StatusTypeDef HAL_DCMI_DisableCROP
(DCMI_HandleTypeDef * hdcmi)
Function Description
Disable the Crop feature.
Parameters

hdcmi: pointer to a DCMI_HandleTypeDef structure that
contains the configuration information for DCMI.
Return values

HAL status
HAL_DCMI_EnableCROP
Function Name
HAL_StatusTypeDef HAL_DCMI_EnableCROP
(DCMI_HandleTypeDef * hdcmi)
Function Description
Enable the Crop feature.
Parameters

hdcmi: pointer to a DCMI_HandleTypeDef structure that
contains the configuration information for DCMI.
Return values

HAL status
HAL_DCMI_GetState
Function Name
HAL_DCMI_StateTypeDef HAL_DCMI_GetState
(DCMI_HandleTypeDef * hdcmi)
Function Description
Return the DCMI state.
Parameters

hdcmi: pointer to a DCMI_HandleTypeDef structure that
contains the configuration information for DCMI.
Return values

HAL state
HAL_DCMI_GetError
Function Name
uint32_t HAL_DCMI_GetError (DCMI_HandleTypeDef * hdcmi)
Function Description
Return the DCMI error code.
DOCID028236 Rev 1
195/692
HAL DCMI Generic Driver
Parameters

hdcmi: : pointer to a DCMI_HandleTypeDef structure that
contains the configuration information for DCMI.
UM1940
Return values

DCMI Error Code
12.3
DCMI Firmware driver defines
12.3.1
DCMI
DCMI Capture Mode
DCMI_MODE_CONTINUOUS
The received data are transferred continuously into the
destination memory through the DMA
DCMI_MODE_SNAPSHOT
Once activated, the interface waits for the start of frame
and then transfers a single frame through the DMA
DCMI Capture Rate
DCMI_CR_ALL_FRAME
All frames are captured
DCMI_CR_ALTERNATE_2_FRAME
Every alternate frame captured
DCMI_CR_ALTERNATE_4_FRAME
One frame in 4 frames captured
DCMI Error Code
HAL_DCMI_ERROR_NONE
No error
HAL_DCMI_ERROR_OVF
Overflow error
HAL_DCMI_ERROR_SYNC
Synchronization error
HAL_DCMI_ERROR_TIMEOUT
Timeout error
DCMI Exported Macros
__HAL_DCMI_RESET_HANDLE_STATE
Description:

Reset DCMI handle state.
Parameters:

__HANDLE__: specifies the DCMI
handle.
Return value:

__HAL_DCMI_ENABLE
None
Description:

Enable the DCMI.
Parameters:

__HANDLE__: DCMI handle
Return value:

__HAL_DCMI_DISABLE
None
Description:

Disable the DCMI.
Parameters:
196/692
DOCID028236 Rev 1
UM1940
HAL DCMI Generic Driver

__HANDLE__: DCMI handle
Return value:

None
Description:
__HAL_DCMI_GET_FLAG

Get the DCMI pending flags.
Parameters:


__HANDLE__: DCMI handle
__FLAG__: Get the specified flag. This
parameter can be any combination of the
following values:

DCMI_FLAG_FRAMERI: Frame
capture complete flag mask

DCMI_FLAG_OVFRI: Overflow flag
mask

DCMI_FLAG_ERRRI:
Synchronization error flag mask

DCMI_FLAG_VSYNCRI: VSYNC
flag mask

DCMI_FLAG_LINERI: Line flag mask
Return value:

__HAL_DCMI_CLEAR_FLAG
The: state of FLAG.
Description:

Clear the DCMI pending flags.
Parameters:


__HANDLE__: DCMI handle
__FLAG__: specifies the flag to clear.
This parameter can be any combination of
the following values:

DCMI_FLAG_FRAMERI: Frame
capture complete flag mask

DCMI_FLAG_OVFRI: Overflow flag
mask

DCMI_FLAG_ERRRI:
Synchronization error flag mask

DCMI_FLAG_VSYNCRI: VSYNC
flag mask

DCMI_FLAG_LINERI: Line flag mask
Return value:

__HAL_DCMI_ENABLE_IT
None
Description:

Enable the specified DCMI interrupts.
Parameters:


__HANDLE__: DCMI handle
__INTERRUPT__: specifies the DCMI
interrupt sources to be enabled. This
DOCID028236 Rev 1
197/692
HAL DCMI Generic Driver
UM1940
parameter can be any combination of the
following values:

DCMI_IT_FRAME: Frame capture
complete interrupt mask

DCMI_IT_OVF: Overflow interrupt
mask

DCMI_IT_ERR: Synchronization
error interrupt mask

DCMI_IT_VSYNC: VSYNC interrupt
mask

DCMI_IT_LINE: Line interrupt mask
Return value:

None
Description:
__HAL_DCMI_DISABLE_IT

Disable the specified DCMI interrupts.
Parameters:


__HANDLE__: DCMI handle
__INTERRUPT__: specifies the DCMI
interrupt sources to be enabled. This
parameter can be any combination of the
following values:

DCMI_IT_FRAME: Frame capture
complete interrupt mask

DCMI_IT_OVF: Overflow interrupt
mask

DCMI_IT_ERR: Synchronization
error interrupt mask

DCMI_IT_VSYNC: VSYNC interrupt
mask

DCMI_IT_LINE: Line interrupt mask
Return value:

__HAL_DCMI_GET_IT_SOURCE
None
Description:

Check whether the specified DCMI
interrupt has occurred or not.
Parameters:


198/692
__HANDLE__: DCMI handle
__INTERRUPT__: specifies the DCMI
interrupt source to check. This parameter
can be one of the following values:

DCMI_IT_FRAME: Frame capture
complete interrupt mask

DCMI_IT_OVF: Overflow interrupt
mask

DCMI_IT_ERR: Synchronization
error interrupt mask

DCMI_IT_VSYNC: VSYNC interrupt
mask
DOCID028236 Rev 1
UM1940
HAL DCMI Generic Driver

DCMI_IT_LINE: Line interrupt mask
Return value:

The: state of INTERRUPT.
DCMI Extended Data Mode
DCMI_EXTEND_DATA_8B
Interface captures 8-bit data on every pixel clock
DCMI_EXTEND_DATA_10B
Interface captures 10-bit data on every pixel clock
DCMI_EXTEND_DATA_12B
Interface captures 12-bit data on every pixel clock
DCMI_EXTEND_DATA_14B
Interface captures 14-bit data on every pixel clock
DCMI Flags
DCMI_FLAG_HSYNC
DCMI_FLAG_VSYNC
DCMI_FLAG_FNE
DCMI_FLAG_FRAMERI
DCMI_FLAG_OVFRI
DCMI_FLAG_ERRRI
DCMI_FLAG_VSYNCRI
DCMI_FLAG_LINERI
DCMI_FLAG_FRAMEMI
DCMI_FLAG_OVFMI
DCMI_FLAG_ERRMI
DCMI_FLAG_VSYNCMI
DCMI_FLAG_LINEMI
DCMI HSYNC Polarity
DCMI_HSPOLARITY_LOW
Horizontal synchronization active Low
DCMI_HSPOLARITY_HIGH
Horizontal synchronization active High
DCMI interrupt sources
DCMI_IT_FRAME
DCMI_IT_OVF
DCMI_IT_ERR
DCMI_IT_VSYNC
DCMI_IT_LINE
DCMI MODE JPEG
DCMI_JPEG_DISABLE
Mode JPEG Disabled
DCMI_JPEG_ENABLE
Mode JPEG Enabled
DCMI PIXCK Polarity
DCMI_PCKPOLARITY_FALLING
Pixel clock active on Falling edge
DOCID028236 Rev 1
199/692
HAL DCMI Generic Driver
DCMI_PCKPOLARITY_RISING
UM1940
Pixel clock active on Rising edge
DCMI Private Macros
IS_DCMI_CAPTURE_MODE
IS_DCMI_SYNCHRO
IS_DCMI_PCKPOLARITY
IS_DCMI_VSPOLARITY
IS_DCMI_HSPOLARITY
IS_DCMI_MODE_JPEG
IS_DCMI_CAPTURE_RATE
IS_DCMI_EXTENDED_DATA
IS_DCMI_WINDOW_COORDINATE
IS_DCMI_WINDOW_HEIGHT
DCMI Synchronization Mode
DCMI_SYNCHRO_HARDWARE
Hardware synchronization data capture (frame/line
start/stop) is synchronized with the HSYNC/VSYNC
signals
DCMI_SYNCHRO_EMBEDDED
Embedded synchronization data capture is
synchronized with synchronization codes embedded in
the data flow
DCMI VSYNC Polarity
DCMI_VSPOLARITY_LOW
Vertical synchronization active Low
DCMI_VSPOLARITY_HIGH
Vertical synchronization active High
DCMI Window Coordinate
DCMI_WINDOW_COORDINATE
Window coordinate
DCMI Window Height
DCMI_WINDOW_HEIGHT
200/692
Window Height
DOCID028236 Rev 1
UM1940
HAL DMA Generic Driver
13
HAL DMA Generic Driver
13.1
DMA Firmware driver registers structures
13.1.1
DMA_InitTypeDef
Data Fields












uint32_t Channel
uint32_t Direction
uint32_t PeriphInc
uint32_t MemInc
uint32_t PeriphDataAlignment
uint32_t MemDataAlignment
uint32_t Mode
uint32_t Priority
uint32_t FIFOMode
uint32_t FIFOThreshold
uint32_t MemBurst
uint32_t PeriphBurst
Field Documentation








uint32_t DMA_InitTypeDef::Channel
Specifies the channel used for the specified stream. This parameter can be a value of
DMA_Channel_selection
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 Streamx. 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 Stream
uint32_t DMA_InitTypeDef::Priority
Specifies the software priority for the DMAy Streamx. This parameter can be a value
of DMA_Priority_level
DOCID028236 Rev 1
201/692
HAL DMA Generic Driver




13.1.2
UM1940
uint32_t DMA_InitTypeDef::FIFOMode
Specifies if the FIFO mode or Direct mode will be used for the specified stream. This
parameter can be a value of DMA_FIFO_direct_mode
Note:The Direct mode (FIFO mode disabled) cannot be used if the memory-tomemory data transfer is configured on the selected stream
uint32_t DMA_InitTypeDef::FIFOThreshold
Specifies the FIFO threshold level. This parameter can be a value of
DMA_FIFO_threshold_level
uint32_t DMA_InitTypeDef::MemBurst
Specifies the Burst transfer configuration for the memory transfers. It specifies the
amount of data to be transferred in a single non interruptible transaction. This
parameter can be a value of DMA_Memory_burst
Note:The burst mode is possible only if the address Increment mode is enabled.
uint32_t DMA_InitTypeDef::PeriphBurst
Specifies the Burst transfer configuration for the peripheral transfers. It specifies the
amount of data to be transferred in a single non interruptible transaction. This
parameter can be a value of DMA_Peripheral_burst
Note:The burst mode is possible only if the address Increment mode is enabled.
__DMA_HandleTypeDef
Data Fields












DMA_Stream_TypeDef * Instance
DMA_InitTypeDef Init
HAL_LockTypeDef Lock
__IO HAL_DMA_StateTypeDef State
void * Parent
void(* XferCpltCallback
void(* XferHalfCpltCallback
void(* XferM1CpltCallback
void(* XferErrorCallback
__IO uint32_t ErrorCode
uint32_t StreamBaseAddress
uint32_t StreamIndex
Field Documentation






202/692
DMA_Stream_TypeDef* __DMA_HandleTypeDef::Instance
Register base address
DMA_InitTypeDef __DMA_HandleTypeDef::Init
DMA communication parameters
HAL_LockTypeDef __DMA_HandleTypeDef::Lock
DMA locking object
__IO 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
DOCID028236 Rev 1
UM1940
HAL DMA Generic Driver






void(* __DMA_HandleTypeDef::XferHalfCpltCallback)(struct
__DMA_HandleTypeDef *hdma)
DMA Half transfer complete callback
void(* __DMA_HandleTypeDef::XferM1CpltCallback)(struct
__DMA_HandleTypeDef *hdma)
DMA transfer complete Memory1 callback
void(* __DMA_HandleTypeDef::XferErrorCallback)(struct
__DMA_HandleTypeDef *hdma)
DMA transfer error callback
__IO uint32_t __DMA_HandleTypeDef::ErrorCode
DMA Error code
uint32_t __DMA_HandleTypeDef::StreamBaseAddress
DMA Stream Base Address
uint32_t __DMA_HandleTypeDef::StreamIndex
DMA Stream Index
13.2
DMA Firmware driver API description
13.2.1
How to use this driver
1.
2.
Enable and configure the peripheral to be connected to the DMA Stream (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 Stream, program the required configuration through the following
parameters: Transfer Direction, Source and Destination data formats, Circular, Normal
or peripheral flow control mode, Stream Priority level, Source and Destination
Increment mode, FIFO mode and its Threshold (if needed), Burst mode for Source
and/or Destination (if needed) using HAL_DMA_Init() function.
Polling mode IO operation


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.
Interrupt mode IO operation





Configure the DMA interrupt priority using HAL_NVIC_SetPriority()
Enable the DMA IRQ handler using HAL_NVIC_EnableIRQ()
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_DMA_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).
DOCID028236 Rev 1
203/692
HAL DMA Generic Driver
UM1940
1.
Use HAL_DMA_GetState() function to return the DMA state and
HAL_DMA_GetError() in case of error detection.
2.
Use HAL_DMA_Abort() function to abort the current transfer In Memory-to-Memory
transfer mode, Circular mode is not allowed. The FIFO is used mainly to reduce bus
usage and to allow data packing/unpacking: it is possible to set different Data Sizes
for the Peripheral and the Memory (ie. you can set Half-Word data size for the
peripheral to access its data register and set Word data size for the Memory to gain in
access time. Each two half words will be packed and written in a single access to a
Word in the Memory). When FIFO is disabled, it is not allowed to configure different
Data Sizes for Source and Destination. In this case the Peripheral Data Size will be
applied to both Source and Destination.
DMA HAL driver macros list
Below the list of most used macros in DMA HAL driver.








__HAL_DMA_ENABLE: Enable the specified DMA Stream.
__HAL_DMA_DISABLE: Disable the specified DMA Stream.
__HAL_DMA_GET_FS: Return the current DMA Stream FIFO filled level.
__HAL_DMA_GET_FLAG: Get the DMA Stream pending flags.
__HAL_DMA_CLEAR_FLAG: Clear the DMA Stream pending flags.
__HAL_DMA_ENABLE_IT: Enable the specified DMA Stream interrupts.
__HAL_DMA_DISABLE_IT: Disable the specified DMA Stream interrupts.
__HAL_DMA_GET_IT_SOURCE: Check whether the specified DMA Stream interrupt
has occurred or not.
You can refer to the DMA HAL driver header file for more useful macros
13.2.2
Initialization and de-initialization functions
This section provides functions allowing to initialize the DMA Stream source and
destination addresses, incrementation and data sizes, transfer direction, circular/normal
mode selection, memory-to-memory mode selection and Stream priority value.
The HAL_DMA_Init() function follows the DMA configuration procedures as described in
reference manual.
This section contains the following APIs:


13.2.3
HAL_DMA_Init()
HAL_DMA_DeInit()
IO operation functions
This section provides functions allowing to:





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
This section contains the following APIs:

204/692
HAL_DMA_Start()
DOCID028236 Rev 1
UM1940
HAL DMA Generic Driver




13.2.4
HAL_DMA_Start_IT()
HAL_DMA_Abort()
HAL_DMA_PollForTransfer()
HAL_DMA_IRQHandler()
State and Errors functions
This subsection provides functions allowing to


Check the DMA state
Get error code
This section contains the following APIs:


13.2.5
13.2.6
13.2.7
HAL_DMA_GetState()
HAL_DMA_GetError()
HAL_DMA_Init
Function Name
HAL_StatusTypeDef HAL_DMA_Init (DMA_HandleTypeDef *
hdma)
Function Description
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
contains the configuration information for the specified DMA
Stream.
Return values

HAL status
HAL_DMA_DeInit
Function Name
HAL_StatusTypeDef HAL_DMA_DeInit (DMA_HandleTypeDef *
hdma)
Function Description
DeInitializes the DMA peripheral.
Parameters

hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Stream.
Return values

HAL status
HAL_DMA_Start
Function Name
HAL_StatusTypeDef HAL_DMA_Start (DMA_HandleTypeDef *
hdma, uint32_t SrcAddress, uint32_t DstAddress, uint32_t
DataLength)
Function Description
Starts the DMA Transfer.
Parameters




hdma: : pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Stream.
SrcAddress: The source memory Buffer address
DstAddress: The destination memory Buffer address
DataLength: The length of data to be transferred from
source to destination
DOCID028236 Rev 1
205/692
HAL DMA Generic Driver
Return values
13.2.8
UM1940

HAL_DMA_Start_IT
Function Name
HAL_StatusTypeDef HAL_DMA_Start_IT
(DMA_HandleTypeDef * hdma, uint32_t SrcAddress, uint32_t
DstAddress, uint32_t DataLength)
Function Description
Start the DMA Transfer with interrupt enabled.
Parameters




Return values
13.2.9
13.2.10
HAL status
Function Name
HAL_StatusTypeDef HAL_DMA_Abort (DMA_HandleTypeDef *
hdma)
Function Description
Aborts the DMA Transfer.
Parameters

hdma: : pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Stream.
Return values

HAL status
Notes

After disabling a DMA Stream, a check for wait until the DMA
Stream is effectively disabled is added. If a Stream is disabled
while a data transfer is ongoing, the current data will be
transferred and the Stream 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)
Function Description
Polling for transfer complete.
Parameters



hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Stream.
CompleteLevel: Specifies the DMA level complete.
Timeout: Timeout duration.

HAL status
HAL_DMA_IRQHandler
Function Name
206/692

hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Stream.
SrcAddress: The source memory Buffer address
DstAddress: The destination memory Buffer address
DataLength: The length of data to be transferred from
source to destination
HAL_DMA_Abort
Return values
13.2.11
HAL status
void HAL_DMA_IRQHandler (DMA_HandleTypeDef * hdma)
DOCID028236 Rev 1
UM1940
13.2.12
13.2.13
HAL DMA Generic Driver
Function Description
Handles DMA interrupt request.
Parameters

hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Stream.
Return values

None
HAL_DMA_GetState
Function Name
HAL_DMA_StateTypeDef HAL_DMA_GetState
(DMA_HandleTypeDef * hdma)
Function Description
Returns the DMA state.
Parameters

hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Stream.
Return values

HAL state
HAL_DMA_GetError
Function Name
uint32_t HAL_DMA_GetError (DMA_HandleTypeDef * hdma)
Function Description
Return the DMA error code.
Parameters

hdma: : pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Stream.
Return values

DMA Error Code
13.3
DMA Firmware driver defines
13.3.1
DMA
DMA Channel selection
DMA_CHANNEL_0
DMA Channel 0
DMA_CHANNEL_1
DMA Channel 1
DMA_CHANNEL_2
DMA Channel 2
DMA_CHANNEL_3
DMA Channel 3
DMA_CHANNEL_4
DMA Channel 4
DMA_CHANNEL_5
DMA Channel 5
DMA_CHANNEL_6
DMA Channel 6
DMA_CHANNEL_7
DMA Channel 7
DMA Data transfer direction
DMA_PERIPH_TO_MEMORY
Peripheral to memory direction
DMA_MEMORY_TO_PERIPH
Memory to peripheral direction
DMA_MEMORY_TO_MEMORY
Memory to memory direction
DMA Error Code
DOCID028236 Rev 1
207/692
HAL DMA Generic Driver
HAL_DMA_ERROR_NONE
UM1940
No error
HAL_DMA_ERROR_TE
Transfer error
HAL_DMA_ERROR_FE
FIFO error
HAL_DMA_ERROR_DME
Direct Mode error
HAL_DMA_ERROR_TIMEOUT
Timeout error
DMA FIFO direct mode
DMA_FIFOMODE_DISABLE
FIFO mode disable
DMA_FIFOMODE_ENABLE
FIFO mode enable
DMA FIFO threshold level
DMA_FIFO_THRESHOLD_1QUARTERFULL
FIFO threshold 1 quart full configuration
DMA_FIFO_THRESHOLD_HALFFULL
FIFO threshold half full configuration
DMA_FIFO_THRESHOLD_3QUARTERSFULL
FIFO threshold 3 quarts full configuration
DMA_FIFO_THRESHOLD_FULL
FIFO threshold full configuration
DMA flag definitions
DMA_FLAG_FEIF0_4
DMA_FLAG_DMEIF0_4
DMA_FLAG_TEIF0_4
DMA_FLAG_HTIF0_4
DMA_FLAG_TCIF0_4
DMA_FLAG_FEIF1_5
DMA_FLAG_DMEIF1_5
DMA_FLAG_TEIF1_5
DMA_FLAG_HTIF1_5
DMA_FLAG_TCIF1_5
DMA_FLAG_FEIF2_6
DMA_FLAG_DMEIF2_6
DMA_FLAG_TEIF2_6
DMA_FLAG_HTIF2_6
DMA_FLAG_TCIF2_6
DMA_FLAG_FEIF3_7
DMA_FLAG_DMEIF3_7
DMA_FLAG_TEIF3_7
DMA_FLAG_HTIF3_7
DMA_FLAG_TCIF3_7
DMA Handle index
TIM_DMA_ID_UPDATE
208/692
Index of the DMA handle used for Update DMA requests
DOCID028236 Rev 1
UM1940
HAL DMA Generic Driver
Index of the DMA handle used for Capture/Compare 1
DMA requests
TIM_DMA_ID_CC1
TIM_DMA_ID_CC2
Index of the DMA handle used for Capture/Compare 2
DMA requests
TIM_DMA_ID_CC3
Index of the DMA handle used for Capture/Compare 3
DMA requests
TIM_DMA_ID_CC4
Index of the DMA handle used for Capture/Compare 4
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
DMA interrupt enable definitions
DMA_IT_TC
DMA_IT_HT
DMA_IT_TE
DMA_IT_DME
DMA_IT_FE
DMA Memory burst
DMA_MBURST_SINGLE
DMA_MBURST_INC4
DMA_MBURST_INC8
DMA_MBURST_INC16
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
DMA Memory incremented mode
DMA_MINC_ENABLE
Memory increment mode enable
DMA_MINC_DISABLE
Memory increment mode disable
DMA mode
DMA_NORMAL
Normal mode
DMA_CIRCULAR
Circular mode
DMA_PFCTRL
Peripheral flow control mode
DMA Peripheral burst
DMA_PBURST_SINGLE
DMA_PBURST_INC4
DMA_PBURST_INC8
DMA_PBURST_INC16
DOCID028236 Rev 1
209/692
HAL DMA Generic Driver
DMA Peripheral data size
UM1940
DMA_PDATAALIGN_BYTE
Peripheral data alignment: Byte
DMA_PDATAALIGN_HALFWORD
Peripheral data alignment: HalfWord
DMA_PDATAALIGN_WORD
Peripheral data alignment: Word
DMA Peripheral incremented mode
DMA_PINC_ENABLE
Peripheral increment mode enable
DMA_PINC_DISABLE
Peripheral increment mode disable
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
DMA Private Constants
HAL_TIMEOUT_DMA_ABORT
DMA Private Macros
IS_DMA_CHANNEL
IS_DMA_DIRECTION
IS_DMA_BUFFER_SIZE
IS_DMA_PERIPHERAL_INC_STATE
IS_DMA_MEMORY_INC_STATE
IS_DMA_PERIPHERAL_DATA_SIZE
IS_DMA_MEMORY_DATA_SIZE
IS_DMA_MODE
IS_DMA_PRIORITY
IS_DMA_FIFO_MODE_STATE
IS_DMA_FIFO_THRESHOLD
IS_DMA_MEMORY_BURST
IS_DMA_PERIPHERAL_BURST
210/692
DOCID028236 Rev 1
UM1940
HAL DMA Extension Driver
14
HAL DMA Extension Driver
14.1
DMAEx Firmware driver API description
14.1.1
How to use this driver
The DMA Extension HAL driver can be used as follows:
1.
14.1.2
Start a multi buffer transfer using the HAL_DMA_MultiBufferStart() function for polling
mode or HAL_DMA_MultiBufferStart_IT() for interrupt mode. In Memory-to-Memory
transfer mode, Multi (Double) Buffer mode is not allowed. When Multi (Double) Buffer
mode is enabled the, transfer is circular by default. In Multi (Double) buffer mode, it is
possible to update the base address for the AHB memory port on the fly
(DMA_SxM0AR or DMA_SxM1AR) when the stream is enabled.
Extended features functions
This section provides functions allowing to:



Configure the source, destination address and data length and Start MultiBuffer DMA
transfer
Configure the source, destination address and data length and Start MultiBuffer DMA
transfer with interrupt
Change on the fly the memory0 or memory1 address.
This section contains the following APIs:



14.1.3
HAL_DMAEx_MultiBufferStart()
HAL_DMAEx_MultiBufferStart_IT()
HAL_DMAEx_ChangeMemory()
HAL_DMAEx_MultiBufferStart
Function Name
HAL_StatusTypeDef HAL_DMAEx_MultiBufferStart
(DMA_HandleTypeDef * hdma, uint32_t SrcAddress, uint32_t
DstAddress, uint32_t SecondMemAddress, uint32_t
DataLength)
Function Description
Starts the multi_buffer DMA Transfer.
Parameters





Return values
14.1.4

hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Stream.
SrcAddress: The source memory Buffer address
DstAddress: The destination memory Buffer address
SecondMemAddress: The second memory Buffer address
in case of multi buffer Transfer
DataLength: The length of data to be transferred from
source to destination
HAL status
HAL_DMAEx_MultiBufferStart_IT
Function Name
HAL_StatusTypeDef HAL_DMAEx_MultiBufferStart_IT
(DMA_HandleTypeDef * hdma, uint32_t SrcAddress, uint32_t
DOCID028236 Rev 1
211/692
HAL DMA Extension Driver
UM1940
DstAddress, uint32_t SecondMemAddress, uint32_t
DataLength)
Function Description
Starts the multi_buffer DMA Transfer with interrupt enabled.
Parameters





Return values
14.1.5

HAL status
HAL_DMAEx_ChangeMemory
Function Name
HAL_StatusTypeDef HAL_DMAEx_ChangeMemory
(DMA_HandleTypeDef * hdma, uint32_t Address,
HAL_DMA_MemoryTypeDef memory)
Function Description
Change the memory0 or memory1 address on the fly.
Parameters



212/692
hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Stream.
SrcAddress: The source memory Buffer address
DstAddress: The destination memory Buffer address
SecondMemAddress: The second memory Buffer address
in case of multi buffer Transfer
DataLength: The length of data to be transferred from
source to destination
hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Stream.
Address: The new address
memory: the memory to be changed, This parameter can be
one of the following values: MEMORY0 / MEMORY1
Return values

HAL status
Notes

The MEMORY0 address can be changed only when the
current transfer use MEMORY1 and the MEMORY1 address
can be changed only when the current transfer use
MEMORY0.
DOCID028236 Rev 1
UM1940
HAL ETH Generic Driver
15
HAL ETH Generic Driver
15.1
ETH Firmware driver registers structures
15.1.1
ETH_InitTypeDef
Data Fields








uint32_t AutoNegotiation
uint32_t Speed
uint32_t DuplexMode
uint16_t PhyAddress
uint8_t * MACAddr
uint32_t RxMode
uint32_t ChecksumMode
uint32_t MediaInterface
Field Documentation








15.1.2
uint32_t ETH_InitTypeDef::AutoNegotiation
Selects or not the AutoNegotiation mode for the external PHY The AutoNegotiation
allows an automatic setting of the Speed (10/100Mbps) and the mode (half/fullduplex). This parameter can be a value of ETH_AutoNegotiation
uint32_t ETH_InitTypeDef::Speed
Sets the Ethernet speed: 10/100 Mbps. This parameter can be a value of
ETH_Speed
uint32_t ETH_InitTypeDef::DuplexMode
Selects the MAC duplex mode: Half-Duplex or Full-Duplex mode This parameter can
be a value of ETH_Duplex_Mode
uint16_t ETH_InitTypeDef::PhyAddress
Ethernet PHY address. This parameter must be a number between Min_Data = 0 and
Max_Data = 32
uint8_t* ETH_InitTypeDef::MACAddr
MAC Address of used Hardware: must be pointer on an array of 6 bytes
uint32_t ETH_InitTypeDef::RxMode
Selects the Ethernet Rx mode: Polling mode, Interrupt mode. This parameter can be
a value of ETH_Rx_Mode
uint32_t ETH_InitTypeDef::ChecksumMode
Selects if the checksum is check by hardware or by software. This parameter can be
a value of ETH_Checksum_Mode
uint32_t ETH_InitTypeDef::MediaInterface
Selects the media-independent interface or the reduced media-independent interface.
This parameter can be a value of ETH_Media_Interface
ETH_MACInitTypeDef
Data Fields

uint32_t Watchdog
DOCID028236 Rev 1
213/692
HAL ETH Generic Driver




























UM1940
uint32_t Jabber
uint32_t InterFrameGap
uint32_t CarrierSense
uint32_t ReceiveOwn
uint32_t LoopbackMode
uint32_t ChecksumOffload
uint32_t RetryTransmission
uint32_t AutomaticPadCRCStrip
uint32_t BackOffLimit
uint32_t DeferralCheck
uint32_t ReceiveAll
uint32_t SourceAddrFilter
uint32_t PassControlFrames
uint32_t BroadcastFramesReception
uint32_t DestinationAddrFilter
uint32_t PromiscuousMode
uint32_t MulticastFramesFilter
uint32_t UnicastFramesFilter
uint32_t HashTableHigh
uint32_t HashTableLow
uint32_t PauseTime
uint32_t ZeroQuantaPause
uint32_t PauseLowThreshold
uint32_t UnicastPauseFrameDetect
uint32_t ReceiveFlowControl
uint32_t TransmitFlowControl
uint32_t VLANTagComparison
uint32_t VLANTagIdentifier
Field Documentation






214/692
uint32_t ETH_MACInitTypeDef::Watchdog
Selects or not the Watchdog timer When enabled, the MAC allows no more then 2048
bytes to be received. When disabled, the MAC can receive up to 16384 bytes. This
parameter can be a value of ETH_Watchdog
uint32_t ETH_MACInitTypeDef::Jabber
Selects or not Jabber timer When enabled, the MAC allows no more then 2048 bytes
to be sent. When disabled, the MAC can send up to 16384 bytes. This parameter can
be a value of ETH_Jabber
uint32_t ETH_MACInitTypeDef::InterFrameGap
Selects the minimum IFG between frames during transmission. This parameter can
be a value of ETH_Inter_Frame_Gap
uint32_t ETH_MACInitTypeDef::CarrierSense
Selects or not the Carrier Sense. This parameter can be a value of
ETH_Carrier_Sense
uint32_t ETH_MACInitTypeDef::ReceiveOwn
Selects or not the ReceiveOwn, ReceiveOwn allows the reception of frames when the
TX_EN signal is asserted in Half-Duplex mode. This parameter can be a value of
ETH_Receive_Own
uint32_t ETH_MACInitTypeDef::LoopbackMode
Selects or not the internal MAC MII Loopback mode. This parameter can be a value
of ETH_Loop_Back_Mode
DOCID028236 Rev 1
UM1940
HAL ETH Generic Driver

















uint32_t ETH_MACInitTypeDef::ChecksumOffload
Selects or not the IPv4 checksum checking for received frame payloads'
TCP/UDP/ICMP headers. This parameter can be a value of ETH_Checksum_Offload
uint32_t ETH_MACInitTypeDef::RetryTransmission
Selects or not the MAC attempt retries transmission, based on the settings of BL,
when a collision occurs (Half-Duplex mode). This parameter can be a value of
ETH_Retry_Transmission
uint32_t ETH_MACInitTypeDef::AutomaticPadCRCStrip
Selects or not the Automatic MAC Pad/CRC Stripping. This parameter can be a value
of ETH_Automatic_Pad_CRC_Strip
uint32_t ETH_MACInitTypeDef::BackOffLimit
Selects the BackOff limit value. This parameter can be a value of
ETH_Back_Off_Limit
uint32_t ETH_MACInitTypeDef::DeferralCheck
Selects or not the deferral check function (Half-Duplex mode). This parameter can be
a value of ETH_Deferral_Check
uint32_t ETH_MACInitTypeDef::ReceiveAll
Selects or not all frames reception by the MAC (No filtering). This parameter can be a
value of ETH_Receive_All
uint32_t ETH_MACInitTypeDef::SourceAddrFilter
Selects the Source Address Filter mode. This parameter can be a value of
ETH_Source_Addr_Filter
uint32_t ETH_MACInitTypeDef::PassControlFrames
Sets the forwarding mode of the control frames (including unicast and multicast
PAUSE frames) This parameter can be a value of ETH_Pass_Control_Frames
uint32_t ETH_MACInitTypeDef::BroadcastFramesReception
Selects or not the reception of Broadcast Frames. This parameter can be a value of
ETH_Broadcast_Frames_Reception
uint32_t ETH_MACInitTypeDef::DestinationAddrFilter
Sets the destination filter mode for both unicast and multicast frames. This parameter
can be a value of ETH_Destination_Addr_Filter
uint32_t ETH_MACInitTypeDef::PromiscuousMode
Selects or not the Promiscuous Mode This parameter can be a value of
ETH_Promiscuous_Mode
uint32_t ETH_MACInitTypeDef::MulticastFramesFilter
Selects the Multicast Frames filter mode:
None/HashTableFilter/PerfectFilter/PerfectHashTableFilter. This parameter can be a
value of ETH_Multicast_Frames_Filter
uint32_t ETH_MACInitTypeDef::UnicastFramesFilter
Selects the Unicast Frames filter mode:
HashTableFilter/PerfectFilter/PerfectHashTableFilter. This parameter can be a value
of ETH_Unicast_Frames_Filter
uint32_t ETH_MACInitTypeDef::HashTableHigh
This field holds the higher 32 bits of Hash table. This parameter must be a number
between Min_Data = 0x0 and Max_Data = 0xFFFFFFFF
uint32_t ETH_MACInitTypeDef::HashTableLow
This field holds the lower 32 bits of Hash table. This parameter must be a number
between Min_Data = 0x0 and Max_Data = 0xFFFFFFFF
uint32_t ETH_MACInitTypeDef::PauseTime
This field holds the value to be used in the Pause Time field in the transmit control
frame. This parameter must be a number between Min_Data = 0x0 and Max_Data =
0xFFFF
uint32_t ETH_MACInitTypeDef::ZeroQuantaPause
Selects or not the automatic generation of Zero-Quanta Pause Control frames. This
parameter can be a value of ETH_Zero_Quanta_Pause
DOCID028236 Rev 1
215/692
HAL ETH Generic Driver






15.1.3
UM1940
uint32_t ETH_MACInitTypeDef::PauseLowThreshold
This field configures the threshold of the PAUSE to be checked for automatic
retransmission of PAUSE Frame. This parameter can be a value of
ETH_Pause_Low_Threshold
uint32_t ETH_MACInitTypeDef::UnicastPauseFrameDetect
Selects or not the MAC detection of the Pause frames (with MAC Address0 unicast
address and unique multicast address). This parameter can be a value of
ETH_Unicast_Pause_Frame_Detect
uint32_t ETH_MACInitTypeDef::ReceiveFlowControl
Enables or disables the MAC to decode the received Pause frame and disable its
transmitter for a specified time (Pause Time) This parameter can be a value of
ETH_Receive_Flow_Control
uint32_t ETH_MACInitTypeDef::TransmitFlowControl
Enables or disables the MAC to transmit Pause frames (Full-Duplex mode) or the
MAC back-pressure operation (Half-Duplex mode) This parameter can be a value of
ETH_Transmit_Flow_Control
uint32_t ETH_MACInitTypeDef::VLANTagComparison
Selects the 12-bit VLAN identifier or the complete 16-bit VLAN tag for comparison
and filtering. This parameter can be a value of ETH_VLAN_Tag_Comparison
uint32_t ETH_MACInitTypeDef::VLANTagIdentifier
Holds the VLAN tag identifier for receive frames
ETH_DMAInitTypeDef
Data Fields
















uint32_t DropTCPIPChecksumErrorFrame
uint32_t ReceiveStoreForward
uint32_t FlushReceivedFrame
uint32_t TransmitStoreForward
uint32_t TransmitThresholdControl
uint32_t ForwardErrorFrames
uint32_t ForwardUndersizedGoodFrames
uint32_t ReceiveThresholdControl
uint32_t SecondFrameOperate
uint32_t AddressAlignedBeats
uint32_t FixedBurst
uint32_t RxDMABurstLength
uint32_t TxDMABurstLength
uint32_t EnhancedDescriptorFormat
uint32_t DescriptorSkipLength
uint32_t DMAArbitration
Field Documentation


216/692
uint32_t ETH_DMAInitTypeDef::DropTCPIPChecksumErrorFrame
Selects or not the Dropping of TCP/IP Checksum Error Frames. This parameter can
be a value of ETH_Drop_TCP_IP_Checksum_Error_Frame
uint32_t ETH_DMAInitTypeDef::ReceiveStoreForward
Enables or disables the Receive store and forward mode. This parameter can be a
value of ETH_Receive_Store_Forward
DOCID028236 Rev 1
UM1940
HAL ETH Generic Driver














15.1.4
uint32_t ETH_DMAInitTypeDef::FlushReceivedFrame
Enables or disables the flushing of received frames. This parameter can be a value of
ETH_Flush_Received_Frame
uint32_t ETH_DMAInitTypeDef::TransmitStoreForward
Enables or disables Transmit store and forward mode. This parameter can be a value
of ETH_Transmit_Store_Forward
uint32_t ETH_DMAInitTypeDef::TransmitThresholdControl
Selects or not the Transmit Threshold Control. This parameter can be a value of
ETH_Transmit_Threshold_Control
uint32_t ETH_DMAInitTypeDef::ForwardErrorFrames
Selects or not the forward to the DMA of erroneous frames. This parameter can be a
value of ETH_Forward_Error_Frames
uint32_t ETH_DMAInitTypeDef::ForwardUndersizedGoodFrames
Enables or disables the Rx FIFO to forward Undersized frames (frames with no Error
and length less than 64 bytes) including pad-bytes and CRC) This parameter can be a
value of ETH_Forward_Undersized_Good_Frames
uint32_t ETH_DMAInitTypeDef::ReceiveThresholdControl
Selects the threshold level of the Receive FIFO. This parameter can be a value of
ETH_Receive_Threshold_Control
uint32_t ETH_DMAInitTypeDef::SecondFrameOperate
Selects or not the Operate on second frame mode, which allows the DMA to process
a second frame of Transmit data even before obtaining the status for the first frame.
This parameter can be a value of ETH_Second_Frame_Operate
uint32_t ETH_DMAInitTypeDef::AddressAlignedBeats
Enables or disables the Address Aligned Beats. This parameter can be a value of
ETH_Address_Aligned_Beats
uint32_t ETH_DMAInitTypeDef::FixedBurst
Enables or disables the AHB Master interface fixed burst transfers. This parameter
can be a value of ETH_Fixed_Burst
uint32_t ETH_DMAInitTypeDef::RxDMABurstLength
Indicates the maximum number of beats to be transferred in one Rx DMA transaction.
This parameter can be a value of ETH_Rx_DMA_Burst_Length
uint32_t ETH_DMAInitTypeDef::TxDMABurstLength
Indicates the maximum number of beats to be transferred in one Tx DMA transaction.
This parameter can be a value of ETH_Tx_DMA_Burst_Length
uint32_t ETH_DMAInitTypeDef::EnhancedDescriptorFormat
Enables the enhanced descriptor format. This parameter can be a value of
ETH_DMA_Enhanced_descriptor_format
uint32_t ETH_DMAInitTypeDef::DescriptorSkipLength
Specifies the number of word to skip between two unchained descriptors (Ring mode)
This parameter must be a number between Min_Data = 0 and Max_Data = 32
uint32_t ETH_DMAInitTypeDef::DMAArbitration
Selects the DMA Tx/Rx arbitration. This parameter can be a value of
ETH_DMA_Arbitration
ETH_DMADescTypeDef
Data Fields



__IO uint32_t Status
uint32_t ControlBufferSize
uint32_t Buffer1Addr
DOCID028236 Rev 1
217/692
HAL ETH Generic Driver





UM1940
uint32_t Buffer2NextDescAddr
uint32_t ExtendedStatus
uint32_t Reserved1
uint32_t TimeStampLow
uint32_t TimeStampHigh
Field Documentation








15.1.5
__IO uint32_t ETH_DMADescTypeDef::Status
Status
uint32_t ETH_DMADescTypeDef::ControlBufferSize
Control and Buffer1, Buffer2 lengths
uint32_t ETH_DMADescTypeDef::Buffer1Addr
Buffer1 address pointer
uint32_t ETH_DMADescTypeDef::Buffer2NextDescAddr
Buffer2 or next descriptor address pointer Enhanced ETHERNET DMA PTP
Descriptors
uint32_t ETH_DMADescTypeDef::ExtendedStatus
Extended status for PTP receive descriptor
uint32_t ETH_DMADescTypeDef::Reserved1
Reserved
uint32_t ETH_DMADescTypeDef::TimeStampLow
Time Stamp Low value for transmit and receive
uint32_t ETH_DMADescTypeDef::TimeStampHigh
Time Stamp High value for transmit and receive
ETH_DMARxFrameInfos
Data Fields





ETH_DMADescTypeDef * FSRxDesc
ETH_DMADescTypeDef * LSRxDesc
uint32_t SegCount
uint32_t length
uint32_t buffer
Field Documentation





218/692
ETH_DMADescTypeDef* ETH_DMARxFrameInfos::FSRxDesc
First Segment Rx Desc
ETH_DMADescTypeDef* ETH_DMARxFrameInfos::LSRxDesc
Last Segment Rx Desc
uint32_t ETH_DMARxFrameInfos::SegCount
Segment count
uint32_t ETH_DMARxFrameInfos::length
Frame length
uint32_t ETH_DMARxFrameInfos::buffer
Frame buffer
DOCID028236 Rev 1
UM1940
15.1.6
HAL ETH Generic Driver
ETH_HandleTypeDef
Data Fields








ETH_TypeDef * Instance
ETH_InitTypeDef Init
uint32_t LinkStatus
ETH_DMADescTypeDef * RxDesc
ETH_DMADescTypeDef * TxDesc
ETH_DMARxFrameInfos RxFrameInfos
__IO HAL_ETH_StateTypeDef State
HAL_LockTypeDef Lock
Field Documentation








ETH_TypeDef* ETH_HandleTypeDef::Instance
Register base address
ETH_InitTypeDef ETH_HandleTypeDef::Init
Ethernet Init Configuration
uint32_t ETH_HandleTypeDef::LinkStatus
Ethernet link status
ETH_DMADescTypeDef* ETH_HandleTypeDef::RxDesc
Rx descriptor to Get
ETH_DMADescTypeDef* ETH_HandleTypeDef::TxDesc
Tx descriptor to Set
ETH_DMARxFrameInfos ETH_HandleTypeDef::RxFrameInfos
last Rx frame infos
__IO HAL_ETH_StateTypeDef ETH_HandleTypeDef::State
ETH communication state
HAL_LockTypeDef ETH_HandleTypeDef::Lock
ETH Lock
15.2
ETH Firmware driver API description
15.2.1
How to use this driver
1.
2.
3.
4.
5.
Declare a ETH_HandleTypeDef handle structure, for example: ETH_HandleTypeDef
heth;
Fill parameters of Init structure in heth handle
Call HAL_ETH_Init() API to initialize the Ethernet peripheral (MAC, DMA, ...)
Initialize the ETH low level resources through the HAL_ETH_MspInit() API:
a.
Enable the Ethernet interface clock using

__HAL_RCC_ETHMAC_CLK_ENABLE();

__HAL_RCC_ETHMACTX_CLK_ENABLE();

__HAL_RCC_ETHMACRX_CLK_ENABLE();
b.
Initialize the related GPIO clocks
c.
Configure Ethernet pin-out
d.
Configure Ethernet NVIC interrupt (IT mode)
Initialize Ethernet DMA Descriptors in chain mode and point to allocated buffers:
a.
HAL_ETH_DMATxDescListInit(); for Transmission process
DOCID028236 Rev 1
219/692
HAL ETH Generic Driver
UM1940
b.
HAL_ETH_DMARxDescListInit(); for Reception process
6. Enable MAC and DMA transmission and reception:
a.
HAL_ETH_Start();
7. Prepare ETH DMA TX Descriptors and give the hand to ETH DMA to transfer the
frame to MAC TX FIFO:
a.
HAL_ETH_TransmitFrame();
8. Poll for a received frame in ETH RX DMA Descriptors and get received frame
parameters
a.
HAL_ETH_GetReceivedFrame(); (should be called into an infinite loop)
9.
Get a received frame when an ETH RX interrupt occurs:
a.
HAL_ETH_GetReceivedFrame_IT(); (called in IT mode only)
10. Communicate with external PHY device:
a.
Read a specific register from the PHY HAL_ETH_ReadPHYRegister();
b.
Write data to a specific RHY register: HAL_ETH_WritePHYRegister();
11. Configure the Ethernet MAC after ETH peripheral initialization
HAL_ETH_ConfigMAC(); all MAC parameters should be filled.
12. Configure the Ethernet DMA after ETH peripheral initialization
HAL_ETH_ConfigDMA(); all DMA parameters should be filled.
15.2.2
Initialization and de-initialization functions
This section provides functions allowing to:


Initialize and configure the Ethernet peripheral
De-initialize the Ethernet peripheral
This section contains the following APIs:






15.2.3
HAL_ETH_Init()
HAL_ETH_DeInit()
HAL_ETH_DMATxDescListInit()
HAL_ETH_DMARxDescListInit()
HAL_ETH_MspInit()
HAL_ETH_MspDeInit()
IO operation functions
This section provides functions allowing to:




Transmit a frame HAL_ETH_TransmitFrame();
Receive a frame HAL_ETH_GetReceivedFrame();
HAL_ETH_GetReceivedFrame_IT();
Read from an External PHY register HAL_ETH_ReadPHYRegister();
Write to an External PHY register HAL_ETH_WritePHYRegister();
This section contains the following APIs:









220/692
HAL_ETH_TransmitFrame()
HAL_ETH_GetReceivedFrame()
HAL_ETH_GetReceivedFrame_IT()
HAL_ETH_IRQHandler()
HAL_ETH_TxCpltCallback()
HAL_ETH_RxCpltCallback()
HAL_ETH_ErrorCallback()
HAL_ETH_ReadPHYRegister()
HAL_ETH_WritePHYRegister()
DOCID028236 Rev 1
UM1940
15.2.4
HAL ETH Generic Driver
Peripheral Control functions
This section provides functions allowing to:




Enable MAC and DMA transmission and reception. HAL_ETH_Start();
Disable MAC and DMA transmission and reception. HAL_ETH_Stop();
Set the MAC configuration in runtime mode HAL_ETH_ConfigMAC();
Set the DMA configuration in runtime mode HAL_ETH_ConfigDMA();
This section contains the following APIs:




15.2.5
HAL_ETH_Start()
HAL_ETH_Stop()
HAL_ETH_ConfigMAC()
HAL_ETH_ConfigDMA()
Peripheral State functions
This subsection permits to get in run-time the status of the peripheral and the data flow.

Get the ETH handle state: HAL_ETH_GetState();
This section contains the following APIs:

15.2.6
15.2.7
15.2.8
HAL_ETH_GetState()
HAL_ETH_Init
Function Name
HAL_StatusTypeDef HAL_ETH_Init (ETH_HandleTypeDef *
heth)
Function Description
Initializes the Ethernet MAC and DMA according to default
parameters.
Parameters

heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
Return values

HAL status
HAL_ETH_DeInit
Function Name
HAL_StatusTypeDef HAL_ETH_DeInit (ETH_HandleTypeDef *
heth)
Function Description
De-Initializes the ETH peripheral.
Parameters

heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
Return values

HAL status
HAL_ETH_DMATxDescListInit
Function Name
HAL_StatusTypeDef HAL_ETH_DMATxDescListInit
(ETH_HandleTypeDef * heth, ETH_DMADescTypeDef *
DMATxDescTab, uint8_t * TxBuff, uint32_t TxBuffCount)
Function Description
Initializes the DMA Tx descriptors in chain mode.
Parameters


heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
DMATxDescTab: Pointer to the first Tx desc list
DOCID028236 Rev 1
221/692
HAL ETH Generic Driver
Return values
15.2.9
15.2.11
15.2.12
HAL status
HAL_StatusTypeDef HAL_ETH_DMARxDescListInit
(ETH_HandleTypeDef * heth, ETH_DMADescTypeDef *
DMARxDescTab, uint8_t * RxBuff, uint32_t RxBuffCount)
Function Description
Initializes the DMA Rx descriptors in chain mode.
Parameters




heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
DMARxDescTab: Pointer to the first Rx desc list
RxBuff: Pointer to the first RxBuffer list
RxBuffCount: Number of the used Rx desc in the list

HAL status
HAL_ETH_MspInit
Function Name
void HAL_ETH_MspInit (ETH_HandleTypeDef * heth)
Function Description
Initializes the ETH MSP.
Parameters

heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
Return values

None
HAL_ETH_MspDeInit
Function Name
void HAL_ETH_MspDeInit (ETH_HandleTypeDef * heth)
Function Description
DeInitializes ETH MSP.
Parameters

heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
Return values

None
HAL_ETH_TransmitFrame
Function Name
HAL_StatusTypeDef HAL_ETH_TransmitFrame
(ETH_HandleTypeDef * heth, uint32_t FrameLength)
Function Description
Sends an Ethernet frame.
Parameters


heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
FrameLength: Amount of data to be sent

HAL status
HAL_ETH_GetReceivedFrame
Function Name
222/692

Function Name
Return values
15.2.13
TxBuff: Pointer to the first TxBuffer list
TxBuffCount: Number of the used Tx desc in the list
HAL_ETH_DMARxDescListInit
Return values
15.2.10
UM1940


HAL_StatusTypeDef HAL_ETH_GetReceivedFrame
(ETH_HandleTypeDef * heth)
DOCID028236 Rev 1
UM1940
15.2.14
15.2.15
15.2.16
15.2.17
15.2.18
HAL ETH Generic Driver
Function Description
Checks for received frames.
Parameters

heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
Return values

HAL status
HAL_ETH_GetReceivedFrame_IT
Function Name
HAL_StatusTypeDef HAL_ETH_GetReceivedFrame_IT
(ETH_HandleTypeDef * heth)
Function Description
Gets the Received frame in interrupt mode.
Parameters

heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
Return values

HAL status
HAL_ETH_IRQHandler
Function Name
void HAL_ETH_IRQHandler (ETH_HandleTypeDef * heth)
Function Description
This function handles ETH interrupt request.
Parameters

heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
Return values

HAL status
HAL_ETH_TxCpltCallback
Function Name
void HAL_ETH_TxCpltCallback (ETH_HandleTypeDef * heth)
Function Description
Tx Transfer completed callbacks.
Parameters

heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
Return values

None
HAL_ETH_RxCpltCallback
Function Name
void HAL_ETH_RxCpltCallback (ETH_HandleTypeDef * heth)
Function Description
Rx Transfer completed callbacks.
Parameters

heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
Return values

None
HAL_ETH_ErrorCallback
Function Name
void HAL_ETH_ErrorCallback (ETH_HandleTypeDef * heth)
Function Description
Ethernet transfer error callbacks.
Parameters

heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
Return values

None
DOCID028236 Rev 1
223/692
HAL ETH Generic Driver
15.2.19
UM1940
HAL_ETH_ReadPHYRegister
Function Name
HAL_StatusTypeDef HAL_ETH_ReadPHYRegister
(ETH_HandleTypeDef * heth, uint16_t PHYReg, uint32_t *
RegValue)
Function Description
Reads a PHY register.
Parameters


heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
PHYReg: PHY register address, is the index of one of the 32
PHY register. This parameter can be one of the following
values: PHY_BCR: Transceiver Basic Control Register,
PHY_BSR: Transceiver Basic Status Register. More PHY
register could be read depending on the used PHY
RegValue: PHY register value

HAL status

Return values
15.2.20
HAL_ETH_WritePHYRegister
Function Name
HAL_StatusTypeDef HAL_ETH_WritePHYRegister
(ETH_HandleTypeDef * heth, uint16_t PHYReg, uint32_t
RegValue)
Function Description
Writes to a PHY register.
Parameters


heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
PHYReg: PHY register address, is the index of one of the 32
PHY register. This parameter can be one of the following
values: PHY_BCR: Transceiver Control Register. More PHY
register could be written depending on the used PHY
RegValue: the value to write

HAL status

Return values
15.2.21
15.2.22
224/692
HAL_ETH_Start
Function Name
HAL_StatusTypeDef HAL_ETH_Start (ETH_HandleTypeDef *
heth)
Function Description
Enables Ethernet MAC and DMA reception/transmission.
Parameters

heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
Return values

HAL status
HAL_ETH_Stop
Function Name
HAL_StatusTypeDef HAL_ETH_Stop (ETH_HandleTypeDef *
heth)
Function Description
Stop Ethernet MAC and DMA reception/transmission.
Parameters

heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
Return values

HAL status
DOCID028236 Rev 1
UM1940
15.2.23
HAL ETH Generic Driver
HAL_ETH_ConfigMAC
Function Name
HAL_StatusTypeDef HAL_ETH_ConfigMAC
(ETH_HandleTypeDef * heth, ETH_MACInitTypeDef * macconf)
Function Description
Set ETH MAC Configuration.
Parameters

Return values
15.2.24

HAL status
HAL_ETH_ConfigDMA
Function Name
HAL_StatusTypeDef HAL_ETH_ConfigDMA
(ETH_HandleTypeDef * heth, ETH_DMAInitTypeDef * dmaconf)
Function Description
Sets ETH DMA Configuration.
Parameters

Return values
15.2.25

heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
macconf: MAC Configuration structure

heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
dmaconf: DMA Configuration structure

HAL status
HAL_ETH_GetState
Function Name
HAL_ETH_StateTypeDef HAL_ETH_GetState
(ETH_HandleTypeDef * heth)
Function Description
Return the ETH HAL state.
Parameters

heth: pointer to a ETH_HandleTypeDef structure that
contains the configuration information for ETHERNET module
Return values

HAL state
15.3
ETH Firmware driver defines
15.3.1
ETH
ETH Address Aligned Beats
ETH_ADDRESSALIGNEDBEATS_ENABLE
ETH_ADDRESSALIGNEDBEATS_DISABLE
ETH Automatic Pad CRC Strip
ETH_AUTOMATICPADCRCSTRIP_ENABLE
ETH_AUTOMATICPADCRCSTRIP_DISABLE
ETH AutoNegotiation
ETH_AUTONEGOTIATION_ENABLE
ETH_AUTONEGOTIATION_DISABLE
ETH Back Off Limit
ETH_BACKOFFLIMIT_10
DOCID028236 Rev 1
225/692
HAL ETH Generic Driver
ETH_BACKOFFLIMIT_8
UM1940
ETH_BACKOFFLIMIT_4
ETH_BACKOFFLIMIT_1
ETH Broadcast Frames Reception
ETH_BROADCASTFRAMESRECEPTION_ENABLE
ETH_BROADCASTFRAMESRECEPTION_DISABLE
ETH Buffers setting
ETH_MAX_PACKET_SIZE
ETH_HEADER + ETH_EXTRA + ETH_VLAN_TAG +
ETH_MAX_ETH_PAYLOAD + ETH_CRC
ETH_HEADER
6 byte Dest addr, 6 byte Src addr, 2 byte length/type
ETH_CRC
Ethernet CRC
ETH_EXTRA
Extra bytes in some cases
ETH_VLAN_TAG
optional 802.1q VLAN Tag
ETH_MIN_ETH_PAYLOAD
Minimum Ethernet payload size
ETH_MAX_ETH_PAYLOAD
Maximum Ethernet payload size
ETH_JUMBO_FRAME_PAYLOAD
Jumbo frame payload size
ETH_RX_BUF_SIZE
ETH_RXBUFNB
ETH_TX_BUF_SIZE
ETH_TXBUFNB
ETH Carrier Sense
ETH_CARRIERSENCE_ENABLE
ETH_CARRIERSENCE_DISABLE
ETH Checksum Mode
ETH_CHECKSUM_BY_HARDWARE
ETH_CHECKSUM_BY_SOFTWARE
ETH Checksum Offload
ETH_CHECKSUMOFFLAOD_ENABLE
ETH_CHECKSUMOFFLAOD_DISABLE
ETH Deferral Check
ETH_DEFFERRALCHECK_ENABLE
ETH_DEFFERRALCHECK_DISABLE
ETH Destination Addr Filter
ETH_DESTINATIONADDRFILTER_NORMAL
ETH_DESTINATIONADDRFILTER_INVERSE
ETH DMA Arbitration
ETH_DMAARBITRATION_ROUNDROBIN_RXTX_1_1
226/692
DOCID028236 Rev 1
UM1940
HAL ETH Generic Driver
ETH_DMAARBITRATION_ROUNDROBIN_RXTX_2_1
ETH_DMAARBITRATION_ROUNDROBIN_RXTX_3_1
ETH_DMAARBITRATION_ROUNDROBIN_RXTX_4_1
ETH_DMAARBITRATION_RXPRIORTX
ETH DMA Enhanced descriptor format
ETH_DMAENHANCEDDESCRIPTOR_ENABLE
ETH_DMAENHANCEDDESCRIPTOR_DISABLE
ETH DMA Flags
ETH_DMA_FLAG_TST
Time-stamp trigger interrupt (on DMA)
ETH_DMA_FLAG_PMT
PMT interrupt (on DMA)
ETH_DMA_FLAG_MMC
MMC interrupt (on DMA)
ETH_DMA_FLAG_DATATRANSFERERROR
Error bits 0-Rx DMA, 1-Tx DMA
ETH_DMA_FLAG_READWRITEERROR
Error bits 0-write transfer, 1-read transfer
ETH_DMA_FLAG_ACCESSERROR
Error bits 0-data buffer, 1-desc. access
ETH_DMA_FLAG_NIS
Normal interrupt summary flag
ETH_DMA_FLAG_AIS
Abnormal interrupt summary flag
ETH_DMA_FLAG_ER
Early receive flag
ETH_DMA_FLAG_FBE
Fatal bus error flag
ETH_DMA_FLAG_ET
Early transmit flag
ETH_DMA_FLAG_RWT
Receive watchdog timeout flag
ETH_DMA_FLAG_RPS
Receive process stopped flag
ETH_DMA_FLAG_RBU
Receive buffer unavailable flag
ETH_DMA_FLAG_R
Receive flag
ETH_DMA_FLAG_TU
Underflow flag
ETH_DMA_FLAG_RO
Overflow flag
ETH_DMA_FLAG_TJT
Transmit jabber timeout flag
ETH_DMA_FLAG_TBU
Transmit buffer unavailable flag
ETH_DMA_FLAG_TPS
Transmit process stopped flag
ETH_DMA_FLAG_T
Transmit flag
ETH DMA Interrupts
ETH_DMA_IT_TST
Time-stamp trigger interrupt (on DMA)
ETH_DMA_IT_PMT
PMT interrupt (on DMA)
ETH_DMA_IT_MMC
MMC interrupt (on DMA)
ETH_DMA_IT_NIS
Normal interrupt summary
ETH_DMA_IT_AIS
Abnormal interrupt summary
ETH_DMA_IT_ER
Early receive interrupt
DOCID028236 Rev 1
227/692
HAL ETH Generic Driver
ETH_DMA_IT_FBE
UM1940
Fatal bus error interrupt
ETH_DMA_IT_ET
Early transmit interrupt
ETH_DMA_IT_RWT
Receive watchdog timeout interrupt
ETH_DMA_IT_RPS
Receive process stopped interrupt
ETH_DMA_IT_RBU
Receive buffer unavailable interrupt
ETH_DMA_IT_R
Receive interrupt
ETH_DMA_IT_TU
Underflow interrupt
ETH_DMA_IT_RO
Overflow interrupt
ETH_DMA_IT_TJT
Transmit jabber timeout interrupt
ETH_DMA_IT_TBU
Transmit buffer unavailable interrupt
ETH_DMA_IT_TPS
Transmit process stopped interrupt
ETH_DMA_IT_T
Transmit interrupt
ETH DMA overflow
ETH_DMA_OVERFLOW_RXFIFOCOUNTER
Overflow bit for FIFO overflow
counter
ETH_DMA_OVERFLOW_MISSEDFRAMECOUNTER
Overflow bit for missed frame
counter
ETH DMA receive process state
ETH_DMA_RECEIVEPROCESS_STOPPED
Stopped - Reset or Stop Rx Command
issued
ETH_DMA_RECEIVEPROCESS_FETCHING
Running - fetching the Rx descriptor
ETH_DMA_RECEIVEPROCESS_WAITING
Running - waiting for packet
ETH_DMA_RECEIVEPROCESS_SUSPENDED
Suspended - Rx Descriptor unavailable
ETH_DMA_RECEIVEPROCESS_CLOSING
Running - closing descriptor
ETH_DMA_RECEIVEPROCESS_QUEUING
Running - queuing the receive frame
into host memory
ETH DMA RX Descriptor
228/692
ETH_DMARXDESC_OWN
OWN bit:
descriptor is
owned by DMA
engine
ETH_DMARXDESC_AFM
DA Filter Fail for
the rx frame
ETH_DMARXDESC_FL
Receive
descriptor frame
length
ETH_DMARXDESC_ES
Error summary:
OR of the
following bits:
DE || OE || IPC ||
LC || RWT || RE
DOCID028236 Rev 1
UM1940
HAL ETH Generic Driver
|| CE
ETH_DMARXDESC_DE
Descriptor error:
no more
descriptors for
receive frame
ETH_DMARXDESC_SAF
SA Filter Fail for
the received
frame
ETH_DMARXDESC_LE
Frame size not
matching with
length field
ETH_DMARXDESC_OE
Overflow Error:
Frame was
damaged due to
buffer overflow
ETH_DMARXDESC_VLAN
VLAN Tag:
received frame
is a VLAN frame
ETH_DMARXDESC_FS
First descriptor
of the frame
ETH_DMARXDESC_LS
Last descriptor
of the frame
ETH_DMARXDESC_IPV4HCE
IPC Checksum
Error: Rx Ipv4
header
checksum error
ETH_DMARXDESC_LC
Late collision
occurred during
reception
ETH_DMARXDESC_FT
Frame type Ethernet,
otherwise 802.3
ETH_DMARXDESC_RWT
Receive
Watchdog
Timeout:
watchdog timer
expired during
reception
ETH_DMARXDESC_RE
Receive error:
error reported by
MII interface
ETH_DMARXDESC_DBE
Dribble bit error:
frame contains
non int multiple
of 8 bits
ETH_DMARXDESC_CE
CRC error
ETH_DMARXDESC_MAMPCE
Rx MAC
Address/Payloa
DOCID028236 Rev 1
229/692
HAL ETH Generic Driver
UM1940
d Checksum
Error: Rx MAC
address
matched/ Rx
Payload
Checksum Error
ETH_DMARXDESC_DIC
Disable Interrupt
on Completion
ETH_DMARXDESC_RBS2
Receive Buffer2
Size
ETH_DMARXDESC_RER
Receive End of
Ring
ETH_DMARXDESC_RCH
Second Address
Chained
ETH_DMARXDESC_RBS1
Receive Buffer1
Size
ETH_DMARXDESC_B1AP
Buffer1 Address
Pointer
ETH_DMARXDESC_B2AP
Buffer2 Address
Pointer
ETH_DMAPTPRXDESC_PTPV
ETH_DMAPTPRXDESC_PTPFT
ETH_DMAPTPRXDESC_PTPMT
ETH_DMAPTPRXDESC_PTPMT_SYNC
ETH_DMAPTPRXDESC_PTPMT_FOLLOWUP
ETH_DMAPTPRXDESC_PTPMT_DELAYREQ
ETH_DMAPTPRXDESC_PTPMT_DELAYRESP
ETH_DMAPTPRXDESC_PTPMT_PDELAYREQ_ANNOUNCE
ETH_DMAPTPRXDESC_PTPMT_PDELAYRESP_MANAG
ETH_DMAPTPRXDESC_PTPMT_PDELAYRESPFOLLOWUP_SIGNA
L
ETH_DMAPTPRXDESC_IPV6PR
ETH_DMAPTPRXDESC_IPV4PR
ETH_DMAPTPRXDESC_IPCB
ETH_DMAPTPRXDESC_IPPE
ETH_DMAPTPRXDESC_IPHE
ETH_DMAPTPRXDESC_IPPT
ETH_DMAPTPRXDESC_IPPT_UDP
ETH_DMAPTPRXDESC_IPPT_TCP
ETH_DMAPTPRXDESC_IPPT_ICMP
ETH_DMAPTPRXDESC_RTSL
230/692
DOCID028236 Rev 1
UM1940
HAL ETH Generic Driver
ETH_DMAPTPRXDESC_RTSH
ETH DMA Rx descriptor buffers
ETH_DMARXDESC_BUFFER1
DMA Rx Desc Buffer1
ETH_DMARXDESC_BUFFER2
DMA Rx Desc Buffer2
ETH DMA transmit process state
ETH_DMA_TRANSMITPROCESS_STOPPED
Stopped - Reset or Stop Tx Command
issued
ETH_DMA_TRANSMITPROCESS_FETCHING
Running - fetching the Tx descriptor
ETH_DMA_TRANSMITPROCESS_WAITING
Running - waiting for status
ETH_DMA_TRANSMITPROCESS_READING
Running - reading the data from host
memory
ETH_DMA_TRANSMITPROCESS_SUSPENDED
Suspended - Tx Descriptor
unavailable
ETH_DMA_TRANSMITPROCESS_CLOSING
Running - closing Rx descriptor
ETH DMA TX Descriptor
ETH_DMATXDESC_OWN
OWN bit: descriptor is owned by
DMA engine
ETH_DMATXDESC_IC
Interrupt on Completion
ETH_DMATXDESC_LS
Last Segment
ETH_DMATXDESC_FS
First Segment
ETH_DMATXDESC_DC
Disable CRC
ETH_DMATXDESC_DP
Disable Padding
ETH_DMATXDESC_TTSE
Transmit Time Stamp Enable
ETH_DMATXDESC_CIC
Checksum Insertion Control: 4
cases
ETH_DMATXDESC_CIC_BYPASS
Do Nothing: Checksum Engine is
bypassed
ETH_DMATXDESC_CIC_IPV4HEADER
IPV4 header Checksum Insertion
ETH_DMATXDESC_CIC_TCPUDPICMP_SEGMENT
TCP/UDP/ICMP Checksum
Insertion calculated over segment
only
ETH_DMATXDESC_CIC_TCPUDPICMP_FULL
TCP/UDP/ICMP Checksum
Insertion fully calculated
ETH_DMATXDESC_TER
Transmit End of Ring
ETH_DMATXDESC_TCH
Second Address Chained
ETH_DMATXDESC_TTSS
Tx Time Stamp Status
ETH_DMATXDESC_IHE
IP Header Error
ETH_DMATXDESC_ES
Error summary: OR of the
following bits: UE || ED || EC ||
LCO || NC || LCA || FF || JT
DOCID028236 Rev 1
231/692
HAL ETH Generic Driver
ETH_DMATXDESC_JT
UM1940
Jabber Timeout
ETH_DMATXDESC_FF
Frame Flushed: DMA/MTL flushed
the frame due to SW flush
ETH_DMATXDESC_PCE
Payload Checksum Error
ETH_DMATXDESC_LCA
Loss of Carrier: carrier lost during
transmission
ETH_DMATXDESC_NC
No Carrier: no carrier signal from
the transceiver
ETH_DMATXDESC_LCO
Late Collision: transmission
aborted due to collision
ETH_DMATXDESC_EC
Excessive Collision: transmission
aborted after 16 collisions
ETH_DMATXDESC_VF
VLAN Frame
ETH_DMATXDESC_CC
Collision Count
ETH_DMATXDESC_ED
Excessive Deferral
ETH_DMATXDESC_UF
Underflow Error: late data arrival
from the memory
ETH_DMATXDESC_DB
Deferred Bit
ETH_DMATXDESC_TBS2
Transmit Buffer2 Size
ETH_DMATXDESC_TBS1
Transmit Buffer1 Size
ETH_DMATXDESC_B1AP
Buffer1 Address Pointer
ETH_DMATXDESC_B2AP
Buffer2 Address Pointer
ETH_DMAPTPTXDESC_TTSL
ETH_DMAPTPTXDESC_TTSH
ETH DMA Tx descriptor Checksum Insertion Control
ETH_DMATXDESC_CHECKSUMBYPASS
Checksum engine bypass
ETH_DMATXDESC_CHECKSUMIPV4HEADER
IPv4 header checksum
insertion
ETH_DMATXDESC_CHECKSUMTCPUDPICMPSEGMENT
TCP/UDP/ICMP checksum
insertion. Pseudo header
checksum is assumed to be
present
ETH_DMATXDESC_CHECKSUMTCPUDPICMPFULL
TCP/UDP/ICMP checksum
fully in hardware including
pseudo header
ETH DMA Tx descriptor segment
ETH_DMATXDESC_LASTSEGMENTS
Last Segment
ETH_DMATXDESC_FIRSTSEGMENT
First Segment
ETH Drop TCP IP Checksum Error Frame
ETH_DROPTCPIPCHECKSUMERRORFRAME_ENABLE
232/692
DOCID028236 Rev 1
UM1940
HAL ETH Generic Driver
ETH_DROPTCPIPCHECKSUMERRORFRAME_DISABLE
ETH Duplex Mode
ETH_MODE_FULLDUPLEX
ETH_MODE_HALFDUPLEX
ETH Exported Macros
__HAL_ETH_RESET_HANDLE_STATE
Description:

Reset ETH handle state.
Parameters:

__HANDLE__: specifies the ETH
handle.
Return value:

__HAL_ETH_DMATXDESC_GET_FLAG
None
Description:

Checks whether the specified
ETHERNET DMA Tx Desc flag is set or
not.
Parameters:


__HANDLE__: ETH Handle
__FLAG__: specifies the flag of TDES0
to check.
Return value:

__HAL_ETH_DMARXDESC_GET_FLAG
the: ETH_DMATxDescFlag (SET or
RESET).
Description:

Checks whether the specified
ETHERNET DMA Rx Desc flag is set or
not.
Parameters:


__HANDLE__: ETH Handle
__FLAG__: specifies the flag of RDES0
to check.
Return value:

__HAL_ETH_DMARXDESC_ENABLE_IT
the: ETH_DMATxDescFlag (SET or
RESET).
Description:

Enables the specified DMA Rx Desc
receive interrupt.
Parameters:

__HANDLE__: ETH Handle
Return value:
DOCID028236 Rev 1
233/692
HAL ETH Generic Driver
UM1940

__HAL_ETH_DMARXDESC_DISABLE_IT
None
Description:

Disables the specified DMA Rx Desc
receive interrupt.
Parameters:

__HANDLE__: ETH Handle
Return value:

__HAL_ETH_DMARXDESC_SET_OWN_
BIT
None
Description:

Set the specified DMA Rx Desc Own bit.
Parameters:

__HANDLE__: ETH Handle
Return value:

__HAL_ETH_DMATXDESC_GET_COLLI
SION_COUNT
None
Description:

Returns the specified ETHERNET DMA
Tx Desc collision count.
Parameters:

__HANDLE__: ETH Handle
Return value:

__HAL_ETH_DMATXDESC_SET_OWN_
BIT
The: Transmit descriptor collision
counter value.
Description:

Set the specified DMA Tx Desc Own bit.
Parameters:

__HANDLE__: ETH Handle
Return value:

__HAL_ETH_DMATXDESC_ENABLE_IT
None
Description:

Enables the specified DMA Tx Desc
Transmit interrupt.
Parameters:

__HANDLE__: ETH Handle
Return value:

__HAL_ETH_DMATXDESC_DISABLE_IT
Description:

234/692
None
DOCID028236 Rev 1
Disables the specified DMA Tx Desc
UM1940
HAL ETH Generic Driver
Transmit interrupt.
Parameters:

__HANDLE__: ETH Handle
Return value:

__HAL_ETH_DMATXDESC_CHECKSUM
_INSERTION
None
Description:

Selects the specified ETHERNET DMA
Tx Desc Checksum Insertion.
Parameters:


__HANDLE__: ETH Handle
__CHECKSUM__: specifies is the DMA
Tx desc checksum insertion. This
parameter can be one of the following
values:

ETH_DMATXDESC_CHECKSUMB
YPASS : Checksum bypass

ETH_DMATXDESC_CHECKSUMI
PV4HEADER : IPv4 header
checksum

ETH_DMATXDESC_CHECKSUMT
CPUDPICMPSEGMENT :
TCP/UDP/ICMP checksum. Pseudo
header checksum is assumed to be
present

ETH_DMATXDESC_CHECKSUMT
CPUDPICMPFULL :
TCP/UDP/ICMP checksum fully in
hardware including pseudo header
Return value:

__HAL_ETH_DMATXDESC_CRC_ENABL
E
None
Description:

Enables the DMA Tx Desc CRC.
Parameters:

__HANDLE__: ETH Handle
Return value:

__HAL_ETH_DMATXDESC_CRC_DISAB
LE
None
Description:

Disables the DMA Tx Desc CRC.
Parameters:

__HANDLE__: ETH Handle
Return value:

DOCID028236 Rev 1
None
235/692
HAL ETH Generic Driver
__HAL_ETH_DMATXDESC_SHORT_FRA
ME_PADDING_ENABLE
UM1940
Description:

Enables the DMA Tx Desc padding for
frame shorter than 64 bytes.
Parameters:

__HANDLE__: ETH Handle
Return value:

__HAL_ETH_DMATXDESC_SHORT_FRA
ME_PADDING_DISABLE
None
Description:

Disables the DMA Tx Desc padding for
frame shorter than 64 bytes.
Parameters:

__HANDLE__: ETH Handle
Return value:

__HAL_ETH_MAC_ENABLE_IT
None
Description:

Enables the specified ETHERNET MAC
interrupts.
Parameters:


__HANDLE__: : ETH Handle
__INTERRUPT__: specifies the
ETHERNET MAC interrupt sources to
be enabled or disabled. This parameter
can be any combination of the following
values:

ETH_MAC_IT_TST : Time stamp
trigger interrupt

ETH_MAC_IT_PMT : PMT interrupt
Return value:

__HAL_ETH_MAC_DISABLE_IT
None
Description:

Disables the specified ETHERNET MAC
interrupts.
Parameters:


__HANDLE__: : ETH Handle
__INTERRUPT__: specifies the
ETHERNET MAC interrupt sources to
be enabled or disabled. This parameter
can be any combination of the following
values:

ETH_MAC_IT_TST : Time stamp
trigger interrupt

ETH_MAC_IT_PMT : PMT interrupt
Return value:
236/692
DOCID028236 Rev 1
UM1940
HAL ETH Generic Driver

__HAL_ETH_INITIATE_PAUSE_CONTRO
L_FRAME
None
Description:

Initiate a Pause Control Frame (Fullduplex only).
Parameters:

__HANDLE__: ETH Handle
Return value:

__HAL_ETH_GET_FLOW_CONTROL_BU
SY_STATUS
None
Description:

Checks whether the ETHERNET flow
control busy bit is set or not.
Parameters:

__HANDLE__: ETH Handle
Return value:

__HAL_ETH_BACK_PRESSURE_ACTIVA
TION_ENABLE
The: new state of flow control busy
status bit (SET or RESET).
Description:

Enables the MAC Back Pressure
operation activation (Half-duplex only).
Parameters:

__HANDLE__: ETH Handle
Return value:

__HAL_ETH_BACK_PRESSURE_ACTIVA
TION_DISABLE
None
Description:

Disables the MAC BackPressure
operation activation (Half-duplex only).
Parameters:

__HANDLE__: ETH Handle
Return value:

__HAL_ETH_MAC_GET_FLAG
None
Description:

Checks whether the specified
ETHERNET MAC flag is set or not.
Parameters:


DOCID028236 Rev 1
__HANDLE__: ETH Handle
__FLAG__: specifies the flag to check.
This parameter can be one of the
following values:

ETH_MAC_FLAG_TST : Time
stamp trigger flag
237/692
HAL ETH Generic Driver
UM1940




ETH_MAC_FLAG_MMCT : MMC
transmit flag
ETH_MAC_FLAG_MMCR : MMC
receive flag
ETH_MAC_FLAG_MMC : MMC
flag
ETH_MAC_FLAG_PMT : PMT flag
Return value:

__HAL_ETH_DMA_ENABLE_IT
The: state of ETHERNET MAC flag.
Description:

Enables the specified ETHERNET DMA
interrupts.
Parameters:


__HANDLE__: : ETH Handle
__INTERRUPT__: specifies the
ETHERNET DMA interrupt sources to
be enabled
Return value:

__HAL_ETH_DMA_DISABLE_IT
None
Description:

Disables the specified ETHERNET DMA
interrupts.
Parameters:


__HANDLE__: : ETH Handle
__INTERRUPT__: specifies the
ETHERNET DMA interrupt sources to
be disabled.
Return value:

__HAL_ETH_DMA_CLEAR_IT
None
Description:

Clears the ETHERNET DMA IT pending
bit.
Parameters:


__HANDLE__: : ETH Handle
__INTERRUPT__: specifies the interrupt
pending bit to clear.
Return value:

__HAL_ETH_DMA_GET_FLAG
None
Description:

Checks whether the specified
ETHERNET DMA flag is set or not.
Parameters:
238/692
DOCID028236 Rev 1
UM1940
HAL ETH Generic Driver


__HANDLE__: ETH Handle
__FLAG__: specifies the flag to check.
Return value:

__HAL_ETH_DMA_CLEAR_FLAG
The: new state of ETH_DMA_FLAG
(SET or RESET).
Description:

Checks whether the specified
ETHERNET DMA flag is set or not.
Parameters:


__HANDLE__: ETH Handle
__FLAG__: specifies the flag to clear.
Return value:

__HAL_ETH_GET_DMA_OVERFLOW_ST
ATUS
The: new state of ETH_DMA_FLAG
(SET or RESET).
Description:

Checks whether the specified
ETHERNET DMA overflow flag is set or
not.
Parameters:


__HANDLE__: ETH Handle
__OVERFLOW__: specifies the DMA
overflow flag to check. This parameter
can be one of the following values:

ETH_DMA_OVERFLOW_RXFIFO
COUNTER : Overflow for FIFO
Overflows Counter

ETH_DMA_OVERFLOW_MISSED
FRAMECOUNTER : Overflow for
Buffer Unavailable Missed Frame
Counter
Return value:

__HAL_ETH_SET_RECEIVE_WATCHDO
G_TIMER
The: state of ETHERNET DMA overflow
Flag (SET or RESET).
Description:

Set the DMA Receive status watchdog
timer register value.
Parameters:


__HANDLE__: ETH Handle
__VALUE__: DMA Receive status
watchdog timer register value
Return value:

__HAL_ETH_GLOBAL_UNICAST_WAKE
None
Description:
DOCID028236 Rev 1
239/692
HAL ETH Generic Driver
UP_ENABLE
UM1940

Enables any unicast packet filtered by
the MAC address recognition to be a
wake-up frame.
Parameters:

__HANDLE__: ETH Handle.
Return value:

__HAL_ETH_GLOBAL_UNICAST_WAKE
UP_DISABLE
None
Description:

Disables any unicast packet filtered by
the MAC address recognition to be a
wake-up frame.
Parameters:

__HANDLE__: ETH Handle.
Return value:

__HAL_ETH_WAKEUP_FRAME_DETECT
ION_ENABLE
None
Description:

Enables the MAC Wake-Up Frame
Detection.
Parameters:

__HANDLE__: ETH Handle.
Return value:

__HAL_ETH_WAKEUP_FRAME_DETECT
ION_DISABLE
None
Description:

Disables the MAC Wake-Up Frame
Detection.
Parameters:

__HANDLE__: ETH Handle.
Return value:

__HAL_ETH_MAGIC_PACKET_DETECTI
ON_ENABLE
None
Description:

Enables the MAC Magic Packet
Detection.
Parameters:

__HANDLE__: ETH Handle.
Return value:

__HAL_ETH_MAGIC_PACKET_DETECTI
ON_DISABLE
240/692
None
Description:

DOCID028236 Rev 1
Disables the MAC Magic Packet
UM1940
HAL ETH Generic Driver
Detection.
Parameters:

__HANDLE__: ETH Handle.
Return value:

__HAL_ETH_POWER_DOWN_ENABLE
None
Description:

Enables the MAC Power Down.
Parameters:

__HANDLE__: ETH Handle
Return value:

__HAL_ETH_POWER_DOWN_DISABLE
None
Description:

Disables the MAC Power Down.
Parameters:

__HANDLE__: ETH Handle
Return value:

__HAL_ETH_GET_PMT_FLAG_STATUS
None
Description:

Checks whether the specified
ETHERNET PMT flag is set or not.
Parameters:


__HANDLE__: ETH Handle.
__FLAG__: specifies the flag to check.
This parameter can be one of the
following values:

ETH_PMT_FLAG_WUFFRPR :
Wake-Up Frame Filter Register
Pointer Reset

ETH_PMT_FLAG_WUFR : WakeUp Frame Received

ETH_PMT_FLAG_MPR : Magic
Packet Received
Return value:

__HAL_ETH_MMC_COUNTER_FULL_PR
ESET
The: new state of ETHERNET PMT Flag
(SET or RESET).
Description:

Preset and Initialize the MMC counters
to almost-full value: 0xFFFF_FFF0 (full 16)
Parameters:
DOCID028236 Rev 1
241/692
HAL ETH Generic Driver
UM1940

__HANDLE__: ETH Handle.
Return value:

__HAL_ETH_MMC_COUNTER_HALF_PR
ESET
None
Description:

Preset and Initialize the MMC counters
to almost-half value: 0x7FFF_FFF0 (half
- 16)
Parameters:

__HANDLE__: ETH Handle.
Return value:

__HAL_ETH_MMC_COUNTER_FREEZE_
ENABLE
None
Description:

Enables the MMC Counter Freeze.
Parameters:

__HANDLE__: ETH Handle.
Return value:

__HAL_ETH_MMC_COUNTER_FREEZE_
DISABLE
None
Description:

Disables the MMC Counter Freeze.
Parameters:

__HANDLE__: ETH Handle.
Return value:

__HAL_ETH_ETH_MMC_RESET_ONREA
D_ENABLE
None
Description:

Enables the MMC Reset On Read.
Parameters:

__HANDLE__: ETH Handle.
Return value:

__HAL_ETH_ETH_MMC_RESET_ONREA
D_DISABLE
None
Description:

Disables the MMC Reset On Read.
Parameters:

__HANDLE__: ETH Handle.
Return value:

__HAL_ETH_ETH_MMC_COUNTER_RO
LLOVER_ENABLE
242/692
None
Description:

DOCID028236 Rev 1
Enables the MMC Counter Stop
UM1940
HAL ETH Generic Driver
Rollover.
Parameters:

__HANDLE__: ETH Handle.
Return value:

__HAL_ETH_ETH_MMC_COUNTER_RO
LLOVER_DISABLE
None
Description:

Disables the MMC Counter Stop
Rollover.
Parameters:

__HANDLE__: ETH Handle.
Return value:

__HAL_ETH_MMC_COUNTERS_RESET
None
Description:

Resets the MMC Counters.
Parameters:

__HANDLE__: ETH Handle.
Return value:

__HAL_ETH_MMC_RX_IT_ENABLE
None
Description:

Enables the specified ETHERNET MMC
Rx interrupts.
Parameters:


__HANDLE__: ETH Handle.
__INTERRUPT__: specifies the
ETHERNET MMC interrupt sources to
be enabled or disabled. This parameter
can be one of the following values:

ETH_MMC_IT_RGUF : When Rx
good unicast frames counter
reaches half the maximum value

ETH_MMC_IT_RFAE : When Rx
alignment error counter reaches
half the maximum value

ETH_MMC_IT_RFCE : When Rx
crc error counter reaches half the
maximum value
Return value:

__HAL_ETH_MMC_RX_IT_DISABLE
None
Description:

DOCID028236 Rev 1
Disables the specified ETHERNET MMC
Rx interrupts.
243/692
HAL ETH Generic Driver
UM1940
Parameters:


__HANDLE__: ETH Handle.
__INTERRUPT__: specifies the
ETHERNET MMC interrupt sources to
be enabled or disabled. This parameter
can be one of the following values:

ETH_MMC_IT_RGUF : When Rx
good unicast frames counter
reaches half the maximum value

ETH_MMC_IT_RFAE : When Rx
alignment error counter reaches
half the maximum value

ETH_MMC_IT_RFCE : When Rx
crc error counter reaches half the
maximum value
Return value:

__HAL_ETH_MMC_TX_IT_ENABLE
None
Description:

Enables the specified ETHERNET MMC
Tx interrupts.
Parameters:


__HANDLE__: ETH Handle.
__INTERRUPT__: specifies the
ETHERNET MMC interrupt sources to
be enabled or disabled. This parameter
can be one of the following values:

ETH_MMC_IT_TGF : When Tx
good frame counter reaches half
the maximum value

ETH_MMC_IT_TGFMSC: When Tx
good multi col counter reaches half
the maximum value

ETH_MMC_IT_TGFSC : When Tx
good single col counter reaches
half the maximum value
Return value:

__HAL_ETH_MMC_TX_IT_DISABLE
None
Description:

Disables the specified ETHERNET MMC
Tx interrupts.
Parameters:


244/692
DOCID028236 Rev 1
__HANDLE__: ETH Handle.
__INTERRUPT__: specifies the
ETHERNET MMC interrupt sources to
be enabled or disabled. This parameter
can be one of the following values:

ETH_MMC_IT_TGF : When Tx
good frame counter reaches half
UM1940


HAL ETH Generic Driver
the maximum value
ETH_MMC_IT_TGFMSC: When Tx
good multi col counter reaches half
the maximum value
ETH_MMC_IT_TGFSC : When Tx
good single col counter reaches
half the maximum value
Return value:

__HAL_ETH_WAKEUP_EXTI_ENABLE_I
T
None
Description:

Enables the ETH External interrupt line.
Return value:

__HAL_ETH_WAKEUP_EXTI_DISABLE_I
T
None
Description:

Disables the ETH External interrupt line.
Return value:

__HAL_ETH_WAKEUP_EXTI_ENABLE_E
VENT
None
Description:

Enable event on ETH External event
line.
Return value:

__HAL_ETH_WAKEUP_EXTI_DISABLE_
EVENT
None.
Description:

Disable event on ETH External event
line.
Return value:

__HAL_ETH_WAKEUP_EXTI_GET_FLAG
None.
Description:

Get flag of the ETH External interrupt
line.
Return value:

__HAL_ETH_WAKEUP_EXTI_CLEAR_FL
AG
None
Description:

Clear flag of the ETH External interrupt
line.
Return value:

__HAL_ETH_WAKEUP_EXTI_ENABLE_R
ISING_EDGE_TRIGGER
None
Description:

DOCID028236 Rev 1
Enables rising edge trigger to the ETH
245/692
HAL ETH Generic Driver
UM1940
External interrupt line.
Return value:

__HAL_ETH_WAKEUP_EXTI_DISABLE_
RISING_EDGE_TRIGGER
None
Description:

Disables the rising edge trigger to the
ETH External interrupt line.
Return value:

__HAL_ETH_WAKEUP_EXTI_ENABLE_F
ALLING_EDGE_TRIGGER
None
Description:

Enables falling edge trigger to the ETH
External interrupt line.
Return value:

__HAL_ETH_WAKEUP_EXTI_DISABLE_
FALLING_EDGE_TRIGGER
None
Description:

Disables falling edge trigger to the ETH
External interrupt line.
Return value:

__HAL_ETH_WAKEUP_EXTI_ENABLE_F
ALLINGRISING_TRIGGER
None
Description:

Enables rising/falling edge trigger to the
ETH External interrupt line.
Return value:

__HAL_ETH_WAKEUP_EXTI_DISABLE_
FALLINGRISING_TRIGGER
None
Description:

Disables rising/falling edge trigger to the
ETH External interrupt line.
Return value:

__HAL_ETH_WAKEUP_EXTI_GENERAT
E_SWIT
None
Description:

Generate a Software interrupt on
selected EXTI line.
Return value:

None.
ETH EXTI LINE WAKEUP
ETH_EXTI_LINE_WAKEUP
External interrupt line 19 Connected to the ETH EXTI Line
ETH Fixed Burst
ETH_FIXEDBURST_ENABLE
ETH_FIXEDBURST_DISABLE
246/692
DOCID028236 Rev 1
UM1940
HAL ETH Generic Driver
ETH Flush Received Frame
ETH_FLUSHRECEIVEDFRAME_ENABLE
ETH_FLUSHRECEIVEDFRAME_DISABLE
ETH Forward Error Frames
ETH_FORWARDERRORFRAMES_ENABLE
ETH_FORWARDERRORFRAMES_DISABLE
ETH Forward Undersized Good Frames
ETH_FORWARDUNDERSIZEDGOODFRAMES_ENABLE
ETH_FORWARDUNDERSIZEDGOODFRAMES_DISABLE
ETH Inter Frame Gap
ETH_INTERFRAMEGAP_96BIT
minimum IFG between frames during transmission is
96Bit
ETH_INTERFRAMEGAP_88BIT
minimum IFG between frames during transmission is
88Bit
ETH_INTERFRAMEGAP_80BIT
minimum IFG between frames during transmission is
80Bit
ETH_INTERFRAMEGAP_72BIT
minimum IFG between frames during transmission is
72Bit
ETH_INTERFRAMEGAP_64BIT
minimum IFG between frames during transmission is
64Bit
ETH_INTERFRAMEGAP_56BIT
minimum IFG between frames during transmission is
56Bit
ETH_INTERFRAMEGAP_48BIT
minimum IFG between frames during transmission is
48Bit
ETH_INTERFRAMEGAP_40BIT
minimum IFG between frames during transmission is
40Bit
ETH Jabber
ETH_JABBER_ENABLE
ETH_JABBER_DISABLE
ETH Loop Back Mode
ETH_LOOPBACKMODE_ENABLE
ETH_LOOPBACKMODE_DISABLE
ETH MAC addresses
ETH_MAC_ADDRESS0
ETH_MAC_ADDRESS1
ETH_MAC_ADDRESS2
ETH_MAC_ADDRESS3
ETH MAC addresses filter Mask bytes
ETH_MAC_ADDRESSMASK_BYTE6
Mask MAC Address high reg bits [15:8]
DOCID028236 Rev 1
247/692
HAL ETH Generic Driver
ETH_MAC_ADDRESSMASK_BYTE5
UM1940
Mask MAC Address high reg bits [7:0]
ETH_MAC_ADDRESSMASK_BYTE4
Mask MAC Address low reg bits [31:24]
ETH_MAC_ADDRESSMASK_BYTE3
Mask MAC Address low reg bits [23:16]
ETH_MAC_ADDRESSMASK_BYTE2
Mask MAC Address low reg bits [15:8]
ETH_MAC_ADDRESSMASK_BYTE1
Mask MAC Address low reg bits [70]
ETH MAC addresses filter SA DA
ETH_MAC_ADDRESSFILTER_SA
ETH_MAC_ADDRESSFILTER_DA
ETH MAC Debug flags
ETH_MAC_TXFIFO_FULL
ETH_MAC_TXFIFONOT_EMPTY
ETH_MAC_TXFIFO_WRITE_ACTIVE
ETH_MAC_TXFIFO_IDLE
ETH_MAC_TXFIFO_READ
ETH_MAC_TXFIFO_WAITING
ETH_MAC_TXFIFO_WRITING
ETH_MAC_TRANSMISSION_PAUSE
ETH_MAC_TRANSMITFRAMECONTROLLER_IDLE
ETH_MAC_TRANSMITFRAMECONTROLLER_WAITING
ETH_MAC_TRANSMITFRAMECONTROLLER_GENRATING_PCF
ETH_MAC_TRANSMITFRAMECONTROLLER_TRANSFERRING
ETH_MAC_MII_TRANSMIT_ACTIVE
ETH_MAC_RXFIFO_EMPTY
ETH_MAC_RXFIFO_BELOW_THRESHOLD
ETH_MAC_RXFIFO_ABOVE_THRESHOLD
ETH_MAC_RXFIFO_FULL
ETH_MAC_READCONTROLLER_IDLE
ETH_MAC_READCONTROLLER_READING_DATA
ETH_MAC_READCONTROLLER_READING_STATUS
ETH_MAC_READCONTROLLER_FLUSHING
ETH_MAC_RXFIFO_WRITE_ACTIVE
ETH_MAC_SMALL_FIFO_NOTACTIVE
ETH_MAC_SMALL_FIFO_READ_ACTIVE
ETH_MAC_SMALL_FIFO_WRITE_ACTIVE
ETH_MAC_SMALL_FIFO_RW_ACTIVE
ETH_MAC_MII_RECEIVE_PROTOCOL_ACTIVE
ETH MAC Flags
248/692
DOCID028236 Rev 1
UM1940
HAL ETH Generic Driver
ETH_MAC_FLAG_TST
Time stamp trigger flag (on MAC)
ETH_MAC_FLAG_MMCT
MMC transmit flag
ETH_MAC_FLAG_MMCR
MMC receive flag
ETH_MAC_FLAG_MMC
MMC flag (on MAC)
ETH_MAC_FLAG_PMT
PMT flag (on MAC)
ETH MAC Interrupts
ETH_MAC_IT_TST
Time stamp trigger interrupt (on MAC)
ETH_MAC_IT_MMCT
MMC transmit interrupt
ETH_MAC_IT_MMCR
MMC receive interrupt
ETH_MAC_IT_MMC
MMC interrupt (on MAC)
ETH_MAC_IT_PMT
PMT interrupt (on MAC)
ETH Media Interface
ETH_MEDIA_INTERFACE_MII
ETH_MEDIA_INTERFACE_RMII
ETH MMC Rx Interrupts
ETH_MMC_IT_RGUF
When Rx good unicast frames counter reaches half the maximum
value
ETH_MMC_IT_RFAE
When Rx alignment error counter reaches half the maximum value
ETH_MMC_IT_RFCE
When Rx crc error counter reaches half the maximum value
ETH MMC Tx Interrupts
ETH_MMC_IT_TGF
When Tx good frame counter reaches half the maximum value
ETH_MMC_IT_TGFMSC
When Tx good multi col counter reaches half the maximum
value
ETH_MMC_IT_TGFSC
When Tx good single col counter reaches half the maximum
value
ETH Multicast Frames Filter
ETH_MULTICASTFRAMESFILTER_PERFECTHASHTABLE
ETH_MULTICASTFRAMESFILTER_HASHTABLE
ETH_MULTICASTFRAMESFILTER_PERFECT
ETH_MULTICASTFRAMESFILTER_NONE
ETH Pass Control Frames
ETH_PASSCONTROLFRAMES_BLOCKALL
MAC filters all
control frames from
reaching the
application
ETH_PASSCONTROLFRAMES_FORWARDALL
MAC forwards all
control frames to
application even if
they fail the
Address Filter
DOCID028236 Rev 1
249/692
HAL ETH Generic Driver
ETH_PASSCONTROLFRAMES_FORWARDPASSEDADDRFILTER
UM1940
MAC forwards
control frames that
pass the Address
Filter.
ETH Pause Low Threshold
ETH_PAUSELOWTHRESHOLD_MINUS4
Pause time minus 4 slot times
ETH_PAUSELOWTHRESHOLD_MINUS28
Pause time minus 28 slot times
ETH_PAUSELOWTHRESHOLD_MINUS144
Pause time minus 144 slot times
ETH_PAUSELOWTHRESHOLD_MINUS256
Pause time minus 256 slot times
ETH PMT Flags
ETH_PMT_FLAG_WUFFRPR
Wake-Up Frame Filter Register Pointer Reset
ETH_PMT_FLAG_WUFR
Wake-Up Frame Received
ETH_PMT_FLAG_MPR
Magic Packet Received
ETH Private Constants
LINKED_STATE_TIMEOUT_VALUE
AUTONEGO_COMPLETED_TIMEOUT_VALUE
ETH Private Defines
ETH_REG_WRITE_DELAY
ETH_SUCCESS
ETH_ERROR
ETH_DMATXDESC_COLLISION_COUNTSHIFT
ETH_DMATXDESC_BUFFER2_SIZESHIFT
ETH_DMARXDESC_FRAME_LENGTHSHIFT
ETH_DMARXDESC_BUFFER2_SIZESHIFT
ETH_DMARXDESC_FRAMELENGTHSHIFT
ETH_MAC_ADDR_HBASE
ETH_MAC_ADDR_LBASE
ETH_MACMIIAR_CR_MASK
ETH_MACCR_CLEAR_MASK
ETH_MACFCR_CLEAR_MASK
ETH_DMAOMR_CLEAR_MASK
ETH_WAKEUP_REGISTER_LENGTH
ETH_DMA_RX_OVERFLOW_MISSEDFRAMES_COUNTERSHIFT
ETH Private Macros
IS_ETH_PHY_ADDRESS
IS_ETH_AUTONEGOTIATION
IS_ETH_SPEED
250/692
DOCID028236 Rev 1
UM1940
HAL ETH Generic Driver
IS_ETH_DUPLEX_MODE
IS_ETH_RX_MODE
IS_ETH_CHECKSUM_MODE
IS_ETH_MEDIA_INTERFACE
IS_ETH_WATCHDOG
IS_ETH_JABBER
IS_ETH_INTER_FRAME_GAP
IS_ETH_CARRIER_SENSE
IS_ETH_RECEIVE_OWN
IS_ETH_LOOPBACK_MODE
IS_ETH_CHECKSUM_OFFLOAD
IS_ETH_RETRY_TRANSMISSION
IS_ETH_AUTOMATIC_PADCRC_STRIP
IS_ETH_BACKOFF_LIMIT
IS_ETH_DEFERRAL_CHECK
IS_ETH_RECEIVE_ALL
IS_ETH_SOURCE_ADDR_FILTER
IS_ETH_CONTROL_FRAMES
IS_ETH_BROADCAST_FRAMES_RECEPTION
IS_ETH_DESTINATION_ADDR_FILTER
IS_ETH_PROMISCUOUS_MODE
IS_ETH_MULTICAST_FRAMES_FILTER
IS_ETH_UNICAST_FRAMES_FILTER
IS_ETH_PAUSE_TIME
IS_ETH_ZEROQUANTA_PAUSE
IS_ETH_PAUSE_LOW_THRESHOLD
IS_ETH_UNICAST_PAUSE_FRAME_DETECT
IS_ETH_RECEIVE_FLOWCONTROL
IS_ETH_TRANSMIT_FLOWCONTROL
IS_ETH_VLAN_TAG_COMPARISON
IS_ETH_VLAN_TAG_IDENTIFIER
IS_ETH_MAC_ADDRESS0123
IS_ETH_MAC_ADDRESS123
IS_ETH_MAC_ADDRESS_FILTER
IS_ETH_MAC_ADDRESS_MASK
IS_ETH_DROP_TCPIP_CHECKSUM_FRAME
DOCID028236 Rev 1
251/692
HAL ETH Generic Driver
IS_ETH_RECEIVE_STORE_FORWARD
IS_ETH_FLUSH_RECEIVE_FRAME
IS_ETH_TRANSMIT_STORE_FORWARD
IS_ETH_TRANSMIT_THRESHOLD_CONTROL
IS_ETH_FORWARD_ERROR_FRAMES
IS_ETH_FORWARD_UNDERSIZED_GOOD_FRAMES
IS_ETH_RECEIVE_THRESHOLD_CONTROL
IS_ETH_SECOND_FRAME_OPERATE
IS_ETH_ADDRESS_ALIGNED_BEATS
IS_ETH_FIXED_BURST
IS_ETH_RXDMA_BURST_LENGTH
IS_ETH_TXDMA_BURST_LENGTH
IS_ETH_DMA_DESC_SKIP_LENGTH
IS_ETH_DMA_ARBITRATION_ROUNDROBIN_RXTX
IS_ETH_DMATXDESC_GET_FLAG
IS_ETH_DMA_TXDESC_SEGMENT
IS_ETH_DMA_TXDESC_CHECKSUM
IS_ETH_DMATXDESC_BUFFER_SIZE
IS_ETH_DMARXDESC_GET_FLAG
IS_ETH_DMA_RXDESC_BUFFER
IS_ETH_PMT_GET_FLAG
IS_ETH_DMA_FLAG
IS_ETH_DMA_GET_FLAG
IS_ETH_MAC_IT
IS_ETH_MAC_GET_IT
IS_ETH_MAC_GET_FLAG
IS_ETH_DMA_IT
IS_ETH_DMA_GET_IT
IS_ETH_DMA_GET_OVERFLOW
IS_ETH_MMC_IT
IS_ETH_MMC_GET_IT
IS_ETH_ENHANCED_DESCRIPTOR_FORMAT
ETH Promiscuous Mode
ETH_PROMISCUOUS_MODE_ENABLE
ETH_PROMISCUOUS_MODE_DISABLE
ETH Receive All
252/692
DOCID028236 Rev 1
UM1940
UM1940
HAL ETH Generic Driver
ETH_RECEIVEALL_ENABLE
ETH_RECEIVEAll_DISABLE
ETH Receive Flow Control
ETH_RECEIVEFLOWCONTROL_ENABLE
ETH_RECEIVEFLOWCONTROL_DISABLE
ETH Receive Own
ETH_RECEIVEOWN_ENABLE
ETH_RECEIVEOWN_DISABLE
ETH Receive Store Forward
ETH_RECEIVESTOREFORWARD_ENABLE
ETH_RECEIVESTOREFORWARD_DISABLE
ETH Receive Threshold Control
ETH_RECEIVEDTHRESHOLDCONTROL_64BYTES
threshold level of the MTL
Receive FIFO is 64 Bytes
ETH_RECEIVEDTHRESHOLDCONTROL_32BYTES
threshold level of the MTL
Receive FIFO is 32 Bytes
ETH_RECEIVEDTHRESHOLDCONTROL_96BYTES
threshold level of the MTL
Receive FIFO is 96 Bytes
ETH_RECEIVEDTHRESHOLDCONTROL_128BYTES
threshold level of the MTL
Receive FIFO is 128 Bytes
ETH Retry Transmission
ETH_RETRYTRANSMISSION_ENABLE
ETH_RETRYTRANSMISSION_DISABLE
ETH Rx DMA Burst Length
ETH_RXDMABURSTLENGTH_1BEAT
maximum number of beats to be
transferred in one RxDMA transaction
is 1
ETH_RXDMABURSTLENGTH_2BEAT
maximum number of beats to be
transferred in one RxDMA transaction
is 2
ETH_RXDMABURSTLENGTH_4BEAT
maximum number of beats to be
transferred in one RxDMA transaction
is 4
ETH_RXDMABURSTLENGTH_8BEAT
maximum number of beats to be
transferred in one RxDMA transaction
is 8
ETH_RXDMABURSTLENGTH_16BEAT
maximum number of beats to be
transferred in one RxDMA transaction
is 16
ETH_RXDMABURSTLENGTH_32BEAT
maximum number of beats to be
transferred in one RxDMA transaction
is 32
DOCID028236 Rev 1
253/692
HAL ETH Generic Driver
ETH_RXDMABURSTLENGTH_4XPBL_4BEAT
UM1940
maximum number of beats to be
transferred in one RxDMA transaction
is 4
ETH_RXDMABURSTLENGTH_4XPBL_8BEAT
maximum number of beats to be
transferred in one RxDMA transaction
is 8
ETH_RXDMABURSTLENGTH_4XPBL_16BEAT
maximum number of beats to be
transferred in one RxDMA transaction
is 16
ETH_RXDMABURSTLENGTH_4XPBL_32BEAT
maximum number of beats to be
transferred in one RxDMA transaction
is 32
ETH_RXDMABURSTLENGTH_4XPBL_64BEAT
maximum number of beats to be
transferred in one RxDMA transaction
is 64
ETH_RXDMABURSTLENGTH_4XPBL_128BEAT
maximum number of beats to be
transferred in one RxDMA transaction
is 128
ETH Rx Mode
ETH_RXPOLLING_MODE
ETH_RXINTERRUPT_MODE
ETH Second Frame Operate
ETH_SECONDFRAMEOPERARTE_ENABLE
ETH_SECONDFRAMEOPERARTE_DISABLE
ETH Source Addr Filter
ETH_SOURCEADDRFILTER_NORMAL_ENABLE
ETH_SOURCEADDRFILTER_INVERSE_ENABLE
ETH_SOURCEADDRFILTER_DISABLE
ETH Speed
ETH_SPEED_10M
ETH_SPEED_100M
ETH Transmit Flow Control
ETH_TRANSMITFLOWCONTROL_ENABLE
ETH_TRANSMITFLOWCONTROL_DISABLE
ETH Transmit Store Forward
ETH_TRANSMITSTOREFORWARD_ENABLE
ETH_TRANSMITSTOREFORWARD_DISABLE
ETH Transmit Threshold Control
254/692
ETH_TRANSMITTHRESHOLDCONTROL_64BYTES
threshold level of the MTL
Transmit FIFO is 64 Bytes
ETH_TRANSMITTHRESHOLDCONTROL_128BYTES
threshold level of the MTL
DOCID028236 Rev 1
UM1940
HAL ETH Generic Driver
Transmit FIFO is 128 Bytes
ETH_TRANSMITTHRESHOLDCONTROL_192BYTES
threshold level of the MTL
Transmit FIFO is 192 Bytes
ETH_TRANSMITTHRESHOLDCONTROL_256BYTES
threshold level of the MTL
Transmit FIFO is 256 Bytes
ETH_TRANSMITTHRESHOLDCONTROL_40BYTES
threshold level of the MTL
Transmit FIFO is 40 Bytes
ETH_TRANSMITTHRESHOLDCONTROL_32BYTES
threshold level of the MTL
Transmit FIFO is 32 Bytes
ETH_TRANSMITTHRESHOLDCONTROL_24BYTES
threshold level of the MTL
Transmit FIFO is 24 Bytes
ETH_TRANSMITTHRESHOLDCONTROL_16BYTES
threshold level of the MTL
Transmit FIFO is 16 Bytes
ETH Tx DMA Burst Length
ETH_TXDMABURSTLENGTH_1BEAT
maximum number of beats to be
transferred in one TxDMA (or both)
transaction is 1
ETH_TXDMABURSTLENGTH_2BEAT
maximum number of beats to be
transferred in one TxDMA (or both)
transaction is 2
ETH_TXDMABURSTLENGTH_4BEAT
maximum number of beats to be
transferred in one TxDMA (or both)
transaction is 4
ETH_TXDMABURSTLENGTH_8BEAT
maximum number of beats to be
transferred in one TxDMA (or both)
transaction is 8
ETH_TXDMABURSTLENGTH_16BEAT
maximum number of beats to be
transferred in one TxDMA (or both)
transaction is 16
ETH_TXDMABURSTLENGTH_32BEAT
maximum number of beats to be
transferred in one TxDMA (or both)
transaction is 32
ETH_TXDMABURSTLENGTH_4XPBL_4BEAT
maximum number of beats to be
transferred in one TxDMA (or both)
transaction is 4
ETH_TXDMABURSTLENGTH_4XPBL_8BEAT
maximum number of beats to be
transferred in one TxDMA (or both)
transaction is 8
ETH_TXDMABURSTLENGTH_4XPBL_16BEAT
maximum number of beats to be
transferred in one TxDMA (or both)
transaction is 16
ETH_TXDMABURSTLENGTH_4XPBL_32BEAT
maximum number of beats to be
transferred in one TxDMA (or both)
transaction is 32
ETH_TXDMABURSTLENGTH_4XPBL_64BEAT
maximum number of beats to be
transferred in one TxDMA (or both)
DOCID028236 Rev 1
255/692
HAL ETH Generic Driver
UM1940
transaction is 64
ETH_TXDMABURSTLENGTH_4XPBL_128BEAT
maximum number of beats to be
transferred in one TxDMA (or both)
transaction is 128
ETH Unicast Frames Filter
ETH_UNICASTFRAMESFILTER_PERFECTHASHTABLE
ETH_UNICASTFRAMESFILTER_HASHTABLE
ETH_UNICASTFRAMESFILTER_PERFECT
ETH Unicast Pause Frame Detect
ETH_UNICASTPAUSEFRAMEDETECT_ENABLE
ETH_UNICASTPAUSEFRAMEDETECT_DISABLE
ETH VLAN Tag Comparison
ETH_VLANTAGCOMPARISON_12BIT
ETH_VLANTAGCOMPARISON_16BIT
ETH Watchdog
ETH_WATCHDOG_ENABLE
ETH_WATCHDOG_DISABLE
ETH Zero Quanta Pause
ETH_ZEROQUANTAPAUSE_ENABLE
ETH_ZEROQUANTAPAUSE_DISABLE
256/692
DOCID028236 Rev 1
UM1940
HAL FLASH Generic Driver
16
HAL FLASH Generic Driver
16.1
FLASH Firmware driver registers structures
16.1.1
FLASH_ProcessTypeDef
Data Fields








__IO FLASH_ProcedureTypeDef ProcedureOnGoing
__IO uint32_t NbSectorsToErase
__IO uint8_t VoltageForErase
__IO uint32_t Sector
__IO uint32_t Bank
__IO uint32_t Address
HAL_LockTypeDef Lock
__IO uint32_t ErrorCode
Field Documentation








__IO FLASH_ProcedureTypeDef FLASH_ProcessTypeDef::ProcedureOnGoing
__IO uint32_t FLASH_ProcessTypeDef::NbSectorsToErase
__IO uint8_t FLASH_ProcessTypeDef::VoltageForErase
__IO uint32_t FLASH_ProcessTypeDef::Sector
__IO uint32_t FLASH_ProcessTypeDef::Bank
__IO uint32_t FLASH_ProcessTypeDef::Address
HAL_LockTypeDef FLASH_ProcessTypeDef::Lock
__IO uint32_t FLASH_ProcessTypeDef::ErrorCode
16.2
FLASH Firmware driver API description
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 and cache lines.
The FLASH main features are:






Flash memory read operations
Flash memory program/erase operations
Read / write protections
Prefetch on I-Code
64 cache lines of 128 bits on I-Code
8 cache lines of 128 bits on D-Code
DOCID028236 Rev 1
257/692
HAL FLASH Generic Driver
16.2.2
UM1940
How to use this driver
This driver provides functions and macros to configure and program the FLASH memory of
all STM32F2xx devices.
1.
2.
FLASH Memory IO Programming functions:

Lock and Unlock the FLASH interface using HAL_FLASH_Unlock() and
HAL_FLASH_Lock() functions

Program functions: byte, half word, word and double word

There Two modes of programming :

Polling mode using HAL_FLASH_Program() function

Interrupt mode using HAL_FLASH_Program_IT() function
Interrupts and flags management functions :

Handle FLASH interrupts by calling HAL_FLASH_IRQHandler()

Wait for last FLASH operation according to its status

Get error flag status by calling HAL_SetErrorCode()
In addition to these functions, 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 Instruction cache and the Data cache
Reset the Instruction cache and the Data cache
Enable/Disable the FLASH interrupts
Monitor the FLASH flags status
Programming operation functions
This subsection provides a set of functions allowing to manage the FLASH program
operations.
This section contains the following APIs:





16.2.4
HAL_FLASH_Program()
HAL_FLASH_Program_IT()
HAL_FLASH_IRQHandler()
HAL_FLASH_EndOfOperationCallback()
HAL_FLASH_OperationErrorCallback()
Peripheral Control functions
This subsection provides a set of functions allowing to control the FLASH memory
operations.
This section contains the following APIs:





16.2.5
HAL_FLASH_Unlock()
HAL_FLASH_Lock()
HAL_FLASH_OB_Unlock()
HAL_FLASH_OB_Lock()
HAL_FLASH_OB_Launch()
Peripheral Errors functions
This subsection permits to get in run-time Errors of the FLASH peripheral.
This section contains the following APIs:

258/692
HAL_FLASH_GetError()
DOCID028236 Rev 1
UM1940
HAL FLASH Generic Driver

16.2.6
FLASH_WaitForLastOperation()
HAL_FLASH_Program
Function Name
HAL_StatusTypeDef HAL_FLASH_Program (uint32_t
TypeProgram, uint32_t Address, uint64_t Data)
Function Description
Program byte, halfword, word or double word at a specified
address.
Parameters

Return values
16.2.7
16.2.9
16.2.10

HAL_StatusTypeDef HAL Status
HAL_FLASH_Program_IT
Function Name
HAL_StatusTypeDef HAL_FLASH_Program_IT (uint32_t
TypeProgram, uint32_t Address, uint64_t Data)
Function Description
Program byte, halfword, word or double word at a specified
address with interrupt enabled.
Parameters

Return values
16.2.8


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


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

HAL Status
HAL_FLASH_IRQHandler
Function Name
void HAL_FLASH_IRQHandler (void )
Function Description
This function handles FLASH interrupt request.
Return values

None
HAL_FLASH_EndOfOperationCallback
Function Name
void HAL_FLASH_EndOfOperationCallback (uint32_t
ReturnValue)
Function Description
FLASH end of operation interrupt callback.
Parameters

ReturnValue: The value saved in this parameter depends on
the ongoing procedure Mass Erase: Bank number which has
been requested to erase Sectors Erase: Sector which has
been erased (if 0xFFFFFFFF, it means that all the selected
sectors have been erased) Program: Address which was
selected for data program
Return values

None
HAL_FLASH_OperationErrorCallback
DOCID028236 Rev 1
259/692
HAL FLASH Generic Driver
Function Name
16.2.11
16.2.12
16.2.13
16.2.14
16.2.15
16.2.16
260/692
UM1940
void HAL_FLASH_OperationErrorCallback (uint32_t
ReturnValue)
Function Description
FLASH operation error interrupt callback.
Parameters

ReturnValue: The value saved in this parameter depends on
the ongoing procedure Mass Erase: Bank number which has
been requested to erase Sectors Erase: Sector number which
returned an error Program: Address which was selected for
data program
Return values

None
HAL_FLASH_Unlock
Function Name
HAL_StatusTypeDef HAL_FLASH_Unlock (void )
Function Description
Unlock the FLASH control register access.
Return values

HAL Status
HAL_FLASH_Lock
Function Name
HAL_StatusTypeDef HAL_FLASH_Lock (void )
Function Description
Locks the FLASH control register access.
Return values

HAL Status
HAL_FLASH_OB_Unlock
Function Name
HAL_StatusTypeDef HAL_FLASH_OB_Unlock (void )
Function Description
Unlock the FLASH Option Control Registers access.
Return values

HAL Status
HAL_FLASH_OB_Lock
Function Name
HAL_StatusTypeDef HAL_FLASH_OB_Lock (void )
Function Description
Lock the FLASH Option Control Registers access.
Return values

HAL Status
HAL_FLASH_OB_Launch
Function Name
HAL_StatusTypeDef HAL_FLASH_OB_Launch (void )
Function Description
Launch the option byte loading.
Return values

HAL Status
HAL_FLASH_GetError
Function Name
uint32_t HAL_FLASH_GetError (void )
Function Description
Get the specific FLASH error flag.
Return values

FLASH_ErrorCode The returned value can be a combination
of: HAL_FLASH_ERROR_NONE: FLASH Programming
Sequence error flag HAL_FLASH_ERROR_PGS: FLASH
DOCID028236 Rev 1
UM1940
16.2.17
HAL FLASH Generic Driver
Programming Sequence error flag
HAL_FLASH_ERROR_PGP: FLASH Programming
Parallelism error flag HAL_FLASH_ERROR_PGA: FLASH
Programming Alignment error flag
HAL_FLASH_ERROR_WRP: FLASH Write protected error
flag HAL_FLASH_ERROR_OPERATION: FLASH operation
Error flag
FLASH_WaitForLastOperation
Function Name
HAL_StatusTypeDef FLASH_WaitForLastOperation (uint32_t
Timeout)
Function Description
Wait for a FLASH operation to complete.
Parameters

Timeout: maximum flash operationtimeout
Return values

HAL Status
16.3
FLASH Firmware driver defines
16.3.1
FLASH
FLASH Error Code
HAL_FLASH_ERROR_NONE
No error
HAL_FLASH_ERROR_PGS
Programming Sequence error
HAL_FLASH_ERROR_PGP
Programming Parallelism error
HAL_FLASH_ERROR_PGA
Programming Alignment error
HAL_FLASH_ERROR_WRP
Write protection error
HAL_FLASH_ERROR_OPERATION
Operation Error
FLASH Exported Macros
__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:

__HAL_FLASH_GET_LATENCY
none
Description:

Get the FLASH Latency.
Return value:

DOCID028236 Rev 1
FLASH: Latency The value of this
parameter depend on device
used within the same series
261/692
HAL FLASH Generic Driver
__HAL_FLASH_PREFETCH_BUFFER_ENABLE
UM1940
Description:

Enable the FLASH prefetch
buffer.
Return value:

__HAL_FLASH_PREFETCH_BUFFER_DISABL
E
none
Description:

Disable the FLASH prefetch
buffer.
Return value:

__HAL_FLASH_INSTRUCTION_CACHE_ENAB
LE
none
Description:

Enable the FLASH instruction
cache.
Return value:

__HAL_FLASH_INSTRUCTION_CACHE_DISAB
LE
none
Description:

Disable the FLASH instruction
cache.
Return value:

__HAL_FLASH_DATA_CACHE_ENABLE
none
Description:

Enable the FLASH data cache.
Return value:

__HAL_FLASH_DATA_CACHE_DISABLE
none
Description:

Disable the FLASH data cache.
Return value:

__HAL_FLASH_INSTRUCTION_CACHE_RESE
T
none
Description:

Resets the FLASH instruction
Cache.
Return value:

None
Notes:

__HAL_FLASH_DATA_CACHE_RESET
262/692
DOCID028236 Rev 1
This function must be used only
when the Instruction Cache is
disabled.
Description:
UM1940
HAL FLASH Generic Driver

Resets the FLASH data Cache.
Return value:

None
Notes:

__HAL_FLASH_ENABLE_IT
This function must be used only
when the data Cache is disabled.
Description:

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:

none
Description:
__HAL_FLASH_GET_FLAG

Get the specified FLASH flag
status.
Parameters:

DOCID028236 Rev 1
__FLAG__: specifies the FLASH
flag to check. This parameter can
be one of the following values:

FLASH_FLAG_EOP :
FLASH End of Operation flag

FLASH_FLAG_OPERR :
263/692
HAL FLASH Generic Driver





UM1940
FLASH operation Error flag
FLASH_FLAG_WRPERR:
FLASH Write protected error
flag
FLASH_FLAG_PGAERR:
FLASH Programming
Alignment error flag
FLASH_FLAG_PGPERR:
FLASH Programming
Parallelism error flag
FLASH_FLAG_PGSERR:
FLASH Programming
Sequence 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_OPERR :
FLASH operation Error flag

FLASH_FLAG_WRPERR:
FLASH Write protected error
flag

FLASH_FLAG_PGAERR:
FLASH Programming
Alignment error flag

FLASH_FLAG_PGPERR:
FLASH Programming
Parallelism error flag

FLASH_FLAG_PGSERR:
FLASH Programming
Sequence error flag
Return value:

none
FLASH Flag definition
264/692
FLASH_FLAG_EOP
FLASH End of Operation flag
FLASH_FLAG_OPERR
FLASH operation Error flag
FLASH_FLAG_WRPERR
FLASH Write protected error flag
DOCID028236 Rev 1
UM1940
FLASH_FLAG_PGAERR
HAL FLASH Generic Driver
FLASH Programming Alignment error flag
FLASH_FLAG_PGPERR
FLASH Programming Parallelism error flag
FLASH_FLAG_PGSERR
FLASH Programming Sequence error flag
FLASH_FLAG_BSY
FLASH Busy flag
FLASH Interrupt definition
FLASH_IT_EOP
End of FLASH Operation Interrupt source
FLASH_IT_ERR
Error Interrupt source
FLASH Private macros to check input parameters
IS_FLASH_TYPEPROGRAM
FLASH Keys
RDP_KEY
FLASH_KEY1
FLASH_KEY2
FLASH_OPT_KEY1
FLASH_OPT_KEY2
FLASH Latency
FLASH_LATENCY_0
FLASH Zero Latency cycle
FLASH_LATENCY_1
FLASH One Latency cycle
FLASH_LATENCY_2
FLASH Two Latency cycles
FLASH_LATENCY_3
FLASH Three Latency cycles
FLASH_LATENCY_4
FLASH Four Latency cycles
FLASH_LATENCY_5
FLASH Five Latency cycles
FLASH_LATENCY_6
FLASH Six Latency cycles
FLASH_LATENCY_7
FLASH Seven Latency cycles
FLASH Private Constants
FLASH_TIMEOUT_VALUE
ACR_BYTE0_ADDRESS
OPTCR_BYTE0_ADDRESS
OPTCR_BYTE1_ADDRESS
OPTCR_BYTE2_ADDRESS
OPTCR_BYTE3_ADDRESS
FLASH Program Parallelism
FLASH_PSIZE_BYTE
FLASH_PSIZE_HALF_WORD
FLASH_PSIZE_WORD
FLASH_PSIZE_DOUBLE_WORD
DOCID028236 Rev 1
265/692
HAL FLASH Generic Driver
CR_PSIZE_MASK
UM1940
FLASH Type Program
266/692
FLASH_TYPEPROGRAM_BYTE
Program byte (8-bit) at a specified address
FLASH_TYPEPROGRAM_HALFWORD
Program a half-word (16-bit) at a specified
address
FLASH_TYPEPROGRAM_WORD
Program a word (32-bit) at a specified
address
FLASH_TYPEPROGRAM_DOUBLEWORD
Program a double word (64-bit) at a
specified address
DOCID028236 Rev 1
UM1940
HAL FLASH Extension Driver
17
HAL FLASH Extension Driver
17.1
FLASHEx Firmware driver registers structures
17.1.1
FLASH_EraseInitTypeDef
Data Fields





uint32_t TypeErase
uint32_t Banks
uint32_t Sector
uint32_t NbSectors
uint32_t VoltageRange
Field Documentation





17.1.2
uint32_t FLASH_EraseInitTypeDef::TypeErase
Mass erase or sector Erase. This parameter can be a value of
FLASHEx_Type_Erase
uint32_t FLASH_EraseInitTypeDef::Banks
Select banks to erase when Mass erase is enabled. This parameter must be a value
of FLASHEx_Banks
uint32_t FLASH_EraseInitTypeDef::Sector
Initial FLASH sector to erase when Mass erase is disabled This parameter must be a
value of FLASHEx_Sectors
uint32_t FLASH_EraseInitTypeDef::NbSectors
Number of sectors to be erased. This parameter must be a value between 1 and (max
number of sectors - value of Initial sector)
uint32_t FLASH_EraseInitTypeDef::VoltageRange
The device voltage range which defines the erase parallelism This parameter must be
a value of FLASHEx_Voltage_Range
FLASH_OBProgramInitTypeDef
Data Fields







uint32_t OptionType
uint32_t WRPState
uint32_t WRPSector
uint32_t Banks
uint32_t RDPLevel
uint32_t BORLevel
uint8_t USERConfig
Field Documentation
DOCID028236 Rev 1
267/692
HAL FLASH Extension Driver







UM1940
uint32_t FLASH_OBProgramInitTypeDef::OptionType
Option byte to be configured. This parameter can be a value of
FLASHEx_Option_Type
uint32_t FLASH_OBProgramInitTypeDef::WRPState
Write protection activation or deactivation. This parameter can be a value of
FLASHEx_WRP_State
uint32_t FLASH_OBProgramInitTypeDef::WRPSector
Specifies the sector(s) to be write protected. The value of this parameter depend on
device used within the same series
uint32_t FLASH_OBProgramInitTypeDef::Banks
Select banks for WRP activation/deactivation of all sectors. This parameter must be a
value of FLASHEx_Banks
uint32_t FLASH_OBProgramInitTypeDef::RDPLevel
Set the read protection level. This parameter can be a value of
FLASHEx_Option_Bytes_Read_Protection
uint32_t FLASH_OBProgramInitTypeDef::BORLevel
Set the BOR Level. This parameter can be a value of FLASHEx_BOR_Reset_Level
uint8_t FLASH_OBProgramInitTypeDef::USERConfig
Program the FLASH User Option Byte: IWDG_SW / RST_STOP / RST_STDBY.
17.2
FLASHEx Firmware driver API description
17.2.1
Flash Extension features
17.2.2
How to use this driver
This driver provides functions to configure and program the FLASH memory of all
STM32F2xx devices. It includes
1.
2.
17.2.3
FLASH Memory Erase functions:

Lock and Unlock the FLASH interface using HAL_FLASH_Unlock() and
HAL_FLASH_Lock() functions

Erase function: Erase sector, erase all sectors

There are two modes of erase :

Polling Mode using HAL_FLASHEx_Erase()

Interrupt Mode using HAL_FLASHEx_Erase_IT()
Option Bytes Programming functions: Use HAL_FLASHEx_OBProgram() to :

Set/Reset the write protection

Set the Read protection Level

Set the BOR level

Program the user Option Bytes
Extended programming operation functions
This subsection provides a set of functions allowing to manage the Extension FLASH
programming operations.
This section contains the following APIs:




17.2.4
268/692
HAL_FLASHEx_Erase()
HAL_FLASHEx_Erase_IT()
HAL_FLASHEx_OBProgram()
HAL_FLASHEx_OBGetConfig()
HAL_FLASHEx_Erase
DOCID028236 Rev 1
UM1940
Function Name
HAL FLASH Extension Driver
HAL_StatusTypeDef HAL_FLASHEx_Erase
(FLASH_EraseInitTypeDef * pEraseInit, uint32_t * SectorError)
Function Description
Perform a mass erase or erase the specified FLASH memory
sectors.
Parameters


Return values
17.2.5
17.2.6
17.2.7

pEraseInit: pointer to an FLASH_EraseInitTypeDef structure
that contains the configuration information for the erasing.
SectorError: pointer to variable that contains the
configuration information on faulty sector in case of error
(0xFFFFFFFF means that all the sectors have been correctly
erased)
HAL Status
HAL_FLASHEx_Erase_IT
Function Name
HAL_StatusTypeDef HAL_FLASHEx_Erase_IT
(FLASH_EraseInitTypeDef * pEraseInit)
Function Description
Perform a mass erase or erase the specified FLASH memory
sectors with interrupt enabled.
Parameters

pEraseInit: pointer to an FLASH_EraseInitTypeDef structure
that contains the configuration information for the erasing.
Return values

HAL Status
HAL_FLASHEx_OBProgram
Function Name
HAL_StatusTypeDef HAL_FLASHEx_OBProgram
(FLASH_OBProgramInitTypeDef * pOBInit)
Function Description
Program option bytes.
Parameters

pOBInit: pointer to an FLASH_OBInitStruct structure that
contains the configuration information for the programming.
Return values

HAL Status
HAL_FLASHEx_OBGetConfig
Function Name
void HAL_FLASHEx_OBGetConfig
(FLASH_OBProgramInitTypeDef * pOBInit)
Function Description
Get the Option byte configuration.
Parameters

pOBInit: pointer to an FLASH_OBInitStruct structure that
contains the configuration information for the programming.
Return values

None
17.3
FLASHEx Firmware driver defines
17.3.1
FLASHEx
FLASH Banks
FLASH_BANK_1
Bank 1
FLASH BOR Reset Level
DOCID028236 Rev 1
269/692
HAL FLASH Extension Driver
OB_BOR_LEVEL3
Supply voltage ranges from 2.70 to 3.60 V
UM1940
OB_BOR_LEVEL2
Supply voltage ranges from 2.40 to 2.70 V
OB_BOR_LEVEL1
Supply voltage ranges from 2.10 to 2.40 V
OB_BOR_OFF
Supply voltage ranges from 1.62 to 2.10 V
FLASH Private macros to check input parameters
IS_FLASH_TYPEERASE
IS_VOLTAGERANGE
IS_WRPSTATE
IS_OPTIONBYTE
IS_OB_RDP_LEVEL
IS_OB_IWDG_SOURCE
IS_OB_STOP_SOURCE
IS_OB_STDBY_SOURCE
IS_OB_BOR_LEVEL
IS_FLASH_LATENCY
IS_FLASH_BANK
IS_FLASH_SECTOR
IS_FLASH_ADDRESS
IS_FLASH_NBSECTORS
IS_OB_WRP_SECTOR
FLASH Mass Erase bit
FLASH_MER_BIT
only 1 MER Bit
FLASH Option Bytes IWatchdog
OB_IWDG_SW
Software IWDG selected
OB_IWDG_HW
Hardware IWDG selected
FLASH Option Bytes nRST_STDBY
OB_STDBY_NO_RST
No reset generated when entering in STANDBY
OB_STDBY_RST
Reset generated when entering in STANDBY
FLASH Option Bytes nRST_STOP
OB_STOP_NO_RST
No reset generated when entering in STOP
OB_STOP_RST
Reset generated when entering in STOP
FLASH Option Bytes 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
FLASH Option Bytes Write Protection
270/692
DOCID028236 Rev 1
UM1940
HAL FLASH Extension Driver
OB_WRP_SECTOR_0
Write protection of Sector0
OB_WRP_SECTOR_1
Write protection of Sector1
OB_WRP_SECTOR_2
Write protection of Sector2
OB_WRP_SECTOR_3
Write protection of Sector3
OB_WRP_SECTOR_4
Write protection of Sector4
OB_WRP_SECTOR_5
Write protection of Sector5
OB_WRP_SECTOR_6
Write protection of Sector6
OB_WRP_SECTOR_7
Write protection of Sector7
OB_WRP_SECTOR_8
Write protection of Sector8
OB_WRP_SECTOR_9
Write protection of Sector9
OB_WRP_SECTOR_10
Write protection of Sector10
OB_WRP_SECTOR_11
Write protection of Sector11
OB_WRP_SECTOR_All
Write protection of all Sectors
FLASH Option Type
OPTIONBYTE_WRP
WRP option byte configuration
OPTIONBYTE_RDP
RDP option byte configuration
OPTIONBYTE_USER
USER option byte configuration
OPTIONBYTE_BOR
BOR option byte configuration
FLASH Private Constants
FLASH_TIMEOUT_VALUE
FLASH_SECTOR_TOTAL
FLASH Sectors
FLASH_SECTOR_0
Sector Number 0
FLASH_SECTOR_1
Sector Number 1
FLASH_SECTOR_2
Sector Number 2
FLASH_SECTOR_3
Sector Number 3
FLASH_SECTOR_4
Sector Number 4
FLASH_SECTOR_5
Sector Number 5
FLASH_SECTOR_6
Sector Number 6
FLASH_SECTOR_7
Sector Number 7
FLASH_SECTOR_8
Sector Number 8
FLASH_SECTOR_9
Sector Number 9
FLASH_SECTOR_10
Sector Number 10
FLASH_SECTOR_11
Sector Number 11
FLASH Type Erase
FLASH_TYPEERASE_SECTORS
Sectors erase only
DOCID028236 Rev 1
271/692
HAL FLASH Extension Driver
FLASH_TYPEERASE_MASSERASE
UM1940
Flash Mass erase activation
FLASH Voltage Range
FLASH_VOLTAGE_RANGE_1
Device operating range: 1.8V to 2.1V
FLASH_VOLTAGE_RANGE_2
Device operating range: 2.1V to 2.7V
FLASH_VOLTAGE_RANGE_3
Device operating range: 2.7V to 3.6V
FLASH_VOLTAGE_RANGE_4
Device operating range: 2.7V to 3.6V + External Vpp
FLASH WRP State
272/692
OB_WRPSTATE_DISABLE
Disable the write protection of the desired bank 1 sectors
OB_WRPSTATE_ENABLE
Enable the write protection of the desired bank 1 sectors
DOCID028236 Rev 1
UM1940
HAL GPIO Generic Driver
18
HAL GPIO Generic Driver
18.1
GPIO Firmware driver registers structures
18.1.1
GPIO_InitTypeDef
Data Fields





uint32_t Pin
uint32_t Mode
uint32_t Pull
uint32_t Speed
uint32_t Alternate
Field Documentation





uint32_t GPIO_InitTypeDef::Pin
Specifies the GPIO pins to be configured. This parameter can be any value of
GPIO_pins_define
uint32_t GPIO_InitTypeDef::Mode
Specifies the operating mode for the selected pins. This parameter can be a value of
GPIO_mode_define
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_define
uint32_t GPIO_InitTypeDef::Speed
Specifies the speed for the selected pins. This parameter can be a value of
GPIO_speed_define
uint32_t GPIO_InitTypeDef::Alternate
Peripheral to be connected to the selected pins. This parameter can be a value of
GPIO_Alternate_function_selection
18.2
GPIO Firmware driver API description
18.2.1
GPIO Peripheral features
Subject to the specific hardware characteristics of each I/O port listed in the datasheet,
each port bit of the General Purpose IO (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.
DOCID028236 Rev 1
273/692
HAL GPIO Generic Driver
UM1940
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.
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 23 edge detectors (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
How to use this driver
1.
2.
3.
4.
5.
6.
7.
8.
9.
18.2.3
Enable the GPIO AHB clock using the following function:
__HAL_RCC_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.

In alternate mode is selection, 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).
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().
To get the level of a pin configured in input mode use HAL_GPIO_ReadPin().
To set/reset the level of a pin configured in output mode use
HAL_GPIO_WritePin()/HAL_GPIO_TogglePin().
To lock pin configuration until next reset use HAL_GPIO_LockPin().
During and just after reset, the alternate functions are not active and the GPIO pins
are configured in input floating mode (except JTAG pins).
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.
The HSE oscillator pins OSC_IN/OSC_OUT can be used as general purpose PH0
and PH1, respectively, when the HSE oscillator is off. The HSE has priority over the
GPIO function.
Initialization and de-initialization functions
This section provides functions allowing to initialize and de-initialize the GPIOs to be ready
for use.
This section contains the following APIs:


274/692
HAL_GPIO_Init()
HAL_GPIO_DeInit()
DOCID028236 Rev 1
UM1940
18.2.4
HAL GPIO Generic Driver
IO operation functions
This section contains the following APIs:






18.2.5
18.2.6
18.2.7
18.2.8
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)
Function Description
Initializes the GPIOx peripheral according to the specified
parameters in the GPIO_Init.
Parameters


GPIOx: where x can be (A..I) to select the GPIO peripheral.
GPIO_Init: pointer to a GPIO_InitTypeDef structure that
contains the configuration information for the specified GPIO
peripheral.
Return values

None
HAL_GPIO_DeInit
Function Name
void HAL_GPIO_DeInit (GPIO_TypeDef * GPIOx, uint32_t
GPIO_Pin)
Function Description
De-initializes the GPIOx peripheral registers to their default reset
values.
Parameters


GPIOx: where x can be (A..I) to select the GPIO peripheral.
GPIO_Pin: specifies the port bit to be written. This parameter
can be one of GPIO_PIN_x where x can be (0..15).
Return values

None
HAL_GPIO_ReadPin
Function Name
GPIO_PinState HAL_GPIO_ReadPin (GPIO_TypeDef * GPIOx,
uint16_t GPIO_Pin)
Function Description
Reads the specified input port pin.
Parameters


GPIOx: where x can be (A..I) to select the GPIO peripheral.
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.
HAL_GPIO_WritePin
Function Name
void HAL_GPIO_WritePin (GPIO_TypeDef * GPIOx, uint16_t
GPIO_Pin, GPIO_PinState PinState)
Function Description
Sets or clears the selected data port bit.
DOCID028236 Rev 1
275/692
HAL GPIO Generic Driver
Parameters
UM1940


GPIOx: where x can be (A..I) to select the GPIO peripheral
for all STM32F2XX devices
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
pinGPIO_PIN_SET: to set the port pin
Return values

None
Notes

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.

18.2.9
18.2.10
HAL_GPIO_TogglePin
Function Name
void HAL_GPIO_TogglePin (GPIO_TypeDef * GPIOx, uint16_t
GPIO_Pin)
Function Description
Toggles the specified GPIO pins.
Parameters


GPIOx: where x can be (A..I) to select the GPIO peripheral.
GPIO_Pin: Specifies the pins to be toggled.
Return values

None
HAL_GPIO_LockPin
Function Name
HAL_StatusTypeDef HAL_GPIO_LockPin (GPIO_TypeDef *
GPIOx, uint16_t GPIO_Pin)
Function Description
Locks GPIO Pins configuration registers.
Parameters


GPIOx: where x can be (A..I) to select the GPIO peripheral
for STM32F2XX family
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
modified until the next reset.

18.2.11
18.2.12
276/692
HAL_GPIO_EXTI_IRQHandler
Function Name
void HAL_GPIO_EXTI_IRQHandler (uint16_t GPIO_Pin)
Function Description
This function handles EXTI interrupt request.
Parameters

GPIO_Pin: Specifies the pins connected EXTI line
Return values

None
HAL_GPIO_EXTI_Callback
DOCID028236 Rev 1
UM1940
Function Name
HAL GPIO Generic Driver
void HAL_GPIO_EXTI_Callback (uint16_t GPIO_Pin)
Function Description
EXTI line detection callbacks.
Parameters

GPIO_Pin: Specifies the pins connected EXTI line
Return values

None
18.3
GPIO Firmware driver defines
18.3.1
GPIO
GPIO Alternate function selection
GPIO_AF0_RTC_50Hz
GPIO_AF0_MCO
GPIO_AF0_TAMPER
GPIO_AF0_SWJ
GPIO_AF0_TRACE
GPIO_AF1_TIM1
GPIO_AF1_TIM2
GPIO_AF2_TIM3
GPIO_AF2_TIM4
GPIO_AF2_TIM5
GPIO_AF3_TIM8
GPIO_AF3_TIM9
GPIO_AF3_TIM10
GPIO_AF3_TIM11
GPIO_AF4_I2C1
GPIO_AF4_I2C2
GPIO_AF4_I2C3
GPIO_AF5_SPI1
GPIO_AF5_SPI2
GPIO_AF6_SPI3
GPIO_AF7_USART1
GPIO_AF7_USART2
GPIO_AF7_USART3
GPIO_AF8_UART4
GPIO_AF8_UART5
GPIO_AF8_USART6
GPIO_AF9_CAN1
GPIO_AF9_CAN2
DOCID028236 Rev 1
277/692
HAL GPIO Generic Driver
GPIO_AF9_TIM12
UM1940
GPIO_AF9_TIM13
GPIO_AF9_TIM14
GPIO_AF10_OTG_FS
GPIO_AF10_OTG_HS
GPIO_AF11_ETH
GPIO_AF12_FSMC
GPIO_AF12_OTG_HS_FS
GPIO_AF12_SDIO
GPIO_AF13_DCMI
GPIO_AF15_EVENTOUT
GPIO Exported Macros
__HAL_GPIO_EXTI_GET_FLAG
Description:

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
GPIO_PIN_x where x can be(0..15)
Return value:

278/692
The: new state of __EXTI_LINE__ (SET or
DOCID028236 Rev 1
UM1940
HAL GPIO Generic Driver
RESET).
__HAL_GPIO_EXTI_CLEAR_IT
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:

__EXTI_LINE__: specifies the EXTI line to
check. This parameter can be
GPIO_PIN_x where x can be(0..15)
Return value:

None
GPIO mode define
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
GPIO pins define
GPIO_PIN_0
DOCID028236 Rev 1
279/692
HAL GPIO Generic Driver
GPIO_PIN_1
UM1940
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
GPIO_PIN_13
GPIO_PIN_14
GPIO_PIN_15
GPIO_PIN_All
GPIO_PIN_MASK
GPIO Private Constants
GPIO_MODE
EXTI_MODE
GPIO_MODE_IT
GPIO_MODE_EVT
RISING_EDGE
FALLING_EDGE
GPIO_OUTPUT_TYPE
GPIO_NUMBER
GPIO Private Macros
IS_GPIO_PIN_ACTION
IS_GPIO_PIN
IS_GPIO_MODE
IS_GPIO_SPEED
IS_GPIO_PULL
GPIO pull define
GPIO_NOPULL
No Pull-up or Pull-down activation
GPIO_PULLUP
Pull-up activation
GPIO_PULLDOWN
Pull-down activation
GPIO speed define
280/692
DOCID028236 Rev 1
UM1940
HAL GPIO Generic Driver
IO works at 2 MHz, please refer to the product
datasheet
GPIO_SPEED_FREQ_LOW
GPIO_SPEED_FREQ_MEDIUM
range 12,5 MHz to 50 MHz, please refer to the
product datasheet
GPIO_SPEED_FREQ_HIGH
range 25 MHz to 100 MHz, please refer to the
product datasheet
GPIO_SPEED_FREQ_VERY_HIGH
range 50 MHz to 200 MHz, please refer to the
product datasheet
DOCID028236 Rev 1
281/692
HAL GPIO Extension Driver
UM1940
19
HAL GPIO Extension Driver
19.1
GPIOEx Firmware driver defines
19.1.1
GPIOEx
GPIO Get Port Index
GPIO_GET_INDEX
GPIO Check Alternate Function
IS_GPIO_AF
282/692
DOCID028236 Rev 1
UM1940
HAL HASH Generic Driver
20
HAL HASH Generic Driver
20.1
HASH Firmware driver registers structures
20.1.1
HASH_InitTypeDef
Data Fields



uint32_t DataType
uint32_t KeySize
uint8_t * pKey
Field Documentation



20.1.2
uint32_t HASH_InitTypeDef::DataType
32-bit data, 16-bit data, 8-bit data or 1-bit string. This parameter can be a value of
HASH_Data_Type
uint32_t HASH_InitTypeDef::KeySize
The key size is used only in HMAC operation
uint8_t* HASH_InitTypeDef::pKey
The key is used only in HMAC operation
HASH_HandleTypeDef
Data Fields











HASH_InitTypeDef Init
uint8_t * pHashInBuffPtr
uint8_t * pHashOutBuffPtr
__IO uint32_t HashBuffSize
__IO uint32_t HashInCount
__IO uint32_t HashITCounter
HAL_StatusTypeDef Status
HAL_HASHPhaseTypeDef Phase
DMA_HandleTypeDef * hdmain
HAL_LockTypeDef Lock
__IO HAL_HASH_STATETypeDef State
Field Documentation



HASH_InitTypeDef HASH_HandleTypeDef::Init
HASH required parameters
uint8_t* HASH_HandleTypeDef::pHashInBuffPtr
Pointer to input buffer
uint8_t* HASH_HandleTypeDef::pHashOutBuffPtr
Pointer to input buffer
DOCID028236 Rev 1
283/692
HAL HASH Generic Driver








UM1940
__IO uint32_t HASH_HandleTypeDef::HashBuffSize
Size of buffer to be processed
__IO uint32_t HASH_HandleTypeDef::HashInCount
Counter of input data
__IO uint32_t HASH_HandleTypeDef::HashITCounter
Counter of issued interrupts
HAL_StatusTypeDef HASH_HandleTypeDef::Status
HASH peripheral status
HAL_HASHPhaseTypeDef HASH_HandleTypeDef::Phase
HASH peripheral phase
DMA_HandleTypeDef* HASH_HandleTypeDef::hdmain
HASH In DMA handle parameters
HAL_LockTypeDef HASH_HandleTypeDef::Lock
HASH locking object
__IO HAL_HASH_STATETypeDef HASH_HandleTypeDef::State
HASH peripheral state
20.2
HASH Firmware driver API description
20.2.1
How to use this driver
The HASH HAL driver can be used as follows:
1.
2.
3.
284/692
Initialize the HASH low level resources by implementing the HAL_HASH_MspInit():
a.
Enable the HASH interface clock using __HAL_RCC_HASH_CLK_ENABLE()
b.
In case of using processing APIs based on interrupts (e.g.
HAL_HMAC_SHA1_Start_IT())

Configure the HASH interrupt priority using HAL_NVIC_SetPriority()

Enable the HASH IRQ handler using HAL_NVIC_EnableIRQ()

In HASH IRQ handler, call HAL_HASH_IRQHandler()
c.
In case of using DMA to control data transfer (e.g.
HAL_HMAC_SHA1_Start_DMA())

Enable the DMAx interface clock using __DMAx_CLK_ENABLE()

Configure and enable one DMA stream one for managing data transfer from
memory to peripheral (input stream). Managing data transfer from peripheral
to memory can be performed only using CPU

Associate the initialized DMA handle to the HASH DMA handle using
__HAL_LINKDMA()

Configure the priority and enable the NVIC for the transfer complete
interrupt on the DMA Stream using HAL_NVIC_SetPriority() and
HAL_NVIC_EnableIRQ()
Initialize the HASH HAL using HAL_HASH_Init(). This function configures mainly:
a.
The data type: 1-bit, 8-bit, 16-bit and 32-bit.
b.
For HMAC, the encryption key.
c.
For HMAC, the key size used for encryption.
Three processing functions are available:
a.
Polling mode: processing APIs are blocking functions i.e. they process the data
and wait till the digest computation is finished e.g. HAL_HASH_SHA1_Start()
b.
Interrupt mode: encryption and decryption APIs are not blocking functions i.e.
they process the data under interrupt e.g. HAL_HASH_SHA1_Start_IT()
c.
DMA mode: processing APIs are not blocking functions and the CPU is not used
for data transfer i.e. the data transfer is ensured by DMA e.g.
HAL_HASH_SHA1_Start_DMA()
DOCID028236 Rev 1
UM1940
4.
5.
6.
7.
20.2.2
HAL HASH Generic Driver
When the processing function is called at first time after HAL_HASH_Init() the HASH
peripheral is initialized and processes the buffer in input. After that, the digest
computation is started. When processing multi-buffer use the accumulate function to
write the data in the peripheral without starting the digest computation. In last buffer
use the start function to input the last buffer ans start the digest computation.
a.
e.g. HAL_HASH_SHA1_Accumulate() : write 1st data buffer in the peripheral
without starting the digest computation
b.
write (n-1)th data buffer in the peripheral without starting the digest computation
c.
HAL_HASH_SHA1_Start() : write (n)th data buffer in the peripheral and start the
digest computation
In HMAC mode, there is no Accumulate API. Only Start API is available.
In case of using DMA, call the DMA start processing e.g.
HAL_HASH_SHA1_Start_DMA(). After that, call the finish function in order to get the
digest value e.g. HAL_HASH_SHA1_Finish()
Call HAL_HASH_DeInit() to deinitialize the HASH peripheral.
HASH processing using polling mode functions
This section provides functions allowing to calculate in polling mode the hash value using
one of the following algorithms:


MD5
SHA1
This section contains the following APIs:




20.2.3
HAL_HASH_MD5_Start()
HAL_HASH_MD5_Accumulate()
HAL_HASH_SHA1_Start()
HAL_HASH_SHA1_Accumulate()
HASH processing using interrupt mode functions
This section provides functions allowing to calculate in interrupt mode the hash value using
one of the following algorithms:


MD5
SHA1
This section contains the following APIs:





20.2.4
HAL_HASH_MD5_Start_IT()
HAL_HASH_SHA1_Start_IT()
HAL_HASH_IRQHandler()
HAL_HMAC_SHA1_Start()
HAL_HMAC_MD5_Start()
HASH processing using DMA mode functions
This section provides functions allowing to calculate in DMA mode the hash value using
one of the following algorithms:


MD5
SHA1
This section contains the following APIs:



HAL_HASH_MD5_Start_DMA()
HAL_HASH_MD5_Finish()
HAL_HASH_SHA1_Start_DMA()
DOCID028236 Rev 1
285/692
HAL HASH Generic Driver



20.2.5
UM1940
HAL_HASH_SHA1_Finish()
HAL_HASH_SHA1_Start_IT()
HAL_HASH_MD5_Start_IT()
HMAC processing using polling mode functions
This section provides functions allowing to calculate in polling mode the HMAC value using
one of the following algorithms:


MD5
SHA1
This section contains the following APIs:






20.2.6
HAL_HMAC_MD5_Start()
HAL_HMAC_SHA1_Start()
HAL_HASH_SHA1_Start_DMA()
HAL_HASH_SHA1_Finish()
HAL_HASH_MD5_Start_DMA()
HAL_HASH_MD5_Finish()
HMAC processing using DMA mode functions
This section provides functions allowing to calculate in DMA mode the HMAC value using
one of the following algorithms:


MD5
SHA1
This section contains the following APIs:


20.2.7
HAL_HMAC_MD5_Start_DMA()
HAL_HMAC_SHA1_Start_DMA()
Peripheral State functions
This subsection permits to get in run-time the status of the peripheral.
This section contains the following APIs:


20.2.8
HAL_HASH_GetState()
HAL_HASH_IRQHandler()
Initialization and de-initialization functions
This section provides functions allowing to:




Initialize the HASH according to the specified parameters in the HASH_InitTypeDef
and creates the associated handle.
DeInitialize the HASH peripheral.
Initialize the HASH MSP.
DeInitialize HASH MSP.
This section contains the following APIs:






286/692
HAL_HASH_Init()
HAL_HASH_DeInit()
HAL_HASH_MspInit()
HAL_HASH_MspDeInit()
HAL_HASH_InCpltCallback()
HAL_HASH_ErrorCallback()
DOCID028236 Rev 1
UM1940
HAL HASH Generic Driver

20.2.9
HAL_HASH_DgstCpltCallback()
HAL_HASH_MD5_Start
Function Name
HAL_StatusTypeDef HAL_HASH_MD5_Start
(HASH_HandleTypeDef * hhash, uint8_t * pInBuffer, uint32_t
Size, uint8_t * pOutBuffer, uint32_t Timeout)
Function Description
Initializes the HASH peripheral in MD5 mode then processes
pInBuffer.
Parameters


hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pInBuffer: Pointer to the input buffer (buffer to be hashed).
Size: Length of the input buffer in bytes. If the Size is multiple
of 64 bytes, appending the input buffer is possible. If the Size
is not multiple of 64 bytes, the padding is managed by
hardware and appending the input buffer is no more possible.
pOutBuffer: Pointer to the computed digest. Its size must be
16 bytes.
Timeout: Timeout value

HAL status



Return values
20.2.10
HAL_HASH_MD5_Accumulate
Function Name
HAL_StatusTypeDef HAL_HASH_MD5_Accumulate
(HASH_HandleTypeDef * hhash, uint8_t * pInBuffer, uint32_t
Size)
Function Description
Initializes the HASH peripheral in MD5 mode then writes the
pInBuffer.
Parameters



Return values
20.2.11

hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pInBuffer: Pointer to the input buffer (buffer to be hashed).
Size: Length of the input buffer in bytes. If the Size is multiple
of 64 bytes, appending the input buffer is possible. If the Size
is not multiple of 64 bytes, the padding is managed by
hardware and appending the input buffer is no more possible.
HAL status
HAL_HASH_SHA1_Start
Function Name
HAL_StatusTypeDef HAL_HASH_SHA1_Start
(HASH_HandleTypeDef * hhash, uint8_t * pInBuffer, uint32_t
Size, uint8_t * pOutBuffer, uint32_t Timeout)
Function Description
Initializes the HASH peripheral in SHA1 mode then processes
pInBuffer.
Parameters




hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pInBuffer: Pointer to the input buffer (buffer to be hashed).
Size: Length of the input buffer in bytes. If the Size is not
multiple of 64 bytes, the padding is managed by hardware.
pOutBuffer: Pointer to the computed digest. Its size must be
20 bytes.
DOCID028236 Rev 1
287/692
HAL HASH Generic Driver
Return values
20.2.12
20.2.13
UM1940

Timeout: Timeout value

HAL status
HAL_HASH_SHA1_Accumulate
Function Name
HAL_StatusTypeDef HAL_HASH_SHA1_Accumulate
(HASH_HandleTypeDef * hhash, uint8_t * pInBuffer, uint32_t
Size)
Function Description
Initializes the HASH peripheral in SHA1 mode then processes
pInBuffer.
Parameters



hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pInBuffer: Pointer to the input buffer (buffer to be hashed).
Size: Length of the input buffer in bytes. If the Size is not
multiple of 64 bytes, the padding is managed by hardware.
Return values

HAL status
Notes

Input buffer size in bytes must be a multiple of 4 otherwise the
digest computation is corrupted.
HAL_HASH_MD5_Start_IT
Function Name
HAL_StatusTypeDef HAL_HASH_MD5_Start_IT
(HASH_HandleTypeDef * hhash, uint8_t * pInBuffer, uint32_t
Size, uint8_t * pOutBuffer)
Function Description
Initializes the HASH peripheral in MD5 mode then processes
pInBuffer.
Parameters




Return values
20.2.14

HAL status
HAL_HASH_SHA1_Start_IT
Function Name
HAL_StatusTypeDef HAL_HASH_SHA1_Start_IT
(HASH_HandleTypeDef * hhash, uint8_t * pInBuffer, uint32_t
Size, uint8_t * pOutBuffer)
Function Description
Initializes the HASH peripheral in SHA1 mode then processes
pInBuffer.
Parameters




288/692
hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pInBuffer: Pointer to the input buffer (buffer to be hashed).
Size: Length of the input buffer in bytes. If the Size is not
multiple of 64 bytes, the padding is managed by hardware.
pOutBuffer: Pointer to the computed digest. Its size must be
16 bytes.
hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pInBuffer: Pointer to the input buffer (buffer to be hashed).
Size: Length of the input buffer in bytes. If the Size is not
multiple of 64 bytes, the padding is managed by hardware.
pOutBuffer: Pointer to the computed digest. Its size must be
20 bytes.
DOCID028236 Rev 1
UM1940
HAL HASH Generic Driver
Return values
20.2.15
20.2.16

HAL_HASH_IRQHandler
Function Name
void HAL_HASH_IRQHandler (HASH_HandleTypeDef * hhash)
Function Description
This function handles HASH interrupt request.
Parameters

hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
Return values

None
HAL_HMAC_SHA1_Start
Function Name
HAL_StatusTypeDef HAL_HMAC_SHA1_Start
(HASH_HandleTypeDef * hhash, uint8_t * pInBuffer, uint32_t
Size, uint8_t * pOutBuffer, uint32_t Timeout)
Function Description
Initializes the HASH peripheral in HMAC SHA1 mode then
processes pInBuffer.
Parameters


hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pInBuffer: Pointer to the input buffer (buffer to be hashed).
Size: Length of the input buffer in bytes. If the Size is not
multiple of 64 bytes, the padding is managed by hardware.
pOutBuffer: Pointer to the computed digest. Its size must be
20 bytes.
Timeout: Timeout value

HAL status



Return values
20.2.17
HAL_HMAC_MD5_Start
Function Name
HAL_StatusTypeDef HAL_HMAC_MD5_Start
(HASH_HandleTypeDef * hhash, uint8_t * pInBuffer, uint32_t
Size, uint8_t * pOutBuffer, uint32_t Timeout)
Function Description
Initializes the HASH peripheral in HMAC MD5 mode then
processes pInBuffer.
Parameters


hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pInBuffer: Pointer to the input buffer (buffer to be hashed).
Size: Length of the input buffer in bytes. If the Size is not
multiple of 64 bytes, the padding is managed by hardware.
pOutBuffer: Pointer to the computed digest. Its size must be
20 bytes.
Timeout: Timeout value

HAL status



Return values
20.2.18
HAL status
HAL_HASH_MD5_Start_DMA
Function Name
HAL_StatusTypeDef HAL_HASH_MD5_Start_DMA
(HASH_HandleTypeDef * hhash, uint8_t * pInBuffer, uint32_t
Size)
DOCID028236 Rev 1
289/692
HAL HASH Generic Driver
Function Description
Parameters
Return values
20.2.19
UM1940
Initializes the HASH peripheral in MD5 mode then enables DMA to
control data transfer.



hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pInBuffer: Pointer to the input buffer (buffer to be hashed).
Size: Length of the input buffer in bytes. If the Size is not
multiple of 64 bytes, the padding is managed by hardware.

HAL status
HAL_HASH_MD5_Finish
Function Name
HAL_StatusTypeDef HAL_HASH_MD5_Finish
(HASH_HandleTypeDef * hhash, uint8_t * pOutBuffer, uint32_t
Timeout)
Function Description
Returns the computed digest in MD5 mode.
Parameters


hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pOutBuffer: Pointer to the computed digest. Its size must be
16 bytes.
Timeout: Timeout value

HAL status

Return values
20.2.20
HAL_HASH_SHA1_Start_DMA
Function Name
HAL_StatusTypeDef HAL_HASH_SHA1_Start_DMA
(HASH_HandleTypeDef * hhash, uint8_t * pInBuffer, uint32_t
Size)
Function Description
Initializes the HASH peripheral in SHA1 mode then enables DMA
to control data transfer.
Parameters

Return values
20.2.21


hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pInBuffer: Pointer to the input buffer (buffer to be hashed).
Size: Length of the input buffer in bytes. If the Size is not
multiple of 64 bytes, the padding is managed by hardware.

HAL status
HAL_HASH_SHA1_Finish
Function Name
HAL_StatusTypeDef HAL_HASH_SHA1_Finish
(HASH_HandleTypeDef * hhash, uint8_t * pOutBuffer, uint32_t
Timeout)
Function Description
Returns the computed digest in SHA1 mode.
Parameters


hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pOutBuffer: Pointer to the computed digest. Its size must be
20 bytes.
Timeout: Timeout value

HAL status

Return values
290/692
DOCID028236 Rev 1
UM1940
20.2.22
HAL HASH Generic Driver
HAL_HASH_SHA1_Start_IT
Function Name
HAL_StatusTypeDef HAL_HASH_SHA1_Start_IT
(HASH_HandleTypeDef * hhash, uint8_t * pInBuffer, uint32_t
Size, uint8_t * pOutBuffer)
Function Description
Initializes the HASH peripheral in SHA1 mode then processes
pInBuffer.
Parameters




Return values
20.2.23

HAL status
HAL_HASH_MD5_Start_IT
Function Name
HAL_StatusTypeDef HAL_HASH_MD5_Start_IT
(HASH_HandleTypeDef * hhash, uint8_t * pInBuffer, uint32_t
Size, uint8_t * pOutBuffer)
Function Description
Initializes the HASH peripheral in MD5 mode then processes
pInBuffer.
Parameters




Return values
20.2.24
hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pInBuffer: Pointer to the input buffer (buffer to be hashed).
Size: Length of the input buffer in bytes. If the Size is not
multiple of 64 bytes, the padding is managed by hardware.
pOutBuffer: Pointer to the computed digest. Its size must be
20 bytes.

hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pInBuffer: Pointer to the input buffer (buffer to be hashed).
Size: Length of the input buffer in bytes. If the Size is not
multiple of 64 bytes, the padding is managed by hardware.
pOutBuffer: Pointer to the computed digest. Its size must be
16 bytes.
HAL status
HAL_HMAC_MD5_Start
Function Name
HAL_StatusTypeDef HAL_HMAC_MD5_Start
(HASH_HandleTypeDef * hhash, uint8_t * pInBuffer, uint32_t
Size, uint8_t * pOutBuffer, uint32_t Timeout)
Function Description
Initializes the HASH peripheral in HMAC MD5 mode then
processes pInBuffer.
Parameters


hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pInBuffer: Pointer to the input buffer (buffer to be hashed).
Size: Length of the input buffer in bytes. If the Size is not
multiple of 64 bytes, the padding is managed by hardware.
pOutBuffer: Pointer to the computed digest. Its size must be
20 bytes.
Timeout: Timeout value

HAL status



Return values
DOCID028236 Rev 1
291/692
HAL HASH Generic Driver
20.2.25
UM1940
HAL_HMAC_SHA1_Start
Function Name
HAL_StatusTypeDef HAL_HMAC_SHA1_Start
(HASH_HandleTypeDef * hhash, uint8_t * pInBuffer, uint32_t
Size, uint8_t * pOutBuffer, uint32_t Timeout)
Function Description
Initializes the HASH peripheral in HMAC SHA1 mode then
processes pInBuffer.
Parameters


hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pInBuffer: Pointer to the input buffer (buffer to be hashed).
Size: Length of the input buffer in bytes. If the Size is not
multiple of 64 bytes, the padding is managed by hardware.
pOutBuffer: Pointer to the computed digest. Its size must be
20 bytes.
Timeout: Timeout value

HAL status



Return values
20.2.26
HAL_HASH_SHA1_Start_DMA
Function Name
HAL_StatusTypeDef HAL_HASH_SHA1_Start_DMA
(HASH_HandleTypeDef * hhash, uint8_t * pInBuffer, uint32_t
Size)
Function Description
Initializes the HASH peripheral in SHA1 mode then enables DMA
to control data transfer.
Parameters

Return values
20.2.27


hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pInBuffer: Pointer to the input buffer (buffer to be hashed).
Size: Length of the input buffer in bytes. If the Size is not
multiple of 64 bytes, the padding is managed by hardware.

HAL status
HAL_HASH_SHA1_Finish
Function Name
HAL_StatusTypeDef HAL_HASH_SHA1_Finish
(HASH_HandleTypeDef * hhash, uint8_t * pOutBuffer, uint32_t
Timeout)
Function Description
Returns the computed digest in SHA1 mode.
Parameters


hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pOutBuffer: Pointer to the computed digest. Its size must be
20 bytes.
Timeout: Timeout value

HAL status

Return values
20.2.28
HAL_HASH_MD5_Start_DMA
Function Name
292/692
HAL_StatusTypeDef HAL_HASH_MD5_Start_DMA
(HASH_HandleTypeDef * hhash, uint8_t * pInBuffer, uint32_t
Size)
DOCID028236 Rev 1
UM1940
Function Description
HAL HASH Generic Driver
Initializes the HASH peripheral in MD5 mode then enables DMA to
control data transfer.
Parameters

Return values
20.2.29


hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pInBuffer: Pointer to the input buffer (buffer to be hashed).
Size: Length of the input buffer in bytes. If the Size is not
multiple of 64 bytes, the padding is managed by hardware.

HAL status
HAL_HASH_MD5_Finish
Function Name
HAL_StatusTypeDef HAL_HASH_MD5_Finish
(HASH_HandleTypeDef * hhash, uint8_t * pOutBuffer, uint32_t
Timeout)
Function Description
Returns the computed digest in MD5 mode.
Parameters


hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pOutBuffer: Pointer to the computed digest. Its size must be
16 bytes.
Timeout: Timeout value

HAL status

Return values
20.2.30
HAL_HMAC_MD5_Start_DMA
Function Name
HAL_StatusTypeDef HAL_HMAC_MD5_Start_DMA
(HASH_HandleTypeDef * hhash, uint8_t * pInBuffer, uint32_t
Size)
Function Description
Initializes the HASH peripheral in HMAC MD5 mode then enables
DMA to control data transfer.
Parameters

Return values
20.2.31


hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pInBuffer: Pointer to the input buffer (buffer to be hashed).
Size: Length of the input buffer in bytes. If the Size is not
multiple of 64 bytes, the padding is managed by hardware.

HAL status
HAL_HMAC_SHA1_Start_DMA
Function Name
HAL_StatusTypeDef HAL_HMAC_SHA1_Start_DMA
(HASH_HandleTypeDef * hhash, uint8_t * pInBuffer, uint32_t
Size)
Function Description
Initializes the HASH peripheral in HMAC SHA1 mode then enables
DMA to control data transfer.
Parameters



hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
pInBuffer: Pointer to the input buffer (buffer to be hashed).
Size: Length of the input buffer in bytes. If the Size is not
multiple of 64 bytes, the padding is managed by hardware.
DOCID028236 Rev 1
293/692
HAL HASH Generic Driver
Return values
20.2.32
20.2.33
20.2.34
20.2.35
20.2.36
294/692
UM1940

HAL status
HAL_HASH_GetState
Function Name
HAL_HASH_STATETypeDef HAL_HASH_GetState
(HASH_HandleTypeDef * hhash)
Function Description
return the HASH state
Parameters

hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
Return values

HAL state
HAL_HASH_IRQHandler
Function Name
void HAL_HASH_IRQHandler (HASH_HandleTypeDef * hhash)
Function Description
This function handles HASH interrupt request.
Parameters

hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
Return values

None
HAL_HASH_Init
Function Name
HAL_StatusTypeDef HAL_HASH_Init (HASH_HandleTypeDef *
hhash)
Function Description
Initializes the HASH according to the specified parameters in the
HASH_HandleTypeDef and creates the associated handle.
Parameters

hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
Return values

HAL status
HAL_HASH_DeInit
Function Name
HAL_StatusTypeDef HAL_HASH_DeInit
(HASH_HandleTypeDef * hhash)
Function Description
DeInitializes the HASH peripheral.
Parameters

hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
Return values

HAL status
Notes

This API must be called before starting a new processing.
HAL_HASH_MspInit
Function Name
void HAL_HASH_MspInit (HASH_HandleTypeDef * hhash)
Function Description
Initializes the HASH MSP.
Parameters

hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
DOCID028236 Rev 1
UM1940
HAL HASH Generic Driver
Return values
20.2.37
20.2.38
20.2.39
20.2.40
20.2.41

None
HAL_HASH_MspDeInit
Function Name
void HAL_HASH_MspDeInit (HASH_HandleTypeDef * hhash)
Function Description
DeInitializes HASH MSP.
Parameters

hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
Return values

None
HAL_HASH_InCpltCallback
Function Name
void HAL_HASH_InCpltCallback (HASH_HandleTypeDef *
hhash)
Function Description
Input data transfer complete callback.
Parameters

hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
Return values

None
HAL_HASH_ErrorCallback
Function Name
void HAL_HASH_ErrorCallback (HASH_HandleTypeDef *
hhash)
Function Description
Data transfer Error callback.
Parameters

hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
Return values

None
HAL_HASH_DgstCpltCallback
Function Name
void HAL_HASH_DgstCpltCallback (HASH_HandleTypeDef *
hhash)
Function Description
Digest computation complete callback.
Parameters

hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
Return values

None
Notes

This callback is not relevant with DMA.
HAL_HASH_GetState
Function Name
HAL_HASH_STATETypeDef HAL_HASH_GetState
(HASH_HandleTypeDef * hhash)
Function Description
return the HASH state
Parameters

hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
DOCID028236 Rev 1
295/692
HAL HASH Generic Driver
Return values
20.2.42
20.2.43
20.2.44
20.2.45
20.2.46
296/692
UM1940

HAL state
HAL_HASH_MspInit
Function Name
void HAL_HASH_MspInit (HASH_HandleTypeDef * hhash)
Function Description
Initializes the HASH MSP.
Parameters

hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
Return values

None
HAL_HASH_MspDeInit
Function Name
void HAL_HASH_MspDeInit (HASH_HandleTypeDef * hhash)
Function Description
DeInitializes HASH MSP.
Parameters

hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
Return values

None
HAL_HASH_InCpltCallback
Function Name
void HAL_HASH_InCpltCallback (HASH_HandleTypeDef *
hhash)
Function Description
Input data transfer complete callback.
Parameters

hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
Return values

None
HAL_HASH_DgstCpltCallback
Function Name
void HAL_HASH_DgstCpltCallback (HASH_HandleTypeDef *
hhash)
Function Description
Digest computation complete callback.
Parameters

hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
Return values

None
Notes

This callback is not relevant with DMA.
HAL_HASH_ErrorCallback
Function Name
void HAL_HASH_ErrorCallback (HASH_HandleTypeDef *
hhash)
Function Description
Data transfer Error callback.
Parameters

hhash: pointer to a HASH_HandleTypeDef structure that
contains the configuration information for HASH module
Return values

None
DOCID028236 Rev 1
UM1940
HAL HASH Generic Driver
20.3
HASH Firmware driver defines
20.3.1
HASH
HASH Data Type
HASH_DATATYPE_32B
32-bit data. No swapping
HASH_DATATYPE_16B
16-bit data. Each half word is swapped
HASH_DATATYPE_8B
8-bit data. All bytes are swapped
HASH_DATATYPE_1B
1-bit data. In the word all bits are swapped
HASH Algorithm Selection
HASH_ALGOSELECTION_SHA1
HASH function is SHA1
HASH_ALGOSELECTION_MD5
HASH function is MD5
HASH Algorithm Mode
HASH_ALGOMODE_HASH
Algorithm is HASH
HASH_ALGOMODE_HMAC
Algorithm is HMAC
HASH HMAC Long key
HASH_HMAC_KEYTYPE_SHORTKEY
HMAC Key is <= 64 bytes
HASH_HMAC_KEYTYPE_LONGKEY
HMAC Key is> 64 bytes
HASH Flags definition
HASH_FLAG_DINIS
16 locations are free in the DIN : A new block can be entered into
the input buffer
HASH_FLAG_DCIS
Digest calculation complete
HASH_FLAG_DMAS
DMA interface is enabled (DMAE=1) or a transfer is ongoing
HASH_FLAG_BUSY
The hash core is Busy : processing a block of data
HASH_FLAG_DINNE
DIN not empty : The input buffer contains at least one word of data
HASH Interrupts definition
HASH_IT_DINI
A new block can be entered into the input buffer (DIN)
HASH_IT_DCI
Digest calculation complete
HASH Exported Macros
__HAL_HASH_RESET_HANDLE_STATE
Description:

Reset HASH handle state.
Parameters:

__HANDLE__: specifies the HASH
handle.
Return value:

__HAL_HASH_GET_FLAG
None
Description:

Check whether the specified HASH flag is
set or not.
DOCID028236 Rev 1
297/692
HAL HASH Generic Driver
UM1940
Parameters:

__FLAG__: specifies the flag to check.
This parameter can be one of the
following values:

HASH_FLAG_DINIS: A new block
can be entered into the input buffer.

HASH_FLAG_DCIS: Digest
calculation complete

HASH_FLAG_DMAS: DMA interface
is enabled (DMAE=1) or a transfer is
ongoing

HASH_FLAG_BUSY: The hash core
is Busy : processing a block of data

HASH_FLAG_DINNE: DIN not
empty : The input buffer contains at
least one word of data
Return value:

__HAL_HASH_START_DIGEST
The: new state of __FLAG__ (TRUE or
FALSE).
Description:

Start the digest computation.
Return value:

__HAL_HASH_SET_NBVALIDBITS
None
Description:

Set the number of valid bits in last word
written in Data register.
Parameters:

SIZE: size in byte of last data written in
Data register.
Return value:

None
HASH Private Macros
IS_HASH_ALGOSELECTION
IS_HASH_ALGOMODE
IS_HASH_DATATYPE
IS_HASH_HMAC_KEYTYPE
IS_HASH_SHA1_BUFFER_SIZE
298/692
DOCID028236 Rev 1
UM1940
HAL HCD Generic Driver
21
HAL HCD Generic Driver
21.1
HCD Firmware driver registers structures
21.1.1
HCD_HandleTypeDef
Data Fields






HCD_TypeDef * Instance
HCD_InitTypeDef Init
HCD_HCTypeDef hc
HAL_LockTypeDef Lock
__IO HCD_StateTypeDef State
void * pData
Field Documentation






HCD_TypeDef* HCD_HandleTypeDef::Instance
Register base address
HCD_InitTypeDef HCD_HandleTypeDef::Init
HCD required parameters
HCD_HCTypeDef HCD_HandleTypeDef::hc[15]
Host channels parameters
HAL_LockTypeDef HCD_HandleTypeDef::Lock
HCD peripheral status
__IO HCD_StateTypeDef HCD_HandleTypeDef::State
HCD communication state
void* HCD_HandleTypeDef::pData
Pointer Stack Handler
21.2
HCD Firmware driver API description
21.2.1
How to use this driver
1.
2.
3.
4.
Declare a HCD_HandleTypeDef handle structure, for example: HCD_HandleTypeDef
hhcd;
Fill parameters of Init structure in HCD handle
Call HAL_HCD_Init() API to initialize the HCD peripheral (Core, Host core, ...)
Initialize the HCD low level resources through the HAL_HCD_MspInit() API:
a.
Enable the HCD/USB Low Level interface clock using the following macros

__HAL_RCC_USB_OTG_FS_CLK_ENABLE();

__HAL_RCC_USB_OTG_HS_CLK_ENABLE(); (For High Speed Mode)

__HAL_RCC_USB_OTG_HS_ULPI_CLK_ENABLE(); (For High Speed
Mode)
b.
Initialize the related GPIO clocks
c.
Configure HCD pin-out
d.
Configure HCD NVIC interrupt
DOCID028236 Rev 1
299/692
HAL HCD Generic Driver
5. Associate the Upper USB Host stack to the HAL HCD Driver:
a.
hhcd.pData = phost;
6. Enable HCD transmission and reception:
a.
HAL_HCD_Start();
21.2.2
UM1940
Initialization and de-initialization functions
This section provides functions allowing to:
This section contains the following APIs:






21.2.3
HAL_HCD_Init()
HAL_HCD_HC_Init()
HAL_HCD_HC_Halt()
HAL_HCD_DeInit()
HAL_HCD_MspInit()
HAL_HCD_MspDeInit()
IO operation functions
This subsection provides a set of functions allowing to manage the USB Host Data
Transfer
This section contains the following APIs:






21.2.4
HAL_HCD_HC_SubmitRequest()
HAL_HCD_IRQHandler()
HAL_HCD_SOF_Callback()
HAL_HCD_Connect_Callback()
HAL_HCD_Disconnect_Callback()
HAL_HCD_HC_NotifyURBChange_Callback()
Peripheral Control functions
This subsection provides a set of functions allowing to control the HCD data transfers.
This section contains the following APIs:



21.2.5
HAL_HCD_Start()
HAL_HCD_Stop()
HAL_HCD_ResetPort()
Peripheral State functions
This subsection permits to get in run-time the status of the peripheral and the data flow.
This section contains the following APIs:






21.2.6
HAL_HCD_GetState()
HAL_HCD_HC_GetURBState()
HAL_HCD_HC_GetXferCount()
HAL_HCD_HC_GetState()
HAL_HCD_GetCurrentFrame()
HAL_HCD_GetCurrentSpeed()
HAL_HCD_Init
Function Name
300/692
HAL_StatusTypeDef HAL_HCD_Init (HCD_HandleTypeDef *
hhcd)
DOCID028236 Rev 1
UM1940
21.2.7
HAL HCD Generic Driver
Function Description
Initialize the host driver.
Parameters

hhcd: HCD handle
Return values

HAL status
HAL_HCD_HC_Init
Function Name
HAL_StatusTypeDef HAL_HCD_HC_Init (HCD_HandleTypeDef
* hhcd, uint8_t ch_num, uint8_t epnum, uint8_t dev_address,
uint8_t speed, uint8_t ep_type, uint16_t mps)
Function Description
Initialize a host channel.
Parameters







Return values
21.2.8
21.2.9
21.2.10

hhcd: HCD handle
ch_num: Channel number. This parameter can be a value
from 1 to 15
epnum: Endpoint number. This parameter can be a value
from 1 to 15
dev_address: : Current device address This parameter can
be a value from 0 to 255
speed: Current device speed. This parameter can be one of
these values: HCD_SPEED_HIGH: High speed mode,
HCD_SPEED_FULL: Full speed mode, HCD_SPEED_LOW:
Low speed mode
ep_type: Endpoint Type. This parameter can be one of these
values: EP_TYPE_CTRL: Control type, EP_TYPE_ISOC:
Isochronous type, EP_TYPE_BULK: Bulk type,
EP_TYPE_INTR: Interrupt type
mps: Max Packet Size. This parameter can be a value from
0 to32K
HAL status
HAL_HCD_HC_Halt
Function Name
HAL_StatusTypeDef HAL_HCD_HC_Halt
(HCD_HandleTypeDef * hhcd, uint8_t ch_num)
Function Description
Halt a host channel.
Parameters


hhcd: HCD handle
ch_num: Channel number. This parameter can be a value
from 1 to 15
Return values

HAL status
HAL_HCD_DeInit
Function Name
HAL_StatusTypeDef HAL_HCD_DeInit (HCD_HandleTypeDef *
hhcd)
Function Description
DeInitialize the host driver.
Parameters

hhcd: HCD handle
Return values

HAL status
HAL_HCD_MspInit
DOCID028236 Rev 1
301/692
HAL HCD Generic Driver
Function Name
21.2.11
21.2.12
UM1940
void HAL_HCD_MspInit (HCD_HandleTypeDef * hhcd)
Function Description
Initialize the HCD MSP.
Parameters

hhcd: HCD handle
Return values

None
HAL_HCD_MspDeInit
Function Name
void HAL_HCD_MspDeInit (HCD_HandleTypeDef * hhcd)
Function Description
DeInitialize the HCD MSP.
Parameters

hhcd: HCD handle
Return values

None
HAL_HCD_HC_SubmitRequest
Function Name
HAL_StatusTypeDef HAL_HCD_HC_SubmitRequest
(HCD_HandleTypeDef * hhcd, uint8_t ch_num, uint8_t
direction, uint8_t ep_type, uint8_t token, uint8_t * pbuff,
uint16_t length, uint8_t do_ping)
Function Description
Submit a new URB for processing.
Parameters








Return values
21.2.13
21.2.14
HAL status
HAL_HCD_IRQHandler
Function Name
void HAL_HCD_IRQHandler (HCD_HandleTypeDef * hhcd)
Function Description
Handle HCD interrupt request.
Parameters

hhcd: HCD handle
Return values

None
HAL_HCD_SOF_Callback
Function Name
302/692

hhcd: HCD handle
ch_num: Channel number. This parameter can be a value
from 1 to 15
direction: Channel number. This parameter can be one of
these values: 0 : Output / 1 : Input
ep_type: Endpoint Type. This parameter can be one of these
values: EP_TYPE_CTRL: Control type/ EP_TYPE_ISOC:
Isochronous type/ EP_TYPE_BULK: Bulk type/
EP_TYPE_INTR: Interrupt type/
token: Endpoint Type. This parameter can be one of these
values: 0: HC_PID_SETUP / 1: HC_PID_DATA1
pbuff: pointer to URB data
length: Length of URB data
do_ping: activate do ping protocol (for high speed only). This
parameter can be one of these values: 0 : do ping inactive / 1
: do ping active
void HAL_HCD_SOF_Callback (HCD_HandleTypeDef * hhcd)
DOCID028236 Rev 1
UM1940
21.2.15
21.2.16
21.2.17
HAL HCD Generic Driver
Function Description
SOF callback.
Parameters

hhcd: HCD handle
Return values

None
HAL_HCD_Connect_Callback
Function Name
void HAL_HCD_Connect_Callback (HCD_HandleTypeDef *
hhcd)
Function Description
Connection Event callback.
Parameters

hhcd: HCD handle
Return values

None
HAL_HCD_Disconnect_Callback
Function Name
void HAL_HCD_Disconnect_Callback (HCD_HandleTypeDef *
hhcd)
Function Description
Disconnection Event callback.
Parameters

hhcd: HCD handle
Return values

None
HAL_HCD_HC_NotifyURBChange_Callback
Function Name
void HAL_HCD_HC_NotifyURBChange_Callback
(HCD_HandleTypeDef * hhcd, uint8_t chnum,
HCD_URBStateTypeDef urb_state)
Function Description
Notify URB state change callback.
Parameters


Return values
21.2.18
21.2.19

hhcd: HCD handle
chnum: Channel number. This parameter can be a value
from 1 to 15
urb_state: This parameter can be one of these values:
URB_IDLE/ URB_DONE/ URB_NOTREADY/ URB_NYET/
URB_ERROR/ URB_STALL/

None
HAL_HCD_Start
Function Name
HAL_StatusTypeDef HAL_HCD_Start (HCD_HandleTypeDef *
hhcd)
Function Description
Start the host driver.
Parameters

hhcd: HCD handle
Return values

HAL status
HAL_HCD_Stop
Function Name
HAL_StatusTypeDef HAL_HCD_Stop (HCD_HandleTypeDef *
hhcd)
DOCID028236 Rev 1
303/692
HAL HCD Generic Driver
Function Description
21.2.20
21.2.21
21.2.22
21.2.23
21.2.24
Parameters

hhcd: HCD handle
Return values

HAL status
HAL_HCD_ResetPort
Function Name
HAL_StatusTypeDef HAL_HCD_ResetPort
(HCD_HandleTypeDef * hhcd)
Function Description
Reset the host port.
Parameters

hhcd: HCD handle
Return values

HAL status
HAL_HCD_GetState
Function Name
HCD_StateTypeDef HAL_HCD_GetState (HCD_HandleTypeDef
* hhcd)
Function Description
Return the HCD handle state.
Parameters

hhcd: HCD handle
Return values

HAL state
HAL_HCD_HC_GetURBState
Function Name
HCD_URBStateTypeDef HAL_HCD_HC_GetURBState
(HCD_HandleTypeDef * hhcd, uint8_t chnum)
Function Description
Return URB state for a channel.
Parameters


hhcd: HCD handle
chnum: Channel number. This parameter can be a value
from 1 to 15
Return values

URB state. This parameter can be one of these values:
URB_IDLE/ URB_DONE/ URB_NOTREADY/ URB_NYET/
URB_ERROR/ URB_STALL
HAL_HCD_HC_GetXferCount
Function Name
uint32_t HAL_HCD_HC_GetXferCount (HCD_HandleTypeDef *
hhcd, uint8_t chnum)
Function Description
Return the last host transfer size.
Parameters


hhcd: HCD handle
chnum: Channel number. This parameter can be a value
from 1 to 15
Return values

last transfer size in byte
HAL_HCD_HC_GetState
Function Name
304/692
UM1940
Stop the host driver.
HCD_HCStateTypeDef HAL_HCD_HC_GetState
(HCD_HandleTypeDef * hhcd, uint8_t chnum)
DOCID028236 Rev 1
UM1940
21.2.25
21.2.26
HAL HCD Generic Driver
Function Description
Return the Host Channel state.
Parameters


hhcd: HCD handle
chnum: Channel number. This parameter can be a value
from 1 to 15
Return values

Host channel state This parameter can be one of these
values: HC_IDLE/ HC_XFRC/ HC_HALTED/ HC_NYET/
HC_NAK/ HC_STALL/ HC_XACTERR/ HC_BBLERR/
HC_DATATGLERR
HAL_HCD_GetCurrentFrame
Function Name
uint32_t HAL_HCD_GetCurrentFrame (HCD_HandleTypeDef *
hhcd)
Function Description
Return the current Host frame number.
Parameters

hhcd: HCD handle
Return values

Current Host frame number
HAL_HCD_GetCurrentSpeed
Function Name
uint32_t HAL_HCD_GetCurrentSpeed (HCD_HandleTypeDef *
hhcd)
Function Description
Return the Host enumeration speed.
Parameters

hhcd: HCD handle
Return values

Enumeration speed
21.3
HCD Firmware driver defines
21.3.1
HCD
HCD Exported Macros
__HAL_HCD_ENABLE
__HAL_HCD_DISABLE
__HAL_HCD_GET_FLAG
__HAL_HCD_CLEAR_FLAG
__HAL_HCD_IS_INVALID_INTERRUPT
__HAL_HCD_CLEAR_HC_INT
__HAL_HCD_MASK_HALT_HC_INT
__HAL_HCD_UNMASK_HALT_HC_INT
__HAL_HCD_MASK_ACK_HC_INT
__HAL_HCD_UNMASK_ACK_HC_INT
HCD Instance definition
IS_HCD_ALL_INSTANCE
HCD PHY Module
DOCID028236 Rev 1
305/692
HAL HCD Generic Driver
HCD_PHY_ULPI
UM1940
HCD_PHY_EMBEDDED
HCD Speed
HCD_SPEED_HIGH
HCD_SPEED_LOW
HCD_SPEED_FULL
306/692
DOCID028236 Rev 1
UM1940
HAL I2C Generic Driver
22
HAL I2C Generic Driver
22.1
I2C Firmware driver registers structures
22.1.1
I2C_InitTypeDef
Data Fields








uint32_t ClockSpeed
uint32_t DutyCycle
uint32_t OwnAddress1
uint32_t AddressingMode
uint32_t DualAddressMode
uint32_t OwnAddress2
uint32_t GeneralCallMode
uint32_t NoStretchMode
Field Documentation








22.1.2
uint32_t I2C_InitTypeDef::ClockSpeed
Specifies the clock frequency. This parameter must be set to a value lower than
400kHz
uint32_t I2C_InitTypeDef::DutyCycle
Specifies the I2C fast mode duty cycle. This parameter can be a value of
I2C_duty_cycle_in_fast_mode
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::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
Data Fields
DOCID028236 Rev 1
307/692
HAL I2C Generic Driver










UM1940
I2C_TypeDef * Instance
I2C_InitTypeDef Init
uint8_t * pBuffPtr
uint16_t XferSize
__IO uint16_t XferCount
DMA_HandleTypeDef * hdmatx
DMA_HandleTypeDef * hdmarx
HAL_LockTypeDef Lock
__IO HAL_I2C_StateTypeDef State
__IO uint32_t ErrorCode
Field Documentation










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 uint32_t I2C_HandleTypeDef::ErrorCode
I2C Error code
22.2
I2C Firmware driver API description
22.2.1
How to use this driver
The I2C HAL driver can be used as follows:
1.
2.
308/692
Declare a I2C_HandleTypeDef handle structure, for example: I2C_HandleTypeDef
hi2c;
Initialize the I2C low level resources by implement the HAL_I2C_MspInit() API:
a.
Enable the I2Cx interface clock
b.
I2C pins configuration

Enable the clock for the I2C GPIOs

Configure I2C pins as alternate function open-drain
c.
NVIC configuration if you need to use interrupt process

Configure the I2Cx interrupt priority

Enable the NVIC I2C IRQ Channel
d.
DMA Configuration if you need to use DMA process
DOCID028236 Rev 1
UM1940
HAL I2C Generic Driver

3.
4.
5.
6.
Declare a DMA_HandleTypeDef handle structure for the transmit or receive
stream

Enable the DMAx interface clock using

Configure the DMA handle parameters

Configure the DMA Tx or Rx Stream

Associate the initialized 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 Stream
Configure the Communication Speed, Duty cycle, Addressing mode, Own Address1,
Dual Addressing mode, Own Address2, General call and Nostretch mode in the hi2c
Init structure.
Initialize the I2C registers by calling the HAL_I2C_Init(), configures also the low level
Hardware (GPIO, CLOCK, NVIC...etc) by calling the customized
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 operation modes are available within this
driver :
Polling mode IO operation




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()
Interrupt mode IO operation





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
can add his own code by customization of function pointer
HAL_I2C_MasterRxCpltCallback
Transmit in slave mode an amount of data in non blocking mode using
HAL_I2C_Slave_Transmit_IT()
DOCID028236 Rev 1
309/692
HAL I2C Generic Driver




UM1940
At transmission end of transfer HAL_I2C_SlaveTxCpltCallback is executed and user
can add his own code by customization of function pointer
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
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
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
DMA mode IO operation









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
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 (DMA) using
HAL_I2C_Master_Receive_DMA()
At reception end of transfer HAL_I2C_MasterRxCpltCallback is executed and user
can add his own code by customization of function pointer
HAL_I2C_MasterRxCpltCallback
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
can add his own code by customization of function pointer
HAL_I2C_SlaveTxCpltCallback
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
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
DMA mode IO MEM operation

310/692
Write an amount of data in no-blocking mode with DMA to a specific memory address
using HAL_I2C_Mem_Write_DMA()
DOCID028236 Rev 1
UM1940
HAL I2C Generic Driver




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
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
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 : Clear the specified I2C pending flag
__HAL_I2C_ENABLE_IT: Enable the specified I2C interrupt
__HAL_I2C_DISABLE_IT: Disable the specified I2C interrupt
You can refer to the I2C HAL driver header file for more useful macros
22.2.2
Initialization and de-initialization functions
This subsection provides a set of functions allowing to initialize and de-initialize the I2Cx
peripheral:



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:

Communication Speed

Duty cycle

Addressing mode

Own Address 1

Dual Addressing mode

Own Address 2

General call mode

Nostretch mode
Call the function HAL_I2C_DeInit() to restore the default configuration of the selected
I2Cx peripheral.
This section contains the following APIs:




22.2.3
HAL_I2C_Init()
HAL_I2C_DeInit()
HAL_I2C_MspInit()
HAL_I2C_MspDeInit()
IO operation functions
This subsection provides a set of functions allowing to manage the I2C data transfers.
1.
There are two modes of transfer:
DOCID028236 Rev 1
311/692
HAL I2C Generic Driver
UM1940

2.
3.
4.
5.
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 :

HAL_I2C_Master_Transmit()

HAL_I2C_Master_Receive()

HAL_I2C_Slave_Transmit()

HAL_I2C_Slave_Receive()

HAL_I2C_Mem_Write()

HAL_I2C_Mem_Read()

HAL_I2C_IsDeviceReady()
No-Blocking mode functions with Interrupt are :

HAL_I2C_Master_Transmit_IT()

HAL_I2C_Master_Receive_IT()

HAL_I2C_Slave_Transmit_IT()

HAL_I2C_Slave_Receive_IT()

HAL_I2C_Mem_Write_IT()

HAL_I2C_Mem_Read_IT()
No-Blocking mode functions with DMA are :

HAL_I2C_Master_Transmit_DMA()

HAL_I2C_Master_Receive_DMA()

HAL_I2C_Slave_Transmit_DMA()

HAL_I2C_Slave_Receive_DMA()

HAL_I2C_Mem_Write_DMA()

HAL_I2C_Mem_Read_DMA()
A set of Transfer Complete Callbacks are provided in non Blocking mode:

HAL_I2C_MemTxCpltCallback()

HAL_I2C_MemRxCpltCallback()

HAL_I2C_MasterTxCpltCallback()

HAL_I2C_MasterRxCpltCallback()

HAL_I2C_SlaveTxCpltCallback()

HAL_I2C_SlaveRxCpltCallback()

HAL_I2C_ErrorCallback()
This section contains the following APIs:














312/692
HAL_I2C_Master_Transmit()
HAL_I2C_Master_Receive()
HAL_I2C_Slave_Transmit()
HAL_I2C_Slave_Receive()
HAL_I2C_Master_Transmit_IT()
HAL_I2C_Master_Receive_IT()
HAL_I2C_Slave_Transmit_IT()
HAL_I2C_Slave_Receive_IT()
HAL_I2C_Master_Transmit_DMA()
HAL_I2C_Master_Receive_DMA()
HAL_I2C_Slave_Transmit_DMA()
HAL_I2C_Slave_Receive_DMA()
HAL_I2C_Mem_Write()
HAL_I2C_Mem_Read()
DOCID028236 Rev 1
UM1940
HAL I2C Generic Driver














22.2.4
HAL_I2C_Mem_Write_IT()
HAL_I2C_Mem_Read_IT()
HAL_I2C_Mem_Write_DMA()
HAL_I2C_Mem_Read_DMA()
HAL_I2C_IsDeviceReady()
HAL_I2C_EV_IRQHandler()
HAL_I2C_ER_IRQHandler()
HAL_I2C_MasterTxCpltCallback()
HAL_I2C_MasterRxCpltCallback()
HAL_I2C_SlaveTxCpltCallback()
HAL_I2C_SlaveRxCpltCallback()
HAL_I2C_MemTxCpltCallback()
HAL_I2C_MemRxCpltCallback()
HAL_I2C_ErrorCallback()
Peripheral State and Errors functions
This subsection permits to get in run-time the status of the peripheral and the data flow.
This section contains the following APIs:


22.2.5
22.2.6
22.2.7
22.2.8
HAL_I2C_GetState()
HAL_I2C_GetError()
HAL_I2C_Init
Function Name
HAL_StatusTypeDef HAL_I2C_Init (I2C_HandleTypeDef * hi2c)
Function Description
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 I2C module
Return values

HAL status
HAL_I2C_DeInit
Function Name
HAL_StatusTypeDef HAL_I2C_DeInit (I2C_HandleTypeDef *
hi2c)
Function Description
DeInitializes the I2C peripheral.
Parameters

hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
Return values

HAL status
HAL_I2C_MspInit
Function Name
void HAL_I2C_MspInit (I2C_HandleTypeDef * hi2c)
Function Description
I2C MSP Init.
Parameters

hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
Return values

None
HAL_I2C_MspDeInit
DOCID028236 Rev 1
313/692
HAL I2C Generic Driver
Function Name
22.2.9
Function Description
I2C MSP DeInit.
Parameters

hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
Return values

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)
Function Description
Transmits in master mode an amount of data in blocking mode.
Parameters

Return values
22.2.10

HAL status
Function Name
HAL_StatusTypeDef HAL_I2C_Master_Receive
(I2C_HandleTypeDef * hi2c, uint16_t DevAddress, uint8_t *
pData, uint16_t Size, uint32_t Timeout)
Function Description
Receives in master mode an amount of data in blocking mode.
Parameters





hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
DevAddress: Target device address
pData: Pointer to data buffer
Size: Amount of data to be sent
Timeout: Timeout duration

HAL status
HAL_I2C_Slave_Transmit
Function Name
HAL_StatusTypeDef HAL_I2C_Slave_Transmit
(I2C_HandleTypeDef * hi2c, uint8_t * pData, uint16_t Size,
uint32_t Timeout)
Function Description
Transmits in slave mode an amount of data in blocking mode.
Parameters

Return values
314/692




hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
DevAddress: Target device address
pData: Pointer to data buffer
Size: Amount of data to be sent
Timeout: Timeout duration
HAL_I2C_Master_Receive
Return values
22.2.11
UM1940
void HAL_I2C_MspDeInit (I2C_HandleTypeDef * hi2c)



hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
pData: Pointer to data buffer
Size: Amount of data to be sent
Timeout: Timeout duration

HAL status
DOCID028236 Rev 1
UM1940
22.2.12
HAL I2C Generic Driver
HAL_I2C_Slave_Receive
Function Name
HAL_StatusTypeDef HAL_I2C_Slave_Receive
(I2C_HandleTypeDef * hi2c, uint8_t * pData, uint16_t Size,
uint32_t Timeout)
Function Description
Receive in slave mode an amount of data in blocking mode.
Parameters

Return values
22.2.13
HAL status
Function Name
HAL_StatusTypeDef HAL_I2C_Master_Transmit_IT
(I2C_HandleTypeDef * hi2c, uint16_t DevAddress, uint8_t *
pData, uint16_t Size)
Function Description
Transmit in master mode an amount of data in no-blocking mode
with Interrupt.
Parameters




hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
DevAddress: Target device address
pData: Pointer to data buffer
Size: Amount of data to be sent

HAL status
HAL_I2C_Master_Receive_IT
Function Name
HAL_StatusTypeDef HAL_I2C_Master_Receive_IT
(I2C_HandleTypeDef * hi2c, uint16_t DevAddress, uint8_t *
pData, uint16_t Size)
Function Description
Receive in master mode an amount of data in no-blocking mode
with Interrupt.
Parameters

Return values
22.2.15

HAL_I2C_Master_Transmit_IT
Return values
22.2.14



hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
pData: Pointer to data buffer
Size: Amount of data to be sent
Timeout: Timeout duration



hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
DevAddress: Target device address
pData: Pointer to data buffer
Size: Amount of data to be sent

HAL status
HAL_I2C_Slave_Transmit_IT
Function Name
HAL_StatusTypeDef HAL_I2C_Slave_Transmit_IT
(I2C_HandleTypeDef * hi2c, uint8_t * pData, uint16_t Size)
Function Description
Transmit in slave mode an amount of data in no-blocking mode
with Interrupt.
Parameters

hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
DOCID028236 Rev 1
315/692
HAL I2C Generic Driver
Return values
22.2.16
Function Description
Receive in slave mode an amount of data in no-blocking mode
with Interrupt.
Parameters



hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
pData: Pointer to data buffer
Size: Amount of data to be sent

HAL status
HAL_I2C_Master_Transmit_DMA
Function Name
HAL_StatusTypeDef HAL_I2C_Master_Transmit_DMA
(I2C_HandleTypeDef * hi2c, uint16_t DevAddress, uint8_t *
pData, uint16_t Size)
Function Description
Transmit in master mode an amount of data in no-blocking mode
with DMA.
Parameters




hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
DevAddress: Target device address
pData: Pointer to data buffer
Size: Amount of data to be sent

HAL status
HAL_I2C_Master_Receive_DMA
Function Name
HAL_StatusTypeDef HAL_I2C_Master_Receive_DMA
(I2C_HandleTypeDef * hi2c, uint16_t DevAddress, uint8_t *
pData, uint16_t Size)
Function Description
Receive in master mode an amount of data in no-blocking mode
with DMA.
Parameters




hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
DevAddress: Target device address
pData: Pointer to data buffer
Size: Amount of data to be sent

HAL status
HAL_I2C_Slave_Transmit_DMA
Function Name
316/692
HAL status
HAL_StatusTypeDef HAL_I2C_Slave_Receive_IT
(I2C_HandleTypeDef * hi2c, uint8_t * pData, uint16_t Size)
Return values
22.2.19

Function Name
Return values
22.2.18
pData: Pointer to data buffer
Size: Amount of data to be sent
HAL_I2C_Slave_Receive_IT
Return values
22.2.17
UM1940


HAL_StatusTypeDef HAL_I2C_Slave_Transmit_DMA
(I2C_HandleTypeDef * hi2c, uint8_t * pData, uint16_t Size)
DOCID028236 Rev 1
UM1940
Function Description
HAL I2C Generic Driver
Transmit in slave mode an amount of data in no-blocking mode
with DMA.
Parameters

Return values
22.2.20
HAL status
Function Name
HAL_StatusTypeDef HAL_I2C_Slave_Receive_DMA
(I2C_HandleTypeDef * hi2c, uint8_t * pData, uint16_t Size)
Function Description
Receive in slave mode an amount of data in no-blocking mode
with DMA.
Parameters



hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
pData: Pointer to data buffer
Size: Amount of data to be sent

HAL status
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)
Function Description
Write an amount of data in blocking mode to a specific memory
address.
Parameters

Return values
22.2.22

HAL_I2C_Slave_Receive_DMA
Return values
22.2.21


hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
pData: Pointer to data buffer
Size: Amount of data to be sent






hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
DevAddress: Target device address
MemAddress: Internal memory address
MemAddSize: Size of internal memory address
pData: Pointer to data buffer
Size: Amount of data to be sent
Timeout: Timeout duration

HAL status
HAL_I2C_Mem_Read
Function Name
HAL_StatusTypeDef HAL_I2C_Mem_Read
(I2C_HandleTypeDef * hi2c, uint16_t DevAddress, uint16_t
MemAddress, uint16_t MemAddSize, uint8_t * pData, uint16_t
Size, uint32_t Timeout)
Function Description
Read an amount of data in blocking mode from a specific memory
address.
Parameters


hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
DevAddress: Target device address
DOCID028236 Rev 1
317/692
HAL I2C Generic Driver
Return values
22.2.23
318/692

HAL status
Function Name
HAL_StatusTypeDef HAL_I2C_Mem_Write_IT
(I2C_HandleTypeDef * hi2c, uint16_t DevAddress, uint16_t
MemAddress, uint16_t MemAddSize, uint8_t * pData, uint16_t
Size)
Function Description
Write an amount of data in no-blocking mode with Interrupt to a
specific memory address.
Parameters






hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
DevAddress: Target device address
MemAddress: Internal memory address
MemAddSize: Size of internal memory address
pData: Pointer to data buffer
Size: Amount of data to be sent

HAL status
HAL_I2C_Mem_Read_IT
Function Name
HAL_StatusTypeDef HAL_I2C_Mem_Read_IT
(I2C_HandleTypeDef * hi2c, uint16_t DevAddress, uint16_t
MemAddress, uint16_t MemAddSize, uint8_t * pData, uint16_t
Size)
Function Description
Read an amount of data in no-blocking mode with Interrupt from a
specific memory address.
Parameters

Return values
22.2.25
MemAddress: Internal memory address
MemAddSize: Size of internal memory address
pData: Pointer to data buffer
Size: Amount of data to be sent
Timeout: Timeout duration
HAL_I2C_Mem_Write_IT
Return values
22.2.24
UM1940










hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
DevAddress: Target device address
MemAddress: Internal memory address
MemAddSize: Size of internal memory address
pData: Pointer to data buffer
Size: Amount of data to be sent

HAL status
HAL_I2C_Mem_Write_DMA
Function Name
HAL_StatusTypeDef HAL_I2C_Mem_Write_DMA
(I2C_HandleTypeDef * hi2c, uint16_t DevAddress, uint16_t
MemAddress, uint16_t MemAddSize, uint8_t * pData, uint16_t
Size)
Function Description
Write an amount of data in no-blocking mode with DMA to a
specific memory address.
DOCID028236 Rev 1
UM1940
HAL I2C Generic Driver
Parameters
Return values
22.2.26
22.2.28





hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
DevAddress: Target device address
MemAddress: Internal memory address
MemAddSize: Size of internal memory address
pData: Pointer to data buffer
Size: Amount of data to be sent

HAL status
HAL_I2C_Mem_Read_DMA
Function Name
HAL_StatusTypeDef HAL_I2C_Mem_Read_DMA
(I2C_HandleTypeDef * hi2c, uint16_t DevAddress, uint16_t
MemAddress, uint16_t MemAddSize, uint8_t * pData, uint16_t
Size)
Function Description
Reads an amount of data in no-blocking mode with DMA from a
specific memory address.
Parameters

Return values
22.2.27






hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
DevAddress: Target device address
MemAddress: Internal memory address
MemAddSize: Size of internal memory address
pData: Pointer to data buffer
Size: Amount of data to be read

HAL status
HAL_I2C_IsDeviceReady
Function Name
HAL_StatusTypeDef HAL_I2C_IsDeviceReady
(I2C_HandleTypeDef * hi2c, uint16_t DevAddress, uint32_t
Trials, uint32_t Timeout)
Function Description
Checks if target device is ready for communication.
Parameters




hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
DevAddress: Target device address
Trials: Number of trials
Timeout: Timeout duration
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)
Function Description
This function handles I2C event interrupt request.
Parameters

hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
Return values

HAL status
DOCID028236 Rev 1
319/692
HAL I2C Generic Driver
22.2.29
22.2.30
22.2.31
22.2.32
22.2.33
22.2.34
320/692
UM1940
HAL_I2C_ER_IRQHandler
Function Name
void HAL_I2C_ER_IRQHandler (I2C_HandleTypeDef * hi2c)
Function Description
This function handles I2C error interrupt request.
Parameters

hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
Return values

HAL status
HAL_I2C_MasterTxCpltCallback
Function Name
void HAL_I2C_MasterTxCpltCallback (I2C_HandleTypeDef *
hi2c)
Function Description
Master Tx Transfer completed callbacks.
Parameters

hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
Return values

None
HAL_I2C_MasterRxCpltCallback
Function Name
void HAL_I2C_MasterRxCpltCallback (I2C_HandleTypeDef *
hi2c)
Function Description
Master Rx Transfer completed callbacks.
Parameters

hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
Return values

None
HAL_I2C_SlaveTxCpltCallback
Function Name
void HAL_I2C_SlaveTxCpltCallback (I2C_HandleTypeDef *
hi2c)
Function Description
Slave Tx Transfer completed callbacks.
Parameters

hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
Return values

None
HAL_I2C_SlaveRxCpltCallback
Function Name
void HAL_I2C_SlaveRxCpltCallback (I2C_HandleTypeDef *
hi2c)
Function Description
Slave Rx Transfer completed callbacks.
Parameters

hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
Return values

None
HAL_I2C_MemTxCpltCallback
DOCID028236 Rev 1
UM1940
22.2.35
22.2.36
22.2.37
22.2.38
Function Name
HAL I2C Generic Driver
void HAL_I2C_MemTxCpltCallback (I2C_HandleTypeDef *
hi2c)
Function Description
Memory Tx Transfer completed callbacks.
Parameters

hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
Return values

None
HAL_I2C_MemRxCpltCallback
Function Name
void HAL_I2C_MemRxCpltCallback (I2C_HandleTypeDef *
hi2c)
Function Description
Memory Rx Transfer completed callbacks.
Parameters

hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
Return values

None
HAL_I2C_ErrorCallback
Function Name
void HAL_I2C_ErrorCallback (I2C_HandleTypeDef * hi2c)
Function Description
I2C error callbacks.
Parameters

hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
Return values

None
HAL_I2C_GetState
Function Name
HAL_I2C_StateTypeDef HAL_I2C_GetState
(I2C_HandleTypeDef * hi2c)
Function Description
Returns the I2C state.
Parameters

hi2c: pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
Return values

HAL state
HAL_I2C_GetError
Function Name
uint32_t HAL_I2C_GetError (I2C_HandleTypeDef * hi2c)
Function Description
Return the I2C error code.
Parameters

hi2c: : pointer to a I2C_HandleTypeDef structure that
contains the configuration information for the specified I2C.
Return values

I2C Error Code
22.3
I2C Firmware driver defines
22.3.1
I2C
I2C addressing mode
DOCID028236 Rev 1
321/692
HAL I2C Generic Driver
I2C_ADDRESSINGMODE_7BIT
UM1940
I2C_ADDRESSINGMODE_10BIT
I2C dual addressing mode
I2C_DUALADDRESS_DISABLE
I2C_DUALADDRESS_ENABLE
I2C duty cycle in fast mode
I2C_DUTYCYCLE_2
I2C_DUTYCYCLE_16_9
I2C Error Code
HAL_I2C_ERROR_NONE
No error
HAL_I2C_ERROR_BERR
BERR error
HAL_I2C_ERROR_ARLO
ARLO error
HAL_I2C_ERROR_AF
AF error
HAL_I2C_ERROR_OVR
OVR error
HAL_I2C_ERROR_DMA
DMA transfer error
HAL_I2C_ERROR_TIMEOUT
Timeout Error
I2C Exported Macros
__HAL_I2C_RESET_HANDLE_STATE
Description:

Reset I2C handle state.
Parameters:

__HANDLE__: specifies the I2C Handle.
This parameter can be I2C where x: 1, 2, or
3 to select the I2C peripheral.
Return value:

__HAL_I2C_ENABLE_IT
None
Description:

Enable or disable the specified I2C
interrupts.
Parameters:


__HANDLE__: specifies the I2C Handle.
This parameter can be I2C where x: 1, 2, or
3 to select the I2C peripheral.
__INTERRUPT__: specifies the interrupt
source to enable or disable. This parameter
can be one of the following values:

I2C_IT_BUF: Buffer interrupt enable

I2C_IT_EVT: Event interrupt enable

I2C_IT_ERR: Error interrupt enable
Return value:

322/692
None
DOCID028236 Rev 1
UM1940
HAL I2C Generic Driver
__HAL_I2C_DISABLE_IT
__HAL_I2C_GET_IT_SOURCE
Description:

Checks if the specified I2C interrupt source
is enabled or disabled.
Parameters:


__HANDLE__: specifies the I2C Handle.
This parameter can be I2C where x: 1, 2, or
3 to select the I2C peripheral.
__INTERRUPT__: specifies the I2C
interrupt source to check. This parameter
can be one of the following values:

I2C_IT_BUF: Buffer interrupt enable

I2C_IT_EVT: Event interrupt enable

I2C_IT_ERR: Error interrupt enable
Return value:

__HAL_I2C_GET_FLAG
The: new state of __INTERRUPT__ (TRUE
or FALSE).
Description:

Checks whether the specified I2C flag is set
or not.
Parameters:


__HANDLE__: specifies the I2C Handle.
This parameter can be I2C where x: 1, 2, or
3 to select the I2C peripheral.
__FLAG__: specifies the flag to check. This
parameter can be one of the following
values:

I2C_FLAG_SMBALERT: SMBus Alert
flag

I2C_FLAG_TIMEOUT: Timeout or Tlow
error flag

I2C_FLAG_PECERR: PEC error in
reception flag

I2C_FLAG_OVR: Overrun/Underrun
flag

I2C_FLAG_AF: Acknowledge failure
flag

I2C_FLAG_ARLO: Arbitration lost flag

I2C_FLAG_BERR: Bus error flag

I2C_FLAG_TXE: Data register empty
flag

I2C_FLAG_RXNE: Data register not
empty flag

I2C_FLAG_STOPF: Stop detection flag

I2C_FLAG_ADD10: 10-bit header sent
flag

I2C_FLAG_BTF: Byte transfer finished
flag

I2C_FLAG_ADDR: Address sent flag
DOCID028236 Rev 1
323/692
HAL I2C Generic Driver








UM1940
Address matched flag
I2C_FLAG_SB: Start bit flag
I2C_FLAG_DUALF: Dual flag
I2C_FLAG_SMBHOST: SMBus host
header
I2C_FLAG_SMBDEFAULT: SMBus
default header
I2C_FLAG_GENCALL: General call
header flag
I2C_FLAG_TRA: Transmitter/Receiver
flag
I2C_FLAG_BUSY: Bus busy flag
I2C_FLAG_MSL: Master/Slave flag
Return value:

The: new state of __FLAG__ (TRUE or
FALSE).
Description:
__HAL_I2C_CLEAR_FLAG

Clears the I2C pending flags which are
cleared by writing 0 in a specific bit.
Parameters:


__HANDLE__: specifies the I2C Handle.
This parameter can be I2C where x: 1, 2, or
3 to select the I2C peripheral.
__FLAG__: specifies the flag to clear. This
parameter can be any combination of the
following values:

I2C_FLAG_SMBALERT: SMBus Alert
flag

I2C_FLAG_TIMEOUT: Timeout or Tlow
error flag

I2C_FLAG_PECERR: PEC error in
reception flag

I2C_FLAG_OVR: Overrun/Underrun
flag (Slave mode)

I2C_FLAG_AF: Acknowledge failure
flag

I2C_FLAG_ARLO: Arbitration lost flag
(Master mode)

I2C_FLAG_BERR: Bus error flag
Return value:

__HAL_I2C_CLEAR_ADDRFLAG
None
Description:

Clears the I2C ADDR pending flag.
Parameters:

324/692
__HANDLE__: specifies the I2C Handle.
This parameter can be I2C where x: 1, 2, or
3 to select the I2C peripheral.
DOCID028236 Rev 1
UM1940
HAL I2C Generic Driver
Return value:

__HAL_I2C_CLEAR_STOPFLAG
None
Description:

Clears the I2C STOPF pending flag.
Parameters:

__HANDLE__: specifies the I2C Handle.
This parameter can be I2C where x: 1, 2, or
3 to select the I2C peripheral.
Return value:

None
__HAL_I2C_ENABLE
__HAL_I2C_DISABLE
I2C Flag definition
I2C_FLAG_SMBALERT
I2C_FLAG_TIMEOUT
I2C_FLAG_PECERR
I2C_FLAG_OVR
I2C_FLAG_AF
I2C_FLAG_ARLO
I2C_FLAG_BERR
I2C_FLAG_TXE
I2C_FLAG_RXNE
I2C_FLAG_STOPF
I2C_FLAG_ADD10
I2C_FLAG_BTF
I2C_FLAG_ADDR
I2C_FLAG_SB
I2C_FLAG_DUALF
I2C_FLAG_SMBHOST
I2C_FLAG_SMBDEFAULT
I2C_FLAG_GENCALL
I2C_FLAG_TRA
I2C_FLAG_BUSY
I2C_FLAG_MSL
I2C general call addressing mode
I2C_GENERALCALL_DISABLE
I2C_GENERALCALL_ENABLE
DOCID028236 Rev 1
325/692
HAL I2C Generic Driver
I2C Interrupt configuration definition
I2C_IT_BUF
I2C_IT_EVT
I2C_IT_ERR
I2C Private macros to check input parameters
IS_I2C_DUTY_CYCLE
IS_I2C_ADDRESSING_MODE
IS_I2C_DUAL_ADDRESS
IS_I2C_GENERAL_CALL
IS_I2C_NO_STRETCH
IS_I2C_MEMADD_SIZE
IS_I2C_CLOCK_SPEED
IS_I2C_OWN_ADDRESS1
IS_I2C_OWN_ADDRESS2
I2C Memory Address Size
I2C_MEMADD_SIZE_8BIT
I2C_MEMADD_SIZE_16BIT
I2C nostretch mode
I2C_NOSTRETCH_DISABLE
I2C_NOSTRETCH_ENABLE
I2C Private Constants
I2C_TIMEOUT_FLAG
I2C_TIMEOUT_ADDR_SLAVE
I2C_TIMEOUT_BUSY_FLAG
I2C_FLAG_MASK
I2C Private Macros
I2C_FREQRANGE
I2C_RISE_TIME
I2C_SPEED_STANDARD
I2C_SPEED_FAST
I2C_SPEED
I2C_7BIT_ADD_WRITE
I2C_7BIT_ADD_READ
I2C_10BIT_ADDRESS
I2C_10BIT_HEADER_WRITE
I2C_10BIT_HEADER_READ
326/692
DOCID028236 Rev 1
UM1940
UM1940
HAL I2C Generic Driver
I2C_MEM_ADD_MSB
I2C_MEM_ADD_LSB
DOCID028236 Rev 1
327/692
HAL I2S Generic Driver
UM1940
23
HAL I2S Generic Driver
23.1
I2S Firmware driver registers structures
23.1.1
I2S_InitTypeDef
Data Fields







uint32_t Mode
uint32_t Standard
uint32_t DataFormat
uint32_t MCLKOutput
uint32_t AudioFreq
uint32_t CPOL
uint32_t ClockSource
Field Documentation







23.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
uint32_t I2S_InitTypeDef::ClockSource
Specifies the I2S Clock Source. This parameter can be a value of I2S_Clock_Source
I2S_HandleTypeDef
Data Fields






328/692
SPI_TypeDef * Instance
I2S_InitTypeDef Init
uint16_t * pTxBuffPtr
__IO uint16_t TxXferSize
__IO uint16_t TxXferCount
uint16_t * pRxBuffPtr
DOCID028236 Rev 1
UM1940
HAL I2S Generic Driver







__IO uint16_t RxXferSize
__IO uint16_t RxXferCount
DMA_HandleTypeDef * hdmatx
DMA_HandleTypeDef * hdmarx
__IO HAL_LockTypeDef Lock
__IO HAL_I2S_StateTypeDef State
__IO uint32_t ErrorCode
Field Documentation













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 uint32_t I2S_HandleTypeDef::ErrorCode
23.2
I2S Firmware driver API description
23.2.1
How to use this driver
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 stream.

Enable the DMAx interface clock.

Configure the declared DMA handle structure with the required Tx/Rx
parameters.

Configure the DMA Tx/Rx Stream.

Associate the initialized DMA handle to the I2S DMA Tx/Rx handle.

Configure the priority and enable the NVIC for the transfer complete
interrupt on the DMA Tx/Rx Stream.
Program the Mode, Standard, Data Format, MCLK Output, Audio frequency and
Polarity using HAL_I2S_Init() function. The specific I2S interrupts (Transmission
DOCID028236 Rev 1
329/692
HAL I2S Generic Driver
UM1940
complete interrupt, RXNE interrupt and Error Interrupts) will be managed using the
macros __I2S_ENABLE_IT() and __I2S_DISABLE_IT() inside the transmit and
receive process. Make sure that either: I2S PLL is configured or External clock
source is configured after setting correctly the define constant
EXTERNAL_CLOCK_VALUE in the stm32f2xx_hal_conf.h file.
4.
Three operation modes are available within this driver :
Polling mode IO operation


Send an amount of data in blocking mode using HAL_I2S_Transmit()
Receive an amount of data in blocking mode using HAL_I2S_Receive()
Interrupt mode IO operation







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
user can add his own code by customization of function pointer
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
can add his own code by customization of function pointer
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
DMA mode IO operation










330/692
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
user can add his own code by customization of function pointer
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 (DMA) using
HAL_I2S_Receive_DMA()
At reception end of half transfer HAL_I2S_RxHalfCpltCallback is executed and user
can add his own code by customization of function pointer
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
Pause the DMA Transfer using HAL_I2S_DMAPause()
Resume the DMA Transfer using HAL_I2S_DMAResume()
Stop the DMA Transfer using HAL_I2S_DMAStop()
DOCID028236 Rev 1
UM1940
HAL I2S Generic Driver
I2S HAL driver macros list
Below the list of most used macros in USART HAL driver.





__HAL_I2S_ENABLE: Enable the specified SPI peripheral (in I2S mode)
__HAL_I2S_DISABLE: Disable the specified SPI peripheral (in I2S mode)
__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
23.2.2
Initialization and de-initialization functions
This subsection provides a set of functions allowing to initialize and de-initialize the I2Sx
peripheral in simplex mode:



User must Implement HAL_I2S_MspInit() function in which he configures all related
peripherals resources (CLOCK, GPIO, DMA, IT and NVIC ).
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 peripheral.
This section contains the following APIs:




23.2.3
HAL_I2S_Init()
HAL_I2S_DeInit()
HAL_I2S_MspInit()
HAL_I2S_MspDeInit()
IO operation functions
This subsection provides a set of functions allowing to manage the I2S data transfers.
1.
2.
3.
There are two modes 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 I2S IRQ when using Interrupt
mode or the DMA IRQ when using DMA mode.
Blocking mode functions are :

HAL_I2S_Transmit()

HAL_I2S_Receive()
No-Blocking mode functions with Interrupt are :

HAL_I2S_Transmit_IT()
DOCID028236 Rev 1
331/692
HAL I2S Generic Driver
4.
5.
UM1940

HAL_I2S_Receive_IT()
No-Blocking mode functions with DMA are :

HAL_I2S_Transmit_DMA()

HAL_I2S_Receive_DMA()
A set of Transfer Complete Callbacks are provided in non Blocking mode:

HAL_I2S_TxCpltCallback()

HAL_I2S_RxCpltCallback()

HAL_I2S_ErrorCallback()
This section contains the following APIs:

















23.2.4
HAL_I2S_Transmit()
HAL_I2S_Receive()
HAL_I2S_Transmit_IT()
HAL_I2S_Receive_IT()
HAL_I2S_Transmit_DMA()
HAL_I2S_Receive_DMA()
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()
HAL_I2S_GetState()
HAL_I2S_GetError()
Peripheral State and Errors functions
This subsection permits to get in run-time the status of the peripheral and the data flow.
This section contains the following APIs:


23.2.5
23.2.6
332/692
HAL_I2S_GetState()
HAL_I2S_GetError()
HAL_I2S_Init
Function Name
HAL_StatusTypeDef HAL_I2S_Init (I2S_HandleTypeDef * hi2s)
Function Description
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
HAL_I2S_DeInit
Function Name
HAL_StatusTypeDef HAL_I2S_DeInit (I2S_HandleTypeDef *
hi2s)
Function Description
DeInitializes the I2S peripheral.
Parameters

hi2s: pointer to a I2S_HandleTypeDef structure that contains
DOCID028236 Rev 1
UM1940
HAL I2S Generic Driver
the configuration information for I2S module
Return values
23.2.7
23.2.8
23.2.9

HAL_I2S_MspInit
Function Name
void HAL_I2S_MspInit (I2S_HandleTypeDef * hi2s)
Function Description
I2S MSP Init.
Parameters

hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values

None
HAL_I2S_MspDeInit
Function Name
void HAL_I2S_MspDeInit (I2S_HandleTypeDef * hi2s)
Function Description
I2S MSP DeInit.
Parameters

hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values

None
HAL_I2S_Transmit
Function Name
HAL_StatusTypeDef HAL_I2S_Transmit (I2S_HandleTypeDef *
hi2s, uint16_t * pData, uint16_t Size, uint32_t Timeout)
Function Description
Transmit an amount of data in blocking mode.
Parameters




hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
pData: a 16-bit pointer to data buffer.
Size: number of data sample to be sent:
Timeout: Timeout duration
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).

23.2.10
HAL status
HAL_I2S_Receive
Function Name
HAL_StatusTypeDef HAL_I2S_Receive (I2S_HandleTypeDef *
hi2s, uint16_t * pData, uint16_t Size, uint32_t Timeout)
Function Description
Receive an amount of data in blocking mode.
Parameters

hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
DOCID028236 Rev 1
333/692
HAL I2S Generic Driver
UM1940



pData: a 16-bit pointer to data buffer.
Size: number of data sample to be sent:
Timeout: Timeout duration
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).
In I2S Master Receiver mode, just after enabling the
peripheral the clock will be generate in continuous way and as
the I2S is not disabled at the end of the I2S transaction.


23.2.11
HAL_I2S_Transmit_IT
Function Name
HAL_StatusTypeDef HAL_I2S_Transmit_IT
(I2S_HandleTypeDef * hi2s, uint16_t * pData, uint16_t Size)
Function Description
Transmit an amount of data in non-blocking mode with Interrupt.
Parameters



hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
pData: a 16-bit pointer to data buffer.
Size: number of data sample to be sent:
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).

23.2.12
334/692
HAL_I2S_Receive_IT
Function Name
HAL_StatusTypeDef HAL_I2S_Receive_IT
(I2S_HandleTypeDef * hi2s, uint16_t * pData, uint16_t Size)
Function Description
Receive an amount of data in non-blocking mode with Interrupt.
Parameters



hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
pData: a 16-bit pointer to the Receive data buffer.
Size: number of data sample to be sent:
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
DOCID028236 Rev 1
UM1940


23.2.13
HAL_I2S_Transmit_DMA
Function Name
HAL_StatusTypeDef HAL_I2S_Transmit_DMA
(I2S_HandleTypeDef * hi2s, uint16_t * pData, uint16_t Size)
Function Description
Transmit an amount of data in non-blocking mode with DMA.
Parameters



hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
pData: a 16-bit pointer to the Transmit data buffer.
Size: number of data sample to be sent:
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).

23.2.14
HAL I2S Generic Driver
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).
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.
HAL_I2S_Receive_DMA
Function Name
HAL_StatusTypeDef HAL_I2S_Receive_DMA
(I2S_HandleTypeDef * hi2s, uint16_t * pData, uint16_t Size)
Function Description
Receive an amount of data in non-blocking mode with DMA.
Parameters



hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
pData: a 16-bit pointer to the Receive data buffer.
Size: number of data sample to be sent:
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).

DOCID028236 Rev 1
335/692
HAL I2S Generic Driver
23.2.15
23.2.16
23.2.17
23.2.18
23.2.19
23.2.20
HAL_I2S_DMAPause
Function Name
HAL_StatusTypeDef HAL_I2S_DMAPause
(I2S_HandleTypeDef * hi2s)
Function Description
Pauses the audio stream playing from the Media.
Parameters

hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values

HAL status
HAL_I2S_DMAResume
Function Name
HAL_StatusTypeDef HAL_I2S_DMAResume
(I2S_HandleTypeDef * hi2s)
Function Description
Resumes the audio stream playing from the Media.
Parameters

hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values

HAL status
HAL_I2S_DMAStop
Function Name
HAL_StatusTypeDef HAL_I2S_DMAStop (I2S_HandleTypeDef
* hi2s)
Function Description
Resumes the audio stream playing from the Media.
Parameters

hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values

HAL status
HAL_I2S_IRQHandler
Function Name
void HAL_I2S_IRQHandler (I2S_HandleTypeDef * hi2s)
Function Description
This function handles I2S interrupt request.
Parameters

hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values

None
HAL_I2S_TxHalfCpltCallback
Function Name
void HAL_I2S_TxHalfCpltCallback (I2S_HandleTypeDef * hi2s)
Function Description
Tx Transfer Half completed callbacks.
Parameters

hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values

None
HAL_I2S_TxCpltCallback
Function Name
336/692
UM1940
void HAL_I2S_TxCpltCallback (I2S_HandleTypeDef * hi2s)
DOCID028236 Rev 1
UM1940
23.2.21
23.2.22
23.2.23
23.2.24
23.2.25
HAL I2S Generic Driver
Function Description
Tx Transfer completed callbacks.
Parameters

hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values

None
HAL_I2S_RxHalfCpltCallback
Function Name
void HAL_I2S_RxHalfCpltCallback (I2S_HandleTypeDef * hi2s)
Function Description
Rx Transfer half completed callbacks.
Parameters

hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values

None
HAL_I2S_RxCpltCallback
Function Name
void HAL_I2S_RxCpltCallback (I2S_HandleTypeDef * hi2s)
Function Description
Rx Transfer completed callbacks.
Parameters

hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values

None
HAL_I2S_ErrorCallback
Function Name
void HAL_I2S_ErrorCallback (I2S_HandleTypeDef * hi2s)
Function Description
I2S error callbacks.
Parameters

hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values

None
HAL_I2S_GetState
Function Name
HAL_I2S_StateTypeDef HAL_I2S_GetState
(I2S_HandleTypeDef * hi2s)
Function Description
Return the I2S state.
Parameters

hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values

HAL state
HAL_I2S_GetError
Function Name
uint32_t HAL_I2S_GetError (I2S_HandleTypeDef * hi2s)
Function Description
Return the I2S error code.
Parameters

hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values

I2S Error Code
DOCID028236 Rev 1
337/692
HAL I2S Generic Driver
23.2.26
23.2.27
UM1940
HAL_I2S_GetState
Function Name
HAL_I2S_StateTypeDef HAL_I2S_GetState
(I2S_HandleTypeDef * hi2s)
Function Description
Return the I2S state.
Parameters

hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values

HAL state
HAL_I2S_GetError
Function Name
uint32_t HAL_I2S_GetError (I2S_HandleTypeDef * hi2s)
Function Description
Return the I2S error code.
Parameters

hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values

I2S Error Code
23.3
I2S Firmware driver defines
23.3.1
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
I2S Clock Polarity
I2S_CPOL_LOW
I2S_CPOL_HIGH
I2S Clock Source
I2S_CLOCK_PLL
I2S_CLOCK_EXTERNAL
I2S Data Format
I2S_DATAFORMAT_16B
I2S_DATAFORMAT_16B_EXTENDED
338/692
DOCID028236 Rev 1
UM1940
HAL I2S Generic Driver
I2S_DATAFORMAT_24B
I2S_DATAFORMAT_32B
I2S Error Code
HAL_I2S_ERROR_NONE
No error
HAL_I2S_ERROR_UDR
I2S Underrun error
HAL_I2S_ERROR_OVR
I2S Overrun error
HAL_I2SEX_ERROR_UDR
I2S extended Underrun error
HAL_I2SEX_ERROR_OVR
I2S extended Overrun error
HAL_I2S_ERROR_FRE
I2S Frame format error
HAL_I2S_ERROR_DMA
DMA transfer error
I2S Exported Macros
__HAL_I2S_RESET_HANDLE_STATE
Description:

Reset I2S handle state.
Parameters:

__HANDLE__: specifies the I2S Handle.
Return value:

__HAL_I2S_ENABLE
None
Description:

Enable or disable the specified SPI
peripheral (in I2S mode).
Parameters:

__HANDLE__: specifies the I2S Handle.
Return value:

None
__HAL_I2S_DISABLE
__HAL_I2S_ENABLE_IT
Description:

Enable or disable the specified I2S
interrupts.
Parameters:


__HANDLE__: specifies the I2S Handle.
__INTERRUPT__: specifies the interrupt
source to enable or disable. This parameter
can be one of the following values:

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:
DOCID028236 Rev 1
339/692
HAL I2S Generic Driver
UM1940

None
__HAL_I2S_DISABLE_IT
__HAL_I2S_GET_IT_SOURCE
Description:

Checks if the specified I2S interrupt source
is enabled or disabled.
Parameters:


__HANDLE__: specifies the I2S Handle.
This parameter can be I2S where x: 1, 2, or
3 to select the I2S peripheral.
__INTERRUPT__: specifies the I2S
interrupt source to check. This parameter
can be one of the following values:

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:

The: new state of __IT__ (TRUE or FALSE).
Description:
__HAL_I2S_GET_FLAG

Checks whether the specified I2S flag is set
or not.
Parameters:


__HANDLE__: specifies the I2S Handle.
__FLAG__: specifies the flag to check. This
parameter can be one of the following
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
The: new state of __FLAG__ (TRUE or
FALSE).
Description:

Clears the I2S OVR pending flag.
Parameters:

__HANDLE__: specifies the I2S Handle.
Return value:
340/692
DOCID028236 Rev 1
UM1940
HAL I2S Generic Driver

__HAL_I2S_CLEAR_UDRFLAG
None
Description:

Clears the I2S UDR pending flag.
Parameters:

__HANDLE__: specifies the I2S Handle.
Return value:

None
I2S Flags Definition
I2S_FLAG_TXE
I2S_FLAG_RXNE
I2S_FLAG_UDR
I2S_FLAG_OVR
I2S_FLAG_FRE
I2S_FLAG_CHSIDE
I2S_FLAG_BSY
I2S Interrupts Definition
I2S_IT_TXE
I2S_IT_RXNE
I2S_IT_ERR
I2S Mclk Output
I2S_MCLKOUTPUT_ENABLE
I2S_MCLKOUTPUT_DISABLE
I2S Mode
I2S_MODE_SLAVE_TX
I2S_MODE_SLAVE_RX
I2S_MODE_MASTER_TX
I2S_MODE_MASTER_RX
I2S Private Macros
IS_I2S_CLOCKSOURCE
IS_I2S_MODE
IS_I2S_STANDARD
IS_I2S_DATA_FORMAT
IS_I2S_MCLK_OUTPUT
IS_I2S_AUDIO_FREQ
IS_I2S_CPOL
I2S Standard
DOCID028236 Rev 1
341/692
HAL I2S Generic Driver
I2S_STANDARD_PHILIPS
UM1940
I2S_STANDARD_MSB
I2S_STANDARD_LSB
I2S_STANDARD_PCM_SHORT
I2S_STANDARD_PCM_LONG
342/692
DOCID028236 Rev 1
UM1940
HAL IRDA Generic Driver
24
HAL IRDA Generic Driver
24.1
IRDA Firmware driver registers structures
24.1.1
IRDA_InitTypeDef
Data Fields






uint32_t BaudRate
uint32_t WordLength
uint32_t Parity
uint32_t Mode
uint8_t Prescaler
uint32_t IrDAMode
Field Documentation






24.1.2
uint32_t IRDA_InitTypeDef::BaudRate
This member configures the IRDA communication baud rate. The baud rate is
computed using the following formula:IntegerDivider = ((PCLKx) / (8 * (hirda>Init.BaudRate)))FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 8)
+ 0.5
uint32_t IRDA_InitTypeDef::WordLength
Specifies the number of data bits transmitted or received in a frame. This parameter
can be a value of IRDA_Word_Length
uint32_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).
uint32_t IRDA_InitTypeDef::Mode
Specifies wether 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
uint32_t IRDA_InitTypeDef::IrDAMode
Specifies the IrDA mode This parameter can be a value of IRDA_Low_Power
IRDA_HandleTypeDef
Data Fields






USART_TypeDef * Instance
IRDA_InitTypeDef Init
uint8_t * pTxBuffPtr
uint16_t TxXferSize
uint16_t TxXferCount
uint8_t * pRxBuffPtr
DOCID028236 Rev 1
343/692
HAL IRDA Generic Driver







UM1940
uint16_t RxXferSize
uint16_t RxXferCount
DMA_HandleTypeDef * hdmatx
DMA_HandleTypeDef * hdmarx
HAL_LockTypeDef Lock
__IO HAL_IRDA_StateTypeDef State
__IO uint32_t ErrorCode
Field Documentation













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
DMA_HandleTypeDef* IRDA_HandleTypeDef::hdmatx
DMA_HandleTypeDef* IRDA_HandleTypeDef::hdmarx
HAL_LockTypeDef IRDA_HandleTypeDef::Lock
__IO HAL_IRDA_StateTypeDef IRDA_HandleTypeDef::State
__IO uint32_t IRDA_HandleTypeDef::ErrorCode
24.2
IRDA Firmware driver API description
24.2.1
How to use this driver
The IRDA HAL driver can be used as follows:
1.
2.
3.
344/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.
NVIC configuration if you need to use interrupt process
(HAL_IRDA_Transmit_IT() and HAL_IRDA_Receive_IT() APIs):

Configure the USARTx interrupt priority.

Enable the NVIC USART IRQ handle.
d.
DMA Configuration if you need to use DMA process
(HAL_IRDA_Transmit_DMA() and HAL_IRDA_Receive_DMA() APIs):

Declare a DMA handle structure for the Tx/Rx stream.

Enable the DMAx interface clock.

Configure the declared DMA handle structure with the required Tx/Rx
parameters.

Configure the DMA Tx/Rx Stream.

Associate the initialized DMA handle to the IRDA DMA Tx/Rx handle.

Configure the priority and enable the NVIC for the transfer complete
interrupt on the DMA Tx/Rx Stream.
Program the Baud Rate, Word Length, Parity, IrDA Mode, Prescaler and
Mode(Receiver/Transmitter) in the hirda Init structure.
DOCID028236 Rev 1
UM1940
4.
5.
HAL IRDA Generic Driver
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 customized 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 :
Polling mode IO operation


Send an amount of data in blocking mode using HAL_IRDA_Transmit()
Receive an amount of data in blocking mode using HAL_IRDA_Receive()
Interrupt mode IO operation





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
DMA mode IO operation





Send an amount of data in non blocking mode (DMA) using
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
Receive an amount of data in non blocking mode (DMA) using
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
You can refer to the IRDA HAL driver header file for more useful macros
24.2.2
Initialization and Configuration functions
This subsection provides a set of functions allowing to initialize the USARTx or the UARTy
in IrDA mode.

For the asynchronous mode only these parameters can be configured:

BaudRate
DOCID028236 Rev 1
345/692
HAL IRDA Generic Driver





UM1940
WordLength
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), please refer to Reference manual for
possible IRDA frame formats.
Prescaler: A pulse of width less than two and greater than one PSC period(s)
may or may not be rejected. The receiver set up time should be managed by
software. The IrDA physical layer specification specifies a minimum of 10 ms
delay between transmission and reception (IrDA is a half duplex protocol).
Mode: Receiver/transmitter modes
IrDAMode: the IrDA can operate in the Normal mode or in the Low power mode.
The HAL_IRDA_Init() API follows IRDA configuration procedures (details for the
procedures are available in reference manual).
This section contains the following APIs:




24.2.3
HAL_IRDA_Init()
HAL_IRDA_DeInit()
HAL_IRDA_MspInit()
HAL_IRDA_MspDeInit()
IO operation functions
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.
2.
3.
4.
5.
There are two modes of transfer:

Blocking mode: The communication is performed in polling mode. The HAL
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 APIs 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 respectively 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 APIs with Interrupt are :

HAL_IRDA_Transmit_IT()

HAL_IRDA_Receive_IT()

HAL_IRDA_IRQHandler()
Non Blocking mode functions with DMA are :

HAL_IRDA_Transmit_DMA()

HAL_IRDA_Receive_DMA()
A set of Transfer Complete Callbacks are provided in non Blocking mode:

HAL_IRDA_TxCpltCallback()

HAL_IRDA_RxCpltCallback()

HAL_IRDA_ErrorCallback()
This section contains the following APIs:

346/692
HAL_IRDA_Transmit()
DOCID028236 Rev 1
UM1940
HAL IRDA Generic Driver














24.2.4
HAL_IRDA_Receive()
HAL_IRDA_Transmit_IT()
HAL_IRDA_Receive_IT()
HAL_IRDA_Transmit_DMA()
HAL_IRDA_Receive_DMA()
HAL_IRDA_DMAPause()
HAL_IRDA_DMAResume()
HAL_IRDA_DMAStop()
HAL_IRDA_IRQHandler()
HAL_IRDA_TxCpltCallback()
HAL_IRDA_TxHalfCpltCallback()
HAL_IRDA_RxCpltCallback()
HAL_IRDA_RxHalfCpltCallback()
HAL_IRDA_ErrorCallback()
Peripheral State and Errors functions
This subsection provides a set of functions allowing to return the State of IrDA
communication process and also return Peripheral Errors occurred during communication
process


HAL_IRDA_GetState() API can be helpful to check in run-time the state of the IrDA
peripheral.
HAL_IRDA_GetError() check in run-time errors that could be occurred during
communication.
This section contains the following APIs:


24.2.5
24.2.6
24.2.7
HAL_IRDA_GetState()
HAL_IRDA_GetError()
HAL_IRDA_Init
Function Name
HAL_StatusTypeDef HAL_IRDA_Init (IRDA_HandleTypeDef *
hirda)
Function Description
Initializes the IRDA mode according to the specified parameters in
the IRDA_InitTypeDef and create the associated handle.
Parameters

hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
Return values

HAL status
HAL_IRDA_DeInit
Function Name
HAL_StatusTypeDef HAL_IRDA_DeInit (IRDA_HandleTypeDef
* hirda)
Function Description
DeInitializes the IRDA peripheral.
Parameters

hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
Return values

HAL status
HAL_IRDA_MspInit
DOCID028236 Rev 1
347/692
HAL IRDA Generic Driver
Function Name
24.2.8
24.2.9
Function Description
IRDA MSP Init.
Parameters

hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
Return values

None
HAL_IRDA_MspDeInit
Function Name
void HAL_IRDA_MspDeInit (IRDA_HandleTypeDef * hirda)
Function Description
IRDA MSP DeInit.
Parameters

hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
Return values

None
HAL_IRDA_Transmit
Function Name
HAL_StatusTypeDef HAL_IRDA_Transmit
(IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size,
uint32_t Timeout)
Function Description
Sends an amount of data in blocking mode.
Parameters

Return values
24.2.10

HAL status
Function Name
HAL_StatusTypeDef HAL_IRDA_Receive
(IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size,
uint32_t Timeout)
Function Description
Receive an amount of data in blocking mode.
Parameters




hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
pData: Pointer to data buffer
Size: Amount of data to be received
Timeout: Specify timeout value

HAL status
HAL_IRDA_Transmit_IT
Function Name
348/692



hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
pData: Pointer to data buffer
Size: Amount of data to be sent
Timeout: Specify timeout value
HAL_IRDA_Receive
Return values
24.2.11
UM1940
void HAL_IRDA_MspInit (IRDA_HandleTypeDef * hirda)
HAL_StatusTypeDef HAL_IRDA_Transmit_IT
DOCID028236 Rev 1
UM1940
HAL IRDA Generic Driver
(IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size)
Function Description
Send an amount of data in non blocking mode.
Parameters

Return values
24.2.12
HAL status
Function Name
HAL_StatusTypeDef HAL_IRDA_Receive_IT
(IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size)
Function Description
Receives an amount of data in non blocking mode.
Parameters



hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
pData: Pointer to data buffer
Size: Amount of data to be received

HAL status
HAL_IRDA_Transmit_DMA
Function Name
HAL_StatusTypeDef HAL_IRDA_Transmit_DMA
(IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size)
Function Description
Sends an amount of data in non blocking mode.
Parameters

Return values
24.2.14

HAL_IRDA_Receive_IT
Return values
24.2.13


hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
pData: Pointer to data buffer
Size: Amount of data to be sent


hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
pData: Pointer to data buffer
Size: Amount of data to be sent

HAL status
HAL_IRDA_Receive_DMA
Function Name
HAL_StatusTypeDef HAL_IRDA_Receive_DMA
(IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size)
Function Description
Receives an amount of data in non blocking mode.
Parameters



hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
pData: Pointer to data buffer
Size: Amount of data to be received
Return values

HAL status
Notes

When the IRDA parity is enabled (PCE = 1) the data received
contain the parity bit.
DOCID028236 Rev 1
349/692
HAL IRDA Generic Driver
24.2.15
24.2.16
24.2.17
24.2.18
24.2.19
350/692
UM1940
HAL_IRDA_DMAPause
Function Name
HAL_StatusTypeDef HAL_IRDA_DMAPause
(IRDA_HandleTypeDef * hirda)
Function Description
Pauses the DMA Transfer.
Parameters

hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
Return values

HAL status
HAL_IRDA_DMAResume
Function Name
HAL_StatusTypeDef HAL_IRDA_DMAResume
(IRDA_HandleTypeDef * hirda)
Function Description
Resumes the DMA Transfer.
Parameters

hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified UART
module.
Return values

HAL status
HAL_IRDA_DMAStop
Function Name
HAL_StatusTypeDef HAL_IRDA_DMAStop
(IRDA_HandleTypeDef * hirda)
Function Description
Stops the DMA Transfer.
Parameters

hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified UART
module.
Return values

HAL status
HAL_IRDA_IRQHandler
Function Name
void HAL_IRDA_IRQHandler (IRDA_HandleTypeDef * hirda)
Function Description
This function handles IRDA interrupt request.
Parameters

hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
Return values

None
HAL_IRDA_TxCpltCallback
Function Name
void HAL_IRDA_TxCpltCallback (IRDA_HandleTypeDef *
hirda)
Function Description
Tx Transfer complete callbacks.
Parameters

hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
DOCID028236 Rev 1
UM1940
HAL IRDA Generic Driver
Return values
24.2.20
24.2.21
24.2.22
24.2.23
24.2.24

None
HAL_IRDA_TxHalfCpltCallback
Function Name
void HAL_IRDA_TxHalfCpltCallback (IRDA_HandleTypeDef *
hirda)
Function Description
Tx Half Transfer completed callbacks.
Parameters

hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified
USART module.
Return values

None
HAL_IRDA_RxCpltCallback
Function Name
void HAL_IRDA_RxCpltCallback (IRDA_HandleTypeDef *
hirda)
Function Description
Rx Transfer complete callbacks.
Parameters

hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
Return values

None
HAL_IRDA_RxHalfCpltCallback
Function Name
void HAL_IRDA_RxHalfCpltCallback (IRDA_HandleTypeDef *
hirda)
Function Description
Rx Half Transfer complete callbacks.
Parameters

hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
Return values

None
HAL_IRDA_ErrorCallback
Function Name
void HAL_IRDA_ErrorCallback (IRDA_HandleTypeDef * hirda)
Function Description
IRDA error callbacks.
Parameters

hirda: pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
Return values

None
HAL_IRDA_GetState
Function Name
HAL_IRDA_StateTypeDef HAL_IRDA_GetState
(IRDA_HandleTypeDef * hirda)
Function Description
Returns the IRDA state.
Parameters

hirda: pointer to a IRDA_HandleTypeDef structure that
DOCID028236 Rev 1
351/692
HAL IRDA Generic Driver
Return values
24.2.25
UM1940
contains the configuration information for the specified IRDA
module.

HAL state
HAL_IRDA_GetError
Function Name
uint32_t HAL_IRDA_GetError (IRDA_HandleTypeDef * hirda)
Function Description
Return the IARDA error code.
Parameters

hirda: : pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA.
Return values

IRDA Error Code
24.3
IRDA Firmware driver defines
24.3.1
IRDA
IRDA Error Code
HAL_IRDA_ERROR_NONE
No error
HAL_IRDA_ERROR_PE
Parity error
HAL_IRDA_ERROR_NE
Noise error
HAL_IRDA_ERROR_FE
Frame error
HAL_IRDA_ERROR_ORE
Overrun error
HAL_IRDA_ERROR_DMA
DMA transfer error
IRDA Exported Macros
__HAL_IRDA_RESET_HANDLE_STATE
Description:

Reset IRDA handle state.
Parameters:

__HANDLE__: specifies the USART
Handle. This parameter can be
USARTx where x: 1, 2, 3, 4, 5, 6, 7 or
8 to select the USART or UART
peripheral.
Return value:

__HAL_IRDA_FLUSH_DRREGISTER
None
Description:

Flushes the IRDA DR register.
Parameters:

352/692
DOCID028236 Rev 1
__HANDLE__: specifies the USART
Handle. This parameter can be
USARTx where x: 1, 2, 3, 4, 5, 6, 7 or
8 to select the USART or UART
peripheral.
UM1940
HAL IRDA Generic Driver
Description:
__HAL_IRDA_GET_FLAG

Checks whether the specified IRDA
flag is set or not.
Parameters:


__HANDLE__: specifies the USART
Handle. This parameter can be
USARTx where x: 1, 2, 3, 4, 5, 6, 7 or
8 to select the USART or UART
peripheral.
__FLAG__: specifies the flag to
check. This parameter can be one of
the following values:

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_CLEAR_FLAG
The: new state of __FLAG__ (TRUE
or FALSE).
Description:

Clears the specified IRDA pending
flag.
Parameters:


__HANDLE__: specifies the USART
Handle. This parameter can be
USARTx where x: 1, 2, 3, 4, 5, 6, 7 or
8 to select the USART or UART
peripheral.
__FLAG__: specifies the flag to
check. This parameter can be any
combination of the following values:

IRDA_FLAG_TC: Transmission
Complete flag.

IRDA_FLAG_RXNE: Receive
data register not empty flag.
Return value:
DOCID028236 Rev 1
353/692
HAL IRDA Generic Driver
UM1940

None
Notes:

__HAL_IRDA_CLEAR_PEFLAG
PE (Parity error), FE (Framing error),
NE (Noise error), ORE (OverRun
error) and IDLE (Idle line detected)
flags are cleared by software
sequence: a read operation to
USART_SR register followed by a
read operation to USART_DR
register. RXNE flag can be also
cleared by a read to the USART_DR
register. TC flag can be also cleared
by software sequence: a read
operation to USART_SR register
followed by a write operation to
USART_DR register. TXE flag is
cleared only by a write to the
USART_DR register.
Description:

Clear the IRDA PE pending flag.
Parameters:

__HANDLE__: specifies the USART
Handle. This parameter can be
USARTx where x: 1, 2, 3, 4, 5, 6, 7 or
8 to select the USART or UART
peripheral.
Return value:

__HAL_IRDA_CLEAR_FEFLAG
None
Description:

Clear the IRDA FE pending flag.
Parameters:

__HANDLE__: specifies the USART
Handle. This parameter can be
USARTx where x: 1, 2, 3, 4, 5, 6, 7 or
8 to select the USART or UART
peripheral.
Return value:

__HAL_IRDA_CLEAR_NEFLAG
None
Description:

Clear the IRDA NE pending flag.
Parameters:

354/692
DOCID028236 Rev 1
__HANDLE__: specifies the USART
Handle. This parameter can be
USARTx where x: 1, 2, 3, 4, 5, 6, 7 or
8 to select the USART or UART
UM1940
HAL IRDA Generic Driver
peripheral.
Return value:

__HAL_IRDA_CLEAR_OREFLAG
None
Description:

Clear the IRDA ORE pending flag.
Parameters:

__HANDLE__: specifies the USART
Handle. This parameter can be
USARTx where x: 1, 2, 3, 4, 5, 6, 7 or
8 to select the USART or UART
peripheral.
Return value:

__HAL_IRDA_CLEAR_IDLEFLAG
None
Description:

Clear the IRDA IDLE pending flag.
Parameters:

__HANDLE__: specifies the USART
Handle. This parameter can be
USARTx where x: 1, 2, 3, 4, 5, 6, 7 or
8 to select the USART or UART
peripheral.
Return value:

__HAL_IRDA_ENABLE_IT
None
Description:

Enables or disables the specified
IRDA interrupt.
Parameters:


DOCID028236 Rev 1
__HANDLE__: specifies the USART
Handle. This parameter can be
USARTx where x: 1, 2, 3, 4, 5, 6, 7 or
8 to select the USART or UART
peripheral.
__INTERRUPT__: specifies the IRDA
interrupt source to check. This
parameter can be one of the following
values:

IRDA_IT_TXE: Transmit Data
Register empty interrupt

IRDA_IT_TC: Transmission
complete interrupt

IRDA_IT_RXNE: Receive Data
register not empty interrupt

IRDA_IT_IDLE: Idle line
detection interrupt

IRDA_IT_PE: Parity Error
355/692
HAL IRDA Generic Driver

UM1940
interrupt
IRDA_IT_ERR: Error
interrupt(Frame error, noise
error, overrun error)
Return value:

None
__HAL_IRDA_DISABLE_IT
__HAL_IRDA_GET_IT_SOURCE
Description:

Checks whether the specified IRDA
interrupt has occurred or not.
Parameters:


__HANDLE__: specifies the USART
Handle. This parameter can be
USARTx where x: 1, 2, 3, 4, 5, 6, 7 or
8 to select the USART or UART
peripheral.
__IT__: specifies the IRDA interrupt
source to check. This parameter can
be one of the following values:

IRDA_IT_TXE: Transmit Data
Register empty interrupt

IRDA_IT_TC: Transmission
complete interrupt

IRDA_IT_RXNE: Receive Data
register not empty interrupt

IRDA_IT_IDLE: Idle line
detection interrupt

USART_IT_ERR: Error interrupt

IRDA_IT_PE: Parity Error
interrupt
Return value:

__HAL_IRDA_ONE_BIT_SAMPLE_ENABLE
The: new state of __IT__ (TRUE or
FALSE).
Description:

Macro to enable the IRDA's one bit
sample method.
Parameters:

__HANDLE__: specifies the IRDA
Handle.
Return value:

__HAL_IRDA_ONE_BIT_SAMPLE_DISABLE
None
Description:

Macro to disable the IRDA's one bit
sample method.
Parameters:
356/692
DOCID028236 Rev 1
UM1940
HAL IRDA Generic Driver

__HANDLE__: specifies the IRDA
Handle.
Return value:

__HAL_IRDA_ENABLE
None
Description:

Enable UART/USART associated to
IRDA Handle.
Parameters:

__HANDLE__: specifies the IRDA
Handle. IRDA Handle selects the
USARTx or UARTy peripheral
(USART,UART availability and x,y
values depending on device).
Return value:

__HAL_IRDA_DISABLE
None
Description:

Disable UART/USART associated to
IRDA Handle.
Parameters:

__HANDLE__: specifies the IRDA
Handle. IRDA Handle selects the
USARTx or UARTy peripheral
(USART,UART availability and x,y
values depending on device).
Return value:

None
IRDA Flags
IRDA_FLAG_TXE
IRDA_FLAG_TC
IRDA_FLAG_RXNE
IRDA_FLAG_IDLE
IRDA_FLAG_ORE
IRDA_FLAG_NE
IRDA_FLAG_FE
IRDA_FLAG_PE
IRDA Interrupt Definitions
IRDA_IT_PE
IRDA_IT_TXE
IRDA_IT_TC
IRDA_IT_RXNE
DOCID028236 Rev 1
357/692
HAL IRDA Generic Driver
IRDA_IT_IDLE
UM1940
IRDA_IT_LBD
IRDA_IT_CTS
IRDA_IT_ERR
IRDA Low Power
IRDA_POWERMODE_LOWPOWER
IRDA_POWERMODE_NORMAL
IRDA Transfer Mode
IRDA_MODE_RX
IRDA_MODE_TX
IRDA_MODE_TX_RX
IRDA Parity
IRDA_PARITY_NONE
IRDA_PARITY_EVEN
IRDA_PARITY_ODD
IRDA Private Constants
IRDA_TIMEOUT_VALUE
IRDA_IT_MASK
IRDA_CR1_REG_INDEX
IRDA_CR2_REG_INDEX
IRDA_CR3_REG_INDEX
IRDA Private Macros
IS_IRDA_WORD_LENGTH
IS_IRDA_PARITY
IS_IRDA_MODE
IS_IRDA_POWERMODE
IS_IRDA_BAUDRATE
IRDA_DIV
IRDA_DIVMANT
IRDA_DIVFRAQ
IRDA_BRR
IRDA Word Length
IRDA_WORDLENGTH_8B
IRDA_WORDLENGTH_9B
358/692
DOCID028236 Rev 1
UM1940
HAL IWDG Generic Driver
25
HAL IWDG Generic Driver
25.1
IWDG Firmware driver registers structures
25.1.1
IWDG_InitTypeDef
Data Fields


uint32_t Prescaler
uint32_t Reload
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
IWDG_HandleTypeDef
Data Fields




IWDG_TypeDef * Instance
IWDG_InitTypeDef Init
HAL_LockTypeDef Lock
__IO HAL_IWDG_StateTypeDef State
Field Documentation




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
25.2
IWDG Firmware driver API description
25.2.1
IWDG Specific features

The IWDG can be started by either software or hardware (configurable through option
byte).
DOCID028236 Rev 1
359/692
HAL IWDG Generic Driver




25.2.2
UM1940
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 @32KHz (LSI): ~125us / ~32.7s The IWDG timeout may vary
due to LSI frequency dispersion. STM32F2xx devices provide the capability to
measure the LSI frequency (LSI clock connected internally to TIM5 CH4 input
capture). The measured value can be used to have an IWDG timeout with an
acceptable accuracy.
How to use this driver
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.



25.2.3
__HAL_IWDG_START: Enable the IWDG peripheral
__HAL_IWDG_RELOAD_COUNTER: Reloads IWDG counter with value defined in
the reload register
__HAL_IWDG_GET_FLAG: Get the selected IWDG's flag status
Initialization and de-initialization functions
This section provides functions allowing to:
360/692
DOCID028236 Rev 1
UM1940
HAL IWDG Generic Driver



Initialize the IWDG according to the specified parameters in the IWDG_InitTypeDef
and create the associated handle
Initialize the IWDG MSP
DeInitialize IWDG MSP
This section contains the following APIs:


25.2.4
HAL_IWDG_Init()
HAL_IWDG_MspInit()
IO operation functions
This section provides functions allowing to:


Start the IWDG.
Refresh the IWDG.
This section contains the following APIs:


25.2.5
HAL_IWDG_Start()
HAL_IWDG_Refresh()
Peripheral State functions
This subsection permits to get in run-time the status of the peripheral and the data flow.
This section contains the following APIs:

25.2.6
25.2.7
25.2.8
HAL_IWDG_GetState()
HAL_IWDG_Init
Function Name
HAL_StatusTypeDef HAL_IWDG_Init (IWDG_HandleTypeDef *
hiwdg)
Function Description
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
HAL_IWDG_MspInit
Function Name
void HAL_IWDG_MspInit (IWDG_HandleTypeDef * hiwdg)
Function Description
Initializes the IWDG MSP.
Parameters

hiwdg: pointer to a IWDG_HandleTypeDef structure that
contains the configuration information for the specified IWDG
module.
Return values

None
HAL_IWDG_Start
Function Name
HAL_StatusTypeDef HAL_IWDG_Start (IWDG_HandleTypeDef
* hiwdg)
Function Description
Starts the IWDG.
DOCID028236 Rev 1
361/692
HAL IWDG Generic Driver
Parameters

hiwdg: pointer to a IWDG_HandleTypeDef structure that
contains the configuration information for the specified IWDG
module.
Return values

HAL status
25.2.9
25.2.10
UM1940
HAL_IWDG_Refresh
Function Name
HAL_StatusTypeDef HAL_IWDG_Refresh
(IWDG_HandleTypeDef * hiwdg)
Function Description
Refreshes the IWDG.
Parameters

hiwdg: pointer to a IWDG_HandleTypeDef structure that
contains the configuration information for the specified IWDG
module.
Return values

HAL status
HAL_IWDG_GetState
Function Name
HAL_IWDG_StateTypeDef HAL_IWDG_GetState
(IWDG_HandleTypeDef * hiwdg)
Function Description
Returns the IWDG state.
Parameters

hiwdg: pointer to a IWDG_HandleTypeDef structure that
contains the configuration information for the specified IWDG
module.
Return values

HAL state
25.3
IWDG Firmware driver defines
25.3.1
IWDG
IWDG Exported Macros
__HAL_IWDG_RESET_HANDLE_STATE
Description:

Reset IWDG handle state.
Parameters:

__HANDLE__: IWDG handle.
Return value:

None
Description:
__HAL_IWDG_START

Enables the IWDG peripheral.
Parameters:

__HANDLE__: IWDG handle
Return value:

__HAL_IWDG_RELOAD_COUNTER
362/692
None
Description:
DOCID028236 Rev 1
UM1940
HAL IWDG Generic Driver

Reloads IWDG counter with value defined
in the reload register (write access to
IWDG_PR and IWDG_RLR registers
disabled).
Parameters:

__HANDLE__: IWDG handle
Return value:

None
Description:
__HAL_IWDG_GET_FLAG

Gets the selected IWDG's flag status.
Parameters:


__HANDLE__: IWDG handle
__FLAG__: specifies the flag to check.
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
Return value:

The: new state of __FLAG__ (TRUE or
FALSE).
IWDG Flag definition
IWDG_FLAG_PVU
Watchdog counter prescaler value update Flag
IWDG_FLAG_RVU
Watchdog counter reload value update Flag
IWDG Prescaler
IWDG_PRESCALER_4
IWDG prescaler set to 4
IWDG_PRESCALER_8
IWDG prescaler set to 8
IWDG_PRESCALER_16
IWDG prescaler set to 16
IWDG_PRESCALER_32
IWDG prescaler set to 32
IWDG_PRESCALER_64
IWDG prescaler set to 64
IWDG_PRESCALER_128
IWDG prescaler set to 128
IWDG_PRESCALER_256
IWDG prescaler set to 256
IWDG Private Constants
IWDG_TIMEOUT_FLAG
IWDG Private Macros
IWDG_ENABLE_WRITE_ACCESS
Description:

Enables write access to IWDG_PR and
IWDG_RLR registers.
Parameters:
DOCID028236 Rev 1
363/692
HAL IWDG Generic Driver
UM1940

__HANDLE__: IWDG handle
Return value:

IWDG_DISABLE_WRITE_ACCESS
None
Description:

Disables write access to IWDG_PR and
IWDG_RLR registers.
Parameters:

__HANDLE__: IWDG handle
Return value:

None
IS_IWDG_PRESCALER
IS_IWDG_RELOAD
IWDG Registers BitMask
364/692
IWDG_KEY_RELOAD
IWDG Reload Counter Enable
IWDG_KEY_ENABLE
IWDG Peripheral Enable
IWDG_KEY_WRITE_ACCESS_ENABLE
IWDG KR Write Access Enable
IWDG_KEY_WRITE_ACCESS_DISABLE
IWDG KR Write Access Disable
DOCID028236 Rev 1
UM1940
HAL NAND Generic Driver
26
HAL NAND Generic Driver
26.1
NAND Firmware driver registers structures
26.1.1
NAND_IDTypeDef
Data Fields




uint8_t Maker_Id
uint8_t Device_Id
uint8_t Third_Id
uint8_t Fourth_Id
Field Documentation




26.1.2
uint8_t NAND_IDTypeDef::Maker_Id
uint8_t NAND_IDTypeDef::Device_Id
uint8_t NAND_IDTypeDef::Third_Id
uint8_t NAND_IDTypeDef::Fourth_Id
NAND_AddressTypeDef
Data Fields



uint16_t Page
uint16_t Zone
uint16_t Block
Field Documentation



26.1.3
uint16_t NAND_AddressTypeDef::Page
NAND memory Page address
uint16_t NAND_AddressTypeDef::Zone
NAND memory Zone address
uint16_t NAND_AddressTypeDef::Block
NAND memory Block address
NAND_InfoTypeDef
Data Fields




uint32_t PageSize
uint32_t SpareAreaSize
uint32_t BlockSize
uint32_t BlockNbr
DOCID028236 Rev 1
365/692
HAL NAND Generic Driver

UM1940
uint32_t ZoneSize
Field Documentation





26.1.4
uint32_t NAND_InfoTypeDef::PageSize
NAND memory page (without spare area) size measured in K. bytes
uint32_t NAND_InfoTypeDef::SpareAreaSize
NAND memory spare area size measured in K. bytes
uint32_t NAND_InfoTypeDef::BlockSize
NAND memory block size number of pages
uint32_t NAND_InfoTypeDef::BlockNbr
NAND memory number of blocks
uint32_t NAND_InfoTypeDef::ZoneSize
NAND memory zone size measured in number of blocks
NAND_HandleTypeDef
Data Fields





FSMC_NAND_TypeDef * Instance
FSMC_NAND_InitTypeDef Init
HAL_LockTypeDef Lock
__IO HAL_NAND_StateTypeDef State
NAND_InfoTypeDef Info
Field Documentation





FSMC_NAND_TypeDef* NAND_HandleTypeDef::Instance
Register base address
FSMC_NAND_InitTypeDef NAND_HandleTypeDef::Init
NAND device control configuration parameters
HAL_LockTypeDef NAND_HandleTypeDef::Lock
NAND locking object
__IO HAL_NAND_StateTypeDef NAND_HandleTypeDef::State
NAND device access state
NAND_InfoTypeDef NAND_HandleTypeDef::Info
NAND characteristic information structure
26.2
NAND Firmware driver API description
26.2.1
How to use this driver
This driver is a generic layered driver which contains a set of APIs used to control NAND
flash memories. It uses the FSMC layer functions to interface with NAND devices. This
driver is used as follows:

366/692
NAND flash memory configuration sequence using the function HAL_NAND_Init()
with control and timing parameters for both common and attribute spaces.
DOCID028236 Rev 1
UM1940
HAL NAND Generic Driver







Read NAND flash memory maker and device IDs using the function
HAL_NAND_Read_ID(). The read information is stored in the NAND_ID_TypeDef
structure declared by the function caller.
Access NAND flash memory by read/write operations using the functions
HAL_NAND_Read_Page()/HAL_NAND_Read_SpareArea(),
HAL_NAND_Write_Page()/HAL_NAND_Write_SpareArea() to read/write
page(s)/spare area(s). These functions use specific device information (Block, page
size..) predefined by the user in the HAL_NAND_Info_TypeDef structure. The
read/write address information is contained by the Nand_Address_Typedef structure
passed as parameter.
Perform NAND flash Reset chip operation using the function HAL_NAND_Reset().
Perform NAND flash erase block operation using the function
HAL_NAND_Erase_Block(). The erase block address information is contained in the
Nand_Address_Typedef structure passed as parameter.
Read the NAND flash status operation using the function HAL_NAND_Read_Status().
You can also control the NAND device by calling the control APIs
HAL_NAND_ECC_Enable()/ HAL_NAND_ECC_Disable() to respectively
enable/disable the ECC code correction feature or the function HAL_NAND_GetECC()
to get the ECC correction code.
You can monitor the NAND device HAL state by calling the function
HAL_NAND_GetState()
This driver is a set of generic APIs which handle standard NAND flash
operations. If a NAND flash device contains different operations and/or
implementations, it should be implemented separately.
26.2.2
NAND Initialization and de-initialization functions
This section provides functions allowing to initialize/de-initialize the NAND memory
This section contains the following APIs:






26.2.3
HAL_NAND_Init()
HAL_NAND_DeInit()
HAL_NAND_MspInit()
HAL_NAND_MspDeInit()
HAL_NAND_IRQHandler()
HAL_NAND_ITCallback()
NAND Input and Output functions
This section provides functions allowing to use and control the NAND memory
This section contains the following APIs:









HAL_NAND_Read_ID()
HAL_NAND_Reset()
HAL_NAND_Read_Page()
HAL_NAND_Write_Page()
HAL_NAND_Read_SpareArea()
HAL_NAND_Write_SpareArea()
HAL_NAND_Erase_Block()
HAL_NAND_Read_Status()
HAL_NAND_Address_Inc()
DOCID028236 Rev 1
367/692
HAL NAND Generic Driver
26.2.4
UM1940
NAND Control functions
This subsection provides a set of functions allowing to control dynamically the NAND
interface.
This section contains the following APIs:



26.2.5
HAL_NAND_ECC_Enable()
HAL_NAND_ECC_Disable()
HAL_NAND_GetECC()
NAND State functions
This subsection permits to get in run-time the status of the NAND controller and the data
flow.
This section contains the following APIs:


26.2.6
HAL_NAND_GetState()
HAL_NAND_Read_Status()
HAL_NAND_Init
Function Name
HAL_StatusTypeDef HAL_NAND_Init (NAND_HandleTypeDef *
hnand, FSMC_NAND_PCC_TimingTypeDef *
ComSpace_Timing, FSMC_NAND_PCC_TimingTypeDef *
AttSpace_Timing)
Function Description
Perform NAND memory Initialization sequence.
Parameters


hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
ComSpace_Timing: pointer to Common space timing
structure
AttSpace_Timing: pointer to Attribute space timing structure

HAL status

Return values
26.2.7
26.2.8
368/692
HAL_NAND_DeInit
Function Name
HAL_StatusTypeDef HAL_NAND_DeInit
(NAND_HandleTypeDef * hnand)
Function Description
Perform NAND memory De-Initialization sequence.
Parameters

hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
Return values

HAL status
HAL_NAND_MspInit
Function Name
void HAL_NAND_MspInit (NAND_HandleTypeDef * hnand)
Function Description
NAND MSP Init.
Parameters

hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
Return values

None
DOCID028236 Rev 1
UM1940
26.2.9
26.2.10
26.2.11
26.2.12
HAL NAND Generic Driver
HAL_NAND_MspDeInit
Function Name
void HAL_NAND_MspDeInit (NAND_HandleTypeDef * hnand)
Function Description
NAND MSP DeInit.
Parameters

hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
Return values

None
HAL_NAND_IRQHandler
Function Name
void HAL_NAND_IRQHandler (NAND_HandleTypeDef * hnand)
Function Description
This function handles NAND device interrupt request.
Parameters

hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
Return values

HAL status
HAL_NAND_ITCallback
Function Name
void HAL_NAND_ITCallback (NAND_HandleTypeDef * hnand)
Function Description
NAND interrupt feature callback.
Parameters

hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
Return values

None
HAL_NAND_Read_ID
Function Name
HAL_StatusTypeDef HAL_NAND_Read_ID
(NAND_HandleTypeDef * hnand, NAND_IDTypeDef *
pNAND_ID)
Function Description
Read the NAND memory electronic signature.
Parameters

Return values
26.2.13
26.2.14

hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
pNAND_ID: NAND ID structure

HAL status
HAL_NAND_Reset
Function Name
HAL_StatusTypeDef HAL_NAND_Reset
(NAND_HandleTypeDef * hnand)
Function Description
NAND memory reset.
Parameters

hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
Return values

HAL status
HAL_NAND_Read_Page
DOCID028236 Rev 1
369/692
HAL NAND Generic Driver
Function Name
Function Description
Read Page(s) from NAND memory block.
Parameters

Return values
26.2.15

HAL status
Function Name
HAL_StatusTypeDef HAL_NAND_Write_Page
(NAND_HandleTypeDef * hnand, NAND_AddressTypeDef *
pAddress, uint8_t * pBuffer, uint32_t NumPageToWrite)
Function Description
Write Page(s) to NAND memory block.
Parameters




hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
pAddress: : pointer to NAND address structure
pBuffer: : pointer to source buffer to write
NumPageToWrite: : number of pages to write to block

HAL status
HAL_NAND_Read_SpareArea
Function Name
HAL_StatusTypeDef HAL_NAND_Read_SpareArea
(NAND_HandleTypeDef * hnand, NAND_AddressTypeDef *
pAddress, uint8_t * pBuffer, uint32_t NumSpareAreaToRead)
Function Description
Read Spare area(s) from NAND memory.
Parameters

Return values
26.2.17



hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
pAddress: : pointer to NAND address structure
pBuffer: : pointer to destination read buffer
NumPageToRead: : number of pages to read from block
HAL_NAND_Write_Page
Return values
26.2.16
UM1940
HAL_StatusTypeDef HAL_NAND_Read_Page
(NAND_HandleTypeDef * hnand, NAND_AddressTypeDef *
pAddress, uint8_t * pBuffer, uint32_t NumPageToRead)



hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
pAddress: : pointer to NAND address structure
pBuffer: pointer to source buffer to write
NumSpareAreaToRead: Number of spare area to read

HAL status
HAL_NAND_Write_SpareArea
Function Name
HAL_StatusTypeDef HAL_NAND_Write_SpareArea
(NAND_HandleTypeDef * hnand, NAND_AddressTypeDef *
pAddress, uint8_t * pBuffer, uint32_t NumSpareAreaTowrite)
Function Description
Write Spare area(s) to NAND memory.
Parameters




370/692
hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
pAddress: : pointer to NAND address structure
pBuffer: : pointer to source buffer to write
NumSpareAreaTowrite: : number of spare areas to write to
DOCID028236 Rev 1
UM1940
HAL NAND Generic Driver
block
Return values
26.2.18
26.2.20
Function Name
HAL_StatusTypeDef HAL_NAND_Erase_Block
(NAND_HandleTypeDef * hnand, NAND_AddressTypeDef *
pAddress)
Function Description
NAND memory Block erase.
Parameters


hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
pAddress: : pointer to NAND address structure

HAL status
HAL_NAND_Read_Status
Function Name
uint32_t HAL_NAND_Read_Status (NAND_HandleTypeDef *
hnand)
Function Description
NAND memory read status.
Parameters

hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
Return values

NAND status
HAL_NAND_Address_Inc
Function Name
uint32_t HAL_NAND_Address_Inc (NAND_HandleTypeDef *
hnand, NAND_AddressTypeDef * pAddress)
Function Description
Increment the NAND memory address.
Parameters


Return values
26.2.21
26.2.22
HAL status
HAL_NAND_Erase_Block
Return values
26.2.19


hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
pAddress: pointer to NAND address structure
The new status of the increment address operation. It can be:
NAND_VALID_ADDRESS: When the new address is valid
addressNAND_INVALID_ADDRESS: When the new address
is invalid address
HAL_NAND_ECC_Enable
Function Name
HAL_StatusTypeDef HAL_NAND_ECC_Enable
(NAND_HandleTypeDef * hnand)
Function Description
Enables dynamically NAND ECC feature.
Parameters

hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
Return values

HAL status
HAL_NAND_ECC_Disable
DOCID028236 Rev 1
371/692
HAL NAND Generic Driver
Function Name
26.2.23
Function Description
Disables dynamically FSMC_NAND ECC feature.
Parameters

hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
Return values

HAL status
HAL_NAND_GetECC
Function Name
HAL_StatusTypeDef HAL_NAND_GetECC
(NAND_HandleTypeDef * hnand, uint32_t * ECCval, uint32_t
Timeout)
Function Description
Disables dynamically NAND ECC feature.
Parameters

Return values
26.2.24
26.2.25
UM1940
HAL_StatusTypeDef HAL_NAND_ECC_Disable
(NAND_HandleTypeDef * hnand)


hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
ECCval: pointer to ECC value
Timeout: maximum timeout to wait

HAL status
HAL_NAND_GetState
Function Name
HAL_NAND_StateTypeDef HAL_NAND_GetState
(NAND_HandleTypeDef * hnand)
Function Description
return the NAND state
Parameters

hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
Return values

HAL state
HAL_NAND_Read_Status
Function Name
uint32_t HAL_NAND_Read_Status (NAND_HandleTypeDef *
hnand)
Function Description
NAND memory read status.
Parameters

hnand: pointer to a NAND_HandleTypeDef structure that
contains the configuration information for NAND module.
Return values

NAND status
26.3
NAND Firmware driver defines
26.3.1
NAND
NAND Exported Macros
__HAL_NAND_RESET_HANDLE_STATE
Description:

Reset NAND handle state.
Parameters:

372/692
__HANDLE__: specifies the NAND
DOCID028236 Rev 1
UM1940
HAL NAND Generic Driver
handle.
Return value:

None
NAND Private Constants
NAND_DEVICE1
NAND_DEVICE2
NAND_WRITE_TIMEOUT
CMD_AREA
ADDR_AREA
NAND_CMD_AREA_A
NAND_CMD_AREA_B
NAND_CMD_AREA_C
NAND_CMD_AREA_TRUE1
NAND_CMD_WRITE0
NAND_CMD_WRITE_TRUE1
NAND_CMD_ERASE0
NAND_CMD_ERASE1
NAND_CMD_READID
NAND_CMD_STATUS
NAND_CMD_LOCK_STATUS
NAND_CMD_RESET
NAND_VALID_ADDRESS
NAND_INVALID_ADDRESS
NAND_TIMEOUT_ERROR
NAND_BUSY
NAND_ERROR
NAND_READY
NAND Private Macros
ARRAY_ADDRESS
Description:

NAND memory address computation.
Parameters:


__ADDRESS__: NAND memory address.
__HANDLE__: : NAND handle.
Return value:

ADDR_1ST_CYCLE
NAND: Raw address value
Description:
DOCID028236 Rev 1
373/692
HAL NAND Generic Driver
UM1940

NAND memory address cycling.
Parameters:

__ADDRESS__: NAND memory address.
Return value:

NAND: address cycling value.
ADDR_2ND_CYCLE
ADDR_3RD_CYCLE
ADDR_4TH_CYCLE
374/692
DOCID028236 Rev 1
UM1940
HAL NOR Generic Driver
27
HAL NOR Generic Driver
27.1
NOR Firmware driver registers structures
27.1.1
NOR_IDTypeDef
Data Fields




uint16_t Manufacturer_Code
uint16_t Device_Code1
uint16_t Device_Code2
uint16_t Device_Code3
Field Documentation




27.1.2
uint16_t NOR_IDTypeDef::Manufacturer_Code
Defines the device's manufacturer code used to identify the memory
uint16_t NOR_IDTypeDef::Device_Code1
uint16_t NOR_IDTypeDef::Device_Code2
uint16_t NOR_IDTypeDef::Device_Code3
Defines the device's codes used to identify the memory. These codes can be
accessed by performing read operations with specific control signals and addresses
set.They can also be accessed by issuing an Auto Select command
NOR_CFITypeDef
Data Fields




uint16_t CFI_1
uint16_t CFI_2
uint16_t CFI_3
uint16_t CFI_4
Field Documentation




27.1.3
uint16_t NOR_CFITypeDef::CFI_1
< Defines the information stored in the memory's Common flash interface which
contains a description of various electrical and timing parameters, density information
and functions supported by the memory
uint16_t NOR_CFITypeDef::CFI_2
uint16_t NOR_CFITypeDef::CFI_3
uint16_t NOR_CFITypeDef::CFI_4
NOR_HandleTypeDef
DOCID028236 Rev 1
375/692
HAL NOR Generic Driver
Data Fields





UM1940
FSMC_NORSRAM_TypeDef * Instance
FSMC_NORSRAM_EXTENDED_TypeDef * Extended
FSMC_NORSRAM_InitTypeDef Init
HAL_LockTypeDef Lock
__IO HAL_NOR_StateTypeDef State
Field Documentation





FSMC_NORSRAM_TypeDef* NOR_HandleTypeDef::Instance
Register base address
FSMC_NORSRAM_EXTENDED_TypeDef* NOR_HandleTypeDef::Extended
Extended mode register base address
FSMC_NORSRAM_InitTypeDef NOR_HandleTypeDef::Init
NOR device control configuration parameters
HAL_LockTypeDef NOR_HandleTypeDef::Lock
NOR locking object
__IO HAL_NOR_StateTypeDef NOR_HandleTypeDef::State
NOR device access state
27.2
NOR Firmware driver API description
27.2.1
How to use this driver
This driver is a generic layered driver which contains a set of APIs used to control NOR
flash memories. It uses the FSMC layer functions to interface with NOR devices. This
driver is used as follows:







NOR flash memory configuration sequence using the function HAL_NOR_Init() with
control and timing parameters for both normal and extended mode.
Read NOR flash memory manufacturer code and device IDs using the function
HAL_NOR_Read_ID(). The read information is stored in the NOR_ID_TypeDef
structure declared by the function caller.
Access NOR flash memory by read/write data unit operations using the functions
HAL_NOR_Read(), HAL_NOR_Program().
Perform NOR flash erase block/chip operations using the functions
HAL_NOR_Erase_Block() and HAL_NOR_Erase_Chip().
Read the NOR flash CFI (common flash interface) IDs using the function
HAL_NOR_Read_CFI(). The read information is stored in the NOR_CFI_TypeDef
structure declared by the function caller.
You can also control the NOR device by calling the control APIs
HAL_NOR_WriteOperation_Enable()/ HAL_NOR_WriteOperation_Disable() to
respectively enable/disable the NOR write operation
You can monitor the NOR device HAL state by calling the function
HAL_NOR_GetState()
This driver is a set of generic APIs which handle standard NOR flash operations.
If a NOR flash device contains different operations and/or implementations, it
should be implemented separately.
376/692
DOCID028236 Rev 1
UM1940
HAL NOR Generic Driver
NOR HAL driver macros list
Below the list of most used macros in NOR HAL driver.

27.2.2
NOR_WRITE : NOR memory write data to specified address
NOR Initialization and de_initialization functions
This section provides functions allowing to initialize/de-initialize the NOR memory
This section contains the following APIs:





27.2.3
HAL_NOR_Init()
HAL_NOR_DeInit()
HAL_NOR_MspInit()
HAL_NOR_MspDeInit()
HAL_NOR_MspWait()
NOR Input and Output functions
This section provides functions allowing to use and control the NOR memory
This section contains the following APIs:









27.2.4
HAL_NOR_Read_ID()
HAL_NOR_ReturnToReadMode()
HAL_NOR_Read()
HAL_NOR_Program()
HAL_NOR_ReadBuffer()
HAL_NOR_ProgramBuffer()
HAL_NOR_Erase_Block()
HAL_NOR_Erase_Chip()
HAL_NOR_Read_CFI()
NOR Control functions
This subsection provides a set of functions allowing to control dynamically the NOR
interface.
This section contains the following APIs:


27.2.5
HAL_NOR_WriteOperation_Enable()
HAL_NOR_WriteOperation_Disable()
NOR State functions
This subsection permits to get in run-time the status of the NOR controller and the data
flow.
This section contains the following APIs:


27.2.6
HAL_NOR_GetState()
HAL_NOR_GetStatus()
HAL_NOR_Init
Function Name
HAL_StatusTypeDef HAL_NOR_Init (NOR_HandleTypeDef *
hnor, FSMC_NORSRAM_TimingTypeDef * Timing,
FSMC_NORSRAM_TimingTypeDef * ExtTiming)
Function Description
Perform the NOR memory Initialization sequence.
DOCID028236 Rev 1
377/692
HAL NOR Generic Driver
Parameters
Return values
27.2.7
27.2.8
27.2.9
27.2.10
378/692
hnor: pointer to the NOR handle
Timing: pointer to NOR control timing structure
ExtTiming: pointer to NOR extended mode timing structure

HAL status
HAL_NOR_DeInit
Function Name
HAL_StatusTypeDef HAL_NOR_DeInit (NOR_HandleTypeDef *
hnor)
Function Description
Perform NOR memory De-Initialization sequence.
Parameters

hnor: pointer to a NOR_HandleTypeDef structure that
contains the configuration information for NOR module.
Return values

HAL status
HAL_NOR_MspInit
Function Name
void HAL_NOR_MspInit (NOR_HandleTypeDef * hnor)
Function Description
NOR MSP Init.
Parameters

hnor: pointer to a NOR_HandleTypeDef structure that
contains the configuration information for NOR module.
Return values

None
HAL_NOR_MspDeInit
Function Name
void HAL_NOR_MspDeInit (NOR_HandleTypeDef * hnor)
Function Description
NOR MSP DeInit.
Parameters

hnor: pointer to a NOR_HandleTypeDef structure that
contains the configuration information for NOR module.
Return values

None
HAL_NOR_MspWait
Function Name
void HAL_NOR_MspWait (NOR_HandleTypeDef * hnor,
uint32_t Timeout)
Function Description
NOR BSP Wait for Ready/Busy signal.
Parameters

Return values
27.2.11
UM1940




hnor: pointer to a NOR_HandleTypeDef structure that
contains the configuration information for NOR module.
Timeout: Maximum timeout value

None
HAL_NOR_Read_ID
Function Name
HAL_StatusTypeDef HAL_NOR_Read_ID
(NOR_HandleTypeDef * hnor, NOR_IDTypeDef * pNOR_ID)
Function Description
Read NOR flash IDs.
Parameters

hnor: pointer to the NOR handle
DOCID028236 Rev 1
UM1940
HAL NOR Generic Driver
Return values
27.2.12
27.2.13
27.2.14
27.2.15
pNOR_ID: : pointer to NOR ID structure

HAL status
HAL_NOR_ReturnToReadMode
Function Name
HAL_StatusTypeDef HAL_NOR_ReturnToReadMode
(NOR_HandleTypeDef * hnor)
Function Description
Returns the NOR memory to Read mode.
Parameters

hnor: pointer to the NOR handle
Return values

HAL status
HAL_NOR_Read
Function Name
HAL_StatusTypeDef HAL_NOR_Read (NOR_HandleTypeDef *
hnor, uint32_t * pAddress, uint16_t * pData)
Function Description
Read data from NOR memory.
Parameters



hnor: pointer to the NOR handle
pAddress: pointer to Device address
pData: : pointer to read data
Return values

HAL status
HAL_NOR_Program
Function Name
HAL_StatusTypeDef HAL_NOR_Program
(NOR_HandleTypeDef * hnor, uint32_t * pAddress, uint16_t *
pData)
Function Description
Program data to NOR memory.
Parameters



hnor: pointer to the NOR handle
pAddress: Device address
pData: : pointer to the data to write
Return values

HAL status
HAL_NOR_ReadBuffer
Function Name
HAL_StatusTypeDef HAL_NOR_ReadBuffer
(NOR_HandleTypeDef * hnor, uint32_t uwAddress, uint16_t *
pData, uint32_t uwBufferSize)
Function Description
Reads a half-word buffer from the NOR memory.
Parameters



Return values
27.2.16


hnor: pointer to the NOR handle
uwAddress: NOR memory internal address to read from.
pData: pointer to the buffer that receives the data read from
the NOR memory.
uwBufferSize: : number of Half word to read.

HAL status
HAL_NOR_ProgramBuffer
DOCID028236 Rev 1
379/692
HAL NOR Generic Driver
Function Name
27.2.17
27.2.18
27.2.19
27.2.20
380/692
UM1940
HAL_StatusTypeDef HAL_NOR_ProgramBuffer
(NOR_HandleTypeDef * hnor, uint32_t uwAddress, uint16_t *
pData, uint32_t uwBufferSize)
Function Description
Writes a half-word buffer to the NOR memory.
Parameters




hnor: pointer to the NOR handle
uwAddress: NOR memory internal start write address
pData: pointer to source data buffer.
uwBufferSize: Size of the buffer to write
Return values

HAL status
HAL_NOR_Erase_Block
Function Name
HAL_StatusTypeDef HAL_NOR_Erase_Block
(NOR_HandleTypeDef * hnor, uint32_t BlockAddress, uint32_t
Address)
Function Description
Erase the specified block of the NOR memory.
Parameters



hnor: pointer to the NOR handle
BlockAddress: : Block to erase address
Address: Device address
Return values

HAL status
HAL_NOR_Erase_Chip
Function Name
HAL_StatusTypeDef HAL_NOR_Erase_Chip
(NOR_HandleTypeDef * hnor, uint32_t Address)
Function Description
Erase the entire NOR chip.
Parameters


hnor: pointer to the NOR handle
Address: : Device address
Return values

HAL status
HAL_NOR_Read_CFI
Function Name
HAL_StatusTypeDef HAL_NOR_Read_CFI
(NOR_HandleTypeDef * hnor, NOR_CFITypeDef * pNOR_CFI)
Function Description
Read NOR flash CFI IDs.
Parameters


hnor: pointer to the NOR handle
pNOR_CFI: : pointer to NOR CFI IDs structure
Return values

HAL status
HAL_NOR_WriteOperation_Enable
Function Name
HAL_StatusTypeDef HAL_NOR_WriteOperation_Enable
(NOR_HandleTypeDef * hnor)
Function Description
Enables dynamically NOR write operation.
Parameters

hnor: pointer to the NOR handle
Return values

HAL status
DOCID028236 Rev 1
UM1940
27.2.21
27.2.22
27.2.23
HAL NOR Generic Driver
HAL_NOR_WriteOperation_Disable
Function Name
HAL_StatusTypeDef HAL_NOR_WriteOperation_Disable
(NOR_HandleTypeDef * hnor)
Function Description
Disables dynamically NOR write operation.
Parameters

hnor: pointer to the NOR handle
Return values

HAL status
HAL_NOR_GetState
Function Name
HAL_NOR_StateTypeDef HAL_NOR_GetState
(NOR_HandleTypeDef * hnor)
Function Description
return the NOR controller state
Parameters

hnor: pointer to the NOR handle
Return values

NOR controller state
HAL_NOR_GetStatus
Function Name
HAL_NOR_StatusTypeDef HAL_NOR_GetStatus
(NOR_HandleTypeDef * hnor, uint32_t Address, uint32_t
Timeout)
Function Description
Returns the NOR operation status.
Parameters



hnor: pointer to the NOR handle
Address: Device address
Timeout: NOR programming Timeout
Return values

NOR_Status The returned value can be:
HAL_NOR_STATUS_SUCCESS,
HAL_NOR_STATUS_ERROR or
HAL_NOR_STATUS_TIMEOUT
27.3
NOR Firmware driver defines
27.3.1
NOR
NOR Exported Macros
__HAL_NOR_RESET_HANDLE_STATE
Description:

Reset NOR handle state.
Parameters:

__HANDLE__: specifies the NOR handle.
Return value:

None
NOR Private Constants
MC_ADDRESS
DEVICE_CODE1_ADDR
DOCID028236 Rev 1
381/692
HAL NOR Generic Driver
DEVICE_CODE2_ADDR
UM1940
DEVICE_CODE3_ADDR
CFI1_ADDRESS
CFI2_ADDRESS
CFI3_ADDRESS
CFI4_ADDRESS
NOR_TMEOUT
NOR_MEMORY_8B
NOR_MEMORY_16B
NOR_MEMORY_ADRESS1
NOR_MEMORY_ADRESS2
NOR_MEMORY_ADRESS3
NOR_MEMORY_ADRESS4
NOR Private Defines
NOR_CMD_ADDRESS_FIRST
NOR_CMD_ADDRESS_FIRST_CFI
NOR_CMD_ADDRESS_SECOND
NOR_CMD_ADDRESS_THIRD
NOR_CMD_ADDRESS_FOURTH
NOR_CMD_ADDRESS_FIFTH
NOR_CMD_ADDRESS_SIXTH
NOR_CMD_DATA_READ_RESET
NOR_CMD_DATA_FIRST
NOR_CMD_DATA_SECOND
NOR_CMD_DATA_AUTO_SELECT
NOR_CMD_DATA_PROGRAM
NOR_CMD_DATA_CHIP_BLOCK_ERASE_THIRD
NOR_CMD_DATA_CHIP_BLOCK_ERASE_FOURTH
NOR_CMD_DATA_CHIP_BLOCK_ERASE_FIFTH
NOR_CMD_DATA_CHIP_ERASE
NOR_CMD_DATA_CFI
NOR_CMD_DATA_BUFFER_AND_PROG
NOR_CMD_DATA_BUFFER_AND_PROG_CONFIRM
NOR_CMD_DATA_BLOCK_ERASE
NOR_MASK_STATUS_DQ5
NOR_MASK_STATUS_DQ6
NOR Private Macros
382/692
DOCID028236 Rev 1
UM1940
HAL NOR Generic Driver
NOR_ADDR_SHIFT
Description:

NOR memory address shifting.
Parameters:



__NOR_ADDRESS__: NOR base address
NOR_MEMORY_WIDTH: NOR memory width
ADDRESS: NOR memory address
Return value:

NOR_WRITE
NOR: shifted address value
Description:

NOR memory write data to specified address.
Parameters:


ADDRESS: NOR memory address
DATA: Data to write
Return value:

None
DOCID028236 Rev 1
383/692
HAL PCCARD Generic Driver
UM1940
28
HAL PCCARD Generic Driver
28.1
PCCARD Firmware driver registers structures
28.1.1
PCCARD_HandleTypeDef
Data Fields




FSMC_PCCARD_TypeDef * Instance
FSMC_PCCARD_InitTypeDef Init
__IO HAL_PCCARD_StateTypeDef State
HAL_LockTypeDef Lock
Field Documentation




FSMC_PCCARD_TypeDef* PCCARD_HandleTypeDef::Instance
Register base address for PCCARD device
FSMC_PCCARD_InitTypeDef PCCARD_HandleTypeDef::Init
PCCARD device control configuration parameters
__IO HAL_PCCARD_StateTypeDef PCCARD_HandleTypeDef::State
PCCARD device access state
HAL_LockTypeDef PCCARD_HandleTypeDef::Lock
PCCARD Lock
28.2
PCCARD Firmware driver API description
28.2.1
How to use this driver
This driver is a generic layered driver which contains a set of APIs used to control
PCCARD/compact flash memories. It uses the FSMC layer functions to interface with
PCCARD devices. This driver is used for:







384/692
PCCARD/Compact Flash memory configuration sequence using the function
HAL_PCCARD_Init()/HAL_CF_Init() with control and timing parameters for both
common and attribute spaces.
Read PCCARD/Compact Flash memory maker and device IDs using the function
HAL_PCCARD_Read_ID()/HAL_CF_Read_ID(). The read information is stored in the
CompactFlash_ID structure declared by the function caller.
Access PCCARD/Compact Flash memory by read/write operations using the
functions HAL_PCCARD_Read_Sector()/ HAL_PCCARD_Write_Sector() HAL_CF_Read_Sector()/HAL_CF_Write_Sector(), to read/write sector.
Perform PCCARD/Compact Flash Reset chip operation using the function
HAL_PCCARD_Reset()/HAL_CF_Reset.
Perform PCCARD/Compact Flash erase sector operation using the function
HAL_PCCARD_Erase_Sector()/HAL_CF_Erase_Sector.
Read the PCCARD/Compact Flash status operation using the function
HAL_PCCARD_ReadStatus()/HAL_CF_ReadStatus().
You can monitor the PCCARD/Compact Flash device HAL state by calling the
function HAL_PCCARD_GetState()/HAL_CF_GetState()
DOCID028236 Rev 1
UM1940
HAL PCCARD Generic Driver
This driver is a set of generic APIs which handle standard PCCARD/compact
flash operations. If a PCCARD/Compact Flash device contains different
operations and/or implementations, it should be implemented separately.
28.2.2
PCCARD Initialization and de-initialization functions
This section provides functions allowing to initialize/de-initialize the PCCARD memory
This section contains the following APIs:




28.2.3
HAL_PCCARD_Init()
HAL_PCCARD_DeInit()
HAL_PCCARD_MspInit()
HAL_PCCARD_MspDeInit()
PCCARD Input and Output functions
This section provides functions allowing to use and control the PCCARD memory
This section contains the following APIs:







28.2.4
HAL_PCCARD_Read_ID()
HAL_PCCARD_Read_Sector()
HAL_PCCARD_Write_Sector()
HAL_PCCARD_Erase_Sector()
HAL_PCCARD_Reset()
HAL_PCCARD_IRQHandler()
HAL_PCCARD_ITCallback()
PCCARD State functions
This subsection permits to get in run-time the status of the PCCARD controller and the
data flow.
This section contains the following APIs:



28.2.5
HAL_PCCARD_GetState()
HAL_PCCARD_GetStatus()
HAL_PCCARD_ReadStatus()
HAL_PCCARD_Init
Function Name
HAL_StatusTypeDef HAL_PCCARD_Init
(PCCARD_HandleTypeDef * hpccard,
FSMC_NAND_PCC_TimingTypeDef * ComSpaceTiming,
FSMC_NAND_PCC_TimingTypeDef * AttSpaceTiming,
FSMC_NAND_PCC_TimingTypeDef * IOSpaceTiming)
Function Description
Perform the PCCARD memory Initialization sequence.
Parameters

Return values



hpccard: pointer to a PCCARD_HandleTypeDef structure
that contains the configuration information for PCCARD
module.
ComSpaceTiming: Common space timing structure
AttSpaceTiming: Attribute space timing structure
IOSpaceTiming: IO space timing structure

HAL status
DOCID028236 Rev 1
385/692
HAL PCCARD Generic Driver
28.2.6
28.2.7
28.2.8
28.2.9
HAL_PCCARD_DeInit
Function Name
HAL_StatusTypeDef HAL_PCCARD_DeInit
(PCCARD_HandleTypeDef * hpccard)
Function Description
Perform the PCCARD memory De-initialization sequence.
Parameters

hpccard: pointer to a PCCARD_HandleTypeDef structure
that contains the configuration information for PCCARD
module.
Return values

HAL status
HAL_PCCARD_MspInit
Function Name
void HAL_PCCARD_MspInit (PCCARD_HandleTypeDef *
hpccard)
Function Description
PCCARD MSP Init.
Parameters

hpccard: pointer to a PCCARD_HandleTypeDef structure
that contains the configuration information for PCCARD
module.
Return values

None
HAL_PCCARD_MspDeInit
Function Name
void HAL_PCCARD_MspDeInit (PCCARD_HandleTypeDef *
hpccard)
Function Description
PCCARD MSP DeInit.
Parameters

hpccard: pointer to a PCCARD_HandleTypeDef structure
that contains the configuration information for PCCARD
module.
Return values

None
HAL_PCCARD_Read_ID
Function Name
HAL_StatusTypeDef HAL_PCCARD_Read_ID
(PCCARD_HandleTypeDef * hpccard, uint8_t
CompactFlash_ID, uint8_t * pStatus)
Function Description
Read Compact Flash's ID.
Parameters

Return values
28.2.10


hpccard: pointer to a PCCARD_HandleTypeDef structure
that contains the configuration information for PCCARD
module.
CompactFlash_ID: Compact flash ID structure.
pStatus: pointer to compact flash status

HAL status
HAL_PCCARD_Read_Sector
Function Name
386/692
UM1940
HAL_StatusTypeDef HAL_PCCARD_Read_Sector
(PCCARD_HandleTypeDef * hpccard, uint16_t * pBuffer,
uint16_t SectorAddress, uint8_t * pStatus)
DOCID028236 Rev 1
UM1940
HAL PCCARD Generic Driver
Function Description
Read sector from PCCARD memory.
Parameters

Return values
28.2.11
28.2.14
HAL status
Function Name
HAL_StatusTypeDef HAL_PCCARD_Write_Sector
(PCCARD_HandleTypeDef * hpccard, uint16_t * pBuffer,
uint16_t SectorAddress, uint8_t * pStatus)
Function Description
Write sector to PCCARD memory.
Parameters




hpccard: pointer to a PCCARD_HandleTypeDef structure
that contains the configuration information for PCCARD
module.
pBuffer: pointer to source write buffer
SectorAddress: Sector address to write
pStatus: pointer to PCCARD status

HAL status
HAL_PCCARD_Erase_Sector
Function Name
HAL_StatusTypeDef HAL_PCCARD_Erase_Sector
(PCCARD_HandleTypeDef * hpccard, uint16_t SectorAddress,
uint8_t * pStatus)
Function Description
Erase sector from PCCARD memory.
Parameters

Return values
28.2.13

HAL_PCCARD_Write_Sector
Return values
28.2.12



hpccard: pointer to a PCCARD_HandleTypeDef structure
that contains the configuration information for PCCARD
module.
pBuffer: pointer to destination read buffer
SectorAddress: Sector address to read
pStatus: pointer to PCCARD status


hpccard: pointer to a PCCARD_HandleTypeDef structure
that contains the configuration information for PCCARD
module.
SectorAddress: Sector address to erase
pStatus: pointer to PCCARD status

HAL status
HAL_PCCARD_Reset
Function Name
HAL_StatusTypeDef HAL_PCCARD_Reset
(PCCARD_HandleTypeDef * hpccard)
Function Description
Reset the PCCARD memory.
Parameters

hpccard: pointer to a PCCARD_HandleTypeDef structure
that contains the configuration information for PCCARD
module.
Return values

HAL status
HAL_PCCARD_IRQHandler
DOCID028236 Rev 1
387/692
HAL PCCARD Generic Driver
Function Name
28.2.15
28.2.16
28.2.17
28.2.18
388/692
UM1940
void HAL_PCCARD_IRQHandler (PCCARD_HandleTypeDef *
hpccard)
Function Description
This function handles PCCARD device interrupt request.
Parameters

hpccard: pointer to a PCCARD_HandleTypeDef structure
that contains the configuration information for PCCARD
module.
Return values

HAL status
HAL_PCCARD_ITCallback
Function Name
void HAL_PCCARD_ITCallback (PCCARD_HandleTypeDef *
hpccard)
Function Description
PCCARD interrupt feature callback.
Parameters

hpccard: pointer to a PCCARD_HandleTypeDef structure
that contains the configuration information for PCCARD
module.
Return values

None
HAL_PCCARD_GetState
Function Name
HAL_PCCARD_StateTypeDef HAL_PCCARD_GetState
(PCCARD_HandleTypeDef * hpccard)
Function Description
return the PCCARD controller state
Parameters

hpccard: pointer to a PCCARD_HandleTypeDef structure
that contains the configuration information for PCCARD
module.
Return values

HAL state
HAL_PCCARD_GetStatus
Function Name
HAL_PCCARD_StatusTypeDef HAL_PCCARD_GetStatus
(PCCARD_HandleTypeDef * hpccard)
Function Description
Get the compact flash memory status.
Parameters

hpccard: pointer to a PCCARD_HandleTypeDef structure
that contains the configuration information for PCCARD
module.
Return values

New status of the PCCARD operation. This parameter can
be: CompactFlash_TIMEOUT_ERROR: when the previous
operation generate a Timeout errorCompactFlash_READY:
when memory is ready for the next operation
HAL_PCCARD_ReadStatus
Function Name
HAL_PCCARD_StatusTypeDef HAL_PCCARD_ReadStatus
(PCCARD_HandleTypeDef * hpccard)
Function Description
Reads the Compact Flash memory status using the Read status
command.
DOCID028236 Rev 1
UM1940
HAL PCCARD Generic Driver
Parameters

hpccard: pointer to a PCCARD_HandleTypeDef structure
that contains the configuration information for PCCARD
module.
Return values

The status of the Compact Flash memory. This parameter
can be: CompactFlash_BUSY: when memory is
busyCompactFlash_READY: when memory is ready for the
next operationCompactFlash_ERROR: when the previous
operation generates error
28.3
PCCARD Firmware driver defines
28.3.1
PCCARD
PCCARD Exported Macros
__HAL_PCCARD_RESET_HANDLE_STATE
Description:

Reset PCCARD handle state.
Parameters:

__HANDLE__: specifies the PCCARD
handle.
Return value:

None
PCCARD Private Constants
PCCARD_DEVICE_ADDRESS
PCCARD_ATTRIBUTE_SPACE_ADDRESS
PCCARD_COMMON_SPACE_ADDRESS
PCCARD_IO_SPACE_ADDRESS
PCCARD_IO_SPACE_PRIMARY_ADDR
ATA_DATA
ATA_SECTOR_COUNT
ATA_SECTOR_NUMBER
ATA_CYLINDER_LOW
ATA_CYLINDER_HIGH
ATA_CARD_HEAD
ATA_STATUS_CMD
ATA_STATUS_CMD_ALTERNATE
ATA_COMMON_DATA_AREA
ATA_CARD_CONFIGURATION
ATA_READ_SECTOR_CMD
ATA_WRITE_SECTOR_CMD
ATA_ERASE_SECTOR_CMD
DOCID028236 Rev 1
389/692
HAL PCCARD Generic Driver
ATA_IDENTIFY_CMD
UM1940
PCCARD_TIMEOUT_ERROR
PCCARD_BUSY
PCCARD_PROGR
PCCARD_READY
PCCARD_SECTOR_SIZE
PCCARD Private Defines
PCCARD_TIMEOUT_READ_ID
PCCARD_TIMEOUT_READ_WRITE_SECTOR
PCCARD_TIMEOUT_ERASE_SECTOR
PCCARD_TIMEOUT_STATUS
PCCARD_STATUS_OK
PCCARD_STATUS_WRITE_OK
390/692
DOCID028236 Rev 1
UM1940
HAL PCD Generic Driver
29
HAL PCD Generic Driver
29.1
PCD Firmware driver registers structures
29.1.1
PCD_HandleTypeDef
Data Fields








PCD_TypeDef * Instance
PCD_InitTypeDef Init
PCD_EPTypeDef IN_ep
PCD_EPTypeDef OUT_ep
HAL_LockTypeDef Lock
__IO PCD_StateTypeDef State
uint32_t Setup
void * pData
Field Documentation








PCD_TypeDef* PCD_HandleTypeDef::Instance
Register base address
PCD_InitTypeDef PCD_HandleTypeDef::Init
PCD required parameters
PCD_EPTypeDef PCD_HandleTypeDef::IN_ep[15]
IN endpoint parameters
PCD_EPTypeDef PCD_HandleTypeDef::OUT_ep[15]
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
29.2
PCD Firmware driver API description
29.2.1
How to use this driver
The PCD HAL driver can be used as follows:
1.
2.
3.
4.
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 PCD 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

__HAL_RCC_USB_OTG_FS_CLK_ENABLE();
DOCID028236 Rev 1
391/692
HAL PCD Generic Driver
5.
6.
29.2.2
UM1940

__HAL_RCC_USB_OTG_HS_CLK_ENABLE(); (For High Speed Mode)
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 PCD transmission and reception:
a.
HAL_PCD_Start();
Initialization and de-initialization functions
This section provides functions allowing to:
This section contains the following APIs:




29.2.3
HAL_PCD_Init()
HAL_PCD_DeInit()
HAL_PCD_MspInit()
HAL_PCD_MspDeInit()
IO operation functions
This subsection provides a set of functions allowing to manage the PCD data transfers.
This section contains the following APIs:














29.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()
Peripheral Control functions
This subsection provides a set of functions allowing to control the PCD data transfers.
This section contains the following APIs:











392/692
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()
DOCID028236 Rev 1
UM1940
HAL PCD Generic Driver


29.2.5
HAL_PCD_ActivateRemoteWakeup()
HAL_PCD_DeActivateRemoteWakeup()
Peripheral State functions
This subsection permits to get in run-time the status of the peripheral and the data flow.
This section contains the following APIs:

29.2.6
29.2.7
29.2.8
29.2.9
29.2.10
HAL_PCD_GetState()
HAL_PCD_Init
Function Name
HAL_StatusTypeDef HAL_PCD_Init (PCD_HandleTypeDef *
hpcd)
Function Description
Initializes the PCD according to the specified parameters in the
PCD_InitTypeDef and initialize the associated handle.
Parameters

hpcd: PCD handle
Return values

HAL status
HAL_PCD_DeInit
Function Name
HAL_StatusTypeDef HAL_PCD_DeInit (PCD_HandleTypeDef *
hpcd)
Function Description
DeInitializes the PCD peripheral.
Parameters

hpcd: PCD handle
Return values

HAL status
HAL_PCD_MspInit
Function Name
void HAL_PCD_MspInit (PCD_HandleTypeDef * hpcd)
Function Description
Initializes the PCD MSP.
Parameters

hpcd: PCD handle
Return values

None
HAL_PCD_MspDeInit
Function Name
void HAL_PCD_MspDeInit (PCD_HandleTypeDef * hpcd)
Function Description
DeInitializes PCD MSP.
Parameters

hpcd: PCD handle
Return values

None
HAL_PCD_Start
Function Name
HAL_StatusTypeDef HAL_PCD_Start (PCD_HandleTypeDef *
hpcd)
Function Description
Start The USB OTG Device.
Parameters

hpcd: PCD handle
DOCID028236 Rev 1
393/692
HAL PCD Generic Driver
Return values
29.2.11
29.2.12
29.2.13
29.2.14
29.2.15
29.2.16
HAL status
HAL_PCD_Stop
Function Name
HAL_StatusTypeDef HAL_PCD_Stop (PCD_HandleTypeDef *
hpcd)
Function Description
Stop The USB OTG Device.
Parameters

hpcd: PCD handle
Return values

HAL status
HAL_PCD_IRQHandler
Function Name
void HAL_PCD_IRQHandler (PCD_HandleTypeDef * hpcd)
Function Description
Handles PCD interrupt request.
Parameters

hpcd: PCD handle
Return values

HAL status
HAL_PCD_DataOutStageCallback
Function Name
void HAL_PCD_DataOutStageCallback (PCD_HandleTypeDef *
hpcd, uint8_t epnum)
Function Description
Data OUT stage callback.
Parameters


hpcd: PCD handle
epnum: endpoint number
Return values

None
HAL_PCD_DataInStageCallback
Function Name
void HAL_PCD_DataInStageCallback (PCD_HandleTypeDef *
hpcd, uint8_t epnum)
Function Description
Data IN stage callback.
Parameters


hpcd: PCD handle
epnum: endpoint number
Return values

None
HAL_PCD_SetupStageCallback
Function Name
void HAL_PCD_SetupStageCallback (PCD_HandleTypeDef *
hpcd)
Function Description
Setup stage callback.
Parameters

hpcd: PCD handle
Return values

None
HAL_PCD_SOFCallback
Function Name
394/692
UM1940

void HAL_PCD_SOFCallback (PCD_HandleTypeDef * hpcd)
DOCID028236 Rev 1
UM1940
29.2.17
29.2.18
29.2.19
29.2.20
29.2.21
HAL PCD Generic Driver
Function Description
USB Start Of Frame callback.
Parameters

hpcd: PCD handle
Return values

None
HAL_PCD_ResetCallback
Function Name
void HAL_PCD_ResetCallback (PCD_HandleTypeDef * hpcd)
Function Description
USB Reset callback.
Parameters

hpcd: PCD handle
Return values

None
HAL_PCD_SuspendCallback
Function Name
void HAL_PCD_SuspendCallback (PCD_HandleTypeDef *
hpcd)
Function Description
Suspend event callback.
Parameters

hpcd: PCD handle
Return values

None
HAL_PCD_ResumeCallback
Function Name
void HAL_PCD_ResumeCallback (PCD_HandleTypeDef *
hpcd)
Function Description
Resume event callback.
Parameters

hpcd: PCD handle
Return values

None
HAL_PCD_ISOOUTIncompleteCallback
Function Name
void HAL_PCD_ISOOUTIncompleteCallback
(PCD_HandleTypeDef * hpcd, uint8_t epnum)
Function Description
Incomplete ISO OUT callback.
Parameters


hpcd: PCD handle
epnum: endpoint number
Return values

None
HAL_PCD_ISOINIncompleteCallback
Function Name
void HAL_PCD_ISOINIncompleteCallback
(PCD_HandleTypeDef * hpcd, uint8_t epnum)
Function Description
Incomplete ISO IN callback.
Parameters


hpcd: PCD handle
epnum: endpoint number
Return values

None
DOCID028236 Rev 1
395/692
HAL PCD Generic Driver
29.2.22
29.2.23
29.2.24
29.2.25
29.2.26
29.2.27
HAL_PCD_ConnectCallback
Function Name
void HAL_PCD_ConnectCallback (PCD_HandleTypeDef *
hpcd)
Function Description
Connection event callback.
Parameters

hpcd: PCD handle
Return values

None
HAL_PCD_DisconnectCallback
Function Name
void HAL_PCD_DisconnectCallback (PCD_HandleTypeDef *
hpcd)
Function Description
Disconnection event callback.
Parameters

hpcd: PCD handle
Return values

None
HAL_PCD_DevConnect
Function Name
HAL_StatusTypeDef HAL_PCD_DevConnect
(PCD_HandleTypeDef * hpcd)
Function Description
Connect the USB device.
Parameters

hpcd: PCD handle
Return values

HAL status
HAL_PCD_DevDisconnect
Function Name
HAL_StatusTypeDef HAL_PCD_DevDisconnect
(PCD_HandleTypeDef * hpcd)
Function Description
Disconnect the USB device.
Parameters

hpcd: PCD handle
Return values

HAL status
HAL_PCD_SetAddress
Function Name
HAL_StatusTypeDef HAL_PCD_SetAddress
(PCD_HandleTypeDef * hpcd, uint8_t address)
Function Description
Set the USB Device address.
Parameters


hpcd: PCD handle
address: new device address
Return values

HAL status
HAL_PCD_EP_Open
Function Name
396/692
UM1940
HAL_StatusTypeDef HAL_PCD_EP_Open
(PCD_HandleTypeDef * hpcd, uint8_t ep_addr, uint16_t
ep_mps, uint8_t ep_type)
DOCID028236 Rev 1
UM1940
29.2.28
29.2.29
29.2.30
29.2.31
HAL PCD Generic Driver
Function Description
Open and configure an endpoint.
Parameters




hpcd: PCD handle
ep_addr: endpoint address
ep_mps: endpoint max packet size
ep_type: endpoint type
Return values

HAL status
HAL_PCD_EP_Close
Function Name
HAL_StatusTypeDef HAL_PCD_EP_Close
(PCD_HandleTypeDef * hpcd, uint8_t ep_addr)
Function Description
Deactivate an endpoint.
Parameters


hpcd: PCD handle
ep_addr: endpoint address
Return values

HAL status
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)
Function Description
Receive an amount of data.
Parameters




hpcd: PCD handle
ep_addr: endpoint address
pBuf: pointer to the reception buffer
len: amount of data to be received
Return values

HAL status
HAL_PCD_EP_GetRxCount
Function Name
uint16_t HAL_PCD_EP_GetRxCount (PCD_HandleTypeDef *
hpcd, uint8_t ep_addr)
Function Description
Get Received Data Size.
Parameters


hpcd: PCD handle
ep_addr: endpoint address
Return values

Data Size
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)
Function Description
Send an amount of data.
Parameters




hpcd: PCD handle
ep_addr: endpoint address
pBuf: pointer to the transmission buffer
len: amount of data to be sent
DOCID028236 Rev 1
397/692
HAL PCD Generic Driver
Return values
29.2.32
29.2.33
29.2.34
29.2.35
29.2.36
29.2.37
398/692
UM1940

HAL status
HAL_PCD_EP_SetStall
Function Name
HAL_StatusTypeDef HAL_PCD_EP_SetStall
(PCD_HandleTypeDef * hpcd, uint8_t ep_addr)
Function Description
Set a STALL condition over an endpoint.
Parameters


hpcd: PCD handle
ep_addr: endpoint address
Return values

HAL status
HAL_PCD_EP_ClrStall
Function Name
HAL_StatusTypeDef HAL_PCD_EP_ClrStall
(PCD_HandleTypeDef * hpcd, uint8_t ep_addr)
Function Description
Clear a STALL condition over in an endpoint.
Parameters


hpcd: PCD handle
ep_addr: endpoint address
Return values

HAL status
HAL_PCD_EP_Flush
Function Name
HAL_StatusTypeDef HAL_PCD_EP_Flush
(PCD_HandleTypeDef * hpcd, uint8_t ep_addr)
Function Description
Flush an endpoint.
Parameters


hpcd: PCD handle
ep_addr: endpoint address
Return values

HAL status
HAL_PCD_ActivateRemoteWakeup
Function Name
HAL_StatusTypeDef HAL_PCD_ActivateRemoteWakeup
(PCD_HandleTypeDef * hpcd)
Function Description
Activate remote wakeup signalling.
Parameters

hpcd: PCD handle
Return values

HAL status
HAL_PCD_DeActivateRemoteWakeup
Function Name
HAL_StatusTypeDef HAL_PCD_DeActivateRemoteWakeup
(PCD_HandleTypeDef * hpcd)
Function Description
De-activate remote wakeup signalling.
Parameters

hpcd: PCD handle
Return values

HAL status
HAL_PCD_GetState
DOCID028236 Rev 1
UM1940
Function Name
HAL PCD Generic Driver
PCD_StateTypeDef HAL_PCD_GetState (PCD_HandleTypeDef
* hpcd)
Function Description
Return the PCD handle state.
Parameters

hpcd: PCD handle
Return values

HAL state
29.3
PCD Firmware driver defines
29.3.1
PCD
PCD Exported Macros
__HAL_PCD_ENABLE
__HAL_PCD_DISABLE
__HAL_PCD_GET_FLAG
__HAL_PCD_CLEAR_FLAG
__HAL_PCD_IS_INVALID_INTERRUPT
__HAL_PCD_UNGATE_PHYCLOCK
__HAL_PCD_GATE_PHYCLOCK
__HAL_PCD_IS_PHY_SUSPENDED
USB_OTG_FS_WAKEUP_EXTI_RISING_EDGE
USB_OTG_FS_WAKEUP_EXTI_FALLING_EDGE
USB_OTG_FS_WAKEUP_EXTI_RISING_FALLING_EDGE
USB_OTG_HS_WAKEUP_EXTI_RISING_EDGE
USB_OTG_HS_WAKEUP_EXTI_FALLING_EDGE
USB_OTG_HS_WAKEUP_EXTI_RISING_FALLING_EDGE
USB_OTG_HS_WAKEUP_EXTI_LINE
External interrupt line
20 Connected to the
USB HS EXTI Line
USB_OTG_FS_WAKEUP_EXTI_LINE
External interrupt line
18 Connected to the
USB FS EXTI Line
__HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_IT
__HAL_USB_OTG_HS_WAKEUP_EXTI_DISABLE_IT
__HAL_USB_OTG_HS_WAKEUP_EXTI_GET_FLAG
__HAL_USB_OTG_HS_WAKEUP_EXTI_CLEAR_FLAG
__HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_RISING_EDGE
__HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_FALLING_EDGE
__HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_RISING_FALLING_EDGE
__HAL_USB_OTG_HS_WAKEUP_EXTI_GENERATE_SWIT
__HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_IT
DOCID028236 Rev 1
399/692
HAL PCD Generic Driver
__HAL_USB_OTG_FS_WAKEUP_EXTI_DISABLE_IT
__HAL_USB_OTG_FS_WAKEUP_EXTI_GET_FLAG
__HAL_USB_OTG_FS_WAKEUP_EXTI_CLEAR_FLAG
__HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_RISING_EDGE
__HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_FALLING_EDGE
__HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_RISING_FALLING_EDGE
__HAL_USB_OTG_FS_WAKEUP_EXTI_GENERATE_SWIT
PCD Instance definition
IS_PCD_ALL_INSTANCE
PCD PHY Module
PCD_PHY_ULPI
PCD_PHY_EMBEDDED
PCD Private Macros
PCD_MIN
PCD_MAX
PCD Speed
PCD_SPEED_HIGH
PCD_SPEED_HIGH_IN_FULL
PCD_SPEED_FULL
Turnaround Timeout Value
USBD_HS_TRDT_VALUE
USBD_FS_TRDT_VALUE
400/692
DOCID028236 Rev 1
UM1940
UM1940
HAL PCD Extension Driver
30
HAL PCD Extension Driver
30.1
PCDEx Firmware driver API description
30.1.1
Extended features functions
This section provides functions allowing to:

Update FIFO configuration
This section contains the following APIs:


30.1.2
30.1.3
HAL_PCDEx_SetTxFiFo()
HAL_PCDEx_SetRxFiFo()
HAL_PCDEx_SetTxFiFo
Function Name
HAL_StatusTypeDef HAL_PCDEx_SetTxFiFo
(PCD_HandleTypeDef * hpcd, uint8_t fifo, uint16_t size)
Function Description
Set Tx FIFO.
Parameters



hpcd: PCD handle
fifo: The number of Tx fifo
size: Fifo size
Return values

HAL status
HAL_PCDEx_SetRxFiFo
Function Name
HAL_StatusTypeDef HAL_PCDEx_SetRxFiFo
(PCD_HandleTypeDef * hpcd, uint16_t size)
Function Description
Set Rx FIFO.
Parameters


hpcd: PCD handle
size: Size of Rx fifo
Return values

HAL status
DOCID028236 Rev 1
401/692
HAL PWR Generic Driver
UM1940
31
HAL PWR Generic Driver
31.1
PWR Firmware driver registers structures
31.1.1
PWR_PVDTypeDef
Data Fields


uint32_t PVDLevel
uint32_t Mode
Field Documentation


uint32_t PWR_PVDTypeDef::PVDLevel
PVDLevel: Specifies the PVD detection level. This parameter can be a value of
PWR_PVD_detection_level
uint32_t PWR_PVDTypeDef::Mode
Mode: Specifies the operating mode for the selected pins. This parameter can be a
value of PWR_PVD_Mode
31.2
PWR Firmware driver API description
31.2.1
Initialization and de-initialization functions
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:


Enable the Power Controller (PWR) APB1 interface clock using the
__HAL_RCC_PWR_CLK_ENABLE() macro.
Enable access to RTC domain using the HAL_PWR_EnableBkUpAccess() function.
This section contains the following APIs:



31.2.2
HAL_PWR_DeInit()
HAL_PWR_EnableBkUpAccess()
HAL_PWR_DisableBkUpAccess()
Peripheral Control functions
PVD configuration



402/692
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_PVD_EXTI_ENABLE_IT()
macro.
The PVD is stopped in Standby mode.
DOCID028236 Rev 1
UM1940
HAL PWR Generic Driver
Wake-up pin configuration


Wake-up pin is used to wake up the system from Standby mode. This pin is forced in
input pull-down configuration and is active on rising edges.
There is one Wake-up pin: Wake-up Pin 1 on PA.00.
Low Power modes configuration
The devices feature 3 low-power modes:



Sleep mode: Cortex-M3 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.
Sleep mode


Entry: The Sleep mode is entered by using the
HAL_PWR_EnterSLEEPMode(PWR_MAINREGULATOR_ON,
PWR_SLEEPENTRY_WFI) functions with

PWR_SLEEPENTRY_WFI: enter SLEEP mode with WFI instruction

PWR_SLEEPENTRY_WFE: enter SLEEP mode with WFE instruction The
Regulator parameter is not used for the STM32F2 family and is kept as
parameter just to maintain compatibility with the lower power families (STM32L).
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.2V 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 In Stop mode, FLASH can be powered off before entering the Stop mode
using the HAL_PWREx_EnableFlashPowerDown() function. It can be switched on again by
software after exiting the Stop mode using the HAL_PWREx_DisableFlashPowerDown()
function.


Entry: The Stop mode is entered using the
HAL_PWR_EnterSTOPMode(PWR_MAINREGULATOR_ON) function with:

Main regulator ON.

Low Power regulator ON.
Exit: Any EXTI Line (Internal or External) configured in Interrupt/Event mode.
Standby mode

The Standby mode allows to achieve the lowest power consumption. It is based on
the Cortex-M3 deep sleep mode, with the voltage regulator disabled. The 1.2V 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, backup SRAM and Standby circuitry. The voltage regulator is
OFF.

Entry:

The Standby mode is entered using the HAL_PWR_EnterSTANDBYMode()
function.
DOCID028236 Rev 1
403/692
HAL PWR Generic Driver

UM1940
Exit:

WKUP pin rising edge, RTC alarm (Alarm A and Alarm B), RTC wake-up,
tamper event, time-stamp event, external reset in NRST pin, IWDG reset.
Auto-wake-up (AWU) from low-power mode


The MCU can be woken up from low-power mode by an RTC Alarm event, an RTC
Wake-up event, a tamper event or a time-stamp event, without depending on an
external interrupt (Auto-wake-up mode).
RTC auto-wake-up (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_RTCEx_SetTimeStamp_IT() or HAL_RTCEx_SetTamper_IT() functions.

To wake up from the Stop mode with an RTC Wake-up event, it is necessary to
configure the RTC to generate the RTC Wake-up event using the
HAL_RTCEx_SetWakeUpTimer_IT() function.
This section contains the following APIs:














31.2.3
31.2.4
404/692
HAL_PWR_ConfigPVD()
HAL_PWR_EnablePVD()
HAL_PWR_DisablePVD()
HAL_PWR_EnableWakeUpPin()
HAL_PWR_DisableWakeUpPin()
HAL_PWR_EnterSLEEPMode()
HAL_PWR_EnterSTOPMode()
HAL_PWR_EnterSTANDBYMode()
HAL_PWR_PVD_IRQHandler()
HAL_PWR_PVDCallback()
HAL_PWR_EnableSleepOnExit()
HAL_PWR_DisableSleepOnExit()
HAL_PWR_EnableSEVOnPend()
HAL_PWR_DisableSEVOnPend()
HAL_PWR_DeInit
Function Name
void HAL_PWR_DeInit (void )
Function Description
Deinitializes the HAL PWR peripheral registers to their default
reset values.
Return values

None
HAL_PWR_EnableBkUpAccess
Function Name
void HAL_PWR_EnableBkUpAccess (void )
Function Description
Enables access to the backup domain (RTC registers, RTC
backup data registers and backup SRAM).
Return values

None
Notes

If the HSE divided by 2, 3, ..31 is used as the RTC clock, the
DOCID028236 Rev 1
UM1940
31.2.5
31.2.6
31.2.7
31.2.8
31.2.9
31.2.10
HAL PWR Generic Driver
Backup Domain Access should be kept enabled.
HAL_PWR_DisableBkUpAccess
Function Name
void HAL_PWR_DisableBkUpAccess (void )
Function Description
Disables access to the backup domain (RTC registers, RTC
backup data registers and backup SRAM).
Return values

None
Notes

If the HSE divided by 2, 3, ..31 is used as the RTC clock, the
Backup Domain Access should be kept enabled.
HAL_PWR_ConfigPVD
Function Name
void HAL_PWR_ConfigPVD (PWR_PVDTypeDef * sConfigPVD)
Function Description
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 )
Function Description
Enables the Power Voltage Detector(PVD).
Return values

None
HAL_PWR_DisablePVD
Function Name
void HAL_PWR_DisablePVD (void )
Function Description
Disables the Power Voltage Detector(PVD).
Return values

None
HAL_PWR_EnableWakeUpPin
Function Name
void HAL_PWR_EnableWakeUpPin (uint32_t WakeUpPinx)
Function Description
Enables the Wake-up PINx functionality.
Parameters

WakeUpPinx: Specifies the Power Wake-Up pin to enable.
This parameter can be one of the following values:
PWR_WAKEUP_PIN1
Return values

None
HAL_PWR_DisableWakeUpPin
Function Name
void HAL_PWR_DisableWakeUpPin (uint32_t WakeUpPinx)
DOCID028236 Rev 1
405/692
HAL PWR Generic Driver
Function Description
31.2.11
UM1940
Disables the Wake-up PINx functionality.
Parameters

WakeUpPinx: Specifies the Power Wake-Up pin to disable.
This parameter can be one of the following values:
PWR_WAKEUP_PIN1
Return values

None
HAL_PWR_EnterSLEEPMode
Function Name
void HAL_PWR_EnterSLEEPMode (uint32_t Regulator, uint8_t
SLEEPEntry)
Function Description
Enters Sleep mode.
Parameters


Regulator: Specifies the regulator state in SLEEP mode.
This parameter can be one of the following values:
PWR_MAINREGULATOR_ON: SLEEP mode with regulator
ONPWR_LOWPOWERREGULATOR_ON: SLEEP mode with
low power regulator ON
SLEEPEntry: Specifies if SLEEP mode in entered with WFI
or WFE instruction. This parameter can be one of the
following values: PWR_SLEEPENTRY_WFI: enter SLEEP
mode with WFI instructionPWR_SLEEPENTRY_WFE: enter
SLEEP mode with WFE instruction
Return values

None
Notes

In Sleep mode, all I/O pins keep the same state as in Run
mode.
In Sleep mode, the systick is stopped to avoid exit from this
mode with systick interrupt when used as time base for
Timeout
This parameter is not used for the STM32F2 family and is
kept as parameter just to maintain compatibility with the lower
power families.


31.2.12
406/692
HAL_PWR_EnterSTOPMode
Function Name
void HAL_PWR_EnterSTOPMode (uint32_t Regulator, uint8_t
STOPEntry)
Function Description
Enters Stop mode.
Parameters


Regulator: Specifies the regulator state in Stop mode. This
parameter can be one of the following values:
PWR_MAINREGULATOR_ON: Stop mode with regulator
ONPWR_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_WFI: Enter Stop mode with WFI
instructionPWR_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.
DOCID028236 Rev 1
UM1940
HAL PWR Generic Driver


31.2.13
31.2.14
31.2.15
31.2.16
31.2.17
When exiting Stop mode by issuing an interrupt or a wake-up
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.
HAL_PWR_EnterSTANDBYMode
Function Name
void HAL_PWR_EnterSTANDBYMode (void )
Function Description
Enters Standby mode.
Return values

None
Notes

In Standby mode, all I/O pins are high impedance except for:
Reset pad (still available)RTC_AF1 pin (PC13) if configured
for tamper, time-stamp, RTC Alarm out, or RTC clock
calibration out.RTC_AF2 pin (PI8) if configured for tamper or
time-stamp.WKUP pin 1 (PA0) if enabled.
HAL_PWR_PVD_IRQHandler
Function Name
void HAL_PWR_PVD_IRQHandler (void )
Function Description
This function handles the PWR PVD interrupt request.
Return values

None
Notes

This API should be called under the PVD_IRQHandler().
HAL_PWR_PVDCallback
Function Name
void HAL_PWR_PVDCallback (void )
Function Description
PWR PVD interrupt callback.
Return values

None
HAL_PWR_EnableSleepOnExit
Function Name
void HAL_PWR_EnableSleepOnExit (void )
Function Description
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 )
Function Description
Disables Sleep-On-Exit feature when returning from Handler mode
to Thread mode.
DOCID028236 Rev 1
407/692
HAL PWR Generic Driver
Return values
Notes
31.2.18
31.2.19
UM1940

None

Clears SLEEPONEXIT bit of SCR register. When this bit is
set, the processor re-enters SLEEP mode when an
interruption handling is over.
HAL_PWR_EnableSEVOnPend
Function Name
void HAL_PWR_EnableSEVOnPend (void )
Function Description
Enables CORTEX M3 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 )
Function Description
Disables CORTEX M3 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.
31.3
PWR Firmware driver defines
31.3.1
PWR
PWR CR Register alias address
DBP_BIT_NUMBER
CR_DBP_BB
PVDE_BIT_NUMBER
CR_PVDE_BB
PWR CSR Register alias address
EWUP_BIT_NUMBER
CSR_EWUP_BB
PWR Exported Macro
__HAL_PWR_GET_FLAG
Description:

Check PWR flag is set or not.
Parameters:

408/692
DOCID028236 Rev 1
__FLAG__: specifies the flag to check.
This parameter can be one of the
following values:

PWR_FLAG_WU: Wake Up flag.
This flag indicates that a wakeup
UM1940



HAL PWR Generic Driver
event was received from the
WKUP pin or from the RTC alarm
(Alarm A or Alarm B), 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.
PWR_FLAG_BRR: Backup
regulator ready flag. This bit is not
reset when the device wakes up
from Standby mode or by a system
reset or power reset.
Return value:

__HAL_PWR_CLEAR_FLAG
The: new state of __FLAG__ (TRUE or
FALSE).
Description:

Clear the PWR's pending flags.
Parameters:

__HAL_PWR_PVD_EXTI_ENABLE_IT
__FLAG__: specifies the flag to clear.
This parameter can be one of the
following values:

PWR_FLAG_WU: Wake Up flag

PWR_FLAG_SB: StandBy flag
Description:

Enable the PVD Exti Line 16.
Return value:

__HAL_PWR_PVD_EXTI_DISABLE_IT
None.
Description:

Disable the PVD EXTI Line 16.
Return value:

__HAL_PWR_PVD_EXTI_ENABLE_EVEN
T
None.
Description:

DOCID028236 Rev 1
Enable event on PVD Exti Line 16.
409/692
HAL PWR Generic Driver
UM1940
Return value:

__HAL_PWR_PVD_EXTI_DISABLE_EVE
NT
None.
Description:

Disable event on PVD Exti Line 16.
Return value:

__HAL_PWR_PVD_EXTI_ENABLE_RISIN
G_EDGE
None.
Description:

Enable the PVD Extended Interrupt
Rising Trigger.
Return value:

__HAL_PWR_PVD_EXTI_DISABLE_RISI
NG_EDGE
None.
Description:

Disable the PVD Extended Interrupt
Rising Trigger.
Return value:

__HAL_PWR_PVD_EXTI_ENABLE_FALLI
NG_EDGE
None.
Description:

Enable the PVD Extended Interrupt
Falling Trigger.
Return value:

__HAL_PWR_PVD_EXTI_DISABLE_FALL
ING_EDGE
None.
Description:

Disable the PVD Extended Interrupt
Falling Trigger.
Return value:

__HAL_PWR_PVD_EXTI_ENABLE_RISIN
G_FALLING_EDGE
None.
Description:

PVD EXTI line configuration: set rising
& falling edge trigger.
Return value:

__HAL_PWR_PVD_EXTI_DISABLE_RISI
NG_FALLING_EDGE
None.
Description:

Disable the PVD Extended Interrupt
Rising & Falling Trigger.
Return value:

__HAL_PWR_PVD_EXTI_GET_FLAG
Description:

410/692
None.
DOCID028236 Rev 1
checks whether the specified PVD Exti
UM1940
HAL PWR Generic Driver
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_S
WIT
None.
Description:

Generates a Software interrupt on PVD
EXTI line.
Return value:

None
PWR Flag
PWR_FLAG_WU
PWR_FLAG_SB
PWR_FLAG_PVDO
PWR_FLAG_BRR
PWR Private macros to check input parameters
IS_PWR_WAKEUP_PIN
IS_PWR_PVD_LEVEL
IS_PWR_PVD_MODE
IS_PWR_REGULATOR
IS_PWR_SLEEP_ENTRY
IS_PWR_STOP_ENTRY
PWR 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
PWR PVD EXTI Line
PWR_EXTI_LINE_PVD
External interrupt line 16 Connected to the PVD EXTI Line
PWR PVD Mode
DOCID028236 Rev 1
411/692
HAL PWR Generic Driver
PWR_PVD_MODE_NORMAL
PWR_PVD_MODE_IT_RISING
External Interrupt Mode with Rising edge
trigger detection
PWR_PVD_MODE_IT_FALLING
External Interrupt Mode with Falling
edge trigger detection
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
PWR PVD Mode Mask
PVD_MODE_IT
PVD_MODE_EVT
PVD_RISING_EDGE
PVD_FALLING_EDGE
PWR Register alias address
PWR_OFFSET
PWR_CR_OFFSET
PWR_CSR_OFFSET
PWR_CR_OFFSET_BB
PWR_CSR_OFFSET_BB
PWR Regulator state in SLEEP/STOP mode
PWR_MAINREGULATOR_ON
PWR_LOWPOWERREGULATOR_ON
PWR SLEEP mode entry
PWR_SLEEPENTRY_WFI
PWR_SLEEPENTRY_WFE
PWR STOP mode entry
PWR_STOPENTRY_WFI
PWR_STOPENTRY_WFE
PWR WakeUp Pins
PWR_WAKEUP_PIN1
412/692
UM1940
basic mode is used
DOCID028236 Rev 1
UM1940
HAL PWR Extension Driver
32
HAL PWR Extension Driver
32.1
PWREx Firmware driver API description
32.1.1
Peripheral extended features functions
Main and Backup Regulators configuration



The backup domain includes 4 Kbytes of backup SRAM accessible only from the
CPU, and address in 32-bit, 16-bit or 8-bit mode. Its content is retained even in
Standby or VBAT mode when the low power backup regulator is enabled. It can be
considered as an internal EEPROM when VBAT is always present. You can use the
HAL_PWREx_EnableBkUpReg() function to enable the low power backup regulator.
When the backup domain is supplied by VDD (analog switch connected to VDD) the
backup SRAM is powered from VDD which replaces the VBAT power supply to save
battery life.
The backup SRAM is not mass erased by a tamper event. It is read protected to
prevent confidential data, such as cryptographic private key, from being accessed.
The backup SRAM can be erased only through the Flash interface when a protection
level change from level 1 to level 0 is requested. Refer to the description of Read
protection (RDP) in the Flash programming manual. Refer to the product datasheets
for more details.
FLASH Power Down configuration

By setting the FPDS bit in the PWR_CR register by using the
HAL_PWREx_EnableFlashPowerDown() function, the Flash memory also enters
power down mode when the device enters Stop mode. When the Flash memory is in
power down mode, an additional startup delay is incurred when waking up from Stop
mode.
This section contains the following APIs:




32.1.2
32.1.3
HAL_PWREx_EnableBkUpReg()
HAL_PWREx_DisableBkUpReg()
HAL_PWREx_EnableFlashPowerDown()
HAL_PWREx_DisableFlashPowerDown()
HAL_PWREx_EnableBkUpReg
Function Name
HAL_StatusTypeDef HAL_PWREx_EnableBkUpReg (void )
Function Description
Enables the Backup Regulator.
Return values

HAL status
HAL_PWREx_DisableBkUpReg
Function Name
HAL_StatusTypeDef HAL_PWREx_DisableBkUpReg (void )
Function Description
Disables the Backup Regulator.
DOCID028236 Rev 1
413/692
HAL PWR Extension Driver
Return values
32.1.4
32.1.5
UM1940

HAL status
HAL_PWREx_EnableFlashPowerDown
Function Name
void HAL_PWREx_EnableFlashPowerDown (void )
Function Description
Enables the Flash Power Down in Stop mode.
Return values

None
HAL_PWREx_DisableFlashPowerDown
Function Name
void HAL_PWREx_DisableFlashPowerDown (void )
Function Description
Disables the Flash Power Down in Stop mode.
Return values

None
32.2
PWREx Firmware driver defines
32.2.1
PWREx
PWRx CSR Register alias address
BRE_BIT_NUMBER
CSR_BRE_BB
PWREx Private Constants
PWR_BKPREG_TIMEOUT_VALUE
PWREx Register alias address
FPDS_BIT_NUMBER
CR_FPDS_BB
414/692
DOCID028236 Rev 1
UM1940
HAL RCC Generic Driver
33
HAL RCC Generic Driver
33.1
RCC Firmware driver registers structures
33.1.1
RCC_PLLInitTypeDef
Data Fields






uint32_t PLLState
uint32_t PLLSource
uint32_t PLLM
uint32_t PLLN
uint32_t PLLP
uint32_t PLLQ
Field Documentation






33.1.2
uint32_t RCC_PLLInitTypeDef::PLLState
The new state of the PLL. This parameter can be a value of RCC_PLL_Config
uint32_t RCC_PLLInitTypeDef::PLLSource
RCC_PLLSource: PLL entry clock source. This parameter must be a value of
RCC_PLL_Clock_Source
uint32_t RCC_PLLInitTypeDef::PLLM
PLLM: Division factor for PLL VCO input clock. This parameter must be a number
between Min_Data = 0 and Max_Data = 63
uint32_t RCC_PLLInitTypeDef::PLLN
PLLN: Multiplication factor for PLL VCO output clock. This parameter must be a
number between Min_Data = 192 and Max_Data = 432
uint32_t RCC_PLLInitTypeDef::PLLP
PLLP: Division factor for main system clock (SYSCLK). This parameter must be a
value of RCC_PLLP_Clock_Divider
uint32_t RCC_PLLInitTypeDef::PLLQ
PLLQ: Division factor for OTG FS, SDIO and RNG clocks. This parameter must be a
number between Min_Data = 0 and Max_Data = 63
RCC_OscInitTypeDef
Data Fields







uint32_t OscillatorType
uint32_t HSEState
uint32_t LSEState
uint32_t HSIState
uint32_t HSICalibrationValue
uint32_t LSIState
RCC_PLLInitTypeDef PLL
DOCID028236 Rev 1
415/692
HAL RCC Generic Driver
Field Documentation







33.1.3
UM1940
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
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 calibration trimming value. This parameter must be a number between Min_Data
= 0x00 and Max_Data = 0x1F
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
Data Fields





uint32_t ClockType
uint32_t SYSCLKSource
uint32_t AHBCLKDivider
uint32_t APB1CLKDivider
uint32_t APB2CLKDivider
Field Documentation





416/692
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 (SYSCLKS) 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_APB2_Clock_Source
uint32_t RCC_ClkInitTypeDef::APB2CLKDivider
The APB2 clock (PCLK2) divider. This clock is derived from the AHB clock (HCLK).
This parameter can be a value of RCC_APB1_APB2_Clock_Source
DOCID028236 Rev 1
UM1940
HAL RCC Generic Driver
33.2
RCC Firmware driver API description
33.2.1
RCC specific features
After reset the device is running from Internal High Speed oscillator (HSI 16MHz) with
Flash 0 wait state, Flash prefetch buffer, D-Cache and I-Cache are disabled, and all
peripherals are off except internal SRAM, Flash and JTAG.



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:





33.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 (I2S, RTC, ADC, USB OTG FS/SDIO/RNG)
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 registers.



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.
33.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 functions
This section provides functions allowing to configure the internal/external oscillators (HSE,
HSI, LSE, LSI, PLL, CSS and MCO) and the System busses clocks (SYSCLK, AHB, APB1
and APB2).
Internal/external clock and PLL configuration
1.
2.
3.
4.
5.
HSI (high-speed internal), 16 MHz factory-trimmed RC used directly or through the
PLL as System clock source.
LSI (low-speed internal), 32 KHz low consumption RC used as IWDG and/or RTC
clock source.
HSE (high-speed external), 4 to 26 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 or HSE), featuring two different output clocks:

The first output is used to generate the high speed system clock (up to 120 MHz)
DOCID028236 Rev 1
417/692
HAL RCC Generic Driver
UM1940

6.
7.
8.
The second output is used to generate the clock for the USB OTG FS (48 MHz),
the random analog generator (<=48 MHz) and the SDIO (<= 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 clocks automatically switched to
HSI and an interrupt is generated if enabled. The interrupt is linked to the Cortex-M3
NMI (Non-Maskable Interrupt) exception vector.
MCO1 (microcontroller clock output), used to output HSI, LSE, HSE or PLL clock
(through a configurable prescaler) on PA8 pin.
MCO2 (microcontroller clock output), used to output HSE, PLL, SYSCLK or PLLI2S
clock (through a configurable prescaler) on PC9 pin.
System, AHB and APB busses clocks configuration
1.
2.
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) and APB2 (PCLK2) clocks are 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: I2S: the I2S clock can be derived either from a specific PLL
(PLLI2S) or from an external clock mapped on the I2S_CKIN pin. You have to use
__HAL_RCC_PLLI2S_CONFIG() macro to configure this clock. RTC: the RTC clock
can be derived either from the LSI, LSE or HSE clock divided by 2 to 31. You have to
use __HAL_RCC_RTC_CONFIG() and __HAL_RCC_RTC_ENABLE() macros to
configure this clock. USB OTG FS, SDIO and RTC: USB OTG FS require a frequency
equal to 48 MHz to work correctly, while the SDIO require a frequency equal or lower
than to 48. This clock is derived of the main PLL through PLLQ divider. IWDG clock
which is always the LSI clock.
For the stm32f2xx devices, the maximum frequency of the SYSCLK and HCLK is 120
MHz, PCLK2 60 MHz and PCLK1 30 MHz. Depending on the device voltage range,
the maximum frequency should be adapted according to the table below.
Table 16: Number of wait states (WS) according to CPU clock (HCLK) frequency
HCLK clock frequency (MHz)
418/692
Latency
voltage range 2.7
to 3.6V
voltage range 2.4
to 2.7V
voltage range 2.1
to 2.4V
voltage range 1.8
to 2.1V
0W (1 CPU
cycle)
0 < HCLK ≤ 30
0 < HCLK ≤ 24
0 < HCLK ≤ 18
0 < HCLK ≤ 16
1WS (2 CPU
cycles)
30< HCLK ≤ 60
24< HCLK ≤ 48
18< HCLK ≤ 36
16< HCLK ≤ 32
2WS (3 CPU
cycles)
60< HCLK ≤ 90
48< HCLK ≤ 72
36< HCLK ≤ 54
32< HCLK ≤ 48
3WS (4 CPU
cycles)
90< HCLK ≤ 120
72< HCLK ≤ 96
54< HCLK ≤ 72
48< HCLK ≤ 64
4WS (5 CPU
cycles)
NA
96< HCLK ≤ 120
72< HCLK ≤ 90
64 < HCLK ≤ 80
5WS (6 CPU
cycles)
NA
NA
90< HCLK ≤ 108
80 < HCLK ≤ 96
6WS (7 CPU
cycles)
NA
NA
108< HCLK ≤ 120
96 < HCLK ≤ 112
DOCID028236 Rev 1
UM1940
HAL RCC Generic Driver
HCLK clock frequency (MHz)
Latency
voltage range 2.7
to 3.6V
voltage range 2.4
to 2.7V
voltage range 2.1
to 2.4V
voltage range 1.8
to 2.1V
NA
NA
NA
112 < HCLK ≤
120
7WS (8 CPU
cycles)
This section contains the following APIs:



33.2.4
HAL_RCC_DeInit()
HAL_RCC_OscConfig()
HAL_RCC_ClockConfig()
Peripheral Control functions
This subsection provides a set of functions allowing to control the RCC Clocks
frequencies.
This section contains the following APIs:











33.2.5
HAL_RCC_MCOConfig()
HAL_RCC_EnableCSS()
HAL_RCC_DisableCSS()
HAL_RCC_GetSysClockFreq()
HAL_RCC_GetHCLKFreq()
HAL_RCC_GetPCLK1Freq()
HAL_RCC_GetPCLK2Freq()
HAL_RCC_GetOscConfig()
HAL_RCC_GetClockConfig()
HAL_RCC_NMI_IRQHandler()
HAL_RCC_CSSCallback()
HAL_RCC_DeInit
Function Name
void HAL_RCC_DeInit (void )
Function Description
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, PLL
and PLLI2S OFFAHB, APB1 and APB2 prescaler set to
1.CSS, MCO1 and MCO2 OFFAll interrupts disabled
This function doesn't modify the configuration of the
Peripheral clocksLSI, LSE and RTC clocks

33.2.6
HAL_RCC_OscConfig
Function Name
HAL_StatusTypeDef HAL_RCC_OscConfig
(RCC_OscInitTypeDef * RCC_OscInitStruct)
Function Description
Initializes the RCC Oscillators according to the specified
parameters in the RCC_OscInitTypeDef.
Parameters

RCC_OscInitStruct: pointer to an RCC_OscInitTypeDef
structure that contains the configuration information for the
RCC Oscillators.
DOCID028236 Rev 1
419/692
HAL RCC Generic Driver
Return values
Notes
33.2.7
UM1940

HAL status

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)
Function Description
Initializes the CPU, AHB and APB busses clocks according to the
specified parameters in the RCC_ClkInitStruct.
Parameters


Return values

None
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.
Depending on the device voltage range, the software has to
set correctly HPRE[3:0] bits to ensure that HCLK not exceed
the maximum allowed frequency (for more details refer to
section above "Initialization/de-initialization functions")



33.2.8
HAL_RCC_MCOConfig
Function Name
void HAL_RCC_MCOConfig (uint32_t RCC_MCOx, uint32_t
RCC_MCOSource, uint32_t RCC_MCODiv)
Function Description
Selects the clock source to output on MCO1 pin(PA8) or on MCO2
pin(PC9).
Parameters


420/692
RCC_ClkInitStruct: pointer to an RCC_OscInitTypeDef
structure that contains the configuration information for the
RCC peripheral.
FLatency: FLASH Latency, this parameter depend on device
selected
RCC_MCOx: specifies the output direction for the clock
source. This parameter can be one of the following values:
RCC_MCO1: Clock source to output on MCO1
pin(PA8).RCC_MCO2: Clock source to output on MCO2
pin(PC9).
RCC_MCOSource: specifies the clock source to output. This
parameter can be one of the following values:
RCC_MCO1SOURCE_HSI: HSI clock selected as MCO1
sourceRCC_MCO1SOURCE_LSE: LSE clock selected as
MCO1 sourceRCC_MCO1SOURCE_HSE: HSE clock
selected as MCO1 sourceRCC_MCO1SOURCE_PLLCLK:
main PLL clock selected as MCO1
DOCID028236 Rev 1
UM1940
HAL RCC Generic Driver
sourceRCC_MCO2SOURCE_SYSCLK: System clock
(SYSCLK) selected as MCO2
sourceRCC_MCO2SOURCE_PLLI2SCLK: PLLI2S clock
selected as MCO2 sourceRCC_MCO2SOURCE_HSE: HSE
clock selected as MCO2
sourceRCC_MCO2SOURCE_PLLCLK: main PLL clock
selected as MCO2 source
RCC_MCODiv: specifies the MCOx prescaler. This
parameter can be one of the following values:
RCC_MCODIV_1: no division applied to MCOx
clockRCC_MCODIV_2: division by 2 applied to MCOx
clockRCC_MCODIV_3: division by 3 applied to MCOx
clockRCC_MCODIV_4: division by 4 applied to MCOx
clockRCC_MCODIV_5: division by 5 applied to MCOx clock

33.2.9
33.2.10
33.2.11
Return values

None
Notes

PA8/PC9 should be configured in alternate function mode.
HAL_RCC_EnableCSS
Function Name
void HAL_RCC_EnableCSS (void )
Function Description
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 CortexM3 NMI (Non-Maskable Interrupt) exception vector.
HAL_RCC_DisableCSS
Function Name
void HAL_RCC_DisableCSS (void )
Function Description
Disables the Clock Security System.
Return values

None
HAL_RCC_GetSysClockFreq
Function Name
uint32_t HAL_RCC_GetSysClockFreq (void )
Function Description
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 values based on
HSI_VALUE(*)
If SYSCLK source is HSE, function returns values based on
HSE_VALUE(**)
If SYSCLK source is PLL, function returns values based on
HSE_VALUE(**) or HSI_VALUE(*) multiplied/divided by the



DOCID028236 Rev 1
421/692
HAL RCC Generic Driver





33.2.12
HAL_RCC_GetHCLKFreq
Function Name
uint32_t HAL_RCC_GetHCLKFreq (void )
Function Description
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
based on this function will be incorrect.
The SystemCoreClock CMSIS variable is used to store
System Clock Frequency and updated within this function

33.2.13
33.2.14
33.2.15
HAL_RCC_GetPCLK1Freq
Function Name
uint32_t HAL_RCC_GetPCLK1Freq (void )
Function Description
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
based on this function will be incorrect.
HAL_RCC_GetPCLK2Freq
Function Name
uint32_t HAL_RCC_GetPCLK2Freq (void )
Function Description
Returns the PCLK2 frequency.
Return values

PCLK2 frequency
Notes

Each time PCLK2 changes, this function must be called to
update the right PCLK2 value. Otherwise, any configuration
based on this function will be incorrect.
HAL_RCC_GetOscConfig
Function Name
422/692
UM1940
PLL factors.
(*) HSI_VALUE is a constant defined in stm32f2xx_hal_conf.h
file (default value 16 MHz) but the real value may vary
depending on the variations in voltage and temperature.
(**) HSE_VALUE is a constant defined in
stm32f2xx_hal_conf.h file (default value 25 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.
void HAL_RCC_GetOscConfig (RCC_OscInitTypeDef *
DOCID028236 Rev 1
UM1940
HAL RCC Generic Driver
RCC_OscInitStruct)
33.2.16
Function Description
Configures the RCC_OscInitStruct according to the internal RCC
configuration registers.
Parameters

RCC_OscInitStruct: pointer to an RCC_OscInitTypeDef
structure that will be configured.
Return values

None
HAL_RCC_GetClockConfig
Function Name
void HAL_RCC_GetClockConfig (RCC_ClkInitTypeDef *
RCC_ClkInitStruct, uint32_t * pFLatency)
Function Description
Configures the RCC_ClkInitStruct according to the internal RCC
configuration registers.
Parameters

Return values
33.2.17
33.2.18

RCC_ClkInitStruct: pointer to an RCC_ClkInitTypeDef
structure that will be configured.
pFLatency: Pointer on the Flash Latency.

None
HAL_RCC_NMI_IRQHandler
Function Name
void HAL_RCC_NMI_IRQHandler (void )
Function Description
This function handles the RCC CSS interrupt request.
Return values

None
Notes

This API should be called under the NMI_Handler().
HAL_RCC_CSSCallback
Function Name
void HAL_RCC_CSSCallback (void )
Function Description
RCC Clock Security System interrupt callback.
Return values

None
33.3
RCC Firmware driver defines
33.3.1
RCC
AHB1 Peripheral Clock Enable Disable
__HAL_RCC_GPIOA_CLK_ENABLE
__HAL_RCC_GPIOB_CLK_ENABLE
__HAL_RCC_GPIOC_CLK_ENABLE
__HAL_RCC_GPIOD_CLK_ENABLE
__HAL_RCC_GPIOE_CLK_ENABLE
__HAL_RCC_GPIOF_CLK_ENABLE
__HAL_RCC_GPIOG_CLK_ENABLE
__HAL_RCC_GPIOH_CLK_ENABLE
DOCID028236 Rev 1
423/692
HAL RCC Generic Driver
__HAL_RCC_GPIOI_CLK_ENABLE
__HAL_RCC_CRC_CLK_ENABLE
__HAL_RCC_BKPSRAM_CLK_ENABLE
__HAL_RCC_DMA1_CLK_ENABLE
__HAL_RCC_DMA2_CLK_ENABLE
__HAL_RCC_USB_OTG_HS_CLK_ENABLE
__HAL_RCC_USB_OTG_HS_ULPI_CLK_ENABLE
__HAL_RCC_GPIOA_CLK_DISABLE
__HAL_RCC_GPIOB_CLK_DISABLE
__HAL_RCC_GPIOC_CLK_DISABLE
__HAL_RCC_GPIOD_CLK_DISABLE
__HAL_RCC_GPIOE_CLK_DISABLE
__HAL_RCC_GPIOF_CLK_DISABLE
__HAL_RCC_GPIOG_CLK_DISABLE
__HAL_RCC_GPIOH_CLK_DISABLE
__HAL_RCC_GPIOI_CLK_DISABLE
__HAL_RCC_CRC_CLK_DISABLE
__HAL_RCC_BKPSRAM_CLK_DISABLE
__HAL_RCC_DMA1_CLK_DISABLE
__HAL_RCC_DMA2_CLK_DISABLE
__HAL_RCC_USB_OTG_HS_CLK_DISABLE
__HAL_RCC_USB_OTG_HS_ULPI_CLK_DISABLE
AHB1 Force Release Reset
__HAL_RCC_AHB1_FORCE_RESET
__HAL_RCC_GPIOA_FORCE_RESET
__HAL_RCC_GPIOB_FORCE_RESET
__HAL_RCC_GPIOC_FORCE_RESET
__HAL_RCC_GPIOD_FORCE_RESET
__HAL_RCC_GPIOE_FORCE_RESET
__HAL_RCC_GPIOF_FORCE_RESET
__HAL_RCC_GPIOG_FORCE_RESET
__HAL_RCC_GPIOH_FORCE_RESET
__HAL_RCC_GPIOI_FORCE_RESET
__HAL_RCC_CRC_FORCE_RESET
__HAL_RCC_DMA1_FORCE_RESET
__HAL_RCC_DMA2_FORCE_RESET
424/692
DOCID028236 Rev 1
UM1940
UM1940
HAL RCC Generic Driver
__HAL_RCC_USB_OTG_HS_FORCE_RESET
__HAL_RCC_OTGHSULPI_FORCE_RESET
__HAL_RCC_AHB1_RELEASE_RESET
__HAL_RCC_GPIOA_RELEASE_RESET
__HAL_RCC_GPIOB_RELEASE_RESET
__HAL_RCC_GPIOC_RELEASE_RESET
__HAL_RCC_GPIOD_RELEASE_RESET
__HAL_RCC_GPIOE_RELEASE_RESET
__HAL_RCC_GPIOF_RELEASE_RESET
__HAL_RCC_GPIOG_RELEASE_RESET
__HAL_RCC_GPIOH_RELEASE_RESET
__HAL_RCC_GPIOI_RELEASE_RESET
__HAL_RCC_CRC_RELEASE_RESET
__HAL_RCC_DMA1_RELEASE_RESET
__HAL_RCC_DMA2_RELEASE_RESET
__HAL_RCC_USB_OTG_HS_RELEASE_RESET
__HAL_RCC_OTGHSULPI_RELEASE_RESET
AHB1 Peripheral Low Power Enable Disable
__HAL_RCC_GPIOA_CLK_SLEEP_ENABLE
__HAL_RCC_GPIOB_CLK_SLEEP_ENABLE
__HAL_RCC_GPIOC_CLK_SLEEP_ENABLE
__HAL_RCC_GPIOD_CLK_SLEEP_ENABLE
__HAL_RCC_GPIOE_CLK_SLEEP_ENABLE
__HAL_RCC_GPIOF_CLK_SLEEP_ENABLE
__HAL_RCC_GPIOG_CLK_SLEEP_ENABLE
__HAL_RCC_GPIOH_CLK_SLEEP_ENABLE
__HAL_RCC_GPIOI_CLK_SLEEP_ENABLE
__HAL_RCC_CRC_CLK_SLEEP_ENABLE
__HAL_RCC_FLITF_CLK_SLEEP_ENABLE
__HAL_RCC_SRAM1_CLK_SLEEP_ENABLE
__HAL_RCC_SRAM2_CLK_SLEEP_ENABLE
__HAL_RCC_BKPSRAM_CLK_SLEEP_ENABLE
__HAL_RCC_DMA1_CLK_SLEEP_ENABLE
__HAL_RCC_DMA2_CLK_SLEEP_ENABLE
__HAL_RCC_USB_OTG_HS_CLK_SLEEP_ENABLE
__HAL_RCC_USB_OTG_HS_ULPI_CLK_SLEEP_ENABLE
DOCID028236 Rev 1
425/692
HAL RCC Generic Driver
__HAL_RCC_GPIOA_CLK_SLEEP_DISABLE
__HAL_RCC_GPIOB_CLK_SLEEP_DISABLE
__HAL_RCC_GPIOC_CLK_SLEEP_DISABLE
__HAL_RCC_GPIOD_CLK_SLEEP_DISABLE
__HAL_RCC_GPIOE_CLK_SLEEP_DISABLE
__HAL_RCC_GPIOF_CLK_SLEEP_DISABLE
__HAL_RCC_GPIOG_CLK_SLEEP_DISABLE
__HAL_RCC_GPIOH_CLK_SLEEP_DISABLE
__HAL_RCC_GPIOI_CLK_SLEEP_DISABLE
__HAL_RCC_CRC_CLK_SLEEP_DISABLE
__HAL_RCC_FLITF_CLK_SLEEP_DISABLE
__HAL_RCC_SRAM1_CLK_SLEEP_DISABLE
__HAL_RCC_SRAM2_CLK_SLEEP_DISABLE
__HAL_RCC_BKPSRAM_CLK_SLEEP_DISABLE
__HAL_RCC_DMA1_CLK_SLEEP_DISABLE
__HAL_RCC_DMA2_CLK_SLEEP_DISABLE
__HAL_RCC_USB_OTG_HS_CLK_SLEEP_DISABLE
__HAL_RCC_USB_OTG_HS_ULPI_CLK_SLEEP_DISABLE
AHB2 Peripheral Clock Enable Disable
__HAL_RCC_USB_OTG_FS_CLK_ENABLE
__HAL_RCC_RNG_CLK_ENABLE
__HAL_RCC_USB_OTG_FS_CLK_DISABLE
__HAL_RCC_RNG_CLK_DISABLE
AHB2 Force Release Reset
__HAL_RCC_AHB2_FORCE_RESET
__HAL_RCC_RNG_FORCE_RESET
__HAL_RCC_USB_OTG_FS_FORCE_RESET
__HAL_RCC_AHB2_RELEASE_RESET
__HAL_RCC_RNG_RELEASE_RESET
__HAL_RCC_USB_OTG_FS_RELEASE_RESET
AHB2 Peripheral Low Power Enable Disable
__HAL_RCC_USB_OTG_FS_CLK_SLEEP_ENABLE
__HAL_RCC_RNG_CLK_SLEEP_ENABLE
__HAL_RCC_USB_OTG_FS_CLK_SLEEP_DISABLE
__HAL_RCC_RNG_CLK_SLEEP_DISABLE
AHB3 Peripheral Clock Enable Disable
426/692
DOCID028236 Rev 1
UM1940
UM1940
HAL RCC Generic Driver
__HAL_RCC_FSMC_CLK_ENABLE
__HAL_RCC_FSMC_CLK_DISABLE
AHB3 Force Release Reset
__HAL_RCC_AHB3_FORCE_RESET
__HAL_RCC_FSMC_FORCE_RESET
__HAL_RCC_AHB3_RELEASE_RESET
__HAL_RCC_FSMC_RELEASE_RESET
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
APB1/APB2 Clock Source
RCC_HCLK_DIV1
RCC_HCLK_DIV2
RCC_HCLK_DIV4
RCC_HCLK_DIV8
RCC_HCLK_DIV16
APB1 Peripheral Clock Enable Disable
__HAL_RCC_TIM2_CLK_ENABLE
__HAL_RCC_TIM3_CLK_ENABLE
__HAL_RCC_TIM4_CLK_ENABLE
__HAL_RCC_TIM5_CLK_ENABLE
__HAL_RCC_TIM6_CLK_ENABLE
__HAL_RCC_TIM7_CLK_ENABLE
__HAL_RCC_TIM12_CLK_ENABLE
__HAL_RCC_TIM13_CLK_ENABLE
__HAL_RCC_TIM14_CLK_ENABLE
__HAL_RCC_WWDG_CLK_ENABLE
__HAL_RCC_SPI2_CLK_ENABLE
__HAL_RCC_SPI3_CLK_ENABLE
DOCID028236 Rev 1
427/692
HAL RCC Generic Driver
__HAL_RCC_USART2_CLK_ENABLE
__HAL_RCC_USART3_CLK_ENABLE
__HAL_RCC_UART4_CLK_ENABLE
__HAL_RCC_UART5_CLK_ENABLE
__HAL_RCC_I2C1_CLK_ENABLE
__HAL_RCC_I2C2_CLK_ENABLE
__HAL_RCC_I2C3_CLK_ENABLE
__HAL_RCC_CAN1_CLK_ENABLE
__HAL_RCC_CAN2_CLK_ENABLE
__HAL_RCC_PWR_CLK_ENABLE
__HAL_RCC_DAC_CLK_ENABLE
__HAL_RCC_TIM2_CLK_DISABLE
__HAL_RCC_TIM3_CLK_DISABLE
__HAL_RCC_TIM4_CLK_DISABLE
__HAL_RCC_TIM5_CLK_DISABLE
__HAL_RCC_TIM6_CLK_DISABLE
__HAL_RCC_TIM7_CLK_DISABLE
__HAL_RCC_TIM12_CLK_DISABLE
__HAL_RCC_TIM13_CLK_DISABLE
__HAL_RCC_TIM14_CLK_DISABLE
__HAL_RCC_WWDG_CLK_DISABLE
__HAL_RCC_SPI2_CLK_DISABLE
__HAL_RCC_SPI3_CLK_DISABLE
__HAL_RCC_USART2_CLK_DISABLE
__HAL_RCC_USART3_CLK_DISABLE
__HAL_RCC_UART4_CLK_DISABLE
__HAL_RCC_UART5_CLK_DISABLE
__HAL_RCC_I2C1_CLK_DISABLE
__HAL_RCC_I2C2_CLK_DISABLE
__HAL_RCC_I2C3_CLK_DISABLE
__HAL_RCC_PWR_CLK_DISABLE
__HAL_RCC_CAN1_CLK_DISABLE
__HAL_RCC_CAN2_CLK_DISABLE
__HAL_RCC_DAC_CLK_DISABLE
APB1 Force Release Reset
__HAL_RCC_APB1_FORCE_RESET
428/692
DOCID028236 Rev 1
UM1940
UM1940
HAL RCC Generic Driver
__HAL_RCC_TIM2_FORCE_RESET
__HAL_RCC_TIM3_FORCE_RESET
__HAL_RCC_TIM4_FORCE_RESET
__HAL_RCC_TIM5_FORCE_RESET
__HAL_RCC_TIM6_FORCE_RESET
__HAL_RCC_TIM7_FORCE_RESET
__HAL_RCC_TIM12_FORCE_RESET
__HAL_RCC_TIM13_FORCE_RESET
__HAL_RCC_TIM14_FORCE_RESET
__HAL_RCC_WWDG_FORCE_RESET
__HAL_RCC_SPI2_FORCE_RESET
__HAL_RCC_SPI3_FORCE_RESET
__HAL_RCC_USART2_FORCE_RESET
__HAL_RCC_USART3_FORCE_RESET
__HAL_RCC_UART4_FORCE_RESET
__HAL_RCC_UART5_FORCE_RESET
__HAL_RCC_I2C1_FORCE_RESET
__HAL_RCC_I2C2_FORCE_RESET
__HAL_RCC_I2C3_FORCE_RESET
__HAL_RCC_CAN1_FORCE_RESET
__HAL_RCC_CAN2_FORCE_RESET
__HAL_RCC_PWR_FORCE_RESET
__HAL_RCC_DAC_FORCE_RESET
__HAL_RCC_APB1_RELEASE_RESET
__HAL_RCC_TIM2_RELEASE_RESET
__HAL_RCC_TIM3_RELEASE_RESET
__HAL_RCC_TIM4_RELEASE_RESET
__HAL_RCC_TIM5_RELEASE_RESET
__HAL_RCC_TIM6_RELEASE_RESET
__HAL_RCC_TIM7_RELEASE_RESET
__HAL_RCC_TIM12_RELEASE_RESET
__HAL_RCC_TIM13_RELEASE_RESET
__HAL_RCC_TIM14_RELEASE_RESET
__HAL_RCC_WWDG_RELEASE_RESET
__HAL_RCC_SPI2_RELEASE_RESET
__HAL_RCC_SPI3_RELEASE_RESET
DOCID028236 Rev 1
429/692
HAL RCC Generic Driver
__HAL_RCC_USART2_RELEASE_RESET
__HAL_RCC_USART3_RELEASE_RESET
__HAL_RCC_UART4_RELEASE_RESET
__HAL_RCC_UART5_RELEASE_RESET
__HAL_RCC_I2C1_RELEASE_RESET
__HAL_RCC_I2C2_RELEASE_RESET
__HAL_RCC_I2C3_RELEASE_RESET
__HAL_RCC_CAN1_RELEASE_RESET
__HAL_RCC_CAN2_RELEASE_RESET
__HAL_RCC_PWR_RELEASE_RESET
__HAL_RCC_DAC_RELEASE_RESET
APB1 Peripheral Low Power Enable Disable
__HAL_RCC_TIM2_CLK_SLEEP_ENABLE
__HAL_RCC_TIM3_CLK_SLEEP_ENABLE
__HAL_RCC_TIM4_CLK_SLEEP_ENABLE
__HAL_RCC_TIM5_CLK_SLEEP_ENABLE
__HAL_RCC_TIM6_CLK_SLEEP_ENABLE
__HAL_RCC_TIM7_CLK_SLEEP_ENABLE
__HAL_RCC_TIM12_CLK_SLEEP_ENABLE
__HAL_RCC_TIM13_CLK_SLEEP_ENABLE
__HAL_RCC_TIM14_CLK_SLEEP_ENABLE
__HAL_RCC_WWDG_CLK_SLEEP_ENABLE
__HAL_RCC_SPI2_CLK_SLEEP_ENABLE
__HAL_RCC_SPI3_CLK_SLEEP_ENABLE
__HAL_RCC_USART2_CLK_SLEEP_ENABLE
__HAL_RCC_USART3_CLK_SLEEP_ENABLE
__HAL_RCC_UART4_CLK_SLEEP_ENABLE
__HAL_RCC_UART5_CLK_SLEEP_ENABLE
__HAL_RCC_I2C1_CLK_SLEEP_ENABLE
__HAL_RCC_I2C2_CLK_SLEEP_ENABLE
__HAL_RCC_I2C3_CLK_SLEEP_ENABLE
__HAL_RCC_PWR_CLK_SLEEP_ENABLE
__HAL_RCC_CAN1_CLK_SLEEP_ENABLE
__HAL_RCC_CAN2_CLK_SLEEP_ENABLE
__HAL_RCC_DAC_CLK_SLEEP_ENABLE
__HAL_RCC_TIM2_CLK_SLEEP_DISABLE
430/692
DOCID028236 Rev 1
UM1940
UM1940
HAL RCC Generic Driver
__HAL_RCC_TIM3_CLK_SLEEP_DISABLE
__HAL_RCC_TIM4_CLK_SLEEP_DISABLE
__HAL_RCC_TIM5_CLK_SLEEP_DISABLE
__HAL_RCC_TIM6_CLK_SLEEP_DISABLE
__HAL_RCC_TIM7_CLK_SLEEP_DISABLE
__HAL_RCC_TIM12_CLK_SLEEP_DISABLE
__HAL_RCC_TIM13_CLK_SLEEP_DISABLE
__HAL_RCC_TIM14_CLK_SLEEP_DISABLE
__HAL_RCC_WWDG_CLK_SLEEP_DISABLE
__HAL_RCC_SPI2_CLK_SLEEP_DISABLE
__HAL_RCC_SPI3_CLK_SLEEP_DISABLE
__HAL_RCC_USART2_CLK_SLEEP_DISABLE
__HAL_RCC_USART3_CLK_SLEEP_DISABLE
__HAL_RCC_UART4_CLK_SLEEP_DISABLE
__HAL_RCC_UART5_CLK_SLEEP_DISABLE
__HAL_RCC_I2C1_CLK_SLEEP_DISABLE
__HAL_RCC_I2C2_CLK_SLEEP_DISABLE
__HAL_RCC_I2C3_CLK_SLEEP_DISABLE
__HAL_RCC_PWR_CLK_SLEEP_DISABLE
__HAL_RCC_CAN1_CLK_SLEEP_DISABLE
__HAL_RCC_CAN2_CLK_SLEEP_DISABLE
__HAL_RCC_DAC_CLK_SLEEP_DISABLE
APB2 Peripheral Clock Enable Disable
__HAL_RCC_TIM1_CLK_ENABLE
__HAL_RCC_TIM8_CLK_ENABLE
__HAL_RCC_USART1_CLK_ENABLE
__HAL_RCC_USART6_CLK_ENABLE
__HAL_RCC_ADC1_CLK_ENABLE
__HAL_RCC_ADC2_CLK_ENABLE
__HAL_RCC_ADC3_CLK_ENABLE
__HAL_RCC_SDIO_CLK_ENABLE
__HAL_RCC_SPI1_CLK_ENABLE
__HAL_RCC_SYSCFG_CLK_ENABLE
__HAL_RCC_TIM9_CLK_ENABLE
__HAL_RCC_TIM10_CLK_ENABLE
__HAL_RCC_TIM11_CLK_ENABLE
DOCID028236 Rev 1
431/692
HAL RCC Generic Driver
__HAL_RCC_TIM1_CLK_DISABLE
__HAL_RCC_TIM8_CLK_DISABLE
__HAL_RCC_USART1_CLK_DISABLE
__HAL_RCC_USART6_CLK_DISABLE
__HAL_RCC_ADC1_CLK_DISABLE
__HAL_RCC_ADC2_CLK_DISABLE
__HAL_RCC_ADC3_CLK_DISABLE
__HAL_RCC_SDIO_CLK_DISABLE
__HAL_RCC_SPI1_CLK_DISABLE
__HAL_RCC_SYSCFG_CLK_DISABLE
__HAL_RCC_TIM9_CLK_DISABLE
__HAL_RCC_TIM10_CLK_DISABLE
__HAL_RCC_TIM11_CLK_DISABLE
APB2 Force Release Reset
__HAL_RCC_APB2_FORCE_RESET
__HAL_RCC_TIM1_FORCE_RESET
__HAL_RCC_TIM8_FORCE_RESET
__HAL_RCC_USART1_FORCE_RESET
__HAL_RCC_USART6_FORCE_RESET
__HAL_RCC_ADC_FORCE_RESET
__HAL_RCC_SDIO_FORCE_RESET
__HAL_RCC_SPI1_FORCE_RESET
__HAL_RCC_SYSCFG_FORCE_RESET
__HAL_RCC_TIM9_FORCE_RESET
__HAL_RCC_TIM10_FORCE_RESET
__HAL_RCC_TIM11_FORCE_RESET
__HAL_RCC_APB2_RELEASE_RESET
__HAL_RCC_TIM1_RELEASE_RESET
__HAL_RCC_TIM8_RELEASE_RESET
__HAL_RCC_USART1_RELEASE_RESET
__HAL_RCC_USART6_RELEASE_RESET
__HAL_RCC_ADC_RELEASE_RESET
__HAL_RCC_SDIO_RELEASE_RESET
__HAL_RCC_SPI1_RELEASE_RESET
__HAL_RCC_SYSCFG_RELEASE_RESET
__HAL_RCC_TIM9_RELEASE_RESET
432/692
DOCID028236 Rev 1
UM1940
UM1940
HAL RCC Generic Driver
__HAL_RCC_TIM10_RELEASE_RESET
__HAL_RCC_TIM11_RELEASE_RESET
APB2 Peripheral Low Power Enable Disable
__HAL_RCC_TIM1_CLK_SLEEP_ENABLE
__HAL_RCC_USART1_CLK_SLEEP_ENABLE
__HAL_RCC_USART6_CLK_SLEEP_ENABLE
__HAL_RCC_ADC1_CLK_SLEEP_ENABLE
__HAL_RCC_SDIO_CLK_SLEEP_ENABLE
__HAL_RCC_SPI1_CLK_SLEEP_ENABLE
__HAL_RCC_SYSCFG_CLK_SLEEP_ENABLE
__HAL_RCC_TIM8_CLK_SLEEP_ENABLE
__HAL_RCC_TIM9_CLK_SLEEP_ENABLE
__HAL_RCC_TIM10_CLK_SLEEP_ENABLE
__HAL_RCC_TIM11_CLK_SLEEP_ENABLE
__HAL_RCC_ADC2_CLK_SLEEP_ENABLE
__HAL_RCC_ADC3_CLK_SLEEP_ENABLE
__HAL_RCC_TIM1_CLK_SLEEP_DISABLE
__HAL_RCC_USART1_CLK_SLEEP_DISABLE
__HAL_RCC_USART6_CLK_SLEEP_DISABLE
__HAL_RCC_ADC1_CLK_SLEEP_DISABLE
__HAL_RCC_SDIO_CLK_SLEEP_DISABLE
__HAL_RCC_SPI1_CLK_SLEEP_DISABLE
__HAL_RCC_SYSCFG_CLK_SLEEP_DISABLE
__HAL_RCC_TIM8_CLK_SLEEP_DISABLE
__HAL_RCC_TIM9_CLK_SLEEP_DISABLE
__HAL_RCC_TIM10_CLK_SLEEP_DISABLE
__HAL_RCC_TIM11_CLK_SLEEP_DISABLE
__HAL_RCC_ADC2_CLK_SLEEP_DISABLE
__HAL_RCC_ADC3_CLK_SLEEP_DISABLE
RCC BitAddress AliasRegion
RCC_OFFSET
RCC_CR_OFFSET
RCC_HSION_BIT_NUMBER
RCC_CR_HSION_BB
RCC_CSSON_BIT_NUMBER
RCC_CR_CSSON_BB
DOCID028236 Rev 1
433/692
HAL RCC Generic Driver
RCC_PLLON_BIT_NUMBER
RCC_CR_PLLON_BB
RCC_PLLI2SON_BIT_NUMBER
RCC_CR_PLLI2SON_BB
RCC_CFGR_OFFSET
RCC_I2SSRC_BIT_NUMBER
RCC_CFGR_I2SSRC_BB
RCC_BDCR_OFFSET
RCC_RTCEN_BIT_NUMBER
RCC_BDCR_RTCEN_BB
RCC_BDRST_BIT_NUMBER
RCC_BDCR_BDRST_BB
RCC_CSR_OFFSET
RCC_LSION_BIT_NUMBER
RCC_CSR_LSION_BB
RCC_CR_BYTE2_ADDRESS
RCC_CIR_BYTE1_ADDRESS
RCC_CIR_BYTE2_ADDRESS
RCC_BDCR_BYTE0_ADDRESS
RCC_DBP_TIMEOUT_VALUE
RCC_LSE_TIMEOUT_VALUE
HSE_TIMEOUT_VALUE
HSI_TIMEOUT_VALUE
LSI_TIMEOUT_VALUE
PLLI2S_TIMEOUT_VALUE
RCC Exported Macros
__HAL_RCC_FSMC_CLK_SLEEP_ENABLE
__HAL_RCC_FSMC_CLK_SLEEP_DISABLE
Flags
RCC_FLAG_HSIRDY
RCC_FLAG_HSERDY
RCC_FLAG_PLLRDY
RCC_FLAG_PLLI2SRDY
RCC_FLAG_LSERDY
RCC_FLAG_LSIRDY
RCC_FLAG_BORRST
434/692
DOCID028236 Rev 1
UM1940
UM1940
HAL RCC Generic Driver
RCC_FLAG_PINRST
RCC_FLAG_PORRST
RCC_FLAG_SFTRST
RCC_FLAG_IWDGRST
RCC_FLAG_WWDGRST
RCC_FLAG_LPWRRST
Flags Interrupts Management
__HAL_RCC_ENABLE_IT
Description:

Enable RCC interrupt (Perform Byte access
to RCC_CIR[14:8] bits to enable the
selected interrupts).
Parameters:

__HAL_RCC_DISABLE_IT
__INTERRUPT__: specifies the RCC
interrupt sources to be enabled. This
parameter can be any combination of the
following values:

RCC_IT_LSIRDY: LSI ready interrupt.

RCC_IT_LSERDY: LSE ready interrupt.

RCC_IT_HSIRDY: HSI ready interrupt.

RCC_IT_HSERDY: HSE ready
interrupt.

RCC_IT_PLLRDY: Main PLL ready
interrupt.

RCC_IT_PLLI2SRDY: PLLI2S ready
interrupt.
Description:

Disable RCC interrupt (Perform Byte access
to RCC_CIR[14:8] bits to disable the
selected interrupts).
Parameters:

__HAL_RCC_CLEAR_IT
__INTERRUPT__: specifies the RCC
interrupt sources to be disabled. This
parameter can be any combination of the
following values:

RCC_IT_LSIRDY: LSI ready interrupt.

RCC_IT_LSERDY: LSE ready interrupt.

RCC_IT_HSIRDY: HSI ready interrupt.

RCC_IT_HSERDY: HSE ready
interrupt.

RCC_IT_PLLRDY: Main PLL ready
interrupt.

RCC_IT_PLLI2SRDY: PLLI2S ready
interrupt.
Description:

Clear the RCC's interrupt pending bits
(Perform Byte access to RCC_CIR[23:16]
DOCID028236 Rev 1
435/692
HAL RCC Generic Driver
UM1940
bits to clear the selected interrupt pending
bits.
Parameters:

__INTERRUPT__: specifies the interrupt
pending bit to clear. This parameter can be
any combination of the following values:

RCC_IT_LSIRDY: LSI ready interrupt.

RCC_IT_LSERDY: LSE ready interrupt.

RCC_IT_HSIRDY: HSI ready interrupt.

RCC_IT_HSERDY: HSE ready
interrupt.

RCC_IT_PLLRDY: Main PLL ready
interrupt.

RCC_IT_PLLI2SRDY: PLLI2S ready
interrupt.

RCC_IT_CSS: Clock Security System
interrupt
Description:
__HAL_RCC_GET_IT

Check the RCC's interrupt has occurred or
not.
Parameters:

__INTERRUPT__: specifies the RCC
interrupt source to check. This parameter
can be one of the following values:

RCC_IT_LSIRDY: LSI ready interrupt.

RCC_IT_LSERDY: LSE ready interrupt.

RCC_IT_HSIRDY: HSI ready interrupt.

RCC_IT_HSERDY: HSE ready
interrupt.

RCC_IT_PLLRDY: Main PLL ready
interrupt.

RCC_IT_PLLI2SRDY: PLLI2S ready
interrupt.

RCC_IT_CSS: Clock Security System
interrupt
Return value:

The: new state of __INTERRUPT__ (TRUE
or FALSE).
__HAL_RCC_CLEAR_RESET_FLAGS
RCC_FLAG_MASK
Description:

Check RCC flag is set or not.
Parameters:

436/692
__FLAG__: specifies the flag to check. This
parameter can be one of the following
values:

RCC_FLAG_HSIRDY: HSI oscillator
clock ready.
DOCID028236 Rev 1
UM1940
HAL RCC Generic Driver












RCC_FLAG_HSERDY: HSE oscillator
clock ready.
RCC_FLAG_PLLRDY: Main PLL clock
ready.
RCC_FLAG_PLLI2SRDY: PLLI2S
clock ready.
RCC_FLAG_LSERDY: LSE oscillator
clock ready.
RCC_FLAG_LSIRDY: LSI oscillator
clock ready.
RCC_FLAG_BORRST: POR/PDR or
BOR 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:

The: new state of __FLAG__ (TRUE or
FALSE).
__HAL_RCC_GET_FLAG
RCC_GET_PLL_OSCSOURCE
Get Clock source
__HAL_RCC_SYSCLK_CONFIG
Description:

Macro to configure the system clock source.
Parameters:

__HAL_RCC_GET_SYSCLK_SOU
RCE
__RCC_SYSCLKSOURCE__: specifies the
system clock source. This parameter can be
one of the following values:

RCC_SYSCLKSOURCE_HSI: HSI
oscillator is used as system clock source.

RCC_SYSCLKSOURCE_HSE: HSE
oscillator is used as system clock source.

RCC_SYSCLKSOURCE_PLLCLK: PLL
output is used as system clock source.
Description:

Macro to get the clock source used as system
clock.
Return value:

The: clock source used as system clock. The
returned value can be one of the following:

RCC_SYSCLKSOURCE_STATUS_HSI:
HSI used as system clock.
DOCID028236 Rev 1
437/692
HAL RCC Generic Driver
UM1940


__HAL_RCC_GET_PLL_OSCSOU
RCE
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.
HSE Config
RCC_HSE_OFF
RCC_HSE_ON
RCC_HSE_BYPASS
HSE Configuration
__HAL_RCC_HSE_CONFIG
Description:

Macro to configure the External High Speed oscillator
(HSE).
Parameters:

__STATE__: specifies the new state of the HSE. This
parameter can be one of the following values:

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.
Notes:

438/692
Transition HSE Bypass to HSE On and HSE On to
HSE Bypass are not supported by this macro. User
should request a transition to HSE Off first and then
HSE On or HSE Bypass. After enabling the HSE
(RCC_HSE_ON or RCC_HSE_Bypass), the
application software should wait on HSERDY flag to
be set indicating that HSE clock is stable and can be
used to clock the PLL and/or system clock. HSE state
can not be changed if it is used directly or through the
PLL as system clock. In this case, you have to select
another source of the system clock then change the
HSE state (ex. disable it). The HSE is stopped by
hardware when entering STOP and STANDBY modes.
This function reset the CSSON bit, so if the clock
security system(CSS) was previously enabled you
DOCID028236 Rev 1
UM1940
HAL RCC Generic Driver
have to enable it again after calling this function.
HSI Config
RCC_HSI_OFF
RCC_HSI_ON
HSI Configuration
Notes:
__HAL_RCC_HSI_ENABLE

The HSI is stopped by
hardware when entering STOP
and STANDBY modes. It 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). HSI can not be
stopped if it is used as system
clock source. In this case, you
have to select another source
of the system clock then stop
the HSI. After enabling the HSI,
the application software should
wait on HSIRDY flag to be set
indicating that HSI clock is
stable and can be used as
system clock source. This
parameter can be: ENABLE or
DISABLE. When the HSI is
stopped, HSIRDY flag goes low
after 6 HSI oscillator clock
cycles.
__HAL_RCC_HSI_DISABLE
__HAL_RCC_HSI_CALIBRATIONVALUE_ADJUST
Description:

Macro to adjust the Internal
High Speed oscillator (HSI)
calibration value.
Parameters:

__HSICalibrationValue__:
specifies the calibration
trimming value. This parameter
must be a number between 0
and 0x1F.
Notes:

DOCID028236 Rev 1
The calibration is used to
compensate for the variations in
voltage and temperature that
influence the frequency of the
439/692
HAL RCC Generic Driver
UM1940
internal HSI RC.
I2S Clock Source
RCC_I2SCLKSOURCE_PLLI2S
RCC_I2SCLKSOURCE_EXT
RTC Clock Configuration
__HAL_RCC_RTC_ENABLE
Notes:

These macros must be used only after the
RTC clock source was selected.
__HAL_RCC_RTC_DISABLE
__HAL_RCC_RTC_CLKPRESCALER
Description:

Macros to configure the RTC clock
(RTCCLK).
Parameters:

__RTCCLKSource__: specifies the RTC
clock source. This parameter can be one of
the following values:

RCC_RTCCLKSOURCE_LSE: LSE
selected as RTC clock.

RCC_RTCCLKSOURCE_LSI: LSI
selected as RTC clock.

RCC_RTCCLKSOURCE_HSE_DIVx:
HSE clock divided by x selected as
RTC clock, where x:[2,31]
Notes:


As the RTC clock configuration bits are in
the Backup domain and write access is
denied to this domain after reset, you have
to enable write access using the Power
Backup Access macro before to configure
the RTC clock source (to be done once
after reset). Once the RTC clock is
configured it can't be changed unless the
Backup domain is reset using
__HAL_RCC_BackupReset_RELEASE()
macro, or by a Power On Reset (POR).
If the LSE or LSI is used as RTC clock
source, the RTC continues to work in STOP
and STANDBY modes, and can be used as
wake-up source. However, when the HSE
clock is used as RTC clock source, the
RTC cannot be used in STOP and
STANDBY modes. The maximum input
clock frequency for RTC is 1MHz (when
using HSE as RTC clock source).
__HAL_RCC_RTC_CONFIG
__HAL_RCC_BACKUPRESET_FORC
E
440/692
Notes:

This function resets the RTC peripheral
DOCID028236 Rev 1
UM1940
HAL RCC Generic Driver
(including the backup registers) and the
RTC clock source selection in RCC_CSR
register. The BKPSRAM is not affected by
this reset.
__HAL_RCC_BACKUPRESET_RELEA
SE
Interrupts
RCC_IT_LSIRDY
RCC_IT_LSERDY
RCC_IT_HSIRDY
RCC_IT_HSERDY
RCC_IT_PLLRDY
RCC_IT_PLLI2SRDY
RCC_IT_CSS
RCC Private macros to check input parameters
IS_RCC_OSCILLATORTYPE
IS_RCC_HSE
IS_RCC_LSE
IS_RCC_HSI
IS_RCC_LSI
IS_RCC_PLL
IS_RCC_PLLSOURCE
IS_RCC_SYSCLKSOURCE
IS_RCC_PLLM_VALUE
IS_RCC_PLLN_VALUE
IS_RCC_PLLP_VALUE
IS_RCC_PLLQ_VALUE
IS_RCC_HCLK
IS_RCC_CLOCKTYPE
IS_RCC_PCLK
IS_RCC_MCO
IS_RCC_MCO1SOURCE
IS_RCC_MCO2SOURCE
IS_RCC_MCODIV
IS_RCC_CALIBRATION_VALUE
LSE Config
RCC_LSE_OFF
RCC_LSE_ON
DOCID028236 Rev 1
441/692
HAL RCC Generic Driver
RCC_LSE_BYPASS
UM1940
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
parameter can be one of the following values:

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.
Notes:

Transition LSE Bypass to LSE On and LSE On to LSE
Bypass are not supported by this macro. User should
request a transition to LSE Off first and then LSE On or
LSE Bypass. As the LSE is in the Backup domain and
write access is denied to this domain after reset, you
have to enable write access using
HAL_PWR_EnableBkUpAccess() function before to
configure the LSE (to be done once after reset). After
enabling the LSE (RCC_LSE_ON or
RCC_LSE_BYPASS), the application software should
wait on LSERDY flag to be set indicating that LSE
clock is stable and can be used to clock the RTC.
LSI Config
RCC_LSI_OFF
RCC_LSI_ON
LSI Configuration
__HAL_RCC_LSI_ENABLE
Notes:

After enabling the LSI, the application software should
wait on LSIRDY flag to be set indicating that LSI clock
is stable and can be used to clock the IWDG and/or the
RTC. LSI can not be disabled if the IWDG is running.
When the LSI is stopped, LSIRDY flag goes low after 6
LSI oscillator clock cycles.
__HAL_RCC_LSI_DISABLE
MCO1 Clock Source
RCC_MCO1SOURCE_HSI
RCC_MCO1SOURCE_LSE
RCC_MCO1SOURCE_HSE
RCC_MCO1SOURCE_PLLCLK
MCO2 Clock Source
442/692
DOCID028236 Rev 1
UM1940
HAL RCC Generic Driver
RCC_MCO2SOURCE_SYSCLK
RCC_MCO2SOURCE_PLLI2SCLK
RCC_MCO2SOURCE_HSE
RCC_MCO2SOURCE_PLLCLK
MCOx Clock Prescaler
RCC_MCODIV_1
RCC_MCODIV_2
RCC_MCODIV_3
RCC_MCODIV_4
RCC_MCODIV_5
MCO Index
RCC_MCO1
RCC_MCO2
Oscillator Type
RCC_OSCILLATORTYPE_NONE
RCC_OSCILLATORTYPE_HSE
RCC_OSCILLATORTYPE_HSI
RCC_OSCILLATORTYPE_LSE
RCC_OSCILLATORTYPE_LSI
PLLP Clock Divider
RCC_PLLP_DIV2
RCC_PLLP_DIV4
RCC_PLLP_DIV6
RCC_PLLP_DIV8
PLL Clock Source
RCC_PLLSOURCE_HSI
RCC_PLLSOURCE_HSE
PLL Config
RCC_PLL_NONE
RCC_PLL_OFF
RCC_PLL_ON
PLL Configuration
__HAL_RCC_PLL_ENABLE
Notes:

After enabling the main PLL, the application software
should wait on PLLRDY flag to be set indicating that
PLL clock is stable and can be used as system clock
source. The main PLL can not be disabled if it is used
as system clock source The main PLL is disabled by
DOCID028236 Rev 1
443/692
HAL RCC Generic Driver
UM1940
hardware when entering STOP and STANDBY modes.
__HAL_RCC_PLL_DISABLE
__HAL_RCC_PLL_CONFIG
Description:

Macro to configure the main PLL clock source,
multiplication and division factors.
Parameters:

__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
__PLLM__: specifies the division factor for PLL VCO
input clock This parameter must be a number between
Min_Data = 2 and Max_Data = 63.
__PLLN__: specifies the multiplication factor for PLL
VCO output clock This parameter must be a number
between Min_Data = 192 and Max_Data = 432.
__PLLP__: specifies the division factor for main
system clock (SYSCLK) This parameter must be a
number in the range {2, 4, 6, or 8}.
__PLLQ__: specifies the division factor for OTG FS,
SDIO and RNG clocks This parameter must be a
number between Min_Data = 2 and Max_Data = 15.




Notes:

This function must be used only when the main PLL is
disabled.
This clock source (RCC_PLLSource) is common for
the main PLL and PLLI2S.
You have to set the PLLM parameter correctly to
ensure that the VCO input frequency ranges from 1 to
2 MHz. It is recommended to select a frequency of 2
MHz to limit PLL jitter.
You have to set the PLLN parameter correctly to
ensure that the VCO output frequency is between 192
and 432 MHz.
If the USB OTG FS is used in your application, you
have to set the PLLQ parameter correctly to have 48
MHz clock for the USB. However, the SDIO and RNG
need a frequency lower than or equal to 48 MHz to
work correctly.




PLL I2S Configuration
__HAL_RCC_PLLI2S_ENABLE
Notes:

The PLLI2S is disabled by hardware when entering
STOP and STANDBY modes.
__HAL_RCC_PLLI2S_DISABLE
__HAL_RCC_PLLI2S_CONFIG
444/692
Description:
DOCID028236 Rev 1
UM1940
HAL RCC Generic Driver

Macro to configure the PLLI2S clock multiplication
and division factors .
Parameters:


__PLLI2SN__: specifies the multiplication factor for
PLLI2S VCO output clock This parameter must be
a number between Min_Data = 192 and Max_Data
= 432.
__PLLI2SR__: specifies the division factor for I2S
clock This parameter must be a number between
Min_Data = 2 and Max_Data = 7.
Notes:



This macro must be used only when the PLLI2S is
disabled. PLLI2S clock source is common with the
main PLL (configured in HAL_RCC_ClockConfig()
API).
You have to set the PLLI2SN parameter correctly
to ensure that the VCO output frequency is
between Min_Data = 192 and Max_Data = 432
MHz.
You have to set the PLLI2SR parameter correctly
to not exceed 192 MHz on the I2S clock frequency.
Description:
__HAL_RCC_I2S_CONFIG

Macro to configure the I2S clock source (I2SCLK).
Parameters:

__SOURCE__: specifies the I2S clock source. This
parameter can be one of the following values:

RCC_I2SCLKSOURCE_PLLI2S: PLLI2S
clock used as I2S clock source.

RCC_I2SCLKSOURCE_EXT: External clock
mapped on the I2S_CKIN pin used as I2S
clock source.
Notes:

This function must be called before enabling the
I2S APB clock.
RCC Private Constants
CLOCKSWITCH_TIMEOUT_VALUE
__MCO1_CLK_ENABLE
MCO1_GPIO_PORT
MCO1_PIN
__MCO2_CLK_ENABLE
MCO2_GPIO_PORT
MCO2_PIN
RTC Clock Source
RCC_RTCCLKSOURCE_LSE
DOCID028236 Rev 1
445/692
HAL RCC Generic Driver
RCC_RTCCLKSOURCE_LSI
RCC_RTCCLKSOURCE_HSE_DIV2
RCC_RTCCLKSOURCE_HSE_DIV3
RCC_RTCCLKSOURCE_HSE_DIV4
RCC_RTCCLKSOURCE_HSE_DIV5
RCC_RTCCLKSOURCE_HSE_DIV6
RCC_RTCCLKSOURCE_HSE_DIV7
RCC_RTCCLKSOURCE_HSE_DIV8
RCC_RTCCLKSOURCE_HSE_DIV9
RCC_RTCCLKSOURCE_HSE_DIV10
RCC_RTCCLKSOURCE_HSE_DIV11
RCC_RTCCLKSOURCE_HSE_DIV12
RCC_RTCCLKSOURCE_HSE_DIV13
RCC_RTCCLKSOURCE_HSE_DIV14
RCC_RTCCLKSOURCE_HSE_DIV15
RCC_RTCCLKSOURCE_HSE_DIV16
RCC_RTCCLKSOURCE_HSE_DIV17
RCC_RTCCLKSOURCE_HSE_DIV18
RCC_RTCCLKSOURCE_HSE_DIV19
RCC_RTCCLKSOURCE_HSE_DIV20
RCC_RTCCLKSOURCE_HSE_DIV21
RCC_RTCCLKSOURCE_HSE_DIV22
RCC_RTCCLKSOURCE_HSE_DIV23
RCC_RTCCLKSOURCE_HSE_DIV24
RCC_RTCCLKSOURCE_HSE_DIV25
RCC_RTCCLKSOURCE_HSE_DIV26
RCC_RTCCLKSOURCE_HSE_DIV27
RCC_RTCCLKSOURCE_HSE_DIV28
RCC_RTCCLKSOURCE_HSE_DIV29
RCC_RTCCLKSOURCE_HSE_DIV30
RCC_RTCCLKSOURCE_HSE_DIV31
System Clock Source
RCC_SYSCLKSOURCE_HSI
RCC_SYSCLKSOURCE_HSE
RCC_SYSCLKSOURCE_PLLCLK
System Clock Source Status
446/692
DOCID028236 Rev 1
UM1940
UM1940
RCC_SYSCLKSOURCE_STATUS_HSI
HAL RCC Generic Driver
HSI used as system clock
RCC_SYSCLKSOURCE_STATUS_HSE
HSE used as system clock
RCC_SYSCLKSOURCE_STATUS_PLLCLK
PLL used as system clock
System Clock Type
RCC_CLOCKTYPE_SYSCLK
RCC_CLOCKTYPE_HCLK
RCC_CLOCKTYPE_PCLK1
RCC_CLOCKTYPE_PCLK2
DOCID028236 Rev 1
447/692
HAL RCC Extension Driver
UM1940
34
HAL RCC Extension Driver
34.1
RCCEx Firmware driver registers structures
34.1.1
RCC_PLLI2SInitTypeDef
Data Fields


uint32_t PLLI2SN
uint32_t PLLI2SR
Field Documentation


34.1.2
uint32_t RCC_PLLI2SInitTypeDef::PLLI2SN
Specifies the multiplication factor for PLLI2S VCO output clock. This parameter must
be a number between Min_Data = 192 and Max_Data = 432. This parameter will be
used only when PLLI2S is selected as Clock Source I2S
uint32_t RCC_PLLI2SInitTypeDef::PLLI2SR
Specifies the division factor for I2S clock. This parameter must be a number between
Min_Data = 2 and Max_Data = 7. This parameter will be used only when PLLI2S is
selected as Clock Source I2S
RCC_PeriphCLKInitTypeDef
Data Fields




uint32_t PeriphClockSelection
RCC_PLLI2SInitTypeDef PLLI2S
uint32_t RTCClockSelection
uint8_t TIMPresSelection
Field Documentation




448/692
uint32_t RCC_PeriphCLKInitTypeDef::PeriphClockSelection
The Extended Clock to be configured. This parameter can be a value of
RCCEx_Periph_Clock_Selection
RCC_PLLI2SInitTypeDef RCC_PeriphCLKInitTypeDef::PLLI2S
PLL I2S structure parameters. This parameter will be used only when PLLI2S is
selected as Clock Source I2S
uint32_t RCC_PeriphCLKInitTypeDef::RTCClockSelection
Specifies RTC Clock Prescalers Selection. This parameter can be a value of
RCC_RTC_Clock_Source
uint8_t RCC_PeriphCLKInitTypeDef::TIMPresSelection
Specifies TIM Clock Prescalers Selection. This parameter can be a value of
RCCEx_TIM_PRescaler_Selection
DOCID028236 Rev 1
UM1940
HAL RCC Extension Driver
34.2
RCCEx Firmware driver API description
34.2.1
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.
This section contains the following APIs:


34.2.2
34.2.3
HAL_RCCEx_PeriphCLKConfig()
HAL_RCCEx_GetPeriphCLKConfig()
HAL_RCCEx_PeriphCLKConfig
Function Name
HAL_StatusTypeDef HAL_RCCEx_PeriphCLKConfig
(RCC_PeriphCLKInitTypeDef * PeriphClkInit)
Function Description
Initializes the RCC extended peripherals clocks according to the
specified parameters in the RCC_PeriphCLKInitTypeDef.
Parameters

PeriphClkInit: pointer to an RCC_PeriphCLKInitTypeDef
structure that contains the configuration information for the
Extended Peripherals clocks(I2S and RTC clocks).
Return values

HAL status
Notes

A caution to be taken when HAL_RCCEx_PeriphCLKConfig()
is used to select RTC clock selection, in this case the Reset
of Backup domain will be applied in order to modify the RTC
Clock source as consequence all backup domain (RTC and
RCC_BDCR register expect BKPSRAM) will be reset
HAL_RCCEx_GetPeriphCLKConfig
Function Name
void HAL_RCCEx_GetPeriphCLKConfig
(RCC_PeriphCLKInitTypeDef * PeriphClkInit)
Function Description
Configures the RCC_OscInitStruct according to the internal RCC
configuration registers.
Parameters

PeriphClkInit: pointer to an RCC_PeriphCLKInitTypeDef
structure that will be configured.
Return values

None
34.3
RCCEx Firmware driver defines
34.3.1
RCCEx
AHB2 Force Release Reset
__HAL_RCC_DCMI_FORCE_RESET
DOCID028236 Rev 1
449/692
HAL RCC Extension Driver
__HAL_RCC_DCMI_RELEASE_RESET
UM1940
__HAL_RCC_CRYP_FORCE_RESET
__HAL_RCC_HASH_FORCE_RESET
__HAL_RCC_CRYP_RELEASE_RESET
__HAL_RCC_HASH_RELEASE_RESET
AHB2 Peripheral Low Power Enable Disable
__HAL_RCC_DCMI_CLK_SLEEP_ENABLE
__HAL_RCC_DCMI_CLK_SLEEP_DISABLE
__HAL_RCC_CRYP_CLK_SLEEP_ENABLE
__HAL_RCC_HASH_CLK_SLEEP_ENABLE
__HAL_RCC_CRYP_CLK_SLEEP_DISABLE
__HAL_RCC_HASH_CLK_SLEEP_DISABLE
RCC BitAddress AliasRegion
PLL_TIMEOUT_VALUE
RCCEx Exported Macros
__HAL_RCC_ETHMAC_CLK_ENABLE
__HAL_RCC_ETHMACTX_CLK_ENABLE
__HAL_RCC_ETHMACRX_CLK_ENABLE
__HAL_RCC_ETHMACPTP_CLK_ENABLE
__HAL_RCC_ETHMAC_CLK_DISABLE
__HAL_RCC_ETHMACTX_CLK_DISABLE
__HAL_RCC_ETHMACRX_CLK_DISABLE
__HAL_RCC_ETHMACPTP_CLK_DISABLE
__HAL_RCC_ETH_CLK_ENABLE
__HAL_RCC_ETH_CLK_DISABLE
RCC Private macros to check input parameters
IS_RCC_PERIPHCLOCK
IS_RCC_PLLI2SN_VALUE
IS_RCC_PLLI2SR_VALUE
RCC Extended MCOx Clock Config
__HAL_RCC_MCO1_CONFIG
Description:

Macro to configure the MCO1 clock.
Parameters:

450/692
__MCOCLKSOURCE__: specifies the MCO clock
source. This parameter can be one of the following
values:

RCC_MCO1SOURCE_HSI: HSI clock selected
as MCO1 source
DOCID028236 Rev 1
UM1940
HAL RCC Extension Driver


__HAL_RCC_MCO2_CONFIG
RCC_MCO1SOURCE_LSE: LSE clock selected
as MCO1 source

RCC_MCO1SOURCE_HSE: HSE clock
selected as MCO1 source

RCC_MCO1SOURCE_PLLCLK: main PLL
clock selected as MCO1 source
__MCODIV__: specifies the MCO clock prescaler.
This parameter can be one of the following values:

RCC_MCODIV_1: no division applied to MCOx
clock

RCC_MCODIV_2: division by 2 applied to
MCOx clock

RCC_MCODIV_3: division by 3 applied to
MCOx clock

RCC_MCODIV_4: division by 4 applied to
MCOx clock

RCC_MCODIV_5: division by 5 applied to
MCOx clock
Description:

Macro to configure the MCO2 clock.
Parameters:


__MCOCLKSOURCE__: specifies the MCO clock
source. This parameter can be one of the following
values:

RCC_MCO2SOURCE_SYSCLK: System clock
(SYSCLK) selected as MCO2 source

RCC_MCO2SOURCE_PLLI2SCLK: PLLI2S
clock selected as MCO2 source

RCC_MCO2SOURCE_HSE: HSE clock
selected as MCO2 source

RCC_MCO2SOURCE_PLLCLK: main PLL
clock selected as MCO2 source
__MCODIV__: specifies the MCO clock prescaler.
This parameter can be one of the following values:

RCC_MCODIV_1: no division applied to MCOx
clock

RCC_MCODIV_2: division by 2 applied to
MCOx clock

RCC_MCODIV_3: division by 3 applied to
MCOx clock

RCC_MCODIV_4: division by 4 applied to
MCOx clock

RCC_MCODIV_5: division by 5 applied to
MCOx clock
RCC Periph Clock Selection
RCC_PERIPHCLK_I2S
RCC_PERIPHCLK_TIM
RCC_PERIPHCLK_RTC
RCC_PERIPHCLK_PLLI2S
DOCID028236 Rev 1
451/692
HAL RCC Extension Driver
RCC TIM PRescaler Selection
RCC_TIMPRES_DESACTIVATED
RCC_TIMPRES_ACTIVATED
452/692
DOCID028236 Rev 1
UM1940
UM1940
HAL RNG Generic Driver
35
HAL RNG Generic Driver
35.1
RNG Firmware driver registers structures
35.1.1
RNG_HandleTypeDef
Data Fields




RNG_TypeDef * Instance
HAL_LockTypeDef Lock
__IO HAL_RNG_StateTypeDef State
uint32_t RandomNumber
Field Documentation




RNG_TypeDef* RNG_HandleTypeDef::Instance
Register base address
HAL_LockTypeDef RNG_HandleTypeDef::Lock
RNG locking object
__IO HAL_RNG_StateTypeDef RNG_HandleTypeDef::State
RNG communication state
uint32_t RNG_HandleTypeDef::RandomNumber
Last Generated RNG Data
35.2
RNG Firmware driver API description
35.2.1
How to use this driver
The RNG HAL driver can be used as follows:
1.
2.
3.
4.
35.2.2
Enable the RNG controller clock using __HAL_RCC_RNG_CLK_ENABLE() macro in
HAL_RNG_MspInit().
Activate the RNG peripheral using HAL_RNG_Init() function.
Wait until the 32 bit Random Number Generator contains a valid random data using
(polling/interrupt) mode.
Get the 32 bit random number using HAL_RNG_GenerateRandomNumber() function.
Initialization and de-initialization functions
This section provides functions allowing to:




Initialize the RNG according to the specified parameters in the RNG_InitTypeDef and
create the associated handle
DeInitialize the RNG peripheral
Initialize the RNG MSP
DeInitialize RNG MSP
This section contains the following APIs:


HAL_RNG_Init()
HAL_RNG_DeInit()
DOCID028236 Rev 1
453/692
HAL RNG Generic Driver


35.2.3
UM1940
HAL_RNG_MspInit()
HAL_RNG_MspDeInit()
Peripheral Control functions
This section provides functions allowing to:



Get the 32 bit Random number
Get the 32 bit Random number with interrupt enabled
Handle RNG interrupt request
This section contains the following APIs:








35.2.4
HAL_RNG_GenerateRandomNumber()
HAL_RNG_GenerateRandomNumber_IT()
HAL_RNG_IRQHandler()
HAL_RNG_GetRandomNumber()
HAL_RNG_GetRandomNumber_IT()
HAL_RNG_ReadLastRandomNumber()
HAL_RNG_ReadyDataCallback()
HAL_RNG_ErrorCallback()
Peripheral State functions
This subsection permits to get in run-time the status of the peripheral and the data flow.
This section contains the following APIs:

35.2.5
35.2.6
35.2.7
454/692
HAL_RNG_GetState()
HAL_RNG_Init
Function Name
HAL_StatusTypeDef HAL_RNG_Init (RNG_HandleTypeDef *
hrng)
Function Description
Initializes the RNG peripheral and creates the associated handle.
Parameters

hrng: pointer to a RNG_HandleTypeDef structure that
contains the configuration information for RNG.
Return values

HAL status
HAL_RNG_DeInit
Function Name
HAL_StatusTypeDef HAL_RNG_DeInit (RNG_HandleTypeDef *
hrng)
Function Description
DeInitializes the RNG peripheral.
Parameters

hrng: pointer to a RNG_HandleTypeDef structure that
contains the configuration information for RNG.
Return values

HAL status
HAL_RNG_MspInit
Function Name
void HAL_RNG_MspInit (RNG_HandleTypeDef * hrng)
Function Description
Initializes the RNG MSP.
Parameters

hrng: pointer to a RNG_HandleTypeDef structure that
DOCID028236 Rev 1
UM1940
HAL RNG Generic Driver
contains the configuration information for RNG.
Return values
35.2.8
35.2.9
35.2.10
35.2.11

None
HAL_RNG_MspDeInit
Function Name
void HAL_RNG_MspDeInit (RNG_HandleTypeDef * hrng)
Function Description
DeInitializes the RNG MSP.
Parameters

hrng: pointer to a RNG_HandleTypeDef structure that
contains the configuration information for RNG.
Return values

None
HAL_RNG_GenerateRandomNumber
Function Name
HAL_StatusTypeDef HAL_RNG_GenerateRandomNumber
(RNG_HandleTypeDef * hrng, uint32_t * random32bit)
Function Description
Generates a 32-bit random number.
Parameters


hrng: pointer to a RNG_HandleTypeDef structure that
contains the configuration information for RNG.
random32bit: pointer to generated random number variable
if successful.
Return values

HAL status
Notes

Each time the random number data is read the
RNG_FLAG_DRDY flag is automatically cleared.
HAL_RNG_GenerateRandomNumber_IT
Function Name
HAL_StatusTypeDef HAL_RNG_GenerateRandomNumber_IT
(RNG_HandleTypeDef * hrng)
Function Description
Generates a 32-bit random number in interrupt mode.
Parameters

hrng: pointer to a RNG_HandleTypeDef structure that
contains the configuration information for RNG.
Return values

HAL status
HAL_RNG_IRQHandler
Function Name
void HAL_RNG_IRQHandler (RNG_HandleTypeDef * hrng)
Function Description
Handles RNG interrupt request.
Parameters

hrng: pointer to a RNG_HandleTypeDef structure that
contains the configuration information for RNG.
Return values

None
Notes

In the case of a clock error, the RNG is no more able to
generate random numbers because the PLL48CLK clock is
not correct. User has to check that the clock controller is
correctly configured to provide the RNG clock and clear the
CEIS bit using __HAL_RNG_CLEAR_IT(). The clock error
has no impact on the previously generated random numbers,
and the RNG_DR register contents can be used.
DOCID028236 Rev 1
455/692
HAL RNG Generic Driver
UM1940


35.2.12
35.2.13
35.2.14
35.2.15
HAL_RNG_GetRandomNumber
Function Name
uint32_t HAL_RNG_GetRandomNumber (RNG_HandleTypeDef
* hrng)
Function Description
Returns generated random number in polling mode (Obsolete)
Use HAL_RNG_GenerateRandomNumber() API instead.
Parameters

hrng: pointer to a RNG_HandleTypeDef structure that
contains the configuration information for RNG.
Return values

Random value
HAL_RNG_GetRandomNumber_IT
Function Name
uint32_t HAL_RNG_GetRandomNumber_IT
(RNG_HandleTypeDef * hrng)
Function Description
Returns a 32-bit random number with interrupt enabled (Obsolete),
Use HAL_RNG_GenerateRandomNumber_IT() API instead.
Parameters

hrng: pointer to a RNG_HandleTypeDef structure that
contains the configuration information for RNG.
Return values

32-bit random number
HAL_RNG_ReadLastRandomNumber
Function Name
uint32_t HAL_RNG_ReadLastRandomNumber
(RNG_HandleTypeDef * hrng)
Function Description
Read latest generated random number.
Parameters

hrng: pointer to a RNG_HandleTypeDef structure that
contains the configuration information for RNG.
Return values

random value
HAL_RNG_ReadyDataCallback
Function Name
void HAL_RNG_ReadyDataCallback (RNG_HandleTypeDef *
hrng, uint32_t random32bit)
Function Description
Data Ready callback in non-blocking mode.
Parameters

Return values
456/692
In the case of a seed error, the generation of random
numbers is interrupted as long as the SECS bit is '1'. If a
number is available in the RNG_DR register, it must not be
used because it may not have enough entropy. In this case, it
is recommended to clear the SEIS bit using
__HAL_RNG_CLEAR_IT(), then disable and enable the RNG
peripheral to reinitialize and restart the RNG.
User-written HAL_RNG_ErrorCallback() API is called once
whether SEIS or CEIS are set.

hrng: pointer to a RNG_HandleTypeDef structure that
contains the configuration information for RNG.
random32bit: generated random number.

None
DOCID028236 Rev 1
UM1940
35.2.16
35.2.17
HAL RNG Generic Driver
HAL_RNG_ErrorCallback
Function Name
void HAL_RNG_ErrorCallback (RNG_HandleTypeDef * hrng)
Function Description
RNG error callbacks.
Parameters

hrng: pointer to a RNG_HandleTypeDef structure that
contains the configuration information for RNG.
Return values

None
HAL_RNG_GetState
Function Name
HAL_RNG_StateTypeDef HAL_RNG_GetState
(RNG_HandleTypeDef * hrng)
Function Description
Returns the RNG state.
Parameters

hrng: pointer to a RNG_HandleTypeDef structure that
contains the configuration information for RNG.
Return values

HAL state
35.3
RNG Firmware driver defines
35.3.1
RNG
RNG Interrupt definition
RNG_IT_DRDY
Data Ready interrupt
RNG_IT_CEI
Clock error interrupt
RNG_IT_SEI
Seed error interrupt
RNG Flag definition
RNG_FLAG_DRDY
Data ready
RNG_FLAG_CECS
Clock error current status
RNG_FLAG_SECS
Seed error current status
RNG Exported Macros
__HAL_RNG_RESET_HANDLE_STATE
Description:

Reset RNG handle state.
Parameters:

__HANDLE__: RNG Handle
Return value:

__HAL_RNG_ENABLE
None
Description:

Enables the RNG peripheral.
Parameters:

__HANDLE__: RNG Handle
Return value:
DOCID028236 Rev 1
457/692
HAL RNG Generic Driver
UM1940

None
Description:
__HAL_RNG_DISABLE

Disables the RNG peripheral.
Parameters:

__HANDLE__: RNG Handle
Return value:

None
Description:
__HAL_RNG_GET_FLAG

Check the selected RNG flag status.
Parameters:


__HANDLE__: RNG Handle
__FLAG__: RNG flag This parameter can
be one of the following values:

RNG_FLAG_DRDY: Data ready

RNG_FLAG_CECS: Clock error
current status

RNG_FLAG_SECS: Seed error
current status
Return value:

__HAL_RNG_CLEAR_FLAG
The: new state of __FLAG__ (SET or
RESET).
Description:

Clears the selected RNG flag status.
Parameters:


__HANDLE__: RNG handle
__FLAG__: RNG flag to clear
Return value:

None
Notes:

__HAL_RNG_ENABLE_IT
WARNING: This is a dummy macro for
HAL code alignment, flags
RNG_FLAG_DRDY, RNG_FLAG_CECS
and RNG_FLAG_SECS are read-only.
Description:

Enables the RNG interrupts.
Parameters:

__HANDLE__: RNG Handle
Return value:

__HAL_RNG_DISABLE_IT
458/692
None
Description:
DOCID028236 Rev 1
UM1940
HAL RNG Generic Driver

Disables the RNG interrupts.
Parameters:

__HANDLE__: RNG Handle
Return value:

__HAL_RNG_GET_IT
None
Description:

Checks whether the specified RNG
interrupt has occurred or not.
Parameters:


__HANDLE__: RNG Handle
__INTERRUPT__: specifies the RNG
interrupt status flag to check. This
parameter can be one of the following
values:

RNG_IT_DRDY: Data ready interrupt

RNG_IT_CEI: Clock error interrupt

RNG_IT_SEI: Seed error interrupt
Return value:

__HAL_RNG_CLEAR_IT
The: new state of __INTERRUPT__ (SET
or RESET).
Description:

Clear the RNG interrupt status flags.
Parameters:


__HANDLE__: RNG Handle
__INTERRUPT__: specifies the RNG
interrupt status flag to clear. This
parameter can be one of the following
values:

RNG_IT_CEI: Clock error interrupt

RNG_IT_SEI: Seed error interrupt
Return value:

None
Notes:

RNG_IT_DRDY flag is read-only, reading
RNG_DR register automatically clears
RNG_IT_DRDY.
RNG Private Constants
RNG_TIMEOUT_VALUE
DOCID028236 Rev 1
459/692
HAL RNG Generic Driver
RNG Private Macros
UM1940
IS_RNG_IT
IS_RNG_FLAG
460/692
DOCID028236 Rev 1
UM1940
HAL RTC Generic Driver
36
HAL RTC Generic Driver
36.1
RTC Firmware driver registers structures
36.1.1
RTC_InitTypeDef
Data Fields






uint32_t HourFormat
uint32_t AsynchPrediv
uint32_t SynchPrediv
uint32_t OutPut
uint32_t OutPutPolarity
uint32_t OutPutType
Field Documentation






36.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 = 0x1FFF
uint32_t RTC_InitTypeDef::OutPut
Specifies which signal will be routed to the RTC output. This parameter can be a
value of RTC_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
Data Fields






uint8_t Hours
uint8_t Minutes
uint8_t Seconds
uint8_t TimeFormat
uint32_t DayLightSaving
uint32_t StoreOperation
DOCID028236 Rev 1
461/692
HAL RTC Generic Driver
Field Documentation






36.1.3
UM1940
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
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 DayLight Save Operation. 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
Data Fields




uint8_t WeekDay
uint8_t Month
uint8_t Date
uint8_t Year
Field Documentation




36.1.4
462/692
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
DOCID028236 Rev 1
UM1940
HAL RTC Generic Driver
Data Fields





RTC_TimeTypeDef AlarmTime
uint32_t AlarmMask
uint32_t AlarmDateWeekDaySel
uint8_t AlarmDateWeekDay
uint32_t Alarm
Field Documentation





36.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::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
Data Fields




RTC_TypeDef * Instance
RTC_InitTypeDef Init
HAL_LockTypeDef Lock
__IO HAL_RTCStateTypeDef State
Field Documentation




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
DOCID028236 Rev 1
463/692
HAL RTC Generic Driver
UM1940
36.2
RTC Firmware driver API description
36.2.1
Backup Domain Operating Condition
The real-time clock (RTC), the RTC backup registers, and the backup SRAM (BKP SRAM)
can be powered from the VBAT voltage when the main VDD supply is powered off. To
retain the content of the RTC backup registers, backup SRAM, 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 operating even when the main digital supply (VDD) is turned off, the
VBAT pin powers the following blocks:
1.
2.
3.
4.
The RTC
The LSE oscillator
The backup SRAM when the low power backup regulator is enabled
PC13 to PC15 I/Os, plus PI8 I/O (when available)
When the backup domain is supplied by VDD (analog switch connected to VDD), the
following pins are available:
1.
2.
3.
PC14 and PC15 can be used as either GPIO or LSE pins
PC13 can be used as a GPIO or as the RTC_AF1 pin
PI8 can be used as a GPIO or as the RTC_AF2 pin
When the backup domain is supplied by VBAT (analog switch connected to VBAT
because VDD is not present), the following pins are available:
1.
2.
3.
36.2.2
PC14 and PC15 can be used as LSE pins only
PC13 can be used as the RTC_AF1 pin
PI8 can be used as the RTC_AF2 pin
Backup Domain Reset
The backup domain reset sets all RTC registers and the RCC_BDCR register to their reset
values. The BKPSRAM is not affected by this reset. The only way to reset the BKPSRAM is
through the Flash interface by requesting a protection level change from 1 to 0.
A backup domain reset is generated when one of the following events occurs:
1.
2.
36.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:




36.2.4
How to use this driver

464/692
Enable the Power Controller (PWR) APB1 interface clock using the
__HAL_RCC_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.
Enable the RTC domain access (see description in the section above).
DOCID028236 Rev 1
UM1940
HAL RTC Generic Driver

Configure the RTC Prescaler (Asynchronous and Synchronous) and RTC hour format
using the HAL_RTC_Init() function.
Time and Date configuration


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.
Alarm configuration


36.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 alarms (Alarm A and Alarm B), RTC wake-up,
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-wake-up mode), by using the RTC alarm or the RTC wake-up events.
The RTC provides a programmable time base for waking up from the Stop or Standby
mode at regular intervals. Wake-up from STOP and STANDBY modes is possible only
when the RTC clock source is LSE or LSI.
36.2.6
Initialization and de-initialization functions
This section provides 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.
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 13-bit synchronous prescaler.

When both prescalers are used, it is recommended to configure the
asynchronous prescaler to a high value to minimize power 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 wake-up 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
DOCID028236 Rev 1
465/692
HAL RTC Generic Driver
UM1940
RTC_TR and RTC_DR shadow registers.The HAL_RTC_WaitForSynchro() function
implements the above software sequence (RSF clear and RSF check).
This section contains the following APIs:




36.2.7
HAL_RTC_Init()
HAL_RTC_DeInit()
HAL_RTC_MspInit()
HAL_RTC_MspDeInit()
RTC Time and Date functions
This section provides functions allowing to configure Time and Date features
This section contains the following APIs:




36.2.8
HAL_RTC_SetTime()
HAL_RTC_GetTime()
HAL_RTC_SetDate()
HAL_RTC_GetDate()
RTC Alarm functions
This section provides functions allowing to configure Alarm feature
This section contains the following APIs:







36.2.9
HAL_RTC_SetAlarm()
HAL_RTC_SetAlarm_IT()
HAL_RTC_DeactivateAlarm()
HAL_RTC_GetAlarm()
HAL_RTC_AlarmIRQHandler()
HAL_RTC_AlarmAEventCallback()
HAL_RTC_PollForAlarmAEvent()
Peripheral Control functions
This subsection provides functions allowing to

Wait for RTC Time and Date Synchronization
This section contains the following APIs:

36.2.10
HAL_RTC_WaitForSynchro()
Peripheral State functions
This subsection provides functions allowing to

Get RTC state
This section contains the following APIs:

36.2.11
466/692
HAL_RTC_GetState()
HAL_RTC_Init
Function Name
HAL_StatusTypeDef HAL_RTC_Init (RTC_HandleTypeDef *
hrtc)
Function Description
Initializes the RTC peripheral.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
DOCID028236 Rev 1
UM1940
HAL RTC Generic Driver
contains the configuration information for RTC.
Return values
36.2.12
36.2.13
36.2.14
36.2.15

HAL_RTC_DeInit
Function Name
HAL_StatusTypeDef HAL_RTC_DeInit (RTC_HandleTypeDef *
hrtc)
Function Description
DeInitializes the RTC peripheral.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
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)
Function Description
Initializes the RTC MSP.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Return values

None
HAL_RTC_MspDeInit
Function Name
void HAL_RTC_MspDeInit (RTC_HandleTypeDef * hrtc)
Function Description
DeInitializes the RTC MSP.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Return values

None
HAL_RTC_SetTime
Function Name
HAL_StatusTypeDef HAL_RTC_SetTime (RTC_HandleTypeDef
* hrtc, RTC_TimeTypeDef * sTime, uint32_t Format)
Function Description
Sets RTC current time.
Parameters



Return values
36.2.16
HAL status

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
sTime: Pointer to Time structure
Format: Specifies the format of the entered parameters. This
parameter can be one of the following values:
RTC_FORMAT_BIN: Binary data
formatRTC_FORMAT_BCD: BCD data format
HAL status
HAL_RTC_GetTime
Function Name
HAL_StatusTypeDef HAL_RTC_GetTime (RTC_HandleTypeDef
DOCID028236 Rev 1
467/692
HAL RTC Generic Driver
UM1940
* hrtc, RTC_TimeTypeDef * sTime, uint32_t Format)
Function Description
Gets RTC current time.
Parameters



36.2.17
Return values

HAL status
Notes

You must call HAL_RTC_GetDate() after
HAL_RTC_GetTime() to unlock the values in the higher-order
calendar shadow registers to ensure consistency between the
time and date values. Reading RTC current time locks the
values in calendar shadow registers until Current date is read.
HAL_RTC_SetDate
Function Name
HAL_StatusTypeDef HAL_RTC_SetDate (RTC_HandleTypeDef
* hrtc, RTC_DateTypeDef * sDate, uint32_t Format)
Function Description
Sets RTC current date.
Parameters



Return values
36.2.18

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
sDate: Pointer to date structure
Format: specifies the format of the entered parameters. This
parameter can be one of the following values:
RTC_FORMAT_BIN: Binary data
formatRTC_FORMAT_BCD: BCD data format
HAL status
HAL_RTC_GetDate
Function Name
HAL_StatusTypeDef HAL_RTC_GetDate (RTC_HandleTypeDef
* hrtc, RTC_DateTypeDef * sDate, uint32_t Format)
Function Description
Gets RTC current date.
Parameters



468/692
hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
sTime: Pointer to Time structure
Format: Specifies the format of the entered parameters. This
parameter can be one of the following values:
RTC_FORMAT_BIN: Binary data
formatRTC_FORMAT_BCD: BCD data format
hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
sDate: Pointer to Date structure
Format: Specifies the format of the entered parameters. This
parameter can be one of the following values:
RTC_FORMAT_BIN: Binary data
formatRTC_FORMAT_BCD: BCD data format
Return values

HAL status
Notes

You must call HAL_RTC_GetDate() after
HAL_RTC_GetTime() to unlock the values in the higher-order
calendar shadow registers to ensure consistency between the
time and date values. Reading RTC current time locks the
values in calendar shadow registers until Current date is read.
DOCID028236 Rev 1
UM1940
36.2.19
HAL RTC Generic Driver
HAL_RTC_SetAlarm
Function Name
HAL_StatusTypeDef HAL_RTC_SetAlarm
(RTC_HandleTypeDef * hrtc, RTC_AlarmTypeDef * sAlarm,
uint32_t Format)
Function Description
Sets the specified RTC Alarm.
Parameters



Return values
36.2.20

Function Name
HAL_StatusTypeDef HAL_RTC_SetAlarm_IT
(RTC_HandleTypeDef * hrtc, RTC_AlarmTypeDef * sAlarm,
uint32_t Format)
Function Description
Sets the specified RTC Alarm with Interrupt.
Parameters

Return values

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
sAlarm: Pointer to Alarm structure
Format: Specifies the format of the entered parameters. This
parameter can be one of the following values:
RTC_FORMAT_BIN: Binary data
formatRTC_FORMAT_BCD: BCD data format
HAL status
HAL_RTC_DeactivateAlarm
Function Name
HAL_StatusTypeDef HAL_RTC_DeactivateAlarm
(RTC_HandleTypeDef * hrtc, uint32_t Alarm)
Function Description
Deactivate the specified RTC Alarm.
Parameters

Return values
36.2.22
HAL status
HAL_RTC_SetAlarm_IT


36.2.21
hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
sAlarm: Pointer to Alarm structure
Format: Specifies the format of the entered parameters. This
parameter can be one of the following values:
RTC_FORMAT_BIN: Binary data
formatRTC_FORMAT_BCD: BCD data format

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Alarm: Specifies the Alarm. This parameter can be one of
the following values: RTC_ALARM_A:
AlarmARTC_ALARM_B: AlarmB

HAL status
HAL_RTC_GetAlarm
Function Name
HAL_StatusTypeDef HAL_RTC_GetAlarm
(RTC_HandleTypeDef * hrtc, RTC_AlarmTypeDef * sAlarm,
uint32_t Alarm, uint32_t Format)
Function Description
Gets the RTC Alarm value and masks.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
DOCID028236 Rev 1
469/692
HAL RTC Generic Driver



Return values
36.2.23
36.2.24
36.2.25
470/692
HAL status
HAL_RTC_AlarmIRQHandler
Function Name
void HAL_RTC_AlarmIRQHandler (RTC_HandleTypeDef * hrtc)
Function Description
This function handles Alarm interrupt request.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Return values

None
HAL_RTC_AlarmAEventCallback
Function Name
void HAL_RTC_AlarmAEventCallback (RTC_HandleTypeDef *
hrtc)
Function Description
Alarm A callback.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Return values

None
HAL_RTC_PollForAlarmAEvent
Function Name
HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent
(RTC_HandleTypeDef * hrtc, uint32_t Timeout)
Function Description
This function handles AlarmA Polling request.
Parameters

Return values
36.2.26

UM1940
contains the configuration information for RTC.
sAlarm: Pointer to Date structure
Alarm: Specifies the Alarm. This parameter can be one of
the following values: RTC_ALARM_A:
AlarmARTC_ALARM_B: AlarmB
Format: Specifies the format of the entered parameters. This
parameter can be one of the following values:
RTC_FORMAT_BIN: Binary data
formatRTC_FORMAT_BCD: BCD data format

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Timeout: Timeout duration

HAL status
HAL_RTC_WaitForSynchro
Function Name
HAL_StatusTypeDef HAL_RTC_WaitForSynchro
(RTC_HandleTypeDef * hrtc)
Function Description
Waits until the RTC Time and Date registers (RTC_TR and
RTC_DR) are synchronized with RTC APB clock.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Return values

HAL status
DOCID028236 Rev 1
UM1940
HAL RTC Generic Driver
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
Calendar initialization, calendar update or after wake-up 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.

36.2.27
HAL_RTC_GetState
Function Name
HAL_RTCStateTypeDef HAL_RTC_GetState
(RTC_HandleTypeDef * hrtc)
Function Description
Returns the RTC state.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Return values

HAL state
36.3
RTC Firmware driver defines
36.3.1
RTC
RTC Alarm Date WeekDay Definitions
RTC_ALARMDATEWEEKDAYSEL_DATE
RTC_ALARMDATEWEEKDAYSEL_WEEKDAY
RTC Alarm Mask Definitions
RTC_ALARMMASK_NONE
RTC_ALARMMASK_DATEWEEKDAY
RTC_ALARMMASK_HOURS
RTC_ALARMMASK_MINUTES
RTC_ALARMMASK_SECONDS
RTC_ALARMMASK_ALL
RTC Alarms Definitions
RTC_ALARM_A
RTC_ALARM_B
RTC AM PM Definitions
RTC_HOURFORMAT12_AM
RTC_HOURFORMAT12_PM
RTC DayLight Saving Definitions
RTC_DAYLIGHTSAVING_SUB1H
RTC_DAYLIGHTSAVING_ADD1H
DOCID028236 Rev 1
471/692
HAL RTC Generic Driver
RTC_DAYLIGHTSAVING_NONE
UM1940
RTC Exported Macros
__HAL_RTC_RESET_HANDLE_STATE
Description:

Reset RTC handle state.
Parameters:

__HANDLE__: specifies the 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:

__HANDLE__: specifies the RTC
handle.
Return value:

__HAL_RTC_ALARMA_ENABLE
None
Description:

Enable the RTC ALARMA
peripheral.
Parameters:

__HANDLE__: specifies the RTC
handle.
Return value:

__HAL_RTC_ALARMA_DISABLE
None
Description:

Disable the RTC ALARMA
peripheral.
Parameters:

472/692
DOCID028236 Rev 1
__HANDLE__: specifies the RTC
handle.
UM1940
HAL RTC Generic Driver
Return value:

__HAL_RTC_ALARMB_ENABLE
None
Description:

Enable the RTC ALARMB
peripheral.
Parameters:

__HANDLE__: specifies the RTC
handle.
Return value:

__HAL_RTC_ALARMB_DISABLE
None
Description:

Disable the RTC ALARMB
peripheral.
Parameters:

__HANDLE__: specifies the RTC
handle.
Return value:

__HAL_RTC_ALARM_ENABLE_IT
None
Description:

Enable the RTC Alarm interrupt.
Parameters:


__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the
RTC Alarm interrupt sources to
be enabled or disabled. This
parameter can be any
combination of the following
values:

RTC_IT_ALRA: Alarm A
interrupt

RTC_IT_ALRB: Alarm B
interrupt
Return value:

__HAL_RTC_ALARM_DISABLE_IT
None
Description:

Disable the RTC Alarm interrupt.
Parameters:


DOCID028236 Rev 1
__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the
RTC Alarm interrupt sources to
be enabled or disabled. This
473/692
HAL RTC Generic Driver
UM1940
parameter can be any
combination of the following
values:

RTC_IT_ALRA: Alarm A
interrupt

RTC_IT_ALRB: Alarm B
interrupt
Return value:

__HAL_RTC_ALARM_GET_IT
None
Description:

Check whether the specified RTC
Alarm interrupt has occurred or
not.
Parameters:


__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the
RTC Alarm interrupt to check.
This parameter can be:

RTC_IT_ALRA: Alarm A
interrupt

RTC_IT_ALRB: Alarm B
interrupt
Return value:

__HAL_RTC_ALARM_GET_FLAG
None
Description:

Get the selected RTC Alarm's
flag status.
Parameters:


__HANDLE__: specifies the RTC
handle.
__FLAG__: specifies the RTC
Alarm Flag to check. This
parameter can be:

RTC_FLAG_ALRAF

RTC_FLAG_ALRBF

RTC_FLAG_ALRAWF

RTC_FLAG_ALRBWF
Return value:

__HAL_RTC_ALARM_CLEAR_FLAG
None
Description:

Clear the RTC Alarm's pending
flags.
Parameters:

474/692
DOCID028236 Rev 1
__HANDLE__: specifies the RTC
UM1940

HAL RTC Generic Driver
handle.
__FLAG__: specifies the RTC
Alarm Flag sources to be enabled
or disabled. This parameter can
be:

RTC_FLAG_ALRAF

RTC_FLAG_ALRBF
Return value:

__HAL_RTC_ALARM_GET_IT_SOURCE
None
Description:

Check whether the specified RTC
Alarm interrupt has been enabled
or not.
Parameters:


__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the
RTC Alarm interrupt sources to
check. This parameter can be:

RTC_IT_ALRA: Alarm A
interrupt

RTC_IT_ALRB: Alarm B
interrupt
Return value:

__HAL_RTC_ALARM_EXTI_ENABLE_IT
None
Description:

Enable interrupt on the RTC
Alarm associated Exti line.
Return value:

__HAL_RTC_ALARM_EXTI_DISABLE_IT
None
Description:

Disable interrupt on the RTC
Alarm associated Exti line.
Return value:

__HAL_RTC_ALARM_EXTI_ENABLE_EVENT
None
Description:

Enable event on the RTC Alarm
associated Exti line.
Return value:

__HAL_RTC_ALARM_EXTI_DISABLE_EVENT
Description:

DOCID028236 Rev 1
None.
Disable event on the RTC Alarm
associated Exti line.
475/692
HAL RTC Generic Driver
UM1940
Return value:

__HAL_RTC_ALARM_EXTI_ENABLE_FALLING
_EDGE
None.
Description:

Enable falling edge trigger on the
RTC Alarm associated Exti line.
Return value:

__HAL_RTC_ALARM_EXTI_DISABLE_FALLING
_EDGE
None.
Description:

Disable falling edge trigger on the
RTC Alarm associated Exti line.
Return value:

__HAL_RTC_ALARM_EXTI_ENABLE_RISING_
EDGE
None.
Description:

Enable rising edge trigger on the
RTC Alarm associated Exti line.
Return value:

__HAL_RTC_ALARM_EXTI_DISABLE_RISING_
EDGE
None.
Description:

Disable rising edge trigger on the
RTC Alarm associated Exti line.
Return value:

__HAL_RTC_ALARM_EXTI_ENABLE_RISING_F
ALLING_EDGE
None.
Description:

Enable rising & falling edge
trigger on the RTC Alarm
associated Exti line.
Return value:

__HAL_RTC_ALARM_EXTI_DISABLE_RISING_
FALLING_EDGE
None.
Description:

Disable rising & falling edge
trigger on the RTC Alarm
associated Exti line.
Return value:

__HAL_RTC_ALARM_EXTI_GET_FLAG
None.
Description:

Check whether the RTC Alarm
associated Exti line interrupt flag
is set or not.
Return value:
476/692
DOCID028236 Rev 1
UM1940
HAL RTC Generic Driver

__HAL_RTC_ALARM_EXTI_CLEAR_FLAG
Line: Status.
Description:

Clear the RTC Alarm associated
Exti line flag.
Return value:

__HAL_RTC_ALARM_EXTI_GENERATE_SWIT
None.
Description:

Generate a Software interrupt on
RTC Alarm associated Exti line.
Return value:

None.
RTC Flags Definitions
RTC_FLAG_TAMP1F
RTC_FLAG_TSOVF
RTC_FLAG_TSF
RTC_FLAG_WUTF
RTC_FLAG_ALRBF
RTC_FLAG_ALRAF
RTC_FLAG_INITF
RTC_FLAG_RSF
RTC_FLAG_INITS
RTC_FLAG_WUTWF
RTC_FLAG_ALRBWF
RTC_FLAG_ALRAWF
RTC Hour Formats
RTC_HOURFORMAT_24
RTC_HOURFORMAT_12
RTC Input Parameter Format Definitions
RTC_FORMAT_BIN
RTC_FORMAT_BCD
RTC Interrupts Definitions
RTC_IT_TS
RTC_IT_WUT
RTC_IT_ALRB
RTC_IT_ALRA
RTC_IT_TAMP
RTC_IT_TAMP1
DOCID028236 Rev 1
477/692
HAL RTC Generic Driver
RTC Private macros to check input parameters
IS_RTC_HOUR_FORMAT
IS_RTC_OUTPUT
IS_RTC_OUTPUT_POL
IS_RTC_OUTPUT_TYPE
IS_RTC_HOUR12
IS_RTC_HOUR24
IS_RTC_ASYNCH_PREDIV
IS_RTC_SYNCH_PREDIV
IS_RTC_MINUTES
IS_RTC_SECONDS
IS_RTC_HOURFORMAT12
IS_RTC_DAYLIGHT_SAVING
IS_RTC_STORE_OPERATION
IS_RTC_FORMAT
IS_RTC_YEAR
IS_RTC_MONTH
IS_RTC_DATE
IS_RTC_WEEKDAY
IS_RTC_ALARM_DATE_WEEKDAY_DATE
IS_RTC_ALARM_DATE_WEEKDAY_WEEKDAY
IS_RTC_ALARM_DATE_WEEKDAY_SEL
IS_RTC_ALARM_MASK
IS_RTC_ALARM
RTC Month Date Definitions
RTC_MONTH_JANUARY
RTC_MONTH_FEBRUARY
RTC_MONTH_MARCH
RTC_MONTH_APRIL
RTC_MONTH_MAY
RTC_MONTH_JUNE
RTC_MONTH_JULY
RTC_MONTH_AUGUST
RTC_MONTH_SEPTEMBER
RTC_MONTH_OCTOBER
RTC_MONTH_NOVEMBER
478/692
DOCID028236 Rev 1
UM1940
UM1940
HAL RTC Generic Driver
RTC_MONTH_DECEMBER
RTC Output Polarity Definitions
RTC_OUTPUT_POLARITY_HIGH
RTC_OUTPUT_POLARITY_LOW
RTC Output Selection Definitions
RTC_OUTPUT_DISABLE
RTC_OUTPUT_ALARMA
RTC_OUTPUT_ALARMB
RTC_OUTPUT_WAKEUP
RTC Output Type ALARM OUT
RTC_OUTPUT_TYPE_OPENDRAIN
RTC_OUTPUT_TYPE_PUSHPULL
RTC Private Constants
RTC_TR_RESERVED_MASK
RTC_DR_RESERVED_MASK
RTC_INIT_MASK
RTC_RSF_MASK
RTC_FLAGS_MASK
RTC_TIMEOUT_VALUE
RTC_EXTI_LINE_ALARM_EVENT
External interrupt line 17 Connected to the RTC
Alarm event
RTC Store Operation Definitions
RTC_STOREOPERATION_RESET
RTC_STOREOPERATION_SET
RTC WeekDay Definitions
RTC_WEEKDAY_MONDAY
RTC_WEEKDAY_TUESDAY
RTC_WEEKDAY_WEDNESDAY
RTC_WEEKDAY_THURSDAY
RTC_WEEKDAY_FRIDAY
RTC_WEEKDAY_SATURDAY
RTC_WEEKDAY_SUNDAY
DOCID028236 Rev 1
479/692
HAL RTC Extension Driver
UM1940
37
HAL RTC Extension Driver
37.1
RTCEx Firmware driver registers structures
37.1.1
RTC_TamperTypeDef
Data Fields



uint32_t Tamper
uint32_t PinSelection
uint32_t Trigger
Field Documentation



uint32_t RTC_TamperTypeDef::Tamper
Specifies the Tamper Pin. This parameter can be a value of
RTCEx_Tamper_Pins_Definitions
uint32_t RTC_TamperTypeDef::PinSelection
Specifies the Tamper Pin. This parameter can be a value of
RTCEx_Tamper_Pins_Selection
uint32_t RTC_TamperTypeDef::Trigger
Specifies the Tamper Trigger. This parameter can be a value of
RTCEx_Tamper_Trigger_Definitions
37.2
RTCEx Firmware driver API description
37.2.1
How to use this driver


Enable the RTC domain access.
Configure the RTC Prescaler (Asynchronous and Synchronous) and RTC hour format
using the HAL_RTC_Init() function.
RTC Wake-up configuration


To configure the RTC Wake-up Clock source and Counter use the
HAL_RTCEx_SetWakeUpTimer() function. You can also configure the RTC Wake-up
timer in interrupt mode using the HAL_RTCEx_SetWakeUpTimer_IT() function.
To read the RTC Wake-up Counter register, use the
HAL_RTCEx_GetWakeUpTimer() function.
TimeStamp configuration

480/692
Configure the RTC_AFx trigger and enable 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.
DOCID028236 Rev 1
UM1940
HAL RTC Extension Driver


To read the RTC TimeStamp Time and Date register, use the
HAL_RTCEx_GetTimeStamp() function.
The TIMESTAMP alternate function can be mapped either to RTC_AF1 (PC13) or
RTC_AF2 (PI8) depending on the value of TSINSEL bit in RTC_TAFCR register. The
corresponding pin is also selected by HAL_RTCEx_SetTimeStamp() or
HAL_RTCEx_SetTimeStamp_IT() function.
Tamper configuration


Enable the RTC Tamper and configure the trigger using the
HAL_RTCEx_SetTamper() function. You can configure RTC Tamper in interrupt mode
using HAL_RTCEx_SetTamper_IT() function.
The TAMPER1 alternate function can be mapped either to RTC_AF1 (PC13) or
RTC_AF2 (PI8) depending on the value of TAMP1INSEL bit in RTC_TAFCR register.
The corresponding pin is also selected by HAL_RTCEx_SetTamper() or
HAL_RTCEx_SetTamper_IT() function.
Backup Data Registers configuration


37.2.2
To write to the RTC Backup Data registers, use the HAL_RTCEx_BKUPWrite()
function.
To read the RTC Backup Data registers, use the HAL_RTCEx_BKUPRead() function.
RTC TimeStamp and Tamper functions
This section provides functions allowing to configure TimeStamp feature
This section contains the following APIs:












37.2.3
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()
RTC Wake-up functions
This section provides functions allowing to configure Wake-up feature
This section contains the following APIs:






HAL_RTCEx_SetWakeUpTimer()
HAL_RTCEx_SetWakeUpTimer_IT()
HAL_RTCEx_DeactivateWakeUpTimer()
HAL_RTCEx_GetWakeUpTimer()
HAL_RTCEx_WakeUpTimerIRQHandler()
HAL_RTCEx_WakeUpTimerEventCallback()
DOCID028236 Rev 1
481/692
HAL RTC Extension Driver

37.2.4
UM1940
HAL_RTCEx_PollForWakeUpTimerEvent()
Extension Peripheral Control functions
This subsection provides functions allowing to









Write a data in a specified RTC Backup data register
Read a data in a specified RTC Backup data register
Set the Coarse calibration parameters.
Deactivate the Coarse calibration parameters
Configure the Synchronization Shift Control Settings.
Configure the Calibration Pinout (RTC_CALIB).
Deactivate the Calibration Pinout (RTC_CALIB).
Enable the RTC reference clock detection.
Disable the RTC reference clock detection.
This section contains the following APIs:








37.2.5
HAL_RTCEx_BKUPWrite()
HAL_RTCEx_BKUPRead()
HAL_RTCEx_SetCoarseCalib()
HAL_RTCEx_DeactivateCoarseCalib()
HAL_RTCEx_SetCalibrationOutPut()
HAL_RTCEx_DeactivateCalibrationOutPut()
HAL_RTCEx_SetRefClock()
HAL_RTCEx_DeactivateRefClock()
Extended features functions
This section provides functions allowing to:


RTC Alarm B callback
RTC Poll for Alarm B request
This section contains the following APIs:


37.2.6
HAL_RTCEx_AlarmBEventCallback()
HAL_RTCEx_PollForAlarmBEvent()
HAL_RTCEx_SetTimeStamp
Function Name
HAL_StatusTypeDef HAL_RTCEx_SetTimeStamp
(RTC_HandleTypeDef * hrtc, uint32_t TimeStampEdge,
uint32_t RTC_TimeStampPin)
Function Description
Sets TimeStamp.
Parameters



482/692
hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
TimeStampEdge: Specifies the pin edge on which the
TimeStamp is activated. This parameter can be one of the
following values: RTC_TIMESTAMPEDGE_RISING: the Time
stamp event occurs on the rising edge of the related
pin.RTC_TIMESTAMPEDGE_FALLING: the Time stamp
event occurs on the falling edge of the related pin.
RTC_TimeStampPin: specifies the RTC TimeStamp Pin.
This parameter can be one of the following values:
RTC_TIMESTAMPPIN_DEFAULT: PC13 is selected as RTC
TimeStamp Pin.RTC_TIMESTAMPPIN_POS1: PI8 is
DOCID028236 Rev 1
UM1940
HAL RTC Extension Driver
selected as RTC TimeStamp Pin.
37.2.7
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)
Function Description
Sets TimeStamp with Interrupt.
Parameters



37.2.8
37.2.9
hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
TimeStampEdge: Specifies the pin edge on which the
TimeStamp is activated. This parameter can be one of the
following values: RTC_TIMESTAMPEDGE_RISING: the Time
stamp event occurs on the rising edge of the related
pin.RTC_TIMESTAMPEDGE_FALLING: the Time stamp
event occurs on the falling edge of the related pin.
RTC_TimeStampPin: Specifies the RTC TimeStamp Pin.
This parameter can be one of the following values:
RTC_TIMESTAMPPIN_DEFAULT: PC13 is selected as RTC
TimeStamp Pin.RTC_TIMESTAMPPIN_POS1: PI8 is
selected as RTC TimeStamp Pin.
Return values

HAL status
Notes

This API must be called before enabling the TimeStamp
feature.
HAL_RTCEx_DeactivateTimeStamp
Function Name
HAL_StatusTypeDef HAL_RTCEx_DeactivateTimeStamp
(RTC_HandleTypeDef * hrtc)
Function Description
Deactivates TimeStamp.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Return values

HAL status
HAL_RTCEx_GetTimeStamp
Function Name
HAL_StatusTypeDef HAL_RTCEx_GetTimeStamp
(RTC_HandleTypeDef * hrtc, RTC_TimeTypeDef *
sTimeStamp, RTC_DateTypeDef * sTimeStampDate, uint32_t
Format)
Function Description
Gets the RTC TimeStamp value.
Parameters




hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
sTimeStamp: Pointer to Time structure
sTimeStampDate: Pointer to Date structure
Format: specifies the format of the entered parameters. This
DOCID028236 Rev 1
483/692
HAL RTC Extension Driver
UM1940
parameter can be one of the following values:
RTC_FORMAT_BIN: Binary data format
RTC_FORMAT_BCD: BCD data format
Return values
37.2.10
37.2.11
37.2.12
484/692
HAL status
HAL_RTCEx_SetTamper
Function Name
HAL_StatusTypeDef HAL_RTCEx_SetTamper
(RTC_HandleTypeDef * hrtc, RTC_TamperTypeDef * sTamper)
Function Description
Sets Tamper.
Parameters


hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
sTamper: Pointer to Tamper Structure.
Return values

HAL status
Notes

By calling this API we disable the tamper interrupt for all
tampers.
HAL_RTCEx_SetTamper_IT
Function Name
HAL_StatusTypeDef HAL_RTCEx_SetTamper_IT
(RTC_HandleTypeDef * hrtc, RTC_TamperTypeDef * sTamper)
Function Description
Sets Tamper with interrupt.
Parameters


hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
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)
Function Description
Deactivates Tamper.
Parameters

Return values
37.2.13


hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Tamper: Selected tamper pin. This parameter can be
RTC_Tamper_1.

HAL status
HAL_RTCEx_TamperTimeStampIRQHandler
Function Name
void HAL_RTCEx_TamperTimeStampIRQHandler
(RTC_HandleTypeDef * hrtc)
Function Description
This function handles TimeStamp interrupt request.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
DOCID028236 Rev 1
UM1940
HAL RTC Extension Driver
Return values
37.2.14
37.2.15
37.2.16
Function Name
void HAL_RTCEx_TimeStampEventCallback
(RTC_HandleTypeDef * hrtc)
Function Description
TimeStamp callback.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Return values

None
HAL_RTCEx_Tamper1EventCallback
Function Name
void HAL_RTCEx_Tamper1EventCallback
(RTC_HandleTypeDef * hrtc)
Function Description
Tamper 1 callback.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Return values

None
HAL_RTCEx_PollForTimeStampEvent
Function Name
HAL_StatusTypeDef HAL_RTCEx_PollForTimeStampEvent
(RTC_HandleTypeDef * hrtc, uint32_t Timeout)
Function Description
This function handles TimeStamp polling request.
Parameters


hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Timeout: Timeout duration

HAL status
HAL_RTCEx_PollForTamper1Event
Function Name
HAL_StatusTypeDef HAL_RTCEx_PollForTamper1Event
(RTC_HandleTypeDef * hrtc, uint32_t Timeout)
Function Description
This function handles Tamper1 Polling.
Parameters

Return values
37.2.18
None
HAL_RTCEx_TimeStampEventCallback
Return values
37.2.17


hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Timeout: Timeout duration

HAL status
HAL_RTCEx_SetWakeUpTimer
Function Name
HAL_StatusTypeDef HAL_RTCEx_SetWakeUpTimer
(RTC_HandleTypeDef * hrtc, uint32_t WakeUpCounter,
uint32_t WakeUpClock)
Function Description
Sets wake up timer.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
DOCID028236 Rev 1
485/692
HAL RTC Extension Driver
Return values
37.2.19
37.2.21
37.2.22
37.2.23

HAL status
Function Name
HAL_StatusTypeDef HAL_RTCEx_SetWakeUpTimer_IT
(RTC_HandleTypeDef * hrtc, uint32_t WakeUpCounter,
uint32_t WakeUpClock)
Function Description
Sets wake up timer with interrupt.
Parameters



hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
WakeUpCounter: Wake up counter
WakeUpClock: Wake up clock

HAL status
HAL_RTCEx_DeactivateWakeUpTimer
Function Name
uint32_t HAL_RTCEx_DeactivateWakeUpTimer
(RTC_HandleTypeDef * hrtc)
Function Description
Deactivates wake up timer counter.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Return values

HAL status
HAL_RTCEx_GetWakeUpTimer
Function Name
uint32_t HAL_RTCEx_GetWakeUpTimer (RTC_HandleTypeDef
* hrtc)
Function Description
Gets wake up timer counter.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Return values

Counter value
HAL_RTCEx_WakeUpTimerIRQHandler
Function Name
void HAL_RTCEx_WakeUpTimerIRQHandler
(RTC_HandleTypeDef * hrtc)
Function Description
This function handles Wake Up Timer interrupt request.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Return values

None
HAL_RTCEx_WakeUpTimerEventCallback
Function Name
486/692


HAL_RTCEx_SetWakeUpTimer_IT
Return values
37.2.20
UM1940
contains the configuration information for RTC.
WakeUpCounter: Wake up counter
WakeUpClock: Wake up clock
void HAL_RTCEx_WakeUpTimerEventCallback
DOCID028236 Rev 1
UM1940
HAL RTC Extension Driver
(RTC_HandleTypeDef * hrtc)
37.2.24
Function Description
Wake Up Timer callback.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Return values

None
HAL_RTCEx_PollForWakeUpTimerEvent
Function Name
HAL_StatusTypeDef HAL_RTCEx_PollForWakeUpTimerEvent
(RTC_HandleTypeDef * hrtc, uint32_t Timeout)
Function Description
This function handles Wake Up Timer Polling.
Parameters

Return values
37.2.25

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Timeout: Timeout duration

HAL status
HAL_RTCEx_BKUPWrite
Function Name
void HAL_RTCEx_BKUPWrite (RTC_HandleTypeDef * hrtc,
uint32_t BackupRegister, uint32_t Data)
Function Description
Writes a data in a specified RTC Backup data register.
Parameters



Return values
37.2.26
None
HAL_RTCEx_BKUPRead
Function Name
uint32_t HAL_RTCEx_BKUPRead (RTC_HandleTypeDef * hrtc,
uint32_t BackupRegister)
Function Description
Reads data from the specified RTC Backup data Register.
Parameters

Return values
37.2.27

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
BackupRegister: RTC Backup data Register number. This
parameter can be: RTC_BKP_DRx where x can be from 0 to
19 to specify the register.
Data: Data to be written in the specified RTC Backup data
register.

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
BackupRegister: RTC Backup data Register number. This
parameter can be: RTC_BKP_DRx where x can be from 0 to
19 to specify the register.

Read value
HAL_RTCEx_SetCoarseCalib
Function Name
HAL_StatusTypeDef HAL_RTCEx_SetCoarseCalib
(RTC_HandleTypeDef * hrtc, uint32_t CalibSign, uint32_t
Value)
DOCID028236 Rev 1
487/692
HAL RTC Extension Driver
Function Description
Parameters
UM1940
Sets the Coarse calibration parameters.



Return values

HAL status
Notes

This Calibration value should be between 0 and 63 when
using negative sign with a 2-ppm step.
This Calibration value should be between 0 and 126 when
using positive sign with a 4-ppm step.

37.2.28
37.2.29
37.2.30
37.2.31
HAL_RTCEx_DeactivateCoarseCalib
Function Name
HAL_StatusTypeDef HAL_RTCEx_DeactivateCoarseCalib
(RTC_HandleTypeDef * hrtc)
Function Description
Deactivates the Coarse calibration parameters.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Return values

HAL status
HAL_RTCEx_SetCalibrationOutPut
Function Name
HAL_StatusTypeDef HAL_RTCEx_SetCalibrationOutPut
(RTC_HandleTypeDef * hrtc)
Function Description
Configure the Calibration Pinout (RTC_CALIB).
Parameters

hrtc: : RTC handle
Return values

HAL status
HAL_RTCEx_DeactivateCalibrationOutPut
Function Name
HAL_StatusTypeDef
HAL_RTCEx_DeactivateCalibrationOutPut
(RTC_HandleTypeDef * hrtc)
Function Description
Deactivates the Calibration Pinout (RTC_CALIB).
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Return values

HAL status
HAL_RTCEx_SetRefClock
Function Name
488/692
hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
CalibSign: Specifies the sign of the coarse calibration value.
This parameter can be one of the following values :
RTC_CALIBSIGN_POSITIVE: The value sign is
positiveRTC_CALIBSIGN_NEGATIVE: The value sign is
negative
Value: value of coarse calibration expressed in ppm (coded
on 5 bits).
HAL_StatusTypeDef HAL_RTCEx_SetRefClock
(RTC_HandleTypeDef * hrtc)
DOCID028236 Rev 1
UM1940
37.2.32
37.2.33
37.2.34
Function Description
HAL RTC Extension Driver
Enables the RTC reference clock detection.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Return values

HAL status
HAL_RTCEx_DeactivateRefClock
Function Name
HAL_StatusTypeDef HAL_RTCEx_DeactivateRefClock
(RTC_HandleTypeDef * hrtc)
Function Description
Disable the RTC reference clock detection.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Return values

HAL status
HAL_RTCEx_AlarmBEventCallback
Function Name
void HAL_RTCEx_AlarmBEventCallback
(RTC_HandleTypeDef * hrtc)
Function Description
Alarm B callback.
Parameters

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Return values

None
HAL_RTCEx_PollForAlarmBEvent
Function Name
HAL_StatusTypeDef HAL_RTCEx_PollForAlarmBEvent
(RTC_HandleTypeDef * hrtc, uint32_t Timeout)
Function Description
This function handles AlarmB Polling request.
Parameters

Return values

hrtc: pointer to a RTC_HandleTypeDef structure that
contains the configuration information for RTC.
Timeout: Timeout duration

HAL status
37.3
RTCEx Firmware driver defines
37.3.1
RTCEx
RTC Backup Registers Definitions
RTC_BKP_DR0
RTC_BKP_DR1
RTC_BKP_DR2
RTC_BKP_DR3
RTC_BKP_DR4
RTC_BKP_DR5
DOCID028236 Rev 1
489/692
HAL RTC Extension Driver
RTC_BKP_DR6
UM1940
RTC_BKP_DR7
RTC_BKP_DR8
RTC_BKP_DR9
RTC_BKP_DR10
RTC_BKP_DR11
RTC_BKP_DR12
RTC_BKP_DR13
RTC_BKP_DR14
RTC_BKP_DR15
RTC_BKP_DR16
RTC_BKP_DR17
RTC_BKP_DR18
RTC_BKP_DR19
RTC Calibration
__HAL_RTC_COARSE_CALIB_ENABLE
Description:

Enable the Coarse calibration
process.
Parameters:

__HANDLE__: specifies the
RTC handle.
Return value:

__HAL_RTC_COARSE_CALIB_DISABLE
None
Description:

Disable the Coarse calibration
process.
Parameters:

__HANDLE__: specifies the
RTC handle.
Return value:

__HAL_RTC_CALIBRATION_OUTPUT_ENABLE
None
Description:

Enable the RTC calibration
output.
Parameters:

__HANDLE__: specifies the
RTC handle.
Return value:
490/692
DOCID028236 Rev 1
UM1940
HAL RTC Extension Driver

__HAL_RTC_CALIBRATION_OUTPUT_DISABLE
None
Description:

Disable the calibration output.
Parameters:

__HANDLE__: specifies the
RTC handle.
Return value:

__HAL_RTC_CLOCKREF_DETECTION_ENABLE
None
Description:

Enable the clock reference
detection.
Parameters:

__HANDLE__: specifies the
RTC handle.
Return value:

__HAL_RTC_CLOCKREF_DETECTION_DISABLE
None
Description:

Disable the clock reference
detection.
Parameters:

__HANDLE__: specifies the
RTC handle.
Return value:

None
RTC Digital Calib Definitions
RTC_CALIBSIGN_POSITIVE
RTC_CALIBSIGN_NEGATIVE
Private macros to check input parameters
IS_RTC_BKP
IS_TIMESTAMP_EDGE
IS_RTC_TAMPER_PIN
IS_RTC_TIMESTAMP_PIN
IS_RTC_TAMPER_TRIGGER
IS_RTC_WAKEUP_CLOCK
IS_RTC_WAKEUP_COUNTER
IS_RTC_CALIB_SIGN
IS_RTC_CALIB_VALUE
IS_RTC_TAMPER
DOCID028236 Rev 1
491/692
HAL RTC Extension Driver
RTCEx Private Constants
UM1940
RTC_EXTI_LINE_TAMPER_TIMESTAMP_EVENT
External interrupt line 21 Connected
to the RTC Tamper and Time Stamp
events
RTC_EXTI_LINE_WAKEUPTIMER_EVENT
External interrupt line 22 Connected
to the RTC Wake-up event
RTC Tamper
__HAL_RTC_TAMPER1_ENABLE
Description:

Enable the RTC Tamper1 input
detection.
Parameters:

__HANDLE__: specifies the RTC
handle.
Return value:

__HAL_RTC_TAMPER1_DISABLE
None
Description:

Disable the RTC Tamper1 input
detection.
Parameters:

__HANDLE__: specifies the RTC
handle.
Return value:

__HAL_RTC_TAMPER_GET_IT
None
Description:

Check whether the specified RTC
Tamper interrupt has occurred or not.
Parameters:


__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the RTC
Tamper interrupt to check. This
parameter can be:

RTC_IT_TAMP1
Return value:

__HAL_RTC_TAMPER_GET_IT_SOURCE
None
Description:

Check whether the specified RTC
Tamper interrupt has been enabled or
not.
Parameters:

492/692
DOCID028236 Rev 1
__HANDLE__: specifies the RTC
handle.
UM1940
HAL RTC Extension Driver

__INTERRUPT__: specifies the RTC
Tamper interrupt source to check. This
parameter can be:

RTC_IT_TAMP: Tamper interrupt
Return value:

__HAL_RTC_TAMPER_GET_FLAG
None
Description:

Get the selected RTC Tamper's flag
status.
Parameters:

__HANDLE__: specifies the RTC
handle.
__FLAG__: specifies the RTC Tamper
Flag sources to be enabled or disabled.
This parameter can be:

RTC_FLAG_TAMP1F

Return value:

__HAL_RTC_TAMPER_CLEAR_FLAG
None
Description:

Clear the RTC Tamper's pending flags.
Parameters:

__HANDLE__: specifies the RTC
handle.
__FLAG__: specifies the RTC Tamper
Flag to clear. This parameter can be:

RTC_FLAG_TAMP1F

Return value:

None
RTC Tamper Pins Definitions
RTC_TAMPER_1
RTC tamper Pins Selection
RTC_TAMPERPIN_DEFAULT
RTC_TAMPERPIN_POS1
EXTI RTC Tamper Timestamp EXTI
__HAL_RTC_TAMPER_TIMESTAMP_EXTI
_ENABLE_IT
Description:

Enable interrupt on the RTC Tamper
and Timestamp associated Exti line.
Return value:

__HAL_RTC_TAMPER_TIMESTAMP_EXTI
_DISABLE_IT
None
Description:

DOCID028236 Rev 1
Disable interrupt on the RTC Tamper
493/692
HAL RTC Extension Driver
UM1940
and Timestamp associated Exti line.
Return value:

__HAL_RTC_TAMPER_TIMESTAMP_EXTI
_ENABLE_EVENT
None
Description:

Enable event on the RTC Tamper and
Timestamp associated Exti line.
Return value:

__HAL_RTC_TAMPER_TIMESTAMP_EXTI
_DISABLE_EVENT
None.
Description:

Disable event on the RTC Tamper and
Timestamp associated Exti line.
Return value:

__HAL_RTC_TAMPER_TIMESTAMP_EXTI
_ENABLE_FALLING_EDGE
None.
Description:

Enable falling edge trigger on the RTC
Tamper and Timestamp associated
Exti line.
Return value:

__HAL_RTC_TAMPER_TIMESTAMP_EXTI
_DISABLE_FALLING_EDGE
None.
Description:

Disable falling edge trigger on the
RTC Tamper and Timestamp
associated Exti line.
Return value:

__HAL_RTC_TAMPER_TIMESTAMP_EXTI
_ENABLE_RISING_EDGE
None.
Description:

Enable rising edge trigger on the RTC
Tamper and Timestamp associated
Exti line.
Return value:

__HAL_RTC_TAMPER_TIMESTAMP_EXTI
_DISABLE_RISING_EDGE
None.
Description:

Disable rising edge trigger on the RTC
Tamper and Timestamp associated
Exti line.
Return value:

__HAL_RTC_TAMPER_TIMESTAMP_EXTI
_ENABLE_RISING_FALLING_EDGE
494/692
None.
Description:

DOCID028236 Rev 1
Enable rising & falling edge trigger on
the RTC Tamper and Timestamp
UM1940
HAL RTC Extension Driver
associated Exti line.
Return value:

__HAL_RTC_TAMPER_TIMESTAMP_EXTI
_DISABLE_RISING_FALLING_EDGE
None.
Description:

Disable rising & falling edge trigger on
the RTC Tamper and Timestamp
associated Exti line.
Return value:

__HAL_RTC_TAMPER_TIMESTAMP_EXTI
_GET_FLAG
None.
Description:

Check whether the RTC Tamper and
Timestamp associated Exti line
interrupt flag is set or not.
Return value:

__HAL_RTC_TAMPER_TIMESTAMP_EXTI
_CLEAR_FLAG
Line: Status.
Description:

Clear the RTC Tamper and
Timestamp associated Exti line flag.
Return value:

__HAL_RTC_TAMPER_TIMESTAMP_EXTI
_GENERATE_SWIT
None.
Description:

Generate a Software interrupt on the
RTC Tamper and Timestamp
associated Exti line.
Return value:

None.
RTC Tamper Triggers Definitions
RTC_TAMPERTRIGGER_RISINGEDGE
RTC_TAMPERTRIGGER_FALLINGEDGE
RTC Timestamp
__HAL_RTC_TIMESTAMP_ENABLE
Description:

Enable the RTC TimeStamp
peripheral.
Parameters:

__HANDLE__: specifies the RTC
handle.
Return value:

__HAL_RTC_TIMESTAMP_DISABLE
None
Description:
DOCID028236 Rev 1
495/692
HAL RTC Extension Driver
UM1940

Disable the RTC TimeStamp
peripheral.
Parameters:

__HANDLE__: specifies the RTC
handle.
Return value:

__HAL_RTC_TIMESTAMP_ENABLE_IT
None
Description:

Enable the RTC TimeStamp
interrupt.
Parameters:


__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the
RTC TimeStamp interrupt sources
to be enabled or disabled. This
parameter can be:

RTC_IT_TS: TimeStamp
interrupt
Return value:

__HAL_RTC_TIMESTAMP_DISABLE_IT
None
Description:

Disable the RTC TimeStamp
interrupt.
Parameters:


__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the
RTC TimeStamp interrupt sources
to be enabled or disabled. This
parameter can be:

RTC_IT_TS: TimeStamp
interrupt
Return value:

__HAL_RTC_TIMESTAMP_GET_IT
None
Description:

Check whether the specified RTC
TimeStamp interrupt has occurred
or not.
Parameters:


496/692
DOCID028236 Rev 1
__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the
RTC TimeStamp interrupt to check.
UM1940
HAL RTC Extension Driver
This parameter can be:

RTC_IT_TS: TimeStamp
interrupt
Return value:

__HAL_RTC_TIMESTAMP_GET_IT_SOURCE
None
Description:

Check whether the specified RTC
Time Stamp interrupt has been
enabled or not.
Parameters:


__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the
RTC Time Stamp interrupt source to
check. This parameter can be:

RTC_IT_TS: TimeStamp
interrupt
Return value:

__HAL_RTC_TIMESTAMP_GET_FLAG
None
Description:

Get the selected RTC TimeStamp's
flag status.
Parameters:


__HANDLE__: specifies the RTC
handle.
__FLAG__: specifies the RTC
TimeStamp flag to check. This
parameter can be:

RTC_FLAG_TSF

RTC_FLAG_TSOVF
Return value:

__HAL_RTC_TIMESTAMP_CLEAR_FLAG
None
Description:

Clear the RTC Time Stamp's
pending flags.
Parameters:


__HANDLE__: specifies the RTC
handle.
__FLAG__: specifies the RTC Alarm
Flag sources to be enabled or
disabled. This parameter can be:

RTC_FLAG_TSF
Return value:

DOCID028236 Rev 1
None
497/692
HAL RTC Extension Driver
RTC TimeStamp Pins Selection
UM1940
RTC_TIMESTAMPPIN_DEFAULT
RTC_TIMESTAMPPIN_POS1
RTC TimeStamp Edges Definitions
RTC_TIMESTAMPEDGE_RISING
RTC_TIMESTAMPEDGE_FALLING
RTC WakeUp Timer
__HAL_RTC_WAKEUPTIMER_ENABLE
Description:

Enable the RTC WakeUp Timer
peripheral.
Parameters:

__HANDLE__: specifies the RTC
handle.
Return value:

__HAL_RTC_WAKEUPTIMER_DISABLE
None
Description:

Disable the RTC Wake-up Timer
peripheral.
Parameters:

__HANDLE__: specifies the RTC
handle.
Return value:

__HAL_RTC_WAKEUPTIMER_ENABLE_IT
None
Description:

Enable the RTC WakeUpTimer
interrupt.
Parameters:


__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the
RTC WakeUpTimer interrupt
sources to be enabled or disabled.
This parameter can be:

RTC_IT_WUT: WakeUpTimer
A interrupt
Return value:

__HAL_RTC_WAKEUPTIMER_DISABLE_IT
Description:

498/692
DOCID028236 Rev 1
None
Disable the RTC WakeUpTimer
interrupt.
UM1940
HAL RTC Extension Driver
Parameters:


__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the
RTC WakeUpTimer interrupt
sources to be enabled or disabled.
This parameter can be:

RTC_IT_WUT: WakeUpTimer
A interrupt
Return value:

__HAL_RTC_WAKEUPTIMER_GET_IT
None
Description:

Check whether the specified RTC
WakeUpTimer interrupt has
occurred or not.
Parameters:


__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the
RTC WakeUpTimer interrupt to
check. This parameter can be:

RTC_IT_WUT: WakeUpTimer
A interrupt
Return value:

__HAL_RTC_WAKEUPTIMER_GET_IT_SOUR
CE
None
Description:

Check whether the specified RTC
Wake Up timer interrupt has been
enabled or not.
Parameters:


__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the
RTC Wake Up timer interrupt
sources to check. This parameter
can be:

RTC_IT_WUT: WakeUpTimer
interrupt
Return value:

__HAL_RTC_WAKEUPTIMER_GET_FLAG
None
Description:

Get the selected RTC
WakeUpTimer's flag status.
Parameters:

DOCID028236 Rev 1
__HANDLE__: specifies the RTC
499/692
HAL RTC Extension Driver

UM1940
handle.
__FLAG__: specifies the RTC
WakeUpTimer Flag to check. This
parameter can be:

RTC_FLAG_WUTF

RTC_FLAG_WUTWF
Return value:

__HAL_RTC_WAKEUPTIMER_CLEAR_FLAG
None
Description:

Clear the RTC Wake Up timer's
pending flags.
Parameters:


__HANDLE__: specifies the RTC
handle.
__FLAG__: specifies the RTC
Tamper Flag sources to be
enabled or disabled. This
parameter can be:

RTC_FLAG_WUTF
Return value:

__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE
_IT
None
Description:

Enable interrupt on the RTC Wakeup Timer associated Exti line.
Return value:

__HAL_RTC_WAKEUPTIMER_EXTI_DISABLE
_IT
None
Description:

Disable interrupt on the RTC
Wake-up Timer associated Exti
line.
Return value:

__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE
_EVENT
None
Description:

Enable event on the RTC Wake-up
Timer associated Exti line.
Return value:

__HAL_RTC_WAKEUPTIMER_EXTI_DISABLE
_EVENT
None.
Description:

Disable event on the RTC Wake-up
Timer associated Exti line.
Return value:

500/692
DOCID028236 Rev 1
None.
UM1940
HAL RTC Extension Driver
__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE
_FALLING_EDGE
Description:

Enable falling edge trigger on the
RTC Wake-up Timer associated
Exti line.
Return value:

__HAL_RTC_WAKEUPTIMER_EXTI_DISABLE
_FALLING_EDGE
None.
Description:

Disable falling edge trigger on the
RTC Wake-up Timer associated
Exti line.
Return value:

__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE
_RISING_EDGE
None.
Description:

Enable rising edge trigger on the
RTC Wake-up Timer associated
Exti line.
Return value:

__HAL_RTC_WAKEUPTIMER_EXTI_DISABLE
_RISING_EDGE
None.
Description:

Disable rising edge trigger on the
RTC Wake-up Timer associated
Exti line.
Return value:

__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE
_RISING_FALLING_EDGE
None.
Description:

Enable rising & falling edge trigger
on the RTC Wake-up Timer
associated Exti line.
Return value:

__HAL_RTC_WAKEUPTIMER_EXTI_DISABLE
_RISING_FALLING_EDGE
None.
Description:

Disable rising & falling edge trigger
on the RTC Wake-up Timer
associated Exti line.
Return value:

__HAL_RTC_WAKEUPTIMER_EXTI_GET_FL
AG
None.
Description:

Check whether the RTC Wake-up
Timer associated Exti line interrupt
flag is set or not.
Return value:
DOCID028236 Rev 1
501/692
HAL RTC Extension Driver
UM1940

__HAL_RTC_WAKEUPTIMER_EXTI_CLEAR_
FLAG
Line: Status.
Description:

Clear the RTC Wake-up Timer
associated Exti line flag.
Return value:

__HAL_RTC_WAKEUPTIMER_EXTI_GENERA
TE_SWIT
None.
Description:

Generate a Software interrupt on
the RTC Wake-up Timer
associated Exti line.
Return value:

RTC Wake-up Timer Definitions
RTC_WAKEUPCLOCK_RTCCLK_DIV16
RTC_WAKEUPCLOCK_RTCCLK_DIV8
RTC_WAKEUPCLOCK_RTCCLK_DIV4
RTC_WAKEUPCLOCK_RTCCLK_DIV2
RTC_WAKEUPCLOCK_CK_SPRE_16BITS
RTC_WAKEUPCLOCK_CK_SPRE_17BITS
502/692
DOCID028236 Rev 1
None.
UM1940
HAL SD Generic Driver
38
HAL SD Generic Driver
38.1
SD Firmware driver registers structures
38.1.1
SD_HandleTypeDef
Data Fields













SD_TypeDef * Instance
SD_InitTypeDef Init
HAL_LockTypeDef Lock
uint32_t CardType
uint32_t RCA
uint32_t CSD
uint32_t CID
__IO uint32_t SdTransferCplt
__IO uint32_t SdTransferErr
__IO uint32_t DmaTransferCplt
__IO uint32_t SdOperation
DMA_HandleTypeDef * hdmarx
DMA_HandleTypeDef * hdmatx
Field Documentation













SD_TypeDef* SD_HandleTypeDef::Instance
SDIO register base address
SD_InitTypeDef SD_HandleTypeDef::Init
SD required parameters
HAL_LockTypeDef SD_HandleTypeDef::Lock
SD locking object
uint32_t SD_HandleTypeDef::CardType
SD card type
uint32_t SD_HandleTypeDef::RCA
SD relative card address
uint32_t SD_HandleTypeDef::CSD[4]
SD card specific data table
uint32_t SD_HandleTypeDef::CID[4]
SD card identification number table
__IO uint32_t SD_HandleTypeDef::SdTransferCplt
SD transfer complete flag in non blocking mode
__IO uint32_t SD_HandleTypeDef::SdTransferErr
SD transfer error flag in non blocking mode
__IO uint32_t SD_HandleTypeDef::DmaTransferCplt
SD DMA transfer complete flag
__IO uint32_t SD_HandleTypeDef::SdOperation
SD transfer operation (read/write)
DMA_HandleTypeDef* SD_HandleTypeDef::hdmarx
SD Rx DMA handle parameters
DMA_HandleTypeDef* SD_HandleTypeDef::hdmatx
SD Tx DMA handle parameters
DOCID028236 Rev 1
503/692
HAL SD Generic Driver
38.1.2
UM1940
HAL_SD_CSDTypedef
Data Fields





































__IO uint8_t CSDStruct
__IO uint8_t SysSpecVersion
__IO uint8_t Reserved1
__IO uint8_t TAAC
__IO uint8_t NSAC
__IO uint8_t MaxBusClkFrec
__IO uint16_t CardComdClasses
__IO uint8_t RdBlockLen
__IO uint8_t PartBlockRead
__IO uint8_t WrBlockMisalign
__IO uint8_t RdBlockMisalign
__IO uint8_t DSRImpl
__IO uint8_t Reserved2
__IO uint32_t DeviceSize
__IO uint8_t MaxRdCurrentVDDMin
__IO uint8_t MaxRdCurrentVDDMax
__IO uint8_t MaxWrCurrentVDDMin
__IO uint8_t MaxWrCurrentVDDMax
__IO uint8_t DeviceSizeMul
__IO uint8_t EraseGrSize
__IO uint8_t EraseGrMul
__IO uint8_t WrProtectGrSize
__IO uint8_t WrProtectGrEnable
__IO uint8_t ManDeflECC
__IO uint8_t WrSpeedFact
__IO uint8_t MaxWrBlockLen
__IO uint8_t WriteBlockPaPartial
__IO uint8_t Reserved3
__IO uint8_t ContentProtectAppli
__IO uint8_t FileFormatGrouop
__IO uint8_t CopyFlag
__IO uint8_t PermWrProtect
__IO uint8_t TempWrProtect
__IO uint8_t FileFormat
__IO uint8_t ECC
__IO uint8_t CSD_CRC
__IO uint8_t Reserved4
Field Documentation



504/692
__IO uint8_t HAL_SD_CSDTypedef::CSDStruct
CSD structure
__IO uint8_t HAL_SD_CSDTypedef::SysSpecVersion
System specification version
__IO uint8_t HAL_SD_CSDTypedef::Reserved1
Reserved
DOCID028236 Rev 1
UM1940
HAL SD Generic Driver



























__IO uint8_t HAL_SD_CSDTypedef::TAAC
Data read access time 1
__IO uint8_t HAL_SD_CSDTypedef::NSAC
Data read access time 2 in CLK cycles
__IO uint8_t HAL_SD_CSDTypedef::MaxBusClkFrec
Max. bus clock frequency
__IO uint16_t HAL_SD_CSDTypedef::CardComdClasses
Card command classes
__IO uint8_t HAL_SD_CSDTypedef::RdBlockLen
Max. read data block length
__IO uint8_t HAL_SD_CSDTypedef::PartBlockRead
Partial blocks for read allowed
__IO uint8_t HAL_SD_CSDTypedef::WrBlockMisalign
Write block misalignment
__IO uint8_t HAL_SD_CSDTypedef::RdBlockMisalign
Read block misalignment
__IO uint8_t HAL_SD_CSDTypedef::DSRImpl
DSR implemented
__IO uint8_t HAL_SD_CSDTypedef::Reserved2
Reserved
__IO uint32_t HAL_SD_CSDTypedef::DeviceSize
Device Size
__IO uint8_t HAL_SD_CSDTypedef::MaxRdCurrentVDDMin
Max. read current @ VDD min
__IO uint8_t HAL_SD_CSDTypedef::MaxRdCurrentVDDMax
Max. read current @ VDD max
__IO uint8_t HAL_SD_CSDTypedef::MaxWrCurrentVDDMin
Max. write current @ VDD min
__IO uint8_t HAL_SD_CSDTypedef::MaxWrCurrentVDDMax
Max. write current @ VDD max
__IO uint8_t HAL_SD_CSDTypedef::DeviceSizeMul
Device size multiplier
__IO uint8_t HAL_SD_CSDTypedef::EraseGrSize
Erase group size
__IO uint8_t HAL_SD_CSDTypedef::EraseGrMul
Erase group size multiplier
__IO uint8_t HAL_SD_CSDTypedef::WrProtectGrSize
Write protect group size
__IO uint8_t HAL_SD_CSDTypedef::WrProtectGrEnable
Write protect group enable
__IO uint8_t HAL_SD_CSDTypedef::ManDeflECC
Manufacturer default ECC
__IO uint8_t HAL_SD_CSDTypedef::WrSpeedFact
Write speed factor
__IO uint8_t HAL_SD_CSDTypedef::MaxWrBlockLen
Max. write data block length
__IO uint8_t HAL_SD_CSDTypedef::WriteBlockPaPartial
Partial blocks for write allowed
__IO uint8_t HAL_SD_CSDTypedef::Reserved3
Reserved
__IO uint8_t HAL_SD_CSDTypedef::ContentProtectAppli
Content protection application
__IO uint8_t HAL_SD_CSDTypedef::FileFormatGrouop
File format group
DOCID028236 Rev 1
505/692
HAL SD Generic Driver







38.1.3
UM1940
__IO uint8_t HAL_SD_CSDTypedef::CopyFlag
Copy flag (OTP)
__IO uint8_t HAL_SD_CSDTypedef::PermWrProtect
Permanent write protection
__IO uint8_t HAL_SD_CSDTypedef::TempWrProtect
Temporary write protection
__IO uint8_t HAL_SD_CSDTypedef::FileFormat
File format
__IO uint8_t HAL_SD_CSDTypedef::ECC
ECC code
__IO uint8_t HAL_SD_CSDTypedef::CSD_CRC
CSD CRC
__IO uint8_t HAL_SD_CSDTypedef::Reserved4
Always 1
HAL_SD_CIDTypedef
Data Fields










__IO uint8_t ManufacturerID
__IO uint16_t OEM_AppliID
__IO uint32_t ProdName1
__IO uint8_t ProdName2
__IO uint8_t ProdRev
__IO uint32_t ProdSN
__IO uint8_t Reserved1
__IO uint16_t ManufactDate
__IO uint8_t CID_CRC
__IO uint8_t Reserved2
Field Documentation









506/692
__IO uint8_t HAL_SD_CIDTypedef::ManufacturerID
Manufacturer ID
__IO uint16_t HAL_SD_CIDTypedef::OEM_AppliID
OEM/Application ID
__IO uint32_t HAL_SD_CIDTypedef::ProdName1
Product Name part1
__IO uint8_t HAL_SD_CIDTypedef::ProdName2
Product Name part2
__IO uint8_t HAL_SD_CIDTypedef::ProdRev
Product Revision
__IO uint32_t HAL_SD_CIDTypedef::ProdSN
Product Serial Number
__IO uint8_t HAL_SD_CIDTypedef::Reserved1
Reserved1
__IO uint16_t HAL_SD_CIDTypedef::ManufactDate
Manufacturing Date
__IO uint8_t HAL_SD_CIDTypedef::CID_CRC
CID CRC
DOCID028236 Rev 1
UM1940
HAL SD Generic Driver

38.1.4
__IO uint8_t HAL_SD_CIDTypedef::Reserved2
Always 1
HAL_SD_CardStatusTypedef
Data Fields










__IO uint8_t DAT_BUS_WIDTH
__IO uint8_t SECURED_MODE
__IO uint16_t SD_CARD_TYPE
__IO uint32_t SIZE_OF_PROTECTED_AREA
__IO uint8_t SPEED_CLASS
__IO uint8_t PERFORMANCE_MOVE
__IO uint8_t AU_SIZE
__IO uint16_t ERASE_SIZE
__IO uint8_t ERASE_TIMEOUT
__IO uint8_t ERASE_OFFSET
Field Documentation










38.1.5
__IO uint8_t HAL_SD_CardStatusTypedef::DAT_BUS_WIDTH
Shows the currently defined data bus width
__IO uint8_t HAL_SD_CardStatusTypedef::SECURED_MODE
Card is in secured mode of operation
__IO uint16_t HAL_SD_CardStatusTypedef::SD_CARD_TYPE
Carries information about card type
__IO uint32_t HAL_SD_CardStatusTypedef::SIZE_OF_PROTECTED_AREA
Carries information about the capacity of protected area
__IO uint8_t HAL_SD_CardStatusTypedef::SPEED_CLASS
Carries information about the speed class of the card
__IO uint8_t HAL_SD_CardStatusTypedef::PERFORMANCE_MOVE
Carries information about the card's performance move
__IO uint8_t HAL_SD_CardStatusTypedef::AU_SIZE
Carries information about the card's allocation unit size
__IO uint16_t HAL_SD_CardStatusTypedef::ERASE_SIZE
Determines the number of AUs to be erased in one operation
__IO uint8_t HAL_SD_CardStatusTypedef::ERASE_TIMEOUT
Determines the timeout for any number of AU erase
__IO uint8_t HAL_SD_CardStatusTypedef::ERASE_OFFSET
Carries information about the erase offset
HAL_SD_CardInfoTypedef
Data Fields




HAL_SD_CSDTypedef SD_csd
HAL_SD_CIDTypedef SD_cid
uint64_t CardCapacity
uint32_t CardBlockSize
DOCID028236 Rev 1
507/692
HAL SD Generic Driver


UM1940
uint16_t RCA
uint8_t CardType
Field Documentation






HAL_SD_CSDTypedef HAL_SD_CardInfoTypedef::SD_csd
SD card specific data register
HAL_SD_CIDTypedef HAL_SD_CardInfoTypedef::SD_cid
SD card identification number register
uint64_t HAL_SD_CardInfoTypedef::CardCapacity
Card capacity
uint32_t HAL_SD_CardInfoTypedef::CardBlockSize
Card block size
uint16_t HAL_SD_CardInfoTypedef::RCA
SD relative card address
uint8_t HAL_SD_CardInfoTypedef::CardType
SD card type
38.2
SD Firmware driver API description
38.2.1
How to use this driver
This driver implements a high level communication layer for read and write from/to this
memory. The needed STM32 hardware resources (SDIO and GPIO) are performed by the
user in HAL_SD_MspInit() function (MSP layer). Basically, the MSP layer configuration
should be the same as we provide in the examples. You can easily tailor this configuration
according to hardware resources.
This driver is a generic layered driver for SDIO memories which uses the HAL SDIO driver
functions to interface with SD and uSD cards devices. It is used as follows:
1.
508/692
Initialize the SDIO low level resources by implement the HAL_SD_MspInit() API:
a.
Enable the SDIO interface clock using __HAL_RCC_SDIO_CLK_ENABLE();
b.
SDIO pins configuration for SD card

Enable the clock for the SDIO GPIOs using the functions
__HAL_RCC_GPIOx_CLK_ENABLE();

Configure these SDIO pins as alternate function pull-up using
HAL_GPIO_Init() and according to your pin assignment;
c.
DMA Configuration if you need to use DMA process
(HAL_SD_ReadBlocks_DMA() and HAL_SD_WriteBlocks_DMA() APIs).

Enable the DMAx interface clock using
__HAL_RCC_DMAx_CLK_ENABLE();

Configure the DMA using the function HAL_DMA_Init() with predeclared
and filled.
d.
NVIC configuration if you need to use interrupt process when using DMA
transfer.

Configure the SDIO and DMA interrupt priorities using functions
HAL_NVIC_SetPriority(); DMA priority is superior to SDIO's priority

Enable the NVIC DMA and SDIO IRQs using function
HAL_NVIC_EnableIRQ()

SDIO interrupts are managed using the macros
__HAL_SD_SDIO_ENABLE_IT() and __HAL_SD_SDIO_DISABLE_IT()
inside the communication process.
DOCID028236 Rev 1
UM1940
HAL SD Generic Driver

2.
SDIO interrupts pending bits are managed using the macros
__HAL_SD_SDIO_GET_IT() and __HAL_SD_SDIO_CLEAR_IT()
At this stage, you can perform SD read/write/erase operations after SD card
initialization
SD Card Initialization and configuration
To initialize the SD Card, use the HAL_SD_Init() function. It Initializes the SD Card and put
it into Standby State (Ready for data transfer). This function provide the following
operations:
1.
2.
3.
4.
5.
Apply the SD Card initialization process at 400KHz and check the SD Card type
(Standard Capacity or High Capacity). You can change or adapt this frequency by
adjusting the "ClockDiv" field. The SD Card frequency (SDIO_CK) is computed as
follows: SDIO_CK = SDIOCLK / (ClockDiv + 2) In initialization mode and according to
the SD Card standard, make sure that the SDIO_CK frequency doesn't exceed
400KHz.
Get the SD CID and CSD data. All these information are managed by the SDCardInfo
structure. This structure provide also ready computed SD Card capacity and Block
size. These information are stored in SD handle structure in case of future use.
Configure the SD Card Data transfer frequency. By Default, the card transfer
frequency is set to 24MHz. You can change or adapt this frequency by adjusting the
"ClockDiv" field. In transfer mode and according to the SD Card standard, make sure
that the SDIO_CK frequency doesn't exceed 25MHz and 50MHz in High-speed mode
switch. To be able to use a frequency higher than 24MHz, you should use the SDIO
peripheral in bypass mode. Refer to the corresponding reference manual for more
details.
Select the corresponding SD Card according to the address read with the step 2.
Configure the SD Card in wide bus mode: 4-bits data.
SD Card Read operation


You can read from SD card in polling mode by using function HAL_SD_ReadBlocks().
This function support only 512-bytes block length (the block size should be chosen as
512 bytes). You can choose either one block read operation or multiple block read
operation by adjusting the "NumberOfBlocks" parameter.
You can read from SD card in DMA mode by using function
HAL_SD_ReadBlocks_DMA(). This function support only 512-bytes block length (the
block size should be chosen as 512 bytes). You can choose either one block read
operation or multiple block read operation by adjusting the "NumberOfBlocks"
parameter. After this, you have to call the function HAL_SD_CheckReadOperation(),
to insure that the read transfer is done correctly in both DMA and SD sides.
SD Card Write operation


You can write to SD card in polling mode by using function HAL_SD_WriteBlocks().
This function support only 512-bytes block length (the block size should be chosen as
512 bytes). You can choose either one block read operation or multiple block read
operation by adjusting the "NumberOfBlocks" parameter.
You can write to SD card in DMA mode by using function
HAL_SD_WriteBlocks_DMA(). This function support only 512-bytes block length (the
block size should be chosen as 512 byte). You can choose either one block read
operation or multiple block read operation by adjusting the "NumberOfBlocks"
DOCID028236 Rev 1
509/692
HAL SD Generic Driver
UM1940
parameter. After this, you have to call the function HAL_SD_CheckWriteOperation(),
to insure that the write transfer is done correctly in both DMA and SD sides.
SD card status


At any time, you can check the SD Card status and get the SD card state by using the
HAL_SD_GetStatus() function. This function checks first if the SD card is still
connected and then get the internal SD Card transfer state.
You can also get the SD card SD Status register by using the
HAL_SD_SendSDStatus() function.
SD HAL driver macros list
You can refer to the SD HAL driver header file for more useful macros
38.2.2
Initialization and de-initialization functions
This section provides functions allowing to initialize/de-initialize the SD card device to be
ready for use.
This section contains the following APIs:




38.2.3
HAL_SD_Init()
HAL_SD_DeInit()
HAL_SD_MspInit()
HAL_SD_MspDeInit()
IO operation functions
This subsection provides a set of functions allowing to manage the data transfer from/to
SD card.
This section contains the following APIs:














38.2.4
HAL_SD_ReadBlocks()
HAL_SD_WriteBlocks()
HAL_SD_ReadBlocks_DMA()
HAL_SD_WriteBlocks_DMA()
HAL_SD_CheckReadOperation()
HAL_SD_CheckWriteOperation()
HAL_SD_Erase()
HAL_SD_IRQHandler()
HAL_SD_XferCpltCallback()
HAL_SD_XferErrorCallback()
HAL_SD_DMA_RxCpltCallback()
HAL_SD_DMA_RxErrorCallback()
HAL_SD_DMA_TxCpltCallback()
HAL_SD_DMA_TxErrorCallback()
Peripheral Control functions
This subsection provides a set of functions allowing to control the SD card operations.
510/692
DOCID028236 Rev 1
UM1940
HAL SD Generic Driver
This section contains the following APIs:




38.2.5
HAL_SD_Get_CardInfo()
HAL_SD_WideBusOperation_Config()
HAL_SD_StopTransfer()
HAL_SD_HighSpeed()
Peripheral State functions
This subsection permits to get in runtime the status of the peripheral and the data flow.
This section contains the following APIs:



38.2.6
38.2.7
38.2.8
38.2.9
HAL_SD_SendSDStatus()
HAL_SD_GetStatus()
HAL_SD_GetCardStatus()
HAL_SD_Init
Function Name
HAL_SD_ErrorTypedef HAL_SD_Init (SD_HandleTypeDef *
hsd, HAL_SD_CardInfoTypedef * SDCardInfo)
Function Description
Initializes the SD card according to the specified parameters in the
SD_HandleTypeDef and create the associated handle.
Parameters


hsd: SD handle
SDCardInfo: HAL_SD_CardInfoTypedef structure for SD
card information
Return values

HAL SD error state
HAL_SD_DeInit
Function Name
HAL_StatusTypeDef HAL_SD_DeInit (SD_HandleTypeDef *
hsd)
Function Description
De-Initializes the SD card.
Parameters

hsd: SD handle
Return values

HAL status
HAL_SD_MspInit
Function Name
void HAL_SD_MspInit (SD_HandleTypeDef * hsd)
Function Description
Initializes the SD MSP.
Parameters

hsd: SD handle
Return values

None
HAL_SD_MspDeInit
Function Name
void HAL_SD_MspDeInit (SD_HandleTypeDef * hsd)
Function Description
De-Initialize SD MSP.
Parameters

hsd: SD handle
Return values

None
DOCID028236 Rev 1
511/692
HAL SD Generic Driver
38.2.10
38.2.11
38.2.12
UM1940
HAL_SD_ReadBlocks
Function Name
HAL_SD_ErrorTypedef HAL_SD_ReadBlocks
(SD_HandleTypeDef * hsd, uint32_t * pReadBuffer, uint64_t
ReadAddr, uint32_t BlockSize, uint32_t NumberOfBlocks)
Function Description
Reads block(s) from a specified address in a card.
Parameters





hsd: SD handle
pReadBuffer: pointer to the buffer that will contain the
received data
ReadAddr: Address from where data is to be read
BlockSize: SD card Data block size
NumberOfBlocks: Number of SD blocks to read
Return values

SD Card error state
Notes

BlockSize must be 512 bytes.
HAL_SD_WriteBlocks
Function Name
HAL_SD_ErrorTypedef HAL_SD_WriteBlocks
(SD_HandleTypeDef * hsd, uint32_t * pWriteBuffer, uint64_t
WriteAddr, uint32_t BlockSize, uint32_t NumberOfBlocks)
Function Description
Allows to write block(s) to a specified address in a card.
Parameters





hsd: SD handle
pWriteBuffer: pointer to the buffer that will contain the data
to transmit
WriteAddr: Address from where data is to be written
BlockSize: SD card Data block size
NumberOfBlocks: Number of SD blocks to write
Return values

SD Card error state
Notes

BlockSize must be 512 bytes.
HAL_SD_ReadBlocks_DMA
Function Name
HAL_SD_ErrorTypedef HAL_SD_ReadBlocks_DMA
(SD_HandleTypeDef * hsd, uint32_t * pReadBuffer, uint64_t
ReadAddr, uint32_t BlockSize, uint32_t NumberOfBlocks)
Function Description
Reads block(s) from a specified address in a card.
Parameters





hsd: SD handle
pReadBuffer: Pointer to the buffer that will contain the
received data
ReadAddr: Address from where data is to be read
BlockSize: SD card Data block size
NumberOfBlocks: Number of blocks to read.
Return values

SD Card error state
Notes

This API should be followed by the function
HAL_SD_CheckReadOperation() to check the completion of
the read process
BlockSize must be 512 bytes.

512/692
DOCID028236 Rev 1
UM1940
38.2.13
HAL SD Generic Driver
HAL_SD_WriteBlocks_DMA
Function Name
HAL_SD_ErrorTypedef HAL_SD_WriteBlocks_DMA
(SD_HandleTypeDef * hsd, uint32_t * pWriteBuffer, uint64_t
WriteAddr, uint32_t BlockSize, uint32_t NumberOfBlocks)
Function Description
Writes block(s) to a specified address in a card.
Parameters





hsd: SD handle
pWriteBuffer: pointer to the buffer that will contain the data
to transmit
WriteAddr: Address from where data is to be read
BlockSize: the SD card Data block size
NumberOfBlocks: Number of blocks to write
Return values

SD Card error state
Notes

This API should be followed by the function
HAL_SD_CheckWriteOperation() to check the completion of
the write process (by SD current status polling).
BlockSize must be 512 bytes.

38.2.14
38.2.15
38.2.16
38.2.17
HAL_SD_CheckReadOperation
Function Name
HAL_SD_ErrorTypedef HAL_SD_CheckReadOperation
(SD_HandleTypeDef * hsd, uint32_t Timeout)
Function Description
This function waits until the SD DMA data read transfer is finished.
Parameters


hsd: SD handle
Timeout: Timeout duration
Return values

SD Card error state
HAL_SD_CheckWriteOperation
Function Name
HAL_SD_ErrorTypedef HAL_SD_CheckWriteOperation
(SD_HandleTypeDef * hsd, uint32_t Timeout)
Function Description
This function waits until the SD DMA data write transfer is finished.
Parameters


hsd: SD handle
Timeout: Timeout duration
Return values

SD Card error state
HAL_SD_Erase
Function Name
HAL_SD_ErrorTypedef HAL_SD_Erase (SD_HandleTypeDef *
hsd, uint64_t startaddr, uint64_t endaddr)
Function Description
Erases the specified memory area of the given SD card.
Parameters



hsd: SD handle
startaddr: Start byte address
endaddr: End byte address
Return values

SD Card error state
HAL_SD_IRQHandler
DOCID028236 Rev 1
513/692
HAL SD Generic Driver
Function Name
38.2.18
38.2.19
38.2.20
38.2.21
38.2.22
514/692
UM1940
void HAL_SD_IRQHandler (SD_HandleTypeDef * hsd)
Function Description
This function handles SD card interrupt request.
Parameters

hsd: SD handle
Return values

None
HAL_SD_XferCpltCallback
Function Name
void HAL_SD_XferCpltCallback (SD_HandleTypeDef * hsd)
Function Description
SD end of transfer callback.
Parameters

hsd: SD handle
Return values

None
HAL_SD_XferErrorCallback
Function Name
void HAL_SD_XferErrorCallback (SD_HandleTypeDef * hsd)
Function Description
SD Transfer Error callback.
Parameters

hsd: SD handle
Return values

None
HAL_SD_DMA_RxCpltCallback
Function Name
void HAL_SD_DMA_RxCpltCallback (DMA_HandleTypeDef *
hdma)
Function Description
SD Transfer complete Rx callback in non blocking mode.
Parameters

hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
module.
Return values

None
HAL_SD_DMA_RxErrorCallback
Function Name
void HAL_SD_DMA_RxErrorCallback (DMA_HandleTypeDef *
hdma)
Function Description
SD DMA transfer complete Rx error callback.
Parameters

hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
module.
Return values

None
HAL_SD_DMA_TxCpltCallback
Function Name
void HAL_SD_DMA_TxCpltCallback (DMA_HandleTypeDef *
hdma)
Function Description
SD Transfer complete Tx callback in non blocking mode.
Parameters

hdma: pointer to a DMA_HandleTypeDef structure that
DOCID028236 Rev 1
UM1940
HAL SD Generic Driver
contains the configuration information for the specified DMA
module.
Return values
38.2.23
38.2.24
38.2.25
38.2.26

None
HAL_SD_DMA_TxErrorCallback
Function Name
void HAL_SD_DMA_TxErrorCallback (DMA_HandleTypeDef *
hdma)
Function Description
SD DMA transfer complete error Tx callback.
Parameters

hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
module.
Return values

None
HAL_SD_Get_CardInfo
Function Name
HAL_SD_ErrorTypedef HAL_SD_Get_CardInfo
(SD_HandleTypeDef * hsd, HAL_SD_CardInfoTypedef *
pCardInfo)
Function Description
Returns information about specific card.
Parameters


hsd: SD handle
pCardInfo: Pointer to a HAL_SD_CardInfoTypedef structure
that contains all SD cardinformation
Return values

SD Card error state
HAL_SD_WideBusOperation_Config
Function Name
HAL_SD_ErrorTypedef HAL_SD_WideBusOperation_Config
(SD_HandleTypeDef * hsd, uint32_t WideMode)
Function Description
Enables wide bus operation for the requested card if supported by
card.
Parameters


hsd: SD handle
WideMode: Specifies the SD card wide bus mode This
parameter can be one of the following values:
SDIO_BUS_WIDE_8B: 8-bit data transfer (Only for
MMC)SDIO_BUS_WIDE_4B: 4-bit data
transferSDIO_BUS_WIDE_1B: 1-bit data transfer
Return values

SD Card error state
HAL_SD_StopTransfer
Function Name
HAL_SD_ErrorTypedef HAL_SD_StopTransfer
(SD_HandleTypeDef * hsd)
Function Description
Aborts an ongoing data transfer.
Parameters

hsd: SD handle
Return values

SD Card error state
DOCID028236 Rev 1
515/692
HAL SD Generic Driver
38.2.27
38.2.28
38.2.29
38.2.30
UM1940
HAL_SD_HighSpeed
Function Name
HAL_SD_ErrorTypedef HAL_SD_HighSpeed
(SD_HandleTypeDef * hsd)
Function Description
Switches the SD card to High Speed mode.
Parameters

hsd: SD handle
Return values

SD Card error state
Notes

This operation should be followed by the configuration of PLL
to have SDIOCK clock between 67 and 75 MHz
HAL_SD_SendSDStatus
Function Name
HAL_SD_ErrorTypedef HAL_SD_SendSDStatus
(SD_HandleTypeDef * hsd, uint32_t * pSDstatus)
Function Description
Returns the current SD card's status.
Parameters


hsd: SD handle
pSDstatus: Pointer to the buffer that will contain the SD card
status SD Status register)
Return values

SD Card error state
HAL_SD_GetStatus
Function Name
HAL_SD_TransferStateTypedef HAL_SD_GetStatus
(SD_HandleTypeDef * hsd)
Function Description
Gets the current sd card data status.
Parameters

hsd: SD handle
Return values

Data Transfer state
HAL_SD_GetCardStatus
Function Name
HAL_SD_ErrorTypedef HAL_SD_GetCardStatus
(SD_HandleTypeDef * hsd, HAL_SD_CardStatusTypedef *
pCardStatus)
Function Description
Gets the SD card status.
Parameters


hsd: SD handle
pCardStatus: Pointer to the HAL_SD_CardStatusTypedef
structure that will contain the SD card status information
Return values

SD Card error state
38.3
SD Firmware driver defines
38.3.1
SD
SD Exported Constants
SD_CMD_GO_IDLE_STATE
516/692
DOCID028236 Rev 1
Resets the SD memory
card.
UM1940
SD_CMD_SEND_OP_COND
HAL SD Generic Driver
Sends host capacity support
information and activates
the card's initialization
process.
SD_CMD_ALL_SEND_CID
Asks any card connected to
the host to send the CID
numbers on the CMD line.
SD_CMD_SET_REL_ADDR
Asks the card to publish a
new relative address (RCA).
SD_CMD_SET_DSR
Programs the DSR of all
cards.
SD_CMD_SDIO_SEN_OP_COND
Sends host capacity support
information (HCS) and asks
the accessed card to send
its operating condition
register (OCR) content in
the response on the CMD
line.
SD_CMD_HS_SWITCH
Checks switchable function
(mode 0) and switch card
function (mode 1).
SD_CMD_SEL_DESEL_CARD
Selects the card by its own
relative address and gets
deselected by any other
address
SD_CMD_HS_SEND_EXT_CSD
Sends SD Memory Card
interface condition, which
includes host supply voltage
information and asks the
card whether card supports
voltage.
SD_CMD_SEND_CSD
Addressed card sends its
card specific data (CSD) on
the CMD line.
SD_CMD_SEND_CID
Addressed card sends its
card identification (CID) on
the CMD line.
SD_CMD_READ_DAT_UNTIL_STOP
SD card doesn't support it.
SD_CMD_STOP_TRANSMISSION
Forces the card to stop
transmission.
SD_CMD_SEND_STATUS
Addressed card sends its
status register.
SD_CMD_HS_BUSTEST_READ
SD_CMD_GO_INACTIVE_STATE
Sends an addressed card
into the inactive state.
SD_CMD_SET_BLOCKLEN
Sets the block length (in
bytes for SDSC) for all
following block commands
DOCID028236 Rev 1
517/692
HAL SD Generic Driver
518/692
UM1940
(read, write, lock). Default
block length is fixed to 512
Bytes. Not effective for
SDHS and SDXC.
SD_CMD_READ_SINGLE_BLOCK
Reads single block of size
selected by
SET_BLOCKLEN in case of
SDSC, and a block of fixed
512 bytes in case of SDHC
and SDXC.
SD_CMD_READ_MULT_BLOCK
Continuously transfers data
blocks from card to host
until interrupted by
STOP_TRANSMISSION
command.
SD_CMD_HS_BUSTEST_WRITE
64 bytes tuning pattern is
sent for SDR50 and
SDR104.
SD_CMD_WRITE_DAT_UNTIL_STOP
Speed class control
command.
SD_CMD_SET_BLOCK_COUNT
Specify block count for
CMD18 and CMD25.
SD_CMD_WRITE_SINGLE_BLOCK
Writes single block of size
selected by
SET_BLOCKLEN in case of
SDSC, and a block of fixed
512 bytes in case of SDHC
and SDXC.
SD_CMD_WRITE_MULT_BLOCK
Continuously writes blocks
of data until a
STOP_TRANSMISSION
follows.
SD_CMD_PROG_CID
Reserved for manufacturers.
SD_CMD_PROG_CSD
Programming of the
programmable bits of the
CSD.
SD_CMD_SET_WRITE_PROT
Sets the write protection bit
of the addressed group.
SD_CMD_CLR_WRITE_PROT
Clears the write protection
bit of the addressed group.
SD_CMD_SEND_WRITE_PROT
Asks the card to send the
status of the write protection
bits.
SD_CMD_SD_ERASE_GRP_START
Sets the address of the first
write block to be erased.
(For SD card only).
SD_CMD_SD_ERASE_GRP_END
Sets the address of the last
write block of the continuous
DOCID028236 Rev 1
UM1940
HAL SD Generic Driver
range to be erased.
SD_CMD_ERASE_GRP_START
Sets the address of the first
write block to be erased.
Reserved for each
command system set by
switch function command
(CMD6).
SD_CMD_ERASE_GRP_END
Sets the address of the last
write block of the continuous
range to be erased.
Reserved for each
command system set by
switch function command
(CMD6).
SD_CMD_ERASE
Reserved for SD security
applications.
SD_CMD_FAST_IO
SD card doesn't support it
(Reserved).
SD_CMD_GO_IRQ_STATE
SD card doesn't support it
(Reserved).
SD_CMD_LOCK_UNLOCK
Sets/resets the password or
lock/unlock the card. The
size of the data block is set
by the SET_BLOCK_LEN
command.
SD_CMD_APP_CMD
Indicates to the card that the
next command is an
application specific
command rather than a
standard command.
SD_CMD_GEN_CMD
Used either to transfer a
data block to the card or to
get a data block from the
card for general
purpose/application specific
commands.
SD_CMD_NO_CMD
SD_CMD_APP_SD_SET_BUSWIDTH
SDIO_APP_CMD should be
sent before sending these
commands. (ACMD6)
Defines the data bus width
to be used for data transfer.
The allowed data bus widths
are given in SCR register.
SD_CMD_SD_APP_STATUS
(ACMD13) Sends the SD
status.
SD_CMD_SD_APP_SEND_NUM_WRITE_BLOCKS
(ACMD22) Sends the
number of the written
(without errors) write blocks.
DOCID028236 Rev 1
519/692
HAL SD Generic Driver
UM1940
Responds with 32bit+CRC
data block.
SD_CMD_SD_APP_OP_COND
(ACMD41) Sends host
capacity support information
(HCS) and asks the
accessed card to send its
operating condition register
(OCR) content in the
response on the CMD line.
SD_CMD_SD_APP_SET_CLR_CARD_DETECT
(ACMD42)
Connects/Disconnects the
50 KOhm pull-up resistor on
CD/DAT3 (pin 1) of the card.
SD_CMD_SD_APP_SEND_SCR
Reads the SD Configuration
Register (SCR).
SD_CMD_SDIO_RW_DIRECT
For SD I/O card only,
reserved for security
specification.
SD_CMD_SDIO_RW_EXTENDED
For SD I/O card only,
reserved for security
specification.
SD_CMD_SD_APP_GET_MKB
SD_CMD_APP_CMD
should be sent before
sending these commands.
For SD card only
SD_CMD_SD_APP_GET_MID
For SD card only
SD_CMD_SD_APP_SET_CER_RN1
For SD card only
SD_CMD_SD_APP_GET_CER_RN2
For SD card only
SD_CMD_SD_APP_SET_CER_RES2
For SD card only
SD_CMD_SD_APP_GET_CER_RES1
For SD card only
SD_CMD_SD_APP_SECURE_READ_MULTIPLE_BLOCK
For SD card only
SD_CMD_SD_APP_SECURE_WRITE_MULTIPLE_BLOCK
For SD card only
SD_CMD_SD_APP_SECURE_ERASE
For SD card only
SD_CMD_SD_APP_CHANGE_SECURE_AREA
For SD card only
SD_CMD_SD_APP_SECURE_WRITE_MKB
For SD card only
STD_CAPACITY_SD_CARD_V1_1
STD_CAPACITY_SD_CARD_V2_0
HIGH_CAPACITY_SD_CARD
MULTIMEDIA_CARD
SECURE_DIGITAL_IO_CARD
HIGH_SPEED_MULTIMEDIA_CARD
SECURE_DIGITAL_IO_COMBO_CARD
HIGH_CAPACITY_MMC_CARD
520/692
DOCID028236 Rev 1
UM1940
HAL SD Generic Driver
SD Exported Macros
Description:
__HAL_SD_SDIO_ENABLE

Enable the SD device.
Return value:

__HAL_SD_SDIO_DISABLE
None
Description:

Disable the SD device.
Return value:

__HAL_SD_SDIO_DMA_ENABLE
None
Description:

Enable the SDIO DMA transfer.
Return value:

__HAL_SD_SDIO_DMA_DISABLE
None
Description:

Disable the SDIO DMA transfer.
Return value:

__HAL_SD_SDIO_ENABLE_IT
None
Description:

Enable the SD device interrupt.
Parameters:


__HANDLE__: SD Handle
__INTERRUPT__: specifies the SDIO interrupt
sources to be enabled. This parameter can be
one or a combination of the following values:

SDIO_IT_CCRCFAIL: Command response
received (CRC check failed) interrupt

SDIO_IT_DCRCFAIL: Data block
sent/received (CRC check failed) interrupt

SDIO_IT_CTIMEOUT: Command response
timeout interrupt

SDIO_IT_DTIMEOUT: Data timeout
interrupt

SDIO_IT_TXUNDERR: Transmit FIFO
underrun error interrupt

SDIO_IT_RXOVERR: Received FIFO
overrun error interrupt

SDIO_IT_CMDREND: Command response
received (CRC check passed) interrupt

SDIO_IT_CMDSENT: Command sent (no
response required) interrupt

SDIO_IT_DATAEND: Data end (data
counter, SDIDCOUNT, is zero) interrupt

SDIO_IT_STBITERR: Start bit not detected
on all data signals in wide bus mode
DOCID028236 Rev 1
521/692
HAL SD Generic Driver














UM1940
interrupt
SDIO_IT_DBCKEND: Data block
sent/received (CRC check passed) interrupt
SDIO_IT_CMDACT: Command transfer in
progress interrupt
SDIO_IT_TXACT: Data transmit in progress
interrupt
SDIO_IT_RXACT: Data receive in progress
interrupt
SDIO_IT_TXFIFOHE: Transmit FIFO Half
Empty interrupt
SDIO_IT_RXFIFOHF: Receive FIFO Half
Full interrupt
SDIO_IT_TXFIFOF: Transmit FIFO full
interrupt
SDIO_IT_RXFIFOF: Receive FIFO full
interrupt
SDIO_IT_TXFIFOE: Transmit FIFO empty
interrupt
SDIO_IT_RXFIFOE: Receive FIFO empty
interrupt
SDIO_IT_TXDAVL: Data available in
transmit FIFO interrupt
SDIO_IT_RXDAVL: Data available in
receive FIFO interrupt
SDIO_IT_SDIOIT: SD I/O interrupt received
interrupt
SDIO_IT_CEATAEND: CE-ATA command
completion signal received for CMD61
interrupt
Return value:

__HAL_SD_SDIO_DISABLE_IT
None
Description:

Disable the SD device interrupt.
Parameters:


522/692
__HANDLE__: SD Handle
__INTERRUPT__: specifies the SDIO interrupt
sources to be disabled. This parameter can be
one or a combination of the following values:

SDIO_IT_CCRCFAIL: Command response
received (CRC check failed) interrupt

SDIO_IT_DCRCFAIL: Data block
sent/received (CRC check failed) interrupt

SDIO_IT_CTIMEOUT: Command response
timeout interrupt

SDIO_IT_DTIMEOUT: Data timeout
interrupt

SDIO_IT_TXUNDERR: Transmit FIFO
underrun error interrupt

SDIO_IT_RXOVERR: Received FIFO
overrun error interrupt
DOCID028236 Rev 1
UM1940
HAL SD Generic Driver


















SDIO_IT_CMDREND: Command response
received (CRC check passed) interrupt
SDIO_IT_CMDSENT: Command sent (no
response required) interrupt
SDIO_IT_DATAEND: Data end (data
counter, SDIDCOUNT, is zero) interrupt
SDIO_IT_STBITERR: Start bit not detected
on all data signals in wide bus mode
interrupt
SDIO_IT_DBCKEND: Data block
sent/received (CRC check passed) interrupt
SDIO_IT_CMDACT: Command transfer in
progress interrupt
SDIO_IT_TXACT: Data transmit in progress
interrupt
SDIO_IT_RXACT: Data receive in progress
interrupt
SDIO_IT_TXFIFOHE: Transmit FIFO Half
Empty interrupt
SDIO_IT_RXFIFOHF: Receive FIFO Half
Full interrupt
SDIO_IT_TXFIFOF: Transmit FIFO full
interrupt
SDIO_IT_RXFIFOF: Receive FIFO full
interrupt
SDIO_IT_TXFIFOE: Transmit FIFO empty
interrupt
SDIO_IT_RXFIFOE: Receive FIFO empty
interrupt
SDIO_IT_TXDAVL: Data available in
transmit FIFO interrupt
SDIO_IT_RXDAVL: Data available in
receive FIFO interrupt
SDIO_IT_SDIOIT: SD I/O interrupt received
interrupt
SDIO_IT_CEATAEND: CE-ATA command
completion signal received for CMD61
interrupt
Return value:

__HAL_SD_SDIO_GET_FLAG
None
Description:

Check whether the specified SD flag is set or
not.
Parameters:


__HANDLE__: SD Handle
__FLAG__: specifies the flag to check. This
parameter can be one of the following values:

SDIO_FLAG_CCRCFAIL: Command
response received (CRC check failed)

SDIO_FLAG_DCRCFAIL: Data block
sent/received (CRC check failed)
DOCID028236 Rev 1
523/692
HAL SD Generic Driver
UM1940






















SDIO_FLAG_CTIMEOUT: Command
response timeout
SDIO_FLAG_DTIMEOUT: Data timeout
SDIO_FLAG_TXUNDERR: Transmit FIFO
underrun error
SDIO_FLAG_RXOVERR: Received FIFO
overrun error
SDIO_FLAG_CMDREND: Command
response received (CRC check passed)
SDIO_FLAG_CMDSENT: Command sent
(no response required)
SDIO_FLAG_DATAEND: Data end (data
counter, SDIDCOUNT, is zero)
SDIO_FLAG_STBITERR: Start bit not
detected on all data signals in wide bus
mode.
SDIO_FLAG_DBCKEND: Data block
sent/received (CRC check passed)
SDIO_FLAG_CMDACT: Command transfer
in progress
SDIO_FLAG_TXACT: Data transmit in
progress
SDIO_FLAG_RXACT: Data receive in
progress
SDIO_FLAG_TXFIFOHE: Transmit FIFO
Half Empty
SDIO_FLAG_RXFIFOHF: Receive FIFO
Half Full
SDIO_FLAG_TXFIFOF: Transmit FIFO full
SDIO_FLAG_RXFIFOF: Receive FIFO full
SDIO_FLAG_TXFIFOE: Transmit FIFO
empty
SDIO_FLAG_RXFIFOE: Receive FIFO
empty
SDIO_FLAG_TXDAVL: Data available in
transmit FIFO
SDIO_FLAG_RXDAVL: Data available in
receive FIFO
SDIO_FLAG_SDIOIT: SD I/O interrupt
received
SDIO_FLAG_CEATAEND: CE-ATA
command completion signal received for
CMD61
Return value:

__HAL_SD_SDIO_CLEAR_FLAG
The: new state of SD FLAG (SET or RESET).
Description:

Clear the SD's pending flags.
Parameters:


524/692
__HANDLE__: SD Handle
__FLAG__: specifies the flag to clear. This
parameter can be one or a combination of the
DOCID028236 Rev 1
UM1940
HAL SD Generic Driver
following values:

SDIO_FLAG_CCRCFAIL: Command
response received (CRC check failed)

SDIO_FLAG_DCRCFAIL: Data block
sent/received (CRC check failed)

SDIO_FLAG_CTIMEOUT: Command
response timeout

SDIO_FLAG_DTIMEOUT: Data timeout

SDIO_FLAG_TXUNDERR: Transmit FIFO
underrun error

SDIO_FLAG_RXOVERR: Received FIFO
overrun error

SDIO_FLAG_CMDREND: Command
response received (CRC check passed)

SDIO_FLAG_CMDSENT: Command sent
(no response required)

SDIO_FLAG_DATAEND: Data end (data
counter, SDIDCOUNT, is zero)

SDIO_FLAG_STBITERR: Start bit not
detected on all data signals in wide bus
mode

SDIO_FLAG_DBCKEND: Data block
sent/received (CRC check passed)

SDIO_FLAG_SDIOIT: SD I/O interrupt
received

SDIO_FLAG_CEATAEND: CE-ATA
command completion signal received for
CMD61
Return value:

__HAL_SD_SDIO_GET_IT
None
Description:

Check whether the specified SD interrupt has
occurred or not.
Parameters:


__HANDLE__: SD Handle
__INTERRUPT__: specifies the SDIO interrupt
source to check. This parameter can be one of
the following values:

SDIO_IT_CCRCFAIL: Command response
received (CRC check failed) interrupt

SDIO_IT_DCRCFAIL: Data block
sent/received (CRC check failed) interrupt

SDIO_IT_CTIMEOUT: Command response
timeout interrupt

SDIO_IT_DTIMEOUT: Data timeout
interrupt

SDIO_IT_TXUNDERR: Transmit FIFO
underrun error interrupt

SDIO_IT_RXOVERR: Received FIFO
overrun error interrupt

SDIO_IT_CMDREND: Command response
DOCID028236 Rev 1
525/692
HAL SD Generic Driver

















UM1940
received (CRC check passed) interrupt
SDIO_IT_CMDSENT: Command sent (no
response required) interrupt
SDIO_IT_DATAEND: Data end (data
counter, SDIDCOUNT, is zero) interrupt
SDIO_IT_STBITERR: Start bit not detected
on all data signals in wide bus mode
interrupt
SDIO_IT_DBCKEND: Data block
sent/received (CRC check passed) interrupt
SDIO_IT_CMDACT: Command transfer in
progress interrupt
SDIO_IT_TXACT: Data transmit in progress
interrupt
SDIO_IT_RXACT: Data receive in progress
interrupt
SDIO_IT_TXFIFOHE: Transmit FIFO Half
Empty interrupt
SDIO_IT_RXFIFOHF: Receive FIFO Half
Full interrupt
SDIO_IT_TXFIFOF: Transmit FIFO full
interrupt
SDIO_IT_RXFIFOF: Receive FIFO full
interrupt
SDIO_IT_TXFIFOE: Transmit FIFO empty
interrupt
SDIO_IT_RXFIFOE: Receive FIFO empty
interrupt
SDIO_IT_TXDAVL: Data available in
transmit FIFO interrupt
SDIO_IT_RXDAVL: Data available in
receive FIFO interrupt
SDIO_IT_SDIOIT: SD I/O interrupt received
interrupt
SDIO_IT_CEATAEND: CE-ATA command
completion signal received for CMD61
interrupt
Return value:

__HAL_SD_SDIO_CLEAR_IT
The: new state of SD IT (SET or RESET).
Description:

Clear the SD's interrupt pending bits.
Parameters:


526/692
__HANDLE__: : SD Handle
__INTERRUPT__: specifies the interrupt
pending bit to clear. This parameter can be one
or a combination of the following values:

SDIO_IT_CCRCFAIL: Command response
received (CRC check failed) interrupt

SDIO_IT_DCRCFAIL: Data block
sent/received (CRC check failed) interrupt

SDIO_IT_CTIMEOUT: Command response
DOCID028236 Rev 1
UM1940









HAL SD Generic Driver
timeout interrupt
SDIO_IT_DTIMEOUT: Data timeout
interrupt
SDIO_IT_TXUNDERR: Transmit FIFO
underrun error interrupt
SDIO_IT_RXOVERR: Received FIFO
overrun error interrupt
SDIO_IT_CMDREND: Command response
received (CRC check passed) interrupt
SDIO_IT_CMDSENT: Command sent (no
response required) interrupt
SDIO_IT_DATAEND: Data end (data
counter, SDIO_DCOUNT, is zero) interrupt
SDIO_IT_STBITERR: Start bit not detected
on all data signals in wide bus mode
interrupt
SDIO_IT_SDIOIT: SD I/O interrupt received
interrupt
SDIO_IT_CEATAEND: CE-ATA command
completion signal received for CMD61
Return value:

None
SD Handle Structure definition
SD_InitTypeDef
SD_TypeDef
SD Private Defines
DATA_BLOCK_SIZE
SDIO_STATIC_FLAGS
SDIO_CMD0TIMEOUT
SD_OCR_ADDR_OUT_OF_RANGE
SD_OCR_ADDR_MISALIGNED
SD_OCR_BLOCK_LEN_ERR
SD_OCR_ERASE_SEQ_ERR
SD_OCR_BAD_ERASE_PARAM
SD_OCR_WRITE_PROT_VIOLATION
SD_OCR_LOCK_UNLOCK_FAILED
SD_OCR_COM_CRC_FAILED
SD_OCR_ILLEGAL_CMD
SD_OCR_CARD_ECC_FAILED
SD_OCR_CC_ERROR
SD_OCR_GENERAL_UNKNOWN_ERROR
SD_OCR_STREAM_READ_UNDERRUN
DOCID028236 Rev 1
527/692
HAL SD Generic Driver
SD_OCR_STREAM_WRITE_OVERRUN
UM1940
SD_OCR_CID_CSD_OVERWRITE
SD_OCR_WP_ERASE_SKIP
SD_OCR_CARD_ECC_DISABLED
SD_OCR_ERASE_RESET
SD_OCR_AKE_SEQ_ERROR
SD_OCR_ERRORBITS
SD_R6_GENERAL_UNKNOWN_ERROR
SD_R6_ILLEGAL_CMD
SD_R6_COM_CRC_FAILED
SD_VOLTAGE_WINDOW_SD
SD_HIGH_CAPACITY
SD_STD_CAPACITY
SD_CHECK_PATTERN
SD_MAX_VOLT_TRIAL
SD_ALLZERO
SD_WIDE_BUS_SUPPORT
SD_SINGLE_BUS_SUPPORT
SD_CARD_LOCKED
SD_DATATIMEOUT
SD_0TO7BITS
SD_8TO15BITS
SD_16TO23BITS
SD_24TO31BITS
SD_MAX_DATA_LENGTH
SD_HALFFIFO
SD_HALFFIFOBYTES
SD_CCCC_LOCK_UNLOCK
SD_CCCC_WRITE_PROT
SD_CCCC_ERASE
SD_SDIO_SEND_IF_COND
528/692
SDIO_APP_CMD should be sent before
sending these commands.
DOCID028236 Rev 1
UM1940
HAL SMARTCARD Generic Driver
39
HAL SMARTCARD Generic Driver
39.1
SMARTCARD Firmware driver registers structures
39.1.1
SMARTCARD_InitTypeDef
Data Fields











uint32_t BaudRate
uint32_t WordLength
uint32_t StopBits
uint32_t Parity
uint32_t Mode
uint32_t CLKPolarity
uint32_t CLKPhase
uint32_t CLKLastBit
uint32_t Prescaler
uint32_t GuardTime
uint32_t NACKState
Field Documentation








uint32_t SMARTCARD_InitTypeDef::BaudRate
This member configures the SmartCard communication baud rate. The baud rate is
computed using the following formula:IntegerDivider = ((PCLKx) / (8 * (hirda>Init.BaudRate)))FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 8)
+ 0.5
uint32_t SMARTCARD_InitTypeDef::WordLength
Specifies the number of data bits transmitted or received in a frame. This parameter
can be a value of SMARTCARD_Word_Length
uint32_t SMARTCARD_InitTypeDef::StopBits
Specifies the number of stop bits transmitted. This parameter can be a value of
SMARTCARD_Stop_Bits
uint32_t SMARTCARD_InitTypeDef::Parity
Specifies the parity mode. This parameter can be a value of SMARTCARD_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).
uint32_t SMARTCARD_InitTypeDef::Mode
Specifies whether the Receive or Transmit mode is enabled or disabled. This
parameter can be a value of SMARTCARD_Mode
uint32_t SMARTCARD_InitTypeDef::CLKPolarity
Specifies the steady state of the serial clock. This parameter can be a value of
SMARTCARD_Clock_Polarity
uint32_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
uint32_t SMARTCARD_InitTypeDef::CLKLastBit
Specifies whether the clock pulse corresponding to the last transmitted data bit (MSB)
DOCID028236 Rev 1
529/692
HAL SMARTCARD Generic Driver
UM1940
has to be output on the SCLK pin in synchronous mode. This parameter can be a
value of SMARTCARD_Last_Bit

uint32_t SMARTCARD_InitTypeDef::Prescaler
Specifies the SmartCard Prescaler value used for dividing the system clock to provide
the smartcard clock This parameter can be a value of SMARTCARD_Prescaler

uint32_t SMARTCARD_InitTypeDef::GuardTime
Specifies the SmartCard Guard Time value in terms of number of baud clocks The
value given in the register (5 significant bits) is multiplied by 2 to give the division
factor of the source clock frequency

uint32_t SMARTCARD_InitTypeDef::NACKState
Specifies the SmartCard NACK Transmission state. This parameter can be a value of
SMARTCARD_NACK_State
39.1.2
SMARTCARD_HandleTypeDef
Data Fields













USART_TypeDef * Instance
SMARTCARD_InitTypeDef Init
uint8_t * pTxBuffPtr
uint16_t TxXferSize
uint16_t TxXferCount
uint8_t * pRxBuffPtr
uint16_t RxXferSize
uint16_t RxXferCount
DMA_HandleTypeDef * hdmatx
DMA_HandleTypeDef * hdmarx
HAL_LockTypeDef Lock
__IO HAL_SMARTCARD_StateTypeDef State
__IO uint32_t ErrorCode
Field Documentation













530/692
USART_TypeDef* SMARTCARD_HandleTypeDef::Instance
SMARTCARD_InitTypeDef SMARTCARD_HandleTypeDef::Init
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
__IO HAL_SMARTCARD_StateTypeDef SMARTCARD_HandleTypeDef::State
__IO uint32_t SMARTCARD_HandleTypeDef::ErrorCode
DOCID028236 Rev 1
UM1940
HAL SMARTCARD Generic Driver
39.2
SMARTCARD Firmware driver API description
39.2.1
How to use this driver
The SMARTCARD HAL driver can be used as follows:
1.
2.
3.
4.
Declare a SMARTCARD_HandleTypeDef handle structure.
Initialize the SMARTCARD low level resources by implementing the
HAL_SMARTCARD_MspInit() API:
a.
Enable the USARTx interface clock.
b.
SMARTCARD pins configuration:

Enable the clock for the SMARTCARD GPIOs.

Configure these SMARTCARD pins as alternate function pull-up.
c.
NVIC configuration if you need to use interrupt process
(HAL_SMARTCARD_Transmit_IT() and HAL_SMARTCARD_Receive_IT() APIs):

Configure the USARTx interrupt priority.

Enable the NVIC USART IRQ handle.
d.
DMA Configuration if you need to use DMA process
(HAL_SMARTCARD_Transmit_DMA() and HAL_SMARTCARD_Receive_DMA()
APIs):

Declare a DMA handle structure for the Tx/Rx stream.

Enable the DMAx interface clock.

Configure the declared DMA handle structure with the required Tx/Rx
parameters.

Configure the DMA Tx/Rx Stream.

Associate the initialized DMA handle to the SMARTCARD DMA Tx/Rx
handle.

Configure the priority and enable the NVIC for the transfer complete
interrupt on the DMA Tx/Rx Stream.
Program the Baud Rate, Word Length , Stop Bit, Parity, Hardware flow control and
Mode(Receiver/Transmitter) in the SMARTCARD Init structure.
Initialize the SMARTCARD registers by calling the HAL_SMARTCARD_Init() API:

These APIs configure also the low level Hardware GPIO, CLOCK,
CORTEX...etc) by calling the customized 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.
Three operation modes are available within this driver :
Polling mode IO operation


Send an amount of data in blocking mode using HAL_SMARTCARD_Transmit()
Receive an amount of data in blocking mode using HAL_SMARTCARD_Receive()
Interrupt mode IO operation

Send an amount of data in non blocking mode using
HAL_SMARTCARD_Transmit_IT()
DOCID028236 Rev 1
531/692
HAL SMARTCARD Generic Driver




UM1940
At transmission end of transfer HAL_SMARTCARD_TxCpltCallback is executed and
user can add his own code by customization of function pointer
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
user can add his own code by customization of function pointer
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
DMA mode IO operation





Send an amount of data in non blocking mode (DMA) using
HAL_SMARTCARD_Transmit_DMA()
At transmission end of transfer HAL_SMARTCARD_TxCpltCallback is executed and
user can add his own code by customization of function pointer
HAL_SMARTCARD_TxCpltCallback
Receive an amount of data in non blocking mode (DMA) using
HAL_SMARTCARD_Receive_DMA()
At reception end of transfer HAL_SMARTCARD_RxCpltCallback is executed and
user can add his own code by customization of function pointer
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
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
39.2.2
Initialization and Configuration functions
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.
532/692
DOCID028236 Rev 1
UM1940
HAL SMARTCARD Generic Driver
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

Word Length => Should be 9 bits (8 bits + parity)

Stop Bit

Parity: => Should be enabled (see table below)

USART polarity

USART phase

USART LastBit

Receiver/transmitter modes

Prescaler

GuardTime

NACKState: The Smartcard NACK state
Recommended SmartCard interface configuration to get the Answer to Reset from
the Card:

Word Length = 9 Bits

1.5 Stop Bit

Even parity

BaudRate = 12096 baud

Tx and Rx enabled
Table 17: USART frame formats
M bit
PCE bit
Smartcard frame
1
1
| SB | 8 bit data | PB | STB |
Please refer to the ISO 7816-3 specification for more details. [email protected] It is also possible to
choose 0.5 stop bit for receiving but it is recommended to use 1.5 stop bits for both
transmitting and receiving to avoid switching between the two configurations.
The HAL_SMARTCARD_Init() function follows the USART SmartCard configuration
procedure (details for the procedure are available in reference manual (RM0329)).
This section contains the following APIs:





39.2.3
HAL_SMARTCARD_Init()
HAL_SMARTCARD_DeInit()
HAL_SMARTCARD_MspInit()
HAL_SMARTCARD_MspDeInit()
HAL_SMARTCARD_ReInit()
IO operation functions
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.
There are two modes of transfer:
DOCID028236 Rev 1
533/692
HAL SMARTCARD Generic Driver
UM1940

2.
3.
4.
5.
Blocking mode: The communication is performed in polling mode. The HAL
status of all data processing is returned by the same function after finishing
transfer.

Non Blocking mode: The communication is performed using Interrupts or DMA,
These APIs 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 respectively 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 APIs are :

HAL_SMARTCARD_Transmit()

HAL_SMARTCARD_Receive()
Non Blocking mode APIs with Interrupt are :

HAL_SMARTCARD_Transmit_IT()

HAL_SMARTCARD_Receive_IT()

HAL_SMARTCARD_IRQHandler()
Non Blocking mode functions with DMA are :

HAL_SMARTCARD_Transmit_DMA()

HAL_SMARTCARD_Receive_DMA()
A set of Transfer Complete Callbacks are provided in non Blocking mode:

HAL_SMARTCARD_TxCpltCallback()

HAL_SMARTCARD_RxCpltCallback()

HAL_SMARTCARD_ErrorCallback()
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:


534/692
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. (#) There are two modes of transfer:

Blocking mode: The communication is performed in polling mode. The HAL
status of all data processing is returned by the same function after finishing
transfer.

Non Blocking mode: The communication is performed using Interrupts or DMA,
These APIs 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 respectively 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 APIs are :

HAL_SMARTCARD_Transmit()

HAL_SMARTCARD_Receive() (#) Non Blocking mode APIs with Interrupt are :

HAL_SMARTCARD_Transmit_IT()

HAL_SMARTCARD_Receive_IT()

HAL_SMARTCARD_IRQHandler() (#) Non Blocking mode functions with DMA
are :

HAL_SMARTCARD_Transmit_DMA()

HAL_SMARTCARD_Receive_DMA() (#) A set of Transfer Complete Callbacks
are provided in non Blocking mode:

HAL_SMARTCARD_TxCpltCallback()

HAL_SMARTCARD_RxCpltCallback()
DOCID028236 Rev 1
UM1940
HAL SMARTCARD Generic Driver

HAL_SMARTCARD_ErrorCallback()
This section contains the following APIs:










39.2.4
HAL_SMARTCARD_Transmit()
HAL_SMARTCARD_Receive()
HAL_SMARTCARD_Transmit_IT()
HAL_SMARTCARD_Receive_IT()
HAL_SMARTCARD_Transmit_DMA()
HAL_SMARTCARD_Receive_DMA()
HAL_SMARTCARD_IRQHandler()
HAL_SMARTCARD_TxCpltCallback()
HAL_SMARTCARD_RxCpltCallback()
HAL_SMARTCARD_ErrorCallback()
Peripheral State and Errors functions
This subsection provides a set of functions allowing to control the SmartCard.


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.
This section contains the following APIs:


39.2.5
39.2.6
39.2.7
HAL_SMARTCARD_GetState()
HAL_SMARTCARD_GetError()
HAL_SMARTCARD_Init
Function Name
HAL_StatusTypeDef HAL_SMARTCARD_Init
(SMARTCARD_HandleTypeDef * hsc)
Function Description
Initializes the SmartCard mode according to the specified
parameters in the SMARTCARD_InitTypeDef and create the
associated handle .
Parameters

hsc: pointer to a SMARTCARD_HandleTypeDef structure
that contains the configuration information for SMARTCARD
module.
Return values

HAL status
HAL_SMARTCARD_DeInit
Function Name
HAL_StatusTypeDef HAL_SMARTCARD_DeInit
(SMARTCARD_HandleTypeDef * hsc)
Function Description
DeInitializes the USART SmartCard peripheral.
Parameters

hsc: pointer to a SMARTCARD_HandleTypeDef structure
that contains the configuration information for SMARTCARD
module.
Return values

HAL status
HAL_SMARTCARD_MspInit
Function Name
void HAL_SMARTCARD_MspInit
DOCID028236 Rev 1
535/692
HAL SMARTCARD Generic Driver
UM1940
(SMARTCARD_HandleTypeDef * hsc)
39.2.8
39.2.9
Function Description
SMARTCARD MSP Init.
Parameters

hsc: pointer to a SMARTCARD_HandleTypeDef structure
that contains the configuration information for SMARTCARD
module.
Return values

None
HAL_SMARTCARD_MspDeInit
Function Name
void HAL_SMARTCARD_MspDeInit
(SMARTCARD_HandleTypeDef * hsc)
Function Description
SMARTCARD MSP DeInit.
Parameters

hsc: pointer to a SMARTCARD_HandleTypeDef structure
that contains the configuration information for SMARTCARD
module.
Return values

None
HAL_SMARTCARD_ReInit
Function Name
HAL_StatusTypeDef HAL_SMARTCARD_ReInit
(SMARTCARD_HandleTypeDef * hsc)
Function Description
39.2.10
HAL_SMARTCARD_Transmit
Function Name
HAL_StatusTypeDef HAL_SMARTCARD_Transmit
(SMARTCARD_HandleTypeDef * hsc, uint8_t * pData, uint16_t
Size, uint32_t Timeout)
Function Description
Send an amount of data in blocking mode.
Parameters

Return values
39.2.11



hsc: pointer to a SMARTCARD_HandleTypeDef structure
that contains the configuration information for SMARTCARD
module.
pData: pointer to data buffer
Size: amount of data to be sent
Timeout: Timeout duration

HAL status
HAL_SMARTCARD_Receive
Function Name
HAL_StatusTypeDef HAL_SMARTCARD_Receive
(SMARTCARD_HandleTypeDef * hsc, uint8_t * pData, uint16_t
Size, uint32_t Timeout)
Function Description
Receive an amount of data in blocking mode.
Parameters



536/692
hsc: pointer to a SMARTCARD_HandleTypeDef structure
that contains the configuration information for SMARTCARD
module.
pData: pointer to data buffer
Size: amount of data to be received
DOCID028236 Rev 1
UM1940
HAL SMARTCARD Generic Driver
Return values
39.2.12
HAL status
HAL_StatusTypeDef HAL_SMARTCARD_Transmit_IT
(SMARTCARD_HandleTypeDef * hsc, uint8_t * pData, uint16_t
Size)
Function Description
Send an amount of data in non blocking mode.
Parameters



hsc: pointer to a SMARTCARD_HandleTypeDef structure
that contains the configuration information for SMARTCARD
module.
pData: pointer to data buffer
Size: amount of data to be sent

HAL status
HAL_SMARTCARD_Receive_IT
Function Name
HAL_StatusTypeDef HAL_SMARTCARD_Receive_IT
(SMARTCARD_HandleTypeDef * hsc, uint8_t * pData, uint16_t
Size)
Function Description
Receive an amount of data in non blocking mode.
Parameters



hsc: pointer to a SMARTCARD_HandleTypeDef structure
that contains the configuration information for SMARTCARD
module.
pData: pointer to data buffer
Size: amount of data to be received

HAL status
HAL_SMARTCARD_Transmit_DMA
Function Name
HAL_StatusTypeDef HAL_SMARTCARD_Transmit_DMA
(SMARTCARD_HandleTypeDef * hsc, uint8_t * pData, uint16_t
Size)
Function Description
Send an amount of data in non blocking mode.
Parameters

Return values
39.2.15

Function Name
Return values
39.2.14
Timeout: Timeout duration
HAL_SMARTCARD_Transmit_IT
Return values
39.2.13



hsc: pointer to a SMARTCARD_HandleTypeDef structure
that contains the configuration information for SMARTCARD
module.
pData: pointer to data buffer
Size: amount of data to be sent

HAL status
HAL_SMARTCARD_Receive_DMA
Function Name
HAL_StatusTypeDef HAL_SMARTCARD_Receive_DMA
(SMARTCARD_HandleTypeDef * hsc, uint8_t * pData, uint16_t
Size)
Function Description
Receive an amount of data in non blocking mode.
DOCID028236 Rev 1
537/692
HAL SMARTCARD Generic Driver
Parameters
39.2.16
39.2.17
39.2.18
39.2.19
538/692
UM1940



hsc: pointer to a SMARTCARD_HandleTypeDef structure
that contains the configuration information for SMARTCARD
module.
pData: pointer to data buffer
Size: amount of data to be received
Return values

HAL status
Notes

When the SMARTCARD parity is enabled (PCE = 1) the data
received contain the parity bit.s
HAL_SMARTCARD_IRQHandler
Function Name
void HAL_SMARTCARD_IRQHandler
(SMARTCARD_HandleTypeDef * hsc)
Function Description
This function handles SMARTCARD interrupt request.
Parameters

hsc: pointer to a SMARTCARD_HandleTypeDef structure
that contains the configuration information for SMARTCARD
module.
Return values

None
HAL_SMARTCARD_TxCpltCallback
Function Name
void HAL_SMARTCARD_TxCpltCallback
(SMARTCARD_HandleTypeDef * hsc)
Function Description
Tx Transfer completed callbacks.
Parameters

hsc: pointer to a SMARTCARD_HandleTypeDef structure
that contains the configuration information for SMARTCARD
module.
Return values

None
HAL_SMARTCARD_RxCpltCallback
Function Name
void HAL_SMARTCARD_RxCpltCallback
(SMARTCARD_HandleTypeDef * hsc)
Function Description
Rx Transfer completed callbacks.
Parameters

hsc: pointer to a SMARTCARD_HandleTypeDef structure
that contains the configuration information for SMARTCARD
module.
Return values

None
HAL_SMARTCARD_ErrorCallback
Function Name
void HAL_SMARTCARD_ErrorCallback
(SMARTCARD_HandleTypeDef * hsc)
Function Description
SMARTCARD error callbacks.
Parameters

hsc: pointer to a SMARTCARD_HandleTypeDef structure
that contains the configuration information for SMARTCARD
module.
DOCID028236 Rev 1
UM1940
HAL SMARTCARD Generic Driver
Return values
39.2.20
39.2.21

None
HAL_SMARTCARD_GetState
Function Name
HAL_SMARTCARD_StateTypeDef
HAL_SMARTCARD_GetState (SMARTCARD_HandleTypeDef *
hsc)
Function Description
return the SMARTCARD state
Parameters

hsc: pointer to a SMARTCARD_HandleTypeDef structure
that contains the configuration information for SMARTCARD
module.
Return values

HAL state
HAL_SMARTCARD_GetError
Function Name
uint32_t HAL_SMARTCARD_GetError
(SMARTCARD_HandleTypeDef * hsc)
Function Description
Return the SMARTCARD error code.
Parameters

hsc: : pointer to a SMARTCARD_HandleTypeDef structure
that contains the configuration information for the specified
SMARTCARD.
Return values

SMARTCARD Error Code
39.3
SMARTCARD Firmware driver defines
39.3.1
SMARTCARD
SMARTCARD Clock Phase
SMARTCARD_PHASE_1EDGE
SMARTCARD_PHASE_2EDGE
SMARTCARD Clock Polarity
SMARTCARD_POLARITY_LOW
SMARTCARD_POLARITY_HIGH
SMARTCARD DMA requests
SMARTCARD_DMAREQ_TX
SMARTCARD_DMAREQ_RX
SMARTCARD Error Code
HAL_SMARTCARD_ERROR_NONE
No error
HAL_SMARTCARD_ERROR_PE
Parity error
HAL_SMARTCARD_ERROR_NE
Noise error
HAL_SMARTCARD_ERROR_FE
Frame error
HAL_SMARTCARD_ERROR_ORE
Overrun error
HAL_SMARTCARD_ERROR_DMA
DMA transfer error
DOCID028236 Rev 1
539/692
HAL SMARTCARD Generic Driver
SMARTCARD Exported Macros
__HAL_SMARTCARD_RESET_HANDLE_STA
TE
UM1940
Description:

Reset SMARTCARD handle state.
Parameters:

__HANDLE__: specifies the
SMARTCARD Handle.
Return value:

__HAL_SMARTCARD_FLUSH_DRREGISTER
None
Description:

Flushes the Smartcard DR
register.
Parameters:

__HAL_SMARTCARD_GET_FLAG
__HANDLE__: specifies the
SMARTCARD Handle.
Description:

Checks whether the specified
Smartcard flag is set or not.
Parameters:


__HANDLE__: specifies the
SMARTCARD Handle.
__FLAG__: specifies the flag to
check. This parameter can be one
of the following values:

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_IDLE:
Idle Line detection 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_CLEAR_FLAG
540/692
DOCID028236 Rev 1
The: new state of __FLAG__
(TRUE or FALSE).
Description:
UM1940
HAL SMARTCARD Generic Driver

Clears the specified Smartcard
pending flags.
Parameters:


__HANDLE__: specifies the
SMARTCARD Handle.
__FLAG__: specifies the flag to
check. This parameter can be any
combination of the following
values:

SMARTCARD_FLAG_TC:
Transmission Complete flag.

SMARTCARD_FLAG_RXNE:
Receive data register not
empty flag.
Notes:

__HAL_SMARTCARD_CLEAR_PEFLAG
PE (Parity error), FE (Framing
error), NE (Noise error) and ORE
(Overrun error) flags are cleared
by software sequence: a read
operation to USART_SR register
followed by a read operation to
USART_DR register. RXNE flag
can be also cleared by a read to
the USART_DR register. TC flag
can be also cleared by software
sequence: a read operation to
USART_SR register followed by a
write operation to USART_DR
register. TXE flag is cleared only
by a write to the USART_DR
register.
Description:

Clear the SMARTCARD PE
pending flag.
Parameters:

__HANDLE__: specifies the
USART Handle. This parameter
can be USARTx where x: 1, 2, 3,
4, 5, 6, 7 or 8 to select the USART
or UART peripheral.
Return value:

__HAL_SMARTCARD_CLEAR_FEFLAG
None
Description:

Clear the SMARTCARD FE
pending flag.
Parameters:

DOCID028236 Rev 1
__HANDLE__: specifies the
USART Handle. This parameter
541/692
HAL SMARTCARD Generic Driver
UM1940
can be USARTx where x: 1, 2, 3,
4, 5, 6, 7 or 8 to select the USART
or UART peripheral.
Return value:

__HAL_SMARTCARD_CLEAR_NEFLAG
None
Description:

Clear the SMARTCARD NE
pending flag.
Parameters:

__HANDLE__: specifies the
USART Handle. This parameter
can be USARTx where x: 1, 2, 3,
4, 5, 6, 7 or 8 to select the USART
or UART peripheral.
Return value:

__HAL_SMARTCARD_CLEAR_OREFLAG
None
Description:

Clear the SMARTCARD ORE
pending flag.
Parameters:

__HANDLE__: specifies the
USART Handle. This parameter
can be USARTx where x: 1, 2, 3,
4, 5, 6, 7 or 8 to select the USART
or UART peripheral.
Return value:

__HAL_SMARTCARD_CLEAR_IDLEFLAG
None
Description:

Clear the SMARTCARD IDLE
pending flag.
Parameters:

__HANDLE__: specifies the
USART Handle. This parameter
can be USARTx where x: 1, 2, 3,
4, 5, 6, 7 or 8 to select the USART
or UART peripheral.
Return value:

__HAL_SMARTCARD_ENABLE_IT
None
Description:

Enables or disables the specified
SmartCard interrupts.
Parameters:
542/692
DOCID028236 Rev 1
UM1940
HAL SMARTCARD Generic Driver


__HANDLE__: specifies the
SMARTCARD Handle.
__INTERRUPT__: specifies the
SMARTCARD interrupt source to
check. This parameter can be one
of the following values:

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_IDLE: Idle
line detection interrupt

SMARTCARD_IT_PE: Parity
Error interrupt

SMARTCARD_IT_ERR: Error
interrupt(Frame error, noise
error, overrun error)
__HAL_SMARTCARD_DISABLE_IT
__HAL_SMARTCARD_GET_IT_SOURCE
Description:

Checks whether the specified
SmartCard interrupt has occurred
or not.
Parameters:


__HANDLE__: specifies the
SmartCard Handle.
__IT__: specifies the
SMARTCARD interrupt source to
check. This parameter can be one
of the following values:

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_IDLE: Idle
line detection interrupt

SMARTCARD_IT_ERR: Error
interrupt

SMARTCARD_IT_PE: Parity
Error interrupt
Return value:

DOCID028236 Rev 1
The: new state of __IT__ (TRUE or
543/692
HAL SMARTCARD Generic Driver
UM1940
FALSE).
__HAL_SMARTCARD_ONE_BIT_SAMPLE_EN
ABLE
Description:

Macro to enable the
SMARTCARD's one bit sample
method.
Parameters:

__HANDLE__: specifies the
SMARTCARD Handle.
Return value:

__HAL_SMARTCARD_ONE_BIT_SAMPLE_DI
SABLE
None
Description:

Macro to disable the
SMARTCARD's one bit sample
method.
Parameters:

__HANDLE__: specifies the
SMARTCARD Handle.
Return value:

__HAL_SMARTCARD_ENABLE
None
Description:

Enable the USART associated to
the SMARTCARD Handle.
Parameters:

__HANDLE__: specifies the
SMARTCARD Handle.
SMARTCARD Handle selects the
USARTx peripheral (USART
availability and x value depending
on device).
Return value:

__HAL_SMARTCARD_DISABLE
None
Description:

Disable the USART associated to
the SMARTCARD Handle.
Parameters:

__HANDLE__: specifies the
SMARTCARD Handle.
SMARTCARD Handle selects the
USARTx peripheral (USART
availability and x value depending
on device).
Return value:
544/692
DOCID028236 Rev 1
UM1940
HAL SMARTCARD Generic Driver

__HAL_SMARTCARD_DMA_REQUEST_ENAB
LE
None
Description:

Macros to enable or disable the
SmartCard DMA request.
Parameters:


__HANDLE__: specifies the
SmartCard Handle.
__REQUEST__: specifies the
SmartCard DMA request. This
parameter can be one of the
following values:

SMARTCARD_DMAREQ_TX:
SmartCard DMA transmit
request

SMARTCARD_DMAREQ_RX
: SmartCard DMA receive
request
__HAL_SMARTCARD_DMA_REQUEST_DISA
BLE
SMARTCARD Flags
SMARTCARD_FLAG_TXE
SMARTCARD_FLAG_TC
SMARTCARD_FLAG_RXNE
SMARTCARD_FLAG_IDLE
SMARTCARD_FLAG_ORE
SMARTCARD_FLAG_NE
SMARTCARD_FLAG_FE
SMARTCARD_FLAG_PE
SMARTCARD Interrupts Definition
SMARTCARD_IT_PE
SMARTCARD_IT_TXE
SMARTCARD_IT_TC
SMARTCARD_IT_RXNE
SMARTCARD_IT_IDLE
SMARTCARD_IT_ERR
SMARTCARD Last Bit
SMARTCARD_LASTBIT_DISABLE
SMARTCARD_LASTBIT_ENABLE
SMARTCARD Mode
SMARTCARD_MODE_RX
SMARTCARD_MODE_TX
DOCID028236 Rev 1
545/692
HAL SMARTCARD Generic Driver
SMARTCARD_MODE_TX_RX
UM1940
SMARTCARD NACK State
SMARTCARD_NACK_ENABLE
SMARTCARD_NACK_DISABLE
SMARTCARD Parity
SMARTCARD_PARITY_EVEN
SMARTCARD_PARITY_ODD
SMARTCARD Prescaler
546/692
SMARTCARD_PRESCALER_SYSCLK_DIV2
SYSCLK divided by 2
SMARTCARD_PRESCALER_SYSCLK_DIV4
SYSCLK divided by 4
SMARTCARD_PRESCALER_SYSCLK_DIV6
SYSCLK divided by 6
SMARTCARD_PRESCALER_SYSCLK_DIV8
SYSCLK divided by 8
SMARTCARD_PRESCALER_SYSCLK_DIV10
SYSCLK divided by 10
SMARTCARD_PRESCALER_SYSCLK_DIV12
SYSCLK divided by 12
SMARTCARD_PRESCALER_SYSCLK_DIV14
SYSCLK divided by 14
SMARTCARD_PRESCALER_SYSCLK_DIV16
SYSCLK divided by 16
SMARTCARD_PRESCALER_SYSCLK_DIV18
SYSCLK divided by 18
SMARTCARD_PRESCALER_SYSCLK_DIV20
SYSCLK divided by 20
SMARTCARD_PRESCALER_SYSCLK_DIV22
SYSCLK divided by 22
SMARTCARD_PRESCALER_SYSCLK_DIV24
SYSCLK divided by 24
SMARTCARD_PRESCALER_SYSCLK_DIV26
SYSCLK divided by 26
SMARTCARD_PRESCALER_SYSCLK_DIV28
SYSCLK divided by 28
SMARTCARD_PRESCALER_SYSCLK_DIV30
SYSCLK divided by 30
SMARTCARD_PRESCALER_SYSCLK_DIV32
SYSCLK divided by 32
SMARTCARD_PRESCALER_SYSCLK_DIV34
SYSCLK divided by 34
SMARTCARD_PRESCALER_SYSCLK_DIV36
SYSCLK divided by 36
SMARTCARD_PRESCALER_SYSCLK_DIV38
SYSCLK divided by 38
SMARTCARD_PRESCALER_SYSCLK_DIV40
SYSCLK divided by 40
SMARTCARD_PRESCALER_SYSCLK_DIV42
SYSCLK divided by 42
SMARTCARD_PRESCALER_SYSCLK_DIV44
SYSCLK divided by 44
SMARTCARD_PRESCALER_SYSCLK_DIV46
SYSCLK divided by 46
SMARTCARD_PRESCALER_SYSCLK_DIV48
SYSCLK divided by 48
SMARTCARD_PRESCALER_SYSCLK_DIV50
SYSCLK divided by 50
SMARTCARD_PRESCALER_SYSCLK_DIV52
SYSCLK divided by 52
SMARTCARD_PRESCALER_SYSCLK_DIV54
SYSCLK divided by 54
SMARTCARD_PRESCALER_SYSCLK_DIV56
SYSCLK divided by 56
DOCID028236 Rev 1
UM1940
SMARTCARD_PRESCALER_SYSCLK_DIV58
HAL SMARTCARD Generic Driver
SYSCLK divided by 58
SMARTCARD_PRESCALER_SYSCLK_DIV60
SYSCLK divided by 60
SMARTCARD_PRESCALER_SYSCLK_DIV62
SYSCLK divided by 62
SMARTCARD Private Constants
SMARTCARD_TIMEOUT_VALUE
SMARTCARD_IT_MASK
SMARTCARD_DIV
SMARTCARD_DIVMANT
SMARTCARD_DIVFRAQ
SMARTCARD_BRR
SMARTCARD_CR1_REG_INDEX
SMARTCARD_CR3_REG_INDEX
SMARTCARD Private Macros
IS_SMARTCARD_WORD_LENGTH
IS_SMARTCARD_STOPBITS
IS_SMARTCARD_PARITY
IS_SMARTCARD_MODE
IS_SMARTCARD_POLARITY
IS_SMARTCARD_PHASE
IS_SMARTCARD_LASTBIT
IS_SMARTCARD_NACK_STATE
IS_SMARTCARD_BAUDRATE
SMARTCARD Number of Stop Bits
SMARTCARD_STOPBITS_0_5
SMARTCARD_STOPBITS_1_5
SMARTCARD Word Length
SMARTCARD_WORDLENGTH_9B
DOCID028236 Rev 1
547/692
HAL SPI Generic Driver
UM1940
40
HAL SPI Generic Driver
40.1
SPI Firmware driver registers structures
40.1.1
SPI_InitTypeDef
Data Fields











uint32_t Mode
uint32_t Direction
uint32_t DataSize
uint32_t CLKPolarity
uint32_t CLKPhase
uint32_t NSS
uint32_t BaudRatePrescaler
uint32_t FirstBit
uint32_t TIMode
uint32_t CRCCalculation
uint32_t CRCPolynomial
Field Documentation









548/692
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 Directional mode state. This parameter can be a value of
SPI_Direction_mode
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
DOCID028236 Rev 1
UM1940
HAL SPI Generic Driver


40.1.2
uint32_t SPI_InitTypeDef::CRCCalculation
Specifies if the CRC calculation is enabled or not. This parameter can be a value of
SPI_CRC_Calculation
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
__SPI_HandleTypeDef
Data Fields















SPI_TypeDef * Instance
SPI_InitTypeDef Init
uint8_t * pTxBuffPtr
uint16_t TxXferSize
uint16_t TxXferCount
uint8_t * pRxBuffPtr
uint16_t RxXferSize
uint16_t RxXferCount
DMA_HandleTypeDef * hdmatx
DMA_HandleTypeDef * hdmarx
void(* RxISR
void(* TxISR
HAL_LockTypeDef Lock
__IO HAL_SPI_StateTypeDef State
__IO uint32_t ErrorCode
Field Documentation















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
DMA_HandleTypeDef* __SPI_HandleTypeDef::hdmatx
DMA_HandleTypeDef* __SPI_HandleTypeDef::hdmarx
void(* __SPI_HandleTypeDef::RxISR)(struct __SPI_HandleTypeDef *hspi)
void(* __SPI_HandleTypeDef::TxISR)(struct __SPI_HandleTypeDef *hspi)
HAL_LockTypeDef __SPI_HandleTypeDef::Lock
__IO HAL_SPI_StateTypeDef __SPI_HandleTypeDef::State
__IO uint32_t __SPI_HandleTypeDef::ErrorCode
DOCID028236 Rev 1
549/692
HAL SPI Generic Driver
UM1940
40.2
SPI Firmware driver API description
40.2.1
How to use this driver
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 implementing 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.
NVIC configuration if you need to use interrupt process

Configure the SPIx interrupt priority

Enable the NVIC SPI IRQ handle
d.
DMA Configuration if you need to use DMA process

Declare a DMA_HandleTypeDef handle structure for the transmit or receive
stream

Enable the DMAx interface clock using

Configure the DMA handle parameters

Configure the DMA Tx or Rx Stream

Associate the initialized hdma_tx handle to the hspi DMA Tx or Rx handle

Configure the priority and enable the NVIC for the transfer complete
interrupt on the DMA Tx or Rx Stream
Program the Mode, Direction , 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:

This API configures also the low level Hardware GPIO, CLOCK, CORTEX...etc)
by calling the customized HAL_SPI_MspInit() API.
Circular mode restriction:
1.
2.
3.
40.2.2
The DMA circular mode cannot be used when the SPI is configured in these modes:
a.
Master 2Lines RxOnly
b.
Master 1Line Rx
The CRC feature is not managed when the DMA circular mode is enabled
When the SPI DMA Pause/Stop features are used, we must use the following APIs
the HAL_SPI_DMAPause()/ HAL_SPI_DMAStop() only under the SPI callbacks
Initialization and de-initialization functions
This subsection provides a set of functions allowing to initialize and de-initialize the SPIx
peripheral:


550/692
User must implement HAL_SPI_MspInit() function in which he configures all related
peripherals resources (CLOCK, GPIO, DMA, IT and NVIC ).
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
DOCID028236 Rev 1
UM1940
HAL SPI Generic Driver


CRC Calculation

CRC Polynomial if CRC enabled
Call the function HAL_SPI_DeInit() to restore the default configuration of the selected
SPIx peripheral.
This section contains the following APIs:




40.2.3
HAL_SPI_Init()
HAL_SPI_DeInit()
HAL_SPI_MspInit()
HAL_SPI_MspDeInit()
IO operation functions
The SPI supports master and slave mode :
1.
2.
There are two modes of transfer:

Blocking mode: The communication is performed in polling mode. The HAL
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 APIs return the HAL status. The end of the data processing will be
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 respectively at the end of the transmit or Receive process The
HAL_SPI_ErrorCallback()user callback will be executed when a communication
error is detected
APIs provided for these 2 transfer modes (Blocking mode or Non blocking mode
using either Interrupt or DMA) exist for 1Line (simplex) and 2Lines (full duplex) modes.
This section contains the following APIs:




















40.2.4
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_TxCpltCallback()
HAL_SPI_RxCpltCallback()
HAL_SPI_TxRxCpltCallback()
HAL_SPI_TxHalfCpltCallback()
HAL_SPI_RxHalfCpltCallback()
HAL_SPI_TxRxHalfCpltCallback()
HAL_SPI_ErrorCallback()
Peripheral State and Errors functions
This subsection provides a set of functions allowing to control the SPI.
DOCID028236 Rev 1
551/692
HAL SPI Generic Driver


UM1940
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
This section contains the following APIs:


40.2.5
40.2.6
40.2.7
40.2.8
40.2.9
552/692
HAL_SPI_GetState()
HAL_SPI_GetError()
HAL_SPI_Init
Function Name
HAL_StatusTypeDef HAL_SPI_Init (SPI_HandleTypeDef * hspi)
Function Description
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
HAL_SPI_DeInit
Function Name
HAL_StatusTypeDef HAL_SPI_DeInit (SPI_HandleTypeDef *
hspi)
Function Description
DeInitializes the SPI peripheral.
Parameters

hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
Return values

HAL status
HAL_SPI_MspInit
Function Name
void HAL_SPI_MspInit (SPI_HandleTypeDef * hspi)
Function Description
SPI MSP Init.
Parameters

hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
Return values

None
HAL_SPI_MspDeInit
Function Name
void HAL_SPI_MspDeInit (SPI_HandleTypeDef * hspi)
Function Description
SPI MSP DeInit.
Parameters

hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
Return values

None
HAL_SPI_Transmit
Function Name
HAL_StatusTypeDef HAL_SPI_Transmit (SPI_HandleTypeDef *
hspi, uint8_t * pData, uint16_t Size, uint32_t Timeout)
Function Description
Transmit an amount of data in blocking mode.
DOCID028236 Rev 1
UM1940
HAL SPI Generic Driver
Parameters
Return values
40.2.10
HAL status
HAL_StatusTypeDef HAL_SPI_Receive (SPI_HandleTypeDef *
hspi, uint8_t * pData, uint16_t Size, uint32_t Timeout)
Function Description
Receive an amount of data in blocking mode.
Parameters




hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
pData: pointer to data buffer
Size: amount of data to be sent
Timeout: Timeout duration

HAL status
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)
Function Description
Transmit and Receive an amount of data in blocking mode.
Parameters





hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
pTxData: pointer to transmission data buffer
pRxData: pointer to reception data buffer to be
Size: amount of data to be sent
Timeout: Timeout duration

HAL status
HAL_SPI_Transmit_IT
Function Name
HAL_StatusTypeDef HAL_SPI_Transmit_IT
(SPI_HandleTypeDef * hspi, uint8_t * pData, uint16_t Size)
Function Description
Transmit an amount of data in no-blocking mode with Interrupt.
Parameters

Return values
40.2.13

Function Name
Return values
40.2.12



hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
pData: pointer to data buffer
Size: amount of data to be sent
Timeout: Timeout duration
HAL_SPI_Receive
Return values
40.2.11



hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
pData: pointer to data buffer
Size: amount of data to be sent

HAL status
HAL_SPI_Receive_IT
Function Name
HAL_StatusTypeDef HAL_SPI_Receive_IT
(SPI_HandleTypeDef * hspi, uint8_t * pData, uint16_t Size)
DOCID028236 Rev 1
553/692
HAL SPI Generic Driver
Function Description
Parameters
Return values
40.2.14
40.2.17
554/692


hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
pData: pointer to data buffer
Size: amount of data to be sent

HAL status
Function Name
HAL_StatusTypeDef HAL_SPI_TransmitReceive_IT
(SPI_HandleTypeDef * hspi, uint8_t * pTxData, uint8_t *
pRxData, uint16_t Size)
Function Description
Transmit and Receive an amount of data in no-blocking mode with
Interrupt.
Parameters




hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
pTxData: pointer to transmission data buffer
pRxData: pointer to reception data buffer to be
Size: amount of data to be sent

HAL status
HAL_SPI_Transmit_DMA
Function Name
HAL_StatusTypeDef HAL_SPI_Transmit_DMA
(SPI_HandleTypeDef * hspi, uint8_t * pData, uint16_t Size)
Function Description
Transmit an amount of data in no-blocking mode with DMA.
Parameters

Return values
40.2.16

HAL_SPI_TransmitReceive_IT
Return values
40.2.15
UM1940
Receive an amount of data in no-blocking mode with Interrupt.


hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
pData: pointer to data buffer
Size: amount of data to be sent

HAL status
HAL_SPI_Receive_DMA
Function Name
HAL_StatusTypeDef HAL_SPI_Receive_DMA
(SPI_HandleTypeDef * hspi, uint8_t * pData, uint16_t Size)
Function Description
Receive an amount of data in no-blocking mode with DMA.
Parameters



hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
pData: pointer to data buffer
Size: amount of data to be sent
Return values

HAL status
Notes

When the CRC feature is enabled the pData Length must be
Size + 1.
HAL_SPI_TransmitReceive_DMA
DOCID028236 Rev 1
UM1940
Function Name
40.2.18
40.2.19
40.2.20
40.2.21
HAL SPI Generic Driver
HAL_StatusTypeDef HAL_SPI_TransmitReceive_DMA
(SPI_HandleTypeDef * hspi, uint8_t * pTxData, uint8_t *
pRxData, uint16_t Size)
Function Description
Transmit and Receive an amount of data in no-blocking mode with
DMA.
Parameters




hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
pTxData: pointer to transmission data buffer
pRxData: pointer to reception data buffer
Size: amount of data to be sent
Return values

HAL status
Notes

When the CRC feature is enabled the pRxData Length must
be Size + 1
HAL_SPI_DMAPause
Function Name
HAL_StatusTypeDef HAL_SPI_DMAPause
(SPI_HandleTypeDef * hspi)
Function Description
Pauses the DMA Transfer.
Parameters

hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for the specified SPI module.
Return values

HAL status
HAL_SPI_DMAResume
Function Name
HAL_StatusTypeDef HAL_SPI_DMAResume
(SPI_HandleTypeDef * hspi)
Function Description
Resumes the DMA Transfer.
Parameters

hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for the specified SPI module.
Return values

HAL status
HAL_SPI_DMAStop
Function Name
HAL_StatusTypeDef HAL_SPI_DMAStop (SPI_HandleTypeDef
* hspi)
Function Description
Stops the DMA Transfer.
Parameters

hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for the specified SPI module.
Return values

HAL status
HAL_SPI_IRQHandler
Function Name
void HAL_SPI_IRQHandler (SPI_HandleTypeDef * hspi)
Function Description
This function handles SPI interrupt request.
Parameters

hspi: pointer to a SPI_HandleTypeDef structure that contains
DOCID028236 Rev 1
555/692
HAL SPI Generic Driver
UM1940
the configuration information for SPI module.
Return values
40.2.22
40.2.23
40.2.24
40.2.25
40.2.26
40.2.27
556/692

HAL status
HAL_SPI_TxCpltCallback
Function Name
void HAL_SPI_TxCpltCallback (SPI_HandleTypeDef * hspi)
Function Description
Tx Transfer completed callbacks.
Parameters

hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
Return values

None
HAL_SPI_RxCpltCallback
Function Name
void HAL_SPI_RxCpltCallback (SPI_HandleTypeDef * hspi)
Function Description
Rx Transfer completed callbacks.
Parameters

hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
Return values

None
HAL_SPI_TxRxCpltCallback
Function Name
void HAL_SPI_TxRxCpltCallback (SPI_HandleTypeDef * hspi)
Function Description
Tx and Rx Transfer completed callbacks.
Parameters

hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
Return values

None
HAL_SPI_TxHalfCpltCallback
Function Name
void HAL_SPI_TxHalfCpltCallback (SPI_HandleTypeDef * hspi)
Function Description
Tx Half Transfer completed callbacks.
Parameters

hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
Return values

None
HAL_SPI_RxHalfCpltCallback
Function Name
void HAL_SPI_RxHalfCpltCallback (SPI_HandleTypeDef *
hspi)
Function Description
Rx Half Transfer completed callbacks.
Parameters

hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
Return values

None
HAL_SPI_TxRxHalfCpltCallback
DOCID028236 Rev 1
UM1940
40.2.28
40.2.29
40.2.30
Function Name
HAL SPI Generic Driver
void HAL_SPI_TxRxHalfCpltCallback (SPI_HandleTypeDef *
hspi)
Function Description
Tx and Rx Transfer completed callbacks.
Parameters

hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
Return values

None
HAL_SPI_ErrorCallback
Function Name
void HAL_SPI_ErrorCallback (SPI_HandleTypeDef * hspi)
Function Description
SPI error callbacks.
Parameters

hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
Return values

None
HAL_SPI_GetState
Function Name
HAL_SPI_StateTypeDef HAL_SPI_GetState
(SPI_HandleTypeDef * hspi)
Function Description
Return the SPI state.
Parameters

hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
Return values

HAL state
HAL_SPI_GetError
Function Name
uint32_t HAL_SPI_GetError (SPI_HandleTypeDef * hspi)
Function Description
Return the SPI error code.
Parameters

hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
Return values

SPI Error Code
40.3
SPI Firmware driver defines
40.3.1
SPI
SPI BaudRate Prescaler
SPI_BAUDRATEPRESCALER_2
SPI_BAUDRATEPRESCALER_4
SPI_BAUDRATEPRESCALER_8
SPI_BAUDRATEPRESCALER_16
SPI_BAUDRATEPRESCALER_32
SPI_BAUDRATEPRESCALER_64
SPI_BAUDRATEPRESCALER_128
DOCID028236 Rev 1
557/692
HAL SPI Generic Driver
SPI_BAUDRATEPRESCALER_256
UM1940
SPI Clock Phase
SPI_PHASE_1EDGE
SPI_PHASE_2EDGE
SPI Clock Polarity
SPI_POLARITY_LOW
SPI_POLARITY_HIGH
SPI CRC Calculation
SPI_CRCCALCULATION_DISABLE
SPI_CRCCALCULATION_ENABLE
SPI Data Size
SPI_DATASIZE_8BIT
SPI_DATASIZE_16BIT
SPI Direction Mode
SPI_DIRECTION_2LINES
SPI_DIRECTION_2LINES_RXONLY
SPI_DIRECTION_1LINE
SPI Error Code
HAL_SPI_ERROR_NONE
No error
HAL_SPI_ERROR_MODF
MODF error
HAL_SPI_ERROR_CRC
CRC error
HAL_SPI_ERROR_OVR
OVR error
HAL_SPI_ERROR_FRE
FRE error
HAL_SPI_ERROR_DMA
DMA transfer error
HAL_SPI_ERROR_FLAG
Flag: RXNE,TXE, BSY
SPI Exported Macros
__HAL_SPI_RESET_HANDLE_STATE
Description:

Reset SPI handle state.
Parameters:

__HANDLE__: specifies the SPI handle.
This parameter can be SPI where x: 1, 2, or
3 to select the SPI peripheral.
Return value:

__HAL_SPI_ENABLE_IT
Description:

558/692
None
Enable or disable the specified SPI
interrupts.
DOCID028236 Rev 1
UM1940
HAL SPI Generic Driver
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
source to enable or disable. This parameter
can be one of the following values:

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:

Check if the specified SPI interrupt source is
enabled or disabled.
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 SPI
interrupt source to check. This parameter
can be one of the following values:

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
The: new state of __IT__ (TRUE or FALSE).
Description:

Check whether the specified SPI flag is set
or not.
Parameters:


__HANDLE__: specifies the SPI handle.
This parameter can be SPI where x: 1, 2, or
3 to select the SPI peripheral.
__FLAG__: specifies the flag to check. This
parameter can be one of the following
values:

SPI_FLAG_RXNE: Receive buffer not
empty flag

SPI_FLAG_TXE: Transmit buffer
empty flag

SPI_FLAG_CRCERR: CRC error flag
DOCID028236 Rev 1
559/692
HAL SPI Generic Driver
UM1940




SPI_FLAG_MODF: Mode fault flag
SPI_FLAG_OVR: Overrun flag
SPI_FLAG_BSY: Busy flag
SPI_FLAG_FRE: Frame format error
flag
Return value:

__HAL_SPI_CLEAR_CRCERRFLAG
The: new state of __FLAG__ (TRUE or
FALSE).
Description:

Clear the SPI CRCERR pending flag.
Parameters:

__HANDLE__: specifies the SPI handle.
This parameter can be SPI where x: 1, 2, or
3 to select the SPI peripheral.
Return value:

__HAL_SPI_CLEAR_MODFFLAG
None
Description:

Clear the SPI MODF pending flag.
Parameters:

__HANDLE__: specifies the SPI handle.
This parameter can be SPI where x: 1, 2, or
3 to select the SPI peripheral.
Return value:

__HAL_SPI_CLEAR_OVRFLAG
None
Description:

Clear the SPI OVR pending flag.
Parameters:

__HANDLE__: specifies the SPI handle.
This parameter can be SPI where x: 1, 2, or
3 to select the SPI peripheral.
Return value:

__HAL_SPI_CLEAR_FREFLAG
None
Description:

Clear the SPI FRE pending flag.
Parameters:

__HANDLE__: specifies the SPI handle.
This parameter can be SPI where x: 1, 2, or
3 to select the SPI peripheral.
Return value:

560/692
None
DOCID028236 Rev 1
UM1940
HAL SPI Generic Driver
Description:
__HAL_SPI_ENABLE

Enable SPI.
Parameters:

__HANDLE__: specifies the SPI Handle.
Return value:

None
Description:
__HAL_SPI_DISABLE

Disable SPI.
Parameters:

__HANDLE__: specifies the SPI Handle.
Return value:

None
SPI Flags Definition
SPI_FLAG_RXNE
SPI_FLAG_TXE
SPI_FLAG_CRCERR
SPI_FLAG_MODF
SPI_FLAG_OVR
SPI_FLAG_BSY
SPI_FLAG_FRE
SPI Interrupt Definition
SPI_IT_TXE
SPI_IT_RXNE
SPI_IT_ERR
SPI Mode
SPI_MODE_SLAVE
SPI_MODE_MASTER
SPI MSB LSB Transsmission
SPI_FIRSTBIT_MSB
SPI_FIRSTBIT_LSB
SPI Private Macros
IS_SPI_MODE
IS_SPI_DIRECTION_MODE
IS_SPI_DIRECTION_2LINES_OR_1LINE
IS_SPI_DIRECTION_2LINES
IS_SPI_DATASIZE
DOCID028236 Rev 1
561/692
HAL SPI Generic Driver
IS_SPI_CPOL
UM1940
IS_SPI_CPHA
IS_SPI_NSS
IS_SPI_BAUDRATE_PRESCALER
IS_SPI_FIRST_BIT
IS_SPI_TIMODE
IS_SPI_CRC_CALCULATION
IS_SPI_CRC_POLYNOMIAL
SPI_1LINE_TX
SPI_1LINE_RX
SPI_RESET_CRC
SPI Slave Select Management
SPI_NSS_SOFT
SPI_NSS_HARD_INPUT
SPI_NSS_HARD_OUTPUT
SPI TI Mode
SPI_TIMODE_DISABLE
SPI_TIMODE_ENABLE
562/692
DOCID028236 Rev 1
UM1940
HAL SRAM Generic Driver
41
HAL SRAM Generic Driver
41.1
SRAM Firmware driver registers structures
41.1.1
SRAM_HandleTypeDef
Data Fields






FSMC_NORSRAM_TypeDef * Instance
FSMC_NORSRAM_EXTENDED_TypeDef * Extended
FSMC_NORSRAM_InitTypeDef Init
HAL_LockTypeDef Lock
__IO HAL_SRAM_StateTypeDef State
DMA_HandleTypeDef * hdma
Field Documentation






FSMC_NORSRAM_TypeDef* SRAM_HandleTypeDef::Instance
Register base address
FSMC_NORSRAM_EXTENDED_TypeDef* SRAM_HandleTypeDef::Extended
Extended mode register base address
FSMC_NORSRAM_InitTypeDef SRAM_HandleTypeDef::Init
SRAM device control configuration parameters
HAL_LockTypeDef SRAM_HandleTypeDef::Lock
SRAM locking object
__IO HAL_SRAM_StateTypeDef SRAM_HandleTypeDef::State
SRAM device access state
DMA_HandleTypeDef* SRAM_HandleTypeDef::hdma
Pointer DMA handler
41.2
SRAM Firmware driver API description
41.2.1
How to use this driver
This driver is a generic layered driver which contains a set of APIs used to control SRAM
memories. It uses the FSMC layer functions to interface with SRAM devices. The following
sequence should be followed to configure the FSMC to interface with SRAM/PSRAM
memories:
1.
2.
Declare a SRAM_HandleTypeDef handle structure, for example:
SRAM_HandleTypeDef hsram; and:

Fill the SRAM_HandleTypeDef handle "Init" field with the allowed values of the
structure member.

Fill the SRAM_HandleTypeDef handle "Instance" field with a predefined base
register instance for NOR or SRAM device

Fill the SRAM_HandleTypeDef handle "Extended" field with a predefined base
register instance for NOR or SRAM extended mode
Declare two FSMC_NORSRAM_TimingTypeDef structures, for both normal and
extended mode timings; for example: FSMC_NORSRAM_TimingTypeDef Timing and
DOCID028236 Rev 1
563/692
HAL SRAM Generic Driver
UM1940
FSMC_NORSRAM_TimingTypeDef ExTiming; and fill its fields with the allowed values
of the structure member.
3.
Initialize the SRAM Controller by calling the function HAL_SRAM_Init(). This function
performs the following sequence:
a.
MSP hardware layer configuration using the function HAL_SRAM_MspInit()
b.
Control register configuration using the FSMC NORSRAM interface function
FSMC_NORSRAM_Init()
c.
Timing register configuration using the FSMC NORSRAM interface function
FSMC_NORSRAM_Timing_Init()
d.
Extended mode Timing register configuration using the FSMC NORSRAM
interface function FSMC_NORSRAM_Extended_Timing_Init()
e.
Enable the SRAM device using the macro __FSMC_NORSRAM_ENABLE()
4.
At this stage you can perform read/write accesses from/to the memory connected to
the NOR/SRAM Bank. You can perform either polling or DMA transfer using the
following APIs:

HAL_SRAM_Read()/HAL_SRAM_Write() for polling read/write access

HAL_SRAM_Read_DMA()/HAL_SRAM_Write_DMA() for DMA read/write
transfer
5.
You can also control the SRAM device by calling the control APIs
HAL_SRAM_WriteOperation_Enable()/ HAL_SRAM_WriteOperation_Disable() to
respectively enable/disable the SRAM write operation
6.
You can continuously monitor the SRAM device HAL state by calling the function
HAL_SRAM_GetState()
41.2.2
SRAM Initialization and de_initialization functions
This section provides functions allowing to initialize/de-initialize the SRAM memory
This section contains the following APIs:






41.2.3
HAL_SRAM_Init()
HAL_SRAM_DeInit()
HAL_SRAM_MspInit()
HAL_SRAM_MspDeInit()
HAL_SRAM_DMA_XferCpltCallback()
HAL_SRAM_DMA_XferErrorCallback()
SRAM Input and Output functions
This section provides functions allowing to use and control the SRAM memory
This section contains the following APIs:








41.2.4
HAL_SRAM_Read_8b()
HAL_SRAM_Write_8b()
HAL_SRAM_Read_16b()
HAL_SRAM_Write_16b()
HAL_SRAM_Read_32b()
HAL_SRAM_Write_32b()
HAL_SRAM_Read_DMA()
HAL_SRAM_Write_DMA()
SRAM Control functions
This subsection provides a set of functions allowing to control dynamically the SRAM
interface.
This section contains the following APIs:
564/692
DOCID028236 Rev 1
UM1940
HAL SRAM Generic Driver


41.2.5
HAL_SRAM_WriteOperation_Enable()
HAL_SRAM_WriteOperation_Disable()
SRAM State functions
This subsection permits to get in run-time the status of the SRAM controller and the data
flow.
This section contains the following APIs:

41.2.6
HAL_SRAM_GetState()
HAL_SRAM_Init
Function Name
HAL_StatusTypeDef HAL_SRAM_Init (SRAM_HandleTypeDef *
hsram, FSMC_NORSRAM_TimingTypeDef * Timing,
FSMC_NORSRAM_TimingTypeDef * ExtTiming)
Function Description
Performs the SRAM device initialization sequence.
Parameters

Return values
41.2.7
41.2.8
41.2.9


hsram: pointer to a SRAM_HandleTypeDef structure that
contains the configuration information for SRAM module.
Timing: Pointer to SRAM control timing structure
ExtTiming: Pointer to SRAM extended mode timing structure

HAL status
HAL_SRAM_DeInit
Function Name
HAL_StatusTypeDef HAL_SRAM_DeInit
(SRAM_HandleTypeDef * hsram)
Function Description
Performs the SRAM device De-initialization sequence.
Parameters

hsram: pointer to a SRAM_HandleTypeDef structure that
contains the configuration information for SRAM module.
Return values

HAL status
HAL_SRAM_MspInit
Function Name
void HAL_SRAM_MspInit (SRAM_HandleTypeDef * hsram)
Function Description
SRAM MSP Init.
Parameters

hsram: pointer to a SRAM_HandleTypeDef structure that
contains the configuration information for SRAM module.
Return values

None
HAL_SRAM_MspDeInit
Function Name
void HAL_SRAM_MspDeInit (SRAM_HandleTypeDef * hsram)
Function Description
SRAM MSP DeInit.
Parameters

hsram: pointer to a SRAM_HandleTypeDef structure that
contains the configuration information for SRAM module.
Return values

None
DOCID028236 Rev 1
565/692
HAL SRAM Generic Driver
41.2.10
41.2.11
41.2.12
HAL_SRAM_DMA_XferCpltCallback
Function Name
void HAL_SRAM_DMA_XferCpltCallback
(DMA_HandleTypeDef * hdma)
Function Description
DMA transfer complete callback.
Parameters

hdma: pointer to a SRAM_HandleTypeDef structure that
contains the configuration information for SRAM module.
Return values

None
HAL_SRAM_DMA_XferErrorCallback
Function Name
void HAL_SRAM_DMA_XferErrorCallback
(DMA_HandleTypeDef * hdma)
Function Description
DMA transfer complete error callback.
Parameters

hdma: pointer to a SRAM_HandleTypeDef structure that
contains the configuration information for SRAM module.
Return values

None
HAL_SRAM_Read_8b
Function Name
HAL_StatusTypeDef HAL_SRAM_Read_8b
(SRAM_HandleTypeDef * hsram, uint32_t * pAddress, uint8_t *
pDstBuffer, uint32_t BufferSize)
Function Description
Reads 8-bit buffer from SRAM memory.
Parameters

Return values
41.2.13

HAL status
Function Name
HAL_StatusTypeDef HAL_SRAM_Write_8b
(SRAM_HandleTypeDef * hsram, uint32_t * pAddress, uint8_t *
pSrcBuffer, uint32_t BufferSize)
Function Description
Writes 8-bit buffer to SRAM memory.
Parameters




hsram: pointer to a SRAM_HandleTypeDef structure that
contains the configuration information for SRAM module.
pAddress: Pointer to write start address
pSrcBuffer: Pointer to source buffer to write
BufferSize: Size of the buffer to write to memory

HAL status
HAL_SRAM_Read_16b
Function Name
566/692



hsram: pointer to a SRAM_HandleTypeDef structure that
contains the configuration information for SRAM module.
pAddress: Pointer to read start address
pDstBuffer: Pointer to destination buffer
BufferSize: Size of the buffer to read from memory
HAL_SRAM_Write_8b
Return values
41.2.14
UM1940
HAL_StatusTypeDef HAL_SRAM_Read_16b
(SRAM_HandleTypeDef * hsram, uint32_t * pAddress, uint16_t
DOCID028236 Rev 1
UM1940
HAL SRAM Generic Driver
* pDstBuffer, uint32_t BufferSize)
Function Description
Reads 16-bit buffer from SRAM memory.
Parameters

Return values
41.2.15
HAL status
Function Name
HAL_StatusTypeDef HAL_SRAM_Write_16b
(SRAM_HandleTypeDef * hsram, uint32_t * pAddress, uint16_t
* pSrcBuffer, uint32_t BufferSize)
Function Description
Writes 16-bit buffer to SRAM memory.
Parameters




hsram: pointer to a SRAM_HandleTypeDef structure that
contains the configuration information for SRAM module.
pAddress: Pointer to write start address
pSrcBuffer: Pointer to source buffer to write
BufferSize: Size of the buffer to write to memory

HAL status
HAL_SRAM_Read_32b
Function Name
HAL_StatusTypeDef HAL_SRAM_Read_32b
(SRAM_HandleTypeDef * hsram, uint32_t * pAddress, uint32_t
* pDstBuffer, uint32_t BufferSize)
Function Description
Reads 32-bit buffer from SRAM memory.
Parameters

Return values
41.2.17

HAL_SRAM_Write_16b
Return values
41.2.16



hsram: pointer to a SRAM_HandleTypeDef structure that
contains the configuration information for SRAM module.
pAddress: Pointer to read start address
pDstBuffer: Pointer to destination buffer
BufferSize: Size of the buffer to read from memory



hsram: pointer to a SRAM_HandleTypeDef structure that
contains the configuration information for SRAM module.
pAddress: Pointer to read start address
pDstBuffer: Pointer to destination buffer
BufferSize: Size of the buffer to read from memory

HAL status
HAL_SRAM_Write_32b
Function Name
HAL_StatusTypeDef HAL_SRAM_Write_32b
(SRAM_HandleTypeDef * hsram, uint32_t * pAddress, uint32_t
* pSrcBuffer, uint32_t BufferSize)
Function Description
Writes 32-bit buffer to SRAM memory.
Parameters

Return values



hsram: pointer to a SRAM_HandleTypeDef structure that
contains the configuration information for SRAM module.
pAddress: Pointer to write start address
pSrcBuffer: Pointer to source buffer to write
BufferSize: Size of the buffer to write to memory

HAL status
DOCID028236 Rev 1
567/692
HAL SRAM Generic Driver
41.2.18
HAL_SRAM_Read_DMA
Function Name
HAL_StatusTypeDef HAL_SRAM_Read_DMA
(SRAM_HandleTypeDef * hsram, uint32_t * pAddress, uint32_t
* pDstBuffer, uint32_t BufferSize)
Function Description
Reads a Words data from the SRAM memory using DMA transfer.
Parameters

Return values
41.2.19
41.2.21
41.2.22

HAL status
Function Name
HAL_StatusTypeDef HAL_SRAM_Write_DMA
(SRAM_HandleTypeDef * hsram, uint32_t * pAddress, uint32_t
* pSrcBuffer, uint32_t BufferSize)
Function Description
Writes a Words data buffer to SRAM memory using DMA transfer.
Parameters




hsram: pointer to a SRAM_HandleTypeDef structure that
contains the configuration information for SRAM module.
pAddress: Pointer to write start address
pSrcBuffer: Pointer to source buffer to write
BufferSize: Size of the buffer to write to memory

HAL status
HAL_SRAM_WriteOperation_Enable
Function Name
HAL_StatusTypeDef HAL_SRAM_WriteOperation_Enable
(SRAM_HandleTypeDef * hsram)
Function Description
Enables dynamically SRAM write operation.
Parameters

hsram: pointer to a SRAM_HandleTypeDef structure that
contains the configuration information for SRAM module.
Return values

HAL status
HAL_SRAM_WriteOperation_Disable
Function Name
HAL_StatusTypeDef HAL_SRAM_WriteOperation_Disable
(SRAM_HandleTypeDef * hsram)
Function Description
Disables dynamically SRAM write operation.
Parameters

hsram: pointer to a SRAM_HandleTypeDef structure that
contains the configuration information for SRAM module.
Return values

HAL status
HAL_SRAM_GetState
Function Name
568/692



hsram: pointer to a SRAM_HandleTypeDef structure that
contains the configuration information for SRAM module.
pAddress: Pointer to read start address
pDstBuffer: Pointer to destination buffer
BufferSize: Size of the buffer to read from memory
HAL_SRAM_Write_DMA
Return values
41.2.20
UM1940
HAL_SRAM_StateTypeDef HAL_SRAM_GetState
(SRAM_HandleTypeDef * hsram)
DOCID028236 Rev 1
UM1940
HAL SRAM Generic Driver
Function Description
Returns the SRAM controller state.
Parameters

hsram: pointer to a SRAM_HandleTypeDef structure that
contains the configuration information for SRAM module.
Return values

HAL state
41.3
SRAM Firmware driver defines
41.3.1
SRAM
SRAM Exported Macros
__HAL_SRAM_RESET_HANDLE_STATE
Description:

Reset SRAM handle state.
Parameters:

__HANDLE__: SRAM handle
Return value:

None
DOCID028236 Rev 1
569/692
HAL TIM Generic Driver
UM1940
42
HAL TIM Generic Driver
42.1
TIM Firmware driver registers structures
42.1.1
TIM_Base_InitTypeDef
Data Fields





uint32_t Prescaler
uint32_t CounterMode
uint32_t Period
uint32_t ClockDivision
uint32_t RepetitionCounter
Field Documentation





42.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 edgealigned modethe 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
Data Fields







570/692
uint32_t OCMode
uint32_t Pulse
uint32_t OCPolarity
uint32_t OCNPolarity
uint32_t OCFastMode
uint32_t OCIdleState
uint32_t OCNIdleState
DOCID028236 Rev 1
UM1940
HAL TIM Generic Driver
Field Documentation







42.1.3
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
Note:This parameter is valid only for TIM1 and TIM8.
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
Note:This parameter is valid only for TIM1 and TIM8.
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
Note:This parameter is valid only for TIM1 and TIM8.
TIM_OnePulse_InitTypeDef
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


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
DOCID028236 Rev 1
571/692
HAL TIM Generic Driver







42.1.4
UM1940
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
Note:This parameter is valid only for TIM1 and TIM8.
uint32_t TIM_OnePulse_InitTypeDef::OCIdleState
Specifies the TIM Output Compare pin state during Idle state. This parameter can be
a value of TIM_Output_Compare_Idle_State
Note:This parameter is valid only for TIM1 and TIM8.
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
Note:This parameter is valid only for TIM1 and TIM8.
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
Data Fields




uint32_t ICPolarity
uint32_t ICSelection
uint32_t ICPrescaler
uint32_t ICFilter
Field Documentation




42.1.5
572/692
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 parameter can be a number between Min_Data
= 0x0 and Max_Data = 0xF
TIM_Encoder_InitTypeDef
DOCID028236 Rev 1
UM1940
HAL TIM Generic Driver
Data Fields









uint32_t EncoderMode
uint32_t IC1Polarity
uint32_t IC1Selection
uint32_t IC1Prescaler
uint32_t IC1Filter
uint32_t IC2Polarity
uint32_t IC2Selection
uint32_t IC2Prescaler
uint32_t IC2Filter
Field Documentation









42.1.6
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 input signal. This parameter can be a value of
TIM_Input_Capture_Polarity
uint32_t TIM_Encoder_InitTypeDef::IC1Selection
Specifies the input. This parameter can be a value of TIM_Input_Capture_Selection
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 parameter can be a number between Min_Data
= 0x0 and Max_Data = 0xF
uint32_t TIM_Encoder_InitTypeDef::IC2Polarity
Specifies the active edge of the input signal. This parameter can be a value of
TIM_Input_Capture_Polarity
uint32_t TIM_Encoder_InitTypeDef::IC2Selection
Specifies the input. This parameter can be a value of TIM_Input_Capture_Selection
uint32_t TIM_Encoder_InitTypeDef::IC2Prescaler
Specifies the Input Capture Prescaler. This parameter can be a value of
TIM_Input_Capture_Prescaler
uint32_t TIM_Encoder_InitTypeDef::IC2Filter
Specifies the input capture filter. This parameter can be a number between Min_Data
= 0x0 and Max_Data = 0xF
TIM_ClockConfigTypeDef
Data Fields




uint32_t ClockSource
uint32_t ClockPolarity
uint32_t ClockPrescaler
uint32_t ClockFilter
Field Documentation
DOCID028236 Rev 1
573/692
HAL TIM Generic Driver




42.1.7
UM1940
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 number between Min_Data = 0x0 and
Max_Data = 0xF
TIM_ClearInputConfigTypeDef
Data Fields





uint32_t ClearInputState
uint32_t ClearInputSource
uint32_t ClearInputPolarity
uint32_t ClearInputPrescaler
uint32_t ClearInputFilter
Field Documentation





42.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 number between Min_Data = 0x0 and
Max_Data = 0xF
TIM_SlaveConfigTypeDef
Data Fields





uint32_t SlaveMode
uint32_t InputTrigger
uint32_t TriggerPolarity
uint32_t TriggerPrescaler
uint32_t TriggerFilter
Field Documentation

574/692
uint32_t TIM_SlaveConfigTypeDef::SlaveMode
Slave mode selection This parameter can be a value of TIM_Slave_Mode
DOCID028236 Rev 1
UM1940
HAL TIM Generic Driver




42.1.9
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 number between Min_Data = 0x0 and
Max_Data = 0xF
TIM_HandleTypeDef
Data Fields






TIM_TypeDef * Instance
TIM_Base_InitTypeDef Init
HAL_TIM_ActiveChannel Channel
DMA_HandleTypeDef * hdma
HAL_LockTypeDef Lock
__IO HAL_TIM_StateTypeDef State
Field Documentation






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 DMA_Handle_index
HAL_LockTypeDef TIM_HandleTypeDef::Lock
Locking object
__IO HAL_TIM_StateTypeDef TIM_HandleTypeDef::State
TIM operation state
42.2
TIM Firmware driver API description
42.2.1
TIMER Generic features
The Timer features include:
1.
2.
3.
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
DOCID028236 Rev 1
575/692
HAL TIM Generic Driver
42.2.2
How to use this driver
1.
2.
3.
4.
5.
6.
42.2.3
UM1940
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:
__GPIOx_CLK_ENABLE();

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

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
This section provides functions allowing to:

576/692
Initialize and configure the TIM base.
DOCID028236 Rev 1
UM1940
HAL TIM Generic Driver







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.
This section contains the following APIs:










42.2.4
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
This section provides functions allowing to:








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.
This section contains the following APIs:










42.2.5
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
This section provides functions allowing to:






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.
DOCID028236 Rev 1
577/692
HAL TIM Generic Driver


UM1940
Start the Time PWM and enable DMA transfer.
Stop the Time PWM and disable DMA transfer.
This section contains the following APIs:










42.2.6
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
This section provides functions allowing to:








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.
Start the Time Input Capture and enable DMA transfer.
Stop the Time Input Capture and disable DMA transfer.
This section contains the following APIs:










42.2.7
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
This section provides functions allowing to:








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.
This section contains the following APIs:

578/692
HAL_TIM_OnePulse_Init()
DOCID028236 Rev 1
UM1940
HAL TIM Generic Driver







42.2.8
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
This section provides functions allowing to:








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.
This section contains the following APIs:










42.2.9
HAL_TIM_Encoder_Init()
HAL_TIM_Encoder_DeInit()
HAL_TIM_Encoder_MspInit()
HAL_TIM_Encoder_MspDeInit()
HAL_TIM_Encoder_Start()
HAL_TIM_Encoder_Stop()
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.
This section contains the following APIs:

42.2.10
HAL_TIM_IRQHandler()
Peripheral Control functions
This section provides functions allowing to:





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.
This section contains the following APIs:




HAL_TIM_OC_ConfigChannel()
HAL_TIM_IC_ConfigChannel()
HAL_TIM_PWM_ConfigChannel()
HAL_TIM_OnePulse_ConfigChannel()
DOCID028236 Rev 1
579/692
HAL TIM Generic Driver











42.2.11
UM1940
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:





Timer Period elapsed callback
Timer Output Compare callback
Timer Input capture callback
Timer Trigger callback
Timer Error callback
This section contains the following APIs:






42.2.12
HAL_TIM_PeriodElapsedCallback()
HAL_TIM_OC_DelayElapsedCallback()
HAL_TIM_IC_CaptureCallback()
HAL_TIM_PWM_PulseFinishedCallback()
HAL_TIM_TriggerCallback()
HAL_TIM_ErrorCallback()
Peripheral State functions
This subsection permits to get in run-time the status of the peripheral and the data flow.
This section contains the following APIs:






42.2.13
580/692
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)
Function Description
Initializes the TIM Time base Unit according to the specified
parameters in the TIM_HandleTypeDef and create the associated
handle.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL status
DOCID028236 Rev 1
UM1940
42.2.14
42.2.15
42.2.16
42.2.17
42.2.18
42.2.19
HAL TIM Generic Driver
HAL_TIM_Base_DeInit
Function Name
HAL_StatusTypeDef HAL_TIM_Base_DeInit
(TIM_HandleTypeDef * htim)
Function Description
DeInitializes the TIM Base peripheral.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL status
HAL_TIM_Base_MspInit
Function Name
void HAL_TIM_Base_MspInit (TIM_HandleTypeDef * htim)
Function Description
Initializes the TIM Base MSP.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

None
HAL_TIM_Base_MspDeInit
Function Name
void HAL_TIM_Base_MspDeInit (TIM_HandleTypeDef * htim)
Function Description
DeInitializes TIM Base MSP.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

None
HAL_TIM_Base_Start
Function Name
HAL_StatusTypeDef HAL_TIM_Base_Start
(TIM_HandleTypeDef * htim)
Function Description
Starts the TIM Base generation.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL status
HAL_TIM_Base_Stop
Function Name
HAL_StatusTypeDef HAL_TIM_Base_Stop
(TIM_HandleTypeDef * htim)
Function Description
Stops the TIM Base generation.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL status
HAL_TIM_Base_Start_IT
Function Name
HAL_StatusTypeDef HAL_TIM_Base_Start_IT
DOCID028236 Rev 1
581/692
HAL TIM Generic Driver
UM1940
(TIM_HandleTypeDef * htim)
42.2.20
42.2.21
Function Description
Starts the TIM Base generation in interrupt mode.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL status
HAL_TIM_Base_Stop_IT
Function Name
HAL_StatusTypeDef HAL_TIM_Base_Stop_IT
(TIM_HandleTypeDef * htim)
Function Description
Stops the TIM Base generation in interrupt mode.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL status
HAL_TIM_Base_Start_DMA
Function Name
HAL_StatusTypeDef HAL_TIM_Base_Start_DMA
(TIM_HandleTypeDef * htim, uint32_t * pData, uint16_t Length)
Function Description
Starts the TIM Base generation in DMA mode.
Parameters

Return values
42.2.22
42.2.23
582/692


htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
pData: The source Buffer address.
Length: The length of data to be transferred from memory to
peripheral.

HAL status
HAL_TIM_Base_Stop_DMA
Function Name
HAL_StatusTypeDef HAL_TIM_Base_Stop_DMA
(TIM_HandleTypeDef * htim)
Function Description
Stops the TIM Base generation in DMA mode.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL status
HAL_TIM_OC_Init
Function Name
HAL_StatusTypeDef HAL_TIM_OC_Init (TIM_HandleTypeDef *
htim)
Function Description
Initializes the TIM Output Compare according to the specified
parameters in the TIM_HandleTypeDef and create the associated
handle.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL status
DOCID028236 Rev 1
UM1940
42.2.24
42.2.25
42.2.26
42.2.27
HAL TIM Generic Driver
HAL_TIM_OC_DeInit
Function Name
HAL_StatusTypeDef HAL_TIM_OC_DeInit
(TIM_HandleTypeDef * htim)
Function Description
DeInitializes the TIM peripheral.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL status
HAL_TIM_OC_MspInit
Function Name
void HAL_TIM_OC_MspInit (TIM_HandleTypeDef * htim)
Function Description
Initializes the TIM Output Compare MSP.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

None
HAL_TIM_OC_MspDeInit
Function Name
void HAL_TIM_OC_MspDeInit (TIM_HandleTypeDef * htim)
Function Description
DeInitializes TIM Output Compare MSP.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

None
HAL_TIM_OC_Start
Function Name
HAL_StatusTypeDef HAL_TIM_OC_Start (TIM_HandleTypeDef
* htim, uint32_t Channel)
Function Description
Starts the TIM Output Compare signal generation.
Parameters


Return values
42.2.28

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channel to be enabled. This parameter can be
one of the following values: TIM_CHANNEL_1: TIM Channel
1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected
HAL status
HAL_TIM_OC_Stop
Function Name
HAL_StatusTypeDef HAL_TIM_OC_Stop (TIM_HandleTypeDef
* htim, uint32_t Channel)
Function Description
Stops the TIM Output Compare signal generation.
Parameters


htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channel to be disabled. This parameter can
DOCID028236 Rev 1
583/692
HAL TIM Generic Driver
Return values
42.2.29
UM1940
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected

HAL status
HAL_TIM_OC_Start_IT
Function Name
HAL_StatusTypeDef HAL_TIM_OC_Start_IT
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function Description
Starts the TIM Output Compare signal generation in interrupt
mode.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channel to be enabled. This parameter can be
one of the following values: TIM_CHANNEL_1: TIM Channel
1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected

Return values
42.2.30

HAL_TIM_OC_Stop_IT
Function Name
HAL_StatusTypeDef HAL_TIM_OC_Stop_IT
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function Description
Stops the TIM Output Compare signal generation in interrupt
mode.
Parameters


Return values
42.2.31

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channel to be disabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected
HAL status
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)
Function Description
Starts the TIM Output Compare signal generation in DMA mode.
Parameters



584/692
HAL status
htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channel to be enabled. This parameter can be
one of the following values: TIM_CHANNEL_1: TIM Channel
1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected
pData: The source Buffer address.
DOCID028236 Rev 1
UM1940
HAL TIM Generic Driver
Return values
42.2.32

Length: The length of data to be transferred from memory to
TIM peripheral

HAL status
HAL_TIM_OC_Stop_DMA
Function Name
HAL_StatusTypeDef HAL_TIM_OC_Stop_DMA
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function Description
Stops the TIM Output Compare signal generation in DMA mode.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channel to be disabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected

Return values
42.2.33
42.2.34
42.2.35
42.2.36

HAL status
HAL_TIM_PWM_Init
Function Name
HAL_StatusTypeDef HAL_TIM_PWM_Init (TIM_HandleTypeDef
* htim)
Function Description
Initializes the TIM PWM Time Base according to the specified
parameters in the TIM_HandleTypeDef and create the associated
handle.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL status
HAL_TIM_PWM_DeInit
Function Name
HAL_StatusTypeDef HAL_TIM_PWM_DeInit
(TIM_HandleTypeDef * htim)
Function Description
DeInitializes the TIM peripheral.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL status
HAL_TIM_PWM_MspInit
Function Name
void HAL_TIM_PWM_MspInit (TIM_HandleTypeDef * htim)
Function Description
Initializes the TIM PWM MSP.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

None
HAL_TIM_PWM_MspDeInit
DOCID028236 Rev 1
585/692
HAL TIM Generic Driver
Function Name
42.2.37
UM1940
void HAL_TIM_PWM_MspDeInit (TIM_HandleTypeDef * htim)
Function Description
DeInitializes TIM PWM MSP.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

None
HAL_TIM_PWM_Start
Function Name
HAL_StatusTypeDef HAL_TIM_PWM_Start
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function Description
Starts the PWM signal generation.
Parameters


Return values
42.2.38

Function Name
HAL_StatusTypeDef HAL_TIM_PWM_Stop
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function Description
Stops the PWM signal generation.
Parameters

Return values

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be disabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected
HAL status
HAL_TIM_PWM_Start_IT
Function Name
HAL_StatusTypeDef HAL_TIM_PWM_Start_IT
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function Description
Starts the PWM signal generation in interrupt mode.
Parameters


Return values
586/692
HAL status
HAL_TIM_PWM_Stop

42.2.39
htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be enabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channel to be disabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected
HAL status
DOCID028236 Rev 1
UM1940
42.2.40
HAL TIM Generic Driver
HAL_TIM_PWM_Stop_IT
Function Name
HAL_StatusTypeDef HAL_TIM_PWM_Stop_IT
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function Description
Stops the PWM signal generation in interrupt mode.
Parameters


Return values
42.2.41

Function Name
HAL_StatusTypeDef HAL_TIM_PWM_Start_DMA
(TIM_HandleTypeDef * htim, uint32_t Channel, uint32_t *
pData, uint16_t Length)
Function Description
Starts the TIM PWM signal generation in DMA mode.
Parameters



Return values

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be enabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected
pData: The source Buffer address.
Length: The length of data to be transferred from memory to
TIM peripheral
HAL status
HAL_TIM_PWM_Stop_DMA
Function Name
HAL_StatusTypeDef HAL_TIM_PWM_Stop_DMA
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function Description
Stops the TIM PWM signal generation in DMA mode.
Parameters


Return values
42.2.43
HAL status
HAL_TIM_PWM_Start_DMA

42.2.42
htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be disabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be disabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected
HAL status
HAL_TIM_IC_Init
Function Name
HAL_StatusTypeDef HAL_TIM_IC_Init (TIM_HandleTypeDef *
htim)
DOCID028236 Rev 1
587/692
HAL TIM Generic Driver
Function Description
42.2.44
42.2.45
42.2.46
42.2.47
UM1940
Initializes the TIM Input Capture Time base according to the
specified parameters in the TIM_HandleTypeDef and create the
associated handle.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL status
HAL_TIM_IC_DeInit
Function Name
HAL_StatusTypeDef HAL_TIM_IC_DeInit (TIM_HandleTypeDef
* htim)
Function Description
DeInitializes the TIM peripheral.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL status
HAL_TIM_IC_MspInit
Function Name
void HAL_TIM_IC_MspInit (TIM_HandleTypeDef * htim)
Function Description
Initializes the TIM INput Capture MSP.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

None
HAL_TIM_IC_MspDeInit
Function Name
void HAL_TIM_IC_MspDeInit (TIM_HandleTypeDef * htim)
Function Description
DeInitializes TIM Input Capture MSP.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

None
HAL_TIM_IC_Start
Function Name
HAL_StatusTypeDef HAL_TIM_IC_Start (TIM_HandleTypeDef *
htim, uint32_t Channel)
Function Description
Starts the TIM Input Capture measurement.
Parameters


Return values
42.2.48
588/692

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be enabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected
HAL status
HAL_TIM_IC_Stop
DOCID028236 Rev 1
UM1940
Function Name
HAL TIM Generic Driver
HAL_StatusTypeDef HAL_TIM_IC_Stop (TIM_HandleTypeDef *
htim, uint32_t Channel)
Function Description
Stops the TIM Input Capture measurement.
Parameters


Return values
42.2.49

Function Name
HAL_StatusTypeDef HAL_TIM_IC_Start_IT
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function Description
Starts the TIM Input Capture measurement in interrupt mode.
Parameters

Return values

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be enabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected
HAL status
HAL_TIM_IC_Stop_IT
Function Name
HAL_StatusTypeDef HAL_TIM_IC_Stop_IT
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function Description
Stops the TIM Input Capture measurement in interrupt mode.
Parameters


Return values
42.2.51
HAL status
HAL_TIM_IC_Start_IT

42.2.50
htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be disabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be disabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected
HAL status
HAL_TIM_IC_Start_DMA
Function Name
HAL_StatusTypeDef HAL_TIM_IC_Start_DMA
(TIM_HandleTypeDef * htim, uint32_t Channel, uint32_t *
pData, uint16_t Length)
Function Description
Starts the TIM Input Capture measurement on in DMA mode.
Parameters


htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be enabled. This parameter can
DOCID028236 Rev 1
589/692
HAL TIM Generic Driver


Return values
42.2.52

Function Name
HAL_StatusTypeDef HAL_TIM_IC_Stop_DMA
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function Description
Stops the TIM Input Capture measurement on in DMA mode.
Parameters

Return values

590/692
HAL status
Function Name
HAL_StatusTypeDef HAL_TIM_OnePulse_Init
(TIM_HandleTypeDef * htim, uint32_t OnePulseMode)
Function Description
Initializes the TIM One Pulse Time Base according to the specified
parameters in the TIM_HandleTypeDef and create the associated
handle.
Parameters

Return values
42.2.55
htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be disabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected
HAL_TIM_OnePulse_Init

42.2.54
HAL status
HAL_TIM_IC_Stop_DMA

42.2.53
UM1940
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected
pData: The destination Buffer address.
Length: The length of data to be transferred from TIM
peripheral to memory.

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
OnePulseMode: Select the One pulse mode. This parameter
can be one of the following values: TIM_OPMODE_SINGLE:
Only one pulse will be
generated.TIM_OPMODE_REPETITIVE: Repetitive pulses
will be generated.
HAL status
HAL_TIM_OnePulse_DeInit
Function Name
HAL_StatusTypeDef HAL_TIM_OnePulse_DeInit
(TIM_HandleTypeDef * htim)
Function Description
DeInitializes the TIM One Pulse.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL status
HAL_TIM_OnePulse_MspInit
DOCID028236 Rev 1
UM1940
42.2.56
42.2.57
Function Name
HAL TIM Generic Driver
void HAL_TIM_OnePulse_MspInit (TIM_HandleTypeDef * htim)
Function Description
Initializes the TIM One Pulse MSP.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

None
HAL_TIM_OnePulse_MspDeInit
Function Name
void HAL_TIM_OnePulse_MspDeInit (TIM_HandleTypeDef *
htim)
Function Description
DeInitializes TIM One Pulse MSP.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

None
HAL_TIM_OnePulse_Start
Function Name
HAL_StatusTypeDef HAL_TIM_OnePulse_Start
(TIM_HandleTypeDef * htim, uint32_t OutputChannel)
Function Description
Starts the TIM One Pulse signal generation.
Parameters


Return values
42.2.58

HAL status
HAL_TIM_OnePulse_Stop
Function Name
HAL_StatusTypeDef HAL_TIM_OnePulse_Stop
(TIM_HandleTypeDef * htim, uint32_t OutputChannel)
Function Description
Stops the TIM One Pulse signal generation.
Parameters


Return values
42.2.59
htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
OutputChannel: : TIM Channels to be enabled. This
parameter can be one of the following values:
TIM_CHANNEL_1: TIM Channel 1
selectedTIM_CHANNEL_2: TIM Channel 2 selected

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
OutputChannel: : TIM Channels to be disable. This
parameter can be one of the following values:
TIM_CHANNEL_1: TIM Channel 1
selectedTIM_CHANNEL_2: TIM Channel 2 selected
HAL status
HAL_TIM_OnePulse_Start_IT
Function Name
HAL_StatusTypeDef HAL_TIM_OnePulse_Start_IT
(TIM_HandleTypeDef * htim, uint32_t OutputChannel)
Function Description
Starts the TIM One Pulse signal generation in interrupt mode.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
DOCID028236 Rev 1
591/692
HAL TIM Generic Driver

Return values
42.2.60

Function Name
HAL_StatusTypeDef HAL_TIM_OnePulse_Stop_IT
(TIM_HandleTypeDef * htim, uint32_t OutputChannel)
Function Description
Stops the TIM One Pulse signal generation in interrupt mode.
Parameters

Return values
42.2.63
592/692

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
OutputChannel: : TIM Channels to be enabled. This
parameter can be one of the following values:
TIM_CHANNEL_1: TIM Channel 1
selectedTIM_CHANNEL_2: TIM Channel 2 selected
HAL status
HAL_TIM_Encoder_Init
Function Name
HAL_StatusTypeDef HAL_TIM_Encoder_Init
(TIM_HandleTypeDef * htim, TIM_Encoder_InitTypeDef *
sConfig)
Function Description
Initializes the TIM Encoder Interface and create the associated
handle.
Parameters

Return values
42.2.62
HAL status
HAL_TIM_OnePulse_Stop_IT

42.2.61
UM1940
contains the configuration information for TIM module.
OutputChannel: : TIM Channels to be enabled. This
parameter can be one of the following values:
TIM_CHANNEL_1: TIM Channel 1
selectedTIM_CHANNEL_2: TIM Channel 2 selected

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
sConfig: TIM Encoder Interface configuration structure

HAL status
HAL_TIM_Encoder_DeInit
Function Name
HAL_StatusTypeDef HAL_TIM_Encoder_DeInit
(TIM_HandleTypeDef * htim)
Function Description
DeInitializes the TIM Encoder interface.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL status
HAL_TIM_Encoder_MspInit
Function Name
void HAL_TIM_Encoder_MspInit (TIM_HandleTypeDef * htim)
Function Description
Initializes the TIM Encoder Interface MSP.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
DOCID028236 Rev 1
UM1940
HAL TIM Generic Driver
Return values
42.2.64
42.2.65

HAL_TIM_Encoder_MspDeInit
Function Name
void HAL_TIM_Encoder_MspDeInit (TIM_HandleTypeDef *
htim)
Function Description
DeInitializes TIM Encoder Interface MSP.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

None
HAL_TIM_Encoder_Start
Function Name
HAL_StatusTypeDef HAL_TIM_Encoder_Start
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function Description
Starts the TIM Encoder Interface.
Parameters


Return values
42.2.66

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be enabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_ALL: TIM Channel 1 and TIM
Channel 2 are selected
HAL status
HAL_TIM_Encoder_Stop
Function Name
HAL_StatusTypeDef HAL_TIM_Encoder_Stop
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function Description
Stops the TIM Encoder Interface.
Parameters


Return values
42.2.67
None

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be disabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_ALL: TIM Channel 1 and TIM
Channel 2 are selected
HAL status
HAL_TIM_Encoder_Start_IT
Function Name
HAL_StatusTypeDef HAL_TIM_Encoder_Start_IT
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function Description
Starts the TIM Encoder Interface in interrupt mode.
Parameters


htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be enabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
DOCID028236 Rev 1
593/692
HAL TIM Generic Driver
Return values
42.2.68
UM1940
selectedTIM_CHANNEL_ALL: TIM Channel 1 and TIM
Channel 2 are selected

HAL_TIM_Encoder_Stop_IT
Function Name
HAL_StatusTypeDef HAL_TIM_Encoder_Stop_IT
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function Description
Stops the TIM Encoder Interface in interrupt mode.
Parameters


Return values
42.2.69

HAL status
Function Name
HAL_StatusTypeDef HAL_TIM_Encoder_Start_DMA
(TIM_HandleTypeDef * htim, uint32_t Channel, uint32_t *
pData1, uint32_t * pData2, uint16_t Length)
Function Description
Starts the TIM Encoder Interface in DMA mode.
Parameters




Return values

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be enabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_ALL: TIM Channel 1 and TIM
Channel 2 are selected
pData1: The destination Buffer address for IC1.
pData2: The destination Buffer address for IC2.
Length: The length of data to be transferred from TIM
peripheral to memory.
HAL status
HAL_TIM_Encoder_Stop_DMA
Function Name
HAL_StatusTypeDef HAL_TIM_Encoder_Stop_DMA
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function Description
Stops the TIM Encoder Interface in DMA mode.
Parameters


594/692
htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be disabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_ALL: TIM Channel 1 and TIM
Channel 2 are selected
HAL_TIM_Encoder_Start_DMA

42.2.70
HAL status
htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be enabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_ALL: TIM Channel 1 and TIM
Channel 2 are selected
DOCID028236 Rev 1
UM1940
HAL TIM Generic Driver
Return values
42.2.71
42.2.72

HAL_TIM_IRQHandler
Function Name
void HAL_TIM_IRQHandler (TIM_HandleTypeDef * htim)
Function Description
This function handles TIM interrupts requests.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

None
HAL_TIM_OC_ConfigChannel
Function Name
HAL_StatusTypeDef HAL_TIM_OC_ConfigChannel
(TIM_HandleTypeDef * htim, TIM_OC_InitTypeDef * sConfig,
uint32_t Channel)
Function Description
Initializes the TIM Output Compare Channels according to the
specified parameters in the TIM_OC_InitTypeDef.
Parameters



Return values
42.2.73

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
sConfig: TIM Output Compare configuration structure
Channel: TIM Channels to be enabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected
HAL status
HAL_TIM_IC_ConfigChannel
Function Name
HAL_StatusTypeDef HAL_TIM_IC_ConfigChannel
(TIM_HandleTypeDef * htim, TIM_IC_InitTypeDef * sConfig,
uint32_t Channel)
Function Description
Initializes the TIM Input Capture Channels according to the
specified parameters in the TIM_IC_InitTypeDef.
Parameters



Return values
42.2.74
HAL status

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
sConfig: TIM Input Capture configuration structure
Channel: TIM Channels to be enabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected
HAL status
HAL_TIM_PWM_ConfigChannel
Function Name
HAL_StatusTypeDef HAL_TIM_PWM_ConfigChannel
(TIM_HandleTypeDef * htim, TIM_OC_InitTypeDef * sConfig,
uint32_t Channel)
DOCID028236 Rev 1
595/692
HAL TIM Generic Driver
Function Description
Parameters
UM1940
Initializes the TIM PWM channels according to the specified
parameters in the TIM_OC_InitTypeDef.



Return values
42.2.75

Function Name
HAL_StatusTypeDef HAL_TIM_OnePulse_ConfigChannel
(TIM_HandleTypeDef * htim, TIM_OnePulse_InitTypeDef *
sConfig, uint32_t OutputChannel, uint32_t InputChannel)
Function Description
Initializes the TIM One Pulse Channels according to the specified
parameters in the TIM_OnePulse_InitTypeDef.
Parameters


Return values
596/692
HAL status
HAL_TIM_OnePulse_ConfigChannel


42.2.76
htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
sConfig: TIM PWM configuration structure
Channel: TIM Channels to be enabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
sConfig: TIM One Pulse configuration structure
OutputChannel: TIM Channels to be enabled. This
parameter can be one of the following values:
TIM_CHANNEL_1: TIM Channel 1
selectedTIM_CHANNEL_2: TIM Channel 2 selected
InputChannel: TIM Channels to be enabled. This parameter
can be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selected
HAL status
HAL_TIM_DMABurst_WriteStart
Fu
nc
tio
n
N
a
m
e
HAL_StatusTypeDef HAL_TIM_DMABurst_WriteStart (TIM_HandleTypeDef *
htim, uint32_t BurstBaseAddress, uint32_t BurstRequestSrc, uint32_t *
BurstBuffer, uint32_t BurstLength)
Fu
nc
tio
n
D
es
cri
pti
on
Configure the DMA Burst to transfer Data from the memory to the TIM peripheral.
DOCID028236 Rev 1
UM1940
HAL TIM Generic Driver
Pa
ra
m
et
er
s





R
et
ur
n
va
lu
es
42.2.77

htim: pointer to a TIM_HandleTypeDef structure that contains the configuration
information for TIM module.
BurstBaseAddress: TIM Base address from when the DMA will starts the Data
write. This parameters can be on of the following values:
TIM_DMABASE_CR1TIM_DMABASE_CR2TIM_DMABASE_SMCRTIM_DMAB
ASE_DIERTIM_DMABASE_SRTIM_DMABASE_EGRTIM_DMABASE_CCMR1T
IM_DMABASE_CCMR2TIM_DMABASE_CCERTIM_DMABASE_CNTTIM_DMA
BASE_PSCTIM_DMABASE_ARRTIM_DMABASE_RCRTIM_DMABASE_CCR1
TIM_DMABASE_CCR2TIM_DMABASE_CCR3TIM_DMABASE_CCR4TIM_DMA
BASE_BDTRTIM_DMABASE_DCR
BurstRequestSrc: TIM DMA Request sources. This parameters can be on of
the following values: TIM_DMA_UPDATE: TIM update Interrupt
sourceTIM_DMA_CC1: TIM Capture Compare 1 DMA sourceTIM_DMA_CC2:
TIM Capture Compare 2 DMA sourceTIM_DMA_CC3: TIM Capture Compare 3
DMA sourceTIM_DMA_CC4: TIM Capture Compare 4 DMA
sourceTIM_DMA_COM: TIM Commutation DMA sourceTIM_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.
HAL status
HAL_TIM_DMABurst_WriteStop
Function Name
HAL_StatusTypeDef HAL_TIM_DMABurst_WriteStop
(TIM_HandleTypeDef * htim, uint32_t BurstRequestSrc)
Function Description
Stops the TIM DMA Burst mode.
Parameters

Return values
42.2.78

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
BurstRequestSrc: TIM DMA Request sources to disable

HAL status
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)
Function Description
Configure the DMA Burst to transfer Data from the TIM peripheral
to the memory.
Parameters


htim: pointer to a TIM_HandleTypeDef structure that contains
the configuration information for TIM module.
BurstBaseAddress: TIM Base address from when the DMA
will starts the Data read. This parameters can be on of the
following values:
DOCID028236 Rev 1
597/692
HAL TIM Generic Driver



Return values
42.2.79
Function Name
HAL_StatusTypeDef HAL_TIM_DMABurst_ReadStop
(TIM_HandleTypeDef * htim, uint32_t BurstRequestSrc)
Function Description
Stop the DMA burst reading.
Parameters


htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
BurstRequestSrc: TIM DMA Request sources to disable.

HAL status
HAL_TIM_GenerateEvent
Function Name
HAL_StatusTypeDef HAL_TIM_GenerateEvent
(TIM_HandleTypeDef * htim, uint32_t EventSource)
Function Description
Generate a software event.
Parameters


598/692
HAL status
HAL_TIM_DMABurst_ReadStop
Return values
42.2.80

UM1940
TIM_DMABASE_CR1TIM_DMABASE_CR2TIM_DMABASE_
SMCRTIM_DMABASE_DIERTIM_DMABASE_SRTIM_DMAB
ASE_EGRTIM_DMABASE_CCMR1TIM_DMABASE_CCMR2
TIM_DMABASE_CCERTIM_DMABASE_CNTTIM_DMABASE
_PSCTIM_DMABASE_ARRTIM_DMABASE_RCRTIM_DMAB
ASE_CCR1TIM_DMABASE_CCR2TIM_DMABASE_CCR3TI
M_DMABASE_CCR4TIM_DMABASE_BDTRTIM_DMABASE_
DCR
BurstRequestSrc: TIM DMA Request sources. This
parameters can be on of the following values:
TIM_DMA_UPDATE: TIM update Interrupt
sourceTIM_DMA_CC1: TIM Capture Compare 1 DMA
sourceTIM_DMA_CC2: TIM Capture Compare 2 DMA
sourceTIM_DMA_CC3: TIM Capture Compare 3 DMA
sourceTIM_DMA_CC4: TIM Capture Compare 4 DMA
sourceTIM_DMA_COM: TIM Commutation DMA
sourceTIM_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.
htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
EventSource: specifies the event source. This parameter
can be one of the following values:
TIM_EVENTSOURCE_UPDATE: Timer update Event
sourceTIM_EVENTSOURCE_CC1: Timer Capture Compare
1 Event sourceTIM_EVENTSOURCE_CC2: Timer Capture
Compare 2 Event sourceTIM_EVENTSOURCE_CC3: Timer
Capture Compare 3 Event
sourceTIM_EVENTSOURCE_CC4: Timer Capture Compare
4 Event sourceTIM_EVENTSOURCE_COM: Timer COM
event sourceTIM_EVENTSOURCE_TRIGGER: Timer Trigger
Event sourceTIM_EVENTSOURCE_BREAK: Timer Break
DOCID028236 Rev 1
UM1940
HAL TIM Generic Driver
event source
42.2.81
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 and
TIM8.
HAL_TIM_ConfigOCrefClear
Function Name
HAL_StatusTypeDef HAL_TIM_ConfigOCrefClear
(TIM_HandleTypeDef * htim, TIM_ClearInputConfigTypeDef *
sClearInputConfig, uint32_t Channel)
Function Description
Configures the OCRef clear feature.
Parameters



Return values
42.2.82
HAL status
HAL_TIM_ConfigClockSource
Function Name
HAL_StatusTypeDef HAL_TIM_ConfigClockSource
(TIM_HandleTypeDef * htim, TIM_ClockConfigTypeDef *
sClockSourceConfig)
Function Description
Configures the clock source to be used.
Parameters

Return values
42.2.83

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
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 be
one of the following values: TIM_CHANNEL_1: TIM Channel
1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
sClockSourceConfig: pointer to a TIM_ClockConfigTypeDef
structure that contains the clock source information for the
TIM peripheral.

HAL status
HAL_TIM_ConfigTI1Input
Function Name
HAL_StatusTypeDef HAL_TIM_ConfigTI1Input
(TIM_HandleTypeDef * htim, uint32_t TI1_Selection)
Function Description
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: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
TI1_Selection: Indicate whether or not channel 1 is
connected to the output of a XOR gate. This parameter can
DOCID028236 Rev 1
599/692
HAL TIM Generic Driver
Return values
42.2.84
UM1940
be one of the following values: TIM_TI1SELECTION_CH1:
The TIMx_CH1 pin is connected to TI1
inputTIM_TI1SELECTION_XORCOMBINATION: The
TIMx_CH1, CH2 and CH3 pins are connected to the TI1 input
(XOR combination)

HAL_TIM_SlaveConfigSynchronization
Function Name
HAL_StatusTypeDef HAL_TIM_SlaveConfigSynchronization
(TIM_HandleTypeDef * htim, TIM_SlaveConfigTypeDef *
sSlaveConfig)
Function Description
Configures the TIM in Slave mode.
Parameters


Return values
42.2.85
42.2.86

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
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).
HAL status
HAL_TIM_SlaveConfigSynchronization_IT
Function Name
HAL_StatusTypeDef
HAL_TIM_SlaveConfigSynchronization_IT
(TIM_HandleTypeDef * htim, TIM_SlaveConfigTypeDef *
sSlaveConfig)
Function Description
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
HAL_TIM_ReadCapturedValue
Function Name
uint32_t HAL_TIM_ReadCapturedValue (TIM_HandleTypeDef *
htim, uint32_t Channel)
Function Description
Read the captured value from Capture Compare unit.
Parameters


600/692
HAL status
htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Channel: TIM Channels to be enabled. This parameter can
be one of the following values: TIM_CHANNEL_1: TIM
Channel 1 selectedTIM_CHANNEL_2: TIM Channel 2
selectedTIM_CHANNEL_3: TIM Channel 3
selectedTIM_CHANNEL_4: TIM Channel 4 selected
DOCID028236 Rev 1
UM1940
HAL TIM Generic Driver
Return values
42.2.87
42.2.88
42.2.89
42.2.90
42.2.91

Captured value
HAL_TIM_PeriodElapsedCallback
Function Name
void HAL_TIM_PeriodElapsedCallback (TIM_HandleTypeDef *
htim)
Function Description
Period elapsed callback in non blocking mode.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

None
HAL_TIM_OC_DelayElapsedCallback
Function Name
void HAL_TIM_OC_DelayElapsedCallback
(TIM_HandleTypeDef * htim)
Function Description
Output Compare callback in non blocking mode.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

None
HAL_TIM_IC_CaptureCallback
Function Name
void HAL_TIM_IC_CaptureCallback (TIM_HandleTypeDef *
htim)
Function Description
Input Capture callback in non blocking mode.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

None
HAL_TIM_PWM_PulseFinishedCallback
Function Name
void HAL_TIM_PWM_PulseFinishedCallback
(TIM_HandleTypeDef * htim)
Function Description
PWM Pulse finished callback in non blocking mode.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

None
HAL_TIM_TriggerCallback
Function Name
void HAL_TIM_TriggerCallback (TIM_HandleTypeDef * htim)
Function Description
Hall Trigger detection callback in non blocking mode.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

None
DOCID028236 Rev 1
601/692
HAL TIM Generic Driver
42.2.92
42.2.93
42.2.94
42.2.95
42.2.96
42.2.97
602/692
UM1940
HAL_TIM_ErrorCallback
Function Name
void HAL_TIM_ErrorCallback (TIM_HandleTypeDef * htim)
Function Description
Timer error callback in non blocking mode.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

None
HAL_TIM_Base_GetState
Function Name
HAL_TIM_StateTypeDef HAL_TIM_Base_GetState
(TIM_HandleTypeDef * htim)
Function Description
Return the TIM Base state.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL state
HAL_TIM_OC_GetState
Function Name
HAL_TIM_StateTypeDef HAL_TIM_OC_GetState
(TIM_HandleTypeDef * htim)
Function Description
Return the TIM OC state.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL state
HAL_TIM_PWM_GetState
Function Name
HAL_TIM_StateTypeDef HAL_TIM_PWM_GetState
(TIM_HandleTypeDef * htim)
Function Description
Return the TIM PWM state.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL state
HAL_TIM_IC_GetState
Function Name
HAL_TIM_StateTypeDef HAL_TIM_IC_GetState
(TIM_HandleTypeDef * htim)
Function Description
Return the TIM Input Capture state.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL state
HAL_TIM_OnePulse_GetState
DOCID028236 Rev 1
UM1940
42.2.98
Function Name
HAL TIM Generic Driver
HAL_TIM_StateTypeDef HAL_TIM_OnePulse_GetState
(TIM_HandleTypeDef * htim)
Function Description
Return the TIM One Pulse Mode state.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL state
HAL_TIM_Encoder_GetState
Function Name
HAL_TIM_StateTypeDef HAL_TIM_Encoder_GetState
(TIM_HandleTypeDef * htim)
Function Description
Return the TIM Encoder Mode state.
Parameters

htim: pointer to a TIM_HandleTypeDef structure that
contains the configuration information for TIM module.
Return values

HAL state
42.3
TIM Firmware driver defines
42.3.1
TIM
TIM AOE Bit State
TIM_AUTOMATICOUTPUT_ENABLE
TIM_AUTOMATICOUTPUT_DISABLE
TIM Break Input State
TIM_BREAK_ENABLE
TIM_BREAK_DISABLE
TIM Break Polarity
TIM_BREAKPOLARITY_LOW
TIM_BREAKPOLARITY_HIGH
TIM Channel
TIM_CHANNEL_1
TIM_CHANNEL_2
TIM_CHANNEL_3
TIM_CHANNEL_4
TIM_CHANNEL_ALL
TIM Clear Input Polarity
TIM_CLEARINPUTPOLARITY_INVERTED
Polarity for ETRx pin
TIM_CLEARINPUTPOLARITY_NONINVERTED
Polarity for ETRx pin
TIM Clear Input Prescaler
TIM_CLEARINPUTPRESCALER_DIV1
No prescaler is used
TIM_CLEARINPUTPRESCALER_DIV2
Prescaler for External ETR pin: Capture
DOCID028236 Rev 1
603/692
HAL TIM Generic Driver
UM1940
performed once every 2 events.
TIM_CLEARINPUTPRESCALER_DIV4
Prescaler for External ETR pin: Capture
performed once every 4 events.
TIM_CLEARINPUTPRESCALER_DIV8
Prescaler for External ETR pin: Capture
performed once every 8 events.
TIM Clear Input Source
TIM_CLEARINPUTSOURCE_ETR
TIM_CLEARINPUTSOURCE_NONE
TIM Clock Division
TIM_CLOCKDIVISION_DIV1
TIM_CLOCKDIVISION_DIV2
TIM_CLOCKDIVISION_DIV4
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
Polarity for TIx clock sources
TIM_CLOCKPOLARITY_BOTHEDGE
Polarity for TIx clock sources
TIM Clock Prescaler
TIM_CLOCKPRESCALER_DIV1
No prescaler is used
TIM_CLOCKPRESCALER_DIV2
Prescaler for External ETR Clock: Capture performed
once every 2 events.
TIM_CLOCKPRESCALER_DIV4
Prescaler for External ETR Clock: Capture performed
once every 4 events.
TIM_CLOCKPRESCALER_DIV8
Prescaler for External ETR Clock: Capture performed
once every 8 events.
TIM Clock Source
TIM_CLOCKSOURCE_ETRMODE2
TIM_CLOCKSOURCE_INTERNAL
TIM_CLOCKSOURCE_ITR0
TIM_CLOCKSOURCE_ITR1
TIM_CLOCKSOURCE_ITR2
TIM_CLOCKSOURCE_ITR3
TIM_CLOCKSOURCE_TI1ED
TIM_CLOCKSOURCE_TI1
TIM_CLOCKSOURCE_TI2
TIM_CLOCKSOURCE_ETRMODE1
TIM Commutation Source
604/692
DOCID028236 Rev 1
UM1940
HAL TIM Generic Driver
TIM_COMMUTATION_TRGI
TIM_COMMUTATION_SOFTWARE
TIM Counter Mode
TIM_COUNTERMODE_UP
TIM_COUNTERMODE_DOWN
TIM_COUNTERMODE_CENTERALIGNED1
TIM_COUNTERMODE_CENTERALIGNED2
TIM_COUNTERMODE_CENTERALIGNED3
TIM DMA Base address
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
TIM_DMABASE_OR
TIM DMA Burst Length
TIM_DMABURSTLENGTH_1TRANSFER
TIM_DMABURSTLENGTH_2TRANSFERS
TIM_DMABURSTLENGTH_3TRANSFERS
TIM_DMABURSTLENGTH_4TRANSFERS
TIM_DMABURSTLENGTH_5TRANSFERS
TIM_DMABURSTLENGTH_6TRANSFERS
DOCID028236 Rev 1
605/692
HAL TIM Generic Driver
TIM_DMABURSTLENGTH_7TRANSFERS
TIM_DMABURSTLENGTH_8TRANSFERS
TIM_DMABURSTLENGTH_9TRANSFERS
TIM_DMABURSTLENGTH_10TRANSFERS
TIM_DMABURSTLENGTH_11TRANSFERS
TIM_DMABURSTLENGTH_12TRANSFERS
TIM_DMABURSTLENGTH_13TRANSFERS
TIM_DMABURSTLENGTH_14TRANSFERS
TIM_DMABURSTLENGTH_15TRANSFERS
TIM_DMABURSTLENGTH_16TRANSFERS
TIM_DMABURSTLENGTH_17TRANSFERS
TIM_DMABURSTLENGTH_18TRANSFERS
TIM DMA sources
TIM_DMA_UPDATE
TIM_DMA_CC1
TIM_DMA_CC2
TIM_DMA_CC3
TIM_DMA_CC4
TIM_DMA_COM
TIM_DMA_TRIGGER
TIM Encoder Mode
TIM_ENCODERMODE_TI1
TIM_ENCODERMODE_TI2
TIM_ENCODERMODE_TI12
TIM ETR Polarity
TIM_ETRPOLARITY_INVERTED
Polarity for ETR source
TIM_ETRPOLARITY_NONINVERTED
Polarity for ETR source
TIM ETR Prescaler
TIM_ETRPRESCALER_DIV1
No prescaler is used
TIM_ETRPRESCALER_DIV2
ETR input source is divided by 2
TIM_ETRPRESCALER_DIV4
ETR input source is divided by 4
TIM_ETRPRESCALER_DIV8
ETR input source is divided by 8
TIM Event Source
TIM_EVENTSOURCE_UPDATE
TIM_EVENTSOURCE_CC1
TIM_EVENTSOURCE_CC2
606/692
DOCID028236 Rev 1
UM1940
UM1940
HAL TIM Generic Driver
TIM_EVENTSOURCE_CC3
TIM_EVENTSOURCE_CC4
TIM_EVENTSOURCE_COM
TIM_EVENTSOURCE_TRIGGER
TIM_EVENTSOURCE_BREAK
TIM Exported Macros
__HAL_TIM_RESET_HANDLE_ST
ATE
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:

__HANDLE__: TIM handle
Return value:

None
Description:
__HAL_TIM_DISABLE

Disable the TIM peripheral.
Parameters:

__HANDLE__: TIM handle
Return value:

__HAL_TIM_MOE_DISABLE
None
Description:

Disable the TIM main Output.
Parameters:

__HANDLE__: TIM handle
Return value:

None
DOCID028236 Rev 1
607/692
HAL TIM Generic Driver
__HAL_TIM_ENABLE_IT
UM1940
__HAL_TIM_ENABLE_DMA
__HAL_TIM_DISABLE_IT
__HAL_TIM_DISABLE_DMA
__HAL_TIM_GET_FLAG
__HAL_TIM_CLEAR_FLAG
__HAL_TIM_GET_IT_SOURCE
__HAL_TIM_CLEAR_IT
__HAL_TIM_IS_TIM_COUNTING_
DOWN
__HAL_TIM_SET_PRESCALER
TIM_SET_ICPRESCALERVALUE
TIM_RESET_ICPRESCALERVAL
UE
TIM_SET_CAPTUREPOLARITY
TIM_RESET_CAPTUREPOLARIT
Y
__HAL_TIM_SET_COMPARE
Description:

Sets the TIM Capture Compare Register value
on runtime without calling another time
ConfigChannel function.
Parameters:



__HANDLE__: TIM handle.
__CHANNEL__: : TIM Channels to be
configured. This parameter can be one of the
following values:

TIM_CHANNEL_1: TIM Channel 1
selected

TIM_CHANNEL_2: TIM Channel 2
selected

TIM_CHANNEL_3: TIM Channel 3
selected

TIM_CHANNEL_4: TIM Channel 4
selected
__COMPARE__: specifies the Capture
Compare register new value.
Return value:

__HAL_TIM_GET_COMPARE
None
Description:

Gets the TIM Capture Compare Register value
on runtime.
Parameters:

608/692
__HANDLE__: TIM handle.
DOCID028236 Rev 1
UM1940
HAL TIM Generic Driver

__CHANNEL__: : TIM Channel associated with
the capture compare register This parameter
can be one of the following values:

TIM_CHANNEL_1: get capture/compare 1
register value

TIM_CHANNEL_2: get capture/compare 2
register value

TIM_CHANNEL_3: get capture/compare 3
register value

TIM_CHANNEL_4: get capture/compare 4
register value
Return value:

__HAL_TIM_SET_COUNTER
None
Description:

Sets the TIM Counter Register value on
runtime.
Parameters:


__HANDLE__: TIM handle.
__COUNTER__: specifies the Counter register
new value.
Return value:

__HAL_TIM_GET_COUNTER
None
Description:

Gets the TIM Counter Register value on
runtime.
Parameters:

__HANDLE__: TIM handle.
Return value:

__HAL_TIM_SET_AUTORELOAD
None
Description:

Sets the TIM Autoreload Register value on
runtime without calling another time any Init
function.
Parameters:


__HANDLE__: TIM handle.
__AUTORELOAD__: specifies the Counter
register new value.
Return value:

__HAL_TIM_GET_AUTORELOAD
None
Description:

Gets the TIM Autoreload Register value on
runtime.
DOCID028236 Rev 1
609/692
HAL TIM Generic Driver
UM1940
Parameters:

__HANDLE__: TIM handle.
Return value:

__HAL_TIM_SET_CLOCKDIVISIO
N
None
Description:

Sets the TIM Clock Division value on runtime
without calling another time any Init function.
Parameters:


__HANDLE__: TIM handle.
__CKD__: specifies the clock division value.
This parameter can be one of the following
value:

TIM_CLOCKDIVISION_DIV1

TIM_CLOCKDIVISION_DIV2

TIM_CLOCKDIVISION_DIV4
Return value:

__HAL_TIM_GET_CLOCKDIVISIO
N
None
Description:

Gets the TIM Clock Division value on runtime.
Parameters:

__HANDLE__: TIM handle.
Return value:

__HAL_TIM_SET_ICPRESCALER
None
Description:

Sets the TIM Input Capture prescaler on
runtime without calling another time
Parameters:



610/692
__HANDLE__: TIM handle.
__CHANNEL__: : TIM Channels to be
configured. This parameter can be one of the
following values:

TIM_CHANNEL_1: TIM Channel 1
selected

TIM_CHANNEL_2: TIM Channel 2
selected

TIM_CHANNEL_3: TIM Channel 3
selected

TIM_CHANNEL_4: TIM Channel 4
selected
__ICPSC__: specifies the Input Capture4
prescaler new value. This parameter can be
one of the following values:

TIM_ICPSC_DIV1: no prescaler

TIM_ICPSC_DIV2: capture is done once
DOCID028236 Rev 1
UM1940


HAL TIM Generic Driver
every 2 events
TIM_ICPSC_DIV4: capture is done once
every 4 events
TIM_ICPSC_DIV8: capture is done once
every 8 events
Return value:

__HAL_TIM_GET_ICPRESCALER
None
Description:

Gets the TIM Input Capture prescaler on
runtime.
Parameters:


__HANDLE__: TIM handle.
__CHANNEL__: : TIM Channels to be
configured. This parameter can be one of the
following values:

TIM_CHANNEL_1: get input capture 1
prescaler value

TIM_CHANNEL_2: get input capture 2
prescaler value

TIM_CHANNEL_3: get input capture 3
prescaler value

TIM_CHANNEL_4: get input capture 4
prescaler value
Return value:

None
Description:
__HAL_TIM_URS_ENABLE

Set the Update Request Source (URS) bit of the
TIMx_CR1 register.
Parameters:

__HANDLE__: TIM handle.
Return value:

None
Notes:

__HAL_TIM_URS_DISABLE
When the USR bit of the TIMx_CR1 register is
set, only counter overflow/underflow generates
an update interrupt or DMA request (if enabled)
Description:

Reset the Update Request Source (URS) bit of
the TIMx_CR1 register.
Parameters:

__HANDLE__: TIM handle.
Return value:
DOCID028236 Rev 1
611/692
HAL TIM Generic Driver
UM1940

None
Notes:

__HAL_TIM_SET_CAPTUREPOL
ARITY
When the USR bit of the TIMx_CR1 register is
reset, any of the following events generate an
update interrupt or DMA request (if enabled): _
Counter overflow/underflow _ Setting the UG bit
_ Update generation through the slave mode
controller
Description:

Sets the TIM Capture x input polarity on
runtime.
Parameters:



__HANDLE__: TIM handle.
__CHANNEL__: TIM Channels to be
configured. This parameter can be one of the
following values:

TIM_CHANNEL_1: TIM Channel 1
selected

TIM_CHANNEL_2: TIM Channel 2
selected

TIM_CHANNEL_3: TIM Channel 3
selected

TIM_CHANNEL_4: TIM Channel 4
selected
__POLARITY__: Polarity for TIx source

TIM_INPUTCHANNELPOLARITY_RISING
: Rising Edge

TIM_INPUTCHANNELPOLARITY_FALLIN
G: Falling Edge

TIM_INPUTCHANNELPOLARITY_BOTHE
DGE: Rising and Falling Edge
Return value:

None
Notes:

The polarity
TIM_INPUTCHANNELPOLARITY_BOTHEDGE
is not authorized for TIM Channel 4.
TIM Flag definition
TIM_FLAG_UPDATE
TIM_FLAG_CC1
TIM_FLAG_CC2
TIM_FLAG_CC3
TIM_FLAG_CC4
TIM_FLAG_COM
TIM_FLAG_TRIGGER
612/692
DOCID028236 Rev 1
UM1940
HAL TIM Generic Driver
TIM_FLAG_BREAK
TIM_FLAG_CC1OF
TIM_FLAG_CC2OF
TIM_FLAG_CC3OF
TIM_FLAG_CC4OF
TIM Input Capture Polarity
TIM_ICPOLARITY_RISING
TIM_ICPOLARITY_FALLING
TIM_ICPOLARITY_BOTHEDGE
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
Capture performed once every 4 events
TIM_ICPSC_DIV8
Capture performed once every 8 events
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
TIM Input 1, 2, 3 or 4 is selected to be connected to
IC2, IC1, IC4 or IC3, respectively
TIM_ICSELECTION_TRC
TIM Input 1, 2, 3 or 4 is selected to be connected to
TRC
TIM Input Channel Polarity
TIM_INPUTCHANNELPOLARITY_RISING
Polarity for TIx source
TIM_INPUTCHANNELPOLARITY_FALLING
Polarity for TIx source
TIM_INPUTCHANNELPOLARITY_BOTHEDGE
Polarity for TIx source
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 Private macros to check input parameters
IS_TIM_COUNTER_MODE
IS_TIM_CLOCKDIVISION_DIV
DOCID028236 Rev 1
613/692
HAL TIM Generic Driver
IS_TIM_PWM_MODE
UM1940
IS_TIM_OC_MODE
IS_TIM_FAST_STATE
IS_TIM_OC_POLARITY
IS_TIM_OCN_POLARITY
IS_TIM_OCIDLE_STATE
IS_TIM_OCNIDLE_STATE
IS_TIM_CHANNELS
IS_TIM_OPM_CHANNELS
IS_TIM_COMPLEMENTARY_CHANNELS
IS_TIM_IC_POLARITY
IS_TIM_IC_SELECTION
IS_TIM_IC_PRESCALER
IS_TIM_OPM_MODE
IS_TIM_DMA_SOURCE
IS_TIM_ENCODER_MODE
IS_TIM_EVENT_SOURCE
IS_TIM_CLOCKSOURCE
IS_TIM_CLOCKPOLARITY
IS_TIM_CLOCKPRESCALER
IS_TIM_CLOCKFILTER
IS_TIM_CLEARINPUT_SOURCE
IS_TIM_CLEARINPUT_POLARITY
IS_TIM_CLEARINPUT_PRESCALER
IS_TIM_CLEARINPUT_FILTER
IS_TIM_OSSR_STATE
IS_TIM_OSSI_STATE
IS_TIM_LOCK_LEVEL
IS_TIM_BREAK_STATE
IS_TIM_BREAK_POLARITY
IS_TIM_AUTOMATIC_OUTPUT_STATE
IS_TIM_TRGO_SOURCE
IS_TIM_SLAVE_MODE
IS_TIM_MSM_STATE
IS_TIM_TRIGGER_SELECTION
IS_TIM_INTERNAL_TRIGGEREVENT_SELECTION
614/692
DOCID028236 Rev 1
UM1940
HAL TIM Generic Driver
IS_TIM_TRIGGERPOLARITY
IS_TIM_TRIGGERPRESCALER
IS_TIM_TRIGGERFILTER
IS_TIM_TI1SELECTION
IS_TIM_DMA_BASE
IS_TIM_DMA_LENGTH
IS_TIM_IC_FILTER
TIM Lock level
TIM_LOCKLEVEL_OFF
TIM_LOCKLEVEL_1
TIM_LOCKLEVEL_2
TIM_LOCKLEVEL_3
TIM Mask Definition
TIM_CCER_CCxE_MASK
TIM_CCER_CCxNE_MASK
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
TIM Master Slave Mode
TIM_MASTERSLAVEMODE_ENABLE
TIM_MASTERSLAVEMODE_DISABLE
TIM One Pulse Mode
TIM_OPMODE_SINGLE
TIM_OPMODE_REPETITIVE
TIM OSSI OffState Selection for Idle mode state
TIM_OSSI_ENABLE
TIM_OSSI_DISABLE
TIM OSSR OffState Selection for Run mode state
TIM_OSSR_ENABLE
TIM_OSSR_DISABLE
TIM Output Compare and PWM modes
DOCID028236 Rev 1
615/692
HAL TIM Generic Driver
TIM_OCMODE_TIMING
UM1940
TIM_OCMODE_ACTIVE
TIM_OCMODE_INACTIVE
TIM_OCMODE_TOGGLE
TIM_OCMODE_PWM1
TIM_OCMODE_PWM2
TIM_OCMODE_FORCED_ACTIVE
TIM_OCMODE_FORCED_INACTIVE
TIM Output Compare Idle State
TIM_OCIDLESTATE_SET
TIM_OCIDLESTATE_RESET
TIM Output Compare N Idle State
TIM_OCNIDLESTATE_SET
TIM_OCNIDLESTATE_RESET
TIM Output CompareN Polarity
TIM_OCNPOLARITY_HIGH
TIM_OCNPOLARITY_LOW
TIM Output Compare Polarity
TIM_OCPOLARITY_HIGH
TIM_OCPOLARITY_LOW
TIM Output Fast State
TIM_OCFAST_DISABLE
TIM_OCFAST_ENABLE
TIM Slave Mode
TIM_SLAVEMODE_DISABLE
TIM_SLAVEMODE_RESET
TIM_SLAVEMODE_GATED
TIM_SLAVEMODE_TRIGGER
TIM_SLAVEMODE_EXTERNAL1
TIM TI1 Selection
TIM_TI1SELECTION_CH1
TIM_TI1SELECTION_XORCOMBINATION
TIM Trigger Polarity
616/692
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
DOCID028236 Rev 1
UM1940
HAL TIM Generic Driver
Polarity for TIxFPx or TI1_ED trigger
sources
TIM_TRIGGERPOLARITY_FALLING
TIM_TRIGGERPOLARITY_BOTHEDGE
Polarity for TIxFPx or TI1_ED trigger
sources
TIM Trigger Prescaler
TIM_TRIGGERPRESCALER_DIV1
No prescaler is used
TIM_TRIGGERPRESCALER_DIV2
Prescaler for External ETR Trigger: Capture
performed once every 2 events.
TIM_TRIGGERPRESCALER_DIV4
Prescaler for External ETR Trigger: Capture
performed once every 4 events.
TIM_TRIGGERPRESCALER_DIV8
Prescaler for External ETR Trigger: Capture
performed once every 8 events.
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
DOCID028236 Rev 1
617/692
HAL TIM Extension Driver
UM1940
43
HAL TIM Extension Driver
43.1
TIMEx Firmware driver registers structures
43.1.1
TIM_HallSensor_InitTypeDef
Data Fields




uint32_t IC1Polarity
uint32_t IC1Prescaler
uint32_t IC1Filter
uint32_t Commutation_Delay
Field Documentation




43.1.2
uint32_t TIM_HallSensor_InitTypeDef::IC1Polarity
Specifies the active edge of the input signal. This parameter can be a value of
TIM_Input_Capture_Polarity
uint32_t TIM_HallSensor_InitTypeDef::IC1Prescaler
Specifies the Input Capture Prescaler. This parameter can be a value of
TIM_Input_Capture_Prescaler
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
Data Fields


uint32_t MasterOutputTrigger
uint32_t MasterSlaveMode
Field Documentation


43.1.3
618/692
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
DOCID028236 Rev 1
UM1940
HAL TIM Extension Driver
Data Fields







uint32_t OffStateRunMode
uint32_t OffStateIDLEMode
uint32_t LockLevel
uint32_t DeadTime
uint32_t BreakState
uint32_t BreakPolarity
uint32_t AutomaticOutput
Field Documentation







uint32_t