Description Of STM32F0 HAL And Low Layer Drivers Manual
User Manual:
Open the PDF directly: View PDF 
.
Page Count: 1320
| Download | |
| Open PDF In Browser | View PDF |
UM1785
User manual
Description of STM32F0 HAL and low-layer drivers
Introduction
TM
STMCube is an STMicroelectronics original initiative to make developers' lives easier by reducing
development effort, time and cost. STM32Cube covers the whole STM32 portfolio.
STM32Cube Version 1.x includes:
STM32CubeMX, a graphical software configuration tool that allows the generation of C initialization
code using graphical wizards.
A comprehensive embedded software platform, delivered per series (such as STM32CubeF0 for
STM32F0 series)
The STM32Cube Hardware Abstraction Layer (HAL), STM32 abstraction layer embedded
software ensuring maximized portability across the STM32 portfolio
Low-layer APIs (LL) offering a fast light-weight expert-oriented layer which is closer to the
hardware than the HAL. LL APIs are available only for a set of peripherals.
A consistent set of middleware components such as RTOS, USB, TCP/IP, Graphics
All embedded software, utilities delivered with a full set of examples.
The HAL driver layer provides a generic multi-instance simple set of APIs (application programming
interfaces) to interact with the upper layer (application, libraries and stacks).
The HAL driver 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 line or part number. 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, manage data transfers in polling mode, handle interrupts
or DMA, and manage communication errors.
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 such as basic timer, capture, or pulse width
modulation (PWM). The HAL driver layer implements run-time failure detection by checking the input
values of all functions. Such dynamic checking contributes to enhance the firmware robustness. Runtime detection is also suitable for user application development and debugging.
The LL drivers offer hardware services based on the available features of the STM32 peripherals. These
services reflect exactly the hardware capabilities and provide atomic operations that must be called
following the programming model described in the product line reference manual. As a result, the LL
services are not based on standalone processes and do not require any additional memory resources to
save their states, counter or data pointers: all operations are performed by changing the associated
peripheral registers content. Contrary to the HAL, the LL APIs are not provided for peripherals for which
optimized access is not a key feature, or for those requiring heavy software configuration and/or
complex upper level stack (such as USB).
The HAL and LL drivers are complementary and cover a wide range of applications requirements:
The HAL offers high-level and feature-oriented APIs, with a high-portability level. They hide the
MCU and peripheral complexity to end-user.
The LL offers low-level APIs at registers level, with better optimization but less portability. They
require deep knowledge of the MCU and peripherals specifications.
HAL and LL 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.
September 2017
DocID026525 Rev 6
1/1320
www.st.com
Contents
UM1785
Contents
1
Acronyms and definitions............................................................. 24
2
Overview of HAL drivers ............................................................... 26
2.1
2.2
2/1320
2.1.1
HAL driver files ................................................................................. 26
2.1.2
User-application files ........................................................................ 27
HAL data structures ........................................................................ 29
2.2.1
Peripheral handle structures ............................................................ 29
2.2.2
Initialization and configuration structure ........................................... 30
2.2.3
Specific process structures .............................................................. 30
2.3
API classification ............................................................................. 31
2.4
Devices supported by HAL drivers .................................................. 32
2.5
HAL driver rules .............................................................................. 35
2.5.1
HAL API naming rules ...................................................................... 35
2.5.2
HAL general naming rules ................................................................ 36
2.5.3
HAL interrupt handler and callback functions ................................... 37
2.6
HAL generic APIs ............................................................................ 38
2.7
HAL extension APIs ........................................................................ 39
2.7.1
HAL extension model overview ........................................................ 39
2.7.2
HAL extension model cases ............................................................. 40
2.8
File inclusion model......................................................................... 42
2.9
HAL common resources .................................................................. 43
2.10
HAL configuration............................................................................ 43
2.11
HAL system peripheral handling ..................................................... 45
2.12
3
HAL and user-application files......................................................... 26
2.11.1
Clock ................................................................................................. 45
2.11.2
GPIOs ............................................................................................... 45
2.11.3
Cortex NVIC and SysTick timer........................................................ 47
2.11.4
PWR ................................................................................................. 47
2.11.5
EXTI .................................................................................................. 48
2.11.6
DMA .................................................................................................. 49
How to use HAL drivers .................................................................. 50
2.12.1
HAL usage models ........................................................................... 50
2.12.2
HAL initialization ............................................................................... 51
2.12.3
HAL IO operation process ................................................................ 53
2.12.4
Timeout and error management ....................................................... 56
Overview of low-layer drivers ....................................................... 60
DocID026525 Rev 6
UM1785
4
5
Contents
3.1
Low-layer files ................................................................................. 60
3.2
Overview of low-layer APIs and naming rules ................................. 62
3.2.1
Peripheral initialization functions ...................................................... 62
3.2.2
Peripheral register-level configuration functions .............................. 65
Cohabiting of HAL and LL ............................................................ 67
4.1
Low-layer driver used in standalone mode ...................................... 67
4.2
Mixed use of low-layer APIs and HAL drivers ................................. 67
HAL System Driver ........................................................................ 68
5.1
5.2
HAL Firmware driver API description .............................................. 68
5.1.1
How to use this driver ....................................................................... 68
5.1.2
Initialization and de-initialization functions ....................................... 68
5.1.3
HAL Control functions....................................................................... 68
5.1.4
Detailed description of functions ...................................................... 69
HAL Firmware driver defines ........................................................... 73
5.2.1
6
HAL ADC Generic Driver ............................................................... 79
6.1
6.2
6.3
ADC Firmware driver registers structures ....................................... 79
6.1.1
ADC_InitTypeDef .............................................................................. 79
6.1.2
ADC_ChannelConfTypeDef ............................................................. 81
6.1.3
ADC_AnalogWDGConfTypeDef ....................................................... 81
6.1.4
ADC_HandleTypeDef ....................................................................... 82
ADC Firmware driver API description .............................................. 82
6.2.1
ADC peripheral features ................................................................... 82
6.2.2
How to use this driver ....................................................................... 83
6.2.3
Initialization and de-initialization functions ....................................... 85
6.2.4
IO operation functions ...................................................................... 85
6.2.5
Peripheral Control functions ............................................................. 86
6.2.6
Peripheral State and Errors functions .............................................. 86
6.2.7
Detailed description of functions ...................................................... 86
ADC Firmware driver defines .......................................................... 92
6.3.1
7
ADC .................................................................................................. 92
HAL ADC Extension Driver ......................................................... 100
7.1
8
HAL ................................................................................................... 73
ADCEx Firmware driver API description ....................................... 100
7.1.1
IO operation functions .................................................................... 100
7.1.2
Detailed description of functions .................................................... 100
HAL CAN Generic Driver ............................................................. 101
DocID026525 Rev 6
3/1320
Contents
UM1785
8.1
8.2
8.3
CAN Firmware driver registers structures ..................................... 101
8.1.1
CAN_InitTypeDef ............................................................................ 101
8.1.2
CAN_FilterConfTypeDef ................................................................. 102
8.1.3
CanTxMsgTypeDef......................................................................... 103
8.1.4
CanRxMsgTypeDef ........................................................................ 103
8.1.5
CAN_HandleTypeDef ..................................................................... 104
CAN Firmware driver API description ............................................ 104
8.2.1
How to use this driver ..................................................................... 104
8.2.2
Initialization and de-initialization functions ..................................... 105
8.2.3
Peripheral State and Error functions .............................................. 106
8.2.4
Detailed description of functions .................................................... 106
CAN Firmware driver defines ........................................................ 109
8.3.1
9
HAL CEC Generic Driver ............................................................. 118
9.1
9.2
9.3
CEC Firmware driver registers structures ..................................... 118
9.1.1
CEC_InitTypeDef ............................................................................ 118
9.1.2
CEC_HandleTypeDef ..................................................................... 119
CEC Firmware driver API description ............................................ 120
9.2.1
How to use this driver ..................................................................... 120
9.2.2
Initialization and Configuration functions ........................................ 120
9.2.3
IO operation functions .................................................................... 120
9.2.4
Peripheral Control function ............................................................. 121
9.2.5
Detailed description of functions .................................................... 121
CEC Firmware driver defines ........................................................ 124
9.3.1
10
CEC ................................................................................................ 124
HAL COMP Generic Driver .......................................................... 133
10.1
10.2
4/1320
CAN ................................................................................................ 109
COMP Firmware driver registers structures .................................. 133
10.1.1
COMP_InitTypeDef ........................................................................ 133
10.1.2
COMP_HandleTypeDef .................................................................. 133
COMP Firmware driver API description ........................................ 134
10.2.1
COMP Peripheral features ............................................................. 134
10.2.2
How to use this driver ..................................................................... 134
10.2.3
Initialization and Configuration functions ........................................ 135
10.2.4
IO operation functions .................................................................... 135
10.2.5
Peripheral Control functions ........................................................... 135
10.2.6
Peripheral State functions .............................................................. 135
10.2.7
Detailed description of functions .................................................... 135
DocID026525 Rev 6
UM1785
Contents
10.3
COMP Firmware driver defines ..................................................... 138
10.3.1
11
HAL CORTEX Generic Driver ...................................................... 146
11.1
11.2
CORTEX Firmware driver API description .................................... 146
11.1.1
How to use this driver ..................................................................... 146
11.1.2
Initialization and de-initialization functions ..................................... 146
11.1.3
Peripheral Control functions ........................................................... 147
11.1.4
Detailed description of functions .................................................... 147
CORTEX Firmware driver defines ................................................. 150
11.2.1
12
12.2
12.3
CRC Firmware driver registers structures ..................................... 151
12.1.1
CRC_InitTypeDef ........................................................................... 151
12.1.2
CRC_HandleTypeDef ..................................................................... 152
CRC Firmware driver API description ........................................... 152
12.2.1
How to use this driver ..................................................................... 152
12.2.2
Initialization and de-initialization functions ..................................... 152
12.2.3
Peripheral Control functions ........................................................... 153
12.2.4
Peripheral State functions .............................................................. 153
12.2.5
Detailed description of functions .................................................... 153
CRC Firmware driver defines ........................................................ 155
12.3.1
CRC ................................................................................................ 155
HAL CRC Extension Driver ......................................................... 157
13.1
13.2
CRCEx Firmware driver API description ....................................... 157
13.1.1
How to use this driver ..................................................................... 157
13.1.2
Initialization and Configuration functions ........................................ 157
13.1.3
Detailed description of functions .................................................... 157
CRCEx Firmware driver defines .................................................... 159
13.2.1
14
CORTEX ......................................................................................... 150
HAL CRC Generic Driver ............................................................. 151
12.1
13
COMP ............................................................................................. 138
CRCEx ............................................................................................ 159
HAL DAC Generic Driver ............................................................. 161
14.1
14.2
DAC Firmware driver registers structures ..................................... 161
14.1.1
DAC_HandleTypeDef ..................................................................... 161
14.1.2
DAC_ChannelConfTypeDef ........................................................... 161
DAC Firmware driver API description ............................................ 162
14.2.1
DAC Peripheral features................................................................. 162
14.2.2
How to use this driver ..................................................................... 163
DocID026525 Rev 6
5/1320
Contents
14.3
14.2.3
UM1785
Initialization and de-initialization functions ..................................... 164
14.2.4
IO operation functions .................................................................... 164
14.2.5
Peripheral Control functions ........................................................... 165
14.2.6
Peripheral State and Errors functions ............................................ 165
14.2.7
Detailed description of functions .................................................... 165
DAC Firmware driver defines ........................................................ 170
14.3.1
15
HAL DAC Extension Driver ......................................................... 174
15.1
15.2
DACEx Firmware driver API description ....................................... 174
15.1.1
How to use this driver ..................................................................... 174
15.1.2
Extended features functions ........................................................... 174
15.1.3
Detailed description of functions .................................................... 174
DACEx Firmware driver defines .................................................... 177
15.2.1
16
16.2
16.3
DMA Firmware driver registers structures ..................................... 179
16.1.1
DMA_InitTypeDef ........................................................................... 179
16.1.2
__DMA_HandleTypeDef................................................................. 179
DMA Firmware driver API description ........................................... 180
16.2.1
How to use this driver ..................................................................... 180
16.2.2
Initialization and de-initialization functions ..................................... 181
16.2.3
IO operation functions .................................................................... 181
16.2.4
State and Errors functions .............................................................. 182
16.2.5
Detailed description of functions .................................................... 182
DMA Firmware driver defines ........................................................ 185
16.3.1
DMAEx Firmware driver defines.................................................... 190
17.1.1
DMAEx............................................................................................ 190
HAL FLASH Generic Driver......................................................... 197
18.1
FLASH Firmware driver registers structures ................................. 197
18.1.1
18.2
6/1320
DMA ................................................................................................ 185
HAL DMA Extension Driver......................................................... 190
17.1
18
DACEx ............................................................................................ 177
HAL DMA Generic Driver ............................................................ 179
16.1
17
DAC ................................................................................................ 170
FLASH_ProcessTypeDef ............................................................... 197
FLASH Firmware driver API description ........................................ 197
18.2.1
FLASH peripheral features ............................................................. 197
18.2.2
How to use this driver ..................................................................... 197
18.2.3
Peripheral Control functions ........................................................... 198
DocID026525 Rev 6
UM1785
Contents
18.3
18.2.4
Peripheral Errors functions ............................................................. 198
18.2.5
Detailed description of functions .................................................... 199
FLASH Firmware driver defines .................................................... 201
18.3.1
19
HAL FLASH Extension Driver ..................................................... 204
19.1
19.2
19.3
FLASHEx Firmware driver registers structures ............................. 204
19.1.1
FLASH_EraseInitTypeDef .............................................................. 204
19.1.2
FLASH_OBProgramInitTypeDef .................................................... 204
FLASHEx Firmware driver API description.................................... 205
19.2.1
FLASH Erasing Programming functions ......................................... 205
19.2.2
Option Bytes Programming functions ............................................. 205
19.2.3
Detailed description of functions .................................................... 205
FLASHEx Firmware driver defines ................................................ 207
19.3.1
20
GPIO Firmware driver registers structures .................................... 210
20.1.1
20.2
20.3
GPIO_InitTypeDef .......................................................................... 210
GPIO Firmware driver API description .......................................... 210
20.2.1
GPIO Peripheral features ............................................................... 210
20.2.2
How to use this driver ..................................................................... 211
20.2.3
Initialization and de-initialization functions ..................................... 211
20.2.4
IO operation functions .................................................................... 211
20.2.5
Detailed description of functions .................................................... 212
GPIO Firmware driver defines ....................................................... 214
20.3.1
GPIO ............................................................................................... 214
HAL GPIO Extension Driver ........................................................ 217
21.1
GPIOEx Firmware driver defines................................................... 217
21.1.1
22
FLASHEx ........................................................................................ 207
HAL GPIO Generic Driver............................................................ 210
20.1
21
FLASH ............................................................................................ 201
GPIOEx .......................................................................................... 217
HAL I2C Generic Driver ............................................................... 220
22.1
22.2
I2C Firmware driver registers structures ....................................... 220
22.1.1
I2C_InitTypeDef .............................................................................. 220
22.1.2
__I2C_HandleTypeDef ................................................................... 220
I2C Firmware driver API description .............................................. 221
22.2.1
How to use this driver ..................................................................... 221
22.2.2
Initialization and de-initialization functions ..................................... 226
22.2.3
IO operation functions .................................................................... 226
DocID026525 Rev 6
7/1320
Contents
22.3
22.2.4
UM1785
Peripheral State, Mode and Error functions ................................... 228
22.2.5
Detailed description of functions .................................................... 228
I2C Firmware driver defines .......................................................... 240
22.3.1
23
HAL I2C Extension Driver ........................................................... 247
23.1
23.2
I2CEx Firmware driver API description ......................................... 247
23.1.1
I2C peripheral Extended features ................................................... 247
23.1.2
How to use this driver ..................................................................... 247
23.1.3
Extended features functions ........................................................... 247
23.1.4
Detailed description of functions .................................................... 247
I2CEx Firmware driver defines ...................................................... 249
23.2.1
24
24.2
24.3
I2S Firmware driver registers structures ....................................... 250
24.1.1
I2S_InitTypeDef .............................................................................. 250
24.1.2
I2S_HandleTypeDef ....................................................................... 250
I2S Firmware driver API description .............................................. 251
24.2.1
How to use this driver ..................................................................... 251
24.2.2
Initialization and de-initialization functions ..................................... 253
24.2.3
IO operation functions .................................................................... 253
24.2.4
Peripheral State and Errors functions ............................................ 254
24.2.5
Detailed description of functions .................................................... 254
I2S Firmware driver defines .......................................................... 260
24.3.1
I2S .................................................................................................. 260
HAL IRDA Generic Driver ............................................................ 264
25.1
25.2
25.3
IRDA Firmware driver registers structures .................................... 264
25.1.1
IRDA_InitTypeDef ........................................................................... 264
25.1.2
IRDA_HandleTypeDef .................................................................... 264
IRDA Firmware driver API description ........................................... 265
25.2.1
How to use this driver ..................................................................... 265
25.2.2
Initialization and Configuration functions ........................................ 267
25.2.3
IO operation functions .................................................................... 267
25.2.4
Peripheral State and Error functions .............................................. 269
25.2.5
Detailed description of functions .................................................... 269
IRDA Firmware driver defines ....................................................... 279
25.3.1
8/1320
I2CEx .............................................................................................. 249
HAL I2S Generic Driver ............................................................... 250
24.1
25
I2C .................................................................................................. 240
IRDA ............................................................................................... 279
DocID026525 Rev 6
UM1785
26
Contents
HAL IRDA Extension Driver ........................................................ 287
26.1
IRDAEx Firmware driver defines ................................................... 287
26.1.1
27
HAL IWDG Generic Driver ........................................................... 288
27.1
27.2
27.3
IWDG Firmware driver registers structures ................................... 288
27.1.1
IWDG_InitTypeDef ......................................................................... 288
27.1.2
IWDG_HandleTypeDef ................................................................... 288
IWDG Firmware driver API description ......................................... 288
27.2.1
IWDG Generic features .................................................................. 288
27.2.2
How to use this driver ..................................................................... 289
27.2.3
Initialization and Start functions ...................................................... 289
27.2.4
IO operation functions .................................................................... 289
27.2.5
Detailed description of functions .................................................... 290
IWDG Firmware driver defines ...................................................... 290
27.3.1
28
28.2
28.3
PCD Firmware driver registers structures ..................................... 292
28.1.1
PCD_InitTypeDef ............................................................................ 292
28.1.2
PCD_EPTypeDef ............................................................................ 292
28.1.3
PCD_HandleTypeDef ..................................................................... 293
PCD Firmware driver API description ............................................ 294
28.2.1
How to use this driver ..................................................................... 294
28.2.2
Initialization and de-initialization functions ..................................... 294
28.2.3
IO operation functions .................................................................... 294
28.2.4
Peripheral Control functions ........................................................... 295
28.2.5
Peripheral State functions .............................................................. 295
28.2.6
Detailed description of functions .................................................... 295
PCD Firmware driver defines ........................................................ 302
28.3.1
PCD ................................................................................................ 302
HAL PCD Extension Driver ......................................................... 304
29.1
30
IWDG .............................................................................................. 290
HAL PCD Generic Driver ............................................................. 292
28.1
29
IRDAEx ........................................................................................... 287
PCDEx Firmware driver API description ....................................... 304
29.1.1
Extended Peripheral Control functions ........................................... 304
29.1.2
Detailed description of functions .................................................... 304
HAL PWR Generic Driver ............................................................ 305
30.1
PWR Firmware driver API description ........................................... 305
30.1.1
Initialization and de-initialization functions ..................................... 305
DocID026525 Rev 6
9/1320
Contents
30.2
30.1.2
UM1785
Peripheral Control functions ........................................................... 305
30.1.3
Detailed description of functions .................................................... 307
PWR Firmware driver defines ....................................................... 310
30.2.1
31
HAL PWR Extension Driver ........................................................ 312
31.1
PWREx Firmware driver registers structures ................................ 312
31.1.1
31.2
31.3
31.2.1
Peripheral extended control functions ............................................ 312
31.2.2
Detailed description of functions .................................................... 313
PWREx Firmware driver defines ................................................... 314
PWREx ........................................................................................... 314
HAL RCC Generic Driver ............................................................. 319
32.1
32.2
32.3
RCC Firmware driver registers structures ..................................... 319
32.1.1
RCC_PLLInitTypeDef ..................................................................... 319
32.1.2
RCC_OscInitTypeDef ..................................................................... 319
32.1.3
RCC_ClkInitTypeDef ...................................................................... 320
RCC Firmware driver API description ........................................... 320
32.2.1
RCC specific features ..................................................................... 320
32.2.2
RCC Limitations .............................................................................. 321
32.2.3
Initialization and de-initialization functions ..................................... 321
32.2.4
Peripheral Control functions ........................................................... 322
32.2.5
Detailed description of functions .................................................... 322
RCC Firmware driver defines ........................................................ 327
32.3.1
33
PWR_PVDTypeDef ........................................................................ 312
PWREx Firmware driver API description ....................................... 312
31.3.1
32
PWR ............................................................................................... 310
RCC ................................................................................................ 327
HAL RCC Extension Driver ......................................................... 346
33.1
33.2
33.3
RCCEx Firmware driver registers structures ................................. 346
33.1.1
RCC_PeriphCLKInitTypeDef .......................................................... 346
33.1.2
RCC_CRSInitTypeDef .................................................................... 346
33.1.3
RCC_CRSSynchroInfoTypeDef ..................................................... 347
RCCEx Firmware driver API description ....................................... 348
33.2.1
Extended Peripheral Control functions ........................................... 348
33.2.2
Extended Clock Recovery System Control functions ..................... 348
33.2.3
Detailed description of functions .................................................... 349
RCCEx Firmware driver defines .................................................... 352
33.3.1
10/1320
RCCEx ............................................................................................ 352
DocID026525 Rev 6
UM1785
34
Contents
HAL RTC Generic Driver ............................................................. 366
34.1
34.2
34.3
RTC Firmware driver registers structures ..................................... 366
34.1.1
RTC_InitTypeDef ............................................................................ 366
34.1.2
RTC_TimeTypeDef......................................................................... 366
34.1.3
RTC_DateTypeDef ......................................................................... 367
34.1.4
RTC_AlarmTypeDef ....................................................................... 367
34.1.5
RTC_HandleTypeDef ..................................................................... 368
RTC Firmware driver API description ............................................ 368
34.2.1
How to use RTC Driver................................................................... 368
34.2.2
RTC and low power modes ............................................................ 369
34.2.3
Initialization and de-initialization functions ..................................... 369
34.2.4
RTC Time and Date functions ........................................................ 370
34.2.5
RTC Alarm functions ...................................................................... 370
34.2.6
Peripheral Control functions ........................................................... 370
34.2.7
Peripheral State functions .............................................................. 370
34.2.8
Detailed description of functions .................................................... 370
RTC Firmware driver defines ........................................................ 376
34.3.1
35
HAL RTC Extension Driver ......................................................... 385
35.1
RTCEx Firmware driver registers structures ................................. 385
35.1.1
35.2
35.3
RTC_TamperTypeDef .................................................................... 385
RTCEx Firmware driver API description ........................................ 386
35.2.1
How to use this driver ..................................................................... 386
35.2.2
RTC TimeStamp and Tamper functions ......................................... 386
35.2.3
RTC Wake-up functions ................................................................. 387
35.2.4
Extended Peripheral Control functions ........................................... 387
35.2.5
Detailed description of functions .................................................... 388
RTCEx Firmware driver defines .................................................... 396
35.3.1
36
RTC ................................................................................................ 376
RTCEx ............................................................................................ 396
HAL SMARTCARD Generic Driver.............................................. 413
36.1
36.2
SMARTCARD Firmware driver registers structures ...................... 413
36.1.1
SMARTCARD_InitTypeDef ............................................................ 413
36.1.2
SMARTCARD_AdvFeatureInitTypeDef .......................................... 414
36.1.3
SMARTCARD_HandleTypeDef ...................................................... 415
SMARTCARD Firmware driver API description............................. 416
36.2.1
How to use this driver ..................................................................... 416
DocID026525 Rev 6
11/1320
Contents
36.3
36.2.2
UM1785
Initialization and Configuration functions ........................................ 418
36.2.3
IO operation functions .................................................................... 418
36.2.4
Peripheral State and Errors functions ............................................ 420
36.2.5
Detailed description of functions .................................................... 420
SMARTCARD Firmware driver defines ......................................... 428
36.3.1
37
HAL SMARTCARD Extension Driver .......................................... 439
37.1
38
SMARTCARDEx Firmware driver API description ........................ 439
37.1.1
SMARTCARD peripheral extended features .................................. 439
37.1.2
Peripheral Control functions ........................................................... 439
37.1.3
Detailed description of functions .................................................... 439
HAL SMBUS Generic Driver ........................................................ 441
38.1
38.2
38.3
SMBUS Firmware driver registers structures ................................ 441
38.1.1
SMBUS_InitTypeDef ...................................................................... 441
38.1.2
SMBUS_HandleTypeDef ................................................................ 442
SMBUS Firmware driver API description ...................................... 443
38.2.1
How to use this driver ..................................................................... 443
38.2.2
Initialization and de-initialization functions ..................................... 444
38.2.3
IO operation functions .................................................................... 445
38.2.4
Peripheral State and Errors functions ............................................ 446
38.2.5
Detailed description of functions .................................................... 446
SMBUS Firmware driver defines ................................................... 453
38.3.1
39
SMBUS ........................................................................................... 453
HAL SPI Generic Driver ............................................................... 460
39.1
39.2
39.3
SPI Firmware driver registers structures ....................................... 460
39.1.1
SPI_InitTypeDef ............................................................................. 460
39.1.2
__SPI_HandleTypeDef ................................................................... 461
SPI Firmware driver API description ............................................. 462
39.2.1
How to use this driver ..................................................................... 462
39.2.2
Initialization and de-initialization functions ..................................... 463
39.2.3
IO operation functions .................................................................... 464
39.2.4
Peripheral State and Errors functions ............................................ 464
39.2.5
Detailed description of functions .................................................... 465
SPI Firmware driver defines .......................................................... 472
39.3.1
40
SMARTCARD ................................................................................. 428
SPI .................................................................................................. 472
HAL SPI Extension Driver ........................................................... 478
12/1320
DocID026525 Rev 6
UM1785
Contents
40.1
41
SPIEx Firmware driver API description ......................................... 478
40.1.1
IO operation functions .................................................................... 478
40.1.2
Detailed description of functions .................................................... 478
HAL TIM Generic Driver .............................................................. 479
41.1
41.2
41.3
TIM Firmware driver registers structures ....................................... 479
41.1.1
TIM_Base_InitTypeDef ................................................................... 479
41.1.2
TIM_OC_InitTypeDef...................................................................... 479
41.1.3
TIM_OnePulse_InitTypeDef ........................................................... 480
41.1.4
TIM_IC_InitTypeDef ....................................................................... 481
41.1.5
TIM_Encoder_InitTypeDef ............................................................. 481
41.1.6
TIM_ClockConfigTypeDef .............................................................. 482
41.1.7
TIM_ClearInputConfigTypeDef ....................................................... 482
41.1.8
TIM_SlaveConfigTypeDef .............................................................. 483
41.1.9
TIM_HandleTypeDef ...................................................................... 483
TIM Firmware driver API description ............................................. 484
41.2.1
TIMER Generic features ................................................................. 484
41.2.2
How to use this driver ..................................................................... 484
41.2.3
Time Base functions ....................................................................... 485
41.2.4
Time Output Compare functions .................................................... 485
41.2.5
Time PWM functions ...................................................................... 486
41.2.6
Time Input Capture functions ......................................................... 486
41.2.7
Time One Pulse functions .............................................................. 487
41.2.8
Time Encoder functions .................................................................. 487
41.2.9
IRQ handler management .............................................................. 488
41.2.10
Peripheral Control functions ........................................................... 488
41.2.11
TIM Callbacks functions ................................................................. 488
41.2.12
Peripheral State functions .............................................................. 489
41.2.13
Detailed description of functions .................................................... 489
TIM Firmware driver defines.......................................................... 516
41.3.1
42
TIM.................................................................................................. 516
HAL TIM Extension Driver........................................................... 535
42.1
42.2
TIMEx Firmware driver registers structures................................... 535
42.1.1
TIM_HallSensor_InitTypeDef ......................................................... 535
42.1.2
TIM_MasterConfigTypeDef ............................................................ 535
42.1.3
TIM_BreakDeadTimeConfigTypeDef ............................................. 535
TIMEx Firmware driver API description ......................................... 536
42.2.1
TIMER Extended features .............................................................. 536
DocID026525 Rev 6
13/1320
Contents
42.3
42.2.2
UM1785
How to use this driver ..................................................................... 536
42.2.3
Timer Hall Sensor functions ........................................................... 537
42.2.4
Timer Complementary Output Compare functions ......................... 537
42.2.5
Timer Complementary PWM functions ........................................... 538
42.2.6
Timer Complementary One Pulse functions................................... 538
42.2.7
Peripheral Control functions ........................................................... 538
42.2.8
Extension Callbacks functions ........................................................ 539
42.2.9
Extension Peripheral State functions ............................................. 539
42.2.10
Detailed description of functions .................................................... 539
TIMEx Firmware driver defines ..................................................... 550
42.3.1
43
HAL TSC Generic Driver ............................................................. 551
43.1
43.2
43.3
TSC Firmware driver registers structures ...................................... 551
43.1.1
TSC_InitTypeDef ............................................................................ 551
43.1.2
TSC_IOConfigTypeDef................................................................... 552
43.1.3
TSC_HandleTypeDef ..................................................................... 552
TSC Firmware driver API description ............................................ 552
43.2.1
TSC specific features ..................................................................... 552
43.2.2
How to use this driver ..................................................................... 553
43.2.3
Initialization and de-initialization functions ..................................... 553
43.2.4
Peripheral Control functions ........................................................... 553
43.2.5
State functions ................................................................................ 554
43.2.6
Detailed description of functions .................................................... 554
TSC Firmware driver defines......................................................... 557
43.3.1
44
TIMEx ............................................................................................. 550
TSC................................................................................................. 557
HAL UART Generic Driver........................................................... 567
44.1
44.2
14/1320
UART Firmware driver registers structures ................................... 567
44.1.1
UART_InitTypeDef ......................................................................... 567
44.1.2
UART_AdvFeatureInitTypeDef ....................................................... 568
44.1.3
UART_HandleTypeDef ................................................................... 568
UART Firmware driver API description ......................................... 570
44.2.1
How to use this driver ..................................................................... 570
44.2.2
Initialization and Configuration functions ........................................ 572
44.2.3
IO operation functions .................................................................... 572
44.2.4
Peripheral Control functions ........................................................... 573
44.2.5
Peripheral State and Error functions .............................................. 573
44.2.6
Detailed description of functions .................................................... 573
DocID026525 Rev 6
UM1785
Contents
44.3
UART Firmware driver defines ...................................................... 584
44.3.1
45
HAL UART Extension Driver ....................................................... 599
45.1
UARTEx Firmware driver registers structures ............................... 599
45.1.1
45.2
45.3
45.2.1
UART peripheral extended features ............................................... 599
45.2.2
Initialization and Configuration functions ........................................ 599
45.2.3
IO operation function ...................................................................... 600
45.2.4
Peripheral Control functions ........................................................... 600
45.2.5
Detailed description of functions .................................................... 600
UARTEx Firmware driver defines .................................................. 603
46.2
46.3
USART Firmware driver registers structures ................................. 604
46.1.1
USART_InitTypeDef ....................................................................... 604
46.1.2
USART_HandleTypeDef ................................................................ 604
USART Firmware driver API description ....................................... 605
46.2.1
How to use this driver ..................................................................... 605
46.2.2
Initialization and Configuration functions ........................................ 607
46.2.3
IO operation functions .................................................................... 608
46.2.4
Peripheral State and Error functions .............................................. 609
46.2.5
Detailed description of functions .................................................... 610
USART Firmware driver defines.................................................... 617
46.3.1
USART............................................................................................ 617
HAL USART Extension Driver .................................................... 626
47.1
USARTEx Firmware driver defines ............................................... 626
47.1.1
48
UARTEx .......................................................................................... 603
HAL USART Generic Driver ........................................................ 604
46.1
47
UART_WakeUpTypeDef ................................................................ 599
UARTEx Firmware driver API description ..................................... 599
45.3.1
46
UART .............................................................................................. 584
USARTEx ....................................................................................... 626
HAL WWDG Generic Driver ........................................................ 627
48.1
48.2
WWDG Firmware driver registers structures ................................. 627
48.1.1
WWDG_InitTypeDef ....................................................................... 627
48.1.2
WWDG_HandleTypeDef ................................................................ 627
WWDG Firmware driver API description ....................................... 627
48.2.1
WWDG specific features ................................................................ 627
48.2.2
How to use this driver ..................................................................... 628
48.2.3
Initialization and Configuration functions ........................................ 628
DocID026525 Rev 6
15/1320
Contents
48.3
48.2.4
UM1785
IO operation functions .................................................................... 629
48.2.5
Detailed description of functions .................................................... 629
WWDG Firmware driver defines.................................................... 630
48.3.1
49
LL ADC Generic Driver ................................................................ 633
49.1
49.2
ADC Firmware driver registers structures ..................................... 633
49.1.1
LL_ADC_InitTypeDef...................................................................... 633
49.1.2
LL_ADC_REG_InitTypeDef ............................................................ 633
ADC Firmware driver API description ............................................ 634
49.2.1
49.3
BUS Firmware driver API description ............................................ 695
50.1.1
50.2
COMP Firmware driver registers structures .................................. 708
51.1.1
51.2
51.3
LL_COMP_InitTypeDef .................................................................. 708
COMP Firmware driver API description ........................................ 709
51.2.1
Detailed description of functions .................................................... 709
COMP Firmware driver defines ..................................................... 718
51.3.1
COMP ............................................................................................. 718
LL CORTEX Generic Driver......................................................... 721
52.1
CORTEX Firmware driver API description .................................... 721
52.1.1
52.2
Detailed description of functions .................................................... 721
CORTEX Firmware driver defines ................................................. 724
52.2.1
CORTEX ......................................................................................... 724
LL CRC Generic Driver ................................................................ 725
53.1
CRC Firmware driver API description ........................................... 725
53.1.1
53.2
Detailed description of functions .................................................... 725
CRC Firmware driver defines ........................................................ 732
53.2.1
54
BUS ................................................................................................ 706
LL COMP Generic Driver ............................................................. 708
51.1
53
Detailed description of functions .................................................... 695
BUS Firmware driver defines ........................................................ 706
50.2.1
52
ADC ................................................................................................ 674
LL BUS Generic Driver ................................................................ 695
50.1
51
Detailed description of functions .................................................... 634
ADC Firmware driver defines ........................................................ 674
49.3.1
50
WWDG............................................................................................ 630
CRC ................................................................................................ 732
LL CRS Generic Driver ................................................................ 733
16/1320
DocID026525 Rev 6
UM1785
Contents
54.1
CRS Firmware driver API description ............................................ 733
54.1.1
54.2
CRS Firmware driver defines ........................................................ 744
54.2.1
55
DAC Firmware driver registers structures ..................................... 747
55.1.1
55.2
55.3
DAC ................................................................................................ 764
LL DMA Generic Driver ............................................................... 770
56.1
DMA Firmware driver registers structures ..................................... 770
56.1.1
56.2
56.3
LL_DMA_InitTypeDef ..................................................................... 770
DMA Firmware driver API description ........................................... 771
56.2.1
Detailed description of functions .................................................... 771
DMA Firmware driver defines ........................................................ 806
56.3.1
DMA ................................................................................................ 806
LL EXTI Generic Driver ............................................................... 811
57.1
EXTI Firmware driver registers structures ..................................... 811
57.1.1
57.2
57.3
LL_EXTI_InitTypeDef ..................................................................... 811
EXTI Firmware driver API description ........................................... 811
57.2.1
Detailed description of functions .................................................... 811
EXTI Firmware driver defines ........................................................ 826
57.3.1
EXTI ................................................................................................ 826
LL GPIO Generic Driver .............................................................. 829
58.1
GPIO Firmware driver registers structures .................................... 829
58.1.1
58.2
58.3
LL_GPIO_InitTypeDef .................................................................... 829
GPIO Firmware driver API description .......................................... 829
58.2.1
Detailed description of functions .................................................... 829
GPIO Firmware driver defines ....................................................... 844
58.3.1
59
Detailed description of functions .................................................... 747
DAC Firmware driver defines ........................................................ 764
55.3.1
58
LL_DAC_InitTypeDef...................................................................... 747
DAC Firmware driver API description ............................................ 747
55.2.1
57
CRS ................................................................................................ 744
LL DAC Generic Driver ................................................................ 747
55.1
56
Detailed description of functions .................................................... 733
GPIO ............................................................................................... 844
LL I2C Generic Driver .................................................................. 846
59.1
I2C Firmware driver registers structures ....................................... 846
59.1.1
LL_I2C_InitTypeDef........................................................................ 846
DocID026525 Rev 6
17/1320
Contents
UM1785
59.2
I2C Firmware driver API description .............................................. 847
59.2.1
59.3
I2C Firmware driver defines .......................................................... 887
59.3.1
60
I2S Firmware driver registers structures ....................................... 892
60.1.1
60.2
60.3
I2S .................................................................................................. 906
LL IWDG Generic Driver .............................................................. 908
61.1
IWDG Firmware driver API description ......................................... 908
61.1.1
61.2
Detailed description of functions .................................................... 908
IWDG Firmware driver defines ...................................................... 912
61.2.1
IWDG .............................................................................................. 912
LL PWR Generic Driver ............................................................... 913
62.1
PWR Firmware driver API description ........................................... 913
62.1.1
62.2
Detailed description of functions .................................................... 913
PWR Firmware driver defines ....................................................... 919
62.2.1
PWR ............................................................................................... 919
LL RCC Generic Driver ................................................................ 922
63.1
RCC Firmware driver registers structures ..................................... 922
63.1.1
63.2
63.3
LL_RCC_ClocksTypeDef ............................................................... 922
RCC Firmware driver API description ........................................... 922
63.2.1
Detailed description of functions .................................................... 922
RCC Firmware driver defines ........................................................ 951
63.3.1
64
Detailed description of functions .................................................... 892
I2S Firmware driver defines .......................................................... 906
60.3.1
63
LL_I2S_InitTypeDef ........................................................................ 892
I2S Firmware driver API description .............................................. 892
60.2.1
62
I2C .................................................................................................. 887
LL I2S Generic Driver .................................................................. 892
60.1
61
Detailed description of functions .................................................... 847
RCC ................................................................................................ 951
LL RTC Generic Driver ................................................................ 959
64.1
64.2
RTC Firmware driver registers structures ..................................... 959
64.1.1
LL_RTC_InitTypeDef ...................................................................... 959
64.1.2
LL_RTC_TimeTypeDef................................................................... 959
64.1.3
LL_RTC_DateTypeDef ................................................................... 960
64.1.4
LL_RTC_AlarmTypeDef ................................................................. 960
RTC Firmware driver API description ............................................ 961
64.2.1
18/1320
Detailed description of functions .................................................... 961
DocID026525 Rev 6
UM1785
Contents
64.3
RTC Firmware driver defines ...................................................... 1016
64.3.1
65
LL SPI Generic Driver ................................................................ 1024
65.1
SPI Firmware driver registers structures ..................................... 1024
65.1.1
65.2
65.3
SYSTEM Firmware driver API description .................................. 1051
66.1.1
66.2
Detailed description of functions .................................................. 1051
SYSTEM Firmware driver defines ............................................... 1077
66.2.1
SYSTEM ....................................................................................... 1077
LL TIM Generic Driver ............................................................... 1080
67.1
67.2
TIM Firmware driver registers structures ..................................... 1080
67.1.1
LL_TIM_InitTypeDef ..................................................................... 1080
67.1.2
LL_TIM_OC_InitTypeDef.............................................................. 1080
67.1.3
LL_TIM_IC_InitTypeDef ............................................................... 1081
67.1.4
LL_TIM_ENCODER_InitTypeDef ................................................. 1082
67.1.5
LL_TIM_HALLSENSOR_InitTypeDef ........................................... 1083
67.1.6
LL_TIM_BDTR_InitTypeDef ......................................................... 1083
TIM Firmware driver API description ........................................... 1084
67.2.1
67.3
Detailed description of functions .................................................. 1084
TIM Firmware driver defines........................................................ 1150
67.3.1
TIM................................................................................................ 1150
LL USART Generic Driver ......................................................... 1161
68.1
68.2
USART Firmware driver registers structures ............................... 1161
68.1.1
LL_USART_InitTypeDef ............................................................... 1161
68.1.2
LL_USART_ClockInitTypeDef ...................................................... 1161
USART Firmware driver API description ..................................... 1162
68.2.1
68.3
Detailed description of functions .................................................. 1162
USART Firmware driver defines.................................................. 1233
68.3.1
69
SPI ................................................................................................ 1048
LL SYSTEM Generic Driver ....................................................... 1051
66.1
68
Detailed description of functions .................................................. 1025
SPI Firmware driver defines ........................................................ 1048
65.3.1
67
LL_SPI_InitTypeDef ..................................................................... 1024
SPI Firmware driver API description ........................................... 1025
65.2.1
66
RTC .............................................................................................. 1016
USART.......................................................................................... 1233
LL UTILS Generic Driver ........................................................... 1239
DocID026525 Rev 6
19/1320
Contents
UM1785
69.1
69.2
69.3
UTILS Firmware driver registers structures ................................. 1239
69.1.1
LL_UTILS_PLLInitTypeDef .......................................................... 1239
69.1.2
LL_UTILS_ClkInitTypeDef ............................................................ 1239
UTILS Firmware driver API description ....................................... 1239
69.2.1
System Configuration functions .................................................... 1239
69.2.2
Detailed description of functions .................................................. 1240
UTILS Firmware driver defines.................................................... 1243
69.3.1
70
UTILS............................................................................................ 1243
LL WWDG Generic Driver ......................................................... 1244
70.1
WWDG Firmware driver API description ..................................... 1244
70.1.1
70.2
Detailed description of functions .................................................. 1244
WWDG Firmware driver defines.................................................. 1248
70.2.1
WWDG.......................................................................................... 1248
71 Correspondence between API registers and API low-layer driver
functions ............................................................................................. 1249
20/1320
71.1
ADC ............................................................................................ 1249
71.2
BUS ............................................................................................. 1254
71.3
COMP ......................................................................................... 1259
71.4
CORTEX ..................................................................................... 1260
71.5
CRC ............................................................................................ 1261
71.6
CRS ............................................................................................ 1262
71.7
DAC ............................................................................................ 1263
71.8
DMA ............................................................................................ 1265
71.9
EXTI ............................................................................................ 1269
71.10
GPIO ........................................................................................... 1269
71.11
I2C .............................................................................................. 1270
71.12
I2S............................................................................................... 1274
71.13
IWDG .......................................................................................... 1276
71.14
PWR............................................................................................ 1276
71.15
RCC ............................................................................................ 1278
71.16
RTC ............................................................................................. 1281
71.17
SPI .............................................................................................. 1288
71.18
SYSTEM ..................................................................................... 1290
71.19
TIM .............................................................................................. 1295
71.20
USART ........................................................................................ 1304
DocID026525 Rev 6
UM1785
Contents
71.21
WWDG ........................................................................................ 1311
72
FAQs........................................................................................... 1313
73
Revision history ........................................................................ 1317
DocID026525 Rev 6
21/1320
List of tables
UM1785
List of tables
Table 1: Acronyms and definitions ............................................................................................................ 24
Table 2: HAL driver files............................................................................................................................ 26
Table 3: User-application files .................................................................................................................. 27
Table 4: API classification ......................................................................................................................... 31
Table 5: List of devices supported by HAL drivers ................................................................................... 33
Table 6: HAL API naming rules ................................................................................................................ 35
Table 7: Macros handling interrupts and specific clock configurations .................................................... 36
Table 8: Callback functions ....................................................................................................................... 37
Table 9: HAL generic APIs ....................................................................................................................... 38
Table 10: HAL extension APIs .................................................................................................................. 39
Table 11: Define statements used for HAL configuration ......................................................................... 44
Table 12: Description of GPIO_InitTypeDef structure .............................................................................. 46
Table 13: Description of EXTI configuration macros ................................................................................ 48
Table 14: MSP functions ........................................................................................................................... 52
Table 15: Timeout values ......................................................................................................................... 56
Table 16: LL driver files............................................................................................................................. 60
Table 17: Common peripheral initialization functions ............................................................................... 63
Table 18: Optional peripheral initialization functions ................................................................................ 63
Table 19: Specific Interrupt, DMA request and status flags management ............................................... 65
Table 20: Available function formats......................................................................................................... 65
Table 21: Peripheral clock activation/deactivation management ............................................................. 65
Table 22: Peripheral activation/deactivation management ....................................................................... 66
Table 23: Peripheral configuration management ...................................................................................... 66
Table 24: Peripheral register management .............................................................................................. 66
Table 25: Correspondence between ADC registers and ADC low-layer driver functions .................... 1249
Table 26: Correspondence between BUS registers and BUS low-layer driver functions ..................... 1254
Table 27: Correspondence between COMP registers and COMP low-layer driver functions .............. 1259
Table 28: Correspondence between CORTEX registers and CORTEX low-layer driver functions ..... 1260
Table 29: Correspondence between CRC registers and CRC low-layer driver functions .................... 1261
Table 30: Correspondence between CRS registers and CRS low-layer driver functions .................... 1262
Table 31: Correspondence between DAC registers and DAC low-layer driver functions .................... 1263
Table 32: Correspondence between DMA registers and DMA low-layer driver functions ................... 1265
Table 33: Correspondence between EXTI registers and EXTI low-layer driver functions ................... 1269
Table 34: Correspondence between GPIO registers and GPIO low-layer driver functions ................. 1269
Table 35: Correspondence between I2C registers and I2C low-layer driver functions ........................ 1270
Table 36: Correspondence between I2S registers and I2S low-layer driver functions ......................... 1274
Table 37: Correspondence between IWDG registers and IWDG low-layer driver functions ................ 1276
Table 38: Correspondence between PWR registers and PWR low-layer driver functions ................... 1276
Table 39: Correspondence between RCC registers and RCC low-layer driver functions .................... 1278
Table 40: Correspondence between RTC registers and RTC low-layer driver functions ..................... 1281
Table 41: Correspondence between SPI registers and SPI low-layer driver functions ........................ 1288
Table 42: Correspondence between SYSTEM registers and SYSTEM low-layer driver functions ...... 1290
Table 43: Correspondence between TIM registers and TIM low-layer driver functions ....................... 1295
Table 44: Correspondence between USART registers and USART low-layer driver functions ........... 1304
Table 45: Correspondence between WWDG registers and WWDG low-layer driver functions ........... 1311
Table 46: Document revision history .................................................................................................... 1317
22/1320
DocID026525 Rev 6
UM1785
List of figures
List of figures
Figure 1: Example of project template ...................................................................................................... 28
Figure 2: Adding device-specific functions ............................................................................................... 40
Figure 3: Adding family-specific functions ................................................................................................ 40
Figure 4: Adding new peripherals ............................................................................................................. 41
Figure 5: Updating existing APIs .............................................................................................................. 41
Figure 6: File inclusion model ................................................................................................................... 42
Figure 7: HAL driver model ....................................................................................................................... 50
Figure 8: Low-layer driver folders ............................................................................................................. 61
Figure 9: Low-layer driver CMSIS files ..................................................................................................... 62
DocID026525 Rev 6
23/1320
Acronyms and definitions
1
UM1785
Acronyms and definitions
Table 1: Acronyms and definitions
24/1320
Acronym
Definition
ADC
Analog-to-digital converter
ANSI
American National Standards Institute
API
Application Programming Interface
BSP
Board Support Package
COMP
Comparator
CMSIS
Cortex Microcontroller Software Interface Standard
CPU
Central Processing Unit
CRYP
Cryptographic processor unit
CRC
CRC calculation unit
DAC
Digital to analog converter
DMA
Direct Memory Access
EXTI
External interrupt/event controller
FLASH
Flash memory
GPIO
General purpose I/Os
HAL
Hardware abstraction layer
I2C
Inter-integrated circuit
I2S
Inter-integrated sound
IRDA
InfraRed Data Association
IWDG
Independent watchdog
LCD
Liquid Crystal Display Controler
MSP
MCU Specific Package
NVIC
Nested Vectored Interrupt Controller
PCD
USB Peripheral Controller Driver
PWR
Power controller
RCC
Reset and clock controller
RNG
Random Number Generator
RTC
Real-time clock
SD
Secure Digital
SRAM
SRAM external memory
SMARTCARD
Smartcard IC
SPI
Serial Peripheral interface
SysTick
System tick timer
TIM
Advanced-control, general-purpose or basic timer
TSC
Touch Sensing Controller
DocID026525 Rev 6
UM1785
Acronyms and definitions
Acronym
Definition
UART
Universal asynchronous receiver/transmitter
USART
Universal synchronous receiver/transmitter
WWDG
Window watchdog
USB
Universal Serial Bus
PPP
STM32 peripheral or block
DocID026525 Rev 6
25/1320
Overview of HAL drivers
2
UM1785
Overview of HAL drivers
The HAL drivers were designed to offer a rich set of APIs and to interact easily with the
application upper layers.
Each driver consists of a set of functions covering the most common peripheral features.
The development of each driver is driven by a common API which standardizes the driver
structure, the functions and the parameter names.
The HAL drivers include 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.
Support of peripheral multi-instance 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 driver files
File
26/1320
Description
stm32f0xx_hal_ppp.c
Main peripheral/module driver file.
It includes the APIs that are common to all STM32 devices.
Example: stm32f0xx_hal_adc.c, stm32f0xx_hal_irda.c, …
stm32xx_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: stm32xx_hal_adc.h, stm32xx_hal_irda.h, …
DocID026525 Rev 6
UM1785
Overview of HAL drivers
File
2.1.2
Description
stm32xx_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: stm32xx_hal_adc_ex.c, stm32f0xx_hal_dma_ex.c, …
stm32xx_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: stm32xx_hal_adc_ex.h, stm32xx_hal_dma_ex.h, …
stm32xx_hal.c
This file is used for HAL initialization and contains DBGMCU,
Remap and Time Delay based on systick APIs.
stm32xx_hal.h
stm32xx_hal.c header file
stm32xx_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.
stm32xx_hal_conf_template.h
Template file allowing to customize the drivers for a given
application.
stm32xx_hal_def.h
Common HAL resources such as common define statements,
enumerations, structures and macros.
User-application files
The minimum files required to build an application using the HAL are listed in the table
below:
Table 3: User-application files
File
Description
system_stm32f0xx.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.
startup_stm32f0xx.s
Toolchain specific file that contains reset handler and exception vectors.
For some toolchains, it allows adapting the stack/heap size to fit the
application requirements.
stm32f0xx_flash.icf
(optional)
Linker file for EWARM toolchain allowing mainly to adapt the stack/heap
size to fit the application requirements.
stm32f0xx_hal_msp.c
This file contains the MSP initialization and de-initialization (main routine
and callbacks) of the peripheral used in the user application.
stm32f0xx_hal_conf.h
This file allows the user to customize the HAL drivers for a specific
application.
It is not mandatory to modify this configuration. The application can use the
default configuration without any modification.
DocID026525 Rev 6
27/1320
Overview of HAL drivers
UM1785
File
stm32f0xx_it.c/.h
Description
This file contains the exceptions handler and peripherals interrupt service
routine, and calls HAL_IncTick() at regular time intervals to increment a
local variable (declared in stm32f0xx_hal.c) used as HAL timebase. By
default, this function is called each 1ms in Systick ISR. .
The PPP_IRQHandler() routine must call HAL_PPP_IRQHandler() if an
interrupt based process is used within the application.
This file contains the main program routine, mainly:
main.c/.h
the call to HAL_Init()
assert_failed() implementation
system clock configuration
peripheral HAL initialization and user application code.
The STM32Cube package comes with ready-to-use project templates, one for each
supported board. Each project contains the files listed above and a preconfigured project
for the supported toolchains.
Each project template provides empty main loop function and can be used as a starting
point to get familiar with project settings for STM32Cube. Their characteristics are the
following:
It contains the 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 configuring the CMSIS and HAL
drivers accordingly.
It provides ready to use user files preconfigured as defined below:
HAL is initialized
SysTick ISR implemented for HAL_Delay()
System clock configured with the maximum frequency of the device
If an existing project is copied to another location, then include paths must be
updated.
Figure 1: Example of project template
28/1320
DocID026525 Rev 6
UM1785
2.2
Overview of HAL drivers
HAL data structures
Each HAL driver can contain the following data structures:
Peripheral handle structures
Initialization and configuration structures
Specific process structures.
2.2.1
Peripheral handle structures
The APIs have a modular generic multi-instance architecture that allows working with
several IP instances simultaneously.
PPP_HandleTypeDef *handle is the main structure that is implemented in the HAL
drivers. It handles the peripheral/module configuration and registers and embeds all the
structures and variables needed to follow the peripheral device flow.
The peripheral handle is used for the following purposes:
Multi-instance support: each peripheral/module instance has its own handle. As a
result instance resources are independent.
Peripheral process intercommunication: the handle is used to manage shared data
resources between the process routines.
Example: global pointers, DMA handles, state machine.
Storage : this handle is used also to manage global variables within a given HAL
driver.
An example of peripheral structure is shown below:
typedef struct
{
USART_TypeDef *Instance; /* USART registers base address */
USART_InitTypeDef Init; /* Usart communication parameters */
uint8_t *pTxBuffPtr;/* Pointer to Usart Tx transfer Buffer */
uint16_t TxXferSize; /* Usart Tx Transfer size */
__IO uint16_t TxXferCount;/* Usart Tx Transfer Counter */
uint8_t *pRxBuffPtr;/* Pointer to Usart Rx transfer Buffer */
uint16_t RxXferSize; /* Usart Rx Transfer size */
__IO uint16_t RxXferCount; /* Usart Rx Transfer Counter */
DMA_HandleTypeDef *hdmatx; /* Usart Tx DMA Handle parameters */
DMA_HandleTypeDef *hdmarx; /* Usart Rx DMA Handle parameters */
HAL_LockTypeDef Lock; /* Locking object */
__IO HAL_USART_StateTypeDef State; /* Usart communication state */
__IO HAL_USART_ErrorTypeDef ErrorCode;/* USART Error code */
}USART_HandleTypeDef;
1) The multi-instance feature implies that all the APIs used in the application are
re-entrant and avoid using global variables because subroutines can fail to be reentrant if they rely on a global variable to remain unchanged but that variable is
modified when the subroutine is recursively invoked. For this reason, the following
rules are respected:
Re-entrant code does not hold any static (or global) non-constant data: reentrant functions can work with global data. For example, a re-entrant
interrupt service routine can grab a piece of hardware status to work with
(e.g. serial port read buffer) which is not only global, but volatile. Still, typical
use of static variables and global data is not advised, in the sense that only
atomic read-modify-write instructions should be used in these variables. It
should not be possible for an interrupt or signal to occur during the execution
of such an instruction.
Reentrant code does not modify its own code.
DocID026525 Rev 6
29/1320
Overview of HAL drivers
UM1785
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.
2.2.2
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)
30/1320
DocID026525 Rev 6
UM1785
2.3
Overview of HAL drivers
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 driver files of all STM32 microcontrollers.
HAL_StatusTypeDef HAL_ADC_Init(ADC_HandleTypeDef* hadc);
HAL_StatusTypeDef HAL_ADC_DeInit(ADC_HandleTypeDef *hadc);
HAL_StatusTypeDef HAL_ADC_Start(ADC_HandleTypeDef* hadc);
HAL_StatusTypeDef HAL_ADC_Stop(ADC_HandleTypeDef* hadc);
HAL_StatusTypeDef HAL_ADC_Start_IT(ADC_HandleTypeDef* hadc);
HAL_StatusTypeDef HAL_ADC_Stop_IT(ADC_HandleTypeDef* hadc);
void HAL_ADC_IRQHandler(ADC_HandleTypeDef* hadc);
Extension APIs:This set of API is divided into two sub-categories :
Family specific APIs: APIs applying to a given family. They are located in the
extension HAL driver file (see example below related to the ADC).
HAL_StatusTypeDef HAL_ADCEx_Calibration_Start(ADC_HandleTypeDef* hadc, uint32_t
SingleDiff);
uint32_t HAL_ADCEx_Calibration_GetValue(ADC_HandleTypeDef* hadc, uint32_t
SingleDiff);
Device part number specific APIs:These APIs are implemented in the
extension file and delimited by specific define statements relative to a given part
number.
#if defined(STM32F042x6) || defined(STM32F048xx) || defined(STM32F072xB) ||
defined(STM32F078xx) || \
defined(STM32F091xC) || defined(STM32F098xx)
#endif /* STM32F042x6 || STM32F048xx || STM32F072xB || STM32F078xx || */
/* STM32F091xC || STM32F098xx */The data structure related to the specific APIs is
delimited by the device part number define statement. It is located in the
corresponding extension header C file.
The following table summarizes the location of the different categories of HAL APIs in the
driver files.
Table 4: API classification
Common APIs
Generic file
Extension file
X
X
Family specific APIs
X
Device specific APIs
X
(1)
Notes:
(1)
In some cases, the implementation for a specific device part number may change . In this case the generic API
is declared as weak function in the extension file. The API is implemented again to overwrite the default function
Family specific APIs are only related to a given family. This means that if a
specific API is implemented in another family, and the arguments of this latter
family are different, additional structures and arguments might need to be added.
The IRQ handlers are used for common and family specific processes.
DocID026525 Rev 6
31/1320
Overview of HAL drivers
2.4
32/1320
UM1785
Devices supported by HAL drivers
DocID026525 Rev 6
UM1785
Overview of HAL drivers
IP/Module
STM32F030x6
STM32F030x8
STM32F070x6
STM32F070x8
STM32F030xC
STM32F031x6
STM32F051x8
STM32F071xB
STM32F091xC
STM32F042x6
STM32F072xB
STM32F048xx
STM32F058xx
STM32F078xx
STM32F098xx
Table 5: List of devices supported by HAL drivers
stm32f0xx_hal.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_adc.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_adc_ex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_can.c
No
No
No
No
No
No
No
No
Yes
Yes
Yes
Yes
No
Yes
Yes
stm32f0xx_hal_cec.c
No
No
No
No
No
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_comp.c
No
No
No
No
No
No
Yes
Yes
Yes
No
Yes
No
Yes
Yes
Yes
stm32f0xx_hal_cortex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_crc.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_crc_ex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_dac.c
No
No
No
No
No
No
Yes
Yes
Yes
No
Yes
No
Yes
Yes
Yes
stm32f0xx_hal_dac_ex.c
No
No
No
No
No
No
Yes
Yes
Yes
No
Yes
No
Yes
Yes
Yes
stm32f0xx_hal_dma.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_flash.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_flash_ex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_gpio.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_i2c.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_i2c_ex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_i2s.c
No
No
No
No
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_irda.c
No
No
No
No
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_iwdg.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
DocID026525 Rev 6
33/1320
34/1320
IP/Module
STM32F030x8
STM32F070x6
STM32F070x8
STM32F030xC
STM32F031x6
STM32F051x8
STM32F071xB
STM32F091xC
STM32F042x6
STM32F072xB
STM32F048xx
STM32F058xx
STM32F078xx
STM32F098xx
UM1785
STM32F030x6
Overview of HAL drivers
stm32f0xx_hal_msp_template.c
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
stm32f0xx_hal_pcd.c
No
No
Yes
Yes
No
No
No
No
No
Yes
Yes
Yes
No
Yes
No
stm32f0xx_hal_pcd_ex.c
No
No
Yes
Yes
No
No
No
No
No
Yes
Yes
Yes
No
Yes
No
stm32f0xx_hal_pwr.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_pwr_ex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
No
No
No
No
stm32f0xx_hal_rcc.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_rcc_ex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_rtc.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_rtc_ex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_smartcard.c
No
No
No
No
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_smartcard_ex.c
No
No
No
No
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_smbus.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_spi.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_tim.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_tim_ex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_tsc.c
No
No
No
No
No
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_uart.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_uart_ex.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_usart.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
stm32f0xx_hal_wwdg.c
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
DocID026525 Rev 6
UM1785
Overview of HAL drivers
2.5
HAL driver rules
2.5.1
HAL API naming rules
The following naming rules are used in HAL drivers:
Table 6: HAL API naming rules
File
names
Generic
Family specific
Device specific
stm32f0xx_hal_ppp (c/h)
stm32f0xx_hal_ppp_ex (c/h)
stm32f0xx_ hal_ppp_ex (c/h)
Module
name
HAL_PPP_ MODULE
Function
name
HAL_PPP_Function
HAL_PPP_FeatureFunction_
MODE
HAL_PPPEx_Function
HAL_PPPEx_FeatureFunction_M
ODE
HAL_PPPEx_Function
HAL_PPPEx_FeatureFunction_M
ODE
Handle
name
PPP_HandleTypedef
NA
NA
Init
structure
name
PPP_InitTypeDef
NA
PPP_InitTypeDef
Enum
name
HAL_PPP_StructnameType
Def
NA
NA
The PPP prefix refers to the peripheral functional mode and not to the peripheral itself.
For example, if the USART, PPP can be USART, IRDA, UART or SMARTCARD
depending on the peripheral mode.
The constants used in one file are defined within this file. A constant used in several
files is defined in a header file. All constants are written in uppercase, except for
peripheral driver function parameters.
typedef variable names should be suffixed with _TypeDef.
Registers are considered as constants. In most cases, their name is in uppercase and
uses the same acronyms as in the STM32F0 reference manuals.
Peripheral registers are declared in the PPP_TypeDef structure (e.g. ADC_TypeDef)
in the CMSIS header file corresponding to the selected platform: stm32f030x6.h,
stm32f030x8.h, stm32f031x6.h, stm32f038xx.h, stm32f042x6.h, stm32f048xx.h,
stm32f051x8.h, stm32f058xx.h, stm32f071xB.h, stm32f072xB.h, stm32f078xx.h,
stm32f091xC.h and stm32f098xx.h. The platform is selected by enabling the
compilation switch in the compilation toolchain directive or in the stm32f0xx.h file.
Peripheral function names are prefixed by HAL_, then the corresponding peripheral
acronym in uppercase followed by an underscore. The first letter of each word is in
uppercase (e.g. HAL_UART_Transmit()). Only one underscore is allowed in a function
name to separate the peripheral acronym from the rest of the function name.
The structure containing the PPP peripheral initialization parameters are named
PPP_InitTypeDef (e.g. ADC_InitTypeDef).
The structure containing the Specific configuration parameters for the PPP peripheral
are named PPP_xxxxConfTypeDef (e.g. ADC_ChannelConfTypeDef).
Peripheral handle structures are named PPP_HandleTypedef (e.g
DMA_HandleTypeDef)
The functions used to initialize the PPP peripheral according to parameters specified
in PPP_InitTypeDef are named HAL_PPP_Init (e.g. HAL_TIM_Init()).
The functions used to reset the PPP peripheral registers to their default values are
named PPP_DeInit, e.g. TIM_DeInit.
DocID026525 Rev 6
35/1320
Overview of HAL drivers
UM1785
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
2.5.2
HAL general naming rules
For the shared and system peripherals, no handle or instance object is used. This rule
applies to the following peripherals:
GPIO
SYSTICK
NVIC
RCC
FLASH.
Example: The HAL_GPIO_Init() requires only the GPIO address and its configuration
parameters.
HAL_StatusTypeDef HAL_GPIO_Init (GPIO_TypeDef* GPIOx, GPIO_InitTypeDef *Init)
{
/*GPIO Initialization body */
}
The macros that handle interrupts and specific clock configurations are defined in
each peripheral/module driver. These macros are exported in the peripheral driver
header files so that they can be used by the extension file. The list of these macros is
defined below: This list is not exhaustive and other macros related to peripheral
features can be added, so that they can be used in the user application.
Table 7: Macros handling interrupts and specific clock configurations
Macros
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 stm32f0xx_hal_cortex.c file.
36/1320
DocID026525 Rev 6
UM1785
Overview of HAL drivers
When a status bit or a flag is read from registers, it is composed of shifted values
depending on the number of read values and of their size. In this case, the returned
status width is 32 bits. Example : STATUS = XX | (YY << 16) or STATUS = XX | (YY
<< 8) | (YY << 16) | (YY << 24)".
The PPP handles are valid before using the HAL_PPP_Init() API. The init function
performs a check before modifying the handle fields.
HAL_PPP_Init(PPP_HandleTypeDef)
if(hppp == NULL)
{
return HAL_ERROR;
}
The macros defined below are used:
Conditional macro:
#define ABS(x) (((x) > 0) ? (x) : -(x))
Pseudo-code macro (multiple instructions macro):
#define __HAL_LINKDMA(__HANDLE__, __PPP_DMA_FIELD_, __DMA_HANDLE_) \
do{ \
(__HANDLE__)->__PPP_DMA_FIELD_ = &(__DMA_HANDLE_); \
(__DMA_HANDLE_).Parent = (__HANDLE__); \
} while(0)
2.5.3
HAL interrupt handler and callback functions
Besides the APIs, HAL peripheral drivers include:
HAL_PPP_IRQHandler() peripheral interrupt handler that should be called from
stm32f0xx_it.c
User callback functions.
The user callback functions are defined as empty functions with “weak” attribute. They
have to be defined in the user code.
There are three types of user callbacks functions:
Peripheral system level initialization/ de-Initialization callbacks: HAL_PPP_MspInit()
and HAL_PPP_MspDeInit
Process complete callbacks : HAL_PPP_ProcessCpltCallback
Error callback: HAL_PPP_ErrorCallback.
Table 8: Callback functions
Callback functions
Example
HAL_PPP_MspInit() / _DeInit()
Ex: HAL_USART_MspInit()
Called from HAL_PPP_Init() API function to perform peripheral
system level initialization (GPIOs, clock, DMA, interrupt)
HAL_PPP_ProcessCpltCallback
Ex: HAL_USART_TxCpltCallback
Called by peripheral or DMA interrupt handler when the process
completes
HAL_PPP_ErrorCallback
Ex: HAL_USART_ErrorCallback
Called by peripheral or DMA interrupt handler when an error
occurs
DocID026525 Rev 6
37/1320
Overview of HAL drivers
2.6
UM1785
HAL generic APIs
The generic APIs provide common generic functions applying to all STM32 devices. They
are composed of four APIs groups:
Initialization and de-initialization functions:HAL_PPP_Init(), HAL_PPP_DeInit()
IO operation functions: HAL_PPP_Read(), HAL_PPP_Write(),HAL_PPP_Transmit(),
HAL_PPP_Receive()
Control functions: HAL_PPP_Set (), HAL_PPP_Get ().
State and Errors functions: HAL_PPP_GetState (), HAL_PPP_GetError ().
For some peripheral/module drivers, these groups are modified depending on the
peripheral/module implementation.
Example: in the timer driver, the API grouping is based on timer features (PWM, OC, IC...).
The initialization and de-initialization functions allow initializing a peripheral and configuring
the low-level resources, mainly clocks, GPIO, alternate functions (AF) and possibly DMA
and interrupts. The HAL_DeInit()function restores the peripheral default state, frees the
low-level resources and removes any direct dependency with the hardware.
The IO operation functions perform a row access to the peripheral payload data in write
and read modes.
The control functions are used to change dynamically the peripheral configuration and set
another operating mode.
The peripheral state and errors functions allow retrieving in runtime the peripheral and data
flow states, and identifying the type of errors that occurred. The example below is based on
the ADC peripheral. The list of generic APIs is not exhaustive. It is only given as an
example.
Table 9: HAL generic APIs
Function
Group
Common API Name
Description
HAL_ADC_Init()
This function initializes the peripheral and
configures the low -level resources (clocks,
GPIO, AF..)
HAL_ADC_DeInit()
This function restores the peripheral default state,
frees the low-level resources and removes any
direct dependency with the hardware.
HAL_ADC_Start ()
This function starts ADC conversions when the
polling method is used
HAL_ADC_Stop ()
This function stops ADC conversions when the
polling method is used
HAL_ADC_PollForConversion()
This function allows waiting for the end of
conversions when the polling method is used. In
this case, a timout value is specified by the user
according to the application.
HAL_ADC_Start_IT()
This function starts ADC conversions when the
interrupt method is used
HAL_ADC_Stop_IT()
This function stops ADC conversions when the
interrupt method is used
Initialization
group
IO operation
group
HAL_ADC_IRQHandler()
38/1320
This function handles ADC interrupt requests
DocID026525 Rev 6
UM1785
Overview of HAL drivers
Function
Group
Common API Name
Description
HAL_ADC_ConvCpltCallback()
Callback function called in the IT subroutine to
indicate the end of the current process or when a
DMA transfer has completed
HAL_ADC_ErrorCallback()
Callback function called in the IT subroutine if a
peripheral error or a DMA transfer error occurred
HAL_ADC_ConfigChannel()
This function configures the selected ADC regular
channel, the corresponding rank in the sequencer
and the sample time
HAL_ADC_AnalogWDGConfig
This function configures the analog watchdog for
the selected ADC
HAL_ADC_GetState()
This function allows getting in runtime the
peripheral and the data flow states.
HAL_ADC_GetError()
This fuction allows getting in runtime the error
that occurred during IT routine
Control group
State and
Errors group
2.7
HAL extension APIs
2.7.1
HAL extension model overview
The extension APIs provide specific functions or overwrite modified APIs for a specific
family (series) or specific part number within the same family.
The extension model consists of an additional file, stm32f0xx_hal_ppp_ex.c, that includes
all the specific functions and define statements (stm32f0xx_hal_ppp_ex.h) for a given part
number.
Below an example based on the ADC peripheral:
Table 10: HAL extension APIs
Function Group
Common API Name
HAL_ADCEx_CalibrationStart()
This function is used to start the automatic ADC calibration
HAL_ADCEx_Calibration_GetValue()
This function is used to get the ADC calibration factor
HAL_ADCEx_Calibration_SetValue()
This function is used to set the calibration factor to overwrite
automatic conversion result
DocID026525 Rev 6
39/1320
Overview of HAL drivers
2.7.2
UM1785
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 part number-specific function
When a new feature specific to a given device is required, the new APIs are added in the
stm32f0xx_hal_ppp_ex.c extension file. They are named HAL_PPPEx_Function().
Figure 2: Adding device-specific functions
Example: stm32f0xx_hal_rcc_ex.c/h
#if defined(STM32F042x6) || defined(STM32F048xx) || \
defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) || \
defined(STM32F091xC) || defined(STM32F098xx)
void HAL_RCCEx_CRSConfig(RCC_CRSInitTypeDef *pInit);
void HAL_RCCEx_CRSSoftwareSynchronizationGenerate(void);
void HAL_RCCEx_CRSGetSynchronizationInfo(RCC_CRSSynchroInfoTypeDef *pSynchroInfo);
RCC_CRSStatusTypeDef HAL_RCCEx_CRSWaitSynchronization(uint32_t Timeout);
#endif /* STM32F042x6 || STM32F048xx || */
/* STM32F071xB || STM32F072xB || STM32F078xx || */
/* STM32F091xC || STM32F098xx */
Case 2: Adding a family-specific function
In this case, the API is added in the extension driver C file and named
HAL_PPPEx_Function ().
Figure 3: Adding family-specific functions
40/1320
DocID026525 Rev 6
UM1785
Overview of HAL drivers
Case 3: Adding a new peripheral (specific to a device belonging to a given
family)
When a peripheral which is available only in a specific device is required, the APIs
corresponding to this new peripheral/module are added in stm32f0xx_hal_newppp.c.
However the inclusion of this file is selected in the stm32f0xx_hal_conf.h using the macro:
#define HAL_NEWPPP_MODULE_ENABLED
Figure 4: Adding new peripherals
Example:xx_hal_lcd.c/h
Case 4: Updating existing common APIs
In this case, the routines are defined with the same names in the xx_hal_ppp_ex.c
extension file, while the generic API is defined as weak, so that the compiler will overwrite
the original routine by the new defined function.
Figure 5: Updating existing APIs
Case 5: Updating existing data structures
The data structure for a specific device part number (e.g. PPP_InitTypeDef) can be
composed of different fields. In this case, the data structure is defined in the extension
header file and delimited by the specific part number define statement.
Example:
#if defined (STM32F072xB)
typedef struct
{
(…)
}PPP_InitTypeDef;
#endif /* STM32F072xB */
DocID026525 Rev 6
41/1320
Overview of HAL drivers
2.8
UM1785
File inclusion model
The header of the common HAL driver file (stm32f0xx_hal.h) includes the common
configurations for the whole HAL library. It is the only header file that is included in the user
sources and the HAL C sources files to be able to use the HAL resources.
Figure 6: File inclusion model
A PPP driver is a standalone module which is used in a project. The user must enable the
corresponding USE_HAL_PPP_MODULE define statement in the configuration file.
/*********************************************************************
* @file stm32f0xx_hal_conf.h
* @author MCD Application Team
* @version VX.Y.Z * @date dd-mm-yyyy
* @brief This file contains the modules to be used
**********************************************************************
(…)
#define USE_HAL_USART_MODULE
#define USE_HAL_IRDA_MODULE
#define USE_HAL_DMA_MODULE
#define USE_HAL_RCC_MODULE
(…)
42/1320
DocID026525 Rev 6
UM1785
2.9
Overview of HAL drivers
HAL common resources
The common HAL resources, such as common define enumerations, structures and
macros, are defined in stm32f0xx_hal_def.h.The main common define enumeration is
HAL_StatusTypeDef.
HAL Status The HAL status is used by almost all HAL APIs, except for boolean
functions and IRQ handler. It returns the status of the current API operations. It has
four possible values as described below:
Typedef enum
{
HAL_OK = 0x00,
HAL_ERROR = 0x01,
HAL_BUSY = 0x02,
HAL_TIMEOUT = 0x03
} HAL_StatusTypeDef;
HAL Locked The HAL lock is used by all HAL APIs to prevent accessing by accident
shared resources.
typedef enum
{
HAL_UNLOCKED = 0x00, /*!__PPP_DMA_FIELD_ = &(__DMA_HANDLE_); \
(__DMA_HANDLE_).Parent = (__HANDLE__); \
} while(0)
2.10
HAL configuration
The configuration file, stm32f0xx_hal_conf.h, allows customizing the drivers for the user
application. Modifying this configuration is not mandatory: the application can use the
default configuration without any modification.
To configure these parameters, the user should enable, disable or modify some options by
uncommenting, commenting or modifying the values of the related define statements as
described in the table below:
DocID026525 Rev 6
43/1320
Overview of HAL drivers
UM1785
Table 11: Define statements used for HAL configuration
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.
8 000 000
(Hz)
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)
HSI_STARTUP_TIMEOUT
Timeout for HSI start-up, expressed in ms
5000
LSE_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.
32768 (Hz)
LSE_STARTUP_TIMEOUT
Timeout for LSE start-up, expressed in ms
5000
HSI14_VALUE
Defines the value of the Internal High Speed oscillator
for ADC expressed in Hz. The real value may vary
depending on the variations in voltage and
temperature.
14 000 000
(Hz)
HSI48_VALUE
Defines the value of the Internal High Speed oscillator
for USB expressed in Hz. The real value may vary
depending on the variations in voltage and
temperature.
48 000 000
(Hz)
LSI_VALUE
Defines the value of the Internal Low Speed oscillator
expressed in Hz. The real value may vary depending
on the variations in voltage and temperature.
40 000 (Hz)
VDD_VALUE
VDD value
3300 (mV)
USE_RTOS
Enables the use of RTOS
FALSE (for
future use)
PREFETCH_ENABLE
Enables prefetch feature
TRUE
HSE_STARTUP_TIMEOUT
The stm32f0xx_hal_conf_template.h file is located in the HAL drivers Inc folder. It
should be copied to the user folder, renamed and modified as described above.
By default, the values defined in the stm32f0xx_hal_conf_template.h file are the
same as the ones used for the examples and demonstrations. All HAL include
files are enabled so that they can be used in the user code without modifications.
44/1320
DocID026525 Rev 6
UM1785
2.11
Overview of HAL drivers
HAL system peripheral handling
This chapter gives an overview of how the system peripherals are handled by the HAL
drivers. The full API list is provided within each peripheral driver description section.
2.11.1
Clock
Two main functions can be used to configure the system clock:
HAL_RCC_OscConfig (RCC_OscInitTypeDef *RCC_OscInitStruct). This function
configures/enables multiple clock sources (HSE, HSI, LSE, LSI, PLL).
HAL_RCC_ClockConfig (RCC_ClkInitTypeDef *RCC_ClkInitStruct, uint32_t
FLatency). This function
selects the system clock source
configures AHB and APB clock dividers
configures the number of Flash memory wait states
updates the SysTick configuration when HCLK clock changes.
Some peripheral clocks are not derived from the system clock (RTC, USB…). In this case,
the clock configuration is performed by an extended API defined in
stm32f0xx_hal_rcc_ex.c: HAL_RCCEx_PeriphCLKConfig(RCC_PeriphCLKInitTypeDef
*PeriphClkInit).
Additional RCC HAL driver functions are available:
HAL_RCC_DeInit() Clock de-init function that return clock configuration to reset state
Get clock functions that allow retreiving various clock configurations (system clock,
HCLK, PCLK1, …)
MCO and CSS configuration functions
A set of macros are defined in stm32f0xx_hal_rcc.h andstm32f0xx_hal_rcc_ex.h. They
allow executing elementary operations on RCC block registers, such as peripherals clock
gating/reset control:
__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.
2.11.2
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), the pin mode can be
configured as EXTI with interrupt or event generation.
When selecting EXTI mode with interrupt generation, the user must call
HAL_GPIO_EXTI_IRQHandler() from stm32f0xx_it.c and implement
HAL_GPIO_EXTI_Callback()
The table below describes the GPIO_InitTypeDef structure field.
DocID026525 Rev 6
45/1320
Overview of HAL drivers
UM1785
Table 12: Description of GPIO_InitTypeDef structure
Structure
field
Pin
Description
Specifies the GPIO pins to be configured.
Possible values: GPIO_PIN_x or GPIO_PIN_All, where x[0..15]
Specifies the operating mode for the selected pins: GPIO mode or EXTI mode.
Possible values are:
Mode
GPIO mode
GPIO_MODE_INPUT : Input floating
GPIO_MODE_OUTPUT_PP : Output push-pull
GPIO_MODE_OUTPUT_OD : Output open drain
GPIO_MODE_AF_PP : Alternate function push-pull
GPIO_MODE_AF_OD : Alternate function open drain
GPIO_MODE_ANALOG : Analog mode
External Interrupt mode
GPIO_MODE_IT_RISING : Rising edge trigger detection
GPIO_MODE_IT_FALLING : Falling edge trigger detection
GPIO_MODE_IT_RISING_FALLING : Rising/Falling edge trigger detection
External Event mode
GPIO_MODE_EVT_RISING : Rising edge trigger detection
GPIO_MODE_EVT_FALLING : Falling edge trigger detection
GPIO_MODE_EVT_RISING_FALLING: Rising/Falling edge trigger
detection
Pull
Specifies the Pull-up or Pull-down activation for the selected pins.
Possible values are:
GPIO_NOPULL
GPIO_PULLUP
GPIO_PULLDOWN
Speed
Specifies the speed for the selected pins
Possible values are:
GPIO_SPEED_FREQ_LOW
GPIO_SPEED_FREQ_MEDIUM
GPIO_SPEED_FREQ_HIGH
Alternate
Peripheral to be connected to the selected pins.
Possible values: GPIO_AFx_PPP, where
AFx: is the alternate function index
PPP: is the peripheral instance
Example: use GPIO_AF1_TIM2 to connect TIM2 IOs on AF1.
These values are defined in the GPIO extended driver, since the AF mapping may
change between product lines.
Refer to the “Alternate function mapping” table in the
datasheets for the detailed description of the system and
peripheral I/O alternate functions.
46/1320
DocID026525 Rev 6
UM1785
Overview of HAL drivers
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_FREQ_MEDIUM;
HAL_GPIO_Init(GPIOD, &GPIO_InitStruct);
Configuring PA0 as external interrupt with falling edge sensitivity:
GPIO_InitStructure.Mode = GPIO_MODE_IT_FALLING;
GPIO_InitStructure.Pull = GPIO_NOPULL;
GPIO_InitStructure.Pin = GPIO_PIN_0;
HAL_GPIO_Init(GPIOA, &GPIO_InitStructure);
Configuring USART1 Tx (PA9, mapped on AF4) as alternate function:
GPIO_InitStruct.Pin = GPIO_PIN_9;
GPIO_InitStruct.Mode = GPIO_MODE_AF_PP;
GPIO_InitStruct.Pull = GPIO_PULLUP;
GPIO_InitStruct.Speed = GPIO_SPEED_FREQ_HIGH;
GPIO_InitStruct.Alternate = GPIO_AF4_USART1;
HAL_GPIO_Init(GPIOA, &GPIO_InitStruct);
2.11.3
Cortex NVIC and SysTick timer
The Cortex HAL driver, stm32f0xx_hal_cortex.c, provides APIs to handle NVIC and
Systick. The supported APIs include:
HAL_NVIC_SetPriority()
HAL_NVIC_EnableIRQ()/HAL_NVIC_DisableIRQ()
HAL_NVIC_SystemReset()
HAL_SYSTICK_IRQHandler()
HAL_NVIC_GetPendingIRQ() / HAL_NVIC_SetPendingIRQ () /
HAL_NVIC_ClearPendingIRQ()
HAL_SYSTICK_Config()
HAL_SYSTICK_CLKSourceConfig()
HAL_SYSTICK_Callback()
2.11.4
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_PVDConfig()
HAL_PWR_EnablePVD() / HAL_PWR_DisablePVD()
HAL_PWR_PVD_IRQHandler()
HAL_PWR_PVDCallback()
Wakeup pin configuration
HAL_PWR_EnableWakeUpPin() / HAL_PWR_DisableWakeUpPin()
Low-power mode entry
HAL_PWR_EnterSLEEPMode()
HAL_PWR_EnterSTOPMode()
HAL_PWR_EnterSTANDBYMode()
Backup domain configuration
HAL_PWR_EnableBkUpAccess()/ HAL_PWR_DisableBkUpAccess()
DocID026525 Rev 6
47/1320
Overview of HAL drivers
2.11.5
UM1785
EXTI
The EXTI is not considered as a standalone peripheral but rather as a service used by
other peripheral. As a result there are no EXTI APIs but each peripheral HAL driver
implements the associated EXTI configuration and EXTI function are implemented as
macros in its header file.
The first 16 EXTI lines connected to the GPIOs are managed within the GPIO driver. The
GPIO_InitTypeDef structure allows configuring an I/O as external interrupt or external
event.
The EXTI lines connected internally to the PVD, RTC, USB, and COMP are configured
within the HAL drivers of these peripheral through the macros given in the table below. The
EXTI internal connections depend on the targeted STM32 microcontroller (refer to the
product datasheet for more details):
Table 13: Description of EXTI configuration macros
Macros
Description
PPP_EXTI_LINE_FUNCTION
Defines the EXTI line connected to the internal peripheral.
Example:
#define PWR_EXTI_LINE_PVD ((uint32_t)0x00010000) /*!DMA_Handle->XferCpltCallback = HAL_UART_TxCpltCallback ;
hppp->DMA_Handle->XferErrorCallback = HAL_UART_ErrorCallback ;
(…)
}
2.12.4
Timeout and error management
2.12.4.1
Timeout management
The timeout is often used for the APIs that operate in polling mode. It defines the delay
during which a blocking process should wait till an error is returned. An example is provided
below:
HAL_StatusTypeDef HAL_DMA_PollForTransfer(DMA_HandleTypeDef *hdma, uint32_t
CompleteLevel, uint32_t Timeout)
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 stm32fxxx_hal_def.h as 0xFFFFFFFF
However, in some cases, a fixed timeout is used for system peripherals or internal HAL
driver processes. In these cases, the timeout has the same meaning and is used in the
same way, except when it is defined locally in the drivers and cannot be modified or
introduced as an argument in the user application.
Example of fixed timeout:
#define LOCAL_PROCESS_TIMEOUT 100
HAL_StatusTypeDef HAL_PPP_Process(PPP_HandleTypeDef)
{
(…)
timeout = HAL_GetTick() + LOCAL_PROCESS_TIMEOUT;
(…)
while(ProcessOngoing)
{
(…)
if(HAL_GetTick() >= timeout)
{
/* Process unlocked */
__HAL_UNLOCK(hppp);
hppp->State= HAL_PPP_STATE_TIMEOUT;
return HAL_PPP_STATE_TIMEOUT;
}
}
(…)
}
The following example shows how to use the timeout inside the polling functions:
HAL_PPP_StateTypeDef HAL_PPP_Poll (PPP_HandleTypeDef *hppp, uint32_t Timeout)
{
(…)
timeout = HAL_GetTick() + Timeout;
(…)
while(ProcessOngoing)
{
56/1320
DocID026525 Rev 6
UM1785
Overview of HAL drivers
(…)
if(Timeout != HAL_MAX_DELAY)
{
if(HAL_GetTick() >= timeout)
{
/* Process unlocked */
__HAL_UNLOCK(hppp);
hppp->State= HAL_PPP_STATE_TIMEOUT;
return hppp->State;
}
}
(…)
}
2.12.4.2
Error management
The HAL drivers implement a check on the following items:
Valid parameters: for some process the used parameters should be valid and already
defined, otherwise the system may crash or go into an undefined state. These critical
parameters are checked before being used (see example below).
HAL_StatusTypeDef HAL_PPP_Process(PPP_HandleTypeDef* hppp, uint32_t *pdata, uint32
Size)
{
if ((pData == NULL ) || (Size == 0))
{
return HAL_ERROR;
}
}
Valid handle: the PPP peripheral handle is the most important argument since it keeps
the PPP driver vital parameters. It is always checked in the beginning of the
HAL_PPP_Init() function.
HAL_StatusTypeDef HAL_PPP_Init(PPP_HandleTypeDef* hppp)
{
if (hppp == NULL) //the handle should be already allocated
{
return HAL_ERROR;
}
}
Timeout error: the following statement is used when a timeout error occurs: while
(Process ongoing)
{
timeout = HAL_GetTick() + Timeout; while (data processing is running)
{
if(timeout) { return HAL_TIMEOUT;
}
}
When an error occurs during a peripheral process, HAL_PPP_Process () returns with a
HAL_ERROR status. The HAL PPP driver implements the HAL_PPP_GetError () to allow
retrieving the origin of the error.
HAL_PPP_ErrorTypeDef HAL_PPP_GetError (PPP_HandleTypeDef *hppp);
In all peripheral handles, a HAL_PPP_ErrorTypeDef is defined and used to store the last
error code.
typedef struct
{
PPP_TypeDef * Instance; /* PPP registers base address */
PPP_InitTypeDef Init; /* PPP initialization parameters */
HAL_LockTypeDef Lock; /* PPP locking object */
__IO HAL_PPP_StateTypeDef State; /* PPP state */
__IO HAL_PPP_ErrorTypeDef ErrorCode; /* PPP Error code */
(…)
DocID026525 Rev 6
57/1320
Overview of HAL drivers
UM1785
/* PPP specific parameters */
}
PPP_HandleTypeDef;
The error state and the peripheral global state are always updated before returning an
error:
PPP->State = HAL_PPP_READY; /* Set the peripheral ready */
PP->ErrorCode = HAL_ERRORCODE ; /* Set the error code */
_HAL_UNLOCK(PPP) ; /* Unlock the PPP resources */
return HAL_ERROR; /*return with HAL error */
HAL_PPP_GetError () must be used in interrupt mode in the error callback:
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
driver functions. The run-time checking is achieved by using an assert_param macro. This
macro is used in all the HAL driver functions which have an input parameter. It allows
verifying that the input value lies within the parameter allowed values.
To enable the run-time checking, use the assert_param macro, and leave the define
USE_FULL_ASSERT uncommented in stm32f0xx_hal_conf.h file.
void HAL_UART_Init(UART_HandleTypeDef *huart)
{
(..) /* Check the parameters */
assert_param(IS_UART_INSTANCE(huart->Instance));
assert_param(IS_UART_BAUDRATE(huart->Init.BaudRate));
assert_param(IS_UART_WORD_LENGTH(huart->Init.WordLength));
assert_param(IS_UART_STOPBITS(huart->Init.StopBits));
assert_param(IS_UART_PARITY(huart->Init.Parity));
assert_param(IS_UART_MODE(huart->Init.Mode));
assert_param(IS_UART_HARDWARE_FLOW_CONTROL(huart->Init.HwFlowCtl));
(..)
/** @defgroup UART_Word_Length *
@{
*/
#define UART_WORDLENGTH_8B ((uint32_t)0x00000000)
#define UART_WORDLENGTH_9B ((uint32_t)USART_CR1_M)
#define IS_UART_WORD_LENGTH(LENGTH) (((LENGTH) == UART_WORDLENGTH_8B) ||
\ ((LENGTH) == UART_WORDLENGTH_9B))
If the expression passed to the assert_param macro is false, theassert_failed function is
called and returns the name of the source file and the source line number of the call that
failed. If the expression is true, no value is returned.
The assert_param macro is implemented in stm32f0xx_hal_conf.h:
/* Exported macro ------------------------------------------------------------*/
#ifdef USE_FULL_ASSERT
/**
* @brief The assert_param macro is used for function's parameters check.
* @param expr: If expr is false, it calls assert_failed function
* which reports the name of the source file and the source
* line number of the call that failed.
* If expr is true, it returns no value.
* @retval None */
#define assert_param(expr) ((expr)?(void)0:assert_failed((uint8_t *)__FILE__,
__LINE__))
/* Exported functions --------------------------------------*/
void assert_failed(uint8_t* file, uint32_t line);
#else
58/1320
DocID026525 Rev 6
UM1785
Overview of HAL drivers
#define assert_param(expr)((void)0)
#endif /* USE_FULL_ASSERT */
The assert_failed function is implemented in the main.c file or in any other user C file:
#ifdef USE_FULL_ASSERT /**
* @brief Reports the name of the source file and the source line number
* where the assert_param error has occurred.
* @param file: pointer to the source file name
* @param line: assert_param error line source number
* @retval None */
void assert_failed(uint8_t* file, uint32_t line)
{
/* User can add his own implementation to report the file name and line number,
ex: printf("Wrong parameters value: file %s on line %d\r\n", file, line) */
/* Infinite loop */
while (1)
{
}
}
Because of the overhead run-time checking introduces, it is recommended
to use it during application code development and debugging, and to
remove it from the final application to improve code size and speed.
DocID026525 Rev 6
59/1320
Overview of low-layer drivers
3
UM1785
Overview of low-layer drivers
The low-layer (LL) drivers are designed to offer a fast light-weight expert-oriented layer
which is closer to the hardware than the HAL. Contrary to the HAL, LL APIs are not
provided for peripherals where optimized access is not a key feature, or those requiring
heavy software configuration and/or complex upper-level stack (such USB).
The LL drivers feature:
A set of functions to initialize peripheral main features according to the parameters
specified in data structures
A set of functions used to fill initialization data structures with the reset values of each
field
Functions to perform peripheral de-initialization (peripheral registers restored to their
default values)
A set of inline functions for direct and atomic register access
Full independence from HAL since LL drivers can be used either in standalone mode
(without HAL drivers) or in mixed mode (with HAL drivers)
Full coverage of the supported peripheral features.
The low-layer drivers provide hardware services based on the available features of the
STM32 peripherals. These services reflect exactly the hardware capabilities and provide
one-shot operations that must be called following the programming model described in the
microcontroller line reference manual. As a result, the LL services do not implement any
processing and do not require any additional memory resources to save their states,
counter or data pointers: all the operations are performed by changing the associated
peripheral registers content.
3.1
Low-layer files
The low-layer drivers are built around header/C files (one per each supported peripheral)
plus five header files for some System and Cortex related features.
Table 16: LL driver files
File
Description
stm32f0xx_ll_bus.h
This is the h-source file for core bus control and peripheral clock
activation and deactivation
Example: LL_AHB1_GRP1_EnableClock
stm32f0xx_ll_ppp.h/.c
stm32f0xx_ll_ppp.c provides peripheral initialization functions such as
LL_PPP_Init(), LL_PPP_StructInit(), LL_PPP_DeInit(). All the other
APIs are definined within stm32f0xx_ll_ppp.h file.
The low-layer PPP driver is a standalone module. To use it, the
application must include it in the xx_ll_ppp.h file.
stm32xx_ll_cortex.h
CortexM related register operation APIs including the Systick, Low
power (LL_SYSTICK_xxxxx, LL_LPM_xxxxx "Low Power Mode" ...)
This file covers the generic APIs:
stm32xx_ll_xx_ll_utils.h/.c
stm32xx_ll_xx_ll_system.h
60/1320
Read of device unique ID and electronic signature
Timebase and delay management
System clock configuration.
System related operations (LL_SYSCFG_xxx, LL_DBGMCU_xxx,
LL_FLASH_xxx)
DocID026525 Rev 6
UM1785
Overview of low-layer drivers
File
stm32_assert_template.h
Description
Template file allowing to define the assert_param macro, that is used
when run-time checking is enabled.
This file is required only when the LL drivers are used in standalone
mode (without calling the HAL APIs). It should be copied to the
application folder and renamed to stm32_assert.h.
There is no configuration file for the LL drivers.
The low-layer files are located in the same HAL driver folder.
Figure 8: Low-layer driver folders
In general, low-layer drivers include only the STM32 CMSIS device file.
#include "stm32yyxx.h"
DocID026525 Rev 6
61/1320
Overview of low-layer drivers
UM1785
Figure 9: Low-layer driver CMSIS files
Application files have to include only the used low-layer drivers header files.
3.2
Overview of low-layer APIs and naming rules
3.2.1
Peripheral initialization functions
The LL drivers offer three sets of initialization functions. They are defined in
stm32f0xx_ll_ppp.c file:
Functions to initialize peripheral main features according to the parameters specified
in data structures
A set of functions used to fill initialization data structures with the reset values of each
field
Function for peripheral de-initialization (peripheral registers restored to their default
values)
The definition of these LL initialization functions and associated resources (structure,
literals and prototypes) is conditioned by a compilation switch: USE_FULL_LL_DRIVER. To
use these functions, this switch must be added in the toolchain compiler preprocessor or to
any generic header file which is processed before the LL drivers.
The below table shows the list of the common functions provided for all the supported
peripherals:
62/1320
DocID026525 Rev 6
UM1785
Overview of low-layer drivers
Table 17: Common peripheral initialization functions
Return
Type
Functions
Parameters
ErrorStatus
LL_PPP_Init
LL_PPP_StructInit
LL_PPP_DeInit
void
ErrorStatus
Description
PPP_TypeDef* PPPx
LL_PPP_InitTypeDef*
PPP_InitStruct
Initializes the peripheral main features according
to the parameters specified in PPP_InitStruct.
Example: LL_USART_Init(USART_TypeDef
*USARTx, LL_USART_InitTypeDef
*USART_InitStruct)
LL_PPP_InitTypeDef*
PPP_InitStruct
Fills each PPP_InitStruct member with its default
value.
Example.
LL_USART_StructInit(LL_USART_InitTypeDef
*USART_InitStruct)
PPP_TypeDef* PPPx
De-initializes the peripheral registers, that is
restore them to their default reset values.
Example. LL_USART_DeInit(USART_TypeDef
*USARTx)
Additional functions are available for some peripherals (refer to Table 18: "Optional
peripheral initialization functions" ).
Table 18: Optional peripheral initialization functions
Functions
Return
Type
Parameters
Examples
Initializes peripheral features according to
the parameters specified in PPP_InitStruct.
Example:
LL_RTC_TIME_Init(RTC_TypeDef *RTCx,
uint32_t RTC_Format,
LL_RTC_TimeTypeDef *RTC_TimeStruct)
LL_PPP{_CATEGORY}_I
nit
Error
Status
PPP_TypeDef* PPPx
LL_PPP{_CATEGOR
Y}_ InitTypeDef*
PPP{_CATEGORY}_I
nitStruct
LL_RTC_DATE_Init(RTC_TypeDef *RTCx,
uint32_t RTC_Format,
LL_RTC_DateTypeDef *RTC_DateStruct)
LL_TIM_IC_Init(TIM_TypeDef* TIMx,
uint32_t Channel, LL_TIM_IC_InitTypeDef*
TIM_IC_InitStruct)
LL_TIM_ENCODER_Init(TIM_TypeDef*
TIMx, LL_TIM_ENCODER_InitTypeDef*
TIM_EncoderInitStruct)
LL_PPP{_CATEGORY}_
StructInit
void
LL_PPP{_CATEGORY}_Ini
t TypeDef*
PPP{_CATEGORY}_Init
Struct
DocID026525 Rev 6
Fills each PPP{_CATEGORY}_InitStruct
member with its default value.
Example:
LL_RTC_TIME_StructInit(LL_RTC_TimeTyp
eDef *RTC_TimeStruct);
63/1320
Overview of low-layer drivers
Return
Type
Functions
Error
Status
LL_PPP_CommonInit
LL_PPP_CommonStruct
Init
void
ErrorSta
tus
LL_PPP_ClockInit
UM1785
Parameters
PPP_TypeDef* PPPx
LL_PPP_CommonInit
TypeDef*
PPP_CommonInit
Struct
LL_PPP_CommonInitType
Def*
PPP_CommonInitStruct
PPP_TypeDef* PPPx
LL_PPP_ClockInit
TypeDef*
PPP_ClockInitStruct
Examples
Initializes the common features shared
between different instances of the same
peripheral.
Example:
LL_ADC_CommonInit(ADC_Common_Type
Def *ADCxy_COMMON,
LL_ADC_CommonInitTypeDef
*ADC_CommonInitStruct)
Fills each PPP_CommonInitStruct member
with its default value
Example:
LL_ADC_CommonStructInit(LL_ADC_Comm
onInitTypeDef *ADC_CommonInitStruct)
Initializes the peripheral clock configuration
in synchronous mode.
Example:
LL_USART_ClockInit(USART_TypeDef
*USARTx, LL_USART_ClockInitTypeDef
*USART_ClockInitStruct)
Fills each PPP_ClockInitStruct member with
its default value
LL_PPP_ClockStructInit
3.2.1.1
void
LL_PPP_ClockInitTypeDef*
PPP_ClockInitStruct
Example:
LL_USART_ClockStructInit(LL_USART_Clo
ckInitTypeDef *USART_ClockInitStruct)
Run-time checking
Like HAL drivers, LL initialization functions implement run-time failure detection by
checking the input values of all LL driver functions. For more details please refer to Section
2.12.4.3: "Run-time checking".
When using the LL drivers in standalone mode (without calling HAL functions), the
following actions are required to use run-time checking:
1.
2.
3.
Copy stm32_assert_template.h to the application folder and rename it to
stm32_assert.h. This file defines the assert_param macro which is used when runtime checking is enabled.
Include stm32_assert.h file within the application main header file.
Add the USE_FULL_ASSERT compilation switch in the toolchain compiler
preprocessor or in any generic header file which is processed before the
stm32_assert.h driver.
Run-time checking is not available for LL inline functions.
64/1320
DocID026525 Rev 6
UM1785
3.2.2
Overview of low-layer drivers
Peripheral register-level configuration functions
On top of the peripheral initialization functions, the LL drivers offer a set of inline functions
for direct atomic register access. Their format is as follows:
__STATIC_INLINE return_type LL_PPP_Function (PPPx_TypeDef *PPPx, args)
The “Function” naming is defined depending to the action category:
Specific Interrupt, DMA request and status flags management:
Set/Get/Clear/Enable/Disable flags on interrupt and status registers
Table 19: Specific Interrupt, DMA request and status flags management
Name
Examples
LL_RCC_IsActiveFlag_LSIRDY
LL_RCC_IsActiveFlag_FWRST()
LL_ADC_ClearFlag_EOC(ADC1)
LL_DMA_ClearFlag_TCx(DMA_TypeDef* DMAx)
LL_PPP_{_CATEGORY}_ActionItem_BITNAME
LL_PPP{_CATEGORY}_IsItem_BITNAME_Action
Table 20: Available function formats
Item
Action
Format
Get
LL_PPP_IsActiveFlag_BITNAME
Clear
LL_PPP_ClearFlag_BITNAME
Enable
LL_PPP_EnableIT_BITNAME
Disable
LL_PPP_DisableIT_BITNAME
Get
LL_PPP_IsEnabledIT_BITNAME
Enable
LL_PPP_EnableDMAReq_BITNAME
Disable
LL_PPP_DisableDMAReq_BITNAME
Get
LL_PPP_IsEnabledDMAReq_BITNAME
Flag
Interrupts
DMA
BITNAME refers to the peripheral register bit name as described in the product
line reference manual.
Peripheral clock activation/deactivation management: Enable/Disable/Reset a
peripheral clock
Table 21: Peripheral clock activation/deactivation management
Name
LL_bus_GRPx_ActionClock{Mode}
Examples
LL_AHB1_GRP1_EnableClock
(LL_AHB1_GRP1_PERIPH_GPIOA|LL_AHB1_GRP1_PERIPH_
GPIOB)
LL_APB1_GRP1_EnableClockSleep
(LL_APB1_GRP1_PERIPH_DAC1)
'x' corresponds to the group index and refers to the index of the modified register
on a given bus.
DocID026525 Rev 6
65/1320
Overview of low-layer drivers
UM1785
'bus' correspond to the bus name (for example APB1).
Peripheral activation/deactivation management: Enable/disable a peripheral or
activate/deactivate specific peripheral features
Table 22: Peripheral activation/deactivation management
Name
Examples
LL_ADC_Enable ()
LL_ADC_StartCalibration();
LL_ADC_IsCalibrationOnGoing;
LL_RCC_HSI_Enable ()
LL_RCC_HSI_IsReady()
LL_PPP{_CATEGORY}_Action{Item}
LL_PPP{_CATEGORY}_IsItemAction
Peripheral configuration management: Set/get a peripheral configuration settings
Table 23: Peripheral configuration management
Name
Examples
LL_PPP{_CATEGORY}_Set{ or
Get}ConfigItem
LL_USART_SetBaudRate (USART2, 16000000,
LL_USART_OVERSAMPLING_16, 9600)
Peripheral register management: Write/read the content of a register/retrun DMA
relative register address
Table 24: Peripheral register management
Name
LL_PPP_WriteReg(__INSTANCE__, __REG__, __VALUE__)
LL_PPP_ReadReg(__INSTANCE__, __REG__)
LL_PPP_DMA_GetRegAddr (PPP_TypeDef *PPPx,{Sub Instance if any ex: Channel} , {uint32_t Propriety})
The Propriety is a variable used to identify the DMA transfer direction or the data
register type.
66/1320
DocID026525 Rev 6
UM1785
4
Cohabiting of HAL and LL
Cohabiting of HAL and LL
The low-layer APIs are designed to be used in standalone mode or combined with the HAL.
They cannot be automatically used with the HAL for the same peripheral instance. If you
use the LL APIs for a specific instance, you can still use the HAL APIs for other instances.
Be careful that the low-layer might overwrite some registers which content is mirrored in the
HAL handles.
4.1
Low-layer driver used in standalone mode
The low-layer APIs can be used without calling the HAL driver services. This is done by
simply including stm32f0xx_ll_ppp.h in the application files. The LL APIs for a given
peripheral are called by executing the same sequence as the one recommended by the
programming model in the corresponding product line reference manual. In this case the
HAL drivers associated to the used peripheral can be removed from the workspace.
However the STM32F0 framework should be used in the same way as in the HAL drivers
case which means that System file, startup file and CMSIS should always be used.
When the BSP drivers are included, the used HAL drivers associated with the
BSP functions drivers should be included in the workspace, even if they are not
used by the application layer.
4.2
Mixed use of low-layer APIs and HAL drivers
In this case the low-layer APIs are used in conjunction with the HAL drivers to achieve
direct and register level based operations.
Mixed use is allowed, however some consideration should be taken into account:
It is recommended to avoid using simultaneously the HAL APIs and the combination of
low-layer APIs for a given peripheral instance. If this is the case, one or more private
fields in the HAL PPP handle structure should be updated accordingly.
For operations and processes that do not alter the handle fields including the
initialization structure, the HAL driver APIs and the low-layer services can be used
together for the same peripheral instance.
The low-layer drivers can be used without any restriction with all the HAL drivers that
are not based on handle objects (RCC, common HAL, flash and GPIO).
Several examples showing how to use HAL and LL in the same application are provided
within STM32F0 firmware package (refer to Examples_MIX projects).
1.
2.
3.
When the HAL Init/DeInit APIs are not used and are replaced by the lowlayer macros, the InitMsp() functions are not called and the MSP initialization
should be done in the user application.
When process APIs are not used and the corresponding function is
performed through the low-layer APIs, the callbacks are not called and post
processing or error management should be done by the user application.
When the LL APIs is used for process operations, the IRQ handler HAL APIs
cannot be called and the IRQ should be implemented by the user application.
Each LL driver implements the macros needed to read and clear the
associated interrupt flags.
DocID026525 Rev 6
67/1320
HAL System Driver
UM1785
5
HAL System Driver
5.1
HAL Firmware driver API description
5.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:
HAL Initialization and de-initialization functions
HAL Control functions
5.1.2
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 source of time base also when timeout is needed and the backup
domain when enabled.
de-Initializes common part of the HAL.
Configure The time base source to have 1ms time base with a dedicated Tick interrupt
priority.
Systick timer is used by default as source of time base, but user can eventually
implement his proper time base source (a general purpose timer for example or
other time source), keeping in mind that Time base duration should be kept 1ms
since PPP_TIMEOUT_VALUEs are defined and handled in milliseconds basis.
Time base configuration function (HAL_InitTick ()) is called automatically at the
beginning of the program after reset by HAL_Init() or at any time when clock is
configured, by HAL_RCC_ClockConfig().
Source of time base is configured to generate interrupts at regular time intervals.
Care must be taken if HAL_Delay() is called from a peripheral ISR process, the
Tick interrupt line must have higher priority (numerically lower) than the
peripheral interrupt. Otherwise the caller ISR process will be blocked.
functions affecting time base configurations are declared as __Weak to make
override possible in case of other implementations in user file.
This section contains the following APIs:
HAL_Init()
HAL_DeInit()
HAL_MspInit()
HAL_MspDeInit()
HAL_InitTick()
5.1.3
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
68/1320
DocID026525 Rev 6
UM1785
HAL System Driver
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:
HAL_IncTick()
HAL_GetTick()
HAL_Delay()
HAL_SuspendTick()
HAL_ResumeTick()
HAL_GetHalVersion()
HAL_GetREVID()
HAL_GetDEVID()
HAL_GetUIDw0()
HAL_GetUIDw1()
HAL_GetUIDw2()
HAL_DBGMCU_EnableDBGStopMode()
HAL_DBGMCU_DisableDBGStopMode()
HAL_DBGMCU_EnableDBGStandbyMode()
HAL_DBGMCU_DisableDBGStandbyMode()
5.1.4
Detailed description of functions
HAL_Init
Function name
HAL_StatusTypeDef HAL_Init (void )
Function description
This function configures the Flash prefetch, Configures time base
source, NVIC and Low level hardware.
Return values
HAL: status
Notes
This function is called at the beginning of program after reset
and before the clock configuration
The time base configuration is based on HSI clock when
exiting from Reset. Once done, time base tick start
incrementing. In the default implementation,Systick is used as
source of time base. The tick variable is incremented each
1ms in its ISR.
HAL_DeInit
Function name
HAL_StatusTypeDef HAL_DeInit (void )
Function description
This function de-Initializes common part of the HAL and stops the
source of time base.
Return values
HAL: status
Notes
This function is optional.
DocID026525 Rev 6
69/1320
HAL System Driver
UM1785
HAL_MspInit
Function name
void HAL_MspInit (void )
Function description
Initializes the MSP.
Return values
None
HAL_MspDeInit
Function name
void HAL_MspDeInit (void )
Function description
DeInitializes the MSP.
Return values
None
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.
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.
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
70/1320
Delay: specifies the delay time length, in milliseconds.
DocID026525 Rev 6
UM1785
HAL System Driver
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 where uwTick is incremented.
ThiS function is declared as __weak to be overwritten in case
of other implementations in user file.
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_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 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.
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 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.
HAL_GetHalVersion
Function name
uint32_t HAL_GetHalVersion (void )
Function description
This method returns the HAL revision.
Return values
version: : 0xXYZR (8bits for each decimal, R for RC)
DocID026525 Rev 6
71/1320
HAL System Driver
UM1785
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.
Return values
Device: identifier
HAL_GetUIDw0
Function name
uint32_t HAL_GetUIDw0 (void )
Function description
Returns first word of the unique device identifier (UID based on 96
bits)
Return values
Device: identifier
HAL_GetUIDw1
Function name
uint32_t HAL_GetUIDw1 (void )
Function description
Returns second word of the unique device identifier (UID based on
96 bits)
Return values
Device: identifier
HAL_GetUIDw2
Function name
uint32_t HAL_GetUIDw2 (void )
Function description
Returns third word of the unique device identifier (UID based on 96
bits)
Return values
Device: identifier
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
72/1320
None
DocID026525 Rev 6
UM1785
HAL System Driver
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
5.2
HAL Firmware driver defines
5.2.1
HAL
HAL Exported Macros
__HAL_SYSCFG_FASTMODEPLUS_ENABLE
Description:
Fast-mode Plus driving capability
enable/disable macros.
Parameters:
__FASTMODEPLUS__: This
parameter can be a value of
__HAL_SYSCFG_FASTMODEPLUS_DISABLE
HAL Freeze Unfreeze Peripherals
__HAL_FREEZE_CAN_DBGMCU
__HAL_UNFREEZE_CAN_DBGMCU
__HAL_DBGMCU_FREEZE_RTC
__HAL_DBGMCU_UNFREEZE_RTC
__HAL_DBGMCU_FREEZE_I2C1_TIMEOUT
__HAL_DBGMCU_UNFREEZE_I2C1_TIMEOUT
__HAL_DBGMCU_FREEZE_IWDG
__HAL_DBGMCU_UNFREEZE_IWDG
__HAL_DBGMCU_FREEZE_WWDG
__HAL_DBGMCU_UNFREEZE_WWDG
__HAL_DBGMCU_FREEZE_TIM2
__HAL_DBGMCU_UNFREEZE_TIM2
__HAL_DBGMCU_FREEZE_TIM3
__HAL_DBGMCU_UNFREEZE_TIM3
__HAL_DBGMCU_FREEZE_TIM6
__HAL_DBGMCU_UNFREEZE_TIM6
DocID026525 Rev 6
73/1320
HAL System Driver
__HAL_DBGMCU_FREEZE_TIM7
__HAL_DBGMCU_UNFREEZE_TIM7
__HAL_DBGMCU_FREEZE_TIM14
__HAL_DBGMCU_UNFREEZE_TIM14
__HAL_DBGMCU_FREEZE_TIM1
__HAL_DBGMCU_UNFREEZE_TIM1
__HAL_DBGMCU_FREEZE_TIM15
__HAL_DBGMCU_UNFREEZE_TIM15
__HAL_DBGMCU_FREEZE_TIM16
__HAL_DBGMCU_UNFREEZE_TIM16
__HAL_DBGMCU_FREEZE_TIM17
__HAL_DBGMCU_UNFREEZE_TIM17
HAL IRDA Enveloppe Selection
HAL_SYSCFG_IRDA_ENV_SEL_TIM16
HAL_SYSCFG_IRDA_ENV_SEL_USART1
HAL_SYSCFG_IRDA_ENV_SEL_USART4
HAL ISR Wrapper
74/1320
HAL_SYSCFG_ITLINE0
Internal define for macro handling
HAL_SYSCFG_ITLINE1
Internal define for macro handling
HAL_SYSCFG_ITLINE2
Internal define for macro handling
HAL_SYSCFG_ITLINE3
Internal define for macro handling
HAL_SYSCFG_ITLINE4
Internal define for macro handling
HAL_SYSCFG_ITLINE5
Internal define for macro handling
HAL_SYSCFG_ITLINE6
Internal define for macro handling
HAL_SYSCFG_ITLINE7
Internal define for macro handling
HAL_SYSCFG_ITLINE8
Internal define for macro handling
HAL_SYSCFG_ITLINE9
Internal define for macro handling
HAL_SYSCFG_ITLINE10
Internal define for macro handling
HAL_SYSCFG_ITLINE11
Internal define for macro handling
HAL_SYSCFG_ITLINE12
Internal define for macro handling
HAL_SYSCFG_ITLINE13
Internal define for macro handling
HAL_SYSCFG_ITLINE14
Internal define for macro handling
HAL_SYSCFG_ITLINE15
Internal define for macro handling
HAL_SYSCFG_ITLINE16
Internal define for macro handling
HAL_SYSCFG_ITLINE17
Internal define for macro handling
HAL_SYSCFG_ITLINE18
Internal define for macro handling
DocID026525 Rev 6
UM1785
UM1785
HAL System Driver
HAL_SYSCFG_ITLINE19
Internal define for macro handling
HAL_SYSCFG_ITLINE20
Internal define for macro handling
HAL_SYSCFG_ITLINE21
Internal define for macro handling
HAL_SYSCFG_ITLINE22
Internal define for macro handling
HAL_SYSCFG_ITLINE23
Internal define for macro handling
HAL_SYSCFG_ITLINE24
Internal define for macro handling
HAL_SYSCFG_ITLINE25
Internal define for macro handling
HAL_SYSCFG_ITLINE26
Internal define for macro handling
HAL_SYSCFG_ITLINE27
Internal define for macro handling
HAL_SYSCFG_ITLINE28
Internal define for macro handling
HAL_SYSCFG_ITLINE29
Internal define for macro handling
HAL_SYSCFG_ITLINE30
Internal define for macro handling
HAL_SYSCFG_ITLINE31
Internal define for macro handling
HAL_ITLINE_EWDG
EWDG has expired ....
HAL_ITLINE_PVDOUT
Power voltage detection Interrupt ....
HAL_ITLINE_VDDIO2
VDDIO2 Interrupt ....
HAL_ITLINE_RTC_WAKEUP
RTC WAKEUP -> exti[20] Interrupt
HAL_ITLINE_RTC_TSTAMP
RTC Time Stamp -> exti[19] interrupt
HAL_ITLINE_RTC_ALRA
RTC Alarm -> exti[17] interrupt ....
HAL_ITLINE_FLASH_ITF
Flash ITF Interrupt
HAL_ITLINE_CRS
CRS Interrupt
HAL_ITLINE_CLK_CTRL
CLK Control Interrupt
HAL_ITLINE_EXTI0
External Interrupt 0
HAL_ITLINE_EXTI1
External Interrupt 1
HAL_ITLINE_EXTI2
External Interrupt 2
HAL_ITLINE_EXTI3
External Interrupt 3
HAL_ITLINE_EXTI4
EXTI4 Interrupt
HAL_ITLINE_EXTI5
EXTI5 Interrupt
HAL_ITLINE_EXTI6
EXTI6 Interrupt
HAL_ITLINE_EXTI7
EXTI7 Interrupt
HAL_ITLINE_EXTI8
EXTI8 Interrupt
HAL_ITLINE_EXTI9
EXTI9 Interrupt
HAL_ITLINE_EXTI10
EXTI10 Interrupt
HAL_ITLINE_EXTI11
EXTI11 Interrupt
HAL_ITLINE_EXTI12
EXTI12 Interrupt
HAL_ITLINE_EXTI13
EXTI13 Interrupt
DocID026525 Rev 6
75/1320
HAL System Driver
HAL_ITLINE_EXTI14
EXTI14 Interrupt
HAL_ITLINE_EXTI15
EXTI15 Interrupt
HAL_ITLINE_TSC_EOA
Touch control EOA Interrupt
HAL_ITLINE_TSC_MCE
Touch control MCE Interrupt
HAL_ITLINE_DMA1_CH1
DMA1 Channel 1 Interrupt
HAL_ITLINE_DMA1_CH2
DMA1 Channel 2 Interrupt
HAL_ITLINE_DMA1_CH3
DMA1 Channel 3 Interrupt
HAL_ITLINE_DMA2_CH1
DMA2 Channel 1 Interrupt
HAL_ITLINE_DMA2_CH2
DMA2 Channel 2 Interrupt
HAL_ITLINE_DMA1_CH4
DMA1 Channel 4 Interrupt
HAL_ITLINE_DMA1_CH5
DMA1 Channel 5 Interrupt
HAL_ITLINE_DMA1_CH6
DMA1 Channel 6 Interrupt
HAL_ITLINE_DMA1_CH7
DMA1 Channel 7 Interrupt
HAL_ITLINE_DMA2_CH3
DMA2 Channel 3 Interrupt
HAL_ITLINE_DMA2_CH4
DMA2 Channel 4 Interrupt
HAL_ITLINE_DMA2_CH5
DMA2 Channel 5 Interrupt
HAL_ITLINE_ADC
ADC Interrupt
HAL_ITLINE_COMP1
COMP1 Interrupt -> exti[21]
HAL_ITLINE_COMP2
COMP2 Interrupt -> exti[21]
HAL_ITLINE_TIM1_BRK
TIM1 BRK Interrupt
HAL_ITLINE_TIM1_UPD
TIM1 UPD Interrupt
HAL_ITLINE_TIM1_TRG
TIM1 TRG Interrupt
HAL_ITLINE_TIM1_CCU
TIM1 CCU Interrupt
HAL_ITLINE_TIM1_CC
TIM1 CC Interrupt
HAL_ITLINE_TIM2
TIM2 Interrupt
HAL_ITLINE_TIM3
TIM3 Interrupt
HAL_ITLINE_DAC
DAC Interrupt
HAL_ITLINE_TIM6
TIM6 Interrupt
HAL_ITLINE_TIM7
TIM7 Interrupt
HAL_ITLINE_TIM14
TIM14 Interrupt
HAL_ITLINE_TIM15
TIM15 Interrupt
HAL_ITLINE_TIM16
TIM16 Interrupt
HAL_ITLINE_TIM17
TIM17 Interrupt
HAL_ITLINE_I2C1
I2C1 Interrupt -> exti[23]
HAL_ITLINE_I2C2
I2C2 Interrupt
HAL_ITLINE_SPI1
I2C1 Interrupt -> exti[23]
76/1320
UM1785
DocID026525 Rev 6
UM1785
HAL System Driver
HAL_ITLINE_SPI2
SPI1 Interrupt
HAL_ITLINE_USART1
USART1 GLB Interrupt -> exti[25]
HAL_ITLINE_USART2
USART2 GLB Interrupt -> exti[26]
HAL_ITLINE_USART3
USART3 Interrupt ....
HAL_ITLINE_USART4
USART4 Interrupt ....
HAL_ITLINE_USART5
USART5 Interrupt ....
HAL_ITLINE_USART6
USART6 Interrupt ....
HAL_ITLINE_USART7
USART7 Interrupt ....
HAL_ITLINE_USART8
USART8 Interrupt ....
HAL_ITLINE_CAN
CAN Interrupt
HAL_ITLINE_CEC
CEC Interrupt -> exti[27]
HAL ISR wrapper check
__HAL_GET_PENDING_IT
HAL state definition
HAL_SMBUS_STATE_RESET
SMBUS not yet initialized or disabled
HAL_SMBUS_STATE_READY
SMBUS initialized and ready for use
HAL_SMBUS_STATE_BUSY
SMBUS internal process is ongoing
HAL_SMBUS_STATE_MASTER_BUSY_TX
Master Data Transmission process is
ongoing
HAL_SMBUS_STATE_MASTER_BUSY_RX
Master Data Reception process is ongoing
HAL_SMBUS_STATE_SLAVE_BUSY_TX
Slave Data Transmission process is
ongoing
HAL_SMBUS_STATE_SLAVE_BUSY_RX
Slave Data Reception process is ongoing
HAL_SMBUS_STATE_TIMEOUT
Timeout state
HAL_SMBUS_STATE_ERROR
Reception process is ongoing
HAL_SMBUS_STATE_LISTEN
Address Listen Mode is ongoing
HAL SYSCFG IRDA modulation envelope selection
__HAL_SYSCFG_IRDA_ENV_SELECTION
__HAL_SYSCFG_GET_IRDA_ENV_SELECTION
HAL SYSCFG Parity check on RAM
__HAL_SYSCFG_RAM_PARITYCHECK_DISABLE
DocID026525 Rev 6
77/1320
HAL System Driver
Fast-mode Plus on GPIO
78/1320
UM1785
SYSCFG_FASTMODEPLUS_PA9
Enable Fast-mode Plus on PA9
SYSCFG_FASTMODEPLUS_PA10
Enable Fast-mode Plus on PA10
SYSCFG_FASTMODEPLUS_PB6
Enable Fast-mode Plus on PB6
SYSCFG_FASTMODEPLUS_PB7
Enable Fast-mode Plus on PB7
SYSCFG_FASTMODEPLUS_PB8
Enable Fast-mode Plus on PB8
SYSCFG_FASTMODEPLUS_PB9
Enable Fast-mode Plus on PB9
DocID026525 Rev 6
UM1785
HAL ADC Generic Driver
6
HAL ADC Generic Driver
6.1
ADC Firmware driver registers structures
6.1.1
ADC_InitTypeDef
Data Fields
uint32_t ClockPrescaler
uint32_t Resolution
uint32_t DataAlign
uint32_t ScanConvMode
uint32_t EOCSelection
uint32_t LowPowerAutoWait
uint32_t LowPowerAutoPowerOff
uint32_t ContinuousConvMode
uint32_t DiscontinuousConvMode
uint32_t ExternalTrigConv
uint32_t ExternalTrigConvEdge
uint32_t DMAContinuousRequests
uint32_t Overrun
uint32_t SamplingTimeCommon
Field Documentation
uint32_t ADC_InitTypeDef::ClockPrescaler
Select ADC clock source (synchronous clock derived from APB clock or asynchronous
clock derived from ADC dedicated HSI RC oscillator 14MHz) and clock prescaler. This
parameter can be a value of ADC_ClockPrescaler Note: In case of usage of the ADC
dedicated HSI RC oscillator, it must be preliminarily enabled at RCC top level. Note:
This parameter can be modified only if the ADC is disabled
uint32_t ADC_InitTypeDef::Resolution
Configures the ADC resolution. This parameter can be a value of ADC_Resolution
uint32_t ADC_InitTypeDef::DataAlign
Specifies whether the ADC data alignment is left or right. This parameter can be a
value of ADC_Data_align
uint32_t ADC_InitTypeDef::ScanConvMode
Configures the sequencer of regular group. This parameter can be associated to
parameter 'DiscontinuousConvMode' to have main sequence subdivided in successive
parts. Sequencer is automatically enabled if several channels are set (sequencer
cannot be disabled, as it can be the case on other STM32 devices): If only 1 channel
is set: Conversion is performed in single mode. If several channels are set:
Conversions are performed in sequence mode (ranks defined by each channel
number: channel 0 fixed on rank 0, channel 1 fixed on rank1, ...). Scan direction can
be set to forward (from channel 0 to channel 18) or backward (from channel 18 to
channel 0). This parameter can be a value of ADC_Scan_mode
uint32_t ADC_InitTypeDef::EOCSelection
Specifies what EOC (End Of Conversion) flag is used for conversion by polling and
interruption: end of conversion of each rank or complete sequence. This parameter
can be a value of ADC_EOCSelection.
uint32_t ADC_InitTypeDef::LowPowerAutoWait
Selects the dynamic low power Auto Delay: new conversion start only when the
previous conversion (for regular group) has been treated by user software, using
DocID026525 Rev 6
79/1320
HAL ADC Generic Driver
UM1785
function HAL_ADC_GetValue(). This feature automatically adapts the ADC
conversions trigs to the speed of the system that reads the data. Moreover, this avoids
risk of overrun for low frequency applications. This parameter can be set to ENABLE
or DISABLE. Note: Do not use with interruption or DMA (HAL_ADC_Start_IT(),
HAL_ADC_Start_DMA()) since they have to clear immediately the EOC flag to free
the IRQ vector sequencer. Do use with polling: 1. Start conversion with
HAL_ADC_Start(), 2. Later on, when conversion data is needed: use
HAL_ADC_PollForConversion() to ensure that conversion is completed and use
HAL_ADC_GetValue() to retrieve conversion result and trig another conversion.
uint32_t ADC_InitTypeDef::LowPowerAutoPowerOff
Selects the auto-off mode: the ADC automatically powers-off after a conversion and
automatically wakes-up when a new conversion is triggered (with startup time
between trigger and start of sampling). This feature can be combined with automatic
wait mode (parameter 'LowPowerAutoWait'). This parameter can be set to ENABLE or
DISABLE. Note: If enabled, this feature also turns off the ADC dedicated 14 MHz RC
oscillator (HSI14)
uint32_t ADC_InitTypeDef::ContinuousConvMode
Specifies whether the conversion is performed in single mode (one conversion) or
continuous mode for regular group, after the selected trigger occurred (software start
or external trigger). This parameter can be set to ENABLE or DISABLE.
uint32_t ADC_InitTypeDef::DiscontinuousConvMode
Specifies whether the conversions sequence of regular group is performed in
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: Number of discontinuous ranks increment is fixed to oneby-one.
uint32_t ADC_InitTypeDef::ExternalTrigConv
Selects the external event used to trigger the conversion start of regular group. If set
to ADC_SOFTWARE_START, external triggers are disabled. This parameter can be a
value of ADC_External_trigger_source_Regular
uint32_t ADC_InitTypeDef::ExternalTrigConvEdge
Selects the external trigger edge of regular group. If trigger is set to
ADC_SOFTWARE_START, this parameter is discarded. This parameter can be a
value of ADC_External_trigger_edge_Regular
uint32_t ADC_InitTypeDef::DMAContinuousRequests
Specifies whether the DMA requests are performed in one shot mode (DMA transfer
stop when number of conversions is reached) or in Continuous mode (DMA transfer
unlimited, whatever number of conversions). Note: In continuous mode, DMA must be
configured in circular mode. Otherwise an overrun will be triggered when DMA buffer
maximum pointer is reached. This parameter can be set to ENABLE or DISABLE.
uint32_t ADC_InitTypeDef::Overrun
Select the behaviour in case of overrun: data preserved or overwritten This parameter
has an effect on regular group only, including in DMA mode. This parameter can be a
value of ADC_Overrun
uint32_t ADC_InitTypeDef::SamplingTimeCommon
Sampling time value to be set for the selected channel. Unit: ADC clock cycles
Conversion time is the addition of sampling time and processing time (12.5 ADC clock
cycles at ADC resolution 12 bits, 10.5 cycles at 10 bits, 8.5 cycles at 8 bits, 6.5 cycles
at 6 bits). Note: On STM32F0 devices, the sampling time setting is common to all
channels. On some other STM32 devices, this parameter in channel wise and is
located into ADC channel initialization structure. This parameter can be a value of
ADC_sampling_times Note: In case of usage of internal measurement channels
80/1320
DocID026525 Rev 6
UM1785
6.1.2
HAL ADC Generic Driver
(VrefInt/Vbat/TempSensor), sampling time constraints must be respected (sampling
time can be adjusted in function of ADC clock frequency and sampling time setting)
Refer to device datasheet for timings values, parameters TS_vrefint, TS_vbat,
TS_temp (values rough order: 5us to 17us).
ADC_ChannelConfTypeDef
Data Fields
uint32_t Channel
uint32_t Rank
uint32_t SamplingTime
Field Documentation
uint32_t ADC_ChannelConfTypeDef::Channel
Specifies the channel to configure into ADC regular group. This parameter can be a
value of ADC_channels Note: Depending on devices, some channels may not be
available on package pins. Refer to device datasheet for channels availability.
uint32_t ADC_ChannelConfTypeDef::Rank
Add or remove the channel from ADC regular group sequencer. On STM32F0
devices, number of ranks in the sequence is defined by number of channels enabled,
rank of each channel is defined by channel number (channel 0 fixed on rank 0,
channel 1 fixed on rank1, ...).. Despite the channel rank is fixed, this parameter allow
an additional possibility: to remove the selected rank (selected channel) from
sequencer. This parameter can be a value of ADC_rank
uint32_t ADC_ChannelConfTypeDef::SamplingTime
Sampling time value to be set for the selected channel. Unit: ADC clock cycles
Conversion time is the addition of sampling time and processing time (12.5 ADC clock
cycles at ADC resolution 12 bits, 10.5 cycles at 10 bits, 8.5 cycles at 8 bits, 6.5 cycles
at 6 bits). This parameter can be a value of ADC_sampling_times Caution: this
setting impacts the entire regular group. Therefore, call of
HAL_ADC_ConfigChannel() to configure a channel can impact the configuration of
other channels previously set. Caution: Obsolete parameter. Use parameter
"SamplingTimeCommon" in ADC initialization structure. If parameter
"SamplingTimeCommon" is set to a valid sampling time, parameter "SamplingTime" is
discarded. Note: In case of usage of internal measurement channels
(VrefInt/Vbat/TempSensor), sampling time constraints must be respected (sampling
time can be adjusted in function of ADC clock frequency and sampling time setting)
Refer to device datasheet for timings values, parameters TS_vrefint, TS_vbat,
TS_temp (values rough order: 5us to 17us).
6.1.3
ADC_AnalogWDGConfTypeDef
Data Fields
uint32_t WatchdogMode
uint32_t Channel
uint32_t ITMode
uint32_t HighThreshold
uint32_t LowThreshold
Field Documentation
uint32_t ADC_AnalogWDGConfTypeDef::WatchdogMode
Configures the ADC analog watchdog mode: single/all/none channels. This parameter
can be a value of ADC_analog_watchdog_mode.
DocID026525 Rev 6
81/1320
HAL ADC Generic Driver
UM1785
uint32_t ADC_AnalogWDGConfTypeDef::Channel
Selects which ADC channel to monitor by analog watchdog. This parameter has an
effect only if parameter 'WatchdogMode' is configured on single channel. Only 1
channel can be monitored. This parameter can be a value of ADC_channels.
uint32_t ADC_AnalogWDGConfTypeDef::ITMode
Specifies whether the analog watchdog is configured in interrupt or polling mode. This
parameter can be set to ENABLE or DISABLE
uint32_t ADC_AnalogWDGConfTypeDef::HighThreshold
Configures the ADC analog watchdog High threshold value. Depending of ADC
resolution selected (12, 10, 8 or 6 bits), this parameter must be a number between
Min_Data = 0x000 and Max_Data = 0xFFF, 0x3FF, 0xFF or 0x3F respectively.
uint32_t ADC_AnalogWDGConfTypeDef::LowThreshold
Configures the ADC analog watchdog High threshold value. Depending of ADC
resolution selected (12, 10, 8 or 6 bits), this parameter must be a number between
Min_Data = 0x000 and Max_Data = 0xFFF, 0x3FF, 0xFF or 0x3F respectively.
6.1.4
ADC_HandleTypeDef
Data Fields
ADC_TypeDef * Instance
ADC_InitTypeDef Init
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
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 (bitmap of ADC states)
__IO uint32_t ADC_HandleTypeDef::ErrorCode
ADC Error code
6.2
ADC Firmware driver API description
6.2.1
ADC peripheral features
12-bit, 10-bit, 8-bit or 6-bit configurable resolution
Interrupt generation at the end of regular conversion and in case of analog watchdog
or overrun events.
Single and continuous conversion modes.
Scan mode for conversion of several channels sequentially.
Data alignment with in-built data coherency.
Programmable sampling time (common for all channels)
ADC conversion of regular group.
External trigger (timer or EXTI) with configurable polarity
DMA request generation for transfer of conversions data of regular group.
82/1320
DocID026525 Rev 6
UM1785
HAL ADC Generic Driver
ADC calibration
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: from Vref- (connected to Vssa) to Vref+ (connected to Vdda or to an
external voltage reference).
6.2.2
How to use this driver
Configuration of top level parameters related to ADC
1.
2.
3.
4.
Enable the ADC interface
As prerequisite, ADC clock must be configured at RCC top level. Caution: On
STM32F0, ADC clock frequency max is 14MHz (refer to device datasheet).
Therefore, ADC clock prescaler must be configured in function of ADC clock
source frequency to remain below this maximum frequency.
Two clock settings are mandatory:
ADC clock (core clock, also possibly conversion clock).
ADC clock (conversions clock). Two possible clock sources: synchronous
clock derived from APB clock or asynchronous clock derived from ADC
dedicated HSI RC oscillator 14MHz. If asynchronous clock is selected,
parameter "HSI14State" must be set either: - to "...HSI14State =
RCC_HSI14_ADC_CONTROL" to let the ADC control the HSI14 oscillator
enable/disable (if not used to supply the main system clock): feature used if
ADC mode LowPowerAutoPowerOff is enabled. - to "...HSI14State =
RCC_HSI14_ON" to maintain the HSI14 oscillator always enabled: can be
used to supply the main system clock.
Example: Into HAL_ADC_MspInit() (recommended code location) or with
other device clock parameters configuration:
__HAL_RCC_ADC1_CLK_ENABLE(); (mandatory) HI14 enable or let under
control of ADC: (optional: if asynchronous clock selected)
RCC_OscInitTypeDef RCC_OscInitStructure;
RCC_OscInitStructure.OscillatorType = RCC_OSCILLATORTYPE_HSI14;
RCC_OscInitStructure.HSI14CalibrationValue =
RCC_HSI14CALIBRATION_DEFAULT;
RCC_OscInitStructure.HSI14State = RCC_HSI14_ADC_CONTROL;
RCC_OscInitStructure.PLL... (optional if used for system clock)
HAL_RCC_OscConfig(&RCC_OscInitStructure);
ADC clock source and clock prescaler are configured at ADC level with
parameter "ClockPrescaler" using function HAL_ADC_Init().
ADC pins configuration
Enable the clock for the ADC GPIOs using macro
__HAL_RCC_GPIOx_CLK_ENABLE()
Configure these ADC pins in analog mode using function HAL_GPIO_Init()
Optionally, in case of usage of ADC with interruptions:
Configure the NVIC for ADC using function HAL_NVIC_EnableIRQ(ADCx_IRQn)
Insert the ADC interruption handler function HAL_ADC_IRQHandler() into the
function of corresponding ADC interruption vector ADCx_IRQHandler().
Optionally, in case of usage of DMA:
Configure the DMA (DMA channel, mode normal or circular, ...) using function
HAL_DMA_Init().
Configure the NVIC for DMA using function
HAL_NVIC_EnableIRQ(DMAx_Channelx_IRQn)
DocID026525 Rev 6
83/1320
HAL ADC Generic Driver
UM1785
Insert the ADC interruption handler function HAL_ADC_IRQHandler() into the
function of corresponding DMA interruption vector
DMAx_Channelx_IRQHandler().
Configuration of ADC, group regular, channels parameters
1.
2.
3.
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 analog watchdog parameters (channels monitored,
thresholds, ...) using function HAL_ADC_AnalogWDGConfig().
Execution of ADC conversions
1.
2.
Optionally, perform an automatic ADC calibration to improve the conversion accuracy
using function HAL_ADCEx_Calibration_Start().
ADC driver can be used among three modes: polling, interruption, transfer by DMA.
ADC conversion by polling:
Activate the ADC peripheral and start conversions using function
HAL_ADC_Start()
Wait for ADC conversion completion using function
HAL_ADC_PollForConversion()
Retrieve conversion results using function HAL_ADC_GetValue()
Stop conversion and disable the ADC peripheral using function
HAL_ADC_Stop()
ADC conversion by interruption:
Activate the ADC peripheral and start conversions using function
HAL_ADC_Start_IT()
Wait for ADC conversion completion by call of function
HAL_ADC_ConvCpltCallback() (this function must be implemented in user
program)
Retrieve conversion results using function HAL_ADC_GetValue()
Stop conversion and disable the ADC peripheral using function
HAL_ADC_Stop_IT()
ADC conversion with transfer by DMA:
Activate the ADC peripheral and start conversions using function
HAL_ADC_Start_DMA()
Wait for ADC conversion completion by call of function
HAL_ADC_ConvCpltCallback() or HAL_ADC_ConvHalfCpltCallback() (these
functions must be implemented in user program)
Conversion results are automatically transferred by DMA into destination
variable address.
Stop conversion and disable the ADC peripheral using function
HAL_ADC_Stop_DMA()
Callback functions must be implemented in user program:
HAL_ADC_ErrorCallback()
HAL_ADC_LevelOutOfWindowCallback() (callback of analog watchdog)
HAL_ADC_ConvCpltCallback()
HAL_ADC_ConvHalfCpltCallback
84/1320
DocID026525 Rev 6
UM1785
HAL ADC Generic Driver
Deinitialization of ADC
1.
2.
3.
4.
6.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 __ADCx_FORCE_RESET(),
__ADCx_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:
RCC_OscInitStructure.OscillatorType = RCC_OSCILLATORTYPE_HSI14;
RCC_OscInitStructure.HSI14State = RCC_HSI14_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_EnableIRQ(ADCx_IRQn)
Optionally, in case of usage of DMA:
Deinitialize the DMA using function HAL_DMA_Init().
Disable the NVIC for DMA using function
HAL_NVIC_EnableIRQ(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:
HAL_ADC_Init()
HAL_ADC_DeInit()
HAL_ADC_MspInit()
HAL_ADC_MspDeInit()
6.2.4
IO operation functions
This section provides functions allowing to:
Start conversion of regular group.
Stop conversion of regular group.
Poll for conversion complete on regular group.
Poll for conversion event.
Get result of regular channel conversion.
Start conversion of regular group and enable interruptions.
Stop conversion of regular group and disable interruptions.
Handle ADC interrupt request
Start conversion of regular group and enable DMA transfer.
Stop conversion of regular group and disable ADC DMA transfer.
This section contains the following APIs:
HAL_ADC_Start()
HAL_ADC_Stop()
DocID026525 Rev 6
85/1320
HAL ADC Generic Driver
UM1785
HAL_ADC_PollForConversion()
HAL_ADC_PollForEvent()
HAL_ADC_Start_IT()
HAL_ADC_Stop_IT()
HAL_ADC_Start_DMA()
HAL_ADC_Stop_DMA()
HAL_ADC_GetValue()
HAL_ADC_IRQHandler()
HAL_ADC_ConvCpltCallback()
HAL_ADC_ConvHalfCpltCallback()
HAL_ADC_LevelOutOfWindowCallback()
HAL_ADC_ErrorCallback()
6.2.5
Peripheral Control functions
This section provides functions allowing to:
Configure channels on regular group
Configure the analog watchdog
This section contains the following APIs:
HAL_ADC_ConfigChannel()
HAL_ADC_AnalogWDGConfig()
6.2.6
Peripheral State and Errors functions
This subsection provides functions to get in run-time the status of the peripheral.
Check the ADC state
Check the ADC error code
This section contains the following APIs:
HAL_ADC_GetState()
HAL_ADC_GetError()
6.2.7
Detailed description of functions
HAL_ADC_Init
86/1320
Function name
HAL_StatusTypeDef HAL_ADC_Init (ADC_HandleTypeDef *
hadc)
Function description
Initializes the ADC peripheral and regular group according to
parameters specified in structure "ADC_InitTypeDef".
Parameters
hadc: ADC handle
Return values
HAL: status
Notes
As prerequisite, ADC clock must be configured at RCC top
level depending on both possible clock sources: APB clock of
HSI clock. See commented example code below that can be
copied and uncommented into HAL_ADC_MspInit().
Possibility to update parameters on the flythis function
initializes the ADC MSP (HAL_ADC_MspInit()) only when
coming from ADC state reset. Following calls to this function
can be used to reconfigure some parameters of
ADC_InitTypeDef structure on the fly, without modifying MSP
DocID026525 Rev 6
UM1785
HAL ADC Generic Driver
configuration. If ADC MSP has to be modified again,
HAL_ADC_DeInit() must be called before HAL_ADC_Init().
The setting of these parameters is conditioned to ADC state.
For parameters constraints, see comments of structure
"ADC_InitTypeDef".
This function configures the ADC within 2 scopes: scope of
entire ADC and scope of regular group. For parameters
details, see comments of structure "ADC_InitTypeDef".
HAL_ADC_DeInit
Function name
HAL_StatusTypeDef HAL_ADC_DeInit (ADC_HandleTypeDef *
hadc)
Function description
Deinitialize the ADC peripheral registers to their default reset
values, with deinitialization of the ADC MSP.
Parameters
hadc: ADC handle
Return values
HAL: status
Notes
For devices with several ADCs: reset of ADC common
registers is done only if all ADCs sharing the same common
group are disabled. If this is not the case, reset of these
common parameters reset is bypassed without error
reporting: it can be the intended behaviour in case of reset of
a single ADC while the other ADCs sharing the same
common group is still running.
HAL_ADC_MspInit
Function name
void HAL_ADC_MspInit (ADC_HandleTypeDef * hadc)
Function description
Initializes the ADC MSP.
Parameters
hadc: ADC handle
Return values
None
HAL_ADC_MspDeInit
Function name
void HAL_ADC_MspDeInit (ADC_HandleTypeDef * hadc)
Function description
DeInitializes the ADC MSP.
Parameters
hadc: ADC handle
Return values
None
HAL_ADC_Start
Function name
HAL_StatusTypeDef HAL_ADC_Start (ADC_HandleTypeDef *
hadc)
Function description
Enables ADC, starts conversion of regular group.
Parameters
hadc: ADC handle
Return values
HAL: status
DocID026525 Rev 6
87/1320
HAL ADC Generic Driver
UM1785
HAL_ADC_Stop
Function name
HAL_StatusTypeDef HAL_ADC_Stop (ADC_HandleTypeDef *
hadc)
Function description
Stop ADC conversion of regular group, disable ADC peripheral.
Parameters
hadc: ADC handle
Return values
HAL: status.
HAL_ADC_PollForConversion
Function name
HAL_StatusTypeDef HAL_ADC_PollForConversion
(ADC_HandleTypeDef * hadc, uint32_t Timeout)
Function description
Wait for regular group conversion to be completed.
Parameters
hadc: ADC handle
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, with an exception:
if low power feature "LowPowerAutoWait" is enabled, flags
are not cleared to not interfere with this feature until data
register is read using function HAL_ADC_GetValue().
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 (ADC init parameter "EOCSelection"
set to ADC_EOC_SEQ_CONV).
HAL_ADC_PollForEvent
88/1320
Function name
HAL_StatusTypeDef HAL_ADC_PollForEvent
(ADC_HandleTypeDef * hadc, uint32_t EventType, uint32_t
Timeout)
Function description
Poll for conversion event.
Parameters
hadc: ADC handle
EventType: the ADC event type. This parameter can be one
of the following values:
ADC_AWD_EVENT: ADC Analog watchdog event
ADC_OVR_EVENT: ADC Overrun event
Timeout: Timeout value in millisecond.
Return values
HAL: status
DocID026525 Rev 6
UM1785
HAL ADC Generic Driver
HAL_ADC_Start_IT
Function name
HAL_StatusTypeDef HAL_ADC_Start_IT (ADC_HandleTypeDef
* hadc)
Function description
Enables ADC, starts conversion of regular group with interruption.
HAL_ADC_Stop_IT
Function name
HAL_StatusTypeDef HAL_ADC_Stop_IT (ADC_HandleTypeDef
* hadc)
Function description
Stop ADC conversion of regular group, disable interruption of endof-conversion, disable ADC peripheral.
Parameters
hadc: ADC handle
Return values
HAL: status.
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, starts conversion of regular group and transfers
result through DMA.
HAL_ADC_Stop_DMA
Function name
HAL_StatusTypeDef HAL_ADC_Stop_DMA
(ADC_HandleTypeDef * hadc)
Function description
Stop ADC conversion of regular group, disable ADC DMA transfer,
disable ADC peripheral.
Parameters
hadc: ADC handle
Return values
HAL: status.
HAL_ADC_GetValue
Function name
uint32_t HAL_ADC_GetValue (ADC_HandleTypeDef * hadc)
Function description
Get ADC regular group conversion result.
Parameters
hadc: ADC handle
Return values
ADC: group regular conversion data
Notes
Reading register DR automatically clears ADC flag EOC
(ADC group regular end of unitary conversion).
This function does not clear ADC flag EOS (ADC group
regular end of sequence conversion). Occurrence of flag EOS
rising: If sequencer is composed of 1 rank, flag EOS is
equivalent to flag EOC.If sequencer is composed of several
ranks, during the scan sequence flag EOC only is raised, at
the end of the scan sequence both flags EOC and EOS are
raised. To clear this flag, either use function: in programming
model IT: HAL_ADC_IRQHandler(), in programming model
DocID026525 Rev 6
89/1320
HAL ADC Generic Driver
UM1785
polling: HAL_ADC_PollForConversion() or
__HAL_ADC_CLEAR_FLAG(&hadc, ADC_FLAG_EOS).
HAL_ADC_IRQHandler
Function name
void HAL_ADC_IRQHandler (ADC_HandleTypeDef * hadc)
Function description
Handles ADC interrupt request.
Parameters
hadc: ADC handle
Return values
None
HAL_ADC_ConvCpltCallback
Function name
void HAL_ADC_ConvCpltCallback (ADC_HandleTypeDef *
hadc)
Function description
Conversion complete callback in non blocking mode.
Parameters
hadc: ADC handle
Return values
None
HAL_ADC_ConvHalfCpltCallback
Function name
void HAL_ADC_ConvHalfCpltCallback (ADC_HandleTypeDef *
hadc)
Function description
Conversion DMA half-transfer callback in non blocking mode.
Parameters
hadc: ADC handle
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: ADC handle
Return values
None
HAL_ADC_ErrorCallback
90/1320
Function name
void HAL_ADC_ErrorCallback (ADC_HandleTypeDef * hadc)
Function description
ADC error callback in non blocking mode (ADC conversion with
interruption or transfer by DMA)
Parameters
hadc: ADC handle
Return values
None
DocID026525 Rev 6
UM1785
HAL ADC Generic Driver
HAL_ADC_ConfigChannel
Function name
HAL_StatusTypeDef HAL_ADC_ConfigChannel
(ADC_HandleTypeDef * hadc, ADC_ChannelConfTypeDef *
sConfig)
Function description
Configures the the selected channel to be linked to the regular
group.
Parameters
hadc: ADC handle
sConfig: Structure of ADC channel for regular group.
Return values
HAL: status
Notes
In case of usage of internal measurement channels:
VrefInt/Vbat/TempSensor. Sampling time constraints must be
respected (sampling time can be adjusted in function of ADC
clock frequency and sampling time setting). Refer to device
datasheet for timings values, parameters TS_vrefint, TS_vbat,
TS_temp (values rough order: 5us to 17us). These internal
paths can be be disabled using function HAL_ADC_DeInit().
Possibility to update parameters on the flythis function
initializes channel into regular group, following calls to this
function can be used to reconfigure some parameters of
structure "ADC_ChannelConfTypeDef" on the fly, without
reseting the ADC. The setting of these parameters is
conditioned to ADC state. For parameters constraints, see
comments of structure "ADC_ChannelConfTypeDef".
HAL_ADC_AnalogWDGConfig
Function name
HAL_StatusTypeDef HAL_ADC_AnalogWDGConfig
(ADC_HandleTypeDef * hadc, ADC_AnalogWDGConfTypeDef *
AnalogWDGConfig)
Function description
Configures the analog watchdog.
Parameters
hadc: ADC handle
AnalogWDGConfig: Structure of ADC analog watchdog
configuration
Return values
HAL: status
Notes
Possibility to update parameters on the flythis function
initializes the selected analog watchdog, following calls to this
function can be used to reconfigure some parameters of
structure "ADC_AnalogWDGConfTypeDef" on the fly, without
reseting the ADC. The setting of these parameters is
conditioned to ADC state. For parameters constraints, see
comments of structure "ADC_AnalogWDGConfTypeDef".
HAL_ADC_GetState
Function name
uint32_t HAL_ADC_GetState (ADC_HandleTypeDef * hadc)
Function description
Return the ADC state.
Parameters
hadc: ADC handle
Return values
HAL: state
DocID026525 Rev 6
91/1320
HAL ADC Generic Driver
Notes
UM1785
ADC state machine is managed by bitfields, ADC status must
be compared with states bits. For example: " if
(HAL_IS_BIT_SET(HAL_ADC_GetState(hadc1),
HAL_ADC_STATE_REG_BUSY)) " " if
(HAL_IS_BIT_SET(HAL_ADC_GetState(hadc1),
HAL_ADC_STATE_AWD1) ) "
HAL_ADC_GetError
Function name
uint32_t HAL_ADC_GetError (ADC_HandleTypeDef * hadc)
Function description
Return the ADC error code.
Parameters
hadc: ADC handle
Return values
ADC: Error Code
6.3
ADC Firmware driver defines
6.3.1
ADC
ADC analog watchdog mode
ADC_ANALOGWATCHDOG_NONE
ADC_ANALOGWATCHDOG_SINGLE_REG
ADC_ANALOGWATCHDOG_ALL_REG
ADC channels
ADC_CHANNEL_0
ADC_CHANNEL_1
ADC_CHANNEL_2
ADC_CHANNEL_3
ADC_CHANNEL_4
ADC_CHANNEL_5
ADC_CHANNEL_6
ADC_CHANNEL_7
ADC_CHANNEL_8
ADC_CHANNEL_9
ADC_CHANNEL_10
ADC_CHANNEL_11
ADC_CHANNEL_12
ADC_CHANNEL_13
ADC_CHANNEL_14
ADC_CHANNEL_15
ADC_CHANNEL_16
ADC_CHANNEL_17
92/1320
DocID026525 Rev 6
UM1785
HAL ADC Generic Driver
ADC_CHANNEL_TEMPSENSOR
ADC_CHANNEL_VREFINT
ADC_CHANNEL_18
ADC_CHANNEL_VBAT
ADC ClockPrescaler
ADC_CLOCK_ASYNC_DIV1
ADC asynchronous clock derived from ADC
dedicated HSI
ADC_CLOCK_SYNC_PCLK_DIV2
ADC synchronous clock derived from AHB clock
divided by a prescaler of 2
ADC_CLOCK_SYNC_PCLK_DIV4
ADC synchronous clock derived from AHB clock
divided by a prescaler of 4
ADC Data_align
ADC_DATAALIGN_RIGHT
ADC_DATAALIGN_LEFT
ADC EOCSelection
ADC_EOC_SINGLE_CONV
ADC_EOC_SEQ_CONV
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 Analog watchdog 1 event
ADC_OVR_EVENT
ADC overrun event
ADC Exported Constants
ADC_CCR_ALL
ADC Exported Macros
__HAL_ADC_ENABLE
Description:
Enable the ADC peripheral.
Parameters:
__HANDLE__: ADC handle
Return value:
None
__HAL_ADC_DISABLE
Description:
Disable the ADC peripheral.
DocID026525 Rev 6
93/1320
HAL ADC Generic Driver
UM1785
Parameters:
__HANDLE__: ADC handle
Return value:
None
__HAL_ADC_ENABLE_IT
Description:
Enable the ADC end of conversion
interrupt.
Parameters:
__HANDLE__: ADC handle
__INTERRUPT__: ADC Interrupt This
parameter can be any combination of the
following values:
ADC_IT_EOC: ADC End of Regular
Conversion interrupt source
ADC_IT_EOS: ADC End of Regular
sequence of Conversions interrupt
source
ADC_IT_AWD: ADC Analog
watchdog interrupt source
ADC_IT_OVR: ADC overrun interrupt
source
ADC_IT_EOSMP: ADC End of
Sampling interrupt source
ADC_IT_RDY: ADC Ready interrupt
source
Return value:
None
__HAL_ADC_DISABLE_IT
Description:
Disable the ADC end of conversion
interrupt.
Parameters:
__HANDLE__: ADC handle
__INTERRUPT__: ADC Interrupt This
parameter can be any combination of the
following values:
ADC_IT_EOC: ADC End of Regular
Conversion interrupt source
ADC_IT_EOS: ADC End of Regular
sequence of Conversions interrupt
source
ADC_IT_AWD: ADC Analog
watchdog interrupt source
ADC_IT_OVR: ADC overrun interrupt
source
ADC_IT_EOSMP: ADC End of
Sampling interrupt source
94/1320
DocID026525 Rev 6
UM1785
HAL ADC Generic Driver
ADC_IT_RDY: ADC Ready interrupt
source
Return value:
None
__HAL_ADC_GET_IT_SOURCE
Description:
Checks if the specified ADC interrupt
source is enabled or disabled.
Parameters:
__HANDLE__: ADC handle
__INTERRUPT__: ADC interrupt source to
check This parameter can be any
combination of the following values:
ADC_IT_EOC: ADC End of Regular
Conversion interrupt source
ADC_IT_EOS: ADC End of Regular
sequence of Conversions interrupt
source
ADC_IT_AWD: ADC Analog
watchdog interrupt source
ADC_IT_OVR: ADC overrun interrupt
source
ADC_IT_EOSMP: ADC End of
Sampling interrupt source
ADC_IT_RDY: ADC Ready interrupt
source
Return value:
State: ofinterruption (SET or RESET)
__HAL_ADC_GET_FLAG
Description:
Get the selected ADC's flag status.
Parameters:
__HANDLE__: ADC handle
__FLAG__: ADC flag This parameter can
be any combination of the following values:
ADC_FLAG_EOC: ADC End of
Regular conversion flag
ADC_FLAG_EOS: ADC End of
Regular sequence of Conversions flag
ADC_FLAG_AWD: ADC Analog
watchdog flag
ADC_FLAG_OVR: ADC overrun flag
ADC_FLAG_EOSMP: ADC End of
Sampling flag
ADC_FLAG_RDY: ADC Ready flag
Return value:
None
DocID026525 Rev 6
95/1320
HAL ADC Generic Driver
__HAL_ADC_CLEAR_FLAG
UM1785
Description:
Clear the ADC's pending flags.
Parameters:
__HANDLE__: ADC handle
__FLAG__: ADC flag This parameter can
be any combination of the following values:
ADC_FLAG_EOC: ADC End of
Regular conversion flag
ADC_FLAG_EOS: ADC End of
Regular sequence of Conversions flag
ADC_FLAG_AWD: ADC Analog
watchdog flag
ADC_FLAG_OVR: ADC overrun flag
ADC_FLAG_EOSMP: ADC End of
Sampling flag
ADC_FLAG_RDY: ADC Ready flag
Return value:
None
__HAL_ADC_RESET_HANDLE_STATE
Description:
Reset ADC handle state.
Parameters:
__HANDLE__: ADC handle
Return value:
None
ADC Exported Types
Notes:
HAL_ADC_STATE_RESET
ADC state machine is managed by
bitfields, state must be compared with bit
by bit. For example: " if
(HAL_IS_BIT_SET(HAL_ADC_GetState(h
adc1), HAL_ADC_STATE_REG_BUSY)) "
" if
(HAL_IS_BIT_SET(HAL_ADC_GetState(h
adc1), HAL_ADC_STATE_AWD1) ) " ADC
not yet initialized or disabled
96/1320
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
DocID026525 Rev 6
UM1785
HAL_ADC_STATE_REG_BUSY
HAL ADC Generic Driver
A conversion on group regular is ongoing or
can occur (either by continuous mode, external
trigger, low power auto power-on, multimode
ADC master control)
HAL_ADC_STATE_REG_EOC
Conversion data available on group regular
HAL_ADC_STATE_REG_OVR
Overrun occurrence
HAL_ADC_STATE_REG_EOSMP
Not available on STM32F0 device: End Of
Sampling flag raised
HAL_ADC_STATE_INJ_BUSY
Not available on STM32F0 device: A
conversion on group injected is ongoing or can
occur (either by auto-injection mode, external
trigger, low power auto power-on, multimode
ADC master control)
HAL_ADC_STATE_INJ_EOC
Not available on STM32F0 device: Conversion
data available on group injected
HAL_ADC_STATE_INJ_JQOVF
Not available on STM32F0 device: Not
available on STM32F0 device: Injected queue
overflow occurrence
HAL_ADC_STATE_AWD1
Out-of-window occurrence of analog watchdog
1
HAL_ADC_STATE_AWD2
Not available on STM32F0 device: Out-ofwindow occurrence of analog watchdog 2
HAL_ADC_STATE_AWD3
Not available on STM32F0 device: Out-ofwindow occurrence of analog watchdog 3
HAL_ADC_STATE_MULTIMODE_SLAV
E
Not available on STM32F0 device: ADC in
multimode slave state, controlled by another
ADC master (
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_TRGO
ADC_EXTERNALTRIGCONV_T1_CC4
ADC_EXTERNALTRIGCONV_T3_TRGO
ADC_SOFTWARE_START
ADC_EXTERNALTRIGCONV_T2_TRGO
ADC_EXTERNALTRIGCONV_T15_TRGO
ADC flags definition
ADC_FLAG_AWD
ADC Analog watchdog flag
ADC_FLAG_OVR
ADC overrun flag
DocID026525 Rev 6
97/1320
HAL ADC Generic Driver
ADC_FLAG_EOS
UM1785
ADC End of Regular sequence of Conversions flag
ADC_FLAG_EOC
ADC End of Regular Conversion flag
ADC_FLAG_EOSMP
ADC End of Sampling flag
ADC_FLAG_RDY
ADC Ready flag
ADC Internal HAL driver Ext trig src Regular
ADC1_2_EXTERNALTRIG_T1_TRGO
ADC1_2_EXTERNALTRIG_T1_CC4
ADC1_2_EXTERNALTRIG_T2_TRGO
ADC1_2_EXTERNALTRIG_T3_TRGO
ADC1_2_EXTERNALTRIG_T15_TRGO
ADC interrupts definition
ADC_IT_AWD
ADC Analog watchdog interrupt source
ADC_IT_OVR
ADC overrun interrupt source
ADC_IT_EOS
ADC End of Regular sequence of Conversions interrupt source
ADC_IT_EOC
ADC End of Regular Conversion interrupt source
ADC_IT_EOSMP
ADC End of Sampling interrupt source
ADC_IT_RDY
ADC Ready interrupt source
ADC Overrun
ADC_OVR_DATA_OVERWRITTEN
ADC_OVR_DATA_PRESERVED
ADC range verification
IS_ADC_RANGE
ADC rank
ADC_RANK_CHANNEL_NUMBER
Enable the rank of the selected channels. Number of
ranks in the sequence is defined by number of
channels enabled, rank of each channel is defined by
channel number (channel 0 fixed on rank 0, channel
1 fixed on rank1, ...)
ADC_RANK_NONE
Disable the selected rank (selected channel) from
sequencer
ADC regular rank verification
IS_ADC_REGULAR_RANK
ADC Resolution
98/1320
ADC_RESOLUTION_12B
ADC 12-bit resolution
ADC_RESOLUTION_10B
ADC 10-bit resolution
ADC_RESOLUTION_8B
ADC 8-bit resolution
ADC_RESOLUTION_6B
ADC 6-bit resolution
DocID026525 Rev 6
UM1785
HAL ADC Generic Driver
ADC sampling times
ADC_SAMPLETIME_1CYCLE_5
Sampling time 1.5 ADC clock cycle
ADC_SAMPLETIME_7CYCLES_5
Sampling time 7.5 ADC clock cycles
ADC_SAMPLETIME_13CYCLES_5
Sampling time 13.5 ADC clock cycles
ADC_SAMPLETIME_28CYCLES_5
Sampling time 28.5 ADC clock cycles
ADC_SAMPLETIME_41CYCLES_5
Sampling time 41.5 ADC clock cycles
ADC_SAMPLETIME_55CYCLES_5
Sampling time 55.5 ADC clock cycles
ADC_SAMPLETIME_71CYCLES_5
Sampling time 71.5 ADC clock cycles
ADC_SAMPLETIME_239CYCLES_5
Sampling time 239.5 ADC clock cycles
ADC Scan mode
ADC_SCAN_DIRECTION_FORWARD
Scan direction forward: from channel 0 to
channel 18
ADC_SCAN_DIRECTION_BACKWARD
Scan direction backward: from channel 18 to
channel 0
ADC_SCAN_ENABLE
DocID026525 Rev 6
99/1320
HAL ADC Extension Driver
UM1785
7
HAL ADC Extension Driver
7.1
ADCEx Firmware driver API description
7.1.1
IO operation functions
This section provides functions allowing to:
Perform the ADC calibration.
This section contains the following APIs:
HAL_ADCEx_Calibration_Start()
7.1.2
Detailed description of functions
HAL_ADCEx_Calibration_Start
100/1320
Function name
HAL_StatusTypeDef HAL_ADCEx_Calibration_Start
(ADC_HandleTypeDef * hadc)
Function description
Perform an ADC automatic self-calibration Calibration prerequisite:
ADC must be disabled (execute this function before
HAL_ADC_Start() or after HAL_ADC_Stop() ).
Parameters
hadc: ADC handle
Return values
HAL: status
Notes
Calibration factor can be read after calibration, using function
HAL_ADC_GetValue() (value on 7 bits: from DR[6;0]).
DocID026525 Rev 6
UM1785
HAL CAN Generic Driver
8
HAL CAN Generic Driver
8.1
CAN Firmware driver registers structures
8.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
uint32_t CAN_InitTypeDef::Prescaler
Specifies the length of a time quantum. This parameter must be a number between
Min_Data = 1 and Max_Data = 1024.
uint32_t CAN_InitTypeDef::Mode
Specifies the CAN operating mode. This parameter can be a value of
CAN_operating_mode
uint32_t CAN_InitTypeDef::SJW
Specifies the maximum number of time quanta the CAN hardware is allowed to
lengthen or shorten a bit to perform resynchronization. This parameter can be a value
of CAN_synchronisation_jump_width
uint32_t CAN_InitTypeDef::BS1
Specifies the number of time quanta in Bit Segment 1. This parameter can be a value
of CAN_time_quantum_in_bit_segment_1
uint32_t CAN_InitTypeDef::BS2
Specifies the number of time quanta in Bit Segment 2. This parameter can be a value
of CAN_time_quantum_in_bit_segment_2
uint32_t CAN_InitTypeDef::TTCM
Enable or disable the time triggered communication mode. This parameter can be set
to ENABLE or DISABLE.
uint32_t CAN_InitTypeDef::ABOM
Enable or disable the automatic bus-off management. This parameter can be set to
ENABLE or DISABLE.
uint32_t CAN_InitTypeDef::AWUM
Enable or disable the automatic wake-up mode. This parameter can be set to
ENABLE or DISABLE.
uint32_t CAN_InitTypeDef::NART
Enable or disable the non-automatic retransmission mode. This parameter can be set
to ENABLE or DISABLE.
uint32_t CAN_InitTypeDef::RFLM
Enable or disable the Receive FIFO Locked mode. This parameter can be set to
ENABLE or DISABLE.
DocID026525 Rev 6
101/1320
HAL CAN Generic Driver
UM1785
uint32_t CAN_InitTypeDef::TXFP
Enable or disable the transmit FIFO priority. This parameter can be set to ENABLE or
DISABLE.
8.1.2
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 1U) which will be assigned to the filter. This parameter can be
a value of CAN_filter_FIFO
uint32_t CAN_FilterConfTypeDef::FilterNumber
Specifies the filter which will be initialized. This parameter must be a number between
Min_Data = 0 and Max_Data = 27.
uint32_t CAN_FilterConfTypeDef::FilterMode
Specifies the filter mode to be initialized. This parameter can be a value of
CAN_filter_mode
uint32_t CAN_FilterConfTypeDef::FilterScale
Specifies the filter scale. This parameter can be a value of CAN_filter_scale
uint32_t CAN_FilterConfTypeDef::FilterActivation
Enable or disable the filter. This parameter can be set to ENABLE or DISABLE.
uint32_t CAN_FilterConfTypeDef::BankNumber
Select the start slave bank filter This parameter must be a number between Min_Data
= 0 and Max_Data = 28.
102/1320
DocID026525 Rev 6
UM1785
8.1.3
HAL CAN Generic Driver
CanTxMsgTypeDef
Data Fields
uint32_t StdId
uint32_t ExtId
uint32_t IDE
uint32_t RTR
uint32_t DLC
uint8_t Data
Field Documentation
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.
8.1.4
CanRxMsgTypeDef
Data Fields
uint32_t StdId
uint32_t ExtId
uint32_t IDE
uint32_t RTR
uint32_t DLC
uint8_t Data
uint32_t FMI
uint32_t FIFONumber
Field Documentation
uint32_t CanRxMsgTypeDef::StdId
Specifies the standard identifier. This parameter must be a number between Min_Data
= 0 and Max_Data = 0x7FF.
uint32_t CanRxMsgTypeDef::ExtId
Specifies the extended identifier. This parameter must be a number between
Min_Data = 0 and Max_Data = 0x1FFFFFFF.
uint32_t CanRxMsgTypeDef::IDE
Specifies the type of identifier for the message that will be received. This parameter
can be a value of CAN_identifier_type
DocID026525 Rev 6
103/1320
HAL CAN Generic Driver
UM1785
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
8.1.5
CAN_HandleTypeDef
Data Fields
CAN_TypeDef * Instance
CAN_InitTypeDef Init
CanTxMsgTypeDef * pTxMsg
CanRxMsgTypeDef * pRxMsg
CanRxMsgTypeDef * pRx1Msg
HAL_LockTypeDef Lock
__IO HAL_CAN_StateTypeDef State
__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 for RX FIFO0 msg
CanRxMsgTypeDef* CAN_HandleTypeDef::pRx1Msg
Pointer to reception structure for RX FIFO1 msg
HAL_LockTypeDef CAN_HandleTypeDef::Lock
CAN locking object
__IO HAL_CAN_StateTypeDef CAN_HandleTypeDef::State
CAN communication state
__IO uint32_t CAN_HandleTypeDef::ErrorCode
CAN Error code This parameter can be a value of CAN_Error_Code
8.2
CAN Firmware driver API description
8.2.1
How to use this driver
1.
2.
104/1320
Enable the CAN controller interface clock using __HAL_RCC_CAN1_CLK_ENABLE();
CAN pins configuration
Enable the clock for the CAN GPIOs using the following function:
__HAL_RCC_GPIOx_CLK_ENABLE();
DocID026525 Rev 6
UM1785
HAL CAN Generic Driver
3.
4.
5.
6.
7.
Connect and configure the involved CAN pins to AF9 using the following function
HAL_GPIO_Init();
Initialise and configure the CAN using HAL_CAN_Init() function.
Transmit the desired CAN frame using HAL_CAN_Transmit() function.
Or transmit the desired CAN frame using HAL_CAN_Transmit_IT() function.
Receive a CAN frame using HAL_CAN_Receive() function.
Or receive a CAN frame using HAL_CAN_Receive_IT() 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.
__HAL_CAN_ENABLE_IT: Enable the specified CAN interrupts
__HAL_CAN_DISABLE_IT: Disable the specified CAN interrupts
__HAL_CAN_GET_IT_SOURCE: Check if the specified CAN interrupt source is
enabled or disabled
__HAL_CAN_CLEAR_FLAG: Clear the CAN's pending flags
__HAL_CAN_GET_FLAG: Get the selected CAN's flag status
You can refer to the CAN HAL driver header file for more useful macros
8.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:
HAL_CAN_Init()
HAL_CAN_ConfigFilter()
HAL_CAN_DeInit()
HAL_CAN_MspInit()
DocID026525 Rev 6
105/1320
HAL CAN Generic Driver
UM1785
HAL_CAN_MspDeInit()
8.2.3
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()
8.2.4
Detailed description of functions
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
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.
Return values
None
HAL_CAN_DeInit
106/1320
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
DocID026525 Rev 6
UM1785
HAL CAN Generic Driver
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.
Return values
None
HAL_CAN_Transmit
Function name
HAL_StatusTypeDef HAL_CAN_Transmit
(CAN_HandleTypeDef * hcan, uint32_t Timeout)
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.
Timeout: Timeout duration.
Return values
HAL: status
HAL_CAN_Transmit_IT
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.
Timeout: Timeout duration.
Return values
HAL: status
DocID026525 Rev 6
107/1320
HAL CAN Generic Driver
UM1785
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
hcan: pointer to a CAN_HandleTypeDef structure that
contains the configuration information for the specified CAN.
FIFONumber: FIFO number.
Return values
HAL: status
HAL_CAN_Sleep
Function name
HAL_StatusTypeDef HAL_CAN_Sleep (CAN_HandleTypeDef *
hcan)
Function description
Enters the Sleep (low power) mode.
Parameters
hcan: pointer to a CAN_HandleTypeDef structure that
contains the configuration information for the specified CAN.
Return values
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
108/1320
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
DocID026525 Rev 6
UM1785
HAL CAN Generic Driver
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
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
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
8.3
CAN Firmware driver defines
8.3.1
CAN
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
DocID026525 Rev 6
109/1320
HAL CAN Generic Driver
HAL_CAN_ERROR_ACK
UM1785
Acknowledgment error
HAL_CAN_ERROR_BR
Bit recessive
HAL_CAN_ERROR_BD
LEC dominant
HAL_CAN_ERROR_CRC
LEC transfer error
HAL_CAN_ERROR_FOV0
FIFO0 overrun error
HAL_CAN_ERROR_FOV1
FIFO1 overrun error
HAL_CAN_ERROR_TXFAIL
Transmit failure
CAN Exported Macros
__HAL_CAN_RESET_HANDLE_STATE
Description:
Reset CAN handle state.
Parameters:
__HANDLE__: CAN handle.
Return value:
None
Description:
__HAL_CAN_ENABLE_IT
Enable the specified CAN interrupts.
Parameters:
__HANDLE__: CAN handle.
__INTERRUPT__: CAN Interrupt
Return value:
None
Description:
__HAL_CAN_DISABLE_IT
Disable the specified CAN interrupts.
Parameters:
__HANDLE__: CAN handle.
__INTERRUPT__: CAN Interrupt
Return value:
None
__HAL_CAN_MSG_PENDING
Description:
Return the number of pending received
messages.
Parameters:
__HANDLE__: CAN handle.
__FIFONUMBER__: Receive FIFO
number, CAN_FIFO0 or CAN_FIFO1.
Return value:
The: number of pending message.
110/1320
DocID026525 Rev 6
UM1785
HAL CAN Generic Driver
__HAL_CAN_GET_FLAG
Description:
Check whether the specified CAN flag is
set or not.
Parameters:
__HANDLE__: specifies the CAN Handle.
__FLAG__: specifies the flag to check.
This parameter can be one of the following
values:
CAN_TSR_RQCP0: Request
MailBox0 Flag
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
CAN_FLAG_EPV: Error Passive Flag
CAN_FLAG_BOF: Bus-Off Flag
Return value:
The: new state of __FLAG__ (TRUE or
FALSE).
DocID026525 Rev 6
111/1320
HAL CAN Generic Driver
__HAL_CAN_CLEAR_FLAG
UM1785
Description:
Clear the specified CAN pending flag.
Parameters:
__HANDLE__: specifies the CAN Handle.
__FLAG__: specifies the flag to check.
This parameter can be one of the following
values:
CAN_TSR_RQCP0: Request
MailBox0 Flag
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_SLAKI: Sleep
acknowledge Flag
CAN_FLAG_EWG: Error Warning
Flag
CAN_FLAG_EPV: Error Passive Flag
CAN_FLAG_BOF: Bus-Off Flag
Return value:
The: new state of __FLAG__ (TRUE or
FALSE).
112/1320
DocID026525 Rev 6
UM1785
HAL CAN Generic Driver
__HAL_CAN_GET_IT_SOURCE
Description:
Check if the specified CAN interrupt source
is enabled or disabled.
Parameters:
__HANDLE__: specifies the 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 enablev
CAN_IT_FMP1: FIFO1 message
pending interrupt enable
Return value:
The: new state of __IT__ (TRUE or
FALSE).
__HAL_CAN_TRANSMIT_STATUS
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:
The: new status of transmission (TRUE or
FALSE).
__HAL_CAN_FIFO_RELEASE
Description:
Release the specified receive FIFO.
Parameters:
__HANDLE__: CAN handle.
__FIFONUMBER__: Receive FIFO
number, CAN_FIFO0 or CAN_FIFO1.
Return value:
None
__HAL_CAN_CANCEL_TRANSMIT
Description:
Cancel a transmit request.
Parameters:
__HANDLE__: specifies the CAN Handle.
__TRANSMITMAILBOX__: the number of
the mailbox that is used for transmission.
DocID026525 Rev 6
113/1320
HAL CAN Generic Driver
UM1785
Return value:
None
Description:
__HAL_CAN_DBG_FREEZE
Enable or disables the DBG Freeze for
CAN.
Parameters:
__HANDLE__: specifies the 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
114/1320
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
CAN_FLAG_FOV0
FIFO 0 Overrun flag
CAN_FLAG_FF1
FIFO 1 Full flag
CAN_FLAG_FOV1
FIFO 1 Overrun flag
CAN_FLAG_INAK
Initialization acknowledge flag
DocID026525 Rev 6
UM1785
HAL CAN Generic Driver
CAN_FLAG_SLAK
Sleep acknowledge flag
CAN_FLAG_ERRI
Error flag
CAN_FLAG_WKU
Wake up flag
CAN_FLAG_SLAKI
Sleep acknowledge flag
CAN_FLAG_EWG
Error warning flag
CAN_FLAG_EPV
Error passive flag
CAN_FLAG_BOF
Bus-Off flag
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
CAN_TXMAILBOX_0
CAN_TXMAILBOX_1
CAN_TXMAILBOX_2
CAN Operating Mode
CAN_MODE_NORMAL
Normal mode
CAN_MODE_LOOPBACK
Loopback mode
CAN_MODE_SILENT
Silent mode
DocID026525 Rev 6
115/1320
HAL CAN Generic Driver
CAN_MODE_SILENT_LOOPBACK
UM1785
Loopback combined with silent mode
CAN Receive FIFO Number
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 Synchronization 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
116/1320
CAN_BS1_1TQ
1 time quantum
CAN_BS1_2TQ
2 time quantum
CAN_BS1_3TQ
3 time quantum
CAN_BS1_4TQ
4 time quantum
CAN_BS1_5TQ
5 time quantum
CAN_BS1_6TQ
6 time quantum
CAN_BS1_7TQ
7 time quantum
CAN_BS1_8TQ
8 time quantum
CAN_BS1_9TQ
9 time quantum
CAN_BS1_10TQ
10 time quantum
CAN_BS1_11TQ
11 time quantum
CAN_BS1_12TQ
12 time quantum
CAN_BS1_13TQ
13 time quantum
CAN_BS1_14TQ
14 time quantum
CAN_BS1_15TQ
15 time quantum
CAN_BS1_16TQ
16 time quantum
DocID026525 Rev 6
UM1785
HAL CAN Generic Driver
CAN Time Quantum in Bit Segment 2
CAN_BS2_1TQ
1 time quantum
CAN_BS2_2TQ
2 time quantum
CAN_BS2_3TQ
3 time quantum
CAN_BS2_4TQ
4 time quantum
CAN_BS2_5TQ
5 time quantum
CAN_BS2_6TQ
6 time quantum
CAN_BS2_7TQ
7 time quantum
CAN_BS2_8TQ
8 time quantum
DocID026525 Rev 6
117/1320
HAL CEC Generic Driver
UM1785
9
HAL CEC Generic Driver
9.1
CEC Firmware driver registers structures
9.1.1
CEC_InitTypeDef
Data Fields
uint32_t SignalFreeTime
uint32_t Tolerance
uint32_t BRERxStop
uint32_t BREErrorBitGen
uint32_t LBPEErrorBitGen
uint32_t BroadcastMsgNoErrorBitGen
uint32_t SignalFreeTimeOption
uint32_t ListenMode
uint16_t OwnAddress
uint8_t * RxBuffer
Field Documentation
uint32_t CEC_InitTypeDef::SignalFreeTime
Set SFT field, specifies the Signal Free Time. It can be one of
CEC_Signal_Free_Time and belongs to the set {0,...,7} where 0x0 is the default
configuration else means 0.5 + (SignalFreeTime - 1) nominal data bit periods
uint32_t CEC_InitTypeDef::Tolerance
Set RXTOL bit, specifies the tolerance accepted on the received waveforms, it can be
a value of CEC_Tolerance : it is either CEC_STANDARD_TOLERANCE or
CEC_EXTENDED_TOLERANCE
uint32_t CEC_InitTypeDef::BRERxStop
Set BRESTP bit CEC_BRERxStop : specifies whether or not a Bit Rising Error stops
the reception. CEC_NO_RX_STOP_ON_BRE: reception is not stopped.
CEC_RX_STOP_ON_BRE: reception is stopped.
uint32_t CEC_InitTypeDef::BREErrorBitGen
Set BREGEN bit CEC_BREErrorBitGen : specifies whether or not an Error-Bit is
generated on the CEC line upon Bit Rising Error detection.
CEC_BRE_ERRORBIT_NO_GENERATION: no error-bit generation.
CEC_BRE_ERRORBIT_GENERATION: error-bit generation if BRESTP is set.
uint32_t CEC_InitTypeDef::LBPEErrorBitGen
Set LBPEGEN bit CEC_LBPEErrorBitGen : specifies whether or not an Error-Bit is
generated on the CEC line upon Long Bit Period Error detection.
CEC_LBPE_ERRORBIT_NO_GENERATION: no error-bit generation.
CEC_LBPE_ERRORBIT_GENERATION: error-bit generation.
uint32_t CEC_InitTypeDef::BroadcastMsgNoErrorBitGen
Set BRDNOGEN bit CEC_BroadCastMsgErrorBitGen : allows to avoid an Error-Bit
generation on the CEC line upon an error detected on a broadcast message.It
supersedes BREGEN and LBPEGEN bits for a broadcast message error handling. It
can take two values:1) CEC_BROADCASTERROR_ERRORBIT_GENERATION. a)
BRE detection: error-bit generation on the CEC line if
BRESTP=CEC_RX_STOP_ON_BRE and
BREGEN=CEC_BRE_ERRORBIT_NO_GENERATION. b) LBPE detection: error-bit
generation on the CEC line if
LBPGEN=CEC_LBPE_ERRORBIT_NO_GENERATION.2)
118/1320
DocID026525 Rev 6
UM1785
9.1.2
HAL CEC Generic Driver
CEC_BROADCASTERROR_NO_ERRORBIT_GENERATION. no error-bit generation
in case neither a) nor b) are satisfied. Additionally, there is no error-bit generation in
case of Short Bit Period Error detection in a broadcast message while LSTN bit is set.
uint32_t CEC_InitTypeDef::SignalFreeTimeOption
Set SFTOP bit CEC_SFT_Option : specifies when SFT timer starts.
CEC_SFT_START_ON_TXSOM SFT: timer starts when TXSOM is set by software.
CEC_SFT_START_ON_TX_RX_END: SFT timer starts automatically at the end of
message transmission/reception.
uint32_t CEC_InitTypeDef::ListenMode
Set LSTN bit CEC_Listening_Mode : specifies device listening mode. It can take two
values:CEC_REDUCED_LISTENING_MODE: CEC peripheral receives only message
addressed to its own address (OAR). Messages addressed to different destination are
ignored. Broadcast messages are always received.CEC_FULL_LISTENING_MODE:
CEC peripheral receives messages addressed to its own address (OAR) with positive
acknowledge. Messages addressed to different destination are received, but without
interfering with the CEC bus: no acknowledge sent.
uint16_t CEC_InitTypeDef::OwnAddress
Own addresses configuration This parameter can be a value of
CEC_OWN_ADDRESS
uint8_t* CEC_InitTypeDef::RxBuffer
CEC Rx buffer pointeur
CEC_HandleTypeDef
Data Fields
CEC_TypeDef * Instance
CEC_InitTypeDef Init
uint8_t * pTxBuffPtr
uint16_t TxXferCount
uint16_t RxXferSize
HAL_LockTypeDef Lock
HAL_CEC_StateTypeDef gState
HAL_CEC_StateTypeDef RxState
uint32_t ErrorCode
Field Documentation
CEC_TypeDef* CEC_HandleTypeDef::Instance
CEC registers base address
CEC_InitTypeDef CEC_HandleTypeDef::Init
CEC communication parameters
uint8_t* CEC_HandleTypeDef::pTxBuffPtr
Pointer to CEC Tx transfer Buffer
uint16_t CEC_HandleTypeDef::TxXferCount
CEC Tx Transfer Counter
uint16_t CEC_HandleTypeDef::RxXferSize
CEC Rx Transfer size, 0: header received only
HAL_LockTypeDef CEC_HandleTypeDef::Lock
Locking object
HAL_CEC_StateTypeDef CEC_HandleTypeDef::gState
CEC state information related to global Handle management and also related to Tx
operations. This parameter can be a value of HAL_CEC_StateTypeDef
HAL_CEC_StateTypeDef CEC_HandleTypeDef::RxState
CEC state information related to Rx operations. This parameter can be a value of
HAL_CEC_StateTypeDef
DocID026525 Rev 6
119/1320
HAL CEC Generic Driver
UM1785
uint32_t CEC_HandleTypeDef::ErrorCode
For errors handling purposes, copy of ISR register in case error is reported
9.2
CEC Firmware driver API description
9.2.1
How to use this driver
The specific CEC interrupts (Transmission complete interrupt, RXNE interrupt
and Error Interrupts) will be managed using the macros
__HAL_CEC_ENABLE_IT() and __HAL_CEC_DISABLE_IT() inside the transmit
and receive process. (#) Program the Signal Free Time (SFT) and SFT option,
Tolerance, reception stop in in case of Bit Rising Error, Error-Bit generation
conditions, device logical address and Listen mode in the hcec Init structure. (#)
Initialize the CEC registers by calling the HAL_CEC_Init() API.
This API (HAL_CEC_Init()) configures also the low level Hardware GPIO,
CLOCK, CORTEX...etc) by calling the customed HAL_CEC_MspInit() API.
9.2.2
Initialization and Configuration functions
This subsection provides a set of functions allowing to initialize the CEC
The following parameters need to be configured:
SignalFreeTime
Tolerance
BRERxStop (RX stopped or not upon Bit Rising Error)
BREErrorBitGen (Error-Bit generation in case of Bit Rising Error)
LBPEErrorBitGen (Error-Bit generation in case of Long Bit Period Error)
BroadcastMsgNoErrorBitGen (Error-bit generation in case of broadcast message
error)
SignalFreeTimeOption (SFT Timer start definition)
OwnAddress (CEC device address)
ListenMode
This section contains the following APIs:
HAL_CEC_Init()
HAL_CEC_DeInit()
HAL_CEC_SetDeviceAddress()
HAL_CEC_MspInit()
HAL_CEC_MspDeInit()
9.2.3
IO operation functions
This section contains the following APIs:
HAL_CEC_Transmit_IT()
HAL_CEC_GetLastReceivedFrameSize()
HAL_CEC_ChangeRxBuffer()
HAL_CEC_IRQHandler()
HAL_CEC_TxCpltCallback()
HAL_CEC_RxCpltCallback()
120/1320
DocID026525 Rev 6
UM1785
HAL CEC Generic Driver
HAL_CEC_ErrorCallback()
9.2.4
Peripheral Control function
This subsection provides a set of functions allowing to control the CEC.
HAL_CEC_GetState() API can be helpful to check in run-time the state of the CEC
peripheral.
HAL_CEC_GetError() API can be helpful to check in run-time the error of the CEC
peripheral.
This section contains the following APIs:
HAL_CEC_GetState()
HAL_CEC_GetError()
9.2.5
Detailed description of functions
HAL_CEC_Init
Function name
HAL_StatusTypeDef HAL_CEC_Init (CEC_HandleTypeDef *
hcec)
Function description
Initializes the CEC mode according to the specified parameters in
the CEC_InitTypeDef and creates the associated handle .
Parameters
hcec: CEC handle
Return values
HAL: status
HAL_CEC_DeInit
Function name
HAL_StatusTypeDef HAL_CEC_DeInit (CEC_HandleTypeDef *
hcec)
Function description
DeInitializes the CEC peripheral.
Parameters
hcec: CEC handle
Return values
HAL: status
HAL_CEC_SetDeviceAddress
Function name
HAL_StatusTypeDef HAL_CEC_SetDeviceAddress
(CEC_HandleTypeDef * hcec, uint16_t CEC_OwnAddress)
Function description
Initializes the Own Address of the CEC device.
Parameters
hcec: CEC handle
CEC_OwnAddress: The CEC own address.
Return values
HAL: status
DocID026525 Rev 6
121/1320
HAL CEC Generic Driver
UM1785
HAL_CEC_MspInit
Function name
void HAL_CEC_MspInit (CEC_HandleTypeDef * hcec)
Function description
CEC MSP Init.
Parameters
hcec: CEC handle
Return values
None
HAL_CEC_MspDeInit
Function name
void HAL_CEC_MspDeInit (CEC_HandleTypeDef * hcec)
Function description
CEC MSP DeInit.
Parameters
hcec: CEC handle
Return values
None
HAL_CEC_Transmit_IT
Function name
HAL_StatusTypeDef HAL_CEC_Transmit_IT
(CEC_HandleTypeDef * hcec, uint8_t InitiatorAddress, uint8_t
DestinationAddress, uint8_t * pData, uint32_t Size)
Function description
Send data in interrupt mode.
Parameters
hcec: CEC handle
InitiatorAddress: Initiator address
DestinationAddress: destination logical address
pData: pointer to input byte data buffer
Size: amount of data to be sent in bytes (without counting the
header). 0 means only the header is sent (ping operation).
Maximum TX size is 15 bytes (1 opcode and up to 14
operands).
Return values
HAL: status
HAL_CEC_GetLastReceivedFrameSize
Function name
uint32_t HAL_CEC_GetLastReceivedFrameSize
(CEC_HandleTypeDef * hcec)
Function description
Get size of the received frame.
Parameters
hcec: CEC handle
Return values
Frame: size
HAL_CEC_ChangeRxBuffer
122/1320
Function name
void HAL_CEC_ChangeRxBuffer (CEC_HandleTypeDef * hcec,
uint8_t * Rxbuffer)
Function description
Change Rx Buffer.
Parameters
hcec: CEC handle
Rxbuffer: Rx Buffer
Return values
Frame: size
DocID026525 Rev 6
UM1785
HAL CEC Generic Driver
Notes
This function can be called only inside the
HAL_CEC_RxCpltCallback()
HAL_CEC_IRQHandler
Function name
void HAL_CEC_IRQHandler (CEC_HandleTypeDef * hcec)
Function description
This function handles CEC interrupt requests.
Parameters
hcec: CEC handle
Return values
None
HAL_CEC_TxCpltCallback
Function name
void HAL_CEC_TxCpltCallback (CEC_HandleTypeDef * hcec)
Function description
Tx Transfer completed callback.
Parameters
hcec: CEC handle
Return values
None
HAL_CEC_RxCpltCallback
Function name
void HAL_CEC_RxCpltCallback (CEC_HandleTypeDef * hcec,
uint32_t RxFrameSize)
Function description
Rx Transfer completed callback.
Parameters
hcec: CEC handle
RxFrameSize: Size of frame
Return values
None
HAL_CEC_ErrorCallback
Function name
void HAL_CEC_ErrorCallback (CEC_HandleTypeDef * hcec)
Function description
CEC error callbacks.
Parameters
hcec: CEC handle
Return values
None
HAL_CEC_GetState
Function name
HAL_CEC_StateTypeDef HAL_CEC_GetState
(CEC_HandleTypeDef * hcec)
Function description
return the CEC state
Parameters
hcec: pointer to a CEC_HandleTypeDef structure that
contains the configuration information for the specified CEC
module.
Return values
HAL: state
DocID026525 Rev 6
123/1320
HAL CEC Generic Driver
UM1785
HAL_CEC_GetError
Function name
uint32_t HAL_CEC_GetError (CEC_HandleTypeDef * hcec)
Function description
Return the CEC error code.
Parameters
hcec: pointer to a CEC_HandleTypeDef structure that
contains the configuration information for the specified CEC.
Return values
CEC: Error Code
9.3
CEC Firmware driver defines
9.3.1
CEC
CEC all RX or TX errors flags
CEC_ISR_ALL_ERROR
CEC Error Bit Generation if Bit Rise Error reported
CEC_BRE_ERRORBIT_NO_GENERATION
CEC_BRE_ERRORBIT_GENERATION
CEC Reception Stop on Error
CEC_NO_RX_STOP_ON_BRE
CEC_RX_STOP_ON_BRE
CEC Error Bit Generation on Broadcast message
CEC_BROADCASTERROR_ERRORBIT_GENERATION
CEC_BROADCASTERROR_NO_ERRORBIT_GENERATION
CEC Error Code
HAL_CEC_ERROR_NONE
no error
HAL_CEC_ERROR_RXOVR
CEC Rx-Overrun
HAL_CEC_ERROR_BRE
CEC Rx Bit Rising Error
HAL_CEC_ERROR_SBPE
CEC Rx Short Bit period Error
HAL_CEC_ERROR_LBPE
CEC Rx Long Bit period Error
HAL_CEC_ERROR_RXACKE
CEC Rx Missing Acknowledge
HAL_CEC_ERROR_ARBLST
CEC Arbitration Lost
HAL_CEC_ERROR_TXUDR
CEC Tx-Buffer Underrun
HAL_CEC_ERROR_TXERR
CEC Tx-Error
HAL_CEC_ERROR_TXACKE
CEC Tx Missing Acknowledge
CEC Exported Macros
__HAL_CEC_RESET_HANDLE_STATE
Description:
Reset CEC handle gstate & RxState.
Parameters:
__HANDLE__: CEC handle.
124/1320
DocID026525 Rev 6
UM1785
HAL CEC Generic Driver
Return value:
None
__HAL_CEC_GET_FLAG
Description:
Checks whether or not the specified
CEC interrupt flag is set.
Parameters:
__HANDLE__: specifies the CEC
Handle.
__FLAG__: specifies the flag to check.
CEC_FLAG_TXACKE: Tx Missing
acknowledge Error
CEC_FLAG_TXERR: Tx Error.
CEC_FLAG_TXUDR: Tx-Buffer
Underrun.
CEC_FLAG_TXEND: End of
transmission (successful
transmission of the last byte).
CEC_FLAG_TXBR: Tx-Byte
Request.
CEC_FLAG_ARBLST: Arbitration
Lost
CEC_FLAG_RXACKE: Rx-Missing
Acknowledge
CEC_FLAG_LBPE: Rx Long
period Error
CEC_FLAG_SBPE: Rx Short
period Error
CEC_FLAG_BRE: Rx Bit Rising
Error
CEC_FLAG_RXOVR: Rx Overrun.
CEC_FLAG_RXEND: End Of
Reception.
CEC_FLAG_RXBR: Rx-Byte
Received.
Return value:
ITStatus
__HAL_CEC_CLEAR_FLAG
Description:
Clears the interrupt or status flag when
raised (write at 1)
Parameters:
__HANDLE__: specifies the CEC
Handle.
__FLAG__: specifies the
interrupt/status flag to clear. This
parameter can be one of the following
values:
CEC_FLAG_TXACKE: Tx Missing
acknowledge Error
DocID026525 Rev 6
125/1320
HAL CEC Generic Driver
UM1785
CEC_FLAG_TXERR: Tx Error.
CEC_FLAG_TXUDR: Tx-Buffer
Underrun.
CEC_FLAG_TXEND: End of
transmission (successful
transmission of the last byte).
CEC_FLAG_TXBR: Tx-Byte
Request.
CEC_FLAG_ARBLST: Arbitration
Lost
CEC_FLAG_RXACKE: Rx-Missing
Acknowledge
CEC_FLAG_LBPE: Rx Long
period Error
CEC_FLAG_SBPE: Rx Short
period Error
CEC_FLAG_BRE: Rx Bit Rising
Error
CEC_FLAG_RXOVR: Rx Overrun.
CEC_FLAG_RXEND: End Of
Reception.
CEC_FLAG_RXBR: Rx-Byte
Received.
Return value:
none
__HAL_CEC_ENABLE_IT
Description:
Enables the specified CEC interrupt.
Parameters:
__HANDLE__: specifies the CEC
Handle.
__INTERRUPT__: specifies the CEC
interrupt to enable. This parameter can
be one of the following values:
CEC_IT_TXACKE: Tx Missing
acknowledge Error IT Enable
CEC_IT_TXERR: Tx Error IT
Enable
CEC_IT_TXUDR: Tx-Buffer
Underrun IT Enable
CEC_IT_TXEND: End of
transmission IT Enable
CEC_IT_TXBR: Tx-Byte Request
IT Enable
CEC_IT_ARBLST: Arbitration Lost
IT Enable
CEC_IT_RXACKE: Rx-Missing
Acknowledge IT Enable
CEC_IT_LBPE: Rx Long period
Error IT Enable
CEC_IT_SBPE: Rx Short period
Error IT Enable
126/1320
DocID026525 Rev 6
UM1785
HAL CEC Generic Driver
CEC_IT_BRE: Rx Bit Rising Error
IT Enable
CEC_IT_RXOVR: Rx Overrun IT
Enable
CEC_IT_RXEND: End Of
Reception IT Enable
CEC_IT_RXBR: Rx-Byte Received
IT Enable
Return value:
none
__HAL_CEC_DISABLE_IT
Description:
Disables the specified CEC interrupt.
Parameters:
__HANDLE__: specifies the CEC
Handle.
__INTERRUPT__: specifies the CEC
interrupt to disable. This parameter can
be one of the following values:
CEC_IT_TXACKE: Tx Missing
acknowledge Error IT Enable
CEC_IT_TXERR: Tx Error IT
Enable
CEC_IT_TXUDR: Tx-Buffer
Underrun IT Enable
CEC_IT_TXEND: End of
transmission IT Enable
CEC_IT_TXBR: Tx-Byte Request
IT Enable
CEC_IT_ARBLST: Arbitration Lost
IT Enable
CEC_IT_RXACKE: Rx-Missing
Acknowledge IT Enable
CEC_IT_LBPE: Rx Long period
Error IT Enable
CEC_IT_SBPE: Rx Short period
Error IT Enable
CEC_IT_BRE: Rx Bit Rising Error
IT Enable
CEC_IT_RXOVR: Rx Overrun IT
Enable
CEC_IT_RXEND: End Of
Reception IT Enable
CEC_IT_RXBR: Rx-Byte Received
IT Enable
Return value:
none
DocID026525 Rev 6
127/1320
HAL CEC Generic Driver
__HAL_CEC_GET_IT_SOURCE
UM1785
Description:
Checks whether or not the specified
CEC interrupt is enabled.
Parameters:
__HANDLE__: specifies the CEC
Handle.
__INTERRUPT__: specifies the CEC
interrupt to check. This parameter can
be one of the following values:
CEC_IT_TXACKE: Tx Missing
acknowledge Error IT Enable
CEC_IT_TXERR: Tx Error IT
Enable
CEC_IT_TXUDR: Tx-Buffer
Underrun IT Enable
CEC_IT_TXEND: End of
transmission IT Enable
CEC_IT_TXBR: Tx-Byte Request
IT Enable
CEC_IT_ARBLST: Arbitration Lost
IT Enable
CEC_IT_RXACKE: Rx-Missing
Acknowledge IT Enable
CEC_IT_LBPE: Rx Long period
Error IT Enable
CEC_IT_SBPE: Rx Short period
Error IT Enable
CEC_IT_BRE: Rx Bit Rising Error
IT Enable
CEC_IT_RXOVR: Rx Overrun IT
Enable
CEC_IT_RXEND: End Of
Reception IT Enable
CEC_IT_RXBR: Rx-Byte Received
IT Enable
Return value:
FlagStatus
__HAL_CEC_ENABLE
Description:
Enables the CEC device.
Parameters:
__HANDLE__: specifies the CEC
Handle.
Return value:
none
__HAL_CEC_DISABLE
Description:
Disables the CEC device.
128/1320
DocID026525 Rev 6
UM1785
HAL CEC Generic Driver
Parameters:
__HANDLE__: specifies the CEC
Handle.
Return value:
none
__HAL_CEC_FIRST_BYTE_TX_SET
Description:
Set Transmission Start flag.
Parameters:
__HANDLE__: specifies the CEC
Handle.
Return value:
none
__HAL_CEC_LAST_BYTE_TX_SET
Description:
Set Transmission End flag.
Parameters:
__HANDLE__: specifies the CEC
Handle.
Return value:
None If the CEC message consists of
only one byte, TXEOM must be set
before of TXSOM.
__HAL_CEC_GET_TRANSMISSION_
START_FLAG
Description:
Get Transmission Start flag.
Parameters:
__HANDLE__: specifies the CEC
Handle.
Return value:
FlagStatus
__HAL_CEC_GET_TRANSMISSION_END
_FLAG
Description:
Get Transmission End flag.
Parameters:
__HANDLE__: specifies the CEC
Handle.
Return value:
FlagStatus
__HAL_CEC_CLEAR_OAR
Description:
Clear OAR register.
DocID026525 Rev 6
129/1320
HAL CEC Generic Driver
UM1785
Parameters:
__HANDLE__: specifies the CEC
Handle.
Return value:
none
Description:
__HAL_CEC_SET_OAR
Set OAR register (without resetting
previously set address in case of multiaddress mode) To reset OAR,
Parameters:
__HANDLE__: specifies the CEC
Handle.
__ADDRESS__: Own Address value
(CEC logical address is identified by bit
position)
Return value:
none
CEC Flags definition
CEC_FLAG_TXACKE
CEC_FLAG_TXERR
CEC_FLAG_TXUDR
CEC_FLAG_TXEND
CEC_FLAG_TXBR
CEC_FLAG_ARBLST
CEC_FLAG_RXACKE
CEC_FLAG_LBPE
CEC_FLAG_SBPE
CEC_FLAG_BRE
CEC_FLAG_RXOVR
CEC_FLAG_RXEND
CEC_FLAG_RXBR
CEC all RX errors interrupts enabling flag
CEC_IER_RX_ALL_ERR
CEC all TX errors interrupts enabling flag
CEC_IER_TX_ALL_ERR
CEC Initiator logical address position in message header
CEC_INITIATOR_LSB_POS
130/1320
DocID026525 Rev 6
UM1785
HAL CEC Generic Driver
CEC Interrupts definition
CEC_IT_TXACKE
CEC_IT_TXERR
CEC_IT_TXUDR
CEC_IT_TXEND
CEC_IT_TXBR
CEC_IT_ARBLST
CEC_IT_RXACKE
CEC_IT_LBPE
CEC_IT_SBPE
CEC_IT_BRE
CEC_IT_RXOVR
CEC_IT_RXEND
CEC_IT_RXBR
CEC Error Bit Generation if Long Bit Period Error reported
CEC_LBPE_ERRORBIT_NO_GENERATION
CEC_LBPE_ERRORBIT_GENERATION
CEC Listening mode option
CEC_REDUCED_LISTENING_MODE
CEC_FULL_LISTENING_MODE
CEC Device Own Address position in CEC CFGR register
CEC_CFGR_OAR_LSB_POS
CEC Own Address
CEC_OWN_ADDRESS_NONE
CEC_OWN_ADDRESS_0
CEC_OWN_ADDRESS_1
CEC_OWN_ADDRESS_2
CEC_OWN_ADDRESS_3
CEC_OWN_ADDRESS_4
CEC_OWN_ADDRESS_5
CEC_OWN_ADDRESS_6
CEC_OWN_ADDRESS_7
CEC_OWN_ADDRESS_8
CEC_OWN_ADDRESS_9
CEC_OWN_ADDRESS_10
CEC_OWN_ADDRESS_11
DocID026525 Rev 6
131/1320
HAL CEC Generic Driver
CEC_OWN_ADDRESS_12
UM1785
CEC_OWN_ADDRESS_13
CEC_OWN_ADDRESS_14
CEC Signal Free Time start option
CEC_SFT_START_ON_TXSOM
CEC_SFT_START_ON_TX_RX_END
CEC Signal Free Time setting parameter
CEC_DEFAULT_SFT
CEC_0_5_BITPERIOD_SFT
CEC_1_5_BITPERIOD_SFT
CEC_2_5_BITPERIOD_SFT
CEC_3_5_BITPERIOD_SFT
CEC_4_5_BITPERIOD_SFT
CEC_5_5_BITPERIOD_SFT
CEC_6_5_BITPERIOD_SFT
CEC Receiver Tolerance
CEC_STANDARD_TOLERANCE
CEC_EXTENDED_TOLERANCE
132/1320
DocID026525 Rev 6
UM1785
HAL COMP Generic Driver
10
HAL COMP Generic Driver
10.1
COMP Firmware driver registers structures
10.1.1
COMP_InitTypeDef
Data Fields
uint32_t InvertingInput
uint32_t NonInvertingInput
uint32_t Output
uint32_t OutputPol
uint32_t Hysteresis
uint32_t Mode
uint32_t WindowMode
uint32_t TriggerMode
Field Documentation
uint32_t COMP_InitTypeDef::InvertingInput
Selects the inverting input of the comparator. This parameter can be a value of
COMP_InvertingInput
uint32_t COMP_InitTypeDef::NonInvertingInput
Selects the non inverting input of the comparator. This parameter can be a value of
COMP_NonInvertingInput
uint32_t COMP_InitTypeDef::Output
Selects the output redirection of the comparator. This parameter can be a value of
COMP_Output
uint32_t COMP_InitTypeDef::OutputPol
Selects the output polarity of the comparator. This parameter can be a value of
COMP_OutputPolarity
uint32_t COMP_InitTypeDef::Hysteresis
Selects the hysteresis voltage of the comparator. This parameter can be a value of
COMP_Hysteresis
uint32_t COMP_InitTypeDef::Mode
Selects the operating comsumption mode of the comparator to adjust the
speed/consumption. This parameter can be a value of COMP_Mode
uint32_t COMP_InitTypeDef::WindowMode
Selects the window mode of the comparator 1 & 2. This parameter can be a value of
COMP_WindowMode
uint32_t COMP_InitTypeDef::TriggerMode
Selects the trigger mode of the comparator (interrupt mode). This parameter can be a
value of COMP_TriggerMode
10.1.2
COMP_HandleTypeDef
Data Fields
COMP_TypeDef * Instance
COMP_InitTypeDef Init
HAL_LockTypeDef Lock
__IO uint32_t State
Field Documentation
DocID026525 Rev 6
133/1320
HAL COMP Generic Driver
UM1785
COMP_TypeDef* COMP_HandleTypeDef::Instance
Register base address
COMP_InitTypeDef COMP_HandleTypeDef::Init
COMP required parameters
HAL_LockTypeDef COMP_HandleTypeDef::Lock
Locking object
__IO uint32_t COMP_HandleTypeDef::State
COMP communication state This parameter can be a value of COMP_State
10.2
COMP Firmware driver API description
10.2.1
COMP Peripheral features
The STM32F0xx device family integrates up to 2 analog comparators COMP1 and
COMP2:
The non inverting input and inverting input can be set to GPIO pins.
The COMP output is available using HAL_COMP_GetOutputLevel() and can be set on
GPIO pins.
The COMP output can be redirected to embedded timers (TIM1, TIM2 and TIM3).
The comparators COMP1 and COMP2 can be combined in window mode.
The comparators have interrupt capability with wake-up from Sleep and Stop modes
(through the EXTI controller):
COMP1 is internally connected to EXTI Line 21
COMP2 is internally connected to EXTI Line 22
From the corresponding IRQ handler, the right interrupt source can be retrieved with
the macros __HAL_COMP_COMP1_EXTI_GET_FLAG() and
__HAL_COMP_COMP2_EXTI_GET_FLAG().
10.2.2
How to use this driver
This driver provides functions to configure and program the Comparators of STM32F05x,
STM32F07x and STM32F09x devices. To use the comparator, perform the following steps:
1.
2.
3.
134/1320
Fill in the HAL_COMP_MspInit() to
Configure the comparator input in analog mode using HAL_GPIO_Init()
Configure the comparator output in alternate function mode using
HAL_GPIO_Init() to map the comparator output to the GPIO pin
If required enable the COMP interrupt by configuring and enabling EXTI line in
Interrupt mode and selecting the desired sensitivity level using HAL_GPIO_Init()
function. After that enable the comparator interrupt vector using
HAL_NVIC_EnableIRQ() function.
Configure the comparator using HAL_COMP_Init() function:
Select the inverting input (input minus)
Select the non inverting input (input plus)
Select the output polarity
Select the output redirection
Select the hysteresis level
Select the power mode
Select the event/interrupt mode
Select the window mode HAL_COMP_Init() calls internally
__HAL_RCC_SYSCFG_CLK_ENABLE() in order to access the comparator(s)
registers.
Enable the comparator using HAL_COMP_Start() function or HAL_COMP_Start_IT()
function for interrupt mode.
DocID026525 Rev 6
UM1785
4.
5.
6.
7.
10.2.3
HAL COMP Generic Driver
Use HAL_COMP_TriggerCallback() and/or HAL_COMP_GetOutputLevel() functions
to manage comparator outputs (event/interrupt triggered and output level).
Disable the comparator using HAL_COMP_Stop() or HAL_COMP_Stop_IT() function.
De-initialize the comparator using HAL_COMP_DeInit() function.
For safety purposes comparator(s) can be locked using HAL_COMP_Lock() function.
Only a MCU reset can reset that protection.
Initialization and Configuration functions
This section provides functions to initialize and de-initialize comparators
This section contains the following APIs:
HAL_COMP_Init()
HAL_COMP_DeInit()
HAL_COMP_MspInit()
HAL_COMP_MspDeInit()
10.2.4
IO operation functions
This subsection provides a set of functions allowing to manage the COMP data transfers.
This section contains the following APIs:
HAL_COMP_Start()
HAL_COMP_Stop()
HAL_COMP_Start_IT()
HAL_COMP_Stop_IT()
HAL_COMP_IRQHandler()
10.2.5
Peripheral Control functions
This subsection provides a set of functions allowing to control the COMP data transfers.
This section contains the following APIs:
HAL_COMP_Lock()
HAL_COMP_GetOutputLevel()
HAL_COMP_TriggerCallback()
10.2.6
Peripheral State functions
This subsection permit to get in run-time the status of the peripheral and the data flow.
This section contains the following APIs:
HAL_COMP_GetState()
10.2.7
Detailed description of functions
HAL_COMP_Init
Function name
HAL_StatusTypeDef HAL_COMP_Init (COMP_HandleTypeDef
* hcomp)
Function description
Initializes the COMP according to the specified parameters in the
COMP_InitTypeDef and create the associated handle.
Parameters
hcomp: COMP handle
Return values
HAL: status
DocID026525 Rev 6
135/1320
HAL COMP Generic Driver
Notes
UM1785
If the selected comparator is locked, initialization can't be
performed. To unlock the configuration, perform a system
reset.
HAL_COMP_DeInit
Function name
HAL_StatusTypeDef HAL_COMP_DeInit
(COMP_HandleTypeDef * hcomp)
Function description
DeInitializes the COMP peripheral.
Parameters
hcomp: COMP handle
Return values
HAL: status
Notes
Deinitialization can't be performed if the COMP configuration
is locked. To unlock the configuration, perform a system
reset.
HAL_COMP_MspInit
Function name
void HAL_COMP_MspInit (COMP_HandleTypeDef * hcomp)
Function description
Initializes the COMP MSP.
Parameters
hcomp: COMP handle
Return values
None
HAL_COMP_MspDeInit
Function name
void HAL_COMP_MspDeInit (COMP_HandleTypeDef * hcomp)
Function description
DeInitializes COMP MSP.
Parameters
hcomp: COMP handle
Return values
None
HAL_COMP_Start
Function name
HAL_StatusTypeDef HAL_COMP_Start
(COMP_HandleTypeDef * hcomp)
Function description
Start the comparator.
Parameters
hcomp: COMP handle
Return values
HAL: status
HAL_COMP_Stop
136/1320
Function name
HAL_StatusTypeDef HAL_COMP_Stop
(COMP_HandleTypeDef * hcomp)
Function description
Stop the comparator.
Parameters
hcomp: COMP handle
Return values
HAL: status
DocID026525 Rev 6
UM1785
HAL COMP Generic Driver
HAL_COMP_Start_IT
Function name
HAL_StatusTypeDef HAL_COMP_Start_IT
(COMP_HandleTypeDef * hcomp)
Function description
Enables the interrupt and starts the comparator.
Parameters
hcomp: COMP handle
Return values
HAL: status.
HAL_COMP_Stop_IT
Function name
HAL_StatusTypeDef HAL_COMP_Stop_IT
(COMP_HandleTypeDef * hcomp)
Function description
Disable the interrupt and Stop the comparator.
Parameters
hcomp: COMP handle
Return values
HAL: status
HAL_COMP_IRQHandler
Function name
void HAL_COMP_IRQHandler (COMP_HandleTypeDef *
hcomp)
Function description
Comparator IRQ Handler.
Parameters
hcomp: COMP handle
Return values
HAL: status
HAL_COMP_Lock
Function name
HAL_StatusTypeDef HAL_COMP_Lock
(COMP_HandleTypeDef * hcomp)
Function description
Lock the selected comparator configuration.
Parameters
hcomp: COMP handle
Return values
HAL: status
HAL_COMP_GetOutputLevel
Function name
uint32_t HAL_COMP_GetOutputLevel (COMP_HandleTypeDef
* hcomp)
Function description
Return the output level (high or low) of the selected comparator.
HAL_COMP_TriggerCallback
Function name
void HAL_COMP_TriggerCallback (COMP_HandleTypeDef *
hcomp)
Function description
Comparator callback.
Parameters
hcomp: COMP handle
Return values
None
DocID026525 Rev 6
137/1320
HAL COMP Generic Driver
UM1785
HAL_COMP_GetState
Function name
uint32_t HAL_COMP_GetState (COMP_HandleTypeDef *
hcomp)
Function description
Return the COMP state.
Parameters
hcomp: COMP handle
Return values
HAL: state
10.3
COMP Firmware driver defines
10.3.1
COMP
COMP Exported Macros
__HAL_COMP_RESET_HANDLE_STATE
Description:
Reset COMP handle state.
Parameters:
__HANDLE__: COMP handle.
Return value:
None
Description:
__HAL_COMP_ENABLE
Enable the specified comparator.
Parameters:
__HANDLE__: COMP handle.
Return value:
None
Description:
__HAL_COMP_DISABLE
Disable the specified comparator.
Parameters:
__HANDLE__: COMP handle.
Return value:
None
Description:
__HAL_COMP_LOCK
Lock the specified comparator
configuration.
Parameters:
__HANDLE__: COMP handle.
Return value:
None
138/1320
DocID026525 Rev 6
UM1785
__HAL_COMP_COMP1_EXTI_ENABLE_RISING
_EDGE
HAL COMP Generic Driver
Description:
Enable the COMP1 EXTI line
rising edge trigger.
Return value:
None
__HAL_COMP_COMP1_EXTI_DISABLE_
RISING_EDGE
Description:
Disable the COMP1 EXTI line
rising edge trigger.
Return value:
None
__HAL_COMP_COMP1_EXTI_ENABLE_
FALLING_EDGE
Description:
Enable the COMP1 EXTI line
falling edge trigger.
Return value:
None
__HAL_COMP_COMP1_EXTI_DISABLE_
FALLING_EDGE
Description:
Disable the COMP1 EXTI line
falling edge trigger.
Return value:
None
__HAL_COMP_COMP1_EXTI_ENABLE_RISING
_FALLING_EDGE
Description:
Enable the COMP1 EXTI line
rising & falling edge trigger.
Return value:
None
__HAL_COMP_COMP1_EXTI_DISABLE_
RISING_FALLING_EDGE
Description:
Disable the COMP1 EXTI line
rising & falling edge trigger.
Return value:
None
__HAL_COMP_COMP1_EXTI_ENABLE_IT
Description:
Enable the COMP1 EXTI line in
interrupt mode.
Return value:
None
__HAL_COMP_COMP1_EXTI_DISABLE_IT
Description:
Disable the COMP1 EXTI line in
interrupt mode.
DocID026525 Rev 6
139/1320
HAL COMP Generic Driver
UM1785
Return value:
None
__HAL_COMP_COMP1_EXTI_GENERATE_
SWIT
Description:
Generate a software interrupt on
the COMP1 EXTI line.
Return value:
None
__HAL_COMP_COMP1_EXTI_ENABLE_EVENT
Description:
Enable the COMP1 EXTI Line in
event mode.
Return value:
None
__HAL_COMP_COMP1_EXTI_DISABLE_EVENT
Description:
Disable the COMP1 EXTI Line in
event mode.
Return value:
None
__HAL_COMP_COMP1_EXTI_GET_FLAG
Description:
Check whether the COMP1 EXTI
line flag is set or not.
Return value:
RESET: or SET
__HAL_COMP_COMP1_EXTI_CLEAR_FLAG
Description:
Clear the COMP1 EXTI flag.
Return value:
None
__HAL_COMP_COMP2_EXTI_ENABLE_RISING
_EDGE
Description:
Enable the COMP2 EXTI line
rising edge trigger.
Return value:
None
__HAL_COMP_COMP2_EXTI_DISABLE_
RISING_EDGE
Description:
Disable the COMP2 EXTI line
rising edge trigger.
Return value:
None
140/1320
DocID026525 Rev 6
UM1785
__HAL_COMP_COMP2_EXTI_ENABLE_
FALLING_EDGE
HAL COMP Generic Driver
Description:
Enable the COMP2 EXTI line
falling edge trigger.
Return value:
None
__HAL_COMP_COMP2_EXTI_DISABLE_
FALLING_EDGE
Description:
Disable the COMP2 EXTI line
falling edge trigger.
Return value:
None
__HAL_COMP_COMP2_EXTI_ENABLE_RISING
_FALLING_EDGE
Description:
Enable the COMP2 EXTI line
rising & falling edge trigger.
Return value:
None
__HAL_COMP_COMP2_EXTI_DISABLE_
RISING_FALLING_EDGE
Description:
Disable the COMP2 EXTI line
rising & falling edge trigger.
Return value:
None
__HAL_COMP_COMP2_EXTI_ENABLE_IT
Description:
Enable the COMP2 EXTI line in
interrupt mode.
Return value:
None
__HAL_COMP_COMP2_EXTI_DISABLE_IT
Description:
Disable the COMP2 EXTI line in
interrupt mode.
Return value:
None
__HAL_COMP_COMP2_EXTI_GENERATE_
SWIT
Description:
Generate a software interrupt on
the COMP2 EXTI line.
Return value:
None
__HAL_COMP_COMP2_EXTI_ENABLE_EVENT
Description:
Enable the COMP2 EXTI Line in
event mode.
DocID026525 Rev 6
141/1320
HAL COMP Generic Driver
UM1785
Return value:
None
__HAL_COMP_COMP2_EXTI_DISABLE_EVENT
Description:
Disable the COMP2 EXTI Line in
event mode.
Return value:
None
__HAL_COMP_COMP2_EXTI_GET_FLAG
Description:
Check whether the COMP2 EXTI
line flag is set or not.
Return value:
RESET: or SET
__HAL_COMP_COMP2_EXTI_CLEAR_FLAG
Description:
Clear the COMP2 EXTI flag.
Return value:
None
Description:
__HAL_COMP_GET_FLAG
Check whether the specified
COMP flag is set or not.
Parameters:
__HANDLE__: specifies the
COMP Handle.
__FLAG__: specifies the flag to
check. This parameter can be
one of the following values:
COMP_FLAG_LOCK: lock
flag
Return value:
The: new state of __FLAG__
(TRUE or FALSE).
COMP EXTI Lines
COMP_EXTI_LINE_COMP1
EXTI line 21 connected to COMP1 output
COMP_EXTI_LINE_COMP2
EXTI line 22 connected to COMP2 output
COMP Flag
COMP_FLAG_LOCK
142/1320
Lock flag
DocID026525 Rev 6
UM1785
HAL COMP Generic Driver
COMP Private macros to get EXTI line associated with Comparators
COMP_GET_EXTI_LINE
Description:
Get the specified EXTI line for a comparator instance.
Parameters:
__INSTANCE__: specifies the COMP instance.
Return value:
value: of
COMP Hysteresis
COMP_HYSTERESIS_NONE
No hysteresis
COMP_HYSTERESIS_LOW
Hysteresis level low
COMP_HYSTERESIS_MEDIUM
Hysteresis level medium
COMP_HYSTERESIS_HIGH
Hysteresis level high
COMP InvertingInput
COMP_INVERTINGINPUT_1_4VREFINT
1/4 VREFINT connected to
comparator inverting input
COMP_INVERTINGINPUT_1_2VREFINT
1/2 VREFINT connected to
comparator inverting input
COMP_INVERTINGINPUT_3_4VREFINT
3/4 VREFINT connected to
comparator inverting input
COMP_INVERTINGINPUT_VREFINT
VREFINT connected to comparator
inverting input
COMP_INVERTINGINPUT_DAC1
DAC_OUT1 (PA4) connected to
comparator inverting input
COMP_INVERTINGINPUT_DAC1SWITCHCLOSED
DAC_OUT1 (PA4) connected to
comparator inverting input and
close switch (PA0 for COMP1 only)
COMP_INVERTINGINPUT_DAC2
DAC_OUT2 (PA5) connected to
comparator inverting input
COMP_INVERTINGINPUT_IO1
IO (PA0 for COMP1 and PA2 for
COMP2) connected to comparator
inverting input
COMP Private macros to check input parameters
IS_COMP_OUTPUTPOL
IS_COMP_HYSTERESIS
IS_COMP_MODE
IS_COMP_INVERTINGINPUT
IS_COMP_NONINVERTINGINPUT
IS_COMP_OUTPUT
IS_COMP_WINDOWMODE
IS_COMP_TRIGGERMODE
DocID026525 Rev 6
143/1320
HAL COMP Generic Driver
COMP Lock
UM1785
COMP_LOCK_DISABLE
COMP_LOCK_ENABLE
COMP_STATE_BIT_LOCK
COMP Mode
COMP_MODE_HIGHSPEED
High Speed
COMP_MODE_MEDIUMSPEED
Medium Speed
COMP_MODE_LOWPOWER
Low power mode
COMP_MODE_ULTRALOWPOWER
Ultra-low power mode
COMP NonInvertingInput
COMP_NONINVERTINGINPUT_IO1
I/O1 (PA1 for COMP1, PA3 for
COMP2) connected to
comparator non inverting input
COMP_NONINVERTINGINPUT_DAC1SWITCHCLOSED
DAC ouput connected to
comparator COMP1 non
inverting input
COMP Output
COMP_OUTPUT_NONE
COMP output isn't connected to other peripherals
COMP_OUTPUT_TIM1BKIN
COMP output connected to TIM1 Break Input (BKIN)
COMP_OUTPUT_TIM1IC1
COMP output connected to TIM1 Input Capture 1
COMP_OUTPUT_TIM1OCREFCLR
COMP output connected to TIM1 OCREF Clear
COMP_OUTPUT_TIM2IC4
COMP output connected to TIM2 Input Capture 4
COMP_OUTPUT_TIM2OCREFCLR
COMP output connected to TIM2 OCREF Clear
COMP_OUTPUT_TIM3IC1
COMP output connected to TIM3 Input Capture 1
COMP_OUTPUT_TIM3OCREFCLR
COMP output connected to TIM3 OCREF Clear
COMP OutputLevel
COMP_OUTPUTLEVEL_LOW
COMP_OUTPUTLEVEL_HIGH
COMP OutputPolarity
COMP_OUTPUTPOL_NONINVERTED
COMP output on GPIO isn't inverted
COMP_OUTPUTPOL_INVERTED
COMP output on GPIO is inverted
COMP State
144/1320
HAL_COMP_STATE_RESET
COMP not yet initialized or disabled
HAL_COMP_STATE_READY
COMP initialized and ready for use
HAL_COMP_STATE_READY_LOCKED
COMP initialized but the configuration is locked
HAL_COMP_STATE_BUSY
COMP is running
HAL_COMP_STATE_BUSY_LOCKED
COMP is running and the configuration is
locked
DocID026525 Rev 6
UM1785
HAL COMP Generic Driver
COMP TriggerMode
COMP_TRIGGERMODE_NONE
No External Interrupt trigger
detection
COMP_TRIGGERMODE_IT_RISING
External Interrupt Mode with Rising
edge trigger detection
COMP_TRIGGERMODE_IT_FALLING
External Interrupt Mode with
Falling edge trigger detection
COMP_TRIGGERMODE_IT_RISING_FALLING
External Interrupt Mode with
Rising/Falling edge trigger
detection
COMP_TRIGGERMODE_EVENT_RISING
Event Mode with Rising edge
trigger detection
COMP_TRIGGERMODE_EVENT_FALLING
Event Mode with Falling edge
trigger detection
COMP_TRIGGERMODE_EVENT_RISING_FALLING
Event Mode with Rising/Falling
edge trigger detection
COMP WindowMode
COMP_WINDOWMODE_DISABLE
Window mode disabled
COMP_WINDOWMODE_ENABLE
Window mode enabled: non inverting input of
comparator 2 is connected to the non inverting input
of comparator 1 (PA1)
DocID026525 Rev 6
145/1320
HAL CORTEX Generic Driver
UM1785
11
HAL CORTEX Generic Driver
11.1
CORTEX Firmware driver API description
11.1.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-M0 exceptions are managed by CMSIS functions.
1.
2.
3.
Enable and Configure the priority of the selected IRQ Channels. The priority can be
0..3. Lower priority values gives higher priority. Priority Order: Lowest priority.Lowest
hardware priority (IRQn position).
Configure the priority of the selected IRQ Channels using HAL_NVIC_SetPriority()
Enable the selected IRQ Channels using HAL_NVIC_EnableIRQ() Negative value of
IRQn_Type are not allowed.
How to configure Systick using CORTEX HAL driver
Setup SysTick Timer for time base.
The HAL_SYSTICK_Config()function calls the SysTick_Config() function which is a
CMSIS function that:
Configures the SysTick Reload register with value passed as function parameter.
Configures the SysTick IRQ priority to the lowest value (0x03).
Resets the SysTick Counter register.
Configures the SysTick Counter clock source to be Core Clock Source (HCLK).
Enables the SysTick Interrupt.
Starts the SysTick Counter.
You can change the SysTick Clock source to be HCLK_Div8 by calling the macro
HAL_SYSTICK_CLKSourceConfig(SYSTICK_CLKSOURCE_HCLK_DIV8) just after
the HAL_SYSTICK_Config() function call. The HAL_SYSTICK_CLKSourceConfig()
macro is defined inside the stm32f0xx_hal_cortex.h file.
You can change the SysTick IRQ priority by calling the
HAL_NVIC_SetPriority(SysTick_IRQn,...) function just after the
HAL_SYSTICK_Config() function call. The HAL_NVIC_SetPriority() call the
NVIC_SetPriority() function which is a CMSIS function.
To adjust the SysTick time base, use the following formula: Reload Value = SysTick
Counter Clock (Hz) x Desired Time base (s)
Reload Value is the parameter to be passed for HAL_SYSTICK_Config() function
Reload Value should not exceed 0xFFFFFF
11.1.2
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:
HAL_NVIC_SetPriority()
146/1320
DocID026525 Rev 6
UM1785
HAL CORTEX Generic Driver
HAL_NVIC_EnableIRQ()
HAL_NVIC_DisableIRQ()
HAL_NVIC_SystemReset()
HAL_SYSTICK_Config()
11.1.3
Peripheral Control functions
This subsection provides a set of functions allowing to control the CORTEX (NVIC,
SYSTICK) functionalities.
This section contains the following APIs:
HAL_NVIC_GetPriority()
HAL_NVIC_SetPendingIRQ()
HAL_NVIC_GetPendingIRQ()
HAL_NVIC_ClearPendingIRQ()
HAL_SYSTICK_CLKSourceConfig()
HAL_SYSTICK_IRQHandler()
HAL_SYSTICK_Callback()
11.1.4
Detailed description of functions
HAL_NVIC_SetPriority
Function name
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
stm32f0xx.h file)
PreemptPriority: The preemption priority for the IRQn
channel. This parameter can be a value between 0 and 3. A
lower priority value indicates a higher priority
SubPriority: the subpriority level for the IRQ channel. with
stm32f0xx devices, this parameter is a dummy value and it is
ignored, because no subpriority supported in Cortex M0
based products.
Return values
None
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 (stm32f0xxxx.h))
Return values
None
Notes
To configure interrupts priority correctly, the
NVIC_PriorityGroupConfig() function should be called before.
DocID026525 Rev 6
147/1320
HAL CORTEX Generic Driver
UM1785
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 (stm32f0xxxx.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
Tick Timer.
Parameters
TicksNumb: Specifies the ticks Number of ticks between two
interrupts.
Return values
status: - 0 Function succeeded.
1 Function failed.
HAL_NVIC_GetPriority
Function name
uint32_t HAL_NVIC_GetPriority (IRQn_Type IRQn)
Function description
Gets 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 (stm32f0xxxx.h))
Return values
None
HAL_NVIC_GetPendingIRQ
148/1320
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 (stm32f0xxxx.h))
Return values
status: - 0 Interrupt status is not pending.
1 Interrupt status is pending.
DocID026525 Rev 6
UM1785
HAL CORTEX Generic Driver
HAL_NVIC_SetPendingIRQ
Function name
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 (stm32f0xxxx.h))
Return values
None
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 (stm32f0xxxx.h))
Return values
None
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
parameter can be one of the following values:
SYSTICK_CLKSOURCE_HCLK_DIV8: AHB clock
divided by 8 selected as SysTick clock source.
SYSTICK_CLKSOURCE_HCLK: AHB clock selected as
SysTick clock source.
Return values
None
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
DocID026525 Rev 6
149/1320
HAL CORTEX Generic Driver
UM1785
11.2
CORTEX Firmware driver defines
11.2.1
CORTEX
CORTEX SysTick clock source
SYSTICK_CLKSOURCE_HCLK_DIV8
SYSTICK_CLKSOURCE_HCLK
150/1320
DocID026525 Rev 6
UM1785
HAL CRC Generic Driver
12
HAL CRC Generic Driver
12.1
CRC Firmware driver registers structures
12.1.1
CRC_InitTypeDef
Data Fields
uint8_t DefaultPolynomialUse
uint8_t DefaultInitValueUse
uint32_t GeneratingPolynomial
uint32_t CRCLength
uint32_t InitValue
uint32_t InputDataInversionMode
uint32_t OutputDataInversionMode
Field Documentation
uint8_t CRC_InitTypeDef::DefaultPolynomialUse
This parameter is a value of CRC_Default_Polynomial and indicates if default
polynomial is used. If set to DEFAULT_POLYNOMIAL_ENABLE, resort to default
X^32 + X^26 + X^23 + X^22 + X^16 + X^12 + X^11 + X^10 +X^8 + X^7 + X^5 + X^4 +
X^2+ X +1. In that case, there is no need to set GeneratingPolynomial field. If
otherwise set to DEFAULT_POLYNOMIAL_DISABLE, GeneratingPolynomial and
CRCLength fields must be set
uint8_t CRC_InitTypeDef::DefaultInitValueUse
This parameter is a value of CRC_Default_InitValue_Use and indicates if default init
value is used. If set to DEFAULT_INIT_VALUE_ENABLE, resort to default
0xFFFFFFFF value. In that case, there is no need to set InitValue field. If otherwise
set to DEFAULT_INIT_VALUE_DISABLE, InitValue field must be set
uint32_t CRC_InitTypeDef::GeneratingPolynomial
Set CRC generating polynomial. 7, 8, 16 or 32-bit long value for a polynomial degree
respectively equal to 7, 8, 16 or 32. This field is written in normal representation, e.g.,
for a polynomial of degree 7, X^7 + X^6 + X^5 + X^2 + 1 is written 0x65. No need to
specify it if DefaultPolynomialUse is set to DEFAULT_POLYNOMIAL_ENABLE
uint32_t CRC_InitTypeDef::CRCLength
This parameter is a value of CRCEx_Polynomial_Sizes and indicates CRC length.
Value can be either one of CRC_POLYLENGTH_32B (32-bit CRC)
CRC_POLYLENGTH_16B (16-bit CRC) CRC_POLYLENGTH_8B (8-bit CRC)
CRC_POLYLENGTH_7B (7-bit CRC)
uint32_t CRC_InitTypeDef::InitValue
Init value to initiate CRC computation. No need to specify it if DefaultInitValueUse is
set to DEFAULT_INIT_VALUE_ENABLE
uint32_t CRC_InitTypeDef::InputDataInversionMode
This parameter is a value of CRCEx_Input_Data_Inversion and specifies input data
inversion mode. Can be either one of the following values
CRC_INPUTDATA_INVERSION_NONE no input data inversion
CRC_INPUTDATA_INVERSION_BYTE byte-wise inversion, 0x1A2B3C4D becomes
0x58D43CB2 CRC_INPUTDATA_INVERSION_HALFWORD halfword-wise inversion,
0x1A2B3C4D becomes 0xD458B23C CRC_INPUTDATA_INVERSION_WORD wordwise inversion, 0x1A2B3C4D becomes 0xB23CD458
uint32_t CRC_InitTypeDef::OutputDataInversionMode
This parameter is a value of CRCEx_Output_Data_Inversion and specifies output
DocID026525 Rev 6
151/1320
HAL CRC Generic Driver
UM1785
data (i.e. CRC) inversion mode. Can be either
CRC_OUTPUTDATA_INVERSION_DISABLE no CRC inversion, or
CRC_OUTPUTDATA_INVERSION_ENABLE CRC 0x11223344 is converted into
0x22CC4488
12.1.2
CRC_HandleTypeDef
Data Fields
CRC_TypeDef * Instance
CRC_InitTypeDef Init
HAL_LockTypeDef Lock
__IO HAL_CRC_StateTypeDef State
uint32_t InputDataFormat
Field Documentation
CRC_TypeDef* CRC_HandleTypeDef::Instance
Register base address
CRC_InitTypeDef CRC_HandleTypeDef::Init
CRC configuration parameters
HAL_LockTypeDef CRC_HandleTypeDef::Lock
CRC Locking object
__IO HAL_CRC_StateTypeDef CRC_HandleTypeDef::State
CRC communication state
uint32_t CRC_HandleTypeDef::InputDataFormat
This parameter is a value of CRC_Input_Buffer_Format and specifies input data
format. Can be either CRC_INPUTDATA_FORMAT_BYTES input data is a stream of
bytes (8-bit data) CRC_INPUTDATA_FORMAT_HALFWORDS input data is a stream
of half-words (16-bit data) CRC_INPUTDATA_FORMAT_WORDS input data is a
stream of words (32-bits data) Note that constant
CRC_INPUT_FORMAT_UNDEFINED is defined but an initialization error must occur
if InputBufferFormat is not one of the three values listed above
12.2
CRC Firmware driver API description
12.2.1
How to use this driver
Enable CRC AHB clock using __HAL_RCC_CRC_CLK_ENABLE();
Initialize CRC calculator
specify generating polynomial (IP default or non-default one)
specify initialization value (IP default or non-default one)
specify input data format
specify input or output data inversion mode if any
Use HAL_CRC_Accumulate() function to compute the CRC value of the input data
buffer starting with the previously computed CRC as initialization value
Use HAL_CRC_Calculate() function to compute the CRC value of the input data buffer
starting with the defined initialization value (default or non-default) to initiate CRC
calculation
12.2.2
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
152/1320
DocID026525 Rev 6
UM1785
HAL CRC Generic Driver
Initialize the CRC MSP (MCU Specific Package)
DeInitialize the CRC MSP
This section contains the following APIs:
HAL_CRC_Init()
HAL_CRC_DeInit()
HAL_CRC_MspInit()
HAL_CRC_MspDeInit()
12.2.3
Peripheral Control functions
This section provides functions allowing to:
compute the 7U, 8U, 16 or 32-bit CRC value of an 8U, 16 or 32-bit data buffer using
the combination of the previous CRC value and the new one
or
compute the 7U, 8U, 16 or 32-bit CRC value of an 8U, 16 or 32-bit data buffer
independently of the previous CRC value.
This section contains the following APIs:
HAL_CRC_Accumulate()
HAL_CRC_Calculate()
12.2.4
Peripheral State functions
This subsection permits to get in run-time the status of the peripheral.
This section contains the following APIs:
HAL_CRC_GetState()
12.2.5
Detailed description of functions
HAL_CRC_Init
Function name
HAL_StatusTypeDef HAL_CRC_Init (CRC_HandleTypeDef *
hcrc)
Function description
Initialize the CRC according to the specified parameters in the
CRC_InitTypeDef and initialize the associated handle.
Parameters
hcrc: CRC handle
Return values
HAL: status
HAL_CRC_DeInit
Function name
HAL_StatusTypeDef HAL_CRC_DeInit (CRC_HandleTypeDef *
hcrc)
Function description
DeInitialize the CRC peripheral.
Parameters
hcrc: CRC handle
Return values
HAL: status
DocID026525 Rev 6
153/1320
HAL CRC Generic Driver
UM1785
HAL_CRC_MspInit
Function name
void HAL_CRC_MspInit (CRC_HandleTypeDef * hcrc)
Function description
Initializes the CRC MSP.
Parameters
hcrc: CRC handle
Return values
None
HAL_CRC_MspDeInit
Function name
void HAL_CRC_MspDeInit (CRC_HandleTypeDef * hcrc)
Function description
DeInitialize the CRC MSP.
Parameters
hcrc: CRC handle
Return values
None
HAL_CRC_Accumulate
Function name
uint32_t HAL_CRC_Accumulate (CRC_HandleTypeDef * hcrc,
uint32_t pBuffer, uint32_t BufferLength)
Function description
Compute the 7, 8, 16 or 32-bit CRC value of an 8, 16 or 32-bit data
buffer starting with the previously computed CRC as initialization
value.
Parameters
hcrc: CRC handle
pBuffer: pointer to the input data buffer, exact input data
format is provided by hcrc->InputDataFormat.
BufferLength: input data buffer length (number of bytes if
pBuffer type is * uint8_t, number of half-words if pBuffer type
is * uint16_t, number of words if pBuffer type is * uint32_t).
Return values
uint32_t: CRC (returned value LSBs for CRC shorter than 32
bits)
Notes
By default, the API expects a uint32_t pointer as input buffer
parameter. Input buffer pointers with other types simply need
to be cast in uint32_t and the API will internally adjust its input
data processing based on the handle field hcrc>InputDataFormat.
HAL_CRC_Calculate
Function name
uint32_t HAL_CRC_Calculate (CRC_HandleTypeDef * hcrc,
uint32_t pBuffer, uint32_t BufferLength)
Function description
Compute the 7, 8, 16 or 32-bit CRC value of an 8, 16 or 32-bit data
buffer starting with hcrc->Instance->INIT as initialization value.
Parameters
154/1320
hcrc: CRC handle
pBuffer: pointer to the input data buffer, exact input data
format is provided by hcrc->InputDataFormat.
BufferLength: input data buffer length (number of bytes if
pBuffer type is * uint8_t, number of half-words if pBuffer type
is * uint16_t, number of words if pBuffer type is * uint32_t).
DocID026525 Rev 6
UM1785
HAL CRC Generic Driver
Return values
uint32_t: CRC (returned value LSBs for CRC shorter than 32
bits)
Notes
By default, the API expects a uint32_t pointer as input buffer
parameter. Input buffer pointers with other types simply need
to be cast in uint32_t and the API will internally adjust its input
data processing based on the handle field hcrc>InputDataFormat.
HAL_CRC_GetState
Function name
HAL_CRC_StateTypeDef HAL_CRC_GetState
(CRC_HandleTypeDef * hcrc)
Function description
Return the CRC handle state.
Parameters
hcrc: CRC handle
Return values
HAL: state
12.3
CRC Firmware driver defines
12.3.1
CRC
Aliases for inter STM32 series compatibility
HAL_CRC_Input_Data_Reverse
HAL_CRC_Output_Data_Reverse
Default CRC computation initialization value
DEFAULT_CRC_INITVALUE
Indicates whether or not default init value is used
DEFAULT_INIT_VALUE_ENABLE
DEFAULT_INIT_VALUE_DISABLE
IS_DEFAULT_INIT_VALUE
Indicates whether or not default polynomial is used
DEFAULT_POLYNOMIAL_ENABLE
DEFAULT_POLYNOMIAL_DISABLE
IS_DEFAULT_POLYNOMIAL
Default CRC generating polynomial
DEFAULT_CRC32_POLY
CRC Exported Macros
__HAL_CRC_RESET_HANDLE_STATE
Description:
Reset CRC handle state.
Parameters:
__HANDLE__: CRC handle.
DocID026525 Rev 6
155/1320
HAL CRC Generic Driver
UM1785
Return value:
None
Description:
__HAL_CRC_DR_RESET
Reset CRC Data Register.
Parameters:
__HANDLE__: CRC handle
Return value:
None.
__HAL_CRC_INITIALCRCVALUE_CONFIG
Description:
Set CRC INIT non-default value.
Parameters:
__HANDLE__: CRC handle
__INIT__: 32-bit initial value
Return value:
None.
Description:
__HAL_CRC_SET_IDR
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:
None
Description:
__HAL_CRC_GET_IDR
Returns the 8-bit data stored in the
Independent Data(ID) register.
Parameters:
__HANDLE__: CRC handle
Return value:
8-bit: value of the ID register
Input Buffer Format
CRC_INPUTDATA_FORMAT_UNDEFINED
CRC_INPUTDATA_FORMAT_BYTES
CRC_INPUTDATA_FORMAT_HALFWORDS
CRC_INPUTDATA_FORMAT_WORDS
IS_CRC_INPUTDATA_FORMAT
156/1320
DocID026525 Rev 6
UM1785
HAL CRC Extension Driver
13
HAL CRC Extension Driver
13.1
CRCEx Firmware driver API description
13.1.1
How to use this driver
Extended initialization
Set or not user-defined generating polynomial other than default one
13.1.2
Initialization and Configuration functions
This section provides functions allowing to:
Initialize the CRC generating polynomial: if programmable polynomial feature is
applicable to device, set default or non-default generating polynomial according to
hcrc->Init.DefaultPolynomialUse parameter. If feature is non-applicable to device in
use, HAL_CRCEx_Init straight away reports HAL_OK.
Set the generating polynomial
This section contains the following APIs:
HAL_CRCEx_Init()
HAL_CRCEx_Input_Data_Reverse()
HAL_CRCEx_Output_Data_Reverse()
HAL_CRCEx_Polynomial_Set()
13.1.3
Detailed description of functions
HAL_CRCEx_Init
Function name
HAL_StatusTypeDef HAL_CRCEx_Init (CRC_HandleTypeDef *
hcrc)
Function description
Extended initialization to set generating polynomial.
Parameters
hcrc: CRC handle
Return values
HAL: status
HAL_CRCEx_Input_Data_Reverse
Function name
HAL_StatusTypeDef HAL_CRCEx_Input_Data_Reverse
(CRC_HandleTypeDef * hcrc, uint32_t InputReverseMode)
Function description
Set the Reverse Input data mode.
Parameters
hcrc: CRC handle
InputReverseMode: Input Data inversion mode This
parameter can be one of the following values:
CRC_INPUTDATA_NOINVERSION: no change in bit
order (default value)
CRC_INPUTDATA_INVERSION_BYTE: Byte-wise bit
reversal
CRC_INPUTDATA_INVERSION_HALFWORD:
HalfWord-wise bit reversal
CRC_INPUTDATA_INVERSION_WORD: Word-wise bit
DocID026525 Rev 6
157/1320
HAL CRC Extension Driver
UM1785
reversal
Return values
HAL: status
HAL_CRCEx_Output_Data_Reverse
Function name
HAL_StatusTypeDef HAL_CRCEx_Output_Data_Reverse
(CRC_HandleTypeDef * hcrc, uint32_t OutputReverseMode)
Function description
Set the Reverse Output data mode.
Parameters
hcrc: CRC handle
OutputReverseMode: Output Data inversion mode This
parameter can be one of the following values:
CRC_OUTPUTDATA_INVERSION_DISABLE: no CRC
inversion (default value)
CRC_OUTPUTDATA_INVERSION_ENABLE: bit-level
inversion (e.g for a 8-bit CRC: 0xB5 becomes 0xAD)
Return values
HAL: status
HAL_CRCEx_Polynomial_Set
158/1320
Function name
HAL_StatusTypeDef HAL_CRCEx_Polynomial_Set
(CRC_HandleTypeDef * hcrc, uint32_t Pol, uint32_t
PolyLength)
Function description
Initializes the CRC polynomial if different from default one.
Parameters
hcrc: CRC handle
Pol: CRC generating polynomial (7, 8, 16 or 32-bit long) This
parameter is written in normal representation, e.g. for a
polynomial of degree 7, X^7 + X^6 + X^5 + X^2 + 1 is written
0x65 for a polynomial of degree 16, X^16 + X^12 + X^5 + 1 is
written 0x1021
PolyLength: CRC polynomial length This parameter can be
one of the following values:
CRC_POLYLENGTH_7B: 7-bit long CRC (generating
polynomial of degree 7)
CRC_POLYLENGTH_8B: 8-bit long CRC (generating
polynomial of degree 8)
CRC_POLYLENGTH_16B: 16-bit long CRC (generating
polynomial of degree 16)
CRC_POLYLENGTH_32B: 32-bit long CRC (generating
polynomial of degree 32)
Return values
HAL: status
DocID026525 Rev 6
UM1785
HAL CRC Extension Driver
13.2
CRCEx Firmware driver defines
13.2.1
CRCEx
CRCEx Exported Macros
__HAL_CRC_OUTPUTREVERSAL_ENABLE
Description:
Set CRC output reversal.
Parameters:
__HANDLE__: CRC handle
Return value:
None.
__HAL_CRC_OUTPUTREVERSAL_DISABLE
Description:
Unset CRC output reversal.
Parameters:
__HANDLE__: CRC handle
Return value:
None.
__HAL_CRC_POLYNOMIAL_CONFIG
Description:
Set CRC non-default polynomial.
Parameters:
__HANDLE__: CRC handle
__POLYNOMIAL__: 7, 8, 16 or 32-bit
polynomial
Return value:
None.
Input Data Inversion Modes
CRC_INPUTDATA_INVERSION_NONE
CRC_INPUTDATA_INVERSION_BYTE
CRC_INPUTDATA_INVERSION_HALFWORD
CRC_INPUTDATA_INVERSION_WORD
IS_CRC_INPUTDATA_INVERSION_MODE
Output Data Inversion Modes
CRC_OUTPUTDATA_INVERSION_DISABLE
CRC_OUTPUTDATA_INVERSION_ENABLE
IS_CRC_OUTPUTDATA_INVERSION_MODE
Polynomial sizes to configure the IP
CRC_POLYLENGTH_32B
CRC_POLYLENGTH_16B
DocID026525 Rev 6
159/1320
HAL CRC Extension Driver
CRC_POLYLENGTH_8B
UM1785
CRC_POLYLENGTH_7B
IS_CRC_POL_LENGTH
CRC polynomial possible sizes actual definitions
HAL_CRC_LENGTH_32B
HAL_CRC_LENGTH_16B
HAL_CRC_LENGTH_8B
HAL_CRC_LENGTH_7B
160/1320
DocID026525 Rev 6
UM1785
HAL DAC Generic Driver
14
HAL DAC Generic Driver
14.1
DAC Firmware driver registers structures
14.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
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
14.1.2
DAC_ChannelConfTypeDef
Data Fields
uint32_t DAC_Trigger
uint32_t DAC_OutputBuffer
Field Documentation
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
DocID026525 Rev 6
161/1320
HAL DAC Generic Driver
UM1785
14.2
DAC Firmware driver API description
14.2.1
DAC Peripheral features
DAC Channels
STM32F0 devices integrates no, one or two 12-bit Digital Analog Converters. STM32F05x
devices have one converter (channel1) STM32F07x & STM32F09x devices have two
converters (i.e. channel1 & channel2) When 2 converters are present (i.e. channel1 &
channel2) they can be used independently or simultaneously (dual mode):
1.
2.
DAC channel1 with DAC_OUT1 (PA4) as output
DAC channel2 with DAC_OUT2 (PA5) as output
DAC Triggers
Digital to Analog conversion can be non-triggered using DAC_TRIGGER_NONE and
DAC_OUT1/DAC_OUT2 is available once writing to DHRx register.
Digital to Analog conversion can be triggered by:
1.
2.
3.
External event: EXTI Line 9 (any GPIOx_PIN_9) using DAC_TRIGGER_EXT_IT9.
The used pin (GPIOx_PIN_9) must be configured in input mode.
Timers TRGO: TIM2, TIM3, TIM6, and TIM15 (DAC_TRIGGER_T2_TRGO,
DAC_TRIGGER_T3_TRGO...)
Software using DAC_TRIGGER_SOFTWARE
DAC Buffer mode feature
Each DAC channel integrates an output buffer that can be used to reduce the output
impedance, and to drive external loads directly without having to add an external
operational amplifier. To enable, the output buffer use sConfig.DAC_OutputBuffer =
DAC_OUTPUTBUFFER_ENABLE;
Refer to the device datasheet for more details about output impedance value with
and without output buffer.
GPIO configurations guidelines
When a DAC channel is used (ex channel1 on PA4) and the other is not (ex channel1 on
PA5 is configured in Analog and disabled). Channel1 may disturb channel2 as coupling
effect. Note that there is no coupling on channel2 as soon as channel2 is turned on.
Coupling on adjacent channel could be avoided as follows: when unused PA5 is configured
as INPUT PULL-UP or DOWN. PA5 is configured in ANALOG just before it is turned on.
DAC wave generation feature
Both DAC channels can be used to generate
1.
2.
162/1320
Noise wave
Triangle wave
DocID026525 Rev 6
UM1785
HAL DAC Generic Driver
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 correspondance
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+ 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()
For Dual mode and specific signal (Triangle and noise) generation please refer to
Extended Features Driver description STM32F0 devices with one channel (one
converting capability) does not support Dual mode and specific signal (Triangle
and noise) generation.
14.2.2
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 middle of data transfer HAL_DAC_ConvHalfCpltCallbackCh1() or
HAL_DACEx_ConvHalfCpltCallbackCh2() function is executed and user can add his
own code by customization of function pointer HAL_DAC_ConvHalfCpltCallbackCh1()
or HAL_DACEx_ConvHalfCpltCallbackCh2()
DocID026525 Rev 6
163/1320
HAL DAC Generic Driver
UM1785
At The end of data transfer HAL_DAC_ConvCpltCallbackCh1() or
HAL_DACEx_ConvHalfCpltCallbackCh2() function is executed and user can add his
own code by customization of function pointer HAL_DAC_ConvCpltCallbackCh1() or
HAL_DACEx_ConvHalfCpltCallbackCh2()
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
In case of DMA underrun, DAC interruption triggers and execute internal function
HAL_DAC_IRQHandler. HAL_DAC_DMAUnderrunCallbackCh1() or
HAL_DACEx_DMAUnderrunCallbackCh2() function is executed and user can add his
own code by customization of function pointer
HAL_DAC_DMAUnderrunCallbackCh1() or
HAL_DACEx_DMAUnderrunCallbackCh2() and 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.
__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
You can refer to the DAC HAL driver header file for more useful macros
14.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:
HAL_DAC_Init()
HAL_DAC_DeInit()
HAL_DAC_MspInit()
HAL_DAC_MspDeInit()
14.2.4
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.
Set the specified data holding register value for DAC channel.
This section contains the following APIs:
HAL_DAC_Start()
HAL_DAC_Stop()
164/1320
DocID026525 Rev 6
UM1785
HAL DAC Generic Driver
HAL_DAC_Start_DMA()
HAL_DAC_Stop_DMA()
HAL_DAC_IRQHandler()
HAL_DAC_SetValue()
HAL_DAC_ConvCpltCallbackCh1()
HAL_DAC_ConvHalfCpltCallbackCh1()
HAL_DAC_ErrorCallbackCh1()
HAL_DAC_DMAUnderrunCallbackCh1()
14.2.5
Peripheral Control functions
This section provides functions allowing to:
Configure channels.
Get result of conversion.
This section contains the following APIs:
HAL_DAC_GetValue()
HAL_DAC_ConfigChannel()
14.2.6
Peripheral State and Errors functions
This subsection provides functions allowing to
Check the DAC state.
Check the DAC Errors.
This section contains the following APIs:
HAL_DAC_GetState()
HAL_DAC_GetError()
14.2.7
Detailed description of functions
HAL_DAC_Init
Function name
HAL_StatusTypeDef HAL_DAC_Init (DAC_HandleTypeDef *
hdac)
Function description
Initialize the DAC peripheral according to the specified parameters
in the DAC_InitStruct and initialize the associated handle.
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
Deinitialize 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
DocID026525 Rev 6
165/1320
HAL DAC Generic Driver
UM1785
HAL_DAC_MspInit
Function name
void HAL_DAC_MspInit (DAC_HandleTypeDef * hdac)
Function description
Initialize 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
DeInitialize 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
Function name
HAL_StatusTypeDef HAL_DAC_Start (DAC_HandleTypeDef *
hdac, uint32_t Channel)
Function description
Enables DAC and starts conversion of 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 selected
DAC_CHANNEL_2: DAC Channel2 selected
Return values
HAL: status
HAL_DAC_Stop
166/1320
Function name
HAL_StatusTypeDef HAL_DAC_Stop (DAC_HandleTypeDef *
hdac, uint32_t Channel)
Function description
Disables DAC and stop conversion of 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 selected
DAC_CHANNEL_2: DAC Channel2 selected
Return values
HAL: status
DocID026525 Rev 6
UM1785
HAL DAC Generic Driver
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
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 selected
DAC_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 selected
DAC_ALIGN_12B_L: 12bit left data alignment selected
DAC_ALIGN_12B_R: 12bit right data alignment selected
Return values
HAL: status
HAL_DAC_Stop_DMA
Function name
HAL_StatusTypeDef HAL_DAC_Stop_DMA
(DAC_HandleTypeDef * hdac, uint32_t Channel)
Function description
Disables DAC and stop conversion of 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 selected
DAC_CHANNEL_2: DAC Channel2 selected
Return values
HAL: status
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
DocID026525 Rev 6
167/1320
HAL DAC Generic Driver
UM1785
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 selected
DAC_CHANNEL_2: DAC Channel2 selected
Alignment: Specifies the data alignment. 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
Data: Data to be loaded in the selected data holding register.
Return values
HAL: status
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.
Parameters
hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values
None
HAL_DAC_ErrorCallbackCh1
168/1320
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
DocID026525 Rev 6
UM1785
HAL DAC Generic Driver
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_GetValue
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
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 selected
DAC_CHANNEL_2: DAC Channel2 selected
Return values
The: selected DAC channel data output value.
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
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 selected
DAC_CHANNEL_2: DAC Channel2 selected
Return values
HAL: status
HAL_DAC_GetState
Function name
HAL_DAC_StateTypeDef HAL_DAC_GetState
(DAC_HandleTypeDef * hdac)
Function description
return the DAC handle state
Parameters
hdac: pointer to a DAC_HandleTypeDef structure that
contains the configuration information for the specified DAC.
Return values
HAL: state
DocID026525 Rev 6
169/1320
HAL DAC Generic Driver
UM1785
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
14.3
DAC Firmware driver defines
14.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 DMA underrun error
HAL_DAC_ERROR_DMAUNDERRUNCH2
DAC channel2 DMA underrun error
HAL_DAC_ERROR_DMA
DMA error
DAC Exported Macros
__HAL_DAC_RESET_HANDLE_STATE
Description:
Reset DAC handle state.
Parameters:
__HANDLE__: specifies the DAC handle.
Return value:
None
__HAL_DAC_ENABLE
Description:
Enable the DAC channel.
Parameters:
__HANDLE__: specifies the DAC handle.
__DAC_Channel__: specifies the DAC
channel
Return value:
None
170/1320
DocID026525 Rev 6
UM1785
HAL DAC Generic Driver
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. 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:
None
Description:
__HAL_DAC_DISABLE_IT
Disable the DAC interrupt.
Parameters:
__HANDLE__: specifies the DAC handle
__INTERRUPT__: specifies the DAC
interrupt. This parameter can be any
combination of the following values:
DAC_IT_DMAUDR1: DAC channel 1
DMA underrun interrupt
Return value:
None
__HAL_DAC_GET_IT_SOURCE
Description:
Check whether the specified DAC interrupt
source is enabled or not.
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
DocID026525 Rev 6
171/1320
HAL DAC Generic Driver
UM1785
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 DAC flag to get.
This parameter can be any combination of
the following values:
DAC_FLAG_DMAUDR1: DAC
channel 1 DMA underrun flag
Return value:
None
Description:
__HAL_DAC_CLEAR_FLAG
Clear the DAC's flag.
Parameters:
__HANDLE__: specifies the DAC handle.
__FLAG__: specifies the DAC flag to clear.
This parameter can be any combination of
the following values:
DAC_FLAG_DMAUDR1: DAC
channel 1 DMA underrun flag
Return value:
None
DAC flags definition
DAC_FLAG_DMAUDR1
DAC_FLAG_DMAUDR2
DAC IT definition
DAC_IT_DMAUDR1
DAC_IT_DMAUDR2
DAC output buffer
DAC_OUTPUTBUFFER_ENABLE
DAC_OUTPUTBUFFER_DISABLE
DAC trigger selection
172/1320
DAC_TRIGGER_NONE
Conversion is automatic once the DAC1_DHRxxxx
register has been loaded, and not by external trigger
DAC_TRIGGER_T2_TRGO
TIM2 TRGO selected as external conversion trigger for
DAC channel
DAC_TRIGGER_T3_TRGO
TIM3 TRGO selected as external conversion trigger for
DocID026525 Rev 6
UM1785
HAL DAC Generic Driver
DAC channel
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_T15_TRGO
TIM15 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
DocID026525 Rev 6
173/1320
HAL DAC Extension Driver
UM1785
15
HAL DAC Extension Driver
15.1
DACEx Firmware driver API description
15.1.1
How to use this driver
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.
15.1.2
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:
HAL_DACEx_DualGetValue()
HAL_DACEx_TriangleWaveGenerate()
HAL_DACEx_NoiseWaveGenerate()
HAL_DACEx_DualSetValue()
HAL_DACEx_ConvCpltCallbackCh2()
HAL_DACEx_ConvHalfCpltCallbackCh2()
HAL_DACEx_ErrorCallbackCh2()
HAL_DACEx_DMAUnderrunCallbackCh2()
15.1.3
Detailed description of functions
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.
Parameters
174/1320
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 1
DAC_TRIANGLEAMPLITUDE_3: Select max triangle
DocID026525 Rev 6
UM1785
HAL DAC Extension Driver
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
Return values
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 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
DocID026525 Rev 6
175/1320
HAL DAC Extension Driver
Return values
UM1785
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 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
HAL: status
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
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
176/1320
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
DocID026525 Rev 6
UM1785
HAL DAC Extension Driver
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
contains the configuration information for the specified DAC.
Return values
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
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.
15.2
DACEx Firmware driver defines
15.2.1
DACEx
DACEx lfsrunmask triangleamplitude
DAC_LFSRUNMASK_BIT0
Unmask DAC channel LFSR bit0 for noise wave
generation
DAC_LFSRUNMASK_BITS1_0
Unmask DAC channel LFSR bit[1:0] for noise wave
generation
DocID026525 Rev 6
177/1320
HAL DAC Extension Driver
DAC_LFSRUNMASK_BITS2_0
178/1320
UM1785
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
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
DocID026525 Rev 6
UM1785
HAL DMA Generic Driver
16
HAL DMA Generic Driver
16.1
DMA Firmware driver registers structures
16.1.1
DMA_InitTypeDef
Data Fields
uint32_t Direction
uint32_t PeriphInc
uint32_t MemInc
uint32_t PeriphDataAlignment
uint32_t MemDataAlignment
uint32_t Mode
uint32_t Priority
Field Documentation
uint32_t DMA_InitTypeDef::Direction
Specifies if the data will be transferred from memory to peripheral, from memory to
memory or from peripheral to memory. This parameter can be a value of
DMA_Data_transfer_direction
uint32_t DMA_InitTypeDef::PeriphInc
Specifies whether the Peripheral address register should be incremented or not. This
parameter can be a value of DMA_Peripheral_incremented_mode
uint32_t DMA_InitTypeDef::MemInc
Specifies whether the memory address register should be incremented or not. This
parameter can be a value of DMA_Memory_incremented_mode
uint32_t DMA_InitTypeDef::PeriphDataAlignment
Specifies the Peripheral data width. This parameter can be a value of
DMA_Peripheral_data_size
uint32_t DMA_InitTypeDef::MemDataAlignment
Specifies the Memory data width. This parameter can be a value of
DMA_Memory_data_size
uint32_t DMA_InitTypeDef::Mode
Specifies the operation mode of the DMAy Channelx. This parameter can be a value
of DMA_mode
Note:The circular buffer mode cannot be used if the memory-to-memory data transfer
is configured on the selected Channel
uint32_t DMA_InitTypeDef::Priority
Specifies the software priority for the DMAy Channelx. This parameter can be a value
of DMA_Priority_level
16.1.2
__DMA_HandleTypeDef
Data Fields
DMA_Channel_TypeDef * Instance
DMA_InitTypeDef Init
HAL_LockTypeDef Lock
__IO HAL_DMA_StateTypeDef State
void * Parent
void(* XferCpltCallback
void(* XferHalfCpltCallback
DocID026525 Rev 6
179/1320
HAL DMA Generic Driver
UM1785
void(* XferErrorCallback
void(* XferAbortCallback
__IO uint32_t ErrorCode
DMA_TypeDef * DmaBaseAddress
uint32_t ChannelIndex
Field Documentation
DMA_Channel_TypeDef* __DMA_HandleTypeDef::Instance
Register base address
DMA_InitTypeDef __DMA_HandleTypeDef::Init
DMA communication parameters
HAL_LockTypeDef __DMA_HandleTypeDef::Lock
DMA locking object
__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
void(* __DMA_HandleTypeDef::XferHalfCpltCallback)(struct
__DMA_HandleTypeDef *hdma)
DMA Half transfer complete callback
void(* __DMA_HandleTypeDef::XferErrorCallback)(struct
__DMA_HandleTypeDef *hdma)
DMA transfer error callback
void(* __DMA_HandleTypeDef::XferAbortCallback)(struct
__DMA_HandleTypeDef *hdma)
DMA transfer abort callback
__IO uint32_t __DMA_HandleTypeDef::ErrorCode
DMA Error code
DMA_TypeDef* __DMA_HandleTypeDef::DmaBaseAddress
DMA Channel Base Address
uint32_t __DMA_HandleTypeDef::ChannelIndex
DMA Channel Index
16.2
DMA Firmware driver API description
16.2.1
How to use this driver
1.
2.
3.
4.
180/1320
Enable and configure the peripheral to be connected to the DMA Channel (except for
internal SRAM / FLASH memories: no initialization is necessary). Please refer to
Reference manual for connection between peripherals and DMA requests .
For a given Channel, program the required configuration through the following
parameters: Transfer Direction, Source and Destination data formats, Circular or
Normal mode, Channel Priority level, Source and Destination Increment mode, using
HAL_DMA_Init() function.
Use HAL_DMA_GetState() function to return the DMA state and
HAL_DMA_GetError() in case of error detection.
Use HAL_DMA_Abort() function to abort the current transfer In Memory-to-Memory
transfer mode, Circular mode is not allowed.
DocID026525 Rev 6
UM1785
HAL DMA Generic Driver
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_Channel_IRQHandler() called under DMA_IRQHandler() Interrupt
subroutine
At the end of data transfer HAL_DMA_IRQHandler() function is executed and user can
add his own function by customization of function pointer XferCpltCallback and
XferErrorCallback (i.e a member of DMA handle structure).
DMA HAL driver macros list
Below the list of most used macros in DMA HAL driver.
You can refer to the DMA HAL driver header file for more useful macros
16.2.2
Initialization and de-initialization functions
This section provides functions allowing to initialize the DMA Channel source and
destination addresses, incrementation and data sizes, transfer direction, circular/normal
mode selection, memory-to-memory mode selection and Channel priority value.
The HAL_DMA_Init() function follows the DMA configuration procedures as described in
reference manual.
This section contains the following APIs:
HAL_DMA_Init()
HAL_DMA_DeInit()
16.2.3
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:
HAL_DMA_Start()
HAL_DMA_Start_IT()
HAL_DMA_Abort()
DocID026525 Rev 6
181/1320
HAL DMA Generic Driver
UM1785
HAL_DMA_Abort_IT()
HAL_DMA_PollForTransfer()
HAL_DMA_IRQHandler()
HAL_DMA_RegisterCallback()
HAL_DMA_UnRegisterCallback()
16.2.4
State and Errors functions
This subsection provides functions allowing to
Check the DMA state
Get error code
This section contains the following APIs:
HAL_DMA_GetState()
HAL_DMA_GetError()
16.2.5
Detailed description of functions
HAL_DMA_Init
Function name
HAL_StatusTypeDef HAL_DMA_Init (DMA_HandleTypeDef *
hdma)
Function description
Initialize the DMA according to the specified parameters in the
DMA_InitTypeDef and initialize the associated handle.
Parameters
hdma: Pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Channel.
Return values
HAL: status
HAL_DMA_DeInit
Function name
HAL_StatusTypeDef HAL_DMA_DeInit (DMA_HandleTypeDef *
hdma)
Function description
DeInitialize the DMA peripheral.
Parameters
hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Channel.
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
Start the DMA Transfer.
Parameters
182/1320
hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Channel.
SrcAddress: The source memory Buffer address
DstAddress: The destination memory Buffer address
DocID026525 Rev 6
UM1785
HAL DMA Generic Driver
DataLength: The length of data to be transferred from
source to destination
Return values
HAL: status
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
hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Channel.
SrcAddress: The source memory Buffer address
DstAddress: The destination memory Buffer address
DataLength: The length of data to be transferred from
source to destination
Return values
HAL: status
HAL_DMA_Abort
Function name
HAL_StatusTypeDef HAL_DMA_Abort (DMA_HandleTypeDef *
hdma)
Function description
Abort the DMA Transfer.
Parameters
hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Channel.
Return values
HAL: status
HAL_DMA_Abort_IT
Function name
HAL_StatusTypeDef HAL_DMA_Abort_IT
(DMA_HandleTypeDef * hdma)
Function description
Abort the DMA Transfer in Interrupt mode.
Parameters
hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Stream.
Return values
HAL: status
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
Channel.
DocID026525 Rev 6
183/1320
HAL DMA Generic Driver
UM1785
CompleteLevel: Specifies the DMA level complete.
Timeout: Timeout duration.
Return values
HAL: status
HAL_DMA_IRQHandler
Function name
void HAL_DMA_IRQHandler (DMA_HandleTypeDef * hdma)
Function description
Handle DMA interrupt request.
Parameters
hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Channel.
Return values
None
HAL_DMA_RegisterCallback
Function name
HAL_StatusTypeDef HAL_DMA_RegisterCallback
(DMA_HandleTypeDef * hdma, HAL_DMA_CallbackIDTypeDef
CallbackID, void(*)(DMA_HandleTypeDef *_hdma) pCallback)
Function description
Register callbacks.
Parameters
hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Stream.
CallbackID: User Callback identifer a
HAL_DMA_CallbackIDTypeDef ENUM as parameter.
pCallback: pointer to private callback function which has
pointer to a DMA_HandleTypeDef structure as parameter.
Return values
HAL: status
HAL_DMA_UnRegisterCallback
184/1320
Function name
HAL_StatusTypeDef HAL_DMA_UnRegisterCallback
(DMA_HandleTypeDef * hdma, HAL_DMA_CallbackIDTypeDef
CallbackID)
Function description
UnRegister callbacks.
Parameters
hdma: pointer to a DMA_HandleTypeDef structure that
contains the configuration information for the specified DMA
Stream.
CallbackID: User Callback identifer a
HAL_DMA_CallbackIDTypeDef ENUM as parameter.
Return values
HAL: status
DocID026525 Rev 6
UM1785
HAL DMA Generic Driver
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
Channel.
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
Channel.
Return values
DMA: Error Code
16.3
DMA Firmware driver defines
16.3.1
DMA
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
HAL_DMA_ERROR_NONE
No error
HAL_DMA_ERROR_TE
Transfer error
HAL_DMA_ERROR_NO_XFER
no ongoin transfer
HAL_DMA_ERROR_TIMEOUT
Timeout error
HAL_DMA_ERROR_NOT_SUPPORTED
Not supported mode
DMA Exported Macros
__HAL_DMA_RESET_HANDLE_STATE
Description:
Reset DMA handle state.
Parameters:
__HANDLE__: DMA handle.
Return value:
None
__HAL_DMA_ENABLE
Description:
Enable the specified DMA Channel.
DocID026525 Rev 6
185/1320
HAL DMA Generic Driver
UM1785
Parameters:
__HANDLE__: DMA handle
Return value:
None
__HAL_DMA_DISABLE
Description:
Disable the specified DMA Channel.
Parameters:
__HANDLE__: DMA handle
Return value:
None
__HAL_DMA_ENABLE_IT
Description:
Enables the specified DMA Channel
interrupts.
Parameters:
__HANDLE__: DMA handle
__INTERRUPT__: specifies the DMA
interrupt sources to be enabled or
disabled. This parameter can be any
combination of the following values:
DMA_IT_TC: Transfer complete
interrupt mask
DMA_IT_HT: Half transfer complete
interrupt mask
DMA_IT_TE: Transfer error interrupt
mask
Return value:
None
__HAL_DMA_DISABLE_IT
Description:
Disables the specified DMA Channel
interrupts.
Parameters:
__HANDLE__: DMA handle
__INTERRUPT__: specifies the DMA
interrupt sources to be enabled or
disabled. This parameter can be any
combination of the following values:
DMA_IT_TC: Transfer complete
interrupt mask
DMA_IT_HT: Half transfer complete
interrupt mask
DMA_IT_TE: Transfer error interrupt
mask
186/1320
DocID026525 Rev 6
UM1785
HAL DMA Generic Driver
Return value:
None
__HAL_DMA_GET_IT_SOURCE
Description:
Checks whether the specified DMA
Channel interrupt is enabled or disabled.
Parameters:
__HANDLE__: DMA handle
__INTERRUPT__: specifies the DMA
interrupt source to check. This parameter
can be one of the following values:
DMA_IT_TC: Transfer complete
interrupt mask
DMA_IT_HT: Half transfer complete
interrupt mask
DMA_IT_TE: Transfer error interrupt
mask
Return value:
The: state of DMA_IT (SET or RESET).
__HAL_DMA_GET_COUNTER
Description:
Returns the number of remaining data
units in the current DMAy Channelx
transfer.
Parameters:
__HANDLE__: DMA handle
Return value:
The: number of remaining data units in the
current DMA Channel transfer.
DMA flag definitions
DMA_FLAG_GL1
Channel 1 global interrupt flag
DMA_FLAG_TC1
Channel 1 transfer complete flag
DMA_FLAG_HT1
Channel 1 half transfer flag
DMA_FLAG_TE1
Channel 1 transfer error flag
DMA_FLAG_GL2
Channel 2 global interrupt flag
DMA_FLAG_TC2
Channel 2 transfer complete flag
DMA_FLAG_HT2
Channel 2 half transfer flag
DMA_FLAG_TE2
Channel 2 transfer error flag
DMA_FLAG_GL3
Channel 3 global interrupt flag
DMA_FLAG_TC3
Channel 3 transfer complete flag
DMA_FLAG_HT3
Channel 3 half transfer flag
DMA_FLAG_TE3
Channel 3 transfer error flag
DocID026525 Rev 6
187/1320
HAL DMA Generic Driver
DMA_FLAG_GL4
UM1785
Channel 4 global interrupt flag
DMA_FLAG_TC4
Channel 4 transfer complete flag
DMA_FLAG_HT4
Channel 4 half transfer flag
DMA_FLAG_TE4
Channel 4 transfer error flag
DMA_FLAG_GL5
Channel 5 global interrupt flag
DMA_FLAG_TC5
Channel 5 transfer complete flag
DMA_FLAG_HT5
Channel 5 half transfer flag
DMA_FLAG_TE5
Channel 5 transfer error flag
DMA_FLAG_GL6
Channel 6 global interrupt flag
DMA_FLAG_TC6
Channel 6 transfer complete flag
DMA_FLAG_HT6
Channel 6 half transfer flag
DMA_FLAG_TE6
Channel 6 transfer error flag
DMA_FLAG_GL7
Channel 7 global interrupt flag
DMA_FLAG_TC7
Channel 7 transfer complete flag
DMA_FLAG_HT7
Channel 7 half transfer flag
DMA_FLAG_TE7
Channel 7 transfer error flag
DMA interrupt enable definitions
DMA_IT_TC
DMA_IT_HT
DMA_IT_TE
DMA Memory data size
DMA_MDATAALIGN_BYTE
Memory data alignment : Byte
DMA_MDATAALIGN_HALFWORD
Memory data alignment : HalfWord
DMA_MDATAALIGN_WORD
Memory data alignment : Word
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 Peripheral data size
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
188/1320
Peripheral increment mode Enable
DocID026525 Rev 6
UM1785
HAL DMA Generic Driver
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
DocID026525 Rev 6
189/1320
HAL DMA Extension Driver
UM1785
17
HAL DMA Extension Driver
17.1
DMAEx Firmware driver defines
17.1.1
DMAEx
DMAEx Exported Constants
190/1320
DMA1_CHANNEL1_RMP
Internal define for remaping on STM32F09x/30xC
DMA1_CHANNEL2_RMP
Internal define for remaping on STM32F09x/30xC
DMA1_CHANNEL3_RMP
Internal define for remaping on STM32F09x/30xC
DMA1_CHANNEL4_RMP
Internal define for remaping on STM32F09x/30xC
DMA1_CHANNEL5_RMP
Internal define for remaping on STM32F09x/30xC
DMA1_CHANNEL6_RMP
Internal define for remaping on STM32F09x/30xC
DMA1_CHANNEL7_RMP
Internal define for remaping on STM32F09x/30xC
DMA2_CHANNEL1_RMP
Internal define for remaping on STM32F09x/30xC
DMA2_CHANNEL2_RMP
Internal define for remaping on STM32F09x/30xC
DMA2_CHANNEL3_RMP
Internal define for remaping on STM32F09x/30xC
DMA2_CHANNEL4_RMP
Internal define for remaping on STM32F09x/30xC
DMA2_CHANNEL5_RMP
Internal define for remaping on STM32F09x/30xC
HAL_DMA1_CH1_DEFAULT
Default remap position for DMA1
HAL_DMA1_CH1_ADC
Remap ADC on DMA1 Channel 1
HAL_DMA1_CH1_TIM17_CH1
Remap TIM17 channel 1 on DMA1 channel 1
HAL_DMA1_CH1_TIM17_UP
Remap TIM17 up on DMA1 channel 1
HAL_DMA1_CH1_USART1_RX
Remap USART1 Rx on DMA1 channel 1
HAL_DMA1_CH1_USART2_RX
Remap USART2 Rx on DMA1 channel 1
HAL_DMA1_CH1_USART3_RX
Remap USART3 Rx on DMA1 channel 1
HAL_DMA1_CH1_USART4_RX
Remap USART4 Rx on DMA1 channel 1
HAL_DMA1_CH1_USART5_RX
Remap USART5 Rx on DMA1 channel 1
HAL_DMA1_CH1_USART6_RX
Remap USART6 Rx on DMA1 channel 1
HAL_DMA1_CH1_USART7_RX
Remap USART7 Rx on DMA1 channel 1
HAL_DMA1_CH1_USART8_RX
Remap USART8 Rx on DMA1 channel 1
HAL_DMA1_CH2_DEFAULT
Default remap position for DMA1
HAL_DMA1_CH2_ADC
Remap ADC on DMA1 channel 2
HAL_DMA1_CH2_I2C1_TX
Remap I2C1 Tx on DMA1 channel 2
HAL_DMA1_CH2_SPI1_RX
Remap SPI1 Rx on DMA1 channel 2
HAL_DMA1_CH2_TIM1_CH1
Remap TIM1 channel 1 on DMA1 channel 2
HAL_DMA1_CH2_TIM17_CH1
Remap TIM17 channel 1 on DMA1 channel 2
DocID026525 Rev 6
UM1785
HAL_DMA1_CH2_TIM17_UP
HAL DMA Extension Driver
Remap TIM17 up on DMA1 channel 2
HAL_DMA1_CH2_USART1_TX
Remap USART1 Tx on DMA1 channel 2
HAL_DMA1_CH2_USART2_TX
Remap USART2 Tx on DMA1 channel 2
HAL_DMA1_CH2_USART3_TX
Remap USART3 Tx on DMA1 channel 2
HAL_DMA1_CH2_USART4_TX
Remap USART4 Tx on DMA1 channel 2
HAL_DMA1_CH2_USART5_TX
Remap USART5 Tx on DMA1 channel 2
HAL_DMA1_CH2_USART6_TX
Remap USART6 Tx on DMA1 channel 2
HAL_DMA1_CH2_USART7_TX
Remap USART7 Tx on DMA1 channel 2
HAL_DMA1_CH2_USART8_TX
Remap USART8 Tx on DMA1 channel 2
HAL_DMA1_CH3_DEFAULT
Default remap position for DMA1
HAL_DMA1_CH3_TIM6_UP
Remap TIM6 up on DMA1 channel 3
HAL_DMA1_CH3_DAC_CH1
Remap DAC Channel 1on DMA1 channel 3
HAL_DMA1_CH3_I2C1_RX
Remap I2C1 Rx on DMA1 channel 3
HAL_DMA1_CH3_SPI1_TX
Remap SPI1 Tx on DMA1 channel 3
HAL_DMA1_CH3_TIM1_CH2
Remap TIM1 channel 2 on DMA1 channel 3
HAL_DMA1_CH3_TIM2_CH2
Remap TIM2 channel 2 on DMA1 channel 3
HAL_DMA1_CH3_TIM16_CH1
Remap TIM16 channel 1 on DMA1 channel 3
HAL_DMA1_CH3_TIM16_UP
Remap TIM16 up on DMA1 channel 3
HAL_DMA1_CH3_USART1_RX
Remap USART1 Rx on DMA1 channel 3
HAL_DMA1_CH3_USART2_RX
Remap USART2 Rx on DMA1 channel 3
HAL_DMA1_CH3_USART3_RX
Remap USART3 Rx on DMA1 channel 3
HAL_DMA1_CH3_USART4_RX
Remap USART4 Rx on DMA1 channel 3
HAL_DMA1_CH3_USART5_RX
Remap USART5 Rx on DMA1 channel 3
HAL_DMA1_CH3_USART6_RX
Remap USART6 Rx on DMA1 channel 3
HAL_DMA1_CH3_USART7_RX
Remap USART7 Rx on DMA1 channel 3
HAL_DMA1_CH3_USART8_RX
Remap USART8 Rx on DMA1 channel 3
HAL_DMA1_CH4_DEFAULT
Default remap position for DMA1
HAL_DMA1_CH4_TIM7_UP
Remap TIM7 up on DMA1 channel 4
HAL_DMA1_CH4_DAC_CH2
Remap DAC Channel 2 on DMA1 channel 4
HAL_DMA1_CH4_I2C2_TX
Remap I2C2 Tx on DMA1 channel 4
HAL_DMA1_CH4_SPI2_RX
Remap SPI2 Rx on DMA1 channel 4
HAL_DMA1_CH4_TIM2_CH4
Remap TIM2 channel 4 on DMA1 channel 4
HAL_DMA1_CH4_TIM3_CH1
Remap TIM3 channel 1 on DMA1 channel 4
HAL_DMA1_CH4_TIM3_TRIG
Remap TIM3 Trig on DMA1 channel 4
HAL_DMA1_CH4_TIM16_CH1
Remap TIM16 channel 1 on DMA1 channel 4
HAL_DMA1_CH4_TIM16_UP
Remap TIM16 up on DMA1 channel 4
DocID026525 Rev 6
191/1320
HAL DMA Extension Driver
HAL_DMA1_CH4_USART1_TX
Remap USART1 Tx on DMA1 channel 4
HAL_DMA1_CH4_USART2_TX
Remap USART2 Tx on DMA1 channel 4
HAL_DMA1_CH4_USART3_TX
Remap USART3 Tx on DMA1 channel 4
HAL_DMA1_CH4_USART4_TX
Remap USART4 Tx on DMA1 channel 4
HAL_DMA1_CH4_USART5_TX
Remap USART5 Tx on DMA1 channel 4
HAL_DMA1_CH4_USART6_TX
Remap USART6 Tx on DMA1 channel 4
HAL_DMA1_CH4_USART7_TX
Remap USART7 Tx on DMA1 channel 4
HAL_DMA1_CH4_USART8_TX
Remap USART8 Tx on DMA1 channel 4
HAL_DMA1_CH5_DEFAULT
Default remap position for DMA1
HAL_DMA1_CH5_I2C2_RX
Remap I2C2 Rx on DMA1 channel 5
HAL_DMA1_CH5_SPI2_TX
Remap SPI1 Tx on DMA1 channel 5
HAL_DMA1_CH5_TIM1_CH3
Remap TIM1 channel 3 on DMA1 channel 5
HAL_DMA1_CH5_USART1_RX
Remap USART1 Rx on DMA1 channel 5
HAL_DMA1_CH5_USART2_RX
Remap USART2 Rx on DMA1 channel 5
HAL_DMA1_CH5_USART3_RX
Remap USART3 Rx on DMA1 channel 5
HAL_DMA1_CH5_USART4_RX
Remap USART4 Rx on DMA1 channel 5
HAL_DMA1_CH5_USART5_RX
Remap USART5 Rx on DMA1 channel 5
HAL_DMA1_CH5_USART6_RX
Remap USART6 Rx on DMA1 channel 5
HAL_DMA1_CH5_USART7_RX
Remap USART7 Rx on DMA1 channel 5
HAL_DMA1_CH5_USART8_RX
Remap USART8 Rx on DMA1 channel 5
HAL_DMA1_CH6_DEFAULT
Default remap position for DMA1
HAL_DMA1_CH6_I2C1_TX
Remap I2C1 Tx on DMA1 channel 6
HAL_DMA1_CH6_SPI2_RX
Remap SPI2 Rx on DMA1 channel 6
HAL_DMA1_CH6_TIM1_CH1
Remap TIM1 channel 1 on DMA1 channel 6
HAL_DMA1_CH6_TIM1_CH2
Remap TIM1 channel 2 on DMA1 channel 6
HAL_DMA1_CH6_TIM1_CH3
Remap TIM1 channel 3 on DMA1 channel 6
HAL_DMA1_CH6_TIM3_CH1
Remap TIM3 channel 1 on DMA1 channel 6
HAL_DMA1_CH6_TIM3_TRIG
Remap TIM3 Trig on DMA1 channel 6
HAL_DMA1_CH6_TIM16_CH1
Remap TIM16 channel 1 on DMA1 channel 6
HAL_DMA1_CH6_TIM16_UP
Remap TIM16 up on DMA1 channel 6
HAL_DMA1_CH6_USART1_RX
Remap USART1 Rx on DMA1 channel 6
HAL_DMA1_CH6_USART2_RX
Remap USART2 Rx on DMA1 channel 6
HAL_DMA1_CH6_USART3_RX
Remap USART3 Rx on DMA1 channel 6
HAL_DMA1_CH6_USART4_RX
Remap USART4 Rx on DMA1 channel 6
HAL_DMA1_CH6_USART5_RX
Remap USART5 Rx on DMA1 channel 6
HAL_DMA1_CH6_USART6_RX
Remap USART6 Rx on DMA1 channel 6
192/1320
UM1785
DocID026525 Rev 6
UM1785
HAL_DMA1_CH6_USART7_RX
HAL DMA Extension Driver
Remap USART7 Rx on DMA1 channel 6
HAL_DMA1_CH6_USART8_RX
Remap USART8 Rx on DMA1 channel 6
HAL_DMA1_CH7_DEFAULT
Default remap position for DMA1
HAL_DMA1_CH7_I2C1_RX
Remap I2C1 Rx on DMA1 channel 7
HAL_DMA1_CH7_SPI2_TX
Remap SPI2 Tx on DMA1 channel 7
HAL_DMA1_CH7_TIM2_CH2
Remap TIM2 channel 2 on DMA1 channel 7
HAL_DMA1_CH7_TIM2_CH4
Remap TIM2 channel 4 on DMA1 channel 7
HAL_DMA1_CH7_TIM17_CH1
Remap TIM17 channel 1 on DMA1 channel 7
HAL_DMA1_CH7_TIM17_UP
Remap TIM17 up on DMA1 channel 7
HAL_DMA1_CH7_USART1_TX
Remap USART1 Tx on DMA1 channel 7
HAL_DMA1_CH7_USART2_TX
Remap USART2 Tx on DMA1 channel 7
HAL_DMA1_CH7_USART3_TX
Remap USART3 Tx on DMA1 channel 7
HAL_DMA1_CH7_USART4_TX
Remap USART4 Tx on DMA1 channel 7
HAL_DMA1_CH7_USART5_TX
Remap USART5 Tx on DMA1 channel 7
HAL_DMA1_CH7_USART6_TX
Remap USART6 Tx on DMA1 channel 7
HAL_DMA1_CH7_USART7_TX
Remap USART7 Tx on DMA1 channel 7
HAL_DMA1_CH7_USART8_TX
Remap USART8 Tx on DMA1 channel 7
HAL_DMA2_CH1_DEFAULT
Default remap position for DMA2
HAL_DMA2_CH1_I2C2_TX
Remap I2C2 TX on DMA2 channel 1
HAL_DMA2_CH1_USART1_TX
Remap USART1 Tx on DMA2 channel 1
HAL_DMA2_CH1_USART2_TX
Remap USART2 Tx on DMA2 channel 1
HAL_DMA2_CH1_USART3_TX
Remap USART3 Tx on DMA2 channel 1
HAL_DMA2_CH1_USART4_TX
Remap USART4 Tx on DMA2 channel 1
HAL_DMA2_CH1_USART5_TX
Remap USART5 Tx on DMA2 channel 1
HAL_DMA2_CH1_USART6_TX
Remap USART6 Tx on DMA2 channel 1
HAL_DMA2_CH1_USART7_TX
Remap USART7 Tx on DMA2 channel 1
HAL_DMA2_CH1_USART8_TX
Remap USART8 Tx on DMA2 channel 1
HAL_DMA2_CH2_DEFAULT
Default remap position for DMA2
HAL_DMA2_CH2_I2C2_RX
Remap I2C2 Rx on DMA2 channel 2
HAL_DMA2_CH2_USART1_RX
Remap USART1 Rx on DMA2 channel 2
HAL_DMA2_CH2_USART2_RX
Remap USART2 Rx on DMA2 channel 2
HAL_DMA2_CH2_USART3_RX
Remap USART3 Rx on DMA2 channel 2
HAL_DMA2_CH2_USART4_RX
Remap USART4 Rx on DMA2 channel 2
HAL_DMA2_CH2_USART5_RX
Remap USART5 Rx on DMA2 channel 2
HAL_DMA2_CH2_USART6_RX
Remap USART6 Rx on DMA2 channel 2
HAL_DMA2_CH2_USART7_RX
Remap USART7 Rx on DMA2 channel 2
DocID026525 Rev 6
193/1320
HAL DMA Extension Driver
HAL_DMA2_CH2_USART8_RX
UM1785
Remap USART8 Rx on DMA2 channel 2
HAL_DMA2_CH3_DEFAULT
Default remap position for DMA2
HAL_DMA2_CH3_TIM6_UP
Remap TIM6 up on DMA2 channel 3
HAL_DMA2_CH3_DAC_CH1
Remap DAC channel 1 on DMA2 channel 3
HAL_DMA2_CH3_SPI1_RX
Remap SPI1 Rx on DMA2 channel 3
HAL_DMA2_CH3_USART1_RX
Remap USART1 Rx on DMA2 channel 3
HAL_DMA2_CH3_USART2_RX
Remap USART2 Rx on DMA2 channel 3
HAL_DMA2_CH3_USART3_RX
Remap USART3 Rx on DMA2 channel 3
HAL_DMA2_CH3_USART4_RX
Remap USART4 Rx on DMA2 channel 3
HAL_DMA2_CH3_USART5_RX
Remap USART5 Rx on DMA2 channel 3
HAL_DMA2_CH3_USART6_RX
Remap USART6 Rx on DMA2 channel 3
HAL_DMA2_CH3_USART7_RX
Remap USART7 Rx on DMA2 channel 3
HAL_DMA2_CH3_USART8_RX
Remap USART8 Rx on DMA2 channel 3
HAL_DMA2_CH4_DEFAULT
Default remap position for DMA2
HAL_DMA2_CH4_TIM7_UP
Remap TIM7 up on DMA2 channel 4
HAL_DMA2_CH4_DAC_CH2
Remap DAC channel 2 on DMA2 channel 4
HAL_DMA2_CH4_SPI1_TX
Remap SPI1 Tx on DMA2 channel 4
HAL_DMA2_CH4_USART1_TX
Remap USART1 Tx on DMA2 channel 4
HAL_DMA2_CH4_USART2_TX
Remap USART2 Tx on DMA2 channel 4
HAL_DMA2_CH4_USART3_TX
Remap USART3 Tx on DMA2 channel 4
HAL_DMA2_CH4_USART4_TX
Remap USART4 Tx on DMA2 channel 4
HAL_DMA2_CH4_USART5_TX
Remap USART5 Tx on DMA2 channel 4
HAL_DMA2_CH4_USART6_TX
Remap USART6 Tx on DMA2 channel 4
HAL_DMA2_CH4_USART7_TX
Remap USART7 Tx on DMA2 channel 4
HAL_DMA2_CH4_USART8_TX
Remap USART8 Tx on DMA2 channel 4
HAL_DMA2_CH5_DEFAULT
Default remap position for DMA2
HAL_DMA2_CH5_ADC
Remap ADC on DMA2 channel 5
HAL_DMA2_CH5_USART1_TX
Remap USART1 Tx on DMA2 channel 5
HAL_DMA2_CH5_USART2_TX
Remap USART2 Tx on DMA2 channel 5
HAL_DMA2_CH5_USART3_TX
Remap USART3 Tx on DMA2 channel 5
HAL_DMA2_CH5_USART4_TX
Remap USART4 Tx on DMA2 channel 5
HAL_DMA2_CH5_USART5_TX
Remap USART5 Tx on DMA2 channel 5
HAL_DMA2_CH5_USART6_TX
Remap USART6 Tx on DMA2 channel 5
HAL_DMA2_CH5_USART7_TX
Remap USART7 Tx on DMA2 channel 5
HAL_DMA2_CH5_USART8_TX
Remap USART8 Tx on DMA2 channel 5
IS_HAL_DMA1_REMAP
194/1320
DocID026525 Rev 6
UM1785
HAL DMA Extension Driver
IS_HAL_DMA2_REMAP
DMAEx Exported Macros
__HAL_DMA_GET_TC_FLAG_INDEX
Description:
Returns the current DMA Channel transfer
complete flag.
Parameters:
__HANDLE__: DMA handle
Return value:
The: specified transfer complete flag index.
__HAL_DMA_GET_HT_FLAG_INDEX
Description:
Returns the current DMA Channel half
transfer complete flag.
Parameters:
__HANDLE__: DMA handle
Return value:
The: specified half transfer complete flag
index.
__HAL_DMA_GET_TE_FLAG_INDEX
Description:
Returns the current DMA Channel transfer
error flag.
Parameters:
__HANDLE__: DMA handle
Return value:
The: specified transfer error flag index.
__HAL_DMA_GET_GI_FLAG_INDEX
Description:
Return the current DMA Channel Global
interrupt flag.
Parameters:
__HANDLE__: DMA handle
Return value:
The: specified transfer error flag index.
__HAL_DMA_GET_FLAG
Description:
Get the DMA Channel pending flags.
Parameters:
__HANDLE__: DMA handle
__FLAG__: Get the specified flag. This
parameter can be any combination of the
following values:
DMA_FLAG_TCx: Transfer complete
DocID026525 Rev 6
195/1320
HAL DMA Extension Driver
UM1785
flag
DMA_FLAG_HTx: Half transfer
complete flag
DMA_FLAG_TEx: Transfer error flag
Where x can be 0_4, 1_5, 2_6 or 3_7 to
select the DMA Channel flag.
Return value:
The: state of FLAG (SET or RESET).
__HAL_DMA_CLEAR_FLAG
Description:
Clears the DMA Channel pending flags.
Parameters:
__HANDLE__: DMA handle
__FLAG__: specifies the flag to clear. This
parameter can be any combination of the
following values:
DMA_FLAG_TCx: Transfer complete
flag
DMA_FLAG_HTx: Half transfer
complete flag
DMA_FLAG_TEx: Transfer error flag
Where x can be 0_4, 1_5, 2_6 or 3_7 to
select the DMA Channel flag.
Return value:
None
__HAL_DMA1_REMAP
__HAL_DMA2_REMAP
196/1320
DocID026525 Rev 6
UM1785
HAL FLASH Generic Driver
18
HAL FLASH Generic Driver
18.1
FLASH Firmware driver registers structures
18.1.1
FLASH_ProcessTypeDef
Data Fields
__IO FLASH_ProcedureTypeDef ProcedureOnGoing
__IO uint32_t DataRemaining
__IO uint32_t Address
__IO uint64_t Data
HAL_LockTypeDef Lock
__IO uint32_t ErrorCode
Field Documentation
__IO FLASH_ProcedureTypeDef FLASH_ProcessTypeDef::ProcedureOnGoing
Internal variable to indicate which procedure is ongoing or not in IT context
__IO uint32_t FLASH_ProcessTypeDef::DataRemaining
Internal variable to save the remaining pages to erase or half-word to program in IT
context
__IO uint32_t FLASH_ProcessTypeDef::Address
Internal variable to save address selected for program or erase
__IO uint64_t FLASH_ProcessTypeDef::Data
Internal variable to save data to be programmed
HAL_LockTypeDef FLASH_ProcessTypeDef::Lock
FLASH locking object
__IO uint32_t FLASH_ProcessTypeDef::ErrorCode
FLASH error code This parameter can be a value of FLASH_Error_Codes
18.2
FLASH Firmware driver API description
18.2.1
FLASH peripheral features
The Flash memory interface manages CPU AHB I-Code and D-Code accesses to the
Flash memory. It implements the erase and program Flash memory operations and the
read and write protection mechanisms.
The Flash memory interface accelerates code execution with a system of instruction
prefetch.
The FLASH main features are:
Flash memory read operations
Flash memory program/erase operations
Read / write protections
Prefetch on I-Code
Option Bytes programming
18.2.2
How to use this driver
This driver provides functions and macros to configure and program the FLASH memory of
all STM32F0xx devices.
DocID026525 Rev 6
197/1320
HAL FLASH Generic Driver
UM1785
1. FLASH Memory I/O Programming functions: this group includes all needed functions
to erase and program the main memory:
Lock and Unlock the FLASH interface
Erase function: Erase page, erase all pages
Program functions: half word, word and doubleword
2. FLASH Option Bytes Programming functions: this group includes all needed functions
to manage the Option Bytes:
Lock and Unlock the Option Bytes
Set/Reset the write protection
Set the Read protection Level
Program the user Option Bytes
Launch the Option Bytes loader
Erase Option Bytes
Program the data Option Bytes
Get the Write protection.
Get the user option bytes.
3. Interrupts and flags management functions : this group includes all needed functions
to:
Handle FLASH interrupts
Wait for last FLASH operation according to its status
Get error flag status
In addition to these function, this driver includes a set of macros allowing to handle the
following operations:
Set/Get the latency
Enable/Disable the prefetch buffer
Enable/Disable the FLASH interrupts
Monitor the FLASH flags status
18.2.3
Peripheral Control functions
This subsection provides a set of functions allowing to control the FLASH memory
operations.
This section contains the following APIs:
HAL_FLASH_Unlock()
HAL_FLASH_Lock()
HAL_FLASH_OB_Unlock()
HAL_FLASH_OB_Lock()
HAL_FLASH_OB_Launch()
18.2.4
Peripheral Errors functions
This subsection permit to get in run-time errors of the FLASH peripheral.
This section contains the following APIs:
HAL_FLASH_GetError()
198/1320
DocID026525 Rev 6
UM1785
18.2.5
HAL FLASH Generic Driver
Detailed description of functions
HAL_FLASH_Program
Function name
HAL_StatusTypeDef HAL_FLASH_Program (uint32_t
TypeProgram, uint32_t Address, uint64_t Data)
Function description
Program halfword, word or double word at a specified address.
Parameters
TypeProgram: Indicate the way to program at a specified
address. This parameter can be a value of FLASH Type
Program
Address: Specifie the address to be programmed.
Data: Specifie the data to be programmed
Return values
HAL_StatusTypeDef: HAL Status
Notes
The function HAL_FLASH_Unlock() should be called before
to unlock the FLASH interface The function
HAL_FLASH_Lock() should be called after to lock the FLASH
interface
If an erase and a program operations are requested
simultaneously, the erase operation is performed before the
program one.
FLASH should be previously erased before new
programmation (only exception to this is when 0x0000 is
programmed)
HAL_FLASH_Program_IT
Function name
HAL_StatusTypeDef HAL_FLASH_Program_IT (uint32_t
TypeProgram, uint32_t Address, uint64_t Data)
Function description
Program halfword, word or double word at a specified address with
interrupt enabled.
Parameters
TypeProgram: Indicate the way to program at a specified
address. This parameter can be a value of FLASH Type
Program
Address: Specifie the address to be programmed.
Data: Specifie the data to be programmed
Return values
HAL_StatusTypeDef: HAL Status
Notes
The function HAL_FLASH_Unlock() should be called before
to unlock the FLASH interface The function
HAL_FLASH_Lock() should be called after to lock the FLASH
interface
If an erase and a program operations are requested
simultaneously, the erase operation is performed before the
program one.
HAL_FLASH_IRQHandler
Function name
void HAL_FLASH_IRQHandler (void )
Function description
This function handles FLASH interrupt request.
Return values
None
DocID026525 Rev 6
199/1320
HAL FLASH Generic Driver
UM1785
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: No return value expected
Pages Erase: Address of the page which has been
erased (if 0xFFFFFFFF, it means that all the selected
pages have been erased)
Program: Address which was selected for data program
Return values
None
HAL_FLASH_OperationErrorCallback
Function name
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: No return value expected
Pages Erase: Address of the page which returned an
error
Program: Address which was selected for data program
Return values
None
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
200/1320
HAL: Status
DocID026525 Rev 6
UM1785
HAL FLASH Generic Driver
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
Notes
This function will reset automatically the MCU.
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: FLASH
Error Codes
FLASH_WaitForLastOperation
Function name
HAL_StatusTypeDef FLASH_WaitForLastOperation (uint32_t
Timeout)
Function description
Wait for a FLASH operation to complete.
Parameters
Timeout: maximum flash operation timeout
Return values
HAL: Status
18.3
FLASH Firmware driver defines
18.3.1
FLASH
FLASH Error Codes
HAL_FLASH_ERROR_NONE
No error
HAL_FLASH_ERROR_PROG
Programming error
HAL_FLASH_ERROR_WRP
Write protection error
FLASH Flag definition
FLASH_FLAG_BSY
FLASH Busy flag
FLASH_FLAG_PGERR
FLASH Programming error flag
FLASH_FLAG_WRPERR
FLASH Write protected error flag
FLASH_FLAG_EOP
FLASH End of Operation flag
DocID026525 Rev 6
201/1320
HAL FLASH Generic Driver
FLASH Interrupts
UM1785
Description:
__HAL_FLASH_ENABLE_IT
Enable the specified FLASH interrupt.
Parameters:
__INTERRUPT__: FLASH interrupt This parameter
can be any combination of the following values:
FLASH_IT_EOP End of FLASH Operation
Interrupt
FLASH_IT_ERR Error Interrupt
Return value:
none
__HAL_FLASH_DISABLE_IT
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:
__FLAG__: specifies the FLASH flag to check. This
parameter can be one of the following values:
FLASH_FLAG_BSY FLASH Busy flag
FLASH_FLAG_EOP FLASH End of Operation
flag
FLASH_FLAG_WRPERR FLASH Write
protected error flag
FLASH_FLAG_PGERR FLASH Programming
error flag
Return value:
The: new state of __FLAG__ (SET or RESET).
__HAL_FLASH_CLEAR_FLAG
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
202/1320
DocID026525 Rev 6
UM1785
HAL FLASH Generic Driver
FLASH_FLAG_WRPERR FLASH Write
protected error flag
FLASH_FLAG_PGERR FLASH Programming
error flag
Return value:
none
FLASH Interrupt definition
FLASH_IT_EOP
End of FLASH Operation Interrupt source
FLASH_IT_ERR
Error Interrupt source
FLASH Latency
FLASH_LATENCY_0
FLASH Zero Latency cycle
FLASH_LATENCY_1
FLASH One Latency cycle
FLASH Prefetch
__HAL_FLASH_PREFETCH_BUFFER_ENABLE
Description:
Enable the FLASH prefetch
buffer.
Return value:
None
__HAL_FLASH_PREFETCH_BUFFER_DISABLE
Description:
Disable the FLASH prefetch
buffer.
Return value:
None
FLASH Type Program
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
DocID026525 Rev 6
203/1320
HAL FLASH Extension Driver
UM1785
19
HAL FLASH Extension Driver
19.1
FLASHEx Firmware driver registers structures
19.1.1
FLASH_EraseInitTypeDef
Data Fields
uint32_t TypeErase
uint32_t PageAddress
uint32_t NbPages
Field Documentation
uint32_t FLASH_EraseInitTypeDef::TypeErase
TypeErase: Mass erase or page erase. This parameter can be a value of
FLASHEx_Type_Erase
uint32_t FLASH_EraseInitTypeDef::PageAddress
PageAdress: Initial FLASH page address to erase when mass erase is disabled This
parameter must be a number between Min_Data = FLASH_BASE and Max_Data =
FLASH_BANK1_END
uint32_t FLASH_EraseInitTypeDef::NbPages
NbPages: Number of pagess to be erased. This parameter must be a value between
Min_Data = 1 and Max_Data = (max number of pages - value of initial page)
19.1.2
FLASH_OBProgramInitTypeDef
Data Fields
uint32_t OptionType
uint32_t WRPState
uint32_t WRPPage
uint8_t RDPLevel
uint8_t USERConfig
uint32_t DATAAddress
uint8_t DATAData
Field Documentation
uint32_t FLASH_OBProgramInitTypeDef::OptionType
OptionType: Option byte to be configured. This parameter can be a value of
FLASHEx_OB_Type
uint32_t FLASH_OBProgramInitTypeDef::WRPState
WRPState: Write protection activation or deactivation. This parameter can be a value
of FLASHEx_OB_WRP_State
uint32_t FLASH_OBProgramInitTypeDef::WRPPage
WRPPage: specifies the page(s) to be write protected This parameter can be a value
of FLASHEx_OB_Write_Protection
uint8_t FLASH_OBProgramInitTypeDef::RDPLevel
RDPLevel: Set the read protection level.. This parameter can be a value of
FLASHEx_OB_Read_Protection
uint8_t FLASH_OBProgramInitTypeDef::USERConfig
USERConfig: Program the FLASH User Option Byte: IWDG / STOP / STDBY /
BOOT1 / VDDA_ANALOG / SRAM_PARITY This parameter can be a combination of
FLASHEx_OB_IWatchdog, FLASHEx_OB_nRST_STOP,
204/1320
DocID026525 Rev 6
UM1785
HAL FLASH Extension Driver
FLASHEx_OB_nRST_STDBY, FLASHEx_OB_BOOT1,
FLASHEx_OB_VDDA_Analog_Monitoring and
FLASHEx_OB_RAM_Parity_Check_Enable
uint32_t FLASH_OBProgramInitTypeDef::DATAAddress
DATAAddress: Address of the option byte DATA to be programmed This parameter
can be a value of FLASHEx_OB_Data_Address
uint8_t FLASH_OBProgramInitTypeDef::DATAData
DATAData: Data to be stored in the option byte DATA This parameter must be a
number between Min_Data = 0x00 and Max_Data = 0xFF
19.2
FLASHEx Firmware driver API description
19.2.1
FLASH Erasing Programming functions
The FLASH Memory Erasing functions, includes the following functions:
@ref HAL_FLASHEx_Erase: return only when erase has been done
@ref HAL_FLASHEx_Erase_IT: end of erase is done when @ref
HAL_FLASH_EndOfOperationCallback is called with parameter 0xFFFFFFFF
Any operation of erase should follow these steps:
1.
2.
3.
Call the @ref HAL_FLASH_Unlock() function to enable the flash control register and
program memory access.
Call the desired function to erase page.
Call the @ref HAL_FLASH_Lock() to disable the flash program memory access
(recommended to protect the FLASH memory against possible unwanted operation).
This section contains the following APIs:
HAL_FLASHEx_Erase()
HAL_FLASHEx_Erase_IT()
19.2.2
Option Bytes Programming functions
This subsection provides a set of functions allowing to control the FLASH option bytes
operations.
This section contains the following APIs:
HAL_FLASHEx_OBErase()
HAL_FLASHEx_OBProgram()
HAL_FLASHEx_OBGetConfig()
HAL_FLASHEx_OBGetUserData()
19.2.3
Detailed description of functions
HAL_FLASHEx_Erase
Function name
HAL_StatusTypeDef HAL_FLASHEx_Erase
(FLASH_EraseInitTypeDef * pEraseInit, uint32_t * PageError)
Function description
Perform a mass erase or erase the specified FLASH memory
pages.
Parameters
pEraseInit: pointer to an FLASH_EraseInitTypeDef structure
that contains the configuration information for the erasing.
PageError: pointer to variable that contains the configuration
information on faulty page in case of error (0xFFFFFFFF
DocID026525 Rev 6
205/1320
HAL FLASH Extension Driver
UM1785
means that all the pages have been correctly erased)
Return values
HAL_StatusTypeDef: HAL Status
Notes
To correctly run this function, the HAL_FLASH_Unlock()
function must be called before. Call the HAL_FLASH_Lock()
to disable the flash memory access (recommended to protect
the FLASH memory against possible unwanted operation)
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
pages with interrupt enabled.
Parameters
pEraseInit: pointer to an FLASH_EraseInitTypeDef structure
that contains the configuration information for the erasing.
Return values
HAL_StatusTypeDef: HAL Status
Notes
To correctly run this function, the HAL_FLASH_Unlock()
function must be called before. Call the HAL_FLASH_Lock()
to disable the flash memory access (recommended to protect
the FLASH memory against possible unwanted operation)
HAL_FLASHEx_OBErase
Function name
HAL_StatusTypeDef HAL_FLASHEx_OBErase (void )
Function description
Erases the FLASH option bytes.
Return values
HAL: status
Notes
This functions erases all option bytes except the Read
protection (RDP). The function HAL_FLASH_Unlock() should
be called before to unlock the FLASH interface The function
HAL_FLASH_OB_Unlock() should be called before to unlock
the options bytes The function HAL_FLASH_OB_Launch()
should be called after to force the reload of the options bytes
(system reset will occur)
HAL_FLASHEx_OBProgram
206/1320
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_StatusTypeDef: HAL Status
Notes
The function HAL_FLASH_Unlock() should be called before
to unlock the FLASH interface The function
HAL_FLASH_OB_Unlock() should be called before to unlock
the options bytes The function HAL_FLASH_OB_Launch()
should be called after to force the reload of the options bytes
DocID026525 Rev 6
UM1785
HAL FLASH Extension Driver
(system reset will occur)
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
HAL_FLASHEx_OBGetUserData
Function name
uint32_t HAL_FLASHEx_OBGetUserData (uint32_t
DATAAdress)
Function description
Get the Option byte user data.
Parameters
DATAAdress: Address of the option byte DATA This
parameter can be one of the following values:
OB_DATA_ADDRESS_DATA0
OB_DATA_ADDRESS_DATA1
Return values
Value: programmed in USER data
19.3
FLASHEx Firmware driver defines
19.3.1
FLASHEx
FLASHEx Option Byte BOOT0
OB_BOOT0_RESET
BOOT0 Reset
OB_BOOT0_SET
BOOT0 Set
Option Byte BOOT1
OB_BOOT1_RESET
BOOT1 Reset
OB_BOOT1_SET
BOOT1 Set
FLASHEx Option Byte BOOT SEL
OB_BOOT_SEL_RESET
BOOT_SEL Reset
OB_BOOT_SEL_SET
BOOT_SEL Set
Option Byte Data Address
OB_DATA_ADDRESS_DATA0
OB_DATA_ADDRESS_DATA1
Option Byte IWatchdog
OB_IWDG_SW
Software IWDG selected
OB_IWDG_HW
Hardware IWDG selected
DocID026525 Rev 6
207/1320
HAL FLASH Extension Driver
Option Byte nRST STDBY
UM1785
OB_STDBY_NO_RST
No reset generated when entering in STANDBY
OB_STDBY_RST
Reset generated when entering in STANDBY
Option Byte nRST STOP
OB_STOP_NO_RST
No reset generated when entering in STOP
OB_STOP_RST
Reset generated when entering in STOP
Option Byte SRAM Parity Check Enable
OB_SRAM_PARITY_SET
SRAM parity check enable set
OB_SRAM_PARITY_RESET
SRAM parity check enable reset
Option Byte 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
Option Bytes Type
OPTIONBYTE_WRP
WRP option byte configuration
OPTIONBYTE_RDP
RDP option byte configuration
OPTIONBYTE_USER
USER option byte configuration
OPTIONBYTE_DATA
DATA option byte configuration
Option Byte VDDA Analog Monitoring
OB_VDDA_ANALOG_ON
Analog monitoring on VDDA Power source ON
OB_VDDA_ANALOG_OFF
Analog monitoring on VDDA Power source OFF
FLASHEx OB Write Protection
OB_WRP_PAGES0TO1
OB_WRP_PAGES2TO3
OB_WRP_PAGES4TO5
OB_WRP_PAGES6TO7
OB_WRP_PAGES8TO9
OB_WRP_PAGES10TO11
OB_WRP_PAGES12TO13
OB_WRP_PAGES14TO15
OB_WRP_PAGES16TO17
OB_WRP_PAGES18TO19
OB_WRP_PAGES20TO21
OB_WRP_PAGES22TO23
OB_WRP_PAGES24TO25
OB_WRP_PAGES26TO27
208/1320
DocID026525 Rev 6
UM1785
HAL FLASH Extension Driver
OB_WRP_PAGES28TO29
OB_WRP_PAGES30TO31
OB_WRP_PAGES32TO33
OB_WRP_PAGES34TO35
OB_WRP_PAGES36TO37
OB_WRP_PAGES38TO39
OB_WRP_PAGES40TO41
OB_WRP_PAGES42TO43
OB_WRP_PAGES44TO45
OB_WRP_PAGES46TO47
OB_WRP_PAGES48TO49
OB_WRP_PAGES50TO51
OB_WRP_PAGES52TO53
OB_WRP_PAGES54TO55
OB_WRP_PAGES56TO57
OB_WRP_PAGES58TO59
OB_WRP_PAGES60TO61
OB_WRP_PAGES62TO127
OB_WRP_PAGES0TO15MASK
OB_WRP_PAGES16TO31MASK
OB_WRP_PAGES32TO47MASK
OB_WRP_PAGES48TO127MASK
OB_WRP_ALLPAGES
Write protection of all pages
Option Byte WRP State
OB_WRPSTATE_DISABLE
Disable the write protection of the desired pages
OB_WRPSTATE_ENABLE
Enable the write protection of the desired pagess
FLASHEx Page Size
FLASH_PAGE_SIZE
FLASH Type Erase
FLASH_TYPEERASE_PAGES
Pages erase only
FLASH_TYPEERASE_MASSERASE
Flash mass erase activation
DocID026525 Rev 6
209/1320
HAL GPIO Generic Driver
UM1785
20
HAL GPIO Generic Driver
20.1
GPIO Firmware driver registers structures
20.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
uint32_t GPIO_InitTypeDef::Mode
Specifies the operating mode for the selected pins. This parameter can be a value of
GPIO_mode
uint32_t GPIO_InitTypeDef::Pull
Specifies the Pull-up or Pull-Down activation for the selected pins. This parameter can
be a value of GPIO_pull
uint32_t GPIO_InitTypeDef::Speed
Specifies the speed for the selected pins. This parameter can be a value of
GPIO_speed
uint32_t GPIO_InitTypeDef::Alternate
Peripheral to be connected to the selected pins This parameter can be a value of
GPIOEx_Alternate_function_selection
20.2
GPIO Firmware driver API description
20.2.1
GPIO Peripheral features
Each port bit of the general-purpose I/O (GPIO) ports can be individually configured by
software in several modes:
Input mode
Analog mode
Output mode
Alternate function mode
External interrupt/event lines
During and just after reset, the alternate functions and external interrupt lines are not
active and the I/O ports are configured in input floating mode.
All GPIO pins have weak internal pull-up and pull-down resistors, which can be
activated or not.
In Output or Alternate mode, each IO can be configured on open-drain or push-pull
type and the IO speed can be selected depending on the VDD value.
The microcontroller IO pins are connected to onboard peripherals/modules through a
multiplexer that allows only one peripheral alternate function (AF) connected to an IO
pin at a time. In this way, there can be no conflict between peripherals sharing the
same IO pin.
210/1320
DocID026525 Rev 6
UM1785
HAL GPIO Generic Driver
All ports have external interrupt/event capability. To use external interrupt lines, the
port must be configured in input mode. All available GPIO pins are connected to the
16 external interrupt/event lines from EXTI0 to EXTI15.
The external interrupt/event controller consists of up to 28 edge detectors (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.
20.2.2
How to use this driver
1.
Enable the GPIO AHB clock using the following function :
__HAL_RCC_GPIOx_CLK_ENABLE().
2. 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).
3. In case of external interrupt/event mode selection, configure NVIC IRQ priority
mapped to the EXTI line using HAL_NVIC_SetPriority() and enable it using
HAL_NVIC_EnableIRQ().
4. HAL_GPIO_DeInit allows to set register values to their reset value. It's also
recommended to use it to unconfigure pin which was used as an external interrupt or
in event mode. That's the only way to reset corresponding bit in EXTI & SYSCFG
registers.
5. To get the level of a pin configured in input mode use HAL_GPIO_ReadPin().
6. To set/reset the level of a pin configured in output mode use
HAL_GPIO_WritePin()/HAL_GPIO_TogglePin().
7. To lock pin configuration until next reset use HAL_GPIO_LockPin().
8. During and just after reset, the alternate functions are not active and the GPIO pins
are configured in input floating mode (except JTAG pins).
9. The LSE oscillator pins OSC32_IN and OSC32_OUT can be used as general purpose
(PC14 and PC15, respectively) when the LSE oscillator is off. The LSE has priority
over the GPIO function.
10. The HSE oscillator pins OSC_IN/OSC_OUT can be used as general purpose PF0 and
PF1, respectively, when the HSE oscillator is off. The HSE has priority over the GPIO
function.
20.2.3
Initialization and de-initialization functions
This section contains the following APIs:
HAL_GPIO_Init()
HAL_GPIO_DeInit()
20.2.4
IO operation functions
This section contains the following APIs:
HAL_GPIO_ReadPin()
DocID026525 Rev 6
211/1320
HAL GPIO Generic Driver
UM1785
HAL_GPIO_WritePin()
HAL_GPIO_TogglePin()
HAL_GPIO_LockPin()
HAL_GPIO_EXTI_IRQHandler()
HAL_GPIO_EXTI_Callback()
20.2.5
Detailed description of functions
HAL_GPIO_Init
Function name
void HAL_GPIO_Init (GPIO_TypeDef * GPIOx,
GPIO_InitTypeDef * GPIO_Init)
Function description
Initialize the GPIOx peripheral according to the specified
parameters in the GPIO_Init.
Parameters
GPIOx: where x can be (A..F) to select the GPIO peripheral
for STM32F0 family
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-initialize the GPIOx peripheral registers to their default reset
values.
Parameters
GPIOx: where x can be (A..F) to select the GPIO peripheral
for STM32F0 family
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
Read the specified input port pin.
Parameters
GPIOx: where x can be (A..F) to select the GPIO peripheral
for STM32F0 family
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
212/1320
Function name
void HAL_GPIO_WritePin (GPIO_TypeDef * GPIOx, uint16_t
GPIO_Pin, GPIO_PinState PinState)
Function description
Set or clear the selected data port bit.
DocID026525 Rev 6
UM1785
HAL GPIO Generic Driver
Parameters
GPIOx: where x can be (A..H) to select the GPIO peripheral
for STM32F0 family
GPIO_Pin: specifies the port bit to be written. This parameter
can be one of GPIO_PIN_x where x can be (0..15).
PinState: specifies the value to be written to the selected bit.
This parameter can be one of the GPIO_PinState enum
values:
GPIO_PIN_RESET: to clear the port pin
GPIO_PIN_SET: to set the port pin
Return values
None
Notes
This function uses GPIOx_BSRR and GPIOx_BRR registers
to allow atomic read/modify accesses. In this way, there is no
risk of an IRQ occurring between the read and the modify
access.
HAL_GPIO_TogglePin
Function name
void HAL_GPIO_TogglePin (GPIO_TypeDef * GPIOx, uint16_t
GPIO_Pin)
Function description
Toggle the specified GPIO pin.
Parameters
GPIOx: where x can be (A..F) to select the GPIO peripheral
for STM32F0 family
GPIO_Pin: specifies the pin 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..F) to select the GPIO peripheral
for STM32F0 family
GPIO_Pin: specifies the port bits 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.
HAL_GPIO_EXTI_IRQHandler
Function name
void HAL_GPIO_EXTI_IRQHandler (uint16_t GPIO_Pin)
Function description
Handle EXTI interrupt request.
Parameters
GPIO_Pin: Specifies the port pin connected to corresponding
EXTI line.
DocID026525 Rev 6
213/1320
HAL GPIO Generic Driver
Return values
UM1785
None
HAL_GPIO_EXTI_Callback
Function name
void HAL_GPIO_EXTI_Callback (uint16_t GPIO_Pin)
Function description
EXTI line detection callback.
Parameters
GPIO_Pin: Specifies the port pin connected to corresponding
EXTI line.
Return values
None
20.3
GPIO Firmware driver defines
20.3.1
GPIO
GPIO Exported Macros
__HAL_GPIO_EXTI_GET_FLAG
Description:
Check 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:
The: new state of __EXTI_LINE__ (SET or
RESET).
__HAL_GPIO_EXTI_CLEAR_FLAG
Description:
Clear 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:
None
__HAL_GPIO_EXTI_GET_IT
Description:
Check 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:
The: new state of __EXTI_LINE__ (SET or
214/1320
DocID026525 Rev 6
UM1785
HAL GPIO Generic Driver
RESET).
__HAL_GPIO_EXTI_CLEAR_IT
Description:
Clear 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:
None
__HAL_GPIO_EXTI_GENERATE_SWIT
Description:
Generate 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
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
DocID026525 Rev 6
215/1320
HAL GPIO Generic Driver
GPIO pins
UM1785
GPIO_PIN_0
GPIO_PIN_1
GPIO_PIN_2
GPIO_PIN_3
GPIO_PIN_4
GPIO_PIN_5
GPIO_PIN_6
GPIO_PIN_7
GPIO_PIN_8
GPIO_PIN_9
GPIO_PIN_10
GPIO_PIN_11
GPIO_PIN_12
GPIO_PIN_13
GPIO_PIN_14
GPIO_PIN_15
GPIO_PIN_All
GPIO_PIN_MASK
GPIO pull
GPIO_NOPULL
No Pull-up or Pull-down activation
GPIO_PULLUP
Pull-up activation
GPIO_PULLDOWN
Pull-down activation
GPIO speed
216/1320
GPIO_SPEED_FREQ_LOW
range up to 2 MHz, please refer to the product
datasheet
GPIO_SPEED_FREQ_MEDIUM
range 4 MHz to 10 MHz, please refer to the product
datasheet
GPIO_SPEED_FREQ_HIGH
range 10 MHz to 50 MHz, please refer to the product
datasheet
DocID026525 Rev 6
UM1785
HAL GPIO Extension Driver
21
HAL GPIO Extension Driver
21.1
GPIOEx Firmware driver defines
21.1.1
GPIOEx
GPIOEx Alternate function selection
GPIO_AF0_EVENTOUT
AF0: EVENTOUT Alternate Function mapping
GPIO_AF0_SWDIO
AF0: SWDIO Alternate Function mapping
GPIO_AF0_SWCLK
AF0: SWCLK Alternate Function mapping
GPIO_AF0_MCO
AF0: MCO Alternate Function mapping
GPIO_AF0_CEC
AF0: CEC Alternate Function mapping
GPIO_AF0_CRS
AF0: CRS Alternate Function mapping
GPIO_AF0_IR
AF0: IR Alternate Function mapping
GPIO_AF0_SPI1
AF0: SPI1/I2S1 Alternate Function mapping
GPIO_AF0_SPI2
AF0: SPI2/I2S2 Alternate Function mapping
GPIO_AF0_TIM1
AF0: TIM1 Alternate Function mapping
GPIO_AF0_TIM3
AF0: TIM3 Alternate Function mapping
GPIO_AF0_TIM14
AF0: TIM14 Alternate Function mapping
GPIO_AF0_TIM15
AF0: TIM15 Alternate Function mapping
GPIO_AF0_TIM16
AF0: TIM16 Alternate Function mapping
GPIO_AF0_TIM17
AF0: TIM17 Alternate Function mapping
GPIO_AF0_TSC
AF0: TSC Alternate Function mapping
GPIO_AF0_USART1
AF0: USART1 Alternate Function mapping
GPIO_AF0_USART2
AF0: USART2 Alternate Function mapping
GPIO_AF0_USART3
AF0: USART3 Alternate Function mapping
GPIO_AF0_USART4
AF0: USART4 Alternate Function mapping
GPIO_AF0_USART8
AF0: USART8 Alternate Function mapping
GPIO_AF0_CAN
AF0: CAN Alternate Function mapping
GPIO_AF1_TIM3
AF1: TIM3 Alternate Function mapping
GPIO_AF1_TIM15
AF1: TIM15 Alternate Function mapping
GPIO_AF1_USART1
AF1: USART1 Alternate Function mapping
GPIO_AF1_USART2
AF1: USART2 Alternate Function mapping
GPIO_AF1_USART3
AF1: USART3 Alternate Function mapping
GPIO_AF1_USART4
AF1: USART4 Alternate Function mapping
GPIO_AF1_USART5
AF1: USART5 Alternate Function mapping
GPIO_AF1_USART6
AF1: USART6 Alternate Function mapping
DocID026525 Rev 6
217/1320
HAL GPIO Extension Driver
GPIO_AF1_USART7
AF1: USART7 Alternate Function mapping
GPIO_AF1_USART8
AF1: USART8 Alternate Function mapping
GPIO_AF1_IR
AF1: IR Alternate Function mapping
GPIO_AF1_CEC
AF1: CEC Alternate Function mapping
GPIO_AF1_EVENTOUT
AF1: EVENTOUT Alternate Function mapping
GPIO_AF1_I2C1
AF1: I2C1 Alternate Function mapping
GPIO_AF1_I2C2
AF1: I2C2 Alternate Function mapping
GPIO_AF1_TSC
AF1: TSC Alternate Function mapping
GPIO_AF1_SPI1
AF1: SPI1 Alternate Function mapping
GPIO_AF1_SPI2
AF1: SPI2 Alternate Function mapping
GPIO_AF2_TIM1
AF2: TIM1 Alternate Function mapping
GPIO_AF2_TIM2
AF2: TIM2 Alternate Function mapping
GPIO_AF2_TIM16
AF2: TIM16 Alternate Function mapping
GPIO_AF2_TIM17
AF2: TIM17 Alternate Function mapping
GPIO_AF2_EVENTOUT
AF2: EVENTOUT Alternate Function mapping
GPIO_AF2_USART5
AF2: USART5 Alternate Function mapping
GPIO_AF2_USART6
AF2: USART6 Alternate Function mapping
GPIO_AF2_USART7
AF2: USART7 Alternate Function mapping
GPIO_AF2_USART8
AF2: USART8 Alternate Function mapping
GPIO_AF3_EVENTOUT
AF3: EVENTOUT Alternate Function mapping
GPIO_AF3_TSC
AF3: TSC Alternate Function mapping
GPIO_AF3_TIM15
AF3: TIM15 Alternate Function mapping
GPIO_AF3_I2C1
AF3: I2C1 Alternate Function mapping
GPIO_AF4_TIM14
AF4: TIM14 Alternate Function mapping
GPIO_AF4_USART4
AF4: USART4 Alternate Function mapping
GPIO_AF4_USART3
AF4: USART3 Alternate Function mapping
GPIO_AF4_CRS
AF4: CRS Alternate Function mapping
GPIO_AF4_CAN
AF4: CAN Alternate Function mapping
GPIO_AF4_I2C1
AF4: I2C1 Alternate Function mapping
GPIO_AF4_USART5
AF4: USART5 Alternate Function mapping
GPIO_AF5_TIM15
AF5: TIM15 Alternate Function mapping
GPIO_AF5_TIM16
AF5: TIM16 Alternate Function mapping
GPIO_AF5_TIM17
AF5: TIM17 Alternate Function mapping
GPIO_AF5_SPI2
AF5: SPI2 Alternate Function mapping
GPIO_AF5_I2C2
AF5: I2C2 Alternate Function mapping
GPIO_AF5_MCO
AF5: MCO Alternate Function mapping
218/1320
UM1785
DocID026525 Rev 6
UM1785
GPIO_AF5_USART6
HAL GPIO Extension Driver
AF5: USART6 Alternate Function mapping
GPIO_AF6_EVENTOUT
AF6: EVENTOUT Alternate Function mapping
GPIO_AF7_COMP1
AF7: COMP1 Alternate Function mapping
GPIO_AF7_COMP2
AF7: COMP2 Alternate Function mapping
IS_GPIO_AF
GPIOEx_Get Port Index
GPIO_GET_INDEX
DocID026525 Rev 6
219/1320
HAL I2C Generic Driver
UM1785
22
HAL I2C Generic Driver
22.1
I2C Firmware driver registers structures
22.1.1
I2C_InitTypeDef
Data Fields
uint32_t Timing
uint32_t OwnAddress1
uint32_t AddressingMode
uint32_t DualAddressMode
uint32_t OwnAddress2
uint32_t OwnAddress2Masks
uint32_t GeneralCallMode
uint32_t NoStretchMode
Field Documentation
uint32_t I2C_InitTypeDef::Timing
Specifies the I2C_TIMINGR_register value. This parameter calculated by referring to
I2C initialization section in Reference manual
uint32_t I2C_InitTypeDef::OwnAddress1
Specifies the first device own address. This parameter can be a 7-bit or 10-bit
address.
uint32_t I2C_InitTypeDef::AddressingMode
Specifies if 7-bit or 10-bit addressing mode is selected. This parameter can be a value
of I2C_ADDRESSING_MODE
uint32_t I2C_InitTypeDef::DualAddressMode
Specifies if dual addressing mode is selected. This parameter can be a value of
I2C_DUAL_ADDRESSING_MODE
uint32_t I2C_InitTypeDef::OwnAddress2
Specifies the second device own address if dual addressing mode is selected This
parameter can be a 7-bit address.
uint32_t I2C_InitTypeDef::OwnAddress2Masks
Specifies the acknowledge mask address second device own address if dual
addressing mode is selected This parameter can be a value of
I2C_OWN_ADDRESS2_MASKS
uint32_t I2C_InitTypeDef::GeneralCallMode
Specifies if general call mode is selected. This parameter can be a value of
I2C_GENERAL_CALL_ADDRESSING_MODE
uint32_t I2C_InitTypeDef::NoStretchMode
Specifies if nostretch mode is selected. This parameter can be a value of
I2C_NOSTRETCH_MODE
22.1.2
__I2C_HandleTypeDef
Data Fields
I2C_TypeDef * Instance
I2C_InitTypeDef Init
uint8_t * pBuffPtr
uint16_t XferSize
__IO uint16_t XferCount
220/1320
DocID026525 Rev 6
UM1785
HAL I2C Generic Driver
__IO uint32_t XferOptions
__IO uint32_t PreviousState
HAL_StatusTypeDef(* XferISR
DMA_HandleTypeDef * hdmatx
DMA_HandleTypeDef * hdmarx
HAL_LockTypeDef Lock
__IO HAL_I2C_StateTypeDef State
__IO HAL_I2C_ModeTypeDef Mode
__IO uint32_t ErrorCode
__IO uint32_t AddrEventCount
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
__IO uint32_t __I2C_HandleTypeDef::XferOptions
I2C sequantial transfer options, this parameter can be a value of I2C_XFEROPTIONS
__IO uint32_t __I2C_HandleTypeDef::PreviousState
I2C communication Previous state
HAL_StatusTypeDef(* __I2C_HandleTypeDef::XferISR)(struct
__I2C_HandleTypeDef *hi2c, uint32_t ITFlags, uint32_t ITSources)
I2C transfer IRQ handler function pointer
DMA_HandleTypeDef* __I2C_HandleTypeDef::hdmatx
I2C Tx DMA handle parameters
DMA_HandleTypeDef* __I2C_HandleTypeDef::hdmarx
I2C Rx DMA handle parameters
HAL_LockTypeDef __I2C_HandleTypeDef::Lock
I2C locking object
__IO HAL_I2C_StateTypeDef __I2C_HandleTypeDef::State
I2C communication state
__IO HAL_I2C_ModeTypeDef __I2C_HandleTypeDef::Mode
I2C communication mode
__IO uint32_t __I2C_HandleTypeDef::ErrorCode
I2C Error code
__IO uint32_t __I2C_HandleTypeDef::AddrEventCount
I2C Address Event counter
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.
Declare a I2C_HandleTypeDef handle structure, for example: I2C_HandleTypeDef
hi2c;
Initialize the I2C low level resources by implementing the HAL_I2C_MspInit() API:
a. Enable the I2Cx interface clock
DocID026525 Rev 6
221/1320
HAL I2C Generic Driver
UM1785
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
Declare a DMA_HandleTypeDef handle structure for the transmit or receive
channel
Enable the DMAx interface clock using
Configure the DMA handle parameters
Configure the DMA Tx or Rx channel
Associate the 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 channel
3. Configure the Communication Clock Timing, Own Address1, Master Addressing
mode, Dual Addressing mode, Own Address2, Own Address2 Mask, General call and
Nostretch mode in the hi2c Init structure.
4. 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.
5. To check if target device is ready for communication, use the function
HAL_I2C_IsDeviceReady()
6. 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()
222/1320
DocID026525 Rev 6
UM1785
HAL I2C Generic Driver
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()
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()
Abort a master I2C process communication with Interrupt using
HAL_I2C_Master_Abort_IT()
End of abort process, HAL_I2C_AbortCpltCallback() is executed and user can add his
own code by customization of function pointer HAL_I2C_AbortCpltCallback()
Discard a slave I2C process communication using __HAL_I2C_GENERATE_NACK()
macro. This action will inform Master to generate a Stop condition to discard the
communication.
Interrupt mode IO sequential operation
These interfaces allow to manage a sequential transfer with a repeated start
condition when a direction change during transfer
A specific option field manage the different steps of a sequential transfer
Option field values are defined through @ref I2C_XFEROPTIONS and are listed
below:
I2C_FIRST_AND_LAST_FRAME: No sequential usage, functionnal is same as
associated interfaces in no sequential mode
I2C_FIRST_FRAME: Sequential usage, this option allow to manage a sequence
with start condition, address and data to transfer without a final stop condition
I2C_FIRST_AND_NEXT_FRAME: Sequential usage (Master only), this option
allow to manage a sequence with start condition, address and data to transfer
without a final stop condition, an then permit a call the same master sequential
interface several times (like HAL_I2C_Master_Sequential_Transmit_IT() then
HAL_I2C_Master_Sequential_Transmit_IT())
I2C_NEXT_FRAME: Sequential usage, this option allow to manage a sequence
with a restart condition, address and with new data to transfer if the direction
change or manage only the new data to transfer if no direction change and
without a final stop condition in both cases
I2C_LAST_FRAME: Sequential usage, this option allow to manage a sequance
with a restart condition, address and with new data to transfer if the direction
change or manage only the new data to transfer if no direction change and with a
final stop condition in both cases
Differents sequential I2C interfaces are listed below:
Sequential transmit in master I2C mode an amount of data in non-blocking mode
using HAL_I2C_Master_Sequential_Transmit_IT()
DocID026525 Rev 6
223/1320
HAL I2C Generic Driver
UM1785
At transmission end of current frame transfer,
HAL_I2C_MasterTxCpltCallback() is executed and user can add his own
code by customization of function pointer HAL_I2C_MasterTxCpltCallback()
Sequential receive in master I2C mode an amount of data in non-blocking mode
using HAL_I2C_Master_Sequential_Receive_IT()
At reception end of current frame transfer,
HAL_I2C_MasterRxCpltCallback() is executed and user can add his own
code by customization of function pointer HAL_I2C_MasterRxCpltCallback()
Abort a master I2C process communication with Interrupt using
HAL_I2C_Master_Abort_IT()
End of abort process, HAL_I2C_AbortCpltCallback() is executed and user
can add his own code by customization of function pointer
HAL_I2C_AbortCpltCallback()
Enable/disable the Address listen mode in slave I2C mode using
HAL_I2C_EnableListen_IT() HAL_I2C_DisableListen_IT()
When address slave I2C match, HAL_I2C_AddrCallback() is executed and
user can add his own code to check the Address Match Code and the
transmission direction request by master (Write/Read).
At Listen mode end HAL_I2C_ListenCpltCallback() is executed and user can
add his own code by customization of function pointer
HAL_I2C_ListenCpltCallback()
Sequential transmit in slave I2C mode an amount of data in non-blocking mode
using HAL_I2C_Slave_Sequential_Transmit_IT()
At transmission end of current frame transfer,
HAL_I2C_SlaveTxCpltCallback() is executed and user can add his own
code by customization of function pointer HAL_I2C_SlaveTxCpltCallback()
Sequential receive in slave I2C mode an amount of data in non-blocking mode
using HAL_I2C_Slave_Sequential_Receive_IT()
At reception end of current frame 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()
Abort a master I2C process communication with Interrupt using
HAL_I2C_Master_Abort_IT()
End of abort process, HAL_I2C_AbortCpltCallback() is executed and user can
add his own code by customization of function pointer
HAL_I2C_AbortCpltCallback()
Discard a slave I2C process communication using
__HAL_I2C_GENERATE_NACK() macro. This action will inform Master to
generate a Stop condition to discard the communication.
Interrupt mode IO MEM operation
Write an amount of data in non-blocking mode with Interrupt to a specific memory
address using HAL_I2C_Mem_Write_IT()
At Memory 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 non-blocking mode with Interrupt from a specific memory
address using HAL_I2C_Mem_Read_IT()
At Memory end of read transfer, HAL_I2C_MemRxCpltCallback() is executed and user
can add his own code by customization of function pointer
HAL_I2C_MemRxCpltCallback()
224/1320
DocID026525 Rev 6
UM1785
HAL I2C Generic Driver
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()
Abort a master I2C process communication with Interrupt using
HAL_I2C_Master_Abort_IT()
End of abort process, HAL_I2C_AbortCpltCallback() is executed and user can add his
own code by customization of function pointer HAL_I2C_AbortCpltCallback()
Discard a slave I2C process communication using __HAL_I2C_GENERATE_NACK()
macro. This action will inform Master to generate a Stop condition to discard the
communication.
DMA mode IO MEM operation
Write an amount of data in non-blocking mode with DMA to a specific memory
address using HAL_I2C_Mem_Write_DMA()
At Memory 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 non-blocking mode with DMA from a specific memory
address using HAL_I2C_Mem_Read_DMA()
At Memory 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
DocID026525 Rev 6
225/1320
HAL I2C Generic Driver
UM1785
__HAL_I2C_GENERATE_NACK: Generate a Non-Acknowledge I2C peripheral in
Slave mode
__HAL_I2C_GET_FLAG: Check 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 deinitialize 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:
Clock Timing
Own Address 1
Addressing mode (Master, Slave)
Dual Addressing mode
Own Address 2
Own Address 2 Mask
General call mode
Nostretch mode
Call the function HAL_I2C_DeInit() to restore the default configuration of the selected
I2Cx peripheral.
This section contains the following APIs:
HAL_I2C_Init()
HAL_I2C_DeInit()
HAL_I2C_MspInit()
HAL_I2C_MspDeInit()
22.2.3
IO operation functions
This subsection provides a set of functions allowing to manage the I2C data transfers.
1.
2.
226/1320
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 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()
DocID026525 Rev 6
UM1785
HAL I2C Generic Driver
3.
4.
5.
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:
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()
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_Master_Sequential_Transmit_IT()
HAL_I2C_Master_Sequential_Receive_IT()
HAL_I2C_Slave_Sequential_Transmit_IT()
HAL_I2C_Slave_Sequential_Receive_IT()
HAL_I2C_EnableListen_IT()
HAL_I2C_DisableListen_IT()
HAL_I2C_Master_Abort_IT()
DocID026525 Rev 6
227/1320
HAL I2C Generic Driver
22.2.4
UM1785
Peripheral State, Mode and Error functions
This subsection permit to get in run-time the status of the peripheral and the data flow.
This section contains the following APIs:
HAL_I2C_GetState()
HAL_I2C_GetMode()
HAL_I2C_GetError()
22.2.5
Detailed description of functions
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 initialize the associated handle.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
Return values
HAL: status
HAL_I2C_DeInit
Function name
HAL_StatusTypeDef HAL_I2C_DeInit (I2C_HandleTypeDef *
hi2c)
Function description
DeInitialize the I2C peripheral.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
Return values
HAL: status
HAL_I2C_MspInit
Function name
void HAL_I2C_MspInit (I2C_HandleTypeDef * hi2c)
Function description
Initialize the I2C MSP.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
Return values
None
HAL_I2C_MspDeInit
228/1320
Function name
void HAL_I2C_MspDeInit (I2C_HandleTypeDef * hi2c)
Function description
DeInitialize the I2C MSP.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
Return values
None
DocID026525 Rev 6
UM1785
HAL I2C Generic Driver
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
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
pData: Pointer to data buffer
Size: Amount of data to be sent
Timeout: Timeout duration
Return values
HAL: status
HAL_I2C_Master_Receive
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 the specified I2C.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
pData: Pointer to data buffer
Size: Amount of data to be sent
Timeout: Timeout duration
Return values
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
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
pData: Pointer to data buffer
Size: Amount of data to be sent
Timeout: Timeout duration
Return values
HAL: status
DocID026525 Rev 6
229/1320
HAL I2C Generic Driver
UM1785
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
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
pData: Pointer to data buffer
Size: Amount of data to be sent
Timeout: Timeout duration
Return values
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
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
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
Return values
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
230/1320
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
MemAddress: Internal memory address
MemAddSize: Size of internal memory address
pData: Pointer to data buffer
Size: Amount of data to be sent
DocID026525 Rev 6
UM1785
HAL I2C Generic Driver
Timeout: Timeout duration
Return values
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 the specified I2C.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
Trials: Number of trials
Timeout: Timeout duration
Return values
HAL: status
Notes
This function is used with Memory devices
HAL_I2C_Master_Transmit_IT
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 non-blocking mode
with Interrupt.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
pData: Pointer to data buffer
Size: Amount of data to be sent
Return values
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 non-blocking mode
with Interrupt.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
pData: Pointer to data buffer
DocID026525 Rev 6
231/1320
HAL I2C Generic Driver
UM1785
Size: Amount of data to be sent
Return values
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 non-blocking mode
with Interrupt.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
pData: Pointer to data buffer
Size: Amount of data to be sent
Return values
HAL: status
HAL_I2C_Slave_Receive_IT
Function name
HAL_StatusTypeDef HAL_I2C_Slave_Receive_IT
(I2C_HandleTypeDef * hi2c, uint8_t * pData, uint16_t Size)
Function description
Receive in slave mode an amount of data in non-blocking mode
with Interrupt.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
pData: Pointer to data buffer
Size: Amount of data to be sent
Return values
HAL: status
HAL_I2C_Mem_Write_IT
232/1320
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 non-blocking mode with Interrupt to a
specific memory address.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
MemAddress: Internal memory address
MemAddSize: Size of internal memory address
pData: Pointer to data buffer
Size: Amount of data to be sent
Return values
HAL: status
DocID026525 Rev 6
UM1785
HAL I2C Generic Driver
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 non-blocking mode with Interrupt from
a specific memory address.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
MemAddress: Internal memory address
MemAddSize: Size of internal memory address
pData: Pointer to data buffer
Size: Amount of data to be sent
Return values
HAL: status
HAL_I2C_Master_Sequential_Transmit_IT
Function name
HAL_StatusTypeDef
HAL_I2C_Master_Sequential_Transmit_IT
(I2C_HandleTypeDef * hi2c, uint16_t DevAddress, uint8_t *
pData, uint16_t Size, uint32_t XferOptions)
Function description
Sequential transmit in master I2C mode an amount of data in nonblocking mode with Interrupt.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
pData: Pointer to data buffer
Size: Amount of data to be sent
XferOptions: Options of Transfer, value of I2C Sequential
Transfer Options
Return values
HAL: status
Notes
This interface allow to manage repeated start condition when
a direction change during transfer
HAL_I2C_Master_Sequential_Receive_IT
Function name
HAL_StatusTypeDef HAL_I2C_Master_Sequential_Receive_IT
(I2C_HandleTypeDef * hi2c, uint16_t DevAddress, uint8_t *
pData, uint16_t Size, uint32_t XferOptions)
Function description
Sequential receive in master I2C mode an amount of data in nonblocking mode with Interrupt.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
DevAddress: Target device address: The device 7 bits
DocID026525 Rev 6
233/1320
HAL I2C Generic Driver
UM1785
address value in datasheet must be shift at right before call
interface
pData: Pointer to data buffer
Size: Amount of data to be sent
XferOptions: Options of Transfer, value of I2C Sequential
Transfer Options
Return values
HAL: status
Notes
This interface allow to manage repeated start condition when
a direction change during transfer
HAL_I2C_Slave_Sequential_Transmit_IT
Function name
HAL_StatusTypeDef HAL_I2C_Slave_Sequential_Transmit_IT
(I2C_HandleTypeDef * hi2c, uint8_t * pData, uint16_t Size,
uint32_t XferOptions)
Function description
Sequential transmit in slave/device I2C mode an amount of data in
non-blocking mode with Interrupt.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
pData: Pointer to data buffer
Size: Amount of data to be sent
XferOptions: Options of Transfer, value of I2C Sequential
Transfer Options
Return values
HAL: status
Notes
This interface allow to manage repeated start condition when
a direction change during transfer
HAL_I2C_Slave_Sequential_Receive_IT
Function name
HAL_StatusTypeDef HAL_I2C_Slave_Sequential_Receive_IT
(I2C_HandleTypeDef * hi2c, uint8_t * pData, uint16_t Size,
uint32_t XferOptions)
Function description
Sequential receive in slave/device I2C mode an amount of data in
non-blocking mode with Interrupt.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
pData: Pointer to data buffer
Size: Amount of data to be sent
XferOptions: Options of Transfer, value of I2C Sequential
Transfer Options
Return values
HAL: status
Notes
This interface allow to manage repeated start condition when
a direction change during transfer
HAL_I2C_EnableListen_IT
Function name
234/1320
HAL_StatusTypeDef HAL_I2C_EnableListen_IT
(I2C_HandleTypeDef * hi2c)
DocID026525 Rev 6
UM1785
Function description
HAL I2C Generic Driver
Enable the Address listen mode with Interrupt.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
Return values
HAL: status
HAL_I2C_DisableListen_IT
Function name
HAL_StatusTypeDef HAL_I2C_DisableListen_IT
(I2C_HandleTypeDef * hi2c)
Function description
Disable the Address listen mode with Interrupt.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C
Return values
HAL: status
HAL_I2C_Master_Abort_IT
Function name
HAL_StatusTypeDef HAL_I2C_Master_Abort_IT
(I2C_HandleTypeDef * hi2c, uint16_t DevAddress)
Function description
Abort a master I2C IT or DMA process communication with
Interrupt.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
Return values
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 non-blocking mode
with DMA.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
pData: Pointer to data buffer
Size: Amount of data to be sent
Return values
HAL: status
DocID026525 Rev 6
235/1320
HAL I2C Generic Driver
UM1785
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 non-blocking mode
with DMA.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
pData: Pointer to data buffer
Size: Amount of data to be sent
Return values
HAL: status
HAL_I2C_Slave_Transmit_DMA
Function name
HAL_StatusTypeDef HAL_I2C_Slave_Transmit_DMA
(I2C_HandleTypeDef * hi2c, uint8_t * pData, uint16_t Size)
Function description
Transmit in slave mode an amount of data in non-blocking mode
with DMA.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
pData: Pointer to data buffer
Size: Amount of data to be sent
Return values
HAL: status
HAL_I2C_Slave_Receive_DMA
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 non-blocking mode
with DMA.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
pData: Pointer to data buffer
Size: Amount of data to be sent
Return values
HAL: status
HAL_I2C_Mem_Write_DMA
236/1320
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 non-blocking mode with DMA to a
specific memory address.
DocID026525 Rev 6
UM1785
HAL I2C Generic Driver
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
MemAddress: Internal memory address
MemAddSize: Size of internal memory address
pData: Pointer to data buffer
Size: Amount of data to be sent
Return values
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 non-blocking mode with DMA from a
specific memory address.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
MemAddress: Internal memory address
MemAddSize: Size of internal memory address
pData: Pointer to data buffer
Size: Amount of data to be read
Return values
HAL: status
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 the specified I2C.
Return values
None
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 the specified I2C.
Return values
None
DocID026525 Rev 6
237/1320
HAL I2C Generic Driver
UM1785
HAL_I2C_MasterTxCpltCallback
Function name
void HAL_I2C_MasterTxCpltCallback (I2C_HandleTypeDef *
hi2c)
Function description
Master Tx Transfer completed callback.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
Return values
None
HAL_I2C_MasterRxCpltCallback
Function name
void HAL_I2C_MasterRxCpltCallback (I2C_HandleTypeDef *
hi2c)
Function description
Master Rx Transfer completed callback.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
Return values
None
HAL_I2C_SlaveTxCpltCallback
Function name
void HAL_I2C_SlaveTxCpltCallback (I2C_HandleTypeDef *
hi2c)
Function description
Slave Tx Transfer completed callback.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
Return values
None
HAL_I2C_SlaveRxCpltCallback
Function name
void HAL_I2C_SlaveRxCpltCallback (I2C_HandleTypeDef *
hi2c)
Function description
Slave Rx Transfer completed callback.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
Return values
None
HAL_I2C_AddrCallback
Function name
void HAL_I2C_AddrCallback (I2C_HandleTypeDef * hi2c,
uint8_t TransferDirection, uint16_t AddrMatchCode)
Function description
Slave Address Match callback.
Parameters
238/1320
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
TransferDirection: Master request Transfer Direction
(Write/Read), value of I2C Transfer Direction Master Point of
View
AddrMatchCode: Address Match Code
DocID026525 Rev 6
UM1785
HAL I2C Generic Driver
Return values
None
HAL_I2C_ListenCpltCallback
Function name
void HAL_I2C_ListenCpltCallback (I2C_HandleTypeDef * hi2c)
Function description
Listen Complete callback.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
Return values
None
HAL_I2C_MemTxCpltCallback
Function name
void HAL_I2C_MemTxCpltCallback (I2C_HandleTypeDef *
hi2c)
Function description
Memory Tx Transfer completed callback.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
Return values
None
HAL_I2C_MemRxCpltCallback
Function name
void HAL_I2C_MemRxCpltCallback (I2C_HandleTypeDef *
hi2c)
Function description
Memory Rx Transfer completed callback.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
Return values
None
HAL_I2C_ErrorCallback
Function name
void HAL_I2C_ErrorCallback (I2C_HandleTypeDef * hi2c)
Function description
I2C error callback.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
Return values
None
HAL_I2C_AbortCpltCallback
Function name
void HAL_I2C_AbortCpltCallback (I2C_HandleTypeDef * hi2c)
Function description
I2C abort callback.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
Return values
None
DocID026525 Rev 6
239/1320
HAL I2C Generic Driver
UM1785
HAL_I2C_GetState
Function name
HAL_I2C_StateTypeDef HAL_I2C_GetState
(I2C_HandleTypeDef * hi2c)
Function description
Return the I2C handle state.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2C.
Return values
HAL: state
HAL_I2C_GetMode
Function name
HAL_I2C_ModeTypeDef HAL_I2C_GetMode
(I2C_HandleTypeDef * hi2c)
Function description
Returns the I2C Master, Slave, Memory or no mode.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for I2C module
Return values
HAL: mode
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
I2C_ADDRESSINGMODE_7BIT
I2C_ADDRESSINGMODE_10BIT
I2C Dual Addressing Mode
I2C_DUALADDRESS_DISABLE
I2C_DUALADDRESS_ENABLE
I2C Error Code definition
240/1320
HAL_I2C_ERROR_NONE
No error
HAL_I2C_ERROR_BERR
BERR error
HAL_I2C_ERROR_ARLO
ARLO error
HAL_I2C_ERROR_AF
ACKF error
HAL_I2C_ERROR_OVR
OVR error
HAL_I2C_ERROR_DMA
DMA transfer error
DocID026525 Rev 6
UM1785
HAL I2C Generic Driver
HAL_I2C_ERROR_TIMEOUT
Timeout error
HAL_I2C_ERROR_SIZE
Size Management error
I2C Exported Macros
__HAL_I2C_RESET_HANDLE_STATE
Description:
Reset I2C handle state.
Parameters:
__HANDLE__: specifies the I2C Handle.
Return value:
None
__HAL_I2C_ENABLE_IT
Description:
Enable the specified I2C interrupt.
Parameters:
__HANDLE__: specifies the I2C Handle.
__INTERRUPT__: specifies the interrupt
source to enable. This parameter can be
one of the following values:
I2C_IT_ERRI Errors interrupt enable
I2C_IT_TCI Transfer complete interrupt
enable
I2C_IT_STOPI STOP detection
interrupt enable
I2C_IT_NACKI NACK received
interrupt enable
I2C_IT_ADDRI Address match interrupt
enable
I2C_IT_RXI RX interrupt enable
I2C_IT_TXI TX interrupt enable
Return value:
None
__HAL_I2C_DISABLE_IT
Description:
Disable the specified I2C interrupt.
Parameters:
__HANDLE__: specifies the I2C Handle.
__INTERRUPT__: specifies the interrupt
source to disable. This parameter can be
one of the following values:
I2C_IT_ERRI Errors interrupt enable
I2C_IT_TCI Transfer complete interrupt
enable
I2C_IT_STOPI STOP detection
interrupt enable
I2C_IT_NACKI NACK received
interrupt enable
I2C_IT_ADDRI Address match interrupt
enable
DocID026525 Rev 6
241/1320
HAL I2C Generic Driver
UM1785
I2C_IT_RXI RX interrupt enable
I2C_IT_TXI TX interrupt enable
Return value:
None
__HAL_I2C_GET_IT_SOURCE
Description:
Check whether the specified I2C interrupt
source is enabled or not.
Parameters:
__HANDLE__: specifies the I2C Handle.
__INTERRUPT__: specifies the I2C
interrupt source to check. This parameter
can be one of the following values:
I2C_IT_ERRI Errors interrupt enable
I2C_IT_TCI Transfer complete interrupt
enable
I2C_IT_STOPI STOP detection
interrupt enable
I2C_IT_NACKI NACK received
interrupt enable
I2C_IT_ADDRI Address match interrupt
enable
I2C_IT_RXI RX interrupt enable
I2C_IT_TXI TX interrupt enable
Return value:
The: new state of __INTERRUPT__ (SET or
RESET).
__HAL_I2C_GET_FLAG
Description:
Check whether the specified I2C flag is set
or not.
Parameters:
__HANDLE__: specifies the I2C Handle.
__FLAG__: specifies the flag to check. This
parameter can be one of the following
values:
I2C_FLAG_TXE Transmit data register
empty
I2C_FLAG_TXIS Transmit interrupt
status
I2C_FLAG_RXNE Receive data
register not empty
I2C_FLAG_ADDR Address matched
(slave mode)
I2C_FLAG_AF Acknowledge failure
received flag
I2C_FLAG_STOPF STOP detection
flag
I2C_FLAG_TC Transfer complete
(master mode)
242/1320
DocID026525 Rev 6
UM1785
HAL I2C Generic Driver
I2C_FLAG_TCR Transfer complete
reload
I2C_FLAG_BERR Bus error
I2C_FLAG_ARLO Arbitration lost
I2C_FLAG_OVR Overrun/Underrun
I2C_FLAG_PECERR PEC error in
reception
I2C_FLAG_TIMEOUT Timeout or Tlow
detection flag
I2C_FLAG_ALERT SMBus alert
I2C_FLAG_BUSY Bus busy
I2C_FLAG_DIR Transfer direction
(slave mode)
Return value:
The: new state of __FLAG__ (SET or
RESET).
__HAL_I2C_CLEAR_FLAG
Description:
Clear the I2C pending flags which are
cleared by writing 1 in a specific bit.
Parameters:
__HANDLE__: specifies the I2C Handle.
__FLAG__: specifies the flag to clear. This
parameter can be any combination of the
following values:
I2C_FLAG_TXE Transmit data register
empty
I2C_FLAG_ADDR Address matched
(slave mode)
I2C_FLAG_AF Acknowledge failure
received flag
I2C_FLAG_STOPF STOP detection
flag
I2C_FLAG_BERR Bus error
I2C_FLAG_ARLO Arbitration lost
I2C_FLAG_OVR Overrun/Underrun
I2C_FLAG_PECERR PEC error in
reception
I2C_FLAG_TIMEOUT Timeout or Tlow
detection flag
I2C_FLAG_ALERT SMBus alert
Return value:
None
__HAL_I2C_ENABLE
Description:
Enable the specified I2C peripheral.
Parameters:
__HANDLE__: specifies the I2C Handle.
Return value:
DocID026525 Rev 6
243/1320
HAL I2C Generic Driver
UM1785
None
Description:
__HAL_I2C_DISABLE
Disable the specified I2C peripheral.
Parameters:
__HANDLE__: specifies the I2C Handle.
Return value:
None
__HAL_I2C_GENERATE_NACK
Description:
Generate a Non-Acknowledge I2C
peripheral in Slave mode.
Parameters:
__HANDLE__: specifies the I2C Handle.
Return value:
None
I2C Flag definition
I2C_FLAG_TXE
I2C_FLAG_TXIS
I2C_FLAG_RXNE
I2C_FLAG_ADDR
I2C_FLAG_AF
I2C_FLAG_STOPF
I2C_FLAG_TC
I2C_FLAG_TCR
I2C_FLAG_BERR
I2C_FLAG_ARLO
I2C_FLAG_OVR
I2C_FLAG_PECERR
I2C_FLAG_TIMEOUT
I2C_FLAG_ALERT
I2C_FLAG_BUSY
I2C_FLAG_DIR
I2C General Call Addressing Mode
I2C_GENERALCALL_DISABLE
I2C_GENERALCALL_ENABLE
I2C Interrupt configuration definition
I2C_IT_ERRI
244/1320
DocID026525 Rev 6
UM1785
HAL I2C Generic Driver
I2C_IT_TCI
I2C_IT_STOPI
I2C_IT_NACKI
I2C_IT_ADDRI
I2C_IT_RXI
I2C_IT_TXI
I2C Memory Address Size
I2C_MEMADD_SIZE_8BIT
I2C_MEMADD_SIZE_16BIT
I2C No-Stretch Mode
I2C_NOSTRETCH_DISABLE
I2C_NOSTRETCH_ENABLE
I2C Own Address2 Masks
I2C_OA2_NOMASK
I2C_OA2_MASK01
I2C_OA2_MASK02
I2C_OA2_MASK03
I2C_OA2_MASK04
I2C_OA2_MASK05
I2C_OA2_MASK06
I2C_OA2_MASK07
I2C Reload End Mode
I2C_RELOAD_MODE
I2C_AUTOEND_MODE
I2C_SOFTEND_MODE
I2C Start or Stop Mode
I2C_NO_STARTSTOP
I2C_GENERATE_STOP
I2C_GENERATE_START_READ
I2C_GENERATE_START_WRITE
I2C Transfer Direction Master Point of View
I2C_DIRECTION_TRANSMIT
I2C_DIRECTION_RECEIVE
DocID026525 Rev 6
245/1320
HAL I2C Generic Driver
I2C Sequential Transfer Options
I2C_FIRST_FRAME
I2C_FIRST_AND_NEXT_FRAME
I2C_NEXT_FRAME
I2C_FIRST_AND_LAST_FRAME
I2C_LAST_FRAME
246/1320
DocID026525 Rev 6
UM1785
UM1785
HAL I2C Extension Driver
23
HAL I2C Extension Driver
23.1
I2CEx Firmware driver API description
23.1.1
I2C peripheral Extended features
Comparing to other previous devices, the I2C interface for STM32F0xx devices contains
the following additional features
Possibility to disable or enable Analog Noise Filter
Use of a configured Digital Noise Filter
Disable or enable wakeup from Stop mode
23.1.2
How to use this driver
This driver provides functions to configure Noise Filter and Wake Up Feature
1.
2.
3.
4.
23.1.3
Configure I2C Analog noise filter using the function HAL_I2CEx_ConfigAnalogFilter()
Configure I2C Digital noise filter using the function HAL_I2CEx_ConfigDigitalFilter()
Configure the enable or disable of I2C Wake Up Mode using the functions :
HAL_I2CEx_EnableWakeUp()
HAL_I2CEx_DisableWakeUp()
Configure the enable or disable of fast mode plus driving capability using the functions
:
HAL_I2CEx_EnableFastModePlus()
HAL_I2CEx_DisableFastModePlus()
Extended features functions
This section provides functions allowing to:
Configure Noise Filters
Configure Wake Up Feature
This section contains the following APIs:
HAL_I2CEx_ConfigAnalogFilter()
HAL_I2CEx_ConfigDigitalFilter()
HAL_I2CEx_EnableWakeUp()
HAL_I2CEx_DisableWakeUp()
HAL_I2CEx_EnableFastModePlus()
HAL_I2CEx_DisableFastModePlus()
23.1.4
Detailed description of functions
HAL_I2CEx_ConfigAnalogFilter
Function name
HAL_StatusTypeDef HAL_I2CEx_ConfigAnalogFilter
(I2C_HandleTypeDef * hi2c, uint32_t AnalogFilter)
Function description
Configure I2C Analog noise filter.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2Cx peripheral.
AnalogFilter: New state of the Analog filter.
DocID026525 Rev 6
247/1320
HAL I2C Extension Driver
Return values
UM1785
HAL: status
HAL_I2CEx_ConfigDigitalFilter
Function name
HAL_StatusTypeDef HAL_I2CEx_ConfigDigitalFilter
(I2C_HandleTypeDef * hi2c, uint32_t DigitalFilter)
Function description
Configure I2C Digital noise filter.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2Cx peripheral.
DigitalFilter: Coefficient of digital noise filter between
Min_Data=0x00 and Max_Data=0x0F.
Return values
HAL: status
HAL_I2CEx_EnableWakeUp
Function name
HAL_StatusTypeDef HAL_I2CEx_EnableWakeUp
(I2C_HandleTypeDef * hi2c)
Function description
Enable I2C wakeup from stop mode.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2Cx peripheral.
Return values
HAL: status
HAL_I2CEx_DisableWakeUp
Function name
HAL_StatusTypeDef HAL_I2CEx_DisableWakeUp
(I2C_HandleTypeDef * hi2c)
Function description
Disable I2C wakeup from stop mode.
Parameters
hi2c: Pointer to a I2C_HandleTypeDef structure that contains
the configuration information for the specified I2Cx peripheral.
Return values
HAL: status
HAL_I2CEx_EnableFastModePlus
248/1320
Function name
void HAL_I2CEx_EnableFastModePlus (uint32_t
ConfigFastModePlus)
Function description
Enable the I2C fast mode plus driving capability.
Parameters
ConfigFastModePlus: Selects the pin. This parameter can
be one of the I2C Extended Fast Mode Plus values
Return values
None
Notes
For I2C1, fast mode plus driving capability can be enabled on
all selected I2C1 pins using I2C_FASTMODEPLUS_I2C1
parameter or independently on each one of the following pins
PB6, PB7, PB8 and PB9.
For remaining I2C1 pins (PA14, PA15...) fast mode plus
driving capability can be enabled only by using
I2C_FASTMODEPLUS_I2C1 parameter.
For all I2C2 pins fast mode plus driving capability can be
DocID026525 Rev 6
UM1785
HAL I2C Extension Driver
enabled only by using I2C_FASTMODEPLUS_I2C2
parameter.
HAL_I2CEx_DisableFastModePlus
Function name
void HAL_I2CEx_DisableFastModePlus (uint32_t
ConfigFastModePlus)
Function description
Disable the I2C fast mode plus driving capability.
Parameters
ConfigFastModePlus: Selects the pin. This parameter can
be one of the I2C Extended Fast Mode Plus values
Return values
None
Notes
For I2C1, fast mode plus driving capability can be disabled on
all selected I2C1 pins using I2C_FASTMODEPLUS_I2C1
parameter or independently on each one of the following pins
PB6, PB7, PB8 and PB9.
For remaining I2C1 pins (PA14, PA15...) fast mode plus
driving capability can be disabled only by using
I2C_FASTMODEPLUS_I2C1 parameter.
For all I2C2 pins fast mode plus driving capability can be
disabled only by using I2C_FASTMODEPLUS_I2C2
parameter.
23.2
I2CEx Firmware driver defines
23.2.1
I2CEx
I2C Extended Analog Filter
I2C_ANALOGFILTER_ENABLE
I2C_ANALOGFILTER_DISABLE
I2C Extended Fast Mode Plus
I2C_FMP_NOT_SUPPORTED
Fast Mode Plus not supported
I2C_FASTMODEPLUS_PA9
Enable Fast Mode Plus on PA9
I2C_FASTMODEPLUS_PA10
Enable Fast Mode Plus on PA10
I2C_FASTMODEPLUS_PB6
Enable Fast Mode Plus on PB6
I2C_FASTMODEPLUS_PB7
Enable Fast Mode Plus on PB7
I2C_FASTMODEPLUS_PB8
Enable Fast Mode Plus on PB8
I2C_FASTMODEPLUS_PB9
Enable Fast Mode Plus on PB9
I2C_FASTMODEPLUS_I2C1
Enable Fast Mode Plus on I2C1 pins
I2C_FASTMODEPLUS_I2C2
Enable Fast Mode Plus on I2C2 pins
DocID026525 Rev 6
249/1320
HAL I2S Generic Driver
UM1785
24
HAL I2S Generic Driver
24.1
I2S Firmware driver registers structures
24.1.1
I2S_InitTypeDef
Data Fields
uint32_t Mode
uint32_t Standard
uint32_t DataFormat
uint32_t MCLKOutput
uint32_t AudioFreq
uint32_t CPOL
Field Documentation
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
24.1.2
I2S_HandleTypeDef
Data Fields
SPI_TypeDef * Instance
I2S_InitTypeDef Init
uint16_t * pTxBuffPtr
__IO uint16_t TxXferSize
__IO uint16_t TxXferCount
uint16_t * pRxBuffPtr
__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
250/1320
DocID026525 Rev 6
UM1785
HAL I2S Generic Driver
SPI_TypeDef* I2S_HandleTypeDef::Instance
I2S registers base address
I2S_InitTypeDef I2S_HandleTypeDef::Init
I2S communication parameters
uint16_t* I2S_HandleTypeDef::pTxBuffPtr
Pointer to I2S Tx transfer buffer
__IO uint16_t I2S_HandleTypeDef::TxXferSize
I2S Tx transfer size
__IO uint16_t I2S_HandleTypeDef::TxXferCount
I2S Tx transfer Counter
uint16_t* I2S_HandleTypeDef::pRxBuffPtr
Pointer to I2S Rx transfer buffer
__IO uint16_t I2S_HandleTypeDef::RxXferSize
I2S Rx transfer size
__IO uint16_t I2S_HandleTypeDef::RxXferCount
I2S Rx transfer counter (This field is initialized at the same value as transfer size at
the beginning of the transfer and decremented when a sample is received.
NbSamplesReceived = RxBufferSize-RxBufferCount)
DMA_HandleTypeDef* I2S_HandleTypeDef::hdmatx
I2S Tx DMA handle parameters
DMA_HandleTypeDef* I2S_HandleTypeDef::hdmarx
I2S Rx DMA handle parameters
__IO HAL_LockTypeDef I2S_HandleTypeDef::Lock
I2S locking object
__IO HAL_I2S_StateTypeDef I2S_HandleTypeDef::State
I2S communication state
__IO uint32_t I2S_HandleTypeDef::ErrorCode
I2S Error code This parameter can be a value of I2S_Error
24.2
I2S Firmware driver API description
24.2.1
How to use this driver
The I2S HAL driver can be used as follow:
1.
2.
Declare a I2S_HandleTypeDef handle structure.
Initialize the I2S low level resources by implement the HAL_I2S_MspInit() API:
a. Enable the SPIx interface clock.
b. I2S pins configuration:
Enable the clock for the I2S GPIOs.
Configure these I2S pins as alternate function pull-up.
c. NVIC configuration if you need to use interrupt process (HAL_I2S_Transmit_IT()
and HAL_I2S_Receive_IT() APIs).
Configure the I2Sx interrupt priority.
Enable the NVIC I2S IRQ handle.
d. DMA Configuration if you need to use DMA process (HAL_I2S_Transmit_DMA()
and HAL_I2S_Receive_DMA() APIs:
Declare a DMA handle structure for the Tx/Rx Channel.
Enable the DMAx interface clock.
Configure the declared DMA handle structure with the required Tx/Rx
parameters.
Configure the DMA Tx/Rx Channel.
Associate the initilalized DMA handle to the I2S DMA Tx/Rx handle.
Configure the priority and enable the NVIC for the transfer complete interrupt
on the DMA Tx/Rx Channel.
DocID026525 Rev 6
251/1320
HAL I2S Generic Driver
UM1785
3. Program the Mode, Standard, Data Format, MCLK Output, Audio frequency and
Polarity using HAL_I2S_Init() function. The specific I2S interrupts (Transmission
complete interrupt, RXNE interrupt and Error Interrupts) will be managed using the
macros __HAL_I2S_ENABLE_IT() and __HAL_I2S_DISABLE_IT() inside the transmit
and receive process. Make sure that either: External clock source is configured after
setting correctly the define constant EXTERNAL_CLOCK_VALUE in the
stm32f0xx_hal_conf.h file.
4. Three mode of operations 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
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()
I2S HAL driver macros list
Below the list of most used macros in I2S HAL driver.
252/1320
DocID026525 Rev 6
UM1785
HAL I2S Generic 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
24.2.2
Initialization and de-initialization functions
This subsection provides a set of functions allowing to initialize and de-initialiaze 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 periperal.
This section contains the following APIs:
HAL_I2S_Init()
HAL_I2S_DeInit()
HAL_I2S_MspInit()
HAL_I2S_MspDeInit()
24.2.3
IO operation functions
This subsection provides a set of functions allowing to manage the I2S data transfers.
1.
2.
3.
4.
There are two modes of transfer:
Blocking mode : The communication is performed in the polling mode. The 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()
HAL_I2S_Receive_IT()
No-Blocking mode functions with DMA are :
HAL_I2S_Transmit_DMA()
HAL_I2S_Receive_DMA()
DocID026525 Rev 6
253/1320
HAL I2S Generic Driver
5. A set of Transfer Complete Callbacks are provided in non Blocking mode:
HAL_I2S_TxCpltCallback()
HAL_I2S_RxCpltCallback()
HAL_I2S_ErrorCallback()
UM1785
This section contains the following APIs:
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()
24.2.4
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:
HAL_I2S_GetState()
HAL_I2S_GetError()
24.2.5
Detailed description of functions
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
254/1320
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
the configuration information for I2S module
Return values
HAL: status
DocID026525 Rev 6
UM1785
HAL I2S Generic Driver
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).
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
pData: a 16-bit pointer to data buffer.
Size: number of data sample to be sent:
Timeout: Timeout duration
DocID026525 Rev 6
255/1320
HAL I2S Generic Driver
Return values
UM1785
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 continouse way and as
the I2S is not disabled at the end of the I2S transaction.
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).
HAL_I2S_Receive_IT
256/1320
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
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.
DocID026525 Rev 6
UM1785
HAL I2S Generic Driver
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_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_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).
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
DocID026525 Rev 6
257/1320
HAL I2S Generic Driver
UM1785
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).
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_TxHalfCpltCallback
258/1320
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
DocID026525 Rev 6
UM1785
HAL I2S Generic Driver
HAL_I2S_TxCpltCallback
Function name
void HAL_I2S_TxCpltCallback (I2S_HandleTypeDef * hi2s)
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
DocID026525 Rev 6
259/1320
HAL I2S Generic Driver
UM1785
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
24.3
I2S Firmware driver defines
24.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
IS_I2S_AUDIO_FREQ
I2S Clock Polarity
I2S_CPOL_LOW
I2S_CPOL_HIGH
IS_I2S_CPOL
I2S Data Format
I2S_DATAFORMAT_16B
I2S_DATAFORMAT_16B_EXTENDED
I2S_DATAFORMAT_24B
I2S_DATAFORMAT_32B
IS_I2S_DATA_FORMAT
I2S Error
260/1320
HAL_I2S_ERROR_NONE
No error
HAL_I2S_ERROR_TIMEOUT
Timeout error
HAL_I2S_ERROR_OVR
OVR error
HAL_I2S_ERROR_UDR
UDR error
DocID026525 Rev 6
UM1785
HAL I2S Generic Driver
HAL_I2S_ERROR_DMA
DMA transfer error
HAL_I2S_ERROR_UNKNOW
Unknow Error error
I2S Exported Macros
__HAL_I2S_RESET_HANDLE_STATE
Description:
Reset I2S handle state.
Parameters:
__HANDLE__: I2S handle.
Return value:
None
Description:
__HAL_I2S_ENABLE
Enable or disable the specified SPI
peripheral (in I2S mode).
Parameters:
__HANDLE__: specifies the I2S Handle.
Return value:
None
__HAL_I2S_DISABLE
Description:
__HAL_I2S_ENABLE_IT
Enable or disable the specified I2S
interrupts.
Parameters:
__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:
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
DocID026525 Rev 6
261/1320
HAL I2S Generic Driver
UM1785
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:
The: new state of __FLAG__ (TRUE or
FALSE).
__HAL_I2S_CLEAR_OVRFLAG
Description:
Clears the I2S OVR pending flag.
Parameters:
__HANDLE__: specifies the I2S Handle.
Return value:
None
__HAL_I2S_CLEAR_UDRFLAG
Description:
Clears the I2S UDR pending flag.
Parameters:
__HANDLE__: specifies the I2S Handle.
Return value:
None
262/1320
DocID026525 Rev 6
UM1785
HAL I2S Generic Driver
I2S Flag definition
I2S_FLAG_TXE
I2S_FLAG_RXNE
I2S_FLAG_UDR
I2S_FLAG_OVR
I2S_FLAG_FRE
I2S_FLAG_CHSIDE
I2S_FLAG_BSY
I2S Interrupt configuration definition
I2S_IT_TXE
I2S_IT_RXNE
I2S_IT_ERR
I2S MCLK Output
I2S_MCLKOUTPUT_ENABLE
I2S_MCLKOUTPUT_DISABLE
IS_I2S_MCLK_OUTPUT
I2S Mode
I2S_MODE_SLAVE_TX
I2S_MODE_SLAVE_RX
I2S_MODE_MASTER_TX
I2S_MODE_MASTER_RX
IS_I2S_MODE
I2S Standard
I2S_STANDARD_PHILIPS
I2S_STANDARD_MSB
I2S_STANDARD_LSB
I2S_STANDARD_PCM_SHORT
I2S_STANDARD_PCM_LONG
IS_I2S_STANDARD
DocID026525 Rev 6
263/1320
HAL IRDA Generic Driver
UM1785
25
HAL IRDA Generic Driver
25.1
IRDA Firmware driver registers structures
25.1.1
IRDA_InitTypeDef
Data Fields
uint32_t BaudRate
uint32_t WordLength
uint32_t Parity
uint32_t Mode
uint8_t Prescaler
uint16_t PowerMode
Field Documentation
uint32_t IRDA_InitTypeDef::BaudRate
This member configures the IRDA communication baud rate. The baud rate register is
computed using the following formula: Baud Rate Register = ((PCLKx) / ((hirda>Init.BaudRate)))
uint32_t IRDA_InitTypeDef::WordLength
Specifies the number of data bits transmitted or received in a frame. This parameter
can be a value of IRDAEx_Word_Length
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 whether the Receive or Transmit mode is enabled or disabled. This
parameter can be a value of IRDA_Transfer_Mode
uint8_t IRDA_InitTypeDef::Prescaler
Specifies the Prescaler value for dividing the UART/USART source clock to achieve
low-power frequency.
Note:Prescaler value 0 is forbidden
uint16_t IRDA_InitTypeDef::PowerMode
Specifies the IRDA power mode. This parameter can be a value of IRDA_Low_Power
25.1.2
IRDA_HandleTypeDef
Data Fields
USART_TypeDef * Instance
IRDA_InitTypeDef Init
uint8_t * pTxBuffPtr
uint16_t TxXferSize
__IO uint16_t TxXferCount
uint8_t * pRxBuffPtr
uint16_t RxXferSize
__IO uint16_t RxXferCount
uint16_t Mask
DMA_HandleTypeDef * hdmatx
DMA_HandleTypeDef * hdmarx
264/1320
DocID026525 Rev 6
UM1785
HAL IRDA Generic Driver
HAL_LockTypeDef Lock
__IO HAL_IRDA_StateTypeDef gState
__IO HAL_IRDA_StateTypeDef RxState
__IO uint32_t ErrorCode
Field Documentation
USART_TypeDef* IRDA_HandleTypeDef::Instance
IRDA registers base address
IRDA_InitTypeDef IRDA_HandleTypeDef::Init
IRDA communication parameters
uint8_t* IRDA_HandleTypeDef::pTxBuffPtr
Pointer to IRDA Tx transfer Buffer
uint16_t IRDA_HandleTypeDef::TxXferSize
IRDA Tx Transfer size
__IO uint16_t IRDA_HandleTypeDef::TxXferCount
IRDA Tx Transfer Counter
uint8_t* IRDA_HandleTypeDef::pRxBuffPtr
Pointer to IRDA Rx transfer Buffer
uint16_t IRDA_HandleTypeDef::RxXferSize
IRDA Rx Transfer size
__IO uint16_t IRDA_HandleTypeDef::RxXferCount
IRDA Rx Transfer Counter
uint16_t IRDA_HandleTypeDef::Mask
IRDA RX RDR register mask
DMA_HandleTypeDef* IRDA_HandleTypeDef::hdmatx
IRDA Tx DMA Handle parameters
DMA_HandleTypeDef* IRDA_HandleTypeDef::hdmarx
IRDA Rx DMA Handle parameters
HAL_LockTypeDef IRDA_HandleTypeDef::Lock
Locking object
__IO HAL_IRDA_StateTypeDef IRDA_HandleTypeDef::gState
IRDA state information related to global Handle management and also related to Tx
operations. This parameter can be a value of HAL_IRDA_StateTypeDef
__IO HAL_IRDA_StateTypeDef IRDA_HandleTypeDef::RxState
IRDA state information related to Rx operations. This parameter can be a value of
HAL_IRDA_StateTypeDef
__IO uint32_t IRDA_HandleTypeDef::ErrorCode
IRDA Error code This parameter can be a value of IRDA_Error
25.2
IRDA Firmware driver API description
25.2.1
How to use this driver
The IRDA HAL driver can be used as follows:
1.
2.
Declare a IRDA_HandleTypeDef handle structure (eg. IRDA_HandleTypeDef hirda).
Initialize the IRDA low level resources by implementing the HAL_IRDA_MspInit() API
in setting the associated USART or UART in IRDA mode:
Enable the USARTx/UARTx interface clock.
USARTx/UARTx pins configuration:
Enable the clock for the USARTx/UARTx GPIOs.
Configure these USARTx/UARTx pins (TX as alternate function pull-up, RX
as alternate function Input).
DocID026525 Rev 6
265/1320
HAL IRDA Generic Driver
3.
4.
5.
UM1785
NVIC configuration if you need to use interrupt process
(HAL_IRDA_Transmit_IT() and HAL_IRDA_Receive_IT() APIs):
Configure the USARTx/UARTx interrupt priority.
Enable the NVIC USARTx/UARTx IRQ handle.
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.
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 channel.
Enable the DMAx interface clock.
Configure the declared DMA handle structure with the required Tx/Rx
parameters.
Configure the DMA Tx/Rx channel.
Associate the 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 channel.
Program the Baud Rate, Word Length and Parity and Mode(Receiver/Transmitter), the
normal or low power mode and the clock prescaler in the hirda handle Init structure.
Initialize the IRDA registers by calling the HAL_IRDA_Init() API:
This API configures also the low level Hardware GPIO, CLOCK, CORTEX...etc)
by calling the 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 half of transfer HAL_IRDA_TxHalfCpltCallback() is executed and user
can add his own code by customization of function pointer
HAL_IRDA_TxHalfCpltCallback()
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()
266/1320
DocID026525 Rev 6
UM1785
HAL IRDA Generic Driver
At reception half of transfer HAL_IRDA_RxHalfCpltCallback() is executed and user
can add his own code by customization of function pointer
HAL_IRDA_RxHalfCpltCallback()
At reception end of transfer HAL_IRDA_RxCpltCallback() is executed and user can
add his own code by customization of function pointer HAL_IRDA_RxCpltCallback()
In case of transfer Error, HAL_IRDA_ErrorCallback() function is executed and user
can add his own code by customization of function pointer HAL_IRDA_ErrorCallback()
IRDA HAL driver macros list
Below the list of most used macros in IRDA HAL driver.
__HAL_IRDA_ENABLE: Enable the IRDA peripheral
__HAL_IRDA_DISABLE: Disable the IRDA peripheral
__HAL_IRDA_GET_FLAG : Check whether the specified IRDA flag is set or not
__HAL_IRDA_CLEAR_FLAG : Clear the specified IRDA pending flag
__HAL_IRDA_ENABLE_IT: Enable the specified IRDA interrupt
__HAL_IRDA_DISABLE_IT: Disable the specified IRDA interrupt
__HAL_IRDA_GET_IT_SOURCE: Check whether or not the specified IRDA interrupt
is enabled
You can refer to the IRDA HAL driver header file for more useful macros
25.2.2
Initialization and Configuration functions
This subsection provides a set of functions allowing to initialize the USARTx in
asynchronous IRDA mode.
For the asynchronous mode only these parameters can be configured:
Baud Rate
Word Length
Parity
Power mode
Prescaler setting
Receiver/transmitter modes
The HAL_IRDA_Init() API follows the USART asynchronous configuration procedures
(details for the procedures are available in reference manual).
This section contains the following APIs:
HAL_IRDA_Init()
HAL_IRDA_DeInit()
HAL_IRDA_MspInit()
HAL_IRDA_MspDeInit()
25.2.3
IO operation functions
This subsection provides a set of functions allowing to manage the IRDA data transfers.
IrDA is a half duplex communication protocol. If the Transmitter is busy, any data on the
IrDA receive line will be ignored by the IrDA decoder and if the Receiver is busy, data on
the TX from the USART to IrDA will not be encoded by IrDA. While receiving data,
transmission should be avoided as the data to be transmitted could be corrupted.
DocID026525 Rev 6
267/1320
HAL IRDA Generic Driver
UM1785
1. There are two mode 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 API's return the HAL status. The end of the data processing will be
indicated through the dedicated IRDA IRQ when using Interrupt mode or the
DMA IRQ when using DMA mode. The HAL_IRDA_TxCpltCallback(),
HAL_IRDA_RxCpltCallback() user callbacks will be executed 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
2. Blocking mode APIs are :
HAL_IRDA_Transmit()
HAL_IRDA_Receive()
3. Non Blocking mode APIs with Interrupt are :
HAL_IRDA_Transmit_IT()
HAL_IRDA_Receive_IT()
HAL_IRDA_IRQHandler()
4. Non Blocking mode functions with DMA are :
HAL_IRDA_Transmit_DMA()
HAL_IRDA_Receive_DMA()
HAL_IRDA_DMAPause()
HAL_IRDA_DMAResume()
HAL_IRDA_DMAStop()
5. A set of Transfer Complete Callbacks are provided in Non Blocking mode:
HAL_IRDA_TxHalfCpltCallback()
HAL_IRDA_TxCpltCallback()
HAL_IRDA_RxHalfCpltCallback()
HAL_IRDA_RxCpltCallback()
HAL_IRDA_ErrorCallback()
6. Non-Blocking mode transfers could be aborted using Abort API's :
HAL_IRDA_Abort()
HAL_IRDA_AbortTransmit()
HAL_IRDA_AbortReceive()
HAL_IRDA_Abort_IT()
HAL_IRDA_AbortTransmit_IT()
HAL_IRDA_AbortReceive_IT()
7. For Abort services based on interrupts (HAL_IRDA_Abortxxx_IT), a set of Abort
Complete Callbacks are provided:
HAL_IRDA_AbortCpltCallback()
HAL_IRDA_AbortTransmitCpltCallback()
HAL_IRDA_AbortReceiveCpltCallback()
8. In Non-Blocking mode transfers, possible errors are split into 2 categories. Errors are
handled as follows :
Error is considered as Recoverable and non blocking : Transfer could go till end,
but error severity is to be evaluated by user : this concerns Frame Error, Parity
Error or Noise Error in Interrupt mode reception . Received character is then
retrieved and stored in Rx buffer, Error code is set to allow user to identify error
type, and HAL_IRDA_ErrorCallback() user callback is executed. Transfer is kept
ongoing on IRDA side. If user wants to abort it, Abort services should be called
by user.
Error is considered as Blocking : Transfer could not be completed properly and is
aborted. This concerns Overrun Error In Interrupt mode reception and all errors in
DMA mode. Error code is set to allow user to identify error type, and
HAL_IRDA_ErrorCallback() user callback is executed.
268/1320
DocID026525 Rev 6
UM1785
HAL IRDA Generic Driver
This section contains the following APIs:
HAL_IRDA_Transmit()
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_Abort()
HAL_IRDA_AbortTransmit()
HAL_IRDA_AbortReceive()
HAL_IRDA_Abort_IT()
HAL_IRDA_AbortTransmit_IT()
HAL_IRDA_AbortReceive_IT()
HAL_IRDA_IRQHandler()
HAL_IRDA_TxCpltCallback()
HAL_IRDA_TxHalfCpltCallback()
HAL_IRDA_RxCpltCallback()
HAL_IRDA_RxHalfCpltCallback()
HAL_IRDA_ErrorCallback()
HAL_IRDA_AbortCpltCallback()
HAL_IRDA_AbortTransmitCpltCallback()
HAL_IRDA_AbortReceiveCpltCallback()
25.2.4
Peripheral State and Error 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 handle.
HAL_IRDA_GetError() checks in run-time errors that could occur during
communication.
This section contains the following APIs:
HAL_IRDA_GetState()
HAL_IRDA_GetError()
25.2.5
Detailed description of functions
HAL_IRDA_Init
Function name
HAL_StatusTypeDef HAL_IRDA_Init (IRDA_HandleTypeDef *
hirda)
Function description
Initialize the IRDA mode according to the specified parameters in
the IRDA_InitTypeDef and initialize the associated handle.
Parameters
hirda: Pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
DocID026525 Rev 6
269/1320
HAL IRDA Generic Driver
Return values
UM1785
HAL: status
HAL_IRDA_DeInit
Function name
HAL_StatusTypeDef HAL_IRDA_DeInit (IRDA_HandleTypeDef
* hirda)
Function description
DeInitialize 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
Function name
void HAL_IRDA_MspInit (IRDA_HandleTypeDef * hirda)
Function description
Initialize the IRDA MSP.
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
DeInitialize the IRDA MSP.
Parameters
hirda: Pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
Return values
None
HAL_IRDA_Transmit
270/1320
Function name
HAL_StatusTypeDef HAL_IRDA_Transmit
(IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size,
uint32_t Timeout)
Function description
Send 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 sent.
Timeout: Specify timeout value.
Return values
HAL: status
Notes
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffer containing data to be sent, should be aligned on a
half word frontier (16 bits) (as sent data will be handled using
DocID026525 Rev 6
UM1785
HAL IRDA Generic Driver
u16 pointer cast). Depending on compilation chain, use of
specific alignment compilation directives or pragmas might be
required to ensure proper alignment for pData.
HAL_IRDA_Receive
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.
Return values
HAL: status
Notes
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffer for storing data to be received, should be aligned
on a half word frontier (16 bits) (as received data will be
handled using u16 pointer cast). Depending on compilation
chain, use of specific alignment compilation directives or
pragmas might be required to ensure proper alignment for
pData.
HAL_IRDA_Transmit_IT
Function name
HAL_StatusTypeDef HAL_IRDA_Transmit_IT
(IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size)
Function description
Send an amount of data in interrupt 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 sent.
Return values
HAL: status
Notes
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffer containing data to be sent, should be aligned on a
half word frontier (16 bits) (as sent data will be handled using
u16 pointer cast). Depending on compilation chain, use of
specific alignment compilation directives or pragmas might be
required to ensure proper alignment for pData.
DocID026525 Rev 6
271/1320
HAL IRDA Generic Driver
UM1785
HAL_IRDA_Receive_IT
Function name
HAL_StatusTypeDef HAL_IRDA_Receive_IT
(IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size)
Function description
Receive an amount of data in interrupt 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 UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffer for storing data to be received, should be aligned
on a half word frontier (16 bits) (as received data will be
handled using u16 pointer cast). Depending on compilation
chain, use of specific alignment compilation directives or
pragmas might be required to ensure proper alignment for
pData.
HAL_IRDA_Transmit_DMA
Function name
HAL_StatusTypeDef HAL_IRDA_Transmit_DMA
(IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size)
Function description
Send an amount of data in DMA 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 sent.
Return values
HAL: status
Notes
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffer containing data to be sent, should be aligned on a
half word frontier (16 bits) (as sent data will be handled by
DMA from halfword frontier). Depending on compilation chain,
use of specific alignment compilation directives or pragmas
might be required to ensure proper alignment for pData.
HAL_IRDA_Receive_DMA
Function name
HAL_StatusTypeDef HAL_IRDA_Receive_DMA
(IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size)
Function description
Receive an amount of data in DMA mode.
Parameters
272/1320
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.
DocID026525 Rev 6
UM1785
HAL IRDA Generic Driver
Return values
HAL: status
Notes
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffer for storing data to be received, should be aligned
on a half word frontier (16 bits) (as received data will be
handled by DMA from halfword frontier). Depending on
compilation chain, use of specific alignment compilation
directives or pragmas might be required to ensure proper
alignment for pData.
HAL_IRDA_DMAPause
Function name
HAL_StatusTypeDef HAL_IRDA_DMAPause
(IRDA_HandleTypeDef * hirda)
Function description
Pause 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
Resume 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
Stop 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
DocID026525 Rev 6
273/1320
HAL IRDA Generic Driver
UM1785
HAL_IRDA_Abort
Function name
HAL_StatusTypeDef HAL_IRDA_Abort (IRDA_HandleTypeDef
* hirda)
Function description
Abort ongoing transfers (blocking mode).
Parameters
hirda: Pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified UART
module.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable IRDA Interrupts (Tx
and Rx)Disable the DMA transfer in the peripheral register (if
enabled)Abort DMA transfer by calling HAL_DMA_Abort (in
case of transfer in DMA mode)Set handle State to READY
This procedure is executed in blocking mode : when exiting
function, Abort is considered as completed.
HAL_IRDA_AbortTransmit
Function name
HAL_StatusTypeDef HAL_IRDA_AbortTransmit
(IRDA_HandleTypeDef * hirda)
Function description
Abort ongoing Transmit transfer (blocking mode).
Parameters
hirda: Pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified UART
module.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing Tx
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable IRDA Interrupts
(Tx)Disable the DMA transfer in the peripheral register (if
enabled)Abort DMA transfer by calling HAL_DMA_Abort (in
case of transfer in DMA mode)Set handle State to READY
This procedure is executed in blocking mode : when exiting
function, Abort is considered as completed.
HAL_IRDA_AbortReceive
274/1320
Function name
HAL_StatusTypeDef HAL_IRDA_AbortReceive
(IRDA_HandleTypeDef * hirda)
Function description
Abort ongoing Receive transfer (blocking mode).
Parameters
hirda: Pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified UART
module.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing Rx
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable IRDA Interrupts
(Rx)Disable the DMA transfer in the peripheral register (if
DocID026525 Rev 6
UM1785
HAL IRDA Generic Driver
enabled)Abort DMA transfer by calling HAL_DMA_Abort (in
case of transfer in DMA mode)Set handle State to READY
This procedure is executed in blocking mode : when exiting
function, Abort is considered as completed.
HAL_IRDA_Abort_IT
Function name
HAL_StatusTypeDef HAL_IRDA_Abort_IT
(IRDA_HandleTypeDef * hirda)
Function description
Abort ongoing transfers (Interrupt mode).
Parameters
hirda: Pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified UART
module.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable IRDA Interrupts (Tx
and Rx)Disable the DMA transfer in the peripheral register (if
enabled)Abort DMA transfer by calling HAL_DMA_Abort_IT
(in case of transfer in DMA mode)Set handle State to
READYAt abort completion, call user abort complete callback
This procedure is executed in Interrupt mode, meaning that
abort procedure could be considered as completed only when
user abort complete callback is executed (not when exiting
function).
HAL_IRDA_AbortTransmit_IT
Function name
HAL_StatusTypeDef HAL_IRDA_AbortTransmit_IT
(IRDA_HandleTypeDef * hirda)
Function description
Abort ongoing Transmit transfer (Interrupt mode).
Parameters
hirda: Pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified UART
module.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing Tx
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable IRDA Interrupts
(Tx)Disable the DMA transfer in the peripheral register (if
enabled)Abort DMA transfer by calling HAL_DMA_Abort_IT
(in case of transfer in DMA mode)Set handle State to
READYAt abort completion, call user abort complete callback
This procedure is executed in Interrupt mode, meaning that
abort procedure could be considered as completed only when
user abort complete callback is executed (not when exiting
function).
DocID026525 Rev 6
275/1320
HAL IRDA Generic Driver
UM1785
HAL_IRDA_AbortReceive_IT
Function name
HAL_StatusTypeDef HAL_IRDA_AbortReceive_IT
(IRDA_HandleTypeDef * hirda)
Function description
Abort ongoing Receive transfer (Interrupt mode).
Parameters
hirda: Pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified UART
module.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing Rx
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable IRDA Interrupts
(Rx)Disable the DMA transfer in the peripheral register (if
enabled)Abort DMA transfer by calling HAL_DMA_Abort_IT
(in case of transfer in DMA mode)Set handle State to
READYAt abort completion, call user abort complete callback
This procedure is executed in Interrupt mode, meaning that
abort procedure could be considered as completed only when
user abort complete callback is executed (not when exiting
function).
HAL_IRDA_IRQHandler
Function name
void HAL_IRDA_IRQHandler (IRDA_HandleTypeDef * hirda)
Function description
Handle 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
276/1320
Function name
void HAL_IRDA_TxCpltCallback (IRDA_HandleTypeDef *
hirda)
Function description
Tx Transfer completed callback.
Parameters
hirda: Pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
Return values
None
DocID026525 Rev 6
UM1785
HAL IRDA Generic Driver
HAL_IRDA_RxCpltCallback
Function name
void HAL_IRDA_RxCpltCallback (IRDA_HandleTypeDef *
hirda)
Function description
Rx Transfer completed callback.
Parameters
hirda: Pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
Return values
None
HAL_IRDA_TxHalfCpltCallback
Function name
void HAL_IRDA_TxHalfCpltCallback (IRDA_HandleTypeDef *
hirda)
Function description
Tx Half Transfer completed callback.
Parameters
hirda: Pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified
USART module.
Return values
None
HAL_IRDA_RxHalfCpltCallback
Function name
void HAL_IRDA_RxHalfCpltCallback (IRDA_HandleTypeDef *
hirda)
Function description
Rx Half Transfer complete callback.
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 callback.
Parameters
hirda: Pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
Return values
None
DocID026525 Rev 6
277/1320
HAL IRDA Generic Driver
UM1785
HAL_IRDA_AbortCpltCallback
Function name
void HAL_IRDA_AbortCpltCallback (IRDA_HandleTypeDef *
hirda)
Function description
IRDA Abort Complete callback.
Parameters
hirda: Pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
Return values
None
HAL_IRDA_AbortTransmitCpltCallback
Function name
void HAL_IRDA_AbortTransmitCpltCallback
(IRDA_HandleTypeDef * hirda)
Function description
IRDA Abort Complete callback.
Parameters
hirda: Pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
Return values
None
HAL_IRDA_AbortReceiveCpltCallback
Function name
void HAL_IRDA_AbortReceiveCpltCallback
(IRDA_HandleTypeDef * hirda)
Function description
IRDA Abort Receive Complete callback.
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
Return the IRDA handle state.
Parameters
hirda: Pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
Return values
HAL: state
HAL_IRDA_GetError
Function name
uint32_t HAL_IRDA_GetError (IRDA_HandleTypeDef * hirda)
Function description
Return the IRDA handle error code.
Parameters
278/1320
hirda: Pointer to a IRDA_HandleTypeDef structure that
contains the configuration information for the specified IRDA
module.
DocID026525 Rev 6
UM1785
HAL IRDA Generic Driver
Return values
IRDA: Error Code
25.3
IRDA Firmware driver defines
25.3.1
IRDA
IRDA DMA Rx
IRDA_DMA_RX_DISABLE
IRDA DMA RX disabled
IRDA_DMA_RX_ENABLE
IRDA DMA RX enabled
IRDA DMA Tx
IRDA_DMA_TX_DISABLE
IRDA DMA TX disabled
IRDA_DMA_TX_ENABLE
IRDA DMA TX enabled
IRDA Error
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
HAL_IRDA_ERROR_BUSY
Busy Error
IRDA Exported Macros
__HAL_IRDA_RESET_HANDLE_STA
TE
Description:
Reset IRDA handle state.
Parameters:
__HANDLE__: IRDA handle.
Return value:
None
__HAL_IRDA_FLUSH_DRREGISTER
Description:
Flush the IRDA DR register.
Parameters:
__HANDLE__: specifies the IRDA Handle.
Return value:
None
__HAL_IRDA_CLEAR_FLAG
Description:
Clear the specified IRDA pending flag.
Parameters:
__HANDLE__: specifies the IRDA Handle.
__FLAG__: specifies the flag to check. This
parameter can be any combination of the
DocID026525 Rev 6
279/1320
HAL IRDA Generic Driver
UM1785
following values:
IRDA_CLEAR_PEF
IRDA_CLEAR_FEF
IRDA_CLEAR_NEF
IRDA_CLEAR_OREF
IRDA_CLEAR_TCF
IRDA_CLEAR_IDLEF
Return value:
None
__HAL_IRDA_CLEAR_PEFLAG
Description:
Clear the IRDA PE pending flag.
Parameters:
__HANDLE__: specifies the IRDA Handle.
Return value:
None
__HAL_IRDA_CLEAR_FEFLAG
Description:
Clear the IRDA FE pending flag.
Parameters:
__HANDLE__: specifies the IRDA Handle.
Return value:
None
__HAL_IRDA_CLEAR_NEFLAG
Description:
Clear the IRDA NE pending flag.
Parameters:
__HANDLE__: specifies the IRDA Handle.
Return value:
None
__HAL_IRDA_CLEAR_OREFLAG
Description:
Clear the IRDA ORE pending flag.
Parameters:
__HANDLE__: specifies the IRDA Handle.
Return value:
None
__HAL_IRDA_CLEAR_IDLEFLAG
Description:
Clear the IRDA IDLE pending flag.
Parameters:
__HANDLE__: specifies the IRDA Handle.
Return value:
280/1320
DocID026525 Rev 6
UM1785
HAL IRDA Generic Driver
None
__HAL_IRDA_GET_FLAG
Description:
Check whether the specified IRDA flag is
set or not.
Parameters:
__HANDLE__: specifies the IRDA Handle.
__FLAG__: specifies the flag to check. This
parameter can be one of the following
values:
IRDA_FLAG_REACK Receive enable
acknowledge flag
IRDA_FLAG_TEACK Transmit enable
acknowledge flag
IRDA_FLAG_BUSY Busy flag
IRDA_FLAG_ABRF Auto Baud rate
detection flag
IRDA_FLAG_ABRE Auto Baud rate
detection error flag
IRDA_FLAG_TXE Transmit data
register empty flag
IRDA_FLAG_TC Transmission
Complete flag
IRDA_FLAG_RXNE Receive data
register not empty flag
IRDA_FLAG_ORE OverRun Error flag
IRDA_FLAG_NE Noise Error flag
IRDA_FLAG_FE Framing Error flag
IRDA_FLAG_PE Parity Error flag
Return value:
The: new state of __FLAG__ (TRUE or
FALSE).
__HAL_IRDA_ENABLE_IT
Description:
Enable the specified IRDA interrupt.
Parameters:
__HANDLE__: specifies the IRDA Handle.
__INTERRUPT__: specifies the IRDA
interrupt source to enable. 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 interrupt
IRDA_IT_ERR Error interrupt(Frame
DocID026525 Rev 6
281/1320
HAL IRDA Generic Driver
UM1785
error, noise error, overrun error)
Return value:
None
Description:
__HAL_IRDA_DISABLE_IT
Disable the specified IRDA interrupt.
Parameters:
__HANDLE__: specifies the IRDA Handle.
__INTERRUPT__: specifies the IRDA
interrupt source to disable. 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 interrupt
IRDA_IT_ERR Error interrupt(Frame
error, noise error, overrun error)
Return value:
None
Description:
__HAL_IRDA_GET_IT
Check whether the specified IRDA interrupt
has occurred or not.
Parameters:
__HANDLE__: specifies the IRDA Handle.
__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
IRDA_IT_ORE OverRun Error interrupt
IRDA_IT_NE Noise Error interrupt
IRDA_IT_FE Framing Error interrupt
IRDA_IT_PE Parity Error interrupt
Return value:
The: new state of __IT__ (TRUE or FALSE).
__HAL_IRDA_GET_IT_SOURCE
282/1320
Description:
DocID026525 Rev 6
UM1785
HAL IRDA Generic Driver
Check whether the specified IRDA interrupt
source is enabled or not.
Parameters:
__HANDLE__: specifies the IRDA Handle.
__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
IRDA_IT_ERR Framing, overrun or
noise error interrupt
IRDA_IT_PE Parity Error interrupt
Return value:
The: new state of __IT__ (TRUE or FALSE).
__HAL_IRDA_CLEAR_IT
Description:
Clear the specified IRDA ISR flag, in setting
the proper ICR register flag.
Parameters:
__HANDLE__: specifies the IRDA Handle.
__IT_CLEAR__: specifies the interrupt clear
register flag that needs to be set to clear the
corresponding interrupt This parameter can
be one of the following values:
IRDA_CLEAR_PEF Parity Error Clear
Flag
IRDA_CLEAR_FEF Framing Error
Clear Flag
IRDA_CLEAR_NEF Noise detected
Clear Flag
IRDA_CLEAR_OREF OverRun Error
Clear Flag
IRDA_CLEAR_TCF Transmission
Complete Clear Flag
Return value:
None
__HAL_IRDA_SEND_REQ
Description:
Set a specific IRDA request flag.
Parameters:
__HANDLE__: specifies the IRDA Handle.
__REQ__: specifies the request flag to set
This parameter can be one of the following
DocID026525 Rev 6
283/1320
HAL IRDA Generic Driver
UM1785
values:
IRDA_AUTOBAUD_REQUEST AutoBaud Rate Request
IRDA_RXDATA_FLUSH_REQUEST
Receive Data flush Request
IRDA_TXDATA_FLUSH_REQUEST
Transmit data flush Request
Return value:
None
__HAL_IRDA_ONE_BIT_SAMPLE_
ENABLE
Description:
Enable the IRDA one bit sample method.
Parameters:
__HANDLE__: specifies the IRDA Handle.
Return value:
None
__HAL_IRDA_ONE_BIT_SAMPLE_
DISABLE
Description:
Disable the IRDA one bit sample method.
Parameters:
__HANDLE__: specifies the IRDA Handle.
Return value:
None
__HAL_IRDA_ENABLE
Description:
Enable UART/USART associated to IRDA
Handle.
Parameters:
__HANDLE__: specifies the IRDA Handle.
Return value:
None
__HAL_IRDA_DISABLE
Description:
Disable UART/USART associated to IRDA
Handle.
Parameters:
__HANDLE__: specifies the IRDA Handle.
Return value:
None
IRDA Flags
284/1320
IRDA_FLAG_REACK
IRDA Receive enable acknowledge flag
IRDA_FLAG_TEACK
IRDA Transmit enable acknowledge flag
DocID026525 Rev 6
UM1785
HAL IRDA Generic Driver
IRDA_FLAG_BUSY
IRDA Busy flag
IRDA_FLAG_ABRF
IRDA Auto baud rate flag
IRDA_FLAG_ABRE
IRDA Auto baud rate error
IRDA_FLAG_TXE
IRDA Transmit data register empty
IRDA_FLAG_TC
IRDA Transmission complete
IRDA_FLAG_RXNE
IRDA Read data register not empty
IRDA_FLAG_ORE
IRDA Overrun error
IRDA_FLAG_NE
IRDA Noise error
IRDA_FLAG_FE
IRDA Framing error
IRDA_FLAG_PE
IRDA Parity error
IRDA interruptions flags mask
IRDA_IT_MASK
IRDA Interruptions flags mask
IRDA Interrupts Definition
IRDA_IT_PE
IRDA Parity error interruption
IRDA_IT_TXE
IRDA Transmit data register empty interruption
IRDA_IT_TC
IRDA Transmission complete interruption
IRDA_IT_RXNE
IRDA Read data register not empty interruption
IRDA_IT_IDLE
IRDA Idle interruption
IRDA_IT_ERR
IRDA Error interruption
IRDA_IT_ORE
IRDA Overrun error interruption
IRDA_IT_NE
IRDA Noise error interruption
IRDA_IT_FE
IRDA Frame error interruption
IRDA Interruption Clear Flags
IRDA_CLEAR_PEF
Parity Error Clear Flag
IRDA_CLEAR_FEF
Framing Error Clear Flag
IRDA_CLEAR_NEF
Noise detected Clear Flag
IRDA_CLEAR_OREF
OverRun Error Clear Flag
IRDA_CLEAR_IDLEF
IDLE line detected Clear Flag
IRDA_CLEAR_TCF
Transmission Complete Clear Flag
IRDA Low Power
IRDA_POWERMODE_NORMAL
IRDA normal power mode
IRDA_POWERMODE_LOWPOWER
IRDA low power mode
IRDA Mode
IRDA_MODE_DISABLE
Associated UART disabled in IRDA mode
IRDA_MODE_ENABLE
Associated UART enabled in IRDA mode
DocID026525 Rev 6
285/1320
HAL IRDA Generic Driver
IRDA One Bit Sampling
UM1785
IRDA_ONE_BIT_SAMPLE_DISABLE
One-bit sampling disabled
IRDA_ONE_BIT_SAMPLE_ENABLE
One-bit sampling enabled
IRDA Parity
IRDA_PARITY_NONE
No parity
IRDA_PARITY_EVEN
Even parity
IRDA_PARITY_ODD
Odd parity
IRDA Request Parameters
IRDA_AUTOBAUD_REQUEST
Auto-Baud Rate Request
IRDA_RXDATA_FLUSH_REQUEST
Receive Data flush Request
IRDA_TXDATA_FLUSH_REQUEST
Transmit data flush Request
IRDA State
IRDA_STATE_DISABLE
IRDA disabled
IRDA_STATE_ENABLE
IRDA enabled
IRDA Transfer Mode
286/1320
IRDA_MODE_RX
RX mode
IRDA_MODE_TX
TX mode
IRDA_MODE_TX_RX
RX and TX mode
DocID026525 Rev 6
UM1785
HAL IRDA Extension Driver
26
HAL IRDA Extension Driver
26.1
IRDAEx Firmware driver defines
26.1.1
IRDAEx
IRDA Word Length
IRDA_WORDLENGTH_7B
7-bit long frame
IRDA_WORDLENGTH_8B
8-bit long frame
IRDA_WORDLENGTH_9B
9-bit long frame
DocID026525 Rev 6
287/1320
HAL IWDG Generic Driver
UM1785
27
HAL IWDG Generic Driver
27.1
IWDG Firmware driver registers structures
27.1.1
IWDG_InitTypeDef
Data Fields
uint32_t Prescaler
uint32_t Reload
uint32_t Window
Field Documentation
uint32_t IWDG_InitTypeDef::Prescaler
Select the prescaler of the IWDG. This parameter can be a value of IWDG_Prescaler
uint32_t IWDG_InitTypeDef::Reload
Specifies the IWDG down-counter reload value. This parameter must be a number
between Min_Data = 0 and Max_Data = 0x0FFF
uint32_t IWDG_InitTypeDef::Window
Specifies the window value to be compared to the down-counter. This parameter must
be a number between Min_Data = 0 and Max_Data = 0x0FFF
27.1.2
IWDG_HandleTypeDef
Data Fields
IWDG_TypeDef * Instance
IWDG_InitTypeDef Init
Field Documentation
IWDG_TypeDef* IWDG_HandleTypeDef::Instance
Register base address
IWDG_InitTypeDef IWDG_HandleTypeDef::Init
IWDG required parameters
27.2
IWDG Firmware driver API description
27.2.1
IWDG Generic features
The IWDG can be started by either software or hardware (configurable through option
byte).
The IWDG is clocked by 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 both can not be disabled. The
counter starts counting down from the reset value (0xFFF). When it reaches the end of
count value (0x000) a reset signal is generated (IWDG reset).
Whenever the key value 0x0000 AAAA is written in the IWDG_KR register, the
IWDG_RLR value is reloaded in the counter and the watchdog reset is prevented.
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.
Debug mode : When the microcontroller enters debug mode (core halted), the IWDG
counter either continues to work normally or stops, depending on DBG_IWDG_STOP
288/1320
DocID026525 Rev 6
UM1785
HAL IWDG Generic Driver
configuration bit in DBG module, accessible through
__HAL_DBGMCU_FREEZE_IWDG() and __HAL_DBGMCU_UNFREEZE_IWDG()
macros
Min-max timeout value @40KHz (LSI): ~0.1ms / ~26.2s The IWDG timeout may vary due
to LSI frequency dispersion. STM32F0xx devices provide the capability to measure the LSI
frequency (LSI clock connected internally to TIM16 CH1 input capture). The measured
value can be used to have an IWDG timeout with an acceptable accuracy.
27.2.2
How to use this driver
1.
2.
Use IWDG using HAL_IWDG_Init() function to :
Enable instance by writing Start keyword in IWDG_KEY register. LSI clock is
forced ON and IWDG counter starts downcounting.
Enable write access to configuration register: IWDG_PR, IWDG_RLR &
IWDG_WINR.
Configure the IWDG prescaler and counter reload value. This reload value will be
loaded in the IWDG counter each time the watchdog is reloaded, then the IWDG
will start counting down from this value.
wait for status flags to be reset"
Depending on window parameter:
If Window Init parameter is same as Window register value, nothing more is
done but reload counter value in order to exit function withy exact time base.
Else modify Window register. This will automatically reload watchdog
counter.
Then the application program must refresh the IWDG counter at regular intervals
during normal operation to prevent an MCU reset, using HAL_IWDG_Refresh()
function.
IWDG HAL driver macros list
Below the list of most used macros in IWDG HAL driver:
__HAL_IWDG_START: Enable the IWDG peripheral
__HAL_IWDG_RELOAD_COUNTER: Reloads IWDG counter with value defined in
the reload register
27.2.3
Initialization and Start functions
This section provides functions allowing to:
Initialize the IWDG according to the specified parameters in the IWDG_InitTypeDef of
associated handle.
Manage Window option.
Once initialization is performed in HAL_IWDG_Init function, Watchdog is reloaded in
order to exit function with correct time base.
This section contains the following APIs:
HAL_IWDG_Init()
27.2.4
IO operation functions
This section provides functions allowing to:
Refresh the IWDG.
This section contains the following APIs:
HAL_IWDG_Refresh()
DocID026525 Rev 6
289/1320
HAL IWDG Generic Driver
27.2.5
UM1785
Detailed description of functions
HAL_IWDG_Init
Function name
HAL_StatusTypeDef HAL_IWDG_Init (IWDG_HandleTypeDef *
hiwdg)
Function description
Initialize the IWDG according to the specified parameters in the
IWDG_InitTypeDef and start watchdog.
Parameters
hiwdg: pointer to a IWDG_HandleTypeDef structure that
contains the configuration information for the specified IWDG
module.
Return values
HAL: status
HAL_IWDG_Refresh
Function name
HAL_StatusTypeDef HAL_IWDG_Refresh
(IWDG_HandleTypeDef * hiwdg)
Function description
Refresh the IWDG.
Parameters
hiwdg: pointer to a IWDG_HandleTypeDef structure that
contains the configuration information for the specified IWDG
module.
Return values
HAL: status
27.3
IWDG Firmware driver defines
27.3.1
IWDG
IWDG Exported Macros
Description:
__HAL_IWDG_START
Enable the IWDG peripheral.
Parameters:
__HANDLE__: IWDG handle
Return value:
None
__HAL_IWDG_RELOAD_COUNTER
Description:
Reload IWDG counter with value defined in
the reload register (write access to IWDG_PR,
IWDG_RLR & IWDG_WINR registers
disabled).
Parameters:
__HANDLE__: IWDG handle
Return value:
None
290/1320
DocID026525 Rev 6
UM1785
HAL IWDG Generic Driver
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 Window option
IWDG_WINDOW_DISABLE
DocID026525 Rev 6
291/1320
HAL PCD Generic Driver
UM1785
28
HAL PCD Generic Driver
28.1
PCD Firmware driver registers structures
28.1.1
PCD_InitTypeDef
Data Fields
uint32_t dev_endpoints
uint32_t speed
uint32_t ep0_mps
uint32_t phy_itface
uint32_t Sof_enable
uint32_t low_power_enable
uint32_t lpm_enable
uint32_t battery_charging_enable
Field Documentation
uint32_t PCD_InitTypeDef::dev_endpoints
Device Endpoints number. This parameter depends on the used USB core. This
parameter must be a number between Min_Data = 1 and Max_Data = 15
uint32_t PCD_InitTypeDef::speed
USB Core speed. This parameter can be any value of PCD_Core_Speed
uint32_t PCD_InitTypeDef::ep0_mps
Set the Endpoint 0 Max Packet size. This parameter can be any value of
PCD_EP0_MPS
uint32_t PCD_InitTypeDef::phy_itface
Select the used PHY interface. This parameter can be any value of PCD_Core_PHY
uint32_t PCD_InitTypeDef::Sof_enable
Enable or disable the output of the SOF signal. This parameter can be set to ENABLE
or DISABLE
uint32_t PCD_InitTypeDef::low_power_enable
Enable or disable Low Power mode This parameter can be set to ENABLE or
DISABLE
uint32_t PCD_InitTypeDef::lpm_enable
Enable or disable the Link Power Management . This parameter can be set to
ENABLE or DISABLE
uint32_t PCD_InitTypeDef::battery_charging_enable
Enable or disable Battery charging. This parameter can be set to ENABLE or
DISABLE
28.1.2
PCD_EPTypeDef
Data Fields
uint8_t num
uint8_t is_in
uint8_t is_stall
uint8_t type
uint16_t pmaadress
uint16_t pmaaddr0
uint16_t pmaaddr1
uint8_t doublebuffer
292/1320
DocID026525 Rev 6
UM1785
HAL PCD Generic Driver
uint32_t maxpacket
uint8_t * xfer_buff
uint32_t xfer_len
uint32_t xfer_count
Field Documentation
uint8_t PCD_EPTypeDef::num
Endpoint number This parameter must be a number between Min_Data = 1 and
Max_Data = 15
uint8_t PCD_EPTypeDef::is_in
Endpoint direction This parameter must be a number between Min_Data = 0 and
Max_Data = 1
uint8_t PCD_EPTypeDef::is_stall
Endpoint stall condition This parameter must be a number between Min_Data = 0 and
Max_Data = 1
uint8_t PCD_EPTypeDef::type
Endpoint type This parameter can be any value of PCD_EP_Type
uint16_t PCD_EPTypeDef::pmaadress
PMA Address This parameter can be any value between Min_addr = 0 and Max_addr
= 1K
uint16_t PCD_EPTypeDef::pmaaddr0
PMA Address0 This parameter can be any value between Min_addr = 0 and
Max_addr = 1K
uint16_t PCD_EPTypeDef::pmaaddr1
PMA Address1 This parameter can be any value between Min_addr = 0 and
Max_addr = 1K
uint8_t PCD_EPTypeDef::doublebuffer
Double buffer enable This parameter can be 0 or 1
uint32_t PCD_EPTypeDef::maxpacket
Endpoint Max packet size This parameter must be a number between Min_Data = 0
and Max_Data = 64KB
uint8_t* PCD_EPTypeDef::xfer_buff
Pointer to transfer buffer
uint32_t PCD_EPTypeDef::xfer_len
Current transfer length
uint32_t PCD_EPTypeDef::xfer_count
Partial transfer length in case of multi packet transfer
28.1.3
PCD_HandleTypeDef
Data Fields
PCD_TypeDef * Instance
PCD_InitTypeDef Init
__IO uint8_t USB_Address
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
DocID026525 Rev 6
293/1320
HAL PCD Generic Driver
UM1785
PCD_InitTypeDef PCD_HandleTypeDef::Init
PCD required parameters
__IO uint8_t PCD_HandleTypeDef::USB_Address
USB Address
PCD_EPTypeDef PCD_HandleTypeDef::IN_ep[8]
IN endpoint parameters
PCD_EPTypeDef PCD_HandleTypeDef::OUT_ep[8]
OUT endpoint parameters
HAL_LockTypeDef PCD_HandleTypeDef::Lock
PCD peripheral status
__IO PCD_StateTypeDef PCD_HandleTypeDef::State
PCD communication state
uint32_t PCD_HandleTypeDef::Setup[12]
Setup packet buffer
void* PCD_HandleTypeDef::pData
Pointer to upper stack Handler
28.2
PCD Firmware driver API description
28.2.1
How to use this driver
The PCD HAL driver can be used as follows:
1.
2.
3.
4.
5.
6.
28.2.2
Declare a PCD_HandleTypeDef handle structure, for example: PCD_HandleTypeDef
hpcd;
Fill parameters of Init structure in HCD handle
Call HAL_PCD_Init() API to initialize the HCD peripheral (Core, Device core, ...)
Initialize the PCD low level resources through the HAL_PCD_MspInit() API:
a. Enable the PCD/USB Low Level interface clock using
__HAL_RCC_USB_CLK_ENABLE);
b. Initialize the related GPIO clocks
c. Configure PCD pin-out
d. Configure PCD NVIC interrupt
Associate the Upper USB device stack to the HAL PCD Driver:
a. hpcd.pData = pdev;
Enable HCD transmission and reception:
a. HAL_PCD_Start();
Initialization and de-initialization functions
This section provides functions allowing to:
This section contains the following APIs:
HAL_PCD_Init()
HAL_PCD_DeInit()
HAL_PCD_MspInit()
HAL_PCD_MspDeInit()
28.2.3
IO operation functions
This subsection provides a set of functions allowing to manage the PCD data transfers.
This section contains the following APIs:
HAL_PCD_Start()
HAL_PCD_Stop()
HAL_PCD_IRQHandler()
294/1320
DocID026525 Rev 6
UM1785
HAL PCD Generic Driver
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()
28.2.4
Peripheral Control functions
This subsection provides a set of functions allowing to control the PCD data transfers.
This section contains the following APIs:
HAL_PCD_DevConnect()
HAL_PCD_DevDisconnect()
HAL_PCD_SetAddress()
HAL_PCD_EP_Open()
HAL_PCD_EP_Close()
HAL_PCD_EP_Receive()
HAL_PCD_EP_GetRxCount()
HAL_PCD_EP_Transmit()
HAL_PCD_EP_SetStall()
HAL_PCD_EP_ClrStall()
HAL_PCD_EP_Flush()
HAL_PCD_ActivateRemoteWakeup()
HAL_PCD_DeActivateRemoteWakeup()
28.2.5
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:
HAL_PCD_GetState()
28.2.6
Detailed description of functions
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 create the associated handle.
Parameters
hpcd: PCD handle
Return values
HAL: status
DocID026525 Rev 6
295/1320
HAL PCD Generic Driver
UM1785
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 device.
Parameters
hpcd: PCD handle
Return values
HAL: status
HAL_PCD_Stop
Function name
HAL_StatusTypeDef HAL_PCD_Stop (PCD_HandleTypeDef *
hpcd)
Function description
Stop the USB device.
Parameters
hpcd: PCD handle
Return values
HAL: status
HAL_PCD_IRQHandler
296/1320
Function name
void HAL_PCD_IRQHandler (PCD_HandleTypeDef * hpcd)
Function description
This function handles PCD interrupt request.
Parameters
hpcd: PCD handle
Return values
HAL: status
DocID026525 Rev 6
UM1785
HAL PCD Generic Driver
HAL_PCD_DataOutStageCallback
Function name
void HAL_PCD_DataOutStageCallback (PCD_HandleTypeDef *
hpcd, uint8_t epnum)
Function description
Data out stage callbacks.
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 callbacks.
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
void HAL_PCD_SOFCallback (PCD_HandleTypeDef * hpcd)
Function description
USB Start Of Frame callbacks.
Parameters
hpcd: PCD handle
Return values
None
HAL_PCD_ResetCallback
Function name
void HAL_PCD_ResetCallback (PCD_HandleTypeDef * hpcd)
Function description
USB Reset callbacks.
Parameters
hpcd: PCD handle
Return values
None
HAL_PCD_SuspendCallback
Function name
void HAL_PCD_SuspendCallback (PCD_HandleTypeDef *
hpcd)
Function description
Suspend event callbacks.
DocID026525 Rev 6
297/1320
HAL PCD Generic Driver
Parameters
Return values
UM1785
hpcd: PCD handle
None
HAL_PCD_ResumeCallback
Function name
void HAL_PCD_ResumeCallback (PCD_HandleTypeDef *
hpcd)
Function description
Resume event callbacks.
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 callbacks.
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 callbacks.
Parameters
hpcd: PCD handle
epnum: endpoint number
Return values
None
HAL_PCD_ConnectCallback
Function name
void HAL_PCD_ConnectCallback (PCD_HandleTypeDef *
hpcd)
Function description
Connection event callbacks.
Parameters
hpcd: PCD handle
Return values
None
HAL_PCD_DisconnectCallback
298/1320
Function name
void HAL_PCD_DisconnectCallback (PCD_HandleTypeDef *
hpcd)
Function description
Disconnection event callbacks.
Parameters
hpcd: PCD handle
Return values
None
DocID026525 Rev 6
UM1785
HAL PCD Generic Driver
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
HAL_StatusTypeDef HAL_PCD_EP_Open
(PCD_HandleTypeDef * hpcd, uint8_t ep_addr, uint16_t
ep_mps, uint8_t ep_type)
Function description
Open and configure an endpoint.
Parameters
hpcd: PCD handle
ep_addr: endpoint address
ep_mps: endpoint max packert size
ep_type: endpoint type
Return values
HAL: status
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
DocID026525 Rev 6
299/1320
HAL PCD Generic Driver
UM1785
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_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
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_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
300/1320
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.
DocID026525 Rev 6
UM1785
HAL PCD Generic Driver
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
HAL_PCD_ActivateRemoteWakeup : active 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
HAL_PCD_DeActivateRemoteWakeup : de-active remote wakeup
signalling.
Parameters
hpcd: PCD handle
Return values
HAL: status
HAL_PCD_GetState
Function name
PCD_StateTypeDef HAL_PCD_GetState (PCD_HandleTypeDef
* hpcd)
Function description
Return the PCD state.
Parameters
hpcd: PCD handle
Return values
HAL: state
DocID026525 Rev 6
301/1320
HAL PCD Generic Driver
UM1785
28.3
PCD Firmware driver defines
28.3.1
PCD
PCD Core PHY
PCD_PHY_EMBEDDED
PCD Core Speed
PCD_SPEED_HIGH
PCD_SPEED_FULL
PCD ENDP
PCD_ENDP0
PCD_ENDP1
PCD_ENDP2
PCD_ENDP3
PCD_ENDP4
PCD_ENDP5
PCD_ENDP6
PCD_ENDP7
PCD Endpoint Kind
PCD_SNG_BUF
PCD_DBL_BUF
PCD EP0 MPS
DEP0CTL_MPS_64
DEP0CTL_MPS_32
DEP0CTL_MPS_16
DEP0CTL_MPS_8
PCD_EP0MPS_64
PCD_EP0MPS_32
PCD_EP0MPS_16
PCD_EP0MPS_08
PCD EP Type
PCD_EP_TYPE_CTRL
PCD_EP_TYPE_ISOC
PCD_EP_TYPE_BULK
PCD_EP_TYPE_INTR
302/1320
DocID026525 Rev 6
UM1785
HAL PCD Generic Driver
PCD Exported Macros
__HAL_PCD_GET_FLAG
__HAL_PCD_CLEAR_FLAG
__HAL_USB_WAKEUP_EXTI_ENABLE_IT
__HAL_USB_WAKEUP_EXTI_DISABLE_IT
__HAL_USB_EXTI_GENERATE_SWIT
PCD Instance definition
IS_PCD_ALL_INSTANCE
DocID026525 Rev 6
303/1320
HAL PCD Extension Driver
UM1785
29
HAL PCD Extension Driver
29.1
PCDEx Firmware driver API description
29.1.1
Extended Peripheral Control functions
This section provides functions allowing to:
Update PMA configuration
This section contains the following APIs:
HAL_PCDEx_PMAConfig()
29.1.2
Detailed description of functions
HAL_PCDEx_PMAConfig
304/1320
Function name
HAL_StatusTypeDef HAL_PCDEx_PMAConfig
(PCD_HandleTypeDef * hpcd, uint16_t ep_addr, uint16_t
ep_kind, uint32_t pmaadress)
Function description
Configure PMA for EP.
Parameters
hpcd: PCD handle
ep_addr: endpoint address
ep_kind: endpoint Kind
USB_SNG_BUF: Single Buffer used
USB_DBL_BUF: Double Buffer used
pmaadress: EP address in The PMA: In case of single buffer
endpoint this parameter is 16-bit value providing the address
in PMA allocated to endpoint. In case of double buffer
endpoint this parameter is a 32-bit value providing the
endpoint buffer 0 address in the LSB part of 32-bit value and
endpoint buffer 1 address in the MSB part of 32-bit value.
Return values
status
DocID026525 Rev 6
UM1785
HAL PWR Generic Driver
30
HAL PWR Generic Driver
30.1
PWR Firmware driver API description
30.1.1
Initialization and de-initialization functions
After reset, the backup domain (RTC registers, RTC backup data registers) is protected
against possible unwanted write accesses. To enable access to the RTC Domain and RTC
registers, proceed as follows:
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.
30.1.2
Peripheral Control functions
WakeUp pin configuration
WakeUp pin is used to wakeup the system from Standby mode. This pin is forced in
input pull down configuration and is active on rising edges.
There are two WakeUp pins, and up to eight Wakeup pins on STM32F07x &
STM32F09x devices.
WakeUp Pin 1 on PA.00.
WakeUp Pin 2 on PC.13.
WakeUp Pin 3 on PE.06.(STM32F07x/STM32F09x)
WakeUp Pin 4 on PA.02.(STM32F07x/STM32F09x)
WakeUp Pin 5 on PC.05.(STM32F07x/STM32F09x)
WakeUp Pin 6 on PB.05.(STM32F07x/STM32F09x)
WakeUp Pin 7 on PB.15.(STM32F07x/STM32F09x)
WakeUp Pin 8 on PF.02.(STM32F07x/STM32F09x)
Low Power modes configuration
The devices feature 3 low-power modes:
Sleep mode: Cortex-M0 core stopped, peripherals kept running.
Stop mode: all clocks are stopped, regulator running, regulator in low power mode
Standby mode: 1.2V domain powered off (mode not available on STM32F0x8
devices).
Sleep mode
Entry: The Sleep mode is entered by using the
HAL_PWR_EnterSLEEPMode(PWR_MAINREGULATOR_ON,
PWR_SLEEPENTRY_WFx) functions with
PWR_SLEEPENTRY_WFI: enter SLEEP mode with WFI instruction
PWR_SLEEPENTRY_WFE: enter SLEEP mode with WFE instruction
Exit:
Any peripheral interrupt acknowledged by the nested vectored interrupt controller
(NVIC) can wake up the device from Sleep mode.
DocID026525 Rev 6
305/1320
HAL PWR Generic Driver
UM1785
Stop mode
In Stop mode, all clocks in the 1.8V domain are stopped, the PLL, the HSI, and the HSE
RC oscillators are disabled. Internal SRAM and register contents are preserved. The
voltage regulator can be configured either in normal or low-power mode. To minimize the
consumption.
Entry: The Stop mode is entered using the
HAL_PWR_EnterSTOPMode(PWR_MAINREGULATOR_ON,
PWR_STOPENTRY_WFI ) function with:
Main regulator ON.
Low Power regulator ON.
PWR_STOPENTRY_WFI: enter STOP mode with WFI instruction
PWR_STOPENTRY_WFE: enter STOP mode with WFE instruction
Exit:
Any EXTI Line (Internal or External) configured in Interrupt/Event mode.
Some specific communication peripherals (CEC, USART, I2C) interrupts, when
programmed in wakeup mode (the peripheral must be programmed in wakeup
mode and the corresponding interrupt vector must be enabled in the NVIC)
Standby mode
The Standby mode allows to achieve the lowest power consumption. It is based on the
Cortex-M0 deep sleep mode, with the voltage regulator disabled. The 1.8V domain is
consequently powered off. The PLL, the HSI oscillator and the HSE oscillator are also
switched off. SRAM and register contents are lost except for the RTC registers, RTC
backup registers and Standby circuitry. The voltage regulator is OFF.
Entry:
The Standby mode is entered using the HAL_PWR_EnterSTANDBYMode()
function.
Exit:
WKUP pin rising edge, RTC alarm (Alarm A), RTC wakeup, tamper event, timestamp event, external reset in NRST pin, IWDG reset.
Auto-wakeup (AWU) from low-power mode
The MCU can be woken up from low-power mode by an RTC Alarm event, an RTC
Wakeup event, a tamper event, a time-stamp event, or a comparator event, without
depending on an external interrupt (Auto-wakeup mode).
RTC auto-wakeup (AWU) from the Stop and Standby modes
To wake up from the Stop mode with an RTC alarm event, it is necessary to
configure the RTC to generate the RTC alarm using the
HAL_RTC_SetAlarm_IT() function.
To wake up from the Stop mode with an RTC Tamper or time stamp event, it is
necessary to configure the RTC to detect the tamper or time stamp event using
the HAL_RTC_SetTimeStamp_IT() or HAL_RTC_SetTamper_IT() functions.
To wake up from the Stop mode with an RTC WakeUp event, it is necessary to
configure the RTC to generate the RTC WakeUp event using the
HAL_RTC_SetWakeUpTimer_IT() function.
Comparator auto-wakeup (AWU) from the Stop mode
To wake up from the Stop mode with a comparator wakeup event, it is necessary
to:
Configure the EXTI Line associated with the comparator (example EXTI Line
22 for comparator 2) to be sensitive to to the selected edges (falling, rising
306/1320
DocID026525 Rev 6
UM1785
HAL PWR Generic Driver
or falling and rising) (Interrupt or Event modes) using the EXTI_Init()
function.
Configure the comparator to generate the event.
This section contains the following APIs:
HAL_PWR_EnableWakeUpPin()
HAL_PWR_DisableWakeUpPin()
HAL_PWR_EnterSLEEPMode()
HAL_PWR_EnterSTOPMode()
HAL_PWR_EnterSTANDBYMode()
HAL_PWR_EnableSleepOnExit()
HAL_PWR_DisableSleepOnExit()
HAL_PWR_EnableSEVOnPend()
HAL_PWR_DisableSEVOnPend()
HAL_PWR_EnableBkUpAccess()
HAL_PWR_DisableBkUpAccess()
30.1.3
Detailed description of functions
HAL_PWR_DeInit
Function name
void HAL_PWR_DeInit (void )
Function description
Deinitializes the 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 when present).
Return values
None
Notes
If the HSE divided by 32 is used as the RTC clock, the
Backup Domain Access should be kept enabled.
HAL_PWR_DisableBkUpAccess
Function name
void HAL_PWR_DisableBkUpAccess (void )
Function description
Disables access to the backup domain (RTC registers, RTC
backup data registers when present).
Return values
None
Notes
If the HSE divided by 32 is used as the RTC clock, the
Backup Domain Access should be kept enabled.
DocID026525 Rev 6
307/1320
HAL PWR Generic Driver
UM1785
HAL_PWR_EnableWakeUpPin
Function name
void HAL_PWR_EnableWakeUpPin (uint32_t WakeUpPinx)
Function description
Enables the WakeUp PINx functionality.
Parameters
WakeUpPinx: Specifies the Power Wake-Up pin to enable.
This parameter can be value of : PWREx Wakeup Pins
Return values
None
HAL_PWR_DisableWakeUpPin
Function name
void HAL_PWR_DisableWakeUpPin (uint32_t WakeUpPinx)
Function description
Disables the WakeUp PINx functionality.
Parameters
WakeUpPinx: Specifies the Power Wake-Up pin to disable.
This parameter can be values of : PWREx Wakeup Pins
Return values
None
HAL_PWR_EnterSTOPMode
308/1320
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 ON
PWR_LOWPOWERREGULATOR_ON: STOP mode
with low power regulator ON
STOPEntry: specifies if STOP mode in entered with WFI or
WFE instruction. This parameter can be one of the following
values:
PWR_STOPENTRY_WFI:Enter STOP mode with WFI
instruction
PWR_STOPENTRY_WFE: Enter STOP mode with WFE
instruction
Return values
None
Notes
In Stop mode, all I/O pins keep the same state as in Run
mode.
When exiting Stop mode by issuing an interrupt or a wakeup
event, the HSI RC oscillator is selected as system clock.
When the voltage regulator operates in low power mode, an
additional startup delay is incurred when waking up from Stop
mode. By keeping the internal regulator ON during Stop
mode, the consumption is higher although the startup time is
reduced.
DocID026525 Rev 6
UM1785
HAL PWR Generic Driver
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. On
STM32F0 devices, this parameter is a dummy value and it is
ignored as regulator can't be modified in this mode.
Parameter is kept for platform compatibility.
SLEEPEntry: Specifies if SLEEP mode is entered with WFI
or WFE instruction. When WFI entry is used, tick interrupt
have to be disabled if not desired as the interrupt wake up
source. This parameter can be one of the following values:
PWR_SLEEPENTRY_WFI: enter SLEEP mode with WFI
instruction
PWR_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.
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 alternate function pins if
configured for tamper, time-stamp, RTC Alarm out, or RTC
clock calibration out.WKUP pins if enabled. STM32F0x8
devices, the Stop mode is available, but it is aningless to
distinguish between voltage regulator in Low power mode and
voltage regulator in Run mode because the regulator not used
and the core is supplied directly from an external source.
Consequently, the Standby mode is not available on those
devices.
HAL_PWR_EnableSleepOnExit
Function name
void HAL_PWR_EnableSleepOnExit (void )
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.
DocID026525 Rev 6
309/1320
HAL PWR Generic Driver
UM1785
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.
Return values
None
Notes
Clears SLEEPONEXIT bit of SCR register. When this bit is
set, the processor re-enters SLEEP mode when an
interruption handling is over.
HAL_PWR_EnableSEVOnPend
Function name
void HAL_PWR_EnableSEVOnPend (void )
Function description
Enables CORTEX M4 SEVONPEND bit.
Return values
None
Notes
Sets SEVONPEND bit of SCR register. When this bit is set,
this causes WFE to wake up when an interrupt moves from
inactive to pended.
HAL_PWR_DisableSEVOnPend
Function name
void HAL_PWR_DisableSEVOnPend (void )
Function description
Disables CORTEX M4 SEVONPEND bit.
Return values
None
Notes
Clears SEVONPEND bit of SCR register. When this bit is set,
this causes WFE to wake up when an interrupt moves from
inactive to pended.
30.2
PWR Firmware driver defines
30.2.1
PWR
PWR Exported Macro
__HAL_PWR_GET_FLAG
Description:
Check PWR flag is set or not.
Parameters:
__FLAG__: specifies the flag to check. This parameter
can be one of the following values:
PWR_FLAG_WU: Wake Up flag. This flag
indicates that a wakeup event was received from
the WKUP pin or from the RTC alarm (Alarm A),
RTC Tamper event, RTC TimeStamp event or
RTC Wakeup. An additional wakeup event is
detected if the WKUP pin is enabled (by setting
the EWUP bit) when the WKUP pin level is
already high.
PWR_FLAG_SB: StandBy flag. This flag
indicates that the system was resumed from
310/1320
DocID026525 Rev 6
UM1785
HAL PWR Generic Driver
StandBy mode.
PWR_FLAG_PVDO: PVD Output. This flag is
valid only if PVD is enabled by the
HAL_PWR_EnablePVD() function. The PVD is
stopped by Standby mode For this reason, this bit
is equal to 0 after Standby or reset until the
PVDE bit is set. Warning: this Flag is not
available on STM32F030x8 products
PWR_FLAG_VREFINTRDY: This flag indicates
that the internal reference voltage VREFINT is
ready. Warning: this Flag is not available on
STM32F030x8 products
Return value:
The: new state of __FLAG__ (TRUE or FALSE).
__HAL_PWR_CLEAR_FLAG
Description:
Clear the PWR's pending flags.
Parameters:
__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
PWR Regulator state in STOP mode
PWR_MAINREGULATOR_ON
PWR_LOWPOWERREGULATOR_ON
IS_PWR_REGULATOR
PWR SLEEP mode entry
PWR_SLEEPENTRY_WFI
PWR_SLEEPENTRY_WFE
IS_PWR_SLEEP_ENTRY
PWR STOP mode entry
PWR_STOPENTRY_WFI
PWR_STOPENTRY_WFE
IS_PWR_STOP_ENTRY
DocID026525 Rev 6
311/1320
HAL PWR Extension Driver
UM1785
31
HAL PWR Extension Driver
31.1
PWREx 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
PWREx_PVD_detection_level
uint32_t PWR_PVDTypeDef::Mode
Mode: Specifies the operating mode for the selected pins. This parameter can be a
value of PWREx_PVD_Mode
31.2
PWREx Firmware driver API description
31.2.1
Peripheral extended control functions
PVD configuration
The PVD is used to monitor the VDD power supply by comparing it to a threshold
selected by the PVD Level (PLS[2:0] bits in the PWR_CR).
A PVDO flag is available to indicate if VDD/VDDA is higher or lower than the PVD
threshold. This event is internally connected to the EXTI line16 and can generate an
interrupt if enabled. This is done through HAL_PWR_ConfigPVD(),
HAL_PWR_EnablePVD() functions.
The PVD is stopped in Standby mode. PVD is not available on STM32F030x4/x6/x8
VDDIO2 Monitor Configuration
VDDIO2 monitor is used to monitor the VDDIO2 power supply by comparing it to
VREFInt Voltage
This monitor is internally connected to the EXTI line31 and can generate an interrupt if
enabled. This is done through HAL_PWREx_EnableVddio2Monitor() function.
VDDIO2 is available on STM32F07x/09x/04x
This section contains the following APIs:
HAL_PWR_ConfigPVD()
HAL_PWR_EnablePVD()
HAL_PWR_DisablePVD()
HAL_PWR_PVD_IRQHandler()
HAL_PWR_PVDCallback()
HAL_PWREx_EnableVddio2Monitor()
HAL_PWREx_DisableVddio2Monitor()
HAL_PWREx_Vddio2Monitor_IRQHandler()
HAL_PWREx_Vddio2MonitorCallback()
312/1320
DocID026525 Rev 6
UM1785
31.2.2
HAL PWR Extension Driver
Detailed description of functions
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() or
PVD_VDDIO2_IRQHandler().
HAL_PWR_PVDCallback
Function name
void HAL_PWR_PVDCallback (void )
Function description
PWR PVD interrupt callback.
Return values
None
HAL_PWREx_Vddio2Monitor_IRQHandler
Function name
void HAL_PWREx_Vddio2Monitor_IRQHandler (void )
Function description
This function handles the PWR Vddio2 monitor interrupt request.
Return values
None
Notes
This API should be called under the VDDIO2_IRQHandler()
PVD_VDDIO2_IRQHandler().
HAL_PWREx_Vddio2MonitorCallback
Function name
void HAL_PWREx_Vddio2MonitorCallback (void )
Function description
PWR Vddio2 Monitor interrupt callback.
Return values
None
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.
DocID026525 Rev 6
313/1320
HAL PWR Extension Driver
UM1785
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_PWREx_EnableVddio2Monitor
Function name
void HAL_PWREx_EnableVddio2Monitor (void )
Function description
Enable VDDIO2 monitor: enable Exti 31 and falling edge detection.
Return values
None
Notes
If Exti 31 is enable correlty and VDDIO2 voltage goes below
Vrefint, an interrupt is generated Irq line 1. NVIS has to be
enable by user.
HAL_PWREx_DisableVddio2Monitor
Function name
void HAL_PWREx_DisableVddio2Monitor (void )
Function description
Disable the Vddio2 Monitor.
Return values
None
31.3
PWREx Firmware driver defines
31.3.1
PWREx
PWREx Exported Macros
__HAL_PWR_PVD_EXTI_ENABLE_IT
Description:
Enable interrupt on PVD
Exti Line 16.
Return value:
None.
__HAL_PWR_PVD_EXTI_DISABLE_IT
Description:
Disable interrupt on PVD
Exti Line 16.
Return value:
None.
314/1320
DocID026525 Rev 6
UM1785
__HAL_PWR_PVD_EXTI_ENABLE_EVENT
HAL PWR Extension Driver
Description:
Enable event on PVD Exti
Line 16.
Return value:
None.
__HAL_PWR_PVD_EXTI_DISABLE_EVENT
Description:
Disable event on PVD Exti
Line 16.
Return value:
None.
__HAL_PWR_PVD_EXTI_DISABLE_RISING_EDGE
Description:
Disable the PVD Extended
Interrupt Rising Trigger.
Return value:
None.
__HAL_PWR_PVD_EXTI_DISABLE_FALLING_EDGE
Description:
Disable the PVD Extended
Interrupt Falling Trigger.
Return value:
None.
__HAL_PWR_PVD_EXTI_DISABLE_RISING_FALLING
_EDGE
Description:
Disable the PVD Extended
Interrupt Rising & Falling
Trigger.
Return value:
None
__HAL_PWR_PVD_EXTI_ENABLE_FALLING_EDGE
Description:
PVD EXTI line
configuration: set falling
edge trigger.
Return value:
None.
__HAL_PWR_PVD_EXTI_ENABLE_RISING_EDGE
Description:
PVD EXTI line
configuration: set rising
edge trigger.
Return value:
None.
DocID026525 Rev 6
315/1320
HAL PWR Extension Driver
__HAL_PWR_PVD_EXTI_ENABLE_RISING_FALLING
_EDGE
UM1785
Description:
Enable the PVD Extended
Interrupt Rising & Falling
Trigger.
Return value:
None
__HAL_PWR_PVD_EXTI_GET_FLAG
Description:
Check whether the
specified PVD EXTI
interrupt flag is set or not.
Return value:
EXTI: PVD Line Status.
__HAL_PWR_PVD_EXTI_CLEAR_FLAG
Description:
Clear the PVD EXTI flag.
Return value:
None.
__HAL_PWR_PVD_EXTI_GENERATE_SWIT
Description:
Generate a Software
interrupt on selected EXTI
line.
Return value:
None.
__HAL_PWR_VDDIO2_EXTI_ENABLE_IT
Description:
Enable interrupt on Vddio2
Monitor Exti Line 31.
Return value:
None.
__HAL_PWR_VDDIO2_EXTI_DISABLE_IT
Description:
Disable interrupt on Vddio2
Monitor Exti Line 31.
Return value:
None.
__HAL_PWR_VDDIO2_EXTI_DISABLE_FALLING_
EDGE
Description:
Vddio2 Monitor EXTI line
configuration: clear falling
edge and rising edge
trigger.
Return value:
None.
316/1320
DocID026525 Rev 6
UM1785
__HAL_PWR_VDDIO2_EXTI_ENABLE_FALLING_
EDGE
HAL PWR Extension Driver
Description:
Vddio2 Monitor EXTI line
configuration: set falling
edge trigger.
Return value:
None.
__HAL_PWR_VDDIO2_EXTI_GET_FLAG
Description:
Check whether the
specified VDDIO2 monitor
EXTI interrupt flag is set or
not.
Return value:
EXTI: VDDIO2 Monitor
Line Status.
__HAL_PWR_VDDIO2_EXTI_CLEAR_FLAG
Description:
Clear the VDDIO2 Monitor
EXTI flag.
Return value:
None.
__HAL_PWR_VDDIO2_EXTI_GENERATE_SWIT
Description:
Generate a Software
interrupt on selected EXTI
line.
Return value:
None.
PWREx EXTI Line
PWR_EXTI_LINE_PVD
External interrupt line 16 Connected to the PVD EXTI Line
PWR_EXTI_LINE_VDDIO2
External interrupt line 31 Connected to the Vddio2 Monitor
EXTI Line
PWREx Flag
PWR_FLAG_WU
PWR_FLAG_SB
PWR_FLAG_PVDO
PWR_FLAG_VREFINTRDY
PWREx PVD detection level
PWR_PVDLEVEL_0
PWR_PVDLEVEL_1
PWR_PVDLEVEL_2
PWR_PVDLEVEL_3
DocID026525 Rev 6
317/1320
HAL PWR Extension Driver
PWR_PVDLEVEL_4
UM1785
PWR_PVDLEVEL_5
PWR_PVDLEVEL_6
PWR_PVDLEVEL_7
IS_PWR_PVD_LEVEL
PWREx PVD Mode
PWR_PVD_MODE_NORMAL
basic mode is used
PWR_PVD_MODE_IT_RISING
External Interrupt Mode with Rising edge
trigger detection
PWR_PVD_MODE_IT_FALLING
External Interrupt Mode with Falling
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
IS_PWR_PVD_MODE
PWREx Wakeup Pins
PWR_WAKEUP_PIN1
PWR_WAKEUP_PIN2
PWR_WAKEUP_PIN3
PWR_WAKEUP_PIN4
PWR_WAKEUP_PIN5
PWR_WAKEUP_PIN6
PWR_WAKEUP_PIN7
PWR_WAKEUP_PIN8
IS_PWR_WAKEUP_PIN
318/1320
DocID026525 Rev 6
UM1785
HAL RCC Generic Driver
32
HAL RCC Generic Driver
32.1
RCC Firmware driver registers structures
32.1.1
RCC_PLLInitTypeDef
Data Fields
uint32_t PLLState
uint32_t PLLSource
uint32_t PLLMUL
uint32_t PREDIV
Field Documentation
uint32_t RCC_PLLInitTypeDef::PLLState
PLLState: The new state of the PLL. This parameter can be a value of
RCC_PLL_Config
uint32_t RCC_PLLInitTypeDef::PLLSource
PLLSource: PLL entry clock source. This parameter must be a value of
RCC_PLL_Clock_Source
uint32_t RCC_PLLInitTypeDef::PLLMUL
PLLMUL: Multiplication factor for PLL VCO input clock This parameter must be a
value of RCC_PLL_Multiplication_Factor
uint32_t RCC_PLLInitTypeDef::PREDIV
PREDIV: Predivision factor for PLL VCO input clock This parameter must be a value
of RCC_PLL_Prediv_Factor
32.1.2
RCC_OscInitTypeDef
Data Fields
uint32_t OscillatorType
uint32_t HSEState
uint32_t LSEState
uint32_t HSIState
uint32_t HSICalibrationValue
uint32_t HSI14State
uint32_t HSI14CalibrationValue
uint32_t LSIState
uint32_t HSI48State
RCC_PLLInitTypeDef PLL
Field Documentation
uint32_t RCC_OscInitTypeDef::OscillatorType
The oscillators to be configured. This parameter can be a value of
RCC_Oscillator_Type
uint32_t RCC_OscInitTypeDef::HSEState
The new state of the HSE. This parameter can be a value of RCC_HSE_Config
uint32_t RCC_OscInitTypeDef::LSEState
The new state of the LSE. This parameter can be a value of RCC_LSE_Config
uint32_t RCC_OscInitTypeDef::HSIState
The new state of the HSI. This parameter can be a value of RCC_HSI_Config
DocID026525 Rev 6
319/1320
HAL RCC Generic Driver
UM1785
uint32_t RCC_OscInitTypeDef::HSICalibrationValue
The HSI calibration trimming value (default is RCC_HSICALIBRATION_DEFAULT).
This parameter must be a number between Min_Data = 0x00 and Max_Data = 0x1FU
uint32_t RCC_OscInitTypeDef::HSI14State
The new state of the HSI14. This parameter can be a value of RCC_HSI14_Config
uint32_t RCC_OscInitTypeDef::HSI14CalibrationValue
The HSI14 calibration trimming value (default is
RCC_HSI14CALIBRATION_DEFAULT). This parameter must be a number between
Min_Data = 0x00 and Max_Data = 0x1FU
uint32_t RCC_OscInitTypeDef::LSIState
The new state of the LSI. This parameter can be a value of RCC_LSI_Config
uint32_t RCC_OscInitTypeDef::HSI48State
The new state of the HSI48. This parameter can be a value of RCC_HSI48_Config
RCC_PLLInitTypeDef RCC_OscInitTypeDef::PLL
PLL structure parameters
32.1.3
RCC_ClkInitTypeDef
Data Fields
uint32_t ClockType
uint32_t SYSCLKSource
uint32_t AHBCLKDivider
uint32_t APB1CLKDivider
Field Documentation
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_Clock_Source
32.2
RCC Firmware driver API description
32.2.1
RCC specific features
After reset the device is running from Internal High Speed oscillator (HSI 8MHz) with Flash
0 wait state, Flash prefetch buffer is enabled, and all peripherals are off except internal
SRAM, Flash and JTAG.
There is no prescaler on High speed (AHB) and Low speed (APB) buses; all
peripherals mapped on these buses 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:
Configure the clock source to be used to drive the System clock (if the application
needs higher frequency/performance)
320/1320
DocID026525 Rev 6
UM1785
HAL RCC Generic Driver
Configure the System clock frequency and Flash settings
Configure the AHB and APB buses prescalers
Enable the clock for the peripheral(s) to be used
Configure the clock source(s) for peripherals whose clocks are not derived from the
System clock (RTC, ADC, I2C, USART, TIM, USB FS, etc..)
32.2.2
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.
AHB & APB peripherals, 1 dummy read is necessary
Workarounds:
1.
32.2.3
For AHB & APB peripherals, a dummy read to the peripheral register has been
inserted in each __HAL_RCC_PPP_CLK_ENABLE() macro.
Initialization and de-initialization functions
This section provides functions allowing to configure the internal/external oscillators (HSE,
HSI, HSI14, HSI48, LSE, LSI, PLL, CSS and MCO) and the System buses clocks
(SYSCLK, AHB and APB1).
Internal/external clock and PLL configuration
1.
2.
3.
4.
5.
6.
7.
8.
HSI (high-speed internal), 8 MHz factory-trimmed RC used directly or through the PLL
as System clock source. The HSI clock can be used also to clock the USART and I2C
peripherals.
HSI14 (high-speed internal), 14 MHz factory-trimmed RC used directly to clock the
ADC peripheral.
LSI (low-speed internal), ~40 KHz low consumption RC used as IWDG and/or RTC
clock source.
HSE (high-speed external), 4 to 32 MHz crystal oscillator used directly or through the
PLL as System clock source. Can be used also as RTC clock source.
LSE (low-speed external), 32 KHz oscillator used as RTC clock source.
PLL (clocked by HSI, HSI48 or HSE), featuring different output clocks:
The first output is used to generate the high speed system clock (up to 48 MHz)
The second output is used to generate the clock for the USB FS (48 MHz)
The third output may be used to generate the clock for the TIM, I2C and USART
peripherals (up to 48 MHz)
CSS (Clock security system), once enable using the macro
__HAL_RCC_CSS_ENABLE() and if a HSE clock failure occurs(HSE used directly or
through PLL as System clock source), the System clocks automatically switched to
HSI and an interrupt is generated if enabled. The interrupt is linked to the Cortex-M0
NMI (Non-Maskable Interrupt) exception vector.
MCO (microcontroller clock output), used to output SYSCLK, HSI, HSE, LSI, LSE or
PLL clock (divided by 2) output on pin (such as PA8 pin).
System, AHB and APB buses clocks configuration
1.
Several clock sources can be used to drive the System clock (SYSCLK): HSI, HSE
and PLL. The AHB clock (HCLK) is derived from System clock through configurable
prescaler and used to clock the CPU, memory and peripherals mapped on AHB bus
(DMA, GPIO...). APB1 (PCLK1) clock is derived from AHB clock through configurable
prescalers and used to clock the peripherals mapped on these buses. You can use
"@ref HAL_RCC_GetSysClockFreq()" function to retrieve the frequencies of these
clocks.
DocID026525 Rev 6
321/1320
HAL RCC Generic Driver
UM1785
2. All the peripheral clocks are derived from the System clock (SYSCLK) except:
The FLASH program/erase clock which is always HSI 8MHz clock.
The USB 48 MHz clock which is derived from the PLL VCO clock.
The USART clock which can be derived as well from HSI 8MHz, LSI or LSE.
The I2C clock which can be derived as well from HSI 8MHz clock.
The ADC clock which is derived from PLL output.
The RTC clock which is derived from the LSE, LSI or 1 MHz HSE_RTC (HSE
divided by a programmable prescaler). The System clock (SYSCLK) frequency
must be higher or equal to the RTC clock frequency.
IWDG clock which is always the LSI clock.
3. For the STM32F0xx devices, the maximum frequency of the SYSCLK, HCLK and
PCLK1 is 48 MHz, Depending on the SYSCLK frequency, the flash latency should be
adapted accordingly.
4. After reset, the System clock source is the HSI (8 MHz) with 0 WS and prefetch is
disabled.
This section contains the following APIs:
HAL_RCC_DeInit()
HAL_RCC_OscConfig()
HAL_RCC_ClockConfig()
32.2.4
Peripheral Control functions
This subsection provides a set of functions allowing to control the RCC Clocks
frequencies.
This section contains the following APIs:
HAL_RCC_MCOConfig()
HAL_RCC_EnableCSS()
HAL_RCC_DisableCSS()
HAL_RCC_GetSysClockFreq()
HAL_RCC_GetHCLKFreq()
HAL_RCC_GetPCLK1Freq()
HAL_RCC_GetOscConfig()
HAL_RCC_GetClockConfig()
HAL_RCC_NMI_IRQHandler()
HAL_RCC_CSSCallback()
32.2.5
Detailed description of functions
HAL_RCC_DeInit
322/1320
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 and
PLL OFFAHB, APB1 prescaler set to 1.CSS and MCO1
OFFAll interrupts disabled
This function does not modify the configuration of the
Peripheral clocksLSI, LSE and RTC clocks
DocID026525 Rev 6
UM1785
HAL RCC Generic Driver
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.
Return values
HAL: status
Notes
The PLL is not disabled when used as system clock.
Transitions 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.
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.
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 buses clocks according to the
specified parameters in the RCC_ClkInitStruct.
Parameters
RCC_ClkInitStruct: pointer to an RCC_OscInitTypeDef
structure that contains the configuration information for the
RCC peripheral.
FLatency: FLASH Latency The value of this parameter
depend on device used within the same series
Return values
HAL: status
Notes
The SystemCoreClock CMSIS variable is used to store
System Clock Frequency and updated by
HAL_RCC_GetHCLKFreq() function called within this function
The HSI is used (enabled by hardware) as system clock
source after start-up 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 start-up 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. You can use HAL_RCC_GetClockConfig() function to
know which clock is currently used as system clock source.
DocID026525 Rev 6
323/1320
HAL RCC Generic Driver
UM1785
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 MCO pin.
Parameters
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_MCOSource: specifies the clock source to output. This
parameter can be one of the following values:
RCC_MCO1SOURCE_NOCLOCK No clock selected
RCC_MCO1SOURCE_SYSCLK System Clock selected
as MCO clock
RCC_MCO1SOURCE_HSI HSI selected as MCO clock
RCC_MCO1SOURCE_HSE HSE selected as MCO
clock
RCC_MCO1SOURCE_LSI LSI selected as MCO clock
RCC_MCO1SOURCE_LSE LSE selected as MCO clock
RCC_MCO1SOURCE_HSI14 HSI14 selected as MCO
clock
RCC_MCO1SOURCE_HSI48 HSI48 selected as MCO
clock
RCC_MCO1SOURCE_PLLCLK PLLCLK selected as
MCO clock
RCC_MCO1SOURCE_PLLCLK_DIV2 PLLCLK Divided
by 2 selected as MCO clock
RCC_MCODiv: specifies the MCO DIV. This parameter can
be one of the following values:
RCC_MCODIV_1 no division applied to MCO clock
RCC_MCODIV_2 division by 2 applied to MCO clock
RCC_MCODIV_4 division by 4 applied to MCO clock
RCC_MCODIV_8 division by 8 applied to MCO clock
RCC_MCODIV_16 division by 16 applied to MCO clock
RCC_MCODIV_32 division by 32 applied to MCO clock
RCC_MCODIV_64 division by 64 applied to MCO clock
RCC_MCODIV_128 division by 128 applied to MCO
clock
Return values
None
Notes
MCO pin should be configured in alternate function mode.
HAL_RCC_EnableCSS
324/1320
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 CortexDocID026525 Rev 6
UM1785
HAL RCC Generic Driver
M0 NMI (Non-Maskable Interrupt) exception vector.
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
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 a value based on
HSE_VALUE divided by PREDIV factor(**)
If SYSCLK source is PLL, function returns a value based on
HSE_VALUE divided by PREDIV factor(**) or depending on
STM32F0xxxx devices either a value based on HSI_VALUE
divided by 2 or HSI_VALUE divided by PREDIV factor(*)
multiplied by the PLL factor.
(*) HSI_VALUE is a constant defined in stm32f0xx_hal_conf.h
file (default value 8 MHz) but the real value may vary
depending on the variations in voltage and temperature.
(**) HSE_VALUE is a constant defined in
stm32f0xx_hal_conf.h file (default value 8 MHz), user has to
ensure that HSE_VALUE is same as the real frequency of the
crystal used. Otherwise, this function may have wrong result.
The result of this function could be not correct when using
fractional value for HSE crystal.
This function can be used by the user application to compute
the baud-rate for the communication peripherals or configure
DocID026525 Rev 6
325/1320
HAL RCC Generic Driver
UM1785
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.
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
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_GetOscConfig
Function name
void HAL_RCC_GetOscConfig (RCC_OscInitTypeDef *
RCC_OscInitStruct)
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
326/1320
Function name
void HAL_RCC_GetClockConfig (RCC_ClkInitTypeDef *
RCC_ClkInitStruct, uint32_t * pFLatency)
Function description
Get the RCC_ClkInitStruct according to the internal RCC
configuration registers.
Parameters
RCC_ClkInitStruct: pointer to an RCC_ClkInitTypeDef
structure that contains the current clock configuration.
pFLatency: Pointer on the Flash Latency.
Return values
None
DocID026525 Rev 6
UM1785
HAL RCC Generic Driver
32.3
RCC Firmware driver defines
32.3.1
RCC
RCC AHB Clock Enable Disable
__HAL_RCC_GPIOA_CLK_ENABLE
__HAL_RCC_GPIOB_CLK_ENABLE
__HAL_RCC_GPIOC_CLK_ENABLE
__HAL_RCC_GPIOF_CLK_ENABLE
__HAL_RCC_CRC_CLK_ENABLE
__HAL_RCC_DMA1_CLK_ENABLE
__HAL_RCC_SRAM_CLK_ENABLE
__HAL_RCC_FLITF_CLK_ENABLE
__HAL_RCC_GPIOA_CLK_DISABLE
__HAL_RCC_GPIOB_CLK_DISABLE
__HAL_RCC_GPIOC_CLK_DISABLE
__HAL_RCC_GPIOF_CLK_DISABLE
__HAL_RCC_CRC_CLK_DISABLE
__HAL_RCC_DMA1_CLK_DISABLE
__HAL_RCC_SRAM_CLK_DISABLE
__HAL_RCC_FLITF_CLK_DISABLE
AHB Clock Source
RCC_SYSCLK_DIV1
SYSCLK not divided
RCC_SYSCLK_DIV2
SYSCLK divided by 2
RCC_SYSCLK_DIV4
SYSCLK divided by 4
RCC_SYSCLK_DIV8
SYSCLK divided by 8
RCC_SYSCLK_DIV16
SYSCLK divided by 16
RCC_SYSCLK_DIV64
SYSCLK divided by 64
RCC_SYSCLK_DIV128
SYSCLK divided by 128
RCC_SYSCLK_DIV256
SYSCLK divided by 256
RCC_SYSCLK_DIV512
SYSCLK divided by 512
RCC AHB Force Release Reset
__HAL_RCC_AHB_FORCE_RESET
__HAL_RCC_GPIOA_FORCE_RESET
__HAL_RCC_GPIOB_FORCE_RESET
__HAL_RCC_GPIOC_FORCE_RESET
__HAL_RCC_GPIOF_FORCE_RESET
__HAL_RCC_AHB_RELEASE_RESET
DocID026525 Rev 6
327/1320
HAL RCC Generic Driver
__HAL_RCC_GPIOA_RELEASE_RESET
__HAL_RCC_GPIOB_RELEASE_RESET
__HAL_RCC_GPIOC_RELEASE_RESET
__HAL_RCC_GPIOF_RELEASE_RESET
AHB Peripheral Clock Enable Disable Status
__HAL_RCC_GPIOA_IS_CLK_ENABLED
__HAL_RCC_GPIOB_IS_CLK_ENABLED
__HAL_RCC_GPIOC_IS_CLK_ENABLED
__HAL_RCC_GPIOF_IS_CLK_ENABLED
__HAL_RCC_CRC_IS_CLK_ENABLED
__HAL_RCC_DMA1_IS_CLK_ENABLED
__HAL_RCC_SRAM_IS_CLK_ENABLED
__HAL_RCC_FLITF_IS_CLK_ENABLED
__HAL_RCC_GPIOA_IS_CLK_DISABLED
__HAL_RCC_GPIOB_IS_CLK_DISABLED
__HAL_RCC_GPIOC_IS_CLK_DISABLED
__HAL_RCC_GPIOF_IS_CLK_DISABLED
__HAL_RCC_CRC_IS_CLK_DISABLED
__HAL_RCC_DMA1_IS_CLK_DISABLED
__HAL_RCC_SRAM_IS_CLK_DISABLED
__HAL_RCC_FLITF_IS_CLK_DISABLED
RCC APB1 Clock Enable Disable
__HAL_RCC_TIM3_CLK_ENABLE
__HAL_RCC_TIM14_CLK_ENABLE
__HAL_RCC_WWDG_CLK_ENABLE
__HAL_RCC_I2C1_CLK_ENABLE
__HAL_RCC_PWR_CLK_ENABLE
__HAL_RCC_TIM3_CLK_DISABLE
__HAL_RCC_TIM14_CLK_DISABLE
__HAL_RCC_WWDG_CLK_DISABLE
__HAL_RCC_I2C1_CLK_DISABLE
__HAL_RCC_PWR_CLK_DISABLE
RCC APB1 Clock Source
328/1320
RCC_HCLK_DIV1
HCLK not divided
RCC_HCLK_DIV2
HCLK divided by 2
RCC_HCLK_DIV4
HCLK divided by 4
DocID026525 Rev 6
UM1785
UM1785
HAL RCC Generic Driver
RCC_HCLK_DIV8
HCLK divided by 8
RCC_HCLK_DIV16
HCLK divided by 16
RCC APB1 Force Release Reset
__HAL_RCC_APB1_FORCE_RESET
__HAL_RCC_TIM3_FORCE_RESET
__HAL_RCC_TIM14_FORCE_RESET
__HAL_RCC_WWDG_FORCE_RESET
__HAL_RCC_I2C1_FORCE_RESET
__HAL_RCC_PWR_FORCE_RESET
__HAL_RCC_APB1_RELEASE_RESET
__HAL_RCC_TIM3_RELEASE_RESET
__HAL_RCC_TIM14_RELEASE_RESET
__HAL_RCC_WWDG_RELEASE_RESET
__HAL_RCC_I2C1_RELEASE_RESET
__HAL_RCC_PWR_RELEASE_RESET
APB1 Peripheral Clock Enable Disable Status
__HAL_RCC_TIM3_IS_CLK_ENABLED
__HAL_RCC_TIM14_IS_CLK_ENABLED
__HAL_RCC_WWDG_IS_CLK_ENABLED
__HAL_RCC_I2C1_IS_CLK_ENABLED
__HAL_RCC_PWR_IS_CLK_ENABLED
__HAL_RCC_TIM3_IS_CLK_DISABLED
__HAL_RCC_TIM14_IS_CLK_DISABLED
__HAL_RCC_WWDG_IS_CLK_DISABLED
__HAL_RCC_I2C1_IS_CLK_DISABLED
__HAL_RCC_PWR_IS_CLK_DISABLED
RCC APB2 Clock Enable Disable
__HAL_RCC_SYSCFG_CLK_ENABLE
__HAL_RCC_ADC1_CLK_ENABLE
__HAL_RCC_TIM1_CLK_ENABLE
__HAL_RCC_SPI1_CLK_ENABLE
__HAL_RCC_TIM16_CLK_ENABLE
__HAL_RCC_TIM17_CLK_ENABLE
__HAL_RCC_USART1_CLK_ENABLE
__HAL_RCC_DBGMCU_CLK_ENABLE
__HAL_RCC_SYSCFG_CLK_DISABLE
DocID026525 Rev 6
329/1320
HAL RCC Generic Driver
__HAL_RCC_ADC1_CLK_DISABLE
__HAL_RCC_TIM1_CLK_DISABLE
__HAL_RCC_SPI1_CLK_DISABLE
__HAL_RCC_TIM16_CLK_DISABLE
__HAL_RCC_TIM17_CLK_DISABLE
__HAL_RCC_USART1_CLK_DISABLE
__HAL_RCC_DBGMCU_CLK_DISABLE
RCC APB2 Force Release Reset
__HAL_RCC_APB2_FORCE_RESET
__HAL_RCC_SYSCFG_FORCE_RESET
__HAL_RCC_ADC1_FORCE_RESET
__HAL_RCC_TIM1_FORCE_RESET
__HAL_RCC_SPI1_FORCE_RESET
__HAL_RCC_USART1_FORCE_RESET
__HAL_RCC_TIM16_FORCE_RESET
__HAL_RCC_TIM17_FORCE_RESET
__HAL_RCC_DBGMCU_FORCE_RESET
__HAL_RCC_APB2_RELEASE_RESET
__HAL_RCC_SYSCFG_RELEASE_RESET
__HAL_RCC_ADC1_RELEASE_RESET
__HAL_RCC_TIM1_RELEASE_RESET
__HAL_RCC_SPI1_RELEASE_RESET
__HAL_RCC_USART1_RELEASE_RESET
__HAL_RCC_TIM16_RELEASE_RESET
__HAL_RCC_TIM17_RELEASE_RESET
__HAL_RCC_DBGMCU_RELEASE_RESET
APB2 Peripheral Clock Enable Disable Status
__HAL_RCC_SYSCFG_IS_CLK_ENABLED
__HAL_RCC_ADC1_IS_CLK_ENABLED
__HAL_RCC_TIM1_IS_CLK_ENABLED
__HAL_RCC_SPI1_IS_CLK_ENABLED
__HAL_RCC_TIM16_IS_CLK_ENABLED
__HAL_RCC_TIM17_IS_CLK_ENABLED
__HAL_RCC_USART1_IS_CLK_ENABLED
__HAL_RCC_DBGMCU_IS_CLK_ENABLED
__HAL_RCC_SYSCFG_IS_CLK_DISABLED
330/1320
DocID026525 Rev 6
UM1785
UM1785
HAL RCC Generic Driver
__HAL_RCC_ADC1_IS_CLK_DISABLED
__HAL_RCC_TIM1_IS_CLK_DISABLED
__HAL_RCC_SPI1_IS_CLK_DISABLED
__HAL_RCC_TIM16_IS_CLK_DISABLED
__HAL_RCC_TIM17_IS_CLK_DISABLED
__HAL_RCC_USART1_IS_CLK_DISABLED
__HAL_RCC_DBGMCU_IS_CLK_DISABLED
Flags
RCC_FLAG_HSIRDY
RCC_FLAG_HSERDY
RCC_FLAG_PLLRDY
RCC_FLAG_HSI14RDY
RCC_FLAG_LSIRDY
RCC_FLAG_V18PWRRST
RCC_FLAG_OBLRST
RCC_FLAG_PINRST
PIN reset flag
RCC_FLAG_PORRST
POR/PDR reset flag
RCC_FLAG_SFTRST
Software Reset flag
RCC_FLAG_IWDGRST
Independent Watchdog reset flag
RCC_FLAG_WWDGRST
Window watchdog reset flag
RCC_FLAG_LPWRRST
Low-Power reset flag
RCC_FLAG_LSERDY
External Low Speed oscillator Ready
RCC_FLAG_HSI48RDY
Flags Interrupts Management
__HAL_RCC_ENABLE_IT
Description:
Enable RCC interrupt.
Parameters:
__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_HSI14RDY HSI14 ready
interrupt
RCC_IT_HSI48RDY HSI48 ready
DocID026525 Rev 6
331/1320
HAL RCC Generic Driver
UM1785
interrupt
__HAL_RCC_DISABLE_IT
Description:
Disable RCC interrupt.
Parameters:
__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_HSI14RDY HSI14 ready
interrupt
RCC_IT_HSI48RDY HSI48 ready
interrupt
__HAL_RCC_CLEAR_IT
Description:
Clear the RCC's 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_CSS Clock Security System
interrupt
RCC_IT_HSI14RDY HSI14 ready
interrupt
RCC_IT_HSI48RDY HSI48 ready
interrupt
__HAL_RCC_GET_IT
Description:
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
332/1320
DocID026525 Rev 6
UM1785
HAL RCC Generic Driver
interrupt.
RCC_IT_PLLRDY Main PLL ready
interrupt.
RCC_IT_CSS Clock Security System
interrupt
RCC_IT_HSI14RDY HSI14 ready
interrupt enable
RCC_IT_HSI48RDY HSI48 ready
interrupt
Return value:
The: new state of __INTERRUPT__ (TRUE
or FALSE).
__HAL_RCC_CLEAR_RESET_FLAGS
The reset flags are RCC_FLAG_PINRST,
RCC_FLAG_PORRST, RCC_FLAG_SFTRST,
RCC_FLAG_OBLRST, RCC_FLAG_IWDGRST,
RCC_FLAG_WWDGRST,
RCC_FLAG_LPWRRST
__HAL_RCC_GET_FLAG
Description:
Check RCC flag is set or not.
Parameters:
__FLAG__: specifies the flag to check. This
parameter can be one of the following
values:
RCC_FLAG_HSIRDY HSI oscillator
clock ready.
RCC_FLAG_HSERDY HSE oscillator
clock ready.
RCC_FLAG_PLLRDY Main PLL clock
ready.
RCC_FLAG_HSI14RDY HSI14
oscillator clock ready
RCC_FLAG_HSI48RDY HSI48
oscillator clock ready
RCC_FLAG_LSERDY LSE oscillator
clock ready.
RCC_FLAG_LSIRDY LSI oscillator
clock ready.
RCC_FLAG_OBLRST Option Byte
Load reset
RCC_FLAG_PINRST Pin reset.
RCC_FLAG_PORRST POR/PDR
reset.
RCC_FLAG_SFTRST Software reset.
RCC_FLAG_IWDGRST Independent
Watchdog reset.
RCC_FLAG_WWDGRST Window
Watchdog reset.
RCC_FLAG_LPWRRST Low Power
reset.
Return value:
DocID026525 Rev 6
333/1320
HAL RCC Generic Driver
UM1785
The: new state of __FLAG__ (TRUE or
FALSE).
Get Clock source
__HAL_RCC_SYSCLK_CONFIG
Description:
Macro to configure the system clock source.
Parameters:
__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.
__HAL_RCC_GET_SYSCLK_SOU
RCE
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
RCC_SYSCLKSOURCE_STATUS_HSE
HSE used as system clock
RCC_SYSCLKSOURCE_STATUS_PLLCL
K PLL used as system clock
HSE Config
RCC_HSE_OFF
HSE clock deactivation
RCC_HSE_ON
HSE clock activation
RCC_HSE_BYPASS
External clock source for HSE clock
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
334/1320
DocID026525 Rev 6
UM1785
HAL RCC Generic Driver
bypassed with external clock
Notes:
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 have to enable it again after
calling this function.
__HAL_RCC_HSE_PREDIV_CONFIG
Description:
Macro to configure the External High Speed
oscillator (HSE) Predivision factor for PLL.
Parameters:
__HSE_PREDIV_VALUE__: specifies the
division value applied to HSE. This
parameter must be a number between
RCC_HSE_PREDIV_DIV1 and
RCC_HSE_PREDIV_DIV16.
Notes:
Predivision factor can not be changed if PLL
is used as system clock In this case, you
have to select another source of the system
clock, disable the PLL and then change the
HSE predivision factor.
RCC HSI14 Config
RCC_HSI14_OFF
RCC_HSI14_ON
RCC_HSI14_ADC_CONTROL
RCC_HSI14CALIBRATION_DEFAULT
RCC_HSI14_Configuration
__HAL_RCC_HSI14_ENABLE
Notes:
After enabling the HSI14 with
__HAL_RCC_HSI14_ENABLE(), the
application software should wait on
DocID026525 Rev 6
335/1320
HAL RCC Generic Driver
UM1785
HSI14RDY flag to be set indicating
that HSI clock is stable and can be
used as system clock source. This is
not necessary if
HAL_RCC_OscConfig() is used. clock
cycles.
Notes:
__HAL_RCC_HSI14_DISABLE
The HSI14 is stopped by hardware
when entering STOP and STANDBY
modes. HSI14 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 HSI14. When the HSI14 is
stopped, HSI14RDY flag goes low
after 6 HSI14 oscillator clock cycles.
__HAL_RCC_HSI14ADC_ENABLE
__HAL_RCC_HSI14ADC_DISABLE
__HAL_RCC_HSI14_CALIBRATIONVALUE_
ADJUST
Description:
Macro to adjust the Internal 14Mhz
High Speed oscillator (HSI) calibration
value.
Parameters:
__HSI14CALIBRATIONVALUE__:
specifies the calibration trimming
value (default is
RCC_HSI14CALIBRATION_DEFAUL
T). This parameter must be a number
between 0 and 0x1F.
Notes:
The calibration is used to compensate
for the variations in voltage and
temperature that influence the
frequency of the internal HSI14 RC.
HSI48 Config
RCC_HSI48_OFF
RCC_HSI48_ON
HSI Config
RCC_HSI_OFF
HSI clock deactivation
RCC_HSI_ON
HSI clock activation
RCC_HSICALIBRATION_DEFAULT
336/1320
DocID026525 Rev 6
UM1785
HAL RCC Generic Driver
HSI Configuration
Notes:
__HAL_RCC_HSI_ENABLE
The HSI is stopped by hardware when
entering STOP and STANDBY modes.
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. 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. (default is
RCC_HSICALIBRATION_DEFAULT).
This parameter must be a number
between 0 and 0x1F.
Notes:
The calibration is used to compensate
for the variations in voltage and
temperature that influence the frequency
of the internal HSI RC.
RCC I2C1 Clock Source
RCC_I2C1CLKSOURCE_HSI
RCC_I2C1CLKSOURCE_SYSCLK
RCC I2Cx Clock Config
__HAL_RCC_I2C1_CONFIG
Description:
Macro to configure the I2C1 clock (I2C1CLK).
Parameters:
__I2C1CLKSOURCE__: specifies the I2C1
clock source. This parameter can be one of the
following values:
RCC_I2C1CLKSOURCE_HSI HSI
selected as I2C1 clock
RCC_I2C1CLKSOURCE_SYSCLK
System Clock selected as I2C1 clock
DocID026525 Rev 6
337/1320
HAL RCC Generic Driver
__HAL_RCC_GET_I2C1_SOURCE
UM1785
Description:
Macro to get the I2C1 clock source.
Return value:
The: clock source can be one of the following
values:
RCC_I2C1CLKSOURCE_HSI HSI
selected as I2C1 clock
RCC_I2C1CLKSOURCE_SYSCLK
System Clock selected as I2C1 clock
Interrupts
RCC_IT_LSIRDY
LSI Ready Interrupt flag
RCC_IT_LSERDY
LSE Ready Interrupt flag
RCC_IT_HSIRDY
HSI Ready Interrupt flag
RCC_IT_HSERDY
HSE Ready Interrupt flag
RCC_IT_PLLRDY
PLL Ready Interrupt flag
RCC_IT_HSI14RDY
HSI14 Ready Interrupt flag
RCC_IT_HSI48RDY
HSI48 Ready Interrupt flag
RCC_IT_CSS
Clock Security System Interrupt flag
RCC_IT_HSI48
HSI48 Ready Interrupt flag
LSE Config
RCC_LSE_OFF
LSE clock deactivation
RCC_LSE_ON
LSE clock activation
RCC_LSE_BYPASS
External clock source for LSE clock
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:
Transitions LSE Bypass to LSE On and LSE On to
LSE Bypass are not supported by this macro. 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()
338/1320
DocID026525 Rev 6
UM1785
HAL RCC Generic Driver
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
LSI clock deactivation
RCC_LSI_ON
LSI clock activation
LSI Configuration
Notes:
__HAL_RCC_LSI_ENABLE
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.
Notes:
__HAL_RCC_LSI_DISABLE
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.
RCC MCO Clock Source
RCC_MCO1SOURCE_NOCLOCK
RCC_MCO1SOURCE_LSI
RCC_MCO1SOURCE_LSE
RCC_MCO1SOURCE_SYSCLK
RCC_MCO1SOURCE_HSI
RCC_MCO1SOURCE_HSE
RCC_MCO1SOURCE_PLLCLK_DIV2
RCC_MCO1SOURCE_HSI14
RCC_MCO1SOURCE_PLLCLK
RCC_MCO1SOURCE_HSI48
MCO Index
RCC_MCO1
RCC_MCO
MCO1 to be compliant with other families with 2 MCOs
Oscillator Type
RCC_OSCILLATORTYPE_NONE
RCC_OSCILLATORTYPE_HSE
RCC_OSCILLATORTYPE_HSI
RCC_OSCILLATORTYPE_LSE
DocID026525 Rev 6
339/1320
HAL RCC Generic Driver
RCC_OSCILLATORTYPE_LSI
UM1785
RCC_OSCILLATORTYPE_HSI14
RCC_OSCILLATORTYPE_HSI48
PLL Clock Source
RCC_PLLSOURCE_HSE
HSE clock selected as PLL entry clock source
RCC_PLLSOURCE_HSI
RCC_PLLSOURCE_HSI48
PLL Config
RCC_PLL_NONE
PLL is not configured
RCC_PLL_OFF
PLL deactivation
RCC_PLL_ON
PLL activation
PLL Configuration
Notes:
__HAL_RCC_PLL_ENABLE
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 is disabled by hardware when
entering STOP and STANDBY modes.
__HAL_RCC_PLL_DISABLE
Notes:
The main PLL can not be disabled if it is
used as system clock source
__HAL_RCC_PLL_CONFIG
Description:
Macro to configure the 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
__PLLMUL__: specifies the multiplication
factor for PLL VCO output clock This
parameter can be one of the following
values: This parameter must be a number
between RCC_PLL_MUL2 and
RCC_PLL_MUL16.
__PREDIV__: specifies the predivider
factor for PLL VCO input clock This
340/1320
DocID026525 Rev 6
UM1785
HAL RCC Generic Driver
parameter must be a number between
RCC_PREDIV_DIV1 and
RCC_PREDIV_DIV16.
Notes:
This function must be used only when the
main PLL is disabled.
__HAL_RCC_GET_PLL_OSCSOURCE
Description:
Get oscillator clock selected as PLL input
clock.
Return value:
The: clock source used for PLL entry. The
returned value can be one of the following:
RCC_PLLSOURCE_HSE HSE
oscillator clock selected as PLL input
clock
RCC PLL Multiplication Factor
RCC_PLL_MUL2
RCC_PLL_MUL3
RCC_PLL_MUL4
RCC_PLL_MUL5
RCC_PLL_MUL6
RCC_PLL_MUL7
RCC_PLL_MUL8
RCC_PLL_MUL9
RCC_PLL_MUL10
RCC_PLL_MUL11
RCC_PLL_MUL12
RCC_PLL_MUL13
RCC_PLL_MUL14
RCC_PLL_MUL15
RCC_PLL_MUL16
RCC PLL Prediv Factor
RCC_PREDIV_DIV1
RCC_PREDIV_DIV2
RCC_PREDIV_DIV3
RCC_PREDIV_DIV4
RCC_PREDIV_DIV5
RCC_PREDIV_DIV6
RCC_PREDIV_DIV7
DocID026525 Rev 6
341/1320
HAL RCC Generic Driver
RCC_PREDIV_DIV8
UM1785
RCC_PREDIV_DIV9
RCC_PREDIV_DIV10
RCC_PREDIV_DIV11
RCC_PREDIV_DIV12
RCC_PREDIV_DIV13
RCC_PREDIV_DIV14
RCC_PREDIV_DIV15
RCC_PREDIV_DIV16
Register offsets
RCC_OFFSET
RCC_CR_OFFSET
RCC_CFGR_OFFSET
RCC_CIR_OFFSET
RCC_BDCR_OFFSET
RCC_CSR_OFFSET
RCC RTC Clock Configuration
__HAL_RCC_RTC_CONFIG
Description:
Macro to configure the RTC clock (RTCCLK).
Parameters:
__RTC_CLKSOURCE__: specifies the RTC
clock source. This parameter can be one of the
following values:
RCC_RTCCLKSOURCE_NO_CLK No
clock selected as RTC clock
RCC_RTCCLKSOURCE_LSE LSE
selected as RTC clock
RCC_RTCCLKSOURCE_LSI LSI selected
as RTC clock
RCC_RTCCLKSOURCE_HSE_DIV32
HSE clock divided by 32
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 cannot be changed unless the
Backup domain is reset using
__HAL_RCC_BACKUPRESET_FORCE()
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
342/1320
DocID026525 Rev 6
UM1785
HAL RCC Generic Driver
STANDBY modes, and can be used as wakeup
source. However, when the LSI clock and HSE
clock divided by 32 is used as RTC clock
source, the RTC cannot be used in STOP and
STANDBY modes. The system must always be
configured so as to get a PCLK frequency
greater than or equal to the RTCCLK frequency
for a proper operation of the RTC.
__HAL_RCC_GET_RTC_SOURCE
Description:
Macro to get the RTC clock source.
Return value:
The: clock source can be one of the following
values:
RCC_RTCCLKSOURCE_NO_CLK No
clock selected as RTC clock
RCC_RTCCLKSOURCE_LSE LSE
selected as RTC clock
RCC_RTCCLKSOURCE_LSI LSI selected
as RTC clock
RCC_RTCCLKSOURCE_HSE_DIV32
HSE clock divided by 32
__HAL_RCC_RTC_ENABLE
Notes:
These macros must be used only after the RTC
clock source was selected.
__HAL_RCC_RTC_DISABLE
Notes:
These macros must be used only after the RTC
clock source was selected.
__HAL_RCC_BACKUPRESET_
FORCE
Notes:
This function resets the RTC peripheral
(including the backup registers) and the RTC
clock source selection in RCC_BDCR register.
__HAL_RCC_BACKUPRESET_
RELEASE
RTC Clock Source
RCC_RTCCLKSOURCE_NO_CLK
No clock
RCC_RTCCLKSOURCE_LSE
LSE oscillator clock used as RTC clock
RCC_RTCCLKSOURCE_LSI
LSI oscillator clock used as RTC clock
RCC_RTCCLKSOURCE_HSE_DIV32
HSE oscillator clock divided by 32 used as RTC
clock
DocID026525 Rev 6
343/1320
HAL RCC Generic Driver
System Clock Source
UM1785
RCC_SYSCLKSOURCE_HSI
HSI selected as system clock
RCC_SYSCLKSOURCE_HSE
HSE selected as system clock
RCC_SYSCLKSOURCE_PLLCLK
PLL selected as system clock
RCC_SYSCLKSOURCE_HSI48
System Clock Source Status
RCC_SYSCLKSOURCE_STATUS_HSI
HSI used as system clock
RCC_SYSCLKSOURCE_STATUS_HSE
HSE used as system clock
RCC_SYSCLKSOURCE_STATUS_PLLCLK
PLL used as system clock
RCC_SYSCLKSOURCE_STATUS_HSI48
System Clock Type
RCC_CLOCKTYPE_SYSCLK
SYSCLK to configure
RCC_CLOCKTYPE_HCLK
HCLK to configure
RCC_CLOCKTYPE_PCLK1
PCLK1 to configure
RCC Timeout
RCC_DBP_TIMEOUT_VALUE
RCC_LSE_TIMEOUT_VALUE
CLOCKSWITCH_TIMEOUT_VALUE
HSE_TIMEOUT_VALUE
HSI_TIMEOUT_VALUE
LSI_TIMEOUT_VALUE
PLL_TIMEOUT_VALUE
HSI14_TIMEOUT_VALUE
HSI48_TIMEOUT_VALUE
RCC USART1 Clock Source
RCC_USART1CLKSOURCE_PCLK1
RCC_USART1CLKSOURCE_SYSCLK
RCC_USART1CLKSOURCE_LSE
RCC_USART1CLKSOURCE_HSI
RCC USARTx Clock Config
__HAL_RCC_USART1_CONFIG
Description:
Macro to configure the USART1 clock
(USART1CLK).
Parameters:
__USART1CLKSOURCE__: specifies the
USART1 clock source. This parameter can be one
of the following values:
RCC_USART1CLKSOURCE_PCLK1 PCLK1
344/1320
DocID026525 Rev 6
UM1785
HAL RCC Generic Driver
selected as USART1 clock
RCC_USART1CLKSOURCE_HSI HSI
selected as USART1 clock
RCC_USART1CLKSOURCE_SYSCLK
System Clock selected as USART1 clock
RCC_USART1CLKSOURCE_LSE LSE
selected as USART1 clock
__HAL_RCC_GET_USART1_
SOURCE
Description:
Macro to get the USART1 clock source.
Return value:
The: clock source can be one of the following
values:
RCC_USART1CLKSOURCE_PCLK1 PCLK1
selected as USART1 clock
RCC_USART1CLKSOURCE_HSI HSI
selected as USART1 clock
RCC_USART1CLKSOURCE_SYSCLK
System Clock selected as USART1 clock
RCC_USART1CLKSOURCE_LSE LSE
selected as USART1 clock
DocID026525 Rev 6
345/1320
HAL RCC Extension Driver
UM1785
33
HAL RCC Extension Driver
33.1
RCCEx Firmware driver registers structures
33.1.1
RCC_PeriphCLKInitTypeDef
Data Fields
uint32_t PeriphClockSelection
uint32_t RTCClockSelection
uint32_t Usart1ClockSelection
uint32_t Usart2ClockSelection
uint32_t Usart3ClockSelection
uint32_t I2c1ClockSelection
uint32_t CecClockSelection
Field Documentation
uint32_t RCC_PeriphCLKInitTypeDef::PeriphClockSelection
The Extended Clock to be configured. This parameter can be a value of
RCCEx_Periph_Clock_Selection
uint32_t RCC_PeriphCLKInitTypeDef::RTCClockSelection
Specifies RTC Clock Prescalers Selection This parameter can be a value of
RCC_RTC_Clock_Source
uint32_t RCC_PeriphCLKInitTypeDef::Usart1ClockSelection
USART1 clock source This parameter can be a value of
RCC_USART1_Clock_Source
uint32_t RCC_PeriphCLKInitTypeDef::Usart2ClockSelection
USART2 clock source This parameter can be a value of
RCCEx_USART2_Clock_Source
uint32_t RCC_PeriphCLKInitTypeDef::Usart3ClockSelection
USART3 clock source This parameter can be a value of
RCCEx_USART3_Clock_Source
uint32_t RCC_PeriphCLKInitTypeDef::I2c1ClockSelection
I2C1 clock source This parameter can be a value of RCC_I2C1_Clock_Source
uint32_t RCC_PeriphCLKInitTypeDef::CecClockSelection
HDMI CEC clock source This parameter can be a value of
RCCEx_CEC_Clock_Source
33.1.2
RCC_CRSInitTypeDef
Data Fields
uint32_t Prescaler
uint32_t Source
uint32_t Polarity
uint32_t ReloadValue
uint32_t ErrorLimitValue
uint32_t HSI48CalibrationValue
Field Documentation
uint32_t RCC_CRSInitTypeDef::Prescaler
Specifies the division factor of the SYNC signal. This parameter can be a value of
RCCEx_CRS_SynchroDivider
346/1320
DocID026525 Rev 6
UM1785
HAL RCC Extension Driver
uint32_t RCC_CRSInitTypeDef::Source
Specifies the SYNC signal source. This parameter can be a value of
RCCEx_CRS_SynchroSource
uint32_t RCC_CRSInitTypeDef::Polarity
Specifies the input polarity for the SYNC signal source. This parameter can be a value
of RCCEx_CRS_SynchroPolarity
uint32_t RCC_CRSInitTypeDef::ReloadValue
Specifies the value to be loaded in the frequency error counter with each SYNC event.
It can be calculated in using macro
__HAL_RCC_CRS_RELOADVALUE_CALCULATE(__FTARGET__, __FSYNC__)
This parameter must be a number between 0 and 0xFFFF or a value of
RCCEx_CRS_ReloadValueDefault .
uint32_t RCC_CRSInitTypeDef::ErrorLimitValue
Specifies the value to be used to evaluate the captured frequency error value. This
parameter must be a number between 0 and 0xFF or a value of
RCCEx_CRS_ErrorLimitDefault
uint32_t RCC_CRSInitTypeDef::HSI48CalibrationValue
Specifies a user-programmable trimming value to the HSI48 oscillator. This parameter
must be a number between 0 and 0x3F or a value of
RCCEx_CRS_HSI48CalibrationDefault
33.1.3
RCC_CRSSynchroInfoTypeDef
Data Fields
uint32_t ReloadValue
uint32_t HSI48CalibrationValue
uint32_t FreqErrorCapture
uint32_t FreqErrorDirection
Field Documentation
uint32_t RCC_CRSSynchroInfoTypeDef::ReloadValue
Specifies the value loaded in the Counter reload value. This parameter must be a
number between 0 and 0xFFFFU
uint32_t RCC_CRSSynchroInfoTypeDef::HSI48CalibrationValue
Specifies value loaded in HSI48 oscillator smooth trimming. This parameter must be a
number between 0 and 0x3FU
uint32_t RCC_CRSSynchroInfoTypeDef::FreqErrorCapture
Specifies the value loaded in the .FECAP, the frequency error counter value latched in
the time of the last SYNC event. This parameter must be a number between 0 and
0xFFFFU
uint32_t RCC_CRSSynchroInfoTypeDef::FreqErrorDirection
Specifies the value loaded in the .FEDIR, the counting direction of the frequency error
counter latched in the time of the last SYNC event. It shows whether the actual
frequency is below or above the target. This parameter must be a value of
RCCEx_CRS_FreqErrorDirection
DocID026525 Rev 6
347/1320
HAL RCC Extension Driver
UM1785
33.2
RCCEx Firmware driver API description
33.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) are set to their reset values.
This section contains the following APIs:
HAL_RCCEx_PeriphCLKConfig()
HAL_RCCEx_GetPeriphCLKConfig()
HAL_RCCEx_GetPeriphCLKFreq()
33.2.2
Extended Clock Recovery System Control functions
For devices with Clock Recovery System feature (CRS), RCC Extention HAL driver can be
used as follows:
1.
2.
3.
4.
5.
348/1320
In System clock config, HSI48 needs to be enabled
Enable CRS clock in IP MSP init which will use CRS functions
Call CRS functions as follows:
a. Prepare synchronization configuration necessary for HSI48 calibration
Default values can be set for frequency Error Measurement (reload and
error limit) and also HSI48 oscillator smooth trimming.
Macro @ref __HAL_RCC_CRS_RELOADVALUE_CALCULATE can be also
used to calculate directly reload value with target and synchronization
frequencies values
b. Call function @ref HAL_RCCEx_CRSConfig which
Reset CRS registers to their default values.
Configure CRS registers with synchronization configuration
Enable automatic calibration and frequency error counter feature Note:
When using USB LPM (Link Power Management) and the device is in Sleep
mode, the periodic USB SOF will not be generated by the host. No SYNC
signal will therefore be provided to the CRS to calibrate the HSI48 on the
run. To guarantee the required clock precision after waking up from Sleep
mode, the LSE or reference clock on the GPIOs should be used as SYNC
signal.
c. A polling function is provided to wait for complete synchronization
Call function @ref HAL_RCCEx_CRSWaitSynchronization()
According to CRS status, user can decide to adjust again the calibration or
continue application if synchronization is OK
User can retrieve information related to synchronization in calling function @ref
HAL_RCCEx_CRSGetSynchronizationInfo()
Regarding synchronization status and synchronization information, user can try a new
calibration in changing synchronization configuration and call again
HAL_RCCEx_CRSConfig. Note: When the SYNC event is detected during the
downcounting phase (before reaching the zero value), it means that the actual
frequency is lower than the target (and so, that the TRIM value should be
incremented), while when it is detected during the upcounting phase it means that the
actual frequency is higher (and that the TRIM value should be decremented).
DocID026525 Rev 6
UM1785
6.
7.
HAL RCC Extension Driver
In interrupt mode, user can resort to the available macros
(__HAL_RCC_CRS_XXX_IT). Interrupts will go through CRS Handler
(RCC_IRQn/RCC_IRQHandler)
Call function @ref HAL_RCCEx_CRSConfig()
Enable RCC_IRQn (thanks to NVIC functions)
Enable CRS interrupt (@ref __HAL_RCC_CRS_ENABLE_IT)
Implement CRS status management in the following user callbacks called from
HAL_RCCEx_CRS_IRQHandler():
@ref HAL_RCCEx_CRS_SyncOkCallback()
@ref HAL_RCCEx_CRS_SyncWarnCallback()
@ref HAL_RCCEx_CRS_ExpectedSyncCallback()
@ref HAL_RCCEx_CRS_ErrorCallback()
To force a SYNC EVENT, user can use the function @ref
HAL_RCCEx_CRSSoftwareSynchronizationGenerate(). This function can be called
before calling @ref HAL_RCCEx_CRSConfig (for instance in Systick handler)
This section contains the following APIs:
HAL_RCCEx_CRSConfig()
HAL_RCCEx_CRSSoftwareSynchronizationGenerate()
HAL_RCCEx_CRSGetSynchronizationInfo()
HAL_RCCEx_CRSWaitSynchronization()
HAL_RCCEx_CRS_IRQHandler()
HAL_RCCEx_CRS_SyncOkCallback()
HAL_RCCEx_CRS_SyncWarnCallback()
HAL_RCCEx_CRS_ExpectedSyncCallback()
HAL_RCCEx_CRS_ErrorCallback()
33.2.3
Detailed description of functions
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 (USART, RTC, I2C, CEC and
USB).
Return values
HAL: status
Notes
Care must be taken when HAL_RCCEx_PeriphCLKConfig() is
used to select the RTC clock source; in this case the Backup
domain will be reset in order to modify the RTC Clock source,
as consequence RTC registers (including the backup
registers) and RCC_BDCR register are set to their reset
values.
DocID026525 Rev 6
349/1320
HAL RCC Extension Driver
UM1785
HAL_RCCEx_GetPeriphCLKConfig
Function name
void HAL_RCCEx_GetPeriphCLKConfig
(RCC_PeriphCLKInitTypeDef * PeriphClkInit)
Function description
Get the RCC_ClkInitStruct according to the internal RCC
configuration registers.
Parameters
PeriphClkInit: pointer to an RCC_PeriphCLKInitTypeDef
structure that returns the configuration information for the
Extended Peripherals clocks (USART, RTC, I2C, CEC and
USB).
Return values
None
HAL_RCCEx_GetPeriphCLKFreq
Function name
uint32_t HAL_RCCEx_GetPeriphCLKFreq (uint32_t PeriphClk)
Function description
Returns the peripheral clock frequency.
Parameters
PeriphClk: Peripheral clock identifier This parameter can be
one of the following values:
RCC_PERIPHCLK_RTC RTC peripheral clock
RCC_PERIPHCLK_USART1 USART1 peripheral clock
RCC_PERIPHCLK_I2C1 I2C1 peripheral clock
RCC_PERIPHCLK_USART2 USART2 peripheral clock
RCC_PERIPHCLK_USART3 USART2 peripheral clock
RCC_PERIPHCLK_CEC CEC peripheral clock
Return values
Frequency: in Hz (0: means that no available frequency for
the peripheral)
Notes
Returns 0 if peripheral clock is unknown
HAL_RCCEx_CRSConfig
Function name
void HAL_RCCEx_CRSConfig (RCC_CRSInitTypeDef * pInit)
Function description
Start automatic synchronization for polling mode.
Parameters
pInit: Pointer on RCC_CRSInitTypeDef structure
Return values
None
HAL_RCCEx_CRSSoftwareSynchronizationGenerate
Function name
void HAL_RCCEx_CRSSoftwareSynchronizationGenerate
(void )
Function description
Generate the software synchronization event.
Return values
None
HAL_RCCEx_CRSGetSynchronizationInfo
350/1320
Function name
void HAL_RCCEx_CRSGetSynchronizationInfo
(RCC_CRSSynchroInfoTypeDef * pSynchroInfo)
Function description
Return synchronization info.
DocID026525 Rev 6
UM1785
HAL RCC Extension Driver
Parameters
pSynchroInfo: Pointer on RCC_CRSSynchroInfoTypeDef
structure
Return values
None
HAL_RCCEx_CRSWaitSynchronization
Function name
uint32_t HAL_RCCEx_CRSWaitSynchronization (uint32_t
Timeout)
Function description
Wait for CRS Synchronization status.
Parameters
Timeout: Duration of the timeout
Return values
Combination: of Synchronization status This parameter can
be a combination of the following values:
RCC_CRS_TIMEOUT
RCC_CRS_SYNCOK
RCC_CRS_SYNCWARN
RCC_CRS_SYNCERR
RCC_CRS_SYNCMISS
RCC_CRS_TRIMOVF
Notes
Timeout is based on the maximum time to receive a SYNC
event based on synchronization frequency.
If Timeout set to HAL_MAX_DELAY, HAL_TIMEOUT will be
never returned.
HAL_RCCEx_CRS_IRQHandler
Function name
void HAL_RCCEx_CRS_IRQHandler (void )
Function description
Handle the Clock Recovery System interrupt request.
Return values
None
HAL_RCCEx_CRS_SyncOkCallback
Function name
void HAL_RCCEx_CRS_SyncOkCallback (void )
Function description
RCCEx Clock Recovery System SYNCOK interrupt callback.
Return values
None
HAL_RCCEx_CRS_SyncWarnCallback
Function name
void HAL_RCCEx_CRS_SyncWarnCallback (void )
Function description
RCCEx Clock Recovery System SYNCWARN interrupt callback.
Return values
None
DocID026525 Rev 6
351/1320
HAL RCC Extension Driver
UM1785
HAL_RCCEx_CRS_ExpectedSyncCallback
Function name
void HAL_RCCEx_CRS_ExpectedSyncCallback (void )
Function description
RCCEx Clock Recovery System Expected SYNC interrupt
callback.
Return values
None
HAL_RCCEx_CRS_ErrorCallback
Function name
void HAL_RCCEx_CRS_ErrorCallback (uint32_t Error)
Function description
RCCEx Clock Recovery System Error interrupt callback.
Parameters
Error: Combination of Error status. This parameter can be a
combination of the following values:
RCC_CRS_SYNCERR
RCC_CRS_SYNCMISS
RCC_CRS_TRIMOVF
Return values
None
33.3
RCCEx Firmware driver defines
33.3.1
RCCEx
RCCEx CEC Clock Source
RCC_CECCLKSOURCE_HSI
RCC_CECCLKSOURCE_LSE
RCCEx CRS Default Error Limit Value
RCC_CRS_ERRORLIMIT_DEFAULT
Default Frequency error limit
RCCEx CRS Extended Features
__HAL_RCC_CRS_FREQ_ERROR_COUNTER_
ENABLE
Description:
Enable the oscillator clock for
frequency error counter.
Return value:
None
Notes:
when the CEN bit is set the
CRS_CFGR register becomes
write-protected.
__HAL_RCC_CRS_FREQ_ERROR_COUNTER_
DISABLE
Description:
Disable the oscillator clock for
frequency error counter.
Return value:
None
352/1320
DocID026525 Rev 6
UM1785
__HAL_RCC_CRS_AUTOMATIC_CALIB_ENABLE
HAL RCC Extension Driver
Description:
Enable the automatic
hardware adjustement of
TRIM bits.
Return value:
None
Notes:
When the AUTOTRIMEN bit is
set the CRS_CFGR register
becomes write-protected.
__HAL_RCC_CRS_AUTOMATIC_CALIB_DISABLE
Description:
Disable the automatic
hardware adjustement of
TRIM bits.
Return value:
None
__HAL_RCC_CRS_RELOADVALUE_CALCULATE
Description:
Macro to calculate reload
value to be set in CRS register
according to target and sync
frequencies.
Parameters:
__FTARGET__: Target
frequency (value in Hz)
__FSYNC__: Synchronization
signal frequency (value in Hz)
Return value:
None
Notes:
The RELOAD value should be
selected according to the ratio
between the target frequency
and the frequency of the
synchronization source after
prescaling. It is then
decreased by one in order to
reach the expected
synchronization on the zero
value. The formula is the
following: RELOAD =
(fTARGET / fSYNC) -1
RCCEx CRS Flags
RCC_CRS_FLAG_SYNCOK
SYNC event OK flag
RCC_CRS_FLAG_SYNCWARN
SYNC warning flag
DocID026525 Rev 6
353/1320
HAL RCC Extension Driver
RCC_CRS_FLAG_ERR
UM1785
Error flag
RCC_CRS_FLAG_ESYNC
Expected SYNC flag
RCC_CRS_FLAG_SYNCERR
SYNC error
RCC_CRS_FLAG_SYNCMISS
SYNC missed
RCC_CRS_FLAG_TRIMOVF
Trimming overflow or underflow
RCCEx CRS Frequency Error Direction
RCC_CRS_FREQERRORDIR_UP
Upcounting direction, the actual frequency is
above the target
RCC_CRS_FREQERRORDIR_DOWN
Downcounting direction, the actual frequency is
below the target
RCCEx CRS Default HSI48 Calibration vakye
RCC_CRS_HSI48CALIBRATION_DEFAULT
The default value is 32, which corresponds
to the middle of the trimming interval. The
trimming step is around 67 kHz between
two consecutive TRIM steps. A higher
TRIM value corresponds to a higher output
frequency
RCCEx CRS Interrupt Sources
RCC_CRS_IT_SYNCOK
SYNC event OK
RCC_CRS_IT_SYNCWARN
SYNC warning
RCC_CRS_IT_ERR
Error
RCC_CRS_IT_ESYNC
Expected SYNC
RCC_CRS_IT_SYNCERR
SYNC error
RCC_CRS_IT_SYNCMISS
SYNC missed
RCC_CRS_IT_TRIMOVF
Trimming overflow or underflow
RCCEx CRS Default Reload Value
RCC_CRS_RELOADVALUE_DEFAULT
The reset value of the RELOAD field
corresponds to a target frequency of 48 MHz
and a synchronization signal frequency of 1 kHz
(SOF signal from USB).
RCCEx CRS Status
RCC_CRS_NONE
RCC_CRS_TIMEOUT
RCC_CRS_SYNCOK
RCC_CRS_SYNCWARN
RCC_CRS_SYNCERR
RCC_CRS_SYNCMISS
RCC_CRS_TRIMOVF
RCCEx CRS Synchronization Divider
RCC_CRS_SYNC_DIV1
354/1320
Synchro Signal not divided (default)
DocID026525 Rev 6
UM1785
HAL RCC Extension Driver
RCC_CRS_SYNC_DIV2
Synchro Signal divided by 2
RCC_CRS_SYNC_DIV4
Synchro Signal divided by 4
RCC_CRS_SYNC_DIV8
Synchro Signal divided by 8
RCC_CRS_SYNC_DIV16
Synchro Signal divided by 16
RCC_CRS_SYNC_DIV32
Synchro Signal divided by 32
RCC_CRS_SYNC_DIV64
Synchro Signal divided by 64
RCC_CRS_SYNC_DIV128
Synchro Signal divided by 128
RCCEx CRS Synchronization Polarity
RCC_CRS_SYNC_POLARITY_RISING
Synchro Active on rising edge (default)
RCC_CRS_SYNC_POLARITY_FALLING
Synchro Active on falling edge
RCCEx CRS Synchronization Source
RCC_CRS_SYNC_SOURCE_GPIO
Synchro Signal source GPIO
RCC_CRS_SYNC_SOURCE_LSE
Synchro Signal source LSE
RCC_CRS_SYNC_SOURCE_USB
Synchro Signal source USB SOF (default)
RCCEx Force Release Peripheral Reset
__HAL_RCC_GPIOD_FORCE_RESET
__HAL_RCC_GPIOD_RELEASE_RESET
__HAL_RCC_GPIOE_FORCE_RESET
__HAL_RCC_GPIOE_RELEASE_RESET
__HAL_RCC_TSC_FORCE_RESET
__HAL_RCC_TSC_RELEASE_RESET
__HAL_RCC_USART2_FORCE_RESET
__HAL_RCC_SPI2_FORCE_RESET
__HAL_RCC_USART2_RELEASE_RESET
__HAL_RCC_SPI2_RELEASE_RESET
__HAL_RCC_TIM2_FORCE_RESET
__HAL_RCC_TIM2_RELEASE_RESET
__HAL_RCC_TIM6_FORCE_RESET
__HAL_RCC_I2C2_FORCE_RESET
__HAL_RCC_TIM6_RELEASE_RESET
__HAL_RCC_I2C2_RELEASE_RESET
__HAL_RCC_DAC1_FORCE_RESET
__HAL_RCC_DAC1_RELEASE_RESET
__HAL_RCC_CEC_FORCE_RESET
__HAL_RCC_CEC_RELEASE_RESET
__HAL_RCC_TIM7_FORCE_RESET
DocID026525 Rev 6
355/1320
HAL RCC Extension Driver
__HAL_RCC_USART3_FORCE_RESET
UM1785
__HAL_RCC_USART4_FORCE_RESET
__HAL_RCC_TIM7_RELEASE_RESET
__HAL_RCC_USART3_RELEASE_RESET
__HAL_RCC_USART4_RELEASE_RESET
__HAL_RCC_CAN1_FORCE_RESET
__HAL_RCC_CAN1_RELEASE_RESET
__HAL_RCC_CRS_FORCE_RESET
__HAL_RCC_CRS_RELEASE_RESET
__HAL_RCC_USART5_FORCE_RESET
__HAL_RCC_USART5_RELEASE_RESET
__HAL_RCC_TIM15_FORCE_RESET
__HAL_RCC_TIM15_RELEASE_RESET
__HAL_RCC_USART6_FORCE_RESET
__HAL_RCC_USART6_RELEASE_RESET
__HAL_RCC_USART7_FORCE_RESET
__HAL_RCC_USART8_FORCE_RESET
__HAL_RCC_USART7_RELEASE_RESET
__HAL_RCC_USART8_RELEASE_RESET
RCCEx HSI48 Enable Disable
__HAL_RCC_HSI48_ENABLE
__HAL_RCC_HSI48_DISABLE
__HAL_RCC_GET_HSI48_STATE
Description:
Macro to get the Internal 48Mhz High Speed
oscillator (HSI48) state.
Return value:
The: clock source can be one of the following
values:
RCC_HSI48_ON HSI48 enabled
RCC_HSI48_OFF HSI48 disabled
RCCEx IT and Flag
__HAL_RCC_CRS_ENABLE_IT
Description:
Enable the specified CRS interrupts.
Parameters:
__INTERRUPT__: specifies the CRS
interrupt sources to be enabled. This
parameter can be any combination of the
following values:
RCC_CRS_IT_SYNCOK SYNC event
356/1320
DocID026525 Rev 6
UM1785
HAL RCC Extension Driver
OK interrupt
RCC_CRS_IT_SYNCWARN SYNC
warning interrupt
RCC_CRS_IT_ERR Synchronization or
trimming error interrupt
RCC_CRS_IT_ESYNC Expected
SYNC interrupt
Return value:
None
__HAL_RCC_CRS_DISABLE_IT
Description:
Disable the specified CRS interrupts.
Parameters:
__INTERRUPT__: specifies the CRS
interrupt sources to be disabled. This
parameter can be any combination of the
following values:
RCC_CRS_IT_SYNCOK SYNC event
OK interrupt
RCC_CRS_IT_SYNCWARN SYNC
warning interrupt
RCC_CRS_IT_ERR Synchronization or
trimming error interrupt
RCC_CRS_IT_ESYNC Expected
SYNC interrupt
Return value:
None
__HAL_RCC_CRS_GET_IT_SOURCE
Description:
Check whether the CRS interrupt has
occurred or not.
Parameters:
__INTERRUPT__: specifies the CRS
interrupt source to check. This parameter
can be one of the following values:
RCC_CRS_IT_SYNCOK SYNC event
OK interrupt
RCC_CRS_IT_SYNCWARN SYNC
warning interrupt
RCC_CRS_IT_ERR Synchronization or
trimming error interrupt
RCC_CRS_IT_ESYNC Expected
SYNC interrupt
Return value:
The: new state of __INTERRUPT__ (SET or
RESET).
__HAL_RCC_CRS_CLEAR_IT
Description:
DocID026525 Rev 6
357/1320
HAL RCC Extension Driver
UM1785
Clear the CRS interrupt pending bits.
Parameters:
__INTERRUPT__: specifies the interrupt
pending bit to clear. This parameter can be
any combination of the following values:
RCC_CRS_IT_SYNCOK SYNC event
OK interrupt
RCC_CRS_IT_SYNCWARN SYNC
warning interrupt
RCC_CRS_IT_ERR Synchronization or
trimming error interrupt
RCC_CRS_IT_ESYNC Expected
SYNC interrupt
RCC_CRS_IT_TRIMOVF Trimming
overflow or underflow interrupt
RCC_CRS_IT_SYNCERR SYNC error
interrupt
RCC_CRS_IT_SYNCMISS SYNC
missed interrupt
__HAL_RCC_CRS_GET_FLAG
Description:
Check whether the specified CRS flag is set
or not.
Parameters:
__FLAG__: specifies the flag to check. This
parameter can be one of the following
values:
RCC_CRS_FLAG_SYNCOK SYNC
event OK
RCC_CRS_FLAG_SYNCWARN SYNC
warning
RCC_CRS_FLAG_ERR Error
RCC_CRS_FLAG_ESYNC Expected
SYNC
RCC_CRS_FLAG_TRIMOVF Trimming
overflow or underflow
RCC_CRS_FLAG_SYNCERR SYNC
error
RCC_CRS_FLAG_SYNCMISS SYNC
missed
Return value:
The: new state of _FLAG_ (TRUE or
FALSE).
__HAL_RCC_CRS_CLEAR_FLAG
Description:
Clear the CRS specified FLAG.
Parameters:
__FLAG__: specifies the flag to clear. This
parameter can be one of the following
values:
358/1320
DocID026525 Rev 6
UM1785
HAL RCC Extension Driver
RCC_CRS_FLAG_SYNCOK SYNC
event OK
RCC_CRS_FLAG_SYNCWARN SYNC
warning
RCC_CRS_FLAG_ERR Error
RCC_CRS_FLAG_ESYNC Expected
SYNC
RCC_CRS_FLAG_TRIMOVF Trimming
overflow or underflow
RCC_CRS_FLAG_SYNCERR SYNC
error
RCC_CRS_FLAG_SYNCMISS SYNC
missed
Return value:
None
Notes:
RCC_CRS_FLAG_ERR clears
RCC_CRS_FLAG_TRIMOVF,
RCC_CRS_FLAG_SYNCERR,
RCC_CRS_FLAG_SYNCMISS and
consequently RCC_CRS_FLAG_ERR
RCC LSE Drive Configuration
RCC_LSEDRIVE_LOW
Xtal mode lower driving capability
RCC_LSEDRIVE_MEDIUMLOW
Xtal mode medium low driving capability
RCC_LSEDRIVE_MEDIUMHIGH
Xtal mode medium high driving capability
RCC_LSEDRIVE_HIGH
Xtal mode higher driving capability
LSE Drive Configuration
__HAL_RCC_LSEDRIVE_CONFIG
Description:
Macro to configure the External Low Speed
oscillator (LSE) drive capability.
Parameters:
__RCC_LSEDRIVE__: specifies the new state
of the LSE drive capability. This parameter can
be one of the following values:
RCC_LSEDRIVE_LOW LSE oscillator low
drive capability.
RCC_LSEDRIVE_MEDIUMLOW LSE
oscillator medium low drive capability.
RCC_LSEDRIVE_MEDIUMHIGH LSE
oscillator medium high drive capability.
RCC_LSEDRIVE_HIGH LSE oscillator high
drive capability.
Return value:
None
DocID026525 Rev 6
359/1320
HAL RCC Extension Driver
RCC Extended MCOx Clock Config
__HAL_RCC_MCO1_CONFIG
UM1785
Description:
Macro to configure the MCO clock.
Parameters:
__MCOCLKSOURCE__: specifies the MCO clock
source. This parameter can be one of the following
values:
RCC_MCO1SOURCE_NOCLOCK No clock
selected as MCO clock
RCC_MCO1SOURCE_SYSCLK System Clock
selected as MCO clock
RCC_MCO1SOURCE_HSI HSI oscillator clock
selected as MCO clock
RCC_MCO1SOURCE_HSE HSE selected as
MCO clock
RCC_MCO1SOURCE_LSI LSI selected as
MCO clock
RCC_MCO1SOURCE_LSE LSE selected as
MCO clock
RCC_MCO1SOURCE_HSI14 HSI14 selected
as MCO clock
RCC_MCO1SOURCE_HSI48 HSI48 selected
as MCO clock
RCC_MCO1SOURCE_PLLCLK PLLCLK
selected as MCO clock
RCC_MCO1SOURCE_PLLCLK_DIV2 PLLCLK
Divided by 2 selected as MCO clock
__MCODIV__: specifies the MCO clock prescaler.
This parameter can be one of the following values:
RCC_MCODIV_1 MCO clock source is divided
by 1
RCC_MCODIV_2 MCO clock source is divided
by 2
RCC_MCODIV_4 MCO clock source is divided
by 4
RCC_MCODIV_8 MCO clock source is divided
by 8
RCC_MCODIV_16 MCO clock source is divided
by 16
RCC_MCODIV_32 MCO clock source is divided
by 32
RCC_MCODIV_64 MCO clock source is divided
by 64
RCC_MCODIV_128 MCO clock source is
divided by 128
RCCEx MCOx Clock Prescaler
RCC_MCODIV_1
RCC_MCODIV_2
RCC_MCODIV_4
360/1320
DocID026525 Rev 6
UM1785
HAL RCC Extension Driver
RCC_MCODIV_8
RCC_MCODIV_16
RCC_MCODIV_32
RCC_MCODIV_64
RCC_MCODIV_128
RCCEx_Peripheral_Clock_Enable_Disable
__HAL_RCC_GPIOD_CLK_ENABLE
__HAL_RCC_GPIOD_CLK_DISABLE
__HAL_RCC_GPIOE_CLK_ENABLE
__HAL_RCC_GPIOE_CLK_DISABLE
__HAL_RCC_TSC_CLK_ENABLE
__HAL_RCC_TSC_CLK_DISABLE
__HAL_RCC_DMA2_CLK_ENABLE
__HAL_RCC_DMA2_CLK_DISABLE
__HAL_RCC_USART2_CLK_ENABLE
Notes:
After reset, the peripheral clock (used for
registers read/write access) is disabled and
the application software has to enable this
clock before using it.
__HAL_RCC_USART2_CLK_DISABLE
__HAL_RCC_SPI2_CLK_ENABLE
__HAL_RCC_SPI2_CLK_DISABLE
__HAL_RCC_TIM2_CLK_ENABLE
__HAL_RCC_TIM2_CLK_DISABLE
__HAL_RCC_TIM6_CLK_ENABLE
__HAL_RCC_I2C2_CLK_ENABLE
__HAL_RCC_TIM6_CLK_DISABLE
__HAL_RCC_I2C2_CLK_DISABLE
__HAL_RCC_DAC1_CLK_ENABLE
__HAL_RCC_DAC1_CLK_DISABLE
__HAL_RCC_CEC_CLK_ENABLE
__HAL_RCC_CEC_CLK_DISABLE
__HAL_RCC_TIM7_CLK_ENABLE
__HAL_RCC_USART3_CLK_ENABLE
__HAL_RCC_USART4_CLK_ENABLE
__HAL_RCC_TIM7_CLK_DISABLE
DocID026525 Rev 6
361/1320
HAL RCC Extension Driver
__HAL_RCC_USART3_CLK_DISABLE
UM1785
__HAL_RCC_USART4_CLK_DISABLE
__HAL_RCC_CAN1_CLK_ENABLE
__HAL_RCC_CAN1_CLK_DISABLE
__HAL_RCC_CRS_CLK_ENABLE
__HAL_RCC_CRS_CLK_DISABLE
__HAL_RCC_USART5_CLK_ENABLE
__HAL_RCC_USART5_CLK_DISABLE
__HAL_RCC_TIM15_CLK_ENABLE
Notes:
After reset, the peripheral clock (used for
registers read/write access) is disabled and
the application software has to enable this
clock before using it.
__HAL_RCC_TIM15_CLK_DISABLE
__HAL_RCC_USART6_CLK_ENABLE
__HAL_RCC_USART6_CLK_DISABLE
__HAL_RCC_USART7_CLK_ENABLE
__HAL_RCC_USART8_CLK_ENABLE
__HAL_RCC_USART7_CLK_DISABLE
__HAL_RCC_USART8_CLK_DISABLE
Peripheral Clock Enable Disable Status
__HAL_RCC_GPIOD_IS_CLK_ENABLED
__HAL_RCC_GPIOD_IS_CLK_DISABLED
__HAL_RCC_GPIOE_IS_CLK_ENABLED
__HAL_RCC_GPIOE_IS_CLK_DISABLED
__HAL_RCC_TSC_IS_CLK_ENABLED
__HAL_RCC_TSC_IS_CLK_DISABLED
__HAL_RCC_DMA2_IS_CLK_ENABLED
__HAL_RCC_DMA2_IS_CLK_DISABLED
__HAL_RCC_USART2_IS_CLK_ENABLED
__HAL_RCC_USART2_IS_CLK_DISABLED
__HAL_RCC_SPI2_IS_CLK_ENABLED
__HAL_RCC_SPI2_IS_CLK_DISABLED
__HAL_RCC_TIM2_IS_CLK_ENABLED
__HAL_RCC_TIM2_IS_CLK_DISABLED
__HAL_RCC_TIM6_IS_CLK_ENABLED
362/1320
DocID026525 Rev 6
UM1785
HAL RCC Extension Driver
__HAL_RCC_I2C2_IS_CLK_ENABLED
__HAL_RCC_TIM6_IS_CLK_DISABLED
__HAL_RCC_I2C2_IS_CLK_DISABLED
__HAL_RCC_DAC1_IS_CLK_ENABLED
__HAL_RCC_DAC1_IS_CLK_DISABLED
__HAL_RCC_CEC_IS_CLK_ENABLED
__HAL_RCC_CEC_IS_CLK_DISABLED
__HAL_RCC_TIM7_IS_CLK_ENABLED
__HAL_RCC_USART3_IS_CLK_ENABLED
__HAL_RCC_USART4_IS_CLK_ENABLED
__HAL_RCC_TIM7_IS_CLK_DISABLED
__HAL_RCC_USART3_IS_CLK_DISABLED
__HAL_RCC_USART4_IS_CLK_DISABLED
__HAL_RCC_CAN1_IS_CLK_ENABLED
__HAL_RCC_CAN1_IS_CLK_DISABLED
__HAL_RCC_CRS_IS_CLK_ENABLED
__HAL_RCC_CRS_IS_CLK_DISABLED
__HAL_RCC_USART5_IS_CLK_ENABLED
__HAL_RCC_USART5_IS_CLK_DISABLED
__HAL_RCC_TIM15_IS_CLK_ENABLED
__HAL_RCC_TIM15_IS_CLK_DISABLED
__HAL_RCC_USART6_IS_CLK_ENABLED
__HAL_RCC_USART6_IS_CLK_DISABLED
__HAL_RCC_USART7_IS_CLK_ENABLED
__HAL_RCC_USART8_IS_CLK_ENABLED
__HAL_RCC_USART7_IS_CLK_DISABLED
__HAL_RCC_USART8_IS_CLK_DISABLED
RCCEx Peripheral Clock Source Config
__HAL_RCC_CEC_CONFIG
Description:
Macro to configure the CEC clock.
Parameters:
__CECCLKSOURCE__: specifies the CEC clock
source. This parameter can be one of the
following values:
RCC_CECCLKSOURCE_HSI HSI selected
as CEC clock
RCC_CECCLKSOURCE_LSE LSE selected
as CEC clock
DocID026525 Rev 6
363/1320
HAL RCC Extension Driver
__HAL_RCC_GET_CEC_
SOURCE
UM1785
Description:
Macro to get the HDMI CEC clock source.
Return value:
The: clock source can be one of the following
values:
RCC_CECCLKSOURCE_HSI HSI selected
as CEC clock
RCC_CECCLKSOURCE_LSE LSE selected
as CEC clock
__HAL_RCC_USART2_CONFIG
Description:
Macro to configure the USART2 clock
(USART2CLK).
Parameters:
__USART2CLKSOURCE__: specifies the
USART2 clock source. This parameter can be one
of the following values:
RCC_USART2CLKSOURCE_PCLK1 PCLK1
selected as USART2 clock
RCC_USART2CLKSOURCE_HSI HSI
selected as USART2 clock
RCC_USART2CLKSOURCE_SYSCLK
System Clock selected as USART2 clock
RCC_USART2CLKSOURCE_LSE LSE
selected as USART2 clock
__HAL_RCC_GET_USART2_
SOURCE
Description:
Macro to get the USART2 clock source.
Return value:
The: clock source can be one of the following
values:
RCC_USART2CLKSOURCE_PCLK1 PCLK1
selected as USART2 clock
RCC_USART2CLKSOURCE_HSI HSI
selected as USART2 clock
RCC_USART2CLKSOURCE_SYSCLK
System Clock selected as USART2 clock
RCC_USART2CLKSOURCE_LSE LSE
selected as USART2 clock
__HAL_RCC_USART3_CONFIG
Description:
Macro to configure the USART3 clock
(USART3CLK).
Parameters:
__USART3CLKSOURCE__: specifies the
USART3 clock source. This parameter can be one
of the following values:
RCC_USART3CLKSOURCE_PCLK1 PCLK1
selected as USART3 clock
364/1320
DocID026525 Rev 6
UM1785
HAL RCC Extension Driver
RCC_USART3CLKSOURCE_HSI HSI
selected as USART3 clock
RCC_USART3CLKSOURCE_SYSCLK
System Clock selected as USART3 clock
RCC_USART3CLKSOURCE_LSE LSE
selected as USART3 clock
__HAL_RCC_GET_USART3_
SOURCE
Description:
Macro to get the USART3 clock source.
Return value:
The: clock source can be one of the following
values:
RCC_USART3CLKSOURCE_PCLK1 PCLK1
selected as USART3 clock
RCC_USART3CLKSOURCE_HSI HSI
selected as USART3 clock
RCC_USART3CLKSOURCE_SYSCLK
System Clock selected as USART3 clock
RCC_USART3CLKSOURCE_LSE LSE
selected as USART3 clock
RCCEx Periph Clock Selection
RCC_PERIPHCLK_USART1
RCC_PERIPHCLK_USART2
RCC_PERIPHCLK_I2C1
RCC_PERIPHCLK_CEC
RCC_PERIPHCLK_RTC
RCC_PERIPHCLK_USART3
RCCEx USART2 Clock Source
RCC_USART2CLKSOURCE_PCLK1
RCC_USART2CLKSOURCE_SYSCLK
RCC_USART2CLKSOURCE_LSE
RCC_USART2CLKSOURCE_HSI
RCCEx USART3 Clock Source
RCC_USART3CLKSOURCE_PCLK1
RCC_USART3CLKSOURCE_SYSCLK
RCC_USART3CLKSOURCE_LSE
RCC_USART3CLKSOURCE_HSI
DocID026525 Rev 6
365/1320
HAL RTC Generic Driver
UM1785
34
HAL RTC Generic Driver
34.1
RTC Firmware driver registers structures
34.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
uint32_t RTC_InitTypeDef::HourFormat
Specifies the RTC Hour Format. This parameter can be a value of
RTC_Hour_Formats
uint32_t RTC_InitTypeDef::AsynchPrediv
Specifies the RTC Asynchronous Predivider value. This parameter must be a number
between Min_Data = 0x00 and Max_Data = 0x7F
uint32_t RTC_InitTypeDef::SynchPrediv
Specifies the RTC Synchronous Predivider value. This parameter must be a number
between Min_Data = 0x00 and Max_Data = 0x7FFF
uint32_t RTC_InitTypeDef::OutPut
Specifies which signal will be routed to the RTC output. This parameter can be a value
of RTCEx_Output_selection_Definitions
uint32_t RTC_InitTypeDef::OutPutPolarity
Specifies the polarity of the output signal. This parameter can be a value of
RTC_Output_Polarity_Definitions
uint32_t RTC_InitTypeDef::OutPutType
Specifies the RTC Output Pin mode. This parameter can be a value of
RTC_Output_Type_ALARM_OUT
34.1.2
RTC_TimeTypeDef
Data Fields
uint8_t Hours
uint8_t Minutes
uint8_t Seconds
uint8_t TimeFormat
uint32_t SubSeconds
uint32_t SecondFraction
uint32_t DayLightSaving
uint32_t StoreOperation
Field Documentation
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
366/1320
DocID026525 Rev 6
UM1785
34.1.3
HAL RTC Generic Driver
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::SubSeconds
Specifies the RTC_SSR RTC Sub Second register content. This parameter
corresponds to a time unit range between [0-1] Second with [1 Sec / SecondFraction
+1] granularity
uint32_t RTC_TimeTypeDef::SecondFraction
Specifies the range or granularity of Sub Second register content corresponding to
Synchronous pre-scaler factor value (PREDIV_S) This parameter corresponds to a
time unit range between [0-1] Second with [1 Sec / SecondFraction +1] granularity.
This field will be used only by HAL_RTC_GetTime function
uint32_t RTC_TimeTypeDef::DayLightSaving
Specifies RTC_DayLightSaveOperation: the value of hour adjustment. This parameter
can be a value of RTC_DayLightSaving_Definitions
uint32_t RTC_TimeTypeDef::StoreOperation
Specifies RTC_StoreOperation value to be written in the BCK bit in CR register to
store the operation. This parameter can be a value of
RTC_StoreOperation_Definitions
RTC_DateTypeDef
Data Fields
uint8_t WeekDay
uint8_t Month
uint8_t Date
uint8_t Year
Field Documentation
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
34.1.4
RTC_AlarmTypeDef
Data Fields
RTC_TimeTypeDef AlarmTime
DocID026525 Rev 6
367/1320
HAL RTC Generic Driver
UM1785
uint32_t AlarmMask
uint32_t AlarmSubSecondMask
uint32_t AlarmDateWeekDaySel
uint8_t AlarmDateWeekDay
uint32_t Alarm
Field Documentation
RTC_TimeTypeDef RTC_AlarmTypeDef::AlarmTime
Specifies the RTC Alarm Time members
uint32_t RTC_AlarmTypeDef::AlarmMask
Specifies the RTC Alarm Masks. This parameter can be a value of
RTC_AlarmMask_Definitions
uint32_t RTC_AlarmTypeDef::AlarmSubSecondMask
Specifies the RTC Alarm SubSeconds Masks. This parameter can be a value of
RTC_Alarm_Sub_Seconds_Masks_Definitions
uint32_t RTC_AlarmTypeDef::AlarmDateWeekDaySel
Specifies the RTC Alarm is on Date or WeekDay. This parameter can be a value of
RTC_AlarmDateWeekDay_Definitions
uint8_t RTC_AlarmTypeDef::AlarmDateWeekDay
Specifies the RTC Alarm Date/WeekDay. If the Alarm Date is selected, this parameter
must be set to a value in the 1-31 range. If the Alarm WeekDay is selected, this
parameter can be a value of RTC_WeekDay_Definitions
uint32_t RTC_AlarmTypeDef::Alarm
Specifies the alarm . This parameter can be a value of RTC_Alarms_Definitions
34.1.5
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
34.2
RTC Firmware driver API description
34.2.1
How to use RTC Driver
Enable the RTC domain access (see description in the section above).
Configure the RTC Prescaler (Asynchronous and Synchronous) and RTC hour format
using the HAL_RTC_Init() function.
368/1320
DocID026525 Rev 6
UM1785
HAL RTC Generic Driver
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
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.
34.2.2
RTC and low power modes
The MCU can be woken up from a low power mode by an RTC alternate function.
The RTC alternate functions are the RTC alarm (Alarm A), RTC 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.
34.2.3
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 15-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
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:
HAL_RTC_Init()
HAL_RTC_DeInit()
HAL_RTC_MspInit()
DocID026525 Rev 6
369/1320
HAL RTC Generic Driver
UM1785
HAL_RTC_MspDeInit()
34.2.4
RTC Time and Date functions
This section provides functions allowing to configure Time and Date features
This section contains the following APIs:
HAL_RTC_SetTime()
HAL_RTC_GetTime()
HAL_RTC_SetDate()
HAL_RTC_GetDate()
34.2.5
RTC Alarm functions
This section provides functions allowing to configure Alarm feature
This section contains the following APIs:
HAL_RTC_SetAlarm()
HAL_RTC_SetAlarm_IT()
HAL_RTC_DeactivateAlarm()
HAL_RTC_GetAlarm()
HAL_RTC_AlarmIRQHandler()
HAL_RTC_AlarmAEventCallback()
HAL_RTC_PollForAlarmAEvent()
34.2.6
Peripheral Control functions
This subsection provides functions allowing to
Wait for RTC Time and Date Synchronization
This section contains the following APIs:
HAL_RTC_WaitForSynchro()
34.2.7
Peripheral State functions
This subsection provides functions allowing to
Get RTC state
This section contains the following APIs:
HAL_RTC_GetState()
34.2.8
Detailed description of functions
HAL_RTC_Init
370/1320
Function name
HAL_StatusTypeDef HAL_RTC_Init (RTC_HandleTypeDef *
hrtc)
Function description
Initialize the RTC according to the specified parameters in the
RTC_InitTypeDef structure and initialize the associated handle.
Parameters
hrtc: RTC handle
Return values
HAL: status
DocID026525 Rev 6
UM1785
HAL RTC Generic Driver
HAL_RTC_DeInit
Function name
HAL_StatusTypeDef HAL_RTC_DeInit (RTC_HandleTypeDef *
hrtc)
Function description
DeInitialize the RTC peripheral.
Parameters
hrtc: RTC handle
Return values
HAL: status
Notes
This function doesn't reset the RTC Backup Data registers.
HAL_RTC_MspInit
Function name
void HAL_RTC_MspInit (RTC_HandleTypeDef * hrtc)
Function description
Initialize the RTC MSP.
Parameters
hrtc: RTC handle
Return values
None
HAL_RTC_MspDeInit
Function name
void HAL_RTC_MspDeInit (RTC_HandleTypeDef * hrtc)
Function description
DeInitialize the RTC MSP.
Parameters
hrtc: RTC handle
Return values
None
HAL_RTC_SetTime
Function name
HAL_StatusTypeDef HAL_RTC_SetTime (RTC_HandleTypeDef
* hrtc, RTC_TimeTypeDef * sTime, uint32_t Format)
Function description
Set RTC current time.
Parameters
hrtc: RTC handle
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 format
RTC_FORMAT_BCD: BCD data format
Return values
HAL: status
HAL_RTC_GetTime
Function name
HAL_StatusTypeDef HAL_RTC_GetTime (RTC_HandleTypeDef
* hrtc, RTC_TimeTypeDef * sTime, uint32_t Format)
Function description
Get RTC current time.
Parameters
hrtc: RTC handle
sTime: Pointer to Time structure with Hours, Minutes and
Seconds fields returned with input format (BIN or BCD), also
SubSeconds field returning the RTC_SSR register content
and SecondFraction field the Synchronous pre-scaler factor to
DocID026525 Rev 6
371/1320
HAL RTC Generic Driver
UM1785
be used for second fraction ratio computation.
Format: Specifies the format of the entered parameters. This
parameter can be one of the following values:
RTC_FORMAT_BIN: Binary data format
RTC_FORMAT_BCD: BCD data format
Return values
HAL: status
Notes
You can use SubSeconds and SecondFraction (sTime
structure fields returned) to convert SubSeconds value in
second fraction ratio with time unit following generic formula:
Second fraction ratio * time_unit= [(SecondFractionSubSeconds)/(SecondFraction+1)] * time_unit This
conversion can be performed only if no shift operation is
pending (ie. SHFP=0) when PREDIV_S >= SS
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
to ensure consistency between the time and date values.
HAL_RTC_SetDate
Function name
HAL_StatusTypeDef HAL_RTC_SetDate (RTC_HandleTypeDef
* hrtc, RTC_DateTypeDef * sDate, uint32_t Format)
Function description
Set RTC current date.
Parameters
hrtc: RTC handle
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 format
RTC_FORMAT_BCD: BCD data format
Return values
HAL: status
HAL_RTC_GetDate
372/1320
Function name
HAL_StatusTypeDef HAL_RTC_GetDate (RTC_HandleTypeDef
* hrtc, RTC_DateTypeDef * sDate, uint32_t Format)
Function description
Get RTC current date.
Parameters
hrtc: RTC handle
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 format
RTC_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
DocID026525 Rev 6
UM1785
HAL RTC Generic Driver
values in calendar shadow registers until Current date is read.
HAL_RTC_SetAlarm
Function name
HAL_StatusTypeDef HAL_RTC_SetAlarm
(RTC_HandleTypeDef * hrtc, RTC_AlarmTypeDef * sAlarm,
uint32_t Format)
Function description
Set the specified RTC Alarm.
Parameters
hrtc: RTC handle
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 format
RTC_FORMAT_BCD: BCD data format
Return values
HAL: status
HAL_RTC_SetAlarm_IT
Function name
HAL_StatusTypeDef HAL_RTC_SetAlarm_IT
(RTC_HandleTypeDef * hrtc, RTC_AlarmTypeDef * sAlarm,
uint32_t Format)
Function description
Set the specified RTC Alarm with Interrupt.
Parameters
hrtc: RTC handle
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 format
RTC_FORMAT_BCD: BCD data format
Return values
HAL: status
Notes
The Alarm register can only be written when the
corresponding Alarm is disabled (Use the
HAL_RTC_DeactivateAlarm()).
The HAL_RTC_SetTime() must be called before enabling the
Alarm feature.
HAL_RTC_DeactivateAlarm
Function name
HAL_StatusTypeDef HAL_RTC_DeactivateAlarm
(RTC_HandleTypeDef * hrtc, uint32_t Alarm)
Function description
Deactivate the specified RTC Alarm.
Parameters
hrtc: RTC handle
Alarm: Specifies the Alarm. This parameter can be one of
the following values:
RTC_ALARM_A: AlarmA
Return values
HAL: status
DocID026525 Rev 6
373/1320
HAL RTC Generic Driver
UM1785
HAL_RTC_GetAlarm
Function name
HAL_StatusTypeDef HAL_RTC_GetAlarm
(RTC_HandleTypeDef * hrtc, RTC_AlarmTypeDef * sAlarm,
uint32_t Alarm, uint32_t Format)
Function description
Get the RTC Alarm value and masks.
Parameters
hrtc: RTC handle
sAlarm: Pointer to Date structure
Alarm: Specifies the Alarm. This parameter can be one of
the following values:
RTC_ALARM_A: AlarmA
Format: Specifies the format of the entered parameters. This
parameter can be one of the following values:
RTC_FORMAT_BIN: Binary data format
RTC_FORMAT_BCD: BCD data format
Return values
HAL: status
HAL_RTC_AlarmIRQHandler
Function name
void HAL_RTC_AlarmIRQHandler (RTC_HandleTypeDef * hrtc)
Function description
Handle Alarm interrupt request.
Parameters
hrtc: RTC handle
Return values
None
HAL_RTC_PollForAlarmAEvent
Function name
HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent
(RTC_HandleTypeDef * hrtc, uint32_t Timeout)
Function description
Handle AlarmA Polling request.
Parameters
hrtc: RTC handle
Timeout: Timeout duration
Return values
HAL: status
HAL_RTC_AlarmAEventCallback
Function name
void HAL_RTC_AlarmAEventCallback (RTC_HandleTypeDef *
hrtc)
Function description
Alarm A callback.
Parameters
hrtc: RTC handle
Return values
None
HAL_RTC_WaitForSynchro
374/1320
Function name
HAL_StatusTypeDef HAL_RTC_WaitForSynchro
(RTC_HandleTypeDef * hrtc)
Function description
Wait until the RTC Time and Date registers (RTC_TR and
RTC_DR) are synchronized with RTC APB clock.
DocID026525 Rev 6
UM1785
HAL RTC Generic Driver
Parameters
hrtc: RTC handle
Return values
HAL: status
Notes
The RTC Resynchronization mode is write protected, use the
__HAL_RTC_WRITEPROTECTION_DISABLE() before
calling this function.
To read the calendar through the shadow registers after
Calendar initialization, calendar update or after wakeup from
low power modes the software must first clear the RSF flag.
The software must then wait until it is set again before reading
the calendar, which means that the calendar registers have
been correctly copied into the RTC_TR and RTC_DR shadow
registers.
HAL_RTC_GetState
Function name
HAL_RTCStateTypeDef HAL_RTC_GetState
(RTC_HandleTypeDef * hrtc)
Function description
Return the RTC handle state.
Parameters
hrtc: RTC handle
Return values
HAL: state
RTC_EnterInitMode
Function name
HAL_StatusTypeDef RTC_EnterInitMode
(RTC_HandleTypeDef * hrtc)
Function description
Enter the RTC Initialization mode.
Parameters
hrtc: RTC handle
Return values
HAL: status
Notes
The RTC Initialization mode is write protected, use the
__HAL_RTC_WRITEPROTECTION_DISABLE() before
calling this function.
RTC_ByteToBcd2
Function name
uint8_t RTC_ByteToBcd2 (uint8_t Value)
Function description
Convert a 2 digit decimal to BCD format.
Parameters
Value: Byte to be converted
Return values
Converted: byte
RTC_Bcd2ToByte
Function name
uint8_t RTC_Bcd2ToByte (uint8_t Value)
Function description
Convert from 2 digit BCD to Binary.
Parameters
Value: BCD value to be converted
Return values
Converted: word
DocID026525 Rev 6
375/1320
HAL RTC Generic Driver
UM1785
34.3
RTC Firmware driver defines
34.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 Sub Seconds Masks Definitions
376/1320
RTC_ALARMSUBSECONDMASK_ALL
All Alarm SS fields are masked. There is no
comparison on sub seconds for Alarm
RTC_ALARMSUBSECONDMASK_SS14_1
SS[14:1] are don't care in Alarm
comparison. Only SS[0] is compared.
RTC_ALARMSUBSECONDMASK_SS14_2
SS[14:2] are don't care in Alarm
comparison. Only SS[1:0] are compared
RTC_ALARMSUBSECONDMASK_SS14_3
SS[14:3] are don't care in Alarm
comparison. Only SS[2:0] are compared
RTC_ALARMSUBSECONDMASK_SS14_4
SS[14:4] are don't care in Alarm
comparison. Only SS[3:0] are compared
RTC_ALARMSUBSECONDMASK_SS14_5
SS[14:5] are don't care in Alarm
comparison. Only SS[4:0] are compared
RTC_ALARMSUBSECONDMASK_SS14_6
SS[14:6] are don't care in Alarm
comparison. Only SS[5:0] are compared
RTC_ALARMSUBSECONDMASK_SS14_7
SS[14:7] are don't care in Alarm
comparison. Only SS[6:0] are compared
RTC_ALARMSUBSECONDMASK_SS14_8
SS[14:8] are don't care in Alarm
comparison. Only SS[7:0] are compared
RTC_ALARMSUBSECONDMASK_SS14_9
SS[14:9] are don't care in Alarm
comparison. Only SS[8:0] are compared
RTC_ALARMSUBSECONDMASK_SS14_10
SS[14:10] are don't care in Alarm
comparison. Only SS[9:0] are compared
RTC_ALARMSUBSECONDMASK_SS14_11
SS[14:11] are don't care in Alarm
comparison. Only SS[10:0] are compared
RTC_ALARMSUBSECONDMASK_SS14_12
SS[14:12] are don't care in Alarm
DocID026525 Rev 6
UM1785
HAL RTC Generic Driver
comparison.Only SS[11:0] are compared
RTC_ALARMSUBSECONDMASK_SS14_13
SS[14:13] are don't care in Alarm
comparison. Only SS[12:0] are compared
RTC_ALARMSUBSECONDMASK_SS14
SS[14] is don't care in Alarm
comparison.Only SS[13:0] are compared
RTC_ALARMSUBSECONDMASK_NONE
SS[14:0] are compared and must match to
activate alarm.
RTC AM PM Definitions
RTC_HOURFORMAT12_AM
RTC_HOURFORMAT12_PM
RTC DayLight Saving Definitions
RTC_DAYLIGHTSAVING_SUB1H
RTC_DAYLIGHTSAVING_ADD1H
RTC_DAYLIGHTSAVING_NONE
RTC Exported Macros
__HAL_RTC_RESET_HANDLE_STATE
Description:
Reset RTC handle state.
Parameters:
__HANDLE__: RTC handle.
Return value:
None
__HAL_RTC_WRITEPROTECTION_
DISABLE
Description:
Disable the write protection for RTC
registers.
Parameters:
__HANDLE__: specifies the RTC
handle.
Return value:
None
__HAL_RTC_WRITEPROTECTION_ENABLE
Description:
Enable the write protection for RTC
registers.
Parameters:
__HANDLE__: specifies the RTC
handle.
Return value:
None
DocID026525 Rev 6
377/1320
HAL RTC Generic Driver
__HAL_RTC_ALARMA_ENABLE
UM1785
Description:
Enable the RTC ALARMA peripheral.
Parameters:
__HANDLE__: specifies the RTC
handle.
Return value:
None
__HAL_RTC_ALARMA_DISABLE
Description:
Disable the RTC ALARMA
peripheral.
Parameters:
__HANDLE__: specifies the RTC
handle.
Return value:
None
__HAL_RTC_ALARM_ENABLE_IT
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
Return value:
None
__HAL_RTC_ALARM_DISABLE_IT
Description:
Disable 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
378/1320
DocID026525 Rev 6
UM1785
HAL RTC Generic Driver
Return value:
None
__HAL_RTC_ALARM_GET_IT
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
Return value:
None
__HAL_RTC_ALARM_GET_IT_SOURCE
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
Return value:
None
__HAL_RTC_ALARM_GET_FLAG
Description:
Get the selected RTC Alarm's flag
status.
Parameters:
__HANDLE__: specifies the RTC
handle.
__FLAG__: specifies the RTC Alarm
Flag sources to check. This
parameter can be:
RTC_FLAG_ALRAF
RTC_FLAG_ALRAWF
Return value:
None
DocID026525 Rev 6
379/1320
HAL RTC Generic Driver
__HAL_RTC_ALARM_CLEAR_FLAG
UM1785
Description:
Clear the RTC Alarm's pending flags.
Parameters:
__HANDLE__: specifies the RTC
handle.
__FLAG__: specifies the RTC Alarm
Flag sources to clear. This parameter
can be:
RTC_FLAG_ALRAF
Return value:
None
__HAL_RTC_ALARM_EXTI_ENABLE_IT
Description:
Enable interrupt on the RTC Alarm
associated Exti line.
Return value:
None
__HAL_RTC_ALARM_EXTI_DISABLE_IT
Description:
Disable interrupt on the RTC Alarm
associated Exti line.
Return value:
None
__HAL_RTC_ALARM_EXTI_ENABLE_
EVENT
Description:
Enable event on the RTC Alarm
associated Exti line.
Return value:
None.
__HAL_RTC_ALARM_EXTI_DISABLE_
EVENT
Description:
Disable event on the RTC Alarm
associated Exti line.
Return value:
None.
__HAL_RTC_ALARM_EXTI_ENABLE_
FALLING_EDGE
Description:
Enable falling edge trigger on the
RTC Alarm associated Exti line.
Return value:
None.
__HAL_RTC_ALARM_EXTI_DISABLE_
FALLING_EDGE
380/1320
Description:
DocID026525 Rev 6
Disable falling edge trigger on the
RTC Alarm associated Exti line.
UM1785
HAL RTC Generic Driver
Return value:
None.
__HAL_RTC_ALARM_EXTI_ENABLE_
RISING_EDGE
Description:
Enable rising edge trigger on the
RTC Alarm associated Exti line.
Return value:
None.
__HAL_RTC_ALARM_EXTI_DISABLE_
RISING_EDGE
Description:
Disable rising edge trigger on the
RTC Alarm associated Exti line.
Return value:
None.
__HAL_RTC_ALARM_EXTI_ENABLE_
RISING_FALLING_EDGE
Description:
Enable rising & falling edge trigger
on the RTC Alarm associated Exti
line.
Return value:
None.
__HAL_RTC_ALARM_EXTI_DISABLE_
RISING_FALLING_EDGE
Description:
Disable rising & falling edge trigger
on the RTC Alarm associated Exti
line.
Return value:
None.
__HAL_RTC_ALARM_EXTI_GET_FLAG
Description:
Check whether the RTC Alarm
associated Exti line interrupt flag is
set or not.
Return value:
Line: Status.
__HAL_RTC_ALARM_EXTI_CLEAR_FLAG
Description:
Clear the RTC Alarm associated Exti
line flag.
Return value:
None.
__HAL_RTC_ALARM_EXTI_GENERATE_S
WIT
Description:
DocID026525 Rev 6
Generate a Software interrupt on
RTC Alarm associated Exti line.
381/1320
HAL RTC Generic Driver
UM1785
Return value:
None.
RTC Flags Definitions
RTC_FLAG_RECALPF
RTC_FLAG_TAMP3F
RTC_FLAG_TAMP2F
RTC_FLAG_TAMP1F
RTC_FLAG_TSOVF
RTC_FLAG_TSF
RTC_FLAG_WUTF
RTC_FLAG_ALRAF
RTC_FLAG_INITF
RTC_FLAG_RSF
RTC_FLAG_INITS
RTC_FLAG_SHPF
RTC_FLAG_WUTWF
RTC_FLAG_ALRAWF
RTC Hour Formats
RTC_HOURFORMAT_24
RTC_HOURFORMAT_12
RTC Input parameter format definitions
RTC_FORMAT_BIN
RTC_FORMAT_BCD
RTC Interrupts Definitions
RTC_IT_TS
RTC_IT_WUT
RTC_IT_ALRA
RTC_IT_TAMP
RTC_IT_TAMP1
RTC_IT_TAMP2
RTC_IT_TAMP3
RTC Private macros to check input parameters
IS_RTC_HOUR_FORMAT
IS_RTC_OUTPUT_POL
IS_RTC_OUTPUT_TYPE
IS_RTC_HOUR12
382/1320
DocID026525 Rev 6
UM1785
HAL RTC Generic Driver
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
IS_RTC_ALARM_SUB_SECOND_VALUE
IS_RTC_ALARM_SUB_SECOND_MASK
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
RTC_MONTH_DECEMBER
RTC Output Polarity Definitions
RTC_OUTPUT_POLARITY_HIGH
RTC_OUTPUT_POLARITY_LOW
DocID026525 Rev 6
383/1320
HAL RTC Generic Driver
RTC Output Type ALARM OUT
RTC_OUTPUT_TYPE_OPENDRAIN
RTC_OUTPUT_TYPE_PUSHPULL
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
384/1320
DocID026525 Rev 6
UM1785
UM1785
HAL RTC Extension Driver
35
HAL RTC Extension Driver
35.1
RTCEx Firmware driver registers structures
35.1.1
RTC_TamperTypeDef
Data Fields
uint32_t Tamper
uint32_t Trigger
uint32_t Filter
uint32_t SamplingFrequency
uint32_t PrechargeDuration
uint32_t TamperPullUp
uint32_t TimeStampOnTamperDetection
Field Documentation
uint32_t RTC_TamperTypeDef::Tamper
Specifies the Tamper Pin. This parameter can be a value of
RTCEx_Tamper_Pins_Definitions
uint32_t RTC_TamperTypeDef::Trigger
Specifies the Tamper Trigger. This parameter can be a value of
RTCEx_Tamper_Trigger_Definitions
uint32_t RTC_TamperTypeDef::Filter
Specifies the RTC Filter Tamper. This parameter can be a value of
RTCEx_Tamper_Filter_Definitions
uint32_t RTC_TamperTypeDef::SamplingFrequency
Specifies the sampling frequency. This parameter can be a value of
RTCEx_Tamper_Sampling_Frequencies_Definitions
uint32_t RTC_TamperTypeDef::PrechargeDuration
Specifies the Precharge Duration . This parameter can be a value of
RTCEx_Tamper_Pin_Precharge_Duration_Definitions
uint32_t RTC_TamperTypeDef::TamperPullUp
Specifies the Tamper PullUp . This parameter can be a value of
RTCEx_Tamper_Pull_UP_Definitions
uint32_t RTC_TamperTypeDef::TimeStampOnTamperDetection
Specifies the TimeStampOnTamperDetection. This parameter can be a value of
RTCEx_Tamper_TimeStampOnTamperDetection_Definitions
DocID026525 Rev 6
385/1320
HAL RTC Extension Driver
UM1785
35.2
RTCEx Firmware driver API description
35.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
Not available on F030x4/x6/x8 and F070x6
TimeStamp configuration
Configure the RTC_AF 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.
To read the RTC TimeStamp Time and Date register, use the
HAL_RTCEx_GetTimeStamp() function.
Tamper configuration
Enable the RTC Tamper and configure the Tamper filter count, trigger Edge or Level
according to the Tamper filter (if equal to 0 Edge else Level) value, sampling
frequency, precharge or discharge and Pull-UP using the HAL_RTCEx_SetTamper()
function. You can configure RTC Tamper in interrupt mode using
HAL_RTCEx_SetTamper_IT() function.
Backup Data Registers configuration
Not available on F030x6/x8/xC and F070x6/xB (F0xx Value Line devices)
35.2.2
RTC TimeStamp and Tamper functions
This section provides functions allowing to configure TimeStamp feature
This section contains the following APIs:
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_Tamper2EventCallback()
386/1320
DocID026525 Rev 6
UM1785
HAL RTC Extension Driver
HAL_RTCEx_Tamper3EventCallback()
HAL_RTCEx_PollForTimeStampEvent()
HAL_RTCEx_PollForTamper1Event()
HAL_RTCEx_PollForTamper2Event()
HAL_RTCEx_PollForTamper3Event()
35.2.3
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()
HAL_RTCEx_PollForWakeUpTimerEvent()
35.2.4
Extended 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
Set the Smooth calibration parameters.
Configure the Synchronization Shift Control Settings.
Configure the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz).
Deactivate the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz).
Enable the RTC reference clock detection.
Disable the RTC reference clock detection.
Enable the Bypass Shadow feature.
Disable the Bypass Shadow feature.
This section contains the following APIs:
HAL_RTCEx_BKUPWrite()
HAL_RTCEx_BKUPRead()
HAL_RTCEx_SetSmoothCalib()
HAL_RTCEx_SetSynchroShift()
HAL_RTCEx_SetCalibrationOutPut()
HAL_RTCEx_DeactivateCalibrationOutPut()
HAL_RTCEx_SetRefClock()
HAL_RTCEx_DeactivateRefClock()
HAL_RTCEx_EnableBypassShadow()
HAL_RTCEx_DisableBypassShadow()
DocID026525 Rev 6
387/1320
HAL RTC Extension Driver
35.2.5
UM1785
Detailed description of functions
HAL_RTCEx_SetTimeStamp
Function name
HAL_StatusTypeDef HAL_RTCEx_SetTimeStamp
(RTC_HandleTypeDef * hrtc, uint32_t TimeStampEdge,
uint32_t RTC_TimeStampPin)
Function description
Set TimeStamp.
Parameters
hrtc: RTC handle
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.
Return values
HAL: status
Notes
This API must be called before enabling the TimeStamp
feature.
HAL_RTCEx_SetTimeStamp_IT
388/1320
Function name
HAL_StatusTypeDef HAL_RTCEx_SetTimeStamp_IT
(RTC_HandleTypeDef * hrtc, uint32_t TimeStampEdge,
uint32_t RTC_TimeStampPin)
Function description
Set TimeStamp with Interrupt.
Parameters
hrtc: RTC handle
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.
Return values
HAL: status
Notes
This API must be called before enabling the TimeStamp
feature.
DocID026525 Rev 6
UM1785
HAL RTC Extension Driver
HAL_RTCEx_DeactivateTimeStamp
Function name
HAL_StatusTypeDef HAL_RTCEx_DeactivateTimeStamp
(RTC_HandleTypeDef * hrtc)
Function description
Deactivate TimeStamp.
Parameters
hrtc: RTC handle
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
Get the RTC TimeStamp value.
Parameters
hrtc: RTC handle
sTimeStamp: Pointer to Time structure
sTimeStampDate: Pointer to Date structure
Format: specifies the format of the entered parameters. This
parameter can be one of the following values:
RTC_FORMAT_BIN: Binary data format
RTC_FORMAT_BCD: BCD data format
Return values
HAL: status
HAL_RTCEx_SetTamper
Function name
HAL_StatusTypeDef HAL_RTCEx_SetTamper
(RTC_HandleTypeDef * hrtc, RTC_TamperTypeDef * sTamper)
Function description
Set Tamper.
Parameters
hrtc: RTC handle
sTamper: Pointer to Tamper Structure.
Return values
HAL: status
Notes
By calling this API we disable the tamper interrupt for all
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.
DocID026525 Rev 6
389/1320
HAL RTC Extension Driver
UM1785
HAL_RTCEx_DeactivateTamper
Function name
HAL_StatusTypeDef HAL_RTCEx_DeactivateTamper
(RTC_HandleTypeDef * hrtc, uint32_t Tamper)
Function description
Deactivate Tamper.
Parameters
hrtc: RTC handle
Tamper: Selected tamper pin. This parameter can be any
combination of RTC_TAMPER_1, RTC_TAMPER_2 and
RTC_TAMPER_3.
Return values
HAL: status
HAL_RTCEx_TamperTimeStampIRQHandler
Function name
void HAL_RTCEx_TamperTimeStampIRQHandler
(RTC_HandleTypeDef * hrtc)
Function description
Handle TimeStamp interrupt request.
Parameters
hrtc: RTC handle
Return values
None
HAL_RTCEx_Tamper1EventCallback
Function name
void HAL_RTCEx_Tamper1EventCallback
(RTC_HandleTypeDef * hrtc)
Function description
Tamper 1 callback.
Parameters
hrtc: RTC handle
Return values
None
HAL_RTCEx_Tamper2EventCallback
Function name
void HAL_RTCEx_Tamper2EventCallback
(RTC_HandleTypeDef * hrtc)
Function description
Tamper 2 callback.
Parameters
hrtc: RTC handle
Return values
None
HAL_RTCEx_Tamper3EventCallback
390/1320
Function name
void HAL_RTCEx_Tamper3EventCallback
(RTC_HandleTypeDef * hrtc)
Function description
Tamper 3 callback.
Parameters
hrtc: RTC handle
Return values
None
DocID026525 Rev 6
UM1785
HAL RTC Extension Driver
HAL_RTCEx_TimeStampEventCallback
Function name
void HAL_RTCEx_TimeStampEventCallback
(RTC_HandleTypeDef * hrtc)
Function description
TimeStamp callback.
Parameters
hrtc: RTC handle
Return values
None
HAL_RTCEx_PollForTimeStampEvent
Function name
HAL_StatusTypeDef HAL_RTCEx_PollForTimeStampEvent
(RTC_HandleTypeDef * hrtc, uint32_t Timeout)
Function description
Handle TimeStamp polling request.
Parameters
hrtc: RTC handle
Timeout: Timeout duration
Return values
HAL: status
HAL_RTCEx_PollForTamper1Event
Function name
HAL_StatusTypeDef HAL_RTCEx_PollForTamper1Event
(RTC_HandleTypeDef * hrtc, uint32_t Timeout)
Function description
Handle Tamper 1 Polling.
Parameters
hrtc: RTC handle
Timeout: Timeout duration
Return values
HAL: status
HAL_RTCEx_PollForTamper2Event
Function name
HAL_StatusTypeDef HAL_RTCEx_PollForTamper2Event
(RTC_HandleTypeDef * hrtc, uint32_t Timeout)
Function description
Handle Tamper 2 Polling.
Parameters
hrtc: RTC handle
Timeout: Timeout duration
Return values
HAL: status
HAL_RTCEx_PollForTamper3Event
Function name
HAL_StatusTypeDef HAL_RTCEx_PollForTamper3Event
(RTC_HandleTypeDef * hrtc, uint32_t Timeout)
Function description
Handle Tamper 3 Polling.
Parameters
hrtc: RTC handle
Timeout: Timeout duration
Return values
HAL: status
DocID026525 Rev 6
391/1320
HAL RTC Extension Driver
UM1785
HAL_RTCEx_SetWakeUpTimer
Function name
HAL_StatusTypeDef HAL_RTCEx_SetWakeUpTimer
(RTC_HandleTypeDef * hrtc, uint32_t WakeUpCounter,
uint32_t WakeUpClock)
Function description
Set wake up timer.
Parameters
hrtc: RTC handle
WakeUpCounter: Wake up counter
WakeUpClock: Wake up clock
Return values
HAL: status
HAL_RTCEx_SetWakeUpTimer_IT
Function name
HAL_StatusTypeDef HAL_RTCEx_SetWakeUpTimer_IT
(RTC_HandleTypeDef * hrtc, uint32_t WakeUpCounter,
uint32_t WakeUpClock)
Function description
Set wake up timer with interrupt.
Parameters
hrtc: RTC handle
WakeUpCounter: Wake up counter
WakeUpClock: Wake up clock
Return values
HAL: status
HAL_RTCEx_DeactivateWakeUpTimer
Function name
uint32_t HAL_RTCEx_DeactivateWakeUpTimer
(RTC_HandleTypeDef * hrtc)
Function description
Deactivate wake up timer counter.
Parameters
hrtc: RTC handle
Return values
HAL: status
HAL_RTCEx_GetWakeUpTimer
Function name
uint32_t HAL_RTCEx_GetWakeUpTimer (RTC_HandleTypeDef
* hrtc)
Function description
Get wake up timer counter.
Parameters
hrtc: RTC handle
Return values
Counter: value
HAL_RTCEx_WakeUpTimerIRQHandler
392/1320
Function name
void HAL_RTCEx_WakeUpTimerIRQHandler
(RTC_HandleTypeDef * hrtc)
Function description
Handle Wake Up Timer interrupt request.
Parameters
hrtc: RTC handle
Return values
None
DocID026525 Rev 6
UM1785
HAL RTC Extension Driver
HAL_RTCEx_WakeUpTimerEventCallback
Function name
void HAL_RTCEx_WakeUpTimerEventCallback
(RTC_HandleTypeDef * hrtc)
Function description
Wake Up Timer callback.
Parameters
hrtc: RTC handle
Return values
None
HAL_RTCEx_PollForWakeUpTimerEvent
Function name
HAL_StatusTypeDef HAL_RTCEx_PollForWakeUpTimerEvent
(RTC_HandleTypeDef * hrtc, uint32_t Timeout)
Function description
Handle Wake Up Timer Polling.
Parameters
hrtc: RTC handle
Timeout: Timeout duration
Return values
HAL: status
HAL_RTCEx_BKUPWrite
Function name
void HAL_RTCEx_BKUPWrite (RTC_HandleTypeDef * hrtc,
uint32_t BackupRegister, uint32_t Data)
Function description
Write a data in a specified RTC Backup data register.
Parameters
hrtc: RTC handle
BackupRegister: RTC Backup data Register number. This
parameter can be: RTC_BKP_DRx where x can be from 0 to
4 to specify the register.
Data: Data to be written in the specified RTC Backup data
register.
Return values
None
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
hrtc: RTC handle
BackupRegister: RTC Backup data Register number. This
parameter can be: RTC_BKP_DRx where x can be from 0 to
4 to specify the register.
Return values
Read: value
HAL_RTCEx_SetSmoothCalib
Function name
HAL_StatusTypeDef HAL_RTCEx_SetSmoothCalib
(RTC_HandleTypeDef * hrtc, uint32_t SmoothCalibPeriod,
uint32_t SmoothCalibPlusPulses, uint32_t
SmoothCalibMinusPulsesValue)
DocID026525 Rev 6
393/1320
HAL RTC Extension Driver
Function description
UM1785
Set the Smooth calibration parameters.
Parameters
hrtc: RTC handle
SmoothCalibPeriod: Select the Smooth Calibration Period.
This parameter can be can be one of the following values :
RTC_SMOOTHCALIB_PERIOD_32SEC: The smooth
calibration period is 32s.
RTC_SMOOTHCALIB_PERIOD_16SEC: The smooth
calibration period is 16s.
RTC_SMOOTHCALIB_PERIOD_8SEC: The smooth
calibration period is 8s.
SmoothCalibPlusPulses: Select to Set or reset the CALP
bit. This parameter can be one of the following values:
RTC_SMOOTHCALIB_PLUSPULSES_SET: Add one
RTCCLK pulse every 2*11 pulses.
RTC_SMOOTHCALIB_PLUSPULSES_RESET: No
RTCCLK pulses are added.
SmoothCalibMinusPulsesValue: Select the value of
CALM[8:0] bits. This parameter can be one any value from 0
to 0x000001FF.
Return values
HAL: status
Notes
To deactivate the smooth calibration, the field
SmoothCalibPlusPulses must be equal to
SMOOTHCALIB_PLUSPULSES_RESET and the field
SmoothCalibMinusPulsesValue mut be equal to 0.
HAL_RTCEx_SetSynchroShift
394/1320
Function name
HAL_StatusTypeDef HAL_RTCEx_SetSynchroShift
(RTC_HandleTypeDef * hrtc, uint32_t ShiftAdd1S, uint32_t
ShiftSubFS)
Function description
Configure the Synchronization Shift Control Settings.
Parameters
hrtc: RTC handle
ShiftAdd1S: Select to add or not 1 second to the time
calendar. This parameter can be one of the following values :
RTC_SHIFTADD1S_SET: Add one second to the clock
calendar.
RTC_SHIFTADD1S_RESET: No effect.
ShiftSubFS: Select the number of Second Fractions to
substitute. This parameter can be one any value from 0 to
0x7FFF.
Return values
HAL: status
Notes
When REFCKON is set, firmware must not write to Shift
control register.
DocID026525 Rev 6
UM1785
HAL RTC Extension Driver
HAL_RTCEx_SetCalibrationOutPut
Function name
HAL_StatusTypeDef HAL_RTCEx_SetCalibrationOutPut
(RTC_HandleTypeDef * hrtc, uint32_t CalibOutput)
Function description
Configure the Calibration Pinout (RTC_CALIB) Selection (1Hz or
512Hz).
Parameters
hrtc: RTC handle
CalibOutput: Select the Calibration output Selection . This
parameter can be one of the following values:
RTC_CALIBOUTPUT_512HZ: A signal has a regular
waveform at 512Hz.
RTC_CALIBOUTPUT_1HZ: A signal has a regular
waveform at 1Hz.
Return values
HAL: status
HAL_RTCEx_DeactivateCalibrationOutPut
Function name
HAL_StatusTypeDef
HAL_RTCEx_DeactivateCalibrationOutPut
(RTC_HandleTypeDef * hrtc)
Function description
Deactivate the Calibration Pinout (RTC_CALIB) Selection (1Hz or
512Hz).
Parameters
hrtc: RTC handle
Return values
HAL: status
HAL_RTCEx_SetRefClock
Function name
HAL_StatusTypeDef HAL_RTCEx_SetRefClock
(RTC_HandleTypeDef * hrtc)
Function description
Enable the RTC reference clock detection.
Parameters
hrtc: RTC handle
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: RTC handle
Return values
HAL: status
HAL_RTCEx_EnableBypassShadow
Function name
HAL_StatusTypeDef HAL_RTCEx_EnableBypassShadow
(RTC_HandleTypeDef * hrtc)
Function description
Enable the Bypass Shadow feature.
Parameters
hrtc: RTC handle
DocID026525 Rev 6
395/1320
HAL RTC Extension Driver
Return values
UM1785
HAL: status
Notes
When the Bypass Shadow is enabled the calendar value are
taken directly from the Calendar counter.
HAL_RTCEx_DisableBypassShadow
Function name
HAL_StatusTypeDef HAL_RTCEx_DisableBypassShadow
(RTC_HandleTypeDef * hrtc)
Function description
Disable the Bypass Shadow feature.
Parameters
hrtc: RTC handle
Return values
HAL: status
Notes
When the Bypass Shadow is enabled the calendar value are
taken directly from the Calendar counter.
35.3
RTCEx Firmware driver defines
35.3.1
RTCEx
RTCEx Add 1 Second Parameter Definition
RTC_SHIFTADD1S_RESET
RTC_SHIFTADD1S_SET
RTCEx Backup Registers Definition
RTC_BKP_DR0
RTC_BKP_DR1
RTC_BKP_DR2
RTC_BKP_DR3
RTC_BKP_DR4
RTC Calibration
__HAL_RTC_CALIBRATION_OUTPUT_ENABLE
Description:
Enable the RTC calibration
output.
Parameters:
__HANDLE__: specifies the
RTC handle.
Return value:
None
__HAL_RTC_CALIBRATION_OUTPUT_DISABLE
Description:
Disable the calibration output.
Parameters:
__HANDLE__: specifies the
RTC handle.
396/1320
DocID026525 Rev 6
UM1785
HAL RTC Extension Driver
Return value:
None
__HAL_RTC_CLOCKREF_DETECTION_ENABLE
Description:
Enable the clock reference
detection.
Parameters:
__HANDLE__: specifies the
RTC handle.
Return value:
None
__HAL_RTC_CLOCKREF_DETECTION_DISABLE
Description:
Disable the clock reference
detection.
Parameters:
__HANDLE__: specifies the
RTC handle.
Return value:
None
__HAL_RTC_SHIFT_GET_FLAG
Description:
Get the selected RTC shift
operation's flag status.
Parameters:
__HANDLE__: specifies the
RTC handle.
__FLAG__: specifies the RTC
shift operation Flag is pending
or not. This parameter can be:
RTC_FLAG_SHPF
Return value:
None
RTCEx Calib Output selection Definitions
RTC_CALIBOUTPUT_512HZ
RTC_CALIBOUTPUT_1HZ
Private macros to check input parameters
IS_RTC_OUTPUT
IS_RTC_BKP
IS_TIMESTAMP_EDGE
IS_RTC_TAMPER
IS_RTC_TIMESTAMP_PIN
DocID026525 Rev 6
397/1320
HAL RTC Extension Driver
IS_RTC_TAMPER_TRIGGER
UM1785
IS_RTC_TAMPER_FILTER
IS_RTC_TAMPER_SAMPLING_FREQ
IS_RTC_TAMPER_PRECHARGE_DURATION
IS_RTC_TAMPER_TIMESTAMPONTAMPER_DETECTION
IS_RTC_TAMPER_PULLUP_STATE
IS_RTC_WAKEUP_CLOCK
IS_RTC_WAKEUP_COUNTER
IS_RTC_SMOOTH_CALIB_PERIOD
IS_RTC_SMOOTH_CALIB_PLUS
IS_RTC_SMOOTH_CALIB_MINUS
IS_RTC_SHIFT_ADD1S
IS_RTC_SHIFT_SUBFS
IS_RTC_CALIB_OUTPUT
RTCEx Output Selection Definition
RTC_OUTPUT_DISABLE
RTC_OUTPUT_ALARMA
RTC_OUTPUT_WAKEUP
RTCEx Smooth calib period Definition
RTC_SMOOTHCALIB_PERIOD_32SEC
If RTCCLK = 32768 Hz, Smooth calibation
period is 32s, else 2exp20 RTCCLK seconds
RTC_SMOOTHCALIB_PERIOD_16SEC
If RTCCLK = 32768 Hz, Smooth calibation
period is 16s, else 2exp19 RTCCLK seconds
RTC_SMOOTHCALIB_PERIOD_8SEC
If RTCCLK = 32768 Hz, Smooth calibation
period is 8s, else 2exp18 RTCCLK seconds
RTCEx Smooth calib Plus pulses Definition
RTC_SMOOTHCALIB_PLUSPULSES_SET
The number of RTCCLK pulses added
during a X -second window = Y CALM[8:0] with Y = 512, 256, 128 when
X = 32, 16, 8
RTC_SMOOTHCALIB_PLUSPULSES_RESET
The number of RTCCLK pulses
subbstited during a 32-second window =
CALM[8:0]
RTC Tamper
__HAL_RTC_TAMPER1_ENABLE
Description:
Enable the RTC Tamper1 input
detection.
Parameters:
__HANDLE__: specifies the RTC
handle.
398/1320
DocID026525 Rev 6
UM1785
HAL RTC Extension Driver
Return value:
None
__HAL_RTC_TAMPER1_DISABLE
Description:
Disable the RTC Tamper1 input
detection.
Parameters:
__HANDLE__: specifies the RTC
handle.
Return value:
None
__HAL_RTC_TAMPER2_ENABLE
Description:
Enable the RTC Tamper2 input
detection.
Parameters:
__HANDLE__: specifies the RTC
handle.
Return value:
None
__HAL_RTC_TAMPER2_DISABLE
Description:
Disable the RTC Tamper2 input
detection.
Parameters:
__HANDLE__: specifies the RTC
handle.
Return value:
None
__HAL_RTC_TAMPER3_ENABLE
Description:
Enable the RTC Tamper3 input
detection.
Parameters:
__HANDLE__: specifies the RTC
handle.
Return value:
None
__HAL_RTC_TAMPER3_DISABLE
Description:
Disable the RTC Tamper3 input
detection.
Parameters:
__HANDLE__: specifies the RTC
DocID026525 Rev 6
399/1320
HAL RTC Extension Driver
UM1785
handle.
Return value:
None
__HAL_RTC_TAMPER_ENABLE_IT
Description:
Enable the RTC Tamper interrupt.
Parameters:
__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the RTC
Tamper interrupt sources to be enabled.
This parameter can be any combination
of the following values:
RTC_IT_TAMP: Tamper interrupt
Return value:
None
__HAL_RTC_TAMPER_DISABLE_IT
Description:
Disable the RTC Tamper interrupt.
Parameters:
__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the RTC
Tamper interrupt sources to be
disabled. This parameter can be any
combination of the following values:
RTC_IT_TAMP: Tamper interrupt
Return value:
None
__HAL_RTC_TAMPER_GET_IT
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: Tamper1
interrupt
RTC_IT_TAMP2: Tamper2
interrupt
RTC_IT_TAMP3: Tamper3
interrupt
400/1320
DocID026525 Rev 6
UM1785
HAL RTC Extension Driver
Return value:
None
__HAL_RTC_TAMPER_GET_IT_SOURCE
Description:
Check whether the specified RTC
Tamper interrupt has been enabled or
not.
Parameters:
__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the RTC
Tamper interrupt source to check. This
parameter can be:
RTC_IT_TAMP: Tamper interrupt
Return value:
None
Description:
__HAL_RTC_TAMPER_GET_FLAG
Get the selected RTC Tamper's flag
status.
Parameters:
__HANDLE__: specifies the RTC
handle.
__FLAG__: specifies the RTC Tamper
Flag is pending or not. This parameter
can be:
RTC_FLAG_TAMP1F
RTC_FLAG_TAMP2F
RTC_FLAG_TAMP3F
Return value:
None
__HAL_RTC_TAMPER_CLEAR_FLAG
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
RTC_FLAG_TAMP2F
RTC_FLAG_TAMP3F
Return value:
None
RTCEx Tamper Filter Definition
RTC_TAMPERFILTER_DISABLE
Tamper filter is disabled
DocID026525 Rev 6
401/1320
HAL RTC Extension Driver
RTC_TAMPERFILTER_2SAMPLE
UM1785
Tamper is activated after 2 consecutive samples at
the active level
RTC_TAMPERFILTER_4SAMPLE
Tamper is activated after 4 consecutive samples at
the active level
RTC_TAMPERFILTER_8SAMPLE
Tamper is activated after 8 consecutive samples at
the active level.
RTCEx Tamper Pins Definition
RTC_TAMPER_1
RTC_TAMPER_2
RTC_TAMPER_3
RTCEx Tamper Pin Precharge Duration Definition
RTC_TAMPERPRECHARGEDURATION_1RTCCLK
Tamper pins are pre-charged
before sampling during 1 RTCCLK
cycle
RTC_TAMPERPRECHARGEDURATION_2RTCCLK
Tamper pins are pre-charged
before sampling during 2 RTCCLK
cycles
RTC_TAMPERPRECHARGEDURATION_4RTCCLK
Tamper pins are pre-charged
before sampling during 4 RTCCLK
cycles
RTC_TAMPERPRECHARGEDURATION_8RTCCLK
Tamper pins are pre-charged
before sampling during 8 RTCCLK
cycles
RTCEx Tamper Pull UP Definition
RTC_TAMPER_PULLUP_ENABLE
Tamper pins are pre-charged before sampling
RTC_TAMPER_PULLUP_DISABLE
Tamper pins are not pre-charged before sampling
RTCEx Tamper Sampling Frequencies Definition
402/1320
RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV32768
Each of the tamper inputs are
sampled with a frequency =
RTCCLK / 32768
RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV16384
Each of the tamper inputs are
sampled with a frequency =
RTCCLK / 16384
RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV8192
Each of the tamper inputs are
sampled with a frequency =
RTCCLK / 8192
RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV4096
Each of the tamper inputs are
sampled with a frequency =
RTCCLK / 4096
RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV2048
Each of the tamper inputs are
sampled with a frequency =
RTCCLK / 2048
RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV1024
Each of the tamper inputs are
sampled with a frequency =
DocID026525 Rev 6
UM1785
HAL RTC Extension Driver
RTCCLK / 1024
RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV512
Each of the tamper inputs are
sampled with a frequency =
RTCCLK / 512
RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV256
Each of the tamper inputs are
sampled with a frequency =
RTCCLK / 256
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:
None
__HAL_RTC_TAMPER_TIMESTAMP_EXTI_DISABLE_
IT
Description:
Disable interrupt on the
RTC Tamper and
Timestamp associated Exti
line.
Return value:
None
__HAL_RTC_TAMPER_TIMESTAMP_EXTI_ENABLE_
EVENT
Description:
Enable event on the RTC
Tamper and Timestamp
associated Exti line.
Return value:
None.
__HAL_RTC_TAMPER_TIMESTAMP_EXTI_DISABLE_
EVENT
Description:
Disable event on the RTC
Tamper and Timestamp
associated Exti line.
Return value:
None.
__HAL_RTC_TAMPER_TIMESTAMP_EXTI_ENABLE_
FALLING_EDGE
Description:
Enable falling edge trigger
on the RTC Tamper and
Timestamp associated Exti
line.
Return value:
None.
DocID026525 Rev 6
403/1320
HAL RTC Extension Driver
__HAL_RTC_TAMPER_TIMESTAMP_EXTI_DISABLE_
FALLING_EDGE
UM1785
Description:
Disable falling edge trigger
on the RTC Tamper and
Timestamp associated Exti
line.
Return value:
None.
__HAL_RTC_TAMPER_TIMESTAMP_EXTI_ENABLE_
RISING_EDGE
Description:
Enable rising edge trigger
on the RTC Tamper and
Timestamp associated Exti
line.
Return value:
None.
__HAL_RTC_TAMPER_TIMESTAMP_EXTI_DISABLE_
RISING_EDGE
Description:
Disable rising edge trigger
on the RTC Tamper and
Timestamp associated Exti
line.
Return value:
None.
__HAL_RTC_TAMPER_TIMESTAMP_EXTI_ENABLE_
RISING_FALLING_EDGE
Description:
Enable rising & falling
edge trigger on the RTC
Tamper and Timestamp
associated Exti line.
Return value:
None.
__HAL_RTC_TAMPER_TIMESTAMP_EXTI_DISABLE_
RISING_FALLING_EDGE
Description:
Disable rising & falling
edge trigger on the RTC
Tamper and Timestamp
associated Exti line.
Return value:
None.
__HAL_RTC_TAMPER_TIMESTAMP_EXTI_GET_
FLAG
Description:
Check whether the RTC
Tamper and Timestamp
associated Exti line
interrupt flag is set or not.
Return value:
Line: Status.
404/1320
DocID026525 Rev 6
UM1785
HAL RTC Extension Driver
Description:
__HAL_RTC_TAMPER_TIMESTAMP_EXTI_CLEAR_
FLAG
Clear the RTC Tamper and
Timestamp associated Exti
line flag.
Return value:
None.
Description:
__HAL_RTC_TAMPER_TIMESTAMP_EXTI_
GENERATE_SWIT
Generate a Software
interrupt on the RTC
Tamper and Timestamp
associated Exti line.
Return value:
None.
RTCEx Tamper TimeStampOnTamperDetection Definition
RTC_TIMESTAMPONTAMPERDETECTION_ENABLE
TimeStamp on Tamper
Detection event saved
RTC_TIMESTAMPONTAMPERDETECTION_DISABLE
TimeStamp on Tamper
Detection event is not saved
RTCEx Tamper Trigger Definition
RTC_TAMPERTRIGGER_RISINGEDGE
RTC_TAMPERTRIGGER_FALLINGEDGE
RTC_TAMPERTRIGGER_LOWLEVEL
RTC_TAMPERTRIGGER_HIGHLEVEL
RTC Timestamp
__HAL_RTC_TIMESTAMP_ENABLE
Description:
Enable the RTC TimeStamp
peripheral.
Parameters:
__HANDLE__: specifies the RTC
handle.
Return value:
None
__HAL_RTC_TIMESTAMP_DISABLE
Description:
Disable the RTC TimeStamp
peripheral.
Parameters:
__HANDLE__: specifies the RTC
handle.
Return value:
None
DocID026525 Rev 6
405/1320
HAL RTC Extension Driver
__HAL_RTC_TIMESTAMP_ENABLE_IT
UM1785
Description:
Enable the RTC TimeStamp
interrupt.
Parameters:
__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the
RTC TimeStamp interrupt source to
be enabled. This parameter can be:
RTC_IT_TS: TimeStamp
interrupt
Return value:
None
__HAL_RTC_TIMESTAMP_DISABLE_IT
Description:
Disable the RTC TimeStamp
interrupt.
Parameters:
__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the
RTC TimeStamp interrupt source to
be disabled. This parameter can be:
RTC_IT_TS: TimeStamp
interrupt
Return value:
None
__HAL_RTC_TIMESTAMP_GET_IT
Description:
Check whether the specified RTC
TimeStamp interrupt has occurred
or not.
Parameters:
__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the
RTC TimeStamp interrupt to check.
This parameter can be:
RTC_IT_TS: TimeStamp
interrupt
Return value:
None
__HAL_RTC_TIMESTAMP_GET_IT_SOURCE
Description:
Check whether the specified RTC
Time Stamp interrupt has been
enabled or not.
406/1320
DocID026525 Rev 6
UM1785
HAL RTC Extension Driver
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:
None
__HAL_RTC_TIMESTAMP_GET_FLAG
Description:
Get the selected RTC TimeStamp's
flag status.
Parameters:
__HANDLE__: specifies the RTC
handle.
__FLAG__: specifies the RTC
TimeStamp Flag is pending or not.
This parameter can be:
RTC_FLAG_TSF
RTC_FLAG_TSOVF
Return value:
None
__HAL_RTC_TIMESTAMP_CLEAR_FLAG
Description:
Clear the RTC Time Stamp's
pending flags.
Parameters:
__HANDLE__: specifies the RTC
handle.
__FLAG__: specifies the RTC Alarm
Flag to clear. This parameter can
be:
RTC_FLAG_TSF
Return value:
None
RTCEx TimeStamp Pin Selection
RTC_TIMESTAMPPIN_DEFAULT
RTCEx Time Stamp Edges definition
RTC_TIMESTAMPEDGE_RISING
RTC_TIMESTAMPEDGE_FALLING
DocID026525 Rev 6
407/1320
HAL RTC Extension Driver
RTC WakeUp Timer
UM1785
__HAL_RTC_WAKEUPTIMER_ENABLE
Description:
Enable the RTC WakeUp Timer
peripheral.
Parameters:
__HANDLE__: specifies the RTC
handle.
Return value:
None
__HAL_RTC_WAKEUPTIMER_DISABLE
Description:
Disable the RTC WakeUp Timer
peripheral.
Parameters:
__HANDLE__: specifies the RTC
handle.
Return value:
None
__HAL_RTC_WAKEUPTIMER_ENABLE_IT
Description:
Enable the RTC WakeUpTimer
interrupt.
Parameters:
__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the
RTC WakeUpTimer interrupt
sources to be enabled. This
parameter can be:
RTC_IT_WUT:
WakeUpTimer interrupt
Return value:
None
__HAL_RTC_WAKEUPTIMER_DISABLE_IT
Description:
Disable the RTC WakeUpTimer
interrupt.
Parameters:
__HANDLE__: specifies the RTC
handle.
__INTERRUPT__: specifies the
RTC WakeUpTimer interrupt
sources to be disabled. This
parameter can be:
RTC_IT_WUT:
WakeUpTimer interrupt
408/1320
DocID026525 Rev 6
UM1785
HAL RTC Extension Driver
Return value:
None
__HAL_RTC_WAKEUPTIMER_GET_IT
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 interrupt
Return value:
None
__HAL_RTC_WAKEUPTIMER_GET_IT_
SOURCE
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:
None
__HAL_RTC_WAKEUPTIMER_GET_FLAG
Description:
Get the selected RTC
WakeUpTimer's flag status.
Parameters:
__HANDLE__: specifies the RTC
handle.
__FLAG__: specifies the RTC
WakeUpTimer Flag is pending or
not. This parameter can be:
RTC_FLAG_WUTF
RTC_FLAG_WUTWF
Return value:
None
DocID026525 Rev 6
409/1320
HAL RTC Extension Driver
__HAL_RTC_WAKEUPTIMER_CLEAR_FLAG
UM1785
Description:
Clear the RTC Wake Up timer's
pending flags.
Parameters:
__HANDLE__: specifies the RTC
handle.
__FLAG__: specifies the RTC
WakeUpTimer Flag to clear. This
parameter can be:
RTC_FLAG_WUTF
Return value:
None
__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_
IT
Description:
Enable interrupt on the RTC
WakeUp Timer associated Exti
line.
Return value:
None
__HAL_RTC_WAKEUPTIMER_EXTI_DISABLE
_IT
Description:
Disable interrupt on the RTC
WakeUp Timer associated Exti
line.
Return value:
None
__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_
EVENT
Description:
Enable event on the RTC WakeUp
Timer associated Exti line.
Return value:
None.
__HAL_RTC_WAKEUPTIMER_EXTI_DISABLE
_EVENT
Description:
Disable event on the RTC
WakeUp Timer associated Exti
line.
Return value:
None.
__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_
FALLING_EDGE
Description:
Enable falling edge trigger on the
RTC WakeUp Timer associated
Exti line.
Return value:
None.
410/1320
DocID026525 Rev 6
UM1785
__HAL_RTC_WAKEUPTIMER_EXTI_DISABLE
_FALLING_EDGE
HAL RTC Extension Driver
Description:
Disable falling edge trigger on the
RTC WakeUp Timer associated
Exti line.
Return value:
None.
__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_
RISING_EDGE
Description:
Enable rising edge trigger on the
RTC WakeUp Timer associated
Exti line.
Return value:
None.
__HAL_RTC_WAKEUPTIMER_EXTI_DISABLE
_RISING_EDGE
Description:
Disable rising edge trigger on the
RTC WakeUp Timer associated
Exti line.
Return value:
None.
__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_
RISING_FALLING_EDGE
Description:
Enable rising & falling edge trigger
on the RTC WakeUp Timer
associated Exti line.
Return value:
None.
__HAL_RTC_WAKEUPTIMER_EXTI_DISABLE
_RISING_FALLING_EDGE
Description:
Disable rising & falling edge
trigger on the RTC WakeUp Timer
associated Exti line.
Return value:
None.
__HAL_RTC_WAKEUPTIMER_EXTI_GET_
FLAG
Description:
Check whether the RTC WakeUp
Timer associated Exti line interrupt
flag is set or not.
Return value:
Line: Status.
__HAL_RTC_WAKEUPTIMER_EXTI_CLEAR_
FLAG
DocID026525 Rev 6
Description:
Clear the RTC WakeUp Timer
associated Exti line flag.
411/1320
HAL RTC Extension Driver
UM1785
Return value:
None.
__HAL_RTC_WAKEUPTIMER_EXTI_GENERA
TE_SWIT
Description:
Generate a Software interrupt on
the RTC WakeUp Timer
associated Exti line.
Return value:
None.
RTCEx Wakeup Timer Definition
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
412/1320
DocID026525 Rev 6
UM1785
HAL SMARTCARD Generic Driver
36
HAL SMARTCARD Generic Driver
36.1
SMARTCARD Firmware driver registers structures
36.1.1
SMARTCARD_InitTypeDef
Data Fields
uint32_t BaudRate
uint32_t WordLength
uint32_t StopBits
uint16_t Parity
uint16_t Mode
uint16_t CLKPolarity
uint16_t CLKPhase
uint16_t CLKLastBit
uint16_t OneBitSampling
uint8_t Prescaler
uint8_t GuardTime
uint16_t NACKEnable
uint32_t TimeOutEnable
uint32_t TimeOutValue
uint8_t BlockLength
uint8_t AutoRetryCount
Field Documentation
uint32_t SMARTCARD_InitTypeDef::BaudRate
Configures the SmartCard communication baud rate. The baud rate register is
computed using the following formula: Baud Rate Register = ((PCLKx) / ((hsmartcard>Init.BaudRate)))
uint32_t SMARTCARD_InitTypeDef::WordLength
Specifies the number of data bits transmitted or received in a frame. This parameter
SMARTCARD_Word_Length can only be set to 9 (8 data + 1 parity bits).
uint32_t SMARTCARD_InitTypeDef::StopBits
Specifies the number of stop bits. This parameter can be a value of
SMARTCARD_Stop_Bits.
uint16_t SMARTCARD_InitTypeDef::Parity
Specifies the parity mode. This parameter can be a value of SMARTCARD_Parity
Note:The parity is enabled by default (PCE is forced to 1). Since the WordLength is
forced to 8 bits + parity, M is forced to 1 and the parity bit is the 9th bit.
uint16_t SMARTCARD_InitTypeDef::Mode
Specifies whether the Receive or Transmit mode is enabled or disabled. This
parameter can be a value of SMARTCARD_Mode
uint16_t SMARTCARD_InitTypeDef::CLKPolarity
Specifies the steady state of the serial clock. This parameter can be a value of
SMARTCARD_Clock_Polarity
uint16_t SMARTCARD_InitTypeDef::CLKPhase
Specifies the clock transition on which the bit capture is made. This parameter can be
a value of SMARTCARD_Clock_Phase
uint16_t SMARTCARD_InitTypeDef::CLKLastBit
Specifies whether the clock pulse corresponding to the last transmitted data bit (MSB)
DocID026525 Rev 6
413/1320
HAL SMARTCARD Generic Driver
UM1785
has to be output on the SCLK pin in synchronous mode. This parameter can be a
value of SMARTCARD_Last_Bit
uint16_t SMARTCARD_InitTypeDef::OneBitSampling
Specifies whether a single sample or three samples' majority vote is selected.
Selecting the single sample method increases the receiver tolerance to clock
deviations. This parameter can be a value of SMARTCARD_OneBit_Sampling.
uint8_t SMARTCARD_InitTypeDef::Prescaler
Specifies the SmartCard Prescaler.
uint8_t SMARTCARD_InitTypeDef::GuardTime
Specifies the SmartCard Guard Time applied after stop bits.
uint16_t SMARTCARD_InitTypeDef::NACKEnable
Specifies whether the SmartCard NACK transmission is enabled in case of parity
error. This parameter can be a value of SMARTCARD_NACK_Enable
uint32_t SMARTCARD_InitTypeDef::TimeOutEnable
Specifies whether the receiver timeout is enabled. This parameter can be a value of
SMARTCARD_Timeout_Enable
uint32_t SMARTCARD_InitTypeDef::TimeOutValue
Specifies the receiver time out value in number of baud blocks: it is used to implement
the Character Wait Time (CWT) and Block Wait Time (BWT). It is coded over 24 bits.
uint8_t SMARTCARD_InitTypeDef::BlockLength
Specifies the SmartCard Block Length in T=1 Reception mode. This parameter can be
any value from 0x0 to 0xFF
uint8_t SMARTCARD_InitTypeDef::AutoRetryCount
Specifies the SmartCard auto-retry count (number of retries in receive and transmit
mode). When set to 0, retransmission is disabled. Otherwise, its maximum value is 7
(before signalling an error)
36.1.2
SMARTCARD_AdvFeatureInitTypeDef
Data Fields
uint32_t AdvFeatureInit
uint32_t TxPinLevelInvert
uint32_t RxPinLevelInvert
uint32_t DataInvert
uint32_t Swap
uint32_t OverrunDisable
uint32_t DMADisableonRxError
uint32_t MSBFirst
Field Documentation
uint32_t SMARTCARD_AdvFeatureInitTypeDef::AdvFeatureInit
Specifies which advanced SMARTCARD features is initialized. Several advanced
features may be initialized at the same time. This parameter can be a value of
SMARTCARD_Advanced_Features_Initialization_Type
uint32_t SMARTCARD_AdvFeatureInitTypeDef::TxPinLevelInvert
Specifies whether the TX pin active level is inverted. This parameter can be a value of
SMARTCARD_Tx_Inv
uint32_t SMARTCARD_AdvFeatureInitTypeDef::RxPinLevelInvert
Specifies whether the RX pin active level is inverted. This parameter can be a value of
SMARTCARD_Rx_Inv
uint32_t SMARTCARD_AdvFeatureInitTypeDef::DataInvert
Specifies whether data are inverted (positive/direct logic vs negative/inverted logic).
This parameter can be a value of SMARTCARD_Data_Inv
414/1320
DocID026525 Rev 6
UM1785
HAL SMARTCARD Generic Driver
uint32_t SMARTCARD_AdvFeatureInitTypeDef::Swap
Specifies whether TX and RX pins are swapped. This parameter can be a value of
SMARTCARD_Rx_Tx_Swap
uint32_t SMARTCARD_AdvFeatureInitTypeDef::OverrunDisable
Specifies whether the reception overrun detection is disabled. This parameter can be
a value of SMARTCARD_Overrun_Disable
uint32_t SMARTCARD_AdvFeatureInitTypeDef::DMADisableonRxError
Specifies whether the DMA is disabled in case of reception error. This parameter can
be a value of SMARTCARD_DMA_Disable_on_Rx_Error
uint32_t SMARTCARD_AdvFeatureInitTypeDef::MSBFirst
Specifies whether MSB is sent first on UART line. This parameter can be a value of
SMARTCARD_MSB_First
36.1.3
SMARTCARD_HandleTypeDef
Data Fields
USART_TypeDef * Instance
SMARTCARD_InitTypeDef Init
SMARTCARD_AdvFeatureInitTypeDef AdvancedInit
uint8_t * pTxBuffPtr
uint16_t TxXferSize
__IO uint16_t TxXferCount
uint8_t * pRxBuffPtr
uint16_t RxXferSize
__IO uint16_t RxXferCount
DMA_HandleTypeDef * hdmatx
DMA_HandleTypeDef * hdmarx
HAL_LockTypeDef Lock
__IO HAL_SMARTCARD_StateTypeDef gState
__IO HAL_SMARTCARD_StateTypeDef RxState
__IO uint32_t ErrorCode
Field Documentation
USART_TypeDef* SMARTCARD_HandleTypeDef::Instance
USART registers base address
SMARTCARD_InitTypeDef SMARTCARD_HandleTypeDef::Init
SmartCard communication parameters
SMARTCARD_AdvFeatureInitTypeDef
SMARTCARD_HandleTypeDef::AdvancedInit
SmartCard advanced features initialization parameters
uint8_t* SMARTCARD_HandleTypeDef::pTxBuffPtr
Pointer to SmartCard Tx transfer Buffer
uint16_t SMARTCARD_HandleTypeDef::TxXferSize
SmartCard Tx Transfer size
__IO uint16_t SMARTCARD_HandleTypeDef::TxXferCount
SmartCard Tx Transfer Counter
uint8_t* SMARTCARD_HandleTypeDef::pRxBuffPtr
Pointer to SmartCard Rx transfer Buffer
uint16_t SMARTCARD_HandleTypeDef::RxXferSize
SmartCard Rx Transfer size
__IO uint16_t SMARTCARD_HandleTypeDef::RxXferCount
SmartCard Rx Transfer Counter
DMA_HandleTypeDef* SMARTCARD_HandleTypeDef::hdmatx
SmartCard Tx DMA Handle parameters
DocID026525 Rev 6
415/1320
HAL SMARTCARD Generic Driver
UM1785
DMA_HandleTypeDef* SMARTCARD_HandleTypeDef::hdmarx
SmartCard Rx DMA Handle parameters
HAL_LockTypeDef SMARTCARD_HandleTypeDef::Lock
Locking object
__IO HAL_SMARTCARD_StateTypeDef SMARTCARD_HandleTypeDef::gState
SmartCard state information related to global Handle management and also related to
Tx operations. This parameter can be a value of HAL_SMARTCARD_StateTypeDef
__IO HAL_SMARTCARD_StateTypeDef SMARTCARD_HandleTypeDef::RxState
SmartCard state information related to Rx operations. This parameter can be a value
of HAL_SMARTCARD_StateTypeDef
__IO uint32_t SMARTCARD_HandleTypeDef::ErrorCode
SmartCard Error code This parameter can be a value of SMARTCARD_Error
36.2
SMARTCARD Firmware driver API description
36.2.1
How to use this driver
The SMARTCARD HAL driver can be used as follows:
1.
2.
3.
4.
5.
6.
416/1320
Declare a SMARTCARD_HandleTypeDef handle structure (eg.
SMARTCARD_HandleTypeDef hsmartcard).
Associate a USART to the SMARTCARD handle hsmartcard.
Initialize the SMARTCARD low level resources by implementing the
HAL_SMARTCARD_MspInit() API:
Enable the USARTx interface clock.
USART pins configuration:
Enable the clock for the USART GPIOs.
Configure the USART pins (TX as alternate function pull-up, RX as alternate
function Input).
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.
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 channel.
Enable the DMAx interface clock.
Configure the declared DMA handle structure with the required Tx/Rx
parameters.
Configure the DMA Tx/Rx channel.
Associate the 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 channel.
Program the Baud Rate, Parity, Mode(Receiver/Transmitter), clock enabling/disabling
and accordingly, the clock parameters (parity, phase, last bit), prescaler value, guard
time and NACK on transmission error enabling or disabling in the hsmartcard handle
Init structure.
If required, program SMARTCARD advanced features (TX/RX pins swap, TimeOut,
auto-retry counter,...) in the hsmartcard handle AdvancedInit structure.
Initialize the SMARTCARD registers by calling the HAL_SMARTCARD_Init() API:
This API configures also the low level Hardware (GPIO, CLOCK, CORTEX...etc)
by calling the customized HAL_SMARTCARD_MspInit() API.
DocID026525 Rev 6
UM1785
HAL SMARTCARD Generic Driver
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()
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_GET_FLAG : Check whether or not the specified
SMARTCARD flag is set
__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
DocID026525 Rev 6
417/1320
HAL SMARTCARD Generic Driver
UM1785
__HAL_SMARTCARD_GET_IT_SOURCE: Check whether or not the specified
SMARTCARD interrupt is enabled
You can refer to the SMARTCARD HAL driver header file for more useful macros
36.2.2
Initialization and Configuration functions
This subsection provides a set of functions allowing to initialize the USARTx associated to
the SmartCard.
The Smartcard interface is designed to support asynchronous protocol Smartcards as
defined in the ISO 7816-3 standard.
The USART can provide a clock to the smartcard through the SCLK output. In smartcard
mode, SCLK is not associated to the communication but is simply derived from the internal
peripheral input clock through a 5-bit prescaler.
These parameters can be configured:
Baud Rate
Parity: should be enabled
Receiver/transmitter modes
Synchronous mode (and if enabled, phase, polarity and last bit parameters)
Prescaler value
Guard bit time
NACK enabling or disabling on transmission error
The following advanced features can be configured as well:
TX and/or RX pin level inversion
data logical level inversion
RX and TX pins swap
RX overrun detection disabling
DMA disabling on RX error
MSB first on communication line
Time out enabling (and if activated, timeout value)
Block length
Auto-retry counter
The HAL_SMARTCARD_Init() API follows the USART synchronous configuration
procedures (details for the procedures are available in reference manual).
This section contains the following APIs:
HAL_SMARTCARD_Init()
HAL_SMARTCARD_DeInit()
HAL_SMARTCARD_MspInit()
HAL_SMARTCARD_MspDeInit()
36.2.3
IO operation functions
This subsection provides a set of functions allowing to manage the SMARTCARD data
transfers.
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:
418/1320
DocID026525 Rev 6
UM1785
HAL SMARTCARD Generic Driver
1.
2.
3.
4.
5.
6.
7.
8.
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,
the relevant API's return the HAL status. The end of the data processing will be
indicated through the dedicated SMARTCARD IRQ when using Interrupt mode or
the DMA IRQ when using DMA mode.
The HAL_SMARTCARD_TxCpltCallback(),
HAL_SMARTCARD_RxCpltCallback() user callbacks will be executed
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()
Non-Blocking mode transfers could be aborted using Abort API's :
HAL_SMARTCARD_Abort()
HAL_SMARTCARD_AbortTransmit()
HAL_SMARTCARD_AbortReceive()
HAL_SMARTCARD_Abort_IT()
HAL_SMARTCARD_AbortTransmit_IT()
HAL_SMARTCARD_AbortReceive_IT()
For Abort services based on interrupts (HAL_SMARTCARD_Abortxxx_IT), a set of
Abort Complete Callbacks are provided:
HAL_SMARTCARD_AbortCpltCallback()
HAL_SMARTCARD_AbortTransmitCpltCallback()
HAL_SMARTCARD_AbortReceiveCpltCallback()
In Non-Blocking mode transfers, possible errors are split into 2 categories. Errors are
handled as follows :
Error is considered as Recoverable and non blocking : Transfer could go till end,
but error severity is to be evaluated by user : this concerns Frame Error, Parity
Error or Noise Error in Interrupt mode reception . Received character is then
retrieved and stored in Rx buffer, Error code is set to allow user to identify error
type, and HAL_SMARTCARD_ErrorCallback() user callback is executed.
Transfer is kept ongoing on SMARTCARD side. If user wants to abort it, Abort
services should be called by user.
Error is considered as Blocking : Transfer could not be completed properly and is
aborted. This concerns Frame Error in Interrupt mode tranmission, Overrun Error
in Interrupt mode reception and all errors in DMA mode. Error code is set to allow
DocID026525 Rev 6
419/1320
HAL SMARTCARD Generic Driver
UM1785
user to identify error type, and HAL_SMARTCARD_ErrorCallback() user callback
is executed.
This section contains the following APIs:
HAL_SMARTCARD_Transmit()
HAL_SMARTCARD_Receive()
HAL_SMARTCARD_Transmit_IT()
HAL_SMARTCARD_Receive_IT()
HAL_SMARTCARD_Transmit_DMA()
HAL_SMARTCARD_Receive_DMA()
HAL_SMARTCARD_Abort()
HAL_SMARTCARD_AbortTransmit()
HAL_SMARTCARD_AbortReceive()
HAL_SMARTCARD_Abort_IT()
HAL_SMARTCARD_AbortTransmit_IT()
HAL_SMARTCARD_AbortReceive_IT()
HAL_SMARTCARD_IRQHandler()
HAL_SMARTCARD_TxCpltCallback()
HAL_SMARTCARD_RxCpltCallback()
HAL_SMARTCARD_ErrorCallback()
HAL_SMARTCARD_AbortCpltCallback()
HAL_SMARTCARD_AbortTransmitCpltCallback()
HAL_SMARTCARD_AbortReceiveCpltCallback()
36.2.4
Peripheral State and Errors functions
This subsection provides a set of functions allowing to return the State of SmartCard
handle and also return Peripheral Errors occurred during communication process
HAL_SMARTCARD_GetState() API can be helpful to check in run-time the state of
the SMARTCARD peripheral.
HAL_SMARTCARD_GetError() checks in run-time errors that could occur during
communication.
This section contains the following APIs:
HAL_SMARTCARD_GetState()
HAL_SMARTCARD_GetError()
36.2.5
Detailed description of functions
HAL_SMARTCARD_Init
420/1320
Function name
HAL_StatusTypeDef HAL_SMARTCARD_Init
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
Initialize the SMARTCARD mode according to the specified
parameters in the SMARTCARD_HandleTypeDef and initialize the
associated handle.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
HAL: status
DocID026525 Rev 6
UM1785
HAL SMARTCARD Generic Driver
HAL_SMARTCARD_DeInit
Function name
HAL_StatusTypeDef HAL_SMARTCARD_DeInit
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
DeInitialize the SMARTCARD peripheral.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
HAL: status
HAL_SMARTCARD_MspInit
Function name
void HAL_SMARTCARD_MspInit
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
Initialize the SMARTCARD MSP.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
None
HAL_SMARTCARD_MspDeInit
Function name
void HAL_SMARTCARD_MspDeInit
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
DeInitialize the SMARTCARD MSP.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
None
HAL_SMARTCARD_Transmit
Function name
HAL_StatusTypeDef HAL_SMARTCARD_Transmit
(SMARTCARD_HandleTypeDef * hsmartcard, uint8_t * pData,
uint16_t Size, uint32_t Timeout)
Function description
Send an amount of data in blocking mode.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
pData: pointer to data buffer.
Size: amount of data to be sent.
Timeout: Timeout duration.
Return values
HAL: status
HAL_SMARTCARD_Receive
Function name
HAL_StatusTypeDef HAL_SMARTCARD_Receive
(SMARTCARD_HandleTypeDef * hsmartcard, uint8_t * pData,
DocID026525 Rev 6
421/1320
HAL SMARTCARD Generic Driver
UM1785
uint16_t Size, uint32_t Timeout)
Function description
Receive an amount of data in blocking mode.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
pData: pointer to data buffer.
Size: amount of data to be received.
Timeout: Timeout duration.
Return values
HAL: status
HAL_SMARTCARD_Transmit_IT
Function name
HAL_StatusTypeDef HAL_SMARTCARD_Transmit_IT
(SMARTCARD_HandleTypeDef * hsmartcard, uint8_t * pData,
uint16_t Size)
Function description
Send an amount of data in interrupt mode.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
pData: pointer to data buffer.
Size: amount of data to be sent.
Return values
HAL: status
HAL_SMARTCARD_Receive_IT
Function name
HAL_StatusTypeDef HAL_SMARTCARD_Receive_IT
(SMARTCARD_HandleTypeDef * hsmartcard, uint8_t * pData,
uint16_t Size)
Function description
Receive an amount of data in interrupt mode.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
pData: pointer to data buffer.
Size: amount of data to be received.
Return values
HAL: status
HAL_SMARTCARD_Transmit_DMA
Function name
HAL_StatusTypeDef HAL_SMARTCARD_Transmit_DMA
(SMARTCARD_HandleTypeDef * hsmartcard, uint8_t * pData,
uint16_t Size)
Function description
Send an amount of data in DMA mode.
Parameters
422/1320
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
pData: pointer to data buffer.
Size: amount of data to be sent.
DocID026525 Rev 6
UM1785
HAL SMARTCARD Generic Driver
Return values
HAL: status
HAL_SMARTCARD_Receive_DMA
Function name
HAL_StatusTypeDef HAL_SMARTCARD_Receive_DMA
(SMARTCARD_HandleTypeDef * hsmartcard, uint8_t * pData,
uint16_t Size)
Function description
Receive an amount of data in DMA mode.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
pData: pointer to data buffer.
Size: amount of data to be received.
Return values
HAL: status
Notes
The SMARTCARD-associated USART parity is enabled (PCE
= 1), the received data contain the parity bit (MSB position).
HAL_SMARTCARD_Abort
Function name
HAL_StatusTypeDef HAL_SMARTCARD_Abort
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
Abort ongoing transfers (blocking mode).
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable SMARTCARD
Interrupts (Tx and Rx)Disable the DMA transfer in the
peripheral register (if enabled)Abort DMA transfer by calling
HAL_DMA_Abort (in case of transfer in DMA mode)Set
handle State to READY
This procedure is executed in blocking mode : when exiting
function, Abort is considered as completed.
HAL_SMARTCARD_AbortTransmit
Function name
HAL_StatusTypeDef HAL_SMARTCARD_AbortTransmit
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
Abort ongoing Transmit transfer (blocking mode).
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing Tx
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable SMARTCARD
DocID026525 Rev 6
423/1320
HAL SMARTCARD Generic Driver
UM1785
Interrupts (Tx)Disable the DMA transfer in the peripheral
register (if enabled)Abort DMA transfer by calling
HAL_DMA_Abort (in case of transfer in DMA mode)Set
handle State to READY
This procedure is executed in blocking mode : when exiting
function, Abort is considered as completed.
HAL_SMARTCARD_AbortReceive
Function name
HAL_StatusTypeDef HAL_SMARTCARD_AbortReceive
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
Abort ongoing Receive transfer (blocking mode).
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing Rx
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable SMARTCARD
Interrupts (Rx)Disable the DMA transfer in the peripheral
register (if enabled)Abort DMA transfer by calling
HAL_DMA_Abort (in case of transfer in DMA mode)Set
handle State to READY
This procedure is executed in blocking mode : when exiting
function, Abort is considered as completed.
HAL_SMARTCARD_Abort_IT
424/1320
Function name
HAL_StatusTypeDef HAL_SMARTCARD_Abort_IT
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
Abort ongoing transfers (Interrupt mode).
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable SMARTCARD
Interrupts (Tx and Rx)Disable the DMA transfer in the
peripheral register (if enabled)Abort DMA transfer by calling
HAL_DMA_Abort_IT (in case of transfer in DMA mode)Set
handle State to READYAt abort completion, call user abort
complete callback
This procedure is executed in Interrupt mode, meaning that
abort procedure could be considered as completed only when
user abort complete callback is executed (not when exiting
function).
DocID026525 Rev 6
UM1785
HAL SMARTCARD Generic Driver
HAL_SMARTCARD_AbortTransmit_IT
Function name
HAL_StatusTypeDef HAL_SMARTCARD_AbortTransmit_IT
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
Abort ongoing Transmit transfer (Interrupt mode).
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing Tx
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable SMARTCARD
Interrupts (Tx)Disable the DMA transfer in the peripheral
register (if enabled)Abort DMA transfer by calling
HAL_DMA_Abort_IT (in case of transfer in DMA mode)Set
handle State to READYAt abort completion, call user abort
complete callback
This procedure is executed in Interrupt mode, meaning that
abort procedure could be considered as completed only when
user abort complete callback is executed (not when exiting
function).
HAL_SMARTCARD_AbortReceive_IT
Function name
HAL_StatusTypeDef HAL_SMARTCARD_AbortReceive_IT
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
Abort ongoing Receive transfer (Interrupt mode).
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing Rx
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable SMARTCARD
Interrupts (Rx)Disable the DMA transfer in the peripheral
register (if enabled)Abort DMA transfer by calling
HAL_DMA_Abort_IT (in case of transfer in DMA mode)Set
handle State to READYAt abort completion, call user abort
complete callback
This procedure is executed in Interrupt mode, meaning that
abort procedure could be considered as completed only when
user abort complete callback is executed (not when exiting
function).
HAL_SMARTCARD_IRQHandler
Function name
void HAL_SMARTCARD_IRQHandler
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
Handle SMARTCARD interrupt requests.
DocID026525 Rev 6
425/1320
HAL SMARTCARD Generic Driver
Parameters
Return values
UM1785
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
None
HAL_SMARTCARD_TxCpltCallback
Function name
void HAL_SMARTCARD_TxCpltCallback
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
Tx Transfer completed callback.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
None
HAL_SMARTCARD_RxCpltCallback
Function name
void HAL_SMARTCARD_RxCpltCallback
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
Rx Transfer completed callback.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
None
HAL_SMARTCARD_ErrorCallback
Function name
void HAL_SMARTCARD_ErrorCallback
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
SMARTCARD error callback.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
None
HAL_SMARTCARD_AbortCpltCallback
426/1320
Function name
void HAL_SMARTCARD_AbortCpltCallback
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
SMARTCARD Abort Complete callback.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
None
DocID026525 Rev 6
UM1785
HAL SMARTCARD Generic Driver
HAL_SMARTCARD_AbortTransmitCpltCallback
Function name
void HAL_SMARTCARD_AbortTransmitCpltCallback
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
SMARTCARD Abort Complete callback.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
None
HAL_SMARTCARD_AbortReceiveCpltCallback
Function name
void HAL_SMARTCARD_AbortReceiveCpltCallback
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
SMARTCARD Abort Receive Complete callback.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
None
HAL_SMARTCARD_GetState
Function name
HAL_SMARTCARD_StateTypeDef
HAL_SMARTCARD_GetState (SMARTCARD_HandleTypeDef *
hsmartcard)
Function description
Return the SMARTCARD handle state.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
SMARTCARD: handle state
HAL_SMARTCARD_GetError
Function name
uint32_t HAL_SMARTCARD_GetError
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
Return the SMARTCARD handle error code.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
SMARTCARD: handle Error Code
DocID026525 Rev 6
427/1320
HAL SMARTCARD Generic Driver
UM1785
36.3
SMARTCARD Firmware driver defines
36.3.1
SMARTCARD
SMARTCARD advanced feature initialization type
SMARTCARD_ADVFEATURE_NO_INIT
No advanced feature
initialization
SMARTCARD_ADVFEATURE_TXINVERT_INIT
TX pin active level
inversion
SMARTCARD_ADVFEATURE_RXINVERT_INIT
RX pin active level
inversion
SMARTCARD_ADVFEATURE_DATAINVERT_INIT
Binary data inversion
SMARTCARD_ADVFEATURE_SWAP_INIT
TX/RX pins swap
SMARTCARD_ADVFEATURE_RXOVERRUNDISABLE_INIT
RX overrun disable
SMARTCARD_ADVFEATURE_DMADISABLEONERROR_INIT
DMA disable on
Reception Error
SMARTCARD_ADVFEATURE_MSBFIRST_INIT
Most significant bit
sent/received first
SMARTCARD Clock Phase
SMARTCARD_PHASE_1EDGE
SMARTCARD frame phase on first clock transition
SMARTCARD_PHASE_2EDGE
SMARTCARD frame phase on second clock transition
SMARTCARD Clock Polarity
SMARTCARD_POLARITY_LOW
SMARTCARD frame low polarity
SMARTCARD_POLARITY_HIGH
SMARTCARD frame high polarity
SMARTCARD auto retry counter LSB position in CR3 register
SMARTCARD_CR3_SCARCNT_LSB_POS
SMARTCARD auto retry counter LSB
position in CR3 register
SMARTCARD advanced feature Binary Data inversion
SMARTCARD_ADVFEATURE_DATAINV_DISABLE
Binary data inversion disable
SMARTCARD_ADVFEATURE_DATAINV_ENABLE
Binary data inversion enable
SMARTCARD advanced feature DMA Disable on Rx Error
SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR
DMA enable on
Reception Error
SMARTCARD_ADVFEATURE_DMA_DISABLEONRXERROR
DMA disable on
Reception Error
SMARTCARD Error
428/1320
HAL_SMARTCARD_ERROR_NONE
No error
HAL_SMARTCARD_ERROR_PE
Parity error
HAL_SMARTCARD_ERROR_NE
Noise error
HAL_SMARTCARD_ERROR_FE
frame error
DocID026525 Rev 6
UM1785
HAL SMARTCARD Generic Driver
HAL_SMARTCARD_ERROR_ORE
Overrun error
HAL_SMARTCARD_ERROR_DMA
DMA transfer error
HAL_SMARTCARD_ERROR_RTO
Receiver TimeOut error
SMARTCARD Exported Macros
__HAL_SMARTCARD_RESET_HANDL
E_STATE
Description:
Reset SMARTCARD handle states.
Parameters:
__HANDLE__: SMARTCARD handle.
Return value:
None
__HAL_SMARTCARD_FLUSH_DR
REGISTER
Description:
Flush the Smartcard Data registers.
Parameters:
__HANDLE__: specifies the SMARTCARD
Handle.
Return value:
None
__HAL_SMARTCARD_CLEAR_FLAG
Description:
Clear the specified SMARTCARD pending
flag.
Parameters:
__HANDLE__: specifies the SMARTCARD
Handle.
__FLAG__: specifies the flag to check. This
parameter can be any combination of the
following values:
SMARTCARD_CLEAR_PEF Parity
error clear flag
SMARTCARD_CLEAR_FEF Framing
error clear flag
SMARTCARD_CLEAR_NEF Noise
detected clear flag
SMARTCARD_CLEAR_OREF
OverRun error clear flag
SMARTCARD_CLEAR_IDLEF Idle
line detected clear flag
SMARTCARD_CLEAR_TCF
Transmission complete clear flag
SMARTCARD_CLEAR_RTOF
Receiver timeout clear flag
SMARTCARD_CLEAR_EOBF End of
block clear flag
DocID026525 Rev 6
429/1320
HAL SMARTCARD Generic Driver
UM1785
Return value:
None
__HAL_SMARTCARD_CLEAR_PEFLA
G
Description:
Clear the SMARTCARD PE pending flag.
Parameters:
__HANDLE__: specifies the SMARTCARD
Handle.
Return value:
None
__HAL_SMARTCARD_CLEAR_FEFLA
G
Description:
Clear the SMARTCARD FE pending flag.
Parameters:
__HANDLE__: specifies the SMARTCARD
Handle.
Return value:
None
__HAL_SMARTCARD_CLEAR_NEFLA
G
Description:
Clear the SMARTCARD NE pending flag.
Parameters:
__HANDLE__: specifies the SMARTCARD
Handle.
Return value:
None
__HAL_SMARTCARD_CLEAR_ORE
FLAG
Description:
Clear the SMARTCARD ORE pending flag.
Parameters:
__HANDLE__: specifies the SMARTCARD
Handle.
Return value:
None
__HAL_SMARTCARD_CLEAR_IDLE
FLAG
Description:
Clear the SMARTCARD IDLE pending flag.
Parameters:
__HANDLE__: specifies the SMARTCARD
Handle.
Return value:
430/1320
DocID026525 Rev 6
UM1785
HAL SMARTCARD Generic Driver
None
__HAL_SMARTCARD_GET_FLAG
Description:
Check 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_REACK
Receive enable acknowledge flag
SMARTCARD_FLAG_TEACK
Transmit enable acknowledge flag
SMARTCARD_FLAG_BUSY Busy
flag
SMARTCARD_FLAG_EOBF End of
block flag
SMARTCARD_FLAG_RTOF Receiver
timeout flag
SMARTCARD_FLAG_TXE Transmit
data register empty flag
SMARTCARD_FLAG_TC
Transmission complete flag
SMARTCARD_FLAG_RXNE Receive
data register not empty flag
SMARTCARD_FLAG_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:
The: new state of __FLAG__ (TRUE or
FALSE).
__HAL_SMARTCARD_ENABLE_IT
Description:
Enable the specified SmartCard interrupt.
Parameters:
__HANDLE__: specifies the SMARTCARD
Handle.
__INTERRUPT__: specifies the
SMARTCARD interrupt to enable. This
parameter can be one of the following
values:
SMARTCARD_IT_EOB End of block
DocID026525 Rev 6
431/1320
HAL SMARTCARD Generic Driver
UM1785
interrupt
SMARTCARD_IT_RTO Receive
timeout interrupt
SMARTCARD_IT_TXE Transmit data
register empty interrupt
SMARTCARD_IT_TC Transmission
complete interrupt
SMARTCARD_IT_RXNE Receive
data register not empty interrupt
SMARTCARD_IT_IDLE Idle line
detection interrupt
SMARTCARD_IT_PE Parity error
interrupt
SMARTCARD_IT_ERR Error
interrupt(frame error, noise error,
overrun error)
Return value:
None
__HAL_SMARTCARD_DISABLE_IT
Description:
Disable the specified SmartCard interrupt.
Parameters:
__HANDLE__: specifies the SMARTCARD
Handle.
__INTERRUPT__: specifies the
SMARTCARD interrupt to disable. This
parameter can be one of the following
values:
SMARTCARD_IT_EOB End of block
interrupt
SMARTCARD_IT_RTO Receive
timeout interrupt
SMARTCARD_IT_TXE Transmit data
register empty interrupt
SMARTCARD_IT_TC Transmission
complete interrupt
SMARTCARD_IT_RXNE Receive
data register not empty interrupt
SMARTCARD_IT_IDLE Idle line
detection interrupt
SMARTCARD_IT_PE Parity error
interrupt
SMARTCARD_IT_ERR Error
interrupt(frame error, noise error,
overrun error)
Return value:
None
__HAL_SMARTCARD_GET_IT
Description:
Check whether the specified SmartCard
432/1320
DocID026525 Rev 6
UM1785
HAL SMARTCARD Generic Driver
interrupt has occurred or not.
Parameters:
__HANDLE__: specifies the SMARTCARD
Handle.
__IT__: specifies the SMARTCARD
interrupt to check. This parameter can be
one of the following values:
SMARTCARD_IT_EOB End of block
interrupt
SMARTCARD_IT_RTO Receive
timeout interrupt
SMARTCARD_IT_TXE Transmit data
register empty interrupt
SMARTCARD_IT_TC Transmission
complete interrupt
SMARTCARD_IT_RXNE Receive
data register not empty interrupt
SMARTCARD_IT_IDLE Idle line
detection interrupt
SMARTCARD_IT_ORE Overrun error
interrupt
SMARTCARD_IT_NE Noise error
interrupt
SMARTCARD_IT_FE Framing error
interrupt
SMARTCARD_IT_PE Parity error
interrupt
Return value:
The: new state of __IT__ (TRUE or
FALSE).
__HAL_SMARTCARD_GET_IT_
SOURCE
Description:
Check whether the specified SmartCard
interrupt source is enabled 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_EOB End of block
interrupt
SMARTCARD_IT_RTO Receive
timeout interrupt
SMARTCARD_IT_TXE Transmit data
register empty interrupt
SMARTCARD_IT_TC Transmission
complete interrupt
SMARTCARD_IT_RXNE Receive
data register not empty interrupt
SMARTCARD_IT_IDLE Idle line
DocID026525 Rev 6
433/1320
HAL SMARTCARD Generic Driver
UM1785
detection interrupt
SMARTCARD_IT_ERR Framing,
overrun or noise error interrupt
SMARTCARD_IT_PE Parity error
interrupt
Return value:
The: new state of __IT__ (TRUE or
FALSE).
__HAL_SMARTCARD_CLEAR_IT
Description:
Clear the specified SMARTCARD ISR flag,
in setting the proper ICR register flag.
Parameters:
__HANDLE__: specifies the SMARTCARD
Handle.
__IT_CLEAR__: specifies the interrupt
clear register flag that needs to be set to
clear the corresponding interrupt. This
parameter can be one of the following
values:
SMARTCARD_CLEAR_PEF Parity
error clear flag
SMARTCARD_CLEAR_FEF Framing
error clear flag
SMARTCARD_CLEAR_NEF Noise
detected clear flag
SMARTCARD_CLEAR_OREF
OverRun error clear flag
SMARTCARD_CLEAR_IDLEF Idle
line detection clear flag
SMARTCARD_CLEAR_TCF
Transmission complete clear flag
SMARTCARD_CLEAR_RTOF
Receiver timeout clear flag
SMARTCARD_CLEAR_EOBF End of
block clear flag
Return value:
None
__HAL_SMARTCARD_SEND_REQ
Description:
Set a specific SMARTCARD request flag.
Parameters:
__HANDLE__: specifies the SMARTCARD
Handle.
__REQ__: specifies the request flag to set
This parameter can be one of the following
values:
SMARTCARD_RXDATA_FLUSH_RE
QUEST Receive data flush Request
SMARTCARD_TXDATA_FLUSH_RE
434/1320
DocID026525 Rev 6
UM1785
HAL SMARTCARD Generic Driver
QUEST Transmit data flush Request
Return value:
None
__HAL_SMARTCARD_ONE_BIT_
SAMPLE_ENABLE
Description:
Enable the SMARTCARD one bit sample
method.
Parameters:
__HANDLE__: specifies the SMARTCARD
Handle.
Return value:
None
__HAL_SMARTCARD_ONE_BIT_
SAMPLE_DISABLE
Description:
Disable the SMARTCARD one bit sample
method.
Parameters:
__HANDLE__: specifies the SMARTCARD
Handle.
Return value:
None
Description:
__HAL_SMARTCARD_ENABLE
Enable the USART associated to the
SMARTCARD Handle.
Parameters:
__HANDLE__: specifies the SMARTCARD
Handle.
Return value:
None
__HAL_SMARTCARD_DISABLE
Description:
Disable the USART associated to the
SMARTCARD Handle.
Parameters:
__HANDLE__: specifies the SMARTCARD
Handle.
Return value:
None
SMARTCARD Flags
SMARTCARD_FLAG_REACK
SMARTCARD receive enable acknowledge flag
SMARTCARD_FLAG_TEACK
SMARTCARD transmit enable acknowledge flag
SMARTCARD_FLAG_BUSY
SMARTCARD busy flag
DocID026525 Rev 6
435/1320
HAL SMARTCARD Generic Driver
SMARTCARD_FLAG_EOBF
UM1785
SMARTCARD end of block flag
SMARTCARD_FLAG_RTOF
SMARTCARD receiver timeout flag
SMARTCARD_FLAG_TXE
SMARTCARD transmit data register empty
SMARTCARD_FLAG_TC
SMARTCARD transmission complete
SMARTCARD_FLAG_RXNE
SMARTCARD read data register not empty
SMARTCARD_FLAG_IDLE
SMARTCARD idle line detection
SMARTCARD_FLAG_ORE
SMARTCARD overrun error
SMARTCARD_FLAG_NE
SMARTCARD noise error
SMARTCARD_FLAG_FE
SMARTCARD frame error
SMARTCARD_FLAG_PE
SMARTCARD parity error
SMARTCARD guard time value LSB position in GTPR register
SMARTCARD_GTPR_GT_LSB_POS
SMARTCARD guard time value LSB position in
GTPR register
SMARTCARD interruptions flags mask
SMARTCARD_IT_MASK
SMARTCARD interruptions flags mask
SMARTCARD Interrupts Definition
SMARTCARD_IT_PE
SMARTCARD parity error interruption
SMARTCARD_IT_TXE
SMARTCARD transmit data register empty interruption
SMARTCARD_IT_TC
SMARTCARD transmission complete interruption
SMARTCARD_IT_RXNE
SMARTCARD read data register not empty interruption
SMARTCARD_IT_IDLE
SMARTCARD idle line detection interruption
SMARTCARD_IT_ERR
SMARTCARD error interruption
SMARTCARD_IT_ORE
SMARTCARD overrun error interruption
SMARTCARD_IT_NE
SMARTCARD noise error interruption
SMARTCARD_IT_FE
SMARTCARD frame error interruption
SMARTCARD_IT_EOB
SMARTCARD end of block interruption
SMARTCARD_IT_RTO
SMARTCARD receiver timeout interruption
SMARTCARD Interruption Clear Flags
436/1320
SMARTCARD_CLEAR_PEF
SMARTCARD parity error clear flag
SMARTCARD_CLEAR_FEF
SMARTCARD framing error clear flag
SMARTCARD_CLEAR_NEF
SMARTCARD noise detected clear flag
SMARTCARD_CLEAR_OREF
SMARTCARD overrun error clear flag
SMARTCARD_CLEAR_IDLEF
SMARTCARD idle line detected clear flag
SMARTCARD_CLEAR_TCF
SMARTCARD transmission complete clear flag
SMARTCARD_CLEAR_RTOF
SMARTCARD receiver time out clear flag
SMARTCARD_CLEAR_EOBF
SMARTCARD end of block clear flag
DocID026525 Rev 6
UM1785
HAL SMARTCARD Generic Driver
SMARTCARD Last Bit
SMARTCARD_LASTBIT_DISABLE
SMARTCARD frame last data bit clock pulse not
output to SCLK pin
SMARTCARD_LASTBIT_ENABLE
SMARTCARD frame last data bit clock pulse output
to SCLK pin
SMARTCARD Transfer Mode
SMARTCARD_MODE_RX
SMARTCARD RX mode
SMARTCARD_MODE_TX
SMARTCARD TX mode
SMARTCARD_MODE_TX_RX
SMARTCARD RX and TX mode
SMARTCARD advanced feature MSB first
SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE
Most significant bit sent/received
first disable
SMARTCARD_ADVFEATURE_MSBFIRST_ENABLE
Most significant bit sent/received
first enable
SMARTCARD NACK Enable
SMARTCARD_NACK_ENABLE
SMARTCARD NACK transmission disabled
SMARTCARD_NACK_DISABLE
SMARTCARD NACK transmission enabled
SMARTCARD One Bit Sampling Method
SMARTCARD_ONE_BIT_SAMPLE_DISABLE
SMARTCARD frame one-bit sample
disabled
SMARTCARD_ONE_BIT_SAMPLE_ENABLE
SMARTCARD frame one-bit sample
enabled
SMARTCARD advanced feature Overrun Disable
SMARTCARD_ADVFEATURE_OVERRUN_ENABLE
RX overrun enable
SMARTCARD_ADVFEATURE_OVERRUN_DISABLE
RX overrun disable
SMARTCARD Parity
SMARTCARD_PARITY_EVEN
SMARTCARD frame even parity
SMARTCARD_PARITY_ODD
SMARTCARD frame odd parity
SMARTCARD Request Parameters
SMARTCARD_RXDATA_FLUSH_REQUEST
Receive data flush request
SMARTCARD_TXDATA_FLUSH_REQUEST
Transmit data flush request
SMARTCARD block length LSB position in RTOR register
SMARTCARD_RTOR_BLEN_LSB_POS
SMARTCARD block length LSB position in
RTOR register
SMARTCARD advanced feature RX pin active level inversion
SMARTCARD_ADVFEATURE_RXINV_DISABLE
RX pin active level inversion disable
SMARTCARD_ADVFEATURE_RXINV_ENABLE
RX pin active level inversion enable
SMARTCARD advanced feature RX TX pins swap
SMARTCARD_ADVFEATURE_SWAP_DISABLE
DocID026525 Rev 6
TX/RX pins swap disable
437/1320
HAL SMARTCARD Generic Driver
SMARTCARD_ADVFEATURE_SWAP_ENABLE
UM1785
TX/RX pins swap enable
SMARTCARD Number of Stop Bits
SMARTCARD_STOPBITS_0_5
SMARTCARD frame with 0.5 stop bit
SMARTCARD_STOPBITS_1_5
SMARTCARD frame with 1.5 stop bits
SMARTCARD Timeout Enable
SMARTCARD_TIMEOUT_DISABLE
SMARTCARD receiver timeout disabled
SMARTCARD_TIMEOUT_ENABLE
SMARTCARD receiver timeout enabled
SMARTCARD advanced feature TX pin active level inversion
SMARTCARD_ADVFEATURE_TXINV_DISABLE
TX pin active level inversion disable
SMARTCARD_ADVFEATURE_TXINV_ENABLE
TX pin active level inversion enable
SMARTCARD Word Length
SMARTCARD_WORDLENGTH_9B
438/1320
SMARTCARD frame length
DocID026525 Rev 6
UM1785
HAL SMARTCARD Extension Driver
37
HAL SMARTCARD Extension Driver
37.1
SMARTCARDEx Firmware driver API description
37.1.1
SMARTCARD peripheral extended features
The Extended SMARTCARD HAL driver can be used as follows:
1.
37.1.2
After having configured the SMARTCARD basic features with
HAL_SMARTCARD_Init(), then program SMARTCARD advanced features if required
(TX/RX pins swap, TimeOut, auto-retry counter,...) in the hsmartcard AdvancedInit
structure.
Peripheral Control functions
This subsection provides a set of functions allowing to initialize the SMARTCARD.
HAL_SMARTCARDEx_BlockLength_Config() API allows to configure the Block
Length on the fly
HAL_SMARTCARDEx_TimeOut_Config() API allows to configure the receiver timeout
value on the fly
HAL_SMARTCARDEx_EnableReceiverTimeOut() API enables the receiver timeout
feature
HAL_SMARTCARDEx_DisableReceiverTimeOut() API disables the receiver timeout
feature
This section contains the following APIs:
HAL_SMARTCARDEx_BlockLength_Config()
HAL_SMARTCARDEx_TimeOut_Config()
HAL_SMARTCARDEx_EnableReceiverTimeOut()
HAL_SMARTCARDEx_DisableReceiverTimeOut()
37.1.3
Detailed description of functions
HAL_SMARTCARDEx_BlockLength_Config
Function name
void HAL_SMARTCARDEx_BlockLength_Config
(SMARTCARD_HandleTypeDef * hsmartcard, uint8_t
BlockLength)
Function description
Update on the fly the SMARTCARD block length in RTOR register.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
BlockLength: SMARTCARD block length (8-bit long at
most)
Return values
None
DocID026525 Rev 6
439/1320
HAL SMARTCARD Extension Driver
UM1785
HAL_SMARTCARDEx_TimeOut_Config
Function name
void HAL_SMARTCARDEx_TimeOut_Config
(SMARTCARD_HandleTypeDef * hsmartcard, uint32_t
TimeOutValue)
Function description
Update on the fly the receiver timeout value in RTOR register.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
TimeOutValue: receiver timeout value in number of baud
blocks. The timeout value must be less or equal to
0x0FFFFFFFF.
Return values
None
HAL_SMARTCARDEx_EnableReceiverTimeOut
Function name
HAL_StatusTypeDef
HAL_SMARTCARDEx_EnableReceiverTimeOut
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
Enable the SMARTCARD receiver timeout feature.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
HAL: status
HAL_SMARTCARDEx_DisableReceiverTimeOut
440/1320
Function name
HAL_StatusTypeDef
HAL_SMARTCARDEx_DisableReceiverTimeOut
(SMARTCARD_HandleTypeDef * hsmartcard)
Function description
Disable the SMARTCARD receiver timeout feature.
Parameters
hsmartcard: Pointer to a SMARTCARD_HandleTypeDef
structure that contains the configuration information for the
specified SMARTCARD module.
Return values
HAL: status
DocID026525 Rev 6
UM1785
HAL SMBUS Generic Driver
38
HAL SMBUS Generic Driver
38.1
SMBUS Firmware driver registers structures
38.1.1
SMBUS_InitTypeDef
Data Fields
uint32_t Timing
uint32_t AnalogFilter
uint32_t OwnAddress1
uint32_t AddressingMode
uint32_t DualAddressMode
uint32_t OwnAddress2
uint32_t OwnAddress2Masks
uint32_t GeneralCallMode
uint32_t NoStretchMode
uint32_t PacketErrorCheckMode
uint32_t PeripheralMode
uint32_t SMBusTimeout
Field Documentation
uint32_t SMBUS_InitTypeDef::Timing
Specifies the SMBUS_TIMINGR_register value. This parameter calculated by
referring to SMBUS initialization section in Reference manual
uint32_t SMBUS_InitTypeDef::AnalogFilter
Specifies if Analog Filter is enable or not. This parameter can be a value of
SMBUS_Analog_Filter
uint32_t SMBUS_InitTypeDef::OwnAddress1
Specifies the first device own address. This parameter can be a 7-bit or 10-bit
address.
uint32_t SMBUS_InitTypeDef::AddressingMode
Specifies if 7-bit or 10-bit addressing mode for master is selected. This parameter can
be a value of SMBUS_addressing_mode
uint32_t SMBUS_InitTypeDef::DualAddressMode
Specifies if dual addressing mode is selected. This parameter can be a value of
SMBUS_dual_addressing_mode
uint32_t SMBUS_InitTypeDef::OwnAddress2
Specifies the second device own address if dual addressing mode is selected This
parameter can be a 7-bit address.
uint32_t SMBUS_InitTypeDef::OwnAddress2Masks
Specifies the acknoledge mask address second device own address if dual
addressing mode is selected This parameter can be a value of
SMBUS_own_address2_masks.
uint32_t SMBUS_InitTypeDef::GeneralCallMode
Specifies if general call mode is selected. This parameter can be a value of
SMBUS_general_call_addressing_mode.
uint32_t SMBUS_InitTypeDef::NoStretchMode
Specifies if nostretch mode is selected. This parameter can be a value of
SMBUS_nostretch_mode
DocID026525 Rev 6
441/1320
HAL SMBUS Generic Driver
UM1785
uint32_t SMBUS_InitTypeDef::PacketErrorCheckMode
Specifies if Packet Error Check mode is selected. This parameter can be a value of
SMBUS_packet_error_check_mode
uint32_t SMBUS_InitTypeDef::PeripheralMode
Specifies which mode of Periphal is selected. This parameter can be a value of
SMBUS_peripheral_mode
uint32_t SMBUS_InitTypeDef::SMBusTimeout
Specifies the content of the 32 Bits SMBUS_TIMEOUT_register value. (Enable bits
and different timeout values) This parameter calculated by referring to SMBUS
initialization section in Reference manual
38.1.2
SMBUS_HandleTypeDef
Data Fields
I2C_TypeDef * Instance
SMBUS_InitTypeDef Init
uint8_t * pBuffPtr
uint16_t XferSize
__IO uint16_t XferCount
__IO uint32_t XferOptions
__IO uint32_t PreviousState
HAL_LockTypeDef Lock
__IO uint32_t State
__IO uint32_t ErrorCode
Field Documentation
I2C_TypeDef* SMBUS_HandleTypeDef::Instance
SMBUS registers base address
SMBUS_InitTypeDef SMBUS_HandleTypeDef::Init
SMBUS communication parameters
uint8_t* SMBUS_HandleTypeDef::pBuffPtr
Pointer to SMBUS transfer buffer
uint16_t SMBUS_HandleTypeDef::XferSize
SMBUS transfer size
__IO uint16_t SMBUS_HandleTypeDef::XferCount
SMBUS transfer counter
__IO uint32_t SMBUS_HandleTypeDef::XferOptions
SMBUS transfer options
__IO uint32_t SMBUS_HandleTypeDef::PreviousState
SMBUS communication Previous state
HAL_LockTypeDef SMBUS_HandleTypeDef::Lock
SMBUS locking object
__IO uint32_t SMBUS_HandleTypeDef::State
SMBUS communication state
__IO uint32_t SMBUS_HandleTypeDef::ErrorCode
SMBUS Error code
442/1320
DocID026525 Rev 6
UM1785
HAL SMBUS Generic Driver
38.2
SMBUS Firmware driver API description
38.2.1
How to use this driver
The SMBUS HAL driver can be used as follows:
1.
2.
3.
4.
5.
6.
Declare a SMBUS_HandleTypeDef handle structure, for example:
SMBUS_HandleTypeDef hsmbus;
Initialize the SMBUS low level resources by implementing the HAL_SMBUS_MspInit()
API:
a. Enable the SMBUSx interface clock
b. SMBUS pins configuration
Enable the clock for the SMBUS GPIOs
Configure SMBUS pins as alternate function open-drain
c. NVIC configuration if you need to use interrupt process
Configure the SMBUSx interrupt priority
Enable the NVIC SMBUS IRQ Channel
Configure the Communication Clock Timing, Bus Timeout, Own Address1, Master
Addressing mode, Dual Addressing mode, Own Address2, Own Address2 Mask,
General call, Nostretch mode, Peripheral mode and Packet Error Check mode in the
hsmbus Init structure.
Initialize the SMBUS registers by calling the HAL_SMBUS_Init() API:
These API's configures also the low level Hardware GPIO, CLOCK,
CORTEX...etc) by calling the customized HAL_SMBUS_MspInit(&hsmbus) API.
To check if target device is ready for communication, use the function
HAL_SMBUS_IsDeviceReady()
For SMBUS IO operations, only one mode of operations is available within this driver
Interrupt mode IO operation
Transmit in master/host SMBUS mode an amount of data in non-blocking mode using
HAL_SMBUS_Master_Transmit_IT()
At transmission end of transfer HAL_SMBUS_MasterTxCpltCallback() is
executed and user can add his own code by customization of function pointer
HAL_SMBUS_MasterTxCpltCallback()
Receive in master/host SMBUS mode an amount of data in non-blocking mode using
HAL_SMBUS_Master_Receive_IT()
At reception end of transfer HAL_SMBUS_MasterRxCpltCallback() is executed
and user can add his own code by customization of function pointer
HAL_SMBUS_MasterRxCpltCallback()
Abort a master/host SMBUS process communication with Interrupt using
HAL_SMBUS_Master_Abort_IT()
The associated previous transfer callback is called at the end of abort process
mean HAL_SMBUS_MasterTxCpltCallback() in case of previous state was
master transmit
mean HAL_SMBUS_MasterRxCpltCallback() in case of previous state was
master receive
Enable/disable the Address listen mode in slave/device or host/slave SMBUS mode
using HAL_SMBUS_EnableListen_IT() HAL_SMBUS_DisableListen_IT()
When address slave/device SMBUS match, HAL_SMBUS_AddrCallback() is
executed and user can add his own code to check the Address Match Code and
the transmission direction request by master/host (Write/Read).
At Listen mode end HAL_SMBUS_ListenCpltCallback() is executed and user can
add his own code by customization of function pointer
HAL_SMBUS_ListenCpltCallback()
DocID026525 Rev 6
443/1320
HAL SMBUS Generic Driver
UM1785
Transmit in slave/device SMBUS mode an amount of data in non-blocking mode using
HAL_SMBUS_Slave_Transmit_IT()
At transmission end of transfer HAL_SMBUS_SlaveTxCpltCallback() is executed
and user can add his own code by customization of function pointer
HAL_SMBUS_SlaveTxCpltCallback()
Receive in slave/device SMBUS mode an amount of data in non-blocking mode using
HAL_SMBUS_Slave_Receive_IT()
At reception end of transfer HAL_SMBUS_SlaveRxCpltCallback() is executed
and user can add his own code by customization of function pointer
HAL_SMBUS_SlaveRxCpltCallback()
Enable/Disable the SMBUS alert mode using HAL_SMBUS_EnableAlert_IT()
HAL_SMBUS_DisableAlert_IT()
When SMBUS Alert is generated HAL_SMBUS_ErrorCallback() is executed and
user can add his own code by customization of function pointer
HAL_SMBUS_ErrorCallback() to check the Alert Error Code using function
HAL_SMBUS_GetError()
Get HAL state machine or error values using HAL_SMBUS_GetState() or
HAL_SMBUS_GetError()
In case of transfer Error, HAL_SMBUS_ErrorCallback() function is executed and user
can add his own code by customization of function pointer
HAL_SMBUS_ErrorCallback() to check the Error Code using function
HAL_SMBUS_GetError()
SMBUS HAL driver macros list
Below the list of most used macros in SMBUS HAL driver.
__HAL_SMBUS_ENABLE: Enable the SMBUS peripheral
__HAL_SMBUS_DISABLE: Disable the SMBUS peripheral
__HAL_SMBUS_GET_FLAG: Check whether the specified SMBUS flag is set or not
__HAL_SMBUS_CLEAR_FLAG: Clear the specified SMBUS pending flag
__HAL_SMBUS_ENABLE_IT: Enable the specified SMBUS interrupt
__HAL_SMBUS_DISABLE_IT: Disable the specified SMBUS interrupt
You can refer to the SMBUS HAL driver header file for more useful macros
38.2.2
Initialization and de-initialization functions
This subsection provides a set of functions allowing to initialize and deinitialize the
SMBUSx peripheral:
User must Implement HAL_SMBUS_MspInit() function in which he configures all
related peripherals resources (CLOCK, GPIO, IT and NVIC ).
Call the function HAL_SMBUS_Init() to configure the selected device with the selected
configuration:
Clock Timing
Bus Timeout
Analog Filer mode
Own Address 1
Addressing mode (Master, Slave)
Dual Addressing mode
Own Address 2
444/1320
DocID026525 Rev 6
UM1785
HAL SMBUS Generic Driver
Own Address 2 Mask
General call mode
Nostretch mode
Packet Error Check mode
Peripheral mode
Call the function HAL_SMBUS_DeInit() to restore the default configuration of the
selected SMBUSx peripheral.
Enable/Disable Analog/Digital filters with HAL_SMBUS_ConfigAnalogFilter() and
HAL_SMBUS_ConfigDigitalFilter().
This section contains the following APIs:
HAL_SMBUS_Init()
HAL_SMBUS_DeInit()
HAL_SMBUS_MspInit()
HAL_SMBUS_MspDeInit()
HAL_SMBUS_ConfigAnalogFilter()
HAL_SMBUS_ConfigDigitalFilter()
38.2.3
IO operation functions
This subsection provides a set of functions allowing to manage the SMBUS data transfers.
1.
2.
3.
4.
Blocking mode function to check if device is ready for usage is :
HAL_SMBUS_IsDeviceReady()
There is only one mode of transfer:
Non-Blocking mode : The communication is performed using Interrupts. These
functions return the status of the transfer startup. The end of the data processing
will be indicated through the dedicated SMBUS IRQ when using Interrupt mode.
Non-Blocking mode functions with Interrupt are :
HAL_SMBUS_Master_Transmit_IT()
HAL_SMBUS_Master_Receive_IT()
HAL_SMBUS_Slave_Transmit_IT()
HAL_SMBUS_Slave_Receive_IT()
HAL_SMBUS_EnableListen_IT() or alias HAL_SMBUS_EnableListen_IT()
HAL_SMBUS_DisableListen_IT()
HAL_SMBUS_EnableAlert_IT()
HAL_SMBUS_DisableAlert_IT()
A set of Transfer Complete Callbacks are provided in non-Blocking mode:
HAL_SMBUS_MasterTxCpltCallback()
HAL_SMBUS_MasterRxCpltCallback()
HAL_SMBUS_SlaveTxCpltCallback()
HAL_SMBUS_SlaveRxCpltCallback()
HAL_SMBUS_AddrCallback()
HAL_SMBUS_ListenCpltCallback()
HAL_SMBUS_ErrorCallback()
This section contains the following APIs:
HAL_SMBUS_Master_Transmit_IT()
HAL_SMBUS_Master_Receive_IT()
HAL_SMBUS_Master_Abort_IT()
HAL_SMBUS_Slave_Transmit_IT()
HAL_SMBUS_Slave_Receive_IT()
HAL_SMBUS_EnableListen_IT()
HAL_SMBUS_DisableListen_IT()
DocID026525 Rev 6
445/1320
HAL SMBUS Generic Driver
UM1785
HAL_SMBUS_EnableAlert_IT()
HAL_SMBUS_DisableAlert_IT()
HAL_SMBUS_IsDeviceReady()
38.2.4
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:
HAL_SMBUS_GetState()
HAL_SMBUS_GetError()
38.2.5
Detailed description of functions
HAL_SMBUS_Init
Function name
HAL_StatusTypeDef HAL_SMBUS_Init
(SMBUS_HandleTypeDef * hsmbus)
Function description
Initialize the SMBUS according to the specified parameters in the
SMBUS_InitTypeDef and initialize the associated handle.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
Return values
HAL: status
HAL_SMBUS_DeInit
Function name
HAL_StatusTypeDef HAL_SMBUS_DeInit
(SMBUS_HandleTypeDef * hsmbus)
Function description
DeInitialize the SMBUS peripheral.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
Return values
HAL: status
HAL_SMBUS_MspInit
446/1320
Function name
void HAL_SMBUS_MspInit (SMBUS_HandleTypeDef *
hsmbus)
Function description
Initialize the SMBUS MSP.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
Return values
None
DocID026525 Rev 6
UM1785
HAL SMBUS Generic Driver
HAL_SMBUS_MspDeInit
Function name
void HAL_SMBUS_MspDeInit (SMBUS_HandleTypeDef *
hsmbus)
Function description
DeInitialize the SMBUS MSP.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
Return values
None
HAL_SMBUS_ConfigAnalogFilter
Function name
HAL_StatusTypeDef HAL_SMBUS_ConfigAnalogFilter
(SMBUS_HandleTypeDef * hsmbus, uint32_t AnalogFilter)
Function description
Configure Analog noise filter.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
AnalogFilter: This parameter can be one of the following
values:
SMBUS_ANALOGFILTER_ENABLE
SMBUS_ANALOGFILTER_DISABLE
Return values
HAL: status
HAL_SMBUS_ConfigDigitalFilter
Function name
HAL_StatusTypeDef HAL_SMBUS_ConfigDigitalFilter
(SMBUS_HandleTypeDef * hsmbus, uint32_t DigitalFilter)
Function description
Configure Digital noise filter.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
DigitalFilter: Coefficient of digital noise filter between
Min_Data=0x00 and Max_Data=0x0F.
Return values
HAL: status
HAL_SMBUS_IsDeviceReady
Function name
HAL_StatusTypeDef HAL_SMBUS_IsDeviceReady
(SMBUS_HandleTypeDef * hsmbus, uint16_t DevAddress,
uint32_t Trials, uint32_t Timeout)
Function description
Check if target device is ready for communication.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
Trials: Number of trials
DocID026525 Rev 6
447/1320
HAL SMBUS Generic Driver
UM1785
Timeout: Timeout duration
Return values
HAL: status
HAL_SMBUS_Master_Transmit_IT
Function name
HAL_StatusTypeDef HAL_SMBUS_Master_Transmit_IT
(SMBUS_HandleTypeDef * hsmbus, uint16_t DevAddress,
uint8_t * pData, uint16_t Size, uint32_t XferOptions)
Function description
Transmit in master/host SMBUS mode an amount of data in nonblocking mode with Interrupt.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
pData: Pointer to data buffer
Size: Amount of data to be sent
XferOptions: Options of Transfer, value of SMBUS
XferOptions definition
Return values
HAL: status
HAL_SMBUS_Master_Receive_IT
Function name
HAL_StatusTypeDef HAL_SMBUS_Master_Receive_IT
(SMBUS_HandleTypeDef * hsmbus, uint16_t DevAddress,
uint8_t * pData, uint16_t Size, uint32_t XferOptions)
Function description
Receive in master/host SMBUS mode an amount of data in nonblocking mode with Interrupt.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
pData: Pointer to data buffer
Size: Amount of data to be sent
XferOptions: Options of Transfer, value of SMBUS
XferOptions definition
Return values
HAL: status
HAL_SMBUS_Master_Abort_IT
Function name
HAL_StatusTypeDef HAL_SMBUS_Master_Abort_IT
(SMBUS_HandleTypeDef * hsmbus, uint16_t DevAddress)
Function description
Abort a master/host SMBUS process communication with
Interrupt.
Parameters
448/1320
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
DocID026525 Rev 6
UM1785
HAL SMBUS Generic Driver
SMBUS.
DevAddress: Target device address: The device 7 bits
address value in datasheet must be shift at right before call
interface
Return values
HAL: status
Notes
This abort can be called only if state is ready
HAL_SMBUS_Slave_Transmit_IT
Function name
HAL_StatusTypeDef HAL_SMBUS_Slave_Transmit_IT
(SMBUS_HandleTypeDef * hsmbus, uint8_t * pData, uint16_t
Size, uint32_t XferOptions)
Function description
Transmit in slave/device SMBUS mode an amount of data in nonblocking mode with Interrupt.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
pData: Pointer to data buffer
Size: Amount of data to be sent
XferOptions: Options of Transfer, value of SMBUS
XferOptions definition
Return values
HAL: status
HAL_SMBUS_Slave_Receive_IT
Function name
HAL_StatusTypeDef HAL_SMBUS_Slave_Receive_IT
(SMBUS_HandleTypeDef * hsmbus, uint8_t * pData, uint16_t
Size, uint32_t XferOptions)
Function description
Receive in slave/device SMBUS mode an amount of data in nonblocking mode with Interrupt.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
pData: Pointer to data buffer
Size: Amount of data to be sent
XferOptions: Options of Transfer, value of SMBUS
XferOptions definition
Return values
HAL: status
HAL_SMBUS_EnableAlert_IT
Function name
HAL_StatusTypeDef HAL_SMBUS_EnableAlert_IT
(SMBUS_HandleTypeDef * hsmbus)
Function description
Enable the SMBUS alert mode with Interrupt.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUSx peripheral.
Return values
HAL: status
DocID026525 Rev 6
449/1320
HAL SMBUS Generic Driver
UM1785
HAL_SMBUS_DisableAlert_IT
Function name
HAL_StatusTypeDef HAL_SMBUS_DisableAlert_IT
(SMBUS_HandleTypeDef * hsmbus)
Function description
Disable the SMBUS alert mode with Interrupt.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUSx peripheral.
Return values
HAL: status
HAL_SMBUS_EnableListen_IT
Function name
HAL_StatusTypeDef HAL_SMBUS_EnableListen_IT
(SMBUS_HandleTypeDef * hsmbus)
Function description
Enable the Address listen mode with Interrupt.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
Return values
HAL: status
HAL_SMBUS_DisableListen_IT
Function name
HAL_StatusTypeDef HAL_SMBUS_DisableListen_IT
(SMBUS_HandleTypeDef * hsmbus)
Function description
Disable the Address listen mode with Interrupt.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
Return values
HAL: status
HAL_SMBUS_EV_IRQHandler
Function name
void HAL_SMBUS_EV_IRQHandler (SMBUS_HandleTypeDef *
hsmbus)
Function description
Handle SMBUS event interrupt request.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
Return values
None
HAL_SMBUS_ER_IRQHandler
Function name
void HAL_SMBUS_ER_IRQHandler (SMBUS_HandleTypeDef *
hsmbus)
Function description
Handle SMBUS error interrupt request.
Parameters
450/1320
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
DocID026525 Rev 6
UM1785
HAL SMBUS Generic Driver
SMBUS.
Return values
None
HAL_SMBUS_MasterTxCpltCallback
Function name
void HAL_SMBUS_MasterTxCpltCallback
(SMBUS_HandleTypeDef * hsmbus)
Function description
Master Tx Transfer completed callback.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
Return values
None
HAL_SMBUS_MasterRxCpltCallback
Function name
void HAL_SMBUS_MasterRxCpltCallback
(SMBUS_HandleTypeDef * hsmbus)
Function description
Master Rx Transfer completed callback.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
Return values
None
HAL_SMBUS_SlaveTxCpltCallback
Function name
void HAL_SMBUS_SlaveTxCpltCallback
(SMBUS_HandleTypeDef * hsmbus)
Function description
Slave Tx Transfer completed callback.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
Return values
None
HAL_SMBUS_SlaveRxCpltCallback
Function name
void HAL_SMBUS_SlaveRxCpltCallback
(SMBUS_HandleTypeDef * hsmbus)
Function description
Slave Rx Transfer completed callback.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
Return values
None
DocID026525 Rev 6
451/1320
HAL SMBUS Generic Driver
UM1785
HAL_SMBUS_AddrCallback
Function name
void HAL_SMBUS_AddrCallback (SMBUS_HandleTypeDef *
hsmbus, uint8_t TransferDirection, uint16_t AddrMatchCode)
Function description
Slave Address Match callback.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
TransferDirection: Master request Transfer Direction
(Write/Read)
AddrMatchCode: Address Match Code
Return values
None
HAL_SMBUS_ListenCpltCallback
Function name
void HAL_SMBUS_ListenCpltCallback
(SMBUS_HandleTypeDef * hsmbus)
Function description
Listen Complete callback.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
Return values
None
HAL_SMBUS_ErrorCallback
Function name
void HAL_SMBUS_ErrorCallback (SMBUS_HandleTypeDef *
hsmbus)
Function description
SMBUS error callback.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
Return values
None
HAL_SMBUS_GetState
452/1320
Function name
uint32_t HAL_SMBUS_GetState (SMBUS_HandleTypeDef *
hsmbus)
Function description
Return the SMBUS handle state.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
Return values
HAL: state
DocID026525 Rev 6
UM1785
HAL SMBUS Generic Driver
HAL_SMBUS_GetError
Function name
uint32_t HAL_SMBUS_GetError (SMBUS_HandleTypeDef *
hsmbus)
Function description
Return the SMBUS error code.
Parameters
hsmbus: Pointer to a SMBUS_HandleTypeDef structure that
contains the configuration information for the specified
SMBUS.
Return values
SMBUS: Error Code
38.3
SMBUS Firmware driver defines
38.3.1
SMBUS
SMBUS addressing mode
SMBUS_ADDRESSINGMODE_7BIT
SMBUS_ADDRESSINGMODE_10BIT
SMBUS Analog Filter
SMBUS_ANALOGFILTER_ENABLE
SMBUS_ANALOGFILTER_DISABLE
SMBUS dual addressing mode
SMBUS_DUALADDRESS_DISABLE
SMBUS_DUALADDRESS_ENABLE
SMBUS Error Code definition
HAL_SMBUS_ERROR_NONE
No error
HAL_SMBUS_ERROR_BERR
BERR error
HAL_SMBUS_ERROR_ARLO
ARLO error
HAL_SMBUS_ERROR_ACKF
ACKF error
HAL_SMBUS_ERROR_OVR
OVR error
HAL_SMBUS_ERROR_HALTIMEOUT
Timeout error
HAL_SMBUS_ERROR_BUSTIMEOUT
Bus Timeout error
HAL_SMBUS_ERROR_ALERT
Alert error
HAL_SMBUS_ERROR_PECERR
PEC error
SMBUS Exported Macros
__HAL_SMBUS_RESET_HANDLE_STATE
Description:
Reset SMBUS handle state.
Parameters:
__HANDLE__: specifies the SMBUS
Handle.
DocID026525 Rev 6
453/1320
HAL SMBUS Generic Driver
UM1785
Return value:
None
__HAL_SMBUS_ENABLE_IT
Description:
Enable the specified SMBUS interrupts.
Parameters:
__HANDLE__: specifies the SMBUS
Handle.
__INTERRUPT__: specifies the
interrupt source to enable. This
parameter can be one of the following
values:
SMBUS_IT_ERRI Errors interrupt
enable
SMBUS_IT_TCI Transfer complete
interrupt enable
SMBUS_IT_STOPI STOP
detection interrupt enable
SMBUS_IT_NACKI NACK
received interrupt enable
SMBUS_IT_ADDRI Address
match interrupt enable
SMBUS_IT_RXI RX interrupt
enable
SMBUS_IT_TXI TX interrupt
enable
Return value:
None
__HAL_SMBUS_DISABLE_IT
Description:
Disable the specified SMBUS
interrupts.
Parameters:
__HANDLE__: specifies the SMBUS
Handle.
__INTERRUPT__: specifies the
interrupt source to disable. This
parameter can be one of the following
values:
SMBUS_IT_ERRI Errors interrupt
enable
SMBUS_IT_TCI Transfer complete
interrupt enable
SMBUS_IT_STOPI STOP
detection interrupt enable
SMBUS_IT_NACKI NACK
received interrupt enable
SMBUS_IT_ADDRI Address
match interrupt enable
SMBUS_IT_RXI RX interrupt
454/1320
DocID026525 Rev 6
UM1785
HAL SMBUS Generic Driver
enable
SMBUS_IT_TXI TX interrupt
enable
Return value:
None
__HAL_SMBUS_GET_IT_SOURCE
Description:
Check whether the specified SMBUS
interrupt source is enabled or not.
Parameters:
__HANDLE__: specifies the SMBUS
Handle.
__INTERRUPT__: specifies the
SMBUS interrupt source to check. This
parameter can be one of the following
values:
SMBUS_IT_ERRI Errors interrupt
enable
SMBUS_IT_TCI Transfer complete
interrupt enable
SMBUS_IT_STOPI STOP
detection interrupt enable
SMBUS_IT_NACKI NACK
received interrupt enable
SMBUS_IT_ADDRI Address
match interrupt enable
SMBUS_IT_RXI RX interrupt
enable
SMBUS_IT_TXI TX interrupt
enable
Return value:
The: new state of __IT__ (TRUE or
FALSE).
SMBUS_FLAG_MASK
Description:
Check whether the specified SMBUS
flag is set or not.
Parameters:
__HANDLE__: specifies the SMBUS
Handle.
__FLAG__: specifies the flag to check.
This parameter can be one of the
following values:
SMBUS_FLAG_TXE Transmit
data register empty
SMBUS_FLAG_TXIS Transmit
interrupt status
SMBUS_FLAG_RXNE Receive
data register not empty
SMBUS_FLAG_ADDR Address
DocID026525 Rev 6
455/1320
HAL SMBUS Generic Driver
UM1785
matched (slave mode)
SMBUS_FLAG_AF NACK
received flag
SMBUS_FLAG_STOPF STOP
detection flag
SMBUS_FLAG_TC Transfer
complete (master mode)
SMBUS_FLAG_TCR Transfer
complete reload
SMBUS_FLAG_BERR Bus error
SMBUS_FLAG_ARLO Arbitration
lost
SMBUS_FLAG_OVR
Overrun/Underrun
SMBUS_FLAG_PECERR PEC
error in reception
SMBUS_FLAG_TIMEOUT
Timeout or Tlow detection flag
SMBUS_FLAG_ALERT SMBus
alert
SMBUS_FLAG_BUSY Bus busy
SMBUS_FLAG_DIR Transfer
direction (slave mode)
Return value:
The: new state of __FLAG__ (TRUE or
FALSE).
__HAL_SMBUS_GET_FLAG
__HAL_SMBUS_CLEAR_FLAG
Description:
Clear the SMBUS pending flags which
are cleared by writing 1 in a specific bit.
Parameters:
__HANDLE__: specifies the SMBUS
Handle.
__FLAG__: specifies the flag to clear.
This parameter can be any combination
of the following values:
SMBUS_FLAG_ADDR Address
matched (slave mode)
SMBUS_FLAG_AF NACK
received flag
SMBUS_FLAG_STOPF STOP
detection flag
SMBUS_FLAG_BERR Bus error
SMBUS_FLAG_ARLO Arbitration
lost
SMBUS_FLAG_OVR
Overrun/Underrun
SMBUS_FLAG_PECERR PEC
error in reception
SMBUS_FLAG_TIMEOUT
456/1320
DocID026525 Rev 6
UM1785
HAL SMBUS Generic Driver
Timeout or Tlow detection flag
SMBUS_FLAG_ALERT SMBus
alert
Return value:
None
Description:
__HAL_SMBUS_ENABLE
Enable the specified SMBUS
peripheral.
Parameters:
__HANDLE__: specifies the SMBUS
Handle.
Return value:
None
Description:
__HAL_SMBUS_DISABLE
Disable the specified SMBUS
peripheral.
Parameters:
__HANDLE__: specifies the SMBUS
Handle.
Return value:
None
__HAL_SMBUS_GENERATE_NACK
Description:
Generate a Non-Acknowledge SMBUS
peripheral in Slave mode.
Parameters:
__HANDLE__: specifies the SMBUS
Handle.
Return value:
None
SMBUS Flag definition
SMBUS_FLAG_TXE
SMBUS_FLAG_TXIS
SMBUS_FLAG_RXNE
SMBUS_FLAG_ADDR
SMBUS_FLAG_AF
SMBUS_FLAG_STOPF
SMBUS_FLAG_TC
SMBUS_FLAG_TCR
SMBUS_FLAG_BERR
DocID026525 Rev 6
457/1320
HAL SMBUS Generic Driver
SMBUS_FLAG_ARLO
UM1785
SMBUS_FLAG_OVR
SMBUS_FLAG_PECERR
SMBUS_FLAG_TIMEOUT
SMBUS_FLAG_ALERT
SMBUS_FLAG_BUSY
SMBUS_FLAG_DIR
SMBUS general call addressing mode
SMBUS_GENERALCALL_DISABLE
SMBUS_GENERALCALL_ENABLE
SMBUS Interrupt configuration definition
SMBUS_IT_ERRI
SMBUS_IT_TCI
SMBUS_IT_STOPI
SMBUS_IT_NACKI
SMBUS_IT_ADDRI
SMBUS_IT_RXI
SMBUS_IT_TXI
SMBUS_IT_TX
SMBUS_IT_RX
SMBUS_IT_ALERT
SMBUS_IT_ADDR
SMBUS nostretch mode
SMBUS_NOSTRETCH_DISABLE
SMBUS_NOSTRETCH_ENABLE
SMBUS ownaddress2 masks
SMBUS_OA2_NOMASK
SMBUS_OA2_MASK01
SMBUS_OA2_MASK02
SMBUS_OA2_MASK03
SMBUS_OA2_MASK04
SMBUS_OA2_MASK05
SMBUS_OA2_MASK06
SMBUS_OA2_MASK07
SMBUS packet error check mode
SMBUS_PEC_DISABLE
458/1320
DocID026525 Rev 6
UM1785
HAL SMBUS Generic Driver
SMBUS_PEC_ENABLE
SMBUS peripheral mode
SMBUS_PERIPHERAL_MODE_SMBUS_HOST
SMBUS_PERIPHERAL_MODE_SMBUS_SLAVE
SMBUS_PERIPHERAL_MODE_SMBUS_SLAVE_ARP
SMBUS ReloadEndMode definition
SMBUS_SOFTEND_MODE
SMBUS_RELOAD_MODE
SMBUS_AUTOEND_MODE
SMBUS_SENDPEC_MODE
SMBUS StartStopMode definition
SMBUS_NO_STARTSTOP
SMBUS_GENERATE_STOP
SMBUS_GENERATE_START_READ
SMBUS_GENERATE_START_WRITE
SMBUS XferOptions definition
SMBUS_FIRST_FRAME
SMBUS_NEXT_FRAME
SMBUS_FIRST_AND_LAST_FRAME_NO_PEC
SMBUS_LAST_FRAME_NO_PEC
SMBUS_FIRST_AND_LAST_FRAME_WITH_PEC
SMBUS_LAST_FRAME_WITH_PEC
SMBUS_OTHER_FRAME_NO_PEC
SMBUS_OTHER_FRAME_WITH_PEC
SMBUS_OTHER_AND_LAST_FRAME_NO_PEC
SMBUS_OTHER_AND_LAST_FRAME_WITH_PEC
DocID026525 Rev 6
459/1320
HAL SPI Generic Driver
UM1785
39
HAL SPI Generic Driver
39.1
SPI Firmware driver registers structures
39.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
uint32_t CRCLength
uint32_t NSSPMode
Field Documentation
uint32_t SPI_InitTypeDef::Mode
Specifies the SPI operating mode. This parameter can be a value of SPI_Mode
uint32_t SPI_InitTypeDef::Direction
Specifies the SPI bidirectional mode state. This parameter can be a value of
SPI_Direction
uint32_t SPI_InitTypeDef::DataSize
Specifies the SPI data size. This parameter can be a value of SPI_Data_Size
uint32_t SPI_InitTypeDef::CLKPolarity
Specifies the serial clock steady state. This parameter can be a value of
SPI_Clock_Polarity
uint32_t SPI_InitTypeDef::CLKPhase
Specifies the clock active edge for the bit capture. This parameter can be a value of
SPI_Clock_Phase
uint32_t SPI_InitTypeDef::NSS
Specifies whether the NSS signal is managed by hardware (NSS pin) or by software
using the SSI bit. This parameter can be a value of SPI_Slave_Select_management
uint32_t SPI_InitTypeDef::BaudRatePrescaler
Specifies the Baud Rate prescaler value which will be used to configure the transmit
and receive SCK clock. This parameter can be a value of SPI_BaudRate_Prescaler
Note:The communication clock is derived from the master clock. The slave clock does
not need to be set.
uint32_t SPI_InitTypeDef::FirstBit
Specifies whether data transfers start from MSB or LSB bit. This parameter can be a
value of SPI_MSB_LSB_transmission
uint32_t SPI_InitTypeDef::TIMode
Specifies if the TI mode is enabled or not. This parameter can be a value of
SPI_TI_mode
460/1320
DocID026525 Rev 6
UM1785
HAL SPI Generic Driver
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 an odd
number between Min_Data = 1 and Max_Data = 65535
uint32_t SPI_InitTypeDef::CRCLength
Specifies the CRC Length used for the CRC calculation. CRC Length is only used with
Data8 and Data16, not other data size This parameter can be a value of
SPI_CRC_length
uint32_t SPI_InitTypeDef::NSSPMode
Specifies whether the NSSP signal is enabled or not . This parameter can be a value
of SPI_NSSP_Mode This mode is activated by the NSSP bit in the SPIx_CR2 register
and it takes effect only if the SPI interface is configured as Motorola SPI master
(FRF=0) with capture on the first edge (SPIx_CR1 CPHA = 0, CPOL setting is
ignored)..
39.1.2
__SPI_HandleTypeDef
Data Fields
SPI_TypeDef * Instance
SPI_InitTypeDef Init
uint8_t * pTxBuffPtr
uint16_t TxXferSize
__IO uint16_t TxXferCount
uint8_t * pRxBuffPtr
uint16_t RxXferSize
__IO uint16_t RxXferCount
uint32_t CRCSize
void(* RxISR
void(* TxISR
DMA_HandleTypeDef * hdmatx
DMA_HandleTypeDef * hdmarx
HAL_LockTypeDef Lock
__IO HAL_SPI_StateTypeDef State
__IO uint32_t ErrorCode
Field Documentation
SPI_TypeDef* __SPI_HandleTypeDef::Instance
SPI registers base address
SPI_InitTypeDef __SPI_HandleTypeDef::Init
SPI communication parameters
uint8_t* __SPI_HandleTypeDef::pTxBuffPtr
Pointer to SPI Tx transfer Buffer
uint16_t __SPI_HandleTypeDef::TxXferSize
SPI Tx Transfer size
__IO uint16_t __SPI_HandleTypeDef::TxXferCount
SPI Tx Transfer Counter
uint8_t* __SPI_HandleTypeDef::pRxBuffPtr
Pointer to SPI Rx transfer Buffer
uint16_t __SPI_HandleTypeDef::RxXferSize
SPI Rx Transfer size
__IO uint16_t __SPI_HandleTypeDef::RxXferCount
SPI Rx Transfer Counter
DocID026525 Rev 6
461/1320
HAL SPI Generic Driver
UM1785
uint32_t __SPI_HandleTypeDef::CRCSize
SPI CRC size used for the transfer
void(* __SPI_HandleTypeDef::RxISR)(struct __SPI_HandleTypeDef *hspi)
function pointer on Rx ISR
void(* __SPI_HandleTypeDef::TxISR)(struct __SPI_HandleTypeDef *hspi)
function pointer on Tx ISR
DMA_HandleTypeDef* __SPI_HandleTypeDef::hdmatx
SPI Tx DMA Handle parameters
DMA_HandleTypeDef* __SPI_HandleTypeDef::hdmarx
SPI Rx DMA Handle parameters
HAL_LockTypeDef __SPI_HandleTypeDef::Lock
Locking object
__IO HAL_SPI_StateTypeDef __SPI_HandleTypeDef::State
SPI communication state
__IO uint32_t __SPI_HandleTypeDef::ErrorCode
SPI Error code
39.2
SPI Firmware driver API description
39.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/Channel
Enable the DMAx clock
Configure the DMA handle parameters
Configure the DMA Tx or Rx Stream/Channel
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/Channel
Program the Mode, BidirectionalMode , Data size, Baudrate Prescaler, NSS
management, Clock polarity and phase, FirstBit and CRC configuration in the hspi Init
structure.
Initialize the SPI registers by calling the HAL_SPI_Init() API:
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.
462/1320
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
DocID026525 Rev 6
UM1785
3.
HAL SPI Generic Driver
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
Master Receive mode restriction:
1.
In Master unidirectional receive-only mode (MSTR =1, BIDIMODE=0, RXONLY=0) or
bidirectional receive mode (MSTR=1, BIDIMODE=1, BIDIOE=0), to ensure that the
SPI does not initiate a new transfer the following procedure has to be respected:
a. HAL_SPI_DeInit()
b. HAL_SPI_Init()
The HAL drivers do not allow reaching all supported SPI frequencies in the different SPI
modes. Refer to the source code (stm32xxxx_hal_spi.c header) to get a summary of the
maximum SPI frequency that can be reached with a data size of 8 or 16 bits, depending on
the APBx peripheral clock frequency (fPCLK) used by the SPI instance.
Data buffer address alignment restriction:
1.
2.
39.2.2
In case more than 1 byte is requested to be transferred, the HAL SPI uses 16-bit
access for data buffer. But there is no support for unaligned accesses on the CortexM0 processor. So, if the user wants to transfer more than 1 byte, it shall ensure that
16-bit aligned address is used for:
a. pData parameter in HAL_SPI_Transmit(), HAL_SPI_Transmit_IT(),
HAL_SPI_Receive() and HAL_SPI_Receive_IT()
b. pTxData and pRxData parameters in HAL_SPI_TransmitReceive() and
HAL_SPI_TransmitReceive_IT()
There is no such restriction when going through DMA by using
HAL_SPI_Transmit_DMA(), HAL_SPI_Receive_DMA() and
HAL_SPI_TransmitReceive_DMA().
Initialization and de-initialization functions
This subsection provides a set of functions allowing to initialize and de-initialize the SPIx
peripheral:
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
CRC Calculation
CRC Polynomial if CRC enabled
CRC Length, used only with Data8 and Data16
FIFO reception threshold
Call the function HAL_SPI_DeInit() to restore the default configuration of the selected
SPIx peripheral.
This section contains the following APIs:
HAL_SPI_Init()
HAL_SPI_DeInit()
HAL_SPI_MspInit()
DocID026525 Rev 6
463/1320
HAL SPI Generic Driver
UM1785
HAL_SPI_MspDeInit()
39.2.3
IO operation functions
This subsection provides a set of functions allowing to manage the SPI data transfers.
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:
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_Abort()
HAL_SPI_Abort_IT()
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()
HAL_SPI_AbortCpltCallback()
39.2.4
Peripheral State and Errors functions
This subsection provides a set of functions allowing to control the SPI.
HAL_SPI_GetState() API can be helpful to check in run-time the state of the SPI
peripheral
HAL_SPI_GetError() check in run-time Errors occurring during communication
464/1320
DocID026525 Rev 6
UM1785
HAL SPI Generic Driver
This section contains the following APIs:
HAL_SPI_GetState()
HAL_SPI_GetError()
39.2.5
Detailed description of functions
HAL_SPI_Init
Function name
HAL_StatusTypeDef HAL_SPI_Init (SPI_HandleTypeDef * hspi)
Function description
Initialize the SPI according to the specified parameters in the
SPI_InitTypeDef and initialize 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
De-Initialize 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
Initialize the SPI MSP.
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
De-Initialize the SPI MSP.
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.
Parameters
hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
DocID026525 Rev 6
465/1320
HAL SPI Generic Driver
UM1785
pData: pointer to data buffer
Size: amount of data to be sent
Timeout: Timeout duration
Return values
HAL: status
HAL_SPI_Receive
Function name
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 received
Timeout: Timeout duration
Return values
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
Size: amount of data to be sent and received
Timeout: Timeout duration
Return values
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 non-blocking mode with Interrupt.
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
HAL_SPI_Receive_IT
466/1320
Function name
HAL_StatusTypeDef HAL_SPI_Receive_IT
(SPI_HandleTypeDef * hspi, uint8_t * pData, uint16_t Size)
Function description
Receive an amount of data in non-blocking mode with Interrupt.
DocID026525 Rev 6
UM1785
HAL SPI Generic Driver
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
HAL_SPI_TransmitReceive_IT
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 non-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
Size: amount of data to be sent and received
Return values
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 non-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
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 non-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
In case of MASTER mode and SPI_DIRECTION_2LINES
direction, hdmatx shall be defined.
When the CRC feature is enabled the pData Length must be
Size + 1.
DocID026525 Rev 6
467/1320
HAL SPI Generic Driver
UM1785
HAL_SPI_TransmitReceive_DMA
Function name
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 non-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
Pause 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
Resume 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
468/1320
Function name
HAL_StatusTypeDef HAL_SPI_DMAStop (SPI_HandleTypeDef
* hspi)
Function description
Stop 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
DocID026525 Rev 6
UM1785
HAL SPI Generic Driver
HAL_SPI_Abort
Function name
HAL_StatusTypeDef HAL_SPI_Abort (SPI_HandleTypeDef *
hspi)
Function description
Abort ongoing transfer (blocking mode).
Parameters
hspi: SPI handle.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing
transfer (Tx and Rx), started in Interrupt or DMA mode. This
procedure performs following operations : Disable SPI
Interrupts (depending of transfer direction)Disable the DMA
transfer in the peripheral register (if enabled)Abort DMA
transfer by calling HAL_DMA_Abort (in case of transfer in
DMA mode)Set handle State to READY
This procedure is executed in blocking mode : when exiting
function, Abort is considered as completed.
HAL_SPI_Abort_IT
Function name
HAL_StatusTypeDef HAL_SPI_Abort_IT (SPI_HandleTypeDef *
hspi)
Function description
Abort ongoing transfer (Interrupt mode).
Parameters
hspi: SPI handle.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing
transfer (Tx and Rx), started in Interrupt or DMA mode. This
procedure performs following operations : Disable SPI
Interrupts (depending of transfer direction)Disable the DMA
transfer in the peripheral register (if enabled)Abort DMA
transfer by calling HAL_DMA_Abort_IT (in case of transfer in
DMA mode)Set handle State to READYAt abort completion,
call user abort complete callback
This procedure is executed in Interrupt mode, meaning that
abort procedure could be considered as completed only when
user abort complete callback is executed (not when exiting
function).
HAL_SPI_IRQHandler
Function name
void HAL_SPI_IRQHandler (SPI_HandleTypeDef * hspi)
Function description
Handle SPI interrupt request.
Parameters
hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for the specified SPI module.
Return values
None
DocID026525 Rev 6
469/1320
HAL SPI Generic Driver
UM1785
HAL_SPI_TxCpltCallback
Function name
void HAL_SPI_TxCpltCallback (SPI_HandleTypeDef * hspi)
Function description
Tx Transfer completed callback.
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 callback.
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 callback.
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 callback.
Parameters
hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
Return values
None
HAL_SPI_RxHalfCpltCallback
470/1320
Function name
void HAL_SPI_RxHalfCpltCallback (SPI_HandleTypeDef *
hspi)
Function description
Rx Half Transfer completed callback.
Parameters
hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
Return values
None
DocID026525 Rev 6
UM1785
HAL SPI Generic Driver
HAL_SPI_TxRxHalfCpltCallback
Function name
void HAL_SPI_TxRxHalfCpltCallback (SPI_HandleTypeDef *
hspi)
Function description
Tx and Rx Half Transfer callback.
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 callback.
Parameters
hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
Return values
None
HAL_SPI_AbortCpltCallback
Function name
void HAL_SPI_AbortCpltCallback (SPI_HandleTypeDef * hspi)
Function description
SPI Abort Complete callback.
Parameters
hspi: SPI handle.
Return values
None
HAL_SPI_GetState
Function name
HAL_SPI_StateTypeDef HAL_SPI_GetState
(SPI_HandleTypeDef * hspi)
Function description
Return the SPI handle state.
Parameters
hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for SPI module.
Return values
SPI: 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 in bitmap format
DocID026525 Rev 6
471/1320
HAL SPI Generic Driver
UM1785
39.3
SPI Firmware driver defines
39.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
SPI_BAUDRATEPRESCALER_256
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 CRC Length
SPI_CRC_LENGTH_DATASIZE
SPI_CRC_LENGTH_8BIT
SPI_CRC_LENGTH_16BIT
SPI Data Size
SPI_DATASIZE_4BIT
SPI_DATASIZE_5BIT
SPI_DATASIZE_6BIT
SPI_DATASIZE_7BIT
SPI_DATASIZE_8BIT
SPI_DATASIZE_9BIT
SPI_DATASIZE_10BIT
SPI_DATASIZE_11BIT
SPI_DATASIZE_12BIT
SPI_DATASIZE_13BIT
SPI_DATASIZE_14BIT
472/1320
DocID026525 Rev 6
UM1785
HAL SPI Generic Driver
SPI_DATASIZE_15BIT
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
Error on RXNE/TXE/BSY/FTLVL/FRLVL Flag
HAL_SPI_ERROR_ABORT
Error during SPI Abort procedure
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:
None
__HAL_SPI_ENABLE_IT
Description:
Enable the specified SPI interrupts.
Parameters:
__HANDLE__: specifies the SPI Handle.
This parameter can be SPI where x: 1, 2, or
3 to select the SPI peripheral.
__INTERRUPT__: specifies the interrupt
source to enable. 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
DocID026525 Rev 6
473/1320
HAL SPI Generic Driver
__HAL_SPI_DISABLE_IT
UM1785
Description:
Disable the specified SPI interrupts.
Parameters:
__HANDLE__: specifies the SPI handle.
This parameter can be SPIx where x: 1, 2,
or 3 to select the SPI peripheral.
__INTERRUPT__: specifies the interrupt
source to 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_GET_IT_SOURCE
Description:
Check whether the specified SPI interrupt
source is enabled or not.
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:
The: new state of __IT__ (TRUE or FALSE).
__HAL_SPI_GET_FLAG
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
474/1320
DocID026525 Rev 6
UM1785
HAL SPI Generic Driver
SPI_FLAG_CRCERR: CRC error flag
SPI_FLAG_MODF: Mode fault flag
SPI_FLAG_OVR: Overrun flag
SPI_FLAG_BSY: Busy flag
SPI_FLAG_FRE: Frame format error
flag
SPI_FLAG_FTLVL: SPI fifo
transmission level
SPI_FLAG_FRLVL: SPI fifo reception
level
Return value:
The: new state of __FLAG__ (TRUE or
FALSE).
__HAL_SPI_CLEAR_CRCERRFLAG
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:
None
__HAL_SPI_CLEAR_MODFFLAG
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:
None
__HAL_SPI_CLEAR_OVRFLAG
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:
None
__HAL_SPI_CLEAR_FREFLAG
Description:
Clear the SPI FRE pending flag.
Parameters:
__HANDLE__: specifies the SPI Handle.
This parameter can be SPI where x: 1, 2, or
DocID026525 Rev 6
475/1320
HAL SPI Generic Driver
UM1785
3 to select the SPI peripheral.
Return value:
None
Description:
__HAL_SPI_ENABLE
Enable the SPI peripheral.
Parameters:
__HANDLE__: specifies the SPI Handle.
This parameter can be SPI where x: 1, 2, or
3 to select the SPI peripheral.
Return value:
None
Description:
__HAL_SPI_DISABLE
Disable the SPI peripheral.
Parameters:
__HANDLE__: specifies the SPI Handle.
This parameter can be SPI where x: 1, 2, or
3 to select the SPI peripheral.
Return value:
None
SPI FIFO Reception Threshold
SPI_RXFIFO_THRESHOLD
SPI_RXFIFO_THRESHOLD_QF
SPI_RXFIFO_THRESHOLD_HF
SPI Flags Definition
SPI_FLAG_RXNE
SPI_FLAG_TXE
SPI_FLAG_BSY
SPI_FLAG_CRCERR
SPI_FLAG_MODF
SPI_FLAG_OVR
SPI_FLAG_FRE
SPI_FLAG_FTLVL
SPI_FLAG_FRLVL
SPI Interrupt Definition
SPI_IT_TXE
SPI_IT_RXNE
SPI_IT_ERR
476/1320
DocID026525 Rev 6
UM1785
HAL SPI Generic Driver
SPI Mode
SPI_MODE_SLAVE
SPI_MODE_MASTER
SPI MSB LSB Transmission
SPI_FIRSTBIT_MSB
SPI_FIRSTBIT_LSB
SPI NSS Pulse Mode
SPI_NSS_PULSE_ENABLE
SPI_NSS_PULSE_DISABLE
SPI Reception FIFO Status Level
SPI_FRLVL_EMPTY
SPI_FRLVL_QUARTER_FULL
SPI_FRLVL_HALF_FULL
SPI_FRLVL_FULL
SPI Slave Select Management
SPI_NSS_SOFT
SPI_NSS_HARD_INPUT
SPI_NSS_HARD_OUTPUT
SPI TI Mode
SPI_TIMODE_DISABLE
SPI_TIMODE_ENABLE
SPI Transmission FIFO Status Level
SPI_FTLVL_EMPTY
SPI_FTLVL_QUARTER_FULL
SPI_FTLVL_HALF_FULL
SPI_FTLVL_FULL
DocID026525 Rev 6
477/1320
HAL SPI Extension Driver
UM1785
40
HAL SPI Extension Driver
40.1
SPIEx Firmware driver API description
40.1.1
IO operation functions
This subsection provides a set of extended functions to manage the SPI data transfers.
1.
Rx data flush function:
HAL_SPIEx_FlushRxFifo()
This section contains the following APIs:
HAL_SPIEx_FlushRxFifo()
40.1.2
Detailed description of functions
HAL_SPIEx_FlushRxFifo
478/1320
Function name
HAL_StatusTypeDef HAL_SPIEx_FlushRxFifo
(SPI_HandleTypeDef * hspi)
Function description
Flush the RX fifo.
Parameters
hspi: pointer to a SPI_HandleTypeDef structure that contains
the configuration information for the specified SPI module.
Return values
HAL: status
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
41
HAL TIM Generic Driver
41.1
TIM Firmware driver registers structures
41.1.1
TIM_Base_InitTypeDef
Data Fields
uint32_t Prescaler
uint32_t CounterMode
uint32_t Period
uint32_t ClockDivision
uint32_t RepetitionCounter
uint32_t AutoReloadPreload
Field Documentation
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.
uint32_t TIM_Base_InitTypeDef::AutoReloadPreload
Specifies the auto-reload preload. This parameter can be a value of
TIM_AutoReloadPreload
41.1.2
TIM_OC_InitTypeDef
Data Fields
uint32_t OCMode
uint32_t Pulse
uint32_t OCPolarity
uint32_t OCNPolarity
uint32_t OCFastMode
uint32_t OCIdleState
uint32_t OCNIdleState
DocID026525 Rev 6
479/1320
HAL TIM Generic Driver
Field Documentation
UM1785
uint32_t TIM_OC_InitTypeDef::OCMode
Specifies the TIM mode. This parameter can be a value of
TIM_Output_Compare_and_PWM_modes
uint32_t TIM_OC_InitTypeDef::Pulse
Specifies the pulse value to be loaded into the Capture Compare Register. This
parameter can be a number between Min_Data = 0x0000 and Max_Data = 0xFFFF
uint32_t TIM_OC_InitTypeDef::OCPolarity
Specifies the output polarity. This parameter can be a value of
TIM_Output_Compare_Polarity
uint32_t TIM_OC_InitTypeDef::OCNPolarity
Specifies the complementary output polarity. This parameter can be a value of
TIM_Output_Compare_N_Polarity
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.
41.1.3
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
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.
480/1320
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
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
41.1.4
TIM_IC_InitTypeDef
Data Fields
uint32_t ICPolarity
uint32_t ICSelection
uint32_t ICPrescaler
uint32_t ICFilter
Field Documentation
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
41.1.5
TIM_Encoder_InitTypeDef
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
DocID026525 Rev 6
481/1320
HAL TIM Generic Driver
Field Documentation
UM1785
uint32_t TIM_Encoder_InitTypeDef::EncoderMode
Specifies the active edge of the input signal. This parameter can be a value of
TIM_Encoder_Mode
uint32_t TIM_Encoder_InitTypeDef::IC1Polarity
Specifies the active edge of the 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
41.1.6
TIM_ClockConfigTypeDef
Data Fields
uint32_t ClockSource
uint32_t ClockPolarity
uint32_t ClockPrescaler
uint32_t ClockFilter
Field Documentation
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
41.1.7
TIM_ClearInputConfigTypeDef
Data Fields
uint32_t ClearInputState
uint32_t ClearInputSource
uint32_t ClearInputPolarity
uint32_t ClearInputPrescaler
482/1320
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
uint32_t ClearInputFilter
Field Documentation
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
TIMEx_Clock_Clear_Input_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
41.1.8
TIM_SlaveConfigTypeDef
Data Fields
uint32_t SlaveMode
uint32_t InputTrigger
uint32_t TriggerPolarity
uint32_t TriggerPrescaler
uint32_t TriggerFilter
Field Documentation
uint32_t TIM_SlaveConfigTypeDef::SlaveMode
Slave mode selection This parameter can be a value of TIM_Slave_Mode
uint32_t TIM_SlaveConfigTypeDef::InputTrigger
Input Trigger source This parameter can be a value of TIM_Trigger_Selection
uint32_t TIM_SlaveConfigTypeDef::TriggerPolarity
Input Trigger polarity This parameter can be a value of TIM_Trigger_Polarity
uint32_t TIM_SlaveConfigTypeDef::TriggerPrescaler
Input trigger prescaler This parameter can be a value of TIM_Trigger_Prescaler
uint32_t TIM_SlaveConfigTypeDef::TriggerFilter
Input trigger filter This parameter can be a number between Min_Data = 0x0 and
Max_Data = 0xF
41.1.9
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
DocID026525 Rev 6
483/1320
HAL TIM Generic Driver
UM1785
HAL_TIM_ActiveChannel TIM_HandleTypeDef::Channel
Active channel
DMA_HandleTypeDef* TIM_HandleTypeDef::hdma[7]
DMA Handlers array This array is accessed by a TIM_DMA_Handle_index
HAL_LockTypeDef TIM_HandleTypeDef::Lock
Locking object
__IO HAL_TIM_StateTypeDef TIM_HandleTypeDef::State
TIM operation state
41.2
TIM Firmware driver API description
41.2.1
TIMER Generic features
The Timer features include:
1.
2.
3.
41.2.2
How to use this driver
1.
2.
3.
4.
484/1320
16-bit up, down, up/down auto-reload counter.
16-bit programmable prescaler allowing dividing (also on the fly) the counter clock
frequency either by any factor between 1 and 65536.
Up to 4 independent channels for:
Input Capture
Output Compare
PWM generation (Edge and Center-aligned Mode)
One-pulse mode output
Initialize the TIM low level resources by implementing the following functions
depending from feature used :
Time Base : HAL_TIM_Base_MspInit()
Input Capture : HAL_TIM_IC_MspInit()
Output Compare : HAL_TIM_OC_MspInit()
PWM generation : HAL_TIM_PWM_MspInit()
One-pulse mode output : HAL_TIM_OnePulse_MspInit()
Encoder mode output : HAL_TIM_Encoder_MspInit()
Initialize the TIM low level resources :
a. Enable the TIM interface clock using __HAL_RCC_TIMx_CLK_ENABLE();
b. TIM pins configuration
Enable the clock for the TIM GPIOs using the following function:
__HAL_RCC_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.
DocID026525 Rev 6
UM1785
5.
6.
41.2.3
HAL TIM Generic Driver
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:
Initialize and configure the TIM base.
De-initialize the TIM base.
Start the Time Base.
Stop the Time Base.
Start the Time Base and enable interrupt.
Stop the Time Base and disable interrupt.
Start the Time Base and enable DMA transfer.
Stop the Time Base and disable DMA transfer.
This section contains the following APIs:
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()
41.2.4
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.
DocID026525 Rev 6
485/1320
HAL TIM Generic Driver
This section contains the following APIs:
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()
41.2.5
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.
Start the Time PWM and enable DMA transfer.
Stop the Time PWM and disable DMA transfer.
This section contains the following APIs:
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()
41.2.6
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:
HAL_TIM_IC_Init()
HAL_TIM_IC_DeInit()
HAL_TIM_IC_MspInit()
486/1320
DocID026525 Rev 6
UM1785
UM1785
HAL TIM Generic Driver
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()
41.2.7
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:
HAL_TIM_OnePulse_Init()
HAL_TIM_OnePulse_DeInit()
HAL_TIM_OnePulse_MspInit()
HAL_TIM_OnePulse_MspDeInit()
HAL_TIM_OnePulse_Start()
HAL_TIM_OnePulse_Stop()
HAL_TIM_OnePulse_Start_IT()
HAL_TIM_OnePulse_Stop_IT()
41.2.8
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:
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()
DocID026525 Rev 6
487/1320
HAL TIM Generic Driver
41.2.9
UM1785
IRQ handler management
This section provides Timer IRQ handler function.
This section contains the following APIs:
HAL_TIM_IRQHandler()
41.2.10
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()
HAL_TIM_DMABurst_WriteStart()
HAL_TIM_DMABurst_MultiWriteStart()
HAL_TIM_DMABurst_WriteStop()
HAL_TIM_DMABurst_ReadStart()
HAL_TIM_DMABurst_MultiReadStart()
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()
41.2.11
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:
HAL_TIM_PeriodElapsedCallback()
HAL_TIM_OC_DelayElapsedCallback()
HAL_TIM_IC_CaptureCallback()
HAL_TIM_PWM_PulseFinishedCallback()
HAL_TIM_TriggerCallback()
HAL_TIM_ErrorCallback()
488/1320
DocID026525 Rev 6
UM1785
41.2.12
HAL TIM Generic Driver
Peripheral State functions
This subsection permit to get in run-time the status of the peripheral and the data flow.
This section contains the following APIs:
HAL_TIM_Base_GetState()
HAL_TIM_OC_GetState()
HAL_TIM_PWM_GetState()
HAL_TIM_IC_GetState()
HAL_TIM_OnePulse_GetState()
HAL_TIM_Encoder_GetState()
41.2.13
Detailed description of functions
TIM_Base_SetConfig
Function name
void TIM_Base_SetConfig (TIM_TypeDef * TIMx,
TIM_Base_InitTypeDef * Structure)
Function description
Time Base configuration.
Parameters
TIMx: TIM periheral
Structure: TIM Base configuration structure
Return values
None
TIM_TI1_SetConfig
Function name
void TIM_TI1_SetConfig (TIM_TypeDef * TIMx, uint32_t
TIM_ICPolarity, uint32_t TIM_ICSelection, uint32_t
TIM_ICFilter)
Function description
Configure the TI1 as Input.
Parameters
TIMx: to select the TIM peripheral.
TIM_ICPolarity: The Input Polarity. This parameter can be
one of the following values:
TIM_ICPOLARITY_RISING
TIM_ICPOLARITY_FALLING
TIM_ICPOLARITY_BOTHEDGE
TIM_ICSelection: specifies the input to be used. This
parameter can be one of the following values:
TIM_ICSELECTION_DIRECTTI : TIM Input 1 is selected
to be connected to IC1.
TIM_ICSELECTION_INDIRECTTI : TIM Input 1 is
selected to be connected to IC2.
TIM_ICSELECTION_TRC : TIM Input 1 is selected to be
connected to TRC.
TIM_ICFilter: Specifies the Input Capture Filter. This
parameter must be a value between 0x00 and 0x0F.
Return values
None
Notes
TIM_ICFilter and TIM_ICPolarity are not used in INDIRECT
mode as TI2FP1 (on channel2 path) is used as the input
signal. Therefore CCMR1 must be protected against uninitialized filter and polarity values.
DocID026525 Rev 6
489/1320
HAL TIM Generic Driver
UM1785
TIM_OC2_SetConfig
Function name
void TIM_OC2_SetConfig (TIM_TypeDef * TIMx,
TIM_OC_InitTypeDef * OC_Config)
Function description
Time Ouput Compare 2 configuration.
Parameters
TIMx: to select the TIM peripheral
OC_Config: The ouput configuration structure
Return values
None
TIM_DMADelayPulseCplt
Function name
void TIM_DMADelayPulseCplt (DMA_HandleTypeDef * hdma)
Function description
TIM DMA Delay Pulse complete callback.
Parameters
hdma: pointer to DMA handle.
Return values
None
TIM_DMAError
Function name
void TIM_DMAError (DMA_HandleTypeDef * hdma)
Function description
TIM DMA error callback.
Parameters
hdma: pointer to DMA handle.
Return values
None
TIM_DMACaptureCplt
Function name
void TIM_DMACaptureCplt (DMA_HandleTypeDef * hdma)
Function description
TIM DMA Capture complete callback.
Parameters
hdma: pointer to DMA handle.
Return values
None
TIM_CCxChannelCmd
490/1320
Function name
void TIM_CCxChannelCmd (TIM_TypeDef * TIMx, uint32_t
Channel, uint32_t ChannelState)
Function description
Enables or disables the TIM Capture Compare Channel x.
Parameters
TIMx: to select the TIM peripheral
Channel: specifies the TIM Channel This parameter can be
one of the following values:
TIM_CHANNEL_1 : TIM Channel 1
TIM_CHANNEL_2 : TIM Channel 2
TIM_CHANNEL_3 : TIM Channel 3
TIM_CHANNEL_4 : TIM Channel 4
ChannelState: specifies the TIM Channel CCxE bit new
state. This parameter can be: TIM_CCx_ENABLE or
TIM_CCx_Disable.
Return values
None
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
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: TIM Base handle
Return values
HAL: status
HAL_TIM_Base_DeInit
Function name
HAL_StatusTypeDef HAL_TIM_Base_DeInit
(TIM_HandleTypeDef * htim)
Function description
DeInitializes the TIM Base peripheral.
Parameters
htim: TIM Base handle
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: TIM handle
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: TIM handle
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: TIM handle
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.
DocID026525 Rev 6
491/1320
HAL TIM Generic Driver
Parameters
UM1785
htim: TIM handle
Return values
HAL: status
HAL_TIM_Base_Start_IT
Function name
HAL_StatusTypeDef HAL_TIM_Base_Start_IT
(TIM_HandleTypeDef * htim)
Function description
Starts the TIM Base generation in interrupt mode.
Parameters
htim: TIM handle
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: TIM handle
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
htim: TIM handle
pData: The source Buffer address.
Length: The length of data to be transferred from memory to
peripheral.
Return values
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: TIM handle
Return values
HAL: status
HAL_TIM_OC_Init
492/1320
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.
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
Parameters
htim: TIM Output Compare handle
Return values
HAL: status
HAL_TIM_OC_DeInit
Function name
HAL_StatusTypeDef HAL_TIM_OC_DeInit
(TIM_HandleTypeDef * htim)
Function description
DeInitializes the TIM peripheral.
Parameters
htim: TIM Output Compare handle
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: TIM handle
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: TIM handle
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
htim: TIM Output Compare handle
Channel: TIM Channel to be enabled 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
Return values
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: TIM handle
Channel: TIM Channel to be disabled This parameter can be
DocID026525 Rev 6
493/1320
HAL TIM Generic Driver
UM1785
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
Return values
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: TIM OC handle
Channel: TIM Channel to be enabled 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
Return values
HAL: status
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
htim: TIM Output Compare handle
Channel: TIM Channel to be disabled 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
Return values
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
494/1320
htim: TIM Output Compare handle
Channel: TIM Channel to be enabled 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
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
TIM_CHANNEL_4: TIM Channel 4 selected
pData: The source Buffer address.
Length: The length of data to be transferred from memory to
TIM peripheral
Return values
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: TIM Output Compare handle
Channel: TIM Channel to be disabled 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
Return values
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: TIM handle
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: TIM handle
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: TIM handle
Return values
None
DocID026525 Rev 6
495/1320
HAL TIM Generic Driver
UM1785
HAL_TIM_PWM_MspDeInit
Function name
void HAL_TIM_PWM_MspDeInit (TIM_HandleTypeDef * htim)
Function description
DeInitializes TIM PWM MSP.
Parameters
htim: TIM handle
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
htim: TIM handle
Channel: TIM Channels to be enabled 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
Return values
HAL: status
HAL_TIM_PWM_Stop
Function name
HAL_StatusTypeDef HAL_TIM_PWM_Stop
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function description
Stops the PWM signal generation.
Parameters
htim: TIM handle
Channel: TIM Channels to be disabled 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
Return values
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
496/1320
htim: TIM handle
Channel: TIM Channel to be enabled 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
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
Return values
HAL: status
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
htim: TIM handle
Channel: TIM Channels to be disabled 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
Return values
HAL: status
HAL_TIM_PWM_Start_DMA
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
htim: TIM handle
Channel: TIM Channels to be enabled 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
pData: The source Buffer address.
Length: The length of data to be transferred from memory to
TIM peripheral
Return values
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
htim: TIM handle
Channel: TIM Channels to be disabled 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
Return values
HAL: status
DocID026525 Rev 6
497/1320
HAL TIM Generic Driver
UM1785
HAL_TIM_IC_Init
Function name
HAL_StatusTypeDef HAL_TIM_IC_Init (TIM_HandleTypeDef *
htim)
Function description
Initializes the TIM Input Capture Time base according to the
specified parameters in the TIM_HandleTypeDef and create the
associated handle.
Parameters
htim: TIM Input Capture handle
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: TIM Input Capture handle
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: TIM handle
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: TIM handle
Return values
None
HAL_TIM_IC_Start
498/1320
Function name
HAL_StatusTypeDef HAL_TIM_IC_Start (TIM_HandleTypeDef *
htim, uint32_t Channel)
Function description
Starts the TIM Input Capture measurement.
Parameters
htim: TIM Input Capture handle
Channel: TIM Channels to be enabled 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
Return values
HAL: status
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
HAL_TIM_IC_Stop
Function name
HAL_StatusTypeDef HAL_TIM_IC_Stop (TIM_HandleTypeDef *
htim, uint32_t Channel)
Function description
Stops the TIM Input Capture measurement.
Parameters
htim: TIM handle
Channel: TIM Channels to be disabled 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
Return values
HAL: status
HAL_TIM_IC_Start_IT
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
htim: TIM Input Capture handle
Channel: TIM Channels to be enabled 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
Return values
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
htim: TIM handle
Channel: TIM Channels to be disabled 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
Return values
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 in DMA mode.
DocID026525 Rev 6
499/1320
HAL TIM Generic Driver
Parameters
UM1785
htim: TIM Input Capture handle
Channel: TIM Channels to be enabled 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
pData: The destination Buffer address.
Length: The length of data to be transferred from TIM
peripheral to memory.
Return values
HAL: status
HAL_TIM_IC_Stop_DMA
Function name
HAL_StatusTypeDef HAL_TIM_IC_Stop_DMA
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function description
Stops the TIM Input Capture measurement in DMA mode.
Parameters
htim: TIM Input Capture handle
Channel: TIM Channels to be disabled 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
Return values
HAL: status
HAL_TIM_OnePulse_Init
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
htim: TIM OnePulse handle
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 wil be
generated.
Return values
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
500/1320
htim: TIM One Pulse handle
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
Return values
HAL: status
HAL_TIM_OnePulse_MspInit
Function name
void HAL_TIM_OnePulse_MspInit (TIM_HandleTypeDef * htim)
Function description
Initializes the TIM One Pulse MSP.
Parameters
htim: TIM handle
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: TIM handle
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
htim: TIM One Pulse handle
OutputChannel: TIM Channels to be enabled This
parameter can be one of the following values:
TIM_CHANNEL_1: TIM Channel 1 selected
TIM_CHANNEL_2: TIM Channel 2 selected
Return values
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
htim: TIM One Pulse handle
OutputChannel: TIM Channels to be disable This parameter
can be one of the following values:
TIM_CHANNEL_1: TIM Channel 1 selected
TIM_CHANNEL_2: TIM Channel 2 selected
Return values
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.
DocID026525 Rev 6
501/1320
HAL TIM Generic Driver
Parameters
UM1785
htim: TIM One Pulse handle
OutputChannel: TIM Channels to be enabled This
parameter can be one of the following values:
TIM_CHANNEL_1: TIM Channel 1 selected
TIM_CHANNEL_2: TIM Channel 2 selected
Return values
HAL: status
HAL_TIM_OnePulse_Stop_IT
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
htim: TIM One Pulse handle
OutputChannel: TIM Channels to be enabled This
parameter can be one of the following values:
TIM_CHANNEL_1: TIM Channel 1 selected
TIM_CHANNEL_2: TIM Channel 2 selected
Return values
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
htim: TIM Encoder Interface handle
sConfig: TIM Encoder Interface configuration structure
Return values
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: TIM Encoder handle
Return values
HAL: status
HAL_TIM_Encoder_MspInit
502/1320
Function name
void HAL_TIM_Encoder_MspInit (TIM_HandleTypeDef * htim)
Function description
Initializes the TIM Encoder Interface MSP.
Parameters
htim: TIM handle
Return values
None
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
HAL_TIM_Encoder_MspDeInit
Function name
void HAL_TIM_Encoder_MspDeInit (TIM_HandleTypeDef *
htim)
Function description
DeInitializes TIM Encoder Interface MSP.
Parameters
htim: TIM handle
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
htim: TIM Encoder Interface handle
Channel: TIM Channels to be enabled 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_ALL: TIM Channel 1 and TIM Channel 2
are selected
Return values
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
htim: TIM Encoder Interface handle
Channel: TIM Channels to be disabled 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_ALL: TIM Channel 1 and TIM Channel 2
are selected
Return values
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: TIM Encoder Interface handle
Channel: TIM Channels to be enabled 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_ALL: TIM Channel 1 and TIM Channel 2
are selected
DocID026525 Rev 6
503/1320
HAL TIM Generic Driver
Return values
UM1785
HAL: status
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
htim: TIM Encoder Interface handle
Channel: TIM Channels to be disabled 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_ALL: TIM Channel 1 and TIM Channel 2
are selected
Return values
HAL: status
HAL_TIM_Encoder_Start_DMA
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
htim: TIM Encoder Interface handle
Channel: TIM Channels to be enabled 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_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.
Return values
HAL: status
HAL_TIM_Encoder_Stop_DMA
504/1320
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
htim: TIM Encoder Interface handle
Channel: TIM Channels to be enabled 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_ALL: TIM Channel 1 and TIM Channel 2
are selected
Return values
HAL: status
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
HAL_TIM_IRQHandler
Function name
void HAL_TIM_IRQHandler (TIM_HandleTypeDef * htim)
Function description
This function handles TIM interrupts requests.
Parameters
htim: TIM handle
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
htim: TIM Output Compare handle
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 selected
TIM_CHANNEL_2: TIM Channel 2 selected
TIM_CHANNEL_3: TIM Channel 3 selected
TIM_CHANNEL_4: TIM Channel 4 selected
Return values
HAL: status
HAL_TIM_PWM_ConfigChannel
Function name
HAL_StatusTypeDef HAL_TIM_PWM_ConfigChannel
(TIM_HandleTypeDef * htim, TIM_OC_InitTypeDef * sConfig,
uint32_t Channel)
Function description
Initializes the TIM PWM channels according to the specified
parameters in the TIM_OC_InitTypeDef.
Parameters
htim: TIM handle
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 selected
TIM_CHANNEL_2: TIM Channel 2 selected
TIM_CHANNEL_3: TIM Channel 3 selected
TIM_CHANNEL_4: TIM Channel 4 selected
Return values
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.
DocID026525 Rev 6
505/1320
HAL TIM Generic Driver
Parameters
Return values
UM1785
htim: TIM IC handle
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 selected
TIM_CHANNEL_2: TIM Channel 2 selected
TIM_CHANNEL_3: TIM Channel 3 selected
TIM_CHANNEL_4: TIM Channel 4 selected
HAL: status
HAL_TIM_OnePulse_ConfigChannel
Function name
HAL_StatusTypeDef HAL_TIM_OnePulse_ConfigChannel
(TIM_HandleTypeDef * htim, TIM_OnePulse_InitTypeDef *
sConfig, uint32_t OutputChannel, uint32_t InputChannel)
Function description
Initializes the TIM One Pulse Channels according to the specified
parameters in the TIM_OnePulse_InitTypeDef.
Parameters
htim: TIM One Pulse handle
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 selected
TIM_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 selected
TIM_CHANNEL_2: TIM Channel 2 selected
Return values
HAL: status
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
506/1320
htim: TIM handle
sClearInputConfig: pointer to a
TIM_ClearInputConfigTypeDef structure that contains the
OCREF clear feature and parameters for the TIM peripheral.
Channel: specifies the TIM Channel This parameter can be
one of the following values:
TIM_CHANNEL_1: TIM Channel 1
TIM_CHANNEL_2: TIM Channel 2
TIM_CHANNEL_3: TIM Channel 3
TIM_CHANNEL_4: TIM Channel 4
htim: TIM handle
sClearInputConfig: pointer to a
TIM_ClearInputConfigTypeDef structure that contains the
OCREF clear feature and parameters for the TIM peripheral.
Channel: specifies the TIM Channel This parameter can be
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
one of the following values:
TIM_CHANNEL_1: TIM Channel 1
TIM_CHANNEL_2: TIM Channel 2
TIM_CHANNEL_3: TIM Channel 3
TIM_CHANNEL_4: TIM Channel 4
TIM_Channel_5: TIM Channel 5
Return values
HAL: status
None
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
htim: TIM handle
sClockSourceConfig: pointer to a TIM_ClockConfigTypeDef
structure that contains the clock source information for the
TIM peripheral.
Return values
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: TIM handle.
TI1_Selection: Indicate whether or not channel 1 is
connected to the output of a XOR gate. This parameter can
be one of the following values:
TIM_TI1SELECTION_CH1: The TIMx_CH1 pin is
connected to TI1 input
TIM_TI1SELECTION_XORCOMBINATION: The
TIMx_CH1, CH2 and CH3 pins are connected to the TI1
input (XOR combination)
Return values
HAL: status
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
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 )
DocID026525 Rev 6
507/1320
HAL TIM Generic Driver
Return values
UM1785
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_DMABurst_WriteStart
Function name
HAL_StatusTypeDef HAL_TIM_DMABurst_WriteStart
(TIM_HandleTypeDef * htim, uint32_t BurstBaseAddress,
uint32_t BurstRequestSrc, uint32_t * BurstBuffer, uint32_t
BurstLength)
Function description
Configure the DMA Burst to transfer Data from the memory to the
TIM peripheral.
Parameters
508/1320
htim: TIM handle
BurstBaseAddress: TIM Base address from where the DMA
will start the Data write This parameter can be one of the
following values:
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
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
BurstRequestSrc: TIM DMA Request sources This
parameter can be one of the following values:
TIM_DMA_UPDATE: TIM update Interrupt source
TIM_DMA_CC1: TIM Capture Compare 1 DMA source
TIM_DMA_CC2: TIM Capture Compare 2 DMA source
TIM_DMA_CC3: TIM Capture Compare 3 DMA source
TIM_DMA_CC4: TIM Capture Compare 4 DMA source
TIM_DMA_COM: TIM Commutation DMA source
TIM_DMA_TRIGGER: TIM Trigger DMA source
BurstBuffer: The Buffer address.
BurstLength: DMA Burst length. This parameter can be one
value between: TIM_DMABURSTLENGTH_1TRANSFER and
TIM_DMABURSTLENGTH_18TRANSFERS.
Return values
HAL: status
HAL_TIM_DMABurst_MultiWriteStart
Function name
HAL_StatusTypeDef HAL_TIM_DMABurst_MultiWriteStart
(TIM_HandleTypeDef * htim, uint32_t BurstBaseAddress,
uint32_t BurstRequestSrc, uint32_t * BurstBuffer, uint32_t
BurstLength, uint32_t DataLength)
Function description
Configure the DMA Burst to transfer multiple Data from the
memory to the TIM peripheral.
Parameters
htim: TIM handle
BurstBaseAddress: TIM Base address from where the DMA
will start the Data write This parameter can be one of the
following values:
TIM_DMABASE_CR1
TIM_DMABASE_CR2
TIM_DMABASE_SMCR
TIM_DMABASE_DIER
TIM_DMABASE_SR
TIM_DMABASE_EGR
TIM_DMABASE_CCMR1
TIM_DMABASE_CCMR2
TIM_DMABASE_CCER
TIM_DMABASE_CNT
TIM_DMABASE_PSC
TIM_DMABASE_ARR
TIM_DMABASE_RCR
TIM_DMABASE_CCR1
TIM_DMABASE_CCR2
TIM_DMABASE_CCR3
TIM_DMABASE_CCR4
TIM_DMABASE_BDTR
TIM_DMABASE_DCR
BurstRequestSrc: TIM DMA Request sources This
parameter can be one of the following values:
TIM_DMA_UPDATE: TIM update Interrupt source
TIM_DMA_CC1: TIM Capture Compare 1 DMA source
TIM_DMA_CC2: TIM Capture Compare 2 DMA source
DocID026525 Rev 6
509/1320
HAL TIM Generic Driver
UM1785
TIM_DMA_CC3: TIM Capture Compare 3 DMA source
TIM_DMA_CC4: TIM Capture Compare 4 DMA source
TIM_DMA_COM: TIM Commutation DMA source
TIM_DMA_TRIGGER: TIM Trigger DMA source
BurstBuffer: The Buffer address.
BurstLength: DMA Burst length. This parameter can be one
value between: TIM_DMABURSTLENGTH_1TRANSFER and
TIM_DMABURSTLENGTH_18TRANSFERS.
DataLength: Data length. This parameter can be one value
between 1 and 0xFFFF.
Return values
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
htim: TIM handle
BurstRequestSrc: TIM DMA Request sources to disable
Return values
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
510/1320
htim: TIM handle
BurstBaseAddress: TIM Base address from where the DMA
will starts the Data read This parameter can be one of the
following values:
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
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
TIM_DMABASE_BDTR
TIM_DMABASE_DCR
BurstRequestSrc: TIM DMA Request sources This
parameter can be one of the following values:
TIM_DMA_UPDATE: TIM update Interrupt source
TIM_DMA_CC1: TIM Capture Compare 1 DMA source
TIM_DMA_CC2: TIM Capture Compare 2 DMA source
TIM_DMA_CC3: TIM Capture Compare 3 DMA source
TIM_DMA_CC4: TIM Capture Compare 4 DMA source
TIM_DMA_COM: TIM Commutation DMA source
TIM_DMA_TRIGGER: TIM Trigger DMA source
BurstBuffer: The Buffer address.
BurstLength: DMA Burst length. This parameter can be one
value between: TIM_DMABURSTLENGTH_1TRANSFER and
TIM_DMABURSTLENGTH_18TRANSFERS.
Return values
HAL: status
HAL_TIM_DMABurst_MultiReadStart
Function name
HAL_StatusTypeDef HAL_TIM_DMABurst_MultiReadStart
(TIM_HandleTypeDef * htim, uint32_t BurstBaseAddress,
uint32_t BurstRequestSrc, uint32_t * BurstBuffer, uint32_t
BurstLength, uint32_t DataLength)
Function description
Configure the DMA Burst to transfer multiple Data from the TIM
peripheral to the memory.
Parameters
htim: TIM handle
BurstBaseAddress: TIM Base address from where the DMA
will starts the Data read This parameter can be one of the
following values:
TIM_DMABASE_CR1
TIM_DMABASE_CR2
TIM_DMABASE_SMCR
TIM_DMABASE_DIER
TIM_DMABASE_SR
TIM_DMABASE_EGR
TIM_DMABASE_CCMR1
TIM_DMABASE_CCMR2
TIM_DMABASE_CCER
TIM_DMABASE_CNT
TIM_DMABASE_PSC
TIM_DMABASE_ARR
TIM_DMABASE_RCR
TIM_DMABASE_CCR1
TIM_DMABASE_CCR2
TIM_DMABASE_CCR3
TIM_DMABASE_CCR4
TIM_DMABASE_BDTR
TIM_DMABASE_DCR
BurstRequestSrc: TIM DMA Request sources This
parameter can be one of the following values:
TIM_DMA_UPDATE: TIM update Interrupt source
DocID026525 Rev 6
511/1320
HAL TIM Generic Driver
UM1785
TIM_DMA_CC1: TIM Capture Compare 1 DMA source
TIM_DMA_CC2: TIM Capture Compare 2 DMA source
TIM_DMA_CC3: TIM Capture Compare 3 DMA source
TIM_DMA_CC4: TIM Capture Compare 4 DMA source
TIM_DMA_COM: TIM Commutation DMA source
TIM_DMA_TRIGGER: TIM Trigger DMA source
BurstBuffer: The Buffer address.
BurstLength: DMA Burst length. This parameter can be one
value between: TIM_DMABURSTLENGTH_1TRANSFER and
TIM_DMABURSTLENGTH_18TRANSFERS.
DataLength: Data length. This parameter can be one value
between 1 and 0xFFFF.
Return values
HAL: status
HAL_TIM_DMABurst_ReadStop
Function name
HAL_StatusTypeDef HAL_TIM_DMABurst_ReadStop
(TIM_HandleTypeDef * htim, uint32_t BurstRequestSrc)
Function description
Stop the DMA burst reading.
Parameters
htim: TIM handle
BurstRequestSrc: TIM DMA Request sources to disable.
Return values
HAL: status
HAL_TIM_GenerateEvent
512/1320
Function name
HAL_StatusTypeDef HAL_TIM_GenerateEvent
(TIM_HandleTypeDef * htim, uint32_t EventSource)
Function description
Generate a software event.
Parameters
htim: TIM handle
EventSource: specifies the event source. This parameter
can be one of the following values:
TIM_EVENTSOURCE_UPDATE: Timer update Event
source
TIM_EVENTSOURCE_CC1: Timer Capture Compare 1
Event source
TIM_EVENTSOURCE_CC2: Timer Capture Compare 2
Event source
TIM_EVENTSOURCE_CC3: Timer Capture Compare 3
Event source
TIM_EVENTSOURCE_CC4: Timer Capture Compare 4
Event source
TIM_EVENTSOURCE_COM: Timer COM event source
TIM_EVENTSOURCE_TRIGGER: Timer Trigger Event
source
TIM_EVENTSOURCE_BREAK: Timer Break event
source
Return values
HAL: status
Notes
TIM6 and TIM7 can only generate an update event.
TIM_EVENTSOURCE_COM and
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
TIM_EVENTSOURCE_BREAK are used only with TIM1,
TIM15, TIM16 and TIM17.
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
htim: TIM handle.
Channel: TIM Channels to be enabled 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
Return values
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: TIM handle
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: TIM OC handle
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: TIM IC handle
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.
DocID026525 Rev 6
513/1320
HAL TIM Generic Driver
Parameters
UM1785
htim: TIM handle
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: TIM handle
Return values
None
HAL_TIM_ErrorCallback
Function name
void HAL_TIM_ErrorCallback (TIM_HandleTypeDef * htim)
Function description
Timer error callback in non blocking mode.
Parameters
htim: TIM handle
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: TIM Base handle
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: TIM Ouput Compare handle
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: TIM handle
Return values
HAL: state
HAL_TIM_IC_GetState
Function name
514/1320
HAL_TIM_StateTypeDef HAL_TIM_IC_GetState
(TIM_HandleTypeDef * htim)
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
Function description
Return the TIM Input Capture state.
Parameters
htim: TIM IC handle
Return values
HAL: state
HAL_TIM_OnePulse_GetState
Function name
HAL_TIM_StateTypeDef HAL_TIM_OnePulse_GetState
(TIM_HandleTypeDef * htim)
Function description
Return the TIM One Pulse Mode state.
Parameters
htim: TIM OPM handle
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: TIM Encoder handle
Return values
HAL: state
TIM_ETR_SetConfig
Function name
void TIM_ETR_SetConfig (TIM_TypeDef * TIMx, uint32_t
TIM_ExtTRGPrescaler, uint32_t TIM_ExtTRGPolarity, uint32_t
ExtTRGFilter)
Function description
Configures the TIMx External Trigger (ETR).
Parameters
TIMx: to select the TIM peripheral
TIM_ExtTRGPrescaler: The external Trigger Prescaler. This
parameter can be one of the following values:
TIM_ETRPRESCALER_DIV1 : ETRP Prescaler OFF.
TIM_ETRPRESCALER_DIV2 : ETRP frequency divided
by 2.
TIM_ETRPRESCALER_DIV4 : ETRP frequency divided
by 4.
TIM_ETRPRESCALER_DIV8 : ETRP frequency divided
by 8.
TIM_ExtTRGPolarity: The external Trigger Polarity. This
parameter can be one of the following values:
TIM_ETRPOLARITY_INVERTED : active low or falling
edge active.
TIM_ETRPOLARITY_NONINVERTED : active high or
rising edge active.
ExtTRGFilter: External Trigger Filter. This parameter must
be a value between 0x00 and 0x0F
Return values
None
DocID026525 Rev 6
515/1320
HAL TIM Generic Driver
UM1785
41.3
TIM Firmware driver defines
41.3.1
TIM
TIM Automatic Output Enable
TIM_AUTOMATICOUTPUT_ENABLE
TIM_AUTOMATICOUTPUT_DISABLE
TIM Auto-Reload Preload
TIM_AUTORELOAD_PRELOAD_DISABLE
TIMx_ARR register is not buffered
TIM_AUTORELOAD_PRELOAD_ENABLE
TIMx_ARR register is buffered
TIM Break Input Enable Disable
TIM_BREAK_ENABLE
TIM_BREAK_DISABLE
TIM Break Input 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 Capture/Compare Channel State
TIM_CCx_ENABLE
TIM_CCx_DISABLE
TIM_CCxN_ENABLE
TIM_CCxN_DISABLE
TIM Clear Input Polarity
TIM_CLEARINPUTPOLARITY_INVERTED
Polarity for ETRx pin
TIM_CLEARINPUTPOLARITY_NONINVERTED
Polarity for ETRx pin
TIM Clear Input Prescaler
516/1320
TIM_CLEARINPUTPRESCALER_DIV1
No prescaler is used
TIM_CLEARINPUTPRESCALER_DIV2
Prescaler for External ETR pin: Capture
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.
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
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
TIM_COMMUTATION_TRGI
TIM_COMMUTATION_SOFTWARE
TIM Counter Mode
TIM_COUNTERMODE_UP
TIM_COUNTERMODE_DOWN
TIM_COUNTERMODE_CENTERALIGNED1
TIM_COUNTERMODE_CENTERALIGNED2
DocID026525 Rev 6
517/1320
HAL TIM Generic Driver
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
TIM_DMABURSTLENGTH_7TRANSFERS
TIM_DMABURSTLENGTH_8TRANSFERS
TIM_DMABURSTLENGTH_9TRANSFERS
TIM_DMABURSTLENGTH_10TRANSFERS
TIM_DMABURSTLENGTH_11TRANSFERS
TIM_DMABURSTLENGTH_12TRANSFERS
TIM_DMABURSTLENGTH_13TRANSFERS
518/1320
DocID026525 Rev 6
UM1785
UM1785
HAL TIM Generic Driver
TIM_DMABURSTLENGTH_14TRANSFERS
TIM_DMABURSTLENGTH_15TRANSFERS
TIM_DMABURSTLENGTH_16TRANSFERS
TIM_DMABURSTLENGTH_17TRANSFERS
TIM_DMABURSTLENGTH_18TRANSFERS
TIM DMA Handle Index
TIM_DMA_ID_UPDATE
Index of the DMA handle used for Update DMA requests
TIM_DMA_ID_CC1
Index of the DMA handle used for Capture/Compare 1
DMA requests
TIM_DMA_ID_CC2
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
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
DocID026525 Rev 6
519/1320
HAL TIM Generic Driver
TIM Event Source
UM1785
TIM_EVENTSOURCE_UPDATE
TIM_EVENTSOURCE_CC1
TIM_EVENTSOURCE_CC2
TIM_EVENTSOURCE_CC3
TIM_EVENTSOURCE_CC4
TIM_EVENTSOURCE_COM
TIM_EVENTSOURCE_TRIGGER
TIM_EVENTSOURCE_BREAK
TIM Exported Macros
__HAL_TIM_RESET_HANDLE_
STATE
Description:
Reset TIM handle state.
Parameters:
__HANDLE__: TIM handle.
Return value:
None
__HAL_TIM_ENABLE
Description:
Enable the TIM peripheral.
Parameters:
__HANDLE__: TIM handle
Return value:
None
__HAL_TIM_MOE_ENABLE
Description:
Enable the TIM main Output.
Parameters:
__HANDLE__: TIM handle
Return value:
None
__HAL_TIM_DISABLE
Description:
Disable the TIM peripheral.
Parameters:
__HANDLE__: TIM handle
Return value:
None
520/1320
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
__HAL_TIM_MOE_DISABLE
Description:
Disable the TIM main Output.
Parameters:
__HANDLE__: TIM handle
Return value:
None
Notes:
The Main Output Enable of a timer instance is
disabled only if all the CCx and CCxN channels
have been disabled
__HAL_TIM_MOE_DISABLE_
UNCONDITIONALLY
Description:
Disable the TIM main Output.
Parameters:
__HANDLE__: TIM handle
Return value:
None
Notes:
The Main Output Enable of a timer instance is
disabled uncondiotionally
__HAL_TIM_ENABLE_IT
Description:
Enables the specified TIM interrupt.
Parameters:
__HANDLE__: specifies the TIM Handle.
__INTERRUPT__: specifies the TIM interrupt
source to enable. This parameter can be one of
the following values:
TIM_IT_UPDATE: Update interrupt
TIM_IT_CC1: Capture/Compare 1 interrupt
TIM_IT_CC2: Capture/Compare 2 interrupt
TIM_IT_CC3: Capture/Compare 3 interrupt
TIM_IT_CC4: Capture/Compare 4 interrupt
TIM_IT_COM: Commutation interrupt
TIM_IT_TRIGGER: Trigger interrupt
TIM_IT_BREAK: Break interrupt
Return value:
None
__HAL_TIM_DISABLE_IT
Description:
Disables the specified TIM interrupt.
Parameters:
__HANDLE__: specifies the TIM Handle.
__INTERRUPT__: specifies the TIM interrupt
DocID026525 Rev 6
521/1320
HAL TIM Generic Driver
UM1785
source to disable. This parameter can be one of
the following values:
TIM_IT_UPDATE: Update interrupt
TIM_IT_CC1: Capture/Compare 1 interrupt
TIM_IT_CC2: Capture/Compare 2 interrupt
TIM_IT_CC3: Capture/Compare 3 interrupt
TIM_IT_CC4: Capture/Compare 4 interrupt
TIM_IT_COM: Commutation interrupt
TIM_IT_TRIGGER: Trigger interrupt
TIM_IT_BREAK: Break interrupt
Return value:
None
Description:
__HAL_TIM_ENABLE_DMA
Enables the specified DMA request.
Parameters:
__HANDLE__: specifies the TIM Handle.
__DMA__: specifies the TIM DMA request to
enable. This parameter can be one of the
following values:
TIM_DMA_UPDATE: Update DMA request
TIM_DMA_CC1: Capture/Compare 1 DMA
request
TIM_DMA_CC2: Capture/Compare 2 DMA
request
TIM_DMA_CC3: Capture/Compare 3 DMA
request
TIM_DMA_CC4: Capture/Compare 4 DMA
request
TIM_DMA_COM: Commutation DMA
request
TIM_DMA_TRIGGER: Trigger DMA
request
Return value:
None
__HAL_TIM_DISABLE_DMA
Description:
Disables the specified DMA request.
Parameters:
__HANDLE__: specifies the TIM Handle.
__DMA__: specifies the TIM DMA request to
disable. This parameter can be one of the
following values:
TIM_DMA_UPDATE: Update DMA request
TIM_DMA_CC1: Capture/Compare 1 DMA
request
TIM_DMA_CC2: Capture/Compare 2 DMA
request
TIM_DMA_CC3: Capture/Compare 3 DMA
request
522/1320
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
TIM_DMA_CC4: Capture/Compare 4 DMA
request
TIM_DMA_COM: Commutation DMA
request
TIM_DMA_TRIGGER: Trigger DMA
request
Return value:
None
__HAL_TIM_GET_FLAG
Description:
Checks whether the specified TIM interrupt flag
is set or not.
Parameters:
__HANDLE__: specifies the TIM Handle.
__FLAG__: specifies the TIM interrupt flag to
check. This parameter can be one of the
following values:
TIM_FLAG_UPDATE: Update interrupt flag
TIM_FLAG_CC1: Capture/Compare 1
interrupt flag
TIM_FLAG_CC2: Capture/Compare 2
interrupt flag
TIM_FLAG_CC3: Capture/Compare 3
interrupt flag
TIM_FLAG_CC4: Capture/Compare 4
interrupt flag
TIM_FLAG_COM: Commutation interrupt
flag
TIM_FLAG_TRIGGER: Trigger interrupt
flag
TIM_FLAG_BREAK: Break interrupt flag
TIM_FLAG_CC1OF: Capture/Compare 1
overcapture flag
TIM_FLAG_CC2OF: Capture/Compare 2
overcapture flag
TIM_FLAG_CC3OF: Capture/Compare 3
overcapture flag
TIM_FLAG_CC4OF: Capture/Compare 4
overcapture flag
Return value:
The: new state of __FLAG__ (TRUE or FALSE).
__HAL_TIM_CLEAR_FLAG
Description:
Clears the specified TIM interrupt flag.
Parameters:
__HANDLE__: specifies the TIM Handle.
__FLAG__: specifies the TIM interrupt flag to
clear. This parameter can be one of the
following values:
TIM_FLAG_UPDATE: Update interrupt flag
DocID026525 Rev 6
523/1320
HAL TIM Generic Driver
UM1785
TIM_FLAG_CC1: Capture/Compare 1
interrupt flag
TIM_FLAG_CC2: Capture/Compare 2
interrupt flag
TIM_FLAG_CC3: Capture/Compare 3
interrupt flag
TIM_FLAG_CC4: Capture/Compare 4
interrupt flag
TIM_FLAG_COM: Commutation interrupt
flag
TIM_FLAG_TRIGGER: Trigger interrupt
flag
TIM_FLAG_BREAK: Break interrupt flag
TIM_FLAG_CC1OF: Capture/Compare 1
overcapture flag
TIM_FLAG_CC2OF: Capture/Compare 2
overcapture flag
TIM_FLAG_CC3OF: Capture/Compare 3
overcapture flag
TIM_FLAG_CC4OF: Capture/Compare 4
overcapture flag
Return value:
The: new state of __FLAG__ (TRUE or FALSE).
__HAL_TIM_GET_IT_SOURCE
Description:
Checks whether the specified TIM interrupt has
occurred or not.
Parameters:
__HANDLE__: TIM handle
__INTERRUPT__: specifies the TIM interrupt
source to check.
Return value:
The: state of TIM_IT (SET or RESET).
Description:
__HAL_TIM_CLEAR_IT
Clear the TIM interrupt pending bits.
Parameters:
__HANDLE__: TIM handle
__INTERRUPT__: specifies the interrupt
pending bit to clear.
Return value:
None
__HAL_TIM_IS_TIM_COUNTING_
DOWN
Description:
Indicates whether or not the TIM Counter is
used as downcounter.
Parameters:
524/1320
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
__HANDLE__: TIM handle.
Return value:
False: (Counter used as upcounter) or True
(Counter used as downcounter)
Notes:
This macro is particularly usefull to get the
counting mode when the timer operates in
Center-aligned mode or Encoder mode.
__HAL_TIM_SET_PRESCALER
Description:
Sets the TIM active prescaler register value on
update event.
Parameters:
__HANDLE__: TIM handle.
__PRESC__: specifies the active prescaler
register new value.
Return value:
None
__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:
None
__HAL_TIM_GET_COMPARE
Description:
Gets the TIM Capture Compare Register value
on runtime.
Parameters:
__HANDLE__: TIM handle.
__CHANNEL__: TIM Channel associated with
DocID026525 Rev 6
525/1320
HAL TIM Generic Driver
UM1785
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:
16-bit: or 32-bit value of the capture/compare
register (TIMx_CCRy)
__HAL_TIM_SET_COUNTER
Description:
Sets the TIM Counter Register value on
runtime.
Parameters:
__HANDLE__: TIM handle.
__COUNTER__: specifies the Counter register
new value.
Return value:
None
__HAL_TIM_GET_COUNTER
Description:
Gets the TIM Counter Register value on
runtime.
Parameters:
__HANDLE__: TIM handle.
Return value:
16-bit: or 32-bit value of the timer counter
register (TIMx_CNT)
__HAL_TIM_SET_AUTORELOAD
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:
None
__HAL_TIM_GET_AUTORELOAD
Description:
Gets the TIM Autoreload Register value on
526/1320
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
runtime.
Parameters:
__HANDLE__: TIM handle.
Return value:
16-bit: or 32-bit value of the timer auto-reload
register(TIMx_ARR)
__HAL_TIM_SET_CLOCK
DIVISION
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:
tDTS=tCK_INT
TIM_CLOCKDIVISION_DIV2:
tDTS=2*tCK_INT
TIM_CLOCKDIVISION_DIV4:
tDTS=4*tCK_INT
Return value:
None
__HAL_TIM_GET_CLOCK
DIVISION
Description:
Gets the TIM Clock Division value on runtime.
Parameters:
__HANDLE__: TIM handle.
Return value:
The: clock division can be one of the following
values:
TIM_CLOCKDIVISION_DIV1:
tDTS=tCK_INT
TIM_CLOCKDIVISION_DIV2:
tDTS=2*tCK_INT
TIM_CLOCKDIVISION_DIV4:
tDTS=4*tCK_INT
__HAL_TIM_ENABLE_OCx
PRELOAD
Description:
Sets the TIM Output compare preload.
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
DocID026525 Rev 6
527/1320
HAL TIM Generic Driver
UM1785
TIM_CHANNEL_2: TIM Channel 2
selected
TIM_CHANNEL_3: TIM Channel 3
selected
TIM_CHANNEL_4: TIM Channel 4
selected
Return value:
None
Description:
__HAL_TIM_DISABLE_OCx
PRELOAD
Resets the TIM Output compare preload.
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
Return value:
None
__HAL_TIM_SET_ICPRESCALER
Description:
Sets the TIM Input Capture prescaler on
runtime without calling another time
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
__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
every 2 events
TIM_ICPSC_DIV4: capture is done once
528/1320
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
every 4 events
TIM_ICPSC_DIV8: capture is done once
every 8 events
Return value:
None
__HAL_TIM_GET_ICPRESCALER
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:
The: input capture prescaler can be one of the
following values:
TIM_ICPSC_DIV1: no prescaler
TIM_ICPSC_DIV2: capture is done once
every 2 events
TIM_ICPSC_DIV4: capture is done once
every 4 events
TIM_ICPSC_DIV8: capture is done once
every 8 events
__HAL_TIM_URS_ENABLE
Description:
Set the Update Request Source (URS) bit of the
TIMx_CR1 register.
Parameters:
__HANDLE__: TIM handle.
Return value:
None
Notes:
When the USR bit of the TIMx_CR1 register is
set, only counter overflow/underflow generates
an update interrupt or DMA request (if enabled)
__HAL_TIM_URS_DISABLE
Description:
Reset the Update Request Source (URS) bit of
DocID026525 Rev 6
529/1320
HAL TIM Generic Driver
UM1785
the TIMx_CR1 register.
Parameters:
__HANDLE__: TIM handle.
Return value:
None
Notes:
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
__HAL_TIM_SET_CAPTUREPOL
ARITY
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
530/1320
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
TIM_FLAG_CC3
TIM_FLAG_CC4
TIM_FLAG_COM
TIM_FLAG_TRIGGER
TIM_FLAG_BREAK
TIM_FLAG_CC1OF
TIM_FLAG_CC2OF
TIM_FLAG_CC3OF
TIM_FLAG_CC4OF
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
DocID026525 Rev 6
531/1320
HAL TIM Generic Driver
TIM_IT_BREAK
UM1785
TIM Lock level
TIM_LOCKLEVEL_OFF
TIM_LOCKLEVEL_1
TIM_LOCKLEVEL_2
TIM_LOCKLEVEL_3
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 Off State Selection for Idle mode state
TIM_OSSI_ENABLE
TIM_OSSI_DISABLE
TIM OSSR Off State Selection for Run mode state
TIM_OSSR_ENABLE
TIM_OSSR_DISABLE
TIM Output Compare and PWM modes
TIM_OCMODE_TIMING
TIM_OCMODE_ACTIVE
TIM_OCMODE_INACTIVE
TIM_OCMODE_TOGGLE
TIM_OCMODE_PWM1
TIM_OCMODE_PWM2
TIM_OCMODE_FORCED_ACTIVE
TIM_OCMODE_FORCED_INACTIVE
532/1320
DocID026525 Rev 6
UM1785
HAL TIM Generic Driver
TIM Output Compare Idle State
TIM_OCIDLESTATE_SET
TIM_OCIDLESTATE_RESET
TIM Complementary Output Compare Idle State
TIM_OCNIDLESTATE_SET
TIM_OCNIDLESTATE_RESET
TIM Complementary Output Compare 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 Input Selection
TIM_TI1SELECTION_CH1
TIM_TI1SELECTION_XORCOMBINATION
TIM Trigger Polarity
TIM_TRIGGERPOLARITY_INVERTED
Polarity for ETRx trigger sources
TIM_TRIGGERPOLARITY_NONINVERTED
Polarity for ETRx trigger sources
TIM_TRIGGERPOLARITY_RISING
Polarity for TIxFPx or TI1_ED trigger
sources
TIM_TRIGGERPOLARITY_FALLING
Polarity for TIxFPx or TI1_ED trigger
sources
TIM_TRIGGERPOLARITY_BOTHEDGE
Polarity for TIxFPx or TI1_ED trigger
sources
DocID026525 Rev 6
533/1320
HAL TIM Generic Driver
TIM Trigger Prescaler
UM1785
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
534/1320
DocID026525 Rev 6
UM1785
HAL TIM Extension Driver
42
HAL TIM Extension Driver
42.1
TIMEx Firmware driver registers structures
42.1.1
TIM_HallSensor_InitTypeDef
Data Fields
uint32_t IC1Polarity
uint32_t IC1Prescaler
uint32_t IC1Filter
uint32_t Commutation_Delay
Field Documentation
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
42.1.2
TIM_MasterConfigTypeDef
Data Fields
uint32_t MasterOutputTrigger
uint32_t MasterSlaveMode
Field Documentation
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
42.1.3
TIM_BreakDeadTimeConfigTypeDef
Data Fields
uint32_t OffStateRunMode
uint32_t OffStateIDLEMode
uint32_t LockLevel
uint32_t DeadTime
uint32_t BreakState
uint32_t BreakPolarity
uint32_t AutomaticOutput
DocID026525 Rev 6
535/1320
HAL TIM Extension Driver
Field Documentation
UM1785
uint32_t TIM_BreakDeadTimeConfigTypeDef::OffStateRunMode
TIM off state in run mode This parameter can be a value of
TIM_OSSR_Off_State_Selection_for_Run_mode_state
uint32_t TIM_BreakDeadTimeConfigTypeDef::OffStateIDLEMode
TIM off state in IDLE mode This parameter can be a value of
TIM_OSSI_Off_State_Selection_for_Idle_mode_state
uint32_t TIM_BreakDeadTimeConfigTypeDef::LockLevel
TIM Lock level This parameter can be a value of TIM_Lock_level
uint32_t TIM_BreakDeadTimeConfigTypeDef::DeadTime
TIM dead Time This parameter can be a number between Min_Data = 0x00 and
Max_Data = 0xFF
uint32_t TIM_BreakDeadTimeConfigTypeDef::BreakState
TIM Break State This parameter can be a value of TIM_Break_Input_enable_disable
uint32_t TIM_BreakDeadTimeConfigTypeDef::BreakPolarity
TIM Break input polarity This parameter can be a value of TIM_Break_Polarity
uint32_t TIM_BreakDeadTimeConfigTypeDef::AutomaticOutput
TIM Automatic Output Enable state This parameter can be a value of
TIM_AOE_Bit_Set_Reset
42.2
TIMEx Firmware driver API description
42.2.1
TIMER Extended features
The Timer Extended features include:
1.
2.
3.
4.
42.2.2
How to use this driver
1.
2.
3.
4.
536/1320
Complementary outputs with programmable dead-time for :
Output Compare
PWM generation (Edge and Center-aligned Mode)
One-pulse mode output
Synchronization circuit to control the timer with external signals and to interconnect
several timers together.
Break input to put the timer output signals in reset state or in a known state.
Supports incremental (quadrature) encoder and hall-sensor circuitry for positioning
purposes
Initialize the TIM low level resources by implementing the following functions
depending from feature used :
Complementary Output Compare : HAL_TIM_OC_MspInit()
Complementary PWM generation : HAL_TIM_PWM_MspInit()
Complementary One-pulse mode output : HAL_TIM_OnePulse_MspInit()
Hall Sensor output : HAL_TIM_HallSensor_MspInit()
Initialize the TIM low level resources :
a. Enable the TIM interface clock using __HAL_RCC_TIMx_CLK_ENABLE();
b. TIM pins configuration
Enable the clock for the TIM GPIOs using the following function:
__HAL_RCC_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:
DocID026525 Rev 6
UM1785
HAL TIM Extension Driver
5.
42.2.3
HAL_TIMEx_HallSensor_Init and HAL_TIMEx_ConfigCommutationEvent: to use
the Timer Hall Sensor Interface and the commutation event with the
corresponding Interrupt and DMA request if needed (Note that One Timer is used
to interface with the Hall sensor Interface and another Timer should be used to
use the commutation event).
Activate the TIM peripheral using one of the start functions:
Complementary Output Compare : HAL_TIMEx_OCN_Start(),
HAL_TIMEx_OCN_Start_DMA(), HAL_TIMEx_OCN_Start_IT()
Complementary PWM generation : HAL_TIMEx_PWMN_Start(),
HAL_TIMEx_PWMN_Start_DMA(), HAL_TIMEx_PWMN_Start_IT()
Complementary One-pulse mode output : HAL_TIMEx_OnePulseN_Start(),
HAL_TIMEx_OnePulseN_Start_IT()
Hall Sensor output : HAL_TIMEx_HallSensor_Start(),
HAL_TIMEx_HallSensor_Start_DMA(), HAL_TIMEx_HallSensor_Start_IT().
Timer Hall Sensor functions
This section provides functions allowing to:
Initialize and configure TIM HAL Sensor.
De-initialize TIM HAL Sensor.
Start the Hall Sensor Interface.
Stop the Hall Sensor Interface.
Start the Hall Sensor Interface and enable interrupts.
Stop the Hall Sensor Interface and disable interrupts.
Start the Hall Sensor Interface and enable DMA transfers.
Stop the Hall Sensor Interface and disable DMA transfers.
This section contains the following APIs:
HAL_TIMEx_HallSensor_Init()
HAL_TIMEx_HallSensor_DeInit()
HAL_TIMEx_HallSensor_MspInit()
HAL_TIMEx_HallSensor_MspDeInit()
HAL_TIMEx_HallSensor_Start()
HAL_TIMEx_HallSensor_Stop()
HAL_TIMEx_HallSensor_Start_IT()
HAL_TIMEx_HallSensor_Stop_IT()
HAL_TIMEx_HallSensor_Start_DMA()
HAL_TIMEx_HallSensor_Stop_DMA()
42.2.4
Timer Complementary Output Compare functions
This section provides functions allowing to:
Start the Complementary Output Compare/PWM.
Stop the Complementary Output Compare/PWM.
Start the Complementary Output Compare/PWM and enable interrupts.
Stop the Complementary Output Compare/PWM and disable interrupts.
Start the Complementary Output Compare/PWM and enable DMA transfers.
Stop the Complementary Output Compare/PWM and disable DMA transfers.
This section contains the following APIs:
HAL_TIMEx_OCN_Start()
HAL_TIMEx_OCN_Stop()
HAL_TIMEx_OCN_Start_IT()
DocID026525 Rev 6
537/1320
HAL TIM Extension Driver
UM1785
HAL_TIMEx_OCN_Stop_IT()
HAL_TIMEx_OCN_Start_DMA()
HAL_TIMEx_OCN_Stop_DMA()
42.2.5
Timer Complementary PWM functions
This section provides functions allowing to:
Start the Complementary PWM.
Stop the Complementary PWM.
Start the Complementary PWM and enable interrupts.
Stop the Complementary PWM and disable interrupts.
Start the Complementary PWM and enable DMA transfers.
Stop the Complementary PWM and disable DMA transfers.
Start the Complementary Input Capture measurement.
Stop the Complementary Input Capture.
Start the Complementary Input Capture and enable interrupts.
Stop the Complementary Input Capture and disable interrupts.
Start the Complementary Input Capture and enable DMA transfers.
Stop the Complementary Input Capture and disable DMA transfers.
Start the Complementary One Pulse generation.
Stop the Complementary One Pulse.
Start the Complementary One Pulse and enable interrupts.
Stop the Complementary One Pulse and disable interrupts.
This section contains the following APIs:
HAL_TIMEx_PWMN_Start()
HAL_TIMEx_PWMN_Stop()
HAL_TIMEx_PWMN_Start_IT()
HAL_TIMEx_PWMN_Stop_IT()
HAL_TIMEx_PWMN_Start_DMA()
HAL_TIMEx_PWMN_Stop_DMA()
42.2.6
Timer Complementary One Pulse functions
This section provides functions allowing to:
Start the Complementary One Pulse generation.
Stop the Complementary One Pulse.
Start the Complementary One Pulse and enable interrupts.
Stop the Complementary One Pulse and disable interrupts.
This section contains the following APIs:
HAL_TIMEx_OnePulseN_Start()
HAL_TIMEx_OnePulseN_Stop()
HAL_TIMEx_OnePulseN_Start_IT()
HAL_TIMEx_OnePulseN_Stop_IT()
42.2.7
Peripheral Control functions
This section provides functions allowing to:
Configure the commutation event in case of use of the Hall sensor interface.
Configure Complementary channels, break features and dead time.
Configure Master synchronization.
Configure timer remapping capabilities.
538/1320
DocID026525 Rev 6
UM1785
HAL TIM Extension Driver
This section contains the following APIs:
HAL_TIMEx_ConfigCommutationEvent()
HAL_TIMEx_ConfigCommutationEvent_IT()
HAL_TIMEx_ConfigCommutationEvent_DMA()
HAL_TIMEx_MasterConfigSynchronization()
HAL_TIMEx_ConfigBreakDeadTime()
HAL_TIMEx_RemapConfig()
42.2.8
Extension Callbacks functions
This section provides Extension TIM callback functions:
Timer Commutation callback
Timer Break callback
This section contains the following APIs:
HAL_TIMEx_CommutationCallback()
HAL_TIMEx_BreakCallback()
TIMEx_DMACommutationCplt()
42.2.9
Extension Peripheral State functions
This subsection permit to get in run-time the status of the peripheral and the data flow.
This section contains the following APIs:
HAL_TIMEx_HallSensor_GetState()
42.2.10
Detailed description of functions
HAL_TIMEx_HallSensor_Init
Function name
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Init
(TIM_HandleTypeDef * htim, TIM_HallSensor_InitTypeDef *
sConfig)
Function description
Initializes the TIM Hall Sensor Interface and create the associated
handle.
Parameters
htim: TIM Encoder Interface handle
sConfig: TIM Hall Sensor configuration structure
Return values
HAL: status
HAL_TIMEx_HallSensor_DeInit
Function name
HAL_StatusTypeDef HAL_TIMEx_HallSensor_DeInit
(TIM_HandleTypeDef * htim)
Function description
DeInitializes the TIM Hall Sensor interface.
Parameters
htim: TIM Hall Sensor handle
Return values
HAL: status
DocID026525 Rev 6
539/1320
HAL TIM Extension Driver
UM1785
HAL_TIMEx_HallSensor_MspInit
Function name
void HAL_TIMEx_HallSensor_MspInit (TIM_HandleTypeDef *
htim)
Function description
Initializes the TIM Hall Sensor MSP.
Parameters
htim: TIM handle
Return values
None
HAL_TIMEx_HallSensor_MspDeInit
Function name
void HAL_TIMEx_HallSensor_MspDeInit (TIM_HandleTypeDef
* htim)
Function description
DeInitializes TIM Hall Sensor MSP.
Parameters
htim: TIM handle
Return values
None
HAL_TIMEx_HallSensor_Start
Function name
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start
(TIM_HandleTypeDef * htim)
Function description
Starts the TIM Hall Sensor Interface.
Parameters
htim: TIM Hall Sensor handle
Return values
HAL: status
HAL_TIMEx_HallSensor_Stop
Function name
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop
(TIM_HandleTypeDef * htim)
Function description
Stops the TIM Hall sensor Interface.
Parameters
htim: TIM Hall Sensor handle
Return values
HAL: status
HAL_TIMEx_HallSensor_Start_IT
Function name
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start_IT
(TIM_HandleTypeDef * htim)
Function description
Starts the TIM Hall Sensor Interface in interrupt mode.
Parameters
htim: TIM Hall Sensor handle
Return values
HAL: status
HAL_TIMEx_HallSensor_Stop_IT
540/1320
Function name
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_IT
(TIM_HandleTypeDef * htim)
Function description
Stops the TIM Hall Sensor Interface in interrupt mode.
DocID026525 Rev 6
UM1785
HAL TIM Extension Driver
Parameters
htim: TIM handle
Return values
HAL: status
HAL_TIMEx_HallSensor_Start_DMA
Function name
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start_DMA
(TIM_HandleTypeDef * htim, uint32_t * pData, uint16_t Length)
Function description
Starts the TIM Hall Sensor Interface in DMA mode.
Parameters
htim: TIM Hall Sensor handle
pData: The destination Buffer address.
Length: The length of data to be transferred from TIM
peripheral to memory.
Return values
HAL: status
HAL_TIMEx_HallSensor_Stop_DMA
Function name
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_DMA
(TIM_HandleTypeDef * htim)
Function description
Stops the TIM Hall Sensor Interface in DMA mode.
Parameters
htim: TIM handle
Return values
HAL: status
HAL_TIMEx_OCN_Start
Function name
HAL_StatusTypeDef HAL_TIMEx_OCN_Start
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function description
Starts the TIM Output Compare signal generation on the
complementary output.
Parameters
htim: TIM Output Compare handle
Channel: TIM Channel to be enabled 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
Return values
HAL: status
HAL_TIMEx_OCN_Stop
Function name
HAL_StatusTypeDef HAL_TIMEx_OCN_Stop
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function description
Stops the TIM Output Compare signal generation on the
complementary output.
Parameters
htim: TIM handle
Channel: TIM Channel to be disabled This parameter can be
one of the following values:
TIM_CHANNEL_1: TIM Channel 1 selected
DocID026525 Rev 6
541/1320
HAL TIM Extension Driver
UM1785
TIM_CHANNEL_2: TIM Channel 2 selected
TIM_CHANNEL_3: TIM Channel 3 selected
TIM_CHANNEL_4: TIM Channel 4 selected
Return values
HAL: status
HAL_TIMEx_OCN_Start_IT
Function name
HAL_StatusTypeDef HAL_TIMEx_OCN_Start_IT
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function description
Starts the TIM Output Compare signal generation in interrupt
mode on the complementary output.
Parameters
htim: TIM OC handle
Channel: TIM Channel to be enabled 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
Return values
HAL: status
HAL_TIMEx_OCN_Stop_IT
Function name
HAL_StatusTypeDef HAL_TIMEx_OCN_Stop_IT
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function description
Stops the TIM Output Compare signal generation in interrupt mode
on the complementary output.
Parameters
htim: TIM Output Compare handle
Channel: TIM Channel to be disabled 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
Return values
HAL: status
HAL_TIMEx_OCN_Start_DMA
Function name
HAL_StatusTypeDef HAL_TIMEx_OCN_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 on
the complementary output.
Parameters
542/1320
htim: TIM Output Compare handle
Channel: TIM Channel to be enabled 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
DocID026525 Rev 6
UM1785
HAL TIM Extension Driver
pData: The source Buffer address.
Length: The length of data to be transferred from memory to
TIM peripheral
Return values
HAL: status
HAL_TIMEx_OCN_Stop_DMA
Function name
HAL_StatusTypeDef HAL_TIMEx_OCN_Stop_DMA
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function description
Stops the TIM Output Compare signal generation in DMA mode on
the complementary output.
Parameters
htim: TIM Output Compare handle
Channel: TIM Channel to be disabled 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
Return values
HAL: status
HAL_TIMEx_PWMN_Start
Function name
HAL_StatusTypeDef HAL_TIMEx_PWMN_Start
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function description
Starts the PWM signal generation on the complementary output.
Parameters
htim: TIM handle
Channel: TIM Channel to be enabled 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
Return values
HAL: status
HAL_TIMEx_PWMN_Stop
Function name
HAL_StatusTypeDef HAL_TIMEx_PWMN_Stop
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function description
Stops the PWM signal generation on the complementary output.
Parameters
htim: TIM handle
Channel: TIM Channel to be disabled 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
Return values
HAL: status
DocID026525 Rev 6
543/1320
HAL TIM Extension Driver
UM1785
HAL_TIMEx_PWMN_Start_IT
Function name
HAL_StatusTypeDef HAL_TIMEx_PWMN_Start_IT
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function description
Starts the PWM signal generation in interrupt mode on the
complementary output.
Parameters
htim: TIM handle
Channel: TIM Channel to be disabled 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
Return values
HAL: status
HAL_TIMEx_PWMN_Stop_IT
Function name
HAL_StatusTypeDef HAL_TIMEx_PWMN_Stop_IT
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function description
Stops the PWM signal generation in interrupt mode on the
complementary output.
Parameters
htim: TIM handle
Channel: TIM Channel to be disabled 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
Return values
HAL: status
HAL_TIMEx_PWMN_Start_DMA
544/1320
Function name
HAL_StatusTypeDef HAL_TIMEx_PWMN_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 on the
complementary output.
Parameters
htim: TIM handle
Channel: TIM Channel to be enabled 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
pData: The source Buffer address.
Length: The length of data to be transferred from memory to
TIM peripheral
Return values
HAL: status
DocID026525 Rev 6
UM1785
HAL TIM Extension Driver
HAL_TIMEx_PWMN_Stop_DMA
Function name
HAL_StatusTypeDef HAL_TIMEx_PWMN_Stop_DMA
(TIM_HandleTypeDef * htim, uint32_t Channel)
Function description
Stops the TIM PWM signal generation in DMA mode on the
complementary output.
Parameters
htim: TIM handle
Channel: TIM Channel to be disabled 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
Return values
HAL: status
HAL_TIMEx_OnePulseN_Start
Function name
HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Start
(TIM_HandleTypeDef * htim, uint32_t OutputChannel)
Function description
Starts the TIM One Pulse signal generation on the complemetary
output.
Parameters
htim: TIM One Pulse handle
OutputChannel: TIM Channel to be enabled This parameter
can be one of the following values:
TIM_CHANNEL_1: TIM Channel 1 selected
TIM_CHANNEL_2: TIM Channel 2 selected
Return values
HAL: status
HAL_TIMEx_OnePulseN_Stop
Function name
HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Stop
(TIM_HandleTypeDef * htim, uint32_t OutputChannel)
Function description
Stops the TIM One Pulse signal generation on the complementary
output.
Parameters
htim: TIM One Pulse handle
OutputChannel: TIM Channel to be disabled This parameter
can be one of the following values:
TIM_CHANNEL_1: TIM Channel 1 selected
TIM_CHANNEL_2: TIM Channel 2 selected
Return values
HAL: status
HAL_TIMEx_OnePulseN_Start_IT
Function name
HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Start_IT
(TIM_HandleTypeDef * htim, uint32_t OutputChannel)
Function description
Starts the TIM One Pulse signal generation in interrupt mode on
the complementary channel.
Parameters
htim: TIM One Pulse handle
DocID026525 Rev 6
545/1320
HAL TIM Extension Driver
UM1785
OutputChannel: TIM Channel to be enabled This parameter
can be one of the following values:
TIM_CHANNEL_1: TIM Channel 1 selected
TIM_CHANNEL_2: TIM Channel 2 selected
Return values
HAL: status
HAL_TIMEx_OnePulseN_Stop_IT
Function name
HAL_StatusTypeDef HAL_TIMEx_OnePulseN_Stop_IT
(TIM_HandleTypeDef * htim, uint32_t OutputChannel)
Function description
Stops the TIM One Pulse signal generation in interrupt mode on
the complementary channel.
Parameters
htim: TIM One Pulse handle
OutputChannel: TIM Channel to be disabled This parameter
can be one of the following values:
TIM_CHANNEL_1: TIM Channel 1 selected
TIM_CHANNEL_2: TIM Channel 2 selected
Return values
HAL: status
HAL_TIMEx_ConfigCommutationEvent
546/1320
Function name
HAL_StatusTypeDef HAL_TIMEx_ConfigCommutationEvent
(TIM_HandleTypeDef * htim, uint32_t InputTrigger, uint32_t
CommutationSource)
Function description
Configure the TIM commutation event sequence.
Parameters
htim: TIM handle
InputTrigger: the Internal trigger corresponding to the Timer
Interfacing with the Hall sensor This parameter can be one of
the following values:
TIM_TS_ITR0: Internal trigger 0 selected
TIM_TS_ITR1: Internal trigger 1 selected
TIM_TS_ITR2: Internal trigger 2 selected
TIM_TS_ITR3: Internal trigger 3 selected
TIM_TS_NONE No trigger is needed
CommutationSource: the Commutation Event source This
parameter can be one of the following values:
TIM_COMMUTATION_TRGI: Commutation source is the
TRGI of the Interface Timer
TIM_COMMUTATION_SOFTWARE: Commutation
source is set by software using the COMG bit
Return values
HAL: status
Notes
this function is mandatory to use the commutation event in
order to update the configuration at each commutation
detection on the TRGI input of the Timer, the typical use of
this feature is with the use of another Timer(interface Timer)
configured in Hall sensor interface, this interface Timer will
generate the commutation at its TRGO output (connected to
Timer used in this function) each time the TI1 of the Interface
Timer detect a commutation at its input TI1.
DocID026525 Rev 6
UM1785
HAL TIM Extension Driver
HAL_TIMEx_ConfigCommutationEvent_IT
Function name
HAL_StatusTypeDef
HAL_TIMEx_ConfigCommutationEvent_IT
(TIM_HandleTypeDef * htim, uint32_t InputTrigger, uint32_t
CommutationSource)
Function description
Configure the TIM commutation event sequence with interrupt.
Parameters
htim: TIM handle
InputTrigger: the Internal trigger corresponding to the Timer
Interfacing with the Hall sensor This parameter can be one of
the following values:
TIM_TS_ITR0: Internal trigger 0 selected
TIM_TS_ITR1: Internal trigger 1 selected
TIM_TS_ITR2: Internal trigger 2 selected
TIM_TS_ITR3: Internal trigger 3 selected
TIM_TS_NONE No trigger is needed
CommutationSource: the Commutation Event source This
parameter can be one of the following values:
TIM_COMMUTATION_TRGI: Commutation source is the
TRGI of the Interface Timer
TIM_COMMUTATION_SOFTWARE: Commutation
source is set by software using the COMG bit
Return values
HAL: status
Notes
this function is mandatory to use the commutation event in
order to update the configuration at each commutation
detection on the TRGI input of the Timer, the typical use of
this feature is with the use of another Timer(interface Timer)
configured in Hall sensor interface, this interface Timer will
generate the commutation at its TRGO output (connected to
Timer used in this function) each time the TI1 of the Interface
Timer detect a commutation at its input TI1.
HAL_TIMEx_ConfigCommutationEvent_DMA
Function name
HAL_StatusTypeDef
HAL_TIMEx_ConfigCommutationEvent_DMA
(TIM_HandleTypeDef * htim, uint32_t InputTrigger, uint32_t
CommutationSource)
Function description
Configure the TIM commutation event sequence with DMA.
Parameters
htim: TIM handle
InputTrigger: the Internal trigger corresponding to the Timer
Interfacing with the Hall sensor This parameter can be one of
the following values:
TIM_TS_ITR0: Internal trigger 0 selected
TIM_TS_ITR1: Internal trigger 1 selected
TIM_TS_ITR2: Internal trigger 2 selected
TIM_TS_ITR3: Internal trigger 3 selected
TIM_TS_NONE No trigger is needed
CommutationSource: the Commutation Event source This
parameter can be one of the following values:
TIM_COMMUTATION_TRGI: Commutation source is the
DocID026525 Rev 6
547/1320
HAL TIM Extension Driver
UM1785
TRGI of the Interface Timer
TIM_COMMUTATION_SOFTWARE: Commutation
source is set by software using the COMG bit
Return values
HAL: status
Notes
this function is mandatory to use the commutation event in
order to update the configuration at each commutation
detection on the TRGI input of the Timer, the typical use of
this feature is with the use of another Timer(interface Timer)
configured in Hall sensor interface, this interface Timer will
generate the commutation at its TRGO output (connected to
Timer used in this function) each time the TI1 of the Interface
Timer detect a commutation at its input TI1.
: The user should configure the DMA in his own software, in
This function only the COMDE bit is set
HAL_TIMEx_MasterConfigSynchronization
Function name
HAL_StatusTypeDef
HAL_TIMEx_MasterConfigSynchronization
(TIM_HandleTypeDef * htim, TIM_MasterConfigTypeDef *
sMasterConfig)
Function description
Configures the TIM in master mode.
Parameters
htim: TIM handle.
sMasterConfig: pointer to a TIM_MasterConfigTypeDef
structure that contains the selected trigger output (TRGO) and
the Master/Slave mode.
Return values
HAL: status
HAL_TIMEx_ConfigBreakDeadTime
Function name
HAL_StatusTypeDef HAL_TIMEx_ConfigBreakDeadTime
(TIM_HandleTypeDef * htim,
TIM_BreakDeadTimeConfigTypeDef * sBreakDeadTimeConfig)
Function description
Configures the Break feature, dead time, Lock level, OSSI/OSSR
State and the AOE(automatic output enable).
Parameters
htim: TIM handle
sBreakDeadTimeConfig: pointer to a
TIM_ConfigBreakDeadConfigTypeDef structure that contains
the BDTR Register configuration information for the TIM
peripheral.
Return values
HAL: status
HAL_TIMEx_RemapConfig
Function name
HAL_StatusTypeDef HAL_TIMEx_RemapConfig
(TIM_HandleTypeDef * htim, uint32_t Remap)
Function description
Configures the TIM14 Remapping input capabilities.
Parameters
548/1320
htim: TIM handle.
Remap: specifies the TIM remapping source. This parameter
DocID026525 Rev 6
UM1785
HAL TIM Extension Driver
can be one of the following values:
TIM_TIM14_GPIO: TIM14 TI1 is connected to GPIO
TIM_TIM14_RTC: TIM14 TI1 is connected to RTC_clock
TIM_TIM14_HSE: TIM14 TI1 is connected to HSE/32
TIM_TIM14_MCO: TIM14 TI1 is connected to MCO
Return values
HAL: status
HAL_TIMEx_CommutationCallback
Function name
void HAL_TIMEx_CommutationCallback (TIM_HandleTypeDef
* htim)
Function description
Hall commutation changed callback in non blocking mode.
Parameters
htim: TIM handle
Return values
None
HAL_TIMEx_BreakCallback
Function name
void HAL_TIMEx_BreakCallback (TIM_HandleTypeDef * htim)
Function description
Hall Break detection callback in non blocking mode.
Parameters
htim: TIM handle
Return values
None
HAL_TIMEx_HallSensor_GetState
Function name
HAL_TIM_StateTypeDef HAL_TIMEx_HallSensor_GetState
(TIM_HandleTypeDef * htim)
Function description
Return the TIM Hall Sensor interface state.
Parameters
htim: TIM Hall Sensor handle
Return values
HAL: state
TIMEx_DMACommutationCplt
Function name
void TIMEx_DMACommutationCplt (DMA_HandleTypeDef *
hdma)
Function description
TIM DMA Commutation callback.
Parameters
hdma: pointer to DMA handle.
Return values
None
DocID026525 Rev 6
549/1320
HAL TIM Extension Driver
UM1785
42.3
TIMEx Firmware driver defines
42.3.1
TIMEx
TIMEx Clear Input Source
TIM_CLEARINPUTSOURCE_NONE
TIM_CLEARINPUTSOURCE_ETR
TIM_CLEARINPUTSOURCE_OCREFCLR
TIMEx Remap
550/1320
TIM_TIM14_GPIO
TIM14 TI1 is connected to GPIO
TIM_TIM14_RTC
TIM14 TI1 is connected to RTC_clock
TIM_TIM14_HSE
TIM14 TI1 is connected to HSE/32
TIM_TIM14_MCO
TIM14 TI1 is connected to MCO
DocID026525 Rev 6
UM1785
HAL TSC Generic Driver
43
HAL TSC Generic Driver
43.1
TSC Firmware driver registers structures
43.1.1
TSC_InitTypeDef
Data Fields
uint32_t CTPulseHighLength
uint32_t CTPulseLowLength
uint32_t SpreadSpectrum
uint32_t SpreadSpectrumDeviation
uint32_t SpreadSpectrumPrescaler
uint32_t PulseGeneratorPrescaler
uint32_t MaxCountValue
uint32_t IODefaultMode
uint32_t SynchroPinPolarity
uint32_t AcquisitionMode
uint32_t MaxCountInterrupt
uint32_t ChannelIOs
uint32_t ShieldIOs
uint32_t SamplingIOs
Field Documentation
uint32_t TSC_InitTypeDef::CTPulseHighLength
Charge-transfer high pulse length
uint32_t TSC_InitTypeDef::CTPulseLowLength
Charge-transfer low pulse length
uint32_t TSC_InitTypeDef::SpreadSpectrum
Spread spectrum activation
uint32_t TSC_InitTypeDef::SpreadSpectrumDeviation
Spread spectrum deviation
uint32_t TSC_InitTypeDef::SpreadSpectrumPrescaler
Spread spectrum prescaler
uint32_t TSC_InitTypeDef::PulseGeneratorPrescaler
Pulse generator prescaler
uint32_t TSC_InitTypeDef::MaxCountValue
Max count value
uint32_t TSC_InitTypeDef::IODefaultMode
IO default mode
uint32_t TSC_InitTypeDef::SynchroPinPolarity
Synchro pin polarity
uint32_t TSC_InitTypeDef::AcquisitionMode
Acquisition mode
uint32_t TSC_InitTypeDef::MaxCountInterrupt
Max count interrupt activation
uint32_t TSC_InitTypeDef::ChannelIOs
Channel IOs mask
uint32_t TSC_InitTypeDef::ShieldIOs
Shield IOs mask
uint32_t TSC_InitTypeDef::SamplingIOs
Sampling IOs mask
DocID026525 Rev 6
551/1320
HAL TSC Generic Driver
43.1.2
UM1785
TSC_IOConfigTypeDef
Data Fields
uint32_t ChannelIOs
uint32_t ShieldIOs
uint32_t SamplingIOs
Field Documentation
uint32_t TSC_IOConfigTypeDef::ChannelIOs
Channel IOs mask
uint32_t TSC_IOConfigTypeDef::ShieldIOs
Shield IOs mask
uint32_t TSC_IOConfigTypeDef::SamplingIOs
Sampling IOs mask
43.1.3
TSC_HandleTypeDef
Data Fields
TSC_TypeDef * Instance
TSC_InitTypeDef Init
__IO HAL_TSC_StateTypeDef State
HAL_LockTypeDef Lock
Field Documentation
TSC_TypeDef* TSC_HandleTypeDef::Instance
Register base address
TSC_InitTypeDef TSC_HandleTypeDef::Init
Initialization parameters
__IO HAL_TSC_StateTypeDef TSC_HandleTypeDef::State
Peripheral state
HAL_LockTypeDef TSC_HandleTypeDef::Lock
Lock feature
43.2
TSC Firmware driver API description
43.2.1
TSC specific features
Proven and robust surface charge transfer acquisition principle
Supports up to 3 capacitive sensing channels per group
Capacitive sensing channels can be acquired in parallel offering a very good response
time
Spread spectrum feature to improve system robustness in noisy environments
Full hardware management of the charge transfer acquisition sequence
Programmable charge transfer frequency
Programmable sampling capacitor I/O pin
Programmable channel I/O pin
Programmable max count value to avoid long acquisition when a channel is faulty
Dedicated end of acquisition and max count error flags with interrupt capability
One sampling capacitor for up to 3 capacitive sensing channels to reduce the system
components
Compatible with proximity, touchkey, linear and rotary touch sensor implementation
552/1320
DocID026525 Rev 6
UM1785
43.2.2
HAL TSC Generic Driver
How to use this driver
1.
2.
3.
4.
Enable the TSC interface clock using __HAL_RCC_TSC_CLK_ENABLE() macro.
GPIO pins configuration
Enable the clock for the TSC GPIOs using __HAL_RCC_GPIOx_CLK_ENABLE()
macro.
Configure the TSC pins used as sampling IOs in alternate function output OpenDrain mode, and TSC pins used as channel/shield IOs in alternate function
output Push-Pull mode using HAL_GPIO_Init() function.
Configure the alternate function on all the TSC pins using HAL_xxxx() function.
Interrupts configuration
Configure the NVIC (if the interrupt model is used) using HAL_xxx() function.
TSC configuration
Configure all TSC parameters and used TSC IOs using HAL_TSC_Init() function.
Acquisition sequence
Discharge all IOs using HAL_TSC_IODischarge() function.
Wait a certain time allowing a good discharge of all capacitors. This delay depends of
the sampling capacitor and electrodes design.
Select the channel IOs to be acquired using HAL_TSC_IOConfig() function.
Launch the acquisition using either HAL_TSC_Start() or HAL_TSC_Start_IT()
function. If the synchronized mode is selected, the acquisition will start as soon as the
signal is received on the synchro pin.
Wait the end of acquisition using either HAL_TSC_PollForAcquisition() or
HAL_TSC_GetState() function or using WFI instruction for example.
Check the group acquisition status using HAL_TSC_GroupGetStatus() function.
Read the acquisition value using HAL_TSC_GroupGetValue() function.
43.2.3
Initialization and de-initialization functions
This section provides functions allowing to:
Initialize and configure the TSC.
De-initialize the TSC.
This section contains the following APIs:
HAL_TSC_Init()
HAL_TSC_DeInit()
HAL_TSC_MspInit()
HAL_TSC_MspDeInit()
43.2.4
Peripheral Control functions
This section provides functions allowing to:
Configure TSC IOs
Discharge TSC IOs
This section contains the following APIs:
HAL_TSC_IOConfig()
HAL_TSC_IODischarge()
DocID026525 Rev 6
553/1320
HAL TSC Generic Driver
43.2.5
UM1785
State functions
This subsection provides functions allowing to
Get TSC state.
Poll for acquisition completed.
Handles TSC interrupt request.
This section contains the following APIs:
HAL_TSC_GetState()
HAL_TSC_PollForAcquisition()
HAL_TSC_IRQHandler()
43.2.6
Detailed description of functions
HAL_TSC_Init
Function name
HAL_StatusTypeDef HAL_TSC_Init (TSC_HandleTypeDef *
htsc)
Function description
Initializes the TSC peripheral according to the specified
parameters in the TSC_InitTypeDef structure.
Parameters
htsc: TSC handle
Return values
HAL: status
HAL_TSC_DeInit
Function name
HAL_StatusTypeDef HAL_TSC_DeInit (TSC_HandleTypeDef *
htsc)
Function description
Deinitializes the TSC peripheral registers to their default reset
values.
Parameters
htsc: TSC handle
Return values
HAL: status
HAL_TSC_MspInit
Function name
void HAL_TSC_MspInit (TSC_HandleTypeDef * htsc)
Function description
Initializes the TSC MSP.
Parameters
htsc: pointer to a TSC_HandleTypeDef structure that
contains the configuration information for the specified TSC.
Return values
None
HAL_TSC_MspDeInit
554/1320
Function name
void HAL_TSC_MspDeInit (TSC_HandleTypeDef * htsc)
Function description
DeInitializes the TSC MSP.
Parameters
htsc: pointer to a TSC_HandleTypeDef structure that
contains the configuration information for the specified TSC.
Return values
None
DocID026525 Rev 6
UM1785
HAL TSC Generic Driver
HAL_TSC_Start
Function name
HAL_StatusTypeDef HAL_TSC_Start (TSC_HandleTypeDef *
htsc)
Function description
Starts the acquisition.
Parameters
htsc: pointer to a TSC_HandleTypeDef structure that
contains the configuration information for the specified TSC.
Return values
HAL: status
HAL_TSC_Start_IT
Function name
HAL_StatusTypeDef HAL_TSC_Start_IT (TSC_HandleTypeDef
* htsc)
Function description
Enables the interrupt and starts the acquisition.
Parameters
htsc: pointer to a TSC_HandleTypeDef structure that
contains the configuration information for the specified TSC.
Return values
HAL: status.
HAL_TSC_Stop
Function name
HAL_StatusTypeDef HAL_TSC_Stop (TSC_HandleTypeDef *
htsc)
Function description
Stops the acquisition previously launched in polling mode.
Parameters
htsc: pointer to a TSC_HandleTypeDef structure that
contains the configuration information for the specified TSC.
Return values
HAL: status
HAL_TSC_Stop_IT
Function name
HAL_StatusTypeDef HAL_TSC_Stop_IT (TSC_HandleTypeDef
* htsc)
Function description
Stops the acquisition previously launched in interrupt mode.
Parameters
htsc: pointer to a TSC_HandleTypeDef structure that
contains the configuration information for the specified TSC.
Return values
HAL: status
HAL_TSC_GroupGetStatus
Function name
TSC_GroupStatusTypeDef HAL_TSC_GroupGetStatus
(TSC_HandleTypeDef * htsc, uint32_t gx_index)
Function description
Gets the acquisition status for a group.
Parameters
htsc: pointer to a TSC_HandleTypeDef structure that
contains the configuration information for the specified TSC.
gx_index: Index of the group
Return values
Group: status
DocID026525 Rev 6
555/1320
HAL TSC Generic Driver
UM1785
HAL_TSC_GroupGetValue
Function name
uint32_t HAL_TSC_GroupGetValue (TSC_HandleTypeDef *
htsc, uint32_t gx_index)
Function description
Gets the acquisition measure for a group.
Parameters
htsc: pointer to a TSC_HandleTypeDef structure that
contains the configuration information for the specified TSC.
gx_index: Index of the group
Return values
Acquisition: measure
HAL_TSC_IOConfig
Function name
HAL_StatusTypeDef HAL_TSC_IOConfig
(TSC_HandleTypeDef * htsc, TSC_IOConfigTypeDef * config)
Function description
Configures TSC IOs.
Parameters
htsc: pointer to a TSC_HandleTypeDef structure that
contains the configuration information for the specified TSC.
config: pointer to the configuration structure.
Return values
HAL: status
HAL_TSC_IODischarge
Function name
HAL_StatusTypeDef HAL_TSC_IODischarge
(TSC_HandleTypeDef * htsc, uint32_t choice)
Function description
Discharge TSC IOs.
Parameters
htsc: pointer to a TSC_HandleTypeDef structure that
contains the configuration information for the specified TSC.
choice: enable or disable
Return values
HAL: status
HAL_TSC_GetState
Function name
HAL_TSC_StateTypeDef HAL_TSC_GetState
(TSC_HandleTypeDef * htsc)
Function description
Return the TSC state.
Parameters
htsc: pointer to a TSC_HandleTypeDef structure that
contains the configuration information for the specified TSC.
Return values
HAL: state
HAL_TSC_PollForAcquisition
Function name
HAL_StatusTypeDef HAL_TSC_PollForAcquisition
(TSC_HandleTypeDef * htsc)
Function description
Start acquisition and wait until completion.
Parameters
556/1320
htsc: pointer to a TSC_HandleTypeDef structure that
contains the configuration information for the specified TSC.
DocID026525 Rev 6
UM1785
HAL TSC Generic Driver
Return values
HAL: state
Notes
There is no need of a timeout parameter as the max count
error is already managed by the TSC peripheral.
HAL_TSC_IRQHandler
Function name
void HAL_TSC_IRQHandler (TSC_HandleTypeDef * htsc)
Function description
Handles TSC interrupt request.
Parameters
htsc: pointer to a TSC_HandleTypeDef structure that
contains the configuration information for the specified TSC.
Return values
None
HAL_TSC_ConvCpltCallback
Function name
void HAL_TSC_ConvCpltCallback (TSC_HandleTypeDef *
htsc)
Function description
Acquisition completed callback in non blocking mode.
Parameters
htsc: pointer to a TSC_HandleTypeDef structure that
contains the configuration information for the specified TSC.
Return values
None
HAL_TSC_ErrorCallback
Function name
void HAL_TSC_ErrorCallback (TSC_HandleTypeDef * htsc)
Function description
Error callback in non blocking mode.
Parameters
htsc: pointer to a TSC_HandleTypeDef structure that
contains the configuration information for the specified TSC.
Return values
None
43.3
TSC Firmware driver defines
43.3.1
TSC
TSC Acquisition mode
TSC_ACQ_MODE_NORMAL
TSC_ACQ_MODE_SYNCHRO
IS_TSC_ACQ_MODE
TSC Charge Transfer Pulse High
TSC_CTPH_1CYCLE
TSC_CTPH_2CYCLES
TSC_CTPH_3CYCLES
TSC_CTPH_4CYCLES
TSC_CTPH_5CYCLES
DocID026525 Rev 6
557/1320
HAL TSC Generic Driver
TSC_CTPH_6CYCLES
UM1785
TSC_CTPH_7CYCLES
TSC_CTPH_8CYCLES
TSC_CTPH_9CYCLES
TSC_CTPH_10CYCLES
TSC_CTPH_11CYCLES
TSC_CTPH_12CYCLES
TSC_CTPH_13CYCLES
TSC_CTPH_14CYCLES
TSC_CTPH_15CYCLES
TSC_CTPH_16CYCLES
IS_TSC_CTPH
TSC Charge Transfer Pulse Low
TSC_CTPL_1CYCLE
TSC_CTPL_2CYCLES
TSC_CTPL_3CYCLES
TSC_CTPL_4CYCLES
TSC_CTPL_5CYCLES
TSC_CTPL_6CYCLES
TSC_CTPL_7CYCLES
TSC_CTPL_8CYCLES
TSC_CTPL_9CYCLES
TSC_CTPL_10CYCLES
TSC_CTPL_11CYCLES
TSC_CTPL_12CYCLES
TSC_CTPL_13CYCLES
TSC_CTPL_14CYCLES
TSC_CTPL_15CYCLES
TSC_CTPL_16CYCLES
IS_TSC_CTPL
TSC Exported Macros
__HAL_TSC_RESET_HANDLE_STATE
Description:
Reset TSC handle state.
Parameters:
__HANDLE__: TSC handle.
Return value:
558/1320
DocID026525 Rev 6
UM1785
HAL TSC Generic Driver
None
Description:
__HAL_TSC_ENABLE
Enable the TSC peripheral.
Parameters:
__HANDLE__: TSC handle
Return value:
None
Description:
__HAL_TSC_DISABLE
Disable the TSC peripheral.
Parameters:
__HANDLE__: TSC handle
Return value:
None
Description:
__HAL_TSC_START_ACQ
Start acquisition.
Parameters:
__HANDLE__: TSC handle
Return value:
None
Description:
__HAL_TSC_STOP_ACQ
Stop acquisition.
Parameters:
__HANDLE__: TSC handle
Return value:
None
__HAL_TSC_SET_IODEF_OUTPPLOW
Description:
Set IO default mode to output pushpull low.
Parameters:
__HANDLE__: TSC handle
Return value:
None
__HAL_TSC_SET_IODEF_INFLOAT
Description:
Set IO default mode to input floating.
Parameters:
__HANDLE__: TSC handle
DocID026525 Rev 6
559/1320
HAL TSC Generic Driver
UM1785
Return value:
None
__HAL_TSC_SET_SYNC_POL_FALL
Description:
Set synchronization polarity to falling
edge.
Parameters:
__HANDLE__: TSC handle
Return value:
None
__HAL_TSC_SET_SYNC_POL_RISE_HIGH
Description:
Set synchronization polarity to rising
edge and high level.
Parameters:
__HANDLE__: TSC handle
Return value:
None
Description:
__HAL_TSC_ENABLE_IT
Enable TSC interrupt.
Parameters:
__HANDLE__: TSC handle
__INTERRUPT__: TSC interrupt
Return value:
None
Description:
__HAL_TSC_DISABLE_IT
Disable TSC interrupt.
Parameters:
__HANDLE__: TSC handle
__INTERRUPT__: TSC interrupt
Return value:
None
__HAL_TSC_GET_IT_SOURCE
Description:
Check if the specified TSC interrupt
source is enabled or disabled.
Parameters:
__HANDLE__: TSC Handle
__INTERRUPT__: TSC interrupt
Return value:
SET: or RESET
560/1320
DocID026525 Rev 6
UM1785
HAL TSC Generic Driver
Description:
__HAL_TSC_GET_FLAG
Get the selected TSC's flag status.
Parameters:
__HANDLE__: TSC handle
__FLAG__: TSC flag
Return value:
SET: or RESET
Description:
__HAL_TSC_CLEAR_FLAG
Clear the TSC's pending flag.
Parameters:
__HANDLE__: TSC handle
__FLAG__: TSC flag
Return value:
None
__HAL_TSC_ENABLE_HYSTERESIS
Description:
Enable schmitt trigger hysteresis on a
group of IOs.
Parameters:
__HANDLE__: TSC handle
__GX_IOY_MASK__: IOs mask
Return value:
None
__HAL_TSC_DISABLE_HYSTERESIS
Description:
Disable schmitt trigger hysteresis on a
group of IOs.
Parameters:
__HANDLE__: TSC handle
__GX_IOY_MASK__: IOs mask
Return value:
None
__HAL_TSC_OPEN_ANALOG_SWITCH
Description:
Open analog switch on a group of IOs.
Parameters:
__HANDLE__: TSC handle
__GX_IOY_MASK__: IOs mask
Return value:
None
DocID026525 Rev 6
561/1320
HAL TSC Generic Driver
__HAL_TSC_CLOSE_ANALOG_SWITCH
UM1785
Description:
Close analog switch on a group of IOs.
Parameters:
__HANDLE__: TSC handle
__GX_IOY_MASK__: IOs mask
Return value:
None
__HAL_TSC_ENABLE_CHANNEL
Description:
Enable a group of IOs in channel
mode.
Parameters:
__HANDLE__: TSC handle
__GX_IOY_MASK__: IOs mask
Return value:
None
__HAL_TSC_DISABLE_CHANNEL
Description:
Disable a group of channel IOs.
Parameters:
__HANDLE__: TSC handle
__GX_IOY_MASK__: IOs mask
Return value:
None
__HAL_TSC_ENABLE_SAMPLING
Description:
Enable a group of IOs in sampling
mode.
Parameters:
__HANDLE__: TSC handle
__GX_IOY_MASK__: IOs mask
Return value:
None
__HAL_TSC_DISABLE_SAMPLING
Description:
Disable a group of sampling IOs.
Parameters:
__HANDLE__: TSC handle
__GX_IOY_MASK__: IOs mask
Return value:
None
562/1320
DocID026525 Rev 6
UM1785
HAL TSC Generic Driver
__HAL_TSC_ENABLE_GROUP
Description:
Enable acquisition groups.
Parameters:
__HANDLE__: TSC handle
__GX_MASK__: Groups mask
Return value:
None
__HAL_TSC_DISABLE_GROUP
Description:
Disable acquisition groups.
Parameters:
__HANDLE__: TSC handle
__GX_MASK__: Groups mask
Return value:
None
__HAL_TSC_GET_GROUP_STATUS
Description:
Gets acquisition group status.
Parameters:
__HANDLE__: TSC Handle
__GX_INDEX__: Group index
Return value:
SET: or RESET
TSC Flags Definition
TSC_FLAG_EOA
TSC_FLAG_MCE
TSC groups definition
TSC_NB_OF_GROUPS
TSC_GROUP1
TSC_GROUP2
TSC_GROUP3
TSC_GROUP4
TSC_GROUP5
TSC_GROUP6
TSC_GROUP7
TSC_GROUP8
TSC_ALL_GROUPS
TSC_GROUP1_IDX
TSC_GROUP2_IDX
DocID026525 Rev 6
563/1320
HAL TSC Generic Driver
TSC_GROUP3_IDX
UM1785
TSC_GROUP4_IDX
TSC_GROUP5_IDX
TSC_GROUP6_IDX
TSC_GROUP7_IDX
TSC_GROUP8_IDX
IS_GROUP_INDEX
TSC_GROUP1_IO1
TSC_GROUP1_IO2
TSC_GROUP1_IO3
TSC_GROUP1_IO4
TSC_GROUP1_ALL_IOS
TSC_GROUP2_IO1
TSC_GROUP2_IO2
TSC_GROUP2_IO3
TSC_GROUP2_IO4
TSC_GROUP2_ALL_IOS
TSC_GROUP3_IO1
TSC_GROUP3_IO2
TSC_GROUP3_IO3
TSC_GROUP3_IO4
TSC_GROUP3_ALL_IOS
TSC_GROUP4_IO1
TSC_GROUP4_IO2
TSC_GROUP4_IO3
TSC_GROUP4_IO4
TSC_GROUP4_ALL_IOS
TSC_GROUP5_IO1
TSC_GROUP5_IO2
TSC_GROUP5_IO3
TSC_GROUP5_IO4
TSC_GROUP5_ALL_IOS
TSC_GROUP6_IO1
TSC_GROUP6_IO2
TSC_GROUP6_IO3
TSC_GROUP6_IO4
564/1320
DocID026525 Rev 6
UM1785
HAL TSC Generic Driver
TSC_GROUP6_ALL_IOS
TSC_GROUP7_IO1
TSC_GROUP7_IO2
TSC_GROUP7_IO3
TSC_GROUP7_IO4
TSC_GROUP7_ALL_IOS
TSC_GROUP8_IO1
TSC_GROUP8_IO2
TSC_GROUP8_IO3
TSC_GROUP8_IO4
TSC_GROUP8_ALL_IOS
TSC_ALL_GROUPS_ALL_IOS
TSC interrupts definition
TSC_IT_EOA
TSC_IT_MCE
IS_TSC_MCE_IT
TSC I/O default mode definition
TSC_IODEF_OUT_PP_LOW
TSC_IODEF_IN_FLOAT
IS_TSC_IODEF
TSC I/O mode definition
TSC_IOMODE_UNUSED
TSC_IOMODE_CHANNEL
TSC_IOMODE_SHIELD
TSC_IOMODE_SAMPLING
IS_TSC_IOMODE
TSC Max Count Value definition
TSC_MCV_255
TSC_MCV_511
TSC_MCV_1023
TSC_MCV_2047
TSC_MCV_4095
TSC_MCV_8191
TSC_MCV_16383
IS_TSC_MCV
DocID026525 Rev 6
565/1320
HAL TSC Generic Driver
TSC Pulse Generator prescaler definition
TSC_PG_PRESC_DIV1
TSC_PG_PRESC_DIV2
TSC_PG_PRESC_DIV4
TSC_PG_PRESC_DIV8
TSC_PG_PRESC_DIV16
TSC_PG_PRESC_DIV32
TSC_PG_PRESC_DIV64
TSC_PG_PRESC_DIV128
IS_TSC_PG_PRESC
TSC Spread Spectrum
IS_TSC_SS
IS_TSC_SSD
TSC Spread spectrum prescaler definition
TSC_SS_PRESC_DIV1
TSC_SS_PRESC_DIV2
IS_TSC_SS_PRESC
TSC Synchronization pin polarity
TSC_SYNC_POLARITY_FALLING
TSC_SYNC_POLARITY_RISING
IS_TSC_SYNC_POL
566/1320
DocID026525 Rev 6
UM1785
UM1785
HAL UART Generic Driver
44
HAL UART Generic Driver
44.1
UART Firmware driver registers structures
44.1.1
UART_InitTypeDef
Data Fields
uint32_t BaudRate
uint32_t WordLength
uint32_t StopBits
uint32_t Parity
uint32_t Mode
uint32_t HwFlowCtl
uint32_t OverSampling
uint32_t OneBitSampling
Field Documentation
uint32_t UART_InitTypeDef::BaudRate
This member configures the UART communication baud rate. The baud rate register
is computed using the following formula:If oversampling is 16 or in LIN mode (LIN
mode not available on F030xx devices), Baud Rate Register = ((PCLKx) / ((huart>Init.BaudRate)))If oversampling is 8, Baud Rate Register[15:4] = ((2 * PCLKx) /
((huart->Init.BaudRate)))[15:4] Baud Rate Register[3] = 0 Baud Rate Register[2:0] =
(((2 * PCLKx) / ((huart->Init.BaudRate)))[3:0]) >> 1U
uint32_t UART_InitTypeDef::WordLength
Specifies the number of data bits transmitted or received in a frame. This parameter
can be a value of UARTEx_Word_Length.
uint32_t UART_InitTypeDef::StopBits
Specifies the number of stop bits transmitted. This parameter can be a value of
UART_Stop_Bits.
uint32_t UART_InitTypeDef::Parity
Specifies the parity mode. This parameter can be a value of UART_Parity
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 UART_InitTypeDef::Mode
Specifies whether the Receive or Transmit mode is enabled or disabled. This
parameter can be a value of UART_Mode.
uint32_t UART_InitTypeDef::HwFlowCtl
Specifies whether the hardware flow control mode is enabled or disabled. This
parameter can be a value of UART_Hardware_Flow_Control.
uint32_t UART_InitTypeDef::OverSampling
Specifies whether the Over sampling 8 is enabled or disabled, to achieve higher
speed (up to f_PCLK/8). This parameter can be a value of UART_Over_Sampling.
uint32_t UART_InitTypeDef::OneBitSampling
Specifies whether a single sample or three samples' majority vote is selected.
Selecting the single sample method increases the receiver tolerance to clock
deviations. This parameter can be a value of UART_OneBit_Sampling.
DocID026525 Rev 6
567/1320
HAL UART Generic Driver
44.1.2
UM1785
UART_AdvFeatureInitTypeDef
Data Fields
uint32_t AdvFeatureInit
uint32_t TxPinLevelInvert
uint32_t RxPinLevelInvert
uint32_t DataInvert
uint32_t Swap
uint32_t OverrunDisable
uint32_t DMADisableonRxError
uint32_t AutoBaudRateEnable
uint32_t AutoBaudRateMode
uint32_t MSBFirst
Field Documentation
uint32_t UART_AdvFeatureInitTypeDef::AdvFeatureInit
Specifies which advanced UART features is initialized. Several Advanced Features
may be initialized at the same time . This parameter can be a value of
UART_Advanced_Features_Initialization_Type.
uint32_t UART_AdvFeatureInitTypeDef::TxPinLevelInvert
Specifies whether the TX pin active level is inverted. This parameter can be a value of
UART_Tx_Inv.
uint32_t UART_AdvFeatureInitTypeDef::RxPinLevelInvert
Specifies whether the RX pin active level is inverted. This parameter can be a value of
UART_Rx_Inv.
uint32_t UART_AdvFeatureInitTypeDef::DataInvert
Specifies whether data are inverted (positive/direct logic vs negative/inverted logic).
This parameter can be a value of UART_Data_Inv.
uint32_t UART_AdvFeatureInitTypeDef::Swap
Specifies whether TX and RX pins are swapped. This parameter can be a value of
UART_Rx_Tx_Swap.
uint32_t UART_AdvFeatureInitTypeDef::OverrunDisable
Specifies whether the reception overrun detection is disabled. This parameter can be
a value of UART_Overrun_Disable.
uint32_t UART_AdvFeatureInitTypeDef::DMADisableonRxError
Specifies whether the DMA is disabled in case of reception error. This parameter can
be a value of UART_DMA_Disable_on_Rx_Error.
uint32_t UART_AdvFeatureInitTypeDef::AutoBaudRateEnable
Specifies whether auto Baud rate detection is enabled. This parameter can be a value
of UART_AutoBaudRate_Enable
uint32_t UART_AdvFeatureInitTypeDef::AutoBaudRateMode
If auto Baud rate detection is enabled, specifies how the rate detection is carried out.
This parameter can be a value of UARTEx_AutoBaud_Rate_Mode.
uint32_t UART_AdvFeatureInitTypeDef::MSBFirst
Specifies whether MSB is sent first on UART line. This parameter can be a value of
UART_MSB_First.
44.1.3
UART_HandleTypeDef
Data Fields
USART_TypeDef * Instance
UART_InitTypeDef Init
UART_AdvFeatureInitTypeDef AdvancedInit
uint8_t * pTxBuffPtr
568/1320
DocID026525 Rev 6
UM1785
HAL UART Generic Driver
uint16_t TxXferSize
__IO uint16_t TxXferCount
uint8_t * pRxBuffPtr
uint16_t RxXferSize
__IO uint16_t RxXferCount
uint16_t Mask
DMA_HandleTypeDef * hdmatx
DMA_HandleTypeDef * hdmarx
HAL_LockTypeDef Lock
__IO HAL_UART_StateTypeDef gState
__IO HAL_UART_StateTypeDef RxState
__IO uint32_t ErrorCode
Field Documentation
USART_TypeDef* UART_HandleTypeDef::Instance
UART registers base address
UART_InitTypeDef UART_HandleTypeDef::Init
UART communication parameters
UART_AdvFeatureInitTypeDef UART_HandleTypeDef::AdvancedInit
UART Advanced Features initialization parameters
uint8_t* UART_HandleTypeDef::pTxBuffPtr
Pointer to UART Tx transfer Buffer
uint16_t UART_HandleTypeDef::TxXferSize
UART Tx Transfer size
__IO uint16_t UART_HandleTypeDef::TxXferCount
UART Tx Transfer Counter
uint8_t* UART_HandleTypeDef::pRxBuffPtr
Pointer to UART Rx transfer Buffer
uint16_t UART_HandleTypeDef::RxXferSize
UART Rx Transfer size
__IO uint16_t UART_HandleTypeDef::RxXferCount
UART Rx Transfer Counter
uint16_t UART_HandleTypeDef::Mask
UART Rx RDR register mask
DMA_HandleTypeDef* UART_HandleTypeDef::hdmatx
UART Tx DMA Handle parameters
DMA_HandleTypeDef* UART_HandleTypeDef::hdmarx
UART Rx DMA Handle parameters
HAL_LockTypeDef UART_HandleTypeDef::Lock
Locking object
__IO HAL_UART_StateTypeDef UART_HandleTypeDef::gState
UART state information related to global Handle management and also related to Tx
operations. This parameter can be a value of HAL_UART_StateTypeDef
__IO HAL_UART_StateTypeDef UART_HandleTypeDef::RxState
UART state information related to Rx operations. This parameter can be a value of
HAL_UART_StateTypeDef
__IO uint32_t UART_HandleTypeDef::ErrorCode
UART Error code
DocID026525 Rev 6
569/1320
HAL UART Generic Driver
UM1785
44.2
UART Firmware driver API description
44.2.1
How to use this driver
The UART HAL driver can be used as follows:
1.
2.
3.
4.
5.
6.
7.
8.
Declare a UART_HandleTypeDef handle structure (eg. UART_HandleTypeDef huart).
Initialize the UART low level resources by implementing the HAL_UART_MspInit()
API:
Enable the USARTx interface clock.
UART pins configuration:
Enable the clock for the UART GPIOs.
Configure these UART pins as alternate function pull-up.
NVIC configuration if you need to use interrupt process
(HAL_UART_Transmit_IT() and HAL_UART_Receive_IT() APIs):
Configure the USARTx interrupt priority.
Enable the NVIC USART IRQ handle.
UART interrupts handling: The specific UART interrupts (Transmission complete
interrupt, RXNE interrupt and Error Interrupts) are managed using the macros
__HAL_UART_ENABLE_IT() and __HAL_UART_DISABLE_IT() inside the
transmit and receive processes.
DMA Configuration if you need to use DMA process
(HAL_UART_Transmit_DMA() and HAL_UART_Receive_DMA() APIs):
Declare a DMA handle structure for the Tx/Rx channel.
Enable the DMAx interface clock.
Configure the declared DMA handle structure with the required Tx/Rx
parameters.
Configure the DMA Tx/Rx channel.
Associate the initialized DMA handle to the UART DMA Tx/Rx handle.
Configure the priority and enable the NVIC for the transfer complete interrupt
on the DMA Tx/Rx channel.
Program the Baud Rate, Word Length, Stop Bit, Parity, Hardware flow control and
Mode (Receiver/Transmitter) in the huart handle Init structure.
If required, program UART advanced features (TX/RX pins swap, auto Baud rate
detection,...) in the huart handle AdvancedInit structure.
For the UART asynchronous mode, initialize the UART registers by calling the
HAL_UART_Init() API.
For the UART Half duplex mode, initialize the UART registers by calling the
HAL_HalfDuplex_Init() API.
For the UART Multiprocessor mode, initialize the UART registers by calling the
HAL_MultiProcessor_Init() API.
For the UART RS485 Driver Enabled mode, initialize the UART registers by calling the
HAL_RS485Ex_Init() API.
These APIs(HAL_UART_Init(), HAL_HalfDuplex_Init(),
HAL_MultiProcessor_Init(), also configure the low level Hardware GPIO, CLOCK,
CORTEX...etc) by calling the customized HAL_UART_MspInit() API.
570/1320
DocID026525 Rev 6
UM1785
HAL UART Generic Driver
Three operation modes are available within this driver :
Polling mode IO operation
Send an amount of data in blocking mode using HAL_UART_Transmit()
Receive an amount of data in blocking mode using HAL_UART_Receive()
Interrupt mode IO operation
Send an amount of data in non blocking mode using HAL_UART_Transmit_IT()
At transmission end of half transfer HAL_UART_TxHalfCpltCallback is executed and
user can add his own code by customization of function pointer
HAL_UART_TxHalfCpltCallback
At transmission end of transfer HAL_UART_TxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_UART_TxCpltCallback
Receive an amount of data in non blocking mode using HAL_UART_Receive_IT()
At reception end of half transfer HAL_UART_RxHalfCpltCallback is executed and user
can add his own code by customization of function pointer
HAL_UART_RxHalfCpltCallback
At reception end of transfer HAL_UART_RxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_UART_RxCpltCallback
In case of transfer Error, HAL_UART_ErrorCallback() function is executed and user
can add his own code by customization of function pointer HAL_UART_ErrorCallback
DMA mode IO operation
Send an amount of data in non blocking mode (DMA) using
HAL_UART_Transmit_DMA()
At transmission end of half transfer HAL_UART_TxHalfCpltCallback is executed and
user can add his own code by customization of function pointer
HAL_UART_TxHalfCpltCallback
At transmission end of transfer HAL_UART_TxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_UART_TxCpltCallback
Receive an amount of data in non blocking mode (DMA) using
HAL_UART_Receive_DMA()
At reception end of half transfer HAL_UART_RxHalfCpltCallback is executed and user
can add his own code by customization of function pointer
HAL_UART_RxHalfCpltCallback
At reception end of transfer HAL_UART_RxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_UART_RxCpltCallback
In case of transfer Error, HAL_UART_ErrorCallback() function is executed and user
can add his own code by customization of function pointer HAL_UART_ErrorCallback
Pause the DMA Transfer using HAL_UART_DMAPause()
Resume the DMA Transfer using HAL_UART_DMAResume()
Stop the DMA Transfer using HAL_UART_DMAStop()
UART HAL driver macros list
Below the list of most used macros in UART HAL driver.
__HAL_UART_ENABLE: Enable the UART peripheral
__HAL_UART_DISABLE: Disable the UART peripheral
__HAL_UART_GET_FLAG : Check whether the specified UART flag is set or not
__HAL_UART_CLEAR_FLAG : Clear the specified UART pending flag
DocID026525 Rev 6
571/1320
HAL UART Generic Driver
UM1785
__HAL_UART_ENABLE_IT: Enable the specified UART interrupt
__HAL_UART_DISABLE_IT: Disable the specified UART interrupt
You can refer to the UART HAL driver header file for more useful macros
44.2.2
Initialization and Configuration functions
This subsection provides a set of functions allowing to initialize the USARTx or the UARTy
in asynchronous mode.
For the asynchronous mode the parameters below can be configured:
Baud Rate
Word Length
Stop Bit
Parity
Hardware flow control
Receiver/transmitter modes
Over Sampling Method
One-Bit Sampling Method
For the asynchronous mode, the following advanced features can be configured as
well:
TX and/or RX pin level inversion
data logical level inversion
RX and TX pins swap
RX overrun detection disabling
DMA disabling on RX error
MSB first on communication line
auto Baud rate detection
The HAL_UART_Init(), HAL_HalfDuplex_Init() and HAL_MultiProcessor_Init() API follow
respectively the UART asynchronous, UART Half duplex and multiprocessor mode
configuration procedures (details for the procedures are available in reference manual).
This section contains the following APIs:
HAL_UART_Init()
HAL_HalfDuplex_Init()
HAL_MultiProcessor_Init()
HAL_UART_DeInit()
HAL_UART_MspInit()
HAL_UART_MspDeInit()
44.2.3
IO operation functions
This section contains the following APIs:
HAL_UART_Transmit()
HAL_UART_Receive()
HAL_UART_Transmit_IT()
HAL_UART_Receive_IT()
HAL_UART_Transmit_DMA()
HAL_UART_Receive_DMA()
HAL_UART_DMAPause()
572/1320
DocID026525 Rev 6
UM1785
HAL UART Generic Driver
HAL_UART_DMAResume()
HAL_UART_DMAStop()
HAL_UART_Abort()
HAL_UART_AbortTransmit()
HAL_UART_AbortReceive()
HAL_UART_Abort_IT()
HAL_UART_AbortTransmit_IT()
HAL_UART_AbortReceive_IT()
HAL_UART_IRQHandler()
HAL_UART_TxCpltCallback()
HAL_UART_TxHalfCpltCallback()
HAL_UART_RxCpltCallback()
HAL_UART_RxHalfCpltCallback()
HAL_UART_ErrorCallback()
HAL_UART_AbortCpltCallback()
HAL_UART_AbortTransmitCpltCallback()
HAL_UART_AbortReceiveCpltCallback()
44.2.4
Peripheral Control functions
This subsection provides a set of functions allowing to control the UART.
HAL_MultiProcessor_EnableMuteMode() API enables mute mode
HAL_MultiProcessor_DisableMuteMode() API disables mute mode
HAL_MultiProcessor_EnterMuteMode() API enters mute mode
HAL_HalfDuplex_EnableTransmitter() API disables receiver and enables transmitter
HAL_HalfDuplex_EnableReceiver() API disables transmitter and enables receiver
This section contains the following APIs:
HAL_MultiProcessor_EnableMuteMode()
HAL_MultiProcessor_DisableMuteMode()
HAL_MultiProcessor_EnterMuteMode()
HAL_HalfDuplex_EnableTransmitter()
HAL_HalfDuplex_EnableReceiver()
44.2.5
Peripheral State and Error functions
This subsection provides functions allowing to :
Return the UART handle state.
Return the UART handle error code
This section contains the following APIs:
HAL_UART_GetState()
HAL_UART_GetError()
44.2.6
Detailed description of functions
HAL_UART_Init
Function name
HAL_StatusTypeDef HAL_UART_Init (UART_HandleTypeDef *
huart)
Function description
Initialize the UART mode according to the specified parameters in
the UART_InitTypeDef and initialize the associated handle.
DocID026525 Rev 6
573/1320
HAL UART Generic Driver
Parameters
UM1785
huart: UART handle.
Return values
HAL: status
HAL_HalfDuplex_Init
Function name
HAL_StatusTypeDef HAL_HalfDuplex_Init
(UART_HandleTypeDef * huart)
Function description
Initialize the half-duplex mode according to the specified
parameters in the UART_InitTypeDef and creates the associated
handle.
Parameters
huart: UART handle.
Return values
HAL: status
HAL_MultiProcessor_Init
Function name
HAL_StatusTypeDef HAL_MultiProcessor_Init
(UART_HandleTypeDef * huart, uint8_t Address, uint32_t
WakeUpMethod)
Function description
Initialize the multiprocessor mode according to the specified
parameters in the UART_InitTypeDef and initialize the associated
handle.
Parameters
huart: UART handle.
Address: UART node address (4-, 6-, 7- or 8-bit long).
WakeUpMethod: specifies the UART wakeup method. This
parameter can be one of the following values:
UART_WAKEUPMETHOD_IDLELINE WakeUp by an
idle line detection
UART_WAKEUPMETHOD_ADDRESSMARK WakeUp
by an address mark
Return values
HAL: status
Notes
If the user resorts to idle line detection wake up, the Address
parameter is useless and ignored by the initialization function.
If the user resorts to address mark wake up, the address
length detection is configured by default to 4 bits only. For the
UART to be able to manage 6-, 7- or 8-bit long addresses
detection, the API
HAL_MultiProcessorEx_AddressLength_Set() must be called
after HAL_MultiProcessor_Init().
HAL_UART_DeInit
574/1320
Function name
HAL_StatusTypeDef HAL_UART_DeInit
(UART_HandleTypeDef * huart)
Function description
DeInitialize the UART peripheral.
Parameters
huart: UART handle.
Return values
HAL: status
DocID026525 Rev 6
UM1785
HAL UART Generic Driver
HAL_UART_MspInit
Function name
void HAL_UART_MspInit (UART_HandleTypeDef * huart)
Function description
Initialize the UART MSP.
Parameters
huart: UART handle.
Return values
None
HAL_UART_MspDeInit
Function name
void HAL_UART_MspDeInit (UART_HandleTypeDef * huart)
Function description
DeInitialize the UART MSP.
Parameters
huart: UART handle.
Return values
None
HAL_UART_Transmit
Function name
HAL_StatusTypeDef HAL_UART_Transmit
(UART_HandleTypeDef * huart, uint8_t * pData, uint16_t Size,
uint32_t Timeout)
Function description
Send an amount of data in blocking mode.
Parameters
huart: UART handle.
pData: Pointer to data buffer.
Size: Amount of data to be sent.
Timeout: Timeout duration.
Return values
HAL: status
Notes
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffer containing data to be sent, should be aligned on a
half word frontier (16 bits) (as sent data will be handled using
u16 pointer cast). Depending on compilation chain, use of
specific alignment compilation directives or pragmas might be
required to ensure proper alignment for pData.
HAL_UART_Receive
Function name
HAL_StatusTypeDef HAL_UART_Receive
(UART_HandleTypeDef * huart, uint8_t * pData, uint16_t Size,
uint32_t Timeout)
Function description
Receive an amount of data in blocking mode.
Parameters
huart: UART handle.
pData: pointer to data buffer.
Size: amount of data to be received.
Timeout: Timeout duration.
Return values
HAL: status
Notes
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffer for storing data to be received, should be aligned
DocID026525 Rev 6
575/1320
HAL UART Generic Driver
UM1785
on a half word frontier (16 bits) (as received data will be
handled using u16 pointer cast). Depending on compilation
chain, use of specific alignment compilation directives or
pragmas might be required to ensure proper alignment for
pData.
HAL_UART_Transmit_IT
Function name
HAL_StatusTypeDef HAL_UART_Transmit_IT
(UART_HandleTypeDef * huart, uint8_t * pData, uint16_t Size)
Function description
Send an amount of data in interrupt mode.
Parameters
huart: UART handle.
pData: pointer to data buffer.
Size: amount of data to be sent.
Return values
HAL: status
Notes
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffer containing data to be sent, should be aligned on a
half word frontier (16 bits) (as sent data will be handled using
u16 pointer cast). Depending on compilation chain, use of
specific alignment compilation directives or pragmas might be
required to ensure proper alignment for pData.
HAL_UART_Receive_IT
Function name
HAL_StatusTypeDef HAL_UART_Receive_IT
(UART_HandleTypeDef * huart, uint8_t * pData, uint16_t Size)
Function description
Receive an amount of data in interrupt mode.
Parameters
huart: UART handle.
pData: pointer to data buffer.
Size: amount of data to be received.
Return values
HAL: status
Notes
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffer for storing data to be received, should be aligned
on a half word frontier (16 bits) (as received data will be
handled using u16 pointer cast). Depending on compilation
chain, use of specific alignment compilation directives or
pragmas might be required to ensure proper alignment for
pData.
HAL_UART_Transmit_DMA
Function name
HAL_StatusTypeDef HAL_UART_Transmit_DMA
(UART_HandleTypeDef * huart, uint8_t * pData, uint16_t Size)
Function description
Send an amount of data in DMA mode.
Parameters
576/1320
huart: UART handle.
pData: pointer to data buffer.
DocID026525 Rev 6
UM1785
HAL UART Generic Driver
Size: amount of data to be sent.
Return values
HAL: status
Notes
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffer containing data to be sent, should be aligned on a
half word frontier (16 bits) (as sent data will be handled by
DMA from halfword frontier). Depending on compilation chain,
use of specific alignment compilation directives or pragmas
might be required to ensure proper alignment for pData.
HAL_UART_Receive_DMA
Function name
HAL_StatusTypeDef HAL_UART_Receive_DMA
(UART_HandleTypeDef * huart, uint8_t * pData, uint16_t Size)
Function description
Receive an amount of data in DMA mode.
Parameters
huart: UART handle.
pData: pointer to data buffer.
Size: amount of data to be received.
Return values
HAL: status
Notes
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffer for storing data to be received, should be aligned
on a half word frontier (16 bits) (as received data will be
handled by DMA from halfword frontier). Depending on
compilation chain, use of specific alignment compilation
directives or pragmas might be required to ensure proper
alignment for pData.
HAL_UART_DMAPause
Function name
HAL_StatusTypeDef HAL_UART_DMAPause
(UART_HandleTypeDef * huart)
Function description
Pause the DMA Transfer.
Parameters
huart: UART handle.
Return values
HAL: status
HAL_UART_DMAResume
Function name
HAL_StatusTypeDef HAL_UART_DMAResume
(UART_HandleTypeDef * huart)
Function description
Resume the DMA Transfer.
Parameters
huart: UART handle.
Return values
HAL: status
HAL_UART_DMAStop
Function name
HAL_StatusTypeDef HAL_UART_DMAStop
DocID026525 Rev 6
577/1320
HAL UART Generic Driver
UM1785
(UART_HandleTypeDef * huart)
Function description
Stop the DMA Transfer.
Parameters
huart: UART handle.
Return values
HAL: status
HAL_UART_Abort
Function name
HAL_StatusTypeDef HAL_UART_Abort
(UART_HandleTypeDef * huart)
Function description
Abort ongoing transfers (blocking mode).
Parameters
huart: UART handle.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable UART Interrupts (Tx
and Rx)Disable the DMA transfer in the peripheral register (if
enabled)Abort DMA transfer by calling HAL_DMA_Abort (in
case of transfer in DMA mode)Set handle State to READY
This procedure is executed in blocking mode : when exiting
function, Abort is considered as completed.
HAL_UART_AbortTransmit
Function name
HAL_StatusTypeDef HAL_UART_AbortTransmit
(UART_HandleTypeDef * huart)
Function description
Abort ongoing Transmit transfer (blocking mode).
Parameters
huart: UART handle.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing Tx
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable UART Interrupts
(Tx)Disable the DMA transfer in the peripheral register (if
enabled)Abort DMA transfer by calling HAL_DMA_Abort (in
case of transfer in DMA mode)Set handle State to READY
This procedure is executed in blocking mode : when exiting
function, Abort is considered as completed.
HAL_UART_AbortReceive
578/1320
Function name
HAL_StatusTypeDef HAL_UART_AbortReceive
(UART_HandleTypeDef * huart)
Function description
Abort ongoing Receive transfer (blocking mode).
Parameters
huart: UART handle.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing Rx
transfer started in Interrupt or DMA mode. This procedure
DocID026525 Rev 6
UM1785
HAL UART Generic Driver
performs following operations : Disable UART Interrupts
(Rx)Disable the DMA transfer in the peripheral register (if
enabled)Abort DMA transfer by calling HAL_DMA_Abort (in
case of transfer in DMA mode)Set handle State to READY
This procedure is executed in blocking mode : when exiting
function, Abort is considered as completed.
HAL_UART_Abort_IT
Function name
HAL_StatusTypeDef HAL_UART_Abort_IT
(UART_HandleTypeDef * huart)
Function description
Abort ongoing transfers (Interrupt mode).
Parameters
huart: UART handle.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable UART Interrupts (Tx
and Rx)Disable the DMA transfer in the peripheral register (if
enabled)Abort DMA transfer by calling HAL_DMA_Abort_IT
(in case of transfer in DMA mode)Set handle State to
READYAt abort completion, call user abort complete callback
This procedure is executed in Interrupt mode, meaning that
abort procedure could be considered as completed only when
user abort complete callback is executed (not when exiting
function).
HAL_UART_AbortTransmit_IT
Function name
HAL_StatusTypeDef HAL_UART_AbortTransmit_IT
(UART_HandleTypeDef * huart)
Function description
Abort ongoing Transmit transfer (Interrupt mode).
Parameters
huart: UART handle.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing Tx
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable UART Interrupts
(Tx)Disable the DMA transfer in the peripheral register (if
enabled)Abort DMA transfer by calling HAL_DMA_Abort_IT
(in case of transfer in DMA mode)Set handle State to
READYAt abort completion, call user abort complete callback
This procedure is executed in Interrupt mode, meaning that
abort procedure could be considered as completed only when
user abort complete callback is executed (not when exiting
function).
DocID026525 Rev 6
579/1320
HAL UART Generic Driver
UM1785
HAL_UART_AbortReceive_IT
Function name
HAL_StatusTypeDef HAL_UART_AbortReceive_IT
(UART_HandleTypeDef * huart)
Function description
Abort ongoing Receive transfer (Interrupt mode).
Parameters
huart: UART handle.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing Rx
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable UART Interrupts
(Rx)Disable the DMA transfer in the peripheral register (if
enabled)Abort DMA transfer by calling HAL_DMA_Abort_IT
(in case of transfer in DMA mode)Set handle State to
READYAt abort completion, call user abort complete callback
This procedure is executed in Interrupt mode, meaning that
abort procedure could be considered as completed only when
user abort complete callback is executed (not when exiting
function).
HAL_UART_IRQHandler
Function name
void HAL_UART_IRQHandler (UART_HandleTypeDef * huart)
Function description
Handle UART interrupt request.
Parameters
huart: UART handle.
Return values
None
HAL_UART_TxCpltCallback
Function name
void HAL_UART_TxCpltCallback (UART_HandleTypeDef *
huart)
Function description
Tx Transfer completed callback.
Parameters
huart: UART handle.
Return values
None
HAL_UART_TxHalfCpltCallback
Function name
void HAL_UART_TxHalfCpltCallback (UART_HandleTypeDef *
huart)
Function description
Tx Half Transfer completed callback.
Parameters
huart: UART handle.
Return values
None
HAL_UART_RxCpltCallback
580/1320
Function name
void HAL_UART_RxCpltCallback (UART_HandleTypeDef *
huart)
Function description
Rx Transfer completed callback.
DocID026525 Rev 6
UM1785
HAL UART Generic Driver
Parameters
huart: UART handle.
Return values
None
HAL_UART_RxHalfCpltCallback
Function name
void HAL_UART_RxHalfCpltCallback (UART_HandleTypeDef *
huart)
Function description
Rx Half Transfer completed callback.
Parameters
huart: UART handle.
Return values
None
HAL_UART_ErrorCallback
Function name
void HAL_UART_ErrorCallback (UART_HandleTypeDef *
huart)
Function description
UART error callback.
Parameters
huart: UART handle.
Return values
None
HAL_UART_AbortCpltCallback
Function name
void HAL_UART_AbortCpltCallback (UART_HandleTypeDef *
huart)
Function description
UART Abort Complete callback.
Parameters
huart: UART handle.
Return values
None
HAL_UART_AbortTransmitCpltCallback
Function name
void HAL_UART_AbortTransmitCpltCallback
(UART_HandleTypeDef * huart)
Function description
UART Abort Complete callback.
Parameters
huart: UART handle.
Return values
None
HAL_UART_AbortReceiveCpltCallback
Function name
void HAL_UART_AbortReceiveCpltCallback
(UART_HandleTypeDef * huart)
Function description
UART Abort Receive Complete callback.
Parameters
huart: UART handle.
Return values
None
DocID026525 Rev 6
581/1320
HAL UART Generic Driver
UM1785
HAL_MultiProcessor_EnableMuteMode
Function name
HAL_StatusTypeDef HAL_MultiProcessor_EnableMuteMode
(UART_HandleTypeDef * huart)
Function description
Enable UART in mute mode (does not mean UART enters mute
mode; to enter mute mode,
HAL_MultiProcessor_EnterMuteMode() API must be called).
Parameters
huart: UART handle.
Return values
HAL: status
HAL_MultiProcessor_DisableMuteMode
Function name
HAL_StatusTypeDef HAL_MultiProcessor_DisableMuteMode
(UART_HandleTypeDef * huart)
Function description
Disable UART mute mode (does not mean the UART actually exits
mute mode as it may not have been in mute mode at this very
moment).
Parameters
huart: UART handle.
Return values
HAL: status
HAL_MultiProcessor_EnterMuteMode
Function name
void HAL_MultiProcessor_EnterMuteMode
(UART_HandleTypeDef * huart)
Function description
Enter UART mute mode (means UART actually enters mute
mode).
Parameters
huart: UART handle.
Return values
None
Notes
To exit from mute mode,
HAL_MultiProcessor_DisableMuteMode() API must be called.
HAL_HalfDuplex_EnableTransmitter
Function name
HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter
(UART_HandleTypeDef * huart)
Function description
Enable the UART transmitter and disable the UART receiver.
Parameters
huart: UART handle.
Return values
HAL: status
HAL_HalfDuplex_EnableReceiver
582/1320
Function name
HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver
(UART_HandleTypeDef * huart)
Function description
Enable the UART receiver and disable the UART transmitter.
Parameters
huart: UART handle.
Return values
HAL: status.
DocID026525 Rev 6
UM1785
HAL UART Generic Driver
HAL_UART_GetState
Function name
HAL_UART_StateTypeDef HAL_UART_GetState
(UART_HandleTypeDef * huart)
Function description
Return the UART handle state.
Parameters
huart: Pointer to a UART_HandleTypeDef structure that
contains the configuration information for the specified UART.
Return values
HAL: state
HAL_UART_GetError
Function name
uint32_t HAL_UART_GetError (UART_HandleTypeDef * huart)
Function description
Return the UART handle error code.
Parameters
huart: Pointer to a UART_HandleTypeDef structure that
contains the configuration information for the specified UART.
Return values
UART: Error Code
UART_AdvFeatureConfig
Function name
void UART_AdvFeatureConfig (UART_HandleTypeDef * huart)
Function description
Configure the UART peripheral advanced features.
Parameters
huart: UART handle.
Return values
None
UART_CheckIdleState
Function name
HAL_StatusTypeDef UART_CheckIdleState
(UART_HandleTypeDef * huart)
Function description
Check the UART Idle State.
Parameters
huart: UART handle.
Return values
HAL: status
UART_SetConfig
Function name
HAL_StatusTypeDef UART_SetConfig (UART_HandleTypeDef
* huart)
Function description
Configure the UART peripheral.
Parameters
huart: UART handle.
Return values
HAL: status
UART_Transmit_IT
Function name
HAL_StatusTypeDef UART_Transmit_IT
(UART_HandleTypeDef * huart)
Function description
Send an amount of data in interrupt mode.
DocID026525 Rev 6
583/1320
HAL UART Generic Driver
Parameters
UM1785
huart: UART handle.
Return values
HAL: status
Notes
Function is called under interruption only, once interruptions
have been enabled by HAL_UART_Transmit_IT().
UART_EndTransmit_IT
Function name
HAL_StatusTypeDef UART_EndTransmit_IT
(UART_HandleTypeDef * huart)
Function description
Wrap up transmission in non-blocking mode.
Parameters
huart: pointer to a UART_HandleTypeDef structure that
contains the configuration information for the specified UART
module.
Return values
HAL: status
UART_Receive_IT
Function name
HAL_StatusTypeDef UART_Receive_IT
(UART_HandleTypeDef * huart)
Function description
Receive an amount of data in interrupt mode.
Parameters
huart: UART handle.
Return values
HAL: status
Notes
Function is called under interruption only, once interruptions
have been enabled by HAL_UART_Receive_IT()
UART_WaitOnFlagUntilTimeout
Function name
HAL_StatusTypeDef UART_WaitOnFlagUntilTimeout
(UART_HandleTypeDef * huart, uint32_t Flag, FlagStatus
Status, uint32_t Tickstart, uint32_t Timeout)
Function description
Handle UART Communication Timeout.
Parameters
huart: UART handle.
Flag: Specifies the UART flag to check
Status: Flag status (SET or RESET)
Tickstart: Tick start value
Timeout: Timeout duration
Return values
HAL: status
44.3
UART Firmware driver defines
44.3.1
UART
UART Advanced Feature Initialization Type
584/1320
UART_ADVFEATURE_NO_INIT
No advanced feature initialization
UART_ADVFEATURE_TXINVERT_INIT
TX pin active level inversion
DocID026525 Rev 6
UM1785
UART_ADVFEATURE_RXINVERT_INIT
HAL UART Generic Driver
RX pin active level inversion
UART_ADVFEATURE_DATAINVERT_INIT
Binary data inversion
UART_ADVFEATURE_SWAP_INIT
TX/RX pins swap
UART_ADVFEATURE_RXOVERRUNDISABLE_INIT
RX overrun disable
UART_ADVFEATURE_DMADISABLEONERROR_INIT
DMA disable on Reception Error
UART_ADVFEATURE_AUTOBAUDRATE_INIT
Auto Baud rate detection
initialization
UART_ADVFEATURE_MSBFIRST_INIT
Most significant bit sent/received
first
UART Advanced Feature Auto BaudRate Enable
UART_ADVFEATURE_AUTOBAUDRATE_DISABLE
RX Auto Baud rate detection
enable
UART_ADVFEATURE_AUTOBAUDRATE_ENABLE
RX Auto Baud rate detection
disable
UART Driver Enable Assertion Time LSB Position In CR1 Register
UART_CR1_DEAT_ADDRESS_LSB_POS
UART Driver Enable assertion time LSB
position in CR1 register
UART Driver Enable DeAssertion Time LSB Position In CR1 Register
UART_CR1_DEDT_ADDRESS_LSB_POS
UART Driver Enable de-assertion time LSB
position in CR1 register
UART Address-matching LSB Position In CR2 Register
UART_CR2_ADDRESS_LSB_POS
UART address-matching LSB position in CR2
register
UART Advanced Feature Binary Data Inversion
UART_ADVFEATURE_DATAINV_DISABLE
Binary data inversion disable
UART_ADVFEATURE_DATAINV_ENABLE
Binary data inversion enable
UART Advanced Feature DMA Disable On Rx Error
UART_ADVFEATURE_DMA_ENABLEONRXERROR
DMA enable on Reception Error
UART_ADVFEATURE_DMA_DISABLEONRXERROR
DMA disable on Reception Error
UART DMA Rx
UART_DMA_RX_DISABLE
UART DMA RX disabled
UART_DMA_RX_ENABLE
UART DMA RX enabled
UART DMA Tx
UART_DMA_TX_DISABLE
UART DMA TX disabled
UART_DMA_TX_ENABLE
UART DMA TX enabled
UART DriverEnable Polarity
UART_DE_POLARITY_HIGH
Driver enable signal is active high
UART_DE_POLARITY_LOW
Driver enable signal is active low
DocID026525 Rev 6
585/1320
HAL UART Generic Driver
UART Error
UM1785
HAL_UART_ERROR_NONE
No error
HAL_UART_ERROR_PE
Parity error
HAL_UART_ERROR_NE
Noise error
HAL_UART_ERROR_FE
frame error
HAL_UART_ERROR_ORE
Overrun error
HAL_UART_ERROR_DMA
DMA transfer error
HAL_UART_ERROR_BUSY
Busy Error
UART Exported Macros
__HAL_UART_RESET_HANDLE_STA
TE
Description:
Reset UART handle states.
Parameters:
__HANDLE__: UART handle.
Return value:
None
__HAL_UART_CLEAR_FLAG
Description:
Clear the specified UART pending flag.
Parameters:
__HANDLE__: specifies the UART Handle.
__FLAG__: specifies the flag to check. This
parameter can be any combination of the
following values:
UART_CLEAR_PEF Parity Error Clear
Flag
UART_CLEAR_FEF Framing Error
Clear Flag
UART_CLEAR_NEF Noise detected
Clear Flag
UART_CLEAR_OREF Overrun Error
Clear Flag
UART_CLEAR_IDLEF IDLE line
detected Clear Flag
UART_CLEAR_TCF Transmission
Complete Clear Flag
UART_CLEAR_LBDF LIN Break
Detection Clear Flag (not available on
all devices)
UART_CLEAR_CTSF CTS Interrupt
Clear Flag
UART_CLEAR_RTOF Receiver Time
Out Clear Flag
UART_CLEAR_EOBF End Of Block
Clear Flag (not available on all
devices)
UART_CLEAR_CMF Character Match
586/1320
DocID026525 Rev 6
UM1785
HAL UART Generic Driver
Clear Flag
UART_CLEAR_WUF Wake Up from
stop mode Clear Flag (not available on
all devices)
Return value:
None
__HAL_UART_CLEAR_PEFLAG
Description:
Clear the UART PE pending flag.
Parameters:
__HANDLE__: specifies the UART Handle.
Return value:
None
__HAL_UART_CLEAR_FEFLAG
Description:
Clear the UART FE pending flag.
Parameters:
__HANDLE__: specifies the UART Handle.
Return value:
None
__HAL_UART_CLEAR_NEFLAG
Description:
Clear the UART NE pending flag.
Parameters:
__HANDLE__: specifies the UART Handle.
Return value:
None
__HAL_UART_CLEAR_OREFLAG
Description:
Clear the UART ORE pending flag.
Parameters:
__HANDLE__: specifies the UART Handle.
Return value:
None
__HAL_UART_CLEAR_IDLEFLAG
Description:
Clear the UART IDLE pending flag.
Parameters:
__HANDLE__: specifies the UART Handle.
Return value:
None
__HAL_UART_GET_FLAG
Description:
DocID026525 Rev 6
587/1320
HAL UART Generic Driver
UM1785
Check whether the specified UART flag is
set or not.
Parameters:
__HANDLE__: specifies the UART Handle.
__FLAG__: specifies the flag to check. This
parameter can be one of the following
values:
UART_FLAG_REACK Receive enable
acknowledge flag
UART_FLAG_TEACK Transmit enable
acknowledge flag
UART_FLAG_WUF Wake up from stop
mode flag (not available on F030xx
devices)
UART_FLAG_RWU Receiver wake up
flag (not available on F030xx devices)
UART_FLAG_SBKF Send Break flag
UART_FLAG_CMF Character match
flag
UART_FLAG_BUSY Busy flag
UART_FLAG_ABRF Auto Baud rate
detection flag
UART_FLAG_ABRE Auto Baud rate
detection error flag
UART_FLAG_EOBF End of block flag
(not available on F030xx devices)
UART_FLAG_RTOF Receiver timeout
flag
UART_FLAG_CTS CTS Change flag
UART_FLAG_LBDF LIN Break
detection flag (not available on F030xx
devices)
UART_FLAG_TXE Transmit data
register empty flag
UART_FLAG_TC Transmission
Complete flag
UART_FLAG_RXNE Receive data
register not empty flag
UART_FLAG_IDLE Idle Line detection
flag
UART_FLAG_ORE Overrun Error flag
UART_FLAG_NE Noise Error flag
UART_FLAG_FE Framing Error flag
UART_FLAG_PE Parity Error flag
Return value:
The: new state of __FLAG__ (TRUE or
FALSE).
__HAL_UART_ENABLE_IT
Description:
Enable the specified UART interrupt.
Parameters:
588/1320
DocID026525 Rev 6
UM1785
HAL UART Generic Driver
__HANDLE__: specifies the UART Handle.
__INTERRUPT__: specifies the UART
interrupt source to enable. This parameter
can be one of the following values:
UART_IT_WUF Wakeup from stop
mode interrupt (not available on
F030xx devices)
UART_IT_CM Character match
interrupt
UART_IT_CTS CTS change interrupt
UART_IT_LBD LIN Break detection
interrupt (not available on F030xx
devices)
UART_IT_TXE Transmit Data Register
empty interrupt
UART_IT_TC Transmission complete
interrupt
UART_IT_RXNE Receive Data register
not empty interrupt
UART_IT_IDLE Idle line detection
interrupt
UART_IT_PE Parity Error interrupt
UART_IT_ERR Error interrupt (Frame
error, noise error, overrun error)
Return value:
None
__HAL_UART_DISABLE_IT
Description:
Disable the specified UART interrupt.
Parameters:
__HANDLE__: specifies the UART Handle.
__INTERRUPT__: specifies the UART
interrupt source to disable. This parameter
can be one of the following values:
UART_IT_WUF Wakeup from stop
mode interrupt (not available on
F030xx devices)
UART_IT_CM Character match
interrupt
UART_IT_CTS CTS change interrupt
UART_IT_LBD LIN Break detection
interrupt (not available on F030xx
devices)
UART_IT_TXE Transmit Data Register
empty interrupt
UART_IT_TC Transmission complete
interrupt
UART_IT_RXNE Receive Data register
not empty interrupt
UART_IT_IDLE Idle line detection
interrupt
UART_IT_PE Parity Error interrupt
DocID026525 Rev 6
589/1320
HAL UART Generic Driver
UM1785
UART_IT_ERR Error interrupt (Frame
error, noise error, overrun error)
Return value:
None
Description:
__HAL_UART_GET_IT
Check whether the specified UART interrupt
has occurred or not.
Parameters:
__HANDLE__: specifies the UART Handle.
__IT__: specifies the UART interrupt to
check. This parameter can be one of the
following values:
UART_IT_WUF Wakeup from stop
mode interrupt (not available on
F030xx devices)
UART_IT_CM Character match
interrupt
UART_IT_CTS CTS change interrupt
UART_IT_LBD LIN Break detection
interrupt (not available on F030xx
devices)
UART_IT_TXE Transmit Data Register
empty interrupt
UART_IT_TC Transmission complete
interrupt
UART_IT_RXNE Receive Data register
not empty interrupt
UART_IT_IDLE Idle line detection
interrupt
UART_IT_ORE Overrun Error interrupt
UART_IT_NE Noise Error interrupt
UART_IT_FE Framing Error interrupt
UART_IT_PE Parity Error interrupt
Return value:
The: new state of __IT__ (TRUE or
FALSE).
__HAL_UART_GET_IT_SOURCE
Description:
Check whether the specified UART interrupt
source is enabled or not.
Parameters:
__HANDLE__: specifies the UART Handle.
__IT__: specifies the UART interrupt source
to check. This parameter can be one of the
following values:
UART_IT_WUF Wakeup from stop
mode interrupt (not available on
F030xx devices)
UART_IT_CM Character match
590/1320
DocID026525 Rev 6
UM1785
HAL UART Generic Driver
interrupt
UART_IT_CTS CTS change interrupt
UART_IT_LBD LIN Break detection
interrupt (not available on F030xx
devices)
UART_IT_TXE Transmit Data Register
empty interrupt
UART_IT_TC Transmission complete
interrupt
UART_IT_RXNE Receive Data register
not empty interrupt
UART_IT_IDLE Idle line detection
interrupt
UART_IT_ERR Error interrupt (Frame
error, noise error, overrun error)
UART_IT_PE Parity Error interrupt
Return value:
The: new state of __IT__ (TRUE or
FALSE).
__HAL_UART_CLEAR_IT
Description:
Clear the specified UART ISR flag, in
setting the proper ICR register flag.
Parameters:
__HANDLE__: specifies the UART Handle.
__IT_CLEAR__: specifies the interrupt clear
register flag that needs to be set to clear the
corresponding interrupt This parameter can
be one of the following values:
UART_CLEAR_PEF Parity Error Clear
Flag
UART_CLEAR_FEF Framing Error
Clear Flag
UART_CLEAR_NEF Noise detected
Clear Flag
UART_CLEAR_OREF Overrun Error
Clear Flag
UART_CLEAR_IDLEF IDLE line
detected Clear Flag
UART_CLEAR_TCF Transmission
Complete Clear Flag
UART_CLEAR_LBDF LIN Break
Detection Clear Flag (not available on
F030xx devices)
UART_CLEAR_CTSF CTS Interrupt
Clear Flag
UART_CLEAR_RTOF Receiver Time
Out Clear Flag
UART_CLEAR_EOBF End Of Block
Clear Flag
UART_CLEAR_CMF Character Match
Clear Flag
DocID026525 Rev 6
591/1320
HAL UART Generic Driver
UM1785
UART_CLEAR_WUF Wake Up from
stop mode Clear Flag (not available on
F030xx devices)
Return value:
None
Description:
__HAL_UART_SEND_REQ
Set a specific UART request flag.
Parameters:
__HANDLE__: specifies the UART Handle.
__REQ__: specifies the request flag to set
This parameter can be one of the following
values:
UART_AUTOBAUD_REQUEST AutoBaud Rate Request
UART_SENDBREAK_REQUEST
Send Break Request
UART_MUTE_MODE_REQUEST
Mute Mode Request
UART_RXDATA_FLUSH_REQUEST
Receive Data flush Request
UART_TXDATA_FLUSH_REQUEST
Transmit data flush Request (not
available on F030xx devices)
Return value:
None
__HAL_UART_ONE_BIT_SAMPLE_
ENABLE
Description:
Enable the UART one bit sample method.
Parameters:
__HANDLE__: specifies the UART Handle.
Return value:
None
__HAL_UART_ONE_BIT_SAMPLE_
DISABLE
Description:
Disable the UART one bit sample method.
Parameters:
__HANDLE__: specifies the UART Handle.
Return value:
None
__HAL_UART_ENABLE
Description:
Enable UART.
Parameters:
__HANDLE__: specifies the UART Handle.
592/1320
DocID026525 Rev 6
UM1785
HAL UART Generic Driver
Return value:
None
Description:
__HAL_UART_DISABLE
Disable UART.
Parameters:
__HANDLE__: specifies the UART Handle.
Return value:
None
__HAL_UART_HWCONTROL_CTS_
ENABLE
Description:
Enable CTS flow control.
Parameters:
__HANDLE__: specifies the UART Handle.
Return value:
None
Notes:
This macro allows to enable CTS hardware
flow control for a given UART instance,
without need to call HAL_UART_Init()
function. As involving direct access to
UART registers, usage of this macro should
be fully endorsed by user. As macro is
expected to be used for modifying CTS Hw
flow control feature activation, without need
for USART instance Deinit/Init, following
conditions for macro call should be fulfilled :
UART instance should have already been
initialised (through call of HAL_UART_Init()
)macro could only be called when
corresponding UART instance is disabled
(i.e.
__HAL_UART_DISABLE(__HANDLE__))
and should be followed by an Enable macro
(i.e.
__HAL_UART_ENABLE(__HANDLE__)).
__HAL_UART_HWCONTROL_CTS_
DISABLE
Description:
Disable CTS flow control.
Parameters:
__HANDLE__: specifies the UART Handle.
Return value:
None
Notes:
This macro allows to disable CTS hardware
flow control for a given UART instance,
DocID026525 Rev 6
593/1320
HAL UART Generic Driver
UM1785
without need to call HAL_UART_Init()
function. As involving direct access to
UART registers, usage of this macro should
be fully endorsed by user. As macro is
expected to be used for modifying CTS Hw
flow control feature activation, without need
for USART instance Deinit/Init, following
conditions for macro call should be fulfilled :
UART instance should have already been
initialised (through call of HAL_UART_Init()
)macro could only be called when
corresponding UART instance is disabled
(i.e.
__HAL_UART_DISABLE(__HANDLE__))
and should be followed by an Enable macro
(i.e.
__HAL_UART_ENABLE(__HANDLE__)).
__HAL_UART_HWCONTROL_RTS_
ENABLE
Description:
Enable RTS flow control.
Parameters:
__HANDLE__: specifies the UART Handle.
Return value:
None
Notes:
This macro allows to enable RTS hardware
flow control for a given UART instance,
without need to call HAL_UART_Init()
function. As involving direct access to
UART registers, usage of this macro should
be fully endorsed by user. As macro is
expected to be used for modifying RTS Hw
flow control feature activation, without need
for USART instance Deinit/Init, following
conditions for macro call should be fulfilled :
UART instance should have already been
initialised (through call of HAL_UART_Init()
)macro could only be called when
corresponding UART instance is disabled
(i.e.
__HAL_UART_DISABLE(__HANDLE__))
and should be followed by an Enable macro
(i.e.
__HAL_UART_ENABLE(__HANDLE__)).
__HAL_UART_HWCONTROL_RTS_
DISABLE
Description:
Disable RTS flow control.
Parameters:
__HANDLE__: specifies the UART Handle.
Return value:
594/1320
DocID026525 Rev 6
UM1785
HAL UART Generic Driver
None
Notes:
This macro allows to disable RTS hardware
flow control for a given UART instance,
without need to call HAL_UART_Init()
function. As involving direct access to
UART registers, usage of this macro should
be fully endorsed by user. As macro is
expected to be used for modifying RTS Hw
flow control feature activation, without need
for USART instance Deinit/Init, following
conditions for macro call should be fulfilled :
UART instance should have already been
initialised (through call of HAL_UART_Init()
)macro could only be called when
corresponding UART instance is disabled
(i.e.
__HAL_UART_DISABLE(__HANDLE__))
and should be followed by an Enable macro
(i.e.
__HAL_UART_ENABLE(__HANDLE__)).
UARTEx Status Flags
UART_FLAG_REACK
UART receive enable acknowledge flag
UART_FLAG_TEACK
UART transmit enable acknowledge flag
UART_FLAG_WUF
UART wake-up from stop mode flag
UART_FLAG_RWU
UART receiver wake-up from mute mode flag
UART_FLAG_SBKF
UART send break flag
UART_FLAG_CMF
UART character match flag
UART_FLAG_BUSY
UART busy flag
UART_FLAG_ABRF
UART auto Baud rate flag
UART_FLAG_ABRE
UART auto Baud rate error
UART_FLAG_EOBF
UART end of block flag
UART_FLAG_RTOF
UART receiver timeout flag
UART_FLAG_CTS
UART clear to send flag
UART_FLAG_CTSIF
UART clear to send interrupt flag
UART_FLAG_LBDF
UART LIN break detection flag (not available on F030xx devices)
UART_FLAG_TXE
UART transmit data register empty
UART_FLAG_TC
UART transmission complete
UART_FLAG_RXNE
UART read data register not empty
UART_FLAG_IDLE
UART idle flag
UART_FLAG_ORE
UART overrun error
UART_FLAG_NE
UART noise error
DocID026525 Rev 6
595/1320
HAL UART Generic Driver
UART_FLAG_FE
UART frame error
UM1785
UART_FLAG_PE
UART parity error
UART Half Duplex Selection
UART_HALF_DUPLEX_DISABLE
UART half-duplex disabled
UART_HALF_DUPLEX_ENABLE
UART half-duplex enabled
UART Hardware Flow Control
UART_HWCONTROL_NONE
No hardware control
UART_HWCONTROL_RTS
Request To Send
UART_HWCONTROL_CTS
Clear To Send
UART_HWCONTROL_RTS_CTS
Request and Clear To Send
UART Interruptions Flag Mask
UART_IT_MASK
UART interruptions flags mask
UARTEx Interrupts Definition
UART_IT_PE
UART parity error interruption
UART_IT_TXE
UART transmit data register empty interruption
UART_IT_TC
UART transmission complete interruption
UART_IT_RXNE
UART read data register not empty interruption
UART_IT_IDLE
UART idle interruption
UART_IT_LBD
UART LIN break detection interruption
UART_IT_CTS
UART CTS interruption
UART_IT_CM
UART character match interruption
UART_IT_WUF
UART wake-up from stop mode interruption
UART IT
UART_IT_ERR
UART error interruption
UART_IT_ORE
UART overrun error interruption
UART_IT_NE
UART noise error interruption
UART_IT_FE
UART frame error interruption
UARTEx Interruption Clear Flags
596/1320
UART_CLEAR_PEF
Parity Error Clear Flag
UART_CLEAR_FEF
Framing Error Clear Flag
UART_CLEAR_NEF
Noise detected Clear Flag
UART_CLEAR_OREF
Overrun Error Clear Flag
UART_CLEAR_IDLEF
IDLE line detected Clear Flag
UART_CLEAR_TCF
Transmission Complete Clear Flag
UART_CLEAR_LBDF
LIN Break Detection Clear Flag (not available on F030xx devices)
UART_CLEAR_CTSF
CTS Interrupt Clear Flag
DocID026525 Rev 6
UM1785
HAL UART Generic Driver
UART_CLEAR_RTOF
Receiver Time Out Clear Flag
UART_CLEAR_EOBF
End Of Block Clear Flag
UART_CLEAR_CMF
Character Match Clear Flag
UART_CLEAR_WUF
Wake Up from stop mode Clear Flag
UART Transfer Mode
UART_MODE_RX
RX mode
UART_MODE_TX
TX mode
UART_MODE_TX_RX
RX and TX mode
UART Advanced Feature MSB First
UART_ADVFEATURE_MSBFIRST_DISABLE
Most significant bit sent/received first
disable
UART_ADVFEATURE_MSBFIRST_ENABLE
Most significant bit sent/received first
enable
UART Advanced Feature Mute Mode Enable
UART_ADVFEATURE_MUTEMODE_DISABLE
UART mute mode disable
UART_ADVFEATURE_MUTEMODE_ENABLE
UART mute mode enable
UART One Bit Sampling Method
UART_ONE_BIT_SAMPLE_DISABLE
One-bit sampling disable
UART_ONE_BIT_SAMPLE_ENABLE
One-bit sampling enable
UART Advanced Feature Overrun Disable
UART_ADVFEATURE_OVERRUN_ENABLE
RX overrun enable
UART_ADVFEATURE_OVERRUN_DISABLE
RX overrun disable
UART Over Sampling
UART_OVERSAMPLING_16
Oversampling by 16
UART_OVERSAMPLING_8
Oversampling by 8
UART Parity
UART_PARITY_NONE
No parity
UART_PARITY_EVEN
Even parity
UART_PARITY_ODD
Odd parity
UART Receiver TimeOut
UART_RECEIVER_TIMEOUT_DISABLE
UART receiver timeout disable
UART_RECEIVER_TIMEOUT_ENABLE
UART receiver timeout enable
UARTEx Request Parameters
UART_AUTOBAUD_REQUEST
Auto-Baud Rate Request
UART_SENDBREAK_REQUEST
Send Break Request
UART_MUTE_MODE_REQUEST
Mute Mode Request
UART_RXDATA_FLUSH_REQUEST
Receive Data flush Request
DocID026525 Rev 6
597/1320
HAL UART Generic Driver
UART_TXDATA_FLUSH_REQUEST
UM1785
Transmit data flush Request
UART Advanced Feature RX Pin Active Level Inversion
UART_ADVFEATURE_RXINV_DISABLE
RX pin active level inversion disable
UART_ADVFEATURE_RXINV_ENABLE
RX pin active level inversion enable
UART Advanced Feature RX TX Pins Swap
UART_ADVFEATURE_SWAP_DISABLE
TX/RX pins swap disable
UART_ADVFEATURE_SWAP_ENABLE
TX/RX pins swap enable
UART State
UART_STATE_DISABLE
UART disabled
UART_STATE_ENABLE
UART enabled
UART Number of Stop Bits
UART_STOPBITS_0_5
UART frame with 0.5 stop bit
UART_STOPBITS_1
UART frame with 1 stop bit
UART_STOPBITS_1_5
UART frame with 1.5 stop bits
UART_STOPBITS_2
UART frame with 2 stop bits
UARTEx Advanced Feature Stop Mode Enable
UART_ADVFEATURE_STOPMODE_DISABLE
UART stop mode disable
UART_ADVFEATURE_STOPMODE_ENABLE
UART stop mode enable
UART polling-based communications time-out value
HAL_UART_TIMEOUT_VALUE
UART polling-based communications time-out value
UART Advanced Feature TX Pin Active Level Inversion
UART_ADVFEATURE_TXINV_DISABLE
TX pin active level inversion disable
UART_ADVFEATURE_TXINV_ENABLE
TX pin active level inversion enable
UART WakeUp Address Length
UART_ADDRESS_DETECT_4B
4-bit long wake-up address
UART_ADDRESS_DETECT_7B
7-bit long wake-up address
UART WakeUp From Stop Selection
UART_WAKEUP_ON_ADDRESS
UART wake-up on address
UART_WAKEUP_ON_STARTBIT
UART wake-up on start bit
UART_WAKEUP_ON_READDATA_NONEMPTY
UART wake-up on receive data
register not empty
UART WakeUp Methods
598/1320
UART_WAKEUPMETHOD_IDLELINE
UART wake-up on idle line
UART_WAKEUPMETHOD_ADDRESSMARK
UART wake-up on address mark
DocID026525 Rev 6
UM1785
HAL UART Extension Driver
45
HAL UART Extension Driver
45.1
UARTEx Firmware driver registers structures
45.1.1
UART_WakeUpTypeDef
Data Fields
uint32_t WakeUpEvent
uint16_t AddressLength
uint8_t Address
Field Documentation
uint32_t UART_WakeUpTypeDef::WakeUpEvent
Specifies which event will activat the Wakeup from Stop mode flag (WUF). This
parameter can be a value of UART_WakeUp_from_Stop_Selection. If set to
UART_WAKEUP_ON_ADDRESS, the two other fields below must be filled up.
uint16_t UART_WakeUpTypeDef::AddressLength
Specifies whether the address is 4 or 7-bit long. This parameter can be a value of
UART_WakeUp_Address_Length.
uint8_t UART_WakeUpTypeDef::Address
UART/USART node address (7-bit long max).
45.2
UARTEx Firmware driver API description
45.2.1
UART peripheral extended features
45.2.2
Initialization and Configuration functions
This subsection provides a set of functions allowing to initialize the USARTx or the UARTy
in asynchronous mode.
For the asynchronous mode the parameters below can be configured:
Baud Rate
Word Length (Fixed to 8-bits only for LIN mode)
Stop Bit
Parity
Hardware flow control
Receiver/transmitter modes
Over Sampling Method
One-Bit Sampling Method
For the asynchronous mode, the following advanced features can be configured as
well:
TX and/or RX pin level inversion
data logical level inversion
RX and TX pins swap
RX overrun detection disabling
DMA disabling on RX error
MSB first on communication line
auto Baud rate detection
DocID026525 Rev 6
599/1320
HAL UART Extension Driver
UM1785
The HAL_LIN_Init() and HAL_RS485Ex_Init() APIs follows respectively the LIN and the
UART RS485 mode configuration procedures (details for the procedures are available in
reference manual).
This section contains the following APIs:
HAL_RS485Ex_Init()
HAL_LIN_Init()
45.2.3
IO operation function
This subsection provides function to handle Wake up interrupt call-back.
1.
Callback provided in No_Blocking mode:
HAL_UARTEx_WakeupCallback()
This section contains the following APIs:
HAL_UARTEx_WakeupCallback()
45.2.4
Peripheral Control functions
This subsection provides extended functions allowing to control the UART.
HAL_UARTEx_StopModeWakeUpSourceConfig() API sets Wakeup from Stop mode
interrupt flag selection
HAL_UARTEx_EnableStopMode() API allows the UART to wake up the MCU from
Stop mode as long as UART clock is HSI or LSE
HAL_UARTEx_DisableStopMode() API disables the above feature
HAL_MultiProcessorEx_AddressLength_Set() API optionally sets the UART node
address detection length to more than 4 bits for multiprocessor address mark wake
up.
HAL_LIN_SendBreak() API transmits the break characters
This section contains the following APIs:
HAL_UARTEx_StopModeWakeUpSourceConfig()
HAL_UARTEx_EnableStopMode()
HAL_UARTEx_DisableStopMode()
HAL_MultiProcessorEx_AddressLength_Set()
HAL_LIN_SendBreak()
45.2.5
Detailed description of functions
HAL_RS485Ex_Init
Function name
HAL_StatusTypeDef HAL_RS485Ex_Init
(UART_HandleTypeDef * huart, uint32_t Polarity, uint32_t
AssertionTime, uint32_t DeassertionTime)
Function description
Initialize the RS485 Driver enable feature according to the
specified parameters in the UART_InitTypeDef and creates the
associated handle.
Parameters
600/1320
huart: UART handle.
Polarity: select the driver enable polarity. This parameter
can be one of the following values:
UART_DE_POLARITY_HIGH DE signal is active high
UART_DE_POLARITY_LOW DE signal is active low
AssertionTime: Driver Enable assertion time: 5-bit value
DocID026525 Rev 6
UM1785
HAL UART Extension Driver
defining the time between the activation of the DE (Driver
Enable) signal and the beginning of the start bit. It is
expressed in sample time units (1/8 or 1/16 bit time,
depending on the oversampling rate)
DeassertionTime: Driver Enable deassertion time: 5-bit
value defining the time between the end of the last stop bit, in
a transmitted message, and the de-activation of the DE
(Driver Enable) signal. It is expressed in sample time units
(1/8 or 1/16 bit time, depending on the oversampling rate).
Return values
HAL: status
HAL_LIN_Init
Function name
HAL_StatusTypeDef HAL_LIN_Init (UART_HandleTypeDef *
huart, uint32_t BreakDetectLength)
Function description
Initialize the LIN mode according to the specified parameters in the
UART_InitTypeDef and creates the associated handle .
Parameters
huart: UART handle.
BreakDetectLength: specifies the LIN break detection
length. This parameter can be one of the following values:
UART_LINBREAKDETECTLENGTH_10B 10-bit break
detection
UART_LINBREAKDETECTLENGTH_11B 11-bit break
detection
Return values
HAL: status
HAL_UARTEx_WakeupCallback
Function name
void HAL_UARTEx_WakeupCallback (UART_HandleTypeDef *
huart)
Function description
UART wakeup from Stop mode callback.
Parameters
huart: UART handle.
Return values
None
HAL_MultiProcessorEx_AddressLength_Set
Function name
HAL_StatusTypeDef
HAL_MultiProcessorEx_AddressLength_Set
(UART_HandleTypeDef * huart, uint32_t AddressLength)
Function description
By default in multiprocessor mode, when the wake up method is
set to address mark, the UART handles only 4-bit long addresses
detection; this API allows to enable longer addresses detection (6-,
7- or 8-bit long).
Parameters
huart: UART handle.
AddressLength: this parameter can be one of the following
values:
UART_ADDRESS_DETECT_4B 4-bit long address
UART_ADDRESS_DETECT_7B 6-, 7- or 8-bit long
address
DocID026525 Rev 6
601/1320
HAL UART Extension Driver
Return values
UM1785
HAL: status
Notes
Addresses detection lengths are: 6-bit address detection in 7bit data mode, 7-bit address detection in 8-bit data mode, 8bit address detection in 9-bit data mode.
HAL_UARTEx_StopModeWakeUpSourceConfig
Function name
HAL_StatusTypeDef
HAL_UARTEx_StopModeWakeUpSourceConfig
(UART_HandleTypeDef * huart, UART_WakeUpTypeDef
WakeUpSelection)
Function description
Set Wakeup from Stop mode interrupt flag selection.
Parameters
huart: UART handle.
WakeUpSelection: address match, Start Bit detection or
RXNE bit status. This parameter can be one of the following
values:
UART_WAKEUP_ON_ADDRESS
UART_WAKEUP_ON_STARTBIT
UART_WAKEUP_ON_READDATA_NONEMPTY
Return values
HAL: status
HAL_UARTEx_EnableStopMode
Function name
HAL_StatusTypeDef HAL_UARTEx_EnableStopMode
(UART_HandleTypeDef * huart)
Function description
Enable UART Stop Mode.
Parameters
huart: UART handle.
Return values
HAL: status
Notes
The UART is able to wake up the MCU from Stop 1 mode as
long as UART clock is HSI or LSE.
HAL_UARTEx_DisableStopMode
Function name
HAL_StatusTypeDef HAL_UARTEx_DisableStopMode
(UART_HandleTypeDef * huart)
Function description
Disable UART Stop Mode.
Parameters
huart: UART handle.
Return values
HAL: status
HAL_LIN_SendBreak
602/1320
Function name
HAL_StatusTypeDef HAL_LIN_SendBreak
(UART_HandleTypeDef * huart)
Function description
Transmit break characters.
Parameters
huart: UART handle.
Return values
HAL: status
DocID026525 Rev 6
UM1785
HAL UART Extension Driver
45.3
UARTEx Firmware driver defines
45.3.1
UARTEx
UARTEx Advanced Feature AutoBaud Rate Mode
UART_ADVFEATURE_AUTOBAUDRATE_ONSTARTBIT
Auto Baud rate detection
on start bit
UART_ADVFEATURE_AUTOBAUDRATE_ONFALLINGEDGE
Auto Baud rate detection
on falling edge
UART_ADVFEATURE_AUTOBAUDRATE_ON0X7FFRAME
Auto Baud rate detection
on 0x7F frame detection
UART_ADVFEATURE_AUTOBAUDRATE_ON0X55FRAME
Auto Baud rate detection
on 0x55 frame detection
UARTEx Exported Macros
__HAL_UART_FLUSH_DRREGISTER
Description:
Flush the UART Data registers.
Parameters:
__HANDLE__: specifies the UART Handle.
Return value:
None
UARTEx Local Interconnection Network mode
UART_LIN_DISABLE
Local Interconnect Network disable
UART_LIN_ENABLE
Local Interconnect Network enable
UARTEx LIN Break Detection
UART_LINBREAKDETECTLENGTH_10B
LIN 10-bit break detection length
UART_LINBREAKDETECTLENGTH_11B
LIN 11-bit break detection length
UARTEx Word Length
UART_WORDLENGTH_7B
7-bit long UART frame
UART_WORDLENGTH_8B
8-bit long UART frame
UART_WORDLENGTH_9B
9-bit long UART frame
DocID026525 Rev 6
603/1320
HAL USART Generic Driver
UM1785
46
HAL USART Generic Driver
46.1
USART Firmware driver registers structures
46.1.1
USART_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
Field Documentation
uint32_t USART_InitTypeDef::BaudRate
This member configures the Usart communication baud rate. The baud rate is
computed using the following formula: Baud Rate Register = ((PCLKx) / ((huart>Init.BaudRate))).
uint32_t USART_InitTypeDef::WordLength
Specifies the number of data bits transmitted or received in a frame. This parameter
can be a value of USARTEx_Word_Length.
uint32_t USART_InitTypeDef::StopBits
Specifies the number of stop bits transmitted. This parameter can be a value of
USART_Stop_Bits.
uint32_t USART_InitTypeDef::Parity
Specifies the parity mode. This parameter can be a value of USART_Parity
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 USART_InitTypeDef::Mode
Specifies whether the Receive or Transmit mode is enabled or disabled. This
parameter can be a value of USART_Mode.
uint32_t USART_InitTypeDef::CLKPolarity
Specifies the steady state of the serial clock. This parameter can be a value of
USART_Clock_Polarity.
uint32_t USART_InitTypeDef::CLKPhase
Specifies the clock transition on which the bit capture is made. This parameter can be
a value of USART_Clock_Phase.
uint32_t USART_InitTypeDef::CLKLastBit
Specifies whether the clock pulse corresponding to the last transmitted data bit (MSB)
has to be output on the SCLK pin in synchronous mode. This parameter can be a
value of USART_Last_Bit.
46.1.2
USART_HandleTypeDef
Data Fields
USART_TypeDef * Instance
USART_InitTypeDef Init
604/1320
DocID026525 Rev 6
UM1785
HAL USART Generic Driver
uint8_t * pTxBuffPtr
uint16_t TxXferSize
__IO uint16_t TxXferCount
uint8_t * pRxBuffPtr
uint16_t RxXferSize
__IO uint16_t RxXferCount
uint16_t Mask
DMA_HandleTypeDef * hdmatx
DMA_HandleTypeDef * hdmarx
HAL_LockTypeDef Lock
__IO HAL_USART_StateTypeDef State
__IO uint32_t ErrorCode
Field Documentation
USART_TypeDef* USART_HandleTypeDef::Instance
USART registers base address
USART_InitTypeDef USART_HandleTypeDef::Init
USART communication parameters
uint8_t* USART_HandleTypeDef::pTxBuffPtr
Pointer to USART Tx transfer Buffer
uint16_t USART_HandleTypeDef::TxXferSize
USART Tx Transfer size
__IO uint16_t USART_HandleTypeDef::TxXferCount
USART Tx Transfer Counter
uint8_t* USART_HandleTypeDef::pRxBuffPtr
Pointer to USART Rx transfer Buffer
uint16_t USART_HandleTypeDef::RxXferSize
USART Rx Transfer size
__IO uint16_t USART_HandleTypeDef::RxXferCount
USART Rx Transfer Counter
uint16_t USART_HandleTypeDef::Mask
USART Rx RDR register mask
DMA_HandleTypeDef* USART_HandleTypeDef::hdmatx
USART Tx DMA Handle parameters
DMA_HandleTypeDef* USART_HandleTypeDef::hdmarx
USART Rx DMA Handle parameters
HAL_LockTypeDef USART_HandleTypeDef::Lock
Locking object
__IO HAL_USART_StateTypeDef USART_HandleTypeDef::State
USART communication state
__IO uint32_t USART_HandleTypeDef::ErrorCode
USART Error code
46.2
USART Firmware driver API description
46.2.1
How to use this driver
The USART HAL driver can be used as follows:
1.
2.
Declare a USART_HandleTypeDef handle structure (eg. USART_HandleTypeDef
husart).
Initialize the USART low level resources by implementing the HAL_USART_MspInit()
API:
Enable the USARTx interface clock.
DocID026525 Rev 6
605/1320
HAL USART Generic Driver
3.
4.
5.
UM1785
USART pins configuration:
Enable the clock for the USART GPIOs.
Configure these USART pins as alternate function pull-up.
NVIC configuration if you need to use interrupt process
(HAL_USART_Transmit_IT(), HAL_USART_Receive_IT() and
HAL_USART_TransmitReceive_IT() APIs):
Configure the USARTx interrupt priority.
Enable the NVIC USART IRQ handle.
USART interrupts handling: The specific USART interrupts (Transmission
complete interrupt, RXNE interrupt and Error Interrupts) will be managed using
the macros __HAL_USART_ENABLE_IT() and __HAL_USART_DISABLE_IT()
inside the transmit and receive process.
DMA Configuration if you need to use DMA process
(HAL_USART_Transmit_DMA() HAL_USART_Receive_DMA() and
HAL_USART_TransmitReceive_DMA() APIs):
Declare a DMA handle structure for the Tx/Rx channel.
Enable the DMAx interface clock.
Configure the declared DMA handle structure with the required Tx/Rx
parameters.
Configure the DMA Tx/Rx channel.
Associate the initialized DMA handle to the USART DMA Tx/Rx handle.
Configure the priority and enable the NVIC for the transfer complete interrupt
on the DMA Tx/Rx channel.
Program the Baud Rate, Word Length, Stop Bit, Parity, Hardware flow control and
Mode (Receiver/Transmitter) in the husart handle Init structure.
Initialize the USART registers by calling the HAL_USART_Init() API:
This API configures also the low level Hardware GPIO, CLOCK, CORTEX...etc)
by calling the customized HAL_USART_MspInit(&husart) API.
Three operation modes are available within this driver :
Polling mode IO operation
Send an amount of data in blocking mode using HAL_USART_Transmit()
Receive an amount of data in blocking mode using HAL_USART_Receive()
Interrupt mode IO operation
Send an amount of data in non blocking mode using HAL_USART_Transmit_IT()
At transmission end of half transfer HAL_USART_TxHalfCpltCallback is executed and
user can add his own code by customization of function pointer
HAL_USART_TxHalfCpltCallback
At transmission end of transfer HAL_USART_TxCpltCallback is executed and user
can add his own code by customization of function pointer
HAL_USART_TxCpltCallback
Receive an amount of data in non blocking mode using HAL_USART_Receive_IT()
At reception end of half transfer HAL_USART_RxHalfCpltCallback is executed and
user can add his own code by customization of function pointer
HAL_USART_RxHalfCpltCallback
At reception end of transfer HAL_USART_RxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_USART_RxCpltCallback
In case of transfer Error, HAL_USART_ErrorCallback() function is executed and user
can add his own code by customization of function pointer
HAL_USART_ErrorCallback
606/1320
DocID026525 Rev 6
UM1785
HAL USART Generic Driver
DMA mode IO operation
Send an amount of data in non blocking mode (DMA) using
HAL_USART_Transmit_DMA()
At transmission end of half transfer HAL_USART_TxHalfCpltCallback is executed and
user can add his own code by customization of function pointer
HAL_USART_TxHalfCpltCallback
At transmission end of transfer HAL_USART_TxCpltCallback is executed and user
can add his own code by customization of function pointer
HAL_USART_TxCpltCallback
Receive an amount of data in non blocking mode (DMA) using
HAL_USART_Receive_DMA()
At reception end of half transfer HAL_USART_RxHalfCpltCallback is executed and
user can add his own code by customization of function pointer
HAL_USART_RxHalfCpltCallback
At reception end of transfer HAL_USART_RxCpltCallback is executed and user can
add his own code by customization of function pointer HAL_USART_RxCpltCallback
In case of transfer Error, HAL_USART_ErrorCallback() function is executed and user
can add his own code by customization of function pointer
HAL_USART_ErrorCallback
Pause the DMA Transfer using HAL_USART_DMAPause()
Resume the DMA Transfer using HAL_USART_DMAResume()
Stop the DMA Transfer using HAL_USART_DMAStop()
USART HAL driver macros list
Below the list of most used macros in USART HAL driver.
__HAL_USART_ENABLE: Enable the USART peripheral
__HAL_USART_DISABLE: Disable the USART peripheral
__HAL_USART_GET_FLAG : Check whether the specified USART flag is set or not
__HAL_USART_CLEAR_FLAG : Clear the specified USART pending flag
__HAL_USART_ENABLE_IT: Enable the specified USART interrupt
__HAL_USART_DISABLE_IT: Disable the specified USART interrupt
You can refer to the USART HAL driver header file for more useful macros
To configure and enable/disable the USART to wake up the MCU from stop
mode, resort to UART API's HAL_UARTEx_StopModeWakeUpSourceConfig(),
HAL_UARTEx_EnableStopMode() and HAL_UARTEx_DisableStopMode() in
casting the USART handle to UART type UART_HandleTypeDef.
46.2.2
Initialization and Configuration functions
This subsection provides a set of functions allowing to initialize the USART in
asynchronous and in synchronous modes.
For the asynchronous mode only these parameters can be configured:
Baud Rate
Word Length
Stop Bit
DocID026525 Rev 6
607/1320
HAL USART Generic Driver
UM1785
Parity
USART polarity
USART phase
USART LastBit
Receiver/transmitter modes
The HAL_USART_Init() function follows the USART synchronous configuration procedure
(details for the procedure are available in reference manual).
This section contains the following APIs:
HAL_USART_Init()
HAL_USART_DeInit()
HAL_USART_MspInit()
HAL_USART_MspDeInit()
46.2.3
IO operation functions
This subsection provides a set of functions allowing to manage the USART synchronous
data transfers.
The USART supports master mode only: it cannot receive or send data related to an input
clock (SCLK is always an output).
1.
2.
3.
4.
5.
608/1320
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 USART IRQ when using Interrupt mode or the
DMA IRQ when using DMA mode. The HAL_USART_TxCpltCallback(),
HAL_USART_RxCpltCallback() and HAL_USART_TxRxCpltCallback() user
callbacks will be executed respectively at the end of the transmit or Receive
process The HAL_USART_ErrorCallback()user callback will be executed when a
communication error is detected
Blocking mode APIs are :
HAL_USART_Transmit()in simplex mode
HAL_USART_Receive() in full duplex receive only
HAL_USART_TransmitReceive() in full duplex mode
No-Blocking mode APIs with Interrupt are :
HAL_USART_Transmit_IT()in simplex mode
HAL_USART_Receive_IT() in full duplex receive only
HAL_USART_TransmitReceive_IT()in full duplex mode
HAL_USART_IRQHandler()
No-Blocking mode APIs with DMA are :
HAL_USART_Transmit_DMA()in simplex mode
HAL_USART_Receive_DMA() in full duplex receive only
HAL_USART_TransmitReceive_DMA() in full duplex mode
HAL_USART_DMAPause()
HAL_USART_DMAResume()
HAL_USART_DMAStop()
A set of Transfer Complete Callbacks are provided in Non-Blocking mode:
HAL_USART_TxCpltCallback()
HAL_USART_RxCpltCallback()
HAL_USART_TxHalfCpltCallback()
HAL_USART_RxHalfCpltCallback()
DocID026525 Rev 6
UM1785
HAL USART Generic Driver
6.
7.
8.
HAL_USART_ErrorCallback()
HAL_USART_TxRxCpltCallback()
Non-Blocking mode transfers could be aborted using Abort API's :
HAL_USART_Abort()
HAL_USART_Abort_IT()
For Abort services based on interrupts (HAL_USART_Abort_IT), a Abort Complete
Callbacks is provided:
HAL_USART_AbortCpltCallback()
In Non-Blocking mode transfers, possible errors are split into 2 categories. Errors are
handled as follows :
Error is considered as Recoverable and non blocking : Transfer could go till end,
but error severity is to be evaluated by user : this concerns Frame Error, Parity
Error or Noise Error in Interrupt mode reception . Received character is then
retrieved and stored in Rx buffer, Error code is set to allow user to identify error
type, and HAL_USART_ErrorCallback() user callback is executed. Transfer is
kept ongoing on USART side. If user wants to abort it, Abort services should be
called by user.
Error is considered as Blocking : Transfer could not be completed properly and is
aborted. This concerns Overrun Error In Interrupt mode reception and all errors in
DMA mode. Error code is set to allow user to identify error type, and
HAL_USART_ErrorCallback() user callback is executed.
This section contains the following APIs:
HAL_USART_Transmit()
HAL_USART_Receive()
HAL_USART_TransmitReceive()
HAL_USART_Transmit_IT()
HAL_USART_Receive_IT()
HAL_USART_TransmitReceive_IT()
HAL_USART_Transmit_DMA()
HAL_USART_Receive_DMA()
HAL_USART_TransmitReceive_DMA()
HAL_USART_DMAPause()
HAL_USART_DMAResume()
HAL_USART_DMAStop()
HAL_USART_Abort()
HAL_USART_Abort_IT()
HAL_USART_IRQHandler()
HAL_USART_TxCpltCallback()
HAL_USART_TxHalfCpltCallback()
HAL_USART_RxCpltCallback()
HAL_USART_RxHalfCpltCallback()
HAL_USART_TxRxCpltCallback()
HAL_USART_ErrorCallback()
HAL_USART_AbortCpltCallback()
46.2.4
Peripheral State and Error functions
This subsection provides functions allowing to :
Return the USART handle state
Return the USART handle error code
This section contains the following APIs:
DocID026525 Rev 6
609/1320
HAL USART Generic Driver
UM1785
HAL_USART_GetState()
HAL_USART_GetError()
46.2.5
Detailed description of functions
HAL_USART_Init
Function name
HAL_StatusTypeDef HAL_USART_Init
(USART_HandleTypeDef * husart)
Function description
Initialize the USART mode according to the specified parameters
in the USART_InitTypeDef and initialize the associated handle.
Parameters
husart: USART handle.
Return values
HAL: status
HAL_USART_DeInit
Function name
HAL_StatusTypeDef HAL_USART_DeInit
(USART_HandleTypeDef * husart)
Function description
DeInitialize the USART peripheral.
Parameters
husart: USART handle.
Return values
HAL: status
HAL_USART_MspInit
Function name
void HAL_USART_MspInit (USART_HandleTypeDef * husart)
Function description
Initialize the USART MSP.
Parameters
husart: USART handle.
Return values
None
HAL_USART_MspDeInit
Function name
void HAL_USART_MspDeInit (USART_HandleTypeDef *
husart)
Function description
DeInitialize the USART MSP.
Parameters
husart: USART handle.
Return values
None
HAL_USART_Transmit
Function name
HAL_StatusTypeDef HAL_USART_Transmit
(USART_HandleTypeDef * husart, uint8_t * pTxData, uint16_t
Size, uint32_t Timeout)
Function description
Simplex send an amount of data in blocking mode.
Parameters
610/1320
husart: USART handle.
pTxData: Pointer to data buffer.
Size: Amount of data to be sent.
DocID026525 Rev 6
UM1785
HAL USART Generic Driver
Timeout: Timeout duration.
Return values
HAL: status
Notes
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffer containing data to be sent, should be aligned on a
half word frontier (16 bits) (as sent data will be handled using
u16 pointer cast). Depending on compilation chain, use of
specific alignment compilation directives or pragmas might be
required to ensure proper alignment for pTxData.
HAL_USART_Receive
Function name
HAL_StatusTypeDef HAL_USART_Receive
(USART_HandleTypeDef * husart, uint8_t * pRxData, uint16_t
Size, uint32_t Timeout)
Function description
Receive an amount of data in blocking mode.
Parameters
husart: USART handle.
pRxData: Pointer to data buffer.
Size: Amount of data to be received.
Timeout: Timeout duration.
Return values
HAL: status
Notes
To receive synchronous data, dummy data are
simultaneously transmitted.
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffer for storing data to be received, should be aligned
on a half word frontier (16 bits) (as received data will be
handled using u16 pointer cast). Depending on compilation
chain, use of specific alignment compilation directives or
pragmas might be required to ensure proper alignment for
pRxData.
HAL_USART_TransmitReceive
Function name
HAL_StatusTypeDef HAL_USART_TransmitReceive
(USART_HandleTypeDef * husart, uint8_t * pTxData, uint8_t *
pRxData, uint16_t Size, uint32_t Timeout)
Function description
Full-Duplex Send and Receive an amount of data in blocking
mode.
Parameters
husart: USART handle.
pTxData: pointer to TX data buffer.
pRxData: pointer to RX data buffer.
Size: amount of data to be sent (same amount to be
received).
Timeout: Timeout duration.
Return values
HAL: status
Notes
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffers containing data to be sent/received, should be
DocID026525 Rev 6
611/1320
HAL USART Generic Driver
UM1785
aligned on a half word frontier (16 bits) (as sent/received data
will be handled using u16 pointer cast). Depending on
compilation chain, use of specific alignment compilation
directives or pragmas might be required to ensure proper
alignment for pTxData and pRxData.
HAL_USART_Transmit_IT
Function name
HAL_StatusTypeDef HAL_USART_Transmit_IT
(USART_HandleTypeDef * husart, uint8_t * pTxData, uint16_t
Size)
Function description
Send an amount of data in interrupt mode.
Parameters
husart: USART handle.
pTxData: pointer to data buffer.
Size: amount of data to be sent.
Return values
HAL: status
Notes
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffer containing data to be sent, should be aligned on a
half word frontier (16 bits) (as sent data will be handled using
u16 pointer cast). Depending on compilation chain, use of
specific alignment compilation directives or pragmas might be
required to ensure proper alignment for pTxData.
HAL_USART_Receive_IT
612/1320
Function name
HAL_StatusTypeDef HAL_USART_Receive_IT
(USART_HandleTypeDef * husart, uint8_t * pRxData, uint16_t
Size)
Function description
Receive an amount of data in interrupt mode.
Parameters
husart: USART handle.
pRxData: pointer to data buffer.
Size: amount of data to be received.
Return values
HAL: status
Notes
To receive synchronous data, dummy data are
simultaneously transmitted.
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffer for storing data to be received, should be aligned
on a half word frontier (16 bits) (as received data will be
handled using u16 pointer cast). Depending on compilation
chain, use of specific alignment compilation directives or
pragmas might be required to ensure proper alignment for
pRxData.
DocID026525 Rev 6
UM1785
HAL USART Generic Driver
HAL_USART_TransmitReceive_IT
Function name
HAL_StatusTypeDef HAL_USART_TransmitReceive_IT
(USART_HandleTypeDef * husart, uint8_t * pTxData, uint8_t *
pRxData, uint16_t Size)
Function description
Full-Duplex Send and Receive an amount of data in interrupt
mode.
Parameters
husart: USART handle.
pTxData: pointer to TX data buffer.
pRxData: pointer to RX data buffer.
Size: amount of data to be sent (same amount to be
received).
Return values
HAL: status
Notes
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffers containing data to be sent/received, should be
aligned on a half word frontier (16 bits) (as sent/received data
will be handled using u16 pointer cast). Depending on
compilation chain, use of specific alignment compilation
directives or pragmas might be required to ensure proper
alignment for pTxData and pRxData.
HAL_USART_Transmit_DMA
Function name
HAL_StatusTypeDef HAL_USART_Transmit_DMA
(USART_HandleTypeDef * husart, uint8_t * pTxData, uint16_t
Size)
Function description
Send an amount of data in DMA mode.
Parameters
husart: USART handle.
pTxData: pointer to data buffer.
Size: amount of data to be sent.
Return values
HAL: status
Notes
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffer containing data to be sent, should be aligned on a
half word frontier (16 bits) (as sent data will be handled by
DMA from halfword frontier). Depending on compilation chain,
use of specific alignment compilation directives or pragmas
might be required to ensure proper alignment for pTxData.
HAL_USART_Receive_DMA
Function name
HAL_StatusTypeDef HAL_USART_Receive_DMA
(USART_HandleTypeDef * husart, uint8_t * pRxData, uint16_t
Size)
Function description
Receive an amount of data in DMA mode.
Parameters
husart: USART handle.
pRxData: pointer to data buffer.
Size: amount of data to be received.
DocID026525 Rev 6
613/1320
HAL USART Generic Driver
Return values
Notes
UM1785
HAL: status
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffer for storing data to be received, should be aligned
on a half word frontier (16 bits) (as received data will be
handled by DMA from halfword frontier). Depending on
compilation chain, use of specific alignment compilation
directives or pragmas might be required to ensure proper
alignment for pRxData.
The USART DMA transmit channel must be configured in
order to generate the clock for the slave.
HAL_USART_TransmitReceive_DMA
Function name
HAL_StatusTypeDef HAL_USART_TransmitReceive_DMA
(USART_HandleTypeDef * husart, uint8_t * pTxData, uint8_t *
pRxData, uint16_t Size)
Function description
Full-Duplex Transmit Receive an amount of data in non-blocking
mode.
Parameters
husart: USART handle.
pTxData: pointer to TX data buffer.
pRxData: pointer to RX data buffer.
Size: amount of data to be received/sent.
Return values
HAL: status
Notes
When UART parity is not enabled (PCE = 0), and Word
Length is configured to 9 bits (M1-M0 = 01), address of user
data buffers containing data to be sent/received, should be
aligned on a half word frontier (16 bits) (as sent/received data
will be handled by DMA from halfword frontier). Depending on
compilation chain, use of specific alignment compilation
directives or pragmas might be required to ensure proper
alignment for pTxData and pRxData.
HAL_USART_DMAPause
Function name
HAL_StatusTypeDef HAL_USART_DMAPause
(USART_HandleTypeDef * husart)
Function description
Pause the DMA Transfer.
Parameters
husart: USART handle.
Return values
HAL: status
HAL_USART_DMAResume
614/1320
Function name
HAL_StatusTypeDef HAL_USART_DMAResume
(USART_HandleTypeDef * husart)
Function description
Resume the DMA Transfer.
Parameters
husart: USART handle.
Return values
HAL: status
DocID026525 Rev 6
UM1785
HAL USART Generic Driver
HAL_USART_DMAStop
Function name
HAL_StatusTypeDef HAL_USART_DMAStop
(USART_HandleTypeDef * husart)
Function description
Stop the DMA Transfer.
Parameters
husart: USART handle.
Return values
HAL: status
HAL_USART_Abort
Function name
HAL_StatusTypeDef HAL_USART_Abort
(USART_HandleTypeDef * husart)
Function description
Abort ongoing transfers (blocking mode).
Parameters
husart: USART handle.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable USART Interrupts (Tx
and Rx)Disable the DMA transfer in the peripheral register (if
enabled)Abort DMA transfer by calling HAL_DMA_Abort (in
case of transfer in DMA mode)Set handle State to READY
This procedure is executed in blocking mode : when exiting
function, Abort is considered as completed.
HAL_USART_Abort_IT
Function name
HAL_StatusTypeDef HAL_USART_Abort_IT
(USART_HandleTypeDef * husart)
Function description
Abort ongoing transfers (Interrupt mode).
Parameters
husart: USART handle.
Return values
HAL: status
Notes
This procedure could be used for aborting any ongoing
transfer started in Interrupt or DMA mode. This procedure
performs following operations : Disable USART Interrupts (Tx
and Rx)Disable the DMA transfer in the peripheral register (if
enabled)Abort DMA transfer by calling HAL_DMA_Abort_IT
(in case of transfer in DMA mode)Set handle State to
READYAt abort completion, call user abort complete callback
This procedure is executed in Interrupt mode, meaning that
abort procedure could be considered as completed only when
user abort complete callback is executed (not when exiting
function).
HAL_USART_IRQHandler
Function name
void HAL_USART_IRQHandler (USART_HandleTypeDef *
husart)
Function description
Handle USART interrupt request.
DocID026525 Rev 6
615/1320
HAL USART Generic Driver
Parameters
Return values
UM1785
husart: USART handle.
None
HAL_USART_TxCpltCallback
Function name
void HAL_USART_TxCpltCallback (USART_HandleTypeDef *
husart)
Function description
Tx Transfer completed callback.
Parameters
husart: USART handle.
Return values
None
HAL_USART_RxCpltCallback
Function name
void HAL_USART_RxCpltCallback (USART_HandleTypeDef *
husart)
Function description
Rx Transfer completed callback.
Parameters
husart: USART handle.
Return values
None
HAL_USART_TxHalfCpltCallback
Function name
void HAL_USART_TxHalfCpltCallback
(USART_HandleTypeDef * husart)
Function description
Tx Half Transfer completed callback.
Parameters
husart: USART handle.
Return values
None
HAL_USART_RxHalfCpltCallback
Function name
void HAL_USART_RxHalfCpltCallback
(USART_HandleTypeDef * husart)
Function description
Rx Half Transfer completed callback.
Parameters
husart: USART handle.
Return values
None
HAL_USART_TxRxCpltCallback
616/1320
Function name
void HAL_USART_TxRxCpltCallback (USART_HandleTypeDef
* husart)
Function description
Tx/Rx Transfers completed callback for the non-blocking process.
Parameters
husart: USART handle.
Return values
None
DocID026525 Rev 6
UM1785
HAL USART Generic Driver
HAL_USART_ErrorCallback
Function name
void HAL_USART_ErrorCallback (USART_HandleTypeDef *
husart)
Function description
USART error callback.
Parameters
husart: USART handle.
Return values
None
HAL_USART_AbortCpltCallback
Function name
void HAL_USART_AbortCpltCallback (USART_HandleTypeDef
* husart)
Function description
USART Abort Complete callback.
Parameters
husart: USART handle.
Return values
None
HAL_USART_GetState
Function name
HAL_USART_StateTypeDef HAL_USART_GetState
(USART_HandleTypeDef * husart)
Function description
Return the USART handle state.
Parameters
husart: pointer to a USART_HandleTypeDef structure that
contains the configuration information for the specified
USART.
Return values
USART: handle state
HAL_USART_GetError
Function name
uint32_t HAL_USART_GetError (USART_HandleTypeDef *
husart)
Function description
Return the USART error code.
Parameters
husart: pointer to a USART_HandleTypeDef structure that
contains the configuration information for the specified
USART.
Return values
USART: handle Error Code
46.3
USART Firmware driver defines
46.3.1
USART
USART Clock
USART_CLOCK_DISABLE
USART clock disable
USART_CLOCK_ENABLE
USART clock enable
USART Clock Phase
USART_PHASE_1EDGE
USART frame phase on first clock transition
DocID026525 Rev 6
617/1320
HAL USART Generic Driver
USART_PHASE_2EDGE
UM1785
USART frame phase on second clock transition
USART Clock Polarity
USART_POLARITY_LOW
USART Clock signal is steady Low
USART_POLARITY_HIGH
USART Clock signal is steady High
USART Error
HAL_USART_ERROR_NONE
No error
HAL_USART_ERROR_PE
Parity error
HAL_USART_ERROR_NE
Noise error
HAL_USART_ERROR_FE
frame error
HAL_USART_ERROR_ORE
Overrun error
HAL_USART_ERROR_DMA
DMA transfer error
USART Exported Macros
__HAL_USART_RESET_HANDLE_
STATE
Description:
Reset USART handle state.
Parameters:
__HANDLE__: USART handle.
Return value:
None
__HAL_USART_GET_FLAG
Description:
Check whether the specified USART flag
is set or not.
Parameters:
__HANDLE__: specifies the USART
Handle
__FLAG__: specifies the flag to check.
This parameter can be one of the
following values:
USART_FLAG_REACK Receive
enable acknowledge flag
USART_FLAG_TEACK Transmit
enable acknowledge flag
USART_FLAG_BUSY Busy flag
USART_FLAG_CTS CTS Change
flag
USART_FLAG_TXE Transmit data
register empty flag
USART_FLAG_TC Transmission
Complete flag
USART_FLAG_RXNE Receive data
register not empty flag
USART_FLAG_IDLE Idle Line
detection flag
USART_FLAG_ORE OverRun Error
flag
618/1320
DocID026525 Rev 6
UM1785
HAL USART Generic Driver
USART_FLAG_NE Noise Error flag
USART_FLAG_FE Framing Error
flag
USART_FLAG_PE Parity Error flag
Return value:
The: new state of __FLAG__ (TRUE or
FALSE).
__HAL_USART_CLEAR_FLAG
Description:
Clear the specified USART pending flag.
Parameters:
__HANDLE__: specifies the USART
Handle.
__FLAG__: specifies the flag to check.
This parameter can be any combination
of the following values:
USART_CLEAR_PEF
USART_CLEAR_FEF
USART_CLEAR_NEF
USART_CLEAR_OREF
USART_CLEAR_IDLEF
USART_CLEAR_TCF
USART_CLEAR_CTSF
Return value:
None
__HAL_USART_CLEAR_PEFLAG
Description:
Clear the USART PE pending flag.
Parameters:
__HANDLE__: specifies the USART
Handle.
Return value:
None
__HAL_USART_CLEAR_FEFLAG
Description:
Clear the USART FE pending flag.
Parameters:
__HANDLE__: specifies the USART
Handle.
Return value:
None
__HAL_USART_CLEAR_NEFLAG
Description:
Clear the USART NE pending flag.
Parameters:
__HANDLE__: specifies the USART
DocID026525 Rev 6
619/1320
HAL USART Generic Driver
UM1785
Handle.
Return value:
None
__HAL_USART_CLEAR_OREFLAG
Description:
Clear the USART ORE pending flag.
Parameters:
__HANDLE__: specifies the USART
Handle.
Return value:
None
__HAL_USART_CLEAR_IDLEFLAG
Description:
Clear the USART IDLE pending flag.
Parameters:
__HANDLE__: specifies the USART
Handle.
Return value:
None
__HAL_USART_ENABLE_IT
Description:
Enable the specified USART interrupt.
Parameters:
__HANDLE__: specifies the USART
Handle.
__INTERRUPT__: specifies the USART
interrupt source to enable. This
parameter can be one of the following
values:
USART_IT_TXE Transmit Data
Register empty interrupt
USART_IT_TC Transmission
complete interrupt
USART_IT_RXNE Receive Data
register not empty interrupt
USART_IT_IDLE Idle line detection
interrupt
USART_IT_PE Parity Error interrupt
USART_IT_ERR Error
interrupt(Frame error, noise error,
overrun error)
Return value:
None
620/1320
DocID026525 Rev 6
UM1785
HAL USART Generic Driver
__HAL_USART_DISABLE_IT
Description:
Disable the specified USART interrupt.
Parameters:
__HANDLE__: specifies the USART Handle.
__INTERRUPT__: specifies the USART
interrupt source to disable. This parameter can
be one of the following values:
USART_IT_TXE Transmit Data Register
empty interrupt
USART_IT_TC Transmission complete
interrupt
USART_IT_RXNE Receive Data register
not empty interrupt
USART_IT_IDLE Idle line detection
interrupt
USART_IT_PE Parity Error interrupt
USART_IT_ERR Error interrupt(Frame
error, noise error, overrun error)
Return value:
None
__HAL_USART_GET_IT
Description:
Check whether the specified USART interrupt
has occurred or not.
Parameters:
__HANDLE__: specifies the USART Handle.
__IT__: specifies the USART interrupt source to
check. This parameter can be one of the
following values:
USART_IT_TXE Transmit Data Register
empty interrupt
USART_IT_TC Transmission complete
interrupt
USART_IT_RXNE Receive Data register
not empty interrupt
USART_IT_IDLE Idle line detection
interrupt
USART_IT_ORE OverRun Error interrupt
USART_IT_NE Noise Error interrupt
USART_IT_FE Framing Error interrupt
USART_IT_PE Parity Error interrupt
Return value:
The: new state of __IT__ (TRUE or FALSE).
DocID026525 Rev 6
621/1320
HAL USART Generic Driver
__HAL_USART_GET_IT_
SOURCE
UM1785
Description:
Check whether the specified USART interrupt
source is enabled or not.
Parameters:
__HANDLE__: specifies the USART Handle.
__IT__: specifies the USART interrupt source to
check. This parameter can be one of the
following values:
USART_IT_TXE Transmit Data Register
empty interrupt
USART_IT_TC Transmission complete
interrupt
USART_IT_RXNE Receive Data register
not empty interrupt
USART_IT_IDLE Idle line detection
interrupt
USART_IT_ORE OverRun Error interrupt
USART_IT_NE Noise Error interrupt
USART_IT_FE Framing Error interrupt
USART_IT_PE Parity Error interrupt
Return value:
The: new state of __IT__ (TRUE or FALSE).
__HAL_USART_CLEAR_IT
Description:
Clear the specified USART ISR flag, in setting
the proper ICR register flag.
Parameters:
__HANDLE__: specifies the USART Handle.
__IT_CLEAR__: specifies the interrupt clear
register flag that needs to be set to clear the
corresponding interrupt. This parameter can be
one of the following values:
USART_CLEAR_PEF Parity Error Clear
Flag
USART_CLEAR_FEF Framing Error Clear
Flag
USART_CLEAR_NEF Noise detected
Clear Flag
USART_CLEAR_OREF OverRun Error
Clear Flag
USART_CLEAR_IDLEF IDLE line detected
Clear Flag
USART_CLEAR_TCF Transmission
Complete Clear Flag
USART_CLEAR_CTSF CTS Interrupt
Clear Flag
Return value:
None
622/1320
DocID026525 Rev 6
UM1785
HAL USART Generic Driver
__HAL_USART_SEND_REQ
Description:
Set a specific USART request flag.
Parameters:
__HANDLE__: specifies the USART Handle.
__REQ__: specifies the request flag to set. This
parameter can be one of the following values:
USART_RXDATA_FLUSH_REQUEST
Receive Data flush Request
USART_TXDATA_FLUSH_REQUEST
Transmit data flush Request
Return value:
None
__HAL_USART_ONE_BIT_
SAMPLE_ ENABLE
Description:
Enable the USART one bit sample method.
Parameters:
__HANDLE__: specifies the USART Handle.
Return value:
None
__HAL_USART_ONE_BIT_
SAMPLE_ DISABLE
Description:
Disable the USART one bit sample method.
Parameters:
__HANDLE__: specifies the USART Handle.
Return value:
None
__HAL_USART_ENABLE
Description:
Enable USART.
Parameters:
__HANDLE__: specifies the USART Handle.
Return value:
None
__HAL_USART_DISABLE
Description:
Disable USART.
Parameters:
__HANDLE__: specifies the USART Handle.
Return value:
None
DocID026525 Rev 6
623/1320
HAL USART Generic Driver
USART Flags
UM1785
USART_FLAG_REACK
USART receive enable acknowledge flag
USART_FLAG_TEACK
USART transmit enable acknowledge flag
USART_FLAG_BUSY
USART busy flag
USART_FLAG_CTS
USART clear to send flag
USART_FLAG_CTSIF
USART clear to send interrupt flag
USART_FLAG_TXE
USART transmit data register empty
USART_FLAG_TC
USART transmission complete
USART_FLAG_RXNE
USART read data register not empty
USART_FLAG_IDLE
USART idle flag
USART_FLAG_ORE
USART overrun error
USART_FLAG_NE
USART noise error
USART_FLAG_FE
USART frame error
USART_FLAG_PE
USART parity error
USART Interruption Flags Mask
USART_IT_MASK
USART interruptions flags mask
USART Interrupts Definition
USART_IT_PE
USART parity error interruption
USART_IT_TXE
USART transmit data register empty interruption
USART_IT_TC
USART transmission complete interruption
USART_IT_RXNE
USART read data register not empty interruption
USART_IT_IDLE
USART idle interruption
USART_IT_ERR
USART error interruption
USART_IT_ORE
USART overrun error interruption
USART_IT_NE
USART noise error interruption
USART_IT_FE
USART frame error interruption
USART Interruption Clear Flags
USART_CLEAR_PEF
Parity Error Clear Flag
USART_CLEAR_FEF
Framing Error Clear Flag
USART_CLEAR_NEF
Noise detected Clear Flag
USART_CLEAR_OREF
OverRun Error Clear Flag
USART_CLEAR_IDLEF
IDLE line detected Clear Flag
USART_CLEAR_TCF
Transmission Complete Clear Flag
USART_CLEAR_CTSF
CTS Interrupt Clear Flag
USART Last Bit
USART_LASTBIT_DISABLE
624/1320
USART frame last data bit clock pulse not output to SCLK
pin
DocID026525 Rev 6
UM1785
HAL USART Generic Driver
USART frame last data bit clock pulse output to SCLK pin
USART_LASTBIT_ENABLE
USART Mode
USART_MODE_RX
RX mode
USART_MODE_TX
TX mode
USART_MODE_TX_RX
RX and TX mode
USART Parity
USART_PARITY_NONE
No parity
USART_PARITY_EVEN
Even parity
USART_PARITY_ODD
Odd parity
USARTEx Request Parameters
USART_RXDATA_FLUSH_REQUEST
Receive Data flush Request
USART_TXDATA_FLUSH_REQUEST
Transmit data flush Request
USART Number of Stop Bits
USART_STOPBITS_0_5
USART frame with 0.5 stop bit
USART_STOPBITS_1
USART frame with 1 stop bit
USART_STOPBITS_1_5
USART frame with 1.5 stop bits
USART_STOPBITS_2
USART frame with 2 stop bits
DocID026525 Rev 6
625/1320
HAL USART Extension Driver
UM1785
47
HAL USART Extension Driver
47.1
USARTEx Firmware driver defines
47.1.1
USARTEx
USARTEx Exported Macros
__HAL_USART_FLUSH_DRREGISTER
Description:
Flush the USART Data registers.
Parameters:
__HANDLE__: specifies the USART
Handle.
Return value:
None
USARTEx Word Length
626/1320
USART_WORDLENGTH_7B
7-bit long USART frame
USART_WORDLENGTH_8B
8-bit long USART frame
USART_WORDLENGTH_9B
9-bit long USART frame
DocID026525 Rev 6
UM1785
HAL WWDG Generic Driver
48
HAL WWDG Generic Driver
48.1
WWDG Firmware driver registers structures
48.1.1
WWDG_InitTypeDef
Data Fields
uint32_t Prescaler
uint32_t Window
uint32_t Counter
uint32_t EWIMode
Field Documentation
uint32_t WWDG_InitTypeDef::Prescaler
Specifies the prescaler value of the WWDG. This parameter can be a value of
WWDG_Prescaler
uint32_t WWDG_InitTypeDef::Window
Specifies the WWDG window value to be compared to the downcounter. This
parameter must be a number Min_Data = 0x40 and Max_Data = 0x7F
uint32_t WWDG_InitTypeDef::Counter
Specifies the WWDG free-running downcounter value. This parameter must be a
number between Min_Data = 0x40 and Max_Data = 0x7F
uint32_t WWDG_InitTypeDef::EWIMode
Specifies if WWDG Early Wakeup Interupt is enable or not. This parameter can be a
value of WWDG_EWI_Mode
48.1.2
WWDG_HandleTypeDef
Data Fields
WWDG_TypeDef * Instance
WWDG_InitTypeDef Init
Field Documentation
WWDG_TypeDef* WWDG_HandleTypeDef::Instance
Register base address
WWDG_InitTypeDef WWDG_HandleTypeDef::Init
WWDG required parameters
48.2
WWDG Firmware driver API description
48.2.1
WWDG specific features
Once enabled the WWDG generates a system reset on expiry of a programmed time
period, unless the program refreshes the counter (T[6;0] downcounter) before reaching
0x3F value (i.e. a reset is generated when the counter value rolls over from 0x40 to 0x3F).
An MCU reset is also generated if the counter value is refreshed before the counter
has reached the refresh window value. This implies that the counter must be refreshed
in a limited window.
Once enabled the WWDG cannot be disabled except by a system reset.
WWDGRST flag in RCC_CSR register informs when a WWDG reset has occurred
(check available with __HAL_RCC_GET_FLAG(RCC_FLAG_WWDGRST)).
DocID026525 Rev 6
627/1320
HAL WWDG Generic Driver
UM1785
The WWDG downcounter input clock is derived from the APB clock divided by a
programmable prescaler.
WWDG downcounter clock (Hz) = PCLK / (4096 * Prescaler)
WWDG timeout (ms) = (1000 * (T[5;0] + 1)) / (WWDG downcounter clock) where
T[5;0] are the lowest 6 bits of downcounter.
WWDG Counter refresh is allowed between the following limits :
min time (ms) = (1000 * (T[5;0] - Window)) / (WWDG downcounter clock)
max time (ms) = (1000 * (T[5;0] - 0x40)) / (WWDG downcounter clock)
Min-max timeout value @48 MHz(PCLK): ~85,3us / ~5,46 ms
The Early Wakeup Interrupt (EWI) can be used if specific safety operations or data
logging must be performed before the actual reset is generated. When the
downcounter reaches the value 0x40, an EWI interrupt is generated and the
corresponding interrupt service routine (ISR) can be used to trigger specific actions
(such as communications or data logging), before resetting the device. In some
applications, the EWI interrupt can be used to manage a software system check
and/or system recovery/graceful degradation, without generating a WWDG reset. In
this case, the corresponding interrupt service routine (ISR) should reload the WWDG
counter to avoid the WWDG reset, then trigger the required actions. Note:When the
EWI interrupt cannot be served, e.g. due to a system lock in a higher priority task, the
WWDG reset will eventually be generated.
Debug mode : When the microcontroller enters debug mode (core halted), the WWDG
counter either continues to work normally or stops, depending on
DBG_WWDG_STOP configuration bit in DBG module, accessible through
__HAL_DBGMCU_FREEZE_WWDG() and __HAL_DBGMCU_UNFREEZE_WWDG()
macros
48.2.2
How to use this driver
Enable WWDG APB1 clock using __HAL_RCC_WWDG_CLK_ENABLE().
Set the WWDG prescaler, refresh window, counter value and Early Wakeup Interrupt
mode using using HAL_WWDG_Init() function. This enables WWDG peripheral and
the downcounter starts downcounting from given counter value. Init function can be
called again to modify all watchdog parameters, however if EWI mode has been set
once, it can't be clear until next reset.
The application program must refresh the WWDG counter at regular intervals during
normal operation to prevent an MCU reset using HAL_WWDG_Refresh() function.
This operation must occur only when the counter is lower than the window value
already programmed.
if Early Wakeup Interrupt mode is enable an interrupt is generated when the counter
reaches 0x40. User can add his own code in weak function
HAL_WWDG_EarlyWakeupCallback().
WWDG HAL driver macros list
Below the list of most used macros in WWDG HAL driver.
__HAL_WWDG_GET_IT_SOURCE: Check the selected WWDG's interrupt source.
__HAL_WWDG_GET_FLAG: Get the selected WWDG's flag status.
__HAL_WWDG_CLEAR_FLAG: Clear the WWDG's pending flags.
48.2.3
Initialization and Configuration functions
This section provides functions allowing to:
Initialize and start the WWDG according to the specified parameters in the
WWDG_InitTypeDef of associated handle.
Initialize the WWDG MSP.
628/1320
DocID026525 Rev 6
UM1785
HAL WWDG Generic Driver
This section contains the following APIs:
HAL_WWDG_Init()
HAL_WWDG_MspInit()
48.2.4
IO operation functions
This section provides functions allowing to:
Refresh the WWDG.
Handle WWDG interrupt request and associated function callback.
This section contains the following APIs:
HAL_WWDG_Refresh()
HAL_WWDG_IRQHandler()
HAL_WWDG_EarlyWakeupCallback()
48.2.5
Detailed description of functions
HAL_WWDG_Init
Function name
HAL_StatusTypeDef HAL_WWDG_Init
(WWDG_HandleTypeDef * hwwdg)
Function description
Initialize the WWDG according to the specified.
Parameters
hwwdg: pointer to a WWDG_HandleTypeDef structure that
contains the configuration information for the specified
WWDG module.
Return values
HAL: status
HAL_WWDG_MspInit
Function name
void HAL_WWDG_MspInit (WWDG_HandleTypeDef * hwwdg)
Function description
Initialize the WWDG MSP.
Parameters
hwwdg: pointer to a WWDG_HandleTypeDef structure that
contains the configuration information for the specified
WWDG module.
Return values
None
Notes
When rewriting this function in user file, mechanism may be
added to avoid multiple initialize when HAL_WWDG_Init
function is called again to change parameters.
HAL_WWDG_Refresh
Function name
HAL_StatusTypeDef HAL_WWDG_Refresh
(WWDG_HandleTypeDef * hwwdg)
Function description
Refresh the WWDG.
Parameters
hwwdg: pointer to a WWDG_HandleTypeDef structure that
contains the configuration information for the specified
WWDG module.
Return values
HAL: status
DocID026525 Rev 6
629/1320
HAL WWDG Generic Driver
UM1785
HAL_WWDG_IRQHandler
Function name
void HAL_WWDG_IRQHandler (WWDG_HandleTypeDef *
hwwdg)
Function description
Handle WWDG interrupt request.
Parameters
hwwdg: pointer to a WWDG_HandleTypeDef structure that
contains the configuration information for the specified
WWDG module.
Return values
None
Notes
The Early Wakeup Interrupt (EWI) can be used if specific
safety operations or data logging must be performed before
the actual reset is generated. The EWI interrupt is enabled by
calling HAL_WWDG_Init function with EWIMode set to
WWDG_EWI_ENABLE. When the downcounter reaches the
value 0x40, and EWI interrupt is generated and the
corresponding Interrupt Service Routine (ISR) can be used to
trigger specific actions (such as communications or data
logging), before resetting the device.
HAL_WWDG_EarlyWakeupCallback
Function name
void HAL_WWDG_EarlyWakeupCallback
(WWDG_HandleTypeDef * hwwdg)
Function description
WWDG Early Wakeup callback.
Parameters
hwwdg: pointer to a WWDG_HandleTypeDef structure that
contains the configuration information for the specified
WWDG module.
Return values
None
48.3
WWDG Firmware driver defines
48.3.1
WWDG
WWDG Early Wakeup Interrupt Mode
WWDG_EWI_DISABLE
EWI Disable
WWDG_EWI_ENABLE
EWI Enable
WWDG Exported Macros
Description:
__HAL_WWDG_ENABLE
Enable the WWDG peripheral.
Parameters:
__HANDLE__: WWDG handle
Return value:
None
__HAL_WWDG_ENABLE_IT
Description:
Enable the WWDG early wakeup interrupt.
630/1320
DocID026525 Rev 6
UM1785
HAL WWDG Generic Driver
Parameters:
__HANDLE__: WWDG handle
__INTERRUPT__: specifies the interrupt to
enable. This parameter can be one of the
following values:
WWDG_IT_EWI: Early wakeup interrupt
Return value:
None
Notes:
Once enabled this interrupt cannot be disabled
except by a system reset.
__HAL_WWDG_GET_IT
Description:
Check whether the selected WWDG interrupt
has occurred or not.
Parameters:
__HANDLE__: WWDG handle
__INTERRUPT__: specifies the it to check. This
parameter can be one of the following values:
WWDG_FLAG_EWIF: Early wakeup
interrupt IT
Return value:
The: new state of WWDG_FLAG (SET or
RESET).
__HAL_WWDG_CLEAR_IT
Description:
Clear the WWDG interrupt pending bits.
Parameters:
__HANDLE__: WWDG handle
__INTERRUPT__: specifies the interrupt
pending bit to clear. This parameter can be one
of the following values:
WWDG_FLAG_EWIF: Early wakeup
interrupt flag
__HAL_WWDG_GET_FLAG
Description:
Check whether the specified WWDG flag is set
or not.
Parameters:
__HANDLE__: WWDG handle
__FLAG__: specifies the flag to check. This
parameter can be one of the following values:
WWDG_FLAG_EWIF: Early wakeup
interrupt flag
Return value:
The: new state of WWDG_FLAG (SET or
DocID026525 Rev 6
631/1320
HAL WWDG Generic Driver
UM1785
RESET).
__HAL_WWDG_CLEAR_FLAG
Description:
Clear the WWDG's pending flags.
Parameters:
__HANDLE__: WWDG handle
__FLAG__: specifies the flag to clear. This
parameter can be one of the following values:
WWDG_FLAG_EWIF: Early wakeup
interrupt flag
Return value:
None
__HAL_WWDG_GET_IT_SOURCE
Description:
Check whether the specified WWDG interrupt
source is enabled or not.
Parameters:
__HANDLE__: WWDG Handle.
__INTERRUPT__: specifies the WWDG
interrupt source to check. This parameter can
be one of the following values:
WWDG_IT_EWI: Early Wakeup Interrupt
Return value:
state: of __INTERRUPT__ (TRUE or FALSE).
WWDG Flag definition
WWDG_FLAG_EWIF
Early wakeup interrupt flag
WWDG Interrupt definition
WWDG_IT_EWI
Early wakeup interrupt
WWDG Prescaler
632/1320
WWDG_PRESCALER_1
WWDG counter clock = (PCLK1/4096)/1
WWDG_PRESCALER_2
WWDG counter clock = (PCLK1/4096)/2
WWDG_PRESCALER_4
WWDG counter clock = (PCLK1/4096)/4
WWDG_PRESCALER_8
WWDG counter clock = (PCLK1/4096)/8
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
49
LL ADC Generic Driver
49.1
ADC Firmware driver registers structures
49.1.1
LL_ADC_InitTypeDef
Data Fields
uint32_t Clock
uint32_t Resolution
uint32_t DataAlignment
uint32_t LowPowerMode
Field Documentation
uint32_t LL_ADC_InitTypeDef::Clock
Set ADC instance clock source and prescaler. This parameter can be a value of
ADC_LL_EC_CLOCK_SOURCE
Note:On this STM32 serie, this parameter has some clock ratio constraints: ADC
clock synchronous (from PCLK) with prescaler 1 must be enabled only if PCLK has a
50% duty clock cycle (APB prescaler configured inside the RCC must be bypassed
and the system clock must by 50% duty cycle). This feature can be modified
afterwards using unitary function LL_ADC_SetClock(). For more details, refer to
description of this function.
uint32_t LL_ADC_InitTypeDef::Resolution
Set ADC resolution. This parameter can be a value of
ADC_LL_EC_RESOLUTIONThis feature can be modified afterwards using unitary
function LL_ADC_SetResolution().
uint32_t LL_ADC_InitTypeDef::DataAlignment
Set ADC conversion data alignment. This parameter can be a value of
ADC_LL_EC_DATA_ALIGNThis feature can be modified afterwards using unitary
function LL_ADC_SetDataAlignment().
uint32_t LL_ADC_InitTypeDef::LowPowerMode
Set ADC low power mode. This parameter can be a value of
ADC_LL_EC_LP_MODEThis feature can be modified afterwards using unitary
function LL_ADC_SetLowPowerMode().
49.1.2
LL_ADC_REG_InitTypeDef
Data Fields
uint32_t TriggerSource
uint32_t SequencerDiscont
uint32_t ContinuousMode
uint32_t DMATransfer
uint32_t Overrun
Field Documentation
uint32_t LL_ADC_REG_InitTypeDef::TriggerSource
Set ADC group regular conversion trigger source: internal (SW start) or from external
IP (timer event, external interrupt line). This parameter can be a value of
ADC_LL_EC_REG_TRIGGER_SOURCE
Note:On this STM32 serie, setting trigger source to external trigger also set trigger
polarity to rising edge (default setting for compatibility with some ADC on other STM32
DocID026525 Rev 6
633/1320
LL ADC Generic Driver
UM1785
families having this setting set by HW default value). In case of need to modify trigger
edge, use function LL_ADC_REG_SetTriggerEdge(). This feature can be modified
afterwards using unitary function LL_ADC_REG_SetTriggerSource().
uint32_t LL_ADC_REG_InitTypeDef::SequencerDiscont
Set ADC group regular sequencer discontinuous mode: sequence subdivided and
scan conversions interrupted every selected number of ranks. This parameter can be
a value of ADC_LL_EC_REG_SEQ_DISCONT_MODE
Note:This parameter has an effect only if group regular sequencer is enabled (several
ADC channels enabled in group regular sequencer). This feature can be modified
afterwards using unitary function LL_ADC_REG_SetSequencerDiscont().
uint32_t LL_ADC_REG_InitTypeDef::ContinuousMode
Set ADC continuous conversion mode on ADC group regular, whether ADC
conversions are performed in single mode (one conversion per trigger) or in
continuous mode (after the first trigger, following conversions launched successively
automatically). This parameter can be a value of
ADC_LL_EC_REG_CONTINUOUS_MODE Note: It is not possible to enable both
ADC group regular continuous mode and discontinuous mode.This feature can be
modified afterwards using unitary function LL_ADC_REG_SetContinuousMode().
uint32_t LL_ADC_REG_InitTypeDef::DMATransfer
Set ADC group regular conversion data transfer: no transfer or transfer by DMA, and
DMA requests mode. This parameter can be a value of
ADC_LL_EC_REG_DMA_TRANSFERThis feature can be modified afterwards using
unitary function LL_ADC_REG_SetDMATransfer().
uint32_t LL_ADC_REG_InitTypeDef::Overrun
Set ADC group regular behavior in case of overrun: data preserved or overwritten.
This parameter can be a value of ADC_LL_EC_REG_OVR_DATA_BEHAVIORThis
feature can be modified afterwards using unitary function
LL_ADC_REG_SetOverrun().
49.2
ADC Firmware driver API description
49.2.1
Detailed description of functions
LL_ADC_DMA_GetRegAddr
634/1320
Function name
__STATIC_INLINE uint32_t LL_ADC_DMA_GetRegAddr
(ADC_TypeDef * ADCx, uint32_t Register)
Function description
Function to help to configure DMA transfer from ADC: retrieve the
ADC register address from ADC instance and a list of ADC
registers intended to be used (most commonly) with DMA transfer.
Parameters
ADCx: ADC instance
Register: This parameter can be one of the following values:
LL_ADC_DMA_REG_REGULAR_DATA
Return values
ADC: register address
Notes
These ADC registers are data registers: when ADC
conversion data is available in ADC data registers, ADC
generates a DMA transfer request.
This macro is intended to be used with LL DMA driver, refer to
function "LL_DMA_ConfigAddresses()". Example:
LL_DMA_ConfigAddresses(DMA1, LL_DMA_CHANNEL_1,
LL_ADC_DMA_GetRegAddr(ADC1,
LL_ADC_DMA_REG_REGULAR_DATA), (uint32_t)&< array
or variable >,
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
LL_DMA_DIRECTION_PERIPH_TO_MEMORY);
For devices with several ADC: in multimode, some devices
use a different data register outside of ADC instance scope
(common data register). This macro manages this register
difference, only ADC instance has to be set as parameter.
Reference Manual to
LL API cross
reference:
DR DATA LL_ADC_DMA_GetRegAddr
LL_ADC_SetCommonPathInternalCh
Function name
__STATIC_INLINE void LL_ADC_SetCommonPathInternalCh
(ADC_Common_TypeDef * ADCxy_COMMON, uint32_t
PathInternal)
Function description
Set parameter common to several ADC: measurement path to
internal channels (VrefInt, temperature sensor, ...).
Parameters
ADCxy_COMMON: ADC common instance (can be set
directly from CMSIS definition or by using helper macro
__LL_ADC_COMMON_INSTANCE() )
PathInternal: This parameter can be a combination of the
following values: (1) On STM32F0, parameter not available
on all devices: all devices except STM32F030x6,
STM32F030x8, STM32F030xC, STM32F070x6,
STM32F070xB.
LL_ADC_PATH_INTERNAL_NONE
LL_ADC_PATH_INTERNAL_VREFINT
LL_ADC_PATH_INTERNAL_TEMPSENSOR
LL_ADC_PATH_INTERNAL_VBAT (1)
Return values
None
Notes
One or several values can be selected. Example:
(LL_ADC_PATH_INTERNAL_VREFINT |
LL_ADC_PATH_INTERNAL_TEMPSENSOR)
Stabilization time of measurement path to internal channel:
After enabling internal paths, before starting ADC conversion,
a delay is required for internal voltage reference and
temperature sensor stabilization time. Refer to device
datasheet. Refer to literal
LL_ADC_DELAY_VREFINT_STAB_US. Refer to literal
LL_ADC_DELAY_TEMPSENSOR_STAB_US.
ADC internal channel sampling time constraint: For ADC
conversion of internal channels, a sampling time minimum
value is required. Refer to device datasheet.
On this STM32 serie, setting of this feature is conditioned to
ADC state: All ADC instances of the ADC common group
must be disabled. This check can be done with function
LL_ADC_IsEnabled() for each ADC instance or by using
helper macro helper macro
__LL_ADC_IS_ENABLED_ALL_COMMON_INSTANCE().
Reference Manual to
LL API cross
reference:
CCR VREFEN LL_ADC_SetCommonPathInternalCh
CCR TSEN LL_ADC_SetCommonPathInternalCh
CCR VBATEN LL_ADC_SetCommonPathInternalCh
DocID026525 Rev 6
635/1320
LL ADC Generic Driver
UM1785
LL_ADC_GetCommonPathInternalCh
Function name
__STATIC_INLINE uint32_t
LL_ADC_GetCommonPathInternalCh
(ADC_Common_TypeDef * ADCxy_COMMON)
Function description
Get parameter common to several ADC: measurement path to
internal channels (VrefInt, temperature sensor, ...).
Parameters
ADCxy_COMMON: ADC common instance (can be set
directly from CMSIS definition or by using helper macro
__LL_ADC_COMMON_INSTANCE() )
Return values
Returned: value can be a combination of the following
values: (1) On STM32F0, parameter not available on all
devices: all devices except STM32F030x6, STM32F030x8,
STM32F030xC, STM32F070x6, STM32F070xB.
LL_ADC_PATH_INTERNAL_NONE
LL_ADC_PATH_INTERNAL_VREFINT
LL_ADC_PATH_INTERNAL_TEMPSENSOR
LL_ADC_PATH_INTERNAL_VBAT (1)
Notes
One or several values can be selected. Example:
(LL_ADC_PATH_INTERNAL_VREFINT |
LL_ADC_PATH_INTERNAL_TEMPSENSOR)
Reference Manual to
LL API cross
reference:
CCR VREFEN LL_ADC_GetCommonPathInternalCh
CCR TSEN LL_ADC_GetCommonPathInternalCh
CCR VBATEN LL_ADC_GetCommonPathInternalCh
LL_ADC_SetClock
636/1320
Function name
__STATIC_INLINE void LL_ADC_SetClock (ADC_TypeDef *
ADCx, uint32_t ClockSource)
Function description
Set ADC instance clock source and prescaler.
Parameters
ADCx: ADC instance
ClockSource: This parameter can be one of the following
values: (1) On this STM32 serie, synchronous clock has no
prescaler.
LL_ADC_CLOCK_SYNC_PCLK_DIV4
LL_ADC_CLOCK_SYNC_PCLK_DIV2
LL_ADC_CLOCK_ASYNC (1)
Return values
None
Notes
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled.
Reference Manual to
LL API cross
reference:
CFGR2 CKMODE LL_ADC_SetClock
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
LL_ADC_GetClock
Function name
__STATIC_INLINE uint32_t LL_ADC_GetClock (ADC_TypeDef
* ADCx)
Function description
Get ADC instance clock source and prescaler.
Parameters
ADCx: ADC instance
Return values
Returned: value can be one of the following values: (1) On
this STM32 serie, synchronous clock has no prescaler.
LL_ADC_CLOCK_SYNC_PCLK_DIV4
LL_ADC_CLOCK_SYNC_PCLK_DIV2
LL_ADC_CLOCK_ASYNC (1)
Reference Manual to
LL API cross
reference:
CFGR2 CKMODE LL_ADC_GetClock
LL_ADC_SetResolution
Function name
__STATIC_INLINE void LL_ADC_SetResolution
(ADC_TypeDef * ADCx, uint32_t Resolution)
Function description
Set ADC resolution.
Parameters
ADCx: ADC instance
Resolution: This parameter can be one of the following
values:
LL_ADC_RESOLUTION_12B
LL_ADC_RESOLUTION_10B
LL_ADC_RESOLUTION_8B
LL_ADC_RESOLUTION_6B
Return values
None
Notes
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
conversion on going on group regular.
Reference Manual to
LL API cross
reference:
CFGR1 RES LL_ADC_SetResolution
LL_ADC_GetResolution
Function name
__STATIC_INLINE uint32_t LL_ADC_GetResolution
(ADC_TypeDef * ADCx)
Function description
Get ADC resolution.
Parameters
ADCx: ADC instance
Return values
Returned: value can be one of the following values:
LL_ADC_RESOLUTION_12B
LL_ADC_RESOLUTION_10B
LL_ADC_RESOLUTION_8B
LL_ADC_RESOLUTION_6B
DocID026525 Rev 6
637/1320
LL ADC Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
CFGR1 RES LL_ADC_GetResolution
LL_ADC_SetDataAlignment
Function name
__STATIC_INLINE void LL_ADC_SetDataAlignment
(ADC_TypeDef * ADCx, uint32_t DataAlignment)
Function description
Set ADC conversion data alignment.
Parameters
ADCx: ADC instance
DataAlignment: This parameter can be one of the following
values:
LL_ADC_DATA_ALIGN_RIGHT
LL_ADC_DATA_ALIGN_LEFT
Return values
None
Notes
Refer to reference manual for alignments formats
dependencies to ADC resolutions.
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
conversion on going on group regular.
Reference Manual to
LL API cross
reference:
CFGR1 ALIGN LL_ADC_SetDataAlignment
LL_ADC_GetDataAlignment
Function name
__STATIC_INLINE uint32_t LL_ADC_GetDataAlignment
(ADC_TypeDef * ADCx)
Function description
Get ADC conversion data alignment.
Parameters
ADCx: ADC instance
Return values
Returned: value can be one of the following values:
LL_ADC_DATA_ALIGN_RIGHT
LL_ADC_DATA_ALIGN_LEFT
Notes
Refer to reference manual for alignments formats
dependencies to ADC resolutions.
Reference Manual to
LL API cross
reference:
CFGR1 ALIGN LL_ADC_GetDataAlignment
LL_ADC_SetLowPowerMode
Function name
__STATIC_INLINE void LL_ADC_SetLowPowerMode
(ADC_TypeDef * ADCx, uint32_t LowPowerMode)
Function description
Set ADC low power mode.
Parameters
638/1320
ADCx: ADC instance
LowPowerMode: This parameter can be one of the following
values:
LL_ADC_LP_MODE_NONE
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
LL_ADC_LP_AUTOWAIT
LL_ADC_LP_AUTOPOWEROFF
LL_ADC_LP_AUTOWAIT_AUTOPOWEROFF
Return values
None
Notes
Description of ADC low power modes: ADC low power mode
"auto wait": Dynamic low power mode, ADC conversions
occurrences are limited to the minimum necessary in order to
reduce power consumption. New ADC conversion starts only
when the previous unitary conversion data (for ADC group
regular) has been retrieved by user software. In the
meantime, ADC remains idle: does not performs any other
conversion. This mode allows to automatically adapt the ADC
conversions triggers to the speed of the software that reads
the data. Moreover, this avoids risk of overrun for low
frequency applications. How to use this low power mode: Do
not use with interruption or DMA since these modes have to
clear immediately the EOC flag to free the IRQ vector
sequencer.Do use with polling: 1. Start conversion, 2. Later
on, when conversion data is needed: poll for end of
conversion to ensure that conversion is completed and
retrieve ADC conversion data. This will trig another ADC
conversion start. ADC low power mode "auto power-off"
(feature available on this device if parameter
LL_ADC_LP_MODE_AUTOOFF is available): the ADC
automatically powers-off after a conversion and automatically
wakes up when a new conversion is triggered (with startup
time between trigger and start of sampling). This feature can
be combined with low power mode "auto wait".
With ADC low power mode "auto wait", the ADC conversion
data read is corresponding to previous ADC conversion start,
independently of delay during which ADC was idle. Therefore,
the ADC conversion data may be outdated: does not
correspond to the current voltage level on the selected ADC
channel.
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
conversion on going on group regular.
Reference Manual to
LL API cross
reference:
CFGR1 WAIT LL_ADC_SetLowPowerMode
CFGR1 AUTOFF LL_ADC_SetLowPowerMode
LL_ADC_GetLowPowerMode
Function name
__STATIC_INLINE uint32_t LL_ADC_GetLowPowerMode
(ADC_TypeDef * ADCx)
Function description
Get ADC low power mode:
Parameters
ADCx: ADC instance
Return values
Returned: value can be one of the following values:
LL_ADC_LP_MODE_NONE
LL_ADC_LP_AUTOWAIT
LL_ADC_LP_AUTOPOWEROFF
DocID026525 Rev 6
639/1320
LL ADC Generic Driver
UM1785
LL_ADC_LP_AUTOWAIT_AUTOPOWEROFF
Notes
Description of ADC low power modes: ADC low power mode
"auto wait": Dynamic low power mode, ADC conversions
occurrences are limited to the minimum necessary in order to
reduce power consumption. New ADC conversion starts only
when the previous unitary conversion data (for ADC group
regular) has been retrieved by user software. In the
meantime, ADC remains idle: does not performs any other
conversion. This mode allows to automatically adapt the ADC
conversions triggers to the speed of the software that reads
the data. Moreover, this avoids risk of overrun for low
frequency applications. How to use this low power mode: Do
not use with interruption or DMA since these modes have to
clear immediately the EOC flag to free the IRQ vector
sequencer.Do use with polling: 1. Start conversion, 2. Later
on, when conversion data is needed: poll for end of
conversion to ensure that conversion is completed and
retrieve ADC conversion data. This will trig another ADC
conversion start. ADC low power mode "auto power-off"
(feature available on this device if parameter
LL_ADC_LP_MODE_AUTOOFF is available): the ADC
automatically powers-off after a conversion and automatically
wakes up when a new conversion is triggered (with startup
time between trigger and start of sampling). This feature can
be combined with low power mode "auto wait".
With ADC low power mode "auto wait", the ADC conversion
data read is corresponding to previous ADC conversion start,
independently of delay during which ADC was idle. Therefore,
the ADC conversion data may be outdated: does not
correspond to the current voltage level on the selected ADC
channel.
Reference Manual to
LL API cross
reference:
CFGR1 WAIT LL_ADC_GetLowPowerMode
CFGR1 AUTOFF LL_ADC_GetLowPowerMode
LL_ADC_SetSamplingTimeCommonChannels
Function name
__STATIC_INLINE void
LL_ADC_SetSamplingTimeCommonChannels (ADC_TypeDef
* ADCx, uint32_t SamplingTime)
Function description
Set sampling time common to a group of channels.
Parameters
640/1320
ADCx: ADC instance
SamplingTime: This parameter can be one of the following
values:
LL_ADC_SAMPLINGTIME_1CYCLE_5
LL_ADC_SAMPLINGTIME_7CYCLES_5
LL_ADC_SAMPLINGTIME_13CYCLES_5
LL_ADC_SAMPLINGTIME_28CYCLES_5
LL_ADC_SAMPLINGTIME_41CYCLES_5
LL_ADC_SAMPLINGTIME_55CYCLES_5
LL_ADC_SAMPLINGTIME_71CYCLES_5
LL_ADC_SAMPLINGTIME_239CYCLES_5
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
Return values
None
Notes
Unit: ADC clock cycles.
On this STM32 serie, sampling time scope is on ADC
instance: Sampling time common to all channels. (on some
other STM32 families, sampling time is channel wise)
In case of internal channel (VrefInt, TempSensor, ...) to be
converted: 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, ...).
Conversion time is the addition of sampling time and
processing time. On this STM32 serie, ADC processing time
is: 12.5 ADC clock cycles at ADC resolution 12 bits10.5 ADC
clock cycles at ADC resolution 10 bits8.5 ADC clock cycles at
ADC resolution 8 bits6.5 ADC clock cycles at ADC resolution
6 bits
In case of ADC conversion of internal channel (VrefInt,
temperature sensor, ...), a sampling time minimum value is
required. Refer to device datasheet.
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
conversion on going on group regular.
Reference Manual to
LL API cross
reference:
SMPR SMP LL_ADC_SetSamplingTimeCommonChannels
LL_ADC_GetSamplingTimeCommonChannels
Function name
__STATIC_INLINE uint32_t
LL_ADC_GetSamplingTimeCommonChannels (ADC_TypeDef
* ADCx)
Function description
Get sampling time common to a group of channels.
Parameters
ADCx: ADC instance
Return values
Returned: value can be one of the following values:
LL_ADC_SAMPLINGTIME_1CYCLE_5
LL_ADC_SAMPLINGTIME_7CYCLES_5
LL_ADC_SAMPLINGTIME_13CYCLES_5
LL_ADC_SAMPLINGTIME_28CYCLES_5
LL_ADC_SAMPLINGTIME_41CYCLES_5
LL_ADC_SAMPLINGTIME_55CYCLES_5
LL_ADC_SAMPLINGTIME_71CYCLES_5
LL_ADC_SAMPLINGTIME_239CYCLES_5
Notes
Unit: ADC clock cycles.
On this STM32 serie, sampling time scope is on ADC
instance: Sampling time common to all channels. (on some
other STM32 families, sampling time is channel wise)
Conversion time is the addition of sampling time and
processing time. Refer to reference manual for ADC
processing time of this STM32 serie.
DocID026525 Rev 6
641/1320
LL ADC Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
SMPR SMP LL_ADC_GetSamplingTimeCommonChannels
LL_ADC_REG_SetTriggerSource
Function name
__STATIC_INLINE void LL_ADC_REG_SetTriggerSource
(ADC_TypeDef * ADCx, uint32_t TriggerSource)
Function description
Set ADC group regular conversion trigger source: internal (SW
start) or from external IP (timer event, external interrupt line).
Parameters
ADCx: ADC instance
TriggerSource: This parameter can be one of the following
values: (1) On STM32F0, parameter not available on all
devices
LL_ADC_REG_TRIG_SOFTWARE
LL_ADC_REG_TRIG_EXT_TIM1_TRGO
LL_ADC_REG_TRIG_EXT_TIM1_CH4
LL_ADC_REG_TRIG_EXT_TIM2_TRGO (1)
LL_ADC_REG_TRIG_EXT_TIM3_TRGO
LL_ADC_REG_TRIG_EXT_TIM15_TRGO (1)
Return values
None
Notes
On this STM32 serie, setting trigger source to external trigger
also set trigger polarity to rising edge (default setting for
compatibility with some ADC on other STM32 families having
this setting set by HW default value). In case of need to
modify trigger edge, use function
LL_ADC_REG_SetTriggerEdge().
Availability of parameters of trigger sources from timer
depends on timers availability on the selected device.
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
conversion on going on group regular.
Reference Manual to
LL API cross
reference:
CFGR1 EXTSEL LL_ADC_REG_SetTriggerSource
CFGR1 EXTEN LL_ADC_REG_SetTriggerSource
LL_ADC_REG_GetTriggerSource
642/1320
Function name
__STATIC_INLINE uint32_t LL_ADC_REG_GetTriggerSource
(ADC_TypeDef * ADCx)
Function description
Get ADC group regular conversion trigger source: internal (SW
start) or from external IP (timer event, external interrupt line).
Parameters
ADCx: ADC instance
Return values
Returned: value can be one of the following values: (1) On
STM32F0, parameter not available on all devices
LL_ADC_REG_TRIG_SOFTWARE
LL_ADC_REG_TRIG_EXT_TIM1_TRGO
LL_ADC_REG_TRIG_EXT_TIM1_CH4
LL_ADC_REG_TRIG_EXT_TIM2_TRGO (1)
LL_ADC_REG_TRIG_EXT_TIM3_TRGO
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
LL_ADC_REG_TRIG_EXT_TIM15_TRGO (1)
Notes
To determine whether group regular trigger source is internal
(SW start) or external, without detail of which peripheral is
selected as external trigger, (equivalent to
"if(LL_ADC_REG_GetTriggerSource(ADC1) ==
LL_ADC_REG_TRIG_SOFTWARE)") use function
LL_ADC_REG_IsTriggerSourceSWStart.
Availability of parameters of trigger sources from timer
depends on timers availability on the selected device.
Reference Manual to
LL API cross
reference:
CFGR1 EXTSEL LL_ADC_REG_GetTriggerSource
CFGR1 EXTEN LL_ADC_REG_GetTriggerSource
LL_ADC_REG_IsTriggerSourceSWStart
Function name
__STATIC_INLINE uint32_t
LL_ADC_REG_IsTriggerSourceSWStart (ADC_TypeDef *
ADCx)
Function description
Get ADC group regular conversion trigger source internal (SW
start) or external.
Parameters
ADCx: ADC instance
Return values
Value: "0" if trigger source external trigger Value "1" if trigger
source SW start.
Notes
In case of group regular trigger source set to external trigger,
to determine which peripheral is selected as external trigger,
use function LL_ADC_REG_GetTriggerSource().
Reference Manual to
LL API cross
reference:
CFGR1 EXTEN LL_ADC_REG_IsTriggerSourceSWStart
LL_ADC_REG_SetTriggerEdge
Function name
__STATIC_INLINE void LL_ADC_REG_SetTriggerEdge
(ADC_TypeDef * ADCx, uint32_t ExternalTriggerEdge)
Function description
Set ADC group regular conversion trigger polarity.
Parameters
ADCx: ADC instance
ExternalTriggerEdge: This parameter can be one of the
following values:
LL_ADC_REG_TRIG_EXT_RISING
LL_ADC_REG_TRIG_EXT_FALLING
LL_ADC_REG_TRIG_EXT_RISINGFALLING
Return values
None
Notes
Applicable only for trigger source set to external trigger.
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
conversion on going on group regular.
DocID026525 Rev 6
643/1320
LL ADC Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
CFGR1 EXTEN LL_ADC_REG_SetTriggerEdge
LL_ADC_REG_GetTriggerEdge
Function name
__STATIC_INLINE uint32_t LL_ADC_REG_GetTriggerEdge
(ADC_TypeDef * ADCx)
Function description
Get ADC group regular conversion trigger polarity.
Parameters
ADCx: ADC instance
Return values
Returned: value can be one of the following values:
LL_ADC_REG_TRIG_EXT_RISING
LL_ADC_REG_TRIG_EXT_FALLING
LL_ADC_REG_TRIG_EXT_RISINGFALLING
Notes
Applicable only for trigger source set to external trigger.
Reference Manual to
LL API cross
reference:
CFGR1 EXTEN LL_ADC_REG_GetTriggerEdge
LL_ADC_REG_SetSequencerScanDirection
Function name
__STATIC_INLINE void
LL_ADC_REG_SetSequencerScanDirection (ADC_TypeDef *
ADCx, uint32_t ScanDirection)
Function description
Set ADC group regular sequencer scan direction.
Parameters
ADCx: ADC instance
ScanDirection: This parameter can be one of the following
values:
LL_ADC_REG_SEQ_SCAN_DIR_FORWARD
LL_ADC_REG_SEQ_SCAN_DIR_BACKWARD
Return values
None
Notes
On some other STM32 families, this setting is not available
and the default scan direction is forward.
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
conversion on going on group regular.
Reference Manual to
LL API cross
reference:
CFGR1 SCANDIR
LL_ADC_REG_SetSequencerScanDirection
LL_ADC_REG_GetSequencerScanDirection
644/1320
Function name
__STATIC_INLINE uint32_t
LL_ADC_REG_GetSequencerScanDirection (ADC_TypeDef *
ADCx)
Function description
Get ADC group regular sequencer scan direction.
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
Parameters
ADCx: ADC instance
Return values
Returned: value can be one of the following values:
LL_ADC_REG_SEQ_SCAN_DIR_FORWARD
LL_ADC_REG_SEQ_SCAN_DIR_BACKWARD
Notes
On some other STM32 families, this setting is not available
and the default scan direction is forward.
Reference Manual to
LL API cross
reference:
CFGR1 SCANDIR
LL_ADC_REG_GetSequencerScanDirection
LL_ADC_REG_SetSequencerDiscont
Function name
__STATIC_INLINE void LL_ADC_REG_SetSequencerDiscont
(ADC_TypeDef * ADCx, uint32_t SeqDiscont)
Function description
Set ADC group regular sequencer discontinuous mode: sequence
subdivided and scan conversions interrupted every selected
number of ranks.
Parameters
ADCx: ADC instance
SeqDiscont: This parameter can be one of the following
values:
LL_ADC_REG_SEQ_DISCONT_DISABLE
LL_ADC_REG_SEQ_DISCONT_1RANK
Return values
None
Notes
It is not possible to enable both ADC group regular
continuous mode and sequencer discontinuous mode.
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
conversion on going on group regular.
Reference Manual to
LL API cross
reference:
CFGR1 DISCEN LL_ADC_REG_SetSequencerDiscont
LL_ADC_REG_GetSequencerDiscont
Function name
__STATIC_INLINE uint32_t
LL_ADC_REG_GetSequencerDiscont (ADC_TypeDef * ADCx)
Function description
Get ADC group regular sequencer discontinuous mode: sequence
subdivided and scan conversions interrupted every selected
number of ranks.
Parameters
ADCx: ADC instance
Return values
Returned: value can be one of the following values:
LL_ADC_REG_SEQ_DISCONT_DISABLE
LL_ADC_REG_SEQ_DISCONT_1RANK
Reference Manual to
LL API cross
reference:
CFGR1 DISCEN LL_ADC_REG_GetSequencerDiscont
DocID026525 Rev 6
645/1320
LL ADC Generic Driver
UM1785
LL_ADC_REG_SetSequencerChannels
646/1320
Function name
__STATIC_INLINE void LL_ADC_REG_SetSequencerChannels
(ADC_TypeDef * ADCx, uint32_t Channel)
Function description
Set ADC group regular sequence: channel on rank corresponding
to channel number.
Parameters
ADCx: ADC instance
Channel: This parameter can be a combination of the
following values: (1) On STM32F0, parameter not available
on all devices: all devices except STM32F030x6,
STM32F030x8, STM32F030xC, STM32F070x6,
STM32F070xB.
LL_ADC_CHANNEL_0
LL_ADC_CHANNEL_1
LL_ADC_CHANNEL_2
LL_ADC_CHANNEL_3
LL_ADC_CHANNEL_4
LL_ADC_CHANNEL_5
LL_ADC_CHANNEL_6
LL_ADC_CHANNEL_7
LL_ADC_CHANNEL_8
LL_ADC_CHANNEL_9
LL_ADC_CHANNEL_10
LL_ADC_CHANNEL_11
LL_ADC_CHANNEL_12
LL_ADC_CHANNEL_13
LL_ADC_CHANNEL_14
LL_ADC_CHANNEL_15
LL_ADC_CHANNEL_16
LL_ADC_CHANNEL_17
LL_ADC_CHANNEL_18 (1)
LL_ADC_CHANNEL_VREFINT
LL_ADC_CHANNEL_TEMPSENSOR
LL_ADC_CHANNEL_VBAT (1)
Return values
None
Notes
This function performs: Channels ordering into each rank of
scan sequence: rank of each channel is fixed by channel HW
number (channel 0 fixed on rank 0, channel 1 fixed on rank1,
...).Set channels selected by overwriting the current
sequencer configuration.
On this STM32 serie, ADC group regular sequencer is not
fully configurable: sequencer length and each rank affectation
to a channel are fixed by channel HW number.
Depending on devices and packages, some channels may
not be available. Refer to device datasheet for channels
availability.
On this STM32 serie, to measure internal channels (VrefInt,
TempSensor, ...), measurement paths to internal channels
must be enabled separately. This can be done using function
LL_ADC_SetCommonPathInternalCh().
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
conversion on going on group regular.
One or several values can be selected. Example:
(LL_ADC_CHANNEL_4 | LL_ADC_CHANNEL_12 | ...)
Reference Manual to
LL API cross
reference:
CHSELR CHSEL0 LL_ADC_REG_SetSequencerChannels
CHSELR CHSEL1 LL_ADC_REG_SetSequencerChannels
CHSELR CHSEL2 LL_ADC_REG_SetSequencerChannels
CHSELR CHSEL3 LL_ADC_REG_SetSequencerChannels
CHSELR CHSEL4 LL_ADC_REG_SetSequencerChannels
CHSELR CHSEL5 LL_ADC_REG_SetSequencerChannels
CHSELR CHSEL6 LL_ADC_REG_SetSequencerChannels
CHSELR CHSEL7 LL_ADC_REG_SetSequencerChannels
CHSELR CHSEL8 LL_ADC_REG_SetSequencerChannels
CHSELR CHSEL9 LL_ADC_REG_SetSequencerChannels
CHSELR CHSEL10 LL_ADC_REG_SetSequencerChannels
CHSELR CHSEL11 LL_ADC_REG_SetSequencerChannels
CHSELR CHSEL12 LL_ADC_REG_SetSequencerChannels
CHSELR CHSEL13 LL_ADC_REG_SetSequencerChannels
CHSELR CHSEL14 LL_ADC_REG_SetSequencerChannels
CHSELR CHSEL15 LL_ADC_REG_SetSequencerChannels
CHSELR CHSEL16 LL_ADC_REG_SetSequencerChannels
CHSELR CHSEL17 LL_ADC_REG_SetSequencerChannels
CHSELR CHSEL18 LL_ADC_REG_SetSequencerChannels
LL_ADC_REG_SetSequencerChAdd
Function name
__STATIC_INLINE void LL_ADC_REG_SetSequencerChAdd
(ADC_TypeDef * ADCx, uint32_t Channel)
Function description
Add channel to ADC group regular sequence: channel on rank
corresponding to channel number.
Parameters
ADCx: ADC instance
Channel: This parameter can be a combination of the
following values: (1) On STM32F0, parameter not available
on all devices: all devices except STM32F030x6,
STM32F030x8, STM32F030xC, STM32F070x6,
STM32F070xB.
LL_ADC_CHANNEL_0
LL_ADC_CHANNEL_1
LL_ADC_CHANNEL_2
LL_ADC_CHANNEL_3
LL_ADC_CHANNEL_4
LL_ADC_CHANNEL_5
LL_ADC_CHANNEL_6
LL_ADC_CHANNEL_7
LL_ADC_CHANNEL_8
LL_ADC_CHANNEL_9
LL_ADC_CHANNEL_10
LL_ADC_CHANNEL_11
LL_ADC_CHANNEL_12
LL_ADC_CHANNEL_13
LL_ADC_CHANNEL_14
LL_ADC_CHANNEL_15
DocID026525 Rev 6
647/1320
LL ADC Generic Driver
UM1785
LL_ADC_CHANNEL_16
LL_ADC_CHANNEL_17
LL_ADC_CHANNEL_18 (1)
LL_ADC_CHANNEL_VREFINT
LL_ADC_CHANNEL_TEMPSENSOR
LL_ADC_CHANNEL_VBAT (1)
648/1320
Return values
None
Notes
This function performs: Channels ordering into each rank of
scan sequence: rank of each channel is fixed by channel HW
number (channel 0 fixed on rank 0, channel 1 fixed on rank1,
...).Set channels selected by adding them to the current
sequencer configuration.
On this STM32 serie, ADC group regular sequencer is not
fully configurable: sequencer length and each rank affectation
to a channel are fixed by channel HW number.
Depending on devices and packages, some channels may
not be available. Refer to device datasheet for channels
availability.
On this STM32 serie, to measure internal channels (VrefInt,
TempSensor, ...), measurement paths to internal channels
must be enabled separately. This can be done using function
LL_ADC_SetCommonPathInternalCh().
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
conversion on going on group regular.
One or several values can be selected. Example:
(LL_ADC_CHANNEL_4 | LL_ADC_CHANNEL_12 | ...)
Reference Manual to
LL API cross
reference:
CHSELR CHSEL0 LL_ADC_REG_SetSequencerChAdd
CHSELR CHSEL1 LL_ADC_REG_SetSequencerChAdd
CHSELR CHSEL2 LL_ADC_REG_SetSequencerChAdd
CHSELR CHSEL3 LL_ADC_REG_SetSequencerChAdd
CHSELR CHSEL4 LL_ADC_REG_SetSequencerChAdd
CHSELR CHSEL5 LL_ADC_REG_SetSequencerChAdd
CHSELR CHSEL6 LL_ADC_REG_SetSequencerChAdd
CHSELR CHSEL7 LL_ADC_REG_SetSequencerChAdd
CHSELR CHSEL8 LL_ADC_REG_SetSequencerChAdd
CHSELR CHSEL9 LL_ADC_REG_SetSequencerChAdd
CHSELR CHSEL10 LL_ADC_REG_SetSequencerChAdd
CHSELR CHSEL11 LL_ADC_REG_SetSequencerChAdd
CHSELR CHSEL12 LL_ADC_REG_SetSequencerChAdd
CHSELR CHSEL13 LL_ADC_REG_SetSequencerChAdd
CHSELR CHSEL14 LL_ADC_REG_SetSequencerChAdd
CHSELR CHSEL15 LL_ADC_REG_SetSequencerChAdd
CHSELR CHSEL16 LL_ADC_REG_SetSequencerChAdd
CHSELR CHSEL17 LL_ADC_REG_SetSequencerChAdd
CHSELR CHSEL18 LL_ADC_REG_SetSequencerChAdd
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
LL_ADC_REG_SetSequencerChRem
Function name
__STATIC_INLINE void LL_ADC_REG_SetSequencerChRem
(ADC_TypeDef * ADCx, uint32_t Channel)
Function description
Remove channel to ADC group regular sequence: channel on rank
corresponding to channel number.
Parameters
ADCx: ADC instance
Channel: This parameter can be a combination of the
following values: (1) On STM32F0, parameter not available
on all devices: all devices except STM32F030x6,
STM32F030x8, STM32F030xC, STM32F070x6,
STM32F070xB.
LL_ADC_CHANNEL_0
LL_ADC_CHANNEL_1
LL_ADC_CHANNEL_2
LL_ADC_CHANNEL_3
LL_ADC_CHANNEL_4
LL_ADC_CHANNEL_5
LL_ADC_CHANNEL_6
LL_ADC_CHANNEL_7
LL_ADC_CHANNEL_8
LL_ADC_CHANNEL_9
LL_ADC_CHANNEL_10
LL_ADC_CHANNEL_11
LL_ADC_CHANNEL_12
LL_ADC_CHANNEL_13
LL_ADC_CHANNEL_14
LL_ADC_CHANNEL_15
LL_ADC_CHANNEL_16
LL_ADC_CHANNEL_17
LL_ADC_CHANNEL_18 (1)
LL_ADC_CHANNEL_VREFINT
LL_ADC_CHANNEL_TEMPSENSOR
LL_ADC_CHANNEL_VBAT (1)
Return values
None
Notes
This function performs: Channels ordering into each rank of
scan sequence: rank of each channel is fixed by channel HW
number (channel 0 fixed on rank 0, channel 1 fixed on rank1,
...).Set channels selected by removing them to the current
sequencer configuration.
On this STM32 serie, ADC group regular sequencer is not
fully configurable: sequencer length and each rank affectation
to a channel are fixed by channel HW number.
Depending on devices and packages, some channels may
not be available. Refer to device datasheet for channels
availability.
On this STM32 serie, to measure internal channels (VrefInt,
TempSensor, ...), measurement paths to internal channels
must be enabled separately. This can be done using function
LL_ADC_SetCommonPathInternalCh().
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
DocID026525 Rev 6
649/1320
LL ADC Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
conversion on going on group regular.
One or several values can be selected. Example:
(LL_ADC_CHANNEL_4 | LL_ADC_CHANNEL_12 | ...)
CHSELR CHSEL0 LL_ADC_REG_SetSequencerChRem
CHSELR CHSEL1 LL_ADC_REG_SetSequencerChRem
CHSELR CHSEL2 LL_ADC_REG_SetSequencerChRem
CHSELR CHSEL3 LL_ADC_REG_SetSequencerChRem
CHSELR CHSEL4 LL_ADC_REG_SetSequencerChRem
CHSELR CHSEL5 LL_ADC_REG_SetSequencerChRem
CHSELR CHSEL6 LL_ADC_REG_SetSequencerChRem
CHSELR CHSEL7 LL_ADC_REG_SetSequencerChRem
CHSELR CHSEL8 LL_ADC_REG_SetSequencerChRem
CHSELR CHSEL9 LL_ADC_REG_SetSequencerChRem
CHSELR CHSEL10 LL_ADC_REG_SetSequencerChRem
CHSELR CHSEL11 LL_ADC_REG_SetSequencerChRem
CHSELR CHSEL12 LL_ADC_REG_SetSequencerChRem
CHSELR CHSEL13 LL_ADC_REG_SetSequencerChRem
CHSELR CHSEL14 LL_ADC_REG_SetSequencerChRem
CHSELR CHSEL15 LL_ADC_REG_SetSequencerChRem
CHSELR CHSEL16 LL_ADC_REG_SetSequencerChRem
CHSELR CHSEL17 LL_ADC_REG_SetSequencerChRem
CHSELR CHSEL18 LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_GetSequencerChannels
650/1320
Function name
__STATIC_INLINE uint32_t
LL_ADC_REG_GetSequencerChannels (ADC_TypeDef *
ADCx)
Function description
Get ADC group regular sequence: channel on rank corresponding
to channel number.
Parameters
ADCx: ADC instance
Return values
Returned: value can be a combination of the following
values: (1) On STM32F0, parameter not available on all
devices: all devices except STM32F030x6, STM32F030x8,
STM32F030xC, STM32F070x6, STM32F070xB.
LL_ADC_CHANNEL_0
LL_ADC_CHANNEL_1
LL_ADC_CHANNEL_2
LL_ADC_CHANNEL_3
LL_ADC_CHANNEL_4
LL_ADC_CHANNEL_5
LL_ADC_CHANNEL_6
LL_ADC_CHANNEL_7
LL_ADC_CHANNEL_8
LL_ADC_CHANNEL_9
LL_ADC_CHANNEL_10
LL_ADC_CHANNEL_11
LL_ADC_CHANNEL_12
LL_ADC_CHANNEL_13
LL_ADC_CHANNEL_14
LL_ADC_CHANNEL_15
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
LL_ADC_CHANNEL_16
LL_ADC_CHANNEL_17
LL_ADC_CHANNEL_18 (1)
LL_ADC_CHANNEL_VREFINT
LL_ADC_CHANNEL_TEMPSENSOR
LL_ADC_CHANNEL_VBAT (1)
Notes
This function performs: Channels order reading into each rank
of scan sequence: rank of each channel is fixed by channel
HW number (channel 0 fixed on rank 0, channel 1 fixed on
rank1, ...).
On this STM32 serie, ADC group regular sequencer is not
fully configurable: sequencer length and each rank affectation
to a channel are fixed by channel HW number.
Depending on devices and packages, some channels may
not be available. Refer to device datasheet for channels
availability.
On this STM32 serie, to measure internal channels (VrefInt,
TempSensor, ...), measurement paths to internal channels
must be enabled separately. This can be done using function
LL_ADC_SetCommonPathInternalCh().
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
conversion on going on group regular.
One or several values can be retrieved. Example:
(LL_ADC_CHANNEL_4 | LL_ADC_CHANNEL_12 | ...)
Reference Manual to
LL API cross
reference:
CHSELR CHSEL0 LL_ADC_REG_GetSequencerChannels
CHSELR CHSEL1 LL_ADC_REG_GetSequencerChannels
CHSELR CHSEL2 LL_ADC_REG_GetSequencerChannels
CHSELR CHSEL3 LL_ADC_REG_GetSequencerChannels
CHSELR CHSEL4 LL_ADC_REG_GetSequencerChannels
CHSELR CHSEL5 LL_ADC_REG_GetSequencerChannels
CHSELR CHSEL6 LL_ADC_REG_GetSequencerChannels
CHSELR CHSEL7 LL_ADC_REG_GetSequencerChannels
CHSELR CHSEL8 LL_ADC_REG_GetSequencerChannels
CHSELR CHSEL9 LL_ADC_REG_GetSequencerChannels
CHSELR CHSEL10 LL_ADC_REG_GetSequencerChannels
CHSELR CHSEL11 LL_ADC_REG_GetSequencerChannels
CHSELR CHSEL12 LL_ADC_REG_GetSequencerChannels
CHSELR CHSEL13 LL_ADC_REG_GetSequencerChannels
CHSELR CHSEL14 LL_ADC_REG_GetSequencerChannels
CHSELR CHSEL15 LL_ADC_REG_GetSequencerChannels
CHSELR CHSEL16 LL_ADC_REG_GetSequencerChannels
CHSELR CHSEL17 LL_ADC_REG_GetSequencerChannels
CHSELR CHSEL18 LL_ADC_REG_GetSequencerChannels
LL_ADC_REG_SetContinuousMode
Function name
__STATIC_INLINE void LL_ADC_REG_SetContinuousMode
(ADC_TypeDef * ADCx, uint32_t Continuous)
Function description
Set ADC continuous conversion mode on ADC group regular.
Parameters
ADCx: ADC instance
DocID026525 Rev 6
651/1320
LL ADC Generic Driver
UM1785
Continuous: This parameter can be one of the following
values:
LL_ADC_REG_CONV_SINGLE
LL_ADC_REG_CONV_CONTINUOUS
Return values
None
Notes
Description of ADC continuous conversion mode: single
mode: one conversion per triggercontinuous mode: after the
first trigger, following conversions launched successively
automatically.
It is not possible to enable both ADC group regular
continuous mode and sequencer discontinuous mode.
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
conversion on going on group regular.
Reference Manual to
LL API cross
reference:
CFGR1 CONT LL_ADC_REG_SetContinuousMode
LL_ADC_REG_GetContinuousMode
Function name
__STATIC_INLINE uint32_t
LL_ADC_REG_GetContinuousMode (ADC_TypeDef * ADCx)
Function description
Get ADC continuous conversion mode on ADC group regular.
Parameters
ADCx: ADC instance
Return values
Returned: value can be one of the following values:
LL_ADC_REG_CONV_SINGLE
LL_ADC_REG_CONV_CONTINUOUS
Notes
Description of ADC continuous conversion mode: single
mode: one conversion per triggercontinuous mode: after the
first trigger, following conversions launched successively
automatically.
Reference Manual to
LL API cross
reference:
CFGR1 CONT LL_ADC_REG_GetContinuousMode
LL_ADC_REG_SetDMATransfer
652/1320
Function name
__STATIC_INLINE void LL_ADC_REG_SetDMATransfer
(ADC_TypeDef * ADCx, uint32_t DMATransfer)
Function description
Set ADC group regular conversion data transfer: no transfer or
transfer by DMA, and DMA requests mode.
Parameters
ADCx: ADC instance
DMATransfer: This parameter can be one of the following
values:
LL_ADC_REG_DMA_TRANSFER_NONE
LL_ADC_REG_DMA_TRANSFER_LIMITED
LL_ADC_REG_DMA_TRANSFER_UNLIMITED
Return values
None
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
Notes
If transfer by DMA selected, specifies the DMA requests
mode: Limited mode (One shot mode): DMA transfer requests
are stopped when number of DMA data transfers (number of
ADC conversions) is reached. This ADC mode is intended to
be used with DMA mode non-circular.Unlimited mode: DMA
transfer requests are unlimited, whatever number of DMA
data transfers (number of ADC conversions). This ADC mode
is intended to be used with DMA mode circular.
If ADC DMA requests mode is set to unlimited and DMA is set
to mode non-circular: when DMA transfers size will be
reached, DMA will stop transfers of ADC conversions data
ADC will raise an overrun error (overrun flag and interruption
if enabled).
To configure DMA source address (peripheral address), use
function LL_ADC_DMA_GetRegAddr().
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
conversion on going on group regular.
Reference Manual to
LL API cross
reference:
CFGR1 DMAEN LL_ADC_REG_SetDMATransfer
CFGR1 DMACFG LL_ADC_REG_SetDMATransfer
LL_ADC_REG_GetDMATransfer
Function name
__STATIC_INLINE uint32_t LL_ADC_REG_GetDMATransfer
(ADC_TypeDef * ADCx)
Function description
Get ADC group regular conversion data transfer: no transfer or
transfer by DMA, and DMA requests mode.
Parameters
ADCx: ADC instance
Return values
Returned: value can be one of the following values:
LL_ADC_REG_DMA_TRANSFER_NONE
LL_ADC_REG_DMA_TRANSFER_LIMITED
LL_ADC_REG_DMA_TRANSFER_UNLIMITED
Notes
If transfer by DMA selected, specifies the DMA requests
mode: Limited mode (One shot mode): DMA transfer requests
are stopped when number of DMA data transfers (number of
ADC conversions) is reached. This ADC mode is intended to
be used with DMA mode non-circular.Unlimited mode: DMA
transfer requests are unlimited, whatever number of DMA
data transfers (number of ADC conversions). This ADC mode
is intended to be used with DMA mode circular.
If ADC DMA requests mode is set to unlimited and DMA is set
to mode non-circular: when DMA transfers size will be
reached, DMA will stop transfers of ADC conversions data
ADC will raise an overrun error (overrun flag and interruption
if enabled).
To configure DMA source address (peripheral address), use
function LL_ADC_DMA_GetRegAddr().
Reference Manual to
LL API cross
reference:
CFGR1 DMAEN LL_ADC_REG_GetDMATransfer
CFGR1 DMACFG LL_ADC_REG_GetDMATransfer
DocID026525 Rev 6
653/1320
LL ADC Generic Driver
UM1785
LL_ADC_REG_SetOverrun
Function name
__STATIC_INLINE void LL_ADC_REG_SetOverrun
(ADC_TypeDef * ADCx, uint32_t Overrun)
Function description
Set ADC group regular behavior in case of overrun: data
preserved or overwritten.
Parameters
ADCx: ADC instance
Overrun: This parameter can be one of the following values:
LL_ADC_REG_OVR_DATA_PRESERVED
LL_ADC_REG_OVR_DATA_OVERWRITTEN
Return values
None
Notes
Compatibility with devices without feature overrun: other
devices without this feature have a behavior equivalent to
data overwritten. The default setting of overrun is data
preserved. Therefore, for compatibility with all devices,
parameter overrun should be set to data overwritten.
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
conversion on going on group regular.
Reference Manual to
LL API cross
reference:
CFGR1 OVRMOD LL_ADC_REG_SetOverrun
LL_ADC_REG_GetOverrun
Function name
__STATIC_INLINE uint32_t LL_ADC_REG_GetOverrun
(ADC_TypeDef * ADCx)
Function description
Get ADC group regular behavior in case of overrun: data
preserved or overwritten.
Parameters
ADCx: ADC instance
Return values
Returned: value can be one of the following values:
LL_ADC_REG_OVR_DATA_PRESERVED
LL_ADC_REG_OVR_DATA_OVERWRITTEN
Reference Manual to
LL API cross
reference:
CFGR1 OVRMOD LL_ADC_REG_GetOverrun
LL_ADC_SetAnalogWDMonitChannels
Function name
__STATIC_INLINE void LL_ADC_SetAnalogWDMonitChannels
(ADC_TypeDef * ADCx, uint32_t AWDChannelGroup)
Function description
Set ADC analog watchdog monitored channels: a single channel
or all channels, on ADC group regular.
Parameters
654/1320
ADCx: ADC instance
AWDChannelGroup: This parameter can be one of the
following values: (1) On STM32F0, parameter not available
on all devices: all devices except STM32F030x6,
STM32F030x8, STM32F030xC, STM32F070x6,
STM32F070xB.
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
LL_ADC_AWD_DISABLE
LL_ADC_AWD_ALL_CHANNELS_REG
LL_ADC_AWD_CHANNEL_0_REG
LL_ADC_AWD_CHANNEL_1_REG
LL_ADC_AWD_CHANNEL_2_REG
LL_ADC_AWD_CHANNEL_3_REG
LL_ADC_AWD_CHANNEL_4_REG
LL_ADC_AWD_CHANNEL_5_REG
LL_ADC_AWD_CHANNEL_6_REG
LL_ADC_AWD_CHANNEL_7_REG
LL_ADC_AWD_CHANNEL_8_REG
LL_ADC_AWD_CHANNEL_9_REG
LL_ADC_AWD_CHANNEL_10_REG
LL_ADC_AWD_CHANNEL_11_REG
LL_ADC_AWD_CHANNEL_12_REG
LL_ADC_AWD_CHANNEL_13_REG
LL_ADC_AWD_CHANNEL_14_REG
LL_ADC_AWD_CHANNEL_15_REG
LL_ADC_AWD_CHANNEL_16_REG
LL_ADC_AWD_CHANNEL_17_REG
LL_ADC_AWD_CHANNEL_18_REG (1)
LL_ADC_AWD_CH_VREFINT_REG
LL_ADC_AWD_CH_TEMPSENSOR_REG
LL_ADC_AWD_CH_VBAT_REG (1)
Return values
None
Notes
Once monitored channels are selected, analog watchdog is
enabled.
In case of need to define a single channel to monitor with
analog watchdog from sequencer channel definition, use
helper macro
__LL_ADC_ANALOGWD_CHANNEL_GROUP().
On this STM32 serie, there is only 1 kind of analog watchdog
instance: AWD standard (instance AWD1): channels
monitored: can monitor 1 channel or all channels.groups
monitored: ADC group regular.resolution: resolution is not
limited (corresponds to ADC resolution configured).
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
conversion on going on group regular.
Reference Manual to
LL API cross
reference:
CFGR1 AWDCH LL_ADC_SetAnalogWDMonitChannels
CFGR1 AWDSGL LL_ADC_SetAnalogWDMonitChannels
CFGR1 AWDEN LL_ADC_SetAnalogWDMonitChannels
LL_ADC_GetAnalogWDMonitChannels
Function name
__STATIC_INLINE uint32_t
LL_ADC_GetAnalogWDMonitChannels (ADC_TypeDef *
ADCx)
Function description
Get ADC analog watchdog monitored channel.
Parameters
ADCx: ADC instance
DocID026525 Rev 6
655/1320
LL ADC Generic Driver
Return values
UM1785
Returned: value can be one of the following values:
LL_ADC_AWD_DISABLE
LL_ADC_AWD_ALL_CHANNELS_REG
LL_ADC_AWD_CHANNEL_0_REG
LL_ADC_AWD_CHANNEL_1_REG
LL_ADC_AWD_CHANNEL_2_REG
LL_ADC_AWD_CHANNEL_3_REG
LL_ADC_AWD_CHANNEL_4_REG
LL_ADC_AWD_CHANNEL_5_REG
LL_ADC_AWD_CHANNEL_6_REG
LL_ADC_AWD_CHANNEL_7_REG
LL_ADC_AWD_CHANNEL_8_REG
LL_ADC_AWD_CHANNEL_9_REG
LL_ADC_AWD_CHANNEL_10_REG
LL_ADC_AWD_CHANNEL_11_REG
LL_ADC_AWD_CHANNEL_12_REG
LL_ADC_AWD_CHANNEL_13_REG
LL_ADC_AWD_CHANNEL_14_REG
LL_ADC_AWD_CHANNEL_15_REG
LL_ADC_AWD_CHANNEL_16_REG
LL_ADC_AWD_CHANNEL_17_REG
LL_ADC_AWD_CHANNEL_18_REG
Notes
Usage of the returned channel number: To reinject this
channel into another function LL_ADC_xxx: the returned
channel number is only partly formatted on definition of literals
LL_ADC_CHANNEL_x. Therefore, it has to be compared with
parts of literals LL_ADC_CHANNEL_x or using helper macro
__LL_ADC_CHANNEL_TO_DECIMAL_NB(). Then the
selected literal LL_ADC_CHANNEL_x can be used as
parameter for another function.To get the channel number in
decimal format: process the returned value with the helper
macro __LL_ADC_CHANNEL_TO_DECIMAL_NB().
Applicable only when the analog watchdog is set to monitor
one channel.
On this STM32 serie, there is only 1 kind of analog watchdog
instance: AWD standard (instance AWD1): channels
monitored: can monitor 1 channel or all channels.groups
monitored: ADC group regular.resolution: resolution is not
limited (corresponds to ADC resolution configured).
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
conversion on going on group regular.
Reference Manual to
LL API cross
reference:
CFGR1 AWDCH LL_ADC_GetAnalogWDMonitChannels
CFGR1 AWDSGL LL_ADC_GetAnalogWDMonitChannels
CFGR1 AWDEN LL_ADC_GetAnalogWDMonitChannels
LL_ADC_ConfigAnalogWDThresholds
656/1320
Function name
__STATIC_INLINE void LL_ADC_ConfigAnalogWDThresholds
(ADC_TypeDef * ADCx, uint32_t AWDThresholdHighValue,
uint32_t AWDThresholdLowValue)
Function description
Set ADC analog watchdog thresholds value of both thresholds
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
high and low.
Parameters
ADCx: ADC instance
AWDThresholdHighValue: Value between
Min_Data=0x000 and Max_Data=0xFFF
AWDThresholdLowValue: Value between Min_Data=0x000
and Max_Data=0xFFF
Return values
None
Notes
If value of only one threshold high or low must be set, use
function LL_ADC_SetAnalogWDThresholds().
In case of ADC resolution different of 12 bits, analog
watchdog thresholds data require a specific shift. Use helper
macro
__LL_ADC_ANALOGWD_SET_THRESHOLD_RESOLUTIO
N().
On this STM32 serie, there is only 1 kind of analog watchdog
instance: AWD standard (instance AWD1): channels
monitored: can monitor 1 channel or all channels.groups
monitored: ADC group regular.resolution: resolution is not
limited (corresponds to ADC resolution configured).
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
conversion on going on group regular.
Reference Manual to
LL API cross
reference:
TR HT LL_ADC_ConfigAnalogWDThresholds
TR LT LL_ADC_ConfigAnalogWDThresholds
LL_ADC_SetAnalogWDThresholds
Function name
__STATIC_INLINE void LL_ADC_SetAnalogWDThresholds
(ADC_TypeDef * ADCx, uint32_t AWDThresholdsHighLow,
uint32_t AWDThresholdValue)
Function description
Set ADC analog watchdog threshold value of threshold high or
low.
Parameters
ADCx: ADC instance
AWDThresholdsHighLow: This parameter can be one of
the following values:
LL_ADC_AWD_THRESHOLD_HIGH
LL_ADC_AWD_THRESHOLD_LOW
AWDThresholdValue: Value between Min_Data=0x000 and
Max_Data=0xFFF
Return values
None
Notes
If values of both thresholds high or low must be set, use
function LL_ADC_ConfigAnalogWDThresholds().
In case of ADC resolution different of 12 bits, analog
watchdog thresholds data require a specific shift. Use helper
macro
__LL_ADC_ANALOGWD_SET_THRESHOLD_RESOLUTIO
N().
On this STM32 serie, there is only 1 kind of analog watchdog
instance: AWD standard (instance AWD1): channels
DocID026525 Rev 6
657/1320
LL ADC Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
monitored: can monitor 1 channel or all channels.groups
monitored: ADC group regular.resolution: resolution is not
limited (corresponds to ADC resolution configured).
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be disabled or enabled without
conversion on going on group regular.
TR HT LL_ADC_SetAnalogWDThresholds
TR LT LL_ADC_SetAnalogWDThresholds
LL_ADC_GetAnalogWDThresholds
Function name
__STATIC_INLINE uint32_t LL_ADC_GetAnalogWDThresholds
(ADC_TypeDef * ADCx, uint32_t AWDThresholdsHighLow)
Function description
Get ADC analog watchdog threshold value of threshold high,
threshold low or raw data with ADC thresholds high and low
concatenated.
Parameters
ADCx: ADC instance
AWDThresholdsHighLow: This parameter can be one of
the following values:
LL_ADC_AWD_THRESHOLD_HIGH
LL_ADC_AWD_THRESHOLD_LOW
LL_ADC_AWD_THRESHOLDS_HIGH_LOW
Return values
Value: between Min_Data=0x000 and Max_Data=0xFFF
Notes
If raw data with ADC thresholds high and low is retrieved, the
data of each threshold high or low can be isolated using
helper macro:
__LL_ADC_ANALOGWD_THRESHOLDS_HIGH_LOW().
In case of ADC resolution different of 12 bits, analog
watchdog thresholds data require a specific shift. Use helper
macro
__LL_ADC_ANALOGWD_GET_THRESHOLD_RESOLUTIO
N().
Reference Manual to
LL API cross
reference:
TR1 HT1 LL_ADC_GetAnalogWDThresholds
TR2 HT2 LL_ADC_GetAnalogWDThresholds
TR3 HT3 LL_ADC_GetAnalogWDThresholds
TR1 LT1 LL_ADC_GetAnalogWDThresholds
TR2 LT2 LL_ADC_GetAnalogWDThresholds
TR3 LT3 LL_ADC_GetAnalogWDThresholds
LL_ADC_Enable
658/1320
Function name
__STATIC_INLINE void LL_ADC_Enable (ADC_TypeDef *
ADCx)
Function description
Enable the selected ADC instance.
Parameters
ADCx: ADC instance
Return values
None
Notes
On this STM32 serie, after ADC enable, a delay for ADC
internal analog stabilization is required before performing a
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
ADC conversion start. Refer to device datasheet, parameter
tSTAB.
On this STM32 serie, flag LL_ADC_FLAG_ADRDY is raised
when the ADC is enabled and when conversion clock is
active. (not only core clock: this ADC has a dual clock
domain)
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be ADC disabled and ADC internal
voltage regulator enabled.
Reference Manual to
LL API cross
reference:
CR ADEN LL_ADC_Enable
LL_ADC_Disable
Function name
__STATIC_INLINE void LL_ADC_Disable (ADC_TypeDef *
ADCx)
Function description
Disable the selected ADC instance.
Parameters
ADCx: ADC instance
Return values
None
Notes
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be not disabled. Must be enabled
without conversion on going on group regular.
Reference Manual to
LL API cross
reference:
CR ADDIS LL_ADC_Disable
LL_ADC_IsEnabled
Function name
__STATIC_INLINE uint32_t LL_ADC_IsEnabled (ADC_TypeDef
* ADCx)
Function description
Get the selected ADC instance enable state.
Parameters
ADCx: ADC instance
Return values
0: ADC is disabled, 1: ADC is enabled.
Notes
On this STM32 serie, flag LL_ADC_FLAG_ADRDY is raised
when the ADC is enabled and when conversion clock is
active. (not only core clock: this ADC has a dual clock
domain)
Reference Manual to
LL API cross
reference:
CR ADEN LL_ADC_IsEnabled
LL_ADC_IsDisableOngoing
Function name
__STATIC_INLINE uint32_t LL_ADC_IsDisableOngoing
(ADC_TypeDef * ADCx)
Function description
Get the selected ADC instance disable state.
DocID026525 Rev 6
659/1320
LL ADC Generic Driver
Parameters
UM1785
ADCx: ADC instance
Return values
0: no ADC disable command on going.
Reference Manual to
LL API cross
reference:
CR ADDIS LL_ADC_IsDisableOngoing
LL_ADC_StartCalibration
Function name
__STATIC_INLINE void LL_ADC_StartCalibration
(ADC_TypeDef * ADCx)
Function description
Start ADC calibration in the mode single-ended or differential (for
devices with differential mode available).
Parameters
ADCx: ADC instance
Return values
None
Notes
On this STM32 serie, a minimum number of ADC clock cycles
are required between ADC end of calibration and ADC
enable. Refer to literal
LL_ADC_DELAY_CALIB_ENABLE_ADC_CYCLES.
In case of usage of ADC with DMA transfer: On this STM32
serie, ADC DMA transfer request should be disabled during
calibration: Calibration factor is available in data register and
also transfered by DMA. To not insert ADC calibration factor
among ADC conversion data in array variable, DMA transfer
must be disabled during calibration. (DMA transfer setting
backup and disable before calibration, DMA transfer setting
restore after calibration. Refer to functions
LL_ADC_REG_GetDMATransfer(),
LL_ADC_REG_SetDMATransfer() ).
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be ADC disabled.
Reference Manual to
LL API cross
reference:
CR ADCAL LL_ADC_StartCalibration
LL_ADC_IsCalibrationOnGoing
660/1320
Function name
__STATIC_INLINE uint32_t LL_ADC_IsCalibrationOnGoing
(ADC_TypeDef * ADCx)
Function description
Get ADC calibration state.
Parameters
ADCx: ADC instance
Return values
0: calibration complete, 1: calibration in progress.
Reference Manual to
LL API cross
reference:
CR ADCAL LL_ADC_IsCalibrationOnGoing
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
LL_ADC_REG_StartConversion
Function name
__STATIC_INLINE void LL_ADC_REG_StartConversion
(ADC_TypeDef * ADCx)
Function description
Start ADC group regular conversion.
Parameters
ADCx: ADC instance
Return values
None
Notes
On this STM32 serie, this function is relevant for both internal
trigger (SW start) and external trigger: If ADC trigger has
been set to software start, ADC conversion starts
immediately.If ADC trigger has been set to external trigger,
ADC conversion will start at next trigger event (on the
selected trigger edge) following the ADC start conversion
command.
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be enabled without conversion on
going on group regular, without conversion stop command on
going on group regular, without ADC disable command on
going.
Reference Manual to
LL API cross
reference:
CR ADSTART LL_ADC_REG_StartConversion
LL_ADC_REG_StopConversion
Function name
__STATIC_INLINE void LL_ADC_REG_StopConversion
(ADC_TypeDef * ADCx)
Function description
Stop ADC group regular conversion.
Parameters
ADCx: ADC instance
Return values
None
Notes
On this STM32 serie, setting of this feature is conditioned to
ADC state: ADC must be enabled with conversion on going
on group regular, without ADC disable command on going.
Reference Manual to
LL API cross
reference:
CR ADSTP LL_ADC_REG_StopConversion
LL_ADC_REG_IsConversionOngoing
Function name
__STATIC_INLINE uint32_t
LL_ADC_REG_IsConversionOngoing (ADC_TypeDef * ADCx)
Function description
Get ADC group regular conversion state.
Parameters
ADCx: ADC instance
Return values
0: no conversion is on going on ADC group regular.
Reference Manual to
LL API cross
reference:
CR ADSTART LL_ADC_REG_IsConversionOngoing
DocID026525 Rev 6
661/1320
LL ADC Generic Driver
UM1785
LL_ADC_REG_IsStopConversionOngoing
Function name
__STATIC_INLINE uint32_t
LL_ADC_REG_IsStopConversionOngoing (ADC_TypeDef *
ADCx)
Function description
Get ADC group regular command of conversion stop state.
Parameters
ADCx: ADC instance
Return values
0: no command of conversion stop is on going on ADC group
regular.
Reference Manual to
LL API cross
reference:
CR ADSTP LL_ADC_REG_IsStopConversionOngoing
LL_ADC_REG_ReadConversionData32
Function name
__STATIC_INLINE uint32_t
LL_ADC_REG_ReadConversionData32 (ADC_TypeDef *
ADCx)
Function description
Get ADC group regular conversion data, range fit for all ADC
configurations: all ADC resolutions and all oversampling increased
data width (for devices with feature oversampling).
Parameters
ADCx: ADC instance
Return values
Value: between Min_Data=0x00000000 and
Max_Data=0xFFFFFFFF
Reference Manual to
LL API cross
reference:
DR DATA LL_ADC_REG_ReadConversionData32
LL_ADC_REG_ReadConversionData12
662/1320
Function name
__STATIC_INLINE uint16_t
LL_ADC_REG_ReadConversionData12 (ADC_TypeDef *
ADCx)
Function description
Get ADC group regular conversion data, range fit for ADC
resolution 12 bits.
Parameters
ADCx: ADC instance
Return values
Value: between Min_Data=0x000 and Max_Data=0xFFF
Notes
For devices with feature oversampling: Oversampling can
increase data width, function for extended range may be
needed: LL_ADC_REG_ReadConversionData32.
Reference Manual to
LL API cross
reference:
DR DATA LL_ADC_REG_ReadConversionData12
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
LL_ADC_REG_ReadConversionData10
Function name
__STATIC_INLINE uint16_t
LL_ADC_REG_ReadConversionData10 (ADC_TypeDef *
ADCx)
Function description
Get ADC group regular conversion data, range fit for ADC
resolution 10 bits.
Parameters
ADCx: ADC instance
Return values
Value: between Min_Data=0x000 and Max_Data=0x3FF
Notes
For devices with feature oversampling: Oversampling can
increase data width, function for extended range may be
needed: LL_ADC_REG_ReadConversionData32.
Reference Manual to
LL API cross
reference:
DR DATA LL_ADC_REG_ReadConversionData10
LL_ADC_REG_ReadConversionData8
Function name
__STATIC_INLINE uint8_t
LL_ADC_REG_ReadConversionData8 (ADC_TypeDef * ADCx)
Function description
Get ADC group regular conversion data, range fit for ADC
resolution 8 bits.
Parameters
ADCx: ADC instance
Return values
Value: between Min_Data=0x00 and Max_Data=0xFF
Notes
For devices with feature oversampling: Oversampling can
increase data width, function for extended range may be
needed: LL_ADC_REG_ReadConversionData32.
Reference Manual to
LL API cross
reference:
DR DATA LL_ADC_REG_ReadConversionData8
LL_ADC_REG_ReadConversionData6
Function name
__STATIC_INLINE uint8_t
LL_ADC_REG_ReadConversionData6 (ADC_TypeDef * ADCx)
Function description
Get ADC group regular conversion data, range fit for ADC
resolution 6 bits.
Parameters
ADCx: ADC instance
Return values
Value: between Min_Data=0x00 and Max_Data=0x3F
Notes
For devices with feature oversampling: Oversampling can
increase data width, function for extended range may be
needed: LL_ADC_REG_ReadConversionData32.
Reference Manual to
LL API cross
reference:
DR DATA LL_ADC_REG_ReadConversionData6
DocID026525 Rev 6
663/1320
LL ADC Generic Driver
UM1785
LL_ADC_IsActiveFlag_ADRDY
Function name
__STATIC_INLINE uint32_t LL_ADC_IsActiveFlag_ADRDY
(ADC_TypeDef * ADCx)
Function description
Get flag ADC ready.
Parameters
ADCx: ADC instance
Return values
State: of bit (1 or 0).
Notes
On this STM32 serie, flag LL_ADC_FLAG_ADRDY is raised
when the ADC is enabled and when conversion clock is
active. (not only core clock: this ADC has a dual clock
domain)
Reference Manual to
LL API cross
reference:
ISR ADRDY LL_ADC_IsActiveFlag_ADRDY
LL_ADC_IsActiveFlag_EOC
Function name
__STATIC_INLINE uint32_t LL_ADC_IsActiveFlag_EOC
(ADC_TypeDef * ADCx)
Function description
Get flag ADC group regular end of unitary conversion.
Parameters
ADCx: ADC instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR EOC LL_ADC_IsActiveFlag_EOC
LL_ADC_IsActiveFlag_EOS
Function name
__STATIC_INLINE uint32_t LL_ADC_IsActiveFlag_EOS
(ADC_TypeDef * ADCx)
Function description
Get flag ADC group regular end of sequence conversions.
Parameters
ADCx: ADC instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR EOSEQ LL_ADC_IsActiveFlag_EOS
LL_ADC_IsActiveFlag_OVR
664/1320
Function name
__STATIC_INLINE uint32_t LL_ADC_IsActiveFlag_OVR
(ADC_TypeDef * ADCx)
Function description
Get flag ADC group regular overrun.
Parameters
ADCx: ADC instance
Return values
State: of bit (1 or 0).
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
Reference Manual to
LL API cross
reference:
ISR OVR LL_ADC_IsActiveFlag_OVR
LL_ADC_IsActiveFlag_EOSMP
Function name
__STATIC_INLINE uint32_t LL_ADC_IsActiveFlag_EOSMP
(ADC_TypeDef * ADCx)
Function description
Get flag ADC group regular end of sampling phase.
Parameters
ADCx: ADC instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR EOSMP LL_ADC_IsActiveFlag_EOSMP
LL_ADC_IsActiveFlag_AWD1
Function name
__STATIC_INLINE uint32_t LL_ADC_IsActiveFlag_AWD1
(ADC_TypeDef * ADCx)
Function description
Get flag ADC analog watchdog 1 flag.
Parameters
ADCx: ADC instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR AWD LL_ADC_IsActiveFlag_AWD1
LL_ADC_ClearFlag_ADRDY
Function name
__STATIC_INLINE void LL_ADC_ClearFlag_ADRDY
(ADC_TypeDef * ADCx)
Function description
Clear flag ADC ready.
Parameters
ADCx: ADC instance
Return values
None
Notes
On this STM32 serie, flag LL_ADC_FLAG_ADRDY is raised
when the ADC is enabled and when conversion clock is
active. (not only core clock: this ADC has a dual clock
domain)
Reference Manual to
LL API cross
reference:
ISR ADRDY LL_ADC_ClearFlag_ADRDY
LL_ADC_ClearFlag_EOC
Function name
__STATIC_INLINE void LL_ADC_ClearFlag_EOC
(ADC_TypeDef * ADCx)
Function description
Clear flag ADC group regular end of unitary conversion.
DocID026525 Rev 6
665/1320
LL ADC Generic Driver
Parameters
UM1785
ADCx: ADC instance
Return values
None
Reference Manual to
LL API cross
reference:
ISR EOC LL_ADC_ClearFlag_EOC
LL_ADC_ClearFlag_EOS
Function name
__STATIC_INLINE void LL_ADC_ClearFlag_EOS
(ADC_TypeDef * ADCx)
Function description
Clear flag ADC group regular end of sequence conversions.
Parameters
ADCx: ADC instance
Return values
None
Reference Manual to
LL API cross
reference:
ISR EOSEQ LL_ADC_ClearFlag_EOS
LL_ADC_ClearFlag_OVR
Function name
__STATIC_INLINE void LL_ADC_ClearFlag_OVR
(ADC_TypeDef * ADCx)
Function description
Clear flag ADC group regular overrun.
Parameters
ADCx: ADC instance
Return values
None
Reference Manual to
LL API cross
reference:
ISR OVR LL_ADC_ClearFlag_OVR
LL_ADC_ClearFlag_EOSMP
Function name
__STATIC_INLINE void LL_ADC_ClearFlag_EOSMP
(ADC_TypeDef * ADCx)
Function description
Clear flag ADC group regular end of sampling phase.
Parameters
ADCx: ADC instance
Return values
None
Reference Manual to
LL API cross
reference:
ISR EOSMP LL_ADC_ClearFlag_EOSMP
LL_ADC_ClearFlag_AWD1
Function name
__STATIC_INLINE void LL_ADC_ClearFlag_AWD1
(ADC_TypeDef * ADCx)
Function description
Clear flag ADC analog watchdog 1.
Parameters
666/1320
ADCx: ADC instance
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
Return values
None
Reference Manual to
LL API cross
reference:
ISR AWD LL_ADC_ClearFlag_AWD1
LL_ADC_EnableIT_ADRDY
Function name
__STATIC_INLINE void LL_ADC_EnableIT_ADRDY
(ADC_TypeDef * ADCx)
Function description
Enable ADC ready.
Parameters
ADCx: ADC instance
Return values
None
Reference Manual to
LL API cross
reference:
IER ADRDYIE LL_ADC_EnableIT_ADRDY
LL_ADC_EnableIT_EOC
Function name
__STATIC_INLINE void LL_ADC_EnableIT_EOC
(ADC_TypeDef * ADCx)
Function description
Enable interruption ADC group regular end of unitary conversion.
Parameters
ADCx: ADC instance
Return values
None
Reference Manual to
LL API cross
reference:
IER EOCIE LL_ADC_EnableIT_EOC
LL_ADC_EnableIT_EOS
Function name
__STATIC_INLINE void LL_ADC_EnableIT_EOS
(ADC_TypeDef * ADCx)
Function description
Enable interruption ADC group regular end of sequence
conversions.
Parameters
ADCx: ADC instance
Return values
None
Reference Manual to
LL API cross
reference:
IER EOSEQIE LL_ADC_EnableIT_EOS
LL_ADC_EnableIT_OVR
Function name
__STATIC_INLINE void LL_ADC_EnableIT_OVR
(ADC_TypeDef * ADCx)
Function description
Enable ADC group regular interruption overrun.
Parameters
ADCx: ADC instance
DocID026525 Rev 6
667/1320
LL ADC Generic Driver
Return values
UM1785
None
Reference Manual to
LL API cross
reference:
IER OVRIE LL_ADC_EnableIT_OVR
LL_ADC_EnableIT_EOSMP
Function name
__STATIC_INLINE void LL_ADC_EnableIT_EOSMP
(ADC_TypeDef * ADCx)
Function description
Enable interruption ADC group regular end of sampling.
Parameters
ADCx: ADC instance
Return values
None
Reference Manual to
LL API cross
reference:
IER EOSMPIE LL_ADC_EnableIT_EOSMP
LL_ADC_EnableIT_AWD1
Function name
__STATIC_INLINE void LL_ADC_EnableIT_AWD1
(ADC_TypeDef * ADCx)
Function description
Enable interruption ADC analog watchdog 1.
Parameters
ADCx: ADC instance
Return values
None
Reference Manual to
LL API cross
reference:
IER AWDIE LL_ADC_EnableIT_AWD1
LL_ADC_DisableIT_ADRDY
Function name
__STATIC_INLINE void LL_ADC_DisableIT_ADRDY
(ADC_TypeDef * ADCx)
Function description
Disable interruption ADC ready.
Parameters
ADCx: ADC instance
Return values
None
Reference Manual to
LL API cross
reference:
IER ADRDYIE LL_ADC_DisableIT_ADRDY
LL_ADC_DisableIT_EOC
668/1320
Function name
__STATIC_INLINE void LL_ADC_DisableIT_EOC
(ADC_TypeDef * ADCx)
Function description
Disable interruption ADC group regular end of unitary conversion.
Parameters
ADCx: ADC instance
Return values
None
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
Reference Manual to
LL API cross
reference:
IER EOCIE LL_ADC_DisableIT_EOC
LL_ADC_DisableIT_EOS
Function name
__STATIC_INLINE void LL_ADC_DisableIT_EOS
(ADC_TypeDef * ADCx)
Function description
Disable interruption ADC group regular end of sequence
conversions.
Parameters
ADCx: ADC instance
Return values
None
Reference Manual to
LL API cross
reference:
IER EOSEQIE LL_ADC_DisableIT_EOS
LL_ADC_DisableIT_OVR
Function name
__STATIC_INLINE void LL_ADC_DisableIT_OVR
(ADC_TypeDef * ADCx)
Function description
Disable interruption ADC group regular overrun.
Parameters
ADCx: ADC instance
Return values
None
Reference Manual to
LL API cross
reference:
IER OVRIE LL_ADC_DisableIT_OVR
LL_ADC_DisableIT_EOSMP
Function name
__STATIC_INLINE void LL_ADC_DisableIT_EOSMP
(ADC_TypeDef * ADCx)
Function description
Disable interruption ADC group regular end of sampling.
Parameters
ADCx: ADC instance
Return values
None
Reference Manual to
LL API cross
reference:
IER EOSMPIE LL_ADC_DisableIT_EOSMP
LL_ADC_DisableIT_AWD1
Function name
__STATIC_INLINE void LL_ADC_DisableIT_AWD1
(ADC_TypeDef * ADCx)
Function description
Disable interruption ADC analog watchdog 1.
Parameters
ADCx: ADC instance
Return values
None
DocID026525 Rev 6
669/1320
LL ADC Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
IER AWDIE LL_ADC_DisableIT_AWD1
LL_ADC_IsEnabledIT_ADRDY
Function name
__STATIC_INLINE uint32_t LL_ADC_IsEnabledIT_ADRDY
(ADC_TypeDef * ADCx)
Function description
Get state of interruption ADC ready (0: interrupt disabled, 1:
interrupt enabled).
Parameters
ADCx: ADC instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
IER ADRDYIE LL_ADC_IsEnabledIT_ADRDY
LL_ADC_IsEnabledIT_EOC
Function name
__STATIC_INLINE uint32_t LL_ADC_IsEnabledIT_EOC
(ADC_TypeDef * ADCx)
Function description
Get state of interruption ADC group regular end of unitary
conversion (0: interrupt disabled, 1: interrupt enabled).
Parameters
ADCx: ADC instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
IER EOCIE LL_ADC_IsEnabledIT_EOC
LL_ADC_IsEnabledIT_EOS
Function name
__STATIC_INLINE uint32_t LL_ADC_IsEnabledIT_EOS
(ADC_TypeDef * ADCx)
Function description
Get state of interruption ADC group regular end of sequence
conversions (0: interrupt disabled, 1: interrupt enabled).
Parameters
ADCx: ADC instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
IER EOSEQIE LL_ADC_IsEnabledIT_EOS
LL_ADC_IsEnabledIT_OVR
Function name
__STATIC_INLINE uint32_t LL_ADC_IsEnabledIT_OVR
(ADC_TypeDef * ADCx)
Function description
Get state of interruption ADC group regular overrun (0: interrupt
disabled, 1: interrupt enabled).
Parameters
670/1320
ADCx: ADC instance
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
IER OVRIE LL_ADC_IsEnabledIT_OVR
LL_ADC_IsEnabledIT_EOSMP
Function name
__STATIC_INLINE uint32_t LL_ADC_IsEnabledIT_EOSMP
(ADC_TypeDef * ADCx)
Function description
Get state of interruption ADC group regular end of sampling (0:
interrupt disabled, 1: interrupt enabled).
Parameters
ADCx: ADC instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
IER EOSMPIE LL_ADC_IsEnabledIT_EOSMP
LL_ADC_IsEnabledIT_AWD1
Function name
__STATIC_INLINE uint32_t LL_ADC_IsEnabledIT_AWD1
(ADC_TypeDef * ADCx)
Function description
Get state of interruption ADC analog watchdog 1 (0: interrupt
disabled, 1: interrupt enabled).
Parameters
ADCx: ADC instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
IER AWDIE LL_ADC_IsEnabledIT_AWD1
LL_ADC_CommonDeInit
Function name
ErrorStatus LL_ADC_CommonDeInit (ADC_Common_TypeDef
* ADCxy_COMMON)
Function description
De-initialize registers of all ADC instances belonging to the same
ADC common instance to their default reset values.
Parameters
ADCxy_COMMON: ADC common instance (can be set
directly from CMSIS definition or by using helper macro
__LL_ADC_COMMON_INSTANCE() )
Return values
An: ErrorStatus enumeration value:
SUCCESS: ADC common registers are de-initialized
ERROR: not applicable
Notes
This function is performing a hard reset, using high level clock
source RCC ADC reset.
DocID026525 Rev 6
671/1320
LL ADC Generic Driver
UM1785
LL_ADC_DeInit
Function name
ErrorStatus LL_ADC_DeInit (ADC_TypeDef * ADCx)
Function description
De-initialize registers of the selected ADC instance to their default
reset values.
Parameters
ADCx: ADC instance
Return values
An: ErrorStatus enumeration value:
SUCCESS: ADC registers are de-initialized
ERROR: ADC registers are not de-initialized
Notes
To reset all ADC instances quickly (perform a hard reset), use
function LL_ADC_CommonDeInit().
If this functions returns error status, it means that ADC
instance is in an unknown state. In this case, perform a hard
reset using high level clock source RCC ADC reset. Refer to
function LL_ADC_CommonDeInit().
LL_ADC_Init
672/1320
Function name
ErrorStatus LL_ADC_Init (ADC_TypeDef * ADCx,
LL_ADC_InitTypeDef * ADC_InitStruct)
Function description
Initialize some features of ADC instance.
Parameters
ADCx: ADC instance
ADC_InitStruct: Pointer to a LL_ADC_REG_InitTypeDef
structure
Return values
An: ErrorStatus enumeration value:
SUCCESS: ADC registers are initialized
ERROR: ADC registers are not initialized
Notes
These parameters have an impact on ADC scope: ADC
instance. Refer to corresponding unitary functions into
Configuration of ADC hierarchical scope: ADC instance .
The setting of these parameters by function LL_ADC_Init() is
conditioned to ADC state: ADC instance must be disabled.
This condition is applied to all ADC features, for efficiency and
compatibility over all STM32 families. However, the different
features can be set under different ADC state conditions
(setting possible with ADC enabled without conversion on
going, ADC enabled with conversion on going, ...) Each
feature can be updated afterwards with a unitary function and
potentially with ADC in a different state than disabled, refer to
description of each function for setting conditioned to ADC
state.
After using this function, some other features must be
configured using LL unitary functions. The minimum
configuration remaining to be done is: Set ADC group regular
sequencer: map channel on rank corresponding to channel
number. Refer to function
LL_ADC_REG_SetSequencerChannels();Set ADC channel
sampling time Refer to function
LL_ADC_SetChannelSamplingTime();
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
LL_ADC_StructInit
Function name
void LL_ADC_StructInit (LL_ADC_InitTypeDef *
ADC_InitStruct)
Function description
Set each LL_ADC_InitTypeDef field to default value.
Parameters
ADC_InitStruct: Pointer to a LL_ADC_InitTypeDef structure
whose fields will be set to default values.
Return values
None
LL_ADC_REG_Init
Function name
ErrorStatus LL_ADC_REG_Init (ADC_TypeDef * ADCx,
LL_ADC_REG_InitTypeDef * ADC_REG_InitStruct)
Function description
Initialize some features of ADC group regular.
Parameters
ADCx: ADC instance
ADC_REG_InitStruct: Pointer to a
LL_ADC_REG_InitTypeDef structure
Return values
An: ErrorStatus enumeration value:
SUCCESS: ADC registers are initialized
ERROR: ADC registers are not initialized
Notes
These parameters have an impact on ADC scope: ADC group
regular. Refer to corresponding unitary functions into
Configuration of ADC hierarchical scope: group regular
(functions with prefix "REG").
The setting of these parameters by function LL_ADC_Init() is
conditioned to ADC state: ADC instance must be disabled.
This condition is applied to all ADC features, for efficiency and
compatibility over all STM32 families. However, the different
features can be set under different ADC state conditions
(setting possible with ADC enabled without conversion on
going, ADC enabled with conversion on going, ...) Each
feature can be updated afterwards with a unitary function and
potentially with ADC in a different state than disabled, refer to
description of each function for setting conditioned to ADC
state.
After using this function, other features must be configured
using LL unitary functions. The minimum configuration
remaining to be done is: Set ADC group regular sequencer:
map channel on rank corresponding to channel number.
Refer to function
LL_ADC_REG_SetSequencerChannels();Set ADC channel
sampling time Refer to function
LL_ADC_SetChannelSamplingTime();
LL_ADC_REG_StructInit
Function name
void LL_ADC_REG_StructInit (LL_ADC_REG_InitTypeDef *
ADC_REG_InitStruct)
Function description
Set each LL_ADC_REG_InitTypeDef field to default value.
Parameters
ADC_REG_InitStruct: Pointer to a
DocID026525 Rev 6
673/1320
LL ADC Generic Driver
Return values
UM1785
LL_ADC_REG_InitTypeDef structure whose fields will be set
to default values.
None
49.3
ADC Firmware driver defines
49.3.1
ADC
Analog watchdog - Monitored channels
674/1320
LL_ADC_AWD_DISABLE
ADC analog watchdog monitoring disabled
LL_ADC_AWD_ALL_CHANNELS_REG
ADC analog watchdog monitoring of all
channels, converted by group regular only
LL_ADC_AWD_CHANNEL_0_REG
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN0, converted by group regular
only
LL_ADC_AWD_CHANNEL_1_REG
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN1, converted by group regular
only
LL_ADC_AWD_CHANNEL_2_REG
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN2, converted by group regular
only
LL_ADC_AWD_CHANNEL_3_REG
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN3, converted by group regular
only
LL_ADC_AWD_CHANNEL_4_REG
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN4, converted by group regular
only
LL_ADC_AWD_CHANNEL_5_REG
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN5, converted by group regular
only
LL_ADC_AWD_CHANNEL_6_REG
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN6, converted by group regular
only
LL_ADC_AWD_CHANNEL_7_REG
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN7, converted by group regular
only
LL_ADC_AWD_CHANNEL_8_REG
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN8, converted by group regular
only
DocID026525 Rev 6
UM1785
LL_ADC_AWD_CHANNEL_9_REG
LL ADC Generic Driver
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN9, converted by group regular
only
LL_ADC_AWD_CHANNEL_10_REG
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN10, converted by group regular
only
LL_ADC_AWD_CHANNEL_11_REG
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN11, converted by group regular
only
LL_ADC_AWD_CHANNEL_12_REG
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN12, converted by group regular
only
LL_ADC_AWD_CHANNEL_13_REG
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN13, converted by group regular
only
LL_ADC_AWD_CHANNEL_14_REG
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN14, converted by group regular
only
LL_ADC_AWD_CHANNEL_15_REG
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN15, converted by group regular
only
LL_ADC_AWD_CHANNEL_16_REG
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN16, converted by group regular
only
LL_ADC_AWD_CHANNEL_17_REG
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN17, converted by group regular
only
LL_ADC_AWD_CH_VREFINT_REG
ADC analog watchdog monitoring of ADC
internal channel connected to VrefInt: Internal
voltage reference, converted by group regular
only
LL_ADC_AWD_CH_TEMPSENSOR_REG
ADC analog watchdog monitoring of ADC
internal channel connected to Temperature
sensor, converted by group regular only
LL_ADC_AWD_CHANNEL_18_REG
ADC analog watchdog monitoring of ADC
external channel (channel connected to GPIO
pin) ADCx_IN18, converted by group regular
only
LL_ADC_AWD_CH_VBAT_REG
ADC analog watchdog monitoring of ADC
internal channel connected to Vbat/3: Vbat
DocID026525 Rev 6
675/1320
LL ADC Generic Driver
UM1785
voltage through a divider ladder of factor 1/3
to have Vbat always below Vdda, converted
by group regular only
Analog watchdog - Analog watchdog number
LL_ADC_AWD1
ADC analog watchdog number 1
Analog watchdog - Thresholds
LL_ADC_AWD_THRESHOLD_HIGH
ADC analog watchdog threshold high
LL_ADC_AWD_THRESHOLD_LOW
ADC analog watchdog threshold low
LL_ADC_AWD_THRESHOLDS_HIGH_LOW
ADC analog watchdog both thresholds high
and low concatenated into the same data
ADC instance - Channel number
676/1320
LL_ADC_CHANNEL_0
ADC external channel (channel connected to GPIO
pin) ADCx_IN0
LL_ADC_CHANNEL_1
ADC external channel (channel connected to GPIO
pin) ADCx_IN1
LL_ADC_CHANNEL_2
ADC external channel (channel connected to GPIO
pin) ADCx_IN2
LL_ADC_CHANNEL_3
ADC external channel (channel connected to GPIO
pin) ADCx_IN3
LL_ADC_CHANNEL_4
ADC external channel (channel connected to GPIO
pin) ADCx_IN4
LL_ADC_CHANNEL_5
ADC external channel (channel connected to GPIO
pin) ADCx_IN5
LL_ADC_CHANNEL_6
ADC external channel (channel connected to GPIO
pin) ADCx_IN6
LL_ADC_CHANNEL_7
ADC external channel (channel connected to GPIO
pin) ADCx_IN7
LL_ADC_CHANNEL_8
ADC external channel (channel connected to GPIO
pin) ADCx_IN8
LL_ADC_CHANNEL_9
ADC external channel (channel connected to GPIO
pin) ADCx_IN9
LL_ADC_CHANNEL_10
ADC external channel (channel connected to GPIO
pin) ADCx_IN10
LL_ADC_CHANNEL_11
ADC external channel (channel connected to GPIO
pin) ADCx_IN11
LL_ADC_CHANNEL_12
ADC external channel (channel connected to GPIO
pin) ADCx_IN12
LL_ADC_CHANNEL_13
ADC external channel (channel connected to GPIO
pin) ADCx_IN13
LL_ADC_CHANNEL_14
ADC external channel (channel connected to GPIO
pin) ADCx_IN14
LL_ADC_CHANNEL_15
ADC external channel (channel connected to GPIO
pin) ADCx_IN15
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
ADC external channel (channel connected to GPIO
pin) ADCx_IN16
LL_ADC_CHANNEL_16
LL_ADC_CHANNEL_17
ADC external channel (channel connected to GPIO
pin) ADCx_IN17
LL_ADC_CHANNEL_VREFINT
ADC internal channel connected to VrefInt: Internal
voltage reference.
LL_ADC_CHANNEL_TEMPSENSOR
ADC internal channel connected to Temperature
sensor.
LL_ADC_CHANNEL_18
ADC external channel (channel connected to GPIO
pin) ADCx_IN18
LL_ADC_CHANNEL_VBAT
ADC internal channel connected to Vbat/2: Vbat
voltage through a divider ladder of factor 1/2 to
have Vbat always below Vdda.
Channel - Sampling time
LL_ADC_SAMPLINGTIME_1CYCLE_5
Sampling time 1.5 ADC clock cycle
LL_ADC_SAMPLINGTIME_7CYCLES_5
Sampling time 7.5 ADC clock cycles
LL_ADC_SAMPLINGTIME_13CYCLES_5
Sampling time 13.5 ADC clock cycles
LL_ADC_SAMPLINGTIME_28CYCLES_5
Sampling time 28.5 ADC clock cycles
LL_ADC_SAMPLINGTIME_41CYCLES_5
Sampling time 41.5 ADC clock cycles
LL_ADC_SAMPLINGTIME_55CYCLES_5
Sampling time 55.5 ADC clock cycles
LL_ADC_SAMPLINGTIME_71CYCLES_5
Sampling time 71.5 ADC clock cycles
LL_ADC_SAMPLINGTIME_239CYCLES_5
Sampling time 239.5 ADC clock cycles
ADC instance - Clock source
LL_ADC_CLOCK_SYNC_PCLK_DIV4
ADC synchronous clock derived from AHB clock
divided by 4
LL_ADC_CLOCK_SYNC_PCLK_DIV2
ADC synchronous clock derived from AHB clock
divided by 2
LL_ADC_CLOCK_ASYNC
ADC asynchronous clock. On this STM32 serie,
asynchronous clock has no prescaler.
ADC common - Measurement path to internal channels
LL_ADC_PATH_INTERNAL_NONE
ADC measurement pathes all disabled
LL_ADC_PATH_INTERNAL_VREFINT
ADC measurement path to internal channel
VrefInt
LL_ADC_PATH_INTERNAL_TEMPSENSOR
ADC measurement path to internal channel
temperature sensor
LL_ADC_PATH_INTERNAL_VBAT
ADC measurement path to internal channel
Vbat
ADC instance - Data alignment
LL_ADC_DATA_ALIGN_RIGHT
ADC conversion data alignment: right aligned (alignment
on data register LSB bit 0)
LL_ADC_DATA_ALIGN_LEFT
ADC conversion data alignment: left aligned (aligment
DocID026525 Rev 6
677/1320
LL ADC Generic Driver
UM1785
on data register MSB bit 15)
ADC flags
LL_ADC_FLAG_ADRDY
ADC flag ADC instance ready
LL_ADC_FLAG_EOC
ADC flag ADC group regular end of unitary conversion
LL_ADC_FLAG_EOS
ADC flag ADC group regular end of sequence conversions
LL_ADC_FLAG_OVR
ADC flag ADC group regular overrun
LL_ADC_FLAG_EOSMP
ADC flag ADC group regular end of sampling phase
LL_ADC_FLAG_AWD1
ADC flag ADC analog watchdog 1
ADC instance - Groups
LL_ADC_GROUP_REGULAR
ADC group regular (available on all STM32 devices)
Definitions of ADC hardware constraints delays
LL_ADC_DELAY_VREFINT_STAB_US
Delay for internal voltage reference
stabilization time
LL_ADC_DELAY_TEMPSENSOR_STAB_US
Delay for temperature sensor
stabilization time
LL_ADC_DELAY_CALIB_ENABLE_ADC_CYCLES
Delay required between ADC end of
calibration and ADC enable
ADC interruptions for configuration (interruption enable or disable)
LL_ADC_IT_ADRDY
ADC interruption ADC instance ready
LL_ADC_IT_EOC
ADC interruption ADC group regular end of unitary conversion
LL_ADC_IT_EOS
ADC interruption ADC group regular end of sequence conversions
LL_ADC_IT_OVR
ADC interruption ADC group regular overrun
LL_ADC_IT_EOSMP
ADC interruption ADC group regular end of sampling phase
LL_ADC_IT_AWD1
ADC interruption ADC analog watchdog 1
ADC instance - Low power mode
678/1320
LL_ADC_LP_MODE_NONE
No ADC low power mode activated
LL_ADC_LP_AUTOWAIT
ADC low power mode auto delay:
Dynamic low power mode, ADC
conversions are performed only when
necessary (when previous ADC
conversion data is read). See description
with function
LL_ADC_LP_AUTOPOWEROFF
ADC low power mode auto power-off: the
ADC automatically powers-off after a ADC
conversion and automatically wakes up
when a new ADC conversion is triggered
(with startup time between trigger and
start of sampling). See description with
function
LL_ADC_LP_AUTOWAIT_AUTOPOWEROFF
ADC low power modes auto wait and auto
power-off combined. See description with
function
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
ADC registers compliant with specific purpose
LL_ADC_DMA_REG_REGULAR_DATA
ADC group regular - Continuous mode
LL_ADC_REG_CONV_SINGLE
ADC conversions are performed in single mode:
one conversion per trigger
LL_ADC_REG_CONV_CONTINUOUS
ADC conversions are performed in continuous
mode: after the first trigger, following conversions
launched successively automatically
ADC group regular - DMA transfer of ADC conversion data
LL_ADC_REG_DMA_TRANSFER_NONE
ADC conversions are not transferred by
DMA
LL_ADC_REG_DMA_TRANSFER_LIMITED
ADC conversion data are transferred by
DMA, in limited mode (one shot mode):
DMA transfer requests are stopped
when number of DMA data transfers
(number of ADC conversions) is
reached. This ADC mode is intended to
be used with DMA mode non-circular.
LL_ADC_REG_DMA_TRANSFER_UNLIMITED
ADC conversion data are transferred by
DMA, in unlimited mode: DMA transfer
requests are unlimited, whatever number
of DMA data transferred (number of
ADC conversions). This ADC mode is
intended to be used with DMA mode
circular.
ADC group regular - Overrun behavior on conversion data
LL_ADC_REG_OVR_DATA_PRESERVED
ADC group regular behavior in case of
overrun: data preserved
LL_ADC_REG_OVR_DATA_OVERWRITTEN
ADC group regular behavior in case of
overrun: data overwritten
ADC group regular - Sequencer discontinuous mode
LL_ADC_REG_SEQ_DISCONT_DISABLE
ADC group regular sequencer discontinuous
mode disable
LL_ADC_REG_SEQ_DISCONT_1RANK
ADC group regular sequencer discontinuous
mode enable with sequence interruption
every rank
ADC group regular - Sequencer scan direction
LL_ADC_REG_SEQ_SCAN_DIR_FORWARD
ADC group regular sequencer scan
direction forward: from lowest channel
number to highest channel number (scan
of all ranks, ADC conversion of ranks
with channels enabled in sequencer). On
some other STM32 families, this setting
is not available and the default scan
direction is forward.
LL_ADC_REG_SEQ_SCAN_DIR_BACKWARD
ADC group regular sequencer scan
direction backward: from highest channel
DocID026525 Rev 6
679/1320
LL ADC Generic Driver
UM1785
number to lowest channel number (scan
of all ranks, ADC conversion of ranks
with channels enabled in sequencer)
ADC group regular - Trigger edge
LL_ADC_REG_TRIG_EXT_RISING
ADC group regular conversion trigger
polarity set to rising edge
LL_ADC_REG_TRIG_EXT_FALLING
ADC group regular conversion trigger
polarity set to falling edge
LL_ADC_REG_TRIG_EXT_RISINGFALLING
ADC group regular conversion trigger
polarity set to both rising and falling edges
ADC group regular - Trigger source
LL_ADC_REG_TRIG_SOFTWARE
ADC group regular conversion trigger internal:
SW start.
LL_ADC_REG_TRIG_EXT_TIM1_TRGO
ADC group regular conversion trigger from
external IP: TIM1 TRGO. Trigger edge set to
rising edge (default setting).
LL_ADC_REG_TRIG_EXT_TIM1_CH4
ADC group regular conversion trigger from
external IP: TIM1 channel 4 event (capture
compare: input capture or output capture).
Trigger edge set to rising edge (default
setting).
LL_ADC_REG_TRIG_EXT_TIM2_TRGO
ADC group regular conversion trigger from
external IP: TIM2 TRGO. Trigger edge set to
rising edge (default setting).
LL_ADC_REG_TRIG_EXT_TIM3_TRGO
ADC group regular conversion trigger from
external IP: TIM3 TRGO. Trigger edge set to
rising edge (default setting).
LL_ADC_REG_TRIG_EXT_TIM15_TRGO
ADC group regular conversion trigger from
external IP: TIM15 TRGO. Trigger edge set to
rising edge (default setting).
ADC instance - Resolution
LL_ADC_RESOLUTION_12B
ADC resolution 12 bits
LL_ADC_RESOLUTION_10B
ADC resolution 10 bits
LL_ADC_RESOLUTION_8B
ADC resolution 8 bits
LL_ADC_RESOLUTION_6B
ADC resolution 6 bits
ADC helper macro
__LL_ADC_CHANNEL_TO_
DECIMAL_NB
Description:
Helper macro to get ADC channel number in
decimal format from literals
LL_ADC_CHANNEL_x.
Parameters:
__CHANNEL__: This parameter can be one of the
following values:
LL_ADC_CHANNEL_0
680/1320
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
LL_ADC_CHANNEL_1
LL_ADC_CHANNEL_2
LL_ADC_CHANNEL_3
LL_ADC_CHANNEL_4
LL_ADC_CHANNEL_5
LL_ADC_CHANNEL_6
LL_ADC_CHANNEL_7
LL_ADC_CHANNEL_8
LL_ADC_CHANNEL_9
LL_ADC_CHANNEL_10
LL_ADC_CHANNEL_11
LL_ADC_CHANNEL_12
LL_ADC_CHANNEL_13
LL_ADC_CHANNEL_14
LL_ADC_CHANNEL_15
LL_ADC_CHANNEL_16
LL_ADC_CHANNEL_17
LL_ADC_CHANNEL_18 (1)
LL_ADC_CHANNEL_VREFINT
LL_ADC_CHANNEL_TEMPSENSOR
LL_ADC_CHANNEL_VBAT (1)
Return value:
Value: between Min_Data=0 and Max_Data=18
Notes:
Example:
__LL_ADC_CHANNEL_TO_DECIMAL_NB(LL_A
DC_CHANNEL_4) will return decimal number "4".
The input can be a value from functions where a
channel number is returned, either defined with
number or with bitfield (only one bit must be set).
__LL_ADC_DECIMAL_NB_TO_
CHANNEL
Description:
Helper macro to get ADC channel in literal format
LL_ADC_CHANNEL_x from number in decimal
format.
Parameters:
__DECIMAL_NB__: Value between Min_Data=0
and Max_Data=18
Return value:
Returned: value can be one of the following
values:
LL_ADC_CHANNEL_0
LL_ADC_CHANNEL_1
LL_ADC_CHANNEL_2
LL_ADC_CHANNEL_3
LL_ADC_CHANNEL_4
LL_ADC_CHANNEL_5
LL_ADC_CHANNEL_6
LL_ADC_CHANNEL_7
DocID026525 Rev 6
681/1320
LL ADC Generic Driver
UM1785
LL_ADC_CHANNEL_8
LL_ADC_CHANNEL_9
LL_ADC_CHANNEL_10
LL_ADC_CHANNEL_11
LL_ADC_CHANNEL_12
LL_ADC_CHANNEL_13
LL_ADC_CHANNEL_14
LL_ADC_CHANNEL_15
LL_ADC_CHANNEL_16
LL_ADC_CHANNEL_17
LL_ADC_CHANNEL_18 (1)
LL_ADC_CHANNEL_VREFINT (2)
LL_ADC_CHANNEL_TEMPSENSOR (2)
LL_ADC_CHANNEL_VBAT (1)(2)
Notes:
Example:
__LL_ADC_DECIMAL_NB_TO_CHANNEL(4) will
return a data equivalent to
"LL_ADC_CHANNEL_4".
__LL_ADC_IS_CHANNEL_
INTERNAL
Description:
Helper macro to determine whether the selected
channel corresponds to literal definitions of driver.
Parameters:
__CHANNEL__: This parameter can be one of the
following values:
LL_ADC_CHANNEL_0
LL_ADC_CHANNEL_1
LL_ADC_CHANNEL_2
LL_ADC_CHANNEL_3
LL_ADC_CHANNEL_4
LL_ADC_CHANNEL_5
LL_ADC_CHANNEL_6
LL_ADC_CHANNEL_7
LL_ADC_CHANNEL_8
LL_ADC_CHANNEL_9
LL_ADC_CHANNEL_10
LL_ADC_CHANNEL_11
LL_ADC_CHANNEL_12
LL_ADC_CHANNEL_13
LL_ADC_CHANNEL_14
LL_ADC_CHANNEL_15
LL_ADC_CHANNEL_16
LL_ADC_CHANNEL_17
LL_ADC_CHANNEL_18 (1)
LL_ADC_CHANNEL_VREFINT
LL_ADC_CHANNEL_TEMPSENSOR
LL_ADC_CHANNEL_VBAT (1)
Return value:
Value: "0" if the channel corresponds to a
682/1320
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
parameter definition of a ADC external channel
(channel connected to a GPIO pin). Value "1" if
the channel corresponds to a parameter definition
of a ADC internal channel.
Notes:
The different literal definitions of ADC channels
are: ADC internal channel:
LL_ADC_CHANNEL_VREFINT,
LL_ADC_CHANNEL_TEMPSENSOR, ...ADC
external channel (channel connected to a GPIO
pin): LL_ADC_CHANNEL_1,
LL_ADC_CHANNEL_2, ... The channel parameter
must be a value defined from literal definition of a
ADC internal channel
(LL_ADC_CHANNEL_VREFINT,
LL_ADC_CHANNEL_TEMPSENSOR, ...), ADC
external channel (LL_ADC_CHANNEL_1,
LL_ADC_CHANNEL_2, ...), must not be a value
from functions where a channel number is
returned from ADC registers, because internal and
external channels share the same channel number
in ADC registers. The differentiation is made only
with parameters definitions of driver.
__LL_ADC_CHANNEL_
INTERNAL_TO_EXTERNAL
Description:
Helper macro to convert a channel defined from
parameter definition of a ADC internal channel
(LL_ADC_CHANNEL_VREFINT,
LL_ADC_CHANNEL_TEMPSENSOR, ...), to its
equivalent parameter definition of a ADC external
channel (LL_ADC_CHANNEL_1,
LL_ADC_CHANNEL_2, ...).
Parameters:
__CHANNEL__: This parameter can be one of the
following values:
LL_ADC_CHANNEL_0
LL_ADC_CHANNEL_1
LL_ADC_CHANNEL_2
LL_ADC_CHANNEL_3
LL_ADC_CHANNEL_4
LL_ADC_CHANNEL_5
LL_ADC_CHANNEL_6
LL_ADC_CHANNEL_7
LL_ADC_CHANNEL_8
LL_ADC_CHANNEL_9
LL_ADC_CHANNEL_10
LL_ADC_CHANNEL_11
LL_ADC_CHANNEL_12
LL_ADC_CHANNEL_13
LL_ADC_CHANNEL_14
LL_ADC_CHANNEL_15
LL_ADC_CHANNEL_16
DocID026525 Rev 6
683/1320
LL ADC Generic Driver
UM1785
LL_ADC_CHANNEL_17
LL_ADC_CHANNEL_18 (1)
LL_ADC_CHANNEL_VREFINT
LL_ADC_CHANNEL_TEMPSENSOR
LL_ADC_CHANNEL_VBAT (1)
Return value:
Returned: value can be one of the following
values:
LL_ADC_CHANNEL_0
LL_ADC_CHANNEL_1
LL_ADC_CHANNEL_2
LL_ADC_CHANNEL_3
LL_ADC_CHANNEL_4
LL_ADC_CHANNEL_5
LL_ADC_CHANNEL_6
LL_ADC_CHANNEL_7
LL_ADC_CHANNEL_8
LL_ADC_CHANNEL_9
LL_ADC_CHANNEL_10
LL_ADC_CHANNEL_11
LL_ADC_CHANNEL_12
LL_ADC_CHANNEL_13
LL_ADC_CHANNEL_14
LL_ADC_CHANNEL_15
LL_ADC_CHANNEL_16
LL_ADC_CHANNEL_17
LL_ADC_CHANNEL_18
Notes:
The channel parameter can be, additionally to a
value defined from parameter definition of a ADC
internal channel (LL_ADC_CHANNEL_VREFINT,
LL_ADC_CHANNEL_TEMPSENSOR, ...), a value
defined from parameter definition of ADC external
channel (LL_ADC_CHANNEL_1,
LL_ADC_CHANNEL_2, ...) or a value from
functions where a channel number is returned
from ADC registers.
__LL_ADC_IS_CHANNEL_
INTERNAL_AVAILABLE
Description:
Helper macro to determine whether the internal
channel selected is available on the ADC instance
selected.
Parameters:
__ADC_INSTANCE__: ADC instance
__CHANNEL__: This parameter can be one of the
following values:
LL_ADC_CHANNEL_VREFINT
LL_ADC_CHANNEL_TEMPSENSOR
LL_ADC_CHANNEL_VBAT (1)
684/1320
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
Return value:
Value: "0" if the internal channel selected is not
available on the ADC instance selected. Value "1"
if the internal channel selected is available on the
ADC instance selected.
Notes:
The channel parameter must be a value defined
from parameter definition of a ADC internal
channel (LL_ADC_CHANNEL_VREFINT,
LL_ADC_CHANNEL_TEMPSENSOR, ...), must
not be a value defined from parameter definition of
ADC external channel (LL_ADC_CHANNEL_1,
LL_ADC_CHANNEL_2, ...) or a value from
functions where a channel number is returned
from ADC registers, because internal and external
channels share the same channel number in ADC
registers. The differentiation is made only with
parameters definitions of driver.
__LL_ADC_ANALOGWD_
CHANNEL_GROUP
Description:
Helper macro to define ADC analog watchdog
parameter: define a single channel to monitor with
analog watchdog from sequencer channel and
groups definition.
Parameters:
__CHANNEL__: This parameter can be one of the
following values:
LL_ADC_CHANNEL_0
LL_ADC_CHANNEL_1
LL_ADC_CHANNEL_2
LL_ADC_CHANNEL_3
LL_ADC_CHANNEL_4
LL_ADC_CHANNEL_5
LL_ADC_CHANNEL_6
LL_ADC_CHANNEL_7
LL_ADC_CHANNEL_8
LL_ADC_CHANNEL_9
LL_ADC_CHANNEL_10
LL_ADC_CHANNEL_11
LL_ADC_CHANNEL_12
LL_ADC_CHANNEL_13
LL_ADC_CHANNEL_14
LL_ADC_CHANNEL_15
LL_ADC_CHANNEL_16
LL_ADC_CHANNEL_17
LL_ADC_CHANNEL_18 (1)
LL_ADC_CHANNEL_VREFINT (2)
LL_ADC_CHANNEL_TEMPSENSOR (2)
LL_ADC_CHANNEL_VBAT (1)(2)
__GROUP__: This parameter can be one of the
following values:
DocID026525 Rev 6
685/1320
LL ADC Generic Driver
UM1785
LL_ADC_GROUP_REGULAR
Return value:
Returned: value can be one of the following
values:
LL_ADC_AWD_DISABLE
LL_ADC_AWD_ALL_CHANNELS_REG
LL_ADC_AWD_CHANNEL_0_REG
LL_ADC_AWD_CHANNEL_1_REG
LL_ADC_AWD_CHANNEL_2_REG
LL_ADC_AWD_CHANNEL_3_REG
LL_ADC_AWD_CHANNEL_4_REG
LL_ADC_AWD_CHANNEL_5_REG
LL_ADC_AWD_CHANNEL_6_REG
LL_ADC_AWD_CHANNEL_7_REG
LL_ADC_AWD_CHANNEL_8_REG
LL_ADC_AWD_CHANNEL_9_REG
LL_ADC_AWD_CHANNEL_10_REG
LL_ADC_AWD_CHANNEL_11_REG
LL_ADC_AWD_CHANNEL_12_REG
LL_ADC_AWD_CHANNEL_13_REG
LL_ADC_AWD_CHANNEL_14_REG
LL_ADC_AWD_CHANNEL_15_REG
LL_ADC_AWD_CHANNEL_16_REG
LL_ADC_AWD_CHANNEL_17_REG
LL_ADC_AWD_CHANNEL_18_REG (1)
LL_ADC_AWD_CH_VREFINT_REG
LL_ADC_AWD_CH_TEMPSENSOR_REG
LL_ADC_AWD_CH_VBAT_REG (1)
Notes:
To be used with function
LL_ADC_SetAnalogWDMonitChannels().
Example: LL_ADC_SetAnalogWDMonitChannels(
ADC1, LL_ADC_AWD1,
__LL_ADC_ANALOGWD_CHANNEL_GROUP(LL
_ADC_CHANNEL4,
LL_ADC_GROUP_REGULAR))
__LL_ADC_ANALOGWD_SET_
THRESHOLD_RESOLUTION
Description:
Helper macro to set the value of ADC analog
watchdog threshold high or low in function of ADC
resolution, when ADC resolution is different of 12
bits.
Parameters:
__ADC_RESOLUTION__: This parameter can be
one of the following values:
LL_ADC_RESOLUTION_12B
LL_ADC_RESOLUTION_10B
LL_ADC_RESOLUTION_8B
LL_ADC_RESOLUTION_6B
__AWD_THRESHOLD__: Value between
686/1320
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
Min_Data=0x000 and Max_Data=0xFFF
Return value:
Value: between Min_Data=0x000 and
Max_Data=0xFFF
Notes:
To be used with function
LL_ADC_ConfigAnalogWDThresholds() or
LL_ADC_SetAnalogWDThresholds(). Example,
with a ADC resolution of 8 bits, to set the value of
analog watchdog threshold high (on 8 bits):
LL_ADC_SetAnalogWDThresholds (< ADCx
param>,
__LL_ADC_ANALOGWD_SET_THRESHOLD_RE
SOLUTION(LL_ADC_RESOLUTION_8B,
) );
__LL_ADC_ANALOGWD_GET_
THRESHOLD_RESOLUTION
Description:
Helper macro to get the value of ADC analog
watchdog threshold high or low in function of ADC
resolution, when ADC resolution is different of 12
bits.
Parameters:
__ADC_RESOLUTION__: This parameter can be
one of the following values:
LL_ADC_RESOLUTION_12B
LL_ADC_RESOLUTION_10B
LL_ADC_RESOLUTION_8B
LL_ADC_RESOLUTION_6B
__AWD_THRESHOLD_12_BITS__: Value
between Min_Data=0x000 and Max_Data=0xFFF
Return value:
Value: between Min_Data=0x000 and
Max_Data=0xFFF
Notes:
To be used with function
LL_ADC_GetAnalogWDThresholds(). Example,
with a ADC resolution of 8 bits, to get the value of
analog watchdog threshold high (on 8 bits): <
threshold_value_6_bits> =
__LL_ADC_ANALOGWD_GET_THRESHOLD_R
ESOLUTION (LL_ADC_RESOLUTION_8B,
LL_ADC_GetAnalogWDThresholds(, LL_ADC_AWD_THRESHOLD_HIGH) );
__LL_ADC_ANALOGWD_
THRESHOLDS_HIGH_LOW
Description:
Helper macro to get the ADC analog watchdog
threshold high or low from raw value containing
both thresholds concatenated.
DocID026525 Rev 6
687/1320
LL ADC Generic Driver
UM1785
Parameters:
__AWD_THRESHOLD_TYPE__: This parameter
can be one of the following values:
LL_ADC_AWD_THRESHOLD_HIGH
LL_ADC_AWD_THRESHOLD_LOW
__AWD_THRESHOLDS__: Value between
Min_Data=0x00000000 and
Max_Data=0xFFFFFFFF
Return value:
Value: between Min_Data=0x000 and
Max_Data=0xFFF
Notes:
To be used with function
LL_ADC_GetAnalogWDThresholds(). Example, to
get analog watchdog threshold high from the
register raw value:
__LL_ADC_ANALOGWD_THRESHOLDS_HIGH_
LOW(LL_ADC_AWD_THRESHOLD_HIGH,
);
Description:
__LL_ADC_COMMON_
INSTANCE
Helper macro to select the ADC common instance
to which is belonging the selected ADC instance.
Parameters:
__ADCx__: ADC instance
Return value:
ADC: common register instance
Notes:
ADC common register instance can be used for:
Set parameters common to several ADC
instancesMultimode (for devices with several ADC
instances) Refer to functions having argument
"ADCxy_COMMON" as parameter.
__LL_ADC_IS_ENABLED_ALL_
COMMON_INSTANCE
Description:
Helper macro to check if all ADC instances
sharing the same ADC common instance are
disabled.
Parameters:
__ADCXY_COMMON__: ADC common instance
(can be set directly from CMSIS definition or by
using helper macro
Return value:
Value: "0" if all ADC instances sharing the same
ADC common instance are disabled. Value "1" if at
least one ADC instance sharing the same ADC
688/1320
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
common instance is enabled.
Notes:
This check is required by functions with setting
conditioned to ADC state: All ADC instances of the
ADC common group must be disabled. Refer to
functions having argument "ADCxy_COMMON" as
parameter. On devices with only 1 ADC common
instance, parameter of this macro is useless and
can be ignored (parameter kept for compatibility
with devices featuring several ADC common
instances).
__LL_ADC_DIGITAL_SCALE
Description:
Helper macro to define the ADC conversion data
full-scale digital value corresponding to the
selected ADC resolution.
Parameters:
__ADC_RESOLUTION__: This parameter can be
one of the following values:
LL_ADC_RESOLUTION_12B
LL_ADC_RESOLUTION_10B
LL_ADC_RESOLUTION_8B
LL_ADC_RESOLUTION_6B
Return value:
ADC: conversion data equivalent voltage value
(unit: mVolt)
Notes:
ADC conversion data full-scale corresponds to
voltage range determined by analog voltage
references Vref+ and Vref- (refer to reference
manual).
__LL_ADC_CONVERT_DATA_
RESOLUTION
Description:
Helper macro to convert the ADC conversion data
from a resolution to another resolution.
Parameters:
__DATA__: ADC conversion data to be converted
__ADC_RESOLUTION_CURRENT__: Resolution
of to the data to be converted This parameter can
be one of the following values:
LL_ADC_RESOLUTION_12B
LL_ADC_RESOLUTION_10B
LL_ADC_RESOLUTION_8B
LL_ADC_RESOLUTION_6B
__ADC_RESOLUTION_TARGET__: Resolution of
the data after conversion This parameter can be
one of the following values:
LL_ADC_RESOLUTION_12B
LL_ADC_RESOLUTION_10B
DocID026525 Rev 6
689/1320
LL ADC Generic Driver
UM1785
LL_ADC_RESOLUTION_8B
LL_ADC_RESOLUTION_6B
Return value:
ADC: conversion data to the requested resolution
__LL_ADC_CALC_DATA_TO_
VOLTAGE
Description:
Helper macro to calculate the voltage (unit: mVolt)
corresponding to a ADC conversion data (unit:
digital value).
Parameters:
__VREFANALOG_VOLTAGE__: Analog
reference voltage (unit: mV)
__ADC_DATA__: ADC conversion data
(resolution 12 bits) (unit: digital value).
__ADC_RESOLUTION__: This parameter can be
one of the following values:
LL_ADC_RESOLUTION_12B
LL_ADC_RESOLUTION_10B
LL_ADC_RESOLUTION_8B
LL_ADC_RESOLUTION_6B
Return value:
ADC: conversion data equivalent voltage value
(unit: mVolt)
Notes:
Analog reference voltage (Vref+) must be either
known from user board environment or can be
calculated using ADC measurement and ADC
helper macro
__LL_ADC_CALC_VREFANALOG_VOLTAGE().
__LL_ADC_CALC_VREF
ANALOG_VOLTAGE
Description:
Helper macro to calculate analog reference
voltage (Vref+) (unit: mVolt) from ADC conversion
data of internal voltage reference VrefInt.
Parameters:
__VREFINT_ADC_DATA__: ADC conversion data
(resolution 12 bits) of internal voltage reference
VrefInt (unit: digital value).
__ADC_RESOLUTION__: This parameter can be
one of the following values:
LL_ADC_RESOLUTION_12B
LL_ADC_RESOLUTION_10B
LL_ADC_RESOLUTION_8B
LL_ADC_RESOLUTION_6B
Return value:
Analog: reference voltage (unit: mV)
690/1320
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
Notes:
Computation is using VrefInt calibration value
stored in system memory for each device during
production. This voltage depends on user board
environment: voltage level connected to pin Vref+.
On devices with small package, the pin Vref+ is
not present and internally bonded to pin Vdda. On
this STM32 serie, calibration data of internal
voltage reference VrefInt corresponds to a
resolution of 12 bits, this is the recommended
ADC resolution to convert voltage of internal
voltage reference VrefInt. Otherwise, this macro
performs the processing to scale ADC conversion
data to 12 bits.
__LL_ADC_CALC_
TEMPERATURE
Description:
Helper macro to calculate the temperature (unit:
degree Celsius) from ADC conversion data of
internal temperature sensor.
Parameters:
__VREFANALOG_VOLTAGE__: Analog
reference voltage (unit: mV)
__TEMPSENSOR_ADC_DATA__: ADC
conversion data of internal temperature sensor
(unit: digital value).
__ADC_RESOLUTION__: ADC resolution at
which internal temperature sensor voltage has
been measured. This parameter can be one of the
following values:
LL_ADC_RESOLUTION_12B
LL_ADC_RESOLUTION_10B
LL_ADC_RESOLUTION_8B
LL_ADC_RESOLUTION_6B
Return value:
Temperature: (unit: degree Celsius)
Notes:
Computation is using temperature sensor
calibration values stored in system memory for
each device during production. Calculation
formula: Temperature = ((TS_ADC_DATA TS_CAL1) * (TS_CAL2_TEMP TS_CAL1_TEMP)) / (TS_CAL2 - TS_CAL1) +
TS_CAL1_TEMP with TS_ADC_DATA =
temperature sensor raw data measured by ADC
Avg_Slope = (TS_CAL2 - TS_CAL1) /
(TS_CAL2_TEMP - TS_CAL1_TEMP) TS_CAL1 =
equivalent TS_ADC_DATA at temperature
TEMP_DEGC_CAL1 (calibrated in factory)
TS_CAL2 = equivalent TS_ADC_DATA at
temperature TEMP_DEGC_CAL2 (calibrated in
factory) Caution: Calculation relevancy under
DocID026525 Rev 6
691/1320
LL ADC Generic Driver
UM1785
reserve that calibration parameters are correct
(address and data). To calculate temperature
using temperature sensor datasheet typical values
(generic values less, therefore less accurate than
calibrated values), use helper macro
__LL_ADC_CALC_TEMPERATURE_TYP_PARA
MS(). As calculation input, the analog reference
voltage (Vref+) must be defined as it impacts the
ADC LSB equivalent voltage. Analog reference
voltage (Vref+) must be either known from user
board environment or can be calculated using
ADC measurement and ADC helper macro
__LL_ADC_CALC_VREFANALOG_VOLTAGE().
On this STM32 serie, calibration data of
temperature sensor corresponds to a resolution of
12 bits, this is the recommended ADC resolution
to convert voltage of temperature sensor.
Otherwise, this macro performs the processing to
scale ADC conversion data to 12 bits.
__LL_ADC_CALC_TEMPERA
TURE_TYP_PARAMS
Description:
Helper macro to calculate the temperature (unit:
degree Celsius) from ADC conversion data of
internal temperature sensor.
Parameters:
__TEMPSENSOR_TYP_AVGSLOPE__: Device
datasheet data: Temperature sensor slope typical
value (unit: uV/DegCelsius). On STM32F0, refer to
device datasheet parameter "Avg_Slope".
__TEMPSENSOR_TYP_CALX_V__: Device
datasheet data: Temperature sensor voltage
typical value (at temperature and Vref+ defined in
parameters below) (unit: mV). On STM32F0, refer
to device datasheet parameter "V30"
(corresponding to TS_CAL1).
__TEMPSENSOR_CALX_TEMP__: Device
datasheet data: Temperature at which
temperature sensor voltage (see parameter
above) is corresponding (unit: mV)
__VREFANALOG_VOLTAGE__: Analog voltage
reference (Vref+) voltage (unit: mV)
__TEMPSENSOR_ADC_DATA__: ADC
conversion data of internal temperature sensor
(unit: digital value).
__ADC_RESOLUTION__: ADC resolution at
which internal temperature sensor voltage has
been measured. This parameter can be one of the
following values:
LL_ADC_RESOLUTION_12B
LL_ADC_RESOLUTION_10B
LL_ADC_RESOLUTION_8B
LL_ADC_RESOLUTION_6B
692/1320
DocID026525 Rev 6
UM1785
LL ADC Generic Driver
Return value:
Temperature: (unit: degree Celsius)
Notes:
Computation is using temperature sensor typical
values (refer to device datasheet). Calculation
formula: Temperature =
(TS_TYP_CALx_VOLT(uV) - TS_ADC_DATA *
Conversion_uV) / Avg_Slope + CALx_TEMP with
TS_ADC_DATA = temperature sensor raw data
measured by ADC (unit: digital value) Avg_Slope
= temperature sensor slope (unit: uV/Degree
Celsius) TS_TYP_CALx_VOLT = temperature
sensor digital value at temperature CALx_TEMP
(unit: mV) Caution: Calculation relevancy under
reserve the temperature sensor of the current
device has characteristics in line with datasheet
typical values. If temperature sensor calibration
values are available on on this device (presence of
macro __LL_ADC_CALC_TEMPERATURE()),
temperature calculation will be more accurate
using helper macro
__LL_ADC_CALC_TEMPERATURE(). As
calculation input, the analog reference voltage
(Vref+) must be defined as it impacts the ADC
LSB equivalent voltage. Analog reference voltage
(Vref+) must be either known from user board
environment or can be calculated using ADC
measurement and ADC helper macro
__LL_ADC_CALC_VREFANALOG_VOLTAGE().
ADC measurement data must correspond to a
resolution of 12bits (full scale digital value 4095). If
not the case, the data must be preliminarily
rescaled to an equivalent resolution of 12 bits.
Common write and read registers Macros
LL_ADC_WriteReg
Description:
Write a value in ADC register.
Parameters:
__INSTANCE__: ADC Instance
__REG__: Register to be written
__VALUE__: Value to be written in the register
Return value:
None
DocID026525 Rev 6
693/1320
LL ADC Generic Driver
LL_ADC_ReadReg
UM1785
Description:
Read a value in ADC register.
Parameters:
__INSTANCE__: ADC Instance
__REG__: Register to be read
Return value:
Register: value
694/1320
DocID026525 Rev 6
UM1785
LL BUS Generic Driver
50
LL BUS Generic Driver
50.1
BUS Firmware driver API description
50.1.1
Detailed description of functions
LL_AHB1_GRP1_EnableClock
Function name
__STATIC_INLINE void LL_AHB1_GRP1_EnableClock
(uint32_t Periphs)
Function description
Enable AHB1 peripherals clock.
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_AHB1_GRP1_PERIPH_DMA1
LL_AHB1_GRP1_PERIPH_DMA2 (*)
LL_AHB1_GRP1_PERIPH_SRAM
LL_AHB1_GRP1_PERIPH_FLASH
LL_AHB1_GRP1_PERIPH_CRC
LL_AHB1_GRP1_PERIPH_GPIOA
LL_AHB1_GRP1_PERIPH_GPIOB
LL_AHB1_GRP1_PERIPH_GPIOC
LL_AHB1_GRP1_PERIPH_GPIOD (*)
LL_AHB1_GRP1_PERIPH_GPIOE (*)
LL_AHB1_GRP1_PERIPH_GPIOF
LL_AHB1_GRP1_PERIPH_TSC (*)
Return values
None
Reference Manual to
LL API cross
reference:
AHBENR DMA1EN LL_AHB1_GRP1_EnableClock
AHBENR DMA2EN LL_AHB1_GRP1_EnableClock
AHBENR SRAMEN LL_AHB1_GRP1_EnableClock
AHBENR FLITFEN LL_AHB1_GRP1_EnableClock
AHBENR CRCEN LL_AHB1_GRP1_EnableClock
AHBENR GPIOAEN LL_AHB1_GRP1_EnableClock
AHBENR GPIOBEN LL_AHB1_GRP1_EnableClock
AHBENR GPIOCEN LL_AHB1_GRP1_EnableClock
AHBENR GPIODEN LL_AHB1_GRP1_EnableClock
AHBENR GPIOEEN LL_AHB1_GRP1_EnableClock
AHBENR GPIOFEN LL_AHB1_GRP1_EnableClock
AHBENR TSCEN LL_AHB1_GRP1_EnableClock
LL_AHB1_GRP1_IsEnabledClock
Function name
__STATIC_INLINE uint32_t LL_AHB1_GRP1_IsEnabledClock
(uint32_t Periphs)
Function description
Check if AHB1 peripheral clock is enabled or not.
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_AHB1_GRP1_PERIPH_DMA1
LL_AHB1_GRP1_PERIPH_DMA2 (*)
DocID026525 Rev 6
695/1320
LL BUS Generic Driver
UM1785
LL_AHB1_GRP1_PERIPH_SRAM
LL_AHB1_GRP1_PERIPH_FLASH
LL_AHB1_GRP1_PERIPH_CRC
LL_AHB1_GRP1_PERIPH_GPIOA
LL_AHB1_GRP1_PERIPH_GPIOB
LL_AHB1_GRP1_PERIPH_GPIOC
LL_AHB1_GRP1_PERIPH_GPIOD (*)
LL_AHB1_GRP1_PERIPH_GPIOE (*)
LL_AHB1_GRP1_PERIPH_GPIOF
LL_AHB1_GRP1_PERIPH_TSC (*)
Return values
State: of Periphs (1 or 0).
Reference Manual to
LL API cross
reference:
AHBENR DMA1EN LL_AHB1_GRP1_IsEnabledClock
AHBENR DMA2EN LL_AHB1_GRP1_IsEnabledClock
AHBENR SRAMEN LL_AHB1_GRP1_IsEnabledClock
AHBENR FLITFEN LL_AHB1_GRP1_IsEnabledClock
AHBENR CRCEN LL_AHB1_GRP1_IsEnabledClock
AHBENR GPIOAEN LL_AHB1_GRP1_IsEnabledClock
AHBENR GPIOBEN LL_AHB1_GRP1_IsEnabledClock
AHBENR GPIOCEN LL_AHB1_GRP1_IsEnabledClock
AHBENR GPIODEN LL_AHB1_GRP1_IsEnabledClock
AHBENR GPIOEEN LL_AHB1_GRP1_IsEnabledClock
AHBENR GPIOFEN LL_AHB1_GRP1_IsEnabledClock
AHBENR TSCEN LL_AHB1_GRP1_IsEnabledClock
LL_AHB1_GRP1_DisableClock
696/1320
Function name
__STATIC_INLINE void LL_AHB1_GRP1_DisableClock
(uint32_t Periphs)
Function description
Disable AHB1 peripherals clock.
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_AHB1_GRP1_PERIPH_DMA1
LL_AHB1_GRP1_PERIPH_DMA2 (*)
LL_AHB1_GRP1_PERIPH_SRAM
LL_AHB1_GRP1_PERIPH_FLASH
LL_AHB1_GRP1_PERIPH_CRC
LL_AHB1_GRP1_PERIPH_GPIOA
LL_AHB1_GRP1_PERIPH_GPIOB
LL_AHB1_GRP1_PERIPH_GPIOC
LL_AHB1_GRP1_PERIPH_GPIOD (*)
LL_AHB1_GRP1_PERIPH_GPIOE (*)
LL_AHB1_GRP1_PERIPH_GPIOF
LL_AHB1_GRP1_PERIPH_TSC (*)
Return values
None
Reference Manual to
LL API cross
reference:
AHBENR DMA1EN LL_AHB1_GRP1_DisableClock
AHBENR DMA2EN LL_AHB1_GRP1_DisableClock
AHBENR SRAMEN LL_AHB1_GRP1_DisableClock
AHBENR FLITFEN LL_AHB1_GRP1_DisableClock
AHBENR CRCEN LL_AHB1_GRP1_DisableClock
AHBENR GPIOAEN LL_AHB1_GRP1_DisableClock
DocID026525 Rev 6
UM1785
LL BUS Generic Driver
AHBENR GPIOBEN LL_AHB1_GRP1_DisableClock
AHBENR GPIOCEN LL_AHB1_GRP1_DisableClock
AHBENR GPIODEN LL_AHB1_GRP1_DisableClock
AHBENR GPIOEEN LL_AHB1_GRP1_DisableClock
AHBENR GPIOFEN LL_AHB1_GRP1_DisableClock
AHBENR TSCEN LL_AHB1_GRP1_DisableClock
LL_AHB1_GRP1_ForceReset
Function name
__STATIC_INLINE void LL_AHB1_GRP1_ForceReset (uint32_t
Periphs)
Function description
Force AHB1 peripherals reset.
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_AHB1_GRP1_PERIPH_ALL
LL_AHB1_GRP1_PERIPH_GPIOA
LL_AHB1_GRP1_PERIPH_GPIOB
LL_AHB1_GRP1_PERIPH_GPIOC
LL_AHB1_GRP1_PERIPH_GPIOD (*)
LL_AHB1_GRP1_PERIPH_GPIOE (*)
LL_AHB1_GRP1_PERIPH_GPIOF
LL_AHB1_GRP1_PERIPH_TSC (*)
Return values
None
Reference Manual to
LL API cross
reference:
AHBRSTR GPIOARST LL_AHB1_GRP1_ForceReset
AHBRSTR GPIOBRST LL_AHB1_GRP1_ForceReset
AHBRSTR GPIOCRST LL_AHB1_GRP1_ForceReset
AHBRSTR GPIODRST LL_AHB1_GRP1_ForceReset
AHBRSTR GPIOERST LL_AHB1_GRP1_ForceReset
AHBRSTR GPIOFRST LL_AHB1_GRP1_ForceReset
AHBRSTR TSCRST LL_AHB1_GRP1_ForceReset
LL_AHB1_GRP1_ReleaseReset
Function name
__STATIC_INLINE void LL_AHB1_GRP1_ReleaseReset
(uint32_t Periphs)
Function description
Release AHB1 peripherals reset.
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_AHB1_GRP1_PERIPH_ALL
LL_AHB1_GRP1_PERIPH_GPIOA
LL_AHB1_GRP1_PERIPH_GPIOB
LL_AHB1_GRP1_PERIPH_GPIOC
LL_AHB1_GRP1_PERIPH_GPIOD (*)
LL_AHB1_GRP1_PERIPH_GPIOE (*)
LL_AHB1_GRP1_PERIPH_GPIOF
LL_AHB1_GRP1_PERIPH_TSC (*)
Return values
None
Reference Manual to
LL API cross
AHBRSTR GPIOARST LL_AHB1_GRP1_ReleaseReset
AHBRSTR GPIOBRST LL_AHB1_GRP1_ReleaseReset
DocID026525 Rev 6
697/1320
LL BUS Generic Driver
reference:
UM1785
AHBRSTR GPIOCRST LL_AHB1_GRP1_ReleaseReset
AHBRSTR GPIODRST LL_AHB1_GRP1_ReleaseReset
AHBRSTR GPIOERST LL_AHB1_GRP1_ReleaseReset
AHBRSTR GPIOFRST LL_AHB1_GRP1_ReleaseReset
AHBRSTR TSCRST LL_AHB1_GRP1_ReleaseReset
LL_APB1_GRP1_EnableClock
698/1320
Function name
__STATIC_INLINE void LL_APB1_GRP1_EnableClock
(uint32_t Periphs)
Function description
Enable APB1 peripherals clock (available in register 1).
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_APB1_GRP1_PERIPH_TIM2 (*)
LL_APB1_GRP1_PERIPH_TIM3
LL_APB1_GRP1_PERIPH_TIM6 (*)
LL_APB1_GRP1_PERIPH_TIM7 (*)
LL_APB1_GRP1_PERIPH_TIM14
LL_APB1_GRP1_PERIPH_WWDG
LL_APB1_GRP1_PERIPH_SPI2 (*)
LL_APB1_GRP1_PERIPH_USART2 (*)
LL_APB1_GRP1_PERIPH_USART3 (*)
LL_APB1_GRP1_PERIPH_USART4 (*)
LL_APB1_GRP1_PERIPH_USART5 (*)
LL_APB1_GRP1_PERIPH_I2C1
LL_APB1_GRP1_PERIPH_I2C2 (*)
LL_APB1_GRP1_PERIPH_USB (*)
LL_APB1_GRP1_PERIPH_CAN (*)
LL_APB1_GRP1_PERIPH_CRS (*)
LL_APB1_GRP1_PERIPH_PWR
LL_APB1_GRP1_PERIPH_DAC1 (*)
LL_APB1_GRP1_PERIPH_CEC (*)
Return values
None
Reference Manual to
LL API cross
reference:
APB1ENR TIM2EN LL_APB1_GRP1_EnableClock
APB1ENR TIM3EN LL_APB1_GRP1_EnableClock
APB1ENR TIM6EN LL_APB1_GRP1_EnableClock
APB1ENR TIM7EN LL_APB1_GRP1_EnableClock
APB1ENR TIM14EN LL_APB1_GRP1_EnableClock
APB1ENR WWDGEN LL_APB1_GRP1_EnableClock
APB1ENR SPI2EN LL_APB1_GRP1_EnableClock
APB1ENR USART2EN LL_APB1_GRP1_EnableClock
APB1ENR USART3EN LL_APB1_GRP1_EnableClock
APB1ENR USART4EN LL_APB1_GRP1_EnableClock
APB1ENR USART5EN LL_APB1_GRP1_EnableClock
APB1ENR I2C1EN LL_APB1_GRP1_EnableClock
APB1ENR I2C2EN LL_APB1_GRP1_EnableClock
APB1ENR USBEN LL_APB1_GRP1_EnableClock
APB1ENR CANEN LL_APB1_GRP1_EnableClock
APB1ENR CRSEN LL_APB1_GRP1_EnableClock
APB1ENR PWREN LL_APB1_GRP1_EnableClock
APB1ENR DACEN LL_APB1_GRP1_EnableClock
DocID026525 Rev 6
UM1785
LL BUS Generic Driver
APB1ENR CECEN LL_APB1_GRP1_EnableClock
LL_APB1_GRP1_IsEnabledClock
Function name
__STATIC_INLINE uint32_t LL_APB1_GRP1_IsEnabledClock
(uint32_t Periphs)
Function description
Check if APB1 peripheral clock is enabled or not (available in
register 1).
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_APB1_GRP1_PERIPH_TIM2 (*)
LL_APB1_GRP1_PERIPH_TIM3
LL_APB1_GRP1_PERIPH_TIM6 (*)
LL_APB1_GRP1_PERIPH_TIM7 (*)
LL_APB1_GRP1_PERIPH_TIM14
LL_APB1_GRP1_PERIPH_WWDG
LL_APB1_GRP1_PERIPH_SPI2 (*)
LL_APB1_GRP1_PERIPH_USART2 (*)
LL_APB1_GRP1_PERIPH_USART3 (*)
LL_APB1_GRP1_PERIPH_USART4 (*)
LL_APB1_GRP1_PERIPH_USART5 (*)
LL_APB1_GRP1_PERIPH_I2C1
LL_APB1_GRP1_PERIPH_I2C2 (*)
LL_APB1_GRP1_PERIPH_USB (*)
LL_APB1_GRP1_PERIPH_CAN (*)
LL_APB1_GRP1_PERIPH_CRS (*)
LL_APB1_GRP1_PERIPH_PWR
LL_APB1_GRP1_PERIPH_DAC1 (*)
LL_APB1_GRP1_PERIPH_CEC (*)
Return values
State: of Periphs (1 or 0).
Reference Manual to
LL API cross
reference:
APB1ENR TIM2EN LL_APB1_GRP1_IsEnabledClock
APB1ENR TIM3EN LL_APB1_GRP1_IsEnabledClock
APB1ENR TIM6EN LL_APB1_GRP1_IsEnabledClock
APB1ENR TIM7EN LL_APB1_GRP1_IsEnabledClock
APB1ENR TIM14EN LL_APB1_GRP1_IsEnabledClock
APB1ENR WWDGEN LL_APB1_GRP1_IsEnabledClock
APB1ENR SPI2EN LL_APB1_GRP1_IsEnabledClock
APB1ENR USART2EN LL_APB1_GRP1_IsEnabledClock
APB1ENR USART3EN LL_APB1_GRP1_IsEnabledClock
APB1ENR USART4EN LL_APB1_GRP1_IsEnabledClock
APB1ENR USART5EN LL_APB1_GRP1_IsEnabledClock
APB1ENR I2C1EN LL_APB1_GRP1_IsEnabledClock
APB1ENR I2C2EN LL_APB1_GRP1_IsEnabledClock
APB1ENR USBEN LL_APB1_GRP1_IsEnabledClock
APB1ENR CANEN LL_APB1_GRP1_IsEnabledClock
APB1ENR CRSEN LL_APB1_GRP1_IsEnabledClock
APB1ENR PWREN LL_APB1_GRP1_IsEnabledClock
APB1ENR DACEN LL_APB1_GRP1_IsEnabledClock
APB1ENR CECEN LL_APB1_GRP1_IsEnabledClock
DocID026525 Rev 6
699/1320
LL BUS Generic Driver
UM1785
LL_APB1_GRP1_DisableClock
700/1320
Function name
__STATIC_INLINE void LL_APB1_GRP1_DisableClock
(uint32_t Periphs)
Function description
Disable APB1 peripherals clock (available in register 1).
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_APB1_GRP1_PERIPH_TIM2 (*)
LL_APB1_GRP1_PERIPH_TIM3
LL_APB1_GRP1_PERIPH_TIM6 (*)
LL_APB1_GRP1_PERIPH_TIM7 (*)
LL_APB1_GRP1_PERIPH_TIM14
LL_APB1_GRP1_PERIPH_WWDG
LL_APB1_GRP1_PERIPH_SPI2 (*)
LL_APB1_GRP1_PERIPH_USART2 (*)
LL_APB1_GRP1_PERIPH_USART3 (*)
LL_APB1_GRP1_PERIPH_USART4 (*)
LL_APB1_GRP1_PERIPH_USART5 (*)
LL_APB1_GRP1_PERIPH_I2C1
LL_APB1_GRP1_PERIPH_I2C2 (*)
LL_APB1_GRP1_PERIPH_USB (*)
LL_APB1_GRP1_PERIPH_CAN (*)
LL_APB1_GRP1_PERIPH_CRS (*)
LL_APB1_GRP1_PERIPH_PWR
LL_APB1_GRP1_PERIPH_DAC1 (*)
LL_APB1_GRP1_PERIPH_CEC (*)
Return values
None
Reference Manual to
LL API cross
reference:
APB1ENR TIM2EN LL_APB1_GRP1_DisableClock
APB1ENR TIM3EN LL_APB1_GRP1_DisableClock
APB1ENR TIM6EN LL_APB1_GRP1_DisableClock
APB1ENR TIM7EN LL_APB1_GRP1_DisableClock
APB1ENR TIM14EN LL_APB1_GRP1_DisableClock
APB1ENR WWDGEN LL_APB1_GRP1_DisableClock
APB1ENR SPI2EN LL_APB1_GRP1_DisableClock
APB1ENR USART2EN LL_APB1_GRP1_DisableClock
APB1ENR USART3EN LL_APB1_GRP1_DisableClock
APB1ENR USART4EN LL_APB1_GRP1_DisableClock
APB1ENR USART5EN LL_APB1_GRP1_DisableClock
APB1ENR I2C1EN LL_APB1_GRP1_DisableClock
APB1ENR I2C2EN LL_APB1_GRP1_DisableClock
APB1ENR USBEN LL_APB1_GRP1_DisableClock
APB1ENR CANEN LL_APB1_GRP1_DisableClock
APB1ENR CRSEN LL_APB1_GRP1_DisableClock
APB1ENR PWREN LL_APB1_GRP1_DisableClock
APB1ENR DACEN LL_APB1_GRP1_DisableClock
APB1ENR CECEN LL_APB1_GRP1_DisableClock
DocID026525 Rev 6
UM1785
LL BUS Generic Driver
LL_APB1_GRP1_ForceReset
Function name
__STATIC_INLINE void LL_APB1_GRP1_ForceReset (uint32_t
Periphs)
Function description
Force APB1 peripherals reset (available in register 1).
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_APB1_GRP1_PERIPH_ALL
LL_APB1_GRP1_PERIPH_TIM2 (*)
LL_APB1_GRP1_PERIPH_TIM3
LL_APB1_GRP1_PERIPH_TIM6 (*)
LL_APB1_GRP1_PERIPH_TIM7 (*)
LL_APB1_GRP1_PERIPH_TIM14
LL_APB1_GRP1_PERIPH_WWDG
LL_APB1_GRP1_PERIPH_SPI2 (*)
LL_APB1_GRP1_PERIPH_USART2 (*)
LL_APB1_GRP1_PERIPH_USART3 (*)
LL_APB1_GRP1_PERIPH_USART4 (*)
LL_APB1_GRP1_PERIPH_USART5 (*)
LL_APB1_GRP1_PERIPH_I2C1
LL_APB1_GRP1_PERIPH_I2C2 (*)
LL_APB1_GRP1_PERIPH_USB (*)
LL_APB1_GRP1_PERIPH_CAN (*)
LL_APB1_GRP1_PERIPH_CRS (*)
LL_APB1_GRP1_PERIPH_PWR
LL_APB1_GRP1_PERIPH_DAC1 (*)
LL_APB1_GRP1_PERIPH_CEC (*)
Return values
None
Reference Manual to
LL API cross
reference:
APB1RSTR TIM2RST LL_APB1_GRP1_ForceReset
APB1RSTR TIM3RST LL_APB1_GRP1_ForceReset
APB1RSTR TIM6RST LL_APB1_GRP1_ForceReset
APB1RSTR TIM7RST LL_APB1_GRP1_ForceReset
APB1RSTR TIM14RST LL_APB1_GRP1_ForceReset
APB1RSTR WWDGRST LL_APB1_GRP1_ForceReset
APB1RSTR SPI2RST LL_APB1_GRP1_ForceReset
APB1RSTR USART2RST LL_APB1_GRP1_ForceReset
APB1RSTR USART3RST LL_APB1_GRP1_ForceReset
APB1RSTR USART4RST LL_APB1_GRP1_ForceReset
APB1RSTR USART5RST LL_APB1_GRP1_ForceReset
APB1RSTR I2C1RST LL_APB1_GRP1_ForceReset
APB1RSTR I2C2RST LL_APB1_GRP1_ForceReset
APB1RSTR USBRST LL_APB1_GRP1_ForceReset
APB1RSTR CANRST LL_APB1_GRP1_ForceReset
APB1RSTR CRSRST LL_APB1_GRP1_ForceReset
APB1RSTR PWRRST LL_APB1_GRP1_ForceReset
APB1RSTR DACRST LL_APB1_GRP1_ForceReset
APB1RSTR CECRST LL_APB1_GRP1_ForceReset
DocID026525 Rev 6
701/1320
LL BUS Generic Driver
UM1785
LL_APB1_GRP1_ReleaseReset
702/1320
Function name
__STATIC_INLINE void LL_APB1_GRP1_ReleaseReset
(uint32_t Periphs)
Function description
Release APB1 peripherals reset (available in register 1).
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_APB1_GRP1_PERIPH_ALL
LL_APB1_GRP1_PERIPH_TIM2 (*)
LL_APB1_GRP1_PERIPH_TIM3
LL_APB1_GRP1_PERIPH_TIM6 (*)
LL_APB1_GRP1_PERIPH_TIM7 (*)
LL_APB1_GRP1_PERIPH_TIM14
LL_APB1_GRP1_PERIPH_WWDG
LL_APB1_GRP1_PERIPH_SPI2 (*)
LL_APB1_GRP1_PERIPH_USART2 (*)
LL_APB1_GRP1_PERIPH_USART3 (*)
LL_APB1_GRP1_PERIPH_USART4 (*)
LL_APB1_GRP1_PERIPH_USART5 (*)
LL_APB1_GRP1_PERIPH_I2C1
LL_APB1_GRP1_PERIPH_I2C2 (*)
LL_APB1_GRP1_PERIPH_USB (*)
LL_APB1_GRP1_PERIPH_CAN (*)
LL_APB1_GRP1_PERIPH_CRS (*)
LL_APB1_GRP1_PERIPH_PWR
LL_APB1_GRP1_PERIPH_DAC1 (*)
LL_APB1_GRP1_PERIPH_CEC (*)
Return values
None
Reference Manual to
LL API cross
reference:
APB1RSTR TIM2RST LL_APB1_GRP1_ReleaseReset
APB1RSTR TIM3RST LL_APB1_GRP1_ReleaseReset
APB1RSTR TIM6RST LL_APB1_GRP1_ReleaseReset
APB1RSTR TIM7RST LL_APB1_GRP1_ReleaseReset
APB1RSTR TIM14RST LL_APB1_GRP1_ReleaseReset
APB1RSTR WWDGRST LL_APB1_GRP1_ReleaseReset
APB1RSTR SPI2RST LL_APB1_GRP1_ReleaseReset
APB1RSTR USART2RST LL_APB1_GRP1_ReleaseReset
APB1RSTR USART3RST LL_APB1_GRP1_ReleaseReset
APB1RSTR USART4RST LL_APB1_GRP1_ReleaseReset
APB1RSTR USART5RST LL_APB1_GRP1_ReleaseReset
APB1RSTR I2C1RST LL_APB1_GRP1_ReleaseReset
APB1RSTR I2C2RST LL_APB1_GRP1_ReleaseReset
APB1RSTR USBRST LL_APB1_GRP1_ReleaseReset
APB1RSTR CANRST LL_APB1_GRP1_ReleaseReset
APB1RSTR CRSRST LL_APB1_GRP1_ReleaseReset
APB1RSTR PWRRST LL_APB1_GRP1_ReleaseReset
APB1RSTR DACRST LL_APB1_GRP1_ReleaseReset
APB1RSTR CECRST LL_APB1_GRP1_ReleaseReset
DocID026525 Rev 6
UM1785
LL BUS Generic Driver
LL_APB1_GRP2_EnableClock
Function name
__STATIC_INLINE void LL_APB1_GRP2_EnableClock
(uint32_t Periphs)
Function description
Enable APB1 peripherals clock (available in register 2).
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_APB1_GRP2_PERIPH_SYSCFG
LL_APB1_GRP2_PERIPH_ADC1
LL_APB1_GRP2_PERIPH_USART8 (*)
LL_APB1_GRP2_PERIPH_USART7 (*)
LL_APB1_GRP2_PERIPH_USART6 (*)
LL_APB1_GRP2_PERIPH_TIM1
LL_APB1_GRP2_PERIPH_SPI1
LL_APB1_GRP2_PERIPH_USART1
LL_APB1_GRP2_PERIPH_TIM15 (*)
LL_APB1_GRP2_PERIPH_TIM16
LL_APB1_GRP2_PERIPH_TIM17
LL_APB1_GRP2_PERIPH_DBGMCU
Return values
None
Reference Manual to
LL API cross
reference:
APB2ENR SYSCFGEN LL_APB1_GRP2_EnableClock
APB2ENR ADC1EN LL_APB1_GRP2_EnableClock
APB2ENR USART8EN LL_APB1_GRP2_EnableClock
APB2ENR USART7EN LL_APB1_GRP2_EnableClock
APB2ENR USART6EN LL_APB1_GRP2_EnableClock
APB2ENR TIM1EN LL_APB1_GRP2_EnableClock
APB2ENR SPI1EN LL_APB1_GRP2_EnableClock
APB2ENR USART1EN LL_APB1_GRP2_EnableClock
APB2ENR TIM15EN LL_APB1_GRP2_EnableClock
APB2ENR TIM16EN LL_APB1_GRP2_EnableClock
APB2ENR TIM17EN LL_APB1_GRP2_EnableClock
APB2ENR DBGMCUEN LL_APB1_GRP2_EnableClock
LL_APB1_GRP2_IsEnabledClock
Function name
__STATIC_INLINE uint32_t LL_APB1_GRP2_IsEnabledClock
(uint32_t Periphs)
Function description
Check if APB1 peripheral clock is enabled or not (available in
register 2).
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_APB1_GRP2_PERIPH_SYSCFG
LL_APB1_GRP2_PERIPH_ADC1
LL_APB1_GRP2_PERIPH_USART8 (*)
LL_APB1_GRP2_PERIPH_USART7 (*)
LL_APB1_GRP2_PERIPH_USART6 (*)
LL_APB1_GRP2_PERIPH_TIM1
LL_APB1_GRP2_PERIPH_SPI1
LL_APB1_GRP2_PERIPH_USART1
LL_APB1_GRP2_PERIPH_TIM15 (*)
DocID026525 Rev 6
703/1320
LL BUS Generic Driver
UM1785
LL_APB1_GRP2_PERIPH_TIM16
LL_APB1_GRP2_PERIPH_TIM17
LL_APB1_GRP2_PERIPH_DBGMCU
Return values
State: of Periphs (1 or 0).
Reference Manual to
LL API cross
reference:
APB2ENR SYSCFGEN LL_APB1_GRP2_IsEnabledClock
APB2ENR ADC1EN LL_APB1_GRP2_IsEnabledClock
APB2ENR USART8EN LL_APB1_GRP2_IsEnabledClock
APB2ENR USART7EN LL_APB1_GRP2_IsEnabledClock
APB2ENR USART6EN LL_APB1_GRP2_IsEnabledClock
APB2ENR TIM1EN LL_APB1_GRP2_IsEnabledClock
APB2ENR SPI1EN LL_APB1_GRP2_IsEnabledClock
APB2ENR USART1EN LL_APB1_GRP2_IsEnabledClock
APB2ENR TIM15EN LL_APB1_GRP2_IsEnabledClock
APB2ENR TIM16EN LL_APB1_GRP2_IsEnabledClock
APB2ENR TIM17EN LL_APB1_GRP2_IsEnabledClock
APB2ENR DBGMCUEN LL_APB1_GRP2_IsEnabledClock
LL_APB1_GRP2_DisableClock
704/1320
Function name
__STATIC_INLINE void LL_APB1_GRP2_DisableClock
(uint32_t Periphs)
Function description
Disable APB1 peripherals clock (available in register 2).
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_APB1_GRP2_PERIPH_SYSCFG
LL_APB1_GRP2_PERIPH_ADC1
LL_APB1_GRP2_PERIPH_USART8 (*)
LL_APB1_GRP2_PERIPH_USART7 (*)
LL_APB1_GRP2_PERIPH_USART6 (*)
LL_APB1_GRP2_PERIPH_TIM1
LL_APB1_GRP2_PERIPH_SPI1
LL_APB1_GRP2_PERIPH_USART1
LL_APB1_GRP2_PERIPH_TIM15 (*)
LL_APB1_GRP2_PERIPH_TIM16
LL_APB1_GRP2_PERIPH_TIM17
LL_APB1_GRP2_PERIPH_DBGMCU
Return values
None
Reference Manual to
LL API cross
reference:
APB2ENR SYSCFGEN LL_APB1_GRP2_DisableClock
APB2ENR ADC1EN LL_APB1_GRP2_DisableClock
APB2ENR USART8EN LL_APB1_GRP2_DisableClock
APB2ENR USART7EN LL_APB1_GRP2_DisableClock
APB2ENR USART6EN LL_APB1_GRP2_DisableClock
APB2ENR TIM1EN LL_APB1_GRP2_DisableClock
APB2ENR SPI1EN LL_APB1_GRP2_DisableClock
APB2ENR USART1EN LL_APB1_GRP2_DisableClock
APB2ENR TIM15EN LL_APB1_GRP2_DisableClock
APB2ENR TIM16EN LL_APB1_GRP2_DisableClock
APB2ENR TIM17EN LL_APB1_GRP2_DisableClock
APB2ENR DBGMCUEN LL_APB1_GRP2_DisableClock
DocID026525 Rev 6
UM1785
LL BUS Generic Driver
LL_APB1_GRP2_ForceReset
Function name
__STATIC_INLINE void LL_APB1_GRP2_ForceReset (uint32_t
Periphs)
Function description
Force APB1 peripherals reset (available in register 2).
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_APB1_GRP2_PERIPH_ALL
LL_APB1_GRP2_PERIPH_SYSCFG
LL_APB1_GRP2_PERIPH_ADC1
LL_APB1_GRP2_PERIPH_USART8 (*)
LL_APB1_GRP2_PERIPH_USART7 (*)
LL_APB1_GRP2_PERIPH_USART6 (*)
LL_APB1_GRP2_PERIPH_TIM1
LL_APB1_GRP2_PERIPH_SPI1
LL_APB1_GRP2_PERIPH_USART1
LL_APB1_GRP2_PERIPH_TIM15 (*)
LL_APB1_GRP2_PERIPH_TIM16
LL_APB1_GRP2_PERIPH_TIM17
LL_APB1_GRP2_PERIPH_DBGMCU
Return values
None
Reference Manual to
LL API cross
reference:
APB2RSTR SYSCFGRST LL_APB1_GRP2_ForceReset
APB2RSTR ADC1RST LL_APB1_GRP2_ForceReset
APB2RSTR USART8RST LL_APB1_GRP2_ForceReset
APB2RSTR USART7RST LL_APB1_GRP2_ForceReset
APB2RSTR USART6RST LL_APB1_GRP2_ForceReset
APB2RSTR TIM1RST LL_APB1_GRP2_ForceReset
APB2RSTR SPI1RST LL_APB1_GRP2_ForceReset
APB2RSTR USART1RST LL_APB1_GRP2_ForceReset
APB2RSTR TIM15RST LL_APB1_GRP2_ForceReset
APB2RSTR TIM16RST LL_APB1_GRP2_ForceReset
APB2RSTR TIM17RST LL_APB1_GRP2_ForceReset
APB2RSTR DBGMCURST LL_APB1_GRP2_ForceReset
LL_APB1_GRP2_ReleaseReset
Function name
__STATIC_INLINE void LL_APB1_GRP2_ReleaseReset
(uint32_t Periphs)
Function description
Release APB1 peripherals reset (available in register 2).
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_APB1_GRP2_PERIPH_ALL
LL_APB1_GRP2_PERIPH_SYSCFG
LL_APB1_GRP2_PERIPH_ADC1
LL_APB1_GRP2_PERIPH_USART8 (*)
LL_APB1_GRP2_PERIPH_USART7 (*)
LL_APB1_GRP2_PERIPH_USART6 (*)
LL_APB1_GRP2_PERIPH_TIM1
LL_APB1_GRP2_PERIPH_SPI1
LL_APB1_GRP2_PERIPH_USART1
DocID026525 Rev 6
705/1320
LL BUS Generic Driver
UM1785
LL_APB1_GRP2_PERIPH_TIM15 (*)
LL_APB1_GRP2_PERIPH_TIM16
LL_APB1_GRP2_PERIPH_TIM17
LL_APB1_GRP2_PERIPH_DBGMCU
Return values
None
Reference Manual to
LL API cross
reference:
APB2RSTR SYSCFGRST LL_APB1_GRP2_ReleaseReset
APB2RSTR ADC1RST LL_APB1_GRP2_ReleaseReset
APB2RSTR USART8RST LL_APB1_GRP2_ReleaseReset
APB2RSTR USART7RST LL_APB1_GRP2_ReleaseReset
APB2RSTR USART6RST LL_APB1_GRP2_ReleaseReset
APB2RSTR TIM1RST LL_APB1_GRP2_ReleaseReset
APB2RSTR SPI1RST LL_APB1_GRP2_ReleaseReset
APB2RSTR USART1RST LL_APB1_GRP2_ReleaseReset
APB2RSTR TIM15RST LL_APB1_GRP2_ReleaseReset
APB2RSTR TIM16RST LL_APB1_GRP2_ReleaseReset
APB2RSTR TIM17RST LL_APB1_GRP2_ReleaseReset
APB2RSTR DBGMCURST LL_APB1_GRP2_ReleaseReset
50.2
BUS Firmware driver defines
50.2.1
BUS
AHB1 GRP1 PERIPH
LL_AHB1_GRP1_PERIPH_ALL
LL_AHB1_GRP1_PERIPH_DMA1
LL_AHB1_GRP1_PERIPH_DMA2
LL_AHB1_GRP1_PERIPH_SRAM
LL_AHB1_GRP1_PERIPH_FLASH
LL_AHB1_GRP1_PERIPH_CRC
LL_AHB1_GRP1_PERIPH_GPIOA
LL_AHB1_GRP1_PERIPH_GPIOB
LL_AHB1_GRP1_PERIPH_GPIOC
LL_AHB1_GRP1_PERIPH_GPIOD
LL_AHB1_GRP1_PERIPH_GPIOE
LL_AHB1_GRP1_PERIPH_GPIOF
LL_AHB1_GRP1_PERIPH_TSC
APB1 GRP1 PERIPH
LL_APB1_GRP1_PERIPH_ALL
LL_APB1_GRP1_PERIPH_TIM2
LL_APB1_GRP1_PERIPH_TIM3
LL_APB1_GRP1_PERIPH_TIM6
LL_APB1_GRP1_PERIPH_TIM7
706/1320
DocID026525 Rev 6
UM1785
LL BUS Generic Driver
LL_APB1_GRP1_PERIPH_TIM14
LL_APB1_GRP1_PERIPH_WWDG
LL_APB1_GRP1_PERIPH_SPI2
LL_APB1_GRP1_PERIPH_USART2
LL_APB1_GRP1_PERIPH_USART3
LL_APB1_GRP1_PERIPH_USART4
LL_APB1_GRP1_PERIPH_USART5
LL_APB1_GRP1_PERIPH_I2C1
LL_APB1_GRP1_PERIPH_I2C2
LL_APB1_GRP1_PERIPH_CAN
LL_APB1_GRP1_PERIPH_CRS
LL_APB1_GRP1_PERIPH_PWR
LL_APB1_GRP1_PERIPH_DAC1
LL_APB1_GRP1_PERIPH_CEC
APB1 GRP2 PERIPH
LL_APB1_GRP2_PERIPH_ALL
LL_APB1_GRP2_PERIPH_SYSCFG
LL_APB1_GRP2_PERIPH_ADC1
LL_APB1_GRP2_PERIPH_USART8
LL_APB1_GRP2_PERIPH_USART7
LL_APB1_GRP2_PERIPH_USART6
LL_APB1_GRP2_PERIPH_TIM1
LL_APB1_GRP2_PERIPH_SPI1
LL_APB1_GRP2_PERIPH_USART1
LL_APB1_GRP2_PERIPH_TIM15
LL_APB1_GRP2_PERIPH_TIM16
LL_APB1_GRP2_PERIPH_TIM17
LL_APB1_GRP2_PERIPH_DBGMCU
DocID026525 Rev 6
707/1320
LL COMP Generic Driver
UM1785
51
LL COMP Generic Driver
51.1
COMP Firmware driver registers structures
51.1.1
LL_COMP_InitTypeDef
Data Fields
uint32_t PowerMode
uint32_t InputPlus
uint32_t InputMinus
uint32_t InputHysteresis
uint32_t OutputSelection
uint32_t OutputPolarity
Field Documentation
uint32_t LL_COMP_InitTypeDef::PowerMode
Set comparator operating mode to adjust power and speed. This parameter can be a
value of COMP_LL_EC_POWERMODEThis feature can be modified afterwards using
unitary function LL_COMP_SetPowerMode().
uint32_t LL_COMP_InitTypeDef::InputPlus
Set comparator input plus (non-inverting input). This parameter can be a value of
COMP_LL_EC_INPUT_PLUSThis feature can be modified afterwards using unitary
function LL_COMP_SetInputPlus().
uint32_t LL_COMP_InitTypeDef::InputMinus
Set comparator input minus (inverting input). This parameter can be a value of
COMP_LL_EC_INPUT_MINUSThis feature can be modified afterwards using unitary
function LL_COMP_SetInputMinus().
uint32_t LL_COMP_InitTypeDef::InputHysteresis
Set comparator hysteresis mode of the input minus. This parameter can be a value of
COMP_LL_EC_INPUT_HYSTERESISThis feature can be modified afterwards using
unitary function LL_COMP_SetInputHysteresis().
uint32_t LL_COMP_InitTypeDef::OutputSelection
Set comparator output selection. This parameter can be a value of
COMP_LL_EC_OUTPUT_SELECTIONThis feature can be modified afterwards using
unitary function LL_COMP_SetOutputSelection().
uint32_t LL_COMP_InitTypeDef::OutputPolarity
Set comparator output polarity. This parameter can be a value of
COMP_LL_EC_OUTPUT_POLARITYThis feature can be modified afterwards using
unitary function LL_COMP_SetOutputPolarity().
708/1320
DocID026525 Rev 6
UM1785
LL COMP Generic Driver
51.2
COMP Firmware driver API description
51.2.1
Detailed description of functions
LL_COMP_SetCommonWindowMode
Function
name
__STATIC_INLINE void LL_COMP_SetCommonWindowMode
(COMP_Common_TypeDef * COMPxy_COMMON, uint32_t
WindowMode)
Function
description
Set window mode of a pair of comparators instances (2 consecutive COMP
instances odd and even COMP and COMP).
Parameters
COMPxy_COMMON: Comparator common instance (can be set
directly from CMSIS definition or by using helper macro
__LL_COMP_COMMON_INSTANCE() )
WindowMode: This parameter can be one of the following values:
LL_COMP_WINDOWMODE_DISABLE
LL_COMP_WINDOWMODE_COMP1_INPUT_PLUS_COMMON
Return
values
None
Reference
Manual to
LL API
cross
reference:
CSR WNDWEN LL_COMP_SetCommonWindowMode
LL_COMP_GetCommonWindowMode
Function
name
__STATIC_INLINE uint32_t LL_COMP_GetCommonWindowMode
(COMP_Common_TypeDef * COMPxy_COMMON)
Function
description
Get window mode of a pair of comparators instances (2 consecutive COMP
instances odd and even COMP and COMP).
Parameters
COMPxy_COMMON: Comparator common instance (can be set
directly from CMSIS definition or by using helper macro
__LL_COMP_COMMON_INSTANCE() )
Return
values
Returned: value can be one of the following values:
LL_COMP_WINDOWMODE_DISABLE
LL_COMP_WINDOWMODE_COMP1_INPUT_PLUS_COMMON
Reference
Manual to
LL API cross
reference:
CSR WNDWEN LL_COMP_GetCommonWindowMode
LL_COMP_SetPowerMode
Function name
__STATIC_INLINE void LL_COMP_SetPowerMode
(COMP_TypeDef * COMPx, uint32_t PowerMode)
Function description
Set comparator instance operating mode to adjust power and
speed.
Parameters
COMPx: Comparator instance
DocID026525 Rev 6
709/1320
LL COMP Generic Driver
UM1785
PowerMode: This parameter can be one of the following
values:
LL_COMP_POWERMODE_HIGHSPEED
LL_COMP_POWERMODE_MEDIUMSPEED
LL_COMP_POWERMODE_LOWPOWER
LL_COMP_POWERMODE_ULTRALOWPOWER
Return values
None
Reference Manual to
LL API cross
reference:
CSR COMP1MODE LL_COMP_SetPowerMode
COMP2MODE LL_COMP_SetPowerMode
LL_COMP_GetPowerMode
Function name
__STATIC_INLINE uint32_t LL_COMP_GetPowerMode
(COMP_TypeDef * COMPx)
Function description
Get comparator instance operating mode to adjust power and
speed.
Parameters
COMPx: Comparator instance
Return values
Returned: value can be one of the following values:
LL_COMP_POWERMODE_HIGHSPEED
LL_COMP_POWERMODE_MEDIUMSPEED
LL_COMP_POWERMODE_LOWPOWER
LL_COMP_POWERMODE_ULTRALOWPOWER
Reference Manual to
LL API cross
reference:
CSR COMP1MODE LL_COMP_GetPowerMode
COMP2MODE LL_COMP_GetPowerMode
LL_COMP_ConfigInputs
Function name
__STATIC_INLINE void LL_COMP_ConfigInputs
(COMP_TypeDef * COMPx, uint32_t InputMinus, uint32_t
InputPlus)
Function description
Set comparator inputs minus (inverting) and plus (non-inverting).
Parameters
710/1320
COMPx: Comparator instance
InputMinus: This parameter can be one of the following
values:
LL_COMP_INPUT_MINUS_1_4VREFINT
LL_COMP_INPUT_MINUS_1_2VREFINT
LL_COMP_INPUT_MINUS_3_4VREFINT
LL_COMP_INPUT_MINUS_VREFINT
LL_COMP_INPUT_MINUS_DAC1_CH1
LL_COMP_INPUT_MINUS_DAC1_CH2
LL_COMP_INPUT_MINUS_IO1
InputPlus: This parameter can be one of the following
values: (1) Parameter available only on COMP instance:
COMP1.
LL_COMP_INPUT_PLUS_IO1
LL_COMP_INPUT_PLUS_DAC1_CH1 (1)
DocID026525 Rev 6
UM1785
LL COMP Generic Driver
Return values
None
Notes
In case of comparator input selected to be connected to IO:
GPIO pins are specific to each comparator instance. Refer to
description of parameters or to reference manual.
Reference Manual to
LL API cross
reference:
CSR COMP1INSEL LL_COMP_ConfigInputs
CSR COMP2INSEL LL_COMP_ConfigInputs
CSR COMP1SW1 LL_COMP_ConfigInputs
LL_COMP_SetInputPlus
Function name
__STATIC_INLINE void LL_COMP_SetInputPlus
(COMP_TypeDef * COMPx, uint32_t InputPlus)
Function description
Set comparator input plus (non-inverting).
Parameters
COMPx: Comparator instance
InputPlus: This parameter can be one of the following
values: (1) Parameter available only on COMP instance:
COMP1.
LL_COMP_INPUT_PLUS_IO1
LL_COMP_INPUT_PLUS_DAC1_CH1 (1)
Return values
None
Notes
In case of comparator input selected to be connected to IO:
GPIO pins are specific to each comparator instance. Refer to
description of parameters or to reference manual.
Reference Manual to
LL API cross
reference:
CSR COMP1INSEL LL_COMP_SetInputPlus
CSR COMP2INSEL LL_COMP_SetInputPlus
LL_COMP_GetInputPlus
Function name
__STATIC_INLINE uint32_t LL_COMP_GetInputPlus
(COMP_TypeDef * COMPx)
Function description
Get comparator input plus (non-inverting).
Parameters
COMPx: Comparator instance
Return values
Returned: value can be one of the following values: (1)
Parameter available only on COMP instance: COMP1.
LL_COMP_INPUT_PLUS_IO1
LL_COMP_INPUT_PLUS_DAC1_CH1 (1)
Notes
In case of comparator input selected to be connected to IO:
GPIO pins are specific to each comparator instance. Refer to
description of parameters or to reference manual.
Reference Manual to
LL API cross
reference:
CSR COMP1INSEL LL_COMP_GetInputPlus
CSR COMP2INSEL LL_COMP_GetInputPlus
DocID026525 Rev 6
711/1320
LL COMP Generic Driver
UM1785
LL_COMP_SetInputMinus
Function name
__STATIC_INLINE void LL_COMP_SetInputMinus
(COMP_TypeDef * COMPx, uint32_t InputMinus)
Function description
Set comparator input minus (inverting).
Parameters
COMPx: Comparator instance
InputMinus: This parameter can be one of the following
values:
LL_COMP_INPUT_MINUS_1_4VREFINT
LL_COMP_INPUT_MINUS_1_2VREFINT
LL_COMP_INPUT_MINUS_3_4VREFINT
LL_COMP_INPUT_MINUS_VREFINT
LL_COMP_INPUT_MINUS_DAC1_CH1
LL_COMP_INPUT_MINUS_DAC1_CH2
LL_COMP_INPUT_MINUS_IO1
Return values
None
Notes
In case of comparator input selected to be connected to IO:
GPIO pins are specific to each comparator instance. Refer to
description of parameters or to reference manual.
Reference Manual to
LL API cross
reference:
CSR COMP1SW1 LL_COMP_SetInputMinus
LL_COMP_GetInputMinus
712/1320
Function name
__STATIC_INLINE uint32_t LL_COMP_GetInputMinus
(COMP_TypeDef * COMPx)
Function description
Get comparator input minus (inverting).
Parameters
COMPx: Comparator instance
Return values
Returned: value can be one of the following values:
LL_COMP_INPUT_MINUS_1_4VREFINT
LL_COMP_INPUT_MINUS_1_2VREFINT
LL_COMP_INPUT_MINUS_3_4VREFINT
LL_COMP_INPUT_MINUS_VREFINT
LL_COMP_INPUT_MINUS_DAC1_CH1
LL_COMP_INPUT_MINUS_DAC1_CH2
LL_COMP_INPUT_MINUS_IO1
Notes
In case of comparator input selected to be connected to IO:
GPIO pins are specific to each comparator instance. Refer to
description of parameters or to reference manual.
Reference Manual to
LL API cross
reference:
CSR COMP1SW1 LL_COMP_GetInputMinus
DocID026525 Rev 6
UM1785
LL COMP Generic Driver
LL_COMP_SetInputHysteresis
Function name
__STATIC_INLINE void LL_COMP_SetInputHysteresis
(COMP_TypeDef * COMPx, uint32_t InputHysteresis)
Function description
Set comparator instance hysteresis mode of the input minus
(inverting input).
Parameters
COMPx: Comparator instance
InputHysteresis: This parameter can be one of the following
values:
LL_COMP_HYSTERESIS_NONE
LL_COMP_HYSTERESIS_LOW
LL_COMP_HYSTERESIS_MEDIUM
LL_COMP_HYSTERESIS_HIGH
Return values
None
Reference Manual to
LL API cross
reference:
CSR COMP1HYST LL_COMP_SetInputHysteresis
COMP2HYST LL_COMP_SetInputHysteresis
LL_COMP_GetInputHysteresis
Function name
__STATIC_INLINE uint32_t LL_COMP_GetInputHysteresis
(COMP_TypeDef * COMPx)
Function description
Get comparator instance hysteresis mode of the minus (inverting)
input.
Parameters
COMPx: Comparator instance
Return values
Returned: value can be one of the following values:
LL_COMP_HYSTERESIS_NONE
LL_COMP_HYSTERESIS_LOW
LL_COMP_HYSTERESIS_MEDIUM
LL_COMP_HYSTERESIS_HIGH
Reference Manual to
LL API cross
reference:
CSR COMP1HYST LL_COMP_GetInputHysteresis
COMP2HYST LL_COMP_GetInputHysteresis
LL_COMP_SetOutputSelection
Function name
__STATIC_INLINE void LL_COMP_SetOutputSelection
(COMP_TypeDef * COMPx, uint32_t OutputSelection)
Function description
Set comparator output selection.
Parameters
COMPx: Comparator instance
OutputSelection: This parameter can be one of the
following values: (1) Parameter availability depending on
timer availability on the selected device.
LL_COMP_OUTPUT_NONE
LL_COMP_OUTPUT_TIM1_BKIN (1)
LL_COMP_OUTPUT_TIM1_IC1 (1)
LL_COMP_OUTPUT_TIM1_OCCLR (1)
LL_COMP_OUTPUT_TIM2_IC4 (1)
LL_COMP_OUTPUT_TIM2_OCCLR (1)
DocID026525 Rev 6
713/1320
LL COMP Generic Driver
UM1785
LL_COMP_OUTPUT_TIM3_IC1 (1)
LL_COMP_OUTPUT_TIM3_OCCLR (1)
Return values
None
Notes
Availability of parameters of output selection to timer depends
on timers availability on the selected device.
Reference Manual to
LL API cross
reference:
CSR COMP1OUTSEL LL_COMP_SetOutputSelection
COMP2OUTSEL LL_COMP_SetOutputSelection
LL_COMP_GetOutputSelection
Function name
__STATIC_INLINE uint32_t LL_COMP_GetOutputSelection
(COMP_TypeDef * COMPx)
Function description
Get comparator output selection.
Parameters
COMPx: Comparator instance
Return values
Returned: value can be one of the following values: (1)
Parameter availability depending on timer availability on the
selected device.
LL_COMP_OUTPUT_NONE
LL_COMP_OUTPUT_TIM1_BKIN (1)
LL_COMP_OUTPUT_TIM1_IC1 (1)
LL_COMP_OUTPUT_TIM1_OCCLR (1)
LL_COMP_OUTPUT_TIM2_IC4 (1)
LL_COMP_OUTPUT_TIM2_OCCLR (1)
LL_COMP_OUTPUT_TIM3_IC1 (1)
LL_COMP_OUTPUT_TIM3_OCCLR (1)
Notes
Availability of parameters of output selection to timer depends
on timers availability on the selected device.
Reference Manual to
LL API cross
reference:
CSR COMP1OUTSEL LL_COMP_GetOutputSelection
COMP2OUTSEL LL_COMP_GetOutputSelection
LL_COMP_SetOutputPolarity
714/1320
Function name
__STATIC_INLINE void LL_COMP_SetOutputPolarity
(COMP_TypeDef * COMPx, uint32_t OutputPolarity)
Function description
Set comparator instance output polarity.
Parameters
COMPx: Comparator instance
OutputPolarity: This parameter can be one of the following
values:
LL_COMP_OUTPUTPOL_NONINVERTED
LL_COMP_OUTPUTPOL_INVERTED
Return values
None
Reference Manual to
LL API cross
reference:
CSR COMP1POL LL_COMP_SetOutputPolarity
COMP2POL LL_COMP_SetOutputPolarity
DocID026525 Rev 6
UM1785
LL COMP Generic Driver
LL_COMP_GetOutputPolarity
Function name
__STATIC_INLINE uint32_t LL_COMP_GetOutputPolarity
(COMP_TypeDef * COMPx)
Function description
Get comparator instance output polarity.
Parameters
COMPx: Comparator instance
Return values
Returned: value can be one of the following values:
LL_COMP_OUTPUTPOL_NONINVERTED
LL_COMP_OUTPUTPOL_INVERTED
Reference Manual to
LL API cross
reference:
CSR COMP1POL LL_COMP_GetOutputPolarity
COMP2POL LL_COMP_GetOutputPolarity
LL_COMP_Enable
Function name
__STATIC_INLINE void LL_COMP_Enable (COMP_TypeDef *
COMPx)
Function description
Enable comparator instance.
Parameters
COMPx: Comparator instance
Return values
None
Notes
After enable from off state, comparator requires a delay to
reach reach propagation delay specification. Refer to device
datasheet, parameter "tSTART".
Reference Manual to
LL API cross
reference:
CSR COMP1EN LL_COMP_Enable
CSR COMP2EN LL_COMP_Enable
LL_COMP_Disable
Function name
__STATIC_INLINE void LL_COMP_Disable (COMP_TypeDef *
COMPx)
Function description
Disable comparator instance.
Parameters
COMPx: Comparator instance
Return values
None
Reference Manual to
LL API cross
reference:
CSR COMP1EN LL_COMP_Disable
CSR COMP2EN LL_COMP_Disable
LL_COMP_IsEnabled
Function name
__STATIC_INLINE uint32_t LL_COMP_IsEnabled
(COMP_TypeDef * COMPx)
Function description
Get comparator enable state (0: COMP is disabled, 1: COMP is
enabled)
Parameters
COMPx: Comparator instance
Return values
State: of bit (1 or 0).
DocID026525 Rev 6
715/1320
LL COMP Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
CSR COMP1EN LL_COMP_IsEnabled
CSR COMP2EN LL_COMP_IsEnabled
LL_COMP_Lock
Function name
__STATIC_INLINE void LL_COMP_Lock (COMP_TypeDef *
COMPx)
Function description
Lock comparator instance.
Parameters
COMPx: Comparator instance
Return values
None
Notes
Once locked, comparator configuration can be accessed in
read-only.
The only way to unlock the comparator is a device hardware
reset.
Reference Manual to
LL API cross
reference:
CSR COMP1LOCK LL_COMP_Lock
CSR COMP2LOCK LL_COMP_Lock
LL_COMP_IsLocked
Function name
__STATIC_INLINE uint32_t LL_COMP_IsLocked
(COMP_TypeDef * COMPx)
Function description
Get comparator lock state (0: COMP is unlocked, 1: COMP is
locked).
Parameters
COMPx: Comparator instance
Return values
State: of bit (1 or 0).
Notes
Once locked, comparator configuration can be accessed in
read-only.
The only way to unlock the comparator is a device hardware
reset.
Reference Manual to
LL API cross
reference:
CSR COMP1LOCK LL_COMP_IsLocked
CSR COMP2LOCK LL_COMP_IsLocked
LL_COMP_ReadOutputLevel
716/1320
Function name
__STATIC_INLINE uint32_t LL_COMP_ReadOutputLevel
(COMP_TypeDef * COMPx)
Function description
Read comparator instance output level.
Parameters
COMPx: Comparator instance
Return values
Returned: value can be one of the following values:
LL_COMP_OUTPUT_LEVEL_LOW
LL_COMP_OUTPUT_LEVEL_HIGH
Notes
The comparator output level depends on the selected polarity
(Refer to function LL_COMP_SetOutputPolarity()). If the
comparator polarity is not inverted: Comparator output is low
DocID026525 Rev 6
UM1785
LL COMP Generic Driver
when the input plus is at a lower voltage than the input
minusComparator output is high when the input plus is at a
higher voltage than the input minus If the comparator polarity
is inverted:Comparator output is high when the input plus is at
a lower voltage than the input minusComparator output is low
when the input plus is at a higher voltage than the input minus
Reference Manual to
LL API cross
reference:
CSR COMP1OUT LL_COMP_ReadOutputLevel
CSR COMP2OUT LL_COMP_ReadOutputLevel
LL_COMP_DeInit
Function name
ErrorStatus LL_COMP_DeInit (COMP_TypeDef * COMPx)
Function description
De-initialize registers of the selected COMP instance to their
default reset values.
Parameters
COMPx: COMP instance
Return values
An: ErrorStatus enumeration value:
SUCCESS: COMP registers are de-initialized
ERROR: COMP registers are not de-initialized
Notes
If comparator is locked, de-initialization by software is not
possible. The only way to unlock the comparator is a device
hardware reset.
LL_COMP_Init
Function name
ErrorStatus LL_COMP_Init (COMP_TypeDef * COMPx,
LL_COMP_InitTypeDef * COMP_InitStruct)
Function description
Initialize some features of COMP instance.
Parameters
COMPx: COMP instance
COMP_InitStruct: Pointer to a LL_COMP_InitTypeDef
structure
Return values
An: ErrorStatus enumeration value:
SUCCESS: COMP registers are initialized
ERROR: COMP registers are not initialized
Notes
This function configures features of the selected COMP
instance. Some features are also available at scope COMP
common instance (common to several COMP instances).
Refer to functions having argument "COMPxy_COMMON" as
parameter.
LL_COMP_StructInit
Function name
void LL_COMP_StructInit (LL_COMP_InitTypeDef *
COMP_InitStruct)
Function description
Set each LL_COMP_InitTypeDef field to default value.
Parameters
COMP_InitStruct: pointer to a LL_COMP_InitTypeDef
structure whose fields will be set to default values.
DocID026525 Rev 6
717/1320
LL COMP Generic Driver
Return values
UM1785
None
51.3
COMP Firmware driver defines
51.3.1
COMP
Comparator common modes - Window mode
LL_COMP_WINDOWMODE_DISABLE
Window mode disable:
Comparators 1 and 2
are independent
LL_COMP_WINDOWMODE_COMP1_INPUT_PLUS_COMMON
Window mode enable:
Comparators instances
pair COMP1 and
COMP2 have their
input plus connected
together. The common
input is COMP1 input
plus (COMP2 input plus
is no more accessible).
Definitions of COMP hardware constraints delays
LL_COMP_DELAY_STARTUP_US
Delay for COMP startup time
LL_COMP_DELAY_VOLTAGE_SCALER_STAB_US
Delay for COMP voltage scaler
stabilization time
Comparator input - Hysteresis
LL_COMP_HYSTERESIS_NONE
No hysteresis
LL_COMP_HYSTERESIS_LOW
Hysteresis level low
LL_COMP_HYSTERESIS_MEDIUM
Hysteresis level medium
LL_COMP_HYSTERESIS_HIGH
Hysteresis level high
Comparator inputs - Input minus (input inverting) selection
LL_COMP_INPUT_MINUS_1_4VREFINT
Comparator input minus connected to 1/4
VrefInt
LL_COMP_INPUT_MINUS_1_2VREFINT
Comparator input minus connected to 1/2
VrefInt
LL_COMP_INPUT_MINUS_3_4VREFINT
Comparator input minus connected to 3/4
VrefInt
LL_COMP_INPUT_MINUS_VREFINT
Comparator input minus connected to VrefInt
LL_COMP_INPUT_MINUS_DAC1_CH1
Comparator input minus connected to DAC1
channel 1 (DAC_OUT1)
LL_COMP_INPUT_MINUS_DAC1_CH2
Comparator input minus connected to DAC1
channel 2 (DAC_OUT2)
LL_COMP_INPUT_MINUS_IO1
Comparator input minus connected to IO1 (pin
PA0 for COMP1, pin PA2 for COMP2)
Comparator inputs - Input plus (input non-inverting) selection
LL_COMP_INPUT_PLUS_IO1
718/1320
Comparator input plus connected to IO1 (pin PA1
DocID026525 Rev 6
UM1785
LL COMP Generic Driver
for COMP1, pin PA3 for COMP2)
LL_COMP_INPUT_PLUS_DAC1_CH1
Comparator input plus connected to DAC1
channel 1 (DAC_OUT1), through dedicated
switch (Note: this switch is solely intended to
redirect signals onto high impedance input, such
as COMP1 input plus (highly resistive switch))
(specific to COMP instance: COMP1)
Comparator output - Output level
LL_COMP_OUTPUT_LEVEL_LOW
Comparator output level low (if the polarity is not
inverted, otherwise to be complemented)
LL_COMP_OUTPUT_LEVEL_HIGH
Comparator output level high (if the polarity is not
inverted, otherwise to be complemented)
Comparator output - Output polarity
LL_COMP_OUTPUTPOL_NONINVERTED
COMP output polarity is not inverted:
comparator output is high when the plus
(non-inverting) input is at a higher voltage
than the minus (inverting) input
LL_COMP_OUTPUTPOL_INVERTED
COMP output polarity is inverted: comparator
output is low when the plus (non-inverting)
input is at a lower voltage than the minus
(inverting) input
Comparator output - Output selection
LL_COMP_OUTPUT_NONE
COMP output is not connected to other peripherals
(except GPIO and EXTI that are always connected
to COMP output)
LL_COMP_OUTPUT_TIM1_BKIN
COMP output connected to TIM1 break input
(BKIN)
LL_COMP_OUTPUT_TIM1_IC1
COMP output connected to TIM1 input capture 1
LL_COMP_OUTPUT_TIM1_OCCLR
COMP output connected to TIM1 OCREF clear
LL_COMP_OUTPUT_TIM2_IC4
COMP output connected to TIM2 input capture 4
LL_COMP_OUTPUT_TIM2_OCCLR
COMP output connected to TIM2 OCREF clear
LL_COMP_OUTPUT_TIM3_IC1
COMP output connected to TIM3 input capture 1
LL_COMP_OUTPUT_TIM3_OCCLR
COMP output connected to TIM3 OCREF clear
Comparator modes - Power mode
LL_COMP_POWERMODE_HIGHSPEED
COMP power mode to high speed
LL_COMP_POWERMODE_MEDIUMSPEED
COMP power mode to medium speed
LL_COMP_POWERMODE_LOWPOWER
COMP power mode to low power
LL_COMP_POWERMODE_ULTRALOWPOWER
COMP power mode to ultra-low power
COMP helper macro
__LL_COMP_COMMON_INSTANCE
Description:
Helper macro to select the COMP common
instance to which is belonging the selected
DocID026525 Rev 6
719/1320
LL COMP Generic Driver
UM1785
COMP instance.
Parameters:
__COMPx__: COMP instance
Return value:
COMP: common instance or value "0" if there
is no COMP common instance.
Notes:
COMP common register instance can be used
to set parameters common to several COMP
instances. Refer to functions having argument
"COMPxy_COMMON" as parameter.
Common write and read registers macro
LL_COMP_WriteReg
Description:
Write a value in COMP register.
Parameters:
__INSTANCE__: comparator instance
__REG__: Register to be written
__VALUE__: Value to be written in the register
Return value:
None
LL_COMP_ReadReg
Description:
Read a value in COMP register.
Parameters:
__INSTANCE__: comparator instance
__REG__: Register to be read
Return value:
Register: value
720/1320
DocID026525 Rev 6
UM1785
LL CORTEX Generic Driver
52
LL CORTEX Generic Driver
52.1
CORTEX Firmware driver API description
52.1.1
Detailed description of functions
LL_SYSTICK_IsActiveCounterFlag
Function name
__STATIC_INLINE uint32_t LL_SYSTICK_IsActiveCounterFlag
(void )
Function description
This function checks if the Systick counter flag is active or not.
Return values
State: of bit (1 or 0).
Notes
It can be used in timeout function on application side.
Reference Manual to
LL API cross
reference:
STK_CTRL COUNTFLAG LL_SYSTICK_IsActiveCounterFlag
LL_SYSTICK_SetClkSource
Function name
__STATIC_INLINE void LL_SYSTICK_SetClkSource (uint32_t
Source)
Function description
Configures the SysTick clock source.
Parameters
Source: This parameter can be one of the following values:
LL_SYSTICK_CLKSOURCE_HCLK_DIV8
LL_SYSTICK_CLKSOURCE_HCLK
Return values
None
Reference Manual to
LL API cross
reference:
STK_CTRL CLKSOURCE LL_SYSTICK_SetClkSource
LL_SYSTICK_GetClkSource
Function name
__STATIC_INLINE uint32_t LL_SYSTICK_GetClkSource (void )
Function description
Get the SysTick clock source.
Return values
Returned: value can be one of the following values:
LL_SYSTICK_CLKSOURCE_HCLK_DIV8
LL_SYSTICK_CLKSOURCE_HCLK
Reference Manual to
LL API cross
reference:
STK_CTRL CLKSOURCE LL_SYSTICK_GetClkSource
LL_SYSTICK_EnableIT
Function name
__STATIC_INLINE void LL_SYSTICK_EnableIT (void )
Function description
Enable SysTick exception request.
DocID026525 Rev 6
721/1320
LL CORTEX Generic Driver
Return values
UM1785
None
Reference Manual to
LL API cross
reference:
STK_CTRL TICKINT LL_SYSTICK_EnableIT
LL_SYSTICK_DisableIT
Function name
__STATIC_INLINE void LL_SYSTICK_DisableIT (void )
Function description
Disable SysTick exception request.
Return values
None
Reference Manual to
LL API cross
reference:
STK_CTRL TICKINT LL_SYSTICK_DisableIT
LL_SYSTICK_IsEnabledIT
Function name
__STATIC_INLINE uint32_t LL_SYSTICK_IsEnabledIT (void )
Function description
Checks if the SYSTICK interrupt is enabled or disabled.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
STK_CTRL TICKINT LL_SYSTICK_IsEnabledIT
LL_LPM_EnableSleep
Function name
__STATIC_INLINE void LL_LPM_EnableSleep (void )
Function description
Processor uses sleep as its low power mode.
Return values
None
Reference Manual to
LL API cross
reference:
SCB_SCR SLEEPDEEP LL_LPM_EnableSleep
LL_LPM_EnableDeepSleep
Function name
__STATIC_INLINE void LL_LPM_EnableDeepSleep (void )
Function description
Processor uses deep sleep as its low power mode.
Return values
None
Reference Manual to
LL API cross
reference:
SCB_SCR SLEEPDEEP LL_LPM_EnableDeepSleep
LL_LPM_EnableSleepOnExit
722/1320
Function name
__STATIC_INLINE void LL_LPM_EnableSleepOnExit (void )
Function description
Configures sleep-on-exit when returning from Handler mode to
Thread mode.
DocID026525 Rev 6
UM1785
LL CORTEX Generic Driver
Return values
None
Notes
Setting this bit to 1 enables an interrupt-driven application to
avoid returning to an empty main application.
Reference Manual to
LL API cross
reference:
SCB_SCR SLEEPONEXIT LL_LPM_EnableSleepOnExit
LL_LPM_DisableSleepOnExit
Function name
__STATIC_INLINE void LL_LPM_DisableSleepOnExit (void )
Function description
Do not sleep when returning to Thread mode.
Return values
None
Reference Manual to
LL API cross
reference:
SCB_SCR SLEEPONEXIT LL_LPM_DisableSleepOnExit
LL_LPM_EnableEventOnPend
Function name
__STATIC_INLINE void LL_LPM_EnableEventOnPend (void )
Function description
Enabled events and all interrupts, including disabled interrupts,
can wakeup the processor.
Return values
None
Reference Manual to
LL API cross
reference:
SCB_SCR SEVEONPEND LL_LPM_EnableEventOnPend
LL_LPM_DisableEventOnPend
Function name
__STATIC_INLINE void LL_LPM_DisableEventOnPend (void )
Function description
Only enabled interrupts or events can wakeup the processor,
disabled interrupts are excluded.
Return values
None
Reference Manual to
LL API cross
reference:
SCB_SCR SEVEONPEND LL_LPM_DisableEventOnPend
LL_CPUID_GetImplementer
Function name
__STATIC_INLINE uint32_t LL_CPUID_GetImplementer (void )
Function description
Get Implementer code.
Return values
Value: should be equal to 0x41 for ARM
Reference Manual to
LL API cross
reference:
SCB_CPUID IMPLEMENTER LL_CPUID_GetImplementer
DocID026525 Rev 6
723/1320
LL CORTEX Generic Driver
UM1785
LL_CPUID_GetVariant
Function name
__STATIC_INLINE uint32_t LL_CPUID_GetVariant (void )
Function description
Get Variant number (The r value in the rnpn product revision
identifier)
Return values
Value: between 0 and 255 (0x0: revision 0)
Reference Manual to
LL API cross
reference:
SCB_CPUID VARIANT LL_CPUID_GetVariant
LL_CPUID_GetArchitecture
Function name
__STATIC_INLINE uint32_t LL_CPUID_GetArchitecture (void )
Function description
Get Architecture number.
Return values
Value: should be equal to 0xC for Cortex-M0 devices
Reference Manual to
LL API cross
reference:
SCB_CPUID ARCHITECTURE LL_CPUID_GetArchitecture
LL_CPUID_GetParNo
Function name
__STATIC_INLINE uint32_t LL_CPUID_GetParNo (void )
Function description
Get Part number.
Return values
Value: should be equal to 0xC20 for Cortex-M0
Reference Manual to
LL API cross
reference:
SCB_CPUID PARTNO LL_CPUID_GetParNo
LL_CPUID_GetRevision
Function name
__STATIC_INLINE uint32_t LL_CPUID_GetRevision (void )
Function description
Get Revision number (The p value in the rnpn product revision
identifier, indicates patch release)
Return values
Value: between 0 and 255 (0x1: patch 1)
Reference Manual to
LL API cross
reference:
SCB_CPUID REVISION LL_CPUID_GetRevision
52.2
CORTEX Firmware driver defines
52.2.1
CORTEX
SYSTICK Clock Source
724/1320
LL_SYSTICK_CLKSOURCE_HCLK_DIV8
AHB clock divided by 8 selected as SysTick
clock source.
LL_SYSTICK_CLKSOURCE_HCLK
AHB clock selected as SysTick clock source.
DocID026525 Rev 6
UM1785
LL CRC Generic Driver
53
LL CRC Generic Driver
53.1
CRC Firmware driver API description
53.1.1
Detailed description of functions
LL_CRC_ResetCRCCalculationUnit
Function name
__STATIC_INLINE void LL_CRC_ResetCRCCalculationUnit
(CRC_TypeDef * CRCx)
Function description
Reset the CRC calculation unit.
Parameters
CRCx: CRC Instance
Return values
None
Notes
If Programmable Initial CRC value feature is available, also
set the Data Register to the value stored in the CRC_INIT
register, otherwise, reset Data Register to its default value.
Reference Manual to
LL API cross
reference:
CR RESET LL_CRC_ResetCRCCalculationUnit
LL_CRC_SetPolynomialSize
Function name
__STATIC_INLINE void LL_CRC_SetPolynomialSize
(CRC_TypeDef * CRCx, uint32_t PolySize)
Function description
Configure size of the polynomial.
Parameters
CRCx: CRC Instance
PolySize: This parameter can be one of the following values:
LL_CRC_POLYLENGTH_32B
LL_CRC_POLYLENGTH_16B
LL_CRC_POLYLENGTH_8B
LL_CRC_POLYLENGTH_7B
Return values
None
Notes
This function is available only on devices supporting
Programmable Polynomial feature.
Reference Manual to
LL API cross
reference:
CR POLYSIZE LL_CRC_SetPolynomialSize
LL_CRC_GetPolynomialSize
Function name
__STATIC_INLINE uint32_t LL_CRC_GetPolynomialSize
(CRC_TypeDef * CRCx)
Function description
Return size of the polynomial.
Parameters
CRCx: CRC Instance
DocID026525 Rev 6
725/1320
LL CRC Generic Driver
Return values
UM1785
Returned: value can be one of the following values:
LL_CRC_POLYLENGTH_32B
LL_CRC_POLYLENGTH_16B
LL_CRC_POLYLENGTH_8B
LL_CRC_POLYLENGTH_7B
Notes
This function is available only on devices supporting
Programmable Polynomial feature.
Reference Manual to
LL API cross
reference:
CR POLYSIZE LL_CRC_GetPolynomialSize
LL_CRC_SetInputDataReverseMode
Function name
__STATIC_INLINE void LL_CRC_SetInputDataReverseMode
(CRC_TypeDef * CRCx, uint32_t ReverseMode)
Function description
Configure the reversal of the bit order of the input data.
Parameters
CRCx: CRC Instance
ReverseMode: This parameter can be one of the following
values:
LL_CRC_INDATA_REVERSE_NONE
LL_CRC_INDATA_REVERSE_BYTE
LL_CRC_INDATA_REVERSE_HALFWORD
LL_CRC_INDATA_REVERSE_WORD
Return values
None
Reference Manual to
LL API cross
reference:
CR REV_IN LL_CRC_SetInputDataReverseMode
LL_CRC_GetInputDataReverseMode
Function name
__STATIC_INLINE uint32_t
LL_CRC_GetInputDataReverseMode (CRC_TypeDef * CRCx)
Function description
Return type of reversal for input data bit order.
Parameters
CRCx: CRC Instance
Return values
Returned: value can be one of the following values:
LL_CRC_INDATA_REVERSE_NONE
LL_CRC_INDATA_REVERSE_BYTE
LL_CRC_INDATA_REVERSE_HALFWORD
LL_CRC_INDATA_REVERSE_WORD
Reference Manual to
LL API cross
reference:
CR REV_IN LL_CRC_GetInputDataReverseMode
LL_CRC_SetOutputDataReverseMode
726/1320
Function name
__STATIC_INLINE void LL_CRC_SetOutputDataReverseMode
(CRC_TypeDef * CRCx, uint32_t ReverseMode)
Function description
Configure the reversal of the bit order of the Output data.
DocID026525 Rev 6
UM1785
LL CRC Generic Driver
Parameters
CRCx: CRC Instance
ReverseMode: This parameter can be one of the following
values:
LL_CRC_OUTDATA_REVERSE_NONE
LL_CRC_OUTDATA_REVERSE_BIT
Return values
None
Reference Manual to
LL API cross
reference:
CR REV_OUT LL_CRC_SetOutputDataReverseMode
LL_CRC_GetOutputDataReverseMode
Function name
__STATIC_INLINE uint32_t
LL_CRC_GetOutputDataReverseMode (CRC_TypeDef * CRCx)
Function description
Configure the reversal of the bit order of the Output data.
Parameters
CRCx: CRC Instance
Return values
Returned: value can be one of the following values:
LL_CRC_OUTDATA_REVERSE_NONE
LL_CRC_OUTDATA_REVERSE_BIT
Reference Manual to
LL API cross
reference:
CR REV_OUT LL_CRC_GetOutputDataReverseMode
LL_CRC_SetInitialData
Function name
__STATIC_INLINE void LL_CRC_SetInitialData (CRC_TypeDef
* CRCx, uint32_t InitCrc)
Function description
Initialize the Programmable initial CRC value.
Parameters
CRCx: CRC Instance
InitCrc: Value to be programmed in Programmable initial
CRC value register
Return values
None
Notes
If the CRC size is less than 32 bits, the least significant bits
are used to write the correct value
LL_CRC_DEFAULT_CRC_INITVALUE could be used as
value for InitCrc parameter.
Reference Manual to
LL API cross
reference:
INIT INIT LL_CRC_SetInitialData
LL_CRC_GetInitialData
Function name
__STATIC_INLINE uint32_t LL_CRC_GetInitialData
(CRC_TypeDef * CRCx)
Function description
Return current Initial CRC value.
Parameters
CRCx: CRC Instance
DocID026525 Rev 6
727/1320
LL CRC Generic Driver
Return values
UM1785
Value: programmed in Programmable initial CRC value
register
Notes
If the CRC size is less than 32 bits, the least significant bits
are used to read the correct value
Reference Manual to
LL API cross
reference:
INIT INIT LL_CRC_GetInitialData
LL_CRC_SetPolynomialCoef
Function name
__STATIC_INLINE void LL_CRC_SetPolynomialCoef
(CRC_TypeDef * CRCx, uint32_t PolynomCoef)
Function description
Initialize the Programmable polynomial value (coefficients of the
polynomial to be used for CRC calculation).
Parameters
CRCx: CRC Instance
PolynomCoef: Value to be programmed in Programmable
Polynomial value register
Return values
None
Notes
This function is available only on devices supporting
Programmable Polynomial feature.
LL_CRC_DEFAULT_CRC32_POLY could be used as value
for PolynomCoef parameter.
Please check Reference Manual and existing Errata Sheets,
regarding possible limitations for Polynomial values usage.
For example, for a polynomial of degree 7, X^7 + X^6 + X^5 +
X^2 + 1 is written 0x65
Reference Manual to
LL API cross
reference:
POL POL LL_CRC_SetPolynomialCoef
LL_CRC_GetPolynomialCoef
728/1320
Function name
__STATIC_INLINE uint32_t LL_CRC_GetPolynomialCoef
(CRC_TypeDef * CRCx)
Function description
Return current Programmable polynomial value.
Parameters
CRCx: CRC Instance
Return values
Value: programmed in Programmable Polynomial value
register
Notes
This function is available only on devices supporting
Programmable Polynomial feature.
Please check Reference Manual and existing Errata Sheets,
regarding possible limitations for Polynomial values usage.
For example, for a polynomial of degree 7, X^7 + X^6 + X^5 +
X^2 + 1 is written 0x65
Reference Manual to
LL API cross
reference:
POL POL LL_CRC_GetPolynomialCoef
DocID026525 Rev 6
UM1785
LL CRC Generic Driver
LL_CRC_FeedData32
Function name
__STATIC_INLINE void LL_CRC_FeedData32 (CRC_TypeDef *
CRCx, uint32_t InData)
Function description
Write given 32-bit data to the CRC calculator.
Parameters
CRCx: CRC Instance
InData: value to be provided to CRC calculator between
between Min_Data=0 and Max_Data=0xFFFFFFFF
Return values
None
Reference Manual to
LL API cross
reference:
DR DR LL_CRC_FeedData32
LL_CRC_FeedData16
Function name
__STATIC_INLINE void LL_CRC_FeedData16 (CRC_TypeDef *
CRCx, uint16_t InData)
Function description
Write given 16-bit data to the CRC calculator.
Parameters
CRCx: CRC Instance
InData: 16 bit value to be provided to CRC calculator
between between Min_Data=0 and Max_Data=0xFFFF
Return values
None
Reference Manual to
LL API cross
reference:
DR DR LL_CRC_FeedData16
LL_CRC_FeedData8
Function name
__STATIC_INLINE void LL_CRC_FeedData8 (CRC_TypeDef *
CRCx, uint8_t InData)
Function description
Write given 8-bit data to the CRC calculator.
Parameters
CRCx: CRC Instance
InData: 8 bit value to be provided to CRC calculator between
between Min_Data=0 and Max_Data=0xFF
Return values
None
Reference Manual to
LL API cross
reference:
DR DR LL_CRC_FeedData8
LL_CRC_ReadData32
Function name
__STATIC_INLINE uint32_t LL_CRC_ReadData32
(CRC_TypeDef * CRCx)
Function description
Return current CRC calculation result.
Parameters
CRCx: CRC Instance
Return values
Current: CRC calculation result as stored in CRC_DR
DocID026525 Rev 6
729/1320
LL CRC Generic Driver
UM1785
register (32 bits).
Reference Manual to
LL API cross
reference:
DR DR LL_CRC_ReadData32
LL_CRC_ReadData16
Function name
__STATIC_INLINE uint16_t LL_CRC_ReadData16
(CRC_TypeDef * CRCx)
Function description
Return current CRC calculation result.
Parameters
CRCx: CRC Instance
Return values
Current: CRC calculation result as stored in CRC_DR
register (16 bits).
Notes
This function is expected to be used in a 16 bits CRC
polynomial size context.
This function is available only on devices supporting
Programmable Polynomial feature.
Reference Manual to
LL API cross
reference:
DR DR LL_CRC_ReadData16
LL_CRC_ReadData8
Function name
__STATIC_INLINE uint8_t LL_CRC_ReadData8 (CRC_TypeDef
* CRCx)
Function description
Return current CRC calculation result.
Parameters
CRCx: CRC Instance
Return values
Current: CRC calculation result as stored in CRC_DR
register (8 bits).
Notes
This function is expected to be used in a 8 bits CRC
polynomial size context.
This function is available only on devices supporting
Programmable Polynomial feature.
Reference Manual to
LL API cross
reference:
DR DR LL_CRC_ReadData8
LL_CRC_ReadData7
730/1320
Function name
__STATIC_INLINE uint8_t LL_CRC_ReadData7 (CRC_TypeDef
* CRCx)
Function description
Return current CRC calculation result.
Parameters
CRCx: CRC Instance
Return values
Current: CRC calculation result as stored in CRC_DR
register (7 bits).
Notes
This function is expected to be used in a 7 bits CRC
DocID026525 Rev 6
UM1785
LL CRC Generic Driver
polynomial size context.
This function is available only on devices supporting
Programmable Polynomial feature.
Reference Manual to
LL API cross
reference:
DR DR LL_CRC_ReadData7
LL_CRC_Read_IDR
Function name
__STATIC_INLINE uint32_t LL_CRC_Read_IDR (CRC_TypeDef
* CRCx)
Function description
Return data stored in the Independent Data(IDR) register.
Parameters
CRCx: CRC Instance
Return values
Value: stored in CRC_IDR register (General-purpose 8-bit
data register).
Notes
This register can be used as a temporary storage location for
one byte.
Reference Manual to
LL API cross
reference:
IDR IDR LL_CRC_Read_IDR
LL_CRC_Write_IDR
Function name
__STATIC_INLINE void LL_CRC_Write_IDR (CRC_TypeDef *
CRCx, uint32_t InData)
Function description
Store data in the Independent Data(IDR) register.
Parameters
CRCx: CRC Instance
InData: value to be stored in CRC_IDR register (8-bit)
between between Min_Data=0 and Max_Data=0xFF
Return values
None
Notes
This register can be used as a temporary storage location for
one byte.
Reference Manual to
LL API cross
reference:
IDR IDR LL_CRC_Write_IDR
LL_CRC_DeInit
Function name
ErrorStatus LL_CRC_DeInit (CRC_TypeDef * CRCx)
Function description
De-initialize CRC registers (Registers restored to their default
values).
Parameters
CRCx: CRC Instance
Return values
An: ErrorStatus enumeration value:
SUCCESS: CRC registers are de-initialized
ERROR: CRC registers are not de-initialized
DocID026525 Rev 6
731/1320
LL CRC Generic Driver
UM1785
53.2
CRC Firmware driver defines
53.2.1
CRC
Default CRC computation initialization value
LL_CRC_DEFAULT_CRC_INITVALUE
Default CRC computation initialization value
Default CRC generating polynomial value
LL_CRC_DEFAULT_CRC32_POLY
Default CRC generating polynomial value
Input Data Reverse
LL_CRC_INDATA_REVERSE_NONE
Input Data bit order not affected
LL_CRC_INDATA_REVERSE_BYTE
Input Data bit reversal done by byte
LL_CRC_INDATA_REVERSE_HALFWORD
Input Data bit reversal done by half-word
LL_CRC_INDATA_REVERSE_WORD
Input Data bit reversal done by word
Output Data Reverse
LL_CRC_OUTDATA_REVERSE_NONE
Output Data bit order not affected
LL_CRC_OUTDATA_REVERSE_BIT
Output Data bit reversal done by bit
Polynomial length
LL_CRC_POLYLENGTH_32B
32 bits Polynomial size
LL_CRC_POLYLENGTH_16B
16 bits Polynomial size
LL_CRC_POLYLENGTH_8B
8 bits Polynomial size
LL_CRC_POLYLENGTH_7B
7 bits Polynomial size
Common Write and read registers Macros
LL_CRC_WriteReg
Description:
Write a value in CRC register.
Parameters:
__INSTANCE__: CRC Instance
__REG__: Register to be written
__VALUE__: Value to be written in the register
Return value:
None
LL_CRC_ReadReg
Description:
Read a value in CRC register.
Parameters:
__INSTANCE__: CRC Instance
__REG__: Register to be read
Return value:
Register: value
732/1320
DocID026525 Rev 6
UM1785
LL CRS Generic Driver
54
LL CRS Generic Driver
54.1
CRS Firmware driver API description
54.1.1
Detailed description of functions
LL_CRS_EnableFreqErrorCounter
Function name
__STATIC_INLINE void LL_CRS_EnableFreqErrorCounter
(void )
Function description
Enable Frequency error counter.
Return values
None
Notes
When this bit is set, the CRS_CFGR register is writeprotected and cannot be modified
Reference Manual to
LL API cross
reference:
CR CEN LL_CRS_EnableFreqErrorCounter
LL_CRS_DisableFreqErrorCounter
Function name
__STATIC_INLINE void LL_CRS_DisableFreqErrorCounter
(void )
Function description
Disable Frequency error counter.
Return values
None
Reference Manual to
LL API cross
reference:
CR CEN LL_CRS_DisableFreqErrorCounter
LL_CRS_IsEnabledFreqErrorCounter
Function name
__STATIC_INLINE uint32_t
LL_CRS_IsEnabledFreqErrorCounter (void )
Function description
Check if Frequency error counter is enabled or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR CEN LL_CRS_IsEnabledFreqErrorCounter
LL_CRS_EnableAutoTrimming
Function name
__STATIC_INLINE void LL_CRS_EnableAutoTrimming (void )
Function description
Enable Automatic trimming counter.
Return values
None
Reference Manual to
LL API cross
CR AUTOTRIMEN LL_CRS_EnableAutoTrimming
DocID026525 Rev 6
733/1320
LL CRS Generic Driver
reference:
UM1785
LL_CRS_DisableAutoTrimming
Function name
__STATIC_INLINE void LL_CRS_DisableAutoTrimming (void )
Function description
Disable Automatic trimming counter.
Return values
None
Reference Manual to
LL API cross
reference:
CR AUTOTRIMEN LL_CRS_DisableAutoTrimming
LL_CRS_IsEnabledAutoTrimming
Function name
__STATIC_INLINE uint32_t LL_CRS_IsEnabledAutoTrimming
(void )
Function description
Check if Automatic trimming is enabled or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR AUTOTRIMEN LL_CRS_IsEnabledAutoTrimming
LL_CRS_SetHSI48SmoothTrimming
Function name
__STATIC_INLINE void LL_CRS_SetHSI48SmoothTrimming
(uint32_t Value)
Function description
Set HSI48 oscillator smooth trimming.
Parameters
Value: a number between Min_Data = 0 and Max_Data = 63
Return values
None
Notes
When the AUTOTRIMEN bit is set, this field is controlled by
hardware and is read-only
Default value can be set thanks to
LL_CRS_HSI48CALIBRATION_DEFAULT
Reference Manual to
LL API cross
reference:
CR TRIM LL_CRS_SetHSI48SmoothTrimming
LL_CRS_GetHSI48SmoothTrimming
734/1320
Function name
__STATIC_INLINE uint32_t
LL_CRS_GetHSI48SmoothTrimming (void )
Function description
Get HSI48 oscillator smooth trimming.
Return values
a: number between Min_Data = 0 and Max_Data = 63
Reference Manual to
LL API cross
reference:
CR TRIM LL_CRS_GetHSI48SmoothTrimming
DocID026525 Rev 6
UM1785
LL CRS Generic Driver
LL_CRS_SetReloadCounter
Function name
__STATIC_INLINE void LL_CRS_SetReloadCounter (uint32_t
Value)
Function description
Set counter reload value.
Parameters
Value: a number between Min_Data = 0 and Max_Data =
0xFFFF
Return values
None
Notes
Default value can be set thanks to
LL_CRS_RELOADVALUE_DEFAULT Otherwise it can be
calculated in using macro
__LL_CRS_CALC_CALCULATE_RELOADVALUE
(_FTARGET_, _FSYNC_)
Reference Manual to
LL API cross
reference:
CFGR RELOAD LL_CRS_SetReloadCounter
LL_CRS_GetReloadCounter
Function name
__STATIC_INLINE uint32_t LL_CRS_GetReloadCounter (void )
Function description
Get counter reload value.
Return values
a: number between Min_Data = 0 and Max_Data = 0xFFFF
Reference Manual to
LL API cross
reference:
CFGR RELOAD LL_CRS_GetReloadCounter
LL_CRS_SetFreqErrorLimit
Function name
__STATIC_INLINE void LL_CRS_SetFreqErrorLimit (uint32_t
Value)
Function description
Set frequency error limit.
Parameters
Value: a number between Min_Data = 0 and Max_Data =
255
Return values
None
Notes
Default value can be set thanks to
LL_CRS_ERRORLIMIT_DEFAULT
Reference Manual to
LL API cross
reference:
CFGR FELIM LL_CRS_SetFreqErrorLimit
LL_CRS_GetFreqErrorLimit
Function name
__STATIC_INLINE uint32_t LL_CRS_GetFreqErrorLimit (void )
Function description
Get frequency error limit.
Return values
A: number between Min_Data = 0 and Max_Data = 255
Reference Manual to
LL API cross
CFGR FELIM LL_CRS_GetFreqErrorLimit
DocID026525 Rev 6
735/1320
LL CRS Generic Driver
reference:
UM1785
LL_CRS_SetSyncDivider
Function name
__STATIC_INLINE void LL_CRS_SetSyncDivider (uint32_t
Divider)
Function description
Set division factor for SYNC signal.
Parameters
Divider: This parameter can be one of the following values:
LL_CRS_SYNC_DIV_1
LL_CRS_SYNC_DIV_2
LL_CRS_SYNC_DIV_4
LL_CRS_SYNC_DIV_8
LL_CRS_SYNC_DIV_16
LL_CRS_SYNC_DIV_32
LL_CRS_SYNC_DIV_64
LL_CRS_SYNC_DIV_128
Return values
None
Reference Manual to
LL API cross
reference:
CFGR SYNCDIV LL_CRS_SetSyncDivider
LL_CRS_GetSyncDivider
Function name
__STATIC_INLINE uint32_t LL_CRS_GetSyncDivider (void )
Function description
Get division factor for SYNC signal.
Return values
Returned: value can be one of the following values:
LL_CRS_SYNC_DIV_1
LL_CRS_SYNC_DIV_2
LL_CRS_SYNC_DIV_4
LL_CRS_SYNC_DIV_8
LL_CRS_SYNC_DIV_16
LL_CRS_SYNC_DIV_32
LL_CRS_SYNC_DIV_64
LL_CRS_SYNC_DIV_128
Reference Manual to
LL API cross
reference:
CFGR SYNCDIV LL_CRS_GetSyncDivider
LL_CRS_SetSyncSignalSource
736/1320
Function name
__STATIC_INLINE void LL_CRS_SetSyncSignalSource
(uint32_t Source)
Function description
Set SYNC signal source.
Parameters
Source: This parameter can be one of the following values:
LL_CRS_SYNC_SOURCE_GPIO
LL_CRS_SYNC_SOURCE_LSE
LL_CRS_SYNC_SOURCE_USB
Return values
None
DocID026525 Rev 6
UM1785
LL CRS Generic Driver
Reference Manual to
LL API cross
reference:
CFGR SYNCSRC LL_CRS_SetSyncSignalSource
LL_CRS_GetSyncSignalSource
Function name
__STATIC_INLINE uint32_t LL_CRS_GetSyncSignalSource
(void )
Function description
Get SYNC signal source.
Return values
Returned: value can be one of the following values:
LL_CRS_SYNC_SOURCE_GPIO
LL_CRS_SYNC_SOURCE_LSE
LL_CRS_SYNC_SOURCE_USB
Reference Manual to
LL API cross
reference:
CFGR SYNCSRC LL_CRS_GetSyncSignalSource
LL_CRS_SetSyncPolarity
Function name
__STATIC_INLINE void LL_CRS_SetSyncPolarity (uint32_t
Polarity)
Function description
Set input polarity for the SYNC signal source.
Parameters
Polarity: This parameter can be one of the following values:
LL_CRS_SYNC_POLARITY_RISING
LL_CRS_SYNC_POLARITY_FALLING
Return values
None
Reference Manual to
LL API cross
reference:
CFGR SYNCPOL LL_CRS_SetSyncPolarity
LL_CRS_GetSyncPolarity
Function name
__STATIC_INLINE uint32_t LL_CRS_GetSyncPolarity (void )
Function description
Get input polarity for the SYNC signal source.
Return values
Returned: value can be one of the following values:
LL_CRS_SYNC_POLARITY_RISING
LL_CRS_SYNC_POLARITY_FALLING
Reference Manual to
LL API cross
reference:
CFGR SYNCPOL LL_CRS_GetSyncPolarity
LL_CRS_ConfigSynchronization
Function name
__STATIC_INLINE void LL_CRS_ConfigSynchronization
(uint32_t HSI48CalibrationValue, uint32_t ErrorLimitValue,
uint32_t ReloadValue, uint32_t Settings)
Function description
Configure CRS for the synchronization.
DocID026525 Rev 6
737/1320
LL CRS Generic Driver
Parameters
UM1785
HSI48CalibrationValue: a number between Min_Data = 0
and Max_Data = 63
ErrorLimitValue: a number between Min_Data = 0 and
Max_Data = 0xFFFF
ReloadValue: a number between Min_Data = 0 and
Max_Data = 255
Settings: This parameter can be a combination of the
following values:
LL_CRS_SYNC_DIV_1 or LL_CRS_SYNC_DIV_2 or
LL_CRS_SYNC_DIV_4 or LL_CRS_SYNC_DIV_8 or
LL_CRS_SYNC_DIV_16 or LL_CRS_SYNC_DIV_32 or
LL_CRS_SYNC_DIV_64 or LL_CRS_SYNC_DIV_128
LL_CRS_SYNC_SOURCE_GPIO or
LL_CRS_SYNC_SOURCE_LSE or
LL_CRS_SYNC_SOURCE_USB
LL_CRS_SYNC_POLARITY_RISING or
LL_CRS_SYNC_POLARITY_FALLING
Return values
None
Reference Manual to
LL API cross
reference:
CR TRIM LL_CRS_ConfigSynchronization
CFGR RELOAD LL_CRS_ConfigSynchronization
CFGR FELIM LL_CRS_ConfigSynchronization
CFGR SYNCDIV LL_CRS_ConfigSynchronization
CFGR SYNCSRC LL_CRS_ConfigSynchronization
CFGR SYNCPOL LL_CRS_ConfigSynchronization
LL_CRS_GenerateEvent_SWSYNC
Function name
__STATIC_INLINE void LL_CRS_GenerateEvent_SWSYNC
(void )
Function description
Generate software SYNC event.
Return values
None
Reference Manual to
LL API cross
reference:
CR SWSYNC LL_CRS_GenerateEvent_SWSYNC
LL_CRS_GetFreqErrorDirection
738/1320
Function name
__STATIC_INLINE uint32_t LL_CRS_GetFreqErrorDirection
(void )
Function description
Get the frequency error direction latched in the time of the last
SYNC event.
Return values
Returned: value can be one of the following values:
LL_CRS_FREQ_ERROR_DIR_UP
LL_CRS_FREQ_ERROR_DIR_DOWN
Reference Manual to
LL API cross
reference:
ISR FEDIR LL_CRS_GetFreqErrorDirection
DocID026525 Rev 6
UM1785
LL CRS Generic Driver
LL_CRS_GetFreqErrorCapture
Function name
__STATIC_INLINE uint32_t LL_CRS_GetFreqErrorCapture
(void )
Function description
Get the frequency error counter value latched in the time of the
last SYNC event.
Return values
A: number between Min_Data = 0x0000 and Max_Data =
0xFFFF
Reference Manual to
LL API cross
reference:
ISR FECAP LL_CRS_GetFreqErrorCapture
LL_CRS_IsActiveFlag_SYNCOK
Function name
__STATIC_INLINE uint32_t LL_CRS_IsActiveFlag_SYNCOK
(void )
Function description
Check if SYNC event OK signal occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR SYNCOKF LL_CRS_IsActiveFlag_SYNCOK
LL_CRS_IsActiveFlag_SYNCWARN
Function name
__STATIC_INLINE uint32_t
LL_CRS_IsActiveFlag_SYNCWARN (void )
Function description
Check if SYNC warning signal occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR SYNCWARNF LL_CRS_IsActiveFlag_SYNCWARN
LL_CRS_IsActiveFlag_ERR
Function name
__STATIC_INLINE uint32_t LL_CRS_IsActiveFlag_ERR (void )
Function description
Check if Synchronization or trimming error signal occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR ERRF LL_CRS_IsActiveFlag_ERR
LL_CRS_IsActiveFlag_ESYNC
Function name
__STATIC_INLINE uint32_t LL_CRS_IsActiveFlag_ESYNC
(void )
Function description
Check if Expected SYNC signal occurred or not.
Return values
State: of bit (1 or 0).
DocID026525 Rev 6
739/1320
LL CRS Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
ISR ESYNCF LL_CRS_IsActiveFlag_ESYNC
LL_CRS_IsActiveFlag_SYNCERR
Function name
__STATIC_INLINE uint32_t LL_CRS_IsActiveFlag_SYNCERR
(void )
Function description
Check if SYNC error signal occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR SYNCERR LL_CRS_IsActiveFlag_SYNCERR
LL_CRS_IsActiveFlag_SYNCMISS
Function name
__STATIC_INLINE uint32_t LL_CRS_IsActiveFlag_SYNCMISS
(void )
Function description
Check if SYNC missed error signal occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR SYNCMISS LL_CRS_IsActiveFlag_SYNCMISS
LL_CRS_IsActiveFlag_TRIMOVF
Function name
__STATIC_INLINE uint32_t LL_CRS_IsActiveFlag_TRIMOVF
(void )
Function description
Check if Trimming overflow or underflow occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TRIMOVF LL_CRS_IsActiveFlag_TRIMOVF
LL_CRS_ClearFlag_SYNCOK
Function name
__STATIC_INLINE void LL_CRS_ClearFlag_SYNCOK (void )
Function description
Clear the SYNC event OK flag.
Return values
None
Reference Manual to
LL API cross
reference:
ICR SYNCOKC LL_CRS_ClearFlag_SYNCOK
LL_CRS_ClearFlag_SYNCWARN
Function name
740/1320
__STATIC_INLINE void LL_CRS_ClearFlag_SYNCWARN (void
)
DocID026525 Rev 6
UM1785
LL CRS Generic Driver
Function description
Clear the SYNC warning flag.
Return values
None
Reference Manual to
LL API cross
reference:
ICR SYNCWARNC LL_CRS_ClearFlag_SYNCWARN
LL_CRS_ClearFlag_ERR
Function name
__STATIC_INLINE void LL_CRS_ClearFlag_ERR (void )
Function description
Clear TRIMOVF, SYNCMISS and SYNCERR bits and
consequently also the ERR flag.
Return values
None
Reference Manual to
LL API cross
reference:
ICR ERRC LL_CRS_ClearFlag_ERR
LL_CRS_ClearFlag_ESYNC
Function name
__STATIC_INLINE void LL_CRS_ClearFlag_ESYNC (void )
Function description
Clear Expected SYNC flag.
Return values
None
Reference Manual to
LL API cross
reference:
ICR ESYNCC LL_CRS_ClearFlag_ESYNC
LL_CRS_EnableIT_SYNCOK
Function name
__STATIC_INLINE void LL_CRS_EnableIT_SYNCOK (void )
Function description
Enable SYNC event OK interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CR SYNCOKIE LL_CRS_EnableIT_SYNCOK
LL_CRS_DisableIT_SYNCOK
Function name
__STATIC_INLINE void LL_CRS_DisableIT_SYNCOK (void )
Function description
Disable SYNC event OK interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CR SYNCOKIE LL_CRS_DisableIT_SYNCOK
DocID026525 Rev 6
741/1320
LL CRS Generic Driver
UM1785
LL_CRS_IsEnabledIT_SYNCOK
Function name
__STATIC_INLINE uint32_t LL_CRS_IsEnabledIT_SYNCOK
(void )
Function description
Check if SYNC event OK interrupt is enabled or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR SYNCOKIE LL_CRS_IsEnabledIT_SYNCOK
LL_CRS_EnableIT_SYNCWARN
Function name
__STATIC_INLINE void LL_CRS_EnableIT_SYNCWARN (void )
Function description
Enable SYNC warning interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CR SYNCWARNIE LL_CRS_EnableIT_SYNCWARN
LL_CRS_DisableIT_SYNCWARN
Function name
__STATIC_INLINE void LL_CRS_DisableIT_SYNCWARN (void
)
Function description
Disable SYNC warning interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CR SYNCWARNIE LL_CRS_DisableIT_SYNCWARN
LL_CRS_IsEnabledIT_SYNCWARN
Function name
__STATIC_INLINE uint32_t LL_CRS_IsEnabledIT_SYNCWARN
(void )
Function description
Check if SYNC warning interrupt is enabled or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR SYNCWARNIE LL_CRS_IsEnabledIT_SYNCWARN
LL_CRS_EnableIT_ERR
742/1320
Function name
__STATIC_INLINE void LL_CRS_EnableIT_ERR (void )
Function description
Enable Synchronization or trimming error interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CR ERRIE LL_CRS_EnableIT_ERR
DocID026525 Rev 6
UM1785
LL CRS Generic Driver
LL_CRS_DisableIT_ERR
Function name
__STATIC_INLINE void LL_CRS_DisableIT_ERR (void )
Function description
Disable Synchronization or trimming error interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CR ERRIE LL_CRS_DisableIT_ERR
LL_CRS_IsEnabledIT_ERR
Function name
__STATIC_INLINE uint32_t LL_CRS_IsEnabledIT_ERR (void )
Function description
Check if Synchronization or trimming error interrupt is enabled or
not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR ERRIE LL_CRS_IsEnabledIT_ERR
LL_CRS_EnableIT_ESYNC
Function name
__STATIC_INLINE void LL_CRS_EnableIT_ESYNC (void )
Function description
Enable Expected SYNC interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CR ESYNCIE LL_CRS_EnableIT_ESYNC
LL_CRS_DisableIT_ESYNC
Function name
__STATIC_INLINE void LL_CRS_DisableIT_ESYNC (void )
Function description
Disable Expected SYNC interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CR ESYNCIE LL_CRS_DisableIT_ESYNC
LL_CRS_IsEnabledIT_ESYNC
Function name
__STATIC_INLINE uint32_t LL_CRS_IsEnabledIT_ESYNC
(void )
Function description
Check if Expected SYNC interrupt is enabled or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR ESYNCIE LL_CRS_IsEnabledIT_ESYNC
DocID026525 Rev 6
743/1320
LL CRS Generic Driver
UM1785
LL_CRS_DeInit
Function name
ErrorStatus LL_CRS_DeInit (void )
Function description
De-Initializes CRS peripheral registers to their default reset values.
Return values
An: ErrorStatus enumeration value:
SUCCESS: CRS registers are de-initialized
ERROR: not applicable
54.2
CRS Firmware driver defines
54.2.1
CRS
Default Values
Notes:
LL_CRS_RELOADVALUE_DEFAULT
The reset value of the RELOAD field
corresponds to a target frequency of 48
MHz and a synchronization signal
frequency of 1 kHz (SOF signal from
USB)
LL_CRS_ERRORLIMIT_DEFAULT
LL_CRS_HSI48CALIBRATION_DEFAULT
Notes:
The default value is 32, which
corresponds to the middle of the
trimming interval. The trimming step is
around 67 kHz between two consecutive
TRIM steps. A higher TRIM value
corresponds to a higher output frequency
Frequency Error Direction
LL_CRS_FREQ_ERROR_DIR_UP
Upcounting direction, the actual frequency is
above the target
LL_CRS_FREQ_ERROR_DIR_DOWN
Downcounting direction, the actual frequency is
below the target
Get Flags Defines
LL_CRS_ISR_SYNCOKF
LL_CRS_ISR_SYNCWARNF
LL_CRS_ISR_ERRF
LL_CRS_ISR_ESYNCF
LL_CRS_ISR_SYNCERR
LL_CRS_ISR_SYNCMISS
LL_CRS_ISR_TRIMOVF
744/1320
DocID026525 Rev 6
UM1785
LL CRS Generic Driver
IT Defines
LL_CRS_CR_SYNCOKIE
LL_CRS_CR_SYNCWARNIE
LL_CRS_CR_ERRIE
LL_CRS_CR_ESYNCIE
Synchronization Signal Divider
LL_CRS_SYNC_DIV_1
Synchro Signal not divided (default)
LL_CRS_SYNC_DIV_2
Synchro Signal divided by 2
LL_CRS_SYNC_DIV_4
Synchro Signal divided by 4
LL_CRS_SYNC_DIV_8
Synchro Signal divided by 8
LL_CRS_SYNC_DIV_16
Synchro Signal divided by 16
LL_CRS_SYNC_DIV_32
Synchro Signal divided by 32
LL_CRS_SYNC_DIV_64
Synchro Signal divided by 64
LL_CRS_SYNC_DIV_128
Synchro Signal divided by 128
Synchronization Signal Polarity
LL_CRS_SYNC_POLARITY_RISING
Synchro Active on rising edge (default)
LL_CRS_SYNC_POLARITY_FALLING
Synchro Active on falling edge
Synchronization Signal Source
LL_CRS_SYNC_SOURCE_GPIO
Synchro Signal soucre GPIO
LL_CRS_SYNC_SOURCE_LSE
Synchro Signal source LSE
LL_CRS_SYNC_SOURCE_USB
Synchro Signal source USB SOF (default)
Exported_Macros_Calculate_Reload
__LL_CRS_CALC_CALCULATE_RELOADVALUE
Description:
Macro to calculate reload value
to be set in CRS register
according to target and sync
frequencies.
Parameters:
__FTARGET__: Target
frequency (value in Hz)
__FSYNC__: Synchronization
signal frequency (value in Hz)
Return value:
Reload: value (in Hz)
Notes:
The RELOAD value should be
selected according to the ratio
between the target frequency
and the frequency of the
synchronization source after
DocID026525 Rev 6
745/1320
LL CRS Generic Driver
UM1785
prescaling. It is then decreased
by one in order to reach the
expected synchronization on the
zero value. The formula is the
following: RELOAD = (fTARGET
/ fSYNC) -1
Common Write and read registers Macros
LL_CRS_WriteReg
Description:
Write a value in CRS register.
Parameters:
__INSTANCE__: CRS Instance
__REG__: Register to be written
__VALUE__: Value to be written in the register
Return value:
None
LL_CRS_ReadReg
Description:
Read a value in CRS register.
Parameters:
__INSTANCE__: CRS Instance
__REG__: Register to be read
Return value:
Register: value
746/1320
DocID026525 Rev 6
UM1785
LL DAC Generic Driver
55
LL DAC Generic Driver
55.1
DAC Firmware driver registers structures
55.1.1
LL_DAC_InitTypeDef
Data Fields
uint32_t TriggerSource
uint32_t WaveAutoGeneration
uint32_t WaveAutoGenerationConfig
uint32_t OutputBuffer
Field Documentation
uint32_t LL_DAC_InitTypeDef::TriggerSource
Set the conversion trigger source for the selected DAC channel: internal (SW start) or
from external IP (timer event, external interrupt line). This parameter can be a value of
DAC_LL_EC_TRIGGER_SOURCEThis feature can be modified afterwards using
unitary function LL_DAC_SetTriggerSource().
uint32_t LL_DAC_InitTypeDef::WaveAutoGeneration
Set the waveform automatic generation mode for the selected DAC channel. This
parameter can be a value of DAC_LL_EC_WAVE_AUTO_GENERATION_MODEThis
feature can be modified afterwards using unitary function
LL_DAC_SetWaveAutoGeneration().
uint32_t LL_DAC_InitTypeDef::WaveAutoGenerationConfig
Set the waveform automatic generation mode for the selected DAC channel. If
waveform automatic generation mode is set to noise, this parameter can be a value of
DAC_LL_EC_WAVE_NOISE_LFSR_UNMASK_BITS If waveform automatic
generation mode is set to triangle, this parameter can be a value of
DAC_LL_EC_WAVE_TRIANGLE_AMPLITUDE
Note:If waveform automatic generation mode is disabled, this parameter is discarded.
This feature can be modified afterwards using unitary function
LL_DAC_SetWaveNoiseLFSR() or LL_DAC_SetWaveTriangleAmplitude(),
depending on the wave automatic generation selected.
uint32_t LL_DAC_InitTypeDef::OutputBuffer
Set the output buffer for the selected DAC channel. This parameter can be a value of
DAC_LL_EC_OUTPUT_BUFFERThis feature can be modified afterwards using
unitary function LL_DAC_SetOutputBuffer().
55.2
DAC Firmware driver API description
55.2.1
Detailed description of functions
LL_DAC_SetTriggerSource
Function name
__STATIC_INLINE void LL_DAC_SetTriggerSource
(DAC_TypeDef * DACx, uint32_t DAC_Channel, uint32_t
TriggerSource)
Function description
Set the conversion trigger source for the selected DAC channel.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
DocID026525 Rev 6
747/1320
LL DAC Generic Driver
UM1785
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
TriggerSource: This parameter can be one of the following
values:
LL_DAC_TRIG_SOFTWARE
LL_DAC_TRIG_EXT_TIM2_TRGO
LL_DAC_TRIG_EXT_TIM3_TRGO
LL_DAC_TRIG_EXT_TIM4_TRGO
LL_DAC_TRIG_EXT_TIM6_TRGO
LL_DAC_TRIG_EXT_TIM7_TRGO
LL_DAC_TRIG_EXT_TIM15_TRGO
LL_DAC_TRIG_EXT_EXTI_LINE9
Return values
None
Notes
For conversion trigger source to be effective, DAC trigger
must be enabled using function LL_DAC_EnableTrigger().
To set conversion trigger source, DAC channel must be
disabled. Otherwise, the setting is discarded.
Availability of parameters of trigger sources from timer
depends on timers availability on the selected device.
Reference Manual to
LL API cross
reference:
CR TSEL1 LL_DAC_SetTriggerSource
CR TSEL2 LL_DAC_SetTriggerSource
LL_DAC_GetTriggerSource
748/1320
Function name
__STATIC_INLINE uint32_t LL_DAC_GetTriggerSource
(DAC_TypeDef * DACx, uint32_t DAC_Channel)
Function description
Get the conversion trigger source for the selected DAC channel.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
Return values
Returned: value can be one of the following values:
LL_DAC_TRIG_SOFTWARE
LL_DAC_TRIG_EXT_TIM2_TRGO
LL_DAC_TRIG_EXT_TIM3_TRGO
LL_DAC_TRIG_EXT_TIM4_TRGO
LL_DAC_TRIG_EXT_TIM6_TRGO
LL_DAC_TRIG_EXT_TIM7_TRGO
LL_DAC_TRIG_EXT_TIM15_TRGO
LL_DAC_TRIG_EXT_EXTI_LINE9
Notes
For conversion trigger source to be effective, DAC trigger
must be enabled using function LL_DAC_EnableTrigger().
Availability of parameters of trigger sources from timer
DocID026525 Rev 6
UM1785
LL DAC Generic Driver
depends on timers availability on the selected device.
Reference Manual to
LL API cross
reference:
CR TSEL1 LL_DAC_GetTriggerSource
CR TSEL2 LL_DAC_GetTriggerSource
LL_DAC_SetWaveAutoGeneration
Function name
__STATIC_INLINE void LL_DAC_SetWaveAutoGeneration
(DAC_TypeDef * DACx, uint32_t DAC_Channel, uint32_t
WaveAutoGeneration)
Function description
Set the waveform automatic generation mode for the selected DAC
channel.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
WaveAutoGeneration: This parameter can be one of the
following values:
LL_DAC_WAVE_AUTO_GENERATION_NONE
LL_DAC_WAVE_AUTO_GENERATION_NOISE
LL_DAC_WAVE_AUTO_GENERATION_TRIANGLE
Return values
None
Reference Manual to
LL API cross
reference:
CR WAVE1 LL_DAC_SetWaveAutoGeneration
CR WAVE2 LL_DAC_SetWaveAutoGeneration
LL_DAC_GetWaveAutoGeneration
Function name
__STATIC_INLINE uint32_t LL_DAC_GetWaveAutoGeneration
(DAC_TypeDef * DACx, uint32_t DAC_Channel)
Function description
Get the waveform automatic generation mode for the selected DAC
channel.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
Return values
Returned: value can be one of the following values:
LL_DAC_WAVE_AUTO_GENERATION_NONE
LL_DAC_WAVE_AUTO_GENERATION_NOISE
LL_DAC_WAVE_AUTO_GENERATION_TRIANGLE
Reference Manual to
LL API cross
reference:
CR WAVE1 LL_DAC_GetWaveAutoGeneration
CR WAVE2 LL_DAC_GetWaveAutoGeneration
DocID026525 Rev 6
749/1320
LL DAC Generic Driver
UM1785
LL_DAC_SetWaveNoiseLFSR
Function name
__STATIC_INLINE void LL_DAC_SetWaveNoiseLFSR
(DAC_TypeDef * DACx, uint32_t DAC_Channel, uint32_t
NoiseLFSRMask)
Function description
Set the noise waveform generation for the selected DAC channel:
Noise mode and parameters LFSR (linear feedback shift register).
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
NoiseLFSRMask: This parameter can be one of the
following values:
LL_DAC_NOISE_LFSR_UNMASK_BIT0
LL_DAC_NOISE_LFSR_UNMASK_BITS1_0
LL_DAC_NOISE_LFSR_UNMASK_BITS2_0
LL_DAC_NOISE_LFSR_UNMASK_BITS3_0
LL_DAC_NOISE_LFSR_UNMASK_BITS4_0
LL_DAC_NOISE_LFSR_UNMASK_BITS5_0
LL_DAC_NOISE_LFSR_UNMASK_BITS6_0
LL_DAC_NOISE_LFSR_UNMASK_BITS7_0
LL_DAC_NOISE_LFSR_UNMASK_BITS8_0
LL_DAC_NOISE_LFSR_UNMASK_BITS9_0
LL_DAC_NOISE_LFSR_UNMASK_BITS10_0
LL_DAC_NOISE_LFSR_UNMASK_BITS11_0
Return values
None
Notes
For wave generation to be effective, DAC channel wave
generation mode must be enabled using function
LL_DAC_SetWaveAutoGeneration().
This setting can be set when the selected DAC channel is
disabled (otherwise, the setting operation is ignored).
Reference Manual to
LL API cross
reference:
CR MAMP1 LL_DAC_SetWaveNoiseLFSR
CR MAMP2 LL_DAC_SetWaveNoiseLFSR
LL_DAC_GetWaveNoiseLFSR
Function name
__STATIC_INLINE uint32_t LL_DAC_GetWaveNoiseLFSR
(DAC_TypeDef * DACx, uint32_t DAC_Channel)
Function description
Set the noise waveform generation for the selected DAC channel:
Noise mode and parameters LFSR (linear feedback shift register).
Parameters
750/1320
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
DocID026525 Rev 6
UM1785
LL DAC Generic Driver
LL_DAC_CHANNEL_2 (1)
Return values
Returned: value can be one of the following values:
LL_DAC_NOISE_LFSR_UNMASK_BIT0
LL_DAC_NOISE_LFSR_UNMASK_BITS1_0
LL_DAC_NOISE_LFSR_UNMASK_BITS2_0
LL_DAC_NOISE_LFSR_UNMASK_BITS3_0
LL_DAC_NOISE_LFSR_UNMASK_BITS4_0
LL_DAC_NOISE_LFSR_UNMASK_BITS5_0
LL_DAC_NOISE_LFSR_UNMASK_BITS6_0
LL_DAC_NOISE_LFSR_UNMASK_BITS7_0
LL_DAC_NOISE_LFSR_UNMASK_BITS8_0
LL_DAC_NOISE_LFSR_UNMASK_BITS9_0
LL_DAC_NOISE_LFSR_UNMASK_BITS10_0
LL_DAC_NOISE_LFSR_UNMASK_BITS11_0
Reference Manual to
LL API cross
reference:
CR MAMP1 LL_DAC_GetWaveNoiseLFSR
CR MAMP2 LL_DAC_GetWaveNoiseLFSR
LL_DAC_SetWaveTriangleAmplitude
Function name
__STATIC_INLINE void LL_DAC_SetWaveTriangleAmplitude
(DAC_TypeDef * DACx, uint32_t DAC_Channel, uint32_t
TriangleAmplitude)
Function description
Set the triangle waveform generation for the selected DAC
channel: triangle mode and amplitude.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
TriangleAmplitude: This parameter can be one of the
following values:
LL_DAC_TRIANGLE_AMPLITUDE_1
LL_DAC_TRIANGLE_AMPLITUDE_3
LL_DAC_TRIANGLE_AMPLITUDE_7
LL_DAC_TRIANGLE_AMPLITUDE_15
LL_DAC_TRIANGLE_AMPLITUDE_31
LL_DAC_TRIANGLE_AMPLITUDE_63
LL_DAC_TRIANGLE_AMPLITUDE_127
LL_DAC_TRIANGLE_AMPLITUDE_255
LL_DAC_TRIANGLE_AMPLITUDE_511
LL_DAC_TRIANGLE_AMPLITUDE_1023
LL_DAC_TRIANGLE_AMPLITUDE_2047
LL_DAC_TRIANGLE_AMPLITUDE_4095
Return values
None
Notes
For wave generation to be effective, DAC channel wave
generation mode must be enabled using function
LL_DAC_SetWaveAutoGeneration().
DocID026525 Rev 6
751/1320
LL DAC Generic Driver
UM1785
This setting can be set when the selected DAC channel is
disabled (otherwise, the setting operation is ignored).
Reference Manual to
LL API cross
reference:
CR MAMP1 LL_DAC_SetWaveTriangleAmplitude
CR MAMP2 LL_DAC_SetWaveTriangleAmplitude
LL_DAC_GetWaveTriangleAmplitude
Function name
__STATIC_INLINE uint32_t
LL_DAC_GetWaveTriangleAmplitude (DAC_TypeDef * DACx,
uint32_t DAC_Channel)
Function description
Set the triangle waveform generation for the selected DAC
channel: triangle mode and amplitude.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
Return values
Returned: value can be one of the following values:
LL_DAC_TRIANGLE_AMPLITUDE_1
LL_DAC_TRIANGLE_AMPLITUDE_3
LL_DAC_TRIANGLE_AMPLITUDE_7
LL_DAC_TRIANGLE_AMPLITUDE_15
LL_DAC_TRIANGLE_AMPLITUDE_31
LL_DAC_TRIANGLE_AMPLITUDE_63
LL_DAC_TRIANGLE_AMPLITUDE_127
LL_DAC_TRIANGLE_AMPLITUDE_255
LL_DAC_TRIANGLE_AMPLITUDE_511
LL_DAC_TRIANGLE_AMPLITUDE_1023
LL_DAC_TRIANGLE_AMPLITUDE_2047
LL_DAC_TRIANGLE_AMPLITUDE_4095
Reference Manual to
LL API cross
reference:
CR MAMP1 LL_DAC_GetWaveTriangleAmplitude
CR MAMP2 LL_DAC_GetWaveTriangleAmplitude
LL_DAC_SetOutputBuffer
Function name
__STATIC_INLINE void LL_DAC_SetOutputBuffer
(DAC_TypeDef * DACx, uint32_t DAC_Channel, uint32_t
OutputBuffer)
Function description
Set the output buffer for the selected DAC channel.
Parameters
752/1320
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
DocID026525 Rev 6
UM1785
LL DAC Generic Driver
OutputBuffer: This parameter can be one of the following
values:
LL_DAC_OUTPUT_BUFFER_ENABLE
LL_DAC_OUTPUT_BUFFER_DISABLE
Return values
None
Reference Manual to
LL API cross
reference:
CR BOFF1 LL_DAC_SetOutputBuffer
CR BOFF2 LL_DAC_SetOutputBuffer
LL_DAC_GetOutputBuffer
Function name
__STATIC_INLINE uint32_t LL_DAC_GetOutputBuffer
(DAC_TypeDef * DACx, uint32_t DAC_Channel)
Function description
Get the output buffer state for the selected DAC channel.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
Return values
Returned: value can be one of the following values:
LL_DAC_OUTPUT_BUFFER_ENABLE
LL_DAC_OUTPUT_BUFFER_DISABLE
Reference Manual to
LL API cross
reference:
CR BOFF1 LL_DAC_GetOutputBuffer
CR BOFF2 LL_DAC_GetOutputBuffer
LL_DAC_EnableDMAReq
Function name
__STATIC_INLINE void LL_DAC_EnableDMAReq
(DAC_TypeDef * DACx, uint32_t DAC_Channel)
Function description
Enable DAC DMA transfer request of the selected channel.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
Return values
None
Notes
To configure DMA source address (peripheral address), use
function LL_DAC_DMA_GetRegAddr().
Reference Manual to
LL API cross
reference:
CR DMAEN1 LL_DAC_EnableDMAReq
CR DMAEN2 LL_DAC_EnableDMAReq
DocID026525 Rev 6
753/1320
LL DAC Generic Driver
UM1785
LL_DAC_DisableDMAReq
Function name
__STATIC_INLINE void LL_DAC_DisableDMAReq
(DAC_TypeDef * DACx, uint32_t DAC_Channel)
Function description
Disable DAC DMA transfer request of the selected channel.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
Return values
None
Notes
To configure DMA source address (peripheral address), use
function LL_DAC_DMA_GetRegAddr().
Reference Manual to
LL API cross
reference:
CR DMAEN1 LL_DAC_DisableDMAReq
CR DMAEN2 LL_DAC_DisableDMAReq
LL_DAC_IsDMAReqEnabled
Function name
__STATIC_INLINE uint32_t LL_DAC_IsDMAReqEnabled
(DAC_TypeDef * DACx, uint32_t DAC_Channel)
Function description
Get DAC DMA transfer request state of the selected channel.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR DMAEN1 LL_DAC_IsDMAReqEnabled
CR DMAEN2 LL_DAC_IsDMAReqEnabled
LL_DAC_DMA_GetRegAddr
Function name
__STATIC_INLINE uint32_t LL_DAC_DMA_GetRegAddr
(DAC_TypeDef * DACx, uint32_t DAC_Channel, uint32_t Register)
Function
description
Function to help to configure DMA transfer to DAC: retrieve the DAC
register address from DAC instance and a list of DAC registers
intended to be used (most commonly) with DMA transfer.
Parameters
754/1320
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on all
devices. Refer to device datasheet for channels availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
DocID026525 Rev 6
UM1785
LL DAC Generic Driver
Register: This parameter can be one of the following values:
LL_DAC_DMA_REG_DATA_12BITS_RIGHT_ALIGNED
LL_DAC_DMA_REG_DATA_12BITS_LEFT_ALIGNED
LL_DAC_DMA_REG_DATA_8BITS_RIGHT_ALIGNED
Return values
DAC: register address
Notes
These DAC registers are data holding registers: when DAC
conversion is requested, DAC generates a DMA transfer request
to have data available in DAC data holding registers.
This macro is intended to be used with LL DMA driver, refer to
function "LL_DMA_ConfigAddresses()". Example:
LL_DMA_ConfigAddresses(DMA1, LL_DMA_CHANNEL_1,
(uint32_t)&< array or variable >,
LL_DAC_DMA_GetRegAddr(DAC1, LL_DAC_CHANNEL_1,
LL_DAC_DMA_REG_DATA_12BITS_RIGHT_ALIGNED),
LL_DMA_DIRECTION_MEMORY_TO_PERIPH);
Reference
Manual to LL API
cross reference:
DHR12R1 DACC1DHR LL_DAC_DMA_GetRegAddr
DHR12L1 DACC1DHR LL_DAC_DMA_GetRegAddr
DHR8R1 DACC1DHR LL_DAC_DMA_GetRegAddr
DHR12R2 DACC2DHR LL_DAC_DMA_GetRegAddr
DHR12L2 DACC2DHR LL_DAC_DMA_GetRegAddr
DHR8R2 DACC2DHR LL_DAC_DMA_GetRegAddr
LL_DAC_Enable
Function name
__STATIC_INLINE void LL_DAC_Enable (DAC_TypeDef *
DACx, uint32_t DAC_Channel)
Function description
Enable DAC selected channel.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
Return values
None
Notes
After enable from off state, DAC channel requires a delay for
output voltage to reach accuracy +/- 1 LSB. Refer to device
datasheet, parameter "tWAKEUP".
Reference Manual to
LL API cross
reference:
CR EN1 LL_DAC_Enable
CR EN2 LL_DAC_Enable
LL_DAC_Disable
Function name
__STATIC_INLINE void LL_DAC_Disable (DAC_TypeDef *
DACx, uint32_t DAC_Channel)
Function description
Disable DAC selected channel.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
DocID026525 Rev 6
755/1320
LL DAC Generic Driver
UM1785
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
Return values
None
Reference Manual to
LL API cross
reference:
CR EN1 LL_DAC_Disable
CR EN2 LL_DAC_Disable
LL_DAC_IsEnabled
Function name
__STATIC_INLINE uint32_t LL_DAC_IsEnabled (DAC_TypeDef
* DACx, uint32_t DAC_Channel)
Function description
Get DAC enable state of the selected channel.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR EN1 LL_DAC_IsEnabled
CR EN2 LL_DAC_IsEnabled
LL_DAC_EnableTrigger
756/1320
Function name
__STATIC_INLINE void LL_DAC_EnableTrigger
(DAC_TypeDef * DACx, uint32_t DAC_Channel)
Function description
Enable DAC trigger of the selected channel.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
Return values
None
Notes
- If DAC trigger is disabled, DAC conversion is performed
automatically once the data holding register is updated, using
functions "LL_DAC_ConvertData{8; 12}{Right; Left}
Aligned()": LL_DAC_ConvertData12RightAligned(), ... If DAC
trigger is enabled, DAC conversion is performed only when a
hardware of software trigger event is occurring. Select trigger
source using function LL_DAC_SetTriggerSource().
Reference Manual to
LL API cross
CR TEN1 LL_DAC_EnableTrigger
DocID026525 Rev 6
UM1785
LL DAC Generic Driver
reference:
CR TEN2 LL_DAC_EnableTrigger
LL_DAC_DisableTrigger
Function name
__STATIC_INLINE void LL_DAC_DisableTrigger
(DAC_TypeDef * DACx, uint32_t DAC_Channel)
Function description
Disable DAC trigger of the selected channel.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
Return values
None
Reference Manual to
LL API cross
reference:
CR TEN1 LL_DAC_DisableTrigger
CR TEN2 LL_DAC_DisableTrigger
LL_DAC_IsTriggerEnabled
Function name
__STATIC_INLINE uint32_t LL_DAC_IsTriggerEnabled
(DAC_TypeDef * DACx, uint32_t DAC_Channel)
Function description
Get DAC trigger state of the selected channel.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR TEN1 LL_DAC_IsTriggerEnabled
CR TEN2 LL_DAC_IsTriggerEnabled
LL_DAC_TrigSWConversion
Function name
__STATIC_INLINE void LL_DAC_TrigSWConversion
(DAC_TypeDef * DACx, uint32_t DAC_Channel)
Function description
Trig DAC conversion by software for the selected DAC channel.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can a combination of the
following values: (1) On this STM32 serie, parameter not
available on all devices. Refer to device datasheet for
channels availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
DocID026525 Rev 6
757/1320
LL DAC Generic Driver
Return values
UM1785
None
Notes
Preliminarily, DAC trigger must be set to software trigger
using function LL_DAC_SetTriggerSource() with parameter
"LL_DAC_TRIGGER_SOFTWARE". and DAC trigger must be
enabled using function LL_DAC_EnableTrigger().
For devices featuring DAC with 2 channelsthis function can
perform a SW start of both DAC channels simultaneously.
Two channels can be selected as parameter. Example:
(LL_DAC_CHANNEL_1 | LL_DAC_CHANNEL_2)
Reference Manual to
LL API cross
reference:
SWTRIGR SWTRIG1 LL_DAC_TrigSWConversion
SWTRIGR SWTRIG2 LL_DAC_TrigSWConversion
LL_DAC_ConvertData12RightAligned
Function name
__STATIC_INLINE void LL_DAC_ConvertData12RightAligned
(DAC_TypeDef * DACx, uint32_t DAC_Channel, uint32_t Data)
Function description
Set the data to be loaded in the data holding register in format 12
bits left alignment (LSB aligned on bit 0), for the selected DAC
channel.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
Data: Value between Min_Data=0x000 and
Max_Data=0xFFF
Return values
None
Reference Manual to
LL API cross
reference:
DHR12R1 DACC1DHR LL_DAC_ConvertData12RightAligned
DHR12R2 DACC2DHR
LL_DAC_ConvertData12RightAligned
LL_DAC_ConvertData12LeftAligned
Function name
__STATIC_INLINE void LL_DAC_ConvertData12LeftAligned
(DAC_TypeDef * DACx, uint32_t DAC_Channel, uint32_t Data)
Function description
Set the data to be loaded in the data holding register in format 12
bits left alignment (MSB aligned on bit 15), for the selected DAC
channel.
Parameters
758/1320
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
Data: Value between Min_Data=0x000 and
DocID026525 Rev 6
UM1785
LL DAC Generic Driver
Max_Data=0xFFF
Return values
None
Reference Manual to
LL API cross
reference:
DHR12L1 DACC1DHR LL_DAC_ConvertData12LeftAligned
DHR12L2 DACC2DHR LL_DAC_ConvertData12LeftAligned
LL_DAC_ConvertData8RightAligned
Function name
__STATIC_INLINE void LL_DAC_ConvertData8RightAligned
(DAC_TypeDef * DACx, uint32_t DAC_Channel, uint32_t Data)
Function description
Set the data to be loaded in the data holding register in format 8
bits left alignment (LSB aligned on bit 0), for the selected DAC
channel.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
Data: Value between Min_Data=0x00 and Max_Data=0xFF
Return values
None
Reference Manual to
LL API cross
reference:
DHR8R1 DACC1DHR LL_DAC_ConvertData8RightAligned
DHR8R2 DACC2DHR LL_DAC_ConvertData8RightAligned
LL_DAC_ConvertDualData12RightAligned
Function name
__STATIC_INLINE void
LL_DAC_ConvertDualData12RightAligned (DAC_TypeDef *
DACx, uint32_t DataChannel1, uint32_t DataChannel2)
Function description
Set the data to be loaded in the data holding register in format 12
bits left alignment (LSB aligned on bit 0), for both DAC channels.
Parameters
DACx: DAC instance
DataChannel1: Value between Min_Data=0x000 and
Max_Data=0xFFF
DataChannel2: Value between Min_Data=0x000 and
Max_Data=0xFFF
Return values
None
Reference Manual to
LL API cross
reference:
DHR12RD DACC1DHR
LL_DAC_ConvertDualData12RightAligned
DHR12RD DACC2DHR
LL_DAC_ConvertDualData12RightAligned
DocID026525 Rev 6
759/1320
LL DAC Generic Driver
UM1785
LL_DAC_ConvertDualData12LeftAligned
Function name
__STATIC_INLINE void
LL_DAC_ConvertDualData12LeftAligned (DAC_TypeDef *
DACx, uint32_t DataChannel1, uint32_t DataChannel2)
Function description
Set the data to be loaded in the data holding register in format 12
bits left alignment (MSB aligned on bit 15), for both DAC channels.
Parameters
DACx: DAC instance
DataChannel1: Value between Min_Data=0x000 and
Max_Data=0xFFF
DataChannel2: Value between Min_Data=0x000 and
Max_Data=0xFFF
Return values
None
Reference Manual to
LL API cross
reference:
DHR12LD DACC1DHR
LL_DAC_ConvertDualData12LeftAligned
DHR12LD DACC2DHR
LL_DAC_ConvertDualData12LeftAligned
LL_DAC_ConvertDualData8RightAligned
Function name
__STATIC_INLINE void
LL_DAC_ConvertDualData8RightAligned (DAC_TypeDef *
DACx, uint32_t DataChannel1, uint32_t DataChannel2)
Function description
Set the data to be loaded in the data holding register in format 8
bits left alignment (LSB aligned on bit 0), for both DAC channels.
Parameters
DACx: DAC instance
DataChannel1: Value between Min_Data=0x00 and
Max_Data=0xFF
DataChannel2: Value between Min_Data=0x00 and
Max_Data=0xFF
Return values
None
Reference Manual to
LL API cross
reference:
DHR8RD DACC1DHR
LL_DAC_ConvertDualData8RightAligned
DHR8RD DACC2DHR
LL_DAC_ConvertDualData8RightAligned
LL_DAC_RetrieveOutputData
Function name
__STATIC_INLINE uint32_t LL_DAC_RetrieveOutputData
(DAC_TypeDef * DACx, uint32_t DAC_Channel)
Function description
Retrieve output data currently generated for the selected DAC
channel.
Parameters
760/1320
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
DocID026525 Rev 6
UM1785
LL DAC Generic Driver
Return values
Value: between Min_Data=0x000 and Max_Data=0xFFF
Notes
Whatever alignment and resolution settings (using functions
"LL_DAC_ConvertData{8; 12}{Right; Left} Aligned()":
LL_DAC_ConvertData12RightAligned(), ...), output data
format is 12 bits right aligned (LSB aligned on bit 0).
Reference Manual to
LL API cross
reference:
DOR1 DACC1DOR LL_DAC_RetrieveOutputData
DOR2 DACC2DOR LL_DAC_RetrieveOutputData
LL_DAC_IsActiveFlag_DMAUDR1
Function name
__STATIC_INLINE uint32_t LL_DAC_IsActiveFlag_DMAUDR1
(DAC_TypeDef * DACx)
Function description
Get DAC underrun flag for DAC channel 1.
Parameters
DACx: DAC instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR DMAUDR1 LL_DAC_IsActiveFlag_DMAUDR1
LL_DAC_IsActiveFlag_DMAUDR2
Function name
__STATIC_INLINE uint32_t LL_DAC_IsActiveFlag_DMAUDR2
(DAC_TypeDef * DACx)
Function description
Get DAC underrun flag for DAC channel 2.
Parameters
DACx: DAC instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR DMAUDR2 LL_DAC_IsActiveFlag_DMAUDR2
LL_DAC_ClearFlag_DMAUDR1
Function name
__STATIC_INLINE void LL_DAC_ClearFlag_DMAUDR1
(DAC_TypeDef * DACx)
Function description
Clear DAC underrun flag for DAC channel 1.
Parameters
DACx: DAC instance
Return values
None
Reference Manual to
LL API cross
reference:
SR DMAUDR1 LL_DAC_ClearFlag_DMAUDR1
DocID026525 Rev 6
761/1320
LL DAC Generic Driver
UM1785
LL_DAC_ClearFlag_DMAUDR2
Function name
__STATIC_INLINE void LL_DAC_ClearFlag_DMAUDR2
(DAC_TypeDef * DACx)
Function description
Clear DAC underrun flag for DAC channel 2.
Parameters
DACx: DAC instance
Return values
None
Reference Manual to
LL API cross
reference:
SR DMAUDR2 LL_DAC_ClearFlag_DMAUDR2
LL_DAC_EnableIT_DMAUDR1
Function name
__STATIC_INLINE void LL_DAC_EnableIT_DMAUDR1
(DAC_TypeDef * DACx)
Function description
Enable DMA underrun interrupt for DAC channel 1.
Parameters
DACx: DAC instance
Return values
None
Reference Manual to
LL API cross
reference:
CR DMAUDRIE1 LL_DAC_EnableIT_DMAUDR1
LL_DAC_EnableIT_DMAUDR2
Function name
__STATIC_INLINE void LL_DAC_EnableIT_DMAUDR2
(DAC_TypeDef * DACx)
Function description
Enable DMA underrun interrupt for DAC channel 2.
Parameters
DACx: DAC instance
Return values
None
Reference Manual to
LL API cross
reference:
CR DMAUDRIE2 LL_DAC_EnableIT_DMAUDR2
LL_DAC_DisableIT_DMAUDR1
762/1320
Function name
__STATIC_INLINE void LL_DAC_DisableIT_DMAUDR1
(DAC_TypeDef * DACx)
Function description
Disable DMA underrun interrupt for DAC channel 1.
Parameters
DACx: DAC instance
Return values
None
Reference Manual to
LL API cross
reference:
CR DMAUDRIE1 LL_DAC_DisableIT_DMAUDR1
DocID026525 Rev 6
UM1785
LL DAC Generic Driver
LL_DAC_DisableIT_DMAUDR2
Function name
__STATIC_INLINE void LL_DAC_DisableIT_DMAUDR2
(DAC_TypeDef * DACx)
Function description
Disable DMA underrun interrupt for DAC channel 2.
Parameters
DACx: DAC instance
Return values
None
Reference Manual to
LL API cross
reference:
CR DMAUDRIE2 LL_DAC_DisableIT_DMAUDR2
LL_DAC_IsEnabledIT_DMAUDR1
Function name
__STATIC_INLINE uint32_t LL_DAC_IsEnabledIT_DMAUDR1
(DAC_TypeDef * DACx)
Function description
Get DMA underrun interrupt for DAC channel 1.
Parameters
DACx: DAC instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR DMAUDRIE1 LL_DAC_IsEnabledIT_DMAUDR1
LL_DAC_IsEnabledIT_DMAUDR2
Function name
__STATIC_INLINE uint32_t LL_DAC_IsEnabledIT_DMAUDR2
(DAC_TypeDef * DACx)
Function description
Get DMA underrun interrupt for DAC channel 2.
Parameters
DACx: DAC instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR DMAUDRIE2 LL_DAC_IsEnabledIT_DMAUDR2
LL_DAC_DeInit
Function name
ErrorStatus LL_DAC_DeInit (DAC_TypeDef * DACx)
Function description
De-initialize registers of the selected DAC instance to their default
reset values.
Parameters
DACx: DAC instance
Return values
An: ErrorStatus enumeration value:
SUCCESS: DAC registers are de-initialized
ERROR: not applicable
DocID026525 Rev 6
763/1320
LL DAC Generic Driver
UM1785
LL_DAC_Init
Function name
ErrorStatus LL_DAC_Init (DAC_TypeDef * DACx, uint32_t
DAC_Channel, LL_DAC_InitTypeDef * DAC_InitStruct)
Function description
Initialize some features of DAC instance.
Parameters
DACx: DAC instance
DAC_Channel: This parameter can be one of the following
values: (1) On this STM32 serie, parameter not available on
all devices. Refer to device datasheet for channels
availability.
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
DAC_InitStruct: Pointer to a LL_DAC_InitTypeDef structure
Return values
An: ErrorStatus enumeration value:
SUCCESS: DAC registers are initialized
ERROR: DAC registers are not initialized
Notes
The setting of these parameters by function LL_DAC_Init() is
conditioned to DAC state: DAC instance must be disabled.
LL_DAC_StructInit
Function name
void LL_DAC_StructInit (LL_DAC_InitTypeDef *
DAC_InitStruct)
Function description
Set each LL_DAC_InitTypeDef field to default value.
Parameters
DAC_InitStruct: pointer to a LL_DAC_InitTypeDef structure
whose fields will be set to default values.
Return values
None
55.3
DAC Firmware driver defines
55.3.1
DAC
DAC channels
LL_DAC_CHANNEL_1
DAC channel 1
LL_DAC_CHANNEL_2
DAC channel 2
DAC flags
LL_DAC_FLAG_DMAUDR1
DAC channel 1 flag DMA underrun
LL_DAC_FLAG_DMAUDR2
DAC channel 2 flag DMA underrun
Definitions of DAC hardware constraints delays
764/1320
LL_DAC_DELAY_STARTUP_VOLTAGE_SETTLING_US
Delay for DAC channel voltage
settling time from DAC channel
startup (transition from disable
to enable)
LL_DAC_DELAY_VOLTAGE_SETTLING_US
Delay for DAC channel voltage
settling time
DocID026525 Rev 6
UM1785
LL DAC Generic Driver
DAC interruptions
LL_DAC_IT_DMAUDRIE1
DAC channel 1 interruption DMA underrun
LL_DAC_IT_DMAUDRIE2
DAC channel 2 interruption DMA underrun
DAC channel output buffer
LL_DAC_OUTPUT_BUFFER_ENABLE
The selected DAC channel output is buffered:
higher drive current capability, but also higher
current consumption
LL_DAC_OUTPUT_BUFFER_DISABLE
The selected DAC channel output is not
buffered: lower drive current capability, but also
lower current consumption
DAC registers compliant with specific purpose
LL_DAC_DMA_REG_DATA_12BITS_RIGHT_ALIGNED
DAC channel data holding
register 12 bits right aligned
LL_DAC_DMA_REG_DATA_12BITS_LEFT_ALIGNED
DAC channel data holding
register 12 bits left aligned
LL_DAC_DMA_REG_DATA_8BITS_RIGHT_ALIGNED
DAC channel data holding
register 8 bits right aligned
DAC channel output resolution
LL_DAC_RESOLUTION_12B
DAC channel resolution 12 bits
LL_DAC_RESOLUTION_8B
DAC channel resolution 8 bits
DAC trigger source
LL_DAC_TRIG_SOFTWARE
DAC channel conversion trigger internal (SW start)
LL_DAC_TRIG_EXT_TIM2_TRGO
DAC channel conversion trigger from external IP:
TIM2 TRGO.
LL_DAC_TRIG_EXT_TIM3_TRGO
DAC channel conversion trigger from external IP:
TIM3 TRGO.
LL_DAC_TRIG_EXT_TIM4_TRGO
DAC channel conversion trigger from external IP:
TIM4 TRGO.
LL_DAC_TRIG_EXT_TIM6_TRGO
DAC channel conversion trigger from external IP:
TIM6 TRGO.
LL_DAC_TRIG_EXT_TIM7_TRGO
DAC channel conversion trigger from external IP:
TIM7 TRGO.
LL_DAC_TRIG_EXT_TIM15_TRGO
DAC channel conversion trigger from external IP:
TIM15 TRGO.
LL_DAC_TRIG_EXT_EXTI_LINE9
DAC channel conversion trigger from external IP:
external interrupt line 9.
DAC waveform automatic generation mode
LL_DAC_WAVE_AUTO_GENERATION_NONE
DAC channel wave auto generation
mode disabled.
LL_DAC_WAVE_AUTO_GENERATION_NOISE
DAC channel wave auto generation
mode enabled, set generated noise
waveform.
DocID026525 Rev 6
765/1320
LL DAC Generic Driver
LL_DAC_WAVE_AUTO_GENERATION_TRIANGLE
UM1785
DAC channel wave auto generation
mode enabled, set generated
triangle waveform.
DAC wave generation - Noise LFSR unmask bits
LL_DAC_NOISE_LFSR_UNMASK_BIT0
Noise wave generation, unmask LFSR
bit0, for the selected DAC channel
LL_DAC_NOISE_LFSR_UNMASK_BITS1_0
Noise wave generation, unmask LFSR
bits[1:0], for the selected DAC channel
LL_DAC_NOISE_LFSR_UNMASK_BITS2_0
Noise wave generation, unmask LFSR
bits[2:0], for the selected DAC channel
LL_DAC_NOISE_LFSR_UNMASK_BITS3_0
Noise wave generation, unmask LFSR
bits[3:0], for the selected DAC channel
LL_DAC_NOISE_LFSR_UNMASK_BITS4_0
Noise wave generation, unmask LFSR
bits[4:0], for the selected DAC channel
LL_DAC_NOISE_LFSR_UNMASK_BITS5_0
Noise wave generation, unmask LFSR
bits[5:0], for the selected DAC channel
LL_DAC_NOISE_LFSR_UNMASK_BITS6_0
Noise wave generation, unmask LFSR
bits[6:0], for the selected DAC channel
LL_DAC_NOISE_LFSR_UNMASK_BITS7_0
Noise wave generation, unmask LFSR
bits[7:0], for the selected DAC channel
LL_DAC_NOISE_LFSR_UNMASK_BITS8_0
Noise wave generation, unmask LFSR
bits[8:0], for the selected DAC channel
LL_DAC_NOISE_LFSR_UNMASK_BITS9_0
Noise wave generation, unmask LFSR
bits[9:0], for the selected DAC channel
LL_DAC_NOISE_LFSR_UNMASK_BITS10_0
Noise wave generation, unmask LFSR
bits[10:0], for the selected DAC channel
LL_DAC_NOISE_LFSR_UNMASK_BITS11_0
Noise wave generation, unmask LFSR
bits[11:0], for the selected DAC channel
DAC wave generation - Triangle amplitude
766/1320
LL_DAC_TRIANGLE_AMPLITUDE_1
Triangle wave generation, amplitude of 1 LSB
of DAC output range, for the selected DAC
channel
LL_DAC_TRIANGLE_AMPLITUDE_3
Triangle wave generation, amplitude of 3 LSB
of DAC output range, for the selected DAC
channel
LL_DAC_TRIANGLE_AMPLITUDE_7
Triangle wave generation, amplitude of 7 LSB
of DAC output range, for the selected DAC
channel
LL_DAC_TRIANGLE_AMPLITUDE_15
Triangle wave generation, amplitude of 15 LSB
of DAC output range, for the selected DAC
channel
LL_DAC_TRIANGLE_AMPLITUDE_31
Triangle wave generation, amplitude of 31 LSB
of DAC output range, for the selected DAC
channel
LL_DAC_TRIANGLE_AMPLITUDE_63
Triangle wave generation, amplitude of 63 LSB
DocID026525 Rev 6
UM1785
LL DAC Generic Driver
of DAC output range, for the selected DAC
channel
LL_DAC_TRIANGLE_AMPLITUDE_127
Triangle wave generation, amplitude of 127
LSB of DAC output range, for the selected
DAC channel
LL_DAC_TRIANGLE_AMPLITUDE_255
Triangle wave generation, amplitude of 255
LSB of DAC output range, for the selected
DAC channel
LL_DAC_TRIANGLE_AMPLITUDE_511
Triangle wave generation, amplitude of 512
LSB of DAC output range, for the selected
DAC channel
LL_DAC_TRIANGLE_AMPLITUDE_1023
Triangle wave generation, amplitude of 1023
LSB of DAC output range, for the selected
DAC channel
LL_DAC_TRIANGLE_AMPLITUDE_2047
Triangle wave generation, amplitude of 2047
LSB of DAC output range, for the selected
DAC channel
LL_DAC_TRIANGLE_AMPLITUDE_4095
Triangle wave generation, amplitude of 4095
LSB of DAC output range, for the selected
DAC channel
DAC helper macro
__LL_DAC_CHANNEL_TO_DECIMAL_
NB
Description:
Helper macro to get DAC channel number
in decimal format from literals
LL_DAC_CHANNEL_x.
Parameters:
__CHANNEL__: This parameter can be
one of the following values:
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
Return value:
1...2: (value "2" depending on DAC
channel 2 availability)
Notes:
The input can be a value from functions
where a channel number is returned.
__LL_DAC_DECIMAL_NB_TO_
CHANNEL
Description:
Helper macro to get DAC channel in literal
format LL_DAC_CHANNEL_x from
number in decimal format.
Parameters:
__DECIMAL_NB__: 1...2 (value "2"
depending on DAC channel 2 availability)
DocID026525 Rev 6
767/1320
LL DAC Generic Driver
UM1785
Return value:
Returned: value can be one of the
following values:
LL_DAC_CHANNEL_1
LL_DAC_CHANNEL_2 (1)
Notes:
If the input parameter does not
correspond to a DAC channel, this macro
returns value '0'.
__LL_DAC_DIGITAL_SCALE
Description:
Helper macro to define the DAC
conversion data full-scale digital value
corresponding to the selected DAC
resolution.
Parameters:
__DAC_RESOLUTION__: This parameter
can be one of the following values:
LL_DAC_RESOLUTION_12B
LL_DAC_RESOLUTION_8B
Return value:
ADC: conversion data equivalent voltage
value (unit: mVolt)
Notes:
DAC conversion data full-scale
corresponds to voltage range determined
by analog voltage references Vref+ and
Vref- (refer to reference manual).
__LL_DAC_CALC_VOLTAGE_TO_
DATA
Description:
Helper macro to calculate the DAC
conversion data (unit: digital value)
corresponding to a voltage (unit: mVolt).
Parameters:
__VREFANALOG_VOLTAGE__: Analog
reference voltage (unit: mV)
__DAC_VOLTAGE__: Voltage to be
generated by DAC channel (unit: mVolt).
__DAC_RESOLUTION__: This parameter
can be one of the following values:
LL_DAC_RESOLUTION_12B
LL_DAC_RESOLUTION_8B
Return value:
DAC: conversion data (unit: digital value)
Notes:
This helper macro is intended to provide
input data in voltage rather than digital
768/1320
DocID026525 Rev 6
UM1785
LL DAC Generic Driver
value, to be used with LL DAC functions
such as
LL_DAC_ConvertData12RightAligned().
Analog reference voltage (Vref+) must be
either known from user board
environment or can be calculated using
ADC measurement and ADC helper
macro
__LL_ADC_CALC_VREFANALOG_VOLT
AGE().
Common write and read registers macros
LL_DAC_WriteReg
Description:
Write a value in DAC register.
Parameters:
__INSTANCE__: DAC Instance
__REG__: Register to be written
__VALUE__: Value to be written in the register
Return value:
None
LL_DAC_ReadReg
Description:
Read a value in DAC register.
Parameters:
__INSTANCE__: DAC Instance
__REG__: Register to be read
Return value:
Register: value
DocID026525 Rev 6
769/1320
LL DMA Generic Driver
UM1785
56
LL DMA Generic Driver
56.1
DMA Firmware driver registers structures
56.1.1
LL_DMA_InitTypeDef
Data Fields
uint32_t PeriphOrM2MSrcAddress
uint32_t MemoryOrM2MDstAddress
uint32_t Direction
uint32_t Mode
uint32_t PeriphOrM2MSrcIncMode
uint32_t MemoryOrM2MDstIncMode
uint32_t PeriphOrM2MSrcDataSize
uint32_t MemoryOrM2MDstDataSize
uint32_t NbData
uint32_t PeriphRequest
uint32_t Priority
Field Documentation
uint32_t LL_DMA_InitTypeDef::PeriphOrM2MSrcAddress
Specifies the peripheral base address for DMA transfer or as Source base address in
case of memory to memory transfer direction.This parameter must be a value between
Min_Data = 0 and Max_Data = 0xFFFFFFFF.
uint32_t LL_DMA_InitTypeDef::MemoryOrM2MDstAddress
Specifies the memory base address for DMA transfer or as Destination base address
in case of memory to memory transfer direction.This parameter must be a value
between Min_Data = 0 and Max_Data = 0xFFFFFFFF.
uint32_t LL_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_LL_EC_DIRECTIONThis feature can be modified afterwards using unitary
function LL_DMA_SetDataTransferDirection().
uint32_t LL_DMA_InitTypeDef::Mode
Specifies the normal or circular operation mode. This parameter can be a value of
DMA_LL_EC_MODE
Note:: The circular buffer mode cannot be used if the memory to memory data
transfer direction is configured on the selected Channel This feature can be modified
afterwards using unitary function LL_DMA_SetMode().
uint32_t LL_DMA_InitTypeDef::PeriphOrM2MSrcIncMode
Specifies whether the Peripheral address or Source address in case of memory to
memory transfer direction is incremented or not. This parameter can be a value of
DMA_LL_EC_PERIPHThis feature can be modified afterwards using unitary function
LL_DMA_SetPeriphIncMode().
uint32_t LL_DMA_InitTypeDef::MemoryOrM2MDstIncMode
Specifies whether the Memory address or Destination address in case of memory to
memory transfer direction is incremented or not. This parameter can be a value of
DMA_LL_EC_MEMORYThis feature can be modified afterwards using unitary
function LL_DMA_SetMemoryIncMode().
uint32_t LL_DMA_InitTypeDef::PeriphOrM2MSrcDataSize
Specifies the Peripheral data size alignment or Source data size alignment (byte, half
770/1320
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
word, word) in case of memory to memory transfer direction. This parameter can be a
value of DMA_LL_EC_PDATAALIGNThis feature can be modified afterwards using
unitary function LL_DMA_SetPeriphSize().
uint32_t LL_DMA_InitTypeDef::MemoryOrM2MDstDataSize
Specifies the Memory data size alignment or Destination data size alignment (byte,
half word, word) in case of memory to memory transfer direction. This parameter can
be a value of DMA_LL_EC_MDATAALIGNThis feature can be modified afterwards
using unitary function LL_DMA_SetMemorySize().
uint32_t LL_DMA_InitTypeDef::NbData
Specifies the number of data to transfer, in data unit. The data unit is equal to the
source buffer configuration set in PeripheralSize or MemorySize parameters
depending in the transfer direction. This parameter must be a value between
Min_Data = 0 and Max_Data = 0x0000FFFFThis feature can be modified afterwards
using unitary function LL_DMA_SetDataLength().
uint32_t LL_DMA_InitTypeDef::PeriphRequest
Specifies the peripheral request. This parameter can be a value of
DMA_LL_EC_REQUESTThis feature can be modified afterwards using unitary
function LL_DMA_SetPeriphRequest().
uint32_t LL_DMA_InitTypeDef::Priority
Specifies the channel priority level. This parameter can be a value of
DMA_LL_EC_PRIORITYThis feature can be modified afterwards using unitary
function LL_DMA_SetChannelPriorityLevel().
56.2
DMA Firmware driver API description
56.2.1
Detailed description of functions
LL_DMA_EnableChannel
Function name
__STATIC_INLINE void LL_DMA_EnableChannel
(DMA_TypeDef * DMAx, uint32_t Channel)
Function description
Enable DMA channel.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
None
Reference Manual to
LL API cross
reference:
CCR EN LL_DMA_EnableChannel
LL_DMA_DisableChannel
Function name
__STATIC_INLINE void LL_DMA_DisableChannel
(DMA_TypeDef * DMAx, uint32_t Channel)
Function description
Disable DMA channel.
DocID026525 Rev 6
771/1320
LL DMA Generic Driver
Parameters
UM1785
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
None
Reference Manual to
LL API cross
reference:
CCR EN LL_DMA_DisableChannel
LL_DMA_IsEnabledChannel
Function name
__STATIC_INLINE uint32_t LL_DMA_IsEnabledChannel
(DMA_TypeDef * DMAx, uint32_t Channel)
Function description
Check if DMA channel is enabled or disabled.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CCR EN LL_DMA_IsEnabledChannel
LL_DMA_ConfigTransfer
Function name
__STATIC_INLINE void LL_DMA_ConfigTransfer
(DMA_TypeDef * DMAx, uint32_t Channel, uint32_t
Configuration)
Function description
Configure all parameters link to DMA transfer.
Parameters
772/1320
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
Configuration: This parameter must be a combination of all
the following values:
LL_DMA_DIRECTION_PERIPH_TO_MEMORY or
LL_DMA_DIRECTION_MEMORY_TO_PERIPH or
LL_DMA_DIRECTION_MEMORY_TO_MEMORY
LL_DMA_MODE_NORMAL or
LL_DMA_MODE_CIRCULAR
LL_DMA_PERIPH_INCREMENT or
LL_DMA_PERIPH_NOINCREMENT
LL_DMA_MEMORY_INCREMENT or
LL_DMA_MEMORY_NOINCREMENT
LL_DMA_PDATAALIGN_BYTE or
LL_DMA_PDATAALIGN_HALFWORD or
LL_DMA_PDATAALIGN_WORD
LL_DMA_MDATAALIGN_BYTE or
LL_DMA_MDATAALIGN_HALFWORD or
LL_DMA_MDATAALIGN_WORD
LL_DMA_PRIORITY_LOW or
LL_DMA_PRIORITY_MEDIUM or
LL_DMA_PRIORITY_HIGH or
LL_DMA_PRIORITY_VERYHIGH
Return values
None
Reference Manual to
LL API cross
reference:
CCR DIR LL_DMA_ConfigTransfer
CCR MEM2MEM LL_DMA_ConfigTransfer
CCR CIRC LL_DMA_ConfigTransfer
CCR PINC LL_DMA_ConfigTransfer
CCR MINC LL_DMA_ConfigTransfer
CCR PSIZE LL_DMA_ConfigTransfer
CCR MSIZE LL_DMA_ConfigTransfer
CCR PL LL_DMA_ConfigTransfer
LL_DMA_SetDataTransferDirection
Function name
__STATIC_INLINE void LL_DMA_SetDataTransferDirection
(DMA_TypeDef * DMAx, uint32_t Channel, uint32_t Direction)
Function description
Set Data transfer direction (read from peripheral or from memory).
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Direction: This parameter can be one of the following
values:
LL_DMA_DIRECTION_PERIPH_TO_MEMORY
LL_DMA_DIRECTION_MEMORY_TO_PERIPH
DocID026525 Rev 6
773/1320
LL DMA Generic Driver
UM1785
LL_DMA_DIRECTION_MEMORY_TO_MEMORY
Return values
None
Reference Manual to
LL API cross
reference:
CCR DIR LL_DMA_SetDataTransferDirection
CCR MEM2MEM LL_DMA_SetDataTransferDirection
LL_DMA_GetDataTransferDirection
Function name
__STATIC_INLINE uint32_t
LL_DMA_GetDataTransferDirection (DMA_TypeDef * DMAx,
uint32_t Channel)
Function description
Get Data transfer direction (read from peripheral or from memory).
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
Returned: value can be one of the following values:
LL_DMA_DIRECTION_PERIPH_TO_MEMORY
LL_DMA_DIRECTION_MEMORY_TO_PERIPH
LL_DMA_DIRECTION_MEMORY_TO_MEMORY
Reference Manual to
LL API cross
reference:
CCR DIR LL_DMA_GetDataTransferDirection
CCR MEM2MEM LL_DMA_GetDataTransferDirection
LL_DMA_SetMode
774/1320
Function name
__STATIC_INLINE void LL_DMA_SetMode (DMA_TypeDef *
DMAx, uint32_t Channel, uint32_t Mode)
Function description
Set DMA mode circular or normal.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Mode: This parameter can be one of the following values:
LL_DMA_MODE_NORMAL
LL_DMA_MODE_CIRCULAR
Return values
None
Notes
The circular buffer mode cannot be used if the memory-toDocID026525 Rev 6
UM1785
LL DMA Generic Driver
memory data transfer is configured on the selected Channel.
Reference Manual to
LL API cross
reference:
CCR CIRC LL_DMA_SetMode
LL_DMA_GetMode
Function name
__STATIC_INLINE uint32_t LL_DMA_GetMode (DMA_TypeDef
* DMAx, uint32_t Channel)
Function description
Get DMA mode circular or normal.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
Returned: value can be one of the following values:
LL_DMA_MODE_NORMAL
LL_DMA_MODE_CIRCULAR
Reference Manual to
LL API cross
reference:
CCR CIRC LL_DMA_GetMode
LL_DMA_SetPeriphIncMode
Function name
__STATIC_INLINE void LL_DMA_SetPeriphIncMode
(DMA_TypeDef * DMAx, uint32_t Channel, uint32_t
PeriphOrM2MSrcIncMode)
Function description
Set Peripheral increment mode.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
PeriphOrM2MSrcIncMode: This parameter can be one of
the following values:
LL_DMA_PERIPH_INCREMENT
LL_DMA_PERIPH_NOINCREMENT
Return values
None
Reference Manual to
LL API cross
CCR PINC LL_DMA_SetPeriphIncMode
DocID026525 Rev 6
775/1320
LL DMA Generic Driver
reference:
UM1785
LL_DMA_GetPeriphIncMode
Function name
__STATIC_INLINE uint32_t LL_DMA_GetPeriphIncMode
(DMA_TypeDef * DMAx, uint32_t Channel)
Function description
Get Peripheral increment mode.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
Returned: value can be one of the following values:
LL_DMA_PERIPH_INCREMENT
LL_DMA_PERIPH_NOINCREMENT
Reference Manual to
LL API cross
reference:
CCR PINC LL_DMA_GetPeriphIncMode
LL_DMA_SetMemoryIncMode
776/1320
Function name
__STATIC_INLINE void LL_DMA_SetMemoryIncMode
(DMA_TypeDef * DMAx, uint32_t Channel, uint32_t
MemoryOrM2MDstIncMode)
Function description
Set Memory increment mode.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
MemoryOrM2MDstIncMode: This parameter can be one of
the following values:
LL_DMA_MEMORY_INCREMENT
LL_DMA_MEMORY_NOINCREMENT
Return values
None
Reference Manual to
LL API cross
reference:
CCR MINC LL_DMA_SetMemoryIncMode
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
LL_DMA_GetMemoryIncMode
Function name
__STATIC_INLINE uint32_t LL_DMA_GetMemoryIncMode
(DMA_TypeDef * DMAx, uint32_t Channel)
Function description
Get Memory increment mode.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
Returned: value can be one of the following values:
LL_DMA_MEMORY_INCREMENT
LL_DMA_MEMORY_NOINCREMENT
Reference Manual to
LL API cross
reference:
CCR MINC LL_DMA_GetMemoryIncMode
LL_DMA_SetPeriphSize
Function name
__STATIC_INLINE void LL_DMA_SetPeriphSize
(DMA_TypeDef * DMAx, uint32_t Channel, uint32_t
PeriphOrM2MSrcDataSize)
Function description
Set Peripheral size.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
PeriphOrM2MSrcDataSize: This parameter can be one of
the following values:
LL_DMA_PDATAALIGN_BYTE
LL_DMA_PDATAALIGN_HALFWORD
LL_DMA_PDATAALIGN_WORD
Return values
None
Reference Manual to
LL API cross
reference:
CCR PSIZE LL_DMA_SetPeriphSize
DocID026525 Rev 6
777/1320
LL DMA Generic Driver
UM1785
LL_DMA_GetPeriphSize
Function name
__STATIC_INLINE uint32_t LL_DMA_GetPeriphSize
(DMA_TypeDef * DMAx, uint32_t Channel)
Function description
Get Peripheral size.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
Returned: value can be one of the following values:
LL_DMA_PDATAALIGN_BYTE
LL_DMA_PDATAALIGN_HALFWORD
LL_DMA_PDATAALIGN_WORD
Reference Manual to
LL API cross
reference:
CCR PSIZE LL_DMA_GetPeriphSize
LL_DMA_SetMemorySize
778/1320
Function name
__STATIC_INLINE void LL_DMA_SetMemorySize
(DMA_TypeDef * DMAx, uint32_t Channel, uint32_t
MemoryOrM2MDstDataSize)
Function description
Set Memory size.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
MemoryOrM2MDstDataSize: This parameter can be one of
the following values:
LL_DMA_MDATAALIGN_BYTE
LL_DMA_MDATAALIGN_HALFWORD
LL_DMA_MDATAALIGN_WORD
Return values
None
Reference Manual to
LL API cross
reference:
CCR MSIZE LL_DMA_SetMemorySize
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
LL_DMA_GetMemorySize
Function name
__STATIC_INLINE uint32_t LL_DMA_GetMemorySize
(DMA_TypeDef * DMAx, uint32_t Channel)
Function description
Get Memory size.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
Returned: value can be one of the following values:
LL_DMA_MDATAALIGN_BYTE
LL_DMA_MDATAALIGN_HALFWORD
LL_DMA_MDATAALIGN_WORD
Reference Manual to
LL API cross
reference:
CCR MSIZE LL_DMA_GetMemorySize
LL_DMA_SetChannelPriorityLevel
Function name
__STATIC_INLINE void LL_DMA_SetChannelPriorityLevel
(DMA_TypeDef * DMAx, uint32_t Channel, uint32_t Priority)
Function description
Set Channel priority level.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Priority: This parameter can be one of the following values:
LL_DMA_PRIORITY_LOW
LL_DMA_PRIORITY_MEDIUM
LL_DMA_PRIORITY_HIGH
LL_DMA_PRIORITY_VERYHIGH
Return values
None
Reference Manual to
LL API cross
reference:
CCR PL LL_DMA_SetChannelPriorityLevel
DocID026525 Rev 6
779/1320
LL DMA Generic Driver
UM1785
LL_DMA_GetChannelPriorityLevel
Function name
__STATIC_INLINE uint32_t LL_DMA_GetChannelPriorityLevel
(DMA_TypeDef * DMAx, uint32_t Channel)
Function description
Get Channel priority level.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
Returned: value can be one of the following values:
LL_DMA_PRIORITY_LOW
LL_DMA_PRIORITY_MEDIUM
LL_DMA_PRIORITY_HIGH
LL_DMA_PRIORITY_VERYHIGH
Reference Manual to
LL API cross
reference:
CCR PL LL_DMA_GetChannelPriorityLevel
LL_DMA_SetDataLength
780/1320
Function name
__STATIC_INLINE void LL_DMA_SetDataLength
(DMA_TypeDef * DMAx, uint32_t Channel, uint32_t NbData)
Function description
Set Number of data to transfer.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
NbData: Between Min_Data = 0 and Max_Data =
0x0000FFFF
Return values
None
Notes
This action has no effect if channel is enabled.
Reference Manual to
LL API cross
reference:
CNDTR NDT LL_DMA_SetDataLength
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
LL_DMA_GetDataLength
Function name
__STATIC_INLINE uint32_t LL_DMA_GetDataLength
(DMA_TypeDef * DMAx, uint32_t Channel)
Function description
Get Number of data to transfer.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
Between: Min_Data = 0 and Max_Data = 0xFFFFFFFF
Notes
Once the channel is enabled, the return value indicate the
remaining bytes to be transmitted.
Reference Manual to
LL API cross
reference:
CNDTR NDT LL_DMA_GetDataLength
LL_DMA_ConfigAddresses
Function name
__STATIC_INLINE void LL_DMA_ConfigAddresses
(DMA_TypeDef * DMAx, uint32_t Channel, uint32_t
SrcAddress, uint32_t DstAddress, uint32_t Direction)
Function description
Configure the Source and Destination addresses.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
SrcAddress: Between Min_Data = 0 and Max_Data =
0xFFFFFFFF
DstAddress: Between Min_Data = 0 and Max_Data =
0xFFFFFFFF
Direction: This parameter can be one of the following
values:
LL_DMA_DIRECTION_PERIPH_TO_MEMORY
LL_DMA_DIRECTION_MEMORY_TO_PERIPH
LL_DMA_DIRECTION_MEMORY_TO_MEMORY
Return values
None
Notes
This API must not be called when the DMA channel is
enabled.
Each IP using DMA provides an API to get directly the
DocID026525 Rev 6
781/1320
LL DMA Generic Driver
UM1785
register adress (LL_PPP_DMA_GetRegAddr).
Reference Manual to
LL API cross
reference:
CPAR PA LL_DMA_ConfigAddresses
CMAR MA LL_DMA_ConfigAddresses
LL_DMA_SetMemoryAddress
Function name
__STATIC_INLINE void LL_DMA_SetMemoryAddress
(DMA_TypeDef * DMAx, uint32_t Channel, uint32_t
MemoryAddress)
Function description
Set the Memory address.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
MemoryAddress: Between Min_Data = 0 and Max_Data =
0xFFFFFFFF
Return values
None
Notes
Interface used for direction
LL_DMA_DIRECTION_PERIPH_TO_MEMORY or
LL_DMA_DIRECTION_MEMORY_TO_PERIPH only.
This API must not be called when the DMA channel is
enabled.
Reference Manual to
LL API cross
reference:
CMAR MA LL_DMA_SetMemoryAddress
LL_DMA_SetPeriphAddress
Function name
__STATIC_INLINE void LL_DMA_SetPeriphAddress
(DMA_TypeDef * DMAx, uint32_t Channel, uint32_t
PeriphAddress)
Function description
Set the Peripheral address.
Parameters
782/1320
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
PeriphAddress: Between Min_Data = 0 and Max_Data =
0xFFFFFFFF
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
Return values
None
Notes
Interface used for direction
LL_DMA_DIRECTION_PERIPH_TO_MEMORY or
LL_DMA_DIRECTION_MEMORY_TO_PERIPH only.
This API must not be called when the DMA channel is
enabled.
Reference Manual to
LL API cross
reference:
CPAR PA LL_DMA_SetPeriphAddress
LL_DMA_GetMemoryAddress
Function name
__STATIC_INLINE uint32_t LL_DMA_GetMemoryAddress
(DMA_TypeDef * DMAx, uint32_t Channel)
Function description
Get Memory address.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
Between: Min_Data = 0 and Max_Data = 0xFFFFFFFF
Notes
Interface used for direction
LL_DMA_DIRECTION_PERIPH_TO_MEMORY or
LL_DMA_DIRECTION_MEMORY_TO_PERIPH only.
Reference Manual to
LL API cross
reference:
CMAR MA LL_DMA_GetMemoryAddress
LL_DMA_GetPeriphAddress
Function name
__STATIC_INLINE uint32_t LL_DMA_GetPeriphAddress
(DMA_TypeDef * DMAx, uint32_t Channel)
Function description
Get Peripheral address.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
Between: Min_Data = 0 and Max_Data = 0xFFFFFFFF
DocID026525 Rev 6
783/1320
LL DMA Generic Driver
Notes
Reference Manual to
LL API cross
reference:
UM1785
Interface used for direction
LL_DMA_DIRECTION_PERIPH_TO_MEMORY or
LL_DMA_DIRECTION_MEMORY_TO_PERIPH only.
CPAR PA LL_DMA_GetPeriphAddress
LL_DMA_SetM2MSrcAddress
Function name
__STATIC_INLINE void LL_DMA_SetM2MSrcAddress
(DMA_TypeDef * DMAx, uint32_t Channel, uint32_t
MemoryAddress)
Function description
Set the Memory to Memory Source address.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
MemoryAddress: Between Min_Data = 0 and Max_Data =
0xFFFFFFFF
Return values
None
Notes
Interface used for direction
LL_DMA_DIRECTION_MEMORY_TO_MEMORY only.
This API must not be called when the DMA channel is
enabled.
Reference Manual to
LL API cross
reference:
CPAR PA LL_DMA_SetM2MSrcAddress
LL_DMA_SetM2MDstAddress
Function name
__STATIC_INLINE void LL_DMA_SetM2MDstAddress
(DMA_TypeDef * DMAx, uint32_t Channel, uint32_t
MemoryAddress)
Function description
Set the Memory to Memory Destination address.
Parameters
784/1320
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
MemoryAddress: Between Min_Data = 0 and Max_Data =
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
0xFFFFFFFF
Return values
None
Notes
Interface used for direction
LL_DMA_DIRECTION_MEMORY_TO_MEMORY only.
This API must not be called when the DMA channel is
enabled.
Reference Manual to
LL API cross
reference:
CMAR MA LL_DMA_SetM2MDstAddress
LL_DMA_GetM2MSrcAddress
Function name
__STATIC_INLINE uint32_t LL_DMA_GetM2MSrcAddress
(DMA_TypeDef * DMAx, uint32_t Channel)
Function description
Get the Memory to Memory Source address.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
Between: Min_Data = 0 and Max_Data = 0xFFFFFFFF
Notes
Interface used for direction
LL_DMA_DIRECTION_MEMORY_TO_MEMORY only.
Reference Manual to
LL API cross
reference:
CPAR PA LL_DMA_GetM2MSrcAddress
LL_DMA_GetM2MDstAddress
Function name
__STATIC_INLINE uint32_t LL_DMA_GetM2MDstAddress
(DMA_TypeDef * DMAx, uint32_t Channel)
Function description
Get the Memory to Memory Destination address.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
Between: Min_Data = 0 and Max_Data = 0xFFFFFFFF
Notes
Interface used for direction
DocID026525 Rev 6
785/1320
LL DMA Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
LL_DMA_DIRECTION_MEMORY_TO_MEMORY only.
CMAR MA LL_DMA_GetM2MDstAddress
LL_DMA_SetPeriphRequest
786/1320
Function name
__STATIC_INLINE void LL_DMA_SetPeriphRequest
(DMA_TypeDef * DMAx, uint32_t Channel, uint32_t
PeriphRequest)
Function description
Set DMA request for DMA instance on Channel x.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
PeriphRequest: This parameter can be one of the following
values:
LL_DMA_REQUEST_0
LL_DMA_REQUEST_1
LL_DMA_REQUEST_2
LL_DMA_REQUEST_3
LL_DMA_REQUEST_4
LL_DMA_REQUEST_5
LL_DMA_REQUEST_6
LL_DMA_REQUEST_7
LL_DMA_REQUEST_8
LL_DMA_REQUEST_9
LL_DMA_REQUEST_10
LL_DMA_REQUEST_11
LL_DMA_REQUEST_12
LL_DMA_REQUEST_13
LL_DMA_REQUEST_14
LL_DMA_REQUEST_15
Return values
None
Notes
Please refer to Reference Manual to get the available
mapping of Request value link to Channel Selection.
Reference Manual to
LL API cross
reference:
CSELR C1S LL_DMA_SetPeriphRequest
CSELR C2S LL_DMA_SetPeriphRequest
CSELR C3S LL_DMA_SetPeriphRequest
CSELR C4S LL_DMA_SetPeriphRequest
CSELR C5S LL_DMA_SetPeriphRequest
CSELR C6S LL_DMA_SetPeriphRequest
CSELR C7S LL_DMA_SetPeriphRequest
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
LL_DMA_GetPeriphRequest
Function name
__STATIC_INLINE uint32_t LL_DMA_GetPeriphRequest
(DMA_TypeDef * DMAx, uint32_t Channel)
Function description
Get DMA request for DMA instance on Channel x.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
Returned: value can be one of the following values:
LL_DMA_REQUEST_0
LL_DMA_REQUEST_1
LL_DMA_REQUEST_2
LL_DMA_REQUEST_3
LL_DMA_REQUEST_4
LL_DMA_REQUEST_5
LL_DMA_REQUEST_6
LL_DMA_REQUEST_7
LL_DMA_REQUEST_8
LL_DMA_REQUEST_9
LL_DMA_REQUEST_10
LL_DMA_REQUEST_11
LL_DMA_REQUEST_12
LL_DMA_REQUEST_13
LL_DMA_REQUEST_14
LL_DMA_REQUEST_15
Reference Manual to
LL API cross
reference:
CSELR C1S LL_DMA_GetPeriphRequest
CSELR C2S LL_DMA_GetPeriphRequest
CSELR C3S LL_DMA_GetPeriphRequest
CSELR C4S LL_DMA_GetPeriphRequest
CSELR C5S LL_DMA_GetPeriphRequest
CSELR C6S LL_DMA_GetPeriphRequest
CSELR C7S LL_DMA_GetPeriphRequest
LL_DMA_IsActiveFlag_GI1
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_GI1
(DMA_TypeDef * DMAx)
Function description
Get Channel 1 global interrupt flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR GIF1 LL_DMA_IsActiveFlag_GI1
DocID026525 Rev 6
787/1320
LL DMA Generic Driver
UM1785
LL_DMA_IsActiveFlag_GI2
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_GI2
(DMA_TypeDef * DMAx)
Function description
Get Channel 2 global interrupt flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR GIF2 LL_DMA_IsActiveFlag_GI2
LL_DMA_IsActiveFlag_GI3
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_GI3
(DMA_TypeDef * DMAx)
Function description
Get Channel 3 global interrupt flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR GIF3 LL_DMA_IsActiveFlag_GI3
LL_DMA_IsActiveFlag_GI4
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_GI4
(DMA_TypeDef * DMAx)
Function description
Get Channel 4 global interrupt flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR GIF4 LL_DMA_IsActiveFlag_GI4
LL_DMA_IsActiveFlag_GI5
788/1320
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_GI5
(DMA_TypeDef * DMAx)
Function description
Get Channel 5 global interrupt flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR GIF5 LL_DMA_IsActiveFlag_GI5
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
LL_DMA_IsActiveFlag_GI6
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_GI6
(DMA_TypeDef * DMAx)
Function description
Get Channel 6 global interrupt flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR GIF6 LL_DMA_IsActiveFlag_GI6
LL_DMA_IsActiveFlag_GI7
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_GI7
(DMA_TypeDef * DMAx)
Function description
Get Channel 7 global interrupt flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR GIF7 LL_DMA_IsActiveFlag_GI7
LL_DMA_IsActiveFlag_TC1
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_TC1
(DMA_TypeDef * DMAx)
Function description
Get Channel 1 transfer complete flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TCIF1 LL_DMA_IsActiveFlag_TC1
LL_DMA_IsActiveFlag_TC2
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_TC2
(DMA_TypeDef * DMAx)
Function description
Get Channel 2 transfer complete flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TCIF2 LL_DMA_IsActiveFlag_TC2
DocID026525 Rev 6
789/1320
LL DMA Generic Driver
UM1785
LL_DMA_IsActiveFlag_TC3
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_TC3
(DMA_TypeDef * DMAx)
Function description
Get Channel 3 transfer complete flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TCIF3 LL_DMA_IsActiveFlag_TC3
LL_DMA_IsActiveFlag_TC4
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_TC4
(DMA_TypeDef * DMAx)
Function description
Get Channel 4 transfer complete flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TCIF4 LL_DMA_IsActiveFlag_TC4
LL_DMA_IsActiveFlag_TC5
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_TC5
(DMA_TypeDef * DMAx)
Function description
Get Channel 5 transfer complete flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TCIF5 LL_DMA_IsActiveFlag_TC5
LL_DMA_IsActiveFlag_TC6
790/1320
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_TC6
(DMA_TypeDef * DMAx)
Function description
Get Channel 6 transfer complete flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TCIF6 LL_DMA_IsActiveFlag_TC6
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
LL_DMA_IsActiveFlag_TC7
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_TC7
(DMA_TypeDef * DMAx)
Function description
Get Channel 7 transfer complete flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TCIF7 LL_DMA_IsActiveFlag_TC7
LL_DMA_IsActiveFlag_HT1
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_HT1
(DMA_TypeDef * DMAx)
Function description
Get Channel 1 half transfer flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR HTIF1 LL_DMA_IsActiveFlag_HT1
LL_DMA_IsActiveFlag_HT2
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_HT2
(DMA_TypeDef * DMAx)
Function description
Get Channel 2 half transfer flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR HTIF2 LL_DMA_IsActiveFlag_HT2
LL_DMA_IsActiveFlag_HT3
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_HT3
(DMA_TypeDef * DMAx)
Function description
Get Channel 3 half transfer flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR HTIF3 LL_DMA_IsActiveFlag_HT3
DocID026525 Rev 6
791/1320
LL DMA Generic Driver
UM1785
LL_DMA_IsActiveFlag_HT4
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_HT4
(DMA_TypeDef * DMAx)
Function description
Get Channel 4 half transfer flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR HTIF4 LL_DMA_IsActiveFlag_HT4
LL_DMA_IsActiveFlag_HT5
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_HT5
(DMA_TypeDef * DMAx)
Function description
Get Channel 5 half transfer flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR HTIF5 LL_DMA_IsActiveFlag_HT5
LL_DMA_IsActiveFlag_HT6
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_HT6
(DMA_TypeDef * DMAx)
Function description
Get Channel 6 half transfer flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR HTIF6 LL_DMA_IsActiveFlag_HT6
LL_DMA_IsActiveFlag_HT7
792/1320
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_HT7
(DMA_TypeDef * DMAx)
Function description
Get Channel 7 half transfer flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR HTIF7 LL_DMA_IsActiveFlag_HT7
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
LL_DMA_IsActiveFlag_TE1
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_TE1
(DMA_TypeDef * DMAx)
Function description
Get Channel 1 transfer error flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TEIF1 LL_DMA_IsActiveFlag_TE1
LL_DMA_IsActiveFlag_TE2
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_TE2
(DMA_TypeDef * DMAx)
Function description
Get Channel 2 transfer error flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TEIF2 LL_DMA_IsActiveFlag_TE2
LL_DMA_IsActiveFlag_TE3
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_TE3
(DMA_TypeDef * DMAx)
Function description
Get Channel 3 transfer error flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TEIF3 LL_DMA_IsActiveFlag_TE3
LL_DMA_IsActiveFlag_TE4
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_TE4
(DMA_TypeDef * DMAx)
Function description
Get Channel 4 transfer error flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TEIF4 LL_DMA_IsActiveFlag_TE4
DocID026525 Rev 6
793/1320
LL DMA Generic Driver
UM1785
LL_DMA_IsActiveFlag_TE5
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_TE5
(DMA_TypeDef * DMAx)
Function description
Get Channel 5 transfer error flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TEIF5 LL_DMA_IsActiveFlag_TE5
LL_DMA_IsActiveFlag_TE6
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_TE6
(DMA_TypeDef * DMAx)
Function description
Get Channel 6 transfer error flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TEIF6 LL_DMA_IsActiveFlag_TE6
LL_DMA_IsActiveFlag_TE7
Function name
__STATIC_INLINE uint32_t LL_DMA_IsActiveFlag_TE7
(DMA_TypeDef * DMAx)
Function description
Get Channel 7 transfer error flag.
Parameters
DMAx: DMAx Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TEIF7 LL_DMA_IsActiveFlag_TE7
LL_DMA_ClearFlag_GI1
794/1320
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_GI1
(DMA_TypeDef * DMAx)
Function description
Clear Channel 1 global interrupt flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CGIF1 LL_DMA_ClearFlag_GI1
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
LL_DMA_ClearFlag_GI2
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_GI2
(DMA_TypeDef * DMAx)
Function description
Clear Channel 2 global interrupt flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CGIF2 LL_DMA_ClearFlag_GI2
LL_DMA_ClearFlag_GI3
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_GI3
(DMA_TypeDef * DMAx)
Function description
Clear Channel 3 global interrupt flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CGIF3 LL_DMA_ClearFlag_GI3
LL_DMA_ClearFlag_GI4
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_GI4
(DMA_TypeDef * DMAx)
Function description
Clear Channel 4 global interrupt flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CGIF4 LL_DMA_ClearFlag_GI4
LL_DMA_ClearFlag_GI5
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_GI5
(DMA_TypeDef * DMAx)
Function description
Clear Channel 5 global interrupt flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CGIF5 LL_DMA_ClearFlag_GI5
DocID026525 Rev 6
795/1320
LL DMA Generic Driver
UM1785
LL_DMA_ClearFlag_GI6
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_GI6
(DMA_TypeDef * DMAx)
Function description
Clear Channel 6 global interrupt flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CGIF6 LL_DMA_ClearFlag_GI6
LL_DMA_ClearFlag_GI7
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_GI7
(DMA_TypeDef * DMAx)
Function description
Clear Channel 7 global interrupt flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CGIF7 LL_DMA_ClearFlag_GI7
LL_DMA_ClearFlag_TC1
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_TC1
(DMA_TypeDef * DMAx)
Function description
Clear Channel 1 transfer complete flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CTCIF1 LL_DMA_ClearFlag_TC1
LL_DMA_ClearFlag_TC2
796/1320
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_TC2
(DMA_TypeDef * DMAx)
Function description
Clear Channel 2 transfer complete flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CTCIF2 LL_DMA_ClearFlag_TC2
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
LL_DMA_ClearFlag_TC3
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_TC3
(DMA_TypeDef * DMAx)
Function description
Clear Channel 3 transfer complete flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CTCIF3 LL_DMA_ClearFlag_TC3
LL_DMA_ClearFlag_TC4
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_TC4
(DMA_TypeDef * DMAx)
Function description
Clear Channel 4 transfer complete flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CTCIF4 LL_DMA_ClearFlag_TC4
LL_DMA_ClearFlag_TC5
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_TC5
(DMA_TypeDef * DMAx)
Function description
Clear Channel 5 transfer complete flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CTCIF5 LL_DMA_ClearFlag_TC5
LL_DMA_ClearFlag_TC6
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_TC6
(DMA_TypeDef * DMAx)
Function description
Clear Channel 6 transfer complete flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CTCIF6 LL_DMA_ClearFlag_TC6
DocID026525 Rev 6
797/1320
LL DMA Generic Driver
UM1785
LL_DMA_ClearFlag_TC7
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_TC7
(DMA_TypeDef * DMAx)
Function description
Clear Channel 7 transfer complete flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CTCIF7 LL_DMA_ClearFlag_TC7
LL_DMA_ClearFlag_HT1
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_HT1
(DMA_TypeDef * DMAx)
Function description
Clear Channel 1 half transfer flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CHTIF1 LL_DMA_ClearFlag_HT1
LL_DMA_ClearFlag_HT2
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_HT2
(DMA_TypeDef * DMAx)
Function description
Clear Channel 2 half transfer flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CHTIF2 LL_DMA_ClearFlag_HT2
LL_DMA_ClearFlag_HT3
798/1320
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_HT3
(DMA_TypeDef * DMAx)
Function description
Clear Channel 3 half transfer flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CHTIF3 LL_DMA_ClearFlag_HT3
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
LL_DMA_ClearFlag_HT4
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_HT4
(DMA_TypeDef * DMAx)
Function description
Clear Channel 4 half transfer flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CHTIF4 LL_DMA_ClearFlag_HT4
LL_DMA_ClearFlag_HT5
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_HT5
(DMA_TypeDef * DMAx)
Function description
Clear Channel 5 half transfer flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CHTIF5 LL_DMA_ClearFlag_HT5
LL_DMA_ClearFlag_HT6
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_HT6
(DMA_TypeDef * DMAx)
Function description
Clear Channel 6 half transfer flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CHTIF6 LL_DMA_ClearFlag_HT6
LL_DMA_ClearFlag_HT7
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_HT7
(DMA_TypeDef * DMAx)
Function description
Clear Channel 7 half transfer flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CHTIF7 LL_DMA_ClearFlag_HT7
DocID026525 Rev 6
799/1320
LL DMA Generic Driver
UM1785
LL_DMA_ClearFlag_TE1
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_TE1
(DMA_TypeDef * DMAx)
Function description
Clear Channel 1 transfer error flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CTEIF1 LL_DMA_ClearFlag_TE1
LL_DMA_ClearFlag_TE2
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_TE2
(DMA_TypeDef * DMAx)
Function description
Clear Channel 2 transfer error flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CTEIF2 LL_DMA_ClearFlag_TE2
LL_DMA_ClearFlag_TE3
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_TE3
(DMA_TypeDef * DMAx)
Function description
Clear Channel 3 transfer error flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CTEIF3 LL_DMA_ClearFlag_TE3
LL_DMA_ClearFlag_TE4
800/1320
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_TE4
(DMA_TypeDef * DMAx)
Function description
Clear Channel 4 transfer error flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CTEIF4 LL_DMA_ClearFlag_TE4
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
LL_DMA_ClearFlag_TE5
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_TE5
(DMA_TypeDef * DMAx)
Function description
Clear Channel 5 transfer error flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CTEIF5 LL_DMA_ClearFlag_TE5
LL_DMA_ClearFlag_TE6
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_TE6
(DMA_TypeDef * DMAx)
Function description
Clear Channel 6 transfer error flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CTEIF6 LL_DMA_ClearFlag_TE6
LL_DMA_ClearFlag_TE7
Function name
__STATIC_INLINE void LL_DMA_ClearFlag_TE7
(DMA_TypeDef * DMAx)
Function description
Clear Channel 7 transfer error flag.
Parameters
DMAx: DMAx Instance
Return values
None
Reference Manual to
LL API cross
reference:
IFCR CTEIF7 LL_DMA_ClearFlag_TE7
LL_DMA_EnableIT_TC
Function name
__STATIC_INLINE void LL_DMA_EnableIT_TC (DMA_TypeDef
* DMAx, uint32_t Channel)
Function description
Enable Transfer complete interrupt.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
DocID026525 Rev 6
801/1320
LL DMA Generic Driver
Return values
UM1785
None
Reference Manual to
LL API cross
reference:
CCR TCIE LL_DMA_EnableIT_TC
LL_DMA_EnableIT_HT
Function name
__STATIC_INLINE void LL_DMA_EnableIT_HT (DMA_TypeDef
* DMAx, uint32_t Channel)
Function description
Enable Half transfer interrupt.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
None
Reference Manual to
LL API cross
reference:
CCR HTIE LL_DMA_EnableIT_HT
LL_DMA_EnableIT_TE
Function name
__STATIC_INLINE void LL_DMA_EnableIT_TE (DMA_TypeDef
* DMAx, uint32_t Channel)
Function description
Enable Transfer error interrupt.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
None
Reference Manual to
LL API cross
reference:
CCR TEIE LL_DMA_EnableIT_TE
LL_DMA_DisableIT_TC
802/1320
Function name
__STATIC_INLINE void LL_DMA_DisableIT_TC (DMA_TypeDef
* DMAx, uint32_t Channel)
Function description
Disable Transfer complete interrupt.
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
None
Reference Manual to
LL API cross
reference:
CCR TCIE LL_DMA_DisableIT_TC
LL_DMA_DisableIT_HT
Function name
__STATIC_INLINE void LL_DMA_DisableIT_HT (DMA_TypeDef
* DMAx, uint32_t Channel)
Function description
Disable Half transfer interrupt.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
None
Reference Manual to
LL API cross
reference:
CCR HTIE LL_DMA_DisableIT_HT
LL_DMA_DisableIT_TE
Function name
__STATIC_INLINE void LL_DMA_DisableIT_TE (DMA_TypeDef
* DMAx, uint32_t Channel)
Function description
Disable Transfer error interrupt.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
None
DocID026525 Rev 6
803/1320
LL DMA Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
CCR TEIE LL_DMA_DisableIT_TE
LL_DMA_IsEnabledIT_TC
Function name
__STATIC_INLINE uint32_t LL_DMA_IsEnabledIT_TC
(DMA_TypeDef * DMAx, uint32_t Channel)
Function description
Check if Transfer complete Interrupt is enabled.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CCR TCIE LL_DMA_IsEnabledIT_TC
LL_DMA_IsEnabledIT_HT
Function name
__STATIC_INLINE uint32_t LL_DMA_IsEnabledIT_HT
(DMA_TypeDef * DMAx, uint32_t Channel)
Function description
Check if Half transfer Interrupt is enabled.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CCR HTIE LL_DMA_IsEnabledIT_HT
LL_DMA_IsEnabledIT_TE
Function name
__STATIC_INLINE uint32_t LL_DMA_IsEnabledIT_TE
(DMA_TypeDef * DMAx, uint32_t Channel)
Function description
Check if Transfer error Interrupt is enabled.
Parameters
804/1320
DMAx: DMAx Instance
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
Channel: This parameter can be one of the following values:
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6
LL_DMA_CHANNEL_7
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CCR TEIE LL_DMA_IsEnabledIT_TE
LL_DMA_Init
Function name
uint32_t LL_DMA_Init (DMA_TypeDef * DMAx, uint32_t
Channel, LL_DMA_InitTypeDef * DMA_InitStruct)
Function description
Initialize the DMA registers according to the specified parameters
in DMA_InitStruct.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
(*) value not defined in all devices
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6 (*)
LL_DMA_CHANNEL_7 (*)
DMA_InitStruct: pointer to a LL_DMA_InitTypeDef structure.
Return values
An: ErrorStatus enumeration value:
SUCCESS: DMA registers are initialized
ERROR: Not applicable
Notes
To convert DMAx_Channely Instance to DMAx Instance and
Channely, use helper macros : __LL_DMA_GET_INSTANCE
__LL_DMA_GET_CHANNEL
LL_DMA_DeInit
Function name
uint32_t LL_DMA_DeInit (DMA_TypeDef * DMAx, uint32_t
Channel)
Function description
De-initialize the DMA registers to their default reset values.
Parameters
DMAx: DMAx Instance
Channel: This parameter can be one of the following values:
(*) value not defined in all devices
LL_DMA_CHANNEL_1
LL_DMA_CHANNEL_2
LL_DMA_CHANNEL_3
LL_DMA_CHANNEL_4
DocID026525 Rev 6
805/1320
LL DMA Generic Driver
UM1785
LL_DMA_CHANNEL_5
LL_DMA_CHANNEL_6 (*)
LL_DMA_CHANNEL_7 (*)
Return values
An: ErrorStatus enumeration value:
SUCCESS: DMA registers are de-initialized
ERROR: DMA registers are not de-initialized
LL_DMA_StructInit
Function name
void LL_DMA_StructInit (LL_DMA_InitTypeDef *
DMA_InitStruct)
Function description
Set each LL_DMA_InitTypeDef field to default value.
Parameters
DMA_InitStruct: Pointer to a LL_DMA_InitTypeDef
structure.
Return values
None
56.3
DMA Firmware driver defines
56.3.1
DMA
CHANNEL
LL_DMA_CHANNEL_1
DMA Channel 1
LL_DMA_CHANNEL_2
DMA Channel 2
LL_DMA_CHANNEL_3
DMA Channel 3
LL_DMA_CHANNEL_4
DMA Channel 4
LL_DMA_CHANNEL_5
DMA Channel 5
LL_DMA_CHANNEL_6
DMA Channel 6
LL_DMA_CHANNEL_7
DMA Channel 7
LL_DMA_CHANNEL_ALL
DMA Channel all (used only for function
Clear Flags Defines
806/1320
LL_DMA_IFCR_CGIF1
Channel 1 global flag
LL_DMA_IFCR_CTCIF1
Channel 1 transfer complete flag
LL_DMA_IFCR_CHTIF1
Channel 1 half transfer flag
LL_DMA_IFCR_CTEIF1
Channel 1 transfer error flag
LL_DMA_IFCR_CGIF2
Channel 2 global flag
LL_DMA_IFCR_CTCIF2
Channel 2 transfer complete flag
LL_DMA_IFCR_CHTIF2
Channel 2 half transfer flag
LL_DMA_IFCR_CTEIF2
Channel 2 transfer error flag
LL_DMA_IFCR_CGIF3
Channel 3 global flag
LL_DMA_IFCR_CTCIF3
Channel 3 transfer complete flag
LL_DMA_IFCR_CHTIF3
Channel 3 half transfer flag
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
LL_DMA_IFCR_CTEIF3
Channel 3 transfer error flag
LL_DMA_IFCR_CGIF4
Channel 4 global flag
LL_DMA_IFCR_CTCIF4
Channel 4 transfer complete flag
LL_DMA_IFCR_CHTIF4
Channel 4 half transfer flag
LL_DMA_IFCR_CTEIF4
Channel 4 transfer error flag
LL_DMA_IFCR_CGIF5
Channel 5 global flag
LL_DMA_IFCR_CTCIF5
Channel 5 transfer complete flag
LL_DMA_IFCR_CHTIF5
Channel 5 half transfer flag
LL_DMA_IFCR_CTEIF5
Channel 5 transfer error flag
LL_DMA_IFCR_CGIF6
Channel 6 global flag
LL_DMA_IFCR_CTCIF6
Channel 6 transfer complete flag
LL_DMA_IFCR_CHTIF6
Channel 6 half transfer flag
LL_DMA_IFCR_CTEIF6
Channel 6 transfer error flag
LL_DMA_IFCR_CGIF7
Channel 7 global flag
LL_DMA_IFCR_CTCIF7
Channel 7 transfer complete flag
LL_DMA_IFCR_CHTIF7
Channel 7 half transfer flag
LL_DMA_IFCR_CTEIF7
Channel 7 transfer error flag
Transfer Direction
LL_DMA_DIRECTION_PERIPH_TO_MEMORY
Peripheral to memory direction
LL_DMA_DIRECTION_MEMORY_TO_PERIPH
Memory to peripheral direction
LL_DMA_DIRECTION_MEMORY_TO_MEMORY
Memory to memory direction
Get Flags Defines
LL_DMA_ISR_GIF1
Channel 1 global flag
LL_DMA_ISR_TCIF1
Channel 1 transfer complete flag
LL_DMA_ISR_HTIF1
Channel 1 half transfer flag
LL_DMA_ISR_TEIF1
Channel 1 transfer error flag
LL_DMA_ISR_GIF2
Channel 2 global flag
LL_DMA_ISR_TCIF2
Channel 2 transfer complete flag
LL_DMA_ISR_HTIF2
Channel 2 half transfer flag
LL_DMA_ISR_TEIF2
Channel 2 transfer error flag
LL_DMA_ISR_GIF3
Channel 3 global flag
LL_DMA_ISR_TCIF3
Channel 3 transfer complete flag
LL_DMA_ISR_HTIF3
Channel 3 half transfer flag
LL_DMA_ISR_TEIF3
Channel 3 transfer error flag
LL_DMA_ISR_GIF4
Channel 4 global flag
LL_DMA_ISR_TCIF4
Channel 4 transfer complete flag
DocID026525 Rev 6
807/1320
LL DMA Generic Driver
LL_DMA_ISR_HTIF4
UM1785
Channel 4 half transfer flag
LL_DMA_ISR_TEIF4
Channel 4 transfer error flag
LL_DMA_ISR_GIF5
Channel 5 global flag
LL_DMA_ISR_TCIF5
Channel 5 transfer complete flag
LL_DMA_ISR_HTIF5
Channel 5 half transfer flag
LL_DMA_ISR_TEIF5
Channel 5 transfer error flag
LL_DMA_ISR_GIF6
Channel 6 global flag
LL_DMA_ISR_TCIF6
Channel 6 transfer complete flag
LL_DMA_ISR_HTIF6
Channel 6 half transfer flag
LL_DMA_ISR_TEIF6
Channel 6 transfer error flag
LL_DMA_ISR_GIF7
Channel 7 global flag
LL_DMA_ISR_TCIF7
Channel 7 transfer complete flag
LL_DMA_ISR_HTIF7
Channel 7 half transfer flag
LL_DMA_ISR_TEIF7
Channel 7 transfer error flag
IT Defines
LL_DMA_CCR_TCIE
Transfer complete interrupt
LL_DMA_CCR_HTIE
Half Transfer interrupt
LL_DMA_CCR_TEIE
Transfer error interrupt
Memory data alignment
LL_DMA_MDATAALIGN_BYTE
Memory data alignment : Byte
LL_DMA_MDATAALIGN_HALFWORD
Memory data alignment : HalfWord
LL_DMA_MDATAALIGN_WORD
Memory data alignment : Word
Memory increment mode
LL_DMA_MEMORY_INCREMENT
Memory increment mode Enable
LL_DMA_MEMORY_NOINCREMENT
Memory increment mode Disable
Transfer mode
LL_DMA_MODE_NORMAL
Normal Mode
LL_DMA_MODE_CIRCULAR
Circular Mode
Peripheral data alignment
LL_DMA_PDATAALIGN_BYTE
Peripheral data alignment : Byte
LL_DMA_PDATAALIGN_HALFWORD
Peripheral data alignment : HalfWord
LL_DMA_PDATAALIGN_WORD
Peripheral data alignment : Word
Peripheral increment mode
808/1320
LL_DMA_PERIPH_INCREMENT
Peripheral increment mode Enable
LL_DMA_PERIPH_NOINCREMENT
Peripheral increment mode Disable
DocID026525 Rev 6
UM1785
LL DMA Generic Driver
Transfer Priority level
LL_DMA_PRIORITY_LOW
Priority level : Low
LL_DMA_PRIORITY_MEDIUM
Priority level : Medium
LL_DMA_PRIORITY_HIGH
Priority level : High
LL_DMA_PRIORITY_VERYHIGH
Priority level : Very_High
Transfer peripheral request
LL_DMA_REQUEST_0
DMA peripheral request 0
LL_DMA_REQUEST_1
DMA peripheral request 1
LL_DMA_REQUEST_2
DMA peripheral request 2
LL_DMA_REQUEST_3
DMA peripheral request 3
LL_DMA_REQUEST_4
DMA peripheral request 4
LL_DMA_REQUEST_5
DMA peripheral request 5
LL_DMA_REQUEST_6
DMA peripheral request 6
LL_DMA_REQUEST_7
DMA peripheral request 7
LL_DMA_REQUEST_8
DMA peripheral request 8
LL_DMA_REQUEST_9
DMA peripheral request 9
LL_DMA_REQUEST_10
DMA peripheral request 10
LL_DMA_REQUEST_11
DMA peripheral request 11
LL_DMA_REQUEST_12
DMA peripheral request 12
LL_DMA_REQUEST_13
DMA peripheral request 13
LL_DMA_REQUEST_14
DMA peripheral request 14
LL_DMA_REQUEST_15
DMA peripheral request 15
Convert DMAxChannely
__LL_DMA_GET_INSTANCE
Description:
Convert DMAx_Channely into DMAx.
Parameters:
__CHANNEL_INSTANCE__:
DMAx_Channely
Return value:
DMAx
__LL_DMA_GET_CHANNEL
Description:
Convert DMAx_Channely into
LL_DMA_CHANNEL_y.
Parameters:
__CHANNEL_INSTANCE__:
DMAx_Channely
Return value:
DocID026525 Rev 6
809/1320
LL DMA Generic Driver
UM1785
LL_DMA_CHANNEL_y
__LL_DMA_GET_CHANNEL_INSTANCE
Description:
Convert DMA Instance DMAx and
LL_DMA_CHANNEL_y into
DMAx_Channely.
Parameters:
__DMA_INSTANCE__: DMAx
__CHANNEL__: LL_DMA_CHANNEL_y
Return value:
DMAx_Channely
Common Write and read registers macros
LL_DMA_WriteReg
Description:
Write a value in DMA register.
Parameters:
__INSTANCE__: DMA Instance
__REG__: Register to be written
__VALUE__: Value to be written in the register
Return value:
None
LL_DMA_ReadReg
Description:
Read a value in DMA register.
Parameters:
__INSTANCE__: DMA Instance
__REG__: Register to be read
Return value:
Register: value
810/1320
DocID026525 Rev 6
UM1785
LL EXTI Generic Driver
57
LL EXTI Generic Driver
57.1
EXTI Firmware driver registers structures
57.1.1
LL_EXTI_InitTypeDef
Data Fields
uint32_t Line_0_31
FunctionalState LineCommand
uint8_t Mode
uint8_t Trigger
Field Documentation
uint32_t LL_EXTI_InitTypeDef::Line_0_31
Specifies the EXTI lines to be enabled or disabled for Lines in range 0 to 31 This
parameter can be any combination of EXTI_LL_EC_LINE
FunctionalState LL_EXTI_InitTypeDef::LineCommand
Specifies the new state of the selected EXTI lines. This parameter can be set either to
ENABLE or DISABLE
uint8_t LL_EXTI_InitTypeDef::Mode
Specifies the mode for the EXTI lines. This parameter can be a value of
EXTI_LL_EC_MODE.
uint8_t LL_EXTI_InitTypeDef::Trigger
Specifies the trigger signal active edge for the EXTI lines. This parameter can be a
value of EXTI_LL_EC_TRIGGER.
57.2
EXTI Firmware driver API description
57.2.1
Detailed description of functions
LL_EXTI_EnableIT_0_31
Function name
__STATIC_INLINE void LL_EXTI_EnableIT_0_31 (uint32_t
ExtiLine)
Function description
Enable ExtiLine Interrupt request for Lines in range 0 to 31.
Parameters
ExtiLine: This parameter can be one of the following values:
LL_EXTI_LINE_0
LL_EXTI_LINE_1
LL_EXTI_LINE_2
LL_EXTI_LINE_3
LL_EXTI_LINE_4
LL_EXTI_LINE_5
LL_EXTI_LINE_6
LL_EXTI_LINE_7
LL_EXTI_LINE_8
LL_EXTI_LINE_9
LL_EXTI_LINE_10
LL_EXTI_LINE_11
LL_EXTI_LINE_12
LL_EXTI_LINE_13
DocID026525 Rev 6
811/1320
LL EXTI Generic Driver
UM1785
LL_EXTI_LINE_14
LL_EXTI_LINE_15
LL_EXTI_LINE_16
LL_EXTI_LINE_17
LL_EXTI_LINE_18
LL_EXTI_LINE_19
LL_EXTI_LINE_20
LL_EXTI_LINE_21
LL_EXTI_LINE_22
LL_EXTI_LINE_23
LL_EXTI_LINE_24
LL_EXTI_LINE_25
LL_EXTI_LINE_26
LL_EXTI_LINE_27
LL_EXTI_LINE_28
LL_EXTI_LINE_29
LL_EXTI_LINE_30
LL_EXTI_LINE_31
LL_EXTI_LINE_ALL_0_31
Return values
None
Notes
The reset value for the direct or internal lines (see RM) is set
to 1 in order to enable the interrupt by default. Bits are set
automatically at Power on.
Please check each device line mapping for EXTI Line
availability
Reference Manual to
LL API cross
reference:
IMR IMx LL_EXTI_EnableIT_0_31
LL_EXTI_DisableIT_0_31
Function name
__STATIC_INLINE void LL_EXTI_DisableIT_0_31 (uint32_t
ExtiLine)
Function description
Disable ExtiLine Interrupt request for Lines in range 0 to 31.
Parameters
812/1320
ExtiLine: This parameter can be one of the following values:
LL_EXTI_LINE_0
LL_EXTI_LINE_1
LL_EXTI_LINE_2
LL_EXTI_LINE_3
LL_EXTI_LINE_4
LL_EXTI_LINE_5
LL_EXTI_LINE_6
LL_EXTI_LINE_7
LL_EXTI_LINE_8
LL_EXTI_LINE_9
LL_EXTI_LINE_10
LL_EXTI_LINE_11
LL_EXTI_LINE_12
LL_EXTI_LINE_13
LL_EXTI_LINE_14
DocID026525 Rev 6
UM1785
LL EXTI Generic Driver
LL_EXTI_LINE_15
LL_EXTI_LINE_16
LL_EXTI_LINE_17
LL_EXTI_LINE_18
LL_EXTI_LINE_19
LL_EXTI_LINE_20
LL_EXTI_LINE_21
LL_EXTI_LINE_22
LL_EXTI_LINE_23
LL_EXTI_LINE_24
LL_EXTI_LINE_25
LL_EXTI_LINE_26
LL_EXTI_LINE_27
LL_EXTI_LINE_28
LL_EXTI_LINE_29
LL_EXTI_LINE_30
LL_EXTI_LINE_31
LL_EXTI_LINE_ALL_0_31
Return values
None
Notes
The reset value for the direct or internal lines (see RM) is set
to 1 in order to enable the interrupt by default. Bits are set
automatically at Power on.
Please check each device line mapping for EXTI Line
availability
Reference Manual to
LL API cross
reference:
IMR IMx LL_EXTI_DisableIT_0_31
LL_EXTI_IsEnabledIT_0_31
Function name
__STATIC_INLINE uint32_t LL_EXTI_IsEnabledIT_0_31
(uint32_t ExtiLine)
Function description
Indicate if ExtiLine Interrupt request is enabled for Lines in range 0
to 31.
Parameters
ExtiLine: This parameter can be one of the following values:
LL_EXTI_LINE_0
LL_EXTI_LINE_1
LL_EXTI_LINE_2
LL_EXTI_LINE_3
LL_EXTI_LINE_4
LL_EXTI_LINE_5
LL_EXTI_LINE_6
LL_EXTI_LINE_7
LL_EXTI_LINE_8
LL_EXTI_LINE_9
LL_EXTI_LINE_10
LL_EXTI_LINE_11
LL_EXTI_LINE_12
LL_EXTI_LINE_13
LL_EXTI_LINE_14
DocID026525 Rev 6
813/1320
LL EXTI Generic Driver
UM1785
LL_EXTI_LINE_15
LL_EXTI_LINE_16
LL_EXTI_LINE_17
LL_EXTI_LINE_18
LL_EXTI_LINE_19
LL_EXTI_LINE_20
LL_EXTI_LINE_21
LL_EXTI_LINE_22
LL_EXTI_LINE_23
LL_EXTI_LINE_24
LL_EXTI_LINE_25
LL_EXTI_LINE_26
LL_EXTI_LINE_27
LL_EXTI_LINE_28
LL_EXTI_LINE_29
LL_EXTI_LINE_30
LL_EXTI_LINE_31
LL_EXTI_LINE_ALL_0_31
Return values
State: of bit (1 or 0).
Notes
The reset value for the direct or internal lines (see RM) is set
to 1 in order to enable the interrupt by default. Bits are set
automatically at Power on.
Please check each device line mapping for EXTI Line
availability
Reference Manual to
LL API cross
reference:
IMR IMx LL_EXTI_IsEnabledIT_0_31
LL_EXTI_EnableEvent_0_31
Function name
__STATIC_INLINE void LL_EXTI_EnableEvent_0_31 (uint32_t
ExtiLine)
Function description
Enable ExtiLine Event request for Lines in range 0 to 31.
Parameters
814/1320
ExtiLine: This parameter can be one of the following values:
LL_EXTI_LINE_0
LL_EXTI_LINE_1
LL_EXTI_LINE_2
LL_EXTI_LINE_3
LL_EXTI_LINE_4
LL_EXTI_LINE_5
LL_EXTI_LINE_6
LL_EXTI_LINE_7
LL_EXTI_LINE_8
LL_EXTI_LINE_9
LL_EXTI_LINE_10
LL_EXTI_LINE_11
LL_EXTI_LINE_12
LL_EXTI_LINE_13
LL_EXTI_LINE_14
LL_EXTI_LINE_15
DocID026525 Rev 6
UM1785
LL EXTI Generic Driver
LL_EXTI_LINE_16
LL_EXTI_LINE_17
LL_EXTI_LINE_18
LL_EXTI_LINE_19
LL_EXTI_LINE_20
LL_EXTI_LINE_21
LL_EXTI_LINE_22
LL_EXTI_LINE_23
LL_EXTI_LINE_24
LL_EXTI_LINE_25
LL_EXTI_LINE_26
LL_EXTI_LINE_27
LL_EXTI_LINE_28
LL_EXTI_LINE_29
LL_EXTI_LINE_30
LL_EXTI_LINE_31
LL_EXTI_LINE_ALL_0_31
Return values
None
Notes
Please check each device line mapping for EXTI Line
availability
Reference Manual to
LL API cross
reference:
EMR EMx LL_EXTI_EnableEvent_0_31
LL_EXTI_DisableEvent_0_31
Function name
__STATIC_INLINE void LL_EXTI_DisableEvent_0_31 (uint32_t
ExtiLine)
Function description
Disable ExtiLine Event request for Lines in range 0 to 31.
Parameters
ExtiLine: This parameter can be one of the following values:
LL_EXTI_LINE_0
LL_EXTI_LINE_1
LL_EXTI_LINE_2
LL_EXTI_LINE_3
LL_EXTI_LINE_4
LL_EXTI_LINE_5
LL_EXTI_LINE_6
LL_EXTI_LINE_7
LL_EXTI_LINE_8
LL_EXTI_LINE_9
LL_EXTI_LINE_10
LL_EXTI_LINE_11
LL_EXTI_LINE_12
LL_EXTI_LINE_13
LL_EXTI_LINE_14
LL_EXTI_LINE_15
LL_EXTI_LINE_16
LL_EXTI_LINE_17
LL_EXTI_LINE_18
LL_EXTI_LINE_19
DocID026525 Rev 6
815/1320
LL EXTI Generic Driver
UM1785
LL_EXTI_LINE_20
LL_EXTI_LINE_21
LL_EXTI_LINE_22
LL_EXTI_LINE_23
LL_EXTI_LINE_24
LL_EXTI_LINE_25
LL_EXTI_LINE_26
LL_EXTI_LINE_27
LL_EXTI_LINE_28
LL_EXTI_LINE_29
LL_EXTI_LINE_30
LL_EXTI_LINE_31
LL_EXTI_LINE_ALL_0_31
Return values
None
Notes
Please check each device line mapping for EXTI Line
availability
Reference Manual to
LL API cross
reference:
EMR EMx LL_EXTI_DisableEvent_0_31
LL_EXTI_IsEnabledEvent_0_31
Function name
__STATIC_INLINE uint32_t LL_EXTI_IsEnabledEvent_0_31
(uint32_t ExtiLine)
Function description
Indicate if ExtiLine Event request is enabled for Lines in range 0 to
31.
Parameters
816/1320
ExtiLine: This parameter can be one of the following values:
LL_EXTI_LINE_0
LL_EXTI_LINE_1
LL_EXTI_LINE_2
LL_EXTI_LINE_3
LL_EXTI_LINE_4
LL_EXTI_LINE_5
LL_EXTI_LINE_6
LL_EXTI_LINE_7
LL_EXTI_LINE_8
LL_EXTI_LINE_9
LL_EXTI_LINE_10
LL_EXTI_LINE_11
LL_EXTI_LINE_12
LL_EXTI_LINE_13
LL_EXTI_LINE_14
LL_EXTI_LINE_15
LL_EXTI_LINE_16
LL_EXTI_LINE_17
LL_EXTI_LINE_18
LL_EXTI_LINE_19
LL_EXTI_LINE_20
LL_EXTI_LINE_21
LL_EXTI_LINE_22
DocID026525 Rev 6
UM1785
LL EXTI Generic Driver
LL_EXTI_LINE_23
LL_EXTI_LINE_24
LL_EXTI_LINE_25
LL_EXTI_LINE_26
LL_EXTI_LINE_27
LL_EXTI_LINE_28
LL_EXTI_LINE_29
LL_EXTI_LINE_30
LL_EXTI_LINE_31
LL_EXTI_LINE_ALL_0_31
Return values
State: of bit (1 or 0).
Notes
Please check each device line mapping for EXTI Line
availability
Reference Manual to
LL API cross
reference:
EMR EMx LL_EXTI_IsEnabledEvent_0_31
LL_EXTI_EnableRisingTrig_0_31
Function name
__STATIC_INLINE void LL_EXTI_EnableRisingTrig_0_31
(uint32_t ExtiLine)
Function description
Enable ExtiLine Rising Edge Trigger for Lines in range 0 to 31.
Parameters
ExtiLine: This parameter can be a combination of the
following values:
LL_EXTI_LINE_0
LL_EXTI_LINE_1
LL_EXTI_LINE_2
LL_EXTI_LINE_3
LL_EXTI_LINE_4
LL_EXTI_LINE_5
LL_EXTI_LINE_6
LL_EXTI_LINE_7
LL_EXTI_LINE_8
LL_EXTI_LINE_9
LL_EXTI_LINE_10
LL_EXTI_LINE_11
LL_EXTI_LINE_12
LL_EXTI_LINE_13
LL_EXTI_LINE_14
LL_EXTI_LINE_15
LL_EXTI_LINE_16
LL_EXTI_LINE_18
LL_EXTI_LINE_19
LL_EXTI_LINE_20
LL_EXTI_LINE_21
LL_EXTI_LINE_22
LL_EXTI_LINE_29
LL_EXTI_LINE_30
LL_EXTI_LINE_31
DocID026525 Rev 6
817/1320
LL EXTI Generic Driver
Return values
UM1785
None
Notes
The configurable wakeup lines are edge-triggered. No glitch
must be generated on these lines. If a rising edge on a
configurable interrupt line occurs during a write operation in
the EXTI_RTSR register, the pending bit is not set. Rising and
falling edge triggers can be set for the same interrupt line. In
this case, both generate a trigger condition.
Please check each device line mapping for EXTI Line
availability
Reference Manual to
LL API cross
reference:
RTSR RTx LL_EXTI_EnableRisingTrig_0_31
LL_EXTI_DisableRisingTrig_0_31
818/1320
Function name
__STATIC_INLINE void LL_EXTI_DisableRisingTrig_0_31
(uint32_t ExtiLine)
Function description
Disable ExtiLine Rising Edge Trigger for Lines in range 0 to 31.
Parameters
ExtiLine: This parameter can be a combination of the
following values:
LL_EXTI_LINE_0
LL_EXTI_LINE_1
LL_EXTI_LINE_2
LL_EXTI_LINE_3
LL_EXTI_LINE_4
LL_EXTI_LINE_5
LL_EXTI_LINE_6
LL_EXTI_LINE_7
LL_EXTI_LINE_8
LL_EXTI_LINE_9
LL_EXTI_LINE_10
LL_EXTI_LINE_11
LL_EXTI_LINE_12
LL_EXTI_LINE_13
LL_EXTI_LINE_14
LL_EXTI_LINE_15
LL_EXTI_LINE_16
LL_EXTI_LINE_18
LL_EXTI_LINE_19
LL_EXTI_LINE_20
LL_EXTI_LINE_21
LL_EXTI_LINE_22
LL_EXTI_LINE_29
LL_EXTI_LINE_30
LL_EXTI_LINE_31
Return values
None
Notes
The configurable wakeup lines are edge-triggered. No glitch
must be generated on these lines. If a rising edge on a
configurable interrupt line occurs during a write operation in
the EXTI_RTSR register, the pending bit is not set. Rising and
DocID026525 Rev 6
UM1785
LL EXTI Generic Driver
falling edge triggers can be set for the same interrupt line. In
this case, both generate a trigger condition.
Please check each device line mapping for EXTI Line
availability
Reference Manual to
LL API cross
reference:
RTSR RTx LL_EXTI_DisableRisingTrig_0_31
LL_EXTI_IsEnabledRisingTrig_0_31
Function name
__STATIC_INLINE uint32_t
LL_EXTI_IsEnabledRisingTrig_0_31 (uint32_t ExtiLine)
Function description
Check if rising edge trigger is enabled for Lines in range 0 to 31.
Parameters
ExtiLine: This parameter can be a combination of the
following values:
LL_EXTI_LINE_0
LL_EXTI_LINE_1
LL_EXTI_LINE_2
LL_EXTI_LINE_3
LL_EXTI_LINE_4
LL_EXTI_LINE_5
LL_EXTI_LINE_6
LL_EXTI_LINE_7
LL_EXTI_LINE_8
LL_EXTI_LINE_9
LL_EXTI_LINE_10
LL_EXTI_LINE_11
LL_EXTI_LINE_12
LL_EXTI_LINE_13
LL_EXTI_LINE_14
LL_EXTI_LINE_15
LL_EXTI_LINE_16
LL_EXTI_LINE_18
LL_EXTI_LINE_19
LL_EXTI_LINE_20
LL_EXTI_LINE_21
LL_EXTI_LINE_22
LL_EXTI_LINE_29
LL_EXTI_LINE_30
LL_EXTI_LINE_31
Return values
State: of bit (1 or 0).
Notes
Please check each device line mapping for EXTI Line
availability
Reference Manual to
LL API cross
reference:
RTSR RTx LL_EXTI_IsEnabledRisingTrig_0_31
DocID026525 Rev 6
819/1320
LL EXTI Generic Driver
UM1785
LL_EXTI_EnableFallingTrig_0_31
820/1320
Function name
__STATIC_INLINE void LL_EXTI_EnableFallingTrig_0_31
(uint32_t ExtiLine)
Function description
Enable ExtiLine Falling Edge Trigger for Lines in range 0 to 31.
Parameters
ExtiLine: This parameter can be a combination of the
following values:
LL_EXTI_LINE_0
LL_EXTI_LINE_1
LL_EXTI_LINE_2
LL_EXTI_LINE_3
LL_EXTI_LINE_4
LL_EXTI_LINE_5
LL_EXTI_LINE_6
LL_EXTI_LINE_7
LL_EXTI_LINE_8
LL_EXTI_LINE_9
LL_EXTI_LINE_10
LL_EXTI_LINE_11
LL_EXTI_LINE_12
LL_EXTI_LINE_13
LL_EXTI_LINE_14
LL_EXTI_LINE_15
LL_EXTI_LINE_16
LL_EXTI_LINE_18
LL_EXTI_LINE_19
LL_EXTI_LINE_20
LL_EXTI_LINE_21
LL_EXTI_LINE_22
LL_EXTI_LINE_29
LL_EXTI_LINE_30
LL_EXTI_LINE_31
Return values
None
Notes
The configurable wakeup lines are edge-triggered. No glitch
must be generated on these lines. If a falling edge on a
configurable interrupt line occurs during a write operation in
the EXTI_FTSR register, the pending bit is not set. Rising and
falling edge triggers can be set for the same interrupt line. In
this case, both generate a trigger condition.
Please check each device line mapping for EXTI Line
availability
Reference Manual to
LL API cross
reference:
FTSR FTx LL_EXTI_EnableFallingTrig_0_31
DocID026525 Rev 6
UM1785
LL EXTI Generic Driver
LL_EXTI_DisableFallingTrig_0_31
Function name
__STATIC_INLINE void LL_EXTI_DisableFallingTrig_0_31
(uint32_t ExtiLine)
Function description
Disable ExtiLine Falling Edge Trigger for Lines in range 0 to 31.
Parameters
ExtiLine: This parameter can be a combination of the
following values:
LL_EXTI_LINE_0
LL_EXTI_LINE_1
LL_EXTI_LINE_2
LL_EXTI_LINE_3
LL_EXTI_LINE_4
LL_EXTI_LINE_5
LL_EXTI_LINE_6
LL_EXTI_LINE_7
LL_EXTI_LINE_8
LL_EXTI_LINE_9
LL_EXTI_LINE_10
LL_EXTI_LINE_11
LL_EXTI_LINE_12
LL_EXTI_LINE_13
LL_EXTI_LINE_14
LL_EXTI_LINE_15
LL_EXTI_LINE_16
LL_EXTI_LINE_18
LL_EXTI_LINE_19
LL_EXTI_LINE_20
LL_EXTI_LINE_21
LL_EXTI_LINE_22
LL_EXTI_LINE_29
LL_EXTI_LINE_30
LL_EXTI_LINE_31
Return values
None
Notes
The configurable wakeup lines are edge-triggered. No glitch
must be generated on these lines. If a Falling edge on a
configurable interrupt line occurs during a write operation in
the EXTI_FTSR register, the pending bit is not set. Rising and
falling edge triggers can be set for the same interrupt line. In
this case, both generate a trigger condition.
Please check each device line mapping for EXTI Line
availability
Reference Manual to
LL API cross
reference:
FTSR FTx LL_EXTI_DisableFallingTrig_0_31
DocID026525 Rev 6
821/1320
LL EXTI Generic Driver
UM1785
LL_EXTI_IsEnabledFallingTrig_0_31
Function name
__STATIC_INLINE uint32_t
LL_EXTI_IsEnabledFallingTrig_0_31 (uint32_t ExtiLine)
Function description
Check if falling edge trigger is enabled for Lines in range 0 to 31.
Parameters
ExtiLine: This parameter can be a combination of the
following values:
LL_EXTI_LINE_0
LL_EXTI_LINE_1
LL_EXTI_LINE_2
LL_EXTI_LINE_3
LL_EXTI_LINE_4
LL_EXTI_LINE_5
LL_EXTI_LINE_6
LL_EXTI_LINE_7
LL_EXTI_LINE_8
LL_EXTI_LINE_9
LL_EXTI_LINE_10
LL_EXTI_LINE_11
LL_EXTI_LINE_12
LL_EXTI_LINE_13
LL_EXTI_LINE_14
LL_EXTI_LINE_15
LL_EXTI_LINE_16
LL_EXTI_LINE_18
LL_EXTI_LINE_19
LL_EXTI_LINE_20
LL_EXTI_LINE_21
LL_EXTI_LINE_22
LL_EXTI_LINE_29
LL_EXTI_LINE_30
LL_EXTI_LINE_31
Return values
State: of bit (1 or 0).
Notes
Please check each device line mapping for EXTI Line
availability
Reference Manual to
LL API cross
reference:
FTSR FTx LL_EXTI_IsEnabledFallingTrig_0_31
LL_EXTI_GenerateSWI_0_31
Function name
__STATIC_INLINE void LL_EXTI_GenerateSWI_0_31 (uint32_t
ExtiLine)
Function description
Generate a software Interrupt Event for Lines in range 0 to 31.
Parameters
822/1320
ExtiLine: This parameter can be a combination of the
following values:
LL_EXTI_LINE_0
LL_EXTI_LINE_1
LL_EXTI_LINE_2
LL_EXTI_LINE_3
DocID026525 Rev 6
UM1785
LL EXTI Generic Driver
LL_EXTI_LINE_4
LL_EXTI_LINE_5
LL_EXTI_LINE_6
LL_EXTI_LINE_7
LL_EXTI_LINE_8
LL_EXTI_LINE_9
LL_EXTI_LINE_10
LL_EXTI_LINE_11
LL_EXTI_LINE_12
LL_EXTI_LINE_13
LL_EXTI_LINE_14
LL_EXTI_LINE_15
LL_EXTI_LINE_16
LL_EXTI_LINE_18
LL_EXTI_LINE_19
LL_EXTI_LINE_20
LL_EXTI_LINE_21
LL_EXTI_LINE_22
LL_EXTI_LINE_29
LL_EXTI_LINE_30
LL_EXTI_LINE_31
Return values
None
Notes
If the interrupt is enabled on this line in the EXTI_IMR, writing
a 1 to this bit when it is at '0' sets the corresponding pending
bit in EXTI_PR resulting in an interrupt request generation.
This bit is cleared by clearing the corresponding bit in the
EXTI_PR register (by writing a 1 into the bit)
Please check each device line mapping for EXTI Line
availability
Reference Manual to
LL API cross
reference:
SWIER SWIx LL_EXTI_GenerateSWI_0_31
LL_EXTI_IsActiveFlag_0_31
Function name
__STATIC_INLINE uint32_t LL_EXTI_IsActiveFlag_0_31
(uint32_t ExtiLine)
Function description
Check if the ExtLine Flag is set or not for Lines in range 0 to 31.
Parameters
ExtiLine: This parameter can be a combination of the
following values:
LL_EXTI_LINE_0
LL_EXTI_LINE_1
LL_EXTI_LINE_2
LL_EXTI_LINE_3
LL_EXTI_LINE_4
LL_EXTI_LINE_5
LL_EXTI_LINE_6
LL_EXTI_LINE_7
LL_EXTI_LINE_8
LL_EXTI_LINE_9
LL_EXTI_LINE_10
DocID026525 Rev 6
823/1320
LL EXTI Generic Driver
UM1785
LL_EXTI_LINE_11
LL_EXTI_LINE_12
LL_EXTI_LINE_13
LL_EXTI_LINE_14
LL_EXTI_LINE_15
LL_EXTI_LINE_16
LL_EXTI_LINE_18
LL_EXTI_LINE_19
LL_EXTI_LINE_20
LL_EXTI_LINE_21
LL_EXTI_LINE_22
LL_EXTI_LINE_29
LL_EXTI_LINE_30
LL_EXTI_LINE_31
Return values
State: of bit (1 or 0).
Notes
This bit is set when the selected edge event arrives on the
interrupt line. This bit is cleared by writing a 1 to the bit.
Please check each device line mapping for EXTI Line
availability
Reference Manual to
LL API cross
reference:
PR PIFx LL_EXTI_IsActiveFlag_0_31
LL_EXTI_ReadFlag_0_31
Function name
__STATIC_INLINE uint32_t LL_EXTI_ReadFlag_0_31 (uint32_t
ExtiLine)
Function description
Read ExtLine Combination Flag for Lines in range 0 to 31.
Parameters
824/1320
ExtiLine: This parameter can be a combination of the
following values:
LL_EXTI_LINE_0
LL_EXTI_LINE_1
LL_EXTI_LINE_2
LL_EXTI_LINE_3
LL_EXTI_LINE_4
LL_EXTI_LINE_5
LL_EXTI_LINE_6
LL_EXTI_LINE_7
LL_EXTI_LINE_8
LL_EXTI_LINE_9
LL_EXTI_LINE_10
LL_EXTI_LINE_11
LL_EXTI_LINE_12
LL_EXTI_LINE_13
LL_EXTI_LINE_14
LL_EXTI_LINE_15
LL_EXTI_LINE_16
LL_EXTI_LINE_18
LL_EXTI_LINE_19
LL_EXTI_LINE_20
DocID026525 Rev 6
UM1785
LL EXTI Generic Driver
LL_EXTI_LINE_21
LL_EXTI_LINE_22
LL_EXTI_LINE_29
LL_EXTI_LINE_30
LL_EXTI_LINE_31
Return values
@note: This bit is set when the selected edge event arrives
on the interrupt
Notes
This bit is set when the selected edge event arrives on the
interrupt line. This bit is cleared by writing a 1 to the bit.
Please check each device line mapping for EXTI Line
availability
Reference Manual to
LL API cross
reference:
PR PIFx LL_EXTI_ReadFlag_0_31
LL_EXTI_ClearFlag_0_31
Function name
__STATIC_INLINE void LL_EXTI_ClearFlag_0_31 (uint32_t
ExtiLine)
Function description
Clear ExtLine Flags for Lines in range 0 to 31.
Parameters
ExtiLine: This parameter can be a combination of the
following values:
LL_EXTI_LINE_0
LL_EXTI_LINE_1
LL_EXTI_LINE_2
LL_EXTI_LINE_3
LL_EXTI_LINE_4
LL_EXTI_LINE_5
LL_EXTI_LINE_6
LL_EXTI_LINE_7
LL_EXTI_LINE_8
LL_EXTI_LINE_9
LL_EXTI_LINE_10
LL_EXTI_LINE_11
LL_EXTI_LINE_12
LL_EXTI_LINE_13
LL_EXTI_LINE_14
LL_EXTI_LINE_15
LL_EXTI_LINE_16
LL_EXTI_LINE_18
LL_EXTI_LINE_19
LL_EXTI_LINE_20
LL_EXTI_LINE_21
LL_EXTI_LINE_22
LL_EXTI_LINE_29
LL_EXTI_LINE_30
LL_EXTI_LINE_31
Return values
None
Notes
This bit is set when the selected edge event arrives on the
DocID026525 Rev 6
825/1320
LL EXTI Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
interrupt line. This bit is cleared by writing a 1 to the bit.
Please check each device line mapping for EXTI Line
availability
PR PIFx LL_EXTI_ClearFlag_0_31
LL_EXTI_Init
Function name
uint32_t LL_EXTI_Init (LL_EXTI_InitTypeDef * EXTI_InitStruct)
Function description
Initialize the EXTI registers according to the specified parameters
in EXTI_InitStruct.
Parameters
EXTI_InitStruct: pointer to a LL_EXTI_InitTypeDef structure.
Return values
An: ErrorStatus enumeration value:
SUCCESS: EXTI registers are initialized
ERROR: not applicable
LL_EXTI_DeInit
Function name
uint32_t LL_EXTI_DeInit (void )
Function description
De-initialize the EXTI registers to their default reset values.
Return values
An: ErrorStatus enumeration value:
SUCCESS: EXTI registers are de-initialized
ERROR: not applicable
LL_EXTI_StructInit
Function name
void LL_EXTI_StructInit (LL_EXTI_InitTypeDef *
EXTI_InitStruct)
Function description
Set each LL_EXTI_InitTypeDef field to default value.
Parameters
EXTI_InitStruct: Pointer to a LL_EXTI_InitTypeDef structure.
Return values
None
57.3
EXTI Firmware driver defines
57.3.1
EXTI
LINE
826/1320
LL_EXTI_LINE_0
Extended line 0
LL_EXTI_LINE_1
Extended line 1
LL_EXTI_LINE_2
Extended line 2
LL_EXTI_LINE_3
Extended line 3
LL_EXTI_LINE_4
Extended line 4
LL_EXTI_LINE_5
Extended line 5
LL_EXTI_LINE_6
Extended line 6
DocID026525 Rev 6
UM1785
LL EXTI Generic Driver
LL_EXTI_LINE_7
Extended line 7
LL_EXTI_LINE_8
Extended line 8
LL_EXTI_LINE_9
Extended line 9
LL_EXTI_LINE_10
Extended line 10
LL_EXTI_LINE_11
Extended line 11
LL_EXTI_LINE_12
Extended line 12
LL_EXTI_LINE_13
Extended line 13
LL_EXTI_LINE_14
Extended line 14
LL_EXTI_LINE_15
Extended line 15
LL_EXTI_LINE_16
Extended line 16
LL_EXTI_LINE_17
Extended line 17
LL_EXTI_LINE_18
Extended line 18
LL_EXTI_LINE_19
Extended line 19
LL_EXTI_LINE_20
Extended line 20
LL_EXTI_LINE_21
Extended line 21
LL_EXTI_LINE_22
Extended line 22
LL_EXTI_LINE_23
Extended line 23
LL_EXTI_LINE_25
Extended line 25
LL_EXTI_LINE_26
Extended line 26
LL_EXTI_LINE_27
Extended line 27
LL_EXTI_LINE_28
Extended line 28
LL_EXTI_LINE_31
Extended line 31
LL_EXTI_LINE_ALL_0_31
All Extended line not reserved
LL_EXTI_LINE_ALL
All Extended line
LL_EXTI_LINE_NONE
None Extended line
Mode
LL_EXTI_MODE_IT
Interrupt Mode
LL_EXTI_MODE_EVENT
Event Mode
LL_EXTI_MODE_IT_EVENT
Interrupt & Event Mode
Edge Trigger
LL_EXTI_TRIGGER_NONE
No Trigger Mode
LL_EXTI_TRIGGER_RISING
Trigger Rising Mode
LL_EXTI_TRIGGER_FALLING
Trigger Falling Mode
LL_EXTI_TRIGGER_RISING_FALLING
Trigger Rising & Falling Mode
DocID026525 Rev 6
827/1320
LL EXTI Generic Driver
Common Write and read registers Macros
LL_EXTI_WriteReg
Description:
Write a value in EXTI register.
Parameters:
__REG__: Register to be written
__VALUE__: Value to be written in the register
Return value:
None
LL_EXTI_ReadReg
Description:
Read a value in EXTI register.
Parameters:
__REG__: Register to be read
Return value:
Register: value
828/1320
DocID026525 Rev 6
UM1785
UM1785
LL GPIO Generic Driver
58
LL GPIO Generic Driver
58.1
GPIO Firmware driver registers structures
58.1.1
LL_GPIO_InitTypeDef
Data Fields
uint32_t Pin
uint32_t Mode
uint32_t Speed
uint32_t OutputType
uint32_t Pull
uint32_t Alternate
Field Documentation
uint32_t LL_GPIO_InitTypeDef::Pin
Specifies the GPIO pins to be configured. This parameter can be any value of
GPIO_LL_EC_PIN
uint32_t LL_GPIO_InitTypeDef::Mode
Specifies the operating mode for the selected pins. This parameter can be a value of
GPIO_LL_EC_MODE.GPIO HW configuration can be modified afterwards using
unitary function LL_GPIO_SetPinMode().
uint32_t LL_GPIO_InitTypeDef::Speed
Specifies the speed for the selected pins. This parameter can be a value of
GPIO_LL_EC_SPEED.GPIO HW configuration can be modified afterwards using
unitary function LL_GPIO_SetPinSpeed().
uint32_t LL_GPIO_InitTypeDef::OutputType
Specifies the operating output type for the selected pins. This parameter can be a
value of GPIO_LL_EC_OUTPUT.GPIO HW configuration can be modified afterwards
using unitary function LL_GPIO_SetPinOutputType().
uint32_t LL_GPIO_InitTypeDef::Pull
Specifies the operating Pull-up/Pull down for the selected pins. This parameter can be
a value of GPIO_LL_EC_PULL.GPIO HW configuration can be modified afterwards
using unitary function LL_GPIO_SetPinPull().
uint32_t LL_GPIO_InitTypeDef::Alternate
Specifies the Peripheral to be connected to the selected pins. This parameter can be a
value of GPIO_LL_EC_AF.GPIO HW configuration can be modified afterwards using
unitary function LL_GPIO_SetAFPin_0_7() and LL_GPIO_SetAFPin_8_15().
58.2
GPIO Firmware driver API description
58.2.1
Detailed description of functions
LL_GPIO_SetPinMode
Function name
__STATIC_INLINE void LL_GPIO_SetPinMode (GPIO_TypeDef
* GPIOx, uint32_t Pin, uint32_t Mode)
Function description
Configure gpio mode for a dedicated pin on dedicated port.
Parameters
GPIOx: GPIO Port
Pin: This parameter can be one of the following values:
DocID026525 Rev 6
829/1320
LL GPIO Generic Driver
UM1785
LL_GPIO_PIN_0
LL_GPIO_PIN_1
LL_GPIO_PIN_2
LL_GPIO_PIN_3
LL_GPIO_PIN_4
LL_GPIO_PIN_5
LL_GPIO_PIN_6
LL_GPIO_PIN_7
LL_GPIO_PIN_8
LL_GPIO_PIN_9
LL_GPIO_PIN_10
LL_GPIO_PIN_11
LL_GPIO_PIN_12
LL_GPIO_PIN_13
LL_GPIO_PIN_14
LL_GPIO_PIN_15
Mode: This parameter can be one of the following values:
LL_GPIO_MODE_INPUT
LL_GPIO_MODE_OUTPUT
LL_GPIO_MODE_ALTERNATE
LL_GPIO_MODE_ANALOG
Return values
None
Notes
I/O mode can be Input mode, General purpose output,
Alternate function mode or Analog.
Warning: only one pin can be passed as parameter.
Reference Manual to
LL API cross
reference:
MODER MODEy LL_GPIO_SetPinMode
LL_GPIO_GetPinMode
Function name
__STATIC_INLINE uint32_t LL_GPIO_GetPinMode
(GPIO_TypeDef * GPIOx, uint32_t Pin)
Function description
Return gpio mode for a dedicated pin on dedicated port.
Parameters
830/1320
GPIOx: GPIO Port
Pin: This parameter can be one of the following values:
LL_GPIO_PIN_0
LL_GPIO_PIN_1
LL_GPIO_PIN_2
LL_GPIO_PIN_3
LL_GPIO_PIN_4
LL_GPIO_PIN_5
LL_GPIO_PIN_6
LL_GPIO_PIN_7
LL_GPIO_PIN_8
LL_GPIO_PIN_9
LL_GPIO_PIN_10
LL_GPIO_PIN_11
LL_GPIO_PIN_12
LL_GPIO_PIN_13
DocID026525 Rev 6
UM1785
LL GPIO Generic Driver
LL_GPIO_PIN_14
LL_GPIO_PIN_15
Return values
Returned: value can be one of the following values:
LL_GPIO_MODE_INPUT
LL_GPIO_MODE_OUTPUT
LL_GPIO_MODE_ALTERNATE
LL_GPIO_MODE_ANALOG
Notes
I/O mode can be Input mode, General purpose output,
Alternate function mode or Analog.
Warning: only one pin can be passed as parameter.
Reference Manual to
LL API cross
reference:
MODER MODEy LL_GPIO_GetPinMode
LL_GPIO_SetPinOutputType
Function name
__STATIC_INLINE void LL_GPIO_SetPinOutputType
(GPIO_TypeDef * GPIOx, uint32_t PinMask, uint32_t
OutputType)
Function description
Configure gpio output type for several pins on dedicated port.
Parameters
GPIOx: GPIO Port
PinMask: This parameter can be a combination of the
following values:
LL_GPIO_PIN_0
LL_GPIO_PIN_1
LL_GPIO_PIN_2
LL_GPIO_PIN_3
LL_GPIO_PIN_4
LL_GPIO_PIN_5
LL_GPIO_PIN_6
LL_GPIO_PIN_7
LL_GPIO_PIN_8
LL_GPIO_PIN_9
LL_GPIO_PIN_10
LL_GPIO_PIN_11
LL_GPIO_PIN_12
LL_GPIO_PIN_13
LL_GPIO_PIN_14
LL_GPIO_PIN_15
LL_GPIO_PIN_ALL
OutputType: This parameter can be one of the following
values:
LL_GPIO_OUTPUT_PUSHPULL
LL_GPIO_OUTPUT_OPENDRAIN
Return values
None
Notes
Output type as to be set when gpio pin is in output or
alternate modes. Possible type are Push-pull or Open-drain.
Reference Manual to
LL API cross
OTYPER OTy LL_GPIO_SetPinOutputType
DocID026525 Rev 6
831/1320
LL GPIO Generic Driver
reference:
UM1785
LL_GPIO_GetPinOutputType
Function name
__STATIC_INLINE uint32_t LL_GPIO_GetPinOutputType
(GPIO_TypeDef * GPIOx, uint32_t Pin)
Function description
Return gpio output type for several pins on dedicated port.
Parameters
GPIOx: GPIO Port
Pin: This parameter can be one of the following values:
LL_GPIO_PIN_0
LL_GPIO_PIN_1
LL_GPIO_PIN_2
LL_GPIO_PIN_3
LL_GPIO_PIN_4
LL_GPIO_PIN_5
LL_GPIO_PIN_6
LL_GPIO_PIN_7
LL_GPIO_PIN_8
LL_GPIO_PIN_9
LL_GPIO_PIN_10
LL_GPIO_PIN_11
LL_GPIO_PIN_12
LL_GPIO_PIN_13
LL_GPIO_PIN_14
LL_GPIO_PIN_15
LL_GPIO_PIN_ALL
Return values
Returned: value can be one of the following values:
LL_GPIO_OUTPUT_PUSHPULL
LL_GPIO_OUTPUT_OPENDRAIN
Notes
Output type as to be set when gpio pin is in output or
alternate modes. Possible type are Push-pull or Open-drain.
Warning: only one pin can be passed as parameter.
Reference Manual to
LL API cross
reference:
OTYPER OTy LL_GPIO_GetPinOutputType
LL_GPIO_SetPinSpeed
Function name
__STATIC_INLINE void LL_GPIO_SetPinSpeed
(GPIO_TypeDef * GPIOx, uint32_t Pin, uint32_t Speed)
Function description
Configure gpio speed for a dedicated pin on dedicated port.
Parameters
832/1320
GPIOx: GPIO Port
Pin: This parameter can be one of the following values:
LL_GPIO_PIN_0
LL_GPIO_PIN_1
LL_GPIO_PIN_2
LL_GPIO_PIN_3
LL_GPIO_PIN_4
LL_GPIO_PIN_5
DocID026525 Rev 6
UM1785
LL GPIO Generic Driver
LL_GPIO_PIN_6
LL_GPIO_PIN_7
LL_GPIO_PIN_8
LL_GPIO_PIN_9
LL_GPIO_PIN_10
LL_GPIO_PIN_11
LL_GPIO_PIN_12
LL_GPIO_PIN_13
LL_GPIO_PIN_14
LL_GPIO_PIN_15
Speed: This parameter can be one of the following values:
LL_GPIO_SPEED_FREQ_LOW
LL_GPIO_SPEED_FREQ_MEDIUM
LL_GPIO_SPEED_FREQ_HIGH
Return values
None
Notes
I/O speed can be Low, Medium, Fast or High speed.
Warning: only one pin can be passed as parameter.
Refer to datasheet for frequency specifications and the power
supply and load conditions for each speed.
Reference Manual to
LL API cross
reference:
OSPEEDR OSPEEDy LL_GPIO_SetPinSpeed
LL_GPIO_GetPinSpeed
Function name
__STATIC_INLINE uint32_t LL_GPIO_GetPinSpeed
(GPIO_TypeDef * GPIOx, uint32_t Pin)
Function description
Return gpio speed for a dedicated pin on dedicated port.
Parameters
GPIOx: GPIO Port
Pin: This parameter can be one of the following values:
LL_GPIO_PIN_0
LL_GPIO_PIN_1
LL_GPIO_PIN_2
LL_GPIO_PIN_3
LL_GPIO_PIN_4
LL_GPIO_PIN_5
LL_GPIO_PIN_6
LL_GPIO_PIN_7
LL_GPIO_PIN_8
LL_GPIO_PIN_9
LL_GPIO_PIN_10
LL_GPIO_PIN_11
LL_GPIO_PIN_12
LL_GPIO_PIN_13
LL_GPIO_PIN_14
LL_GPIO_PIN_15
Return values
Returned: value can be one of the following values:
LL_GPIO_SPEED_FREQ_LOW
LL_GPIO_SPEED_FREQ_MEDIUM
DocID026525 Rev 6
833/1320
LL GPIO Generic Driver
UM1785
LL_GPIO_SPEED_FREQ_HIGH
Notes
I/O speed can be Low, Medium, Fast or High speed.
Warning: only one pin can be passed as parameter.
Refer to datasheet for frequency specifications and the power
supply and load conditions for each speed.
Reference Manual to
LL API cross
reference:
OSPEEDR OSPEEDy LL_GPIO_GetPinSpeed
LL_GPIO_SetPinPull
Function name
__STATIC_INLINE void LL_GPIO_SetPinPull (GPIO_TypeDef *
GPIOx, uint32_t Pin, uint32_t Pull)
Function description
Configure gpio pull-up or pull-down for a dedicated pin on a
dedicated port.
Parameters
GPIOx: GPIO Port
Pin: This parameter can be one of the following values:
LL_GPIO_PIN_0
LL_GPIO_PIN_1
LL_GPIO_PIN_2
LL_GPIO_PIN_3
LL_GPIO_PIN_4
LL_GPIO_PIN_5
LL_GPIO_PIN_6
LL_GPIO_PIN_7
LL_GPIO_PIN_8
LL_GPIO_PIN_9
LL_GPIO_PIN_10
LL_GPIO_PIN_11
LL_GPIO_PIN_12
LL_GPIO_PIN_13
LL_GPIO_PIN_14
LL_GPIO_PIN_15
Pull: This parameter can be one of the following values:
LL_GPIO_PULL_NO
LL_GPIO_PULL_UP
LL_GPIO_PULL_DOWN
Return values
None
Notes
Warning: only one pin can be passed as parameter.
Reference Manual to
LL API cross
reference:
PUPDR PUPDy LL_GPIO_SetPinPull
LL_GPIO_GetPinPull
834/1320
Function name
__STATIC_INLINE uint32_t LL_GPIO_GetPinPull
(GPIO_TypeDef * GPIOx, uint32_t Pin)
Function description
Return gpio pull-up or pull-down for a dedicated pin on a dedicated
port.
DocID026525 Rev 6
UM1785
LL GPIO Generic Driver
Parameters
GPIOx: GPIO Port
Pin: This parameter can be one of the following values:
LL_GPIO_PIN_0
LL_GPIO_PIN_1
LL_GPIO_PIN_2
LL_GPIO_PIN_3
LL_GPIO_PIN_4
LL_GPIO_PIN_5
LL_GPIO_PIN_6
LL_GPIO_PIN_7
LL_GPIO_PIN_8
LL_GPIO_PIN_9
LL_GPIO_PIN_10
LL_GPIO_PIN_11
LL_GPIO_PIN_12
LL_GPIO_PIN_13
LL_GPIO_PIN_14
LL_GPIO_PIN_15
Return values
Returned: value can be one of the following values:
LL_GPIO_PULL_NO
LL_GPIO_PULL_UP
LL_GPIO_PULL_DOWN
Notes
Warning: only one pin can be passed as parameter.
Reference Manual to
LL API cross
reference:
PUPDR PUPDy LL_GPIO_GetPinPull
LL_GPIO_SetAFPin_0_7
Function name
__STATIC_INLINE void LL_GPIO_SetAFPin_0_7
(GPIO_TypeDef * GPIOx, uint32_t Pin, uint32_t Alternate)
Function description
Configure gpio alternate function of a dedicated pin from 0 to 7 for
a dedicated port.
Parameters
GPIOx: GPIO Port
Pin: This parameter can be one of the following values:
LL_GPIO_PIN_0
LL_GPIO_PIN_1
LL_GPIO_PIN_2
LL_GPIO_PIN_3
LL_GPIO_PIN_4
LL_GPIO_PIN_5
LL_GPIO_PIN_6
LL_GPIO_PIN_7
Alternate: This parameter can be one of the following
values:
LL_GPIO_AF_0
LL_GPIO_AF_1
LL_GPIO_AF_2
LL_GPIO_AF_3
LL_GPIO_AF_4
DocID026525 Rev 6
835/1320
LL GPIO Generic Driver
UM1785
LL_GPIO_AF_5
LL_GPIO_AF_6
LL_GPIO_AF_7
Return values
None
Notes
Possible values are from AF0 to AF7 depending on target.
Warning: only one pin can be passed as parameter.
Reference Manual to
LL API cross
reference:
AFRL AFSELy LL_GPIO_SetAFPin_0_7
LL_GPIO_GetAFPin_0_7
Function name
__STATIC_INLINE uint32_t LL_GPIO_GetAFPin_0_7
(GPIO_TypeDef * GPIOx, uint32_t Pin)
Function description
Return gpio alternate function of a dedicated pin from 0 to 7 for a
dedicated port.
Parameters
GPIOx: GPIO Port
Pin: This parameter can be one of the following values:
LL_GPIO_PIN_0
LL_GPIO_PIN_1
LL_GPIO_PIN_2
LL_GPIO_PIN_3
LL_GPIO_PIN_4
LL_GPIO_PIN_5
LL_GPIO_PIN_6
LL_GPIO_PIN_7
Return values
Returned: value can be one of the following values:
LL_GPIO_AF_0
LL_GPIO_AF_1
LL_GPIO_AF_2
LL_GPIO_AF_3
LL_GPIO_AF_4
LL_GPIO_AF_5
LL_GPIO_AF_6
LL_GPIO_AF_7
Reference Manual to
LL API cross
reference:
AFRL AFSELy LL_GPIO_GetAFPin_0_7
LL_GPIO_SetAFPin_8_15
Function name
__STATIC_INLINE void LL_GPIO_SetAFPin_8_15
(GPIO_TypeDef * GPIOx, uint32_t Pin, uint32_t Alternate)
Function description
Configure gpio alternate function of a dedicated pin from 8 to 15
for a dedicated port.
Parameters
836/1320
GPIOx: GPIO Port
Pin: This parameter can be one of the following values:
LL_GPIO_PIN_8
LL_GPIO_PIN_9
DocID026525 Rev 6
UM1785
LL GPIO Generic Driver
LL_GPIO_PIN_10
LL_GPIO_PIN_11
LL_GPIO_PIN_12
LL_GPIO_PIN_13
LL_GPIO_PIN_14
LL_GPIO_PIN_15
Alternate: This parameter can be one of the following
values:
LL_GPIO_AF_0
LL_GPIO_AF_1
LL_GPIO_AF_2
LL_GPIO_AF_3
LL_GPIO_AF_4
LL_GPIO_AF_5
LL_GPIO_AF_6
LL_GPIO_AF_7
Return values
None
Notes
Possible values are from AF0 to AF7 depending on target.
Warning: only one pin can be passed as parameter.
Reference Manual to
LL API cross
reference:
AFRH AFSELy LL_GPIO_SetAFPin_8_15
LL_GPIO_GetAFPin_8_15
Function name
__STATIC_INLINE uint32_t LL_GPIO_GetAFPin_8_15
(GPIO_TypeDef * GPIOx, uint32_t Pin)
Function description
Return gpio alternate function of a dedicated pin from 8 to 15 for a
dedicated port.
Parameters
GPIOx: GPIO Port
Pin: This parameter can be one of the following values:
LL_GPIO_PIN_8
LL_GPIO_PIN_9
LL_GPIO_PIN_10
LL_GPIO_PIN_11
LL_GPIO_PIN_12
LL_GPIO_PIN_13
LL_GPIO_PIN_14
LL_GPIO_PIN_15
Return values
Returned: value can be one of the following values:
LL_GPIO_AF_0
LL_GPIO_AF_1
LL_GPIO_AF_2
LL_GPIO_AF_3
LL_GPIO_AF_4
LL_GPIO_AF_5
LL_GPIO_AF_6
LL_GPIO_AF_7
Notes
Possible values are from AF0 to AF7 depending on target.
DocID026525 Rev 6
837/1320
LL GPIO Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
AFRH AFSELy LL_GPIO_GetAFPin_8_15
LL_GPIO_LockPin
Function name
__STATIC_INLINE void LL_GPIO_LockPin (GPIO_TypeDef *
GPIOx, uint32_t PinMask)
Function description
Lock configuration of several pins for a dedicated port.
Parameters
GPIOx: GPIO Port
PinMask: This parameter can be a combination of the
following values:
LL_GPIO_PIN_0
LL_GPIO_PIN_1
LL_GPIO_PIN_2
LL_GPIO_PIN_3
LL_GPIO_PIN_4
LL_GPIO_PIN_5
LL_GPIO_PIN_6
LL_GPIO_PIN_7
LL_GPIO_PIN_8
LL_GPIO_PIN_9
LL_GPIO_PIN_10
LL_GPIO_PIN_11
LL_GPIO_PIN_12
LL_GPIO_PIN_13
LL_GPIO_PIN_14
LL_GPIO_PIN_15
LL_GPIO_PIN_ALL
Return values
None
Notes
When the lock sequence has been applied on a port bit, the
value of this port bit can no longer be modified until the next
reset.
Each lock bit freezes a specific configuration register (control
and alternate function registers).
Reference Manual to
LL API cross
reference:
LCKR LCKK LL_GPIO_LockPin
LL_GPIO_IsPinLocked
Function name
__STATIC_INLINE uint32_t LL_GPIO_IsPinLocked
(GPIO_TypeDef * GPIOx, uint32_t PinMask)
Function description
Return 1 if all pins passed as parameter, of a dedicated port, are
locked.
Parameters
838/1320
GPIOx: GPIO Port
PinMask: This parameter can be a combination of the
following values:
LL_GPIO_PIN_0
LL_GPIO_PIN_1
DocID026525 Rev 6
UM1785
LL GPIO Generic Driver
LL_GPIO_PIN_2
LL_GPIO_PIN_3
LL_GPIO_PIN_4
LL_GPIO_PIN_5
LL_GPIO_PIN_6
LL_GPIO_PIN_7
LL_GPIO_PIN_8
LL_GPIO_PIN_9
LL_GPIO_PIN_10
LL_GPIO_PIN_11
LL_GPIO_PIN_12
LL_GPIO_PIN_13
LL_GPIO_PIN_14
LL_GPIO_PIN_15
LL_GPIO_PIN_ALL
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
LCKR LCKy LL_GPIO_IsPinLocked
LL_GPIO_IsAnyPinLocked
Function name
__STATIC_INLINE uint32_t LL_GPIO_IsAnyPinLocked
(GPIO_TypeDef * GPIOx)
Function description
Return 1 if one of the pin of a dedicated port is locked.
Parameters
GPIOx: GPIO Port
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
LCKR LCKK LL_GPIO_IsAnyPinLocked
LL_GPIO_ReadInputPort
Function name
__STATIC_INLINE uint32_t LL_GPIO_ReadInputPort
(GPIO_TypeDef * GPIOx)
Function description
Return full input data register value for a dedicated port.
Parameters
GPIOx: GPIO Port
Return values
Input: data register value of port
Reference Manual to
LL API cross
reference:
IDR IDy LL_GPIO_ReadInputPort
LL_GPIO_IsInputPinSet
Function name
__STATIC_INLINE uint32_t LL_GPIO_IsInputPinSet
(GPIO_TypeDef * GPIOx, uint32_t PinMask)
Function description
Return if input data level for several pins of dedicated port is high
DocID026525 Rev 6
839/1320
LL GPIO Generic Driver
UM1785
or low.
Parameters
GPIOx: GPIO Port
PinMask: This parameter can be a combination of the
following values:
LL_GPIO_PIN_0
LL_GPIO_PIN_1
LL_GPIO_PIN_2
LL_GPIO_PIN_3
LL_GPIO_PIN_4
LL_GPIO_PIN_5
LL_GPIO_PIN_6
LL_GPIO_PIN_7
LL_GPIO_PIN_8
LL_GPIO_PIN_9
LL_GPIO_PIN_10
LL_GPIO_PIN_11
LL_GPIO_PIN_12
LL_GPIO_PIN_13
LL_GPIO_PIN_14
LL_GPIO_PIN_15
LL_GPIO_PIN_ALL
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
IDR IDy LL_GPIO_IsInputPinSet
LL_GPIO_WriteOutputPort
Function name
__STATIC_INLINE void LL_GPIO_WriteOutputPort
(GPIO_TypeDef * GPIOx, uint32_t PortValue)
Function description
Write output data register for the port.
Parameters
GPIOx: GPIO Port
PortValue: Level value for each pin of the port
Return values
None
Reference Manual to
LL API cross
reference:
ODR ODy LL_GPIO_WriteOutputPort
LL_GPIO_ReadOutputPort
840/1320
Function name
__STATIC_INLINE uint32_t LL_GPIO_ReadOutputPort
(GPIO_TypeDef * GPIOx)
Function description
Return full output data register value for a dedicated port.
Parameters
GPIOx: GPIO Port
Return values
Output: data register value of port
Reference Manual to
LL API cross
ODR ODy LL_GPIO_ReadOutputPort
DocID026525 Rev 6
UM1785
LL GPIO Generic Driver
reference:
LL_GPIO_IsOutputPinSet
Function name
__STATIC_INLINE uint32_t LL_GPIO_IsOutputPinSet
(GPIO_TypeDef * GPIOx, uint32_t PinMask)
Function description
Return if input data level for several pins of dedicated port is high
or low.
Parameters
GPIOx: GPIO Port
PinMask: This parameter can be a combination of the
following values:
LL_GPIO_PIN_0
LL_GPIO_PIN_1
LL_GPIO_PIN_2
LL_GPIO_PIN_3
LL_GPIO_PIN_4
LL_GPIO_PIN_5
LL_GPIO_PIN_6
LL_GPIO_PIN_7
LL_GPIO_PIN_8
LL_GPIO_PIN_9
LL_GPIO_PIN_10
LL_GPIO_PIN_11
LL_GPIO_PIN_12
LL_GPIO_PIN_13
LL_GPIO_PIN_14
LL_GPIO_PIN_15
LL_GPIO_PIN_ALL
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ODR ODy LL_GPIO_IsOutputPinSet
LL_GPIO_SetOutputPin
Function name
__STATIC_INLINE void LL_GPIO_SetOutputPin
(GPIO_TypeDef * GPIOx, uint32_t PinMask)
Function description
Set several pins to high level on dedicated gpio port.
Parameters
GPIOx: GPIO Port
PinMask: This parameter can be a combination of the
following values:
LL_GPIO_PIN_0
LL_GPIO_PIN_1
LL_GPIO_PIN_2
LL_GPIO_PIN_3
LL_GPIO_PIN_4
LL_GPIO_PIN_5
LL_GPIO_PIN_6
LL_GPIO_PIN_7
LL_GPIO_PIN_8
DocID026525 Rev 6
841/1320
LL GPIO Generic Driver
UM1785
LL_GPIO_PIN_9
LL_GPIO_PIN_10
LL_GPIO_PIN_11
LL_GPIO_PIN_12
LL_GPIO_PIN_13
LL_GPIO_PIN_14
LL_GPIO_PIN_15
LL_GPIO_PIN_ALL
Return values
None
Reference Manual to
LL API cross
reference:
BSRR BSy LL_GPIO_SetOutputPin
LL_GPIO_ResetOutputPin
Function name
__STATIC_INLINE void LL_GPIO_ResetOutputPin
(GPIO_TypeDef * GPIOx, uint32_t PinMask)
Function description
Set several pins to low level on dedicated gpio port.
Parameters
GPIOx: GPIO Port
PinMask: This parameter can be a combination of the
following values:
LL_GPIO_PIN_0
LL_GPIO_PIN_1
LL_GPIO_PIN_2
LL_GPIO_PIN_3
LL_GPIO_PIN_4
LL_GPIO_PIN_5
LL_GPIO_PIN_6
LL_GPIO_PIN_7
LL_GPIO_PIN_8
LL_GPIO_PIN_9
LL_GPIO_PIN_10
LL_GPIO_PIN_11
LL_GPIO_PIN_12
LL_GPIO_PIN_13
LL_GPIO_PIN_14
LL_GPIO_PIN_15
LL_GPIO_PIN_ALL
Return values
None
Reference Manual to
LL API cross
reference:
BRR BRy LL_GPIO_ResetOutputPin
LL_GPIO_TogglePin
Function name
__STATIC_INLINE void LL_GPIO_TogglePin (GPIO_TypeDef *
GPIOx, uint32_t PinMask)
Function description
Toggle data value for several pin of dedicated port.
Parameters
842/1320
GPIOx: GPIO Port
DocID026525 Rev 6
UM1785
LL GPIO Generic Driver
PinMask: This parameter can be a combination of the
following values:
LL_GPIO_PIN_0
LL_GPIO_PIN_1
LL_GPIO_PIN_2
LL_GPIO_PIN_3
LL_GPIO_PIN_4
LL_GPIO_PIN_5
LL_GPIO_PIN_6
LL_GPIO_PIN_7
LL_GPIO_PIN_8
LL_GPIO_PIN_9
LL_GPIO_PIN_10
LL_GPIO_PIN_11
LL_GPIO_PIN_12
LL_GPIO_PIN_13
LL_GPIO_PIN_14
LL_GPIO_PIN_15
LL_GPIO_PIN_ALL
Return values
None
Reference Manual to
LL API cross
reference:
ODR ODy LL_GPIO_TogglePin
LL_GPIO_DeInit
Function name
ErrorStatus LL_GPIO_DeInit (GPIO_TypeDef * GPIOx)
Function description
De-initialize GPIO registers (Registers restored to their default
values).
Parameters
GPIOx: GPIO Port
Return values
An: ErrorStatus enumeration value:
SUCCESS: GPIO registers are de-initialized
ERROR: Wrong GPIO Port
LL_GPIO_Init
Function name
ErrorStatus LL_GPIO_Init (GPIO_TypeDef * GPIOx,
LL_GPIO_InitTypeDef * GPIO_InitStruct)
Function description
Initialize GPIO registers according to the specified parameters in
GPIO_InitStruct.
Parameters
GPIOx: GPIO Port
GPIO_InitStruct: pointer to a LL_GPIO_InitTypeDef
structure that contains the configuration information for the
specified GPIO peripheral.
Return values
An: ErrorStatus enumeration value:
SUCCESS: GPIO registers are initialized according to
GPIO_InitStruct content
ERROR: Not applicable
DocID026525 Rev 6
843/1320
LL GPIO Generic Driver
UM1785
LL_GPIO_StructInit
Function name
void LL_GPIO_StructInit (LL_GPIO_InitTypeDef *
GPIO_InitStruct)
Function description
Set each LL_GPIO_InitTypeDef field to default value.
Parameters
GPIO_InitStruct: pointer to a LL_GPIO_InitTypeDef
structure whose fields will be set to default values.
Return values
None
58.3
GPIO Firmware driver defines
58.3.1
GPIO
Alternate Function
LL_GPIO_AF_0
Select alternate function 0
LL_GPIO_AF_1
Select alternate function 1
LL_GPIO_AF_2
Select alternate function 2
LL_GPIO_AF_3
Select alternate function 3
LL_GPIO_AF_4
Select alternate function 4
LL_GPIO_AF_5
Select alternate function 5
LL_GPIO_AF_6
Select alternate function 6
LL_GPIO_AF_7
Select alternate function 7
Mode
LL_GPIO_MODE_INPUT
Select input mode
LL_GPIO_MODE_OUTPUT
Select output mode
LL_GPIO_MODE_ALTERNATE
Select alternate function mode
LL_GPIO_MODE_ANALOG
Select analog mode
Output Type
LL_GPIO_OUTPUT_PUSHPULL
Select push-pull as output type
LL_GPIO_OUTPUT_OPENDRAIN
Select open-drain as output type
PIN
844/1320
LL_GPIO_PIN_0
Select pin 0
LL_GPIO_PIN_1
Select pin 1
LL_GPIO_PIN_2
Select pin 2
LL_GPIO_PIN_3
Select pin 3
LL_GPIO_PIN_4
Select pin 4
LL_GPIO_PIN_5
Select pin 5
LL_GPIO_PIN_6
Select pin 6
LL_GPIO_PIN_7
Select pin 7
LL_GPIO_PIN_8
Select pin 8
DocID026525 Rev 6
UM1785
LL GPIO Generic Driver
LL_GPIO_PIN_9
Select pin 9
LL_GPIO_PIN_10
Select pin 10
LL_GPIO_PIN_11
Select pin 11
LL_GPIO_PIN_12
Select pin 12
LL_GPIO_PIN_13
Select pin 13
LL_GPIO_PIN_14
Select pin 14
LL_GPIO_PIN_15
Select pin 15
LL_GPIO_PIN_ALL
Select all pins
Pull Up Pull Down
LL_GPIO_PULL_NO
Select I/O no pull
LL_GPIO_PULL_UP
Select I/O pull up
LL_GPIO_PULL_DOWN
Select I/O pull down
Output Speed
LL_GPIO_SPEED_FREQ_LOW
Select I/O low output speed
LL_GPIO_SPEED_FREQ_MEDIUM
Select I/O medium output speed
LL_GPIO_SPEED_FREQ_HIGH
Select I/O high output speed
Common Write and read registers Macros
LL_GPIO_WriteReg
Description:
Write a value in GPIO register.
Parameters:
__INSTANCE__: GPIO Instance
__REG__: Register to be written
__VALUE__: Value to be written in the register
Return value:
None
LL_GPIO_ReadReg
Description:
Read a value in GPIO register.
Parameters:
__INSTANCE__: GPIO Instance
__REG__: Register to be read
Return value:
Register: value
GPIO Exported Constants
LL_GPIO_SPEED_LOW
LL_GPIO_SPEED_MEDIUM
LL_GPIO_SPEED_HIGH
DocID026525 Rev 6
845/1320
LL I2C Generic Driver
UM1785
59
LL I2C Generic Driver
59.1
I2C Firmware driver registers structures
59.1.1
LL_I2C_InitTypeDef
Data Fields
uint32_t PeripheralMode
uint32_t Timing
uint32_t AnalogFilter
uint32_t DigitalFilter
uint32_t OwnAddress1
uint32_t TypeAcknowledge
uint32_t OwnAddrSize
Field Documentation
uint32_t LL_I2C_InitTypeDef::PeripheralMode
Specifies the peripheral mode. This parameter can be a value of
I2C_LL_EC_PERIPHERAL_MODEThis feature can be modified afterwards using
unitary function LL_I2C_SetMode().
uint32_t LL_I2C_InitTypeDef::Timing
Specifies the SDA setup, hold time and the SCL high, low period values. This
parameter must be set by referring to the STM32CubeMX Tool and the helper macro
__LL_I2C_CONVERT_TIMINGS()This feature can be modified afterwards using
unitary function LL_I2C_SetTiming().
uint32_t LL_I2C_InitTypeDef::AnalogFilter
Enables or disables analog noise filter. This parameter can be a value of
I2C_LL_EC_ANALOGFILTER_SELECTIONThis feature can be modified afterwards
using unitary functions LL_I2C_EnableAnalogFilter() or
LL_I2C_DisableAnalogFilter().
uint32_t LL_I2C_InitTypeDef::DigitalFilter
Configures the digital noise filter. This parameter can be a number between Min_Data
= 0x00 and Max_Data = 0x0FThis feature can be modified afterwards using unitary
function LL_I2C_SetDigitalFilter().
uint32_t LL_I2C_InitTypeDef::OwnAddress1
Specifies the device own address 1. This parameter must be a value between
Min_Data = 0x00 and Max_Data = 0x3FFThis feature can be modified afterwards
using unitary function LL_I2C_SetOwnAddress1().
uint32_t LL_I2C_InitTypeDef::TypeAcknowledge
Specifies the ACKnowledge or Non ACKnowledge condition after the address receive
match code or next received byte. This parameter can be a value of
I2C_LL_EC_I2C_ACKNOWLEDGEThis feature can be modified afterwards using
unitary function LL_I2C_AcknowledgeNextData().
uint32_t LL_I2C_InitTypeDef::OwnAddrSize
Specifies the device own address 1 size (7-bit or 10-bit). This parameter can be a
value of I2C_LL_EC_OWNADDRESS1This feature can be modified afterwards using
unitary function LL_I2C_SetOwnAddress1().
846/1320
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
59.2
I2C Firmware driver API description
59.2.1
Detailed description of functions
LL_I2C_Enable
Function name
__STATIC_INLINE void LL_I2C_Enable (I2C_TypeDef * I2Cx)
Function description
Enable I2C peripheral (PE = 1).
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
CR1 PE LL_I2C_Enable
LL_I2C_Disable
Function name
__STATIC_INLINE void LL_I2C_Disable (I2C_TypeDef * I2Cx)
Function description
Disable I2C peripheral (PE = 0).
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
When PE = 0, the I2C SCL and SDA lines are released.
Internal state machines and status bits are put back to their
reset value. When cleared, PE must be kept low for at least 3
APB clock cycles.
Reference Manual to
LL API cross
reference:
CR1 PE LL_I2C_Disable
LL_I2C_IsEnabled
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabled (I2C_TypeDef *
I2Cx)
Function description
Check if the I2C peripheral is enabled or disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 PE LL_I2C_IsEnabled
LL_I2C_ConfigFilters
Function name
__STATIC_INLINE void LL_I2C_ConfigFilters (I2C_TypeDef *
I2Cx, uint32_t AnalogFilter, uint32_t DigitalFilter)
Function description
Configure Noise Filters (Analog and Digital).
Parameters
I2Cx: I2C Instance.
AnalogFilter: This parameter can be one of the following
DocID026525 Rev 6
847/1320
LL I2C Generic Driver
UM1785
values:
LL_I2C_ANALOGFILTER_ENABLE
LL_I2C_ANALOGFILTER_DISABLE
DigitalFilter: This parameter must be a value between
Min_Data=0x00 (Digital filter disabled) and Max_Data=0x0F
(Digital filter enabled and filtering capability up to 15*ti2cclk).
This parameter is used to configure the digital noise filter on
SDA and SCL input. The digital filter will filter spikes with a
length of up to DNF[3:0]*ti2cclk.
Return values
None
Notes
If the analog filter is also enabled, the digital filter is added to
analog filter. The filters can only be programmed when the
I2C is disabled (PE = 0).
Reference Manual to
LL API cross
reference:
CR1 ANFOFF LL_I2C_ConfigFilters
CR1 DNF LL_I2C_ConfigFilters
LL_I2C_SetDigitalFilter
Function name
__STATIC_INLINE void LL_I2C_SetDigitalFilter (I2C_TypeDef *
I2Cx, uint32_t DigitalFilter)
Function description
Configure Digital Noise Filter.
Parameters
I2Cx: I2C Instance.
DigitalFilter: This parameter must be a value between
Min_Data=0x00 (Digital filter disabled) and Max_Data=0x0F
(Digital filter enabled and filtering capability up to 15*ti2cclk).
This parameter is used to configure the digital noise filter on
SDA and SCL input. The digital filter will filter spikes with a
length of up to DNF[3:0]*ti2cclk.
Return values
None
Notes
If the analog filter is also enabled, the digital filter is added to
analog filter. This filter can only be programmed when the I2C
is disabled (PE = 0).
Reference Manual to
LL API cross
reference:
CR1 DNF LL_I2C_SetDigitalFilter
LL_I2C_GetDigitalFilter
848/1320
Function name
__STATIC_INLINE uint32_t LL_I2C_GetDigitalFilter
(I2C_TypeDef * I2Cx)
Function description
Get the current Digital Noise Filter configuration.
Parameters
I2Cx: I2C Instance.
Return values
Value: between Min_Data=0x0 and Max_Data=0xF
Reference Manual to
LL API cross
reference:
CR1 DNF LL_I2C_GetDigitalFilter
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
LL_I2C_EnableAnalogFilter
Function name
__STATIC_INLINE void LL_I2C_EnableAnalogFilter
(I2C_TypeDef * I2Cx)
Function description
Enable Analog Noise Filter.
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
This filter can only be programmed when the I2C is disabled
(PE = 0).
Reference Manual to
LL API cross
reference:
CR1 ANFOFF LL_I2C_EnableAnalogFilter
LL_I2C_DisableAnalogFilter
Function name
__STATIC_INLINE void LL_I2C_DisableAnalogFilter
(I2C_TypeDef * I2Cx)
Function description
Disable Analog Noise Filter.
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
This filter can only be programmed when the I2C is disabled
(PE = 0).
Reference Manual to
LL API cross
reference:
CR1 ANFOFF LL_I2C_DisableAnalogFilter
LL_I2C_IsEnabledAnalogFilter
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledAnalogFilter
(I2C_TypeDef * I2Cx)
Function description
Check if Analog Noise Filter is enabled or disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 ANFOFF LL_I2C_IsEnabledAnalogFilter
LL_I2C_EnableDMAReq_TX
Function name
__STATIC_INLINE void LL_I2C_EnableDMAReq_TX
(I2C_TypeDef * I2Cx)
Function description
Enable DMA transmission requests.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
CR1 TXDMAEN LL_I2C_EnableDMAReq_TX
DocID026525 Rev 6
849/1320
LL I2C Generic Driver
LL API cross
reference:
UM1785
LL_I2C_DisableDMAReq_TX
Function name
__STATIC_INLINE void LL_I2C_DisableDMAReq_TX
(I2C_TypeDef * I2Cx)
Function description
Disable DMA transmission requests.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
CR1 TXDMAEN LL_I2C_DisableDMAReq_TX
LL_I2C_IsEnabledDMAReq_TX
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledDMAReq_TX
(I2C_TypeDef * I2Cx)
Function description
Check if DMA transmission requests are enabled or disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 TXDMAEN LL_I2C_IsEnabledDMAReq_TX
LL_I2C_EnableDMAReq_RX
Function name
__STATIC_INLINE void LL_I2C_EnableDMAReq_RX
(I2C_TypeDef * I2Cx)
Function description
Enable DMA reception requests.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
CR1 RXDMAEN LL_I2C_EnableDMAReq_RX
LL_I2C_DisableDMAReq_RX
850/1320
Function name
__STATIC_INLINE void LL_I2C_DisableDMAReq_RX
(I2C_TypeDef * I2Cx)
Function description
Disable DMA reception requests.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
CR1 RXDMAEN LL_I2C_DisableDMAReq_RX
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
reference:
LL_I2C_IsEnabledDMAReq_RX
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledDMAReq_RX
(I2C_TypeDef * I2Cx)
Function description
Check if DMA reception requests are enabled or disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 RXDMAEN LL_I2C_IsEnabledDMAReq_RX
LL_I2C_DMA_GetRegAddr
Function name
__STATIC_INLINE uint32_t LL_I2C_DMA_GetRegAddr
(I2C_TypeDef * I2Cx, uint32_t Direction)
Function description
Get the data register address used for DMA transfer.
Parameters
I2Cx: I2C Instance
Direction: This parameter can be one of the following
values:
LL_I2C_DMA_REG_DATA_TRANSMIT
LL_I2C_DMA_REG_DATA_RECEIVE
Return values
Address: of data register
Reference Manual to
LL API cross
reference:
TXDR TXDATA LL_I2C_DMA_GetRegAddr
RXDR RXDATA LL_I2C_DMA_GetRegAddr
LL_I2C_EnableClockStretching
Function name
__STATIC_INLINE void LL_I2C_EnableClockStretching
(I2C_TypeDef * I2Cx)
Function description
Enable Clock stretching.
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
This bit can only be programmed when the I2C is disabled
(PE = 0).
Reference Manual to
LL API cross
reference:
CR1 NOSTRETCH LL_I2C_EnableClockStretching
LL_I2C_DisableClockStretching
Function name
__STATIC_INLINE void LL_I2C_DisableClockStretching
(I2C_TypeDef * I2Cx)
Function description
Disable Clock stretching.
DocID026525 Rev 6
851/1320
LL I2C Generic Driver
Parameters
UM1785
I2Cx: I2C Instance.
Return values
None
Notes
This bit can only be programmed when the I2C is disabled
(PE = 0).
Reference Manual to
LL API cross
reference:
CR1 NOSTRETCH LL_I2C_DisableClockStretching
LL_I2C_IsEnabledClockStretching
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledClockStretching
(I2C_TypeDef * I2Cx)
Function description
Check if Clock stretching is enabled or disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 NOSTRETCH LL_I2C_IsEnabledClockStretching
LL_I2C_EnableSlaveByteControl
Function name
__STATIC_INLINE void LL_I2C_EnableSlaveByteControl
(I2C_TypeDef * I2Cx)
Function description
Enable hardware byte control in slave mode.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
CR1 SBC LL_I2C_EnableSlaveByteControl
LL_I2C_DisableSlaveByteControl
852/1320
Function name
__STATIC_INLINE void LL_I2C_DisableSlaveByteControl
(I2C_TypeDef * I2Cx)
Function description
Disable hardware byte control in slave mode.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
CR1 SBC LL_I2C_DisableSlaveByteControl
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
LL_I2C_IsEnabledSlaveByteControl
Function name
__STATIC_INLINE uint32_t
LL_I2C_IsEnabledSlaveByteControl (I2C_TypeDef * I2Cx)
Function description
Check if hardware byte control in slave mode is enabled or
disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 SBC LL_I2C_IsEnabledSlaveByteControl
LL_I2C_EnableWakeUpFromStop
Function name
__STATIC_INLINE void LL_I2C_EnableWakeUpFromStop
(I2C_TypeDef * I2Cx)
Function description
Enable Wakeup from STOP.
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
Macro IS_I2C_WAKEUP_FROMSTOP_INSTANCE(I2Cx) can
be used to check whether or not WakeUpFromStop feature is
supported by the I2Cx Instance.
This bit can only be programmed when Digital Filter is
disabled.
Reference Manual to
LL API cross
reference:
CR1 WUPEN LL_I2C_EnableWakeUpFromStop
LL_I2C_DisableWakeUpFromStop
Function name
__STATIC_INLINE void LL_I2C_DisableWakeUpFromStop
(I2C_TypeDef * I2Cx)
Function description
Disable Wakeup from STOP.
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
Macro IS_I2C_WAKEUP_FROMSTOP_INSTANCE(I2Cx) can
be used to check whether or not WakeUpFromStop feature is
supported by the I2Cx Instance.
Reference Manual to
LL API cross
reference:
CR1 WUPEN LL_I2C_DisableWakeUpFromStop
LL_I2C_IsEnabledWakeUpFromStop
Function name
__STATIC_INLINE uint32_t
LL_I2C_IsEnabledWakeUpFromStop (I2C_TypeDef * I2Cx)
DocID026525 Rev 6
853/1320
LL I2C Generic Driver
Function description
UM1785
Check if Wakeup from STOP is enabled or disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Notes
Macro IS_I2C_WAKEUP_FROMSTOP_INSTANCE(I2Cx) can
be used to check whether or not WakeUpFromStop feature is
supported by the I2Cx Instance.
Reference Manual to
LL API cross
reference:
CR1 WUPEN LL_I2C_IsEnabledWakeUpFromStop
LL_I2C_EnableGeneralCall
Function name
__STATIC_INLINE void LL_I2C_EnableGeneralCall
(I2C_TypeDef * I2Cx)
Function description
Enable General Call.
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
When enabled the Address 0x00 is ACKed.
Reference Manual to
LL API cross
reference:
CR1 GCEN LL_I2C_EnableGeneralCall
LL_I2C_DisableGeneralCall
Function name
__STATIC_INLINE void LL_I2C_DisableGeneralCall
(I2C_TypeDef * I2Cx)
Function description
Disable General Call.
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
When disabled the Address 0x00 is NACKed.
Reference Manual to
LL API cross
reference:
CR1 GCEN LL_I2C_DisableGeneralCall
LL_I2C_IsEnabledGeneralCall
854/1320
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledGeneralCall
(I2C_TypeDef * I2Cx)
Function description
Check if General Call is enabled or disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 GCEN LL_I2C_IsEnabledGeneralCall
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
LL_I2C_SetMasterAddressingMode
Function name
__STATIC_INLINE void LL_I2C_SetMasterAddressingMode
(I2C_TypeDef * I2Cx, uint32_t AddressingMode)
Function description
Configure the Master to operate in 7-bit or 10-bit addressing mode.
Parameters
I2Cx: I2C Instance.
AddressingMode: This parameter can be one of the
following values:
LL_I2C_ADDRESSING_MODE_7BIT
LL_I2C_ADDRESSING_MODE_10BIT
Return values
None
Notes
Changing this bit is not allowed, when the START bit is set.
Reference Manual to
LL API cross
reference:
CR2 ADD10 LL_I2C_SetMasterAddressingMode
LL_I2C_GetMasterAddressingMode
Function name
__STATIC_INLINE uint32_t
LL_I2C_GetMasterAddressingMode (I2C_TypeDef * I2Cx)
Function description
Get the Master addressing mode.
Parameters
I2Cx: I2C Instance.
Return values
Returned: value can be one of the following values:
LL_I2C_ADDRESSING_MODE_7BIT
LL_I2C_ADDRESSING_MODE_10BIT
Reference Manual to
LL API cross
reference:
CR2 ADD10 LL_I2C_GetMasterAddressingMode
LL_I2C_SetOwnAddress1
Function name
__STATIC_INLINE void LL_I2C_SetOwnAddress1
(I2C_TypeDef * I2Cx, uint32_t OwnAddress1, uint32_t
OwnAddrSize)
Function description
Set the Own Address1.
Parameters
I2Cx: I2C Instance.
OwnAddress1: This parameter must be a value between
Min_Data=0 and Max_Data=0x3FF.
OwnAddrSize: This parameter can be one of the following
values:
LL_I2C_OWNADDRESS1_7BIT
LL_I2C_OWNADDRESS1_10BIT
Return values
None
Reference Manual to
LL API cross
reference:
OAR1 OA1 LL_I2C_SetOwnAddress1
OAR1 OA1MODE LL_I2C_SetOwnAddress1
DocID026525 Rev 6
855/1320
LL I2C Generic Driver
UM1785
LL_I2C_EnableOwnAddress1
Function name
__STATIC_INLINE void LL_I2C_EnableOwnAddress1
(I2C_TypeDef * I2Cx)
Function description
Enable acknowledge on Own Address1 match address.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
OAR1 OA1EN LL_I2C_EnableOwnAddress1
LL_I2C_DisableOwnAddress1
Function name
__STATIC_INLINE void LL_I2C_DisableOwnAddress1
(I2C_TypeDef * I2Cx)
Function description
Disable acknowledge on Own Address1 match address.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
OAR1 OA1EN LL_I2C_DisableOwnAddress1
LL_I2C_IsEnabledOwnAddress1
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledOwnAddress1
(I2C_TypeDef * I2Cx)
Function description
Check if Own Address1 acknowledge is enabled or disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
OAR1 OA1EN LL_I2C_IsEnabledOwnAddress1
LL_I2C_SetOwnAddress2
Function name
__STATIC_INLINE void LL_I2C_SetOwnAddress2
(I2C_TypeDef * I2Cx, uint32_t OwnAddress2, uint32_t
OwnAddrMask)
Function description
Set the 7bits Own Address2.
Parameters
856/1320
I2Cx: I2C Instance.
OwnAddress2: Value between Min_Data=0 and
Max_Data=0x7F.
OwnAddrMask: This parameter can be one of the following
values:
LL_I2C_OWNADDRESS2_NOMASK
LL_I2C_OWNADDRESS2_MASK01
LL_I2C_OWNADDRESS2_MASK02
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
LL_I2C_OWNADDRESS2_MASK03
LL_I2C_OWNADDRESS2_MASK04
LL_I2C_OWNADDRESS2_MASK05
LL_I2C_OWNADDRESS2_MASK06
LL_I2C_OWNADDRESS2_MASK07
Return values
None
Notes
This action has no effect if own address2 is enabled.
Reference Manual to
LL API cross
reference:
OAR2 OA2 LL_I2C_SetOwnAddress2
OAR2 OA2MSK LL_I2C_SetOwnAddress2
LL_I2C_EnableOwnAddress2
Function name
__STATIC_INLINE void LL_I2C_EnableOwnAddress2
(I2C_TypeDef * I2Cx)
Function description
Enable acknowledge on Own Address2 match address.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
OAR2 OA2EN LL_I2C_EnableOwnAddress2
LL_I2C_DisableOwnAddress2
Function name
__STATIC_INLINE void LL_I2C_DisableOwnAddress2
(I2C_TypeDef * I2Cx)
Function description
Disable acknowledge on Own Address2 match address.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
OAR2 OA2EN LL_I2C_DisableOwnAddress2
LL_I2C_IsEnabledOwnAddress2
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledOwnAddress2
(I2C_TypeDef * I2Cx)
Function description
Check if Own Address1 acknowledge is enabled or disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
OAR2 OA2EN LL_I2C_IsEnabledOwnAddress2
DocID026525 Rev 6
857/1320
LL I2C Generic Driver
UM1785
LL_I2C_SetTiming
Function name
__STATIC_INLINE void LL_I2C_SetTiming (I2C_TypeDef *
I2Cx, uint32_t Timing)
Function description
Configure the SDA setup, hold time and the SCL high, low period.
Parameters
I2Cx: I2C Instance.
Timing: This parameter must be a value between
Min_Data=0 and Max_Data=0xFFFFFFFF.
Return values
None
Notes
This bit can only be programmed when the I2C is disabled
(PE = 0).
This parameter is computed with the STM32CubeMX Tool.
Reference Manual to
LL API cross
reference:
TIMINGR TIMINGR LL_I2C_SetTiming
LL_I2C_GetTimingPrescaler
Function name
__STATIC_INLINE uint32_t LL_I2C_GetTimingPrescaler
(I2C_TypeDef * I2Cx)
Function description
Get the Timing Prescaler setting.
Parameters
I2Cx: I2C Instance.
Return values
Value: between Min_Data=0x0 and Max_Data=0xF
Reference Manual to
LL API cross
reference:
TIMINGR PRESC LL_I2C_GetTimingPrescaler
LL_I2C_GetClockLowPeriod
Function name
__STATIC_INLINE uint32_t LL_I2C_GetClockLowPeriod
(I2C_TypeDef * I2Cx)
Function description
Get the SCL low period setting.
Parameters
I2Cx: I2C Instance.
Return values
Value: between Min_Data=0x00 and Max_Data=0xFF
Reference Manual to
LL API cross
reference:
TIMINGR SCLL LL_I2C_GetClockLowPeriod
LL_I2C_GetClockHighPeriod
858/1320
Function name
__STATIC_INLINE uint32_t LL_I2C_GetClockHighPeriod
(I2C_TypeDef * I2Cx)
Function description
Get the SCL high period setting.
Parameters
I2Cx: I2C Instance.
Return values
Value: between Min_Data=0x00 and Max_Data=0xFF
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
Reference Manual to
LL API cross
reference:
TIMINGR SCLH LL_I2C_GetClockHighPeriod
LL_I2C_GetDataHoldTime
Function name
__STATIC_INLINE uint32_t LL_I2C_GetDataHoldTime
(I2C_TypeDef * I2Cx)
Function description
Get the SDA hold time.
Parameters
I2Cx: I2C Instance.
Return values
Value: between Min_Data=0x0 and Max_Data=0xF
Reference Manual to
LL API cross
reference:
TIMINGR SDADEL LL_I2C_GetDataHoldTime
LL_I2C_GetDataSetupTime
Function name
__STATIC_INLINE uint32_t LL_I2C_GetDataSetupTime
(I2C_TypeDef * I2Cx)
Function description
Get the SDA setup time.
Parameters
I2Cx: I2C Instance.
Return values
Value: between Min_Data=0x0 and Max_Data=0xF
Reference Manual to
LL API cross
reference:
TIMINGR SCLDEL LL_I2C_GetDataSetupTime
LL_I2C_SetMode
Function name
__STATIC_INLINE void LL_I2C_SetMode (I2C_TypeDef * I2Cx,
uint32_t PeripheralMode)
Function description
Configure peripheral mode.
Parameters
I2Cx: I2C Instance.
PeripheralMode: This parameter can be one of the following
values:
LL_I2C_MODE_I2C
LL_I2C_MODE_SMBUS_HOST
LL_I2C_MODE_SMBUS_DEVICE
LL_I2C_MODE_SMBUS_DEVICE_ARP
Return values
None
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
Reference Manual to
LL API cross
reference:
CR1 SMBHEN LL_I2C_SetMode
CR1 SMBDEN LL_I2C_SetMode
DocID026525 Rev 6
859/1320
LL I2C Generic Driver
UM1785
LL_I2C_GetMode
Function name
__STATIC_INLINE uint32_t LL_I2C_GetMode (I2C_TypeDef *
I2Cx)
Function description
Get peripheral mode.
Parameters
I2Cx: I2C Instance.
Return values
Returned: value can be one of the following values:
LL_I2C_MODE_I2C
LL_I2C_MODE_SMBUS_HOST
LL_I2C_MODE_SMBUS_DEVICE
LL_I2C_MODE_SMBUS_DEVICE_ARP
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
Reference Manual to
LL API cross
reference:
CR1 SMBHEN LL_I2C_GetMode
CR1 SMBDEN LL_I2C_GetMode
LL_I2C_EnableSMBusAlert
Function name
__STATIC_INLINE void LL_I2C_EnableSMBusAlert
(I2C_TypeDef * I2Cx)
Function description
Enable SMBus alert (Host or Device mode)
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
SMBus Device mode: SMBus Alert pin is drived low and Alert
Response Address Header acknowledge is enabled. SMBus
Host mode:SMBus Alert pin management is supported.
Reference Manual to
LL API cross
reference:
CR1 ALERTEN LL_I2C_EnableSMBusAlert
LL_I2C_DisableSMBusAlert
860/1320
Function name
__STATIC_INLINE void LL_I2C_DisableSMBusAlert
(I2C_TypeDef * I2Cx)
Function description
Disable SMBus alert (Host or Device mode)
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
SMBus Device mode: SMBus Alert pin is not drived (can be
used as a standard GPIO) and Alert Response Address
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
Header acknowledge is disabled. SMBus Host mode:SMBus
Alert pin management is not supported.
Reference Manual to
LL API cross
reference:
CR1 ALERTEN LL_I2C_DisableSMBusAlert
LL_I2C_IsEnabledSMBusAlert
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledSMBusAlert
(I2C_TypeDef * I2Cx)
Function description
Check if SMBus alert (Host or Device mode) is enabled or
disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
Reference Manual to
LL API cross
reference:
CR1 ALERTEN LL_I2C_IsEnabledSMBusAlert
LL_I2C_EnableSMBusPEC
Function name
__STATIC_INLINE void LL_I2C_EnableSMBusPEC
(I2C_TypeDef * I2Cx)
Function description
Enable SMBus Packet Error Calculation (PEC).
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
Reference Manual to
LL API cross
reference:
CR1 PECEN LL_I2C_EnableSMBusPEC
LL_I2C_DisableSMBusPEC
Function name
__STATIC_INLINE void LL_I2C_DisableSMBusPEC
(I2C_TypeDef * I2Cx)
Function description
Disable SMBus Packet Error Calculation (PEC).
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
DocID026525 Rev 6
861/1320
LL I2C Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
CR1 PECEN LL_I2C_DisableSMBusPEC
LL_I2C_IsEnabledSMBusPEC
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledSMBusPEC
(I2C_TypeDef * I2Cx)
Function description
Check if SMBus Packet Error Calculation (PEC) is enabled or
disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
Reference Manual to
LL API cross
reference:
CR1 PECEN LL_I2C_IsEnabledSMBusPEC
LL_I2C_ConfigSMBusTimeout
Function name
__STATIC_INLINE void LL_I2C_ConfigSMBusTimeout
(I2C_TypeDef * I2Cx, uint32_t TimeoutA, uint32_t TimeoutAMode,
uint32_t TimeoutB)
Function
description
Configure the SMBus Clock Timeout.
Parameters
I2Cx: I2C Instance.
TimeoutA: This parameter must be a value between
Min_Data=0 and Max_Data=0xFFF.
TimeoutAMode: This parameter can be one of the following
values:
LL_I2C_SMBUS_TIMEOUTA_MODE_SCL_LOW
LL_I2C_SMBUS_TIMEOUTA_MODE_SDA_SCL_HIGH
TimeoutB:
Return values
None
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to check
whether or not SMBus feature is supported by the I2Cx Instance.
This configuration can only be programmed when associated
Timeout is disabled (TimeoutA and/orTimeoutB).
Reference
Manual to LL API
cross reference:
TIMEOUTR TIMEOUTA LL_I2C_ConfigSMBusTimeout
TIMEOUTR TIDLE LL_I2C_ConfigSMBusTimeout
TIMEOUTR TIMEOUTB LL_I2C_ConfigSMBusTimeout
LL_I2C_SetSMBusTimeoutA
862/1320
Function name
__STATIC_INLINE void LL_I2C_SetSMBusTimeoutA
(I2C_TypeDef * I2Cx, uint32_t TimeoutA)
Function description
Configure the SMBus Clock TimeoutA (SCL low timeout or SCL
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
and SDA high timeout depends on TimeoutA mode).
Parameters
I2Cx: I2C Instance.
TimeoutA: This parameter must be a value between
Min_Data=0 and Max_Data=0xFFF.
Return values
None
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
These bits can only be programmed when TimeoutA is
disabled.
Reference Manual to
LL API cross
reference:
TIMEOUTR TIMEOUTA LL_I2C_SetSMBusTimeoutA
LL_I2C_GetSMBusTimeoutA
Function name
__STATIC_INLINE uint32_t LL_I2C_GetSMBusTimeoutA
(I2C_TypeDef * I2Cx)
Function description
Get the SMBus Clock TimeoutA setting.
Parameters
I2Cx: I2C Instance.
Return values
Value: between Min_Data=0 and Max_Data=0xFFF
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
Reference Manual to
LL API cross
reference:
TIMEOUTR TIMEOUTA LL_I2C_GetSMBusTimeoutA
LL_I2C_SetSMBusTimeoutAMode
Function name
__STATIC_INLINE void LL_I2C_SetSMBusTimeoutAMode
(I2C_TypeDef * I2Cx, uint32_t TimeoutAMode)
Function
description
Set the SMBus Clock TimeoutA mode.
Parameters
I2Cx: I2C Instance.
TimeoutAMode: This parameter can be one of the following
values:
LL_I2C_SMBUS_TIMEOUTA_MODE_SCL_LOW
LL_I2C_SMBUS_TIMEOUTA_MODE_SDA_SCL_HIGH
Return values
None
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to check
whether or not SMBus feature is supported by the I2Cx Instance.
This bit can only be programmed when TimeoutA is disabled.
Reference
Manual to LL API
cross reference:
TIMEOUTR TIDLE LL_I2C_SetSMBusTimeoutAMode
DocID026525 Rev 6
863/1320
LL I2C Generic Driver
UM1785
LL_I2C_GetSMBusTimeoutAMode
Function name
__STATIC_INLINE uint32_t LL_I2C_GetSMBusTimeoutAMode
(I2C_TypeDef * I2Cx)
Function
description
Get the SMBus Clock TimeoutA mode.
Parameters
I2Cx: I2C Instance.
Return values
Returned: value can be one of the following values:
LL_I2C_SMBUS_TIMEOUTA_MODE_SCL_LOW
LL_I2C_SMBUS_TIMEOUTA_MODE_SDA_SCL_HIGH
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to check
whether or not SMBus feature is supported by the I2Cx Instance.
Reference
Manual to LL API
cross reference:
TIMEOUTR TIDLE LL_I2C_GetSMBusTimeoutAMode
LL_I2C_SetSMBusTimeoutB
Function name
__STATIC_INLINE void LL_I2C_SetSMBusTimeoutB
(I2C_TypeDef * I2Cx, uint32_t TimeoutB)
Function description
Configure the SMBus Extended Cumulative Clock TimeoutB
(Master or Slave mode).
Parameters
I2Cx: I2C Instance.
TimeoutB: This parameter must be a value between
Min_Data=0 and Max_Data=0xFFF.
Return values
None
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
These bits can only be programmed when TimeoutB is
disabled.
Reference Manual to
LL API cross
reference:
TIMEOUTR TIMEOUTB LL_I2C_SetSMBusTimeoutB
LL_I2C_GetSMBusTimeoutB
864/1320
Function name
__STATIC_INLINE uint32_t LL_I2C_GetSMBusTimeoutB
(I2C_TypeDef * I2Cx)
Function description
Get the SMBus Extented Cumulative Clock TimeoutB setting.
Parameters
I2Cx: I2C Instance.
Return values
Value: between Min_Data=0 and Max_Data=0xFFF
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
Reference Manual to
LL API cross
TIMEOUTR TIMEOUTB LL_I2C_GetSMBusTimeoutB
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
reference:
LL_I2C_EnableSMBusTimeout
Function name
__STATIC_INLINE void LL_I2C_EnableSMBusTimeout
(I2C_TypeDef * I2Cx, uint32_t ClockTimeout)
Function description
Enable the SMBus Clock Timeout.
Parameters
I2Cx: I2C Instance.
ClockTimeout: This parameter can be one of the following
values:
LL_I2C_SMBUS_TIMEOUTA
LL_I2C_SMBUS_TIMEOUTB
LL_I2C_SMBUS_ALL_TIMEOUT
Return values
None
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
Reference Manual to
LL API cross
reference:
TIMEOUTR TIMOUTEN LL_I2C_EnableSMBusTimeout
TIMEOUTR TEXTEN LL_I2C_EnableSMBusTimeout
LL_I2C_DisableSMBusTimeout
Function name
__STATIC_INLINE void LL_I2C_DisableSMBusTimeout
(I2C_TypeDef * I2Cx, uint32_t ClockTimeout)
Function description
Disable the SMBus Clock Timeout.
Parameters
I2Cx: I2C Instance.
ClockTimeout: This parameter can be one of the following
values:
LL_I2C_SMBUS_TIMEOUTA
LL_I2C_SMBUS_TIMEOUTB
LL_I2C_SMBUS_ALL_TIMEOUT
Return values
None
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
Reference Manual to
LL API cross
reference:
TIMEOUTR TIMOUTEN LL_I2C_DisableSMBusTimeout
TIMEOUTR TEXTEN LL_I2C_DisableSMBusTimeout
LL_I2C_IsEnabledSMBusTimeout
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledSMBusTimeout
(I2C_TypeDef * I2Cx, uint32_t ClockTimeout)
Function description
Check if the SMBus Clock Timeout is enabled or disabled.
Parameters
I2Cx: I2C Instance.
ClockTimeout: This parameter can be one of the following
values:
DocID026525 Rev 6
865/1320
LL I2C Generic Driver
UM1785
LL_I2C_SMBUS_TIMEOUTA
LL_I2C_SMBUS_TIMEOUTB
LL_I2C_SMBUS_ALL_TIMEOUT
Return values
State: of bit (1 or 0).
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
Reference Manual to
LL API cross
reference:
TIMEOUTR TIMOUTEN LL_I2C_IsEnabledSMBusTimeout
TIMEOUTR TEXTEN LL_I2C_IsEnabledSMBusTimeout
LL_I2C_EnableIT_TX
Function name
__STATIC_INLINE void LL_I2C_EnableIT_TX (I2C_TypeDef *
I2Cx)
Function description
Enable TXIS interrupt.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
CR1 TXIE LL_I2C_EnableIT_TX
LL_I2C_DisableIT_TX
Function name
__STATIC_INLINE void LL_I2C_DisableIT_TX (I2C_TypeDef *
I2Cx)
Function description
Disable TXIS interrupt.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
CR1 TXIE LL_I2C_DisableIT_TX
LL_I2C_IsEnabledIT_TX
866/1320
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledIT_TX
(I2C_TypeDef * I2Cx)
Function description
Check if the TXIS Interrupt is enabled or disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 TXIE LL_I2C_IsEnabledIT_TX
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
LL_I2C_EnableIT_RX
Function name
__STATIC_INLINE void LL_I2C_EnableIT_RX (I2C_TypeDef *
I2Cx)
Function description
Enable RXNE interrupt.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
CR1 RXIE LL_I2C_EnableIT_RX
LL_I2C_DisableIT_RX
Function name
__STATIC_INLINE void LL_I2C_DisableIT_RX (I2C_TypeDef *
I2Cx)
Function description
Disable RXNE interrupt.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
CR1 RXIE LL_I2C_DisableIT_RX
LL_I2C_IsEnabledIT_RX
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledIT_RX
(I2C_TypeDef * I2Cx)
Function description
Check if the RXNE Interrupt is enabled or disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 RXIE LL_I2C_IsEnabledIT_RX
LL_I2C_EnableIT_ADDR
Function name
__STATIC_INLINE void LL_I2C_EnableIT_ADDR (I2C_TypeDef
* I2Cx)
Function description
Enable Address match interrupt (slave mode only).
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
CR1 ADDRIE LL_I2C_EnableIT_ADDR
DocID026525 Rev 6
867/1320
LL I2C Generic Driver
UM1785
LL_I2C_DisableIT_ADDR
Function name
__STATIC_INLINE void LL_I2C_DisableIT_ADDR (I2C_TypeDef
* I2Cx)
Function description
Disable Address match interrupt (slave mode only).
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
CR1 ADDRIE LL_I2C_DisableIT_ADDR
LL_I2C_IsEnabledIT_ADDR
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledIT_ADDR
(I2C_TypeDef * I2Cx)
Function description
Check if Address match interrupt is enabled or disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 ADDRIE LL_I2C_IsEnabledIT_ADDR
LL_I2C_EnableIT_NACK
Function name
__STATIC_INLINE void LL_I2C_EnableIT_NACK (I2C_TypeDef
* I2Cx)
Function description
Enable Not acknowledge received interrupt.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
CR1 NACKIE LL_I2C_EnableIT_NACK
LL_I2C_DisableIT_NACK
868/1320
Function name
__STATIC_INLINE void LL_I2C_DisableIT_NACK (I2C_TypeDef
* I2Cx)
Function description
Disable Not acknowledge received interrupt.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
CR1 NACKIE LL_I2C_DisableIT_NACK
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
LL_I2C_IsEnabledIT_NACK
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledIT_NACK
(I2C_TypeDef * I2Cx)
Function description
Check if Not acknowledge received interrupt is enabled or
disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 NACKIE LL_I2C_IsEnabledIT_NACK
LL_I2C_EnableIT_STOP
Function name
__STATIC_INLINE void LL_I2C_EnableIT_STOP (I2C_TypeDef
* I2Cx)
Function description
Enable STOP detection interrupt.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
CR1 STOPIE LL_I2C_EnableIT_STOP
LL_I2C_DisableIT_STOP
Function name
__STATIC_INLINE void LL_I2C_DisableIT_STOP (I2C_TypeDef
* I2Cx)
Function description
Disable STOP detection interrupt.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
CR1 STOPIE LL_I2C_DisableIT_STOP
LL_I2C_IsEnabledIT_STOP
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledIT_STOP
(I2C_TypeDef * I2Cx)
Function description
Check if STOP detection interrupt is enabled or disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 STOPIE LL_I2C_IsEnabledIT_STOP
DocID026525 Rev 6
869/1320
LL I2C Generic Driver
UM1785
LL_I2C_EnableIT_TC
Function name
__STATIC_INLINE void LL_I2C_EnableIT_TC (I2C_TypeDef *
I2Cx)
Function description
Enable Transfer Complete interrupt.
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
Any of these events will generate interrupt : Transfer
Complete (TC) Transfer Complete Reload (TCR)
Reference Manual to
LL API cross
reference:
CR1 TCIE LL_I2C_EnableIT_TC
LL_I2C_DisableIT_TC
Function name
__STATIC_INLINE void LL_I2C_DisableIT_TC (I2C_TypeDef *
I2Cx)
Function description
Disable Transfer Complete interrupt.
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
Any of these events will generate interrupt : Transfer
Complete (TC) Transfer Complete Reload (TCR)
Reference Manual to
LL API cross
reference:
CR1 TCIE LL_I2C_DisableIT_TC
LL_I2C_IsEnabledIT_TC
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledIT_TC
(I2C_TypeDef * I2Cx)
Function description
Check if Transfer Complete interrupt is enabled or disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 TCIE LL_I2C_IsEnabledIT_TC
LL_I2C_EnableIT_ERR
870/1320
Function name
__STATIC_INLINE void LL_I2C_EnableIT_ERR (I2C_TypeDef *
I2Cx)
Function description
Enable Error interrupts.
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
check whether or not SMBus feature is supported by the I2Cx
Instance.
Any of these errors will generate interrupt : Arbitration Loss
(ARLO) Bus Error detection (BERR) Overrun/Underrun (OVR)
SMBus Timeout detection (TIMEOUT) SMBus PEC error
detection (PECERR) SMBus Alert pin event detection
(ALERT)
Reference Manual to
LL API cross
reference:
CR1 ERRIE LL_I2C_EnableIT_ERR
LL_I2C_DisableIT_ERR
Function name
__STATIC_INLINE void LL_I2C_DisableIT_ERR (I2C_TypeDef *
I2Cx)
Function description
Disable Error interrupts.
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
Any of these errors will generate interrupt : Arbitration Loss
(ARLO) Bus Error detection (BERR) Overrun/Underrun (OVR)
SMBus Timeout detection (TIMEOUT) SMBus PEC error
detection (PECERR) SMBus Alert pin event detection
(ALERT)
Reference Manual to
LL API cross
reference:
CR1 ERRIE LL_I2C_DisableIT_ERR
LL_I2C_IsEnabledIT_ERR
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledIT_ERR
(I2C_TypeDef * I2Cx)
Function description
Check if Error interrupts are enabled or disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 ERRIE LL_I2C_IsEnabledIT_ERR
LL_I2C_IsActiveFlag_TXE
Function name
__STATIC_INLINE uint32_t LL_I2C_IsActiveFlag_TXE
(I2C_TypeDef * I2Cx)
Function description
Indicate the status of Transmit data register empty flag.
Parameters
I2Cx: I2C Instance.
DocID026525 Rev 6
871/1320
LL I2C Generic Driver
Return values
UM1785
State: of bit (1 or 0).
Notes
RESET: When next data is written in Transmit data register.
SET: When Transmit data register is empty.
Reference Manual to
LL API cross
reference:
ISR TXE LL_I2C_IsActiveFlag_TXE
LL_I2C_IsActiveFlag_TXIS
Function name
__STATIC_INLINE uint32_t LL_I2C_IsActiveFlag_TXIS
(I2C_TypeDef * I2Cx)
Function description
Indicate the status of Transmit interrupt flag.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Notes
RESET: When next data is written in Transmit data register.
SET: When Transmit data register is empty.
Reference Manual to
LL API cross
reference:
ISR TXIS LL_I2C_IsActiveFlag_TXIS
LL_I2C_IsActiveFlag_RXNE
Function name
__STATIC_INLINE uint32_t LL_I2C_IsActiveFlag_RXNE
(I2C_TypeDef * I2Cx)
Function description
Indicate the status of Receive data register not empty flag.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Notes
RESET: When Receive data register is read. SET: When the
received data is copied in Receive data register.
Reference Manual to
LL API cross
reference:
ISR RXNE LL_I2C_IsActiveFlag_RXNE
LL_I2C_IsActiveFlag_ADDR
872/1320
Function name
__STATIC_INLINE uint32_t LL_I2C_IsActiveFlag_ADDR
(I2C_TypeDef * I2Cx)
Function description
Indicate the status of Address matched flag (slave mode).
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Notes
RESET: Clear default value. SET: When the received slave
address matched with one of the enabled slave address.
Reference Manual to
LL API cross
reference:
ISR ADDR LL_I2C_IsActiveFlag_ADDR
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
LL_I2C_IsActiveFlag_NACK
Function name
__STATIC_INLINE uint32_t LL_I2C_IsActiveFlag_NACK
(I2C_TypeDef * I2Cx)
Function description
Indicate the status of Not Acknowledge received flag.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Notes
RESET: Clear default value. SET: When a NACK is received
after a byte transmission.
Reference Manual to
LL API cross
reference:
ISR NACKF LL_I2C_IsActiveFlag_NACK
LL_I2C_IsActiveFlag_STOP
Function name
__STATIC_INLINE uint32_t LL_I2C_IsActiveFlag_STOP
(I2C_TypeDef * I2Cx)
Function description
Indicate the status of Stop detection flag.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Notes
RESET: Clear default value. SET: When a Stop condition is
detected.
Reference Manual to
LL API cross
reference:
ISR STOPF LL_I2C_IsActiveFlag_STOP
LL_I2C_IsActiveFlag_TC
Function name
__STATIC_INLINE uint32_t LL_I2C_IsActiveFlag_TC
(I2C_TypeDef * I2Cx)
Function description
Indicate the status of Transfer complete flag (master mode).
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Notes
RESET: Clear default value. SET: When RELOAD=0,
AUTOEND=0 and NBYTES date have been transferred.
Reference Manual to
LL API cross
reference:
ISR TC LL_I2C_IsActiveFlag_TC
LL_I2C_IsActiveFlag_TCR
Function name
__STATIC_INLINE uint32_t LL_I2C_IsActiveFlag_TCR
(I2C_TypeDef * I2Cx)
Function description
Indicate the status of Transfer complete flag (master mode).
Parameters
I2Cx: I2C Instance.
DocID026525 Rev 6
873/1320
LL I2C Generic Driver
Return values
UM1785
State: of bit (1 or 0).
Notes
RESET: Clear default value. SET: When RELOAD=1 and
NBYTES date have been transferred.
Reference Manual to
LL API cross
reference:
ISR TCR LL_I2C_IsActiveFlag_TCR
LL_I2C_IsActiveFlag_BERR
Function name
__STATIC_INLINE uint32_t LL_I2C_IsActiveFlag_BERR
(I2C_TypeDef * I2Cx)
Function description
Indicate the status of Bus error flag.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Notes
RESET: Clear default value. SET: When a misplaced Start or
Stop condition is detected.
Reference Manual to
LL API cross
reference:
ISR BERR LL_I2C_IsActiveFlag_BERR
LL_I2C_IsActiveFlag_ARLO
Function name
__STATIC_INLINE uint32_t LL_I2C_IsActiveFlag_ARLO
(I2C_TypeDef * I2Cx)
Function description
Indicate the status of Arbitration lost flag.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Notes
RESET: Clear default value. SET: When arbitration lost.
Reference Manual to
LL API cross
reference:
ISR ARLO LL_I2C_IsActiveFlag_ARLO
LL_I2C_IsActiveFlag_OVR
874/1320
Function name
__STATIC_INLINE uint32_t LL_I2C_IsActiveFlag_OVR
(I2C_TypeDef * I2Cx)
Function description
Indicate the status of Overrun/Underrun flag (slave mode).
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Notes
RESET: Clear default value. SET: When an overrun/underrun
error occurs (Clock Stretching Disabled).
Reference Manual to
LL API cross
reference:
ISR OVR LL_I2C_IsActiveFlag_OVR
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
LL_I2C_IsActiveSMBusFlag_PECERR
Function name
__STATIC_INLINE uint32_t
LL_I2C_IsActiveSMBusFlag_PECERR (I2C_TypeDef * I2Cx)
Function description
Indicate the status of SMBus PEC error flag in reception.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
RESET: Clear default value. SET: When the received PEC
does not match with the PEC register content.
Reference Manual to
LL API cross
reference:
ISR PECERR LL_I2C_IsActiveSMBusFlag_PECERR
LL_I2C_IsActiveSMBusFlag_TIMEOUT
Function name
__STATIC_INLINE uint32_t
LL_I2C_IsActiveSMBusFlag_TIMEOUT (I2C_TypeDef * I2Cx)
Function description
Indicate the status of SMBus Timeout detection flag.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
RESET: Clear default value. SET: When a timeout or
extended clock timeout occurs.
Reference Manual to
LL API cross
reference:
ISR TIMEOUT LL_I2C_IsActiveSMBusFlag_TIMEOUT
LL_I2C_IsActiveSMBusFlag_ALERT
Function name
__STATIC_INLINE uint32_t
LL_I2C_IsActiveSMBusFlag_ALERT (I2C_TypeDef * I2Cx)
Function description
Indicate the status of SMBus alert flag.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
RESET: Clear default value. SET: When SMBus host
configuration, SMBus alert enabled and a falling edge event
occurs on SMBA pin.
Reference Manual to
LL API cross
ISR ALERT LL_I2C_IsActiveSMBusFlag_ALERT
DocID026525 Rev 6
875/1320
LL I2C Generic Driver
reference:
UM1785
LL_I2C_IsActiveFlag_BUSY
Function name
__STATIC_INLINE uint32_t LL_I2C_IsActiveFlag_BUSY
(I2C_TypeDef * I2Cx)
Function description
Indicate the status of Bus Busy flag.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Notes
RESET: Clear default value. SET: When a Start condition is
detected.
Reference Manual to
LL API cross
reference:
ISR BUSY LL_I2C_IsActiveFlag_BUSY
LL_I2C_ClearFlag_ADDR
Function name
__STATIC_INLINE void LL_I2C_ClearFlag_ADDR
(I2C_TypeDef * I2Cx)
Function description
Clear Address Matched flag.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
ICR ADDRCF LL_I2C_ClearFlag_ADDR
LL_I2C_ClearFlag_NACK
Function name
__STATIC_INLINE void LL_I2C_ClearFlag_NACK
(I2C_TypeDef * I2Cx)
Function description
Clear Not Acknowledge flag.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
ICR NACKCF LL_I2C_ClearFlag_NACK
LL_I2C_ClearFlag_STOP
876/1320
Function name
__STATIC_INLINE void LL_I2C_ClearFlag_STOP (I2C_TypeDef
* I2Cx)
Function description
Clear Stop detection flag.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
ICR STOPCF LL_I2C_ClearFlag_STOP
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
LL API cross
reference:
LL_I2C_ClearFlag_TXE
Function name
__STATIC_INLINE void LL_I2C_ClearFlag_TXE (I2C_TypeDef *
I2Cx)
Function description
Clear Transmit data register empty flag (TXE).
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
This bit can be clear by software in order to flush the transmit
data register (TXDR).
Reference Manual to
LL API cross
reference:
ISR TXE LL_I2C_ClearFlag_TXE
LL_I2C_ClearFlag_BERR
Function name
__STATIC_INLINE void LL_I2C_ClearFlag_BERR
(I2C_TypeDef * I2Cx)
Function description
Clear Bus error flag.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
ICR BERRCF LL_I2C_ClearFlag_BERR
LL_I2C_ClearFlag_ARLO
Function name
__STATIC_INLINE void LL_I2C_ClearFlag_ARLO
(I2C_TypeDef * I2Cx)
Function description
Clear Arbitration lost flag.
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
ICR ARLOCF LL_I2C_ClearFlag_ARLO
LL_I2C_ClearFlag_OVR
Function name
__STATIC_INLINE void LL_I2C_ClearFlag_OVR (I2C_TypeDef
* I2Cx)
Function description
Clear Overrun/Underrun flag.
Parameters
I2Cx: I2C Instance.
Return values
None
DocID026525 Rev 6
877/1320
LL I2C Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
ICR OVRCF LL_I2C_ClearFlag_OVR
LL_I2C_ClearSMBusFlag_PECERR
Function name
__STATIC_INLINE void LL_I2C_ClearSMBusFlag_PECERR
(I2C_TypeDef * I2Cx)
Function description
Clear SMBus PEC error flag.
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
Reference Manual to
LL API cross
reference:
ICR PECCF LL_I2C_ClearSMBusFlag_PECERR
LL_I2C_ClearSMBusFlag_TIMEOUT
Function name
__STATIC_INLINE void LL_I2C_ClearSMBusFlag_TIMEOUT
(I2C_TypeDef * I2Cx)
Function description
Clear SMBus Timeout detection flag.
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
Reference Manual to
LL API cross
reference:
ICR TIMOUTCF LL_I2C_ClearSMBusFlag_TIMEOUT
LL_I2C_ClearSMBusFlag_ALERT
878/1320
Function name
__STATIC_INLINE void LL_I2C_ClearSMBusFlag_ALERT
(I2C_TypeDef * I2Cx)
Function description
Clear SMBus Alert flag.
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
Reference Manual to
LL API cross
reference:
ICR ALERTCF LL_I2C_ClearSMBusFlag_ALERT
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
LL_I2C_EnableAutoEndMode
Function name
__STATIC_INLINE void LL_I2C_EnableAutoEndMode
(I2C_TypeDef * I2Cx)
Function description
Enable automatic STOP condition generation (master mode).
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
Automatic end mode : a STOP condition is automatically sent
when NBYTES data are transferred. This bit has no effect in
slave mode or when RELOAD bit is set.
Reference Manual to
LL API cross
reference:
CR2 AUTOEND LL_I2C_EnableAutoEndMode
LL_I2C_DisableAutoEndMode
Function name
__STATIC_INLINE void LL_I2C_DisableAutoEndMode
(I2C_TypeDef * I2Cx)
Function description
Disable automatic STOP condition generation (master mode).
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
Software end mode : TC flag is set when NBYTES data are
transferre, stretching SCL low.
Reference Manual to
LL API cross
reference:
CR2 AUTOEND LL_I2C_DisableAutoEndMode
LL_I2C_IsEnabledAutoEndMode
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledAutoEndMode
(I2C_TypeDef * I2Cx)
Function description
Check if automatic STOP condition is enabled or disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR2 AUTOEND LL_I2C_IsEnabledAutoEndMode
LL_I2C_EnableReloadMode
Function name
__STATIC_INLINE void LL_I2C_EnableReloadMode
(I2C_TypeDef * I2Cx)
Function description
Enable reload mode (master mode).
Parameters
I2Cx: I2C Instance.
Return values
None
DocID026525 Rev 6
879/1320
LL I2C Generic Driver
Notes
UM1785
The transfer is not completed after the NBYTES data transfer,
NBYTES will be reloaded when TCR flag is set.
Reference Manual to
LL API cross
reference:
CR2 RELOAD LL_I2C_EnableReloadMode
LL_I2C_DisableReloadMode
Function name
__STATIC_INLINE void LL_I2C_DisableReloadMode
(I2C_TypeDef * I2Cx)
Function description
Disable reload mode (master mode).
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
The transfer is completed after the NBYTES data
transfer(STOP or RESTART will follow).
Reference Manual to
LL API cross
reference:
CR2 RELOAD LL_I2C_DisableReloadMode
LL_I2C_IsEnabledReloadMode
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledReloadMode
(I2C_TypeDef * I2Cx)
Function description
Check if reload mode is enabled or disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR2 RELOAD LL_I2C_IsEnabledReloadMode
LL_I2C_SetTransferSize
880/1320
Function name
__STATIC_INLINE void LL_I2C_SetTransferSize (I2C_TypeDef
* I2Cx, uint32_t TransferSize)
Function description
Configure the number of bytes for transfer.
Parameters
I2Cx: I2C Instance.
TransferSize: This parameter must be a value between
Min_Data=0x00 and Max_Data=0xFF.
Return values
None
Notes
Changing these bits when START bit is set is not allowed.
Reference Manual to
LL API cross
reference:
CR2 NBYTES LL_I2C_SetTransferSize
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
LL_I2C_GetTransferSize
Function name
__STATIC_INLINE uint32_t LL_I2C_GetTransferSize
(I2C_TypeDef * I2Cx)
Function description
Get the number of bytes configured for transfer.
Parameters
I2Cx: I2C Instance.
Return values
Value: between Min_Data=0x0 and Max_Data=0xFF
Reference Manual to
LL API cross
reference:
CR2 NBYTES LL_I2C_GetTransferSize
LL_I2C_AcknowledgeNextData
Function name
__STATIC_INLINE void LL_I2C_AcknowledgeNextData
(I2C_TypeDef * I2Cx, uint32_t TypeAcknowledge)
Function description
Prepare the generation of a ACKnowledge or Non ACKnowledge
condition after the address receive match code or next received
byte.
Parameters
I2Cx: I2C Instance.
TypeAcknowledge: This parameter can be one of the
following values:
LL_I2C_ACK
LL_I2C_NACK
Return values
None
Notes
Usage in Slave mode only.
Reference Manual to
LL API cross
reference:
CR2 NACK LL_I2C_AcknowledgeNextData
LL_I2C_GenerateStartCondition
Function name
__STATIC_INLINE void LL_I2C_GenerateStartCondition
(I2C_TypeDef * I2Cx)
Function description
Generate a START or RESTART condition.
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
The START bit can be set even if bus is BUSY or I2C is in
slave mode. This action has no effect when RELOAD is set.
Reference Manual to
LL API cross
reference:
CR2 START LL_I2C_GenerateStartCondition
LL_I2C_GenerateStopCondition
Function name
__STATIC_INLINE void LL_I2C_GenerateStopCondition
(I2C_TypeDef * I2Cx)
DocID026525 Rev 6
881/1320
LL I2C Generic Driver
Function description
UM1785
Generate a STOP condition after the current byte transfer (master
mode).
Parameters
I2Cx: I2C Instance.
Return values
None
Reference Manual to
LL API cross
reference:
CR2 STOP LL_I2C_GenerateStopCondition
LL_I2C_EnableAuto10BitRead
Function name
__STATIC_INLINE void LL_I2C_EnableAuto10BitRead
(I2C_TypeDef * I2Cx)
Function description
Enable automatic RESTART Read request condition for 10bit
address header (master mode).
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
The master sends the complete 10bit slave address read
sequence : Start + 2 bytes 10bit address in Write direction +
Restart + first 7 bits of 10bit address in Read direction.
Reference Manual to
LL API cross
reference:
CR2 HEAD10R LL_I2C_EnableAuto10BitRead
LL_I2C_DisableAuto10BitRead
Function name
__STATIC_INLINE void LL_I2C_DisableAuto10BitRead
(I2C_TypeDef * I2Cx)
Function description
Disable automatic RESTART Read request condition for 10bit
address header (master mode).
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
The master only sends the first 7 bits of 10bit address in Read
direction.
Reference Manual to
LL API cross
reference:
CR2 HEAD10R LL_I2C_DisableAuto10BitRead
LL_I2C_IsEnabledAuto10BitRead
882/1320
Function name
__STATIC_INLINE uint32_t LL_I2C_IsEnabledAuto10BitRead
(I2C_TypeDef * I2Cx)
Function description
Check if automatic RESTART Read request condition for 10bit
address header is enabled or disabled.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
Reference Manual to
LL API cross
reference:
CR2 HEAD10R LL_I2C_IsEnabledAuto10BitRead
LL_I2C_SetTransferRequest
Function name
__STATIC_INLINE void LL_I2C_SetTransferRequest
(I2C_TypeDef * I2Cx, uint32_t TransferRequest)
Function description
Configure the transfer direction (master mode).
Parameters
I2Cx: I2C Instance.
TransferRequest: This parameter can be one of the
following values:
LL_I2C_REQUEST_WRITE
LL_I2C_REQUEST_READ
Return values
None
Notes
Changing these bits when START bit is set is not allowed.
Reference Manual to
LL API cross
reference:
CR2 RD_WRN LL_I2C_SetTransferRequest
LL_I2C_GetTransferRequest
Function name
__STATIC_INLINE uint32_t LL_I2C_GetTransferRequest
(I2C_TypeDef * I2Cx)
Function description
Get the transfer direction requested (master mode).
Parameters
I2Cx: I2C Instance.
Return values
Returned: value can be one of the following values:
LL_I2C_REQUEST_WRITE
LL_I2C_REQUEST_READ
Reference Manual to
LL API cross
reference:
CR2 RD_WRN LL_I2C_GetTransferRequest
LL_I2C_SetSlaveAddr
Function name
__STATIC_INLINE void LL_I2C_SetSlaveAddr (I2C_TypeDef *
I2Cx, uint32_t SlaveAddr)
Function description
Configure the slave address for transfer (master mode).
Parameters
I2Cx: I2C Instance.
SlaveAddr: This parameter must be a value between
Min_Data=0x00 and Max_Data=0x3F.
Return values
None
Notes
Changing these bits when START bit is set is not allowed.
Reference Manual to
LL API cross
reference:
CR2 SADD LL_I2C_SetSlaveAddr
DocID026525 Rev 6
883/1320
LL I2C Generic Driver
UM1785
LL_I2C_GetSlaveAddr
Function name
__STATIC_INLINE uint32_t LL_I2C_GetSlaveAddr
(I2C_TypeDef * I2Cx)
Function description
Get the slave address programmed for transfer.
Parameters
I2Cx: I2C Instance.
Return values
Value: between Min_Data=0x0 and Max_Data=0x3F
Reference Manual to
LL API cross
reference:
CR2 SADD LL_I2C_GetSlaveAddr
LL_I2C_HandleTransfer
884/1320
Function name
__STATIC_INLINE void LL_I2C_HandleTransfer (I2C_TypeDef
* I2Cx, uint32_t SlaveAddr, uint32_t SlaveAddrSize, uint32_t
TransferSize, uint32_t EndMode, uint32_t Request)
Function description
Handles I2Cx communication when starting transfer or during
transfer (TC or TCR flag are set).
Parameters
I2Cx: I2C Instance.
SlaveAddr: Specifies the slave address to be programmed.
SlaveAddrSize: This parameter can be one of the following
values:
LL_I2C_ADDRSLAVE_7BIT
LL_I2C_ADDRSLAVE_10BIT
TransferSize: Specifies the number of bytes to be
programmed. This parameter must be a value between
Min_Data=0 and Max_Data=255.
EndMode: This parameter can be one of the following
values:
LL_I2C_MODE_RELOAD
LL_I2C_MODE_AUTOEND
LL_I2C_MODE_SOFTEND
LL_I2C_MODE_SMBUS_RELOAD
LL_I2C_MODE_SMBUS_AUTOEND_NO_PEC
LL_I2C_MODE_SMBUS_SOFTEND_NO_PEC
LL_I2C_MODE_SMBUS_AUTOEND_WITH_PEC
LL_I2C_MODE_SMBUS_SOFTEND_WITH_PEC
Request: This parameter can be one of the following values:
LL_I2C_GENERATE_NOSTARTSTOP
LL_I2C_GENERATE_STOP
LL_I2C_GENERATE_START_READ
LL_I2C_GENERATE_START_WRITE
LL_I2C_GENERATE_RESTART_7BIT_READ
LL_I2C_GENERATE_RESTART_7BIT_WRITE
LL_I2C_GENERATE_RESTART_10BIT_READ
LL_I2C_GENERATE_RESTART_10BIT_WRITE
Return values
None
Reference Manual to
LL API cross
CR2 SADD LL_I2C_HandleTransfer
CR2 ADD10 LL_I2C_HandleTransfer
CR2 RD_WRN LL_I2C_HandleTransfer
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
reference:
CR2 START LL_I2C_HandleTransfer
CR2 STOP LL_I2C_HandleTransfer
CR2 RELOAD LL_I2C_HandleTransfer
CR2 NBYTES LL_I2C_HandleTransfer
CR2 AUTOEND LL_I2C_HandleTransfer
CR2 HEAD10R LL_I2C_HandleTransfer
LL_I2C_GetTransferDirection
Function name
__STATIC_INLINE uint32_t LL_I2C_GetTransferDirection
(I2C_TypeDef * I2Cx)
Function description
Indicate the value of transfer direction (slave mode).
Parameters
I2Cx: I2C Instance.
Return values
Returned: value can be one of the following values:
LL_I2C_DIRECTION_WRITE
LL_I2C_DIRECTION_READ
Notes
RESET: Write transfer, Slave enters in receiver mode. SET:
Read transfer, Slave enters in transmitter mode.
Reference Manual to
LL API cross
reference:
ISR DIR LL_I2C_GetTransferDirection
LL_I2C_GetAddressMatchCode
Function name
__STATIC_INLINE uint32_t LL_I2C_GetAddressMatchCode
(I2C_TypeDef * I2Cx)
Function description
Return the slave matched address.
Parameters
I2Cx: I2C Instance.
Return values
Value: between Min_Data=0x00 and Max_Data=0x3F
Reference Manual to
LL API cross
reference:
ISR ADDCODE LL_I2C_GetAddressMatchCode
LL_I2C_EnableSMBusPECCompare
Function name
__STATIC_INLINE void LL_I2C_EnableSMBusPECCompare
(I2C_TypeDef * I2Cx)
Function description
Enable internal comparison of the SMBus Packet Error byte
(transmission or reception mode).
Parameters
I2Cx: I2C Instance.
Return values
None
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
This feature is cleared by hardware when the PEC byte is
transferred, or when a STOP condition or an Address
Matched is received. This bit has no effect when RELOAD bit
DocID026525 Rev 6
885/1320
LL I2C Generic Driver
UM1785
is set. This bit has no effect in device mode when SBC bit is
not set.
Reference Manual to
LL API cross
reference:
CR2 PECBYTE LL_I2C_EnableSMBusPECCompare
LL_I2C_IsEnabledSMBusPECCompare
Function name
__STATIC_INLINE uint32_t
LL_I2C_IsEnabledSMBusPECCompare (I2C_TypeDef * I2Cx)
Function description
Check if the SMBus Packet Error byte internal comparison is
requested or not.
Parameters
I2Cx: I2C Instance.
Return values
State: of bit (1 or 0).
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
Reference Manual to
LL API cross
reference:
CR2 PECBYTE LL_I2C_IsEnabledSMBusPECCompare
LL_I2C_GetSMBusPEC
Function name
__STATIC_INLINE uint32_t LL_I2C_GetSMBusPEC
(I2C_TypeDef * I2Cx)
Function description
Get the SMBus Packet Error byte calculated.
Parameters
I2Cx: I2C Instance.
Return values
Value: between Min_Data=0x00 and Max_Data=0xFF
Notes
Macro IS_SMBUS_ALL_INSTANCE(I2Cx) can be used to
check whether or not SMBus feature is supported by the I2Cx
Instance.
Reference Manual to
LL API cross
reference:
PECR PEC LL_I2C_GetSMBusPEC
LL_I2C_ReceiveData8
886/1320
Function name
__STATIC_INLINE uint8_t LL_I2C_ReceiveData8 (I2C_TypeDef
* I2Cx)
Function description
Read Receive Data register.
Parameters
I2Cx: I2C Instance.
Return values
Value: between Min_Data=0x00 and Max_Data=0xFF
Reference Manual to
LL API cross
reference:
RXDR RXDATA LL_I2C_ReceiveData8
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
LL_I2C_TransmitData8
Function name
__STATIC_INLINE void LL_I2C_TransmitData8 (I2C_TypeDef *
I2Cx, uint8_t Data)
Function description
Write in Transmit Data Register .
Parameters
I2Cx: I2C Instance.
Data: Value between Min_Data=0x00 and Max_Data=0xFF
Return values
None
Reference Manual to
LL API cross
reference:
TXDR TXDATA LL_I2C_TransmitData8
LL_I2C_Init
Function name
uint32_t LL_I2C_Init (I2C_TypeDef * I2Cx, LL_I2C_InitTypeDef
* I2C_InitStruct)
Function description
Initialize the I2C registers according to the specified parameters in
I2C_InitStruct.
Parameters
I2Cx: I2C Instance.
I2C_InitStruct: pointer to a LL_I2C_InitTypeDef structure.
Return values
An: ErrorStatus enumeration value:
SUCCESS: I2C registers are initialized
ERROR: Not applicable
LL_I2C_DeInit
Function name
uint32_t LL_I2C_DeInit (I2C_TypeDef * I2Cx)
Function description
De-initialize the I2C registers to their default reset values.
Parameters
I2Cx: I2C Instance.
Return values
An: ErrorStatus enumeration value:
SUCCESS: I2C registers are de-initialized
ERROR: I2C registers are not de-initialized
LL_I2C_StructInit
Function name
void LL_I2C_StructInit (LL_I2C_InitTypeDef * I2C_InitStruct)
Function description
Set each LL_I2C_InitTypeDef field to default value.
Parameters
I2C_InitStruct: Pointer to a LL_I2C_InitTypeDef structure.
Return values
None
59.3
I2C Firmware driver defines
59.3.1
I2C
Master Addressing Mode
LL_I2C_ADDRESSING_MODE_7BIT
Master operates in 7-bit addressing mode.
DocID026525 Rev 6
887/1320
LL I2C Generic Driver
LL_I2C_ADDRESSING_MODE_10BIT
UM1785
Master operates in 10-bit addressing mode.
Slave Address Length
LL_I2C_ADDRSLAVE_7BIT
Slave Address in 7-bit.
LL_I2C_ADDRSLAVE_10BIT
Slave Address in 10-bit.
Analog Filter Selection
LL_I2C_ANALOGFILTER_ENABLE
Analog filter is enabled.
LL_I2C_ANALOGFILTER_DISABLE
Analog filter is disabled.
Clear Flags Defines
LL_I2C_ICR_ADDRCF
Address Matched flag
LL_I2C_ICR_NACKCF
Not Acknowledge flag
LL_I2C_ICR_STOPCF
Stop detection flag
LL_I2C_ICR_BERRCF
Bus error flag
LL_I2C_ICR_ARLOCF
Arbitration Lost flag
LL_I2C_ICR_OVRCF
Overrun/Underrun flag
LL_I2C_ICR_PECCF
PEC error flag
LL_I2C_ICR_TIMOUTCF
Timeout detection flag
LL_I2C_ICR_ALERTCF
Alert flag
Read Write Direction
LL_I2C_DIRECTION_WRITE
Write transfer request by master, slave enters receiver
mode.
LL_I2C_DIRECTION_READ
Read transfer request by master, slave enters transmitter
mode.
DMA Register Data
LL_I2C_DMA_REG_DATA_TRANSMIT
Get address of data register used for
transmission
LL_I2C_DMA_REG_DATA_RECEIVE
Get address of data register used for reception
Start And Stop Generation
888/1320
LL_I2C_GENERATE_NOSTARTSTOP
Don't Generate Stop and Start
condition.
LL_I2C_GENERATE_STOP
Generate Stop condition (Size should
be set to 0).
LL_I2C_GENERATE_START_READ
Generate Start for read request.
LL_I2C_GENERATE_START_WRITE
Generate Start for write request.
LL_I2C_GENERATE_RESTART_7BIT_READ
Generate Restart for read request,
slave 7Bit address.
LL_I2C_GENERATE_RESTART_7BIT_WRITE
Generate Restart for write request,
slave 7Bit address.
LL_I2C_GENERATE_RESTART_10BIT_READ
Generate Restart for read request,
slave 10Bit address.
DocID026525 Rev 6
UM1785
LL_I2C_GENERATE_RESTART_10BIT_WRITE
LL I2C Generic Driver
Generate Restart for write request,
slave 10Bit address.
Get Flags Defines
LL_I2C_ISR_TXE
Transmit data register empty
LL_I2C_ISR_TXIS
Transmit interrupt status
LL_I2C_ISR_RXNE
Receive data register not empty
LL_I2C_ISR_ADDR
Address matched (slave mode)
LL_I2C_ISR_NACKF
Not Acknowledge received flag
LL_I2C_ISR_STOPF
Stop detection flag
LL_I2C_ISR_TC
Transfer Complete (master mode)
LL_I2C_ISR_TCR
Transfer Complete Reload
LL_I2C_ISR_BERR
Bus error
LL_I2C_ISR_ARLO
Arbitration lost
LL_I2C_ISR_OVR
Overrun/Underrun (slave mode)
LL_I2C_ISR_PECERR
PEC Error in reception (SMBus mode)
LL_I2C_ISR_TIMEOUT
Timeout detection flag (SMBus mode)
LL_I2C_ISR_ALERT
SMBus alert (SMBus mode)
LL_I2C_ISR_BUSY
Bus busy
Acknowledge Generation
LL_I2C_ACK
ACK is sent after current received byte.
LL_I2C_NACK
NACK is sent after current received byte.
IT Defines
LL_I2C_CR1_TXIE
TX Interrupt enable
LL_I2C_CR1_RXIE
RX Interrupt enable
LL_I2C_CR1_ADDRIE
Address match Interrupt enable (slave only)
LL_I2C_CR1_NACKIE
Not acknowledge received Interrupt enable
LL_I2C_CR1_STOPIE
STOP detection Interrupt enable
LL_I2C_CR1_TCIE
Transfer Complete interrupt enable
LL_I2C_CR1_ERRIE
Error interrupts enable
Transfer End Mode
LL_I2C_MODE_RELOAD
Enable I2C Reload mode.
LL_I2C_MODE_AUTOEND
Enable I2C Automatic end mode with
no HW PEC comparison.
LL_I2C_MODE_SOFTEND
Enable I2C Software end mode with
no HW PEC comparison.
LL_I2C_MODE_SMBUS_RELOAD
Enable SMBUS Automatic end mode
with HW PEC comparison.
LL_I2C_MODE_SMBUS_AUTOEND_NO_PEC
Enable SMBUS Automatic end mode
DocID026525 Rev 6
889/1320
LL I2C Generic Driver
UM1785
with HW PEC comparison.
LL_I2C_MODE_SMBUS_SOFTEND_NO_PEC
Enable SMBUS Software end mode
with HW PEC comparison.
LL_I2C_MODE_SMBUS_AUTOEND_WITH_PEC
Enable SMBUS Automatic end mode
with HW PEC comparison.
LL_I2C_MODE_SMBUS_SOFTEND_WITH_PEC
Enable SMBUS Software end mode
with HW PEC comparison.
Own Address 1 Length
LL_I2C_OWNADDRESS1_7BIT
Own address 1 is a 7-bit address.
LL_I2C_OWNADDRESS1_10BIT
Own address 1 is a 10-bit address.
Own Address 2 Masks
LL_I2C_OWNADDRESS2_NOMASK
Own Address2 No mask.
LL_I2C_OWNADDRESS2_MASK01
Only Address2 bits[7:2] are compared.
LL_I2C_OWNADDRESS2_MASK02
Only Address2 bits[7:3] are compared.
LL_I2C_OWNADDRESS2_MASK03
Only Address2 bits[7:4] are compared.
LL_I2C_OWNADDRESS2_MASK04
Only Address2 bits[7:5] are compared.
LL_I2C_OWNADDRESS2_MASK05
Only Address2 bits[7:6] are compared.
LL_I2C_OWNADDRESS2_MASK06
Only Address2 bits[7] are compared.
LL_I2C_OWNADDRESS2_MASK07
No comparison is done. All Address2 are
acknowledged.
Peripheral Mode
LL_I2C_MODE_I2C
I2C Master or Slave mode
LL_I2C_MODE_SMBUS_HOST
SMBus Host address acknowledge
LL_I2C_MODE_SMBUS_DEVICE
SMBus Device default mode (Default address
not acknowledge)
LL_I2C_MODE_SMBUS_DEVICE_ARP
SMBus Device Default address acknowledge
Transfer Request Direction
LL_I2C_REQUEST_WRITE
Master request a write transfer.
LL_I2C_REQUEST_READ
Master request a read transfer.
SMBus TimeoutA Mode SCL SDA Timeout
LL_I2C_SMBUS_TIMEOUTA_MODE_SCL_LOW
TimeoutA is used to detect SCL
low level timeout.
LL_I2C_SMBUS_TIMEOUTA_MODE_SDA_SCL_HIGH
TimeoutA is used to detect both
SCL and SDA high level
timeout.
SMBus Timeout Selection
890/1320
LL_I2C_SMBUS_TIMEOUTA
TimeoutA enable bit
LL_I2C_SMBUS_TIMEOUTB
TimeoutB (extended clock) enable bit
LL_I2C_SMBUS_ALL_TIMEOUT
TimeoutA and TimeoutB (extended clock) enable bits
DocID026525 Rev 6
UM1785
LL I2C Generic Driver
Convert SDA SCL timings
__LL_I2C_CONVERT_TIMINGS
Description:
Configure the SDA setup, hold time and the SCL
high, low period.
Parameters:
__PRESCALER__: This parameter must be a
value between Min_Data=0 and Max_Data=0xF.
__DATA_SETUP_TIME__: This parameter must
be a value between Min_Data=0 and
Max_Data=0xF. (tscldel = (SCLDEL+1)xtpresc)
__DATA_HOLD_TIME__: This parameter must be
a value between Min_Data=0 and Max_Data=0xF.
(tsdadel = SDADELxtpresc)
__CLOCK_HIGH_PERIOD__: This parameter
must be a value between Min_Data=0 and
Max_Data=0xFF. (tsclh = (SCLH+1)xtpresc)
__CLOCK_LOW_PERIOD__: This parameter must
be a value between Min_Data=0 and
Max_Data=0xFF. (tscll = (SCLL+1)xtpresc)
Return value:
Value: between Min_Data=0 and
Max_Data=0xFFFFFFFF
Common Write and read registers Macros
LL_I2C_WriteReg
Description:
Write a value in I2C register.
Parameters:
__INSTANCE__: I2C Instance
__REG__: Register to be written
__VALUE__: Value to be written in the register
Return value:
None
LL_I2C_ReadReg
Description:
Read a value in I2C register.
Parameters:
__INSTANCE__: I2C Instance
__REG__: Register to be read
Return value:
Register: value
DocID026525 Rev 6
891/1320
LL I2S Generic Driver
UM1785
60
LL I2S Generic Driver
60.1
I2S Firmware driver registers structures
60.1.1
LL_I2S_InitTypeDef
Data Fields
uint32_t Mode
uint32_t Standard
uint32_t DataFormat
uint32_t MCLKOutput
uint32_t AudioFreq
uint32_t ClockPolarity
Field Documentation
uint32_t LL_I2S_InitTypeDef::Mode
Specifies the I2S operating mode. This parameter can be a value of
I2S_LL_EC_MODEThis feature can be modified afterwards using unitary function
LL_I2S_SetTransferMode().
uint32_t LL_I2S_InitTypeDef::Standard
Specifies the standard used for the I2S communication. This parameter can be a
value of I2S_LL_EC_STANDARDThis feature can be modified afterwards using
unitary function LL_I2S_SetStandard().
uint32_t LL_I2S_InitTypeDef::DataFormat
Specifies the data format for the I2S communication. This parameter can be a value of
I2S_LL_EC_DATA_FORMATThis feature can be modified afterwards using unitary
function LL_I2S_SetDataFormat().
uint32_t LL_I2S_InitTypeDef::MCLKOutput
Specifies whether the I2S MCLK output is enabled or not. This parameter can be a
value of I2S_LL_EC_MCLK_OUTPUTThis feature can be modified afterwards using
unitary functions LL_I2S_EnableMasterClock() or LL_I2S_DisableMasterClock.
uint32_t LL_I2S_InitTypeDef::AudioFreq
Specifies the frequency selected for the I2S communication. This parameter can be a
value of I2S_LL_EC_AUDIO_FREQAudio Frequency can be modified afterwards
using Reference manual formulas to calculate Prescaler Linear, Parity and unitary
functions LL_I2S_SetPrescalerLinear() and LL_I2S_SetPrescalerParity() to set it.
uint32_t LL_I2S_InitTypeDef::ClockPolarity
Specifies the idle state of the I2S clock. This parameter can be a value of
I2S_LL_EC_POLARITYThis feature can be modified afterwards using unitary function
LL_I2S_SetClockPolarity().
60.2
I2S Firmware driver API description
60.2.1
Detailed description of functions
LL_I2S_Enable
Function name
__STATIC_INLINE void LL_I2S_Enable (SPI_TypeDef * SPIx)
Function description
Select I2S mode and Enable I2S peripheral.
Parameters
892/1320
SPIx: SPI Instance
DocID026525 Rev 6
UM1785
LL I2S Generic Driver
Return values
None
Reference Manual to
LL API cross
reference:
I2SCFGR I2SMOD LL_I2S_Enable
I2SCFGR I2SE LL_I2S_Enable
LL_I2S_Disable
Function name
__STATIC_INLINE void LL_I2S_Disable (SPI_TypeDef * SPIx)
Function description
Disable I2S peripheral.
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
I2SCFGR I2SE LL_I2S_Disable
LL_I2S_IsEnabled
Function name
__STATIC_INLINE uint32_t LL_I2S_IsEnabled (SPI_TypeDef *
SPIx)
Function description
Check if I2S peripheral is enabled.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
I2SCFGR I2SE LL_I2S_IsEnabled
LL_I2S_SetDataFormat
Function name
__STATIC_INLINE void LL_I2S_SetDataFormat (SPI_TypeDef *
SPIx, uint32_t DataFormat)
Function description
Set I2S data frame length.
Parameters
SPIx: SPI Instance
DataFormat: This parameter can be one of the following
values:
LL_I2S_DATAFORMAT_16B
LL_I2S_DATAFORMAT_16B_EXTENDED
LL_I2S_DATAFORMAT_24B
LL_I2S_DATAFORMAT_32B
Return values
None
Reference Manual to
LL API cross
reference:
I2SCFGR DATLEN LL_I2S_SetDataFormat
I2SCFGR CHLEN LL_I2S_SetDataFormat
LL_I2S_GetDataFormat
Function name
__STATIC_INLINE uint32_t LL_I2S_GetDataFormat
(SPI_TypeDef * SPIx)
DocID026525 Rev 6
893/1320
LL I2S Generic Driver
Function description
UM1785
Get I2S data frame length.
Parameters
SPIx: SPI Instance
Return values
Returned: value can be one of the following values:
LL_I2S_DATAFORMAT_16B
LL_I2S_DATAFORMAT_16B_EXTENDED
LL_I2S_DATAFORMAT_24B
LL_I2S_DATAFORMAT_32B
Reference Manual to
LL API cross
reference:
I2SCFGR DATLEN LL_I2S_GetDataFormat
I2SCFGR CHLEN LL_I2S_GetDataFormat
LL_I2S_SetClockPolarity
Function name
__STATIC_INLINE void LL_I2S_SetClockPolarity
(SPI_TypeDef * SPIx, uint32_t ClockPolarity)
Function description
Set I2S clock polarity.
Parameters
SPIx: SPI Instance
ClockPolarity: This parameter can be one of the following
values:
LL_I2S_POLARITY_LOW
LL_I2S_POLARITY_HIGH
Return values
None
Reference Manual to
LL API cross
reference:
I2SCFGR CKPOL LL_I2S_SetClockPolarity
LL_I2S_GetClockPolarity
Function name
__STATIC_INLINE uint32_t LL_I2S_GetClockPolarity
(SPI_TypeDef * SPIx)
Function description
Get I2S clock polarity.
Parameters
SPIx: SPI Instance
Return values
Returned: value can be one of the following values:
LL_I2S_POLARITY_LOW
LL_I2S_POLARITY_HIGH
Reference Manual to
LL API cross
reference:
I2SCFGR CKPOL LL_I2S_GetClockPolarity
LL_I2S_SetStandard
Function name
__STATIC_INLINE void LL_I2S_SetStandard (SPI_TypeDef *
SPIx, uint32_t Standard)
Function description
Set I2S standard protocol.
Parameters
894/1320
SPIx: SPI Instance
Standard: This parameter can be one of the following
values:
DocID026525 Rev 6
UM1785
LL I2S Generic Driver
LL_I2S_STANDARD_PHILIPS
LL_I2S_STANDARD_MSB
LL_I2S_STANDARD_LSB
LL_I2S_STANDARD_PCM_SHORT
LL_I2S_STANDARD_PCM_LONG
Return values
None
Reference Manual to
LL API cross
reference:
I2SCFGR I2SSTD LL_I2S_SetStandard
I2SCFGR PCMSYNC LL_I2S_SetStandard
LL_I2S_GetStandard
Function name
__STATIC_INLINE uint32_t LL_I2S_GetStandard (SPI_TypeDef
* SPIx)
Function description
Get I2S standard protocol.
Parameters
SPIx: SPI Instance
Return values
Returned: value can be one of the following values:
LL_I2S_STANDARD_PHILIPS
LL_I2S_STANDARD_MSB
LL_I2S_STANDARD_LSB
LL_I2S_STANDARD_PCM_SHORT
LL_I2S_STANDARD_PCM_LONG
Reference Manual to
LL API cross
reference:
I2SCFGR I2SSTD LL_I2S_GetStandard
I2SCFGR PCMSYNC LL_I2S_GetStandard
LL_I2S_SetTransferMode
Function name
__STATIC_INLINE void LL_I2S_SetTransferMode
(SPI_TypeDef * SPIx, uint32_t Mode)
Function description
Set I2S transfer mode.
Parameters
SPIx: SPI Instance
Mode: This parameter can be one of the following values:
LL_I2S_MODE_SLAVE_TX
LL_I2S_MODE_SLAVE_RX
LL_I2S_MODE_MASTER_TX
LL_I2S_MODE_MASTER_RX
Return values
None
Reference Manual to
LL API cross
reference:
I2SCFGR I2SCFG LL_I2S_SetTransferMode
LL_I2S_GetTransferMode
Function name
__STATIC_INLINE uint32_t LL_I2S_GetTransferMode
(SPI_TypeDef * SPIx)
Function description
Get I2S transfer mode.
DocID026525 Rev 6
895/1320
LL I2S Generic Driver
Parameters
UM1785
SPIx: SPI Instance
Return values
Returned: value can be one of the following values:
LL_I2S_MODE_SLAVE_TX
LL_I2S_MODE_SLAVE_RX
LL_I2S_MODE_MASTER_TX
LL_I2S_MODE_MASTER_RX
Reference Manual to
LL API cross
reference:
I2SCFGR I2SCFG LL_I2S_GetTransferMode
LL_I2S_SetPrescalerLinear
Function name
__STATIC_INLINE void LL_I2S_SetPrescalerLinear
(SPI_TypeDef * SPIx, uint8_t PrescalerLinear)
Function description
Set I2S linear prescaler.
Parameters
SPIx: SPI Instance
PrescalerLinear: Value between Min_Data=0x02 and
Max_Data=0xFF
Return values
None
Reference Manual to
LL API cross
reference:
I2SPR I2SDIV LL_I2S_SetPrescalerLinear
LL_I2S_GetPrescalerLinear
Function name
__STATIC_INLINE uint32_t LL_I2S_GetPrescalerLinear
(SPI_TypeDef * SPIx)
Function description
Get I2S linear prescaler.
Parameters
SPIx: SPI Instance
Return values
PrescalerLinear: Value between Min_Data=0x02 and
Max_Data=0xFF
Reference Manual to
LL API cross
reference:
I2SPR I2SDIV LL_I2S_GetPrescalerLinear
LL_I2S_SetPrescalerParity
896/1320
Function name
__STATIC_INLINE void LL_I2S_SetPrescalerParity
(SPI_TypeDef * SPIx, uint32_t PrescalerParity)
Function description
Set I2S parity prescaler.
Parameters
SPIx: SPI Instance
PrescalerParity: This parameter can be one of the following
values:
LL_I2S_PRESCALER_PARITY_EVEN
LL_I2S_PRESCALER_PARITY_ODD
Return values
None
DocID026525 Rev 6
UM1785
LL I2S Generic Driver
Reference Manual to
LL API cross
reference:
I2SPR ODD LL_I2S_SetPrescalerParity
LL_I2S_GetPrescalerParity
Function name
__STATIC_INLINE uint32_t LL_I2S_GetPrescalerParity
(SPI_TypeDef * SPIx)
Function description
Get I2S parity prescaler.
Parameters
SPIx: SPI Instance
Return values
Returned: value can be one of the following values:
LL_I2S_PRESCALER_PARITY_EVEN
LL_I2S_PRESCALER_PARITY_ODD
Reference Manual to
LL API cross
reference:
I2SPR ODD LL_I2S_GetPrescalerParity
LL_I2S_EnableMasterClock
Function name
__STATIC_INLINE void LL_I2S_EnableMasterClock
(SPI_TypeDef * SPIx)
Function description
Enable the master clock ouput (Pin MCK)
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
I2SPR MCKOE LL_I2S_EnableMasterClock
LL_I2S_DisableMasterClock
Function name
__STATIC_INLINE void LL_I2S_DisableMasterClock
(SPI_TypeDef * SPIx)
Function description
Disable the master clock ouput (Pin MCK)
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
I2SPR MCKOE LL_I2S_DisableMasterClock
LL_I2S_IsEnabledMasterClock
Function name
__STATIC_INLINE uint32_t LL_I2S_IsEnabledMasterClock
(SPI_TypeDef * SPIx)
Function description
Check if the master clock ouput (Pin MCK) is enabled.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
DocID026525 Rev 6
897/1320
LL I2S Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
I2SPR MCKOE LL_I2S_IsEnabledMasterClock
LL_I2S_IsActiveFlag_RXNE
Function name
__STATIC_INLINE uint32_t LL_I2S_IsActiveFlag_RXNE
(SPI_TypeDef * SPIx)
Function description
Check if Rx buffer is not empty.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR RXNE LL_I2S_IsActiveFlag_RXNE
LL_I2S_IsActiveFlag_TXE
Function name
__STATIC_INLINE uint32_t LL_I2S_IsActiveFlag_TXE
(SPI_TypeDef * SPIx)
Function description
Check if Tx buffer is empty.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR TXE LL_I2S_IsActiveFlag_TXE
LL_I2S_IsActiveFlag_BSY
Function name
__STATIC_INLINE uint32_t LL_I2S_IsActiveFlag_BSY
(SPI_TypeDef * SPIx)
Function description
Get busy flag.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR BSY LL_I2S_IsActiveFlag_BSY
LL_I2S_IsActiveFlag_OVR
898/1320
Function name
__STATIC_INLINE uint32_t LL_I2S_IsActiveFlag_OVR
(SPI_TypeDef * SPIx)
Function description
Get overrun error flag.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
SR OVR LL_I2S_IsActiveFlag_OVR
DocID026525 Rev 6
UM1785
LL I2S Generic Driver
reference:
LL_I2S_IsActiveFlag_UDR
Function name
__STATIC_INLINE uint32_t LL_I2S_IsActiveFlag_UDR
(SPI_TypeDef * SPIx)
Function description
Get underrun error flag.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR UDR LL_I2S_IsActiveFlag_UDR
LL_I2S_IsActiveFlag_FRE
Function name
__STATIC_INLINE uint32_t LL_I2S_IsActiveFlag_FRE
(SPI_TypeDef * SPIx)
Function description
Get frame format error flag.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR FRE LL_I2S_IsActiveFlag_FRE
LL_I2S_IsActiveFlag_CHSIDE
Function name
__STATIC_INLINE uint32_t LL_I2S_IsActiveFlag_CHSIDE
(SPI_TypeDef * SPIx)
Function description
Get channel side flag.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Notes
0: Channel Left has to be transmitted or has been received 1:
Channel Right has to be transmitted or has been received It
has no significance in PCM mode.
Reference Manual to
LL API cross
reference:
SR CHSIDE LL_I2S_IsActiveFlag_CHSIDE
LL_I2S_ClearFlag_OVR
Function name
__STATIC_INLINE void LL_I2S_ClearFlag_OVR (SPI_TypeDef
* SPIx)
Function description
Clear overrun error flag.
Parameters
SPIx: SPI Instance
Return values
None
DocID026525 Rev 6
899/1320
LL I2S Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
SR OVR LL_I2S_ClearFlag_OVR
LL_I2S_ClearFlag_UDR
Function name
__STATIC_INLINE void LL_I2S_ClearFlag_UDR (SPI_TypeDef
* SPIx)
Function description
Clear underrun error flag.
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
SR UDR LL_I2S_ClearFlag_UDR
LL_I2S_ClearFlag_FRE
Function name
__STATIC_INLINE void LL_I2S_ClearFlag_FRE (SPI_TypeDef *
SPIx)
Function description
Clear frame format error flag.
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
SR FRE LL_I2S_ClearFlag_FRE
LL_I2S_EnableIT_ERR
Function name
__STATIC_INLINE void LL_I2S_EnableIT_ERR (SPI_TypeDef *
SPIx)
Function description
Enable error IT.
Parameters
SPIx: SPI Instance
Return values
None
Notes
This bit controls the generation of an interrupt when an error
condition occurs (OVR, UDR and FRE in I2S mode).
Reference Manual to
LL API cross
reference:
CR2 ERRIE LL_I2S_EnableIT_ERR
LL_I2S_EnableIT_RXNE
Function name
__STATIC_INLINE void LL_I2S_EnableIT_RXNE (SPI_TypeDef
* SPIx)
Function description
Enable Rx buffer not empty IT.
Parameters
900/1320
SPIx: SPI Instance
DocID026525 Rev 6
UM1785
LL I2S Generic Driver
Return values
None
Reference Manual to
LL API cross
reference:
CR2 RXNEIE LL_I2S_EnableIT_RXNE
LL_I2S_EnableIT_TXE
Function name
__STATIC_INLINE void LL_I2S_EnableIT_TXE (SPI_TypeDef *
SPIx)
Function description
Enable Tx buffer empty IT.
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR2 TXEIE LL_I2S_EnableIT_TXE
LL_I2S_DisableIT_ERR
Function name
__STATIC_INLINE void LL_I2S_DisableIT_ERR (SPI_TypeDef *
SPIx)
Function description
Disable error IT.
Parameters
SPIx: SPI Instance
Return values
None
Notes
This bit controls the generation of an interrupt when an error
condition occurs (OVR, UDR and FRE in I2S mode).
Reference Manual to
LL API cross
reference:
CR2 ERRIE LL_I2S_DisableIT_ERR
LL_I2S_DisableIT_RXNE
Function name
__STATIC_INLINE void LL_I2S_DisableIT_RXNE (SPI_TypeDef
* SPIx)
Function description
Disable Rx buffer not empty IT.
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR2 RXNEIE LL_I2S_DisableIT_RXNE
LL_I2S_DisableIT_TXE
Function name
__STATIC_INLINE void LL_I2S_DisableIT_TXE (SPI_TypeDef *
SPIx)
Function description
Disable Tx buffer empty IT.
DocID026525 Rev 6
901/1320
LL I2S Generic Driver
Parameters
UM1785
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR2 TXEIE LL_I2S_DisableIT_TXE
LL_I2S_IsEnabledIT_ERR
Function name
__STATIC_INLINE uint32_t LL_I2S_IsEnabledIT_ERR
(SPI_TypeDef * SPIx)
Function description
Check if ERR IT is enabled.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR2 ERRIE LL_I2S_IsEnabledIT_ERR
LL_I2S_IsEnabledIT_RXNE
Function name
__STATIC_INLINE uint32_t LL_I2S_IsEnabledIT_RXNE
(SPI_TypeDef * SPIx)
Function description
Check if RXNE IT is enabled.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR2 RXNEIE LL_I2S_IsEnabledIT_RXNE
LL_I2S_IsEnabledIT_TXE
Function name
__STATIC_INLINE uint32_t LL_I2S_IsEnabledIT_TXE
(SPI_TypeDef * SPIx)
Function description
Check if TXE IT is enabled.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR2 TXEIE LL_I2S_IsEnabledIT_TXE
LL_I2S_EnableDMAReq_RX
Function name
__STATIC_INLINE void LL_I2S_EnableDMAReq_RX
(SPI_TypeDef * SPIx)
Function description
Enable DMA Rx.
Parameters
902/1320
SPIx: SPI Instance
DocID026525 Rev 6
UM1785
LL I2S Generic Driver
Return values
None
Reference Manual to
LL API cross
reference:
CR2 RXDMAEN LL_I2S_EnableDMAReq_RX
LL_I2S_DisableDMAReq_RX
Function name
__STATIC_INLINE void LL_I2S_DisableDMAReq_RX
(SPI_TypeDef * SPIx)
Function description
Disable DMA Rx.
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR2 RXDMAEN LL_I2S_DisableDMAReq_RX
LL_I2S_IsEnabledDMAReq_RX
Function name
__STATIC_INLINE uint32_t LL_I2S_IsEnabledDMAReq_RX
(SPI_TypeDef * SPIx)
Function description
Check if DMA Rx is enabled.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR2 RXDMAEN LL_I2S_IsEnabledDMAReq_RX
LL_I2S_EnableDMAReq_TX
Function name
__STATIC_INLINE void LL_I2S_EnableDMAReq_TX
(SPI_TypeDef * SPIx)
Function description
Enable DMA Tx.
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR2 TXDMAEN LL_I2S_EnableDMAReq_TX
LL_I2S_DisableDMAReq_TX
Function name
__STATIC_INLINE void LL_I2S_DisableDMAReq_TX
(SPI_TypeDef * SPIx)
Function description
Disable DMA Tx.
Parameters
SPIx: SPI Instance
Return values
None
DocID026525 Rev 6
903/1320
LL I2S Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
CR2 TXDMAEN LL_I2S_DisableDMAReq_TX
LL_I2S_IsEnabledDMAReq_TX
Function name
__STATIC_INLINE uint32_t LL_I2S_IsEnabledDMAReq_TX
(SPI_TypeDef * SPIx)
Function description
Check if DMA Tx is enabled.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR2 TXDMAEN LL_I2S_IsEnabledDMAReq_TX
LL_I2S_ReceiveData16
Function name
__STATIC_INLINE uint16_t LL_I2S_ReceiveData16
(SPI_TypeDef * SPIx)
Function description
Read 16-Bits in data register.
Parameters
SPIx: SPI Instance
Return values
RxData: Value between Min_Data=0x0000 and
Max_Data=0xFFFF
Reference Manual to
LL API cross
reference:
DR DR LL_I2S_ReceiveData16
LL_I2S_TransmitData16
Function name
__STATIC_INLINE void LL_I2S_TransmitData16 (SPI_TypeDef
* SPIx, uint16_t TxData)
Function description
Write 16-Bits in data register.
Parameters
SPIx: SPI Instance
TxData: Value between Min_Data=0x0000 and
Max_Data=0xFFFF
Return values
None
Reference Manual to
LL API cross
reference:
DR DR LL_I2S_TransmitData16
LL_I2S_DeInit
904/1320
Function name
ErrorStatus LL_I2S_DeInit (SPI_TypeDef * SPIx)
Function description
De-initialize the SPI/I2S registers to their default reset values.
Parameters
SPIx: SPI Instance
Return values
An: ErrorStatus enumeration value:
DocID026525 Rev 6
UM1785
LL I2S Generic Driver
SUCCESS: SPI registers are de-initialized
ERROR: SPI registers are not de-initialized
LL_I2S_Init
Function name
ErrorStatus LL_I2S_Init (SPI_TypeDef * SPIx,
LL_I2S_InitTypeDef * I2S_InitStruct)
Function description
Initializes the SPI/I2S registers according to the specified
parameters in I2S_InitStruct.
Parameters
SPIx: SPI Instance
I2S_InitStruct: pointer to a LL_I2S_InitTypeDef structure
Return values
An: ErrorStatus enumeration value:
SUCCESS: SPI registers are Initialized
ERROR: SPI registers are not Initialized
Notes
As some bits in SPI configuration registers can only be written
when the SPI is disabled (SPI_CR1_SPE bit =0), SPI IP
should be in disabled state prior calling this function.
Otherwise, ERROR result will be returned.
LL_I2S_StructInit
Function name
void LL_I2S_StructInit (LL_I2S_InitTypeDef * I2S_InitStruct)
Function description
Set each LL_I2S_InitTypeDef field to default value.
Parameters
I2S_InitStruct: pointer to a LL_I2S_InitTypeDef structure
whose fields will be set to default values.
Return values
None
LL_I2S_ConfigPrescaler
Function name
void LL_I2S_ConfigPrescaler (SPI_TypeDef * SPIx, uint32_t
PrescalerLinear, uint32_t PrescalerParity)
Function description
Set linear and parity prescaler.
Parameters
SPIx: SPI Instance
PrescalerLinear: value: Min_Data=0x02 and
Max_Data=0xFF.
PrescalerParity: This parameter can be one of the following
values:
LL_I2S_PRESCALER_PARITY_EVEN
LL_I2S_PRESCALER_PARITY_ODD
Return values
None
Notes
To calculate value of PrescalerLinear(I2SDIV[7:0] bits) and
PrescalerParity(ODD bit) Check Audio frequency table and
formulas inside Reference Manual (SPI/I2S).
DocID026525 Rev 6
905/1320
LL I2S Generic Driver
UM1785
60.3
I2S Firmware driver defines
60.3.1
I2S
Audio Frequency
LL_I2S_AUDIOFREQ_192K
Audio Frequency configuration 192000 Hz
LL_I2S_AUDIOFREQ_96K
Audio Frequency configuration 96000 Hz
LL_I2S_AUDIOFREQ_48K
Audio Frequency configuration 48000 Hz
LL_I2S_AUDIOFREQ_44K
Audio Frequency configuration 44100 Hz
LL_I2S_AUDIOFREQ_32K
Audio Frequency configuration 32000 Hz
LL_I2S_AUDIOFREQ_22K
Audio Frequency configuration 22050 Hz
LL_I2S_AUDIOFREQ_16K
Audio Frequency configuration 16000 Hz
LL_I2S_AUDIOFREQ_11K
Audio Frequency configuration 11025 Hz
LL_I2S_AUDIOFREQ_8K
Audio Frequency configuration 8000 Hz
LL_I2S_AUDIOFREQ_DEFAULT
Audio Freq not specified. Register I2SDIV = 2
Data format
LL_I2S_DATAFORMAT_16B
Data length 16 bits, Channel lenght 16bit
LL_I2S_DATAFORMAT_16B_EXTENDED
Data length 16 bits, Channel lenght 32bit
LL_I2S_DATAFORMAT_24B
Data length 24 bits, Channel lenght 32bit
LL_I2S_DATAFORMAT_32B
Data length 16 bits, Channel lenght 32bit
Get Flags Defines
LL_I2S_SR_RXNE
Rx buffer not empty flag
LL_I2S_SR_TXE
Tx buffer empty flag
LL_I2S_SR_BSY
Busy flag
LL_I2S_SR_UDR
Underrun flag
LL_I2S_SR_OVR
Overrun flag
LL_I2S_SR_FRE
TI mode frame format error flag
MCLK Output
LL_I2S_MCLK_OUTPUT_DISABLE
Master clock output is disabled
LL_I2S_MCLK_OUTPUT_ENABLE
Master clock output is enabled
Operation Mode
LL_I2S_MODE_SLAVE_TX
Slave Tx configuration
LL_I2S_MODE_SLAVE_RX
Slave Rx configuration
LL_I2S_MODE_MASTER_TX
Master Tx configuration
LL_I2S_MODE_MASTER_RX
Master Rx configuration
Clock Polarity
906/1320
LL_I2S_POLARITY_LOW
Clock steady state is low level
LL_I2S_POLARITY_HIGH
Clock steady state is high level
DocID026525 Rev 6
UM1785
LL I2S Generic Driver
Prescaler Factor
LL_I2S_PRESCALER_PARITY_EVEN
Odd factor: Real divider value is = I2SDIV * 2
LL_I2S_PRESCALER_PARITY_ODD
Odd factor: Real divider value is = (I2SDIV * 2)+1
I2s Standard
LL_I2S_STANDARD_PHILIPS
I2S standard philips
LL_I2S_STANDARD_MSB
MSB justified standard (left justified)
LL_I2S_STANDARD_LSB
LSB justified standard (right justified)
LL_I2S_STANDARD_PCM_SHORT
PCM standard, short frame synchronization
LL_I2S_STANDARD_PCM_LONG
PCM standard, long frame synchronization
Common Write and read registers Macros
LL_I2S_WriteReg
Description:
Write a value in I2S register.
Parameters:
__INSTANCE__: I2S Instance
__REG__: Register to be written
__VALUE__: Value to be written in the register
Return value:
None
LL_I2S_ReadReg
Description:
Read a value in I2S register.
Parameters:
__INSTANCE__: I2S Instance
__REG__: Register to be read
Return value:
Register: value
DocID026525 Rev 6
907/1320
LL IWDG Generic Driver
UM1785
61
LL IWDG Generic Driver
61.1
IWDG Firmware driver API description
61.1.1
Detailed description of functions
LL_IWDG_Enable
Function name
__STATIC_INLINE void LL_IWDG_Enable (IWDG_TypeDef *
IWDGx)
Function description
Start the Independent Watchdog.
Parameters
IWDGx: IWDG Instance
Return values
None
Notes
Except if the hardware watchdog option is selected
Reference Manual to
LL API cross
reference:
KR KEY LL_IWDG_Enable
LL_IWDG_ReloadCounter
Function name
__STATIC_INLINE void LL_IWDG_ReloadCounter
(IWDG_TypeDef * IWDGx)
Function description
Reloads IWDG counter with value defined in the reload register.
Parameters
IWDGx: IWDG Instance
Return values
None
Reference Manual to
LL API cross
reference:
KR KEY LL_IWDG_ReloadCounter
LL_IWDG_EnableWriteAccess
Function name
__STATIC_INLINE void LL_IWDG_EnableWriteAccess
(IWDG_TypeDef * IWDGx)
Function description
Enable write access to IWDG_PR, IWDG_RLR and IWDG_WINR
registers.
Parameters
IWDGx: IWDG Instance
Return values
None
Reference Manual to
LL API cross
reference:
KR KEY LL_IWDG_EnableWriteAccess
LL_IWDG_DisableWriteAccess
Function name
908/1320
__STATIC_INLINE void LL_IWDG_DisableWriteAccess
DocID026525 Rev 6
UM1785
LL IWDG Generic Driver
(IWDG_TypeDef * IWDGx)
Function description
Disable write access to IWDG_PR, IWDG_RLR and IWDG_WINR
registers.
Parameters
IWDGx: IWDG Instance
Return values
None
Reference Manual to
LL API cross
reference:
KR KEY LL_IWDG_DisableWriteAccess
LL_IWDG_SetPrescaler
Function name
__STATIC_INLINE void LL_IWDG_SetPrescaler
(IWDG_TypeDef * IWDGx, uint32_t Prescaler)
Function description
Select the prescaler of the IWDG.
Parameters
IWDGx: IWDG Instance
Prescaler: This parameter can be one of the following
values:
LL_IWDG_PRESCALER_4
LL_IWDG_PRESCALER_8
LL_IWDG_PRESCALER_16
LL_IWDG_PRESCALER_32
LL_IWDG_PRESCALER_64
LL_IWDG_PRESCALER_128
LL_IWDG_PRESCALER_256
Return values
None
Reference Manual to
LL API cross
reference:
PR PR LL_IWDG_SetPrescaler
LL_IWDG_GetPrescaler
Function name
__STATIC_INLINE uint32_t LL_IWDG_GetPrescaler
(IWDG_TypeDef * IWDGx)
Function description
Get the selected prescaler of the IWDG.
Parameters
IWDGx: IWDG Instance
Return values
Returned: value can be one of the following values:
LL_IWDG_PRESCALER_4
LL_IWDG_PRESCALER_8
LL_IWDG_PRESCALER_16
LL_IWDG_PRESCALER_32
LL_IWDG_PRESCALER_64
LL_IWDG_PRESCALER_128
LL_IWDG_PRESCALER_256
Reference Manual to
LL API cross
reference:
PR PR LL_IWDG_GetPrescaler
DocID026525 Rev 6
909/1320
LL IWDG Generic Driver
UM1785
LL_IWDG_SetReloadCounter
Function name
__STATIC_INLINE void LL_IWDG_SetReloadCounter
(IWDG_TypeDef * IWDGx, uint32_t Counter)
Function description
Specify the IWDG down-counter reload value.
Parameters
IWDGx: IWDG Instance
Counter: Value between Min_Data=0 and
Max_Data=0x0FFF
Return values
None
Reference Manual to
LL API cross
reference:
RLR RL LL_IWDG_SetReloadCounter
LL_IWDG_GetReloadCounter
Function name
__STATIC_INLINE uint32_t LL_IWDG_GetReloadCounter
(IWDG_TypeDef * IWDGx)
Function description
Get the specified IWDG down-counter reload value.
Parameters
IWDGx: IWDG Instance
Return values
Value: between Min_Data=0 and Max_Data=0x0FFF
Reference Manual to
LL API cross
reference:
RLR RL LL_IWDG_GetReloadCounter
LL_IWDG_SetWindow
Function name
__STATIC_INLINE void LL_IWDG_SetWindow (IWDG_TypeDef
* IWDGx, uint32_t Window)
Function description
Specify high limit of the window value to be compared to the downcounter.
Parameters
IWDGx: IWDG Instance
Window: Value between Min_Data=0 and
Max_Data=0x0FFF
Return values
None
Reference Manual to
LL API cross
reference:
WINR WIN LL_IWDG_SetWindow
LL_IWDG_GetWindow
910/1320
Function name
__STATIC_INLINE uint32_t LL_IWDG_GetWindow
(IWDG_TypeDef * IWDGx)
Function description
Get the high limit of the window value specified.
Parameters
IWDGx: IWDG Instance
Return values
Value: between Min_Data=0 and Max_Data=0x0FFF
Reference Manual to
WINR WIN LL_IWDG_GetWindow
DocID026525 Rev 6
UM1785
LL IWDG Generic Driver
LL API cross
reference:
LL_IWDG_IsActiveFlag_PVU
Function name
__STATIC_INLINE uint32_t LL_IWDG_IsActiveFlag_PVU
(IWDG_TypeDef * IWDGx)
Function description
Check if flag Prescaler Value Update is set or not.
Parameters
IWDGx: IWDG Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR PVU LL_IWDG_IsActiveFlag_PVU
LL_IWDG_IsActiveFlag_RVU
Function name
__STATIC_INLINE uint32_t LL_IWDG_IsActiveFlag_RVU
(IWDG_TypeDef * IWDGx)
Function description
Check if flag Reload Value Update is set or not.
Parameters
IWDGx: IWDG Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR RVU LL_IWDG_IsActiveFlag_RVU
LL_IWDG_IsActiveFlag_WVU
Function name
__STATIC_INLINE uint32_t LL_IWDG_IsActiveFlag_WVU
(IWDG_TypeDef * IWDGx)
Function description
Check if flag Window Value Update is set or not.
Parameters
IWDGx: IWDG Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR WVU LL_IWDG_IsActiveFlag_WVU
LL_IWDG_IsReady
Function name
__STATIC_INLINE uint32_t LL_IWDG_IsReady
(IWDG_TypeDef * IWDGx)
Function description
Check if all flags Prescaler, Reload & Window Value Update are
reset or not.
Parameters
IWDGx: IWDG Instance
Return values
State: of bits (1 or 0).
Reference Manual to
LL API cross
SR PVU LL_IWDG_IsReady
SR WVU LL_IWDG_IsReady
DocID026525 Rev 6
911/1320
LL IWDG Generic Driver
reference:
UM1785
SR RVU LL_IWDG_IsReady
61.2
IWDG Firmware driver defines
61.2.1
IWDG
Get Flags Defines
LL_IWDG_SR_PVU
Watchdog prescaler value update
LL_IWDG_SR_RVU
Watchdog counter reload value update
LL_IWDG_SR_WVU
Watchdog counter window value update
Prescaler Divider
LL_IWDG_PRESCALER_4
Divider by 4
LL_IWDG_PRESCALER_8
Divider by 8
LL_IWDG_PRESCALER_16
Divider by 16
LL_IWDG_PRESCALER_32
Divider by 32
LL_IWDG_PRESCALER_64
Divider by 64
LL_IWDG_PRESCALER_128
Divider by 128
LL_IWDG_PRESCALER_256
Divider by 256
Common Write and read registers Macros
LL_IWDG_WriteReg
Description:
Write a value in IWDG register.
Parameters:
__INSTANCE__: IWDG Instance
__REG__: Register to be written
__VALUE__: Value to be written in the register
Return value:
None
LL_IWDG_ReadReg
Description:
Read a value in IWDG register.
Parameters:
__INSTANCE__: IWDG Instance
__REG__: Register to be read
Return value:
Register: value
912/1320
DocID026525 Rev 6
UM1785
LL PWR Generic Driver
62
LL PWR Generic Driver
62.1
PWR Firmware driver API description
62.1.1
Detailed description of functions
LL_PWR_EnableBkUpAccess
Function name
__STATIC_INLINE void LL_PWR_EnableBkUpAccess (void )
Function description
Enable access to the backup domain.
Return values
None
Reference Manual to
LL API cross
reference:
CR DBP LL_PWR_EnableBkUpAccess
LL_PWR_DisableBkUpAccess
Function name
__STATIC_INLINE void LL_PWR_DisableBkUpAccess (void )
Function description
Disable access to the backup domain.
Return values
None
Reference Manual to
LL API cross
reference:
CR DBP LL_PWR_DisableBkUpAccess
LL_PWR_IsEnabledBkUpAccess
Function name
__STATIC_INLINE uint32_t LL_PWR_IsEnabledBkUpAccess
(void )
Function description
Check if the backup domain is enabled.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR DBP LL_PWR_IsEnabledBkUpAccess
LL_PWR_SetRegulModeDS
Function name
__STATIC_INLINE void LL_PWR_SetRegulModeDS (uint32_t
RegulMode)
Function description
Set voltage Regulator mode during deep sleep mode.
Parameters
RegulMode: This parameter can be one of the following
values:
LL_PWR_REGU_DSMODE_MAIN
LL_PWR_REGU_DSMODE_LOW_POWER
Return values
None
DocID026525 Rev 6
913/1320
LL PWR Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
CR LPDS LL_PWR_SetRegulModeDS
LL_PWR_GetRegulModeDS
Function name
__STATIC_INLINE uint32_t LL_PWR_GetRegulModeDS (void )
Function description
Get voltage Regulator mode during deep sleep mode.
Return values
Returned: value can be one of the following values:
LL_PWR_REGU_DSMODE_MAIN
LL_PWR_REGU_DSMODE_LOW_POWER
Reference Manual to
LL API cross
reference:
CR LPDS LL_PWR_GetRegulModeDS
LL_PWR_SetPowerMode
Function name
__STATIC_INLINE void LL_PWR_SetPowerMode (uint32_t
PDMode)
Function description
Set Power Down mode when CPU enters deepsleep.
Parameters
PDMode: This parameter can be one of the following values:
LL_PWR_MODE_STOP_MAINREGU
LL_PWR_MODE_STOP_LPREGU
LL_PWR_MODE_STANDBY
Return values
None
Reference Manual to
LL API cross
reference:
CR PDDS LL_PWR_SetPowerMode
CR LPDS LL_PWR_SetPowerMode
LL_PWR_GetPowerMode
Function name
__STATIC_INLINE uint32_t LL_PWR_GetPowerMode (void )
Function description
Get Power Down mode when CPU enters deepsleep.
Return values
Returned: value can be one of the following values:
LL_PWR_MODE_STOP_MAINREGU
LL_PWR_MODE_STOP_LPREGU
LL_PWR_MODE_STANDBY
Reference Manual to
LL API cross
reference:
CR PDDS LL_PWR_GetPowerMode
CR LPDS LL_PWR_GetPowerMode
LL_PWR_SetPVDLevel
914/1320
Function name
__STATIC_INLINE void LL_PWR_SetPVDLevel (uint32_t
PVDLevel)
Function description
Configure the voltage threshold detected by the Power Voltage
Detector.
DocID026525 Rev 6
UM1785
LL PWR Generic Driver
Parameters
PVDLevel: This parameter can be one of the following
values:
LL_PWR_PVDLEVEL_0
LL_PWR_PVDLEVEL_1
LL_PWR_PVDLEVEL_2
LL_PWR_PVDLEVEL_3
LL_PWR_PVDLEVEL_4
LL_PWR_PVDLEVEL_5
LL_PWR_PVDLEVEL_6
LL_PWR_PVDLEVEL_7
Return values
None
Reference Manual to
LL API cross
reference:
CR PLS LL_PWR_SetPVDLevel
LL_PWR_GetPVDLevel
Function name
__STATIC_INLINE uint32_t LL_PWR_GetPVDLevel (void )
Function description
Get the voltage threshold detection.
Return values
Returned: value can be one of the following values:
LL_PWR_PVDLEVEL_0
LL_PWR_PVDLEVEL_1
LL_PWR_PVDLEVEL_2
LL_PWR_PVDLEVEL_3
LL_PWR_PVDLEVEL_4
LL_PWR_PVDLEVEL_5
LL_PWR_PVDLEVEL_6
LL_PWR_PVDLEVEL_7
Reference Manual to
LL API cross
reference:
CR PLS LL_PWR_GetPVDLevel
LL_PWR_EnablePVD
Function name
__STATIC_INLINE void LL_PWR_EnablePVD (void )
Function description
Enable Power Voltage Detector.
Return values
None
Reference Manual to
LL API cross
reference:
CR PVDE LL_PWR_EnablePVD
LL_PWR_DisablePVD
Function name
__STATIC_INLINE void LL_PWR_DisablePVD (void )
Function description
Disable Power Voltage Detector.
Return values
None
Reference Manual to
LL API cross
CR PVDE LL_PWR_DisablePVD
DocID026525 Rev 6
915/1320
LL PWR Generic Driver
reference:
UM1785
LL_PWR_IsEnabledPVD
Function name
__STATIC_INLINE uint32_t LL_PWR_IsEnabledPVD (void )
Function description
Check if Power Voltage Detector is enabled.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR PVDE LL_PWR_IsEnabledPVD
LL_PWR_EnableWakeUpPin
Function name
__STATIC_INLINE void LL_PWR_EnableWakeUpPin (uint32_t
WakeUpPin)
Function description
Enable the WakeUp PINx functionality.
Parameters
WakeUpPin: This parameter can be one of the following
values: (*) not available on all devices
LL_PWR_WAKEUP_PIN1
LL_PWR_WAKEUP_PIN2
LL_PWR_WAKEUP_PIN3 (*)
LL_PWR_WAKEUP_PIN4 (*)
LL_PWR_WAKEUP_PIN5 (*)
LL_PWR_WAKEUP_PIN6 (*)
LL_PWR_WAKEUP_PIN7 (*)
LL_PWR_WAKEUP_PIN8 (*)
Return values
None
Reference Manual to
LL API cross
reference:
CSR EWUP1 LL_PWR_EnableWakeUpPin
CSR EWUP2 LL_PWR_EnableWakeUpPin
CSR EWUP3 LL_PWR_EnableWakeUpPin
CSR EWUP4 LL_PWR_EnableWakeUpPin
CSR EWUP5 LL_PWR_EnableWakeUpPin
CSR EWUP6 LL_PWR_EnableWakeUpPin
CSR EWUP7 LL_PWR_EnableWakeUpPin
CSR EWUP8 LL_PWR_EnableWakeUpPin
LL_PWR_DisableWakeUpPin
916/1320
Function name
__STATIC_INLINE void LL_PWR_DisableWakeUpPin (uint32_t
WakeUpPin)
Function description
Disable the WakeUp PINx functionality.
DocID026525 Rev 6
UM1785
LL PWR Generic Driver
Parameters
WakeUpPin: This parameter can be one of the following
values: (*) not available on all devices
LL_PWR_WAKEUP_PIN1
LL_PWR_WAKEUP_PIN2
LL_PWR_WAKEUP_PIN3 (*)
LL_PWR_WAKEUP_PIN4 (*)
LL_PWR_WAKEUP_PIN5 (*)
LL_PWR_WAKEUP_PIN6 (*)
LL_PWR_WAKEUP_PIN7 (*)
LL_PWR_WAKEUP_PIN8 (*)
Return values
None
Reference Manual to
LL API cross
reference:
CSR EWUP1 LL_PWR_DisableWakeUpPin
CSR EWUP2 LL_PWR_DisableWakeUpPin
CSR EWUP3 LL_PWR_DisableWakeUpPin
CSR EWUP4 LL_PWR_DisableWakeUpPin
CSR EWUP5 LL_PWR_DisableWakeUpPin
CSR EWUP6 LL_PWR_DisableWakeUpPin
CSR EWUP7 LL_PWR_DisableWakeUpPin
CSR EWUP8 LL_PWR_DisableWakeUpPin
LL_PWR_IsEnabledWakeUpPin
Function name
__STATIC_INLINE uint32_t LL_PWR_IsEnabledWakeUpPin
(uint32_t WakeUpPin)
Function description
Check if the WakeUp PINx functionality is enabled.
Parameters
WakeUpPin: This parameter can be one of the following
values: (*) not available on all devices
LL_PWR_WAKEUP_PIN1
LL_PWR_WAKEUP_PIN2
LL_PWR_WAKEUP_PIN3 (*)
LL_PWR_WAKEUP_PIN4 (*)
LL_PWR_WAKEUP_PIN5 (*)
LL_PWR_WAKEUP_PIN6 (*)
LL_PWR_WAKEUP_PIN7 (*)
LL_PWR_WAKEUP_PIN8 (*)
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CSR EWUP1 LL_PWR_IsEnabledWakeUpPin
CSR EWUP2 LL_PWR_IsEnabledWakeUpPin
CSR EWUP3 LL_PWR_IsEnabledWakeUpPin
CSR EWUP4 LL_PWR_IsEnabledWakeUpPin
DocID026525 Rev 6
917/1320
LL PWR Generic Driver
UM1785
CSR EWUP5 LL_PWR_IsEnabledWakeUpPin
CSR EWUP6 LL_PWR_IsEnabledWakeUpPin
CSR EWUP7 LL_PWR_IsEnabledWakeUpPin
CSR EWUP8 LL_PWR_IsEnabledWakeUpPin
LL_PWR_IsActiveFlag_WU
Function name
__STATIC_INLINE uint32_t LL_PWR_IsActiveFlag_WU (void )
Function description
Get Wake-up Flag.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CSR WUF LL_PWR_IsActiveFlag_WU
LL_PWR_IsActiveFlag_SB
Function name
__STATIC_INLINE uint32_t LL_PWR_IsActiveFlag_SB (void )
Function description
Get Standby Flag.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CSR SBF LL_PWR_IsActiveFlag_SB
LL_PWR_IsActiveFlag_PVDO
Function name
__STATIC_INLINE uint32_t LL_PWR_IsActiveFlag_PVDO (void
)
Function description
Indicate whether VDD voltage is below the selected PVD
threshold.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CSR PVDO LL_PWR_IsActiveFlag_PVDO
LL_PWR_IsActiveFlag_VREFINTRDY
918/1320
Function name
__STATIC_INLINE uint32_t
LL_PWR_IsActiveFlag_VREFINTRDY (void )
Function description
Get Internal Reference VrefInt Flag.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CSR VREFINTRDYF LL_PWR_IsActiveFlag_VREFINTRDY
DocID026525 Rev 6
UM1785
LL PWR Generic Driver
LL_PWR_ClearFlag_SB
Function name
__STATIC_INLINE void LL_PWR_ClearFlag_SB (void )
Function description
Clear Standby Flag.
Return values
None
Reference Manual to
LL API cross
reference:
CR CSBF LL_PWR_ClearFlag_SB
LL_PWR_ClearFlag_WU
Function name
__STATIC_INLINE void LL_PWR_ClearFlag_WU (void )
Function description
Clear Wake-up Flags.
Return values
None
Reference Manual to
LL API cross
reference:
CR CWUF LL_PWR_ClearFlag_WU
LL_PWR_DeInit
Function name
ErrorStatus LL_PWR_DeInit (void )
Function description
De-initialize the PWR registers to their default reset values.
Return values
An: ErrorStatus enumeration value:
SUCCESS: PWR registers are de-initialized
ERROR: not applicable
62.2
PWR Firmware driver defines
62.2.1
PWR
Clear Flags Defines
LL_PWR_CR_CSBF
Clear standby flag
LL_PWR_CR_CWUF
Clear wakeup flag
Get Flags Defines
LL_PWR_CSR_WUF
Wakeup flag
LL_PWR_CSR_SBF
Standby flag
LL_PWR_CSR_PVDO
Power voltage detector output flag
LL_PWR_CSR_VREFINTRDYF
VREFINT ready flag
LL_PWR_CSR_EWUP1
Enable WKUP pin 1
LL_PWR_CSR_EWUP2
Enable WKUP pin 2
LL_PWR_CSR_EWUP3
Enable WKUP pin 3
LL_PWR_CSR_EWUP4
Enable WKUP pin 4
LL_PWR_CSR_EWUP5
Enable WKUP pin 5
DocID026525 Rev 6
919/1320
LL PWR Generic Driver
LL_PWR_CSR_EWUP6
Enable WKUP pin 6
UM1785
LL_PWR_CSR_EWUP7
Enable WKUP pin 7
LL_PWR_CSR_EWUP8
Enable WKUP pin 8
Mode Power
LL_PWR_MODE_STOP_MAINREGU
Enter Stop mode when the CPU enters deepsleep
LL_PWR_MODE_STOP_LPREGU
Enter Stop mode (with low power Regulator ON)
when the CPU enters deepsleep
LL_PWR_MODE_STANDBY
Enter Standby mode when the CPU enters
deepsleep
Power Voltage Detector Level
LL_PWR_PVDLEVEL_0
Voltage threshold 0
LL_PWR_PVDLEVEL_1
Voltage threshold 1
LL_PWR_PVDLEVEL_2
Voltage threshold 2
LL_PWR_PVDLEVEL_3
Voltage threshold 3
LL_PWR_PVDLEVEL_4
Voltage threshold 4
LL_PWR_PVDLEVEL_5
Voltage threshold 5
LL_PWR_PVDLEVEL_6
Voltage threshold 6
LL_PWR_PVDLEVEL_7
Voltage threshold 7
Regulator Mode In Deep Sleep Mode
LL_PWR_REGU_DSMODE_MAIN
Voltage Regulator in main mode during
deepsleep mode
LL_PWR_REGU_DSMODE_LOW_POWER
Voltage Regulator in low-power mode during
deepsleep mode
Wakeup Pins
920/1320
LL_PWR_WAKEUP_PIN1
WKUP pin 1 : PA0
LL_PWR_WAKEUP_PIN2
WKUP pin 2 : PC13
LL_PWR_WAKEUP_PIN3
WKUP pin 3 : PE6 or PA2 according to device
LL_PWR_WAKEUP_PIN4
WKUP pin 4 : LLG TBD
LL_PWR_WAKEUP_PIN5
WKUP pin 5 : LLG TBD
LL_PWR_WAKEUP_PIN6
WKUP pin 6 : LLG TBD
LL_PWR_WAKEUP_PIN7
WKUP pin 7 : LLG TBD
LL_PWR_WAKEUP_PIN8
WKUP pin 8 : LLG TBD
DocID026525 Rev 6
UM1785
LL PWR Generic Driver
Common write and read registers Macros
LL_PWR_WriteReg
Description:
Write a value in PWR register.
Parameters:
__REG__: Register to be written
__VALUE__: Value to be written in the register
Return value:
None
LL_PWR_ReadReg
Description:
Read a value in PWR register.
Parameters:
__REG__: Register to be read
Return value:
Register: value
DocID026525 Rev 6
921/1320
LL RCC Generic Driver
UM1785
63
LL RCC Generic Driver
63.1
RCC Firmware driver registers structures
63.1.1
LL_RCC_ClocksTypeDef
Data Fields
uint32_t SYSCLK_Frequency
uint32_t HCLK_Frequency
uint32_t PCLK1_Frequency
Field Documentation
uint32_t LL_RCC_ClocksTypeDef::SYSCLK_Frequency
SYSCLK clock frequency
uint32_t LL_RCC_ClocksTypeDef::HCLK_Frequency
HCLK clock frequency
uint32_t LL_RCC_ClocksTypeDef::PCLK1_Frequency
PCLK1 clock frequency
63.2
RCC Firmware driver API description
63.2.1
Detailed description of functions
LL_RCC_HSE_EnableCSS
Function name
__STATIC_INLINE void LL_RCC_HSE_EnableCSS (void )
Function description
Enable the Clock Security System.
Return values
None
Reference Manual to
LL API cross
reference:
CR CSSON LL_RCC_HSE_EnableCSS
LL_RCC_HSE_DisableCSS
Function name
__STATIC_INLINE void LL_RCC_HSE_DisableCSS (void )
Function description
Disable the Clock Security System.
Return values
None
Notes
Cannot be disabled in HSE is ready (only by hardware)
Reference Manual to
LL API cross
reference:
CR CSSON LL_RCC_HSE_DisableCSS
LL_RCC_HSE_EnableBypass
922/1320
Function name
__STATIC_INLINE void LL_RCC_HSE_EnableBypass (void )
Function description
Enable HSE external oscillator (HSE Bypass)
DocID026525 Rev 6
UM1785
LL RCC Generic Driver
Return values
None
Reference Manual to
LL API cross
reference:
CR HSEBYP LL_RCC_HSE_EnableBypass
LL_RCC_HSE_DisableBypass
Function name
__STATIC_INLINE void LL_RCC_HSE_DisableBypass (void )
Function description
Disable HSE external oscillator (HSE Bypass)
Return values
None
Reference Manual to
LL API cross
reference:
CR HSEBYP LL_RCC_HSE_DisableBypass
LL_RCC_HSE_Enable
Function name
__STATIC_INLINE void LL_RCC_HSE_Enable (void )
Function description
Enable HSE crystal oscillator (HSE ON)
Return values
None
Reference Manual to
LL API cross
reference:
CR HSEON LL_RCC_HSE_Enable
LL_RCC_HSE_Disable
Function name
__STATIC_INLINE void LL_RCC_HSE_Disable (void )
Function description
Disable HSE crystal oscillator (HSE ON)
Return values
None
Reference Manual to
LL API cross
reference:
CR HSEON LL_RCC_HSE_Disable
LL_RCC_HSE_IsReady
Function name
__STATIC_INLINE uint32_t LL_RCC_HSE_IsReady (void )
Function description
Check if HSE oscillator Ready.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR HSERDY LL_RCC_HSE_IsReady
LL_RCC_HSI_Enable
Function name
__STATIC_INLINE void LL_RCC_HSI_Enable (void )
Function description
Enable HSI oscillator.
Return values
None
DocID026525 Rev 6
923/1320
LL RCC Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
CR HSION LL_RCC_HSI_Enable
LL_RCC_HSI_Disable
Function name
__STATIC_INLINE void LL_RCC_HSI_Disable (void )
Function description
Disable HSI oscillator.
Return values
None
Reference Manual to
LL API cross
reference:
CR HSION LL_RCC_HSI_Disable
LL_RCC_HSI_IsReady
Function name
__STATIC_INLINE uint32_t LL_RCC_HSI_IsReady (void )
Function description
Check if HSI clock is ready.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR HSIRDY LL_RCC_HSI_IsReady
LL_RCC_HSI_GetCalibration
Function name
__STATIC_INLINE uint32_t LL_RCC_HSI_GetCalibration (void
)
Function description
Get HSI Calibration value.
Return values
Between: Min_Data = 0x00 and Max_Data = 0xFF
Notes
When HSITRIM is written, HSICAL is updated with the sum of
HSITRIM and the factory trim value
Reference Manual to
LL API cross
reference:
CR HSICAL LL_RCC_HSI_GetCalibration
LL_RCC_HSI_SetCalibTrimming
924/1320
Function name
__STATIC_INLINE void LL_RCC_HSI_SetCalibTrimming
(uint32_t Value)
Function description
Set HSI Calibration trimming.
Parameters
Value: between Min_Data = 0x00 and Max_Data = 0x1F
Return values
None
Notes
user-programmable trimming value that is added to the
HSICAL
Default value is 16, which, when added to the HSICAL value,
should trim the HSI to 16 MHz +/- 1 %
DocID026525 Rev 6
UM1785
LL RCC Generic Driver
Reference Manual to
LL API cross
reference:
CR HSITRIM LL_RCC_HSI_SetCalibTrimming
LL_RCC_HSI_GetCalibTrimming
Function name
__STATIC_INLINE uint32_t LL_RCC_HSI_GetCalibTrimming
(void )
Function description
Get HSI Calibration trimming.
Return values
Between: Min_Data = 0x00 and Max_Data = 0x1F
Reference Manual to
LL API cross
reference:
CR HSITRIM LL_RCC_HSI_GetCalibTrimming
LL_RCC_HSI48_Enable
Function name
__STATIC_INLINE void LL_RCC_HSI48_Enable (void )
Function description
Enable HSI48.
Return values
None
Reference Manual to
LL API cross
reference:
CR2 HSI48ON LL_RCC_HSI48_Enable
LL_RCC_HSI48_Disable
Function name
__STATIC_INLINE void LL_RCC_HSI48_Disable (void )
Function description
Disable HSI48.
Return values
None
Reference Manual to
LL API cross
reference:
CR2 HSI48ON LL_RCC_HSI48_Disable
LL_RCC_HSI48_IsReady
Function name
__STATIC_INLINE uint32_t LL_RCC_HSI48_IsReady (void )
Function description
Check if HSI48 oscillator Ready.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR2 HSI48RDY LL_RCC_HSI48_IsReady
LL_RCC_HSI48_GetCalibration
Function name
__STATIC_INLINE uint32_t LL_RCC_HSI48_GetCalibration
(void )
Function description
Get HSI48 Calibration value.
DocID026525 Rev 6
925/1320
LL RCC Generic Driver
Return values
UM1785
Between: Min_Data = 0x00 and Max_Data = 0xFF
Reference Manual to
LL API cross
reference:
CR2 HSI48CAL LL_RCC_HSI48_GetCalibration
LL_RCC_HSI14_Enable
Function name
__STATIC_INLINE void LL_RCC_HSI14_Enable (void )
Function description
Enable HSI14.
Return values
None
Reference Manual to
LL API cross
reference:
CR2 HSI14ON LL_RCC_HSI14_Enable
LL_RCC_HSI14_Disable
Function name
__STATIC_INLINE void LL_RCC_HSI14_Disable (void )
Function description
Disable HSI14.
Return values
None
Reference Manual to
LL API cross
reference:
CR2 HSI14ON LL_RCC_HSI14_Disable
LL_RCC_HSI14_IsReady
Function name
__STATIC_INLINE uint32_t LL_RCC_HSI14_IsReady (void )
Function description
Check if HSI14 oscillator Ready.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR2 HSI14RDY LL_RCC_HSI14_IsReady
LL_RCC_HSI14_EnableADCControl
926/1320
Function name
__STATIC_INLINE void LL_RCC_HSI14_EnableADCControl
(void )
Function description
ADC interface can turn on the HSI14 oscillator.
Return values
None
Reference Manual to
LL API cross
reference:
CR2 HSI14DIS LL_RCC_HSI14_EnableADCControl
DocID026525 Rev 6
UM1785
LL RCC Generic Driver
LL_RCC_HSI14_DisableADCControl
Function name
__STATIC_INLINE void LL_RCC_HSI14_DisableADCControl
(void )
Function description
ADC interface can not turn on the HSI14 oscillator.
Return values
None
Reference Manual to
LL API cross
reference:
CR2 HSI14DIS LL_RCC_HSI14_DisableADCControl
LL_RCC_HSI14_SetCalibTrimming
Function name
__STATIC_INLINE void LL_RCC_HSI14_SetCalibTrimming
(uint32_t Value)
Function description
Set HSI14 Calibration trimming.
Parameters
Value: between Min_Data = 0x00 and Max_Data = 0xFF
Return values
None
Notes
user-programmable trimming value that is added to the
HSI14CAL
Default value is 16, which, when added to the HSI14CAL
value, should trim the HSI14 to 14 MHz +/- 1 %
Reference Manual to
LL API cross
reference:
CR2 HSI14TRIM LL_RCC_HSI14_SetCalibTrimming
LL_RCC_HSI14_GetCalibTrimming
Function name
__STATIC_INLINE uint32_t LL_RCC_HSI14_GetCalibTrimming
(void )
Function description
Get HSI14 Calibration value.
Return values
Between: Min_Data = 0x00 and Max_Data = 0x1F
Notes
When HSI14TRIM is written, HSI14CAL is updated with the
sum of HSI14TRIM and the factory trim value
Reference Manual to
LL API cross
reference:
CR2 HSI14TRIM LL_RCC_HSI14_GetCalibTrimming
LL_RCC_HSI14_GetCalibration
Function name
__STATIC_INLINE uint32_t LL_RCC_HSI14_GetCalibration
(void )
Function description
Get HSI14 Calibration trimming.
Return values
Between: Min_Data = 0x00 and Max_Data = 0x1F
Reference Manual to
LL API cross
reference:
CR2 HSI14CAL LL_RCC_HSI14_GetCalibration
DocID026525 Rev 6
927/1320
LL RCC Generic Driver
UM1785
LL_RCC_LSE_Enable
Function name
__STATIC_INLINE void LL_RCC_LSE_Enable (void )
Function description
Enable Low Speed External (LSE) crystal.
Return values
None
Reference Manual to
LL API cross
reference:
BDCR LSEON LL_RCC_LSE_Enable
LL_RCC_LSE_Disable
Function name
__STATIC_INLINE void LL_RCC_LSE_Disable (void )
Function description
Disable Low Speed External (LSE) crystal.
Return values
None
Reference Manual to
LL API cross
reference:
BDCR LSEON LL_RCC_LSE_Disable
LL_RCC_LSE_EnableBypass
Function name
__STATIC_INLINE void LL_RCC_LSE_EnableBypass (void )
Function description
Enable external clock source (LSE bypass).
Return values
None
Reference Manual to
LL API cross
reference:
BDCR LSEBYP LL_RCC_LSE_EnableBypass
LL_RCC_LSE_DisableBypass
Function name
__STATIC_INLINE void LL_RCC_LSE_DisableBypass (void )
Function description
Disable external clock source (LSE bypass).
Return values
None
Reference Manual to
LL API cross
reference:
BDCR LSEBYP LL_RCC_LSE_DisableBypass
LL_RCC_LSE_SetDriveCapability
Function name
__STATIC_INLINE void LL_RCC_LSE_SetDriveCapability
(uint32_t LSEDrive)
Function description
Set LSE oscillator drive capability.
Parameters
928/1320
LSEDrive: This parameter can be one of the following
values:
LL_RCC_LSEDRIVE_LOW
LL_RCC_LSEDRIVE_MEDIUMLOW
LL_RCC_LSEDRIVE_MEDIUMHIGH
LL_RCC_LSEDRIVE_HIGH
DocID026525 Rev 6
UM1785
LL RCC Generic Driver
Return values
None
Notes
The oscillator is in Xtal mode when it is not in bypass mode.
Reference Manual to
LL API cross
reference:
BDCR LSEDRV LL_RCC_LSE_SetDriveCapability
LL_RCC_LSE_GetDriveCapability
Function name
__STATIC_INLINE uint32_t LL_RCC_LSE_GetDriveCapability
(void )
Function description
Get LSE oscillator drive capability.
Return values
Returned: value can be one of the following values:
LL_RCC_LSEDRIVE_LOW
LL_RCC_LSEDRIVE_MEDIUMLOW
LL_RCC_LSEDRIVE_MEDIUMHIGH
LL_RCC_LSEDRIVE_HIGH
Reference Manual to
LL API cross
reference:
BDCR LSEDRV LL_RCC_LSE_GetDriveCapability
LL_RCC_LSE_IsReady
Function name
__STATIC_INLINE uint32_t LL_RCC_LSE_IsReady (void )
Function description
Check if LSE oscillator Ready.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
BDCR LSERDY LL_RCC_LSE_IsReady
LL_RCC_LSI_Enable
Function name
__STATIC_INLINE void LL_RCC_LSI_Enable (void )
Function description
Enable LSI Oscillator.
Return values
None
Reference Manual to
LL API cross
reference:
CSR LSION LL_RCC_LSI_Enable
LL_RCC_LSI_Disable
Function name
__STATIC_INLINE void LL_RCC_LSI_Disable (void )
Function description
Disable LSI Oscillator.
Return values
None
Reference Manual to
LL API cross
reference:
CSR LSION LL_RCC_LSI_Disable
DocID026525 Rev 6
929/1320
LL RCC Generic Driver
UM1785
LL_RCC_LSI_IsReady
Function name
__STATIC_INLINE uint32_t LL_RCC_LSI_IsReady (void )
Function description
Check if LSI is Ready.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CSR LSIRDY LL_RCC_LSI_IsReady
LL_RCC_SetSysClkSource
Function name
__STATIC_INLINE void LL_RCC_SetSysClkSource (uint32_t
Source)
Function description
Configure the system clock source.
Parameters
Source: This parameter can be one of the following values:
(*) value not defined in all devices
LL_RCC_SYS_CLKSOURCE_HSI
LL_RCC_SYS_CLKSOURCE_HSE
LL_RCC_SYS_CLKSOURCE_PLL
LL_RCC_SYS_CLKSOURCE_HSI48 (*)
Return values
None
Reference Manual to
LL API cross
reference:
CFGR SW LL_RCC_SetSysClkSource
LL_RCC_GetSysClkSource
Function name
__STATIC_INLINE uint32_t LL_RCC_GetSysClkSource (void )
Function description
Get the system clock source.
Return values
Returned: value can be one of the following values: (*)
value not defined in all devices
LL_RCC_SYS_CLKSOURCE_STATUS_HSI
LL_RCC_SYS_CLKSOURCE_STATUS_HSE
LL_RCC_SYS_CLKSOURCE_STATUS_PLL
LL_RCC_SYS_CLKSOURCE_STATUS_HSI48 (*)
Reference Manual to
LL API cross
reference:
CFGR SWS LL_RCC_GetSysClkSource
LL_RCC_SetAHBPrescaler
Function name
__STATIC_INLINE void LL_RCC_SetAHBPrescaler (uint32_t
Prescaler)
Function description
Set AHB prescaler.
Parameters
930/1320
Prescaler: This parameter can be one of the following
values:
LL_RCC_SYSCLK_DIV_1
LL_RCC_SYSCLK_DIV_2
DocID026525 Rev 6
UM1785
LL RCC Generic Driver
LL_RCC_SYSCLK_DIV_4
LL_RCC_SYSCLK_DIV_8
LL_RCC_SYSCLK_DIV_16
LL_RCC_SYSCLK_DIV_64
LL_RCC_SYSCLK_DIV_128
LL_RCC_SYSCLK_DIV_256
LL_RCC_SYSCLK_DIV_512
Return values
None
Reference Manual to
LL API cross
reference:
CFGR HPRE LL_RCC_SetAHBPrescaler
LL_RCC_SetAPB1Prescaler
Function name
__STATIC_INLINE void LL_RCC_SetAPB1Prescaler (uint32_t
Prescaler)
Function description
Set APB1 prescaler.
Parameters
Prescaler: This parameter can be one of the following
values:
LL_RCC_APB1_DIV_1
LL_RCC_APB1_DIV_2
LL_RCC_APB1_DIV_4
LL_RCC_APB1_DIV_8
LL_RCC_APB1_DIV_16
Return values
None
Reference Manual to
LL API cross
reference:
CFGR PPRE LL_RCC_SetAPB1Prescaler
LL_RCC_GetAHBPrescaler
Function name
__STATIC_INLINE uint32_t LL_RCC_GetAHBPrescaler (void )
Function description
Get AHB prescaler.
Return values
Returned: value can be one of the following values:
LL_RCC_SYSCLK_DIV_1
LL_RCC_SYSCLK_DIV_2
LL_RCC_SYSCLK_DIV_4
LL_RCC_SYSCLK_DIV_8
LL_RCC_SYSCLK_DIV_16
LL_RCC_SYSCLK_DIV_64
LL_RCC_SYSCLK_DIV_128
LL_RCC_SYSCLK_DIV_256
LL_RCC_SYSCLK_DIV_512
Reference Manual to
LL API cross
reference:
CFGR HPRE LL_RCC_GetAHBPrescaler
DocID026525 Rev 6
931/1320
LL RCC Generic Driver
UM1785
LL_RCC_GetAPB1Prescaler
Function name
__STATIC_INLINE uint32_t LL_RCC_GetAPB1Prescaler (void )
Function description
Get APB1 prescaler.
Return values
Returned: value can be one of the following values:
LL_RCC_APB1_DIV_1
LL_RCC_APB1_DIV_2
LL_RCC_APB1_DIV_4
LL_RCC_APB1_DIV_8
LL_RCC_APB1_DIV_16
Reference Manual to
LL API cross
reference:
CFGR PPRE LL_RCC_GetAPB1Prescaler
LL_RCC_ConfigMCO
932/1320
Function name
__STATIC_INLINE void LL_RCC_ConfigMCO (uint32_t
MCOxSource, uint32_t MCOxPrescaler)
Function description
Configure MCOx.
Parameters
MCOxSource: This parameter can be one of the following
values: (*) value not defined in all devices
LL_RCC_MCO1SOURCE_NOCLOCK
LL_RCC_MCO1SOURCE_HSI14
LL_RCC_MCO1SOURCE_SYSCLK
LL_RCC_MCO1SOURCE_HSI
LL_RCC_MCO1SOURCE_HSE
LL_RCC_MCO1SOURCE_LSI
LL_RCC_MCO1SOURCE_LSE
LL_RCC_MCO1SOURCE_HSI48 (*)
LL_RCC_MCO1SOURCE_PLLCLK (*)
LL_RCC_MCO1SOURCE_PLLCLK_DIV_2
MCOxPrescaler: This parameter can be one of the following
values: (*) value not defined in all devices
LL_RCC_MCO1_DIV_1
LL_RCC_MCO1_DIV_2 (*)
LL_RCC_MCO1_DIV_4 (*)
LL_RCC_MCO1_DIV_8 (*)
LL_RCC_MCO1_DIV_16 (*)
LL_RCC_MCO1_DIV_32 (*)
LL_RCC_MCO1_DIV_64 (*)
LL_RCC_MCO1_DIV_128 (*)
Return values
None
Reference Manual to
LL API cross
reference:
CFGR MCO LL_RCC_ConfigMCO
CFGR MCOPRE LL_RCC_ConfigMCO
CFGR PLLNODIV LL_RCC_ConfigMCO
DocID026525 Rev 6
UM1785
LL RCC Generic Driver
LL_RCC_SetUSARTClockSource
Function name
__STATIC_INLINE void LL_RCC_SetUSARTClockSource
(uint32_t USARTxSource)
Function description
Configure USARTx clock source.
Parameters
USARTxSource: This parameter can be one of the following
values: (*) value not defined in all devices.
LL_RCC_USART1_CLKSOURCE_PCLK1
LL_RCC_USART1_CLKSOURCE_SYSCLK
LL_RCC_USART1_CLKSOURCE_LSE
LL_RCC_USART1_CLKSOURCE_HSI
LL_RCC_USART2_CLKSOURCE_PCLK1 (*)
LL_RCC_USART2_CLKSOURCE_SYSCLK (*)
LL_RCC_USART2_CLKSOURCE_LSE (*)
LL_RCC_USART2_CLKSOURCE_HSI (*)
LL_RCC_USART3_CLKSOURCE_PCLK1 (*)
LL_RCC_USART3_CLKSOURCE_SYSCLK (*)
LL_RCC_USART3_CLKSOURCE_LSE (*)
LL_RCC_USART3_CLKSOURCE_HSI (*)
Return values
None
Reference Manual to
LL API cross
reference:
CFGR3 USART1SW LL_RCC_SetUSARTClockSource
CFGR3 USART2SW LL_RCC_SetUSARTClockSource
CFGR3 USART3SW LL_RCC_SetUSARTClockSource
LL_RCC_SetI2CClockSource
Function name
__STATIC_INLINE void LL_RCC_SetI2CClockSource (uint32_t
I2CxSource)
Function description
Configure I2Cx clock source.
Parameters
I2CxSource: This parameter can be one of the following
values:
LL_RCC_I2C1_CLKSOURCE_HSI
LL_RCC_I2C1_CLKSOURCE_SYSCLK
Return values
None
Reference Manual to
LL API cross
reference:
CFGR3 I2C1SW LL_RCC_SetI2CClockSource
LL_RCC_SetCECClockSource
Function name
__STATIC_INLINE void LL_RCC_SetCECClockSource
(uint32_t CECxSource)
Function description
Configure CEC clock source.
Parameters
CECxSource: This parameter can be one of the following
values:
LL_RCC_CEC_CLKSOURCE_HSI_DIV244
LL_RCC_CEC_CLKSOURCE_LSE
Return values
None
DocID026525 Rev 6
933/1320
LL RCC Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
CFGR3 CECSW LL_RCC_SetCECClockSource
LL_RCC_GetUSARTClockSource
Function name
__STATIC_INLINE uint32_t LL_RCC_GetUSARTClockSource
(uint32_t USARTx)
Function description
Get USARTx clock source.
Parameters
USARTx: This parameter can be one of the following values:
(*) value not defined in all devices.
LL_RCC_USART1_CLKSOURCE
LL_RCC_USART2_CLKSOURCE (*)
LL_RCC_USART3_CLKSOURCE (*)
Return values
Returned: value can be one of the following values: (*)
value not defined in all devices.
LL_RCC_USART1_CLKSOURCE_PCLK1
LL_RCC_USART1_CLKSOURCE_SYSCLK
LL_RCC_USART1_CLKSOURCE_LSE
LL_RCC_USART1_CLKSOURCE_HSI
LL_RCC_USART2_CLKSOURCE_PCLK1 (*)
LL_RCC_USART2_CLKSOURCE_SYSCLK (*)
LL_RCC_USART2_CLKSOURCE_LSE (*)
LL_RCC_USART2_CLKSOURCE_HSI (*)
LL_RCC_USART3_CLKSOURCE_PCLK1 (*)
LL_RCC_USART3_CLKSOURCE_SYSCLK (*)
LL_RCC_USART3_CLKSOURCE_LSE (*)
LL_RCC_USART3_CLKSOURCE_HSI (*)
Reference Manual to
LL API cross
reference:
CFGR3 USART1SW LL_RCC_GetUSARTClockSource
CFGR3 USART2SW LL_RCC_GetUSARTClockSource
CFGR3 USART3SW LL_RCC_GetUSARTClockSource
LL_RCC_GetI2CClockSource
934/1320
Function name
__STATIC_INLINE uint32_t LL_RCC_GetI2CClockSource
(uint32_t I2Cx)
Function description
Get I2Cx clock source.
Parameters
I2Cx: This parameter can be one of the following values:
LL_RCC_I2C1_CLKSOURCE
Return values
Returned: value can be one of the following values:
LL_RCC_I2C1_CLKSOURCE_HSI
LL_RCC_I2C1_CLKSOURCE_SYSCLK
Reference Manual to
LL API cross
reference:
CFGR3 I2C1SW LL_RCC_GetI2CClockSource
DocID026525 Rev 6
UM1785
LL RCC Generic Driver
LL_RCC_GetCECClockSource
Function name
__STATIC_INLINE uint32_t LL_RCC_GetCECClockSource
(uint32_t CECx)
Function description
Get CEC clock source.
Parameters
CECx: This parameter can be one of the following values:
LL_RCC_CEC_CLKSOURCE
Return values
Returned: value can be one of the following values:
LL_RCC_CEC_CLKSOURCE_HSI_DIV244
LL_RCC_CEC_CLKSOURCE_LSE
Reference Manual to
LL API cross
reference:
CFGR3 CECSW LL_RCC_GetCECClockSource
LL_RCC_SetRTCClockSource
Function name
__STATIC_INLINE void LL_RCC_SetRTCClockSource
(uint32_t Source)
Function description
Set RTC Clock Source.
Parameters
Source: This parameter can be one of the following values:
LL_RCC_RTC_CLKSOURCE_NONE
LL_RCC_RTC_CLKSOURCE_LSE
LL_RCC_RTC_CLKSOURCE_LSI
LL_RCC_RTC_CLKSOURCE_HSE_DIV32
Return values
None
Notes
Once the RTC clock source has been selected, it cannot be
changed any more unless the Backup domain is reset. The
BDRST bit can be used to reset them.
Reference Manual to
LL API cross
reference:
BDCR RTCSEL LL_RCC_SetRTCClockSource
LL_RCC_GetRTCClockSource
Function name
__STATIC_INLINE uint32_t LL_RCC_GetRTCClockSource
(void )
Function description
Get RTC Clock Source.
Return values
Returned: value can be one of the following values:
LL_RCC_RTC_CLKSOURCE_NONE
LL_RCC_RTC_CLKSOURCE_LSE
LL_RCC_RTC_CLKSOURCE_LSI
LL_RCC_RTC_CLKSOURCE_HSE_DIV32
Reference Manual to
LL API cross
reference:
BDCR RTCSEL LL_RCC_GetRTCClockSource
DocID026525 Rev 6
935/1320
LL RCC Generic Driver
UM1785
LL_RCC_EnableRTC
Function name
__STATIC_INLINE void LL_RCC_EnableRTC (void )
Function description
Enable RTC.
Return values
None
Reference Manual to
LL API cross
reference:
BDCR RTCEN LL_RCC_EnableRTC
LL_RCC_DisableRTC
Function name
__STATIC_INLINE void LL_RCC_DisableRTC (void )
Function description
Disable RTC.
Return values
None
Reference Manual to
LL API cross
reference:
BDCR RTCEN LL_RCC_DisableRTC
LL_RCC_IsEnabledRTC
Function name
__STATIC_INLINE uint32_t LL_RCC_IsEnabledRTC (void )
Function description
Check if RTC has been enabled or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
BDCR RTCEN LL_RCC_IsEnabledRTC
LL_RCC_ForceBackupDomainReset
Function name
__STATIC_INLINE void LL_RCC_ForceBackupDomainReset
(void )
Function description
Force the Backup domain reset.
Return values
None
Reference Manual to
LL API cross
reference:
BDCR BDRST LL_RCC_ForceBackupDomainReset
LL_RCC_ReleaseBackupDomainReset
936/1320
Function name
__STATIC_INLINE void LL_RCC_ReleaseBackupDomainReset
(void )
Function description
Release the Backup domain reset.
Return values
None
Reference Manual to
LL API cross
reference:
BDCR BDRST LL_RCC_ReleaseBackupDomainReset
DocID026525 Rev 6
UM1785
LL RCC Generic Driver
LL_RCC_PLL_Enable
Function name
__STATIC_INLINE void LL_RCC_PLL_Enable (void )
Function description
Enable PLL.
Return values
None
Reference Manual to
LL API cross
reference:
CR PLLON LL_RCC_PLL_Enable
LL_RCC_PLL_Disable
Function name
__STATIC_INLINE void LL_RCC_PLL_Disable (void )
Function description
Disable PLL.
Return values
None
Notes
Cannot be disabled if the PLL clock is used as the system
clock
Reference Manual to
LL API cross
reference:
CR PLLON LL_RCC_PLL_Disable
LL_RCC_PLL_IsReady
Function name
__STATIC_INLINE uint32_t LL_RCC_PLL_IsReady (void )
Function description
Check if PLL Ready.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR PLLRDY LL_RCC_PLL_IsReady
LL_RCC_PLL_ConfigDomain_SYS
Function name
__STATIC_INLINE void LL_RCC_PLL_ConfigDomain_SYS
(uint32_t Source, uint32_t PLLMul, uint32_t PLLDiv)
Function description
Configure PLL used for SYSCLK Domain.
Parameters
Source: This parameter can be one of the following values:
(*) value not defined in all devices
LL_RCC_PLLSOURCE_HSI
LL_RCC_PLLSOURCE_HSE
LL_RCC_PLLSOURCE_HSI48 (*)
PLLMul: This parameter can be one of the following values:
LL_RCC_PLL_MUL_2
LL_RCC_PLL_MUL_3
LL_RCC_PLL_MUL_4
LL_RCC_PLL_MUL_5
LL_RCC_PLL_MUL_6
LL_RCC_PLL_MUL_7
LL_RCC_PLL_MUL_8
LL_RCC_PLL_MUL_9
DocID026525 Rev 6
937/1320
LL RCC Generic Driver
UM1785
LL_RCC_PLL_MUL_10
LL_RCC_PLL_MUL_11
LL_RCC_PLL_MUL_12
LL_RCC_PLL_MUL_13
LL_RCC_PLL_MUL_14
LL_RCC_PLL_MUL_15
LL_RCC_PLL_MUL_16
PLLDiv: This parameter can be one of the following values:
LL_RCC_PREDIV_DIV_1
LL_RCC_PREDIV_DIV_2
LL_RCC_PREDIV_DIV_3
LL_RCC_PREDIV_DIV_4
LL_RCC_PREDIV_DIV_5
LL_RCC_PREDIV_DIV_6
LL_RCC_PREDIV_DIV_7
LL_RCC_PREDIV_DIV_8
LL_RCC_PREDIV_DIV_9
LL_RCC_PREDIV_DIV_10
LL_RCC_PREDIV_DIV_11
LL_RCC_PREDIV_DIV_12
LL_RCC_PREDIV_DIV_13
LL_RCC_PREDIV_DIV_14
LL_RCC_PREDIV_DIV_15
LL_RCC_PREDIV_DIV_16
Return values
None
Reference Manual to
LL API cross
reference:
CFGR PLLSRC LL_RCC_PLL_ConfigDomain_SYS
CFGR PLLMUL LL_RCC_PLL_ConfigDomain_SYS
CFGR2 PREDIV LL_RCC_PLL_ConfigDomain_SYS
LL_RCC_PLL_GetMainSource
Function name
__STATIC_INLINE uint32_t LL_RCC_PLL_GetMainSource
(void )
Function description
Get the oscillator used as PLL clock source.
Return values
Returned: value can be one of the following values: (*)
value not defined in all devices
LL_RCC_PLLSOURCE_HSI (*)
LL_RCC_PLLSOURCE_HSI_DIV_2 (*)
LL_RCC_PLLSOURCE_HSE
LL_RCC_PLLSOURCE_HSI48 (*)
Reference Manual to
LL API cross
reference:
CFGR PLLSRC LL_RCC_PLL_GetMainSource
LL_RCC_PLL_GetMultiplicator
938/1320
Function name
__STATIC_INLINE uint32_t LL_RCC_PLL_GetMultiplicator
(void )
Function description
Get PLL multiplication Factor.
DocID026525 Rev 6
UM1785
LL RCC Generic Driver
Return values
Returned: value can be one of the following values:
LL_RCC_PLL_MUL_2
LL_RCC_PLL_MUL_3
LL_RCC_PLL_MUL_4
LL_RCC_PLL_MUL_5
LL_RCC_PLL_MUL_6
LL_RCC_PLL_MUL_7
LL_RCC_PLL_MUL_8
LL_RCC_PLL_MUL_9
LL_RCC_PLL_MUL_10
LL_RCC_PLL_MUL_11
LL_RCC_PLL_MUL_12
LL_RCC_PLL_MUL_13
LL_RCC_PLL_MUL_14
LL_RCC_PLL_MUL_15
LL_RCC_PLL_MUL_16
Reference Manual to
LL API cross
reference:
CFGR PLLMUL LL_RCC_PLL_GetMultiplicator
LL_RCC_PLL_GetPrediv
Function name
__STATIC_INLINE uint32_t LL_RCC_PLL_GetPrediv (void )
Function description
Get PREDIV division factor for the main PLL.
Return values
Returned: value can be one of the following values:
LL_RCC_PREDIV_DIV_1
LL_RCC_PREDIV_DIV_2
LL_RCC_PREDIV_DIV_3
LL_RCC_PREDIV_DIV_4
LL_RCC_PREDIV_DIV_5
LL_RCC_PREDIV_DIV_6
LL_RCC_PREDIV_DIV_7
LL_RCC_PREDIV_DIV_8
LL_RCC_PREDIV_DIV_9
LL_RCC_PREDIV_DIV_10
LL_RCC_PREDIV_DIV_11
LL_RCC_PREDIV_DIV_12
LL_RCC_PREDIV_DIV_13
LL_RCC_PREDIV_DIV_14
LL_RCC_PREDIV_DIV_15
LL_RCC_PREDIV_DIV_16
Notes
They can be written only when the PLL is disabled
Reference Manual to
LL API cross
reference:
CFGR2 PREDIV LL_RCC_PLL_GetPrediv
DocID026525 Rev 6
939/1320
LL RCC Generic Driver
UM1785
LL_RCC_ClearFlag_LSIRDY
Function name
__STATIC_INLINE void LL_RCC_ClearFlag_LSIRDY (void )
Function description
Clear LSI ready interrupt flag.
Return values
None
Reference Manual to
LL API cross
reference:
CIR LSIRDYC LL_RCC_ClearFlag_LSIRDY
LL_RCC_ClearFlag_LSERDY
Function name
__STATIC_INLINE void LL_RCC_ClearFlag_LSERDY (void )
Function description
Clear LSE ready interrupt flag.
Return values
None
Reference Manual to
LL API cross
reference:
CIR LSERDYC LL_RCC_ClearFlag_LSERDY
LL_RCC_ClearFlag_HSIRDY
Function name
__STATIC_INLINE void LL_RCC_ClearFlag_HSIRDY (void )
Function description
Clear HSI ready interrupt flag.
Return values
None
Reference Manual to
LL API cross
reference:
CIR HSIRDYC LL_RCC_ClearFlag_HSIRDY
LL_RCC_ClearFlag_HSERDY
Function name
__STATIC_INLINE void LL_RCC_ClearFlag_HSERDY (void )
Function description
Clear HSE ready interrupt flag.
Return values
None
Reference Manual to
LL API cross
reference:
CIR HSERDYC LL_RCC_ClearFlag_HSERDY
LL_RCC_ClearFlag_PLLRDY
940/1320
Function name
__STATIC_INLINE void LL_RCC_ClearFlag_PLLRDY (void )
Function description
Clear PLL ready interrupt flag.
Return values
None
Reference Manual to
LL API cross
reference:
CIR PLLRDYC LL_RCC_ClearFlag_PLLRDY
DocID026525 Rev 6
UM1785
LL RCC Generic Driver
LL_RCC_ClearFlag_HSI14RDY
Function name
__STATIC_INLINE void LL_RCC_ClearFlag_HSI14RDY (void )
Function description
Clear HSI14 ready interrupt flag.
Return values
None
Reference Manual to
LL API cross
reference:
CIR HSI14RDYC LL_RCC_ClearFlag_HSI14RDY
LL_RCC_ClearFlag_HSI48RDY
Function name
__STATIC_INLINE void LL_RCC_ClearFlag_HSI48RDY (void )
Function description
Clear HSI48 ready interrupt flag.
Return values
None
Reference Manual to
LL API cross
reference:
CIR HSI48RDYC LL_RCC_ClearFlag_HSI48RDY
LL_RCC_ClearFlag_HSECSS
Function name
__STATIC_INLINE void LL_RCC_ClearFlag_HSECSS (void )
Function description
Clear Clock security system interrupt flag.
Return values
None
Reference Manual to
LL API cross
reference:
CIR CSSC LL_RCC_ClearFlag_HSECSS
LL_RCC_IsActiveFlag_LSIRDY
Function name
__STATIC_INLINE uint32_t LL_RCC_IsActiveFlag_LSIRDY
(void )
Function description
Check if LSI ready interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CIR LSIRDYF LL_RCC_IsActiveFlag_LSIRDY
LL_RCC_IsActiveFlag_LSERDY
Function name
__STATIC_INLINE uint32_t LL_RCC_IsActiveFlag_LSERDY
(void )
Function description
Check if LSE ready interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CIR LSERDYF LL_RCC_IsActiveFlag_LSERDY
DocID026525 Rev 6
941/1320
LL RCC Generic Driver
UM1785
LL_RCC_IsActiveFlag_HSIRDY
Function name
__STATIC_INLINE uint32_t LL_RCC_IsActiveFlag_HSIRDY
(void )
Function description
Check if HSI ready interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CIR HSIRDYF LL_RCC_IsActiveFlag_HSIRDY
LL_RCC_IsActiveFlag_HSERDY
Function name
__STATIC_INLINE uint32_t LL_RCC_IsActiveFlag_HSERDY
(void )
Function description
Check if HSE ready interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CIR HSERDYF LL_RCC_IsActiveFlag_HSERDY
LL_RCC_IsActiveFlag_PLLRDY
Function name
__STATIC_INLINE uint32_t LL_RCC_IsActiveFlag_PLLRDY
(void )
Function description
Check if PLL ready interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CIR PLLRDYF LL_RCC_IsActiveFlag_PLLRDY
LL_RCC_IsActiveFlag_HSI14RDY
Function name
__STATIC_INLINE uint32_t LL_RCC_IsActiveFlag_HSI14RDY
(void )
Function description
Check if HSI14 ready interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CIR HSI14RDYF LL_RCC_IsActiveFlag_HSI14RDY
LL_RCC_IsActiveFlag_HSI48RDY
Function name
__STATIC_INLINE uint32_t LL_RCC_IsActiveFlag_HSI48RDY
(void )
Function description
Check if HSI48 ready interrupt occurred or not.
Return values
942/1320
State: of bit (1 or 0).
DocID026525 Rev 6
UM1785
LL RCC Generic Driver
Reference Manual to
LL API cross
reference:
CIR HSI48RDYF LL_RCC_IsActiveFlag_HSI48RDY
LL_RCC_IsActiveFlag_HSECSS
Function name
__STATIC_INLINE uint32_t LL_RCC_IsActiveFlag_HSECSS
(void )
Function description
Check if Clock security system interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CIR CSSF LL_RCC_IsActiveFlag_HSECSS
LL_RCC_IsActiveFlag_IWDGRST
Function name
__STATIC_INLINE uint32_t LL_RCC_IsActiveFlag_IWDGRST
(void )
Function description
Check if RCC flag Independent Watchdog reset is set or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CSR IWDGRSTF LL_RCC_IsActiveFlag_IWDGRST
LL_RCC_IsActiveFlag_LPWRRST
Function name
__STATIC_INLINE uint32_t LL_RCC_IsActiveFlag_LPWRRST
(void )
Function description
Check if RCC flag Low Power reset is set or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CSR LPWRRSTF LL_RCC_IsActiveFlag_LPWRRST
LL_RCC_IsActiveFlag_OBLRST
Function name
__STATIC_INLINE uint32_t LL_RCC_IsActiveFlag_OBLRST
(void )
Function description
Check if RCC flag is set or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CSR OBLRSTF LL_RCC_IsActiveFlag_OBLRST
DocID026525 Rev 6
943/1320
LL RCC Generic Driver
UM1785
LL_RCC_IsActiveFlag_PINRST
Function name
__STATIC_INLINE uint32_t LL_RCC_IsActiveFlag_PINRST
(void )
Function description
Check if RCC flag Pin reset is set or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CSR PINRSTF LL_RCC_IsActiveFlag_PINRST
LL_RCC_IsActiveFlag_PORRST
Function name
__STATIC_INLINE uint32_t LL_RCC_IsActiveFlag_PORRST
(void )
Function description
Check if RCC flag POR/PDR reset is set or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CSR PORRSTF LL_RCC_IsActiveFlag_PORRST
LL_RCC_IsActiveFlag_SFTRST
Function name
__STATIC_INLINE uint32_t LL_RCC_IsActiveFlag_SFTRST
(void )
Function description
Check if RCC flag Software reset is set or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CSR SFTRSTF LL_RCC_IsActiveFlag_SFTRST
LL_RCC_IsActiveFlag_WWDGRST
Function name
__STATIC_INLINE uint32_t LL_RCC_IsActiveFlag_WWDGRST
(void )
Function description
Check if RCC flag Window Watchdog reset is set or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CSR WWDGRSTF LL_RCC_IsActiveFlag_WWDGRST
LL_RCC_IsActiveFlag_V18PWRRST
Function name
__STATIC_INLINE uint32_t
LL_RCC_IsActiveFlag_V18PWRRST (void )
Function description
Check if RCC Reset flag of the 1.8 V domain is set or not.
Return values
944/1320
State: of bit (1 or 0).
DocID026525 Rev 6
UM1785
LL RCC Generic Driver
Reference Manual to
LL API cross
reference:
CSR V18PWRRSTF LL_RCC_IsActiveFlag_V18PWRRST
LL_RCC_ClearResetFlags
Function name
__STATIC_INLINE void LL_RCC_ClearResetFlags (void )
Function description
Set RMVF bit to clear the reset flags.
Return values
None
Reference Manual to
LL API cross
reference:
CSR RMVF LL_RCC_ClearResetFlags
LL_RCC_EnableIT_LSIRDY
Function name
__STATIC_INLINE void LL_RCC_EnableIT_LSIRDY (void )
Function description
Enable LSI ready interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CIR LSIRDYIE LL_RCC_EnableIT_LSIRDY
LL_RCC_EnableIT_LSERDY
Function name
__STATIC_INLINE void LL_RCC_EnableIT_LSERDY (void )
Function description
Enable LSE ready interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CIR LSERDYIE LL_RCC_EnableIT_LSERDY
LL_RCC_EnableIT_HSIRDY
Function name
__STATIC_INLINE void LL_RCC_EnableIT_HSIRDY (void )
Function description
Enable HSI ready interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CIR HSIRDYIE LL_RCC_EnableIT_HSIRDY
DocID026525 Rev 6
945/1320
LL RCC Generic Driver
UM1785
LL_RCC_EnableIT_HSERDY
Function name
__STATIC_INLINE void LL_RCC_EnableIT_HSERDY (void )
Function description
Enable HSE ready interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CIR HSERDYIE LL_RCC_EnableIT_HSERDY
LL_RCC_EnableIT_PLLRDY
Function name
__STATIC_INLINE void LL_RCC_EnableIT_PLLRDY (void )
Function description
Enable PLL ready interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CIR PLLRDYIE LL_RCC_EnableIT_PLLRDY
LL_RCC_EnableIT_HSI14RDY
Function name
__STATIC_INLINE void LL_RCC_EnableIT_HSI14RDY (void )
Function description
Enable HSI14 ready interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CIR HSI14RDYIE LL_RCC_EnableIT_HSI14RDY
LL_RCC_EnableIT_HSI48RDY
Function name
__STATIC_INLINE void LL_RCC_EnableIT_HSI48RDY (void )
Function description
Enable HSI48 ready interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CIR HSI48RDYIE LL_RCC_EnableIT_HSI48RDY
LL_RCC_DisableIT_LSIRDY
946/1320
Function name
__STATIC_INLINE void LL_RCC_DisableIT_LSIRDY (void )
Function description
Disable LSI ready interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CIR LSIRDYIE LL_RCC_DisableIT_LSIRDY
DocID026525 Rev 6
UM1785
LL RCC Generic Driver
LL_RCC_DisableIT_LSERDY
Function name
__STATIC_INLINE void LL_RCC_DisableIT_LSERDY (void )
Function description
Disable LSE ready interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CIR LSERDYIE LL_RCC_DisableIT_LSERDY
LL_RCC_DisableIT_HSIRDY
Function name
__STATIC_INLINE void LL_RCC_DisableIT_HSIRDY (void )
Function description
Disable HSI ready interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CIR HSIRDYIE LL_RCC_DisableIT_HSIRDY
LL_RCC_DisableIT_HSERDY
Function name
__STATIC_INLINE void LL_RCC_DisableIT_HSERDY (void )
Function description
Disable HSE ready interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CIR HSERDYIE LL_RCC_DisableIT_HSERDY
LL_RCC_DisableIT_PLLRDY
Function name
__STATIC_INLINE void LL_RCC_DisableIT_PLLRDY (void )
Function description
Disable PLL ready interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CIR PLLRDYIE LL_RCC_DisableIT_PLLRDY
LL_RCC_DisableIT_HSI14RDY
Function name
__STATIC_INLINE void LL_RCC_DisableIT_HSI14RDY (void )
Function description
Disable HSI14 ready interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CIR HSI14RDYIE LL_RCC_DisableIT_HSI14RDY
DocID026525 Rev 6
947/1320
LL RCC Generic Driver
UM1785
LL_RCC_DisableIT_HSI48RDY
Function name
__STATIC_INLINE void LL_RCC_DisableIT_HSI48RDY (void )
Function description
Disable HSI48 ready interrupt.
Return values
None
Reference Manual to
LL API cross
reference:
CIR HSI48RDYIE LL_RCC_DisableIT_HSI48RDY
LL_RCC_IsEnabledIT_LSIRDY
Function name
__STATIC_INLINE uint32_t LL_RCC_IsEnabledIT_LSIRDY
(void )
Function description
Checks if LSI ready interrupt source is enabled or disabled.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CIR LSIRDYIE LL_RCC_IsEnabledIT_LSIRDY
LL_RCC_IsEnabledIT_LSERDY
Function name
__STATIC_INLINE uint32_t LL_RCC_IsEnabledIT_LSERDY
(void )
Function description
Checks if LSE ready interrupt source is enabled or disabled.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CIR LSERDYIE LL_RCC_IsEnabledIT_LSERDY
LL_RCC_IsEnabledIT_HSIRDY
948/1320
Function name
__STATIC_INLINE uint32_t LL_RCC_IsEnabledIT_HSIRDY
(void )
Function description
Checks if HSI ready interrupt source is enabled or disabled.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CIR HSIRDYIE LL_RCC_IsEnabledIT_HSIRDY
DocID026525 Rev 6
UM1785
LL RCC Generic Driver
LL_RCC_IsEnabledIT_HSERDY
Function name
__STATIC_INLINE uint32_t LL_RCC_IsEnabledIT_HSERDY
(void )
Function description
Checks if HSE ready interrupt source is enabled or disabled.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CIR HSERDYIE LL_RCC_IsEnabledIT_HSERDY
LL_RCC_IsEnabledIT_PLLRDY
Function name
__STATIC_INLINE uint32_t LL_RCC_IsEnabledIT_PLLRDY
(void )
Function description
Checks if PLL ready interrupt source is enabled or disabled.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CIR PLLRDYIE LL_RCC_IsEnabledIT_PLLRDY
LL_RCC_IsEnabledIT_HSI14RDY
Function name
__STATIC_INLINE uint32_t LL_RCC_IsEnabledIT_HSI14RDY
(void )
Function description
Checks if HSI14 ready interrupt source is enabled or disabled.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CIR HSI14RDYIE LL_RCC_IsEnabledIT_HSI14RDY
LL_RCC_IsEnabledIT_HSI48RDY
Function name
__STATIC_INLINE uint32_t LL_RCC_IsEnabledIT_HSI48RDY
(void )
Function description
Checks if HSI48 ready interrupt source is enabled or disabled.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CIR HSI48RDYIE LL_RCC_IsEnabledIT_HSI48RDY
LL_RCC_DeInit
Function name
ErrorStatus LL_RCC_DeInit (void )
Function description
Reset the RCC clock configuration to the default reset state.
Return values
An: ErrorStatus enumeration value:
SUCCESS: RCC registers are de-initialized
ERROR: not applicable
DocID026525 Rev 6
949/1320
LL RCC Generic Driver
Notes
UM1785
The default reset state of the clock configuration is given
below: HSI ON and used as system clock sourceHSE and
PLL OFFAHB and APB1 prescaler set to 1.CSS, MCO OFFAll
interrupts disabled
This function doesn't modify the configuration of the
Peripheral clocksLSI, LSE and RTC clocks
LL_RCC_GetSystemClocksFreq
Function name
void LL_RCC_GetSystemClocksFreq
(LL_RCC_ClocksTypeDef * RCC_Clocks)
Function description
Return the frequencies of different on chip clocks; System, AHB
and APB1 buses clocks.
Parameters
RCC_Clocks: pointer to a LL_RCC_ClocksTypeDef
structure which will hold the clocks frequencies
Return values
None
Notes
Each time SYSCLK, HCLK and/or PCLK1 clock changes, this
function must be called to update structure fields. Otherwise,
any configuration based on this function will be incorrect.
LL_RCC_GetUSARTClockFreq
Function name
uint32_t LL_RCC_GetUSARTClockFreq (uint32_t
USARTxSource)
Function description
Return USARTx clock frequency.
Parameters
USARTxSource: This parameter can be one of the following
values: (*) value not defined in all devices.
LL_RCC_USART1_CLKSOURCE
LL_RCC_USART2_CLKSOURCE (*)
LL_RCC_USART3_CLKSOURCE (*)
Return values
USART: clock frequency (in Hz)
LL_RCC_PERIPH_FREQUENCY_NO indicates that
oscillator (HSI or LSE) is not ready
LL_RCC_GetI2CClockFreq
950/1320
Function name
uint32_t LL_RCC_GetI2CClockFreq (uint32_t I2CxSource)
Function description
Return I2Cx clock frequency.
Parameters
I2CxSource: This parameter can be one of the following
values:
LL_RCC_I2C1_CLKSOURCE
Return values
I2C: clock frequency (in Hz)
LL_RCC_PERIPH_FREQUENCY_NO indicates that HSI
oscillator is not ready
DocID026525 Rev 6
UM1785
LL RCC Generic Driver
LL_RCC_GetCECClockFreq
Function name
uint32_t LL_RCC_GetCECClockFreq (uint32_t CECxSource)
Function description
Return CECx clock frequency.
Parameters
CECxSource: This parameter can be one of the following
values:
LL_RCC_CEC_CLKSOURCE
Return values
CEC: clock frequency (in Hz)
LL_RCC_PERIPH_FREQUENCY_NO indicates that
oscillators (HSI or LSE) are not ready
63.3
RCC Firmware driver defines
63.3.1
RCC
APB low-speed prescaler (APB1)
LL_RCC_APB1_DIV_1
HCLK not divided
LL_RCC_APB1_DIV_2
HCLK divided by 2
LL_RCC_APB1_DIV_4
HCLK divided by 4
LL_RCC_APB1_DIV_8
HCLK divided by 8
LL_RCC_APB1_DIV_16
HCLK divided by 16
Peripheral CEC get clock source
LL_RCC_CEC_CLKSOURCE
CEC Clock source selection
Peripheral CEC clock source selection
LL_RCC_CEC_CLKSOURCE_HSI_DIV244
HSI clock divided by 244 selected as HDMI
CEC entry clock source
LL_RCC_CEC_CLKSOURCE_LSE
LSE clock selected as HDMI CEC entry
clock source
Clear Flags Defines
LL_RCC_CIR_LSIRDYC
LSI Ready Interrupt Clear
LL_RCC_CIR_LSERDYC
LSE Ready Interrupt Clear
LL_RCC_CIR_HSIRDYC
HSI Ready Interrupt Clear
LL_RCC_CIR_HSERDYC
HSE Ready Interrupt Clear
LL_RCC_CIR_PLLRDYC
PLL Ready Interrupt Clear
LL_RCC_CIR_HSI14RDYC
HSI14 Ready Interrupt Clear
LL_RCC_CIR_HSI48RDYC
HSI48 Ready Interrupt Clear
LL_RCC_CIR_CSSC
Clock Security System Interrupt Clear
Get Flags Defines
LL_RCC_CIR_LSIRDYF
LSI Ready Interrupt flag
LL_RCC_CIR_LSERDYF
LSE Ready Interrupt flag
LL_RCC_CIR_HSIRDYF
HSI Ready Interrupt flag
DocID026525 Rev 6
951/1320
LL RCC Generic Driver
LL_RCC_CIR_HSERDYF
HSE Ready Interrupt flag
UM1785
LL_RCC_CIR_PLLRDYF
PLL Ready Interrupt flag
LL_RCC_CIR_HSI14RDYF
HSI14 Ready Interrupt flag
LL_RCC_CIR_HSI48RDYF
HSI48 Ready Interrupt flag
LL_RCC_CIR_CSSF
Clock Security System Interrupt flag
LL_RCC_CSR_OBLRSTF
OBL reset flag
LL_RCC_CSR_PINRSTF
PIN reset flag
LL_RCC_CSR_PORRSTF
POR/PDR reset flag
LL_RCC_CSR_SFTRSTF
Software Reset flag
LL_RCC_CSR_IWDGRSTF
Independent Watchdog reset flag
LL_RCC_CSR_WWDGRSTF
Window watchdog reset flag
LL_RCC_CSR_LPWRRSTF
Low-Power reset flag
LL_RCC_CSR_V18PWRRSTF
Reset flag of the 1.8 V domain.
Peripheral I2C get clock source
LL_RCC_I2C1_CLKSOURCE
I2C1 Clock source selection
Peripheral I2C clock source selection
LL_RCC_I2C1_CLKSOURCE_HSI
HSI oscillator clock used as I2C1 clock source
LL_RCC_I2C1_CLKSOURCE_SYSCLK
System clock selected as I2C1 clock source
IT Defines
LL_RCC_CIR_LSIRDYIE
LSI Ready Interrupt Enable
LL_RCC_CIR_LSERDYIE
LSE Ready Interrupt Enable
LL_RCC_CIR_HSIRDYIE
HSI Ready Interrupt Enable
LL_RCC_CIR_HSERDYIE
HSE Ready Interrupt Enable
LL_RCC_CIR_PLLRDYIE
PLL Ready Interrupt Enable
LL_RCC_CIR_HSI14RDYIE
HSI14 Ready Interrupt Enable
LL_RCC_CIR_HSI48RDYIE
HSI48 Ready Interrupt Enable
LSE oscillator drive capability
LL_RCC_LSEDRIVE_LOW
Xtal mode lower driving capability
LL_RCC_LSEDRIVE_MEDIUMLOW
Xtal mode medium low driving capability
LL_RCC_LSEDRIVE_MEDIUMHIGH
Xtal mode medium high driving capability
LL_RCC_LSEDRIVE_HIGH
Xtal mode higher driving capability
MCO1 SOURCE selection
952/1320
LL_RCC_MCO1SOURCE_NOCLOCK
MCO output disabled, no clock on MCO
LL_RCC_MCO1SOURCE_HSI14
HSI14 oscillator clock selected
LL_RCC_MCO1SOURCE_SYSCLK
SYSCLK selection as MCO source
LL_RCC_MCO1SOURCE_HSI
HSI selection as MCO source
DocID026525 Rev 6
UM1785
LL_RCC_MCO1SOURCE_HSE
LL RCC Generic Driver
HSE selection as MCO source
LL_RCC_MCO1SOURCE_LSI
LSI selection as MCO source
LL_RCC_MCO1SOURCE_LSE
LSE selection as MCO source
LL_RCC_MCO1SOURCE_HSI48
HSI48 selection as MCO source
LL_RCC_MCO1SOURCE_PLLCLK_DIV_2
PLL clock divided by 2
LL_RCC_MCO1SOURCE_PLLCLK
PLL clock selected
MCO1 prescaler
LL_RCC_MCO1_DIV_1
MCO Clock divided by 1
LL_RCC_MCO1_DIV_2
MCO Clock divided by 2
LL_RCC_MCO1_DIV_4
MCO Clock divided by 4
LL_RCC_MCO1_DIV_8
MCO Clock divided by 8
LL_RCC_MCO1_DIV_16
MCO Clock divided by 16
LL_RCC_MCO1_DIV_32
MCO Clock divided by 32
LL_RCC_MCO1_DIV_64
MCO Clock divided by 64
LL_RCC_MCO1_DIV_128
MCO Clock divided by 128
Oscillator Values adaptation
HSE_VALUE
Value of the HSE oscillator in Hz
HSI_VALUE
Value of the HSI oscillator in Hz
LSE_VALUE
Value of the LSE oscillator in Hz
LSI_VALUE
Value of the LSI oscillator in Hz
HSI48_VALUE
Value of the HSI48 oscillator in Hz
Peripheral clock frequency
LL_RCC_PERIPH_FREQUENCY_NO
No clock enabled for the peripheral
LL_RCC_PERIPH_FREQUENCY_NA
Frequency cannot be provided as external clock
PLL SOURCE
LL_RCC_PLLSOURCE_HSE
HSE/PREDIV clock selected as PLL entry clock source
LL_RCC_PLLSOURCE_HSI
HSI/PREDIV clock selected as PLL entry clock source
LL_RCC_PLLSOURCE_HSI48
HSI48/PREDIV clock selected as PLL entry clock source
PLL Multiplicator factor
LL_RCC_PLL_MUL_2
PLL input clock*2
LL_RCC_PLL_MUL_3
PLL input clock*3
LL_RCC_PLL_MUL_4
PLL input clock*4
LL_RCC_PLL_MUL_5
PLL input clock*5
LL_RCC_PLL_MUL_6
PLL input clock*6
LL_RCC_PLL_MUL_7
PLL input clock*7
LL_RCC_PLL_MUL_8
PLL input clock*8
DocID026525 Rev 6
953/1320
LL RCC Generic Driver
LL_RCC_PLL_MUL_9
UM1785
PLL input clock*9
LL_RCC_PLL_MUL_10
PLL input clock*10
LL_RCC_PLL_MUL_11
PLL input clock*11
LL_RCC_PLL_MUL_12
PLL input clock*12
LL_RCC_PLL_MUL_13
PLL input clock*13
LL_RCC_PLL_MUL_14
PLL input clock*14
LL_RCC_PLL_MUL_15
PLL input clock*15
LL_RCC_PLL_MUL_16
PLL input clock*16
PREDIV Division factor
LL_RCC_PREDIV_DIV_1
PREDIV input clock not divided
LL_RCC_PREDIV_DIV_2
PREDIV input clock divided by 2
LL_RCC_PREDIV_DIV_3
PREDIV input clock divided by 3
LL_RCC_PREDIV_DIV_4
PREDIV input clock divided by 4
LL_RCC_PREDIV_DIV_5
PREDIV input clock divided by 5
LL_RCC_PREDIV_DIV_6
PREDIV input clock divided by 6
LL_RCC_PREDIV_DIV_7
PREDIV input clock divided by 7
LL_RCC_PREDIV_DIV_8
PREDIV input clock divided by 8
LL_RCC_PREDIV_DIV_9
PREDIV input clock divided by 9
LL_RCC_PREDIV_DIV_10
PREDIV input clock divided by 10
LL_RCC_PREDIV_DIV_11
PREDIV input clock divided by 11
LL_RCC_PREDIV_DIV_12
PREDIV input clock divided by 12
LL_RCC_PREDIV_DIV_13
PREDIV input clock divided by 13
LL_RCC_PREDIV_DIV_14
PREDIV input clock divided by 14
LL_RCC_PREDIV_DIV_15
PREDIV input clock divided by 15
LL_RCC_PREDIV_DIV_16
PREDIV input clock divided by 16
RTC clock source selection
LL_RCC_RTC_CLKSOURCE_NONE
No clock used as RTC clock
LL_RCC_RTC_CLKSOURCE_LSE
LSE oscillator clock used as RTC clock
LL_RCC_RTC_CLKSOURCE_LSI
LSI oscillator clock used as RTC clock
LL_RCC_RTC_CLKSOURCE_HSE_DIV32
HSE oscillator clock divided by 32 used as
RTC clock
AHB prescaler
954/1320
LL_RCC_SYSCLK_DIV_1
SYSCLK not divided
LL_RCC_SYSCLK_DIV_2
SYSCLK divided by 2
LL_RCC_SYSCLK_DIV_4
SYSCLK divided by 4
LL_RCC_SYSCLK_DIV_8
SYSCLK divided by 8
LL_RCC_SYSCLK_DIV_16
SYSCLK divided by 16
DocID026525 Rev 6
UM1785
LL RCC Generic Driver
LL_RCC_SYSCLK_DIV_64
SYSCLK divided by 64
LL_RCC_SYSCLK_DIV_128
SYSCLK divided by 128
LL_RCC_SYSCLK_DIV_256
SYSCLK divided by 256
LL_RCC_SYSCLK_DIV_512
SYSCLK divided by 512
System clock switch
LL_RCC_SYS_CLKSOURCE_HSI
HSI selection as system clock
LL_RCC_SYS_CLKSOURCE_HSE
HSE selection as system clock
LL_RCC_SYS_CLKSOURCE_PLL
PLL selection as system clock
LL_RCC_SYS_CLKSOURCE_HSI48
HSI48 selection as system clock
System clock switch status
LL_RCC_SYS_CLKSOURCE_STATUS_HSI
HSI used as system clock
LL_RCC_SYS_CLKSOURCE_STATUS_HSE
HSE used as system clock
LL_RCC_SYS_CLKSOURCE_STATUS_PLL
PLL used as system clock
LL_RCC_SYS_CLKSOURCE_STATUS_HSI48
HSI48 used as system clock
Peripheral USART get clock source
LL_RCC_USART1_CLKSOURCE
USART1 Clock source selection
LL_RCC_USART2_CLKSOURCE
USART2 Clock source selection
LL_RCC_USART3_CLKSOURCE
USART3 Clock source selection
Peripheral USART clock source selection
LL_RCC_USART1_CLKSOURCE_PCLK1
PCLK1 clock used as USART1 clock source
LL_RCC_USART1_CLKSOURCE_SYSCLK
System clock selected as USART1 clock
source
LL_RCC_USART1_CLKSOURCE_LSE
LSE oscillator clock used as USART1 clock
source
LL_RCC_USART1_CLKSOURCE_HSI
HSI oscillator clock used as USART1 clock
source
LL_RCC_USART2_CLKSOURCE_PCLK1
PCLK1 clock used as USART2 clock source
LL_RCC_USART2_CLKSOURCE_SYSCLK
System clock selected as USART2 clock
source
LL_RCC_USART2_CLKSOURCE_LSE
LSE oscillator clock used as USART2 clock
source
LL_RCC_USART2_CLKSOURCE_HSI
HSI oscillator clock used as USART2 clock
source
LL_RCC_USART3_CLKSOURCE_PCLK1
PCLK1 clock used as USART3 clock source
LL_RCC_USART3_CLKSOURCE_SYSCLK
System clock selected as USART3 clock
source
LL_RCC_USART3_CLKSOURCE_LSE
LSE oscillator clock used as USART3 clock
source
LL_RCC_USART3_CLKSOURCE_HSI
HSI oscillator clock used as USART3 clock
DocID026525 Rev 6
955/1320
LL RCC Generic Driver
UM1785
source
Calculate frequencies
__LL_RCC_CALC_ PLLCLK_ FREQ
Description:
Helper macro to calculate the PLLCLK
frequency.
Parameters:
__INPUTFREQ__: PLL Input frequency
(based on HSE/HSI/HSI48)
__PLLMUL__: This parameter can be one of
the following values:
LL_RCC_PLL_MUL_2
LL_RCC_PLL_MUL_3
LL_RCC_PLL_MUL_4
LL_RCC_PLL_MUL_5
LL_RCC_PLL_MUL_6
LL_RCC_PLL_MUL_7
LL_RCC_PLL_MUL_8
LL_RCC_PLL_MUL_9
LL_RCC_PLL_MUL_10
LL_RCC_PLL_MUL_11
LL_RCC_PLL_MUL_12
LL_RCC_PLL_MUL_13
LL_RCC_PLL_MUL_14
LL_RCC_PLL_MUL_15
LL_RCC_PLL_MUL_16
__PLLPREDIV__: This parameter can be
one of the following values:
LL_RCC_PREDIV_DIV_1
LL_RCC_PREDIV_DIV_2
LL_RCC_PREDIV_DIV_3
LL_RCC_PREDIV_DIV_4
LL_RCC_PREDIV_DIV_5
LL_RCC_PREDIV_DIV_6
LL_RCC_PREDIV_DIV_7
LL_RCC_PREDIV_DIV_8
LL_RCC_PREDIV_DIV_9
LL_RCC_PREDIV_DIV_10
LL_RCC_PREDIV_DIV_11
LL_RCC_PREDIV_DIV_12
LL_RCC_PREDIV_DIV_13
LL_RCC_PREDIV_DIV_14
LL_RCC_PREDIV_DIV_15
LL_RCC_PREDIV_DIV_16
Return value:
PLL: clock frequency (in Hz)
Notes:
ex: __LL_RCC_CALC_PLLCLK_FREQ
(HSE_VALUE,
LL_RCC_PLL_GetMultiplicator() ,
956/1320
DocID026525 Rev 6
UM1785
LL RCC Generic Driver
LL_RCC_PLL_GetPrediv());
__LL_RCC_CALC_HCLK_ FREQ
Description:
Helper macro to calculate the HCLK
frequency.
Parameters:
__SYSCLKFREQ__: SYSCLK frequency
(based on HSE/HSI/PLLCLK)
__AHBPRESCALER__: This parameter can
be one of the following values:
LL_RCC_SYSCLK_DIV_1
LL_RCC_SYSCLK_DIV_2
LL_RCC_SYSCLK_DIV_4
LL_RCC_SYSCLK_DIV_8
LL_RCC_SYSCLK_DIV_16
LL_RCC_SYSCLK_DIV_64
LL_RCC_SYSCLK_DIV_128
LL_RCC_SYSCLK_DIV_256
LL_RCC_SYSCLK_DIV_512
Return value:
HCLK: clock frequency (in Hz)
Notes:
: __AHBPRESCALER__ be retrieved by
LL_RCC_GetAHBPrescaler ex:
__LL_RCC_CALC_HCLK_FREQ(LL_RCC_
GetAHBPrescaler())
__LL_RCC_CALC_PCLK1_ FREQ
Description:
Helper macro to calculate the PCLK1
frequency (ABP1)
Parameters:
__HCLKFREQ__: HCLK frequency
__APB1PRESCALER__: This parameter
can be one of the following values:
LL_RCC_APB1_DIV_1
LL_RCC_APB1_DIV_2
LL_RCC_APB1_DIV_4
LL_RCC_APB1_DIV_8
LL_RCC_APB1_DIV_16
Return value:
PCLK1: clock frequency (in Hz)
Notes:
: __APB1PRESCALER__ be retrieved by
LL_RCC_GetAPB1Prescaler ex:
__LL_RCC_CALC_PCLK1_FREQ(LL_RCC
_GetAPB1Prescaler())
DocID026525 Rev 6
957/1320
LL RCC Generic Driver
Common Write and read registers Macros
LL_RCC_WriteReg
Description:
Write a value in RCC register.
Parameters:
__REG__: Register to be written
__VALUE__: Value to be written in the register
Return value:
None
LL_RCC_ReadReg
Description:
Read a value in RCC register.
Parameters:
__REG__: Register to be read
Return value:
Register: value
958/1320
DocID026525 Rev 6
UM1785
UM1785
LL RTC Generic Driver
64
LL RTC Generic Driver
64.1
RTC Firmware driver registers structures
64.1.1
LL_RTC_InitTypeDef
Data Fields
uint32_t HourFormat
uint32_t AsynchPrescaler
uint32_t SynchPrescaler
Field Documentation
uint32_t LL_RTC_InitTypeDef::HourFormat
Specifies the RTC Hours Format. This parameter can be a value of
RTC_LL_EC_HOURFORMATThis feature can be modified afterwards using unitary
function LL_RTC_SetHourFormat().
uint32_t LL_RTC_InitTypeDef::AsynchPrescaler
Specifies the RTC Asynchronous Predivider value. This parameter must be a number
between Min_Data = 0x00 and Max_Data = 0x7FThis feature can be modified
afterwards using unitary function LL_RTC_SetAsynchPrescaler().
uint32_t LL_RTC_InitTypeDef::SynchPrescaler
Specifies the RTC Synchronous Predivider value. This parameter must be a number
between Min_Data = 0x00 and Max_Data = 0x7FFFThis feature can be modified
afterwards using unitary function LL_RTC_SetSynchPrescaler().
64.1.2
LL_RTC_TimeTypeDef
Data Fields
uint32_t TimeFormat
uint8_t Hours
uint8_t Minutes
uint8_t Seconds
Field Documentation
uint32_t LL_RTC_TimeTypeDef::TimeFormat
Specifies the RTC AM/PM Time. This parameter can be a value of
RTC_LL_EC_TIME_FORMATThis feature can be modified afterwards using unitary
function LL_RTC_TIME_SetFormat().
uint8_t LL_RTC_TimeTypeDef::Hours
Specifies the RTC Time Hours. This parameter must be a number between Min_Data
= 0 and Max_Data = 12 if the LL_RTC_TIME_FORMAT_PM is selected. This
parameter must be a number between Min_Data = 0 and Max_Data = 23 if the
LL_RTC_TIME_FORMAT_AM_OR_24 is selected.This feature can be modified
afterwards using unitary function LL_RTC_TIME_SetHour().
uint8_t LL_RTC_TimeTypeDef::Minutes
Specifies the RTC Time Minutes. This parameter must be a number between
Min_Data = 0 and Max_Data = 59This feature can be modified afterwards using
unitary function LL_RTC_TIME_SetMinute().
uint8_t LL_RTC_TimeTypeDef::Seconds
Specifies the RTC Time Seconds. This parameter must be a number between
DocID026525 Rev 6
959/1320
LL RTC Generic Driver
UM1785
Min_Data = 0 and Max_Data = 59This feature can be modified afterwards using
unitary function LL_RTC_TIME_SetSecond().
64.1.3
LL_RTC_DateTypeDef
Data Fields
uint8_t WeekDay
uint8_t Month
uint8_t Day
uint8_t Year
Field Documentation
uint8_t LL_RTC_DateTypeDef::WeekDay
Specifies the RTC Date WeekDay. This parameter can be a value of
RTC_LL_EC_WEEKDAYThis feature can be modified afterwards using unitary
function LL_RTC_DATE_SetWeekDay().
uint8_t LL_RTC_DateTypeDef::Month
Specifies the RTC Date Month. This parameter can be a value of
RTC_LL_EC_MONTHThis feature can be modified afterwards using unitary function
LL_RTC_DATE_SetMonth().
uint8_t LL_RTC_DateTypeDef::Day
Specifies the RTC Date Day. This parameter must be a number between Min_Data =
1 and Max_Data = 31This feature can be modified afterwards using unitary function
LL_RTC_DATE_SetDay().
uint8_t LL_RTC_DateTypeDef::Year
Specifies the RTC Date Year. This parameter must be a number between Min_Data =
0 and Max_Data = 99This feature can be modified afterwards using unitary function
LL_RTC_DATE_SetYear().
64.1.4
LL_RTC_AlarmTypeDef
Data Fields
LL_RTC_TimeTypeDef AlarmTime
uint32_t AlarmMask
uint32_t AlarmDateWeekDaySel
uint8_t AlarmDateWeekDay
Field Documentation
LL_RTC_TimeTypeDef LL_RTC_AlarmTypeDef::AlarmTime
Specifies the RTC Alarm Time members.
uint32_t LL_RTC_AlarmTypeDef::AlarmMask
Specifies the RTC Alarm Masks.This parameter can be a value of
RTC_LL_EC_ALMA_MASK This feature can be modified afterwards using unitary
function LL_RTC_ALMA_SetMask() for ALARM A.
uint32_t LL_RTC_AlarmTypeDef::AlarmDateWeekDaySel
Specifies the RTC Alarm is on day or WeekDay. This parameter can be a value of
RTC_LL_EC_ALMA_WEEKDAY_SELECTIONThis feature can be modified
afterwards using unitary function LL_RTC_ALMA_EnableWeekday() or
LL_RTC_ALMA_DisableWeekday()
uint8_t LL_RTC_AlarmTypeDef::AlarmDateWeekDay
Specifies the RTC Alarm Day/WeekDay. If AlarmDateWeekDaySel set to day, this
parameter must be a number between Min_Data = 1 and Max_Data = 31.This feature
can be modified afterwards using unitary function LL_RTC_ALMA_SetDay()If
AlarmDateWeekDaySel set to Weekday, this parameter can be a value of
960/1320
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
RTC_LL_EC_WEEKDAY.This feature can be modified afterwards using unitary
function LL_RTC_ALMA_SetWeekDay()
64.2
RTC Firmware driver API description
64.2.1
Detailed description of functions
LL_RTC_SetHourFormat
Function name
__STATIC_INLINE void LL_RTC_SetHourFormat
(RTC_TypeDef * RTCx, uint32_t HourFormat)
Function description
Set Hours format (24 hour/day or AM/PM hour format)
Parameters
RTCx: RTC Instance
HourFormat: This parameter can be one of the following
values:
LL_RTC_HOURFORMAT_24HOUR
LL_RTC_HOURFORMAT_AMPM
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
It can be written in initialization mode only
(LL_RTC_EnableInitMode function)
Reference Manual to
LL API cross
reference:
CR FMT LL_RTC_SetHourFormat
LL_RTC_GetHourFormat
Function name
__STATIC_INLINE uint32_t LL_RTC_GetHourFormat
(RTC_TypeDef * RTCx)
Function description
Get Hours format (24 hour/day or AM/PM hour format)
Parameters
RTCx: RTC Instance
Return values
Returned: value can be one of the following values:
LL_RTC_HOURFORMAT_24HOUR
LL_RTC_HOURFORMAT_AMPM
Reference Manual to
LL API cross
reference:
CR FMT LL_RTC_GetHourFormat
LL_RTC_SetAlarmOutEvent
Function name
__STATIC_INLINE void LL_RTC_SetAlarmOutEvent
(RTC_TypeDef * RTCx, uint32_t AlarmOutput)
Function description
Select the flag to be routed to RTC_ALARM output.
Parameters
RTCx: RTC Instance
AlarmOutput: This parameter can be one of the following
values:
LL_RTC_ALARMOUT_DISABLE
DocID026525 Rev 6
961/1320
LL RTC Generic Driver
UM1785
LL_RTC_ALARMOUT_ALMA
LL_RTC_ALARMOUT_ALMB
LL_RTC_ALARMOUT_WAKEUP
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Reference Manual to
LL API cross
reference:
CR OSEL LL_RTC_SetAlarmOutEvent
LL_RTC_GetAlarmOutEvent
Function name
__STATIC_INLINE uint32_t LL_RTC_GetAlarmOutEvent
(RTC_TypeDef * RTCx)
Function description
Get the flag to be routed to RTC_ALARM output.
Parameters
RTCx: RTC Instance
Return values
Returned: value can be one of the following values:
LL_RTC_ALARMOUT_DISABLE
LL_RTC_ALARMOUT_ALMA
LL_RTC_ALARMOUT_ALMB
LL_RTC_ALARMOUT_WAKEUP
Reference Manual to
LL API cross
reference:
CR OSEL LL_RTC_GetAlarmOutEvent
LL_RTC_SetAlarmOutputType
Function name
__STATIC_INLINE void LL_RTC_SetAlarmOutputType
(RTC_TypeDef * RTCx, uint32_t Output)
Function description
Set RTC_ALARM output type (ALARM in push-pull or open-drain
output)
Parameters
RTCx: RTC Instance
Output: This parameter can be one of the following values:
LL_RTC_ALARM_OUTPUTTYPE_OPENDRAIN
LL_RTC_ALARM_OUTPUTTYPE_PUSHPULL
Return values
None
Notes
Used only when RTC_ALARM is mapped on PC13
If all RTC alternate functions are disabled and PC13MODE =
1, PC13VALUE configures the PC13 output data
Reference Manual to
LL API cross
reference:
TAFCR ALARMOUTTYPE LL_RTC_SetAlarmOutputType
LL_RTC_GetAlarmOutputType
Function name
962/1320
__STATIC_INLINE uint32_t LL_RTC_GetAlarmOutputType
(RTC_TypeDef * RTCx)
DocID026525 Rev 6
UM1785
Function description
LL RTC Generic Driver
Get RTC_ALARM output type (ALARM in push-pull or open-drain
output)
Parameters
RTCx: RTC Instance
Return values
Returned: value can be one of the following values:
LL_RTC_ALARM_OUTPUTTYPE_OPENDRAIN
LL_RTC_ALARM_OUTPUTTYPE_PUSHPULL
Notes
used only when RTC_ALARM is mapped on PC13
If all RTC alternate functions are disabled and PC13MODE =
1, PC13VALUE configures the PC13 output data
Reference Manual to
LL API cross
reference:
TAFCR ALARMOUTTYPE LL_RTC_GetAlarmOutputType
LL_RTC_EnablePushPullMode
Function name
__STATIC_INLINE void LL_RTC_EnablePushPullMode
(RTC_TypeDef * RTCx, uint32_t PinMask)
Function description
Enable push-pull output on PC13, PC14 and/or PC15.
Parameters
RTCx: RTC Instance
PinMask: This parameter can be a combination of the
following values:
LL_RTC_PIN_PC13
LL_RTC_PIN_PC14
LL_RTC_PIN_PC15
Return values
None
Notes
PC13 forced to push-pull output if all RTC alternate functions
are disabled
PC14 and PC15 forced to push-pull output if LSE is disabled
Reference Manual to
LL API cross
reference:
TAFCR PC13MODE LL_RTC_EnablePushPullMode
TAFCR PC14MODE LL_RTC_EnablePushPullMode
TAFCR PC15MODE LL_RTC_EnablePushPullMode
LL_RTC_DisablePushPullMode
Function name
__STATIC_INLINE void LL_RTC_DisablePushPullMode
(RTC_TypeDef * RTCx, uint32_t PinMask)
Function description
Disable push-pull output on PC13, PC14 and/or PC15.
Parameters
RTCx: RTC Instance
PinMask: This parameter can be a combination of the
following values:
LL_RTC_PIN_PC13
LL_RTC_PIN_PC14
LL_RTC_PIN_PC15
Return values
None
DocID026525 Rev 6
963/1320
LL RTC Generic Driver
Notes
UM1785
PC13, PC14 and/or PC15 are controlled by the GPIO
configuration registers. Consequently PC13, PC14 and/or
PC15 are floating in Standby mode.
Reference Manual to
LL API cross
reference:
TAFCR PC13MODE LL_RTC_DisablePushPullMode
TAFCR PC14MODE LL_RTC_DisablePushPullMode
TAFCR PC15MODE LL_RTC_DisablePushPullMode
LL_RTC_SetOutputPin
Function name
__STATIC_INLINE void LL_RTC_SetOutputPin (RTC_TypeDef
* RTCx, uint32_t PinMask)
Function description
Set PC14 and/or PC15 to high level.
Parameters
RTCx: RTC Instance
PinMask: This parameter can be a combination of the
following values:
LL_RTC_PIN_PC14
LL_RTC_PIN_PC15
Return values
None
Notes
Output data configuration is possible if the LSE is disabled
and PushPull output is enabled (through
LL_RTC_EnablePushPullMode)
Reference Manual to
LL API cross
reference:
TAFCR PC14VALUE LL_RTC_SetOutputPin
TAFCR PC15VALUE LL_RTC_SetOutputPin
LL_RTC_ResetOutputPin
964/1320
Function name
__STATIC_INLINE void LL_RTC_ResetOutputPin
(RTC_TypeDef * RTCx, uint32_t PinMask)
Function description
Set PC14 and/or PC15 to low level.
Parameters
RTCx: RTC Instance
PinMask: This parameter can be a combination of the
following values:
LL_RTC_PIN_PC14
LL_RTC_PIN_PC15
Return values
None
Notes
Output data configuration is possible if the LSE is disabled
and PushPull output is enabled (through
LL_RTC_EnablePushPullMode)
Reference Manual to
LL API cross
reference:
TAFCR PC14VALUE LL_RTC_ResetOutputPin
TAFCR PC15VALUE LL_RTC_ResetOutputPin
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
LL_RTC_EnableInitMode
Function name
__STATIC_INLINE void LL_RTC_EnableInitMode
(RTC_TypeDef * RTCx)
Function description
Enable initialization mode.
Parameters
RTCx: RTC Instance
Return values
None
Notes
Initialization mode is used to program time and date register
(RTC_TR and RTC_DR) and prescaler register (RTC_PRER).
Counters are stopped and start counting from the new value
when INIT is reset.
Reference Manual to
LL API cross
reference:
ISR INIT LL_RTC_EnableInitMode
LL_RTC_DisableInitMode
Function name
__STATIC_INLINE void LL_RTC_DisableInitMode
(RTC_TypeDef * RTCx)
Function description
Disable initialization mode (Free running mode)
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
ISR INIT LL_RTC_DisableInitMode
LL_RTC_SetOutputPolarity
Function name
__STATIC_INLINE void LL_RTC_SetOutputPolarity
(RTC_TypeDef * RTCx, uint32_t Polarity)
Function description
Set Output polarity (pin is low when ALRAF/ALRBF/WUTF is
asserted)
Parameters
RTCx: RTC Instance
Polarity: This parameter can be one of the following values:
LL_RTC_OUTPUTPOLARITY_PIN_HIGH
LL_RTC_OUTPUTPOLARITY_PIN_LOW
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Reference Manual to
LL API cross
reference:
CR POL LL_RTC_SetOutputPolarity
DocID026525 Rev 6
965/1320
LL RTC Generic Driver
UM1785
LL_RTC_GetOutputPolarity
Function name
__STATIC_INLINE uint32_t LL_RTC_GetOutputPolarity
(RTC_TypeDef * RTCx)
Function description
Get Output polarity.
Parameters
RTCx: RTC Instance
Return values
Returned: value can be one of the following values:
LL_RTC_OUTPUTPOLARITY_PIN_HIGH
LL_RTC_OUTPUTPOLARITY_PIN_LOW
Reference Manual to
LL API cross
reference:
CR POL LL_RTC_GetOutputPolarity
LL_RTC_EnableShadowRegBypass
Function name
__STATIC_INLINE void LL_RTC_EnableShadowRegBypass
(RTC_TypeDef * RTCx)
Function description
Enable Bypass the shadow registers.
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Reference Manual to
LL API cross
reference:
CR BYPSHAD LL_RTC_EnableShadowRegBypass
LL_RTC_DisableShadowRegBypass
Function name
__STATIC_INLINE void LL_RTC_DisableShadowRegBypass
(RTC_TypeDef * RTCx)
Function description
Disable Bypass the shadow registers.
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR BYPSHAD LL_RTC_DisableShadowRegBypass
LL_RTC_IsShadowRegBypassEnabled
966/1320
Function name
__STATIC_INLINE uint32_t
LL_RTC_IsShadowRegBypassEnabled (RTC_TypeDef * RTCx)
Function description
Check if Shadow registers bypass is enabled or not.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
CR BYPSHAD LL_RTC_IsShadowRegBypassEnabled
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
reference:
LL_RTC_EnableRefClock
Function name
__STATIC_INLINE void LL_RTC_EnableRefClock
(RTC_TypeDef * RTCx)
Function description
Enable RTC_REFIN reference clock detection (50 or 60 Hz)
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
It can be written in initialization mode only
(LL_RTC_EnableInitMode function)
Reference Manual to
LL API cross
reference:
CR REFCKON LL_RTC_EnableRefClock
LL_RTC_DisableRefClock
Function name
__STATIC_INLINE void LL_RTC_DisableRefClock
(RTC_TypeDef * RTCx)
Function description
Disable RTC_REFIN reference clock detection (50 or 60 Hz)
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
It can be written in initialization mode only
(LL_RTC_EnableInitMode function)
Reference Manual to
LL API cross
reference:
CR REFCKON LL_RTC_DisableRefClock
LL_RTC_SetAsynchPrescaler
Function name
__STATIC_INLINE void LL_RTC_SetAsynchPrescaler
(RTC_TypeDef * RTCx, uint32_t AsynchPrescaler)
Function description
Set Asynchronous prescaler factor.
Parameters
RTCx: RTC Instance
AsynchPrescaler: Value between Min_Data = 0 and
Max_Data = 0x7F
Return values
None
Reference Manual to
LL API cross
reference:
PRER PREDIV_A LL_RTC_SetAsynchPrescaler
DocID026525 Rev 6
967/1320
LL RTC Generic Driver
UM1785
LL_RTC_SetSynchPrescaler
Function name
__STATIC_INLINE void LL_RTC_SetSynchPrescaler
(RTC_TypeDef * RTCx, uint32_t SynchPrescaler)
Function description
Set Synchronous prescaler factor.
Parameters
RTCx: RTC Instance
SynchPrescaler: Value between Min_Data = 0 and
Max_Data = 0x7FFF
Return values
None
Reference Manual to
LL API cross
reference:
PRER PREDIV_S LL_RTC_SetSynchPrescaler
LL_RTC_GetAsynchPrescaler
Function name
__STATIC_INLINE uint32_t LL_RTC_GetAsynchPrescaler
(RTC_TypeDef * RTCx)
Function description
Get Asynchronous prescaler factor.
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data = 0 and Max_Data = 0x7F
Reference Manual to
LL API cross
reference:
PRER PREDIV_A LL_RTC_GetAsynchPrescaler
LL_RTC_GetSynchPrescaler
Function name
__STATIC_INLINE uint32_t LL_RTC_GetSynchPrescaler
(RTC_TypeDef * RTCx)
Function description
Get Synchronous prescaler factor.
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data = 0 and Max_Data = 0x7FFF
Reference Manual to
LL API cross
reference:
PRER PREDIV_S LL_RTC_GetSynchPrescaler
LL_RTC_EnableWriteProtection
968/1320
Function name
__STATIC_INLINE void LL_RTC_EnableWriteProtection
(RTC_TypeDef * RTCx)
Function description
Enable the write protection for RTC registers.
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
WPR KEY LL_RTC_EnableWriteProtection
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
LL_RTC_DisableWriteProtection
Function name
__STATIC_INLINE void LL_RTC_DisableWriteProtection
(RTC_TypeDef * RTCx)
Function description
Disable the write protection for RTC registers.
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
WPR KEY LL_RTC_DisableWriteProtection
LL_RTC_TIME_SetFormat
Function name
__STATIC_INLINE void LL_RTC_TIME_SetFormat
(RTC_TypeDef * RTCx, uint32_t TimeFormat)
Function description
Set time format (AM/24-hour or PM notation)
Parameters
RTCx: RTC Instance
TimeFormat: This parameter can be one of the following
values:
LL_RTC_TIME_FORMAT_AM_OR_24
LL_RTC_TIME_FORMAT_PM
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
It can be written in initialization mode only
(LL_RTC_EnableInitMode function)
Reference Manual to
LL API cross
reference:
TR PM LL_RTC_TIME_SetFormat
LL_RTC_TIME_GetFormat
Function name
__STATIC_INLINE uint32_t LL_RTC_TIME_GetFormat
(RTC_TypeDef * RTCx)
Function description
Get time format (AM or PM notation)
Parameters
RTCx: RTC Instance
Return values
Returned: value can be one of the following values:
LL_RTC_TIME_FORMAT_AM_OR_24
LL_RTC_TIME_FORMAT_PM
Notes
if shadow mode is disabled (BYPSHAD=0), need to check if
RSF flag is set before reading this bit
Read either RTC_SSR or RTC_TR locks the values in the
higher-order calendar shadow registers until RTC_DR is read
(LL_RTC_ReadReg(RTC, DR)).
Reference Manual to
LL API cross
reference:
TR PM LL_RTC_TIME_GetFormat
DocID026525 Rev 6
969/1320
LL RTC Generic Driver
UM1785
LL_RTC_TIME_SetHour
Function name
__STATIC_INLINE void LL_RTC_TIME_SetHour (RTC_TypeDef
* RTCx, uint32_t Hours)
Function description
Set Hours in BCD format.
Parameters
RTCx: RTC Instance
Hours: Value between Min_Data=0x01 and Max_Data=0x12
or between Min_Data=0x00 and Max_Data=0x23
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
It can be written in initialization mode only
(LL_RTC_EnableInitMode function)
helper macro __LL_RTC_CONVERT_BIN2BCD is available
to convert hour from binary to BCD format
Reference Manual to
LL API cross
reference:
TR HT LL_RTC_TIME_SetHour
TR HU LL_RTC_TIME_SetHour
LL_RTC_TIME_GetHour
Function name
__STATIC_INLINE uint32_t LL_RTC_TIME_GetHour
(RTC_TypeDef * RTCx)
Function description
Get Hours in BCD format.
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data=0x01 and Max_Data=0x12 or
between Min_Data=0x00 and Max_Data=0x23
Notes
if shadow mode is disabled (BYPSHAD=0), need to check if
RSF flag is set before reading this bit
Read either RTC_SSR or RTC_TR locks the values in the
higher-order calendar shadow registers until RTC_DR is read
(LL_RTC_ReadReg(RTC, DR)).
helper macro __LL_RTC_CONVERT_BCD2BIN is available
to convert hour from BCD to Binary format
Reference Manual to
LL API cross
reference:
TR HT LL_RTC_TIME_GetHour
TR HU LL_RTC_TIME_GetHour
LL_RTC_TIME_SetMinute
970/1320
Function name
__STATIC_INLINE void LL_RTC_TIME_SetMinute
(RTC_TypeDef * RTCx, uint32_t Minutes)
Function description
Set Minutes in BCD format.
Parameters
RTCx: RTC Instance
Minutes: Value between Min_Data=0x00 and
Max_Data=0x59
Return values
None
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
It can be written in initialization mode only
(LL_RTC_EnableInitMode function)
helper macro __LL_RTC_CONVERT_BIN2BCD is available
to convert Minutes from binary to BCD format
Reference Manual to
LL API cross
reference:
TR MNT LL_RTC_TIME_SetMinute
TR MNU LL_RTC_TIME_SetMinute
LL_RTC_TIME_GetMinute
Function name
__STATIC_INLINE uint32_t LL_RTC_TIME_GetMinute
(RTC_TypeDef * RTCx)
Function description
Get Minutes in BCD format.
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data=0x00 and Max_Data=0x59
Notes
if shadow mode is disabled (BYPSHAD=0), need to check if
RSF flag is set before reading this bit
Read either RTC_SSR or RTC_TR locks the values in the
higher-order calendar shadow registers until RTC_DR is read
(LL_RTC_ReadReg(RTC, DR)).
helper macro __LL_RTC_CONVERT_BCD2BIN is available
to convert minute from BCD to Binary format
Reference Manual to
LL API cross
reference:
TR MNT LL_RTC_TIME_GetMinute
TR MNU LL_RTC_TIME_GetMinute
LL_RTC_TIME_SetSecond
Function name
__STATIC_INLINE void LL_RTC_TIME_SetSecond
(RTC_TypeDef * RTCx, uint32_t Seconds)
Function description
Set Seconds in BCD format.
Parameters
RTCx: RTC Instance
Seconds: Value between Min_Data=0x00 and
Max_Data=0x59
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
It can be written in initialization mode only
(LL_RTC_EnableInitMode function)
helper macro __LL_RTC_CONVERT_BIN2BCD is available
to convert Seconds from binary to BCD format
Reference Manual to
LL API cross
reference:
TR ST LL_RTC_TIME_SetSecond
TR SU LL_RTC_TIME_SetSecond
DocID026525 Rev 6
971/1320
LL RTC Generic Driver
UM1785
LL_RTC_TIME_GetSecond
Function name
__STATIC_INLINE uint32_t LL_RTC_TIME_GetSecond
(RTC_TypeDef * RTCx)
Function description
Get Seconds in BCD format.
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data=0x00 and Max_Data=0x59
Notes
if shadow mode is disabled (BYPSHAD=0), need to check if
RSF flag is set before reading this bit
Read either RTC_SSR or RTC_TR locks the values in the
higher-order calendar shadow registers until RTC_DR is read
(LL_RTC_ReadReg(RTC, DR)).
helper macro __LL_RTC_CONVERT_BCD2BIN is available
to convert Seconds from BCD to Binary format
Reference Manual to
LL API cross
reference:
TR ST LL_RTC_TIME_GetSecond
TR SU LL_RTC_TIME_GetSecond
LL_RTC_TIME_Config
972/1320
Function name
__STATIC_INLINE void LL_RTC_TIME_Config (RTC_TypeDef *
RTCx, uint32_t Format12_24, uint32_t Hours, uint32_t
Minutes, uint32_t Seconds)
Function description
Set time (hour, minute and second) in BCD format.
Parameters
RTCx: RTC Instance
Format12_24: This parameter can be one of the following
values:
LL_RTC_TIME_FORMAT_AM_OR_24
LL_RTC_TIME_FORMAT_PM
Hours: Value between Min_Data=0x01 and Max_Data=0x12
or between Min_Data=0x00 and Max_Data=0x23
Minutes: Value between Min_Data=0x00 and
Max_Data=0x59
Seconds: Value between Min_Data=0x00 and
Max_Data=0x59
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
It can be written in initialization mode only
(LL_RTC_EnableInitMode function)
TimeFormat and Hours should follow the same format
Reference Manual to
LL API cross
reference:
TR PM LL_RTC_TIME_Config
TR HT LL_RTC_TIME_Config
TR HU LL_RTC_TIME_Config
TR MNT LL_RTC_TIME_Config
TR MNU LL_RTC_TIME_Config
TR ST LL_RTC_TIME_Config
TR SU LL_RTC_TIME_Config
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
LL_RTC_TIME_Get
Function name
__STATIC_INLINE uint32_t LL_RTC_TIME_Get (RTC_TypeDef
* RTCx)
Function description
Get time (hour, minute and second) in BCD format.
Parameters
RTCx: RTC Instance
Return values
Combination: of hours, minutes and seconds (Format:
0x00HHMMSS).
Notes
if shadow mode is disabled (BYPSHAD=0), need to check if
RSF flag is set before reading this bit
Read either RTC_SSR or RTC_TR locks the values in the
higher-order calendar shadow registers until RTC_DR is read
(LL_RTC_ReadReg(RTC, DR)).
helper macros __LL_RTC_GET_HOUR,
__LL_RTC_GET_MINUTE and __LL_RTC_GET_SECOND
are available to get independently each parameter.
Reference Manual to
LL API cross
reference:
TR HT LL_RTC_TIME_Get
TR HU LL_RTC_TIME_Get
TR MNT LL_RTC_TIME_Get
TR MNU LL_RTC_TIME_Get
TR ST LL_RTC_TIME_Get
TR SU LL_RTC_TIME_Get
LL_RTC_TIME_EnableDayLightStore
Function name
__STATIC_INLINE void LL_RTC_TIME_EnableDayLightStore
(RTC_TypeDef * RTCx)
Function description
Memorize whether the daylight saving time change has been
performed.
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Reference Manual to
LL API cross
reference:
CR BKP LL_RTC_TIME_EnableDayLightStore
LL_RTC_TIME_DisableDayLightStore
Function name
__STATIC_INLINE void LL_RTC_TIME_DisableDayLightStore
(RTC_TypeDef * RTCx)
Function description
Disable memorization whether the daylight saving time change
has been performed.
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
DocID026525 Rev 6
973/1320
LL RTC Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
CR BKP LL_RTC_TIME_DisableDayLightStore
LL_RTC_TIME_IsDayLightStoreEnabled
Function name
__STATIC_INLINE uint32_t
LL_RTC_TIME_IsDayLightStoreEnabled (RTC_TypeDef *
RTCx)
Function description
Check if RTC Day Light Saving stored operation has been enabled
or not.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR BKP LL_RTC_TIME_IsDayLightStoreEnabled
LL_RTC_TIME_DecHour
Function name
__STATIC_INLINE void LL_RTC_TIME_DecHour
(RTC_TypeDef * RTCx)
Function description
Subtract 1 hour (winter time change)
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Reference Manual to
LL API cross
reference:
CR SUB1H LL_RTC_TIME_DecHour
LL_RTC_TIME_IncHour
974/1320
Function name
__STATIC_INLINE void LL_RTC_TIME_IncHour (RTC_TypeDef
* RTCx)
Function description
Add 1 hour (summer time change)
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Reference Manual to
LL API cross
reference:
CR ADD1H LL_RTC_TIME_IncHour
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
LL_RTC_TIME_GetSubSecond
Function name
__STATIC_INLINE uint32_t LL_RTC_TIME_GetSubSecond
(RTC_TypeDef * RTCx)
Function description
Get Sub second value in the synchronous prescaler counter.
Parameters
RTCx: RTC Instance
Return values
Sub: second value (number between 0 and 65535)
Notes
You can use both SubSeconds value and SecondFraction
(PREDIV_S through LL_RTC_GetSynchPrescaler function)
terms returned to convert Calendar SubSeconds value in
second fraction ratio with time unit following generic formula:
==> Seconds fraction ratio * time_unit= [(SecondFractionSubSeconds)/(SecondFraction+1)] * time_unit This
conversion can be performed only if no shift operation is
pending (ie. SHFP=0) when PREDIV_S >= SS.
Reference Manual to
LL API cross
reference:
SSR SS LL_RTC_TIME_GetSubSecond
LL_RTC_TIME_Synchronize
Function name
__STATIC_INLINE void LL_RTC_TIME_Synchronize
(RTC_TypeDef * RTCx, uint32_t ShiftSecond, uint32_t
Fraction)
Function description
Synchronize to a remote clock with a high degree of precision.
Parameters
RTCx: RTC Instance
ShiftSecond: This parameter can be one of the following
values:
LL_RTC_SHIFT_SECOND_DELAY
LL_RTC_SHIFT_SECOND_ADVANCE
Fraction: Number of Seconds Fractions (any value from 0 to
0x7FFF)
Return values
None
Notes
This operation effectively subtracts from (delays) or advance
the clock of a fraction of a second.
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
When REFCKON is set, firmware must not write to Shift
control register.
Reference Manual to
LL API cross
reference:
SHIFTR ADD1S LL_RTC_TIME_Synchronize
SHIFTR SUBFS LL_RTC_TIME_Synchronize
LL_RTC_DATE_SetYear
Function name
__STATIC_INLINE void LL_RTC_DATE_SetYear
(RTC_TypeDef * RTCx, uint32_t Year)
Function description
Set Year in BCD format.
DocID026525 Rev 6
975/1320
LL RTC Generic Driver
Parameters
UM1785
RTCx: RTC Instance
Year: Value between Min_Data=0x00 and Max_Data=0x99
Return values
None
Notes
helper macro __LL_RTC_CONVERT_BIN2BCD is available
to convert Year from binary to BCD format
Reference Manual to
LL API cross
reference:
DR YT LL_RTC_DATE_SetYear
DR YU LL_RTC_DATE_SetYear
LL_RTC_DATE_GetYear
Function name
__STATIC_INLINE uint32_t LL_RTC_DATE_GetYear
(RTC_TypeDef * RTCx)
Function description
Get Year in BCD format.
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data=0x00 and Max_Data=0x99
Notes
if shadow mode is disabled (BYPSHAD=0), need to check if
RSF flag is set before reading this bit
helper macro __LL_RTC_CONVERT_BCD2BIN is available
to convert Year from BCD to Binary format
Reference Manual to
LL API cross
reference:
DR YT LL_RTC_DATE_GetYear
DR YU LL_RTC_DATE_GetYear
LL_RTC_DATE_SetWeekDay
976/1320
Function name
__STATIC_INLINE void LL_RTC_DATE_SetWeekDay
(RTC_TypeDef * RTCx, uint32_t WeekDay)
Function description
Set Week day.
Parameters
RTCx: RTC Instance
WeekDay: This parameter can be one of the following
values:
LL_RTC_WEEKDAY_MONDAY
LL_RTC_WEEKDAY_TUESDAY
LL_RTC_WEEKDAY_WEDNESDAY
LL_RTC_WEEKDAY_THURSDAY
LL_RTC_WEEKDAY_FRIDAY
LL_RTC_WEEKDAY_SATURDAY
LL_RTC_WEEKDAY_SUNDAY
Return values
None
Reference Manual to
LL API cross
reference:
DR WDU LL_RTC_DATE_SetWeekDay
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
LL_RTC_DATE_GetWeekDay
Function name
__STATIC_INLINE uint32_t LL_RTC_DATE_GetWeekDay
(RTC_TypeDef * RTCx)
Function description
Get Week day.
Parameters
RTCx: RTC Instance
Return values
Returned: value can be one of the following values:
LL_RTC_WEEKDAY_MONDAY
LL_RTC_WEEKDAY_TUESDAY
LL_RTC_WEEKDAY_WEDNESDAY
LL_RTC_WEEKDAY_THURSDAY
LL_RTC_WEEKDAY_FRIDAY
LL_RTC_WEEKDAY_SATURDAY
LL_RTC_WEEKDAY_SUNDAY
Notes
if shadow mode is disabled (BYPSHAD=0), need to check if
RSF flag is set before reading this bit
Reference Manual to
LL API cross
reference:
DR WDU LL_RTC_DATE_GetWeekDay
LL_RTC_DATE_SetMonth
Function name
__STATIC_INLINE void LL_RTC_DATE_SetMonth
(RTC_TypeDef * RTCx, uint32_t Month)
Function description
Set Month in BCD format.
Parameters
RTCx: RTC Instance
Month: This parameter can be one of the following values:
LL_RTC_MONTH_JANUARY
LL_RTC_MONTH_FEBRUARY
LL_RTC_MONTH_MARCH
LL_RTC_MONTH_APRIL
LL_RTC_MONTH_MAY
LL_RTC_MONTH_JUNE
LL_RTC_MONTH_JULY
LL_RTC_MONTH_AUGUST
LL_RTC_MONTH_SEPTEMBER
LL_RTC_MONTH_OCTOBER
LL_RTC_MONTH_NOVEMBER
LL_RTC_MONTH_DECEMBER
Return values
None
Notes
helper macro __LL_RTC_CONVERT_BIN2BCD is available
to convert Month from binary to BCD format
Reference Manual to
LL API cross
reference:
DR MT LL_RTC_DATE_SetMonth
DR MU LL_RTC_DATE_SetMonth
DocID026525 Rev 6
977/1320
LL RTC Generic Driver
UM1785
LL_RTC_DATE_GetMonth
Function name
__STATIC_INLINE uint32_t LL_RTC_DATE_GetMonth
(RTC_TypeDef * RTCx)
Function description
Get Month in BCD format.
Parameters
RTCx: RTC Instance
Return values
Returned: value can be one of the following values:
LL_RTC_MONTH_JANUARY
LL_RTC_MONTH_FEBRUARY
LL_RTC_MONTH_MARCH
LL_RTC_MONTH_APRIL
LL_RTC_MONTH_MAY
LL_RTC_MONTH_JUNE
LL_RTC_MONTH_JULY
LL_RTC_MONTH_AUGUST
LL_RTC_MONTH_SEPTEMBER
LL_RTC_MONTH_OCTOBER
LL_RTC_MONTH_NOVEMBER
LL_RTC_MONTH_DECEMBER
Notes
if shadow mode is disabled (BYPSHAD=0), need to check if
RSF flag is set before reading this bit
helper macro __LL_RTC_CONVERT_BCD2BIN is available
to convert Month from BCD to Binary format
Reference Manual to
LL API cross
reference:
DR MT LL_RTC_DATE_GetMonth
DR MU LL_RTC_DATE_GetMonth
LL_RTC_DATE_SetDay
Function name
__STATIC_INLINE void LL_RTC_DATE_SetDay (RTC_TypeDef
* RTCx, uint32_t Day)
Function description
Set Day in BCD format.
Parameters
RTCx: RTC Instance
Day: Value between Min_Data=0x01 and Max_Data=0x31
Return values
None
Notes
helper macro __LL_RTC_CONVERT_BIN2BCD is available
to convert Day from binary to BCD format
Reference Manual to
LL API cross
reference:
DR DT LL_RTC_DATE_SetDay
DR DU LL_RTC_DATE_SetDay
LL_RTC_DATE_GetDay
Function name
__STATIC_INLINE uint32_t LL_RTC_DATE_GetDay
(RTC_TypeDef * RTCx)
Function description
Get Day in BCD format.
Parameters
978/1320
RTCx: RTC Instance
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
Return values
Value: between Min_Data=0x01 and Max_Data=0x31
Notes
if shadow mode is disabled (BYPSHAD=0), need to check if
RSF flag is set before reading this bit
helper macro __LL_RTC_CONVERT_BCD2BIN is available
to convert Day from BCD to Binary format
Reference Manual to
LL API cross
reference:
DR DT LL_RTC_DATE_GetDay
DR DU LL_RTC_DATE_GetDay
LL_RTC_DATE_Config
Function name
__STATIC_INLINE void LL_RTC_DATE_Config (RTC_TypeDef
* RTCx, uint32_t WeekDay, uint32_t Day, uint32_t Month,
uint32_t Year)
Function description
Set date (WeekDay, Day, Month and Year) in BCD format.
Parameters
RTCx: RTC Instance
WeekDay: This parameter can be one of the following
values:
LL_RTC_WEEKDAY_MONDAY
LL_RTC_WEEKDAY_TUESDAY
LL_RTC_WEEKDAY_WEDNESDAY
LL_RTC_WEEKDAY_THURSDAY
LL_RTC_WEEKDAY_FRIDAY
LL_RTC_WEEKDAY_SATURDAY
LL_RTC_WEEKDAY_SUNDAY
Day: Value between Min_Data=0x01 and Max_Data=0x31
Month: This parameter can be one of the following values:
LL_RTC_MONTH_JANUARY
LL_RTC_MONTH_FEBRUARY
LL_RTC_MONTH_MARCH
LL_RTC_MONTH_APRIL
LL_RTC_MONTH_MAY
LL_RTC_MONTH_JUNE
LL_RTC_MONTH_JULY
LL_RTC_MONTH_AUGUST
LL_RTC_MONTH_SEPTEMBER
LL_RTC_MONTH_OCTOBER
LL_RTC_MONTH_NOVEMBER
LL_RTC_MONTH_DECEMBER
Year: Value between Min_Data=0x00 and Max_Data=0x99
Return values
None
Reference Manual to
LL API cross
reference:
DR WDU LL_RTC_DATE_Config
DR MT LL_RTC_DATE_Config
DR MU LL_RTC_DATE_Config
DR DT LL_RTC_DATE_Config
DR DU LL_RTC_DATE_Config
DR YT LL_RTC_DATE_Config
DR YU LL_RTC_DATE_Config
DocID026525 Rev 6
979/1320
LL RTC Generic Driver
UM1785
LL_RTC_DATE_Get
Function name
__STATIC_INLINE uint32_t LL_RTC_DATE_Get (RTC_TypeDef
* RTCx)
Function description
Get date (WeekDay, Day, Month and Year) in BCD format.
Parameters
RTCx: RTC Instance
Return values
Combination: of WeekDay, Day, Month and Year (Format:
0xWWDDMMYY).
Notes
if shadow mode is disabled (BYPSHAD=0), need to check if
RSF flag is set before reading this bit
helper macros __LL_RTC_GET_WEEKDAY,
__LL_RTC_GET_YEAR, __LL_RTC_GET_MONTH, and
__LL_RTC_GET_DAY are available to get independently
each parameter.
Reference Manual to
LL API cross
reference:
DR WDU LL_RTC_DATE_Get
DR MT LL_RTC_DATE_Get
DR MU LL_RTC_DATE_Get
DR DT LL_RTC_DATE_Get
DR DU LL_RTC_DATE_Get
DR YT LL_RTC_DATE_Get
DR YU LL_RTC_DATE_Get
LL_RTC_ALMA_Enable
Function name
__STATIC_INLINE void LL_RTC_ALMA_Enable (RTC_TypeDef
* RTCx)
Function description
Enable Alarm A.
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Reference Manual to
LL API cross
reference:
CR ALRAE LL_RTC_ALMA_Enable
LL_RTC_ALMA_Disable
980/1320
Function name
__STATIC_INLINE void LL_RTC_ALMA_Disable
(RTC_TypeDef * RTCx)
Function description
Disable Alarm A.
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
Reference Manual to
LL API cross
reference:
CR ALRAE LL_RTC_ALMA_Disable
LL_RTC_ALMA_SetMask
Function name
__STATIC_INLINE void LL_RTC_ALMA_SetMask
(RTC_TypeDef * RTCx, uint32_t Mask)
Function description
Specify the Alarm A masks.
Parameters
RTCx: RTC Instance
Mask: This parameter can be a combination of the following
values:
LL_RTC_ALMA_MASK_NONE
LL_RTC_ALMA_MASK_DATEWEEKDAY
LL_RTC_ALMA_MASK_HOURS
LL_RTC_ALMA_MASK_MINUTES
LL_RTC_ALMA_MASK_SECONDS
LL_RTC_ALMA_MASK_ALL
Return values
None
Reference Manual to
LL API cross
reference:
ALRMAR MSK4 LL_RTC_ALMA_SetMask
ALRMAR MSK3 LL_RTC_ALMA_SetMask
ALRMAR MSK2 LL_RTC_ALMA_SetMask
ALRMAR MSK1 LL_RTC_ALMA_SetMask
LL_RTC_ALMA_GetMask
Function name
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetMask
(RTC_TypeDef * RTCx)
Function description
Get the Alarm A masks.
Parameters
RTCx: RTC Instance
Return values
Returned: value can be can be a combination of the
following values:
LL_RTC_ALMA_MASK_NONE
LL_RTC_ALMA_MASK_DATEWEEKDAY
LL_RTC_ALMA_MASK_HOURS
LL_RTC_ALMA_MASK_MINUTES
LL_RTC_ALMA_MASK_SECONDS
LL_RTC_ALMA_MASK_ALL
Reference Manual to
LL API cross
reference:
ALRMAR MSK4 LL_RTC_ALMA_GetMask
ALRMAR MSK3 LL_RTC_ALMA_GetMask
ALRMAR MSK2 LL_RTC_ALMA_GetMask
ALRMAR MSK1 LL_RTC_ALMA_GetMask
DocID026525 Rev 6
981/1320
LL RTC Generic Driver
UM1785
LL_RTC_ALMA_EnableWeekday
Function name
__STATIC_INLINE void LL_RTC_ALMA_EnableWeekday
(RTC_TypeDef * RTCx)
Function description
Enable AlarmA Week day selection (DU[3:0] represents the week
day.
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
ALRMAR WDSEL LL_RTC_ALMA_EnableWeekday
LL_RTC_ALMA_DisableWeekday
Function name
__STATIC_INLINE void LL_RTC_ALMA_DisableWeekday
(RTC_TypeDef * RTCx)
Function description
Disable AlarmA Week day selection (DU[3:0] represents the date )
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
ALRMAR WDSEL LL_RTC_ALMA_DisableWeekday
LL_RTC_ALMA_SetDay
Function name
__STATIC_INLINE void LL_RTC_ALMA_SetDay (RTC_TypeDef
* RTCx, uint32_t Day)
Function description
Set ALARM A Day in BCD format.
Parameters
RTCx: RTC Instance
Day: Value between Min_Data=0x01 and Max_Data=0x31
Return values
None
Notes
helper macro __LL_RTC_CONVERT_BIN2BCD is available
to convert Day from binary to BCD format
Reference Manual to
LL API cross
reference:
ALRMAR DT LL_RTC_ALMA_SetDay
ALRMAR DU LL_RTC_ALMA_SetDay
LL_RTC_ALMA_GetDay
982/1320
Function name
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetDay
(RTC_TypeDef * RTCx)
Function description
Get ALARM A Day in BCD format.
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data=0x01 and Max_Data=0x31
Notes
helper macro __LL_RTC_CONVERT_BCD2BIN is available
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
to convert Day from BCD to Binary format
Reference Manual to
LL API cross
reference:
ALRMAR DT LL_RTC_ALMA_GetDay
ALRMAR DU LL_RTC_ALMA_GetDay
LL_RTC_ALMA_SetWeekDay
Function name
__STATIC_INLINE void LL_RTC_ALMA_SetWeekDay
(RTC_TypeDef * RTCx, uint32_t WeekDay)
Function description
Set ALARM A Weekday.
Parameters
RTCx: RTC Instance
WeekDay: This parameter can be one of the following
values:
LL_RTC_WEEKDAY_MONDAY
LL_RTC_WEEKDAY_TUESDAY
LL_RTC_WEEKDAY_WEDNESDAY
LL_RTC_WEEKDAY_THURSDAY
LL_RTC_WEEKDAY_FRIDAY
LL_RTC_WEEKDAY_SATURDAY
LL_RTC_WEEKDAY_SUNDAY
Return values
None
Reference Manual to
LL API cross
reference:
ALRMAR DU LL_RTC_ALMA_SetWeekDay
LL_RTC_ALMA_GetWeekDay
Function name
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetWeekDay
(RTC_TypeDef * RTCx)
Function description
Get ALARM A Weekday.
Parameters
RTCx: RTC Instance
Return values
Returned: value can be one of the following values:
LL_RTC_WEEKDAY_MONDAY
LL_RTC_WEEKDAY_TUESDAY
LL_RTC_WEEKDAY_WEDNESDAY
LL_RTC_WEEKDAY_THURSDAY
LL_RTC_WEEKDAY_FRIDAY
LL_RTC_WEEKDAY_SATURDAY
LL_RTC_WEEKDAY_SUNDAY
Reference Manual to
LL API cross
reference:
ALRMAR DU LL_RTC_ALMA_GetWeekDay
LL_RTC_ALMA_SetTimeFormat
Function name
__STATIC_INLINE void LL_RTC_ALMA_SetTimeFormat
(RTC_TypeDef * RTCx, uint32_t TimeFormat)
Function description
Set Alarm A time format (AM/24-hour or PM notation)
DocID026525 Rev 6
983/1320
LL RTC Generic Driver
Parameters
UM1785
RTCx: RTC Instance
TimeFormat: This parameter can be one of the following
values:
LL_RTC_ALMA_TIME_FORMAT_AM
LL_RTC_ALMA_TIME_FORMAT_PM
Return values
None
Reference Manual to
LL API cross
reference:
ALRMAR PM LL_RTC_ALMA_SetTimeFormat
LL_RTC_ALMA_GetTimeFormat
Function name
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetTimeFormat
(RTC_TypeDef * RTCx)
Function description
Get Alarm A time format (AM or PM notation)
Parameters
RTCx: RTC Instance
Return values
Returned: value can be one of the following values:
LL_RTC_ALMA_TIME_FORMAT_AM
LL_RTC_ALMA_TIME_FORMAT_PM
Reference Manual to
LL API cross
reference:
ALRMAR PM LL_RTC_ALMA_GetTimeFormat
LL_RTC_ALMA_SetHour
Function name
__STATIC_INLINE void LL_RTC_ALMA_SetHour
(RTC_TypeDef * RTCx, uint32_t Hours)
Function description
Set ALARM A Hours in BCD format.
Parameters
RTCx: RTC Instance
Hours: Value between Min_Data=0x01 and Max_Data=0x12
or between Min_Data=0x00 and Max_Data=0x23
Return values
None
Notes
helper macro __LL_RTC_CONVERT_BIN2BCD is available
to convert Hours from binary to BCD format
Reference Manual to
LL API cross
reference:
ALRMAR HT LL_RTC_ALMA_SetHour
ALRMAR HU LL_RTC_ALMA_SetHour
LL_RTC_ALMA_GetHour
984/1320
Function name
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetHour
(RTC_TypeDef * RTCx)
Function description
Get ALARM A Hours in BCD format.
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data=0x01 and Max_Data=0x12 or
between Min_Data=0x00 and Max_Data=0x23
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
Notes
helper macro __LL_RTC_CONVERT_BCD2BIN is available
to convert Hours from BCD to Binary format
Reference Manual to
LL API cross
reference:
ALRMAR HT LL_RTC_ALMA_GetHour
ALRMAR HU LL_RTC_ALMA_GetHour
LL_RTC_ALMA_SetMinute
Function name
__STATIC_INLINE void LL_RTC_ALMA_SetMinute
(RTC_TypeDef * RTCx, uint32_t Minutes)
Function description
Set ALARM A Minutes in BCD format.
Parameters
RTCx: RTC Instance
Minutes: Value between Min_Data=0x00 and
Max_Data=0x59
Return values
None
Notes
helper macro __LL_RTC_CONVERT_BIN2BCD is available
to convert Minutes from binary to BCD format
Reference Manual to
LL API cross
reference:
ALRMAR MNT LL_RTC_ALMA_SetMinute
ALRMAR MNU LL_RTC_ALMA_SetMinute
LL_RTC_ALMA_GetMinute
Function name
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetMinute
(RTC_TypeDef * RTCx)
Function description
Get ALARM A Minutes in BCD format.
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data=0x00 and Max_Data=0x59
Notes
helper macro __LL_RTC_CONVERT_BCD2BIN is available
to convert Minutes from BCD to Binary format
Reference Manual to
LL API cross
reference:
ALRMAR MNT LL_RTC_ALMA_GetMinute
ALRMAR MNU LL_RTC_ALMA_GetMinute
LL_RTC_ALMA_SetSecond
Function name
__STATIC_INLINE void LL_RTC_ALMA_SetSecond
(RTC_TypeDef * RTCx, uint32_t Seconds)
Function description
Set ALARM A Seconds in BCD format.
Parameters
RTCx: RTC Instance
Seconds: Value between Min_Data=0x00 and
Max_Data=0x59
Return values
None
Notes
helper macro __LL_RTC_CONVERT_BIN2BCD is available
to convert Seconds from binary to BCD format
Reference Manual to
ALRMAR ST LL_RTC_ALMA_SetSecond
DocID026525 Rev 6
985/1320
LL RTC Generic Driver
LL API cross
reference:
UM1785
ALRMAR SU LL_RTC_ALMA_SetSecond
LL_RTC_ALMA_GetSecond
Function name
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetSecond
(RTC_TypeDef * RTCx)
Function description
Get ALARM A Seconds in BCD format.
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data=0x00 and Max_Data=0x59
Notes
helper macro __LL_RTC_CONVERT_BCD2BIN is available
to convert Seconds from BCD to Binary format
Reference Manual to
LL API cross
reference:
ALRMAR ST LL_RTC_ALMA_GetSecond
ALRMAR SU LL_RTC_ALMA_GetSecond
LL_RTC_ALMA_ConfigTime
Function name
__STATIC_INLINE void LL_RTC_ALMA_ConfigTime
(RTC_TypeDef * RTCx, uint32_t Format12_24, uint32_t Hours,
uint32_t Minutes, uint32_t Seconds)
Function description
Set Alarm A Time (hour, minute and second) in BCD format.
Parameters
RTCx: RTC Instance
Format12_24: This parameter can be one of the following
values:
LL_RTC_ALMA_TIME_FORMAT_AM
LL_RTC_ALMA_TIME_FORMAT_PM
Hours: Value between Min_Data=0x01 and Max_Data=0x12
or between Min_Data=0x00 and Max_Data=0x23
Minutes: Value between Min_Data=0x00 and
Max_Data=0x59
Seconds: Value between Min_Data=0x00 and
Max_Data=0x59
Return values
None
Reference Manual to
LL API cross
reference:
ALRMAR PM LL_RTC_ALMA_ConfigTime
ALRMAR HT LL_RTC_ALMA_ConfigTime
ALRMAR HU LL_RTC_ALMA_ConfigTime
ALRMAR MNT LL_RTC_ALMA_ConfigTime
ALRMAR MNU LL_RTC_ALMA_ConfigTime
ALRMAR ST LL_RTC_ALMA_ConfigTime
ALRMAR SU LL_RTC_ALMA_ConfigTime
LL_RTC_ALMA_GetTime
Function name
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetTime
(RTC_TypeDef * RTCx)
Function description
Get Alarm B Time (hour, minute and second) in BCD format.
Parameters
986/1320
RTCx: RTC Instance
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
Return values
Combination: of hours, minutes and seconds.
Notes
helper macros __LL_RTC_GET_HOUR,
__LL_RTC_GET_MINUTE and __LL_RTC_GET_SECOND
are available to get independently each parameter.
Reference Manual to
LL API cross
reference:
ALRMAR HT LL_RTC_ALMA_GetTime
ALRMAR HU LL_RTC_ALMA_GetTime
ALRMAR MNT LL_RTC_ALMA_GetTime
ALRMAR MNU LL_RTC_ALMA_GetTime
ALRMAR ST LL_RTC_ALMA_GetTime
ALRMAR SU LL_RTC_ALMA_GetTime
LL_RTC_ALMA_SetSubSecondMask
Function name
__STATIC_INLINE void LL_RTC_ALMA_SetSubSecondMask
(RTC_TypeDef * RTCx, uint32_t Mask)
Function description
Set Alarm A Mask the most-significant bits starting at this bit.
Parameters
RTCx: RTC Instance
Mask: Value between Min_Data=0x00 and Max_Data=0xF
Return values
None
Notes
This register can be written only when ALRAE is reset in
RTC_CR register, or in initialization mode.
Reference Manual to
LL API cross
reference:
ALRMASSR MASKSS LL_RTC_ALMA_SetSubSecondMask
LL_RTC_ALMA_GetSubSecondMask
Function name
__STATIC_INLINE uint32_t
LL_RTC_ALMA_GetSubSecondMask (RTC_TypeDef * RTCx)
Function description
Get Alarm A Mask the most-significant bits starting at this bit.
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data=0x00 and Max_Data=0xF
Reference Manual to
LL API cross
reference:
ALRMASSR MASKSS LL_RTC_ALMA_GetSubSecondMask
LL_RTC_ALMA_SetSubSecond
Function name
__STATIC_INLINE void LL_RTC_ALMA_SetSubSecond
(RTC_TypeDef * RTCx, uint32_t Subsecond)
Function description
Set Alarm A Sub seconds value.
Parameters
RTCx: RTC Instance
Subsecond: Value between Min_Data=0x00 and
Max_Data=0x7FFF
Return values
None
DocID026525 Rev 6
987/1320
LL RTC Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
ALRMASSR SS LL_RTC_ALMA_SetSubSecond
LL_RTC_ALMA_GetSubSecond
Function name
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetSubSecond
(RTC_TypeDef * RTCx)
Function description
Get Alarm A Sub seconds value.
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data=0x00 and Max_Data=0x7FFF
Reference Manual to
LL API cross
reference:
ALRMASSR SS LL_RTC_ALMA_GetSubSecond
LL_RTC_TS_Enable
Function name
__STATIC_INLINE void LL_RTC_TS_Enable (RTC_TypeDef *
RTCx)
Function description
Enable Timestamp.
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Reference Manual to
LL API cross
reference:
CR TSE LL_RTC_TS_Enable
LL_RTC_TS_Disable
988/1320
Function name
__STATIC_INLINE void LL_RTC_TS_Disable (RTC_TypeDef *
RTCx)
Function description
Disable Timestamp.
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Reference Manual to
LL API cross
reference:
CR TSE LL_RTC_TS_Disable
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
LL_RTC_TS_SetActiveEdge
Function name
__STATIC_INLINE void LL_RTC_TS_SetActiveEdge
(RTC_TypeDef * RTCx, uint32_t Edge)
Function description
Set Time-stamp event active edge.
Parameters
RTCx: RTC Instance
Edge: This parameter can be one of the following values:
LL_RTC_TIMESTAMP_EDGE_RISING
LL_RTC_TIMESTAMP_EDGE_FALLING
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
TSE must be reset when TSEDGE is changed to avoid
unwanted TSF setting
Reference Manual to
LL API cross
reference:
CR TSEDGE LL_RTC_TS_SetActiveEdge
LL_RTC_TS_GetActiveEdge
Function name
__STATIC_INLINE uint32_t LL_RTC_TS_GetActiveEdge
(RTC_TypeDef * RTCx)
Function description
Get Time-stamp event active edge.
Parameters
RTCx: RTC Instance
Return values
Returned: value can be one of the following values:
LL_RTC_TIMESTAMP_EDGE_RISING
LL_RTC_TIMESTAMP_EDGE_FALLING
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Reference Manual to
LL API cross
reference:
CR TSEDGE LL_RTC_TS_GetActiveEdge
LL_RTC_TS_GetTimeFormat
Function name
__STATIC_INLINE uint32_t LL_RTC_TS_GetTimeFormat
(RTC_TypeDef * RTCx)
Function description
Get Timestamp AM/PM notation (AM or 24-hour format)
Parameters
RTCx: RTC Instance
Return values
Returned: value can be one of the following values:
LL_RTC_TS_TIME_FORMAT_AM
LL_RTC_TS_TIME_FORMAT_PM
Reference Manual to
LL API cross
reference:
TSTR PM LL_RTC_TS_GetTimeFormat
DocID026525 Rev 6
989/1320
LL RTC Generic Driver
UM1785
LL_RTC_TS_GetHour
Function name
__STATIC_INLINE uint32_t LL_RTC_TS_GetHour
(RTC_TypeDef * RTCx)
Function description
Get Timestamp Hours in BCD format.
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data=0x01 and Max_Data=0x12 or
between Min_Data=0x00 and Max_Data=0x23
Notes
helper macro __LL_RTC_CONVERT_BCD2BIN is available
to convert Hours from BCD to Binary format
Reference Manual to
LL API cross
reference:
TSTR HT LL_RTC_TS_GetHour
TSTR HU LL_RTC_TS_GetHour
LL_RTC_TS_GetMinute
Function name
__STATIC_INLINE uint32_t LL_RTC_TS_GetMinute
(RTC_TypeDef * RTCx)
Function description
Get Timestamp Minutes in BCD format.
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data=0x00 and Max_Data=0x59
Notes
helper macro __LL_RTC_CONVERT_BCD2BIN is available
to convert Minutes from BCD to Binary format
Reference Manual to
LL API cross
reference:
TSTR MNT LL_RTC_TS_GetMinute
TSTR MNU LL_RTC_TS_GetMinute
LL_RTC_TS_GetSecond
990/1320
Function name
__STATIC_INLINE uint32_t LL_RTC_TS_GetSecond
(RTC_TypeDef * RTCx)
Function description
Get Timestamp Seconds in BCD format.
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data=0x00 and Max_Data=0x59
Notes
helper macro __LL_RTC_CONVERT_BCD2BIN is available
to convert Seconds from BCD to Binary format
Reference Manual to
LL API cross
reference:
TSTR ST LL_RTC_TS_GetSecond
TSTR SU LL_RTC_TS_GetSecond
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
LL_RTC_TS_GetTime
Function name
__STATIC_INLINE uint32_t LL_RTC_TS_GetTime
(RTC_TypeDef * RTCx)
Function description
Get Timestamp time (hour, minute and second) in BCD format.
Parameters
RTCx: RTC Instance
Return values
Combination: of hours, minutes and seconds.
Notes
helper macros __LL_RTC_GET_HOUR,
__LL_RTC_GET_MINUTE and __LL_RTC_GET_SECOND
are available to get independently each parameter.
Reference Manual to
LL API cross
reference:
TSTR HT LL_RTC_TS_GetTime
TSTR HU LL_RTC_TS_GetTime
TSTR MNT LL_RTC_TS_GetTime
TSTR MNU LL_RTC_TS_GetTime
TSTR ST LL_RTC_TS_GetTime
TSTR SU LL_RTC_TS_GetTime
LL_RTC_TS_GetWeekDay
Function name
__STATIC_INLINE uint32_t LL_RTC_TS_GetWeekDay
(RTC_TypeDef * RTCx)
Function description
Get Timestamp Week day.
Parameters
RTCx: RTC Instance
Return values
Returned: value can be one of the following values:
LL_RTC_WEEKDAY_MONDAY
LL_RTC_WEEKDAY_TUESDAY
LL_RTC_WEEKDAY_WEDNESDAY
LL_RTC_WEEKDAY_THURSDAY
LL_RTC_WEEKDAY_FRIDAY
LL_RTC_WEEKDAY_SATURDAY
LL_RTC_WEEKDAY_SUNDAY
Reference Manual to
LL API cross
reference:
TSDR WDU LL_RTC_TS_GetWeekDay
LL_RTC_TS_GetMonth
Function name
__STATIC_INLINE uint32_t LL_RTC_TS_GetMonth
(RTC_TypeDef * RTCx)
Function description
Get Timestamp Month in BCD format.
Parameters
RTCx: RTC Instance
Return values
Returned: value can be one of the following values:
LL_RTC_MONTH_JANUARY
LL_RTC_MONTH_FEBRUARY
LL_RTC_MONTH_MARCH
LL_RTC_MONTH_APRIL
LL_RTC_MONTH_MAY
LL_RTC_MONTH_JUNE
DocID026525 Rev 6
991/1320
LL RTC Generic Driver
UM1785
LL_RTC_MONTH_JULY
LL_RTC_MONTH_AUGUST
LL_RTC_MONTH_SEPTEMBER
LL_RTC_MONTH_OCTOBER
LL_RTC_MONTH_NOVEMBER
LL_RTC_MONTH_DECEMBER
Notes
helper macro __LL_RTC_CONVERT_BCD2BIN is available
to convert Month from BCD to Binary format
Reference Manual to
LL API cross
reference:
TSDR MT LL_RTC_TS_GetMonth
TSDR MU LL_RTC_TS_GetMonth
LL_RTC_TS_GetDay
Function name
__STATIC_INLINE uint32_t LL_RTC_TS_GetDay
(RTC_TypeDef * RTCx)
Function description
Get Timestamp Day in BCD format.
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data=0x01 and Max_Data=0x31
Notes
helper macro __LL_RTC_CONVERT_BCD2BIN is available
to convert Day from BCD to Binary format
Reference Manual to
LL API cross
reference:
TSDR DT LL_RTC_TS_GetDay
TSDR DU LL_RTC_TS_GetDay
LL_RTC_TS_GetDate
Function name
__STATIC_INLINE uint32_t LL_RTC_TS_GetDate
(RTC_TypeDef * RTCx)
Function description
Get Timestamp date (WeekDay, Day and Month) in BCD format.
Parameters
RTCx: RTC Instance
Return values
Combination: of Weekday, Day and Month
Notes
helper macros __LL_RTC_GET_WEEKDAY,
__LL_RTC_GET_MONTH, and __LL_RTC_GET_DAY are
available to get independently each parameter.
Reference Manual to
LL API cross
reference:
TSDR WDU LL_RTC_TS_GetDate
TSDR MT LL_RTC_TS_GetDate
TSDR MU LL_RTC_TS_GetDate
TSDR DT LL_RTC_TS_GetDate
TSDR DU LL_RTC_TS_GetDate
LL_RTC_TS_GetSubSecond
992/1320
Function name
__STATIC_INLINE uint32_t LL_RTC_TS_GetSubSecond
(RTC_TypeDef * RTCx)
Function description
Get time-stamp sub second value.
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data=0x00 and Max_Data=0xFFFF
Reference Manual to
LL API cross
reference:
TSSSR SS LL_RTC_TS_GetSubSecond
LL_RTC_TS_EnableOnTamper
Function name
__STATIC_INLINE void LL_RTC_TS_EnableOnTamper
(RTC_TypeDef * RTCx)
Function description
Activate timestamp on tamper detection event.
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
TAFCR TAMPTS LL_RTC_TS_EnableOnTamper
LL_RTC_TS_DisableOnTamper
Function name
__STATIC_INLINE void LL_RTC_TS_DisableOnTamper
(RTC_TypeDef * RTCx)
Function description
Disable timestamp on tamper detection event.
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
TAFCR TAMPTS LL_RTC_TS_DisableOnTamper
LL_RTC_TAMPER_Enable
Function name
__STATIC_INLINE void LL_RTC_TAMPER_Enable
(RTC_TypeDef * RTCx, uint32_t Tamper)
Function description
Enable RTC_TAMPx input detection.
Parameters
RTCx: RTC Instance
Tamper: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_RTC_TAMPER_1
LL_RTC_TAMPER_2
LL_RTC_TAMPER_3 (*)
Return values
None
Reference Manual to
LL API cross
reference:
TAFCR TAMP1E LL_RTC_TAMPER_Enable
TAFCR TAMP2E LL_RTC_TAMPER_Enable
TAFCR TAMP3E LL_RTC_TAMPER_Enable
DocID026525 Rev 6
993/1320
LL RTC Generic Driver
UM1785
LL_RTC_TAMPER_Disable
Function name
__STATIC_INLINE void LL_RTC_TAMPER_Disable
(RTC_TypeDef * RTCx, uint32_t Tamper)
Function description
Clear RTC_TAMPx input detection.
Parameters
RTCx: RTC Instance
Tamper: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_RTC_TAMPER_1
LL_RTC_TAMPER_2
LL_RTC_TAMPER_3 (*)
Return values
None
Reference Manual to
LL API cross
reference:
TAFCR TAMP1E LL_RTC_TAMPER_Disable
TAFCR TAMP2E LL_RTC_TAMPER_Disable
TAFCR TAMP3E LL_RTC_TAMPER_Disable
LL_RTC_TAMPER_DisablePullUp
Function name
__STATIC_INLINE void LL_RTC_TAMPER_DisablePullUp
(RTC_TypeDef * RTCx)
Function description
Disable RTC_TAMPx pull-up disable (Disable precharge of
RTC_TAMPx pins)
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
TAFCR TAMPPUDIS LL_RTC_TAMPER_DisablePullUp
LL_RTC_TAMPER_EnablePullUp
Function name
__STATIC_INLINE void LL_RTC_TAMPER_EnablePullUp
(RTC_TypeDef * RTCx)
Function description
Enable RTC_TAMPx pull-up disable ( Precharge RTC_TAMPx
pins before sampling)
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
TAFCR TAMPPUDIS LL_RTC_TAMPER_EnablePullUp
LL_RTC_TAMPER_SetPrecharge
Function name
__STATIC_INLINE void LL_RTC_TAMPER_SetPrecharge
(RTC_TypeDef * RTCx, uint32_t Duration)
Function description
Set RTC_TAMPx precharge duration.
Parameters
994/1320
RTCx: RTC Instance
Duration: This parameter can be one of the following values:
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
LL_RTC_TAMPER_DURATION_1RTCCLK
LL_RTC_TAMPER_DURATION_2RTCCLK
LL_RTC_TAMPER_DURATION_4RTCCLK
LL_RTC_TAMPER_DURATION_8RTCCLK
Return values
None
Reference Manual to
LL API cross
reference:
TAFCR TAMPPRCH LL_RTC_TAMPER_SetPrecharge
LL_RTC_TAMPER_GetPrecharge
Function name
__STATIC_INLINE uint32_t LL_RTC_TAMPER_GetPrecharge
(RTC_TypeDef * RTCx)
Function description
Get RTC_TAMPx precharge duration.
Parameters
RTCx: RTC Instance
Return values
Returned: value can be one of the following values:
LL_RTC_TAMPER_DURATION_1RTCCLK
LL_RTC_TAMPER_DURATION_2RTCCLK
LL_RTC_TAMPER_DURATION_4RTCCLK
LL_RTC_TAMPER_DURATION_8RTCCLK
Reference Manual to
LL API cross
reference:
TAFCR TAMPPRCH LL_RTC_TAMPER_GetPrecharge
LL_RTC_TAMPER_SetFilterCount
Function name
__STATIC_INLINE void LL_RTC_TAMPER_SetFilterCount
(RTC_TypeDef * RTCx, uint32_t FilterCount)
Function description
Set RTC_TAMPx filter count.
Parameters
RTCx: RTC Instance
FilterCount: This parameter can be one of the following
values:
LL_RTC_TAMPER_FILTER_DISABLE
LL_RTC_TAMPER_FILTER_2SAMPLE
LL_RTC_TAMPER_FILTER_4SAMPLE
LL_RTC_TAMPER_FILTER_8SAMPLE
Return values
None
Reference Manual to
LL API cross
reference:
TAFCR TAMPFLT LL_RTC_TAMPER_SetFilterCount
LL_RTC_TAMPER_GetFilterCount
Function name
__STATIC_INLINE uint32_t LL_RTC_TAMPER_GetFilterCount
(RTC_TypeDef * RTCx)
Function description
Get RTC_TAMPx filter count.
Parameters
RTCx: RTC Instance
DocID026525 Rev 6
995/1320
LL RTC Generic Driver
Return values
Reference Manual to
LL API cross
reference:
UM1785
Returned: value can be one of the following values:
LL_RTC_TAMPER_FILTER_DISABLE
LL_RTC_TAMPER_FILTER_2SAMPLE
LL_RTC_TAMPER_FILTER_4SAMPLE
LL_RTC_TAMPER_FILTER_8SAMPLE
TAFCR TAMPFLT LL_RTC_TAMPER_GetFilterCount
LL_RTC_TAMPER_SetSamplingFreq
Function name
__STATIC_INLINE void LL_RTC_TAMPER_SetSamplingFreq
(RTC_TypeDef * RTCx, uint32_t SamplingFreq)
Function description
Set Tamper sampling frequency.
Parameters
RTCx: RTC Instance
SamplingFreq: This parameter can be one of the following
values:
LL_RTC_TAMPER_SAMPLFREQDIV_32768
LL_RTC_TAMPER_SAMPLFREQDIV_16384
LL_RTC_TAMPER_SAMPLFREQDIV_8192
LL_RTC_TAMPER_SAMPLFREQDIV_4096
LL_RTC_TAMPER_SAMPLFREQDIV_2048
LL_RTC_TAMPER_SAMPLFREQDIV_1024
LL_RTC_TAMPER_SAMPLFREQDIV_512
LL_RTC_TAMPER_SAMPLFREQDIV_256
Return values
None
Reference Manual to
LL API cross
reference:
TAFCR TAMPFREQ LL_RTC_TAMPER_SetSamplingFreq
LL_RTC_TAMPER_GetSamplingFreq
996/1320
Function name
__STATIC_INLINE uint32_t
LL_RTC_TAMPER_GetSamplingFreq (RTC_TypeDef * RTCx)
Function description
Get Tamper sampling frequency.
Parameters
RTCx: RTC Instance
Return values
Returned: value can be one of the following values:
LL_RTC_TAMPER_SAMPLFREQDIV_32768
LL_RTC_TAMPER_SAMPLFREQDIV_16384
LL_RTC_TAMPER_SAMPLFREQDIV_8192
LL_RTC_TAMPER_SAMPLFREQDIV_4096
LL_RTC_TAMPER_SAMPLFREQDIV_2048
LL_RTC_TAMPER_SAMPLFREQDIV_1024
LL_RTC_TAMPER_SAMPLFREQDIV_512
LL_RTC_TAMPER_SAMPLFREQDIV_256
Reference Manual to
LL API cross
reference:
TAFCR TAMPFREQ LL_RTC_TAMPER_GetSamplingFreq
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
LL_RTC_TAMPER_EnableActiveLevel
Function name
__STATIC_INLINE void LL_RTC_TAMPER_EnableActiveLevel
(RTC_TypeDef * RTCx, uint32_t Tamper)
Function description
Enable Active level for Tamper input.
Parameters
RTCx: RTC Instance
Tamper: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_RTC_TAMPER_ACTIVELEVEL_TAMP1
LL_RTC_TAMPER_ACTIVELEVEL_TAMP2
LL_RTC_TAMPER_ACTIVELEVEL_TAMP3 (*)
Return values
None
Reference Manual to
LL API cross
reference:
TAFCR TAMP1TRG LL_RTC_TAMPER_EnableActiveLevel
TAFCR TAMP2TRG LL_RTC_TAMPER_EnableActiveLevel
TAFCR TAMP3TRG LL_RTC_TAMPER_EnableActiveLevel
LL_RTC_TAMPER_DisableActiveLevel
Function name
__STATIC_INLINE void LL_RTC_TAMPER_DisableActiveLevel
(RTC_TypeDef * RTCx, uint32_t Tamper)
Function description
Disable Active level for Tamper input.
Parameters
RTCx: RTC Instance
Tamper: This parameter can be a combination of the
following values: (*) value not defined in all devices.
LL_RTC_TAMPER_ACTIVELEVEL_TAMP1
LL_RTC_TAMPER_ACTIVELEVEL_TAMP2
LL_RTC_TAMPER_ACTIVELEVEL_TAMP3 (*)
Return values
None
Reference Manual to
LL API cross
reference:
TAFCR TAMP1TRG LL_RTC_TAMPER_DisableActiveLevel
TAFCR TAMP2TRG LL_RTC_TAMPER_DisableActiveLevel
TAFCR TAMP3TRG LL_RTC_TAMPER_DisableActiveLevel
LL_RTC_WAKEUP_Enable
Function name
__STATIC_INLINE void LL_RTC_WAKEUP_Enable
(RTC_TypeDef * RTCx)
Function description
Enable Wakeup timer.
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Reference Manual to
LL API cross
reference:
CR WUTE LL_RTC_WAKEUP_Enable
DocID026525 Rev 6
997/1320
LL RTC Generic Driver
UM1785
LL_RTC_WAKEUP_Disable
Function name
__STATIC_INLINE void LL_RTC_WAKEUP_Disable
(RTC_TypeDef * RTCx)
Function description
Disable Wakeup timer.
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Reference Manual to
LL API cross
reference:
CR WUTE LL_RTC_WAKEUP_Disable
LL_RTC_WAKEUP_IsEnabled
Function name
__STATIC_INLINE uint32_t LL_RTC_WAKEUP_IsEnabled
(RTC_TypeDef * RTCx)
Function description
Check if Wakeup timer is enabled or not.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR WUTE LL_RTC_WAKEUP_IsEnabled
LL_RTC_WAKEUP_SetClock
998/1320
Function name
__STATIC_INLINE void LL_RTC_WAKEUP_SetClock
(RTC_TypeDef * RTCx, uint32_t WakeupClock)
Function description
Select Wakeup clock.
Parameters
RTCx: RTC Instance
WakeupClock: This parameter can be one of the following
values:
LL_RTC_WAKEUPCLOCK_DIV_16
LL_RTC_WAKEUPCLOCK_DIV_8
LL_RTC_WAKEUPCLOCK_DIV_4
LL_RTC_WAKEUPCLOCK_DIV_2
LL_RTC_WAKEUPCLOCK_CKSPRE
LL_RTC_WAKEUPCLOCK_CKSPRE_WUT
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Bit can be written only when RTC_CR WUTE bit = 0 and
RTC_ISR WUTWF bit = 1
Reference Manual to
LL API cross
reference:
CR WUCKSEL LL_RTC_WAKEUP_SetClock
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
LL_RTC_WAKEUP_GetClock
Function name
__STATIC_INLINE uint32_t LL_RTC_WAKEUP_GetClock
(RTC_TypeDef * RTCx)
Function description
Get Wakeup clock.
Parameters
RTCx: RTC Instance
Return values
Returned: value can be one of the following values:
LL_RTC_WAKEUPCLOCK_DIV_16
LL_RTC_WAKEUPCLOCK_DIV_8
LL_RTC_WAKEUPCLOCK_DIV_4
LL_RTC_WAKEUPCLOCK_DIV_2
LL_RTC_WAKEUPCLOCK_CKSPRE
LL_RTC_WAKEUPCLOCK_CKSPRE_WUT
Reference Manual to
LL API cross
reference:
CR WUCKSEL LL_RTC_WAKEUP_GetClock
LL_RTC_WAKEUP_SetAutoReload
Function name
__STATIC_INLINE void LL_RTC_WAKEUP_SetAutoReload
(RTC_TypeDef * RTCx, uint32_t Value)
Function description
Set Wakeup auto-reload value.
Parameters
RTCx: RTC Instance
Value: Value between Min_Data=0x00 and
Max_Data=0xFFFF
Return values
None
Notes
Bit can be written only when WUTWF is set to 1 in RTC_ISR
Reference Manual to
LL API cross
reference:
WUTR WUT LL_RTC_WAKEUP_SetAutoReload
LL_RTC_WAKEUP_GetAutoReload
Function name
__STATIC_INLINE uint32_t LL_RTC_WAKEUP_GetAutoReload
(RTC_TypeDef * RTCx)
Function description
Get Wakeup auto-reload value.
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data=0x00 and Max_Data=0xFFFF
Reference Manual to
LL API cross
reference:
WUTR WUT LL_RTC_WAKEUP_GetAutoReload
DocID026525 Rev 6
999/1320
LL RTC Generic Driver
UM1785
LL_RTC_BAK_SetRegister
Function name
__STATIC_INLINE void LL_RTC_BAK_SetRegister
(RTC_TypeDef * RTCx, uint32_t BackupRegister, uint32_t
Data)
Function description
Writes a data in a specified RTC Backup data register.
Parameters
RTCx: RTC Instance
BackupRegister: This parameter can be one of the following
values:
LL_RTC_BKP_DR0
LL_RTC_BKP_DR1
LL_RTC_BKP_DR2
LL_RTC_BKP_DR3
LL_RTC_BKP_DR4
Data: Value between Min_Data=0x00 and
Max_Data=0xFFFFFFFF
Return values
None
Reference Manual to
LL API cross
reference:
BKPxR BKP LL_RTC_BAK_SetRegister
LL_RTC_BAK_GetRegister
Function name
__STATIC_INLINE uint32_t LL_RTC_BAK_GetRegister
(RTC_TypeDef * RTCx, uint32_t BackupRegister)
Function description
Reads data from the specified RTC Backup data Register.
Parameters
RTCx: RTC Instance
BackupRegister: This parameter can be one of the following
values:
LL_RTC_BKP_DR0
LL_RTC_BKP_DR1
LL_RTC_BKP_DR2
LL_RTC_BKP_DR3
LL_RTC_BKP_DR4
Return values
Value: between Min_Data=0x00 and
Max_Data=0xFFFFFFFF
Reference Manual to
LL API cross
reference:
BKPxR BKP LL_RTC_BAK_GetRegister
LL_RTC_CAL_SetOutputFreq
Function name
__STATIC_INLINE void LL_RTC_CAL_SetOutputFreq
(RTC_TypeDef * RTCx, uint32_t Frequency)
Function description
Set Calibration output frequency (1 Hz or 512 Hz)
Parameters
1000/1320
RTCx: RTC Instance
Frequency: This parameter can be one of the following
values:
LL_RTC_CALIB_OUTPUT_NONE
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
LL_RTC_CALIB_OUTPUT_1HZ
LL_RTC_CALIB_OUTPUT_512HZ
Return values
None
Notes
Bits are write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Reference Manual to
LL API cross
reference:
CR COE LL_RTC_CAL_SetOutputFreq
CR COSEL LL_RTC_CAL_SetOutputFreq
LL_RTC_CAL_GetOutputFreq
Function name
__STATIC_INLINE uint32_t LL_RTC_CAL_GetOutputFreq
(RTC_TypeDef * RTCx)
Function description
Get Calibration output frequency (1 Hz or 512 Hz)
Parameters
RTCx: RTC Instance
Return values
Returned: value can be one of the following values:
LL_RTC_CALIB_OUTPUT_NONE
LL_RTC_CALIB_OUTPUT_1HZ
LL_RTC_CALIB_OUTPUT_512HZ
Reference Manual to
LL API cross
reference:
CR COE LL_RTC_CAL_GetOutputFreq
CR COSEL LL_RTC_CAL_GetOutputFreq
LL_RTC_CAL_SetPulse
Function name
__STATIC_INLINE void LL_RTC_CAL_SetPulse (RTC_TypeDef
* RTCx, uint32_t Pulse)
Function description
Insert or not One RTCCLK pulse every 2exp11 pulses (frequency
increased by 488.5 ppm)
Parameters
RTCx: RTC Instance
Pulse: This parameter can be one of the following values:
LL_RTC_CALIB_INSERTPULSE_NONE
LL_RTC_CALIB_INSERTPULSE_SET
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Bit can be written only when RECALPF is set to 0 in
RTC_ISR
Reference Manual to
LL API cross
reference:
CALR CALP LL_RTC_CAL_SetPulse
DocID026525 Rev 6
1001/1320
LL RTC Generic Driver
UM1785
LL_RTC_CAL_IsPulseInserted
Function name
__STATIC_INLINE uint32_t LL_RTC_CAL_IsPulseInserted
(RTC_TypeDef * RTCx)
Function description
Check if one RTCCLK has been inserted or not every 2exp11
pulses (frequency increased by 488.5 ppm)
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CALR CALP LL_RTC_CAL_IsPulseInserted
LL_RTC_CAL_SetPeriod
Function name
__STATIC_INLINE void LL_RTC_CAL_SetPeriod
(RTC_TypeDef * RTCx, uint32_t Period)
Function description
Set the calibration cycle period.
Parameters
RTCx: RTC Instance
Period: This parameter can be one of the following values:
LL_RTC_CALIB_PERIOD_32SEC
LL_RTC_CALIB_PERIOD_16SEC
LL_RTC_CALIB_PERIOD_8SEC
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Bit can be written only when RECALPF is set to 0 in
RTC_ISR
Reference Manual to
LL API cross
reference:
CALR CALW8 LL_RTC_CAL_SetPeriod
CALR CALW16 LL_RTC_CAL_SetPeriod
LL_RTC_CAL_GetPeriod
1002/1320
Function name
__STATIC_INLINE uint32_t LL_RTC_CAL_GetPeriod
(RTC_TypeDef * RTCx)
Function description
Get the calibration cycle period.
Parameters
RTCx: RTC Instance
Return values
Returned: value can be one of the following values:
LL_RTC_CALIB_PERIOD_32SEC
LL_RTC_CALIB_PERIOD_16SEC
LL_RTC_CALIB_PERIOD_8SEC
Reference Manual to
LL API cross
reference:
CALR CALW8 LL_RTC_CAL_GetPeriod
CALR CALW16 LL_RTC_CAL_GetPeriod
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
LL_RTC_CAL_SetMinus
Function name
__STATIC_INLINE void LL_RTC_CAL_SetMinus
(RTC_TypeDef * RTCx, uint32_t CalibMinus)
Function description
Set Calibration minus.
Parameters
RTCx: RTC Instance
CalibMinus: Value between Min_Data=0x00 and
Max_Data=0x1FF
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Bit can be written only when RECALPF is set to 0 in
RTC_ISR
Reference Manual to
LL API cross
reference:
CALR CALM LL_RTC_CAL_SetMinus
LL_RTC_CAL_GetMinus
Function name
__STATIC_INLINE uint32_t LL_RTC_CAL_GetMinus
(RTC_TypeDef * RTCx)
Function description
Get Calibration minus.
Parameters
RTCx: RTC Instance
Return values
Value: between Min_Data=0x00 and Max_Data= 0x1FF
Reference Manual to
LL API cross
reference:
CALR CALM LL_RTC_CAL_GetMinus
LL_RTC_IsActiveFlag_RECALP
Function name
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_RECALP
(RTC_TypeDef * RTCx)
Function description
Get Recalibration pending Flag.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR RECALPF LL_RTC_IsActiveFlag_RECALP
LL_RTC_IsActiveFlag_TAMP3
Function name
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_TAMP3
(RTC_TypeDef * RTCx)
Function description
Get RTC_TAMP3 detection flag.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
DocID026525 Rev 6
1003/1320
LL RTC Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
ISR TAMP3F LL_RTC_IsActiveFlag_TAMP3
LL_RTC_IsActiveFlag_TAMP2
Function name
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_TAMP2
(RTC_TypeDef * RTCx)
Function description
Get RTC_TAMP2 detection flag.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TAMP2F LL_RTC_IsActiveFlag_TAMP2
LL_RTC_IsActiveFlag_TAMP1
Function name
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_TAMP1
(RTC_TypeDef * RTCx)
Function description
Get RTC_TAMP1 detection flag.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TAMP1F LL_RTC_IsActiveFlag_TAMP1
LL_RTC_IsActiveFlag_TSOV
1004/1320
Function name
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_TSOV
(RTC_TypeDef * RTCx)
Function description
Get Time-stamp overflow flag.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TSOVF LL_RTC_IsActiveFlag_TSOV
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
LL_RTC_IsActiveFlag_TS
Function name
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_TS
(RTC_TypeDef * RTCx)
Function description
Get Time-stamp flag.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TSF LL_RTC_IsActiveFlag_TS
LL_RTC_IsActiveFlag_WUT
Function name
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_WUT
(RTC_TypeDef * RTCx)
Function description
Get Wakeup timer flag.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR WUTF LL_RTC_IsActiveFlag_WUT
LL_RTC_IsActiveFlag_ALRA
Function name
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_ALRA
(RTC_TypeDef * RTCx)
Function description
Get Alarm A flag.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR ALRAF LL_RTC_IsActiveFlag_ALRA
LL_RTC_ClearFlag_TAMP3
Function name
__STATIC_INLINE void LL_RTC_ClearFlag_TAMP3
(RTC_TypeDef * RTCx)
Function description
Clear RTC_TAMP3 detection flag.
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
ISR TAMP3F LL_RTC_ClearFlag_TAMP3
DocID026525 Rev 6
1005/1320
LL RTC Generic Driver
UM1785
LL_RTC_ClearFlag_TAMP2
Function name
__STATIC_INLINE void LL_RTC_ClearFlag_TAMP2
(RTC_TypeDef * RTCx)
Function description
Clear RTC_TAMP2 detection flag.
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
ISR TAMP2F LL_RTC_ClearFlag_TAMP2
LL_RTC_ClearFlag_TAMP1
Function name
__STATIC_INLINE void LL_RTC_ClearFlag_TAMP1
(RTC_TypeDef * RTCx)
Function description
Clear RTC_TAMP1 detection flag.
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
ISR TAMP1F LL_RTC_ClearFlag_TAMP1
LL_RTC_ClearFlag_TSOV
Function name
__STATIC_INLINE void LL_RTC_ClearFlag_TSOV
(RTC_TypeDef * RTCx)
Function description
Clear Time-stamp overflow flag.
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
ISR TSOVF LL_RTC_ClearFlag_TSOV
LL_RTC_ClearFlag_TS
1006/1320
Function name
__STATIC_INLINE void LL_RTC_ClearFlag_TS (RTC_TypeDef
* RTCx)
Function description
Clear Time-stamp flag.
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
ISR TSF LL_RTC_ClearFlag_TS
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
LL_RTC_ClearFlag_WUT
Function name
__STATIC_INLINE void LL_RTC_ClearFlag_WUT
(RTC_TypeDef * RTCx)
Function description
Clear Wakeup timer flag.
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
ISR WUTF LL_RTC_ClearFlag_WUT
LL_RTC_ClearFlag_ALRA
Function name
__STATIC_INLINE void LL_RTC_ClearFlag_ALRA
(RTC_TypeDef * RTCx)
Function description
Clear Alarm A flag.
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
ISR ALRAF LL_RTC_ClearFlag_ALRA
LL_RTC_IsActiveFlag_INIT
Function name
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_INIT
(RTC_TypeDef * RTCx)
Function description
Get Initialization flag.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR INITF LL_RTC_IsActiveFlag_INIT
LL_RTC_IsActiveFlag_RS
Function name
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_RS
(RTC_TypeDef * RTCx)
Function description
Get Registers synchronization flag.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR RSF LL_RTC_IsActiveFlag_RS
DocID026525 Rev 6
1007/1320
LL RTC Generic Driver
UM1785
LL_RTC_ClearFlag_RS
Function name
__STATIC_INLINE void LL_RTC_ClearFlag_RS (RTC_TypeDef
* RTCx)
Function description
Clear Registers synchronization flag.
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
ISR RSF LL_RTC_ClearFlag_RS
LL_RTC_IsActiveFlag_INITS
Function name
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_INITS
(RTC_TypeDef * RTCx)
Function description
Get Initialization status flag.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR INITS LL_RTC_IsActiveFlag_INITS
LL_RTC_IsActiveFlag_SHP
Function name
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_SHP
(RTC_TypeDef * RTCx)
Function description
Get Shift operation pending flag.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR SHPF LL_RTC_IsActiveFlag_SHP
LL_RTC_IsActiveFlag_WUTW
1008/1320
Function name
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_WUTW
(RTC_TypeDef * RTCx)
Function description
Get Wakeup timer write flag.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR WUTWF LL_RTC_IsActiveFlag_WUTW
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
LL_RTC_IsActiveFlag_ALRAW
Function name
__STATIC_INLINE uint32_t LL_RTC_IsActiveFlag_ALRAW
(RTC_TypeDef * RTCx)
Function description
Get Alarm A write flag.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR ALRAWF LL_RTC_IsActiveFlag_ALRAW
LL_RTC_EnableIT_TS
Function name
__STATIC_INLINE void LL_RTC_EnableIT_TS (RTC_TypeDef *
RTCx)
Function description
Enable Time-stamp interrupt.
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Reference Manual to
LL API cross
reference:
CR TSIE LL_RTC_EnableIT_TS
LL_RTC_DisableIT_TS
Function name
__STATIC_INLINE void LL_RTC_DisableIT_TS (RTC_TypeDef
* RTCx)
Function description
Disable Time-stamp interrupt.
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Reference Manual to
LL API cross
reference:
CR TSIE LL_RTC_DisableIT_TS
LL_RTC_EnableIT_WUT
Function name
__STATIC_INLINE void LL_RTC_EnableIT_WUT
(RTC_TypeDef * RTCx)
Function description
Enable Wakeup timer interrupt.
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
DocID026525 Rev 6
1009/1320
LL RTC Generic Driver
UM1785
function should be called before.
Reference Manual to
LL API cross
reference:
CR WUTIE LL_RTC_EnableIT_WUT
LL_RTC_DisableIT_WUT
Function name
__STATIC_INLINE void LL_RTC_DisableIT_WUT
(RTC_TypeDef * RTCx)
Function description
Disable Wakeup timer interrupt.
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Reference Manual to
LL API cross
reference:
CR WUTIE LL_RTC_DisableIT_WUT
LL_RTC_EnableIT_ALRA
Function name
__STATIC_INLINE void LL_RTC_EnableIT_ALRA
(RTC_TypeDef * RTCx)
Function description
Enable Alarm A interrupt.
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Reference Manual to
LL API cross
reference:
CR ALRAIE LL_RTC_EnableIT_ALRA
LL_RTC_DisableIT_ALRA
1010/1320
Function name
__STATIC_INLINE void LL_RTC_DisableIT_ALRA
(RTC_TypeDef * RTCx)
Function description
Disable Alarm A interrupt.
Parameters
RTCx: RTC Instance
Return values
None
Notes
Bit is write-protected. LL_RTC_DisableWriteProtection
function should be called before.
Reference Manual to
LL API cross
reference:
CR ALRAIE LL_RTC_DisableIT_ALRA
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
LL_RTC_EnableIT_TAMP
Function name
__STATIC_INLINE void LL_RTC_EnableIT_TAMP
(RTC_TypeDef * RTCx)
Function description
Enable all Tamper Interrupt.
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
TAFCR TAMPIE LL_RTC_EnableIT_TAMP
LL_RTC_DisableIT_TAMP
Function name
__STATIC_INLINE void LL_RTC_DisableIT_TAMP
(RTC_TypeDef * RTCx)
Function description
Disable all Tamper Interrupt.
Parameters
RTCx: RTC Instance
Return values
None
Reference Manual to
LL API cross
reference:
TAFCR TAMPIE LL_RTC_DisableIT_TAMP
LL_RTC_IsEnabledIT_TS
Function name
__STATIC_INLINE uint32_t LL_RTC_IsEnabledIT_TS
(RTC_TypeDef * RTCx)
Function description
Check if Time-stamp interrupt is enabled or not.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR TSIE LL_RTC_IsEnabledIT_TS
LL_RTC_IsEnabledIT_WUT
Function name
__STATIC_INLINE uint32_t LL_RTC_IsEnabledIT_WUT
(RTC_TypeDef * RTCx)
Function description
Check if Wakeup timer interrupt is enabled or not.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR WUTIE LL_RTC_IsEnabledIT_WUT
DocID026525 Rev 6
1011/1320
LL RTC Generic Driver
UM1785
LL_RTC_IsEnabledIT_ALRA
Function name
__STATIC_INLINE uint32_t LL_RTC_IsEnabledIT_ALRA
(RTC_TypeDef * RTCx)
Function description
Check if Alarm A interrupt is enabled or not.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR ALRAIE LL_RTC_IsEnabledIT_ALRA
LL_RTC_IsEnabledIT_TAMP
Function name
__STATIC_INLINE uint32_t LL_RTC_IsEnabledIT_TAMP
(RTC_TypeDef * RTCx)
Function description
Check if all the TAMPER interrupts are enabled or not.
Parameters
RTCx: RTC Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
TAFCR TAMPIE LL_RTC_IsEnabledIT_TAMP
LL_RTC_DeInit
Function name
ErrorStatus LL_RTC_DeInit (RTC_TypeDef * RTCx)
Function description
De-Initializes the RTC registers to their default reset values.
Parameters
RTCx: RTC Instance
Return values
An: ErrorStatus enumeration value:
SUCCESS: RTC registers are de-initialized
ERROR: RTC registers are not de-initialized
Notes
This function doesn't reset the RTC Clock source and RTC
Backup Data registers.
LL_RTC_Init
1012/1320
Function name
ErrorStatus LL_RTC_Init (RTC_TypeDef * RTCx,
LL_RTC_InitTypeDef * RTC_InitStruct)
Function description
Initializes the RTC registers according to the specified parameters
in RTC_InitStruct.
Parameters
RTCx: RTC Instance
RTC_InitStruct: pointer to a LL_RTC_InitTypeDef structure
that contains the configuration information for the RTC
peripheral.
Return values
An: ErrorStatus enumeration value:
SUCCESS: RTC registers are initialized
ERROR: RTC registers are not initialized
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
Notes
The RTC Prescaler register is write protected and can be
written in initialization mode only.
LL_RTC_StructInit
Function name
void LL_RTC_StructInit (LL_RTC_InitTypeDef *
RTC_InitStruct)
Function description
Set each LL_RTC_InitTypeDef field to default value.
Parameters
RTC_InitStruct: pointer to a LL_RTC_InitTypeDef structure
which will be initialized.
Return values
None
LL_RTC_TIME_Init
Function name
ErrorStatus LL_RTC_TIME_Init (RTC_TypeDef * RTCx,
uint32_t RTC_Format, LL_RTC_TimeTypeDef *
RTC_TimeStruct)
Function description
Set the RTC current time.
Parameters
RTCx: RTC Instance
RTC_Format: This parameter can be one of the following
values:
LL_RTC_FORMAT_BIN
LL_RTC_FORMAT_BCD
RTC_TimeStruct: pointer to a RTC_TimeTypeDef structure
that contains the time configuration information for the RTC.
Return values
An: ErrorStatus enumeration value:
SUCCESS: RTC Time register is configured
ERROR: RTC Time register is not configured
LL_RTC_TIME_StructInit
Function name
void LL_RTC_TIME_StructInit (LL_RTC_TimeTypeDef *
RTC_TimeStruct)
Function description
Set each LL_RTC_TimeTypeDef field to default value (Time =
00h:00min:00sec).
Parameters
RTC_TimeStruct: pointer to a LL_RTC_TimeTypeDef
structure which will be initialized.
Return values
None
LL_RTC_DATE_Init
Function name
ErrorStatus LL_RTC_DATE_Init (RTC_TypeDef * RTCx,
uint32_t RTC_Format, LL_RTC_DateTypeDef *
RTC_DateStruct)
Function description
Set the RTC current date.
Parameters
RTCx: RTC Instance
RTC_Format: This parameter can be one of the following
values:
DocID026525 Rev 6
1013/1320
LL RTC Generic Driver
UM1785
LL_RTC_FORMAT_BIN
LL_RTC_FORMAT_BCD
RTC_DateStruct: pointer to a RTC_DateTypeDef structure
that contains the date configuration information for the RTC.
Return values
An: ErrorStatus enumeration value:
SUCCESS: RTC Day register is configured
ERROR: RTC Day register is not configured
LL_RTC_DATE_StructInit
Function name
void LL_RTC_DATE_StructInit (LL_RTC_DateTypeDef *
RTC_DateStruct)
Function description
Set each LL_RTC_DateTypeDef field to default value (date =
Monday, January 01 xx00)
Parameters
RTC_DateStruct: pointer to a LL_RTC_DateTypeDef
structure which will be initialized.
Return values
None
LL_RTC_ALMA_Init
Function name
ErrorStatus LL_RTC_ALMA_Init (RTC_TypeDef * RTCx,
uint32_t RTC_Format, LL_RTC_AlarmTypeDef *
RTC_AlarmStruct)
Function description
Set the RTC Alarm A.
Parameters
RTCx: RTC Instance
RTC_Format: This parameter can be one of the following
values:
LL_RTC_FORMAT_BIN
LL_RTC_FORMAT_BCD
RTC_AlarmStruct: pointer to a LL_RTC_AlarmTypeDef
structure that contains the alarm configuration parameters.
Return values
An: ErrorStatus enumeration value:
SUCCESS: ALARMA registers are configured
ERROR: ALARMA registers are not configured
Notes
The Alarm register can only be written when the
corresponding Alarm is disabled (Use
LL_RTC_ALMA_Disable function).
LL_RTC_ALMA_StructInit
1014/1320
Function name
void LL_RTC_ALMA_StructInit (LL_RTC_AlarmTypeDef *
RTC_AlarmStruct)
Function description
Set each LL_RTC_AlarmTypeDef of ALARMA field to default value
(Time = 00h:00mn:00sec / Day = 1st day of the month/Mask = all
fields are masked).
Parameters
RTC_AlarmStruct: pointer to a LL_RTC_AlarmTypeDef
structure which will be initialized.
Return values
None
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
LL_RTC_EnterInitMode
Function name
ErrorStatus LL_RTC_EnterInitMode (RTC_TypeDef * RTCx)
Function description
Enters the RTC Initialization mode.
Parameters
RTCx: RTC Instance
Return values
An: ErrorStatus enumeration value:
SUCCESS: RTC is in Init mode
ERROR: RTC is not in Init mode
Notes
The RTC Initialization mode is write protected, use the
LL_RTC_DisableWriteProtection before calling this function.
LL_RTC_ExitInitMode
Function name
ErrorStatus LL_RTC_ExitInitMode (RTC_TypeDef * RTCx)
Function description
Exit the RTC Initialization mode.
Parameters
RTCx: RTC Instance
Return values
An: ErrorStatus enumeration value:
SUCCESS: RTC exited from in Init mode
ERROR: Not applicable
Notes
When the initialization sequence is complete, the calendar
restarts counting after 4 RTCCLK cycles.
The RTC Initialization mode is write protected, use the
LL_RTC_DisableWriteProtection before calling this function.
LL_RTC_WaitForSynchro
Function name
ErrorStatus LL_RTC_WaitForSynchro (RTC_TypeDef * RTCx)
Function description
Waits until the RTC Time and Day registers (RTC_TR and
RTC_DR) are synchronized with RTC APB clock.
Parameters
RTCx: RTC Instance
Return values
An: ErrorStatus enumeration value:
SUCCESS: RTC registers are synchronised
ERROR: RTC registers are not synchronised
Notes
The RTC Resynchronization mode is write protected, use the
LL_RTC_DisableWriteProtection before calling this function.
To read the calendar through the shadow registers after
Calendar initialization, calendar update or after wakeup from
low power modes the software must first clear the RSF flag.
The software must then wait until it is set again before reading
the calendar, which means that the calendar registers have
been correctly copied into the RTC_TR and RTC_DR shadow
registers.
DocID026525 Rev 6
1015/1320
LL RTC Generic Driver
UM1785
64.3
RTC Firmware driver defines
64.3.1
RTC
ALARM OUTPUT
LL_RTC_ALARMOUT_DISABLE
Output disabled
LL_RTC_ALARMOUT_ALMA
Alarm A output enabled
LL_RTC_ALARMOUT_ALMB
Alarm B output enabled
LL_RTC_ALARMOUT_WAKEUP
Wakeup output enabled
ALARM OUTPUT TYPE
LL_RTC_ALARM_OUTPUTTYPE_OPENDRAIN
RTC_ALARM, when mapped on PC13,
is open-drain output
LL_RTC_ALARM_OUTPUTTYPE_PUSHPULL
RTC_ALARM, when mapped on PC13,
is push-pull output
ALARMA MASK
LL_RTC_ALMA_MASK_NONE
No masks applied on Alarm A
LL_RTC_ALMA_MASK_DATEWEEKDAY
Date/day do not care in Alarm A comparison
LL_RTC_ALMA_MASK_HOURS
Hours do not care in Alarm A comparison
LL_RTC_ALMA_MASK_MINUTES
Minutes do not care in Alarm A comparison
LL_RTC_ALMA_MASK_SECONDS
Seconds do not care in Alarm A comparison
LL_RTC_ALMA_MASK_ALL
Masks all
ALARMA TIME FORMAT
LL_RTC_ALMA_TIME_FORMAT_AM
AM or 24-hour format
LL_RTC_ALMA_TIME_FORMAT_PM
PM
RTC Alarm A Date WeekDay
LL_RTC_ALMA_DATEWEEKDAYSEL_DATE
Alarm A Date is selected
LL_RTC_ALMA_DATEWEEKDAYSEL_WEEKDAY
Alarm A WeekDay is selected
BACKUP
LL_RTC_BKP_DR0
LL_RTC_BKP_DR1
LL_RTC_BKP_DR2
LL_RTC_BKP_DR3
LL_RTC_BKP_DR4
Calibration pulse insertion
1016/1320
LL_RTC_CALIB_INSERTPULSE_NONE
No RTCCLK pulses are added
LL_RTC_CALIB_INSERTPULSE_SET
One RTCCLK pulse is effectively inserted every
2exp11 pulses (frequency increased by 488.5
ppm)
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
Calibration output
LL_RTC_CALIB_OUTPUT_NONE
Calibration output disabled
LL_RTC_CALIB_OUTPUT_1HZ
Calibration output is 1 Hz
LL_RTC_CALIB_OUTPUT_512HZ
Calibration output is 512 Hz
Calibration period
LL_RTC_CALIB_PERIOD_32SEC
Use a 32-second calibration cycle period
LL_RTC_CALIB_PERIOD_16SEC
Use a 16-second calibration cycle period
LL_RTC_CALIB_PERIOD_8SEC
Use a 8-second calibration cycle period
FORMAT
LL_RTC_FORMAT_BIN
Binary data format
LL_RTC_FORMAT_BCD
BCD data format
Get Flags Defines
LL_RTC_ISR_RECALPF
LL_RTC_ISR_TAMP3F
LL_RTC_ISR_TAMP2F
LL_RTC_ISR_TAMP1F
LL_RTC_ISR_TSOVF
LL_RTC_ISR_TSF
LL_RTC_ISR_WUTF
LL_RTC_ISR_ALRAF
LL_RTC_ISR_INITF
LL_RTC_ISR_RSF
LL_RTC_ISR_INITS
LL_RTC_ISR_SHPF
LL_RTC_ISR_WUTWF
LL_RTC_ISR_ALRAWF
HOUR FORMAT
LL_RTC_HOURFORMAT_24HOUR
24 hour/day format
LL_RTC_HOURFORMAT_AMPM
AM/PM hour format
IT Defines
LL_RTC_CR_TSIE
LL_RTC_CR_WUTIE
LL_RTC_CR_ALRAIE
LL_RTC_TAFCR_TAMPIE
MONTH
LL_RTC_MONTH_JANUARY
January
DocID026525 Rev 6
1017/1320
LL RTC Generic Driver
LL_RTC_MONTH_FEBRUARY
UM1785
February
LL_RTC_MONTH_MARCH
March
LL_RTC_MONTH_APRIL
April
LL_RTC_MONTH_MAY
May
LL_RTC_MONTH_JUNE
June
LL_RTC_MONTH_JULY
July
LL_RTC_MONTH_AUGUST
August
LL_RTC_MONTH_SEPTEMBER
September
LL_RTC_MONTH_OCTOBER
October
LL_RTC_MONTH_NOVEMBER
November
LL_RTC_MONTH_DECEMBER
December
OUTPUT POLARITY PIN
LL_RTC_OUTPUTPOLARITY_PIN_HIGH
Pin is high when ALRAF/ALRBF/WUTF is
asserted (depending on OSEL)
LL_RTC_OUTPUTPOLARITY_PIN_LOW
Pin is low when ALRAF/ALRBF/WUTF is
asserted (depending on OSEL)
PIN
LL_RTC_PIN_PC13
PC13 is forced to push-pull output if all RTC alternate functions
are disabled
LL_RTC_PIN_PC14
PC14 is forced to push-pull output if LSE is disabled
LL_RTC_PIN_PC15
PC15 is forced to push-pull output if LSE is disabled
SHIFT SECOND
LL_RTC_SHIFT_SECOND_DELAY
LL_RTC_SHIFT_SECOND_ADVANCE
TAMPER
LL_RTC_TAMPER_1
RTC_TAMP1 input detection
LL_RTC_TAMPER_2
RTC_TAMP2 input detection
LL_RTC_TAMPER_3
RTC_TAMP3 input detection
TAMPER ACTIVE LEVEL
1018/1320
LL_RTC_TAMPER_ACTIVELEVEL_TAMP1
RTC_TAMP1 input falling edge (if
TAMPFLT = 00) or staying high (if
TAMPFLT != 00) triggers a tamper detection
event
LL_RTC_TAMPER_ACTIVELEVEL_TAMP2
RTC_TAMP2 input falling edge (if
TAMPFLT = 00) or staying high (if
TAMPFLT != 00) triggers a tamper detection
event
LL_RTC_TAMPER_ACTIVELEVEL_TAMP3
RTC_TAMP3 input falling edge (if
TAMPFLT = 00) or staying high (if
TAMPFLT != 00) triggers a tamper detection
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
event
TAMPER DURATION
LL_RTC_TAMPER_DURATION_1RTCCLK
Tamper pins are pre-charged before
sampling during 1 RTCCLK cycle
LL_RTC_TAMPER_DURATION_2RTCCLK
Tamper pins are pre-charged before
sampling during 2 RTCCLK cycles
LL_RTC_TAMPER_DURATION_4RTCCLK
Tamper pins are pre-charged before
sampling during 4 RTCCLK cycles
LL_RTC_TAMPER_DURATION_8RTCCLK
Tamper pins are pre-charged before
sampling during 8 RTCCLK cycles
TAMPER FILTER
LL_RTC_TAMPER_FILTER_DISABLE
Tamper filter is disabled
LL_RTC_TAMPER_FILTER_2SAMPLE
Tamper is activated after 2 consecutive samples
at the active level
LL_RTC_TAMPER_FILTER_4SAMPLE
Tamper is activated after 4 consecutive samples
at the active level
LL_RTC_TAMPER_FILTER_8SAMPLE
Tamper is activated after 8 consecutive samples
at the active level.
TAMPER MASK
LL_RTC_TAMPER_MASK_TAMPER1
Tamper 1 event generates a trigger event.
TAMP1F is masked and internally cleared by
hardware.The backup registers are not erased
LL_RTC_TAMPER_MASK_TAMPER2
Tamper 2 event generates a trigger event.
TAMP2F is masked and internally cleared by
hardware. The backup registers are not erased.
LL_RTC_TAMPER_MASK_TAMPER3
Tamper 3 event generates a trigger event.
TAMP3F is masked and internally cleared by
hardware. The backup registers are not erased
TAMPER NO ERASE
LL_RTC_TAMPER_NOERASE_TAMPER1
Tamper 1 event does not erase the backup
registers.
LL_RTC_TAMPER_NOERASE_TAMPER2
Tamper 2 event does not erase the backup
registers.
LL_RTC_TAMPER_NOERASE_TAMPER3
Tamper 3 event does not erase the backup
registers.
TAMPER SAMPLING FREQUENCY DIVIDER
LL_RTC_TAMPER_SAMPLFREQDIV_32768
Each of the tamper inputs are sampled
with a frequency = RTCCLK / 32768
LL_RTC_TAMPER_SAMPLFREQDIV_16384
Each of the tamper inputs are sampled
with a frequency = RTCCLK / 16384
LL_RTC_TAMPER_SAMPLFREQDIV_8192
Each of the tamper inputs are sampled
with a frequency = RTCCLK / 8192
LL_RTC_TAMPER_SAMPLFREQDIV_4096
Each of the tamper inputs are sampled
DocID026525 Rev 6
1019/1320
LL RTC Generic Driver
UM1785
with a frequency = RTCCLK / 4096
LL_RTC_TAMPER_SAMPLFREQDIV_2048
Each of the tamper inputs are sampled
with a frequency = RTCCLK / 2048
LL_RTC_TAMPER_SAMPLFREQDIV_1024
Each of the tamper inputs are sampled
with a frequency = RTCCLK / 1024
LL_RTC_TAMPER_SAMPLFREQDIV_512
Each of the tamper inputs are sampled
with a frequency = RTCCLK / 512
LL_RTC_TAMPER_SAMPLFREQDIV_256
Each of the tamper inputs are sampled
with a frequency = RTCCLK / 256
TIMESTAMP EDGE
LL_RTC_TIMESTAMP_EDGE_RISING
RTC_TS input rising edge generates a timestamp event
LL_RTC_TIMESTAMP_EDGE_FALLING
RTC_TS input falling edge generates a timestamp even
TIME FORMAT
LL_RTC_TIME_FORMAT_AM_OR_24
AM or 24-hour format
LL_RTC_TIME_FORMAT_PM
PM
TIMESTAMP TIME FORMAT
LL_RTC_TS_TIME_FORMAT_AM
AM or 24-hour format
LL_RTC_TS_TIME_FORMAT_PM
PM
WAKEUP CLOCK DIV
LL_RTC_WAKEUPCLOCK_DIV_16
RTC/16 clock is selected
LL_RTC_WAKEUPCLOCK_DIV_8
RTC/8 clock is selected
LL_RTC_WAKEUPCLOCK_DIV_4
RTC/4 clock is selected
LL_RTC_WAKEUPCLOCK_DIV_2
RTC/2 clock is selected
LL_RTC_WAKEUPCLOCK_CKSPRE
ck_spre (usually 1 Hz) clock is selected
LL_RTC_WAKEUPCLOCK_CKSPRE_WUT
ck_spre (usually 1 Hz) clock is selected and
2exp16 is added to the WUT counter value
WEEK DAY
1020/1320
LL_RTC_WEEKDAY_MONDAY
Monday
LL_RTC_WEEKDAY_TUESDAY
Tuesday
LL_RTC_WEEKDAY_WEDNESDAY
Wednesday
LL_RTC_WEEKDAY_THURSDAY
Thrusday
LL_RTC_WEEKDAY_FRIDAY
Friday
LL_RTC_WEEKDAY_SATURDAY
Saturday
LL_RTC_WEEKDAY_SUNDAY
Sunday
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
Convert helper Macros
__LL_RTC_CONVERT_BIN2BCD
Description:
Helper macro to convert a value from 2 digit
decimal format to BCD format.
Parameters:
__VALUE__: Byte to be converted
Return value:
Converted: byte
__LL_RTC_CONVERT_BCD2BIN
Description:
Helper macro to convert a value from BCD format
to 2 digit decimal format.
Parameters:
__VALUE__: BCD value to be converted
Return value:
Converted: byte
Date helper Macros
__LL_RTC_GET_WEEKDAY
Description:
Helper macro to retrieve weekday.
Parameters:
__RTC_DATE__: Date returned by
Return value:
Returned: value can be one of the following values:
LL_RTC_WEEKDAY_MONDAY
LL_RTC_WEEKDAY_TUESDAY
LL_RTC_WEEKDAY_WEDNESDAY
LL_RTC_WEEKDAY_THURSDAY
LL_RTC_WEEKDAY_FRIDAY
LL_RTC_WEEKDAY_SATURDAY
LL_RTC_WEEKDAY_SUNDAY
__LL_RTC_GET_YEAR
Description:
Helper macro to retrieve Year in BCD format.
Parameters:
__RTC_DATE__: Value returned by
Return value:
Year: in BCD format (0x00 . . . 0x99)
__LL_RTC_GET_MONTH
Description:
Helper macro to retrieve Month in BCD format.
Parameters:
__RTC_DATE__: Value returned by
DocID026525 Rev 6
1021/1320
LL RTC Generic Driver
UM1785
Return value:
Returned: value can be one of the following values:
LL_RTC_MONTH_JANUARY
LL_RTC_MONTH_FEBRUARY
LL_RTC_MONTH_MARCH
LL_RTC_MONTH_APRIL
LL_RTC_MONTH_MAY
LL_RTC_MONTH_JUNE
LL_RTC_MONTH_JULY
LL_RTC_MONTH_AUGUST
LL_RTC_MONTH_SEPTEMBER
LL_RTC_MONTH_OCTOBER
LL_RTC_MONTH_NOVEMBER
LL_RTC_MONTH_DECEMBER
__LL_RTC_GET_DAY
Description:
Helper macro to retrieve Day in BCD format.
Parameters:
__RTC_DATE__: Value returned by
Return value:
Day: in BCD format (0x01 . . . 0x31)
Time helper Macros
__LL_RTC_GET_HOUR
Description:
Helper macro to retrieve hour in BCD format.
Parameters:
__RTC_TIME__: RTC time returned by
Return value:
Hours: in BCD format (0x01. . .0x12 or between
Min_Data=0x00 and Max_Data=0x23)
__LL_RTC_GET_MINUTE
Description:
Helper macro to retrieve minute in BCD format.
Parameters:
__RTC_TIME__: RTC time returned by
Return value:
Minutes: in BCD format (0x00. . .0x59)
__LL_RTC_GET_SECOND
Description:
Helper macro to retrieve second in BCD format.
Parameters:
__RTC_TIME__: RTC time returned by
Return value:
Seconds: in format (0x00. . .0x59)
1022/1320
DocID026525 Rev 6
UM1785
LL RTC Generic Driver
Common Write and read registers Macros
LL_RTC_WriteReg
Description:
Write a value in RTC register.
Parameters:
__INSTANCE__: RTC Instance
__REG__: Register to be written
__VALUE__: Value to be written in the register
Return value:
None
LL_RTC_ReadReg
Description:
Read a value in RTC register.
Parameters:
__INSTANCE__: RTC Instance
__REG__: Register to be read
Return value:
Register: value
DocID026525 Rev 6
1023/1320
LL SPI Generic Driver
UM1785
65
LL SPI Generic Driver
65.1
SPI Firmware driver registers structures
65.1.1
LL_SPI_InitTypeDef
Data Fields
uint32_t TransferDirection
uint32_t Mode
uint32_t DataWidth
uint32_t ClockPolarity
uint32_t ClockPhase
uint32_t NSS
uint32_t BaudRate
uint32_t BitOrder
uint32_t CRCCalculation
uint32_t CRCPoly
Field Documentation
uint32_t LL_SPI_InitTypeDef::TransferDirection
Specifies the SPI unidirectional or bidirectional data mode. This parameter can be a
value of SPI_LL_EC_TRANSFER_MODE.This feature can be modified afterwards
using unitary function LL_SPI_SetTransferDirection().
uint32_t LL_SPI_InitTypeDef::Mode
Specifies the SPI mode (Master/Slave). This parameter can be a value of
SPI_LL_EC_MODE.This feature can be modified afterwards using unitary function
LL_SPI_SetMode().
uint32_t LL_SPI_InitTypeDef::DataWidth
Specifies the SPI data width. This parameter can be a value of
SPI_LL_EC_DATAWIDTH.This feature can be modified afterwards using unitary
function LL_SPI_SetDataWidth().
uint32_t LL_SPI_InitTypeDef::ClockPolarity
Specifies the serial clock steady state. This parameter can be a value of
SPI_LL_EC_POLARITY.This feature can be modified afterwards using unitary
function LL_SPI_SetClockPolarity().
uint32_t LL_SPI_InitTypeDef::ClockPhase
Specifies the clock active edge for the bit capture. This parameter can be a value of
SPI_LL_EC_PHASE.This feature can be modified afterwards using unitary function
LL_SPI_SetClockPhase().
uint32_t LL_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_LL_EC_NSS_MODE.This
feature can be modified afterwards using unitary function LL_SPI_SetNSSMode().
uint32_t LL_SPI_InitTypeDef::BaudRate
Specifies the BaudRate prescaler value which will be used to configure the transmit
and receive SCK clock. This parameter can be a value of
SPI_LL_EC_BAUDRATEPRESCALER.
Note:The communication clock is derived from the master clock. The slave clock does
not need to be set. This feature can be modified afterwards using unitary function
LL_SPI_SetBaudRatePrescaler().
1024/1320
DocID026525 Rev 6
UM1785
LL SPI Generic Driver
uint32_t LL_SPI_InitTypeDef::BitOrder
Specifies whether data transfers start from MSB or LSB bit. This parameter can be a
value of SPI_LL_EC_BIT_ORDER.This feature can be modified afterwards using
unitary function LL_SPI_SetTransferBitOrder().
uint32_t LL_SPI_InitTypeDef::CRCCalculation
Specifies if the CRC calculation is enabled or not. This parameter can be a value of
SPI_LL_EC_CRC_CALCULATION.This feature can be modified afterwards using
unitary functions LL_SPI_EnableCRC() and LL_SPI_DisableCRC().
uint32_t LL_SPI_InitTypeDef::CRCPoly
Specifies the polynomial used for the CRC calculation. This parameter must be a
number between Min_Data = 0x00 and Max_Data = 0xFFFF.This feature can be
modified afterwards using unitary function LL_SPI_SetCRCPolynomial().
65.2
SPI Firmware driver API description
65.2.1
Detailed description of functions
LL_SPI_Enable
Function name
__STATIC_INLINE void LL_SPI_Enable (SPI_TypeDef * SPIx)
Function description
Enable SPI peripheral.
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 SPE LL_SPI_Enable
LL_SPI_Disable
Function name
__STATIC_INLINE void LL_SPI_Disable (SPI_TypeDef * SPIx)
Function description
Disable SPI peripheral.
Parameters
SPIx: SPI Instance
Return values
None
Notes
When disabling the SPI, follow the procedure described in the
Reference Manual.
Reference Manual to
LL API cross
reference:
CR1 SPE LL_SPI_Disable
DocID026525 Rev 6
1025/1320
LL SPI Generic Driver
UM1785
LL_SPI_IsEnabled
Function name
__STATIC_INLINE uint32_t LL_SPI_IsEnabled (SPI_TypeDef *
SPIx)
Function description
Check if SPI peripheral is enabled.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 SPE LL_SPI_IsEnabled
LL_SPI_SetMode
Function name
__STATIC_INLINE void LL_SPI_SetMode (SPI_TypeDef * SPIx,
uint32_t Mode)
Function description
Set SPI operation mode to Master or Slave.
Parameters
SPIx: SPI Instance
Mode: This parameter can be one of the following values:
LL_SPI_MODE_MASTER
LL_SPI_MODE_SLAVE
Return values
None
Notes
This bit should not be changed when communication is
ongoing.
Reference Manual to
LL API cross
reference:
CR1 MSTR LL_SPI_SetMode
CR1 SSI LL_SPI_SetMode
LL_SPI_GetMode
Function name
__STATIC_INLINE uint32_t LL_SPI_GetMode (SPI_TypeDef *
SPIx)
Function description
Get SPI operation mode (Master or Slave)
Parameters
SPIx: SPI Instance
Return values
Returned: value can be one of the following values:
LL_SPI_MODE_MASTER
LL_SPI_MODE_SLAVE
Reference Manual to
LL API cross
reference:
CR1 MSTR LL_SPI_GetMode
CR1 SSI LL_SPI_GetMode
LL_SPI_SetStandard
Function name
__STATIC_INLINE void LL_SPI_SetStandard (SPI_TypeDef *
SPIx, uint32_t Standard)
Function description
Set serial protocol used.
Parameters
1026/1320
SPIx: SPI Instance
Standard: This parameter can be one of the following
DocID026525 Rev 6
UM1785
LL SPI Generic Driver
values:
LL_SPI_PROTOCOL_MOTOROLA
LL_SPI_PROTOCOL_TI
Return values
None
Notes
This bit should be written only when SPI is disabled (SPE = 0)
for correct operation.
Reference Manual to
LL API cross
reference:
CR2 FRF LL_SPI_SetStandard
LL_SPI_GetStandard
Function name
__STATIC_INLINE uint32_t LL_SPI_GetStandard (SPI_TypeDef
* SPIx)
Function description
Get serial protocol used.
Parameters
SPIx: SPI Instance
Return values
Returned: value can be one of the following values:
LL_SPI_PROTOCOL_MOTOROLA
LL_SPI_PROTOCOL_TI
Reference Manual to
LL API cross
reference:
CR2 FRF LL_SPI_GetStandard
LL_SPI_SetClockPhase
Function name
__STATIC_INLINE void LL_SPI_SetClockPhase (SPI_TypeDef
* SPIx, uint32_t ClockPhase)
Function description
Set clock phase.
Parameters
SPIx: SPI Instance
ClockPhase: This parameter can be one of the following
values:
LL_SPI_PHASE_1EDGE
LL_SPI_PHASE_2EDGE
Return values
None
Notes
This bit should not be changed when communication is
ongoing. This bit is not used in SPI TI mode.
Reference Manual to
LL API cross
reference:
CR1 CPHA LL_SPI_SetClockPhase
LL_SPI_GetClockPhase
Function name
__STATIC_INLINE uint32_t LL_SPI_GetClockPhase
(SPI_TypeDef * SPIx)
Function description
Get clock phase.
Parameters
SPIx: SPI Instance
DocID026525 Rev 6
1027/1320
LL SPI Generic Driver
Return values
Reference Manual to
LL API cross
reference:
UM1785
Returned: value can be one of the following values:
LL_SPI_PHASE_1EDGE
LL_SPI_PHASE_2EDGE
CR1 CPHA LL_SPI_GetClockPhase
LL_SPI_SetClockPolarity
Function name
__STATIC_INLINE void LL_SPI_SetClockPolarity
(SPI_TypeDef * SPIx, uint32_t ClockPolarity)
Function description
Set clock polarity.
Parameters
SPIx: SPI Instance
ClockPolarity: This parameter can be one of the following
values:
LL_SPI_POLARITY_LOW
LL_SPI_POLARITY_HIGH
Return values
None
Notes
This bit should not be changed when communication is
ongoing. This bit is not used in SPI TI mode.
Reference Manual to
LL API cross
reference:
CR1 CPOL LL_SPI_SetClockPolarity
LL_SPI_GetClockPolarity
Function name
__STATIC_INLINE uint32_t LL_SPI_GetClockPolarity
(SPI_TypeDef * SPIx)
Function description
Get clock polarity.
Parameters
SPIx: SPI Instance
Return values
Returned: value can be one of the following values:
LL_SPI_POLARITY_LOW
LL_SPI_POLARITY_HIGH
Reference Manual to
LL API cross
reference:
CR1 CPOL LL_SPI_GetClockPolarity
LL_SPI_SetBaudRatePrescaler
Function name
__STATIC_INLINE void LL_SPI_SetBaudRatePrescaler
(SPI_TypeDef * SPIx, uint32_t BaudRate)
Function description
Set baud rate prescaler.
Parameters
1028/1320
SPIx: SPI Instance
BaudRate: This parameter can be one of the following
values:
LL_SPI_BAUDRATEPRESCALER_DIV2
LL_SPI_BAUDRATEPRESCALER_DIV4
LL_SPI_BAUDRATEPRESCALER_DIV8
DocID026525 Rev 6
UM1785
LL SPI Generic Driver
LL_SPI_BAUDRATEPRESCALER_DIV16
LL_SPI_BAUDRATEPRESCALER_DIV32
LL_SPI_BAUDRATEPRESCALER_DIV64
LL_SPI_BAUDRATEPRESCALER_DIV128
LL_SPI_BAUDRATEPRESCALER_DIV256
Return values
None
Notes
These bits should not be changed when communication is
ongoing. SPI BaudRate = fPCLK/Prescaler.
Reference Manual to
LL API cross
reference:
CR1 BR LL_SPI_SetBaudRatePrescaler
LL_SPI_GetBaudRatePrescaler
Function name
__STATIC_INLINE uint32_t LL_SPI_GetBaudRatePrescaler
(SPI_TypeDef * SPIx)
Function description
Get baud rate prescaler.
Parameters
SPIx: SPI Instance
Return values
Returned: value can be one of the following values:
LL_SPI_BAUDRATEPRESCALER_DIV2
LL_SPI_BAUDRATEPRESCALER_DIV4
LL_SPI_BAUDRATEPRESCALER_DIV8
LL_SPI_BAUDRATEPRESCALER_DIV16
LL_SPI_BAUDRATEPRESCALER_DIV32
LL_SPI_BAUDRATEPRESCALER_DIV64
LL_SPI_BAUDRATEPRESCALER_DIV128
LL_SPI_BAUDRATEPRESCALER_DIV256
Reference Manual to
LL API cross
reference:
CR1 BR LL_SPI_GetBaudRatePrescaler
LL_SPI_SetTransferBitOrder
Function name
__STATIC_INLINE void LL_SPI_SetTransferBitOrder
(SPI_TypeDef * SPIx, uint32_t BitOrder)
Function description
Set transfer bit order.
Parameters
SPIx: SPI Instance
BitOrder: This parameter can be one of the following values:
LL_SPI_LSB_FIRST
LL_SPI_MSB_FIRST
Return values
None
Notes
This bit should not be changed when communication is
ongoing. This bit is not used in SPI TI mode.
Reference Manual to
LL API cross
reference:
CR1 LSBFIRST LL_SPI_SetTransferBitOrder
DocID026525 Rev 6
1029/1320
LL SPI Generic Driver
UM1785
LL_SPI_GetTransferBitOrder
Function name
__STATIC_INLINE uint32_t LL_SPI_GetTransferBitOrder
(SPI_TypeDef * SPIx)
Function description
Get transfer bit order.
Parameters
SPIx: SPI Instance
Return values
Returned: value can be one of the following values:
LL_SPI_LSB_FIRST
LL_SPI_MSB_FIRST
Reference Manual to
LL API cross
reference:
CR1 LSBFIRST LL_SPI_GetTransferBitOrder
LL_SPI_SetTransferDirection
Function name
__STATIC_INLINE void LL_SPI_SetTransferDirection
(SPI_TypeDef * SPIx, uint32_t TransferDirection)
Function description
Set transfer direction mode.
Parameters
SPIx: SPI Instance
TransferDirection: This parameter can be one of the
following values:
LL_SPI_FULL_DUPLEX
LL_SPI_SIMPLEX_RX
LL_SPI_HALF_DUPLEX_RX
LL_SPI_HALF_DUPLEX_TX
Return values
None
Notes
For Half-Duplex mode, Rx Direction is set by default. In
master mode, the MOSI pin is used and in slave mode, the
MISO pin is used for Half-Duplex.
Reference Manual to
LL API cross
reference:
CR1 RXONLY LL_SPI_SetTransferDirection
CR1 BIDIMODE LL_SPI_SetTransferDirection
CR1 BIDIOE LL_SPI_SetTransferDirection
LL_SPI_GetTransferDirection
1030/1320
Function name
__STATIC_INLINE uint32_t LL_SPI_GetTransferDirection
(SPI_TypeDef * SPIx)
Function description
Get transfer direction mode.
Parameters
SPIx: SPI Instance
Return values
Returned: value can be one of the following values:
LL_SPI_FULL_DUPLEX
LL_SPI_SIMPLEX_RX
LL_SPI_HALF_DUPLEX_RX
LL_SPI_HALF_DUPLEX_TX
Reference Manual to
LL API cross
reference:
CR1 RXONLY LL_SPI_GetTransferDirection
CR1 BIDIMODE LL_SPI_GetTransferDirection
CR1 BIDIOE LL_SPI_GetTransferDirection
DocID026525 Rev 6
UM1785
LL SPI Generic Driver
LL_SPI_SetDataWidth
Function name
__STATIC_INLINE void LL_SPI_SetDataWidth (SPI_TypeDef *
SPIx, uint32_t DataWidth)
Function description
Set frame data width.
Parameters
SPIx: SPI Instance
DataWidth: This parameter can be one of the following
values:
LL_SPI_DATAWIDTH_4BIT
LL_SPI_DATAWIDTH_5BIT
LL_SPI_DATAWIDTH_6BIT
LL_SPI_DATAWIDTH_7BIT
LL_SPI_DATAWIDTH_8BIT
LL_SPI_DATAWIDTH_9BIT
LL_SPI_DATAWIDTH_10BIT
LL_SPI_DATAWIDTH_11BIT
LL_SPI_DATAWIDTH_12BIT
LL_SPI_DATAWIDTH_13BIT
LL_SPI_DATAWIDTH_14BIT
LL_SPI_DATAWIDTH_15BIT
LL_SPI_DATAWIDTH_16BIT
Return values
None
Reference Manual to
LL API cross
reference:
CR2 DS LL_SPI_SetDataWidth
LL_SPI_GetDataWidth
Function name
__STATIC_INLINE uint32_t LL_SPI_GetDataWidth
(SPI_TypeDef * SPIx)
Function description
Get frame data width.
Parameters
SPIx: SPI Instance
Return values
Returned: value can be one of the following values:
LL_SPI_DATAWIDTH_4BIT
LL_SPI_DATAWIDTH_5BIT
LL_SPI_DATAWIDTH_6BIT
LL_SPI_DATAWIDTH_7BIT
LL_SPI_DATAWIDTH_8BIT
LL_SPI_DATAWIDTH_9BIT
LL_SPI_DATAWIDTH_10BIT
LL_SPI_DATAWIDTH_11BIT
LL_SPI_DATAWIDTH_12BIT
LL_SPI_DATAWIDTH_13BIT
LL_SPI_DATAWIDTH_14BIT
LL_SPI_DATAWIDTH_15BIT
LL_SPI_DATAWIDTH_16BIT
Reference Manual to
LL API cross
reference:
CR2 DS LL_SPI_GetDataWidth
DocID026525 Rev 6
1031/1320
LL SPI Generic Driver
UM1785
LL_SPI_SetRxFIFOThreshold
Function name
__STATIC_INLINE void LL_SPI_SetRxFIFOThreshold
(SPI_TypeDef * SPIx, uint32_t Threshold)
Function description
Set threshold of RXFIFO that triggers an RXNE event.
Parameters
SPIx: SPI Instance
Threshold: This parameter can be one of the following
values:
LL_SPI_RX_FIFO_TH_HALF
LL_SPI_RX_FIFO_TH_QUARTER
Return values
None
Reference Manual to
LL API cross
reference:
CR2 FRXTH LL_SPI_SetRxFIFOThreshold
LL_SPI_GetRxFIFOThreshold
Function name
__STATIC_INLINE uint32_t LL_SPI_GetRxFIFOThreshold
(SPI_TypeDef * SPIx)
Function description
Get threshold of RXFIFO that triggers an RXNE event.
Parameters
SPIx: SPI Instance
Return values
Returned: value can be one of the following values:
LL_SPI_RX_FIFO_TH_HALF
LL_SPI_RX_FIFO_TH_QUARTER
Reference Manual to
LL API cross
reference:
CR2 FRXTH LL_SPI_GetRxFIFOThreshold
LL_SPI_EnableCRC
Function name
__STATIC_INLINE void LL_SPI_EnableCRC (SPI_TypeDef *
SPIx)
Function description
Enable CRC.
Parameters
SPIx: SPI Instance
Return values
None
Notes
This bit should be written only when SPI is disabled (SPE = 0)
for correct operation.
Reference Manual to
LL API cross
reference:
CR1 CRCEN LL_SPI_EnableCRC
LL_SPI_DisableCRC
1032/1320
Function name
__STATIC_INLINE void LL_SPI_DisableCRC (SPI_TypeDef *
SPIx)
Function description
Disable CRC.
DocID026525 Rev 6
UM1785
LL SPI Generic Driver
Parameters
SPIx: SPI Instance
Return values
None
Notes
This bit should be written only when SPI is disabled (SPE = 0)
for correct operation.
Reference Manual to
LL API cross
reference:
CR1 CRCEN LL_SPI_DisableCRC
LL_SPI_IsEnabledCRC
Function name
__STATIC_INLINE uint32_t LL_SPI_IsEnabledCRC
(SPI_TypeDef * SPIx)
Function description
Check if CRC is enabled.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Notes
This bit should be written only when SPI is disabled (SPE = 0)
for correct operation.
Reference Manual to
LL API cross
reference:
CR1 CRCEN LL_SPI_IsEnabledCRC
LL_SPI_SetCRCWidth
Function name
__STATIC_INLINE void LL_SPI_SetCRCWidth (SPI_TypeDef *
SPIx, uint32_t CRCLength)
Function description
Set CRC Length.
Parameters
SPIx: SPI Instance
CRCLength: This parameter can be one of the following
values:
LL_SPI_CRC_8BIT
LL_SPI_CRC_16BIT
Return values
None
Notes
This bit should be written only when SPI is disabled (SPE = 0)
for correct operation.
Reference Manual to
LL API cross
reference:
CR1 CRCL LL_SPI_SetCRCWidth
LL_SPI_GetCRCWidth
Function name
__STATIC_INLINE uint32_t LL_SPI_GetCRCWidth
(SPI_TypeDef * SPIx)
Function description
Get CRC Length.
Parameters
SPIx: SPI Instance
Return values
Returned: value can be one of the following values:
LL_SPI_CRC_8BIT
DocID026525 Rev 6
1033/1320
LL SPI Generic Driver
UM1785
LL_SPI_CRC_16BIT
Reference Manual to
LL API cross
reference:
CR1 CRCL LL_SPI_GetCRCWidth
LL_SPI_SetCRCNext
Function name
__STATIC_INLINE void LL_SPI_SetCRCNext (SPI_TypeDef *
SPIx)
Function description
Set CRCNext to transfer CRC on the line.
Parameters
SPIx: SPI Instance
Return values
None
Notes
This bit has to be written as soon as the last data is written in
the SPIx_DR register.
Reference Manual to
LL API cross
reference:
CR1 CRCNEXT LL_SPI_SetCRCNext
LL_SPI_SetCRCPolynomial
Function name
__STATIC_INLINE void LL_SPI_SetCRCPolynomial
(SPI_TypeDef * SPIx, uint32_t CRCPoly)
Function description
Set polynomial for CRC calculation.
Parameters
SPIx: SPI Instance
CRCPoly: This parameter must be a number between
Min_Data = 0x00 and Max_Data = 0xFFFF
Return values
None
Reference Manual to
LL API cross
reference:
CRCPR CRCPOLY LL_SPI_SetCRCPolynomial
LL_SPI_GetCRCPolynomial
1034/1320
Function name
__STATIC_INLINE uint32_t LL_SPI_GetCRCPolynomial
(SPI_TypeDef * SPIx)
Function description
Get polynomial for CRC calculation.
Parameters
SPIx: SPI Instance
Return values
Returned: value is a number between Min_Data = 0x00 and
Max_Data = 0xFFFF
Reference Manual to
LL API cross
reference:
CRCPR CRCPOLY LL_SPI_GetCRCPolynomial
DocID026525 Rev 6
UM1785
LL SPI Generic Driver
LL_SPI_GetRxCRC
Function name
__STATIC_INLINE uint32_t LL_SPI_GetRxCRC (SPI_TypeDef *
SPIx)
Function description
Get Rx CRC.
Parameters
SPIx: SPI Instance
Return values
Returned: value is a number between Min_Data = 0x00 and
Max_Data = 0xFFFF
Reference Manual to
LL API cross
reference:
RXCRCR RXCRC LL_SPI_GetRxCRC
LL_SPI_GetTxCRC
Function name
__STATIC_INLINE uint32_t LL_SPI_GetTxCRC (SPI_TypeDef *
SPIx)
Function description
Get Tx CRC.
Parameters
SPIx: SPI Instance
Return values
Returned: value is a number between Min_Data = 0x00 and
Max_Data = 0xFFFF
Reference Manual to
LL API cross
reference:
TXCRCR TXCRC LL_SPI_GetTxCRC
LL_SPI_SetNSSMode
Function name
__STATIC_INLINE void LL_SPI_SetNSSMode (SPI_TypeDef *
SPIx, uint32_t NSS)
Function description
Set NSS mode.
Parameters
SPIx: SPI Instance
NSS: This parameter can be one of the following values:
LL_SPI_NSS_SOFT
LL_SPI_NSS_HARD_INPUT
LL_SPI_NSS_HARD_OUTPUT
Return values
None
Notes
LL_SPI_NSS_SOFT Mode is not used in SPI TI mode.
Reference Manual to
LL API cross
reference:
CR1 SSM LL_SPI_SetNSSMode
CR2 SSOE LL_SPI_SetNSSMode
LL_SPI_GetNSSMode
Function name
__STATIC_INLINE uint32_t LL_SPI_GetNSSMode
(SPI_TypeDef * SPIx)
Function description
Get NSS mode.
Parameters
SPIx: SPI Instance
DocID026525 Rev 6
1035/1320
LL SPI Generic Driver
Return values
Reference Manual to
LL API cross
reference:
UM1785
Returned: value can be one of the following values:
LL_SPI_NSS_SOFT
LL_SPI_NSS_HARD_INPUT
LL_SPI_NSS_HARD_OUTPUT
CR1 SSM LL_SPI_GetNSSMode
CR2 SSOE LL_SPI_GetNSSMode
LL_SPI_EnableNSSPulseMgt
Function name
__STATIC_INLINE void LL_SPI_EnableNSSPulseMgt
(SPI_TypeDef * SPIx)
Function description
Enable NSS pulse management.
Parameters
SPIx: SPI Instance
Return values
None
Notes
This bit should not be changed when communication is
ongoing. This bit is not used in SPI TI mode.
Reference Manual to
LL API cross
reference:
CR2 NSSP LL_SPI_EnableNSSPulseMgt
LL_SPI_DisableNSSPulseMgt
1036/1320
Function name
__STATIC_INLINE void LL_SPI_DisableNSSPulseMgt
(SPI_TypeDef * SPIx)
Function description
Disable NSS pulse management.
Parameters
SPIx: SPI Instance
Return values
None
Notes
This bit should not be changed when communication is
ongoing. This bit is not used in SPI TI mode.
Reference Manual to
LL API cross
reference:
CR2 NSSP LL_SPI_DisableNSSPulseMgt
DocID026525 Rev 6
UM1785
LL SPI Generic Driver
LL_SPI_IsEnabledNSSPulse
Function name
__STATIC_INLINE uint32_t LL_SPI_IsEnabledNSSPulse
(SPI_TypeDef * SPIx)
Function description
Check if NSS pulse is enabled.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Notes
This bit should not be changed when communication is
ongoing. This bit is not used in SPI TI mode.
Reference Manual to
LL API cross
reference:
CR2 NSSP LL_SPI_IsEnabledNSSPulse
LL_SPI_IsActiveFlag_RXNE
Function name
__STATIC_INLINE uint32_t LL_SPI_IsActiveFlag_RXNE
(SPI_TypeDef * SPIx)
Function description
Check if Rx buffer is not empty.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR RXNE LL_SPI_IsActiveFlag_RXNE
LL_SPI_IsActiveFlag_TXE
Function name
__STATIC_INLINE uint32_t LL_SPI_IsActiveFlag_TXE
(SPI_TypeDef * SPIx)
Function description
Check if Tx buffer is empty.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR TXE LL_SPI_IsActiveFlag_TXE
LL_SPI_IsActiveFlag_CRCERR
Function name
__STATIC_INLINE uint32_t LL_SPI_IsActiveFlag_CRCERR
(SPI_TypeDef * SPIx)
Function description
Get CRC error flag.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR CRCERR LL_SPI_IsActiveFlag_CRCERR
DocID026525 Rev 6
1037/1320
LL SPI Generic Driver
UM1785
LL_SPI_IsActiveFlag_MODF
Function name
__STATIC_INLINE uint32_t LL_SPI_IsActiveFlag_MODF
(SPI_TypeDef * SPIx)
Function description
Get mode fault error flag.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR MODF LL_SPI_IsActiveFlag_MODF
LL_SPI_IsActiveFlag_OVR
Function name
__STATIC_INLINE uint32_t LL_SPI_IsActiveFlag_OVR
(SPI_TypeDef * SPIx)
Function description
Get overrun error flag.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR OVR LL_SPI_IsActiveFlag_OVR
LL_SPI_IsActiveFlag_BSY
Function name
__STATIC_INLINE uint32_t LL_SPI_IsActiveFlag_BSY
(SPI_TypeDef * SPIx)
Function description
Get busy flag.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Notes
The BSY flag is cleared under any one of the following
conditions: -When the SPI is correctly disabled -When a fault
is detected in Master mode (MODF bit set to 1) -In Master
mode, when it finishes a data transmission and no new data
is ready to be sent -In Slave mode, when the BSY flag is set
to '0' for at least one SPI clock cycle between each data
transfer.
Reference Manual to
LL API cross
reference:
SR BSY LL_SPI_IsActiveFlag_BSY
LL_SPI_IsActiveFlag_FRE
Function name
__STATIC_INLINE uint32_t LL_SPI_IsActiveFlag_FRE
(SPI_TypeDef * SPIx)
Function description
Get frame format error flag.
Parameters
1038/1320
SPIx: SPI Instance
DocID026525 Rev 6
UM1785
LL SPI Generic Driver
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR FRE LL_SPI_IsActiveFlag_FRE
LL_SPI_GetRxFIFOLevel
Function name
__STATIC_INLINE uint32_t LL_SPI_GetRxFIFOLevel
(SPI_TypeDef * SPIx)
Function description
Get FIFO reception Level.
Parameters
SPIx: SPI Instance
Return values
Returned: value can be one of the following values:
LL_SPI_RX_FIFO_EMPTY
LL_SPI_RX_FIFO_QUARTER_FULL
LL_SPI_RX_FIFO_HALF_FULL
LL_SPI_RX_FIFO_FULL
Reference Manual to
LL API cross
reference:
SR FRLVL LL_SPI_GetRxFIFOLevel
LL_SPI_GetTxFIFOLevel
Function name
__STATIC_INLINE uint32_t LL_SPI_GetTxFIFOLevel
(SPI_TypeDef * SPIx)
Function description
Get FIFO Transmission Level.
Parameters
SPIx: SPI Instance
Return values
Returned: value can be one of the following values:
LL_SPI_TX_FIFO_EMPTY
LL_SPI_TX_FIFO_QUARTER_FULL
LL_SPI_TX_FIFO_HALF_FULL
LL_SPI_TX_FIFO_FULL
Reference Manual to
LL API cross
reference:
SR FTLVL LL_SPI_GetTxFIFOLevel
LL_SPI_ClearFlag_CRCERR
Function name
__STATIC_INLINE void LL_SPI_ClearFlag_CRCERR
(SPI_TypeDef * SPIx)
Function description
Clear CRC error flag.
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
SR CRCERR LL_SPI_ClearFlag_CRCERR
DocID026525 Rev 6
1039/1320
LL SPI Generic Driver
UM1785
LL_SPI_ClearFlag_MODF
Function name
__STATIC_INLINE void LL_SPI_ClearFlag_MODF
(SPI_TypeDef * SPIx)
Function description
Clear mode fault error flag.
Parameters
SPIx: SPI Instance
Return values
None
Notes
Clearing this flag is done by a read access to the SPIx_SR
register followed by a write access to the SPIx_CR1 register
Reference Manual to
LL API cross
reference:
SR MODF LL_SPI_ClearFlag_MODF
LL_SPI_ClearFlag_OVR
Function name
__STATIC_INLINE void LL_SPI_ClearFlag_OVR (SPI_TypeDef
* SPIx)
Function description
Clear overrun error flag.
Parameters
SPIx: SPI Instance
Return values
None
Notes
Clearing this flag is done by a read access to the SPIx_DR
register followed by a read access to the SPIx_SR register
Reference Manual to
LL API cross
reference:
SR OVR LL_SPI_ClearFlag_OVR
LL_SPI_ClearFlag_FRE
Function name
__STATIC_INLINE void LL_SPI_ClearFlag_FRE (SPI_TypeDef *
SPIx)
Function description
Clear frame format error flag.
Parameters
SPIx: SPI Instance
Return values
None
Notes
Clearing this flag is done by reading SPIx_SR register
Reference Manual to
LL API cross
reference:
SR FRE LL_SPI_ClearFlag_FRE
LL_SPI_EnableIT_ERR
1040/1320
Function name
__STATIC_INLINE void LL_SPI_EnableIT_ERR (SPI_TypeDef *
SPIx)
Function description
Enable error interrupt.
Parameters
SPIx: SPI Instance
Return values
None
DocID026525 Rev 6
UM1785
LL SPI Generic Driver
Notes
This bit controls the generation of an interrupt when an error
condition occurs (CRCERR, OVR, MODF in SPI mode, FRE
at TI mode).
Reference Manual to
LL API cross
reference:
CR2 ERRIE LL_SPI_EnableIT_ERR
LL_SPI_EnableIT_RXNE
Function name
__STATIC_INLINE void LL_SPI_EnableIT_RXNE (SPI_TypeDef
* SPIx)
Function description
Enable Rx buffer not empty interrupt.
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR2 RXNEIE LL_SPI_EnableIT_RXNE
LL_SPI_EnableIT_TXE
Function name
__STATIC_INLINE void LL_SPI_EnableIT_TXE (SPI_TypeDef *
SPIx)
Function description
Enable Tx buffer empty interrupt.
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR2 TXEIE LL_SPI_EnableIT_TXE
LL_SPI_DisableIT_ERR
Function name
__STATIC_INLINE void LL_SPI_DisableIT_ERR (SPI_TypeDef *
SPIx)
Function description
Disable error interrupt.
Parameters
SPIx: SPI Instance
Return values
None
Notes
This bit controls the generation of an interrupt when an error
condition occurs (CRCERR, OVR, MODF in SPI mode, FRE
at TI mode).
Reference Manual to
LL API cross
reference:
CR2 ERRIE LL_SPI_DisableIT_ERR
DocID026525 Rev 6
1041/1320
LL SPI Generic Driver
UM1785
LL_SPI_DisableIT_RXNE
Function name
__STATIC_INLINE void LL_SPI_DisableIT_RXNE (SPI_TypeDef
* SPIx)
Function description
Disable Rx buffer not empty interrupt.
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR2 RXNEIE LL_SPI_DisableIT_RXNE
LL_SPI_DisableIT_TXE
Function name
__STATIC_INLINE void LL_SPI_DisableIT_TXE (SPI_TypeDef *
SPIx)
Function description
Disable Tx buffer empty interrupt.
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR2 TXEIE LL_SPI_DisableIT_TXE
LL_SPI_IsEnabledIT_ERR
Function name
__STATIC_INLINE uint32_t LL_SPI_IsEnabledIT_ERR
(SPI_TypeDef * SPIx)
Function description
Check if error interrupt is enabled.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR2 ERRIE LL_SPI_IsEnabledIT_ERR
LL_SPI_IsEnabledIT_RXNE
1042/1320
Function name
__STATIC_INLINE uint32_t LL_SPI_IsEnabledIT_RXNE
(SPI_TypeDef * SPIx)
Function description
Check if Rx buffer not empty interrupt is enabled.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR2 RXNEIE LL_SPI_IsEnabledIT_RXNE
DocID026525 Rev 6
UM1785
LL SPI Generic Driver
LL_SPI_IsEnabledIT_TXE
Function name
__STATIC_INLINE uint32_t LL_SPI_IsEnabledIT_TXE
(SPI_TypeDef * SPIx)
Function description
Check if Tx buffer empty interrupt.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR2 TXEIE LL_SPI_IsEnabledIT_TXE
LL_SPI_EnableDMAReq_RX
Function name
__STATIC_INLINE void LL_SPI_EnableDMAReq_RX
(SPI_TypeDef * SPIx)
Function description
Enable DMA Rx.
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR2 RXDMAEN LL_SPI_EnableDMAReq_RX
LL_SPI_DisableDMAReq_RX
Function name
__STATIC_INLINE void LL_SPI_DisableDMAReq_RX
(SPI_TypeDef * SPIx)
Function description
Disable DMA Rx.
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR2 RXDMAEN LL_SPI_DisableDMAReq_RX
LL_SPI_IsEnabledDMAReq_RX
Function name
__STATIC_INLINE uint32_t LL_SPI_IsEnabledDMAReq_RX
(SPI_TypeDef * SPIx)
Function description
Check if DMA Rx is enabled.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR2 RXDMAEN LL_SPI_IsEnabledDMAReq_RX
DocID026525 Rev 6
1043/1320
LL SPI Generic Driver
UM1785
LL_SPI_EnableDMAReq_TX
Function name
__STATIC_INLINE void LL_SPI_EnableDMAReq_TX
(SPI_TypeDef * SPIx)
Function description
Enable DMA Tx.
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR2 TXDMAEN LL_SPI_EnableDMAReq_TX
LL_SPI_DisableDMAReq_TX
Function name
__STATIC_INLINE void LL_SPI_DisableDMAReq_TX
(SPI_TypeDef * SPIx)
Function description
Disable DMA Tx.
Parameters
SPIx: SPI Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR2 TXDMAEN LL_SPI_DisableDMAReq_TX
LL_SPI_IsEnabledDMAReq_TX
Function name
__STATIC_INLINE uint32_t LL_SPI_IsEnabledDMAReq_TX
(SPI_TypeDef * SPIx)
Function description
Check if DMA Tx is enabled.
Parameters
SPIx: SPI Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR2 TXDMAEN LL_SPI_IsEnabledDMAReq_TX
LL_SPI_SetDMAParity_RX
1044/1320
Function name
__STATIC_INLINE void LL_SPI_SetDMAParity_RX
(SPI_TypeDef * SPIx, uint32_t Parity)
Function description
Set parity of Last DMA reception.
Parameters
SPIx: SPI Instance
Parity: This parameter can be one of the following values:
LL_SPI_DMA_PARITY_ODD
LL_SPI_DMA_PARITY_EVEN
Return values
None
Reference Manual to
LL API cross
reference:
CR2 LDMARX LL_SPI_SetDMAParity_RX
DocID026525 Rev 6
UM1785
LL SPI Generic Driver
LL_SPI_GetDMAParity_RX
Function name
__STATIC_INLINE uint32_t LL_SPI_GetDMAParity_RX
(SPI_TypeDef * SPIx)
Function description
Get parity configuration for Last DMA reception.
Parameters
SPIx: SPI Instance
Return values
Returned: value can be one of the following values:
LL_SPI_DMA_PARITY_ODD
LL_SPI_DMA_PARITY_EVEN
Reference Manual to
LL API cross
reference:
CR2 LDMARX LL_SPI_GetDMAParity_RX
LL_SPI_SetDMAParity_TX
Function name
__STATIC_INLINE void LL_SPI_SetDMAParity_TX
(SPI_TypeDef * SPIx, uint32_t Parity)
Function description
Set parity of Last DMA transmission.
Parameters
SPIx: SPI Instance
Parity: This parameter can be one of the following values:
LL_SPI_DMA_PARITY_ODD
LL_SPI_DMA_PARITY_EVEN
Return values
None
Reference Manual to
LL API cross
reference:
CR2 LDMATX LL_SPI_SetDMAParity_TX
LL_SPI_GetDMAParity_TX
Function name
__STATIC_INLINE uint32_t LL_SPI_GetDMAParity_TX
(SPI_TypeDef * SPIx)
Function description
Get parity configuration for Last DMA transmission.
Parameters
SPIx: SPI Instance
Return values
Returned: value can be one of the following values:
LL_SPI_DMA_PARITY_ODD
LL_SPI_DMA_PARITY_EVEN
Reference Manual to
LL API cross
reference:
CR2 LDMATX LL_SPI_GetDMAParity_TX
LL_SPI_DMA_GetRegAddr
Function name
__STATIC_INLINE uint32_t LL_SPI_DMA_GetRegAddr
(SPI_TypeDef * SPIx)
Function description
Get the data register address used for DMA transfer.
Parameters
SPIx: SPI Instance
DocID026525 Rev 6
1045/1320
LL SPI Generic Driver
Return values
UM1785
Address: of data register
Reference Manual to
LL API cross
reference:
DR DR LL_SPI_DMA_GetRegAddr
LL_SPI_ReceiveData8
Function name
__STATIC_INLINE uint8_t LL_SPI_ReceiveData8 (SPI_TypeDef
* SPIx)
Function description
Read 8-Bits in the data register.
Parameters
SPIx: SPI Instance
Return values
RxData: Value between Min_Data=0x00 and
Max_Data=0xFF
Reference Manual to
LL API cross
reference:
DR DR LL_SPI_ReceiveData8
LL_SPI_ReceiveData16
Function name
__STATIC_INLINE uint16_t LL_SPI_ReceiveData16
(SPI_TypeDef * SPIx)
Function description
Read 16-Bits in the data register.
Parameters
SPIx: SPI Instance
Return values
RxData: Value between Min_Data=0x00 and
Max_Data=0xFFFF
Reference Manual to
LL API cross
reference:
DR DR LL_SPI_ReceiveData16
LL_SPI_TransmitData8
Function name
__STATIC_INLINE void LL_SPI_TransmitData8 (SPI_TypeDef *
SPIx, uint8_t TxData)
Function description
Write 8-Bits in the data register.
Parameters
SPIx: SPI Instance
TxData: Value between Min_Data=0x00 and
Max_Data=0xFF
Return values
None
Reference Manual to
LL API cross
reference:
DR DR LL_SPI_TransmitData8
LL_SPI_TransmitData16
Function name
1046/1320
__STATIC_INLINE void LL_SPI_TransmitData16 (SPI_TypeDef
* SPIx, uint16_t TxData)
DocID026525 Rev 6
UM1785
LL SPI Generic Driver
Function description
Write 16-Bits in the data register.
Parameters
SPIx: SPI Instance
TxData: Value between Min_Data=0x00 and
Max_Data=0xFFFF
Return values
None
Reference Manual to
LL API cross
reference:
DR DR LL_SPI_TransmitData16
LL_SPI_DeInit
Function name
ErrorStatus LL_SPI_DeInit (SPI_TypeDef * SPIx)
Function description
De-initialize the SPI registers to their default reset values.
Parameters
SPIx: SPI Instance
Return values
An: ErrorStatus enumeration value:
SUCCESS: SPI registers are de-initialized
ERROR: SPI registers are not de-initialized
LL_SPI_Init
Function name
ErrorStatus LL_SPI_Init (SPI_TypeDef * SPIx,
LL_SPI_InitTypeDef * SPI_InitStruct)
Function description
Initialize the SPI registers according to the specified parameters in
SPI_InitStruct.
Parameters
SPIx: SPI Instance
SPI_InitStruct: pointer to a LL_SPI_InitTypeDef structure
Return values
An: ErrorStatus enumeration value. (Return always
SUCCESS)
Notes
As some bits in SPI configuration registers can only be written
when the SPI is disabled (SPI_CR1_SPE bit =0), SPI IP
should be in disabled state prior calling this function.
Otherwise, ERROR result will be returned.
LL_SPI_StructInit
Function name
void LL_SPI_StructInit (LL_SPI_InitTypeDef * SPI_InitStruct)
Function description
Set each LL_SPI_InitTypeDef field to default value.
Parameters
SPI_InitStruct: pointer to a LL_SPI_InitTypeDef structure
whose fields will be set to default values.
Return values
None
DocID026525 Rev 6
1047/1320
LL SPI Generic Driver
UM1785
65.3
SPI Firmware driver defines
65.3.1
SPI
Baud Rate Prescaler
LL_SPI_BAUDRATEPRESCALER_DIV2
BaudRate control equal to fPCLK/2
LL_SPI_BAUDRATEPRESCALER_DIV4
BaudRate control equal to fPCLK/4
LL_SPI_BAUDRATEPRESCALER_DIV8
BaudRate control equal to fPCLK/8
LL_SPI_BAUDRATEPRESCALER_DIV16
BaudRate control equal to fPCLK/16
LL_SPI_BAUDRATEPRESCALER_DIV32
BaudRate control equal to fPCLK/32
LL_SPI_BAUDRATEPRESCALER_DIV64
BaudRate control equal to fPCLK/64
LL_SPI_BAUDRATEPRESCALER_DIV128
BaudRate control equal to fPCLK/128
LL_SPI_BAUDRATEPRESCALER_DIV256
BaudRate control equal to fPCLK/256
Transmission Bit Order
LL_SPI_LSB_FIRST
Data is transmitted/received with the LSB first
LL_SPI_MSB_FIRST
Data is transmitted/received with the MSB first
CRC Calculation
LL_SPI_CRCCALCULATION_DISABLE
CRC calculation disabled
LL_SPI_CRCCALCULATION_ENABLE
CRC calculation enabled
CRC Length
LL_SPI_CRC_8BIT
8-bit CRC length
LL_SPI_CRC_16BIT
16-bit CRC length
Datawidth
LL_SPI_DATAWIDTH_4BIT
Data length for SPI transfer: 4 bits
LL_SPI_DATAWIDTH_5BIT
Data length for SPI transfer: 5 bits
LL_SPI_DATAWIDTH_6BIT
Data length for SPI transfer: 6 bits
LL_SPI_DATAWIDTH_7BIT
Data length for SPI transfer: 7 bits
LL_SPI_DATAWIDTH_8BIT
Data length for SPI transfer: 8 bits
LL_SPI_DATAWIDTH_9BIT
Data length for SPI transfer: 9 bits
LL_SPI_DATAWIDTH_10BIT
Data length for SPI transfer: 10 bits
LL_SPI_DATAWIDTH_11BIT
Data length for SPI transfer: 11 bits
LL_SPI_DATAWIDTH_12BIT
Data length for SPI transfer: 12 bits
LL_SPI_DATAWIDTH_13BIT
Data length for SPI transfer: 13 bits
LL_SPI_DATAWIDTH_14BIT
Data length for SPI transfer: 14 bits
LL_SPI_DATAWIDTH_15BIT
Data length for SPI transfer: 15 bits
LL_SPI_DATAWIDTH_16BIT
Data length for SPI transfer: 16 bits
DMA Parity
LL_SPI_DMA_PARITY_EVEN
1048/1320
Select DMA parity Even
DocID026525 Rev 6
UM1785
LL SPI Generic Driver
LL_SPI_DMA_PARITY_ODD
Select DMA parity Odd
Get Flags Defines
LL_SPI_SR_RXNE
Rx buffer not empty flag
LL_SPI_SR_TXE
Tx buffer empty flag
LL_SPI_SR_BSY
Busy flag
LL_SPI_SR_CRCERR
CRC error flag
LL_SPI_SR_MODF
Mode fault flag
LL_SPI_SR_OVR
Overrun flag
LL_SPI_SR_FRE
TI mode frame format error flag
IT Defines
LL_SPI_CR2_RXNEIE
Rx buffer not empty interrupt enable
LL_SPI_CR2_TXEIE
Tx buffer empty interrupt enable
LL_SPI_CR2_ERRIE
Error interrupt enable
Operation Mode
LL_SPI_MODE_MASTER
Master configuration
LL_SPI_MODE_SLAVE
Slave configuration
Slave Select Pin Mode
LL_SPI_NSS_SOFT
NSS managed internally. NSS pin not used and free
LL_SPI_NSS_HARD_INPUT
NSS pin used in Input. Only used in Master mode
LL_SPI_NSS_HARD_OUTPUT
NSS pin used in Output. Only used in Slave mode as
chip select
Clock Phase
LL_SPI_PHASE_1EDGE
First clock transition is the first data capture edge
LL_SPI_PHASE_2EDGE
Second clock transition is the first data capture edge
Clock Polarity
LL_SPI_POLARITY_LOW
Clock to 0 when idle
LL_SPI_POLARITY_HIGH
Clock to 1 when idle
Serial Protocol
LL_SPI_PROTOCOL_MOTOROLA
Motorola mode. Used as default value
LL_SPI_PROTOCOL_TI
TI mode
RX FIFO Level
LL_SPI_RX_FIFO_EMPTY
FIFO reception empty
LL_SPI_RX_FIFO_QUARTER_FULL
FIFO reception 1/4
LL_SPI_RX_FIFO_HALF_FULL
FIFO reception 1/2
LL_SPI_RX_FIFO_FULL
FIFO reception full
RX FIFO Threshold
LL_SPI_RX_FIFO_TH_HALF
RXNE event is generated if FIFO level is greater than
DocID026525 Rev 6
1049/1320
LL SPI Generic Driver
UM1785
or equel to 1/2 (16-bit)
LL_SPI_RX_FIFO_TH_QUARTER
RXNE event is generated if FIFO level is greater than
or equel to 1/4 (8-bit)
Transfer Mode
LL_SPI_FULL_DUPLEX
Full-Duplex mode. Rx and Tx transfer on 2 lines
LL_SPI_SIMPLEX_RX
Simplex Rx mode. Rx transfer only on 1 line
LL_SPI_HALF_DUPLEX_RX
Half-Duplex Rx mode. Rx transfer on 1 line
LL_SPI_HALF_DUPLEX_TX
Half-Duplex Tx mode. Tx transfer on 1 line
TX FIFO Level
LL_SPI_TX_FIFO_EMPTY
FIFO transmission empty
LL_SPI_TX_FIFO_QUARTER_FULL
FIFO transmission 1/4
LL_SPI_TX_FIFO_HALF_FULL
FIFO transmission 1/2
LL_SPI_TX_FIFO_FULL
FIFO transmission full
Common Write and read registers Macros
LL_SPI_WriteReg
Description:
Write a value in SPI register.
Parameters:
__INSTANCE__: SPI Instance
__REG__: Register to be written
__VALUE__: Value to be written in the register
Return value:
None
LL_SPI_ReadReg
Description:
Read a value in SPI register.
Parameters:
__INSTANCE__: SPI Instance
__REG__: Register to be read
Return value:
Register: value
1050/1320
DocID026525 Rev 6
UM1785
LL SYSTEM Generic Driver
66
LL SYSTEM Generic Driver
66.1
SYSTEM Firmware driver API description
66.1.1
Detailed description of functions
LL_SYSCFG_SetRemapMemory
Function name
__STATIC_INLINE void LL_SYSCFG_SetRemapMemory
(uint32_t Memory)
Function description
Set memory mapping at address 0x00000000.
Parameters
Memory: This parameter can be one of the following values:
LL_SYSCFG_REMAP_FLASH
LL_SYSCFG_REMAP_SYSTEMFLASH
LL_SYSCFG_REMAP_SRAM
Return values
None
Reference Manual to
LL API cross
reference:
SYSCFG_CFGR1 MEM_MODE
LL_SYSCFG_SetRemapMemory
LL_SYSCFG_GetRemapMemory
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_GetRemapMemory
(void )
Function description
Get memory mapping at address 0x00000000.
Return values
Returned: value can be one of the following values:
LL_SYSCFG_REMAP_FLASH
LL_SYSCFG_REMAP_SYSTEMFLASH
LL_SYSCFG_REMAP_SRAM
Reference Manual to
LL API cross
reference:
SYSCFG_CFGR1 MEM_MODE
LL_SYSCFG_GetRemapMemory
LL_SYSCFG_SetIRModEnvelopeSignal
Function name
__STATIC_INLINE void
LL_SYSCFG_SetIRModEnvelopeSignal (uint32_t Source)
Function description
Set IR Modulation Envelope signal source.
Parameters
Source: This parameter can be one of the following values:
LL_SYSCFG_IR_MOD_TIM16
LL_SYSCFG_IR_MOD_USART1
LL_SYSCFG_IR_MOD_USART4
Return values
None
Reference Manual to
LL API cross
SYSCFG_CFGR1 IR_MOD
LL_SYSCFG_SetIRModEnvelopeSignal
DocID026525 Rev 6
1051/1320
LL SYSTEM Generic Driver
reference:
UM1785
LL_SYSCFG_GetIRModEnvelopeSignal
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_GetIRModEnvelopeSignal (void )
Function description
Get IR Modulation Envelope signal source.
Return values
Returned: value can be one of the following values:
LL_SYSCFG_IR_MOD_TIM16
LL_SYSCFG_IR_MOD_USART1
LL_SYSCFG_IR_MOD_USART4
Reference Manual to
LL API cross
reference:
SYSCFG_CFGR1 IR_MOD
LL_SYSCFG_GetIRModEnvelopeSignal
LL_SYSCFG_EnableFastModePlus
1052/1320
Function name
__STATIC_INLINE void LL_SYSCFG_EnableFastModePlus
(uint32_t ConfigFastModePlus)
Function description
Enable the I2C fast mode plus driving capability.
Parameters
ConfigFastModePlus: This parameter can be a combination
of the following values: (*) value not defined in all devices
LL_SYSCFG_I2C_FASTMODEPLUS_PB6
LL_SYSCFG_I2C_FASTMODEPLUS_PB7
LL_SYSCFG_I2C_FASTMODEPLUS_PB8
LL_SYSCFG_I2C_FASTMODEPLUS_PB9
LL_SYSCFG_I2C_FASTMODEPLUS_I2C1 (*)
LL_SYSCFG_I2C_FASTMODEPLUS_I2C2 (*)
LL_SYSCFG_I2C_FASTMODEPLUS_PA9 (*)
LL_SYSCFG_I2C_FASTMODEPLUS_PA10 (*)
Return values
None
Reference Manual to
LL API cross
reference:
SYSCFG_CFGR1 I2C_FMP_PB6
LL_SYSCFG_EnableFastModePlus
SYSCFG_CFGR1 I2C_FMP_PB7
LL_SYSCFG_EnableFastModePlus
SYSCFG_CFGR1 I2C_FMP_PB8
LL_SYSCFG_EnableFastModePlus
SYSCFG_CFGR1 I2C_FMP_PB9
LL_SYSCFG_EnableFastModePlus
SYSCFG_CFGR1 I2C_FMP_I2C1
LL_SYSCFG_EnableFastModePlus
SYSCFG_CFGR1 I2C_FMP_I2C2
LL_SYSCFG_EnableFastModePlus
SYSCFG_CFGR1 I2C_FMP_PA9
LL_SYSCFG_EnableFastModePlus
SYSCFG_CFGR1 I2C_FMP_PA10
LL_SYSCFG_EnableFastModePlus
DocID026525 Rev 6
UM1785
LL SYSTEM Generic Driver
LL_SYSCFG_DisableFastModePlus
Function name
__STATIC_INLINE void LL_SYSCFG_DisableFastModePlus
(uint32_t ConfigFastModePlus)
Function description
Disable the I2C fast mode plus driving capability.
Parameters
ConfigFastModePlus: This parameter can be a combination
of the following values: (*) value not defined in all devices
LL_SYSCFG_I2C_FASTMODEPLUS_PB6
LL_SYSCFG_I2C_FASTMODEPLUS_PB7
LL_SYSCFG_I2C_FASTMODEPLUS_PB8
LL_SYSCFG_I2C_FASTMODEPLUS_PB9
LL_SYSCFG_I2C_FASTMODEPLUS_I2C1 (*)
LL_SYSCFG_I2C_FASTMODEPLUS_I2C2 (*)
LL_SYSCFG_I2C_FASTMODEPLUS_PA9 (*)
LL_SYSCFG_I2C_FASTMODEPLUS_PA10 (*)
Return values
None
Reference Manual to
LL API cross
reference:
SYSCFG_CFGR1 I2C_FMP_PB6
LL_SYSCFG_DisableFastModePlus
SYSCFG_CFGR1 I2C_FMP_PB7
LL_SYSCFG_DisableFastModePlus
SYSCFG_CFGR1 I2C_FMP_PB8
LL_SYSCFG_DisableFastModePlus
SYSCFG_CFGR1 I2C_FMP_PB9
LL_SYSCFG_DisableFastModePlus
SYSCFG_CFGR1 I2C_FMP_I2C1
LL_SYSCFG_DisableFastModePlus
SYSCFG_CFGR1 I2C_FMP_I2C2
LL_SYSCFG_DisableFastModePlus
SYSCFG_CFGR1 I2C_FMP_PA9
LL_SYSCFG_DisableFastModePlus
SYSCFG_CFGR1 I2C_FMP_PA10
LL_SYSCFG_DisableFastModePlus
LL_SYSCFG_SetEXTISource
Function name
__STATIC_INLINE void LL_SYSCFG_SetEXTISource (uint32_t
Port, uint32_t Line)
Function description
Configure source input for the EXTI external interrupt.
Parameters
Port: This parameter can be one of the following values: (*)
value not defined in all devices
LL_SYSCFG_EXTI_PORTA
LL_SYSCFG_EXTI_PORTB
LL_SYSCFG_EXTI_PORTC
LL_SYSCFG_EXTI_PORTD (*)
LL_SYSCFG_EXTI_PORTE (*)
LL_SYSCFG_EXTI_PORTF
Line: This parameter can be one of the following values:
LL_SYSCFG_EXTI_LINE0
LL_SYSCFG_EXTI_LINE1
LL_SYSCFG_EXTI_LINE2
LL_SYSCFG_EXTI_LINE3
DocID026525 Rev 6
1053/1320
LL SYSTEM Generic Driver
UM1785
LL_SYSCFG_EXTI_LINE4
LL_SYSCFG_EXTI_LINE5
LL_SYSCFG_EXTI_LINE6
LL_SYSCFG_EXTI_LINE7
LL_SYSCFG_EXTI_LINE8
LL_SYSCFG_EXTI_LINE9
LL_SYSCFG_EXTI_LINE10
LL_SYSCFG_EXTI_LINE11
LL_SYSCFG_EXTI_LINE12
LL_SYSCFG_EXTI_LINE13
LL_SYSCFG_EXTI_LINE14
LL_SYSCFG_EXTI_LINE15
Return values
None
Reference Manual to
LL API cross
reference:
SYSCFG_EXTICR1 EXTI0 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR1 EXTI1 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR1 EXTI2 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR1 EXTI3 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR2 EXTI4 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR2 EXTI5 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR2 EXTI6 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR2 EXTI7 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR3 EXTI8 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR3 EXTI9 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR3 EXTI10 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR3 EXTI11 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR4 EXTI12 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR4 EXTI13 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR4 EXTI14 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR4 EXTI15 LL_SYSCFG_SetEXTISource
LL_SYSCFG_GetEXTISource
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_GetEXTISource
(uint32_t Line)
Function description
Get the configured defined for specific EXTI Line.
Parameters
1054/1320
Line: This parameter can be one of the following values:
LL_SYSCFG_EXTI_LINE0
LL_SYSCFG_EXTI_LINE1
LL_SYSCFG_EXTI_LINE2
LL_SYSCFG_EXTI_LINE3
LL_SYSCFG_EXTI_LINE4
LL_SYSCFG_EXTI_LINE5
LL_SYSCFG_EXTI_LINE6
LL_SYSCFG_EXTI_LINE7
LL_SYSCFG_EXTI_LINE8
LL_SYSCFG_EXTI_LINE9
LL_SYSCFG_EXTI_LINE10
LL_SYSCFG_EXTI_LINE11
LL_SYSCFG_EXTI_LINE12
LL_SYSCFG_EXTI_LINE13
DocID026525 Rev 6
UM1785
LL SYSTEM Generic Driver
LL_SYSCFG_EXTI_LINE14
LL_SYSCFG_EXTI_LINE15
Return values
Returned: value can be one of the following values: (*)
value not defined in all devices
LL_SYSCFG_EXTI_PORTA
LL_SYSCFG_EXTI_PORTB
LL_SYSCFG_EXTI_PORTC
LL_SYSCFG_EXTI_PORTD (*)
LL_SYSCFG_EXTI_PORTE (*)
LL_SYSCFG_EXTI_PORTF
Reference Manual to
LL API cross
reference:
SYSCFG_EXTICR1 EXTI0 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR1 EXTI1 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR1 EXTI2 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR1 EXTI3 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR2 EXTI4 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR2 EXTI5 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR2 EXTI6 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR2 EXTI7 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR3 EXTI8 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR3 EXTI9 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR3 EXTI10 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR3 EXTI11 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR4 EXTI12 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR4 EXTI13 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR4 EXTI14 LL_SYSCFG_SetEXTISource
SYSCFG_EXTICR4 EXTI15 LL_SYSCFG_SetEXTISource
LL_SYSCFG_IsActiveFlag_WWDG
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_WWDG
(void )
Function description
Check if Window watchdog interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE0 SR_EWDG
LL_SYSCFG_IsActiveFlag_WWDG
LL_SYSCFG_IsActiveFlag_PVDOUT
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_PVDOUT (void )
Function description
Check if PVD supply monitoring interrupt occurred or not (EXTI
line 16).
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE1 SR_PVDOUT
LL_SYSCFG_IsActiveFlag_PVDOUT
DocID026525 Rev 6
1055/1320
LL SYSTEM Generic Driver
UM1785
LL_SYSCFG_IsActiveFlag_VDDIO2
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_VDDIO2
(void )
Function description
Check if VDDIO2 supply monitoring interrupt occurred or not (EXTI
line 31).
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE1 SR_VDDIO2
LL_SYSCFG_IsActiveFlag_VDDIO2
LL_SYSCFG_IsActiveFlag_RTC_WAKEUP
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_RTC_WAKEUP (void )
Function description
Check if RTC Wake Up interrupt occurred or not (EXTI line 20).
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE2 SR_RTC_WAKEUP
LL_SYSCFG_IsActiveFlag_RTC_WAKEUP
LL_SYSCFG_IsActiveFlag_RTC_TSTAMP
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_RTC_TSTAMP (void )
Function description
Check if RTC Tamper and TimeStamp interrupt occurred or not
(EXTI line 19).
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE2 SR_RTC_TSTAMP
LL_SYSCFG_IsActiveFlag_RTC_TSTAMP
LL_SYSCFG_IsActiveFlag_RTC_ALRA
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_RTC_ALRA (void )
Function description
Check if RTC Alarm interrupt occurred or not (EXTI line 17).
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE2 SR_RTC_ALRA
LL_SYSCFG_IsActiveFlag_RTC_ALRA
LL_SYSCFG_IsActiveFlag_FLASH_ITF
1056/1320
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_FLASH_ITF (void )
Function description
Check if Flash interface interrupt occurred or not.
DocID026525 Rev 6
UM1785
LL SYSTEM Generic Driver
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE3 SR_FLASH_ITF
LL_SYSCFG_IsActiveFlag_FLASH_ITF
LL_SYSCFG_IsActiveFlag_CRS
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_CRS
(void )
Function description
Check if Clock recovery system interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE4 SR_CRS LL_SYSCFG_IsActiveFlag_CRS
LL_SYSCFG_IsActiveFlag_CLK_CTRL
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_CLK_CTRL (void )
Function description
Check if Reset and clock control interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE4 SR_CLK_CTRL
LL_SYSCFG_IsActiveFlag_CLK_CTRL
LL_SYSCFG_IsActiveFlag_EXTI0
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_EXTI0
(void )
Function description
Check if EXTI line 0 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE5 SR_EXTI0
LL_SYSCFG_IsActiveFlag_EXTI0
LL_SYSCFG_IsActiveFlag_EXTI1
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_EXTI1
(void )
Function description
Check if EXTI line 1 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE5 SR_EXTI1
LL_SYSCFG_IsActiveFlag_EXTI1
DocID026525 Rev 6
1057/1320
LL SYSTEM Generic Driver
UM1785
LL_SYSCFG_IsActiveFlag_EXTI2
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_EXTI2
(void )
Function description
Check if EXTI line 2 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE6 SR_EXTI2
LL_SYSCFG_IsActiveFlag_EXTI2
LL_SYSCFG_IsActiveFlag_EXTI3
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_EXTI3
(void )
Function description
Check if EXTI line 3 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE6 SR_EXTI3
LL_SYSCFG_IsActiveFlag_EXTI3
LL_SYSCFG_IsActiveFlag_EXTI4
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_EXTI4
(void )
Function description
Check if EXTI line 4 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE7 SR_EXTI4
LL_SYSCFG_IsActiveFlag_EXTI4
LL_SYSCFG_IsActiveFlag_EXTI5
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_EXTI5
(void )
Function description
Check if EXTI line 5 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE7 SR_EXTI5
LL_SYSCFG_IsActiveFlag_EXTI5
LL_SYSCFG_IsActiveFlag_EXTI6
1058/1320
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_EXTI6
(void )
Function description
Check if EXTI line 6 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
SYSCFG_ITLINE7 SR_EXTI6
DocID026525 Rev 6
UM1785
LL SYSTEM Generic Driver
LL API cross
reference:
LL_SYSCFG_IsActiveFlag_EXTI6
LL_SYSCFG_IsActiveFlag_EXTI7
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_EXTI7
(void )
Function description
Check if EXTI line 7 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE7 SR_EXTI7
LL_SYSCFG_IsActiveFlag_EXTI7
LL_SYSCFG_IsActiveFlag_EXTI8
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_EXTI8
(void )
Function description
Check if EXTI line 8 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE7 SR_EXTI8
LL_SYSCFG_IsActiveFlag_EXTI8
LL_SYSCFG_IsActiveFlag_EXTI9
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_EXTI9
(void )
Function description
Check if EXTI line 9 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE7 SR_EXTI9
LL_SYSCFG_IsActiveFlag_EXTI9
LL_SYSCFG_IsActiveFlag_EXTI10
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_EXTI10
(void )
Function description
Check if EXTI line 10 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE7 SR_EXTI10
LL_SYSCFG_IsActiveFlag_EXTI10
DocID026525 Rev 6
1059/1320
LL SYSTEM Generic Driver
UM1785
LL_SYSCFG_IsActiveFlag_EXTI11
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_EXTI11
(void )
Function description
Check if EXTI line 11 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE7 SR_EXTI11
LL_SYSCFG_IsActiveFlag_EXTI11
LL_SYSCFG_IsActiveFlag_EXTI12
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_EXTI12
(void )
Function description
Check if EXTI line 12 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE7 SR_EXTI12
LL_SYSCFG_IsActiveFlag_EXTI12
LL_SYSCFG_IsActiveFlag_EXTI13
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_EXTI13
(void )
Function description
Check if EXTI line 13 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE7 SR_EXTI13
LL_SYSCFG_IsActiveFlag_EXTI13
LL_SYSCFG_IsActiveFlag_EXTI14
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_EXTI14
(void )
Function description
Check if EXTI line 14 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE7 SR_EXTI14
LL_SYSCFG_IsActiveFlag_EXTI14
LL_SYSCFG_IsActiveFlag_EXTI15
1060/1320
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_EXTI15
(void )
Function description
Check if EXTI line 15 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
SYSCFG_ITLINE7 SR_EXTI15
DocID026525 Rev 6
UM1785
LL API cross
reference:
LL SYSTEM Generic Driver
LL_SYSCFG_IsActiveFlag_EXTI15
LL_SYSCFG_IsActiveFlag_TSC_EOA
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_TSC_EOA (void )
Function description
Check if Touch sensing controller end of acquisition interrupt
occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE8 SR_TSC_EOA
LL_SYSCFG_IsActiveFlag_TSC_EOA
LL_SYSCFG_IsActiveFlag_TSC_MCE
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_TSC_MCE (void )
Function description
Check if Touch sensing controller max counterror interrupt
occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE8 SR_TSC_MCE
LL_SYSCFG_IsActiveFlag_TSC_MCE
LL_SYSCFG_IsActiveFlag_DMA1_CH1
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_DMA1_CH1 (void )
Function description
Check if DMA1 channel 1 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE9 SR_DMA1_CH1
LL_SYSCFG_IsActiveFlag_DMA1_CH1
LL_SYSCFG_IsActiveFlag_DMA1_CH2
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_DMA1_CH2 (void )
Function description
Check if DMA1 channel 2 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE10 SR_DMA1_CH2
LL_SYSCFG_IsActiveFlag_DMA1_CH2
DocID026525 Rev 6
1061/1320
LL SYSTEM Generic Driver
UM1785
LL_SYSCFG_IsActiveFlag_DMA1_CH3
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_DMA1_CH3 (void )
Function description
Check if DMA1 channel 3 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE10 SR_DMA1_CH3
LL_SYSCFG_IsActiveFlag_DMA1_CH3
LL_SYSCFG_IsActiveFlag_DMA2_CH1
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_DMA2_CH1 (void )
Function description
Check if DMA2 channel 1 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE10 SR_DMA2_CH1
LL_SYSCFG_IsActiveFlag_DMA2_CH1
LL_SYSCFG_IsActiveFlag_DMA2_CH2
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_DMA2_CH2 (void )
Function description
Check if DMA2 channel 2 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE10 SR_DMA2_CH2
LL_SYSCFG_IsActiveFlag_DMA2_CH2
LL_SYSCFG_IsActiveFlag_DMA1_CH4
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_DMA1_CH4 (void )
Function description
Check if DMA1 channel 4 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE11 SR_DMA1_CH4
LL_SYSCFG_IsActiveFlag_DMA1_CH4
LL_SYSCFG_IsActiveFlag_DMA1_CH5
1062/1320
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_DMA1_CH5 (void )
Function description
Check if DMA1 channel 5 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
SYSCFG_ITLINE11 SR_DMA1_CH5
DocID026525 Rev 6
UM1785
LL API cross
reference:
LL SYSTEM Generic Driver
LL_SYSCFG_IsActiveFlag_DMA1_CH5
LL_SYSCFG_IsActiveFlag_DMA1_CH6
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_DMA1_CH6 (void )
Function description
Check if DMA1 channel 6 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE11 SR_DMA1_CH6
LL_SYSCFG_IsActiveFlag_DMA1_CH6
LL_SYSCFG_IsActiveFlag_DMA1_CH7
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_DMA1_CH7 (void )
Function description
Check if DMA1 channel 7 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE11 SR_DMA1_CH7
LL_SYSCFG_IsActiveFlag_DMA1_CH7
LL_SYSCFG_IsActiveFlag_DMA2_CH3
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_DMA2_CH3 (void )
Function description
Check if DMA2 channel 3 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE11 SR_DMA2_CH3
LL_SYSCFG_IsActiveFlag_DMA2_CH3
LL_SYSCFG_IsActiveFlag_DMA2_CH4
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_DMA2_CH4 (void )
Function description
Check if DMA2 channel 4 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE11 SR_DMA2_CH4
LL_SYSCFG_IsActiveFlag_DMA2_CH4
LL_SYSCFG_IsActiveFlag_DMA2_CH5
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_DMA2_CH5 (void )
DocID026525 Rev 6
1063/1320
LL SYSTEM Generic Driver
Function description
UM1785
Check if DMA2 channel 5 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE11 SR_DMA2_CH5
LL_SYSCFG_IsActiveFlag_DMA2_CH5
LL_SYSCFG_IsActiveFlag_ADC
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_ADC
(void )
Function description
Check if ADC interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE12 SR_ADC
LL_SYSCFG_IsActiveFlag_ADC
LL_SYSCFG_IsActiveFlag_COMP1
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_COMP1
(void )
Function description
Check if Comparator 1 interrupt occurred or not (EXTI line 21).
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE12 SR_COMP1
LL_SYSCFG_IsActiveFlag_COMP1
LL_SYSCFG_IsActiveFlag_COMP2
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_COMP2
(void )
Function description
Check if Comparator 2 interrupt occurred or not (EXTI line 22).
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE12 SR_COMP2
LL_SYSCFG_IsActiveFlag_COMP2
LL_SYSCFG_IsActiveFlag_TIM1_BRK
1064/1320
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_TIM1_BRK (void )
Function description
Check if Timer 1 break interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE13 SR_TIM1_BRK
LL_SYSCFG_IsActiveFlag_TIM1_BRK
DocID026525 Rev 6
UM1785
LL SYSTEM Generic Driver
LL_SYSCFG_IsActiveFlag_TIM1_UPD
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_TIM1_UPD (void )
Function description
Check if Timer 1 update interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE13 SR_TIM1_UPD
LL_SYSCFG_IsActiveFlag_TIM1_UPD
LL_SYSCFG_IsActiveFlag_TIM1_TRG
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_TIM1_TRG (void )
Function description
Check if Timer 1 trigger interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE13 SR_TIM1_TRG
LL_SYSCFG_IsActiveFlag_TIM1_TRG
LL_SYSCFG_IsActiveFlag_TIM1_CCU
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_TIM1_CCU (void )
Function description
Check if Timer 1 commutation interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE13 SR_TIM1_CCU
LL_SYSCFG_IsActiveFlag_TIM1_CCU
LL_SYSCFG_IsActiveFlag_TIM1_CC
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_TIM1_CC (void )
Function description
Check if Timer 1 capture compare interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE14 SR_TIM1_CC
LL_SYSCFG_IsActiveFlag_TIM1_CC
LL_SYSCFG_IsActiveFlag_TIM2
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_TIM2
(void )
Function description
Check if Timer 2 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
SYSCFG_ITLINE15 SR_TIM2_GLB
DocID026525 Rev 6
1065/1320
LL SYSTEM Generic Driver
LL API cross
reference:
UM1785
LL_SYSCFG_IsActiveFlag_TIM2
LL_SYSCFG_IsActiveFlag_TIM3
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_TIM3
(void )
Function description
Check if Timer 3 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE16 SR_TIM3_GLB
LL_SYSCFG_IsActiveFlag_TIM3
LL_SYSCFG_IsActiveFlag_DAC
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_DAC
(void )
Function description
Check if DAC underrun interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE17 SR_DAC
LL_SYSCFG_IsActiveFlag_DAC
LL_SYSCFG_IsActiveFlag_TIM6
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_TIM6
(void )
Function description
Check if Timer 6 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE17 SR_TIM6_GLB
LL_SYSCFG_IsActiveFlag_TIM6
LL_SYSCFG_IsActiveFlag_TIM7
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_TIM7
(void )
Function description
Check if Timer 7 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE18 SR_TIM7_GLB
LL_SYSCFG_IsActiveFlag_TIM7
LL_SYSCFG_IsActiveFlag_TIM14
Function name
1066/1320
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_TIM14
(void )
DocID026525 Rev 6
UM1785
Function description
LL SYSTEM Generic Driver
Check if Timer 14 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE19 SR_TIM14_GLB
LL_SYSCFG_IsActiveFlag_TIM14
LL_SYSCFG_IsActiveFlag_TIM15
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_TIM15
(void )
Function description
Check if Timer 15 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE20 SR_TIM15_GLB
LL_SYSCFG_IsActiveFlag_TIM15
LL_SYSCFG_IsActiveFlag_TIM16
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_TIM16
(void )
Function description
Check if Timer 16 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE21 SR_TIM16_GLB
LL_SYSCFG_IsActiveFlag_TIM16
LL_SYSCFG_IsActiveFlag_TIM17
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_TIM17
(void )
Function description
Check if Timer 17 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE22 SR_TIM17_GLB
LL_SYSCFG_IsActiveFlag_TIM17
LL_SYSCFG_IsActiveFlag_I2C1
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_I2C1
(void )
Function description
Check if I2C1 interrupt occurred or not, combined with EXTI line
23.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE23 SR_I2C1_GLB
LL_SYSCFG_IsActiveFlag_I2C1
DocID026525 Rev 6
1067/1320
LL SYSTEM Generic Driver
UM1785
LL_SYSCFG_IsActiveFlag_I2C2
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_I2C2
(void )
Function description
Check if I2C2 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE24 SR_I2C2_GLB
LL_SYSCFG_IsActiveFlag_I2C2
LL_SYSCFG_IsActiveFlag_SPI1
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_SPI1
(void )
Function description
Check if SPI1 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE25 SR_SPI1
LL_SYSCFG_IsActiveFlag_SPI1
LL_SYSCFG_IsActiveFlag_SPI2
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_SPI2
(void )
Function description
Check if SPI2 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE26 SR_SPI2
LL_SYSCFG_IsActiveFlag_SPI2
LL_SYSCFG_IsActiveFlag_USART1
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_USART1 (void )
Function description
Check if USART1 interrupt occurred or not, combined with EXTI
line 25.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE27 SR_USART1_GLB
LL_SYSCFG_IsActiveFlag_USART1
LL_SYSCFG_IsActiveFlag_USART2
1068/1320
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_USART2 (void )
Function description
Check if USART2 interrupt occurred or not, combined with EXTI
line 26.
DocID026525 Rev 6
UM1785
LL SYSTEM Generic Driver
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE28 SR_USART2_GLB
LL_SYSCFG_IsActiveFlag_USART2
LL_SYSCFG_IsActiveFlag_USART3
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_USART3 (void )
Function description
Check if USART3 interrupt occurred or not, combined with EXTI
line 28.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE29 SR_USART3_GLB
LL_SYSCFG_IsActiveFlag_USART3
LL_SYSCFG_IsActiveFlag_USART4
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_USART4 (void )
Function description
Check if USART4 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE29 SR_USART4_GLB
LL_SYSCFG_IsActiveFlag_USART4
LL_SYSCFG_IsActiveFlag_USART5
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_USART5 (void )
Function description
Check if USART5 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE29 SR_USART5_GLB
LL_SYSCFG_IsActiveFlag_USART5
LL_SYSCFG_IsActiveFlag_USART6
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_USART6 (void )
Function description
Check if USART6 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE29 SR_USART6_GLB
LL_SYSCFG_IsActiveFlag_USART6
DocID026525 Rev 6
1069/1320
LL SYSTEM Generic Driver
UM1785
LL_SYSCFG_IsActiveFlag_USART7
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_USART7 (void )
Function description
Check if USART7 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE29 SR_USART7_GLB
LL_SYSCFG_IsActiveFlag_USART7
LL_SYSCFG_IsActiveFlag_USART8
Function name
__STATIC_INLINE uint32_t
LL_SYSCFG_IsActiveFlag_USART8 (void )
Function description
Check if USART8 interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE29 SR_USART8_GLB
LL_SYSCFG_IsActiveFlag_USART8
LL_SYSCFG_IsActiveFlag_CAN
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_CAN
(void )
Function description
Check if CAN interrupt occurred or not.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE30 SR_CAN
LL_SYSCFG_IsActiveFlag_CAN
LL_SYSCFG_IsActiveFlag_CEC
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_CEC
(void )
Function description
Check if CEC interrupt occurred or not, combined with EXTI line
27.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_ITLINE30 SR_CEC
LL_SYSCFG_IsActiveFlag_CEC
LL_SYSCFG_SetTIMBreakInputs
Function name
__STATIC_INLINE void LL_SYSCFG_SetTIMBreakInputs
(uint32_t Break)
Function description
Set connections to TIMx Break inputs.
Parameters
1070/1320
Break: This parameter can be a combination of the following
values: (*) value not defined in all devices
DocID026525 Rev 6
UM1785
LL SYSTEM Generic Driver
LL_SYSCFG_TIMBREAK_PVD (*)
LL_SYSCFG_TIMBREAK_SRAM_PARITY
LL_SYSCFG_TIMBREAK_LOCKUP
Return values
None
Reference Manual to
LL API cross
reference:
SYSCFG_CFGR2 LOCKUP_LOCK
LL_SYSCFG_SetTIMBreakInputs
SYSCFG_CFGR2 SRAM_PARITY_LOCK
LL_SYSCFG_SetTIMBreakInputs
SYSCFG_CFGR2 PVD_LOCK
LL_SYSCFG_SetTIMBreakInputs
LL_SYSCFG_GetTIMBreakInputs
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_GetTIMBreakInputs
(void )
Function description
Get connections to TIMx Break inputs.
Return values
Returned: value can be can be a combination of the
following values: (*) value not defined in all devices
LL_SYSCFG_TIMBREAK_PVD (*)
LL_SYSCFG_TIMBREAK_SRAM_PARITY
LL_SYSCFG_TIMBREAK_LOCKUP
Reference Manual to
LL API cross
reference:
SYSCFG_CFGR2 LOCKUP_LOCK
LL_SYSCFG_GetTIMBreakInputs
SYSCFG_CFGR2 SRAM_PARITY_LOCK
LL_SYSCFG_GetTIMBreakInputs
SYSCFG_CFGR2 PVD_LOCK
LL_SYSCFG_GetTIMBreakInputs
LL_SYSCFG_IsActiveFlag_SP
Function name
__STATIC_INLINE uint32_t LL_SYSCFG_IsActiveFlag_SP
(void )
Function description
Check if SRAM parity error detected.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SYSCFG_CFGR2 SRAM_PEF
LL_SYSCFG_IsActiveFlag_SP
LL_SYSCFG_ClearFlag_SP
Function name
__STATIC_INLINE void LL_SYSCFG_ClearFlag_SP (void )
Function description
Clear SRAM parity error flag.
Return values
None
Reference Manual to
LL API cross
reference:
SYSCFG_CFGR2 SRAM_PEF LL_SYSCFG_ClearFlag_SP
DocID026525 Rev 6
1071/1320
LL SYSTEM Generic Driver
UM1785
LL_DBGMCU_GetDeviceID
Function name
__STATIC_INLINE uint32_t LL_DBGMCU_GetDeviceID (void )
Function description
Return the device identifier.
Return values
Values: between Min_Data=0x00 and Max_Data=0xFFF
Notes
For STM32F03x devices, the device ID is 0x444
For STM32F04x devices, the device ID is 0x445.
For STM32F05x devices, the device ID is 0x440
For STM32F07x devices, the device ID is 0x448
For STM32F09x devices, the device ID is 0x442
Reference Manual to
LL API cross
reference:
DBGMCU_IDCODE DEV_ID LL_DBGMCU_GetDeviceID
LL_DBGMCU_GetRevisionID
Function name
__STATIC_INLINE uint32_t LL_DBGMCU_GetRevisionID (void
)
Function description
Return the device revision identifier.
Return values
Values: between Min_Data=0x00 and Max_Data=0xFFFF
Notes
This field indicates the revision of the device. For example, it
is read as 0x1000 for Revision 1.0.
Reference Manual to
LL API cross
reference:
DBGMCU_IDCODE REV_ID LL_DBGMCU_GetRevisionID
LL_DBGMCU_EnableDBGStopMode
Function name
__STATIC_INLINE void LL_DBGMCU_EnableDBGStopMode
(void )
Function description
Enable the Debug Module during STOP mode.
Return values
None
Reference Manual to
LL API cross
reference:
DBGMCU_CR DBG_STOP
LL_DBGMCU_EnableDBGStopMode
LL_DBGMCU_DisableDBGStopMode
1072/1320
Function name
__STATIC_INLINE void LL_DBGMCU_DisableDBGStopMode
(void )
Function description
Disable the Debug Module during STOP mode.
Return values
None
Reference Manual to
LL API cross
reference:
DBGMCU_CR DBG_STOP
LL_DBGMCU_DisableDBGStopMode
DocID026525 Rev 6
UM1785
LL SYSTEM Generic Driver
LL_DBGMCU_EnableDBGStandbyMode
Function name
__STATIC_INLINE void
LL_DBGMCU_EnableDBGStandbyMode (void )
Function description
Enable the Debug Module during STANDBY mode.
Return values
None
Reference Manual to
LL API cross
reference:
DBGMCU_CR DBG_STANDBY
LL_DBGMCU_EnableDBGStandbyMode
LL_DBGMCU_DisableDBGStandbyMode
Function name
__STATIC_INLINE void
LL_DBGMCU_DisableDBGStandbyMode (void )
Function description
Disable the Debug Module during STANDBY mode.
Return values
None
Reference Manual to
LL API cross
reference:
DBGMCU_CR DBG_STANDBY
LL_DBGMCU_DisableDBGStandbyMode
LL_DBGMCU_APB1_GRP1_FreezePeriph
Function name
__STATIC_INLINE void
LL_DBGMCU_APB1_GRP1_FreezePeriph (uint32_t Periphs)
Function description
Freeze APB1 peripherals (group1 peripherals)
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices
LL_DBGMCU_APB1_GRP1_TIM2_STOP (*)
LL_DBGMCU_APB1_GRP1_TIM3_STOP
LL_DBGMCU_APB1_GRP1_TIM6_STOP (*)
LL_DBGMCU_APB1_GRP1_TIM7_STOP (*)
LL_DBGMCU_APB1_GRP1_TIM14_STOP
LL_DBGMCU_APB1_GRP1_RTC_STOP
LL_DBGMCU_APB1_GRP1_WWDG_STOP
LL_DBGMCU_APB1_GRP1_IWDG_STOP
LL_DBGMCU_APB1_GRP1_I2C1_STOP
LL_DBGMCU_APB1_GRP1_CAN_STOP (*)
Return values
None
Reference Manual to
LL API cross
reference:
DBGMCU_APB1FZ DBG_TIM2_STOP
LL_DBGMCU_APB1_GRP1_FreezePeriph
DBGMCU_APB1FZ DBG_TIM3_STOP
LL_DBGMCU_APB1_GRP1_FreezePeriph
DBGMCU_APB1FZ DBG_TIM6_STOP
LL_DBGMCU_APB1_GRP1_FreezePeriph
DBGMCU_APB1FZ DBG_TIM7_STOP
LL_DBGMCU_APB1_GRP1_FreezePeriph
DBGMCU_APB1FZ DBG_TIM14_STOP
LL_DBGMCU_APB1_GRP1_FreezePeriph
DBGMCU_APB1FZ DBG_RTC_STOP
DocID026525 Rev 6
1073/1320
LL SYSTEM Generic Driver
UM1785
LL_DBGMCU_APB1_GRP1_FreezePeriph
DBGMCU_APB1FZ DBG_WWDG_STOP
LL_DBGMCU_APB1_GRP1_FreezePeriph
DBGMCU_APB1FZ DBG_IWDG_STOP
LL_DBGMCU_APB1_GRP1_FreezePeriph
DBGMCU_APB1FZ DBG_I2C1_SMBUS_TIMEOUT
LL_DBGMCU_APB1_GRP1_FreezePeriph
DBGMCU_APB1FZ DBG_CAN_STOP
LL_DBGMCU_APB1_GRP1_FreezePeriph
LL_DBGMCU_APB1_GRP1_UnFreezePeriph
1074/1320
Function name
__STATIC_INLINE void
LL_DBGMCU_APB1_GRP1_UnFreezePeriph (uint32_t
Periphs)
Function description
Unfreeze APB1 peripherals (group1 peripherals)
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices
LL_DBGMCU_APB1_GRP1_TIM2_STOP (*)
LL_DBGMCU_APB1_GRP1_TIM3_STOP
LL_DBGMCU_APB1_GRP1_TIM6_STOP (*)
LL_DBGMCU_APB1_GRP1_TIM7_STOP (*)
LL_DBGMCU_APB1_GRP1_TIM14_STOP
LL_DBGMCU_APB1_GRP1_RTC_STOP
LL_DBGMCU_APB1_GRP1_WWDG_STOP
LL_DBGMCU_APB1_GRP1_IWDG_STOP
LL_DBGMCU_APB1_GRP1_I2C1_STOP
LL_DBGMCU_APB1_GRP1_CAN_STOP (*)
Return values
None
Reference Manual to
LL API cross
reference:
DBGMCU_APB1FZ DBG_TIM2_STOP
LL_DBGMCU_APB1_GRP1_UnFreezePeriph
DBGMCU_APB1FZ DBG_TIM3_STOP
LL_DBGMCU_APB1_GRP1_UnFreezePeriph
DBGMCU_APB1FZ DBG_TIM6_STOP
LL_DBGMCU_APB1_GRP1_UnFreezePeriph
DBGMCU_APB1FZ DBG_TIM7_STOP
LL_DBGMCU_APB1_GRP1_UnFreezePeriph
DBGMCU_APB1FZ DBG_TIM14_STOP
LL_DBGMCU_APB1_GRP1_UnFreezePeriph
DBGMCU_APB1FZ DBG_RTC_STOP
LL_DBGMCU_APB1_GRP1_UnFreezePeriph
DBGMCU_APB1FZ DBG_WWDG_STOP
LL_DBGMCU_APB1_GRP1_UnFreezePeriph
DBGMCU_APB1FZ DBG_IWDG_STOP
LL_DBGMCU_APB1_GRP1_UnFreezePeriph
DBGMCU_APB1FZ DBG_I2C1_SMBUS_TIMEOUT
LL_DBGMCU_APB1_GRP1_UnFreezePeriph
DBGMCU_APB1FZ DBG_CAN_STOP
LL_DBGMCU_APB1_GRP1_UnFreezePeriph
DocID026525 Rev 6
UM1785
LL SYSTEM Generic Driver
LL_DBGMCU_APB1_GRP2_FreezePeriph
Function name
__STATIC_INLINE void
LL_DBGMCU_APB1_GRP2_FreezePeriph (uint32_t Periphs)
Function description
Freeze APB1 peripherals (group2 peripherals)
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices
LL_DBGMCU_APB1_GRP2_TIM1_STOP
LL_DBGMCU_APB1_GRP2_TIM15_STOP (*)
LL_DBGMCU_APB1_GRP2_TIM16_STOP
LL_DBGMCU_APB1_GRP2_TIM17_STOP
Return values
None
Reference Manual to
LL API cross
reference:
DBGMCU_APB2FZ DBG_TIM1_STOP
LL_DBGMCU_APB1_GRP2_FreezePeriph
DBGMCU_APB2FZ DBG_TIM15_STOP
LL_DBGMCU_APB1_GRP2_FreezePeriph
DBGMCU_APB2FZ DBG_TIM16_STOP
LL_DBGMCU_APB1_GRP2_FreezePeriph
DBGMCU_APB2FZ DBG_TIM17_STOP
LL_DBGMCU_APB1_GRP2_FreezePeriph
LL_DBGMCU_APB1_GRP2_UnFreezePeriph
Function name
__STATIC_INLINE void
LL_DBGMCU_APB1_GRP2_UnFreezePeriph (uint32_t
Periphs)
Function description
Unfreeze APB1 peripherals (group2 peripherals)
Parameters
Periphs: This parameter can be a combination of the
following values: (*) value not defined in all devices
LL_DBGMCU_APB1_GRP2_TIM1_STOP
LL_DBGMCU_APB1_GRP2_TIM15_STOP (*)
LL_DBGMCU_APB1_GRP2_TIM16_STOP
LL_DBGMCU_APB1_GRP2_TIM17_STOP
Return values
None
Reference Manual to
LL API cross
reference:
DBGMCU_APB2FZ DBG_TIM1_STOP
LL_DBGMCU_APB1_GRP2_UnFreezePeriph
DBGMCU_APB2FZ DBG_TIM15_STOP
LL_DBGMCU_APB1_GRP2_UnFreezePeriph
DBGMCU_APB2FZ DBG_TIM16_STOP
LL_DBGMCU_APB1_GRP2_UnFreezePeriph
DBGMCU_APB2FZ DBG_TIM17_STOP
LL_DBGMCU_APB1_GRP2_UnFreezePeriph
LL_FLASH_SetLatency
Function name
__STATIC_INLINE void LL_FLASH_SetLatency (uint32_t
Latency)
Function description
Set FLASH Latency.
Parameters
Latency: This parameter can be one of the following values:
DocID026525 Rev 6
1075/1320
LL SYSTEM Generic Driver
UM1785
LL_FLASH_LATENCY_0
LL_FLASH_LATENCY_1
Return values
None
Reference Manual to
LL API cross
reference:
FLASH_ACR LATENCY LL_FLASH_SetLatency
LL_FLASH_GetLatency
Function name
__STATIC_INLINE uint32_t LL_FLASH_GetLatency (void )
Function description
Get FLASH Latency.
Return values
Returned: value can be one of the following values:
LL_FLASH_LATENCY_0
LL_FLASH_LATENCY_1
Reference Manual to
LL API cross
reference:
FLASH_ACR LATENCY LL_FLASH_GetLatency
LL_FLASH_EnablePrefetch
Function name
__STATIC_INLINE void LL_FLASH_EnablePrefetch (void )
Function description
Enable Prefetch.
Return values
None
Reference Manual to
LL API cross
reference:
FLASH_ACR PRFTBE LL_FLASH_EnablePrefetch
LL_FLASH_DisablePrefetch
Function name
__STATIC_INLINE void LL_FLASH_DisablePrefetch (void )
Function description
Disable Prefetch.
Return values
None
Reference Manual to
LL API cross
reference:
FLASH_ACR PRFTBE LL_FLASH_DisablePrefetch
LL_FLASH_IsPrefetchEnabled
1076/1320
Function name
__STATIC_INLINE uint32_t LL_FLASH_IsPrefetchEnabled
(void )
Function description
Check if Prefetch buffer is enabled.
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
FLASH_ACR PRFTBS LL_FLASH_IsPrefetchEnabled
DocID026525 Rev 6
UM1785
LL SYSTEM Generic Driver
66.2
SYSTEM Firmware driver defines
66.2.1
SYSTEM
GRP2_STOP_IP DBGMCU APB1 GRP2 STOP IP
LL_DBGMCU_APB1_GRP2_TIM1_STOP
TIM1 counter stopped when core is halted
LL_DBGMCU_APB1_GRP2_TIM15_STOP
TIM15 counter stopped when core is halted
LL_DBGMCU_APB1_GRP2_TIM16_STOP
TIM16 counter stopped when core is halted
LL_DBGMCU_APB1_GRP2_TIM17_STOP
TIM17 counter stopped when core is halted
DBGMCU APB1 GRP1 STOP IP
LL_DBGMCU_APB1_GRP1_TIM2_STOP
TIM2 counter stopped when core is halted
LL_DBGMCU_APB1_GRP1_TIM3_STOP
TIM3 counter stopped when core is halted
LL_DBGMCU_APB1_GRP1_TIM6_STOP
TIM6 counter stopped when core is halted
LL_DBGMCU_APB1_GRP1_TIM7_STOP
TIM7 counter stopped when core is halted
LL_DBGMCU_APB1_GRP1_TIM14_STOP
TIM14 counter stopped when core is halted
LL_DBGMCU_APB1_GRP1_RTC_STOP
RTC Calendar frozen when core is halted
LL_DBGMCU_APB1_GRP1_WWDG_STOP
Debug Window Watchdog stopped when
Core is halted
LL_DBGMCU_APB1_GRP1_IWDG_STOP
Debug Independent Watchdog stopped
when Core is halted
LL_DBGMCU_APB1_GRP1_I2C1_STOP
I2C1 SMBUS timeout mode stopped when
Core is halted
LL_DBGMCU_APB1_GRP1_CAN_STOP
CAN debug stopped when Core is halted
SYSCFG EXTI LINE
LL_SYSCFG_EXTI_LINE0
EXTI_POSITION_0 | EXTICR[0]
LL_SYSCFG_EXTI_LINE1
EXTI_POSITION_4 | EXTICR[0]
LL_SYSCFG_EXTI_LINE2
EXTI_POSITION_8 | EXTICR[0]
LL_SYSCFG_EXTI_LINE3
EXTI_POSITION_12 | EXTICR[0]
LL_SYSCFG_EXTI_LINE4
EXTI_POSITION_0 | EXTICR[1]
LL_SYSCFG_EXTI_LINE5
EXTI_POSITION_4 | EXTICR[1]
LL_SYSCFG_EXTI_LINE6
EXTI_POSITION_8 | EXTICR[1]
LL_SYSCFG_EXTI_LINE7
EXTI_POSITION_12 | EXTICR[1]
LL_SYSCFG_EXTI_LINE8
EXTI_POSITION_0 | EXTICR[2]
LL_SYSCFG_EXTI_LINE9
EXTI_POSITION_4 | EXTICR[2]
LL_SYSCFG_EXTI_LINE10
EXTI_POSITION_8 | EXTICR[2]
LL_SYSCFG_EXTI_LINE11
EXTI_POSITION_12 | EXTICR[2]
LL_SYSCFG_EXTI_LINE12
EXTI_POSITION_0 | EXTICR[3]
LL_SYSCFG_EXTI_LINE13
EXTI_POSITION_4 | EXTICR[3]
LL_SYSCFG_EXTI_LINE14
EXTI_POSITION_8 | EXTICR[3]
DocID026525 Rev 6
1077/1320
LL SYSTEM Generic Driver
LL_SYSCFG_EXTI_LINE15
UM1785
EXTI_POSITION_12 | EXTICR[3]
SYSCFG EXTI PORT
LL_SYSCFG_EXTI_PORTA
EXTI PORT A
LL_SYSCFG_EXTI_PORTB
EXTI PORT B
LL_SYSCFG_EXTI_PORTC
EXTI PORT C
LL_SYSCFG_EXTI_PORTD
EXTI PORT D
LL_SYSCFG_EXTI_PORTE
EXTI PORT E
LL_SYSCFG_EXTI_PORTF
EXTI PORT F
SYSCFG I2C FASTMODEPLUS
LL_SYSCFG_I2C_FASTMODEPLUS_PB6
I2C PB6 Fast mode plus
LL_SYSCFG_I2C_FASTMODEPLUS_PB7
I2C PB7 Fast mode plus
LL_SYSCFG_I2C_FASTMODEPLUS_PB8
I2C PB8 Fast mode plus
LL_SYSCFG_I2C_FASTMODEPLUS_PB9
I2C PB9 Fast mode plus
LL_SYSCFG_I2C_FASTMODEPLUS_I2C1
Enable Fast Mode Plus on PB10, PB11,
PF6 and PF7
LL_SYSCFG_I2C_FASTMODEPLUS_I2C2
Enable I2C2 Fast mode plus
LL_SYSCFG_I2C_FASTMODEPLUS_PA9
Enable Fast Mode Plus on PA9
LL_SYSCFG_I2C_FASTMODEPLUS_PA10
Enable Fast Mode Plus on PA10
SYSCFG IR Modulation
LL_SYSCFG_IR_MOD_TIM16
Timer16 is selected as IR Modulation enveloppe
source
LL_SYSCFG_IR_MOD_USART1
USART1 is selected as IR Modulation enveloppe
source
LL_SYSCFG_IR_MOD_USART4
USART4 is selected as IR Modulation enveloppe
source
FLASH LATENCY
LL_FLASH_LATENCY_0
FLASH Zero Latency cycle
LL_FLASH_LATENCY_1
FLASH One Latency cycle
SYSCFG Remap
1078/1320
LL_SYSCFG_REMAP_FLASH
Main Flash memory mapped at 0x00000000
LL_SYSCFG_REMAP_SYSTEMFLASH
System Flash memory mapped at 0x00000000
LL_SYSCFG_REMAP_SRAM
Embedded SRAM mapped at 0x00000000
DocID026525 Rev 6
UM1785
LL SYSTEM Generic Driver
SYSCFG TIMER BREAK
LL_SYSCFG_TIMBREAK_PVD
Enables and locks the PVD connection with
TIM1/15/16U/17 Break Input and also the
PVDE and PLS bits of the Power Control
Interface
LL_SYSCFG_TIMBREAK_SRAM_PARITY
Enables and locks the SRAM_PARITY error
signal with Break Input of TIM1/15/16/17
LL_SYSCFG_TIMBREAK_LOCKUP
Enables and locks the LOCKUP (Hardfault)
output of CortexM0 with Break Input of
TIM1/15/16/17
DocID026525 Rev 6
1079/1320
LL TIM Generic Driver
UM1785
67
LL TIM Generic Driver
67.1
TIM Firmware driver registers structures
67.1.1
LL_TIM_InitTypeDef
Data Fields
uint16_t Prescaler
uint32_t CounterMode
uint32_t Autoreload
uint32_t ClockDivision
uint8_t RepetitionCounter
Field Documentation
uint16_t LL_TIM_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.This feature can be
modified afterwards using unitary function LL_TIM_SetPrescaler().
uint32_t LL_TIM_InitTypeDef::CounterMode
Specifies the counter mode. This parameter can be a value of
TIM_LL_EC_COUNTERMODE.This feature can be modified afterwards using unitary
function LL_TIM_SetCounterMode().
uint32_t LL_TIM_InitTypeDef::Autoreload
Specifies the auto reload value to be loaded into the active Auto-Reload Register at
the next update event. This parameter must be a number between Min_Data=0x0000
and Max_Data=0xFFFF. Some timer instances may support 32 bits counters. In that
case this parameter must be a number between 0x0000 and 0xFFFFFFFF.This
feature can be modified afterwards using unitary function LL_TIM_SetAutoReload().
uint32_t LL_TIM_InitTypeDef::ClockDivision
Specifies the clock division. This parameter can be a value of
TIM_LL_EC_CLOCKDIVISION.This feature can be modified afterwards using unitary
function LL_TIM_SetClockDivision().
uint8_t LL_TIM_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 0x00 and 0xFF. This feature can be modified afterwards
using unitary function LL_TIM_SetRepetitionCounter().
67.1.2
LL_TIM_OC_InitTypeDef
Data Fields
uint32_t OCMode
uint32_t OCState
uint32_t OCNState
uint32_t CompareValue
uint32_t OCPolarity
uint32_t OCNPolarity
uint32_t OCIdleState
uint32_t OCNIdleState
1080/1320
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
Field Documentation
uint32_t LL_TIM_OC_InitTypeDef::OCMode
Specifies the output mode. This parameter can be a value of
TIM_LL_EC_OCMODE.This feature can be modified afterwards using unitary function
LL_TIM_OC_SetMode().
uint32_t LL_TIM_OC_InitTypeDef::OCState
Specifies the TIM Output Compare state. This parameter can be a value of
TIM_LL_EC_OCSTATE.This feature can be modified afterwards using unitary
functions LL_TIM_CC_EnableChannel() or LL_TIM_CC_DisableChannel().
uint32_t LL_TIM_OC_InitTypeDef::OCNState
Specifies the TIM complementary Output Compare state. This parameter can be a
value of TIM_LL_EC_OCSTATE.This feature can be modified afterwards using
unitary functions LL_TIM_CC_EnableChannel() or LL_TIM_CC_DisableChannel().
uint32_t LL_TIM_OC_InitTypeDef::CompareValue
Specifies the Compare value to be loaded into the Capture Compare Register. This
parameter can be a number between Min_Data=0x0000 and Max_Data=0xFFFF.This
feature can be modified afterwards using unitary function
LL_TIM_OC_SetCompareCHx (x=1..6).
uint32_t LL_TIM_OC_InitTypeDef::OCPolarity
Specifies the output polarity. This parameter can be a value of
TIM_LL_EC_OCPOLARITY.This feature can be modified afterwards using unitary
function LL_TIM_OC_SetPolarity().
uint32_t LL_TIM_OC_InitTypeDef::OCNPolarity
Specifies the complementary output polarity. This parameter can be a value of
TIM_LL_EC_OCPOLARITY.This feature can be modified afterwards using unitary
function LL_TIM_OC_SetPolarity().
uint32_t LL_TIM_OC_InitTypeDef::OCIdleState
Specifies the TIM Output Compare pin state during Idle state. This parameter can be a
value of TIM_LL_EC_OCIDLESTATE.This feature can be modified afterwards using
unitary function LL_TIM_OC_SetIdleState().
uint32_t LL_TIM_OC_InitTypeDef::OCNIdleState
Specifies the TIM Output Compare pin state during Idle state. This parameter can be a
value of TIM_LL_EC_OCIDLESTATE.This feature can be modified afterwards using
unitary function LL_TIM_OC_SetIdleState().
67.1.3
LL_TIM_IC_InitTypeDef
Data Fields
uint32_t ICPolarity
uint32_t ICActiveInput
uint32_t ICPrescaler
uint32_t ICFilter
Field Documentation
uint32_t LL_TIM_IC_InitTypeDef::ICPolarity
Specifies the active edge of the input signal. This parameter can be a value of
TIM_LL_EC_IC_POLARITY.This feature can be modified afterwards using unitary
function LL_TIM_IC_SetPolarity().
uint32_t LL_TIM_IC_InitTypeDef::ICActiveInput
Specifies the input. This parameter can be a value of
TIM_LL_EC_ACTIVEINPUT.This feature can be modified afterwards using unitary
function LL_TIM_IC_SetActiveInput().
uint32_t LL_TIM_IC_InitTypeDef::ICPrescaler
Specifies the Input Capture Prescaler. This parameter can be a value of
DocID026525 Rev 6
1081/1320
LL TIM Generic Driver
UM1785
TIM_LL_EC_ICPSC.This feature can be modified afterwards using unitary function
LL_TIM_IC_SetPrescaler().
uint32_t LL_TIM_IC_InitTypeDef::ICFilter
Specifies the input capture filter. This parameter can be a value of
TIM_LL_EC_IC_FILTER.This feature can be modified afterwards using unitary
function LL_TIM_IC_SetFilter().
67.1.4
LL_TIM_ENCODER_InitTypeDef
Data Fields
uint32_t EncoderMode
uint32_t IC1Polarity
uint32_t IC1ActiveInput
uint32_t IC1Prescaler
uint32_t IC1Filter
uint32_t IC2Polarity
uint32_t IC2ActiveInput
uint32_t IC2Prescaler
uint32_t IC2Filter
Field Documentation
uint32_t LL_TIM_ENCODER_InitTypeDef::EncoderMode
Specifies the encoder resolution (x2 or x4). This parameter can be a value of
TIM_LL_EC_ENCODERMODE.This feature can be modified afterwards using unitary
function LL_TIM_SetEncoderMode().
uint32_t LL_TIM_ENCODER_InitTypeDef::IC1Polarity
Specifies the active edge of TI1 input. This parameter can be a value of
TIM_LL_EC_IC_POLARITY.This feature can be modified afterwards using unitary
function LL_TIM_IC_SetPolarity().
uint32_t LL_TIM_ENCODER_InitTypeDef::IC1ActiveInput
Specifies the TI1 input source This parameter can be a value of
TIM_LL_EC_ACTIVEINPUT.This feature can be modified afterwards using unitary
function LL_TIM_IC_SetActiveInput().
uint32_t LL_TIM_ENCODER_InitTypeDef::IC1Prescaler
Specifies the TI1 input prescaler value. This parameter can be a value of
TIM_LL_EC_ICPSC.This feature can be modified afterwards using unitary function
LL_TIM_IC_SetPrescaler().
uint32_t LL_TIM_ENCODER_InitTypeDef::IC1Filter
Specifies the TI1 input filter. This parameter can be a value of
TIM_LL_EC_IC_FILTER.This feature can be modified afterwards using unitary
function LL_TIM_IC_SetFilter().
uint32_t LL_TIM_ENCODER_InitTypeDef::IC2Polarity
Specifies the active edge of TI2 input. This parameter can be a value of
TIM_LL_EC_IC_POLARITY.This feature can be modified afterwards using unitary
function LL_TIM_IC_SetPolarity().
uint32_t LL_TIM_ENCODER_InitTypeDef::IC2ActiveInput
Specifies the TI2 input source This parameter can be a value of
TIM_LL_EC_ACTIVEINPUT.This feature can be modified afterwards using unitary
function LL_TIM_IC_SetActiveInput().
uint32_t LL_TIM_ENCODER_InitTypeDef::IC2Prescaler
Specifies the TI2 input prescaler value. This parameter can be a value of
TIM_LL_EC_ICPSC.This feature can be modified afterwards using unitary function
LL_TIM_IC_SetPrescaler().
1082/1320
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
uint32_t LL_TIM_ENCODER_InitTypeDef::IC2Filter
Specifies the TI2 input filter. This parameter can be a value of
TIM_LL_EC_IC_FILTER.This feature can be modified afterwards using unitary
function LL_TIM_IC_SetFilter().
67.1.5
LL_TIM_HALLSENSOR_InitTypeDef
Data Fields
uint32_t IC1Polarity
uint32_t IC1Prescaler
uint32_t IC1Filter
uint32_t CommutationDelay
Field Documentation
uint32_t LL_TIM_HALLSENSOR_InitTypeDef::IC1Polarity
Specifies the active edge of TI1 input. This parameter can be a value of
TIM_LL_EC_IC_POLARITY.This feature can be modified afterwards using unitary
function LL_TIM_IC_SetPolarity().
uint32_t LL_TIM_HALLSENSOR_InitTypeDef::IC1Prescaler
Specifies the TI1 input prescaler value. Prescaler must be set to get a maximum
counter period longer than the time interval between 2 consecutive changes on the
Hall inputs. This parameter can be a value of TIM_LL_EC_ICPSC.This feature can be
modified afterwards using unitary function LL_TIM_IC_SetPrescaler().
uint32_t LL_TIM_HALLSENSOR_InitTypeDef::IC1Filter
Specifies the TI1 input filter. This parameter can be a value of
TIM_LL_EC_IC_FILTER.This feature can be modified afterwards using unitary
function LL_TIM_IC_SetFilter().
uint32_t LL_TIM_HALLSENSOR_InitTypeDef::CommutationDelay
Specifies the compare value to be loaded into the Capture Compare Register. A
positive pulse (TRGO event) is generated with a programmable delay every time a
change occurs on the Hall inputs. This parameter can be a number between Min_Data
= 0x0000 and Max_Data = 0xFFFF.This feature can be modified afterwards using
unitary function LL_TIM_OC_SetCompareCH2().
67.1.6
LL_TIM_BDTR_InitTypeDef
Data Fields
uint32_t OSSRState
uint32_t OSSIState
uint32_t LockLevel
uint8_t DeadTime
uint16_t BreakState
uint32_t BreakPolarity
uint32_t AutomaticOutput
Field Documentation
uint32_t LL_TIM_BDTR_InitTypeDef::OSSRState
Specifies the Off-State selection used in Run mode. This parameter can be a value of
TIM_LL_EC_OSSRThis feature can be modified afterwards using unitary function
LL_TIM_SetOffStates()
Note:This bit-field cannot be modified as long as LOCK level 2 has been
programmed.
uint32_t LL_TIM_BDTR_InitTypeDef::OSSIState
Specifies the Off-State used in Idle state. This parameter can be a value of
DocID026525 Rev 6
1083/1320
LL TIM Generic Driver
UM1785
TIM_LL_EC_OSSIThis feature can be modified afterwards using unitary function
LL_TIM_SetOffStates()
Note:This bit-field cannot be modified as long as LOCK level 2 has been
programmed.
uint32_t LL_TIM_BDTR_InitTypeDef::LockLevel
Specifies the LOCK level parameters. This parameter can be a value of
TIM_LL_EC_LOCKLEVEL
Note:The LOCK bits can be written only once after the reset. Once the TIMx_BDTR
register has been written, their content is frozen until the next reset.
uint8_t LL_TIM_BDTR_InitTypeDef::DeadTime
Specifies the delay time between the switching-off and the switching-on of the outputs.
This parameter can be a number between Min_Data = 0x00 and Max_Data =
0xFF.This feature can be modified afterwards using unitary function
LL_TIM_OC_SetDeadTime()
Note:This bit-field can not be modified as long as LOCK level 1, 2 or 3 has been
programmed.
uint16_t LL_TIM_BDTR_InitTypeDef::BreakState
Specifies whether the TIM Break input is enabled or not. This parameter can be a
value of TIM_LL_EC_BREAK_ENABLEThis feature can be modified afterwards using
unitary functions LL_TIM_EnableBRK() or LL_TIM_DisableBRK()
Note:This bit-field can not be modified as long as LOCK level 1 has been
programmed.
uint32_t LL_TIM_BDTR_InitTypeDef::BreakPolarity
Specifies the TIM Break Input pin polarity. This parameter can be a value of
TIM_LL_EC_BREAK_POLARITYThis feature can be modified afterwards using
unitary function LL_TIM_ConfigBRK()
Note:This bit-field can not be modified as long as LOCK level 1 has been
programmed.
uint32_t LL_TIM_BDTR_InitTypeDef::AutomaticOutput
Specifies whether the TIM Automatic Output feature is enabled or not. This parameter
can be a value of TIM_LL_EC_AUTOMATICOUTPUT_ENABLEThis feature can be
modified afterwards using unitary functions LL_TIM_EnableAutomaticOutput() or
LL_TIM_DisableAutomaticOutput()
Note:This bit-field can not be modified as long as LOCK level 1 has been
programmed.
67.2
TIM Firmware driver API description
67.2.1
Detailed description of functions
LL_TIM_EnableCounter
1084/1320
Function name
__STATIC_INLINE void LL_TIM_EnableCounter (TIM_TypeDef
* TIMx)
Function description
Enable timer counter.
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 CEN LL_TIM_EnableCounter
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_DisableCounter
Function name
__STATIC_INLINE void LL_TIM_DisableCounter (TIM_TypeDef
* TIMx)
Function description
Disable timer counter.
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 CEN LL_TIM_DisableCounter
LL_TIM_IsEnabledCounter
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledCounter
(TIM_TypeDef * TIMx)
Function description
Indicates whether the timer counter is enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 CEN LL_TIM_IsEnabledCounter
LL_TIM_EnableUpdateEvent
Function name
__STATIC_INLINE void LL_TIM_EnableUpdateEvent
(TIM_TypeDef * TIMx)
Function description
Enable update event generation.
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 UDIS LL_TIM_EnableUpdateEvent
LL_TIM_DisableUpdateEvent
Function name
__STATIC_INLINE void LL_TIM_DisableUpdateEvent
(TIM_TypeDef * TIMx)
Function description
Disable update event generation.
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 UDIS LL_TIM_DisableUpdateEvent
DocID026525 Rev 6
1085/1320
LL TIM Generic Driver
UM1785
LL_TIM_IsEnabledUpdateEvent
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledUpdateEvent
(TIM_TypeDef * TIMx)
Function description
Indicates whether update event generation is enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 UDIS LL_TIM_IsEnabledUpdateEvent
LL_TIM_SetUpdateSource
Function name
__STATIC_INLINE void LL_TIM_SetUpdateSource
(TIM_TypeDef * TIMx, uint32_t UpdateSource)
Function description
Set update event source.
Parameters
TIMx: Timer instance
UpdateSource: This parameter can be one of the following
values:
LL_TIM_UPDATESOURCE_REGULAR
LL_TIM_UPDATESOURCE_COUNTER
Return values
None
Notes
Update event source set to
LL_TIM_UPDATESOURCE_REGULAR: any of the following
events generate an update interrupt or DMA request if
enabled: Counter overflow/underflowSetting the UG bitUpdate
generation through the slave mode controller
Update event source set to
LL_TIM_UPDATESOURCE_COUNTER: only counter
overflow/underflow generates an update interrupt or DMA
request if enabled.
Reference Manual to
LL API cross
reference:
CR1 URS LL_TIM_SetUpdateSource
LL_TIM_GetUpdateSource
1086/1320
Function name
__STATIC_INLINE uint32_t LL_TIM_GetUpdateSource
(TIM_TypeDef * TIMx)
Function description
Get actual event update source.
Parameters
TIMx: Timer instance
Return values
Returned: value can be one of the following values:
LL_TIM_UPDATESOURCE_REGULAR
LL_TIM_UPDATESOURCE_COUNTER
Reference Manual to
LL API cross
reference:
CR1 URS LL_TIM_GetUpdateSource
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_SetOnePulseMode
Function name
__STATIC_INLINE void LL_TIM_SetOnePulseMode
(TIM_TypeDef * TIMx, uint32_t OnePulseMode)
Function description
Set one pulse mode (one shot v.s.
Parameters
TIMx: Timer instance
OnePulseMode: This parameter can be one of the following
values:
LL_TIM_ONEPULSEMODE_SINGLE
LL_TIM_ONEPULSEMODE_REPETITIVE
Return values
None
Reference Manual to
LL API cross
reference:
CR1 OPM LL_TIM_SetOnePulseMode
LL_TIM_GetOnePulseMode
Function name
__STATIC_INLINE uint32_t LL_TIM_GetOnePulseMode
(TIM_TypeDef * TIMx)
Function description
Get actual one pulse mode.
Parameters
TIMx: Timer instance
Return values
Returned: value can be one of the following values:
LL_TIM_ONEPULSEMODE_SINGLE
LL_TIM_ONEPULSEMODE_REPETITIVE
Reference Manual to
LL API cross
reference:
CR1 OPM LL_TIM_GetOnePulseMode
LL_TIM_SetCounterMode
Function name
__STATIC_INLINE void LL_TIM_SetCounterMode
(TIM_TypeDef * TIMx, uint32_t CounterMode)
Function description
Set the timer counter counting mode.
Parameters
TIMx: Timer instance
CounterMode: This parameter can be one of the following
values:
LL_TIM_COUNTERMODE_UP
LL_TIM_COUNTERMODE_DOWN
LL_TIM_COUNTERMODE_CENTER_UP
LL_TIM_COUNTERMODE_CENTER_DOWN
LL_TIM_COUNTERMODE_CENTER_UP_DOWN
Return values
None
Notes
Macro
IS_TIM_COUNTER_MODE_SELECT_INSTANCE(TIMx) can
be used to check whether or not the counter mode selection
feature is supported by a timer instance.
Reference Manual to
LL API cross
CR1 DIR LL_TIM_SetCounterMode
DocID026525 Rev 6
1087/1320
LL TIM Generic Driver
reference:
UM1785
CR1 CMS LL_TIM_SetCounterMode
LL_TIM_GetCounterMode
Function name
__STATIC_INLINE uint32_t LL_TIM_GetCounterMode
(TIM_TypeDef * TIMx)
Function description
Get actual counter mode.
Parameters
TIMx: Timer instance
Return values
Returned: value can be one of the following values:
LL_TIM_COUNTERMODE_UP
LL_TIM_COUNTERMODE_DOWN
LL_TIM_COUNTERMODE_CENTER_UP
LL_TIM_COUNTERMODE_CENTER_DOWN
LL_TIM_COUNTERMODE_CENTER_UP_DOWN
Notes
Macro
IS_TIM_COUNTER_MODE_SELECT_INSTANCE(TIMx) can
be used to check whether or not the counter mode selection
feature is supported by a timer instance.
Reference Manual to
LL API cross
reference:
CR1 DIR LL_TIM_GetCounterMode
CR1 CMS LL_TIM_GetCounterMode
LL_TIM_EnableARRPreload
Function name
__STATIC_INLINE void LL_TIM_EnableARRPreload
(TIM_TypeDef * TIMx)
Function description
Enable auto-reload (ARR) preload.
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 ARPE LL_TIM_EnableARRPreload
LL_TIM_DisableARRPreload
1088/1320
Function name
__STATIC_INLINE void LL_TIM_DisableARRPreload
(TIM_TypeDef * TIMx)
Function description
Disable auto-reload (ARR) preload.
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 ARPE LL_TIM_DisableARRPreload
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_IsEnabledARRPreload
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledARRPreload
(TIM_TypeDef * TIMx)
Function description
Indicates whether auto-reload (ARR) preload is enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 ARPE LL_TIM_IsEnabledARRPreload
LL_TIM_SetClockDivision
Function name
__STATIC_INLINE void LL_TIM_SetClockDivision
(TIM_TypeDef * TIMx, uint32_t ClockDivision)
Function description
Set the division ratio between the timer clock and the sampling
clock used by the dead-time generators (when supported) and the
digital filters.
Parameters
TIMx: Timer instance
ClockDivision: This parameter can be one of the following
values:
LL_TIM_CLOCKDIVISION_DIV1
LL_TIM_CLOCKDIVISION_DIV2
LL_TIM_CLOCKDIVISION_DIV4
Return values
None
Notes
Macro IS_TIM_CLOCK_DIVISION_INSTANCE(TIMx) can be
used to check whether or not the clock division feature is
supported by the timer instance.
Reference Manual to
LL API cross
reference:
CR1 CKD LL_TIM_SetClockDivision
LL_TIM_GetClockDivision
Function name
__STATIC_INLINE uint32_t LL_TIM_GetClockDivision
(TIM_TypeDef * TIMx)
Function description
Get the actual division ratio between the timer clock and the
sampling clock used by the dead-time generators (when
supported) and the digital filters.
Parameters
TIMx: Timer instance
Return values
Returned: value can be one of the following values:
LL_TIM_CLOCKDIVISION_DIV1
LL_TIM_CLOCKDIVISION_DIV2
LL_TIM_CLOCKDIVISION_DIV4
Notes
Macro IS_TIM_CLOCK_DIVISION_INSTANCE(TIMx) can be
used to check whether or not the clock division feature is
supported by the timer instance.
DocID026525 Rev 6
1089/1320
LL TIM Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
CR1 CKD LL_TIM_GetClockDivision
LL_TIM_SetCounter
Function name
__STATIC_INLINE void LL_TIM_SetCounter (TIM_TypeDef *
TIMx, uint32_t Counter)
Function description
Set the counter value.
Parameters
TIMx: Timer instance
Counter: Counter value (between Min_Data=0 and
Max_Data=0xFFFF or 0xFFFFFFFF)
Return values
None
Notes
Macro IS_TIM_32B_COUNTER_INSTANCE(TIMx) can be
used to check whether or not a timer instance supports a 32
bits counter.
Reference Manual to
LL API cross
reference:
CNT CNT LL_TIM_SetCounter
LL_TIM_GetCounter
1090/1320
Function name
__STATIC_INLINE uint32_t LL_TIM_GetCounter (TIM_TypeDef
* TIMx)
Function description
Get the counter value.
Parameters
TIMx: Timer instance
Return values
Counter: value (between Min_Data=0 and
Max_Data=0xFFFF or 0xFFFFFFFF)
Notes
Macro IS_TIM_32B_COUNTER_INSTANCE(TIMx) can be
used to check whether or not a timer instance supports a 32
bits counter.
Reference Manual to
LL API cross
reference:
CNT CNT LL_TIM_GetCounter
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_GetDirection
Function name
__STATIC_INLINE uint32_t LL_TIM_GetDirection
(TIM_TypeDef * TIMx)
Function description
Get the current direction of the counter.
Parameters
TIMx: Timer instance
Return values
Returned: value can be one of the following values:
LL_TIM_COUNTERDIRECTION_UP
LL_TIM_COUNTERDIRECTION_DOWN
Reference Manual to
LL API cross
reference:
CR1 DIR LL_TIM_GetDirection
LL_TIM_SetPrescaler
Function name
__STATIC_INLINE void LL_TIM_SetPrescaler (TIM_TypeDef *
TIMx, uint32_t Prescaler)
Function description
Set the prescaler value.
Parameters
TIMx: Timer instance
Prescaler: between Min_Data=0 and Max_Data=65535
Return values
None
Notes
The counter clock frequency CK_CNT is equal to fCK_PSC /
(PSC[15:0] + 1).
The prescaler can be changed on the fly as this control
register is buffered. The new prescaler ratio is taken into
account at the next update event.
Helper macro __LL_TIM_CALC_PSC can be used to
calculate the Prescaler parameter
Reference Manual to
LL API cross
reference:
PSC PSC LL_TIM_SetPrescaler
LL_TIM_GetPrescaler
Function name
__STATIC_INLINE uint32_t LL_TIM_GetPrescaler
(TIM_TypeDef * TIMx)
Function description
Get the prescaler value.
Parameters
TIMx: Timer instance
Return values
Prescaler: value between Min_Data=0 and
Max_Data=65535
Reference Manual to
LL API cross
reference:
PSC PSC LL_TIM_GetPrescaler
DocID026525 Rev 6
1091/1320
LL TIM Generic Driver
UM1785
LL_TIM_SetAutoReload
Function name
__STATIC_INLINE void LL_TIM_SetAutoReload (TIM_TypeDef
* TIMx, uint32_t AutoReload)
Function description
Set the auto-reload value.
Parameters
TIMx: Timer instance
AutoReload: between Min_Data=0 and Max_Data=65535
Return values
None
Notes
The counter is blocked while the auto-reload value is null.
Macro IS_TIM_32B_COUNTER_INSTANCE(TIMx) can be
used to check whether or not a timer instance supports a 32
bits counter.
Helper macro __LL_TIM_CALC_ARR can be used to
calculate the AutoReload parameter
Reference Manual to
LL API cross
reference:
ARR ARR LL_TIM_SetAutoReload
LL_TIM_GetAutoReload
1092/1320
Function name
__STATIC_INLINE uint32_t LL_TIM_GetAutoReload
(TIM_TypeDef * TIMx)
Function description
Get the auto-reload value.
Parameters
TIMx: Timer instance
Return values
Auto-reload: value
Notes
Macro IS_TIM_32B_COUNTER_INSTANCE(TIMx) can be
used to check whether or not a timer instance supports a 32
bits counter.
Reference Manual to
LL API cross
reference:
ARR ARR LL_TIM_GetAutoReload
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_SetRepetitionCounter
Function name
__STATIC_INLINE void LL_TIM_SetRepetitionCounter
(TIM_TypeDef * TIMx, uint32_t RepetitionCounter)
Function description
Set the repetition counter value.
Parameters
TIMx: Timer instance
RepetitionCounter: between Min_Data=0 and
Max_Data=255
Return values
None
Notes
Macro IS_TIM_REPETITION_COUNTER_INSTANCE(TIMx)
can be used to check whether or not a timer instance
supports a repetition counter.
Reference Manual to
LL API cross
reference:
RCR REP LL_TIM_SetRepetitionCounter
LL_TIM_GetRepetitionCounter
Function name
__STATIC_INLINE uint32_t LL_TIM_GetRepetitionCounter
(TIM_TypeDef * TIMx)
Function description
Get the repetition counter value.
Parameters
TIMx: Timer instance
Return values
Repetition: counter value
Notes
Macro IS_TIM_REPETITION_COUNTER_INSTANCE(TIMx)
can be used to check whether or not a timer instance
supports a repetition counter.
Reference Manual to
LL API cross
reference:
RCR REP LL_TIM_GetRepetitionCounter
DocID026525 Rev 6
1093/1320
LL TIM Generic Driver
UM1785
LL_TIM_CC_EnablePreload
Function name
__STATIC_INLINE void LL_TIM_CC_EnablePreload
(TIM_TypeDef * TIMx)
Function description
Enable the capture/compare control bits (CCxE, CCxNE and
OCxM) preload.
Parameters
TIMx: Timer instance
Return values
None
Notes
CCxE, CCxNE and OCxM bits are preloaded, after having
been written, they are updated only when a commutation
event (COM) occurs.
Only on channels that have a complementary output.
Macro IS_TIM_COMMUTATION_EVENT_INSTANCE(TIMx)
can be used to check whether or not a timer instance is able
to generate a commutation event.
Reference Manual to
LL API cross
reference:
CR2 CCPC LL_TIM_CC_EnablePreload
LL_TIM_CC_DisablePreload
Function name
__STATIC_INLINE void LL_TIM_CC_DisablePreload
(TIM_TypeDef * TIMx)
Function description
Disable the capture/compare control bits (CCxE, CCxNE and
OCxM) preload.
Parameters
TIMx: Timer instance
Return values
None
Notes
Macro IS_TIM_COMMUTATION_EVENT_INSTANCE(TIMx)
can be used to check whether or not a timer instance is able
to generate a commutation event.
Reference Manual to
LL API cross
reference:
CR2 CCPC LL_TIM_CC_DisablePreload
LL_TIM_CC_SetUpdate
1094/1320
Function name
__STATIC_INLINE void LL_TIM_CC_SetUpdate (TIM_TypeDef
* TIMx, uint32_t CCUpdateSource)
Function description
Set the updated source of the capture/compare control bits (CCxE,
CCxNE and OCxM).
Parameters
TIMx: Timer instance
CCUpdateSource: This parameter can be one of the
following values:
LL_TIM_CCUPDATESOURCE_COMG_ONLY
LL_TIM_CCUPDATESOURCE_COMG_AND_TRGI
Return values
None
Notes
Macro IS_TIM_COMMUTATION_EVENT_INSTANCE(TIMx)
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
can be used to check whether or not a timer instance is able
to generate a commutation event.
Reference Manual to
LL API cross
reference:
CR2 CCUS LL_TIM_CC_SetUpdate
LL_TIM_CC_SetDMAReqTrigger
Function name
__STATIC_INLINE void LL_TIM_CC_SetDMAReqTrigger
(TIM_TypeDef * TIMx, uint32_t DMAReqTrigger)
Function description
Set the trigger of the capture/compare DMA request.
Parameters
TIMx: Timer instance
DMAReqTrigger: This parameter can be one of the following
values:
LL_TIM_CCDMAREQUEST_CC
LL_TIM_CCDMAREQUEST_UPDATE
Return values
None
Reference Manual to
LL API cross
reference:
CR2 CCDS LL_TIM_CC_SetDMAReqTrigger
LL_TIM_CC_GetDMAReqTrigger
Function name
__STATIC_INLINE uint32_t LL_TIM_CC_GetDMAReqTrigger
(TIM_TypeDef * TIMx)
Function description
Get actual trigger of the capture/compare DMA request.
Parameters
TIMx: Timer instance
Return values
Returned: value can be one of the following values:
LL_TIM_CCDMAREQUEST_CC
LL_TIM_CCDMAREQUEST_UPDATE
Reference Manual to
LL API cross
reference:
CR2 CCDS LL_TIM_CC_GetDMAReqTrigger
LL_TIM_CC_SetLockLevel
Function name
__STATIC_INLINE void LL_TIM_CC_SetLockLevel
(TIM_TypeDef * TIMx, uint32_t LockLevel)
Function description
Set the lock level to freeze the configuration of several
capture/compare parameters.
Parameters
TIMx: Timer instance
LockLevel: This parameter can be one of the following
values:
LL_TIM_LOCKLEVEL_OFF
LL_TIM_LOCKLEVEL_1
LL_TIM_LOCKLEVEL_2
LL_TIM_LOCKLEVEL_3
DocID026525 Rev 6
1095/1320
LL TIM Generic Driver
Return values
UM1785
None
Notes
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to
check whether or not the lock mechanism is supported by a
timer instance.
Reference Manual to
LL API cross
reference:
BDTR LOCK LL_TIM_CC_SetLockLevel
LL_TIM_CC_EnableChannel
Function name
__STATIC_INLINE void LL_TIM_CC_EnableChannel
(TIM_TypeDef * TIMx, uint32_t Channels)
Function description
Enable capture/compare channels.
Parameters
TIMx: Timer instance
Channels: This parameter can be a combination of the
following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH1N
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH2N
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH3N
LL_TIM_CHANNEL_CH4
Return values
None
Reference Manual to
LL API cross
reference:
CCER CC1E LL_TIM_CC_EnableChannel
CCER CC1NE LL_TIM_CC_EnableChannel
CCER CC2E LL_TIM_CC_EnableChannel
CCER CC2NE LL_TIM_CC_EnableChannel
CCER CC3E LL_TIM_CC_EnableChannel
CCER CC3NE LL_TIM_CC_EnableChannel
CCER CC4E LL_TIM_CC_EnableChannel
LL_TIM_CC_DisableChannel
1096/1320
Function name
__STATIC_INLINE void LL_TIM_CC_DisableChannel
(TIM_TypeDef * TIMx, uint32_t Channels)
Function description
Disable capture/compare channels.
Parameters
TIMx: Timer instance
Channels: This parameter can be a combination of the
following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH1N
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH2N
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH3N
LL_TIM_CHANNEL_CH4
Return values
None
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
Reference Manual to
LL API cross
reference:
CCER CC1E LL_TIM_CC_DisableChannel
CCER CC1NE LL_TIM_CC_DisableChannel
CCER CC2E LL_TIM_CC_DisableChannel
CCER CC2NE LL_TIM_CC_DisableChannel
CCER CC3E LL_TIM_CC_DisableChannel
CCER CC3NE LL_TIM_CC_DisableChannel
CCER CC4E LL_TIM_CC_DisableChannel
LL_TIM_CC_IsEnabledChannel
Function name
__STATIC_INLINE uint32_t LL_TIM_CC_IsEnabledChannel
(TIM_TypeDef * TIMx, uint32_t Channels)
Function description
Indicate whether channel(s) is(are) enabled.
Parameters
TIMx: Timer instance
Channels: This parameter can be a combination of the
following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH1N
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH2N
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH3N
LL_TIM_CHANNEL_CH4
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CCER CC1E LL_TIM_CC_IsEnabledChannel
CCER CC1NE LL_TIM_CC_IsEnabledChannel
CCER CC2E LL_TIM_CC_IsEnabledChannel
CCER CC2NE LL_TIM_CC_IsEnabledChannel
CCER CC3E LL_TIM_CC_IsEnabledChannel
CCER CC3NE LL_TIM_CC_IsEnabledChannel
CCER CC4E LL_TIM_CC_IsEnabledChannel
LL_TIM_OC_ConfigOutput
Function name
__STATIC_INLINE void LL_TIM_OC_ConfigOutput
(TIM_TypeDef * TIMx, uint32_t Channel, uint32_t
Configuration)
Function description
Configure an output channel.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
Configuration: This parameter must be a combination of all
the following values:
LL_TIM_OCPOLARITY_HIGH or
LL_TIM_OCPOLARITY_LOW
LL_TIM_OCIDLESTATE_LOW or
DocID026525 Rev 6
1097/1320
LL TIM Generic Driver
UM1785
LL_TIM_OCIDLESTATE_HIGH
Return values
None
Reference Manual to
LL API cross
reference:
CCMR1 CC1S LL_TIM_OC_ConfigOutput
CCMR1 CC2S LL_TIM_OC_ConfigOutput
CCMR2 CC3S LL_TIM_OC_ConfigOutput
CCMR2 CC4S LL_TIM_OC_ConfigOutput
CCER CC1P LL_TIM_OC_ConfigOutput
CCER CC2P LL_TIM_OC_ConfigOutput
CCER CC3P LL_TIM_OC_ConfigOutput
CCER CC4P LL_TIM_OC_ConfigOutput
CR2 OIS1 LL_TIM_OC_ConfigOutput
CR2 OIS2 LL_TIM_OC_ConfigOutput
CR2 OIS3 LL_TIM_OC_ConfigOutput
CR2 OIS4 LL_TIM_OC_ConfigOutput
LL_TIM_OC_SetMode
Function name
__STATIC_INLINE void LL_TIM_OC_SetMode (TIM_TypeDef *
TIMx, uint32_t Channel, uint32_t Mode)
Function description
Define the behavior of the output reference signal OCxREF from
which OCx and OCxN (when relevant) are derived.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
Mode: This parameter can be one of the following values:
LL_TIM_OCMODE_FROZEN
LL_TIM_OCMODE_ACTIVE
LL_TIM_OCMODE_INACTIVE
LL_TIM_OCMODE_TOGGLE
LL_TIM_OCMODE_FORCED_INACTIVE
LL_TIM_OCMODE_FORCED_ACTIVE
LL_TIM_OCMODE_PWM1
LL_TIM_OCMODE_PWM2
Return values
None
Reference Manual to
LL API cross
reference:
CCMR1 OC1M LL_TIM_OC_SetMode
CCMR1 OC2M LL_TIM_OC_SetMode
CCMR2 OC3M LL_TIM_OC_SetMode
CCMR2 OC4M LL_TIM_OC_SetMode
LL_TIM_OC_GetMode
Function name
__STATIC_INLINE uint32_t LL_TIM_OC_GetMode
(TIM_TypeDef * TIMx, uint32_t Channel)
Function description
Get the output compare mode of an output channel.
Parameters
1098/1320
TIMx: Timer instance
Channel: This parameter can be one of the following values:
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
Return values
Returned: value can be one of the following values:
LL_TIM_OCMODE_FROZEN
LL_TIM_OCMODE_ACTIVE
LL_TIM_OCMODE_INACTIVE
LL_TIM_OCMODE_TOGGLE
LL_TIM_OCMODE_FORCED_INACTIVE
LL_TIM_OCMODE_FORCED_ACTIVE
LL_TIM_OCMODE_PWM1
LL_TIM_OCMODE_PWM2
Reference Manual to
LL API cross
reference:
CCMR1 OC1M LL_TIM_OC_GetMode
CCMR1 OC2M LL_TIM_OC_GetMode
CCMR2 OC3M LL_TIM_OC_GetMode
CCMR2 OC4M LL_TIM_OC_GetMode
LL_TIM_OC_SetPolarity
Function name
__STATIC_INLINE void LL_TIM_OC_SetPolarity (TIM_TypeDef
* TIMx, uint32_t Channel, uint32_t Polarity)
Function description
Set the polarity of an output channel.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH1N
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH2N
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH3N
LL_TIM_CHANNEL_CH4
Polarity: This parameter can be one of the following values:
LL_TIM_OCPOLARITY_HIGH
LL_TIM_OCPOLARITY_LOW
Return values
None
Reference Manual to
LL API cross
reference:
CCER CC1P LL_TIM_OC_SetPolarity
CCER CC1NP LL_TIM_OC_SetPolarity
CCER CC2P LL_TIM_OC_SetPolarity
CCER CC2NP LL_TIM_OC_SetPolarity
CCER CC3P LL_TIM_OC_SetPolarity
CCER CC3NP LL_TIM_OC_SetPolarity
CCER CC4P LL_TIM_OC_SetPolarity
LL_TIM_OC_GetPolarity
Function name
__STATIC_INLINE uint32_t LL_TIM_OC_GetPolarity
(TIM_TypeDef * TIMx, uint32_t Channel)
Function description
Get the polarity of an output channel.
DocID026525 Rev 6
1099/1320
LL TIM Generic Driver
Parameters
UM1785
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH1N
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH2N
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH3N
LL_TIM_CHANNEL_CH4
Return values
Returned: value can be one of the following values:
LL_TIM_OCPOLARITY_HIGH
LL_TIM_OCPOLARITY_LOW
Reference Manual to
LL API cross
reference:
CCER CC1P LL_TIM_OC_GetPolarity
CCER CC1NP LL_TIM_OC_GetPolarity
CCER CC2P LL_TIM_OC_GetPolarity
CCER CC2NP LL_TIM_OC_GetPolarity
CCER CC3P LL_TIM_OC_GetPolarity
CCER CC3NP LL_TIM_OC_GetPolarity
CCER CC4P LL_TIM_OC_GetPolarity
LL_TIM_OC_SetIdleState
1100/1320
Function name
__STATIC_INLINE void LL_TIM_OC_SetIdleState
(TIM_TypeDef * TIMx, uint32_t Channel, uint32_t IdleState)
Function description
Set the IDLE state of an output channel.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH1N
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH2N
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH3N
LL_TIM_CHANNEL_CH4
IdleState: This parameter can be one of the following values:
LL_TIM_OCIDLESTATE_LOW
LL_TIM_OCIDLESTATE_HIGH
Return values
None
Notes
This function is significant only for the timer instances
supporting the break feature. Macro
IS_TIM_BREAK_INSTANCE(TIMx) can be used to check
whether or not a timer instance provides a break input.
Reference Manual to
LL API cross
reference:
CR2 OIS1 LL_TIM_OC_SetIdleState
CR2 OIS1N LL_TIM_OC_SetIdleState
CR2 OIS2 LL_TIM_OC_SetIdleState
CR2 OIS2N LL_TIM_OC_SetIdleState
CR2 OIS3 LL_TIM_OC_SetIdleState
CR2 OIS3N LL_TIM_OC_SetIdleState
CR2 OIS4 LL_TIM_OC_SetIdleState
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_OC_GetIdleState
Function name
__STATIC_INLINE uint32_t LL_TIM_OC_GetIdleState
(TIM_TypeDef * TIMx, uint32_t Channel)
Function description
Get the IDLE state of an output channel.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH1N
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH2N
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH3N
LL_TIM_CHANNEL_CH4
Return values
Returned: value can be one of the following values:
LL_TIM_OCIDLESTATE_LOW
LL_TIM_OCIDLESTATE_HIGH
Reference Manual to
LL API cross
reference:
CR2 OIS1 LL_TIM_OC_GetIdleState
CR2 OIS1N LL_TIM_OC_GetIdleState
CR2 OIS2 LL_TIM_OC_GetIdleState
CR2 OIS2N LL_TIM_OC_GetIdleState
CR2 OIS3 LL_TIM_OC_GetIdleState
CR2 OIS3N LL_TIM_OC_GetIdleState
CR2 OIS4 LL_TIM_OC_GetIdleState
LL_TIM_OC_EnableFast
Function name
__STATIC_INLINE void LL_TIM_OC_EnableFast (TIM_TypeDef
* TIMx, uint32_t Channel)
Function description
Enable fast mode for the output channel.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
Return values
None
Notes
Acts only if the channel is configured in PWM1 or PWM2
mode.
Reference Manual to
LL API cross
reference:
CCMR1 OC1FE LL_TIM_OC_EnableFast
CCMR1 OC2FE LL_TIM_OC_EnableFast
CCMR2 OC3FE LL_TIM_OC_EnableFast
CCMR2 OC4FE LL_TIM_OC_EnableFast
DocID026525 Rev 6
1101/1320
LL TIM Generic Driver
UM1785
LL_TIM_OC_DisableFast
Function name
__STATIC_INLINE void LL_TIM_OC_DisableFast
(TIM_TypeDef * TIMx, uint32_t Channel)
Function description
Disable fast mode for the output channel.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
Return values
None
Reference Manual to
LL API cross
reference:
CCMR1 OC1FE LL_TIM_OC_DisableFast
CCMR1 OC2FE LL_TIM_OC_DisableFast
CCMR2 OC3FE LL_TIM_OC_DisableFast
CCMR2 OC4FE LL_TIM_OC_DisableFast
LL_TIM_OC_IsEnabledFast
Function name
__STATIC_INLINE uint32_t LL_TIM_OC_IsEnabledFast
(TIM_TypeDef * TIMx, uint32_t Channel)
Function description
Indicates whether fast mode is enabled for the output channel.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CCMR1 OC1FE LL_TIM_OC_IsEnabledFast
CCMR1 OC2FE LL_TIM_OC_IsEnabledFast
CCMR2 OC3FE LL_TIM_OC_IsEnabledFast
CCMR2 OC4FE LL_TIM_OC_IsEnabledFast
LL_TIM_OC_EnablePreload
Function name
__STATIC_INLINE void LL_TIM_OC_EnablePreload
(TIM_TypeDef * TIMx, uint32_t Channel)
Function description
Enable compare register (TIMx_CCRx) preload for the output
channel.
Parameters
1102/1320
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
Return values
None
Reference Manual to
LL API cross
reference:
CCMR1 OC1PE LL_TIM_OC_EnablePreload
CCMR1 OC2PE LL_TIM_OC_EnablePreload
CCMR2 OC3PE LL_TIM_OC_EnablePreload
CCMR2 OC4PE LL_TIM_OC_EnablePreload
LL_TIM_OC_DisablePreload
Function name
__STATIC_INLINE void LL_TIM_OC_DisablePreload
(TIM_TypeDef * TIMx, uint32_t Channel)
Function description
Disable compare register (TIMx_CCRx) preload for the output
channel.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
Return values
None
Reference Manual to
LL API cross
reference:
CCMR1 OC1PE LL_TIM_OC_DisablePreload
CCMR1 OC2PE LL_TIM_OC_DisablePreload
CCMR2 OC3PE LL_TIM_OC_DisablePreload
CCMR2 OC4PE LL_TIM_OC_DisablePreload
LL_TIM_OC_IsEnabledPreload
Function name
__STATIC_INLINE uint32_t LL_TIM_OC_IsEnabledPreload
(TIM_TypeDef * TIMx, uint32_t Channel)
Function description
Indicates whether compare register (TIMx_CCRx) preload is
enabled for the output channel.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CCMR1 OC1PE LL_TIM_OC_IsEnabledPreload
CCMR1 OC2PE LL_TIM_OC_IsEnabledPreload
CCMR2 OC3PE LL_TIM_OC_IsEnabledPreload
CCMR2 OC4PE LL_TIM_OC_IsEnabledPreload
DocID026525 Rev 6
1103/1320
LL TIM Generic Driver
UM1785
LL_TIM_OC_EnableClear
Function name
__STATIC_INLINE void LL_TIM_OC_EnableClear
(TIM_TypeDef * TIMx, uint32_t Channel)
Function description
Enable clearing the output channel on an external event.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
Return values
None
Notes
This function can only be used in Output compare and PWM
modes. It does not work in Forced mode.
Macro IS_TIM_OCXREF_CLEAR_INSTANCE(TIMx) can be
used to check whether or not a timer instance can clear the
OCxREF signal on an external event.
Reference Manual to
LL API cross
reference:
CCMR1 OC1CE LL_TIM_OC_EnableClear
CCMR1 OC2CE LL_TIM_OC_EnableClear
CCMR2 OC3CE LL_TIM_OC_EnableClear
CCMR2 OC4CE LL_TIM_OC_EnableClear
LL_TIM_OC_DisableClear
Function name
__STATIC_INLINE void LL_TIM_OC_DisableClear
(TIM_TypeDef * TIMx, uint32_t Channel)
Function description
Disable clearing the output channel on an external event.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
Return values
None
Notes
Macro IS_TIM_OCXREF_CLEAR_INSTANCE(TIMx) can be
used to check whether or not a timer instance can clear the
OCxREF signal on an external event.
Reference Manual to
LL API cross
reference:
CCMR1 OC1CE LL_TIM_OC_DisableClear
CCMR1 OC2CE LL_TIM_OC_DisableClear
CCMR2 OC3CE LL_TIM_OC_DisableClear
CCMR2 OC4CE LL_TIM_OC_DisableClear
LL_TIM_OC_IsEnabledClear
1104/1320
Function name
__STATIC_INLINE uint32_t LL_TIM_OC_IsEnabledClear
(TIM_TypeDef * TIMx, uint32_t Channel)
Function description
Indicates clearing the output channel on an external event is
enabled for the output channel.
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
Return values
State: of bit (1 or 0).
Notes
This function enables clearing the output channel on an
external event.
This function can only be used in Output compare and PWM
modes. It does not work in Forced mode.
Macro IS_TIM_OCXREF_CLEAR_INSTANCE(TIMx) can be
used to check whether or not a timer instance can clear the
OCxREF signal on an external event.
Reference Manual to
LL API cross
reference:
CCMR1 OC1CE LL_TIM_OC_IsEnabledClear
CCMR1 OC2CE LL_TIM_OC_IsEnabledClear
CCMR2 OC3CE LL_TIM_OC_IsEnabledClear
CCMR2 OC4CE LL_TIM_OC_IsEnabledClear
LL_TIM_OC_SetDeadTime
Function name
__STATIC_INLINE void LL_TIM_OC_SetDeadTime
(TIM_TypeDef * TIMx, uint32_t DeadTime)
Function description
Set the dead-time delay (delay inserted between the rising edge of
the OCxREF signal and the rising edge if the Ocx and OCxN
signals).
Parameters
TIMx: Timer instance
DeadTime: between Min_Data=0 and Max_Data=255
Return values
None
Notes
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to
check whether or not dead-time insertion feature is supported
by a timer instance.
Helper macro __LL_TIM_CALC_DEADTIME can be used to
calculate the DeadTime parameter
Reference Manual to
LL API cross
reference:
BDTR DTG LL_TIM_OC_SetDeadTime
LL_TIM_OC_SetCompareCH1
Function name
__STATIC_INLINE void LL_TIM_OC_SetCompareCH1
(TIM_TypeDef * TIMx, uint32_t CompareValue)
Function description
Set compare value for output channel 1 (TIMx_CCR1).
Parameters
TIMx: Timer instance
CompareValue: between Min_Data=0 and
Max_Data=65535
DocID026525 Rev 6
1105/1320
LL TIM Generic Driver
Return values
UM1785
None
Notes
In 32-bit timer implementations compare value can be
between 0x00000000 and 0xFFFFFFFF.
Macro IS_TIM_32B_COUNTER_INSTANCE(TIMx) can be
used to check whether or not a timer instance supports a 32
bits counter.
Macro IS_TIM_CC1_INSTANCE(TIMx) can be used to check
whether or not output channel 1 is supported by a timer
instance.
Reference Manual to
LL API cross
reference:
CCR1 CCR1 LL_TIM_OC_SetCompareCH1
LL_TIM_OC_SetCompareCH2
Function name
__STATIC_INLINE void LL_TIM_OC_SetCompareCH2
(TIM_TypeDef * TIMx, uint32_t CompareValue)
Function description
Set compare value for output channel 2 (TIMx_CCR2).
Parameters
TIMx: Timer instance
CompareValue: between Min_Data=0 and
Max_Data=65535
Return values
None
Notes
In 32-bit timer implementations compare value can be
between 0x00000000 and 0xFFFFFFFF.
Macro IS_TIM_32B_COUNTER_INSTANCE(TIMx) can be
used to check whether or not a timer instance supports a 32
bits counter.
Macro IS_TIM_CC2_INSTANCE(TIMx) can be used to check
whether or not output channel 2 is supported by a timer
instance.
Reference Manual to
LL API cross
reference:
CCR2 CCR2 LL_TIM_OC_SetCompareCH2
LL_TIM_OC_SetCompareCH3
1106/1320
Function name
__STATIC_INLINE void LL_TIM_OC_SetCompareCH3
(TIM_TypeDef * TIMx, uint32_t CompareValue)
Function description
Set compare value for output channel 3 (TIMx_CCR3).
Parameters
TIMx: Timer instance
CompareValue: between Min_Data=0 and
Max_Data=65535
Return values
None
Notes
In 32-bit timer implementations compare value can be
between 0x00000000 and 0xFFFFFFFF.
Macro IS_TIM_32B_COUNTER_INSTANCE(TIMx) can be
used to check whether or not a timer instance supports a 32
bits counter.
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
Macro IS_TIM_CC3_INSTANCE(TIMx) can be used to check
whether or not output channel is supported by a timer
instance.
Reference Manual to
LL API cross
reference:
CCR3 CCR3 LL_TIM_OC_SetCompareCH3
LL_TIM_OC_SetCompareCH4
Function name
__STATIC_INLINE void LL_TIM_OC_SetCompareCH4
(TIM_TypeDef * TIMx, uint32_t CompareValue)
Function description
Set compare value for output channel 4 (TIMx_CCR4).
Parameters
TIMx: Timer instance
CompareValue: between Min_Data=0 and
Max_Data=65535
Return values
None
Notes
In 32-bit timer implementations compare value can be
between 0x00000000 and 0xFFFFFFFF.
Macro IS_TIM_32B_COUNTER_INSTANCE(TIMx) can be
used to check whether or not a timer instance supports a 32
bits counter.
Macro IS_TIM_CC4_INSTANCE(TIMx) can be used to check
whether or not output channel 4 is supported by a timer
instance.
Reference Manual to
LL API cross
reference:
CCR4 CCR4 LL_TIM_OC_SetCompareCH4
LL_TIM_OC_GetCompareCH1
Function name
__STATIC_INLINE uint32_t LL_TIM_OC_GetCompareCH1
(TIM_TypeDef * TIMx)
Function description
Get compare value (TIMx_CCR1) set for output channel 1.
Parameters
TIMx: Timer instance
Return values
CompareValue: (between Min_Data=0 and
Max_Data=65535)
Notes
In 32-bit timer implementations returned compare value can
be between 0x00000000 and 0xFFFFFFFF.
Macro IS_TIM_32B_COUNTER_INSTANCE(TIMx) can be
used to check whether or not a timer instance supports a 32
bits counter.
Macro IS_TIM_CC1_INSTANCE(TIMx) can be used to check
whether or not output channel 1 is supported by a timer
instance.
Reference Manual to
LL API cross
reference:
CCR1 CCR1 LL_TIM_OC_GetCompareCH1
DocID026525 Rev 6
1107/1320
LL TIM Generic Driver
UM1785
LL_TIM_OC_GetCompareCH2
Function name
__STATIC_INLINE uint32_t LL_TIM_OC_GetCompareCH2
(TIM_TypeDef * TIMx)
Function description
Get compare value (TIMx_CCR2) set for output channel 2.
Parameters
TIMx: Timer instance
Return values
CompareValue: (between Min_Data=0 and
Max_Data=65535)
Notes
In 32-bit timer implementations returned compare value can
be between 0x00000000 and 0xFFFFFFFF.
Macro IS_TIM_32B_COUNTER_INSTANCE(TIMx) can be
used to check whether or not a timer instance supports a 32
bits counter.
Macro IS_TIM_CC2_INSTANCE(TIMx) can be used to check
whether or not output channel 2 is supported by a timer
instance.
Reference Manual to
LL API cross
reference:
CCR2 CCR2 LL_TIM_OC_GetCompareCH2
LL_TIM_OC_GetCompareCH3
Function name
__STATIC_INLINE uint32_t LL_TIM_OC_GetCompareCH3
(TIM_TypeDef * TIMx)
Function description
Get compare value (TIMx_CCR3) set for output channel 3.
Parameters
TIMx: Timer instance
Return values
CompareValue: (between Min_Data=0 and
Max_Data=65535)
Notes
In 32-bit timer implementations returned compare value can
be between 0x00000000 and 0xFFFFFFFF.
Macro IS_TIM_32B_COUNTER_INSTANCE(TIMx) can be
used to check whether or not a timer instance supports a 32
bits counter.
Macro IS_TIM_CC3_INSTANCE(TIMx) can be used to check
whether or not output channel 3 is supported by a timer
instance.
Reference Manual to
LL API cross
reference:
CCR3 CCR3 LL_TIM_OC_GetCompareCH3
LL_TIM_OC_GetCompareCH4
1108/1320
Function name
__STATIC_INLINE uint32_t LL_TIM_OC_GetCompareCH4
(TIM_TypeDef * TIMx)
Function description
Get compare value (TIMx_CCR4) set for output channel 4.
Parameters
TIMx: Timer instance
Return values
CompareValue: (between Min_Data=0 and
Max_Data=65535)
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
Notes
In 32-bit timer implementations returned compare value can
be between 0x00000000 and 0xFFFFFFFF.
Macro IS_TIM_32B_COUNTER_INSTANCE(TIMx) can be
used to check whether or not a timer instance supports a 32
bits counter.
Macro IS_TIM_CC4_INSTANCE(TIMx) can be used to check
whether or not output channel 4 is supported by a timer
instance.
Reference Manual to
LL API cross
reference:
CCR4 CCR4 LL_TIM_OC_GetCompareCH4
LL_TIM_IC_Config
Function name
__STATIC_INLINE void LL_TIM_IC_Config (TIM_TypeDef *
TIMx, uint32_t Channel, uint32_t Configuration)
Function description
Configure input channel.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
Configuration: This parameter must be a combination of all
the following values:
LL_TIM_ACTIVEINPUT_DIRECTTI or
LL_TIM_ACTIVEINPUT_INDIRECTTI or
LL_TIM_ACTIVEINPUT_TRC
LL_TIM_ICPSC_DIV1 or ... or LL_TIM_ICPSC_DIV8
LL_TIM_IC_FILTER_FDIV1 or ... or
LL_TIM_IC_FILTER_FDIV32_N8
LL_TIM_IC_POLARITY_RISING or
LL_TIM_IC_POLARITY_FALLING or
LL_TIM_IC_POLARITY_BOTHEDGE
Return values
None
Reference Manual to
LL API cross
reference:
CCMR1 CC1S LL_TIM_IC_Config
CCMR1 IC1PSC LL_TIM_IC_Config
CCMR1 IC1F LL_TIM_IC_Config
CCMR1 CC2S LL_TIM_IC_Config
CCMR1 IC2PSC LL_TIM_IC_Config
CCMR1 IC2F LL_TIM_IC_Config
CCMR2 CC3S LL_TIM_IC_Config
CCMR2 IC3PSC LL_TIM_IC_Config
CCMR2 IC3F LL_TIM_IC_Config
CCMR2 CC4S LL_TIM_IC_Config
CCMR2 IC4PSC LL_TIM_IC_Config
CCMR2 IC4F LL_TIM_IC_Config
CCER CC1P LL_TIM_IC_Config
CCER CC1NP LL_TIM_IC_Config
CCER CC2P LL_TIM_IC_Config
CCER CC2NP LL_TIM_IC_Config
DocID026525 Rev 6
1109/1320
LL TIM Generic Driver
UM1785
CCER CC3P LL_TIM_IC_Config
CCER CC3NP LL_TIM_IC_Config
CCER CC4P LL_TIM_IC_Config
CCER CC4NP LL_TIM_IC_Config
LL_TIM_IC_SetActiveInput
Function name
__STATIC_INLINE void LL_TIM_IC_SetActiveInput
(TIM_TypeDef * TIMx, uint32_t Channel, uint32_t
ICActiveInput)
Function description
Set the active input.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
ICActiveInput: This parameter can be one of the following
values:
LL_TIM_ACTIVEINPUT_DIRECTTI
LL_TIM_ACTIVEINPUT_INDIRECTTI
LL_TIM_ACTIVEINPUT_TRC
Return values
None
Reference Manual to
LL API cross
reference:
CCMR1 CC1S LL_TIM_IC_SetActiveInput
CCMR1 CC2S LL_TIM_IC_SetActiveInput
CCMR2 CC3S LL_TIM_IC_SetActiveInput
CCMR2 CC4S LL_TIM_IC_SetActiveInput
LL_TIM_IC_GetActiveInput
1110/1320
Function name
__STATIC_INLINE uint32_t LL_TIM_IC_GetActiveInput
(TIM_TypeDef * TIMx, uint32_t Channel)
Function description
Get the current active input.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
Return values
Returned: value can be one of the following values:
LL_TIM_ACTIVEINPUT_DIRECTTI
LL_TIM_ACTIVEINPUT_INDIRECTTI
LL_TIM_ACTIVEINPUT_TRC
Reference Manual to
LL API cross
reference:
CCMR1 CC1S LL_TIM_IC_GetActiveInput
CCMR1 CC2S LL_TIM_IC_GetActiveInput
CCMR2 CC3S LL_TIM_IC_GetActiveInput
CCMR2 CC4S LL_TIM_IC_GetActiveInput
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_IC_SetPrescaler
Function name
__STATIC_INLINE void LL_TIM_IC_SetPrescaler
(TIM_TypeDef * TIMx, uint32_t Channel, uint32_t ICPrescaler)
Function description
Set the prescaler of input channel.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
ICPrescaler: This parameter can be one of the following
values:
LL_TIM_ICPSC_DIV1
LL_TIM_ICPSC_DIV2
LL_TIM_ICPSC_DIV4
LL_TIM_ICPSC_DIV8
Return values
None
Reference Manual to
LL API cross
reference:
CCMR1 IC1PSC LL_TIM_IC_SetPrescaler
CCMR1 IC2PSC LL_TIM_IC_SetPrescaler
CCMR2 IC3PSC LL_TIM_IC_SetPrescaler
CCMR2 IC4PSC LL_TIM_IC_SetPrescaler
LL_TIM_IC_GetPrescaler
Function name
__STATIC_INLINE uint32_t LL_TIM_IC_GetPrescaler
(TIM_TypeDef * TIMx, uint32_t Channel)
Function description
Get the current prescaler value acting on an input channel.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
Return values
Returned: value can be one of the following values:
LL_TIM_ICPSC_DIV1
LL_TIM_ICPSC_DIV2
LL_TIM_ICPSC_DIV4
LL_TIM_ICPSC_DIV8
Reference Manual to
LL API cross
reference:
CCMR1 IC1PSC LL_TIM_IC_GetPrescaler
CCMR1 IC2PSC LL_TIM_IC_GetPrescaler
CCMR2 IC3PSC LL_TIM_IC_GetPrescaler
CCMR2 IC4PSC LL_TIM_IC_GetPrescaler
LL_TIM_IC_SetFilter
Function name
__STATIC_INLINE void LL_TIM_IC_SetFilter (TIM_TypeDef *
TIMx, uint32_t Channel, uint32_t ICFilter)
DocID026525 Rev 6
1111/1320
LL TIM Generic Driver
Function description
UM1785
Set the input filter duration.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
ICFilter: This parameter can be one of the following values:
LL_TIM_IC_FILTER_FDIV1
LL_TIM_IC_FILTER_FDIV1_N2
LL_TIM_IC_FILTER_FDIV1_N4
LL_TIM_IC_FILTER_FDIV1_N8
LL_TIM_IC_FILTER_FDIV2_N6
LL_TIM_IC_FILTER_FDIV2_N8
LL_TIM_IC_FILTER_FDIV4_N6
LL_TIM_IC_FILTER_FDIV4_N8
LL_TIM_IC_FILTER_FDIV8_N6
LL_TIM_IC_FILTER_FDIV8_N8
LL_TIM_IC_FILTER_FDIV16_N5
LL_TIM_IC_FILTER_FDIV16_N6
LL_TIM_IC_FILTER_FDIV16_N8
LL_TIM_IC_FILTER_FDIV32_N5
LL_TIM_IC_FILTER_FDIV32_N6
LL_TIM_IC_FILTER_FDIV32_N8
Return values
None
Reference Manual to
LL API cross
reference:
CCMR1 IC1F LL_TIM_IC_SetFilter
CCMR1 IC2F LL_TIM_IC_SetFilter
CCMR2 IC3F LL_TIM_IC_SetFilter
CCMR2 IC4F LL_TIM_IC_SetFilter
LL_TIM_IC_GetFilter
1112/1320
Function name
__STATIC_INLINE uint32_t LL_TIM_IC_GetFilter (TIM_TypeDef
* TIMx, uint32_t Channel)
Function description
Get the input filter duration.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
Return values
Returned: value can be one of the following values:
LL_TIM_IC_FILTER_FDIV1
LL_TIM_IC_FILTER_FDIV1_N2
LL_TIM_IC_FILTER_FDIV1_N4
LL_TIM_IC_FILTER_FDIV1_N8
LL_TIM_IC_FILTER_FDIV2_N6
LL_TIM_IC_FILTER_FDIV2_N8
LL_TIM_IC_FILTER_FDIV4_N6
LL_TIM_IC_FILTER_FDIV4_N8
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_IC_FILTER_FDIV8_N6
LL_TIM_IC_FILTER_FDIV8_N8
LL_TIM_IC_FILTER_FDIV16_N5
LL_TIM_IC_FILTER_FDIV16_N6
LL_TIM_IC_FILTER_FDIV16_N8
LL_TIM_IC_FILTER_FDIV32_N5
LL_TIM_IC_FILTER_FDIV32_N6
LL_TIM_IC_FILTER_FDIV32_N8
Reference Manual to
LL API cross
reference:
CCMR1 IC1F LL_TIM_IC_GetFilter
CCMR1 IC2F LL_TIM_IC_GetFilter
CCMR2 IC3F LL_TIM_IC_GetFilter
CCMR2 IC4F LL_TIM_IC_GetFilter
LL_TIM_IC_SetPolarity
Function name
__STATIC_INLINE void LL_TIM_IC_SetPolarity (TIM_TypeDef *
TIMx, uint32_t Channel, uint32_t ICPolarity)
Function description
Set the input channel polarity.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
ICPolarity: This parameter can be one of the following
values:
LL_TIM_IC_POLARITY_RISING
LL_TIM_IC_POLARITY_FALLING
LL_TIM_IC_POLARITY_BOTHEDGE
Return values
None
Reference Manual to
LL API cross
reference:
CCER CC1P LL_TIM_IC_SetPolarity
CCER CC1NP LL_TIM_IC_SetPolarity
CCER CC2P LL_TIM_IC_SetPolarity
CCER CC2NP LL_TIM_IC_SetPolarity
CCER CC3P LL_TIM_IC_SetPolarity
CCER CC3NP LL_TIM_IC_SetPolarity
CCER CC4P LL_TIM_IC_SetPolarity
CCER CC4NP LL_TIM_IC_SetPolarity
LL_TIM_IC_GetPolarity
Function name
__STATIC_INLINE uint32_t LL_TIM_IC_GetPolarity
(TIM_TypeDef * TIMx, uint32_t Channel)
Function description
Get the current input channel polarity.
Parameters
TIMx: Timer instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
DocID026525 Rev 6
1113/1320
LL TIM Generic Driver
UM1785
LL_TIM_CHANNEL_CH4
Return values
Returned: value can be one of the following values:
LL_TIM_IC_POLARITY_RISING
LL_TIM_IC_POLARITY_FALLING
LL_TIM_IC_POLARITY_BOTHEDGE
Reference Manual to
LL API cross
reference:
CCER CC1P LL_TIM_IC_GetPolarity
CCER CC1NP LL_TIM_IC_GetPolarity
CCER CC2P LL_TIM_IC_GetPolarity
CCER CC2NP LL_TIM_IC_GetPolarity
CCER CC3P LL_TIM_IC_GetPolarity
CCER CC3NP LL_TIM_IC_GetPolarity
CCER CC4P LL_TIM_IC_GetPolarity
CCER CC4NP LL_TIM_IC_GetPolarity
LL_TIM_IC_EnableXORCombination
Function name
__STATIC_INLINE void LL_TIM_IC_EnableXORCombination
(TIM_TypeDef * TIMx)
Function description
Connect the TIMx_CH1, CH2 and CH3 pins to the TI1 input (XOR
combination).
Parameters
TIMx: Timer instance
Return values
None
Notes
Macro IS_TIM_XOR_INSTANCE(TIMx) can be used to check
whether or not a timer instance provides an XOR input.
Reference Manual to
LL API cross
reference:
CR2 TI1S LL_TIM_IC_EnableXORCombination
LL_TIM_IC_DisableXORCombination
Function name
__STATIC_INLINE void LL_TIM_IC_DisableXORCombination
(TIM_TypeDef * TIMx)
Function description
Disconnect the TIMx_CH1, CH2 and CH3 pins from the TI1 input.
Parameters
TIMx: Timer instance
Return values
None
Notes
Macro IS_TIM_XOR_INSTANCE(TIMx) can be used to check
whether or not a timer instance provides an XOR input.
Reference Manual to
LL API cross
reference:
CR2 TI1S LL_TIM_IC_DisableXORCombination
LL_TIM_IC_IsEnabledXORCombination
1114/1320
Function name
__STATIC_INLINE uint32_t
LL_TIM_IC_IsEnabledXORCombination (TIM_TypeDef * TIMx)
Function description
Indicates whether the TIMx_CH1, CH2 and CH3 pins are
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
connectected to the TI1 input.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Notes
Macro IS_TIM_XOR_INSTANCE(TIMx) can be used to check
whether or not a timer instance provides an XOR input.
Reference Manual to
LL API cross
reference:
CR2 TI1S LL_TIM_IC_IsEnabledXORCombination
LL_TIM_IC_GetCaptureCH1
Function name
__STATIC_INLINE uint32_t LL_TIM_IC_GetCaptureCH1
(TIM_TypeDef * TIMx)
Function description
Get captured value for input channel 1.
Parameters
TIMx: Timer instance
Return values
CapturedValue: (between Min_Data=0 and
Max_Data=65535)
Notes
In 32-bit timer implementations returned captured value can
be between 0x00000000 and 0xFFFFFFFF.
Macro IS_TIM_32B_COUNTER_INSTANCE(TIMx) can be
used to check whether or not a timer instance supports a 32
bits counter.
Macro IS_TIM_CC1_INSTANCE(TIMx) can be used to check
whether or not input channel 1 is supported by a timer
instance.
Reference Manual to
LL API cross
reference:
CCR1 CCR1 LL_TIM_IC_GetCaptureCH1
LL_TIM_IC_GetCaptureCH2
Function name
__STATIC_INLINE uint32_t LL_TIM_IC_GetCaptureCH2
(TIM_TypeDef * TIMx)
Function description
Get captured value for input channel 2.
Parameters
TIMx: Timer instance
Return values
CapturedValue: (between Min_Data=0 and
Max_Data=65535)
Notes
In 32-bit timer implementations returned captured value can
be between 0x00000000 and 0xFFFFFFFF.
Macro IS_TIM_32B_COUNTER_INSTANCE(TIMx) can be
used to check whether or not a timer instance supports a 32
bits counter.
Macro IS_TIM_CC2_INSTANCE(TIMx) can be used to check
whether or not input channel 2 is supported by a timer
instance.
Reference Manual to
LL API cross
CCR2 CCR2 LL_TIM_IC_GetCaptureCH2
DocID026525 Rev 6
1115/1320
LL TIM Generic Driver
reference:
UM1785
LL_TIM_IC_GetCaptureCH3
Function name
__STATIC_INLINE uint32_t LL_TIM_IC_GetCaptureCH3
(TIM_TypeDef * TIMx)
Function description
Get captured value for input channel 3.
Parameters
TIMx: Timer instance
Return values
CapturedValue: (between Min_Data=0 and
Max_Data=65535)
Notes
In 32-bit timer implementations returned captured value can
be between 0x00000000 and 0xFFFFFFFF.
Macro IS_TIM_32B_COUNTER_INSTANCE(TIMx) can be
used to check whether or not a timer instance supports a 32
bits counter.
Macro IS_TIM_CC3_INSTANCE(TIMx) can be used to check
whether or not input channel 3 is supported by a timer
instance.
Reference Manual to
LL API cross
reference:
CCR3 CCR3 LL_TIM_IC_GetCaptureCH3
LL_TIM_IC_GetCaptureCH4
Function name
__STATIC_INLINE uint32_t LL_TIM_IC_GetCaptureCH4
(TIM_TypeDef * TIMx)
Function description
Get captured value for input channel 4.
Parameters
TIMx: Timer instance
Return values
CapturedValue: (between Min_Data=0 and
Max_Data=65535)
Notes
In 32-bit timer implementations returned captured value can
be between 0x00000000 and 0xFFFFFFFF.
Macro IS_TIM_32B_COUNTER_INSTANCE(TIMx) can be
used to check whether or not a timer instance supports a 32
bits counter.
Macro IS_TIM_CC4_INSTANCE(TIMx) can be used to check
whether or not input channel 4 is supported by a timer
instance.
Reference Manual to
LL API cross
reference:
CCR4 CCR4 LL_TIM_IC_GetCaptureCH4
LL_TIM_EnableExternalClock
Function name
__STATIC_INLINE void LL_TIM_EnableExternalClock
(TIM_TypeDef * TIMx)
Function description
Enable external clock mode 2.
Parameters
1116/1320
TIMx: Timer instance
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
Return values
None
Notes
When external clock mode 2 is enabled the counter is clocked
by any active edge on the ETRF signal.
Macro
IS_TIM_CLOCKSOURCE_ETRMODE2_INSTANCE(TIMx)
can be used to check whether or not a timer instance
supports external clock mode2.
Reference Manual to
LL API cross
reference:
SMCR ECE LL_TIM_EnableExternalClock
LL_TIM_DisableExternalClock
Function name
__STATIC_INLINE void LL_TIM_DisableExternalClock
(TIM_TypeDef * TIMx)
Function description
Disable external clock mode 2.
Parameters
TIMx: Timer instance
Return values
None
Notes
Macro
IS_TIM_CLOCKSOURCE_ETRMODE2_INSTANCE(TIMx)
can be used to check whether or not a timer instance
supports external clock mode2.
Reference Manual to
LL API cross
reference:
SMCR ECE LL_TIM_DisableExternalClock
LL_TIM_IsEnabledExternalClock
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledExternalClock
(TIM_TypeDef * TIMx)
Function description
Indicate whether external clock mode 2 is enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Notes
Macro
IS_TIM_CLOCKSOURCE_ETRMODE2_INSTANCE(TIMx)
can be used to check whether or not a timer instance
supports external clock mode2.
Reference Manual to
LL API cross
reference:
SMCR ECE LL_TIM_IsEnabledExternalClock
LL_TIM_SetClockSource
Function name
__STATIC_INLINE void LL_TIM_SetClockSource
(TIM_TypeDef * TIMx, uint32_t ClockSource)
Function description
Set the clock source of the counter clock.
Parameters
TIMx: Timer instance
DocID026525 Rev 6
1117/1320
LL TIM Generic Driver
UM1785
ClockSource: This parameter can be one of the following
values:
LL_TIM_CLOCKSOURCE_INTERNAL
LL_TIM_CLOCKSOURCE_EXT_MODE1
LL_TIM_CLOCKSOURCE_EXT_MODE2
Return values
None
Notes
when selected clock source is external clock mode 1, the
timer input the external clock is applied is selected by calling
the LL_TIM_SetTriggerInput() function. This timer input must
be configured by calling the LL_TIM_IC_Config() function.
Macro
IS_TIM_CLOCKSOURCE_ETRMODE1_INSTANCE(TIMx)
can be used to check whether or not a timer instance
supports external clock mode1.
Macro
IS_TIM_CLOCKSOURCE_ETRMODE2_INSTANCE(TIMx)
can be used to check whether or not a timer instance
supports external clock mode2.
Reference Manual to
LL API cross
reference:
SMCR SMS LL_TIM_SetClockSource
SMCR ECE LL_TIM_SetClockSource
LL_TIM_SetEncoderMode
Function name
__STATIC_INLINE void LL_TIM_SetEncoderMode
(TIM_TypeDef * TIMx, uint32_t EncoderMode)
Function description
Set the encoder interface mode.
Parameters
TIMx: Timer instance
EncoderMode: This parameter can be one of the following
values:
LL_TIM_ENCODERMODE_X2_TI1
LL_TIM_ENCODERMODE_X2_TI2
LL_TIM_ENCODERMODE_X4_TI12
Return values
None
Notes
Macro IS_TIM_ENCODER_INTERFACE_INSTANCE(TIMx)
can be used to check whether or not a timer instance
supports the encoder mode.
Reference Manual to
LL API cross
reference:
SMCR SMS LL_TIM_SetEncoderMode
LL_TIM_SetTriggerOutput
Function name
__STATIC_INLINE void LL_TIM_SetTriggerOutput
(TIM_TypeDef * TIMx, uint32_t TimerSynchronization)
Function description
Set the trigger output (TRGO) used for timer synchronization .
Parameters
1118/1320
TIMx: Timer instance
TimerSynchronization: This parameter can be one of the
following values:
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_TRGO_RESET
LL_TIM_TRGO_ENABLE
LL_TIM_TRGO_UPDATE
LL_TIM_TRGO_CC1IF
LL_TIM_TRGO_OC1REF
LL_TIM_TRGO_OC2REF
LL_TIM_TRGO_OC3REF
LL_TIM_TRGO_OC4REF
Return values
None
Notes
Macro IS_TIM_MASTER_INSTANCE(TIMx) can be used to
check whether or not a timer instance can operate as a
master timer.
Reference Manual to
LL API cross
reference:
CR2 MMS LL_TIM_SetTriggerOutput
LL_TIM_SetSlaveMode
Function name
__STATIC_INLINE void LL_TIM_SetSlaveMode (TIM_TypeDef *
TIMx, uint32_t SlaveMode)
Function description
Set the synchronization mode of a slave timer.
Parameters
TIMx: Timer instance
SlaveMode: This parameter can be one of the following
values:
LL_TIM_SLAVEMODE_DISABLED
LL_TIM_SLAVEMODE_RESET
LL_TIM_SLAVEMODE_GATED
LL_TIM_SLAVEMODE_TRIGGER
Return values
None
Notes
Macro IS_TIM_SLAVE_INSTANCE(TIMx) can be used to
check whether or not a timer instance can operate as a slave
timer.
Reference Manual to
LL API cross
reference:
SMCR SMS LL_TIM_SetSlaveMode
LL_TIM_SetTriggerInput
Function name
__STATIC_INLINE void LL_TIM_SetTriggerInput (TIM_TypeDef
* TIMx, uint32_t TriggerInput)
Function description
Set the selects the trigger input to be used to synchronize the
counter.
Parameters
TIMx: Timer instance
TriggerInput: This parameter can be one of the following
values:
LL_TIM_TS_ITR0
LL_TIM_TS_ITR1
LL_TIM_TS_ITR2
DocID026525 Rev 6
1119/1320
LL TIM Generic Driver
UM1785
LL_TIM_TS_ITR3
LL_TIM_TS_TI1F_ED
LL_TIM_TS_TI1FP1
LL_TIM_TS_TI2FP2
LL_TIM_TS_ETRF
Return values
None
Notes
Macro IS_TIM_SLAVE_INSTANCE(TIMx) can be used to
check whether or not a timer instance can operate as a slave
timer.
Reference Manual to
LL API cross
reference:
SMCR TS LL_TIM_SetTriggerInput
LL_TIM_EnableMasterSlaveMode
Function name
__STATIC_INLINE void LL_TIM_EnableMasterSlaveMode
(TIM_TypeDef * TIMx)
Function description
Enable the Master/Slave mode.
Parameters
TIMx: Timer instance
Return values
None
Notes
Macro IS_TIM_SLAVE_INSTANCE(TIMx) can be used to
check whether or not a timer instance can operate as a slave
timer.
Reference Manual to
LL API cross
reference:
SMCR MSM LL_TIM_EnableMasterSlaveMode
LL_TIM_DisableMasterSlaveMode
Function name
__STATIC_INLINE void LL_TIM_DisableMasterSlaveMode
(TIM_TypeDef * TIMx)
Function description
Disable the Master/Slave mode.
Parameters
TIMx: Timer instance
Return values
None
Notes
Macro IS_TIM_SLAVE_INSTANCE(TIMx) can be used to
check whether or not a timer instance can operate as a slave
timer.
Reference Manual to
LL API cross
reference:
SMCR MSM LL_TIM_DisableMasterSlaveMode
LL_TIM_IsEnabledMasterSlaveMode
1120/1320
Function name
__STATIC_INLINE uint32_t
LL_TIM_IsEnabledMasterSlaveMode (TIM_TypeDef * TIMx)
Function description
Indicates whether the Master/Slave mode is enabled.
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Notes
Macro IS_TIM_SLAVE_INSTANCE(TIMx) can be used to
check whether or not a timer instance can operate as a slave
timer.
Reference Manual to
LL API cross
reference:
SMCR MSM LL_TIM_IsEnabledMasterSlaveMode
LL_TIM_ConfigETR
Function name
__STATIC_INLINE void LL_TIM_ConfigETR (TIM_TypeDef *
TIMx, uint32_t ETRPolarity, uint32_t ETRPrescaler, uint32_t
ETRFilter)
Function description
Configure the external trigger (ETR) input.
Parameters
TIMx: Timer instance
ETRPolarity: This parameter can be one of the following
values:
LL_TIM_ETR_POLARITY_NONINVERTED
LL_TIM_ETR_POLARITY_INVERTED
ETRPrescaler: This parameter can be one of the following
values:
LL_TIM_ETR_PRESCALER_DIV1
LL_TIM_ETR_PRESCALER_DIV2
LL_TIM_ETR_PRESCALER_DIV4
LL_TIM_ETR_PRESCALER_DIV8
ETRFilter: This parameter can be one of the following
values:
LL_TIM_ETR_FILTER_FDIV1
LL_TIM_ETR_FILTER_FDIV1_N2
LL_TIM_ETR_FILTER_FDIV1_N4
LL_TIM_ETR_FILTER_FDIV1_N8
LL_TIM_ETR_FILTER_FDIV2_N6
LL_TIM_ETR_FILTER_FDIV2_N8
LL_TIM_ETR_FILTER_FDIV4_N6
LL_TIM_ETR_FILTER_FDIV4_N8
LL_TIM_ETR_FILTER_FDIV8_N6
LL_TIM_ETR_FILTER_FDIV8_N8
LL_TIM_ETR_FILTER_FDIV16_N5
LL_TIM_ETR_FILTER_FDIV16_N6
LL_TIM_ETR_FILTER_FDIV16_N8
LL_TIM_ETR_FILTER_FDIV32_N5
LL_TIM_ETR_FILTER_FDIV32_N6
LL_TIM_ETR_FILTER_FDIV32_N8
Return values
None
Notes
Macro IS_TIM_ETR_INSTANCE(TIMx) can be used to check
whether or not a timer instance provides an external trigger
input.
Reference Manual to
SMCR ETP LL_TIM_ConfigETR
DocID026525 Rev 6
1121/1320
LL TIM Generic Driver
LL API cross
reference:
UM1785
SMCR ETPS LL_TIM_ConfigETR
SMCR ETF LL_TIM_ConfigETR
LL_TIM_EnableBRK
Function name
__STATIC_INLINE void LL_TIM_EnableBRK (TIM_TypeDef *
TIMx)
Function description
Enable the break function.
Parameters
TIMx: Timer instance
Return values
None
Notes
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to
check whether or not a timer instance provides a break input.
Reference Manual to
LL API cross
reference:
BDTR BKE LL_TIM_EnableBRK
LL_TIM_DisableBRK
Function name
__STATIC_INLINE void LL_TIM_DisableBRK (TIM_TypeDef *
TIMx)
Function description
Disable the break function.
Parameters
TIMx: Timer instance
Return values
None
Notes
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to
check whether or not a timer instance provides a break input.
Reference Manual to
LL API cross
reference:
BDTR BKE LL_TIM_DisableBRK
LL_TIM_ConfigBRK
1122/1320
Function name
__STATIC_INLINE void LL_TIM_ConfigBRK (TIM_TypeDef *
TIMx, uint32_t BreakPolarity)
Function description
Configure the break input.
Parameters
TIMx: Timer instance
BreakPolarity: This parameter can be one of the following
values:
LL_TIM_BREAK_POLARITY_LOW
LL_TIM_BREAK_POLARITY_HIGH
Return values
None
Notes
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to
check whether or not a timer instance provides a break input.
Reference Manual to
LL API cross
reference:
BDTR BKP LL_TIM_ConfigBRK
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_SetOffStates
Function name
__STATIC_INLINE void LL_TIM_SetOffStates (TIM_TypeDef *
TIMx, uint32_t OffStateIdle, uint32_t OffStateRun)
Function description
Select the outputs off state (enabled v.s.
Parameters
TIMx: Timer instance
OffStateIdle: This parameter can be one of the following
values:
LL_TIM_OSSI_DISABLE
LL_TIM_OSSI_ENABLE
OffStateRun: This parameter can be one of the following
values:
LL_TIM_OSSR_DISABLE
LL_TIM_OSSR_ENABLE
Return values
None
Notes
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to
check whether or not a timer instance provides a break input.
Reference Manual to
LL API cross
reference:
BDTR OSSI LL_TIM_SetOffStates
BDTR OSSR LL_TIM_SetOffStates
LL_TIM_EnableAutomaticOutput
Function name
__STATIC_INLINE void LL_TIM_EnableAutomaticOutput
(TIM_TypeDef * TIMx)
Function description
Enable automatic output (MOE can be set by software or
automatically when a break input is active).
Parameters
TIMx: Timer instance
Return values
None
Notes
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to
check whether or not a timer instance provides a break input.
Reference Manual to
LL API cross
reference:
BDTR AOE LL_TIM_EnableAutomaticOutput
DocID026525 Rev 6
1123/1320
LL TIM Generic Driver
UM1785
LL_TIM_DisableAutomaticOutput
Function name
__STATIC_INLINE void LL_TIM_DisableAutomaticOutput
(TIM_TypeDef * TIMx)
Function description
Disable automatic output (MOE can be set only by software).
Parameters
TIMx: Timer instance
Return values
None
Notes
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to
check whether or not a timer instance provides a break input.
Reference Manual to
LL API cross
reference:
BDTR AOE LL_TIM_DisableAutomaticOutput
LL_TIM_IsEnabledAutomaticOutput
Function name
__STATIC_INLINE uint32_t
LL_TIM_IsEnabledAutomaticOutput (TIM_TypeDef * TIMx)
Function description
Indicate whether automatic output is enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Notes
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to
check whether or not a timer instance provides a break input.
Reference Manual to
LL API cross
reference:
BDTR AOE LL_TIM_IsEnabledAutomaticOutput
LL_TIM_EnableAllOutputs
Function name
__STATIC_INLINE void LL_TIM_EnableAllOutputs
(TIM_TypeDef * TIMx)
Function description
Enable the outputs (set the MOE bit in TIMx_BDTR register).
Parameters
TIMx: Timer instance
Return values
None
Notes
The MOE bit in TIMx_BDTR register allows to enable /disable
the outputs by software and is reset in case of break or
break2 event
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to
check whether or not a timer instance provides a break input.
Reference Manual to
LL API cross
reference:
BDTR MOE LL_TIM_EnableAllOutputs
LL_TIM_DisableAllOutputs
Function name
1124/1320
__STATIC_INLINE void LL_TIM_DisableAllOutputs
(TIM_TypeDef * TIMx)
DocID026525 Rev 6
UM1785
Function description
LL TIM Generic Driver
Disable the outputs (reset the MOE bit in TIMx_BDTR register).
Parameters
TIMx: Timer instance
Return values
None
Notes
The MOE bit in TIMx_BDTR register allows to enable /disable
the outputs by software and is reset in case of break or
break2 event.
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to
check whether or not a timer instance provides a break input.
Reference Manual to
LL API cross
reference:
BDTR MOE LL_TIM_DisableAllOutputs
LL_TIM_IsEnabledAllOutputs
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledAllOutputs
(TIM_TypeDef * TIMx)
Function description
Indicates whether outputs are enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Notes
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to
check whether or not a timer instance provides a break input.
Reference Manual to
LL API cross
reference:
BDTR MOE LL_TIM_IsEnabledAllOutputs
LL_TIM_ConfigDMABurst
Function name
__STATIC_INLINE void LL_TIM_ConfigDMABurst
(TIM_TypeDef * TIMx, uint32_t DMABurstBaseAddress,
uint32_t DMABurstLength)
Function description
Configures the timer DMA burst feature.
Parameters
TIMx: Timer instance
DMABurstBaseAddress: This parameter can be one of the
following values:
LL_TIM_DMABURST_BASEADDR_CR1
LL_TIM_DMABURST_BASEADDR_CR2
LL_TIM_DMABURST_BASEADDR_SMCR
LL_TIM_DMABURST_BASEADDR_DIER
LL_TIM_DMABURST_BASEADDR_SR
LL_TIM_DMABURST_BASEADDR_EGR
LL_TIM_DMABURST_BASEADDR_CCMR1
LL_TIM_DMABURST_BASEADDR_CCMR2
LL_TIM_DMABURST_BASEADDR_CCER
LL_TIM_DMABURST_BASEADDR_CNT
LL_TIM_DMABURST_BASEADDR_PSC
LL_TIM_DMABURST_BASEADDR_ARR
LL_TIM_DMABURST_BASEADDR_RCR
LL_TIM_DMABURST_BASEADDR_CCR1
DocID026525 Rev 6
1125/1320
LL TIM Generic Driver
UM1785
LL_TIM_DMABURST_BASEADDR_CCR2
LL_TIM_DMABURST_BASEADDR_CCR3
LL_TIM_DMABURST_BASEADDR_CCR4
LL_TIM_DMABURST_BASEADDR_BDTR
DMABurstLength: This parameter can be one of the
following values:
LL_TIM_DMABURST_LENGTH_1TRANSFER
LL_TIM_DMABURST_LENGTH_2TRANSFERS
LL_TIM_DMABURST_LENGTH_3TRANSFERS
LL_TIM_DMABURST_LENGTH_4TRANSFERS
LL_TIM_DMABURST_LENGTH_5TRANSFERS
LL_TIM_DMABURST_LENGTH_6TRANSFERS
LL_TIM_DMABURST_LENGTH_7TRANSFERS
LL_TIM_DMABURST_LENGTH_8TRANSFERS
LL_TIM_DMABURST_LENGTH_9TRANSFERS
LL_TIM_DMABURST_LENGTH_10TRANSFERS
LL_TIM_DMABURST_LENGTH_11TRANSFERS
LL_TIM_DMABURST_LENGTH_12TRANSFERS
LL_TIM_DMABURST_LENGTH_13TRANSFERS
LL_TIM_DMABURST_LENGTH_14TRANSFERS
LL_TIM_DMABURST_LENGTH_15TRANSFERS
LL_TIM_DMABURST_LENGTH_16TRANSFERS
LL_TIM_DMABURST_LENGTH_17TRANSFERS
LL_TIM_DMABURST_LENGTH_18TRANSFERS
Return values
None
Notes
Macro IS_TIM_DMABURST_INSTANCE(TIMx) can be used
to check whether or not a timer instance supports the DMA
burst mode.
Reference Manual to
LL API cross
reference:
DCR DBL LL_TIM_ConfigDMABurst
DCR DBA LL_TIM_ConfigDMABurst
LL_TIM_SetRemap
1126/1320
Function name
__STATIC_INLINE void LL_TIM_SetRemap (TIM_TypeDef *
TIMx, uint32_t Remap)
Function description
Remap TIM inputs (input channel, internal/external triggers).
Parameters
TIMx: Timer instance
Remap: This parameter can be one of the following values:
LL_TIM_TIM14_TI1_RMP_GPIO
LL_TIM_TIM14_TI1_RMP_RTC_CLK
LL_TIM_TIM14_TI1_RMP_HSE
LL_TIM_TIM14_TI1_RMP_MCO
Return values
None
Notes
Macro IS_TIM_REMAP_INSTANCE(TIMx) can be used to
check whether or not a some timer inputs can be remapped.
Reference Manual to
LL API cross
reference:
TIM14_OR TI1_RMP LL_TIM_SetRemap
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_SetOCRefClearInputSource
Function name
__STATIC_INLINE void LL_TIM_SetOCRefClearInputSource
(TIM_TypeDef * TIMx, uint32_t OCRefClearInputSource)
Function description
Set the OCREF clear input source.
Parameters
TIMx: Timer instance
OCRefClearInputSource: This parameter can be one of the
following values:
LL_TIM_OCREF_CLR_INT_OCREF_CLR
LL_TIM_OCREF_CLR_INT_ETR
Return values
None
Notes
The OCxREF signal of a given channel can be cleared when
a high level is applied on the OCREF_CLR_INPUT
This function can only be used in Output compare and PWM
modes.
Reference Manual to
LL API cross
reference:
SMCR OCCS LL_TIM_SetOCRefClearInputSource
LL_TIM_ClearFlag_UPDATE
Function name
__STATIC_INLINE void LL_TIM_ClearFlag_UPDATE
(TIM_TypeDef * TIMx)
Function description
Clear the update interrupt flag (UIF).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
SR UIF LL_TIM_ClearFlag_UPDATE
LL_TIM_IsActiveFlag_UPDATE
Function name
__STATIC_INLINE uint32_t LL_TIM_IsActiveFlag_UPDATE
(TIM_TypeDef * TIMx)
Function description
Indicate whether update interrupt flag (UIF) is set (update interrupt
is pending).
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR UIF LL_TIM_IsActiveFlag_UPDATE
LL_TIM_ClearFlag_CC1
Function name
__STATIC_INLINE void LL_TIM_ClearFlag_CC1 (TIM_TypeDef
* TIMx)
Function description
Clear the Capture/Compare 1 interrupt flag (CC1F).
DocID026525 Rev 6
1127/1320
LL TIM Generic Driver
Parameters
UM1785
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
SR CC1IF LL_TIM_ClearFlag_CC1
LL_TIM_IsActiveFlag_CC1
Function name
__STATIC_INLINE uint32_t LL_TIM_IsActiveFlag_CC1
(TIM_TypeDef * TIMx)
Function description
Indicate whether Capture/Compare 1 interrupt flag (CC1F) is set
(Capture/Compare 1 interrupt is pending).
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR CC1IF LL_TIM_IsActiveFlag_CC1
LL_TIM_ClearFlag_CC2
Function name
__STATIC_INLINE void LL_TIM_ClearFlag_CC2 (TIM_TypeDef
* TIMx)
Function description
Clear the Capture/Compare 2 interrupt flag (CC2F).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
SR CC2IF LL_TIM_ClearFlag_CC2
LL_TIM_IsActiveFlag_CC2
Function name
__STATIC_INLINE uint32_t LL_TIM_IsActiveFlag_CC2
(TIM_TypeDef * TIMx)
Function description
Indicate whether Capture/Compare 2 interrupt flag (CC2F) is set
(Capture/Compare 2 interrupt is pending).
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR CC2IF LL_TIM_IsActiveFlag_CC2
LL_TIM_ClearFlag_CC3
1128/1320
Function name
__STATIC_INLINE void LL_TIM_ClearFlag_CC3 (TIM_TypeDef
* TIMx)
Function description
Clear the Capture/Compare 3 interrupt flag (CC3F).
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
SR CC3IF LL_TIM_ClearFlag_CC3
LL_TIM_IsActiveFlag_CC3
Function name
__STATIC_INLINE uint32_t LL_TIM_IsActiveFlag_CC3
(TIM_TypeDef * TIMx)
Function description
Indicate whether Capture/Compare 3 interrupt flag (CC3F) is set
(Capture/Compare 3 interrupt is pending).
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR CC3IF LL_TIM_IsActiveFlag_CC3
LL_TIM_ClearFlag_CC4
Function name
__STATIC_INLINE void LL_TIM_ClearFlag_CC4 (TIM_TypeDef
* TIMx)
Function description
Clear the Capture/Compare 4 interrupt flag (CC4F).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
SR CC4IF LL_TIM_ClearFlag_CC4
LL_TIM_IsActiveFlag_CC4
Function name
__STATIC_INLINE uint32_t LL_TIM_IsActiveFlag_CC4
(TIM_TypeDef * TIMx)
Function description
Indicate whether Capture/Compare 4 interrupt flag (CC4F) is set
(Capture/Compare 4 interrupt is pending).
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR CC4IF LL_TIM_IsActiveFlag_CC4
LL_TIM_ClearFlag_COM
Function name
__STATIC_INLINE void LL_TIM_ClearFlag_COM (TIM_TypeDef
* TIMx)
Function description
Clear the commutation interrupt flag (COMIF).
DocID026525 Rev 6
1129/1320
LL TIM Generic Driver
Parameters
UM1785
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
SR COMIF LL_TIM_ClearFlag_COM
LL_TIM_IsActiveFlag_COM
Function name
__STATIC_INLINE uint32_t LL_TIM_IsActiveFlag_COM
(TIM_TypeDef * TIMx)
Function description
Indicate whether commutation interrupt flag (COMIF) is set
(commutation interrupt is pending).
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR COMIF LL_TIM_IsActiveFlag_COM
LL_TIM_ClearFlag_TRIG
Function name
__STATIC_INLINE void LL_TIM_ClearFlag_TRIG (TIM_TypeDef
* TIMx)
Function description
Clear the trigger interrupt flag (TIF).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
SR TIF LL_TIM_ClearFlag_TRIG
LL_TIM_IsActiveFlag_TRIG
Function name
__STATIC_INLINE uint32_t LL_TIM_IsActiveFlag_TRIG
(TIM_TypeDef * TIMx)
Function description
Indicate whether trigger interrupt flag (TIF) is set (trigger interrupt
is pending).
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR TIF LL_TIM_IsActiveFlag_TRIG
LL_TIM_ClearFlag_BRK
1130/1320
Function name
__STATIC_INLINE void LL_TIM_ClearFlag_BRK (TIM_TypeDef
* TIMx)
Function description
Clear the break interrupt flag (BIF).
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
SR BIF LL_TIM_ClearFlag_BRK
LL_TIM_IsActiveFlag_BRK
Function name
__STATIC_INLINE uint32_t LL_TIM_IsActiveFlag_BRK
(TIM_TypeDef * TIMx)
Function description
Indicate whether break interrupt flag (BIF) is set (break interrupt is
pending).
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR BIF LL_TIM_IsActiveFlag_BRK
LL_TIM_ClearFlag_CC1OVR
Function name
__STATIC_INLINE void LL_TIM_ClearFlag_CC1OVR
(TIM_TypeDef * TIMx)
Function description
Clear the Capture/Compare 1 over-capture interrupt flag (CC1OF).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
SR CC1OF LL_TIM_ClearFlag_CC1OVR
LL_TIM_IsActiveFlag_CC1OVR
Function name
__STATIC_INLINE uint32_t LL_TIM_IsActiveFlag_CC1OVR
(TIM_TypeDef * TIMx)
Function description
Indicate whether Capture/Compare 1 over-capture interrupt flag
(CC1OF) is set (Capture/Compare 1 interrupt is pending).
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR CC1OF LL_TIM_IsActiveFlag_CC1OVR
LL_TIM_ClearFlag_CC2OVR
Function name
__STATIC_INLINE void LL_TIM_ClearFlag_CC2OVR
(TIM_TypeDef * TIMx)
Function description
Clear the Capture/Compare 2 over-capture interrupt flag (CC2OF).
DocID026525 Rev 6
1131/1320
LL TIM Generic Driver
Parameters
UM1785
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
SR CC2OF LL_TIM_ClearFlag_CC2OVR
LL_TIM_IsActiveFlag_CC2OVR
Function name
__STATIC_INLINE uint32_t LL_TIM_IsActiveFlag_CC2OVR
(TIM_TypeDef * TIMx)
Function description
Indicate whether Capture/Compare 2 over-capture interrupt flag
(CC2OF) is set (Capture/Compare 2 over-capture interrupt is
pending).
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR CC2OF LL_TIM_IsActiveFlag_CC2OVR
LL_TIM_ClearFlag_CC3OVR
Function name
__STATIC_INLINE void LL_TIM_ClearFlag_CC3OVR
(TIM_TypeDef * TIMx)
Function description
Clear the Capture/Compare 3 over-capture interrupt flag (CC3OF).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
SR CC3OF LL_TIM_ClearFlag_CC3OVR
LL_TIM_IsActiveFlag_CC3OVR
1132/1320
Function name
__STATIC_INLINE uint32_t LL_TIM_IsActiveFlag_CC3OVR
(TIM_TypeDef * TIMx)
Function description
Indicate whether Capture/Compare 3 over-capture interrupt flag
(CC3OF) is set (Capture/Compare 3 over-capture interrupt is
pending).
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR CC3OF LL_TIM_IsActiveFlag_CC3OVR
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_ClearFlag_CC4OVR
Function name
__STATIC_INLINE void LL_TIM_ClearFlag_CC4OVR
(TIM_TypeDef * TIMx)
Function description
Clear the Capture/Compare 4 over-capture interrupt flag (CC4OF).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
SR CC4OF LL_TIM_ClearFlag_CC4OVR
LL_TIM_IsActiveFlag_CC4OVR
Function name
__STATIC_INLINE uint32_t LL_TIM_IsActiveFlag_CC4OVR
(TIM_TypeDef * TIMx)
Function description
Indicate whether Capture/Compare 4 over-capture interrupt flag
(CC4OF) is set (Capture/Compare 4 over-capture interrupt is
pending).
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
SR CC4OF LL_TIM_IsActiveFlag_CC4OVR
LL_TIM_EnableIT_UPDATE
Function name
__STATIC_INLINE void LL_TIM_EnableIT_UPDATE
(TIM_TypeDef * TIMx)
Function description
Enable update interrupt (UIE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER UIE LL_TIM_EnableIT_UPDATE
LL_TIM_DisableIT_UPDATE
Function name
__STATIC_INLINE void LL_TIM_DisableIT_UPDATE
(TIM_TypeDef * TIMx)
Function description
Disable update interrupt (UIE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER UIE LL_TIM_DisableIT_UPDATE
DocID026525 Rev 6
1133/1320
LL TIM Generic Driver
UM1785
LL_TIM_IsEnabledIT_UPDATE
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledIT_UPDATE
(TIM_TypeDef * TIMx)
Function description
Indicates whether the update interrupt (UIE) is enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
DIER UIE LL_TIM_IsEnabledIT_UPDATE
LL_TIM_EnableIT_CC1
Function name
__STATIC_INLINE void LL_TIM_EnableIT_CC1 (TIM_TypeDef *
TIMx)
Function description
Enable capture/compare 1 interrupt (CC1IE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER CC1IE LL_TIM_EnableIT_CC1
LL_TIM_DisableIT_CC1
Function name
__STATIC_INLINE void LL_TIM_DisableIT_CC1 (TIM_TypeDef
* TIMx)
Function description
Disable capture/compare 1 interrupt (CC1IE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER CC1IE LL_TIM_DisableIT_CC1
LL_TIM_IsEnabledIT_CC1
1134/1320
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledIT_CC1
(TIM_TypeDef * TIMx)
Function description
Indicates whether the capture/compare 1 interrupt (CC1IE) is
enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
DIER CC1IE LL_TIM_IsEnabledIT_CC1
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_EnableIT_CC2
Function name
__STATIC_INLINE void LL_TIM_EnableIT_CC2 (TIM_TypeDef *
TIMx)
Function description
Enable capture/compare 2 interrupt (CC2IE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER CC2IE LL_TIM_EnableIT_CC2
LL_TIM_DisableIT_CC2
Function name
__STATIC_INLINE void LL_TIM_DisableIT_CC2 (TIM_TypeDef
* TIMx)
Function description
Disable capture/compare 2 interrupt (CC2IE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER CC2IE LL_TIM_DisableIT_CC2
LL_TIM_IsEnabledIT_CC2
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledIT_CC2
(TIM_TypeDef * TIMx)
Function description
Indicates whether the capture/compare 2 interrupt (CC2IE) is
enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
DIER CC2IE LL_TIM_IsEnabledIT_CC2
LL_TIM_EnableIT_CC3
Function name
__STATIC_INLINE void LL_TIM_EnableIT_CC3 (TIM_TypeDef *
TIMx)
Function description
Enable capture/compare 3 interrupt (CC3IE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER CC3IE LL_TIM_EnableIT_CC3
DocID026525 Rev 6
1135/1320
LL TIM Generic Driver
UM1785
LL_TIM_DisableIT_CC3
Function name
__STATIC_INLINE void LL_TIM_DisableIT_CC3 (TIM_TypeDef
* TIMx)
Function description
Disable capture/compare 3 interrupt (CC3IE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER CC3IE LL_TIM_DisableIT_CC3
LL_TIM_IsEnabledIT_CC3
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledIT_CC3
(TIM_TypeDef * TIMx)
Function description
Indicates whether the capture/compare 3 interrupt (CC3IE) is
enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
DIER CC3IE LL_TIM_IsEnabledIT_CC3
LL_TIM_EnableIT_CC4
Function name
__STATIC_INLINE void LL_TIM_EnableIT_CC4 (TIM_TypeDef *
TIMx)
Function description
Enable capture/compare 4 interrupt (CC4IE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER CC4IE LL_TIM_EnableIT_CC4
LL_TIM_DisableIT_CC4
1136/1320
Function name
__STATIC_INLINE void LL_TIM_DisableIT_CC4 (TIM_TypeDef
* TIMx)
Function description
Disable capture/compare 4 interrupt (CC4IE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER CC4IE LL_TIM_DisableIT_CC4
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_IsEnabledIT_CC4
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledIT_CC4
(TIM_TypeDef * TIMx)
Function description
Indicates whether the capture/compare 4 interrupt (CC4IE) is
enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
DIER CC4IE LL_TIM_IsEnabledIT_CC4
LL_TIM_EnableIT_COM
Function name
__STATIC_INLINE void LL_TIM_EnableIT_COM (TIM_TypeDef
* TIMx)
Function description
Enable commutation interrupt (COMIE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER COMIE LL_TIM_EnableIT_COM
LL_TIM_DisableIT_COM
Function name
__STATIC_INLINE void LL_TIM_DisableIT_COM (TIM_TypeDef
* TIMx)
Function description
Disable commutation interrupt (COMIE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER COMIE LL_TIM_DisableIT_COM
LL_TIM_IsEnabledIT_COM
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledIT_COM
(TIM_TypeDef * TIMx)
Function description
Indicates whether the commutation interrupt (COMIE) is enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
DIER COMIE LL_TIM_IsEnabledIT_COM
DocID026525 Rev 6
1137/1320
LL TIM Generic Driver
UM1785
LL_TIM_EnableIT_TRIG
Function name
__STATIC_INLINE void LL_TIM_EnableIT_TRIG (TIM_TypeDef
* TIMx)
Function description
Enable trigger interrupt (TIE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER TIE LL_TIM_EnableIT_TRIG
LL_TIM_DisableIT_TRIG
Function name
__STATIC_INLINE void LL_TIM_DisableIT_TRIG (TIM_TypeDef
* TIMx)
Function description
Disable trigger interrupt (TIE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER TIE LL_TIM_DisableIT_TRIG
LL_TIM_IsEnabledIT_TRIG
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledIT_TRIG
(TIM_TypeDef * TIMx)
Function description
Indicates whether the trigger interrupt (TIE) is enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
DIER TIE LL_TIM_IsEnabledIT_TRIG
LL_TIM_EnableIT_BRK
1138/1320
Function name
__STATIC_INLINE void LL_TIM_EnableIT_BRK (TIM_TypeDef *
TIMx)
Function description
Enable break interrupt (BIE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER BIE LL_TIM_EnableIT_BRK
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_DisableIT_BRK
Function name
__STATIC_INLINE void LL_TIM_DisableIT_BRK (TIM_TypeDef
* TIMx)
Function description
Disable break interrupt (BIE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER BIE LL_TIM_DisableIT_BRK
LL_TIM_IsEnabledIT_BRK
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledIT_BRK
(TIM_TypeDef * TIMx)
Function description
Indicates whether the break interrupt (BIE) is enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
DIER BIE LL_TIM_IsEnabledIT_BRK
LL_TIM_EnableDMAReq_UPDATE
Function name
__STATIC_INLINE void LL_TIM_EnableDMAReq_UPDATE
(TIM_TypeDef * TIMx)
Function description
Enable update DMA request (UDE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER UDE LL_TIM_EnableDMAReq_UPDATE
LL_TIM_DisableDMAReq_UPDATE
Function name
__STATIC_INLINE void LL_TIM_DisableDMAReq_UPDATE
(TIM_TypeDef * TIMx)
Function description
Disable update DMA request (UDE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER UDE LL_TIM_DisableDMAReq_UPDATE
DocID026525 Rev 6
1139/1320
LL TIM Generic Driver
UM1785
LL_TIM_IsEnabledDMAReq_UPDATE
Function name
__STATIC_INLINE uint32_t
LL_TIM_IsEnabledDMAReq_UPDATE (TIM_TypeDef * TIMx)
Function description
Indicates whether the update DMA request (UDE) is enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
DIER UDE LL_TIM_IsEnabledDMAReq_UPDATE
LL_TIM_EnableDMAReq_CC1
Function name
__STATIC_INLINE void LL_TIM_EnableDMAReq_CC1
(TIM_TypeDef * TIMx)
Function description
Enable capture/compare 1 DMA request (CC1DE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER CC1DE LL_TIM_EnableDMAReq_CC1
LL_TIM_DisableDMAReq_CC1
Function name
__STATIC_INLINE void LL_TIM_DisableDMAReq_CC1
(TIM_TypeDef * TIMx)
Function description
Disable capture/compare 1 DMA request (CC1DE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER CC1DE LL_TIM_DisableDMAReq_CC1
LL_TIM_IsEnabledDMAReq_CC1
1140/1320
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledDMAReq_CC1
(TIM_TypeDef * TIMx)
Function description
Indicates whether the capture/compare 1 DMA request (CC1DE) is
enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
DIER CC1DE LL_TIM_IsEnabledDMAReq_CC1
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_EnableDMAReq_CC2
Function name
__STATIC_INLINE void LL_TIM_EnableDMAReq_CC2
(TIM_TypeDef * TIMx)
Function description
Enable capture/compare 2 DMA request (CC2DE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER CC2DE LL_TIM_EnableDMAReq_CC2
LL_TIM_DisableDMAReq_CC2
Function name
__STATIC_INLINE void LL_TIM_DisableDMAReq_CC2
(TIM_TypeDef * TIMx)
Function description
Disable capture/compare 2 DMA request (CC2DE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER CC2DE LL_TIM_DisableDMAReq_CC2
LL_TIM_IsEnabledDMAReq_CC2
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledDMAReq_CC2
(TIM_TypeDef * TIMx)
Function description
Indicates whether the capture/compare 2 DMA request (CC2DE) is
enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
DIER CC2DE LL_TIM_IsEnabledDMAReq_CC2
LL_TIM_EnableDMAReq_CC3
Function name
__STATIC_INLINE void LL_TIM_EnableDMAReq_CC3
(TIM_TypeDef * TIMx)
Function description
Enable capture/compare 3 DMA request (CC3DE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER CC3DE LL_TIM_EnableDMAReq_CC3
DocID026525 Rev 6
1141/1320
LL TIM Generic Driver
UM1785
LL_TIM_DisableDMAReq_CC3
Function name
__STATIC_INLINE void LL_TIM_DisableDMAReq_CC3
(TIM_TypeDef * TIMx)
Function description
Disable capture/compare 3 DMA request (CC3DE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER CC3DE LL_TIM_DisableDMAReq_CC3
LL_TIM_IsEnabledDMAReq_CC3
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledDMAReq_CC3
(TIM_TypeDef * TIMx)
Function description
Indicates whether the capture/compare 3 DMA request (CC3DE) is
enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
DIER CC3DE LL_TIM_IsEnabledDMAReq_CC3
LL_TIM_EnableDMAReq_CC4
Function name
__STATIC_INLINE void LL_TIM_EnableDMAReq_CC4
(TIM_TypeDef * TIMx)
Function description
Enable capture/compare 4 DMA request (CC4DE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER CC4DE LL_TIM_EnableDMAReq_CC4
LL_TIM_DisableDMAReq_CC4
1142/1320
Function name
__STATIC_INLINE void LL_TIM_DisableDMAReq_CC4
(TIM_TypeDef * TIMx)
Function description
Disable capture/compare 4 DMA request (CC4DE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER CC4DE LL_TIM_DisableDMAReq_CC4
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_IsEnabledDMAReq_CC4
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledDMAReq_CC4
(TIM_TypeDef * TIMx)
Function description
Indicates whether the capture/compare 4 DMA request (CC4DE) is
enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
DIER CC4DE LL_TIM_IsEnabledDMAReq_CC4
LL_TIM_EnableDMAReq_COM
Function name
__STATIC_INLINE void LL_TIM_EnableDMAReq_COM
(TIM_TypeDef * TIMx)
Function description
Enable commutation DMA request (COMDE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER COMDE LL_TIM_EnableDMAReq_COM
LL_TIM_DisableDMAReq_COM
Function name
__STATIC_INLINE void LL_TIM_DisableDMAReq_COM
(TIM_TypeDef * TIMx)
Function description
Disable commutation DMA request (COMDE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER COMDE LL_TIM_DisableDMAReq_COM
LL_TIM_IsEnabledDMAReq_COM
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledDMAReq_COM
(TIM_TypeDef * TIMx)
Function description
Indicates whether the commutation DMA request (COMDE) is
enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
DIER COMDE LL_TIM_IsEnabledDMAReq_COM
DocID026525 Rev 6
1143/1320
LL TIM Generic Driver
UM1785
LL_TIM_EnableDMAReq_TRIG
Function name
__STATIC_INLINE void LL_TIM_EnableDMAReq_TRIG
(TIM_TypeDef * TIMx)
Function description
Enable trigger interrupt (TDE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER TDE LL_TIM_EnableDMAReq_TRIG
LL_TIM_DisableDMAReq_TRIG
Function name
__STATIC_INLINE void LL_TIM_DisableDMAReq_TRIG
(TIM_TypeDef * TIMx)
Function description
Disable trigger interrupt (TDE).
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
DIER TDE LL_TIM_DisableDMAReq_TRIG
LL_TIM_IsEnabledDMAReq_TRIG
Function name
__STATIC_INLINE uint32_t LL_TIM_IsEnabledDMAReq_TRIG
(TIM_TypeDef * TIMx)
Function description
Indicates whether the trigger interrupt (TDE) is enabled.
Parameters
TIMx: Timer instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
DIER TDE LL_TIM_IsEnabledDMAReq_TRIG
LL_TIM_GenerateEvent_UPDATE
1144/1320
Function name
__STATIC_INLINE void LL_TIM_GenerateEvent_UPDATE
(TIM_TypeDef * TIMx)
Function description
Generate an update event.
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
EGR UG LL_TIM_GenerateEvent_UPDATE
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_GenerateEvent_CC1
Function name
__STATIC_INLINE void LL_TIM_GenerateEvent_CC1
(TIM_TypeDef * TIMx)
Function description
Generate Capture/Compare 1 event.
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
EGR CC1G LL_TIM_GenerateEvent_CC1
LL_TIM_GenerateEvent_CC2
Function name
__STATIC_INLINE void LL_TIM_GenerateEvent_CC2
(TIM_TypeDef * TIMx)
Function description
Generate Capture/Compare 2 event.
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
EGR CC2G LL_TIM_GenerateEvent_CC2
LL_TIM_GenerateEvent_CC3
Function name
__STATIC_INLINE void LL_TIM_GenerateEvent_CC3
(TIM_TypeDef * TIMx)
Function description
Generate Capture/Compare 3 event.
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
EGR CC3G LL_TIM_GenerateEvent_CC3
LL_TIM_GenerateEvent_CC4
Function name
__STATIC_INLINE void LL_TIM_GenerateEvent_CC4
(TIM_TypeDef * TIMx)
Function description
Generate Capture/Compare 4 event.
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
EGR CC4G LL_TIM_GenerateEvent_CC4
DocID026525 Rev 6
1145/1320
LL TIM Generic Driver
UM1785
LL_TIM_GenerateEvent_COM
Function name
__STATIC_INLINE void LL_TIM_GenerateEvent_COM
(TIM_TypeDef * TIMx)
Function description
Generate commutation event.
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
EGR COMG LL_TIM_GenerateEvent_COM
LL_TIM_GenerateEvent_TRIG
Function name
__STATIC_INLINE void LL_TIM_GenerateEvent_TRIG
(TIM_TypeDef * TIMx)
Function description
Generate trigger event.
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
EGR TG LL_TIM_GenerateEvent_TRIG
LL_TIM_GenerateEvent_BRK
Function name
__STATIC_INLINE void LL_TIM_GenerateEvent_BRK
(TIM_TypeDef * TIMx)
Function description
Generate break event.
Parameters
TIMx: Timer instance
Return values
None
Reference Manual to
LL API cross
reference:
EGR BG LL_TIM_GenerateEvent_BRK
LL_TIM_DeInit
Function name
ErrorStatus LL_TIM_DeInit (TIM_TypeDef * TIMx)
Function description
Set TIMx registers to their reset values.
Parameters
TIMx: Timer instance
Return values
An: ErrorStatus enumeration value:
SUCCESS: TIMx registers are de-initialized
ERROR: invalid TIMx instance
LL_TIM_StructInit
1146/1320
Function name
void LL_TIM_StructInit (LL_TIM_InitTypeDef * TIM_InitStruct)
Function description
Set the fields of the time base unit configuration data structure to
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
their default values.
Parameters
TIM_InitStruct: pointer to a LL_TIM_InitTypeDef structure
(time base unit configuration data structure)
Return values
None
LL_TIM_Init
Function name
ErrorStatus LL_TIM_Init (TIM_TypeDef * TIMx,
LL_TIM_InitTypeDef * TIM_InitStruct)
Function description
Configure the TIMx time base unit.
Parameters
TIMx: Timer Instance
TIM_InitStruct: pointer to a LL_TIM_InitTypeDef structure
(TIMx time base unit configuration data structure)
Return values
An: ErrorStatus enumeration value:
SUCCESS: TIMx registers are de-initialized
ERROR: not applicable
LL_TIM_OC_StructInit
Function name
void LL_TIM_OC_StructInit (LL_TIM_OC_InitTypeDef *
TIM_OC_InitStruct)
Function description
Set the fields of the TIMx output channel configuration data
structure to their default values.
Parameters
TIM_OC_InitStruct: pointer to a LL_TIM_OC_InitTypeDef
structure (the output channel configuration data structure)
Return values
None
LL_TIM_OC_Init
Function name
ErrorStatus LL_TIM_OC_Init (TIM_TypeDef * TIMx, uint32_t
Channel, LL_TIM_OC_InitTypeDef * TIM_OC_InitStruct)
Function description
Configure the TIMx output channel.
Parameters
TIMx: Timer Instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
TIM_OC_InitStruct: pointer to a LL_TIM_OC_InitTypeDef
structure (TIMx output channel configuration data structure)
Return values
An: ErrorStatus enumeration value:
SUCCESS: TIMx output channel is initialized
ERROR: TIMx output channel is not initialized
DocID026525 Rev 6
1147/1320
LL TIM Generic Driver
UM1785
LL_TIM_IC_StructInit
Function name
void LL_TIM_IC_StructInit (LL_TIM_IC_InitTypeDef *
TIM_ICInitStruct)
Function description
Set the fields of the TIMx input channel configuration data
structure to their default values.
Parameters
TIM_ICInitStruct: pointer to a LL_TIM_IC_InitTypeDef
structure (the input channel configuration data structure)
Return values
None
LL_TIM_IC_Init
Function name
ErrorStatus LL_TIM_IC_Init (TIM_TypeDef * TIMx, uint32_t
Channel, LL_TIM_IC_InitTypeDef * TIM_IC_InitStruct)
Function description
Configure the TIMx input channel.
Parameters
TIMx: Timer Instance
Channel: This parameter can be one of the following values:
LL_TIM_CHANNEL_CH1
LL_TIM_CHANNEL_CH2
LL_TIM_CHANNEL_CH3
LL_TIM_CHANNEL_CH4
TIM_IC_InitStruct: pointer to a LL_TIM_IC_InitTypeDef
structure (TIMx input channel configuration data structure)
Return values
An: ErrorStatus enumeration value:
SUCCESS: TIMx output channel is initialized
ERROR: TIMx output channel is not initialized
LL_TIM_ENCODER_StructInit
Function name
void LL_TIM_ENCODER_StructInit
(LL_TIM_ENCODER_InitTypeDef * TIM_EncoderInitStruct)
Function description
Fills each TIM_EncoderInitStruct field with its default value.
Parameters
TIM_EncoderInitStruct: pointer to a
LL_TIM_ENCODER_InitTypeDef structure (encoder interface
configuration data structure)
Return values
None
LL_TIM_ENCODER_Init
1148/1320
Function name
ErrorStatus LL_TIM_ENCODER_Init (TIM_TypeDef * TIMx,
LL_TIM_ENCODER_InitTypeDef * TIM_EncoderInitStruct)
Function description
Configure the encoder interface of the timer instance.
Parameters
TIMx: Timer Instance
TIM_EncoderInitStruct: pointer to a
LL_TIM_ENCODER_InitTypeDef structure (TIMx encoder
interface configuration data structure)
Return values
An: ErrorStatus enumeration value:
SUCCESS: TIMx registers are de-initialized
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
ERROR: not applicable
LL_TIM_HALLSENSOR_StructInit
Function name
void LL_TIM_HALLSENSOR_StructInit
(LL_TIM_HALLSENSOR_InitTypeDef *
TIM_HallSensorInitStruct)
Function description
Set the fields of the TIMx Hall sensor interface configuration data
structure to their default values.
Parameters
TIM_HallSensorInitStruct: pointer to a
LL_TIM_HALLSENSOR_InitTypeDef structure (HALL sensor
interface configuration data structure)
Return values
None
LL_TIM_HALLSENSOR_Init
Function name
ErrorStatus LL_TIM_HALLSENSOR_Init (TIM_TypeDef * TIMx,
LL_TIM_HALLSENSOR_InitTypeDef *
TIM_HallSensorInitStruct)
Function description
Configure the Hall sensor interface of the timer instance.
Parameters
TIMx: Timer Instance
TIM_HallSensorInitStruct: pointer to a
LL_TIM_HALLSENSOR_InitTypeDef structure (TIMx HALL
sensor interface configuration data structure)
Return values
An: ErrorStatus enumeration value:
SUCCESS: TIMx registers are de-initialized
ERROR: not applicable
Notes
TIMx CH1, CH2 and CH3 inputs connected through a XOR to
the TI1 input channel
TIMx slave mode controller is configured in reset mode.
Selected internal trigger is TI1F_ED.
Channel 1 is configured as input, IC1 is mapped on TRC.
Captured value stored in TIMx_CCR1 correspond to the time
elapsed between 2 changes on the inputs. It gives information
about motor speed.
Channel 2 is configured in output PWM 2 mode.
Compare value stored in TIMx_CCR2 corresponds to the
commutation delay.
OC2REF is selected as trigger output on TRGO.
LL_TIM_IC_POLARITY_BOTHEDGE must not be used for
TI1 when it is used when TIMx operates in Hall sensor
interface mode.
LL_TIM_BDTR_StructInit
Function name
void LL_TIM_BDTR_StructInit (LL_TIM_BDTR_InitTypeDef *
TIM_BDTRInitStruct)
Function description
Set the fields of the Break and Dead Time configuration data
structure to their default values.
DocID026525 Rev 6
1149/1320
LL TIM Generic Driver
Parameters
UM1785
TIM_BDTRInitStruct: pointer to a
LL_TIM_BDTR_InitTypeDef structure (Break and Dead Time
configuration data structure)
Return values
None
LL_TIM_BDTR_Init
Function name
ErrorStatus LL_TIM_BDTR_Init (TIM_TypeDef * TIMx,
LL_TIM_BDTR_InitTypeDef * TIM_BDTRInitStruct)
Function description
Configure the Break and Dead Time feature of the timer instance.
Parameters
TIMx: Timer Instance
TIM_BDTRInitStruct: pointer to a
LL_TIM_BDTR_InitTypeDef structure(Break and Dead Time
configuration data structure)
Return values
An: ErrorStatus enumeration value:
SUCCESS: Break and Dead Time is initialized
ERROR: not applicable
Notes
As the bits AOE, BKP, BKE, OSSR, OSSI and DTG[7:0] can
be write-locked depending on the LOCK configuration, it can
be necessary to configure all of them during the first write
access to the TIMx_BDTR register.
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to
check whether or not a timer instance provides a break input.
67.3
TIM Firmware driver defines
67.3.1
TIM
Active Input Selection
LL_TIM_ACTIVEINPUT_DIRECTTI
ICx is mapped on TIx
LL_TIM_ACTIVEINPUT_INDIRECTTI
ICx is mapped on TIy
LL_TIM_ACTIVEINPUT_TRC
ICx is mapped on TRC
Automatic output enable
LL_TIM_AUTOMATICOUTPUT_DISABLE
MOE can be set only by software
LL_TIM_AUTOMATICOUTPUT_ENABLE
MOE can be set by software or automatically
at the next update event
Break Enable
LL_TIM_BREAK_DISABLE
Break function disabled
LL_TIM_BREAK_ENABLE
Break function enabled
break polarity
LL_TIM_BREAK_POLARITY_LOW
Break input BRK is active low
LL_TIM_BREAK_POLARITY_HIGH
Break input BRK is active high
Capture Compare DMA Request
LL_TIM_CCDMAREQUEST_CC
1150/1320
CCx DMA request sent when CCx event occurs
DocID026525 Rev 6
UM1785
LL_TIM_CCDMAREQUEST_UPDATE
LL TIM Generic Driver
CCx DMA requests sent when update event
occurs
Capture Compare Update Source
LL_TIM_CCUPDATESOURCE_COMG_ONLY
Capture/compare control bits are
updated by setting the COMG bit
only
LL_TIM_CCUPDATESOURCE_COMG_AND_TRGI
Capture/compare control bits are
updated by setting the COMG bit or
when a rising edge occurs on trigger
input (TRGI)
Channel
LL_TIM_CHANNEL_CH1
Timer input/output channel 1
LL_TIM_CHANNEL_CH1N
Timer complementary output channel 1
LL_TIM_CHANNEL_CH2
Timer input/output channel 2
LL_TIM_CHANNEL_CH2N
Timer complementary output channel 2
LL_TIM_CHANNEL_CH3
Timer input/output channel 3
LL_TIM_CHANNEL_CH3N
Timer complementary output channel 3
LL_TIM_CHANNEL_CH4
Timer input/output channel 4
Clock Division
LL_TIM_CLOCKDIVISION_DIV1
tDTS=tCK_INT
LL_TIM_CLOCKDIVISION_DIV2
tDTS=2*tCK_INT
LL_TIM_CLOCKDIVISION_DIV4
tDTS=4*tCK_INT
Clock Source
LL_TIM_CLOCKSOURCE_INTERNAL
The timer is clocked by the internal clock
provided from the RCC
LL_TIM_CLOCKSOURCE_EXT_MODE1
Counter counts at each rising or falling edge on
a selected inpu t
LL_TIM_CLOCKSOURCE_EXT_MODE2
Counter counts at each rising or falling edge on
the external trigger input ETR
Counter Direction
LL_TIM_COUNTERDIRECTION_UP
Timer counter counts up
LL_TIM_COUNTERDIRECTION_DOWN
Timer counter counts down
Counter Mode
LL_TIM_COUNTERMODE_UP
Counter used as upcounter
LL_TIM_COUNTERMODE_DOWN
Counter used as downcounter
LL_TIM_COUNTERMODE_CENTER_UP
The counter counts up and down
alternatively. Output compare interrupt
flags of output channels are set only
when the counter is counting down.
LL_TIM_COUNTERMODE_CENTER_DOWN
The counter counts up and down
alternatively. Output compare interrupt
DocID026525 Rev 6
1151/1320
LL TIM Generic Driver
UM1785
flags of output channels are set only
when the counter is counting up
LL_TIM_COUNTERMODE_CENTER_UP_DOWN
The counter counts up and down
alternatively. Output compare interrupt
flags of output channels are set only
when the counter is counting up or
down.
DMA Burst Base Address
1152/1320
LL_TIM_DMABURST_BASEADDR_CR1
TIMx_CR1 register is the DMA base
address for DMA burst
LL_TIM_DMABURST_BASEADDR_CR2
TIMx_CR2 register is the DMA base
address for DMA burst
LL_TIM_DMABURST_BASEADDR_SMCR
TIMx_SMCR register is the DMA base
address for DMA burst
LL_TIM_DMABURST_BASEADDR_DIER
TIMx_DIER register is the DMA base
address for DMA burst
LL_TIM_DMABURST_BASEADDR_SR
TIMx_SR register is the DMA base address
for DMA burst
LL_TIM_DMABURST_BASEADDR_EGR
TIMx_EGR register is the DMA base
address for DMA burst
LL_TIM_DMABURST_BASEADDR_CCMR1
TIMx_CCMR1 register is the DMA base
address for DMA burst
LL_TIM_DMABURST_BASEADDR_CCMR2
TIMx_CCMR2 register is the DMA base
address for DMA burst
LL_TIM_DMABURST_BASEADDR_CCER
TIMx_CCER register is the DMA base
address for DMA burst
LL_TIM_DMABURST_BASEADDR_CNT
TIMx_CNT register is the DMA base
address for DMA burst
LL_TIM_DMABURST_BASEADDR_PSC
TIMx_PSC register is the DMA base
address for DMA burst
LL_TIM_DMABURST_BASEADDR_ARR
TIMx_ARR register is the DMA base
address for DMA burst
LL_TIM_DMABURST_BASEADDR_RCR
TIMx_RCR register is the DMA base
address for DMA burst
LL_TIM_DMABURST_BASEADDR_CCR1
TIMx_CCR1 register is the DMA base
address for DMA burst
LL_TIM_DMABURST_BASEADDR_CCR2
TIMx_CCR2 register is the DMA base
address for DMA burst
LL_TIM_DMABURST_BASEADDR_CCR3
TIMx_CCR3 register is the DMA base
address for DMA burst
LL_TIM_DMABURST_BASEADDR_CCR4
TIMx_CCR4 register is the DMA base
address for DMA burst
LL_TIM_DMABURST_BASEADDR_BDTR
TIMx_BDTR register is the DMA base
address for DMA burst
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
DMA Burst Length
LL_TIM_DMABURST_LENGTH_1TRANSFER
Transfer is done to 1 register starting
from the DMA burst base address
LL_TIM_DMABURST_LENGTH_2TRANSFERS
Transfer is done to 2 registers starting
from the DMA burst base address
LL_TIM_DMABURST_LENGTH_3TRANSFERS
Transfer is done to 3 registers starting
from the DMA burst base address
LL_TIM_DMABURST_LENGTH_4TRANSFERS
Transfer is done to 4 registers starting
from the DMA burst base address
LL_TIM_DMABURST_LENGTH_5TRANSFERS
Transfer is done to 5 registers starting
from the DMA burst base address
LL_TIM_DMABURST_LENGTH_6TRANSFERS
Transfer is done to 6 registers starting
from the DMA burst base address
LL_TIM_DMABURST_LENGTH_7TRANSFERS
Transfer is done to 7 registers starting
from the DMA burst base address
LL_TIM_DMABURST_LENGTH_8TRANSFERS
Transfer is done to 1 registers starting
from the DMA burst base address
LL_TIM_DMABURST_LENGTH_9TRANSFERS
Transfer is done to 9 registers starting
from the DMA burst base address
LL_TIM_DMABURST_LENGTH_10TRANSFERS
Transfer is done to 10 registers starting
from the DMA burst base address
LL_TIM_DMABURST_LENGTH_11TRANSFERS
Transfer is done to 11 registers starting
from the DMA burst base address
LL_TIM_DMABURST_LENGTH_12TRANSFERS
Transfer is done to 12 registers starting
from the DMA burst base address
LL_TIM_DMABURST_LENGTH_13TRANSFERS
Transfer is done to 13 registers starting
from the DMA burst base address
LL_TIM_DMABURST_LENGTH_14TRANSFERS
Transfer is done to 14 registers starting
from the DMA burst base address
LL_TIM_DMABURST_LENGTH_15TRANSFERS
Transfer is done to 15 registers starting
from the DMA burst base address
LL_TIM_DMABURST_LENGTH_16TRANSFERS
Transfer is done to 16 registers starting
from the DMA burst base address
LL_TIM_DMABURST_LENGTH_17TRANSFERS
Transfer is done to 17 registers starting
from the DMA burst base address
LL_TIM_DMABURST_LENGTH_18TRANSFERS
Transfer is done to 18 registers starting
from the DMA burst base address
Encoder Mode
LL_TIM_ENCODERMODE_X2_TI1
Encoder mode 1 - Counter counts up/down on
TI2FP2 edge depending on TI1FP1 level
LL_TIM_ENCODERMODE_X2_TI2
Encoder mode 2 - Counter counts up/down on
TI1FP1 edge depending on TI2FP2 level
LL_TIM_ENCODERMODE_X4_TI12
Encoder mode 3 - Counter counts up/down on both
TI1FP1 and TI2FP2 edges depending on the level
DocID026525 Rev 6
1153/1320
LL TIM Generic Driver
UM1785
of the other input l
External Trigger Filter
LL_TIM_ETR_FILTER_FDIV1
No filter, sampling is done at fDTS
LL_TIM_ETR_FILTER_FDIV1_N2
fSAMPLING=fCK_INT, N=2
LL_TIM_ETR_FILTER_FDIV1_N4
fSAMPLING=fCK_INT, N=4
LL_TIM_ETR_FILTER_FDIV1_N8
fSAMPLING=fCK_INT, N=8
LL_TIM_ETR_FILTER_FDIV2_N6
fSAMPLING=fDTS/2, N=6
LL_TIM_ETR_FILTER_FDIV2_N8
fSAMPLING=fDTS/2, N=8
LL_TIM_ETR_FILTER_FDIV4_N6
fSAMPLING=fDTS/4, N=6
LL_TIM_ETR_FILTER_FDIV4_N8
fSAMPLING=fDTS/4, N=8
LL_TIM_ETR_FILTER_FDIV8_N6
fSAMPLING=fDTS/8, N=8
LL_TIM_ETR_FILTER_FDIV8_N8
fSAMPLING=fDTS/16, N=5
LL_TIM_ETR_FILTER_FDIV16_N5
fSAMPLING=fDTS/16, N=6
LL_TIM_ETR_FILTER_FDIV16_N6
fSAMPLING=fDTS/16, N=8
LL_TIM_ETR_FILTER_FDIV16_N8
fSAMPLING=fDTS/16, N=5
LL_TIM_ETR_FILTER_FDIV32_N5
fSAMPLING=fDTS/32, N=5
LL_TIM_ETR_FILTER_FDIV32_N6
fSAMPLING=fDTS/32, N=6
LL_TIM_ETR_FILTER_FDIV32_N8
fSAMPLING=fDTS/32, N=8
External Trigger Polarity
LL_TIM_ETR_POLARITY_NONINVERTED
ETR is non-inverted, active at high level or
rising edge
LL_TIM_ETR_POLARITY_INVERTED
ETR is inverted, active at low level or falling
edge
External Trigger Prescaler
LL_TIM_ETR_PRESCALER_DIV1
ETR prescaler OFF
LL_TIM_ETR_PRESCALER_DIV2
ETR frequency is divided by 2
LL_TIM_ETR_PRESCALER_DIV4
ETR frequency is divided by 4
LL_TIM_ETR_PRESCALER_DIV8
ETR frequency is divided by 8
Get Flags Defines
1154/1320
LL_TIM_SR_UIF
Update interrupt flag
LL_TIM_SR_CC1IF
Capture/compare 1 interrupt flag
LL_TIM_SR_CC2IF
Capture/compare 2 interrupt flag
LL_TIM_SR_CC3IF
Capture/compare 3 interrupt flag
LL_TIM_SR_CC4IF
Capture/compare 4 interrupt flag
LL_TIM_SR_COMIF
COM interrupt flag
LL_TIM_SR_TIF
Trigger interrupt flag
LL_TIM_SR_BIF
Break interrupt flag
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
LL_TIM_SR_CC1OF
Capture/Compare 1 overcapture flag
LL_TIM_SR_CC2OF
Capture/Compare 2 overcapture flag
LL_TIM_SR_CC3OF
Capture/Compare 3 overcapture flag
LL_TIM_SR_CC4OF
Capture/Compare 4 overcapture flag
Input Configuration Prescaler
LL_TIM_ICPSC_DIV1
No prescaler, capture is done each time an edge is detected on
the capture input
LL_TIM_ICPSC_DIV2
Capture is done once every 2 events
LL_TIM_ICPSC_DIV4
Capture is done once every 4 events
LL_TIM_ICPSC_DIV8
Capture is done once every 8 events
Input Configuration Filter
LL_TIM_IC_FILTER_FDIV1
No filter, sampling is done at fDTS
LL_TIM_IC_FILTER_FDIV1_N2
fSAMPLING=fCK_INT, N=2
LL_TIM_IC_FILTER_FDIV1_N4
fSAMPLING=fCK_INT, N=4
LL_TIM_IC_FILTER_FDIV1_N8
fSAMPLING=fCK_INT, N=8
LL_TIM_IC_FILTER_FDIV2_N6
fSAMPLING=fDTS/2, N=6
LL_TIM_IC_FILTER_FDIV2_N8
fSAMPLING=fDTS/2, N=8
LL_TIM_IC_FILTER_FDIV4_N6
fSAMPLING=fDTS/4, N=6
LL_TIM_IC_FILTER_FDIV4_N8
fSAMPLING=fDTS/4, N=8
LL_TIM_IC_FILTER_FDIV8_N6
fSAMPLING=fDTS/8, N=6
LL_TIM_IC_FILTER_FDIV8_N8
fSAMPLING=fDTS/8, N=8
LL_TIM_IC_FILTER_FDIV16_N5
fSAMPLING=fDTS/16, N=5
LL_TIM_IC_FILTER_FDIV16_N6
fSAMPLING=fDTS/16, N=6
LL_TIM_IC_FILTER_FDIV16_N8
fSAMPLING=fDTS/16, N=8
LL_TIM_IC_FILTER_FDIV32_N5
fSAMPLING=fDTS/32, N=5
LL_TIM_IC_FILTER_FDIV32_N6
fSAMPLING=fDTS/32, N=6
LL_TIM_IC_FILTER_FDIV32_N8
fSAMPLING=fDTS/32, N=8
Input Configuration Polarity
LL_TIM_IC_POLARITY_RISING
The circuit is sensitive to TIxFP1 rising edge,
TIxFP1 is not inverted
LL_TIM_IC_POLARITY_FALLING
The circuit is sensitive to TIxFP1 falling edge,
TIxFP1 is inverted
LL_TIM_IC_POLARITY_BOTHEDGE
The circuit is sensitive to both TIxFP1 rising and
falling edges, TIxFP1 is not inverted
IT Defines
LL_TIM_DIER_UIE
Update interrupt enable
LL_TIM_DIER_CC1IE
Capture/compare 1 interrupt enable
LL_TIM_DIER_CC2IE
Capture/compare 2 interrupt enable
DocID026525 Rev 6
1155/1320
LL TIM Generic Driver
LL_TIM_DIER_CC3IE
Capture/compare 3 interrupt enable
UM1785
LL_TIM_DIER_CC4IE
Capture/compare 4 interrupt enable
LL_TIM_DIER_COMIE
COM interrupt enable
LL_TIM_DIER_TIE
Trigger interrupt enable
LL_TIM_DIER_BIE
Break interrupt enable
Lock Level
LL_TIM_LOCKLEVEL_OFF
LOCK OFF - No bit is write protected
LL_TIM_LOCKLEVEL_1
LOCK Level 1
LL_TIM_LOCKLEVEL_2
LOCK Level 2
LL_TIM_LOCKLEVEL_3
LOCK Level 3
Output Configuration Idle State
LL_TIM_OCIDLESTATE_LOW
OCx=0 (after a dead-time if OC is implemented) when
MOE=0
LL_TIM_OCIDLESTATE_HIGH
OCx=1 (after a dead-time if OC is implemented) when
MOE=0
Output Configuration Mode
LL_TIM_OCMODE_FROZEN
The comparison between the output compare
register TIMx_CCRy and the counter
TIMx_CNT has no effect on the output channel
level
LL_TIM_OCMODE_ACTIVE
OCyREF is forced high on compare match
LL_TIM_OCMODE_INACTIVE
OCyREF is forced low on compare match
LL_TIM_OCMODE_TOGGLE
OCyREF toggles on compare match
LL_TIM_OCMODE_FORCED_INACTIVE
OCyREF is forced low
LL_TIM_OCMODE_FORCED_ACTIVE
OCyREF is forced high
LL_TIM_OCMODE_PWM1
In upcounting, channel y is active as long as
TIMx_CNTTIMx_CCRy else active.
LL_TIM_OCMODE_PWM2
In upcounting, channel y is inactive as long as
TIMx_CNTTIMx_CCRy else inactive
Output Configuration Polarity
LL_TIM_OCPOLARITY_HIGH
OCxactive high
LL_TIM_OCPOLARITY_LOW
OCxactive low
OCREF clear input selection
1156/1320
LL_TIM_OCREF_CLR_INT_OCREF_CLR
OCREF_CLR_INT is connected to the
OCREF_CLR input
LL_TIM_OCREF_CLR_INT_ETR
OCREF_CLR_INT is connected to ETRF
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
Output Configuration State
LL_TIM_OCSTATE_DISABLE
OCx is not active
LL_TIM_OCSTATE_ENABLE
OCx signal is output on the corresponding output pin
One Pulse Mode
LL_TIM_ONEPULSEMODE_SINGLE
Counter is not stopped at update event
LL_TIM_ONEPULSEMODE_REPETITIVE
Counter stops counting at the next update
event
OSSI
LL_TIM_OSSI_DISABLE
When inactive, OCx/OCxN outputs are disabled
LL_TIM_OSSI_ENABLE
When inactive, OxC/OCxN outputs are first forced with their
inactive level then forced to their idle level after the deadtime
OSSR
LL_TIM_OSSR_DISABLE
When inactive, OCx/OCxN outputs are disabled
LL_TIM_OSSR_ENABLE
When inactive, OC/OCN outputs are enabled with their
inactive level as soon as CCxE=1 or CCxNE=1
Slave Mode
LL_TIM_SLAVEMODE_DISABLED
Slave mode disabled
LL_TIM_SLAVEMODE_RESET
Reset Mode - Rising edge of the selected trigger
input (TRGI) reinitializes the counter
LL_TIM_SLAVEMODE_GATED
Gated Mode - The counter clock is enabled when the
trigger input (TRGI) is high
LL_TIM_SLAVEMODE_TRIGGER
Trigger Mode - The counter starts at a rising edge of
the trigger TRGI
Trigger Output
LL_TIM_TRGO_RESET
UG bit from the TIMx_EGR register is used as trigger output
LL_TIM_TRGO_ENABLE
Counter Enable signal (CNT_EN) is used as trigger output
LL_TIM_TRGO_UPDATE
Update event is used as trigger output
LL_TIM_TRGO_CC1IF
CC1 capture or a compare match is used as trigger output
LL_TIM_TRGO_OC1REF
OC1REF signal is used as trigger output
LL_TIM_TRGO_OC2REF
OC2REF signal is used as trigger output
LL_TIM_TRGO_OC3REF
OC3REF signal is used as trigger output
LL_TIM_TRGO_OC4REF
OC4REF signal is used as trigger output
Trigger Selection
LL_TIM_TS_ITR0
Internal Trigger 0 (ITR0) is used as trigger input
LL_TIM_TS_ITR1
Internal Trigger 1 (ITR1) is used as trigger input
LL_TIM_TS_ITR2
Internal Trigger 2 (ITR2) is used as trigger input
LL_TIM_TS_ITR3
Internal Trigger 3 (ITR3) is used as trigger input
LL_TIM_TS_TI1F_ED
TI1 Edge Detector (TI1F_ED) is used as trigger input
DocID026525 Rev 6
1157/1320
LL TIM Generic Driver
LL_TIM_TS_TI1FP1
Filtered Timer Input 1 (TI1FP1) is used as trigger input
UM1785
LL_TIM_TS_TI2FP2
Filtered Timer Input 2 (TI12P2) is used as trigger input
LL_TIM_TS_ETRF
Filtered external Trigger (ETRF) is used as trigger input
Update Source
LL_TIM_UPDATESOURCE_REGULAR
Counter overflow/underflow, Setting the UG bit
or Update generation through the slave mode
controller generates an update request
LL_TIM_UPDATESOURCE_COUNTER
Only counter overflow/underflow generates an
update request
Exported_Macros
__LL_TIM_CALC_DEADTIME
Description:
HELPER macro calculating DTG[0:7] in the
TIMx_BDTR register to achieve the requested dead
time duration.
Parameters:
__TIMCLK__: timer input clock frequency (in Hz)
__CKD__: This parameter can be one of the
following values:
LL_TIM_CLOCKDIVISION_DIV1
LL_TIM_CLOCKDIVISION_DIV2
LL_TIM_CLOCKDIVISION_DIV4
__DT__: deadtime duration (in ns)
Return value:
DTG[0:7]
Notes:
ex: __LL_TIM_CALC_DEADTIME (80000000,
LL_TIM_GetClockDivision (), 120);
__LL_TIM_CALC_PSC
Description:
HELPER macro calculating the prescaler value to
achieve the required counter clock frequency.
Parameters:
__TIMCLK__: timer input clock frequency (in Hz)
__CNTCLK__: counter clock frequency (in Hz)
Return value:
Prescaler: value (between Min_Data=0 and
Max_Data=65535)
Notes:
ex: __LL_TIM_CALC_PSC (80000000, 1000000);
__LL_TIM_CALC_ARR
Description:
HELPER macro calculating the auto-reload value
to achieve the required output signal frequency.
1158/1320
DocID026525 Rev 6
UM1785
LL TIM Generic Driver
Parameters:
__TIMCLK__: timer input clock frequency (in Hz)
__PSC__: prescaler
__FREQ__: output signal frequency (in Hz)
Return value:
Auto-reload: value (between Min_Data=0 and
Max_Data=65535)
Notes:
ex: __LL_TIM_CALC_ARR (1000000,
LL_TIM_GetPrescaler (), 10000);
Description:
__LL_TIM_CALC_DELAY
HELPER macro calculating the compare value
required to achieve the required timer output
compare active/inactive delay.
Parameters:
__TIMCLK__: timer input clock frequency (in Hz)
__PSC__: prescaler
__DELAY__: timer output compare active/inactive
delay (in us)
Return value:
Compare: value (between Min_Data=0 and
Max_Data=65535)
Notes:
ex: __LL_TIM_CALC_DELAY (1000000,
LL_TIM_GetPrescaler (), 10);
Description:
__LL_TIM_CALC_PULSE
HELPER macro calculating the auto-reload value
to achieve the required pulse duration (when the
timer operates in one pulse mode).
Parameters:
__TIMCLK__: timer input clock frequency (in Hz)
__PSC__: prescaler
__DELAY__: timer output compare active/inactive
delay (in us)
__PULSE__: pulse duration (in us)
Return value:
Auto-reload: value (between Min_Data=0 and
Max_Data=65535)
Notes:
ex: __LL_TIM_CALC_PULSE (1000000,
LL_TIM_GetPrescaler (), 10, 20);
__LL_TIM_GET_ICPSC_RATIO
Description:
DocID026525 Rev 6
1159/1320
LL TIM Generic Driver
UM1785
HELPER macro retrieving the ratio of the input
capture prescaler.
Parameters:
__ICPSC__: This parameter can be one of the
following values:
LL_TIM_ICPSC_DIV1
LL_TIM_ICPSC_DIV2
LL_TIM_ICPSC_DIV4
LL_TIM_ICPSC_DIV8
Return value:
Input: capture prescaler ratio (1, 2, 4 or 8)
Notes:
ex: __LL_TIM_GET_ICPSC_RATIO
(LL_TIM_IC_GetPrescaler ());
Common Write and read registers Macros
LL_TIM_WriteReg
Description:
Write a value in TIM register.
Parameters:
__INSTANCE__: TIM Instance
__REG__: Register to be written
__VALUE__: Value to be written in the register
Return value:
None
LL_TIM_ReadReg
Description:
Read a value in TIM register.
Parameters:
__INSTANCE__: TIM Instance
__REG__: Register to be read
Return value:
Register: value
TIM Exported Constants
1160/1320
LL_TIM_TIM14_TI1_RMP_GPIO
TIM14_TI1 is connected to Ored GPIO
LL_TIM_TIM14_TI1_RMP_RTC_CLK
TIM14_TI1 is connected to RTC clock
LL_TIM_TIM14_TI1_RMP_HSE
TIM14_TI1 is connected to HSE/32 clock
LL_TIM_TIM14_TI1_RMP_MCO
TIM14_TI1 is connected to MCO
DocID026525 Rev 6
UM1785
LL USART Generic Driver
68
LL USART Generic Driver
68.1
USART Firmware driver registers structures
68.1.1
LL_USART_InitTypeDef
Data Fields
uint32_t BaudRate
uint32_t DataWidth
uint32_t StopBits
uint32_t Parity
uint32_t TransferDirection
uint32_t HardwareFlowControl
uint32_t OverSampling
Field Documentation
uint32_t LL_USART_InitTypeDef::BaudRate
This field defines expected Usart communication baud rate.This feature can be
modified afterwards using unitary function LL_USART_SetBaudRate().
uint32_t LL_USART_InitTypeDef::DataWidth
Specifies the number of data bits transmitted or received in a frame. This parameter
can be a value of USART_LL_EC_DATAWIDTH.This feature can be modified
afterwards using unitary function LL_USART_SetDataWidth().
uint32_t LL_USART_InitTypeDef::StopBits
Specifies the number of stop bits transmitted. This parameter can be a value of
USART_LL_EC_STOPBITS.This feature can be modified afterwards using unitary
function LL_USART_SetStopBitsLength().
uint32_t LL_USART_InitTypeDef::Parity
Specifies the parity mode. This parameter can be a value of
USART_LL_EC_PARITY.This feature can be modified afterwards using unitary
function LL_USART_SetParity().
uint32_t LL_USART_InitTypeDef::TransferDirection
Specifies whether the Receive and/or Transmit mode is enabled or disabled. This
parameter can be a value of USART_LL_EC_DIRECTION.This feature can be
modified afterwards using unitary function LL_USART_SetTransferDirection().
uint32_t LL_USART_InitTypeDef::HardwareFlowControl
Specifies whether the hardware flow control mode is enabled or disabled. This
parameter can be a value of USART_LL_EC_HWCONTROL.This feature can be
modified afterwards using unitary function LL_USART_SetHWFlowCtrl().
uint32_t LL_USART_InitTypeDef::OverSampling
Specifies whether USART oversampling mode is 16 or 8. This parameter can be a
value of USART_LL_EC_OVERSAMPLING.This feature can be modified afterwards
using unitary function LL_USART_SetOverSampling().
68.1.2
LL_USART_ClockInitTypeDef
Data Fields
uint32_t ClockOutput
uint32_t ClockPolarity
uint32_t ClockPhase
uint32_t LastBitClockPulse
DocID026525 Rev 6
1161/1320
LL USART Generic Driver
Field Documentation
UM1785
uint32_t LL_USART_ClockInitTypeDef::ClockOutput
Specifies whether the USART clock is enabled or disabled. This parameter can be a
value of USART_LL_EC_CLOCK.USART HW configuration can be modified
afterwards using unitary functions LL_USART_EnableSCLKOutput() or
LL_USART_DisableSCLKOutput(). For more details, refer to description of this
function.
uint32_t LL_USART_ClockInitTypeDef::ClockPolarity
Specifies the steady state of the serial clock. This parameter can be a value of
USART_LL_EC_POLARITY.USART HW configuration can be modified afterwards
using unitary functions LL_USART_SetClockPolarity(). For more details, refer to
description of this function.
uint32_t LL_USART_ClockInitTypeDef::ClockPhase
Specifies the clock transition on which the bit capture is made. This parameter can be
a value of USART_LL_EC_PHASE.USART HW configuration can be modified
afterwards using unitary functions LL_USART_SetClockPhase(). For more details,
refer to description of this function.
uint32_t LL_USART_ClockInitTypeDef::LastBitClockPulse
Specifies whether the clock pulse corresponding to the last transmitted data bit (MSB)
has to be output on the SCLK pin in synchronous mode. This parameter can be a
value of USART_LL_EC_LASTCLKPULSE.USART HW configuration can be
modified afterwards using unitary functions LL_USART_SetLastClkPulseOutput().
For more details, refer to description of this function.
68.2
USART Firmware driver API description
68.2.1
Detailed description of functions
LL_USART_Enable
Function name
__STATIC_INLINE void LL_USART_Enable (USART_TypeDef *
USARTx)
Function description
USART Enable.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 UE LL_USART_Enable
LL_USART_Disable
1162/1320
Function name
__STATIC_INLINE void LL_USART_Disable (USART_TypeDef
* USARTx)
Function description
USART Disable (all USART prescalers and outputs are disabled)
Parameters
USARTx: USART Instance
Return values
None
Notes
When USART is disabled, USART prescalers and outputs are
stopped immediately, and current operations are discarded.
The configuration of the USART is kept, but all the status
DocID026525 Rev 6
UM1785
LL USART Generic Driver
flags, in the USARTx_ISR are set to their default values.
Reference Manual to
LL API cross
reference:
CR1 UE LL_USART_Disable
LL_USART_IsEnabled
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabled
(USART_TypeDef * USARTx)
Function description
Indicate if USART is enabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 UE LL_USART_IsEnabled
LL_USART_EnableInStopMode
Function name
__STATIC_INLINE void LL_USART_EnableInStopMode
(USART_TypeDef * USARTx)
Function description
USART enabled in STOP Mode.
Parameters
USARTx: USART Instance
Return values
None
Notes
When this function is enabled, USART is able to wake up the
MCU from Stop mode, provided that USART clock selection is
HSI or LSE in RCC.
Macro
IS_UART_WAKEUP_FROMSTOP_INSTANCE(USARTx) can
be used to check whether or not Wake-up from Stop mode
feature is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR1 UESM LL_USART_EnableInStopMode
LL_USART_DisableInStopMode
Function name
__STATIC_INLINE void LL_USART_DisableInStopMode
(USART_TypeDef * USARTx)
Function description
USART disabled in STOP Mode.
Parameters
USARTx: USART Instance
Return values
None
Notes
When this function is disabled, USART is not able to wake up
the MCU from Stop mode
Macro
IS_UART_WAKEUP_FROMSTOP_INSTANCE(USARTx) can
be used to check whether or not Wake-up from Stop mode
feature is supported by the USARTx instance.
DocID026525 Rev 6
1163/1320
LL USART Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
CR1 UESM LL_USART_DisableInStopMode
LL_USART_IsEnabledInStopMode
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledInStopMode
(USART_TypeDef * USARTx)
Function description
Indicate if USART is enabled in STOP Mode (able to wake up
MCU from Stop mode or not)
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro
IS_UART_WAKEUP_FROMSTOP_INSTANCE(USARTx) can
be used to check whether or not Wake-up from Stop mode
feature is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR1 UESM LL_USART_IsEnabledInStopMode
LL_USART_EnableDirectionRx
Function name
__STATIC_INLINE void LL_USART_EnableDirectionRx
(USART_TypeDef * USARTx)
Function description
Receiver Enable (Receiver is enabled and begins searching for a
start bit)
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 RE LL_USART_EnableDirectionRx
LL_USART_DisableDirectionRx
Function name
__STATIC_INLINE void LL_USART_DisableDirectionRx
(USART_TypeDef * USARTx)
Function description
Receiver Disable.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 RE LL_USART_DisableDirectionRx
LL_USART_EnableDirectionTx
Function name
1164/1320
__STATIC_INLINE void LL_USART_EnableDirectionTx
(USART_TypeDef * USARTx)
DocID026525 Rev 6
UM1785
LL USART Generic Driver
Function description
Transmitter Enable.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 TE LL_USART_EnableDirectionTx
LL_USART_DisableDirectionTx
Function name
__STATIC_INLINE void LL_USART_DisableDirectionTx
(USART_TypeDef * USARTx)
Function description
Transmitter Disable.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 TE LL_USART_DisableDirectionTx
LL_USART_SetTransferDirection
Function name
__STATIC_INLINE void LL_USART_SetTransferDirection
(USART_TypeDef * USARTx, uint32_t TransferDirection)
Function description
Configure simultaneously enabled/disabled states of Transmitter
and Receiver.
Parameters
USARTx: USART Instance
TransferDirection: This parameter can be one of the
following values:
LL_USART_DIRECTION_NONE
LL_USART_DIRECTION_RX
LL_USART_DIRECTION_TX
LL_USART_DIRECTION_TX_RX
Return values
None
Reference Manual to
LL API cross
reference:
CR1 RE LL_USART_SetTransferDirection
CR1 TE LL_USART_SetTransferDirection
LL_USART_GetTransferDirection
Function name
__STATIC_INLINE uint32_t LL_USART_GetTransferDirection
(USART_TypeDef * USARTx)
Function description
Return enabled/disabled states of Transmitter and Receiver.
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values:
LL_USART_DIRECTION_NONE
LL_USART_DIRECTION_RX
LL_USART_DIRECTION_TX
DocID026525 Rev 6
1165/1320
LL USART Generic Driver
UM1785
LL_USART_DIRECTION_TX_RX
Reference Manual to
LL API cross
reference:
CR1 RE LL_USART_GetTransferDirection
CR1 TE LL_USART_GetTransferDirection
LL_USART_SetParity
Function name
__STATIC_INLINE void LL_USART_SetParity
(USART_TypeDef * USARTx, uint32_t Parity)
Function description
Configure Parity (enabled/disabled and parity mode if enabled).
Parameters
USARTx: USART Instance
Parity: This parameter can be one of the following values:
LL_USART_PARITY_NONE
LL_USART_PARITY_EVEN
LL_USART_PARITY_ODD
Return values
None
Notes
This function selects if hardware parity control (generation
and detection) is enabled or disabled. When the parity control
is enabled (Odd or Even), computed parity bit is inserted at
the MSB position (9th or 8th bit depending on data width) and
parity is checked on the received data.
Reference Manual to
LL API cross
reference:
CR1 PS LL_USART_SetParity
CR1 PCE LL_USART_SetParity
LL_USART_GetParity
Function name
__STATIC_INLINE uint32_t LL_USART_GetParity
(USART_TypeDef * USARTx)
Function description
Return Parity configuration (enabled/disabled and parity mode if
enabled)
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values:
LL_USART_PARITY_NONE
LL_USART_PARITY_EVEN
LL_USART_PARITY_ODD
Reference Manual to
LL API cross
reference:
CR1 PS LL_USART_GetParity
CR1 PCE LL_USART_GetParity
LL_USART_SetWakeUpMethod
Function name
__STATIC_INLINE void LL_USART_SetWakeUpMethod
(USART_TypeDef * USARTx, uint32_t Method)
Function description
Set Receiver Wake Up method from Mute mode.
Parameters
1166/1320
USARTx: USART Instance
Method: This parameter can be one of the following values:
LL_USART_WAKEUP_IDLELINE
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_WAKEUP_ADDRESSMARK
Return values
None
Reference Manual to
LL API cross
reference:
CR1 WAKE LL_USART_SetWakeUpMethod
LL_USART_GetWakeUpMethod
Function name
__STATIC_INLINE uint32_t LL_USART_GetWakeUpMethod
(USART_TypeDef * USARTx)
Function description
Return Receiver Wake Up method from Mute mode.
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values:
LL_USART_WAKEUP_IDLELINE
LL_USART_WAKEUP_ADDRESSMARK
Reference Manual to
LL API cross
reference:
CR1 WAKE LL_USART_GetWakeUpMethod
LL_USART_SetDataWidth
Function name
__STATIC_INLINE void LL_USART_SetDataWidth
(USART_TypeDef * USARTx, uint32_t DataWidth)
Function description
Set Word length (i.e.
Parameters
USARTx: USART Instance
DataWidth: This parameter can be one of the following
values: (*) Values not available on all devices
LL_USART_DATAWIDTH_7B (*)
LL_USART_DATAWIDTH_8B
LL_USART_DATAWIDTH_9B
Return values
None
Reference Manual to
LL API cross
reference:
CR1 M0 LL_USART_SetDataWidth
CR1 M1 LL_USART_SetDataWidth
LL_USART_GetDataWidth
Function name
__STATIC_INLINE uint32_t LL_USART_GetDataWidth
(USART_TypeDef * USARTx)
Function description
Return Word length (i.e.
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values: (*)
Values not available on all devices
LL_USART_DATAWIDTH_7B (*)
LL_USART_DATAWIDTH_8B
LL_USART_DATAWIDTH_9B
Reference Manual to
CR1 M0 LL_USART_GetDataWidth
DocID026525 Rev 6
1167/1320
LL USART Generic Driver
LL API cross
reference:
UM1785
CR1 M1 LL_USART_GetDataWidth
LL_USART_EnableMuteMode
Function name
__STATIC_INLINE void LL_USART_EnableMuteMode
(USART_TypeDef * USARTx)
Function description
Allow switch between Mute Mode and Active mode.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 MME LL_USART_EnableMuteMode
LL_USART_DisableMuteMode
Function name
__STATIC_INLINE void LL_USART_DisableMuteMode
(USART_TypeDef * USARTx)
Function description
Prevent Mute Mode use.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 MME LL_USART_DisableMuteMode
LL_USART_IsEnabledMuteMode
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledMuteMode
(USART_TypeDef * USARTx)
Function description
Indicate if switch between Mute Mode and Active mode is allowed.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 MME LL_USART_IsEnabledMuteMode
LL_USART_SetOverSampling
Function name
__STATIC_INLINE void LL_USART_SetOverSampling
(USART_TypeDef * USARTx, uint32_t OverSampling)
Function description
Set Oversampling to 8-bit or 16-bit mode.
Parameters
1168/1320
USARTx: USART Instance
OverSampling: This parameter can be one of the following
values:
LL_USART_OVERSAMPLING_16
LL_USART_OVERSAMPLING_8
DocID026525 Rev 6
UM1785
LL USART Generic Driver
Return values
None
Reference Manual to
LL API cross
reference:
CR1 OVER8 LL_USART_SetOverSampling
LL_USART_GetOverSampling
Function name
__STATIC_INLINE uint32_t LL_USART_GetOverSampling
(USART_TypeDef * USARTx)
Function description
Return Oversampling mode.
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values:
LL_USART_OVERSAMPLING_16
LL_USART_OVERSAMPLING_8
Reference Manual to
LL API cross
reference:
CR1 OVER8 LL_USART_GetOverSampling
LL_USART_SetLastClkPulseOutput
Function name
__STATIC_INLINE void LL_USART_SetLastClkPulseOutput
(USART_TypeDef * USARTx, uint32_t LastBitClockPulse)
Function description
Configure if Clock pulse of the last data bit is output to the SCLK
pin or not.
Parameters
USARTx: USART Instance
LastBitClockPulse: This parameter can be one of the
following values:
LL_USART_LASTCLKPULSE_NO_OUTPUT
LL_USART_LASTCLKPULSE_OUTPUT
Return values
None
Notes
Macro IS_USART_INSTANCE(USARTx) can be used to
check whether or not Synchronous mode is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR2 LBCL LL_USART_SetLastClkPulseOutput
LL_USART_GetLastClkPulseOutput
Function name
__STATIC_INLINE uint32_t
LL_USART_GetLastClkPulseOutput (USART_TypeDef *
USARTx)
Function description
Retrieve Clock pulse of the last data bit output configuration (Last
bit Clock pulse output to the SCLK pin or not)
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values:
LL_USART_LASTCLKPULSE_NO_OUTPUT
DocID026525 Rev 6
1169/1320
LL USART Generic Driver
UM1785
LL_USART_LASTCLKPULSE_OUTPUT
Notes
Macro IS_USART_INSTANCE(USARTx) can be used to
check whether or not Synchronous mode is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR2 LBCL LL_USART_GetLastClkPulseOutput
LL_USART_SetClockPhase
Function name
__STATIC_INLINE void LL_USART_SetClockPhase
(USART_TypeDef * USARTx, uint32_t ClockPhase)
Function description
Select the phase of the clock output on the SCLK pin in
synchronous mode.
Parameters
USARTx: USART Instance
ClockPhase: This parameter can be one of the following
values:
LL_USART_PHASE_1EDGE
LL_USART_PHASE_2EDGE
Return values
None
Notes
Macro IS_USART_INSTANCE(USARTx) can be used to
check whether or not Synchronous mode is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR2 CPHA LL_USART_SetClockPhase
LL_USART_GetClockPhase
1170/1320
Function name
__STATIC_INLINE uint32_t LL_USART_GetClockPhase
(USART_TypeDef * USARTx)
Function description
Return phase of the clock output on the SCLK pin in synchronous
mode.
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values:
LL_USART_PHASE_1EDGE
LL_USART_PHASE_2EDGE
Notes
Macro IS_USART_INSTANCE(USARTx) can be used to
check whether or not Synchronous mode is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR2 CPHA LL_USART_GetClockPhase
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_SetClockPolarity
Function name
__STATIC_INLINE void LL_USART_SetClockPolarity
(USART_TypeDef * USARTx, uint32_t ClockPolarity)
Function description
Select the polarity of the clock output on the SCLK pin in
synchronous mode.
Parameters
USARTx: USART Instance
ClockPolarity: This parameter can be one of the following
values:
LL_USART_POLARITY_LOW
LL_USART_POLARITY_HIGH
Return values
None
Notes
Macro IS_USART_INSTANCE(USARTx) can be used to
check whether or not Synchronous mode is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR2 CPOL LL_USART_SetClockPolarity
LL_USART_GetClockPolarity
Function name
__STATIC_INLINE uint32_t LL_USART_GetClockPolarity
(USART_TypeDef * USARTx)
Function description
Return polarity of the clock output on the SCLK pin in synchronous
mode.
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values:
LL_USART_POLARITY_LOW
LL_USART_POLARITY_HIGH
Notes
Macro IS_USART_INSTANCE(USARTx) can be used to
check whether or not Synchronous mode is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR2 CPOL LL_USART_GetClockPolarity
LL_USART_ConfigClock
Function name
__STATIC_INLINE void LL_USART_ConfigClock
(USART_TypeDef * USARTx, uint32_t Phase, uint32_t Polarity,
uint32_t LBCPOutput)
Function description
Configure Clock signal format (Phase Polarity and choice about
output of last bit clock pulse)
Parameters
USARTx: USART Instance
Phase: This parameter can be one of the following values:
LL_USART_PHASE_1EDGE
LL_USART_PHASE_2EDGE
Polarity: This parameter can be one of the following values:
DocID026525 Rev 6
1171/1320
LL USART Generic Driver
UM1785
LL_USART_POLARITY_LOW
LL_USART_POLARITY_HIGH
LBCPOutput: This parameter can be one of the following
values:
LL_USART_LASTCLKPULSE_NO_OUTPUT
LL_USART_LASTCLKPULSE_OUTPUT
Return values
None
Notes
Macro IS_USART_INSTANCE(USARTx) can be used to
check whether or not Synchronous mode is supported by the
USARTx instance.
Call of this function is equivalent to following function call
sequence : Clock Phase configuration using
LL_USART_SetClockPhase() functionClock Polarity
configuration using LL_USART_SetClockPolarity()
functionOutput of Last bit Clock pulse configuration using
LL_USART_SetLastClkPulseOutput() function
Reference Manual to
LL API cross
reference:
CR2 CPHA LL_USART_ConfigClock
CR2 CPOL LL_USART_ConfigClock
CR2 LBCL LL_USART_ConfigClock
LL_USART_EnableSCLKOutput
Function name
__STATIC_INLINE void LL_USART_EnableSCLKOutput
(USART_TypeDef * USARTx)
Function description
Enable Clock output on SCLK pin.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_USART_INSTANCE(USARTx) can be used to
check whether or not Synchronous mode is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR2 CLKEN LL_USART_EnableSCLKOutput
LL_USART_DisableSCLKOutput
1172/1320
Function name
__STATIC_INLINE void LL_USART_DisableSCLKOutput
(USART_TypeDef * USARTx)
Function description
Disable Clock output on SCLK pin.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_USART_INSTANCE(USARTx) can be used to
check whether or not Synchronous mode is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR2 CLKEN LL_USART_DisableSCLKOutput
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_IsEnabledSCLKOutput
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledSCLKOutput
(USART_TypeDef * USARTx)
Function description
Indicate if Clock output on SCLK pin is enabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro IS_USART_INSTANCE(USARTx) can be used to
check whether or not Synchronous mode is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR2 CLKEN LL_USART_IsEnabledSCLKOutput
LL_USART_SetStopBitsLength
Function name
__STATIC_INLINE void LL_USART_SetStopBitsLength
(USART_TypeDef * USARTx, uint32_t StopBits)
Function description
Set the length of the stop bits.
Parameters
USARTx: USART Instance
StopBits: This parameter can be one of the following values:
(*) Values not available on all devices
LL_USART_STOPBITS_0_5 (*)
LL_USART_STOPBITS_1
LL_USART_STOPBITS_1_5 (*)
LL_USART_STOPBITS_2
Return values
None
Reference Manual to
LL API cross
reference:
CR2 STOP LL_USART_SetStopBitsLength
LL_USART_GetStopBitsLength
Function name
__STATIC_INLINE uint32_t LL_USART_GetStopBitsLength
(USART_TypeDef * USARTx)
Function description
Retrieve the length of the stop bits.
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values: (*)
Values not available on all devices
LL_USART_STOPBITS_0_5 (*)
LL_USART_STOPBITS_1
LL_USART_STOPBITS_1_5 (*)
LL_USART_STOPBITS_2
Reference Manual to
LL API cross
reference:
CR2 STOP LL_USART_GetStopBitsLength
DocID026525 Rev 6
1173/1320
LL USART Generic Driver
UM1785
LL_USART_ConfigCharacter
Function name
__STATIC_INLINE void LL_USART_ConfigCharacter
(USART_TypeDef * USARTx, uint32_t DataWidth, uint32_t
Parity, uint32_t StopBits)
Function description
Configure Character frame format (Datawidth, Parity control, Stop
Bits)
Parameters
USARTx: USART Instance
DataWidth: This parameter can be one of the following
values:
LL_USART_DATAWIDTH_7B (*)
LL_USART_DATAWIDTH_8B
LL_USART_DATAWIDTH_9B
Parity: This parameter can be one of the following values:
LL_USART_PARITY_NONE
LL_USART_PARITY_EVEN
LL_USART_PARITY_ODD
StopBits: This parameter can be one of the following values:
(*) Values not available on all devices
LL_USART_STOPBITS_0_5 (*)
LL_USART_STOPBITS_1
LL_USART_STOPBITS_1_5 (*)
LL_USART_STOPBITS_2
Return values
None
Notes
Call of this function is equivalent to following function call
sequence : Data Width configuration using
LL_USART_SetDataWidth() functionParity Control and mode
configuration using LL_USART_SetParity() functionStop bits
configuration using LL_USART_SetStopBitsLength() function
Reference Manual to
LL API cross
reference:
CR1 PS LL_USART_ConfigCharacter
CR1 PCE LL_USART_ConfigCharacter
CR1 M0 LL_USART_ConfigCharacter
CR1 M1 LL_USART_ConfigCharacter
CR2 STOP LL_USART_ConfigCharacter
LL_USART_SetTXRXSwap
1174/1320
Function name
__STATIC_INLINE void LL_USART_SetTXRXSwap
(USART_TypeDef * USARTx, uint32_t SwapConfig)
Function description
Configure TX/RX pins swapping setting.
Parameters
USARTx: USART Instance
SwapConfig: This parameter can be one of the following
values:
LL_USART_TXRX_STANDARD
LL_USART_TXRX_SWAPPED
Return values
None
Reference Manual to
LL API cross
reference:
CR2 SWAP LL_USART_SetTXRXSwap
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_GetTXRXSwap
Function name
__STATIC_INLINE uint32_t LL_USART_GetTXRXSwap
(USART_TypeDef * USARTx)
Function description
Retrieve TX/RX pins swapping configuration.
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values:
LL_USART_TXRX_STANDARD
LL_USART_TXRX_SWAPPED
Reference Manual to
LL API cross
reference:
CR2 SWAP LL_USART_GetTXRXSwap
LL_USART_SetRXPinLevel
Function name
__STATIC_INLINE void LL_USART_SetRXPinLevel
(USART_TypeDef * USARTx, uint32_t PinInvMethod)
Function description
Configure RX pin active level logic.
Parameters
USARTx: USART Instance
PinInvMethod: This parameter can be one of the following
values:
LL_USART_RXPIN_LEVEL_STANDARD
LL_USART_RXPIN_LEVEL_INVERTED
Return values
None
Reference Manual to
LL API cross
reference:
CR2 RXINV LL_USART_SetRXPinLevel
LL_USART_GetRXPinLevel
Function name
__STATIC_INLINE uint32_t LL_USART_GetRXPinLevel
(USART_TypeDef * USARTx)
Function description
Retrieve RX pin active level logic configuration.
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values:
LL_USART_RXPIN_LEVEL_STANDARD
LL_USART_RXPIN_LEVEL_INVERTED
Reference Manual to
LL API cross
reference:
CR2 RXINV LL_USART_GetRXPinLevel
LL_USART_SetTXPinLevel
Function name
__STATIC_INLINE void LL_USART_SetTXPinLevel
(USART_TypeDef * USARTx, uint32_t PinInvMethod)
Function description
Configure TX pin active level logic.
Parameters
USARTx: USART Instance
DocID026525 Rev 6
1175/1320
LL USART Generic Driver
UM1785
PinInvMethod: This parameter can be one of the following
values:
LL_USART_TXPIN_LEVEL_STANDARD
LL_USART_TXPIN_LEVEL_INVERTED
Return values
None
Reference Manual to
LL API cross
reference:
CR2 TXINV LL_USART_SetTXPinLevel
LL_USART_GetTXPinLevel
Function name
__STATIC_INLINE uint32_t LL_USART_GetTXPinLevel
(USART_TypeDef * USARTx)
Function description
Retrieve TX pin active level logic configuration.
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values:
LL_USART_TXPIN_LEVEL_STANDARD
LL_USART_TXPIN_LEVEL_INVERTED
Reference Manual to
LL API cross
reference:
CR2 TXINV LL_USART_GetTXPinLevel
LL_USART_SetBinaryDataLogic
Function name
__STATIC_INLINE void LL_USART_SetBinaryDataLogic
(USART_TypeDef * USARTx, uint32_t DataLogic)
Function description
Configure Binary data logic.
Parameters
USARTx: USART Instance
DataLogic: This parameter can be one of the following
values:
LL_USART_BINARY_LOGIC_POSITIVE
LL_USART_BINARY_LOGIC_NEGATIVE
Return values
None
Notes
Allow to define how Logical data from the data register are
send/received : either in positive/direct logic (1=H, 0=L) or in
negative/inverse logic (1=L, 0=H)
Reference Manual to
LL API cross
reference:
CR2 DATAINV LL_USART_SetBinaryDataLogic
LL_USART_GetBinaryDataLogic
Function name
__STATIC_INLINE uint32_t LL_USART_GetBinaryDataLogic
(USART_TypeDef * USARTx)
Function description
Retrieve Binary data configuration.
Parameters
1176/1320
USARTx: USART Instance
DocID026525 Rev 6
UM1785
LL USART Generic Driver
Return values
Returned: value can be one of the following values:
LL_USART_BINARY_LOGIC_POSITIVE
LL_USART_BINARY_LOGIC_NEGATIVE
Reference Manual to
LL API cross
reference:
CR2 DATAINV LL_USART_GetBinaryDataLogic
LL_USART_SetTransferBitOrder
Function name
__STATIC_INLINE void LL_USART_SetTransferBitOrder
(USART_TypeDef * USARTx, uint32_t BitOrder)
Function description
Configure transfer bit order (either Less or Most Significant Bit
First)
Parameters
USARTx: USART Instance
BitOrder: This parameter can be one of the following values:
LL_USART_BITORDER_LSBFIRST
LL_USART_BITORDER_MSBFIRST
Return values
None
Notes
MSB First means data is transmitted/received with the MSB
first, following the start bit. LSB First means data is
transmitted/received with data bit 0 first, following the start bit.
Reference Manual to
LL API cross
reference:
CR2 MSBFIRST LL_USART_SetTransferBitOrder
LL_USART_GetTransferBitOrder
Function name
__STATIC_INLINE uint32_t LL_USART_GetTransferBitOrder
(USART_TypeDef * USARTx)
Function description
Return transfer bit order (either Less or Most Significant Bit First)
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values:
LL_USART_BITORDER_LSBFIRST
LL_USART_BITORDER_MSBFIRST
Notes
MSB First means data is transmitted/received with the MSB
first, following the start bit. LSB First means data is
transmitted/received with data bit 0 first, following the start bit.
Reference Manual to
LL API cross
reference:
CR2 MSBFIRST LL_USART_GetTransferBitOrder
LL_USART_EnableAutoBaudRate
Function name
__STATIC_INLINE void LL_USART_EnableAutoBaudRate
(USART_TypeDef * USARTx)
Function description
Enable Auto Baud-Rate Detection.
Parameters
USARTx: USART Instance
DocID026525 Rev 6
1177/1320
LL USART Generic Driver
Return values
UM1785
None
Notes
Macro
IS_USART_AUTOBAUDRATE_DETECTION_INSTANCE(USA
RTx) can be used to check whether or not Auto Baud Rate
detection feature is supported by the USARTx instance.
Reference Manual
to LL API cross
reference:
CR2 ABREN LL_USART_EnableAutoBaudRate
LL_USART_DisableAutoBaudRate
Function name
__STATIC_INLINE void LL_USART_DisableAutoBaudRate
(USART_TypeDef * USARTx)
Function description
Disable Auto Baud-Rate Detection.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro
IS_USART_AUTOBAUDRATE_DETECTION_INSTANCE(USA
RTx) can be used to check whether or not Auto Baud Rate
detection feature is supported by the USARTx instance.
Reference Manual
to LL API cross
reference:
CR2 ABREN LL_USART_DisableAutoBaudRate
LL_USART_IsEnabledAutoBaud
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledAutoBaud
(USART_TypeDef * USARTx)
Function description
Indicate if Auto Baud-Rate Detection mechanism is enabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro
IS_USART_AUTOBAUDRATE_DETECTION_INSTANCE(USA
RTx) can be used to check whether or not Auto Baud Rate
detection feature is supported by the USARTx instance.
Reference Manual
to LL API cross
reference:
CR2 ABREN LL_USART_IsEnabledAutoBaud
LL_USART_SetAutoBaudRateMode
Function name
__STATIC_INLINE void LL_USART_SetAutoBaudRateMode
(USART_TypeDef * USARTx, uint32_t AutoBaudRateMode)
Function
description
Set Auto Baud-Rate mode bits.
Parameters
1178/1320
USARTx: USART Instance
AutoBaudRateMode: This parameter can be one of the following
DocID026525 Rev 6
UM1785
LL USART Generic Driver
values: (*) Values not available on all devices
LL_USART_AUTOBAUD_DETECT_ON_STARTBIT
LL_USART_AUTOBAUD_DETECT_ON_FALLINGEDGE
LL_USART_AUTOBAUD_DETECT_ON_7F_FRAME (*)
LL_USART_AUTOBAUD_DETECT_ON_55_FRAME (*)
Return values
None
Notes
Macro
IS_USART_AUTOBAUDRATE_DETECTION_INSTANCE(USART
x) can be used to check whether or not Auto Baud Rate detection
feature is supported by the USARTx instance.
Reference
Manual to LL
API cross
reference:
CR2 ABRMODE LL_USART_SetAutoBaudRateMode
LL_USART_GetAutoBaudRateMode
Function name
__STATIC_INLINE uint32_t LL_USART_GetAutoBaudRateMode
(USART_TypeDef * USARTx)
Function
description
Return Auto Baud-Rate mode.
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values: (*) Values
not available on all devices
LL_USART_AUTOBAUD_DETECT_ON_STARTBIT
LL_USART_AUTOBAUD_DETECT_ON_FALLINGEDGE
LL_USART_AUTOBAUD_DETECT_ON_7F_FRAME (*)
LL_USART_AUTOBAUD_DETECT_ON_55_FRAME (*)
Notes
Macro
IS_USART_AUTOBAUDRATE_DETECTION_INSTANCE(USART
x) can be used to check whether or not Auto Baud Rate detection
feature is supported by the USARTx instance.
Reference
Manual to LL
API cross
reference:
CR2 ABRMODE LL_USART_GetAutoBaudRateMode
LL_USART_EnableRxTimeout
Function name
__STATIC_INLINE void LL_USART_EnableRxTimeout
(USART_TypeDef * USARTx)
Function description
Enable Receiver Timeout.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR2 RTOEN LL_USART_EnableRxTimeout
DocID026525 Rev 6
1179/1320
LL USART Generic Driver
UM1785
LL_USART_DisableRxTimeout
Function name
__STATIC_INLINE void LL_USART_DisableRxTimeout
(USART_TypeDef * USARTx)
Function description
Disable Receiver Timeout.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR2 RTOEN LL_USART_DisableRxTimeout
LL_USART_IsEnabledRxTimeout
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledRxTimeout
(USART_TypeDef * USARTx)
Function description
Indicate if Receiver Timeout feature is enabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR2 RTOEN LL_USART_IsEnabledRxTimeout
LL_USART_ConfigNodeAddress
1180/1320
Function name
__STATIC_INLINE void LL_USART_ConfigNodeAddress
(USART_TypeDef * USARTx, uint32_t AddressLen, uint32_t
NodeAddress)
Function description
Set Address of the USART node.
Parameters
USARTx: USART Instance
AddressLen: This parameter can be one of the following
values:
LL_USART_ADDRESS_DETECT_4B
LL_USART_ADDRESS_DETECT_7B
NodeAddress: 4 or 7 bit Address of the USART node.
Return values
None
Notes
This is used in multiprocessor communication during Mute
mode or Stop mode, for wake up with address mark
detection.
4bits address node is used when 4-bit Address Detection is
selected in ADDM7. (b7-b4 should be set to 0) 8bits address
node is used when 7-bit Address Detection is selected in
ADDM7. (This is used in multiprocessor communication
during Mute mode or Stop mode, for wake up with 7-bit
address mark detection. The MSB of the character sent by
the transmitter should be equal to 1. It may also be used for
character detection during normal reception, Mute mode
inactive (for example, end of block detection in ModBus
protocol). In this case, the whole received character (8-bit) is
compared to the ADD[7:0] value and CMF flag is set on
DocID026525 Rev 6
UM1785
LL USART Generic Driver
match)
Reference Manual to
LL API cross
reference:
CR2 ADD LL_USART_ConfigNodeAddress
CR2 ADDM7 LL_USART_ConfigNodeAddress
LL_USART_GetNodeAddress
Function name
__STATIC_INLINE uint32_t LL_USART_GetNodeAddress
(USART_TypeDef * USARTx)
Function description
Return 8 bit Address of the USART node as set in ADD field of
CR2.
Parameters
USARTx: USART Instance
Return values
Address: of the USART node (Value between Min_Data=0
and Max_Data=255)
Notes
If 4-bit Address Detection is selected in ADDM7, only 4bits
(b3-b0) of returned value are relevant (b31-b4 are not
relevant) If 7-bit Address Detection is selected in ADDM7,
only 8bits (b7-b0) of returned value are relevant (b31-b8 are
not relevant)
Reference Manual to
LL API cross
reference:
CR2 ADD LL_USART_GetNodeAddress
LL_USART_GetNodeAddressLen
Function name
__STATIC_INLINE uint32_t LL_USART_GetNodeAddressLen
(USART_TypeDef * USARTx)
Function description
Return Length of Node Address used in Address Detection mode
(7-bit or 4-bit)
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values:
LL_USART_ADDRESS_DETECT_4B
LL_USART_ADDRESS_DETECT_7B
Reference Manual to
LL API cross
reference:
CR2 ADDM7 LL_USART_GetNodeAddressLen
LL_USART_EnableRTSHWFlowCtrl
Function name
__STATIC_INLINE void LL_USART_EnableRTSHWFlowCtrl
(USART_TypeDef * USARTx)
Function description
Enable RTS HW Flow Control.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_UART_HWFLOW_INSTANCE(USARTx) can be
used to check whether or not Hardware Flow control feature
is supported by the USARTx instance.
DocID026525 Rev 6
1181/1320
LL USART Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
CR3 RTSE LL_USART_EnableRTSHWFlowCtrl
LL_USART_DisableRTSHWFlowCtrl
Function name
__STATIC_INLINE void LL_USART_DisableRTSHWFlowCtrl
(USART_TypeDef * USARTx)
Function description
Disable RTS HW Flow Control.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_UART_HWFLOW_INSTANCE(USARTx) can be
used to check whether or not Hardware Flow control feature
is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 RTSE LL_USART_DisableRTSHWFlowCtrl
LL_USART_EnableCTSHWFlowCtrl
Function name
__STATIC_INLINE void LL_USART_EnableCTSHWFlowCtrl
(USART_TypeDef * USARTx)
Function description
Enable CTS HW Flow Control.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_UART_HWFLOW_INSTANCE(USARTx) can be
used to check whether or not Hardware Flow control feature
is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 CTSE LL_USART_EnableCTSHWFlowCtrl
LL_USART_DisableCTSHWFlowCtrl
1182/1320
Function name
__STATIC_INLINE void LL_USART_DisableCTSHWFlowCtrl
(USART_TypeDef * USARTx)
Function description
Disable CTS HW Flow Control.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_UART_HWFLOW_INSTANCE(USARTx) can be
used to check whether or not Hardware Flow control feature
is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 CTSE LL_USART_DisableCTSHWFlowCtrl
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_SetHWFlowCtrl
Function name
__STATIC_INLINE void LL_USART_SetHWFlowCtrl
(USART_TypeDef * USARTx, uint32_t HardwareFlowControl)
Function description
Configure HW Flow Control mode (both CTS and RTS)
Parameters
USARTx: USART Instance
HardwareFlowControl: This parameter can be one of the
following values:
LL_USART_HWCONTROL_NONE
LL_USART_HWCONTROL_RTS
LL_USART_HWCONTROL_CTS
LL_USART_HWCONTROL_RTS_CTS
Return values
None
Notes
Macro IS_UART_HWFLOW_INSTANCE(USARTx) can be
used to check whether or not Hardware Flow control feature
is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 RTSE LL_USART_SetHWFlowCtrl
CR3 CTSE LL_USART_SetHWFlowCtrl
LL_USART_GetHWFlowCtrl
Function name
__STATIC_INLINE uint32_t LL_USART_GetHWFlowCtrl
(USART_TypeDef * USARTx)
Function description
Return HW Flow Control configuration (both CTS and RTS)
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values:
LL_USART_HWCONTROL_NONE
LL_USART_HWCONTROL_RTS
LL_USART_HWCONTROL_CTS
LL_USART_HWCONTROL_RTS_CTS
Notes
Macro IS_UART_HWFLOW_INSTANCE(USARTx) can be
used to check whether or not Hardware Flow control feature
is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 RTSE LL_USART_GetHWFlowCtrl
CR3 CTSE LL_USART_GetHWFlowCtrl
DocID026525 Rev 6
1183/1320
LL USART Generic Driver
UM1785
LL_USART_EnableOneBitSamp
Function name
__STATIC_INLINE void LL_USART_EnableOneBitSamp
(USART_TypeDef * USARTx)
Function description
Enable One bit sampling method.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR3 ONEBIT LL_USART_EnableOneBitSamp
LL_USART_DisableOneBitSamp
Function name
__STATIC_INLINE void LL_USART_DisableOneBitSamp
(USART_TypeDef * USARTx)
Function description
Disable One bit sampling method.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR3 ONEBIT LL_USART_DisableOneBitSamp
LL_USART_IsEnabledOneBitSamp
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledOneBitSamp
(USART_TypeDef * USARTx)
Function description
Indicate if One bit sampling method is enabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR3 ONEBIT LL_USART_IsEnabledOneBitSamp
LL_USART_EnableOverrunDetect
1184/1320
Function name
__STATIC_INLINE void LL_USART_EnableOverrunDetect
(USART_TypeDef * USARTx)
Function description
Enable Overrun detection.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR3 OVRDIS LL_USART_EnableOverrunDetect
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_DisableOverrunDetect
Function name
__STATIC_INLINE void LL_USART_DisableOverrunDetect
(USART_TypeDef * USARTx)
Function description
Disable Overrun detection.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR3 OVRDIS LL_USART_DisableOverrunDetect
LL_USART_IsEnabledOverrunDetect
Function name
__STATIC_INLINE uint32_t
LL_USART_IsEnabledOverrunDetect (USART_TypeDef *
USARTx)
Function description
Indicate if Overrun detection is enabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR3 OVRDIS LL_USART_IsEnabledOverrunDetect
LL_USART_SetWKUPType
Function name
__STATIC_INLINE void LL_USART_SetWKUPType
(USART_TypeDef * USARTx, uint32_t Type)
Function description
Select event type for Wake UP Interrupt Flag (WUS[1:0] bits)
Parameters
USARTx: USART Instance
Type: This parameter can be one of the following values:
LL_USART_WAKEUP_ON_ADDRESS
LL_USART_WAKEUP_ON_STARTBIT
LL_USART_WAKEUP_ON_RXNE
Return values
None
Notes
Macro
IS_UART_WAKEUP_FROMSTOP_INSTANCE(USARTx) can
be used to check whether or not Wake-up from Stop mode
feature is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 WUS LL_USART_SetWKUPType
LL_USART_GetWKUPType
Function name
__STATIC_INLINE uint32_t LL_USART_GetWKUPType
(USART_TypeDef * USARTx)
Function description
Return event type for Wake UP Interrupt Flag (WUS[1:0] bits)
DocID026525 Rev 6
1185/1320
LL USART Generic Driver
Parameters
UM1785
USARTx: USART Instance
Return values
Returned: value can be one of the following values:
LL_USART_WAKEUP_ON_ADDRESS
LL_USART_WAKEUP_ON_STARTBIT
LL_USART_WAKEUP_ON_RXNE
Notes
Macro
IS_UART_WAKEUP_FROMSTOP_INSTANCE(USARTx) can
be used to check whether or not Wake-up from Stop mode
feature is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 WUS LL_USART_GetWKUPType
LL_USART_SetBaudRate
Function name
__STATIC_INLINE void LL_USART_SetBaudRate
(USART_TypeDef * USARTx, uint32_t PeriphClk, uint32_t
OverSampling, uint32_t BaudRate)
Function description
Configure USART BRR register for achieving expected Baud Rate
value.
Parameters
USARTx: USART Instance
PeriphClk: Peripheral Clock
OverSampling: This parameter can be one of the following
values:
LL_USART_OVERSAMPLING_16
LL_USART_OVERSAMPLING_8
BaudRate: Baud Rate
Return values
None
Notes
Compute and set USARTDIV value in BRR Register (full BRR
content) according to used Peripheral Clock, Oversampling
mode, and expected Baud Rate values
Peripheral clock and Baud rate values provided as function
parameters should be valid (Baud rate value != 0)
In case of oversampling by 16 and 8, BRR content must be
greater than or equal to 16d.
Reference Manual to
LL API cross
reference:
BRR BRR LL_USART_SetBaudRate
LL_USART_GetBaudRate
Function name
__STATIC_INLINE uint32_t LL_USART_GetBaudRate
(USART_TypeDef * USARTx, uint32_t PeriphClk, uint32_t
OverSampling)
Function description
Return current Baud Rate value, according to USARTDIV present
in BRR register (full BRR content), and to used Peripheral Clock
and Oversampling mode values.
Parameters
1186/1320
USARTx: USART Instance
PeriphClk: Peripheral Clock
DocID026525 Rev 6
UM1785
LL USART Generic Driver
OverSampling: This parameter can be one of the following
values:
LL_USART_OVERSAMPLING_16
LL_USART_OVERSAMPLING_8
Return values
Baud: Rate
Notes
In case of non-initialized or invalid value stored in BRR
register, value 0 will be returned.
In case of oversampling by 16 and 8, BRR content must be
greater than or equal to 16d.
Reference Manual to
LL API cross
reference:
BRR BRR LL_USART_GetBaudRate
LL_USART_SetRxTimeout
Function name
__STATIC_INLINE void LL_USART_SetRxTimeout
(USART_TypeDef * USARTx, uint32_t Timeout)
Function description
Set Receiver Time Out Value (expressed in nb of bits duration)
Parameters
USARTx: USART Instance
Timeout: Value between Min_Data=0x00 and
Max_Data=0x00FFFFFF
Return values
None
Reference Manual to
LL API cross
reference:
RTOR RTO LL_USART_SetRxTimeout
LL_USART_GetRxTimeout
Function name
__STATIC_INLINE uint32_t LL_USART_GetRxTimeout
(USART_TypeDef * USARTx)
Function description
Get Receiver Time Out Value (expressed in nb of bits duration)
Parameters
USARTx: USART Instance
Return values
Value: between Min_Data=0x00 and
Max_Data=0x00FFFFFF
Reference Manual to
LL API cross
reference:
RTOR RTO LL_USART_GetRxTimeout
LL_USART_SetBlockLength
Function name
__STATIC_INLINE void LL_USART_SetBlockLength
(USART_TypeDef * USARTx, uint32_t BlockLength)
Function description
Set Block Length value in reception.
Parameters
USARTx: USART Instance
BlockLength: Value between Min_Data=0x00 and
Max_Data=0xFF
DocID026525 Rev 6
1187/1320
LL USART Generic Driver
Return values
UM1785
None
Reference Manual to
LL API cross
reference:
RTOR BLEN LL_USART_SetBlockLength
LL_USART_GetBlockLength
Function name
__STATIC_INLINE uint32_t LL_USART_GetBlockLength
(USART_TypeDef * USARTx)
Function description
Get Block Length value in reception.
Parameters
USARTx: USART Instance
Return values
Value: between Min_Data=0x00 and Max_Data=0xFF
Reference Manual to
LL API cross
reference:
RTOR BLEN LL_USART_GetBlockLength
LL_USART_EnableIrda
Function name
__STATIC_INLINE void LL_USART_EnableIrda
(USART_TypeDef * USARTx)
Function description
Enable IrDA mode.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_IRDA_INSTANCE(USARTx) can be used to check
whether or not IrDA feature is supported by the USARTx
instance.
Reference Manual to
LL API cross
reference:
CR3 IREN LL_USART_EnableIrda
LL_USART_DisableIrda
1188/1320
Function name
__STATIC_INLINE void LL_USART_DisableIrda
(USART_TypeDef * USARTx)
Function description
Disable IrDA mode.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_IRDA_INSTANCE(USARTx) can be used to check
whether or not IrDA feature is supported by the USARTx
instance.
Reference Manual to
LL API cross
reference:
CR3 IREN LL_USART_DisableIrda
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_IsEnabledIrda
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledIrda
(USART_TypeDef * USARTx)
Function description
Indicate if IrDA mode is enabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro IS_IRDA_INSTANCE(USARTx) can be used to check
whether or not IrDA feature is supported by the USARTx
instance.
Reference Manual to
LL API cross
reference:
CR3 IREN LL_USART_IsEnabledIrda
LL_USART_SetIrdaPowerMode
Function name
__STATIC_INLINE void LL_USART_SetIrdaPowerMode
(USART_TypeDef * USARTx, uint32_t PowerMode)
Function description
Configure IrDA Power Mode (Normal or Low Power)
Parameters
USARTx: USART Instance
PowerMode: This parameter can be one of the following
values:
LL_USART_IRDA_POWER_NORMAL
LL_USART_IRDA_POWER_LOW
Return values
None
Notes
Macro IS_IRDA_INSTANCE(USARTx) can be used to check
whether or not IrDA feature is supported by the USARTx
instance.
Reference Manual to
LL API cross
reference:
CR3 IRLP LL_USART_SetIrdaPowerMode
LL_USART_GetIrdaPowerMode
Function name
__STATIC_INLINE uint32_t LL_USART_GetIrdaPowerMode
(USART_TypeDef * USARTx)
Function description
Retrieve IrDA Power Mode configuration (Normal or Low Power)
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values:
LL_USART_IRDA_POWER_NORMAL
LL_USART_PHASE_2EDGE
Notes
Macro IS_IRDA_INSTANCE(USARTx) can be used to check
whether or not IrDA feature is supported by the USARTx
instance.
Reference Manual to
LL API cross
CR3 IRLP LL_USART_GetIrdaPowerMode
DocID026525 Rev 6
1189/1320
LL USART Generic Driver
reference:
UM1785
LL_USART_SetIrdaPrescaler
Function name
__STATIC_INLINE void LL_USART_SetIrdaPrescaler
(USART_TypeDef * USARTx, uint32_t PrescalerValue)
Function description
Set Irda prescaler value, used for dividing the USART clock source
to achieve the Irda Low Power frequency (8 bits value)
Parameters
USARTx: USART Instance
PrescalerValue: Value between Min_Data=0x00 and
Max_Data=0xFF
Return values
None
Notes
Macro IS_IRDA_INSTANCE(USARTx) can be used to check
whether or not IrDA feature is supported by the USARTx
instance.
Reference Manual to
LL API cross
reference:
GTPR PSC LL_USART_SetIrdaPrescaler
LL_USART_GetIrdaPrescaler
1190/1320
Function name
__STATIC_INLINE uint32_t LL_USART_GetIrdaPrescaler
(USART_TypeDef * USARTx)
Function description
Return Irda prescaler value, used for dividing the USART clock
source to achieve the Irda Low Power frequency (8 bits value)
Parameters
USARTx: USART Instance
Return values
Irda: prescaler value (Value between Min_Data=0x00 and
Max_Data=0xFF)
Notes
Macro IS_IRDA_INSTANCE(USARTx) can be used to check
whether or not IrDA feature is supported by the USARTx
instance.
Reference Manual to
LL API cross
reference:
GTPR PSC LL_USART_GetIrdaPrescaler
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_EnableSmartcardNACK
Function name
__STATIC_INLINE void LL_USART_EnableSmartcardNACK
(USART_TypeDef * USARTx)
Function description
Enable Smartcard NACK transmission.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 NACK LL_USART_EnableSmartcardNACK
LL_USART_DisableSmartcardNACK
Function name
__STATIC_INLINE void LL_USART_DisableSmartcardNACK
(USART_TypeDef * USARTx)
Function description
Disable Smartcard NACK transmission.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 NACK LL_USART_DisableSmartcardNACK
LL_USART_IsEnabledSmartcardNACK
Function name
__STATIC_INLINE uint32_t
LL_USART_IsEnabledSmartcardNACK (USART_TypeDef *
USARTx)
Function description
Indicate if Smartcard NACK transmission is enabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 NACK LL_USART_IsEnabledSmartcardNACK
DocID026525 Rev 6
1191/1320
LL USART Generic Driver
UM1785
LL_USART_EnableSmartcard
Function name
__STATIC_INLINE void LL_USART_EnableSmartcard
(USART_TypeDef * USARTx)
Function description
Enable Smartcard mode.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 SCEN LL_USART_EnableSmartcard
LL_USART_DisableSmartcard
Function name
__STATIC_INLINE void LL_USART_DisableSmartcard
(USART_TypeDef * USARTx)
Function description
Disable Smartcard mode.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 SCEN LL_USART_DisableSmartcard
LL_USART_IsEnabledSmartcard
1192/1320
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledSmartcard
(USART_TypeDef * USARTx)
Function description
Indicate if Smartcard mode is enabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 SCEN LL_USART_IsEnabledSmartcard
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_SetSmartcardAutoRetryCount
Function name
__STATIC_INLINE void
LL_USART_SetSmartcardAutoRetryCount (USART_TypeDef *
USARTx, uint32_t AutoRetryCount)
Function description
Set Smartcard Auto-Retry Count value (SCARCNT[2:0] bits)
Parameters
USARTx: USART Instance
AutoRetryCount: Value between Min_Data=0 and
Max_Data=7
Return values
None
Notes
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
This bit-field specifies the number of retries in transmit and
receive, in Smartcard mode. In transmission mode, it
specifies the number of automatic retransmission retries,
before generating a transmission error (FE bit set). In
reception mode, it specifies the number or erroneous
reception trials, before generating a reception error (RXNE
and PE bits set)
Reference Manual to
LL API cross
reference:
CR3 SCARCNT LL_USART_SetSmartcardAutoRetryCount
LL_USART_GetSmartcardAutoRetryCount
Function name
__STATIC_INLINE uint32_t
LL_USART_GetSmartcardAutoRetryCount (USART_TypeDef *
USARTx)
Function description
Return Smartcard Auto-Retry Count value (SCARCNT[2:0] bits)
Parameters
USARTx: USART Instance
Return values
Smartcard: Auto-Retry Count value (Value between
Min_Data=0 and Max_Data=7)
Notes
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 SCARCNT LL_USART_GetSmartcardAutoRetryCount
LL_USART_SetSmartcardPrescaler
Function name
__STATIC_INLINE void LL_USART_SetSmartcardPrescaler
(USART_TypeDef * USARTx, uint32_t PrescalerValue)
Function description
Set Smartcard prescaler value, used for dividing the USART clock
source to provide the SMARTCARD Clock (5 bits value)
Parameters
USARTx: USART Instance
PrescalerValue: Value between Min_Data=0 and
DocID026525 Rev 6
1193/1320
LL USART Generic Driver
UM1785
Max_Data=31
Return values
None
Notes
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
GTPR PSC LL_USART_SetSmartcardPrescaler
LL_USART_GetSmartcardPrescaler
Function name
__STATIC_INLINE uint32_t
LL_USART_GetSmartcardPrescaler (USART_TypeDef *
USARTx)
Function description
Return Smartcard prescaler value, used for dividing the USART
clock source to provide the SMARTCARD Clock (5 bits value)
Parameters
USARTx: USART Instance
Return values
Smartcard: prescaler value (Value between Min_Data=0
and Max_Data=31)
Notes
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
GTPR PSC LL_USART_GetSmartcardPrescaler
LL_USART_SetSmartcardGuardTime
1194/1320
Function name
__STATIC_INLINE void LL_USART_SetSmartcardGuardTime
(USART_TypeDef * USARTx, uint32_t GuardTime)
Function description
Set Smartcard Guard time value, expressed in nb of baud clocks
periods (GT[7:0] bits : Guard time value)
Parameters
USARTx: USART Instance
GuardTime: Value between Min_Data=0x00 and
Max_Data=0xFF
Return values
None
Notes
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
GTPR GT LL_USART_SetSmartcardGuardTime
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_GetSmartcardGuardTime
Function name
__STATIC_INLINE uint32_t
LL_USART_GetSmartcardGuardTime (USART_TypeDef *
USARTx)
Function description
Return Smartcard Guard time value, expressed in nb of baud
clocks periods (GT[7:0] bits : Guard time value)
Parameters
USARTx: USART Instance
Return values
Smartcard: Guard time value (Value between
Min_Data=0x00 and Max_Data=0xFF)
Notes
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
GTPR GT LL_USART_GetSmartcardGuardTime
LL_USART_EnableHalfDuplex
Function name
__STATIC_INLINE void LL_USART_EnableHalfDuplex
(USART_TypeDef * USARTx)
Function description
Enable Single Wire Half-Duplex mode.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_UART_HALFDUPLEX_INSTANCE(USARTx) can
be used to check whether or not Half-Duplex mode is
supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 HDSEL LL_USART_EnableHalfDuplex
LL_USART_DisableHalfDuplex
Function name
__STATIC_INLINE void LL_USART_DisableHalfDuplex
(USART_TypeDef * USARTx)
Function description
Disable Single Wire Half-Duplex mode.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_UART_HALFDUPLEX_INSTANCE(USARTx) can
be used to check whether or not Half-Duplex mode is
supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 HDSEL LL_USART_DisableHalfDuplex
DocID026525 Rev 6
1195/1320
LL USART Generic Driver
UM1785
LL_USART_IsEnabledHalfDuplex
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledHalfDuplex
(USART_TypeDef * USARTx)
Function description
Indicate if Single Wire Half-Duplex mode is enabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro IS_UART_HALFDUPLEX_INSTANCE(USARTx) can
be used to check whether or not Half-Duplex mode is
supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 HDSEL LL_USART_IsEnabledHalfDuplex
LL_USART_SetLINBrkDetectionLen
1196/1320
Function name
__STATIC_INLINE void LL_USART_SetLINBrkDetectionLen
(USART_TypeDef * USARTx, uint32_t LINBDLength)
Function description
Set LIN Break Detection Length.
Parameters
USARTx: USART Instance
LINBDLength: This parameter can be one of the following
values:
LL_USART_LINBREAK_DETECT_10B
LL_USART_LINBREAK_DETECT_11B
Return values
None
Notes
Macro IS_UART_LIN_INSTANCE(USARTx) can be used to
check whether or not LIN feature is supported by the USARTx
instance.
Reference Manual to
LL API cross
reference:
CR2 LBDL LL_USART_SetLINBrkDetectionLen
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_GetLINBrkDetectionLen
Function name
__STATIC_INLINE uint32_t
LL_USART_GetLINBrkDetectionLen (USART_TypeDef *
USARTx)
Function description
Return LIN Break Detection Length.
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values:
LL_USART_LINBREAK_DETECT_10B
LL_USART_LINBREAK_DETECT_11B
Notes
Macro IS_UART_LIN_INSTANCE(USARTx) can be used to
check whether or not LIN feature is supported by the USARTx
instance.
Reference Manual to
LL API cross
reference:
CR2 LBDL LL_USART_GetLINBrkDetectionLen
LL_USART_EnableLIN
Function name
__STATIC_INLINE void LL_USART_EnableLIN
(USART_TypeDef * USARTx)
Function description
Enable LIN mode.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_UART_LIN_INSTANCE(USARTx) can be used to
check whether or not LIN feature is supported by the USARTx
instance.
Reference Manual to
LL API cross
reference:
CR2 LINEN LL_USART_EnableLIN
LL_USART_DisableLIN
Function name
__STATIC_INLINE void LL_USART_DisableLIN
(USART_TypeDef * USARTx)
Function description
Disable LIN mode.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_UART_LIN_INSTANCE(USARTx) can be used to
check whether or not LIN feature is supported by the USARTx
instance.
Reference Manual to
LL API cross
reference:
CR2 LINEN LL_USART_DisableLIN
DocID026525 Rev 6
1197/1320
LL USART Generic Driver
UM1785
LL_USART_IsEnabledLIN
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledLIN
(USART_TypeDef * USARTx)
Function description
Indicate if LIN mode is enabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro IS_UART_LIN_INSTANCE(USARTx) can be used to
check whether or not LIN feature is supported by the USARTx
instance.
Reference Manual to
LL API cross
reference:
CR2 LINEN LL_USART_IsEnabledLIN
LL_USART_SetDEDeassertionTime
Function name
__STATIC_INLINE void LL_USART_SetDEDeassertionTime
(USART_TypeDef * USARTx, uint32_t Time)
Function description
Set DEDT (Driver Enable De-Assertion Time), Time value
expressed on 5 bits ([4:0] bits).
Parameters
USARTx: USART Instance
Time: Value between Min_Data=0 and Max_Data=31
Return values
None
Notes
Macro IS_UART_DRIVER_ENABLE_INSTANCE(USARTx)
can be used to check whether or not Driver Enable feature is
supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR1 DEDT LL_USART_SetDEDeassertionTime
LL_USART_GetDEDeassertionTime
1198/1320
Function name
__STATIC_INLINE uint32_t
LL_USART_GetDEDeassertionTime (USART_TypeDef *
USARTx)
Function description
Return DEDT (Driver Enable De-Assertion Time)
Parameters
USARTx: USART Instance
Return values
Time: value expressed on 5 bits ([4:0] bits) : Value between
Min_Data=0 and Max_Data=31
Notes
Macro IS_UART_DRIVER_ENABLE_INSTANCE(USARTx)
can be used to check whether or not Driver Enable feature is
supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR1 DEDT LL_USART_GetDEDeassertionTime
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_SetDEAssertionTime
Function name
__STATIC_INLINE void LL_USART_SetDEAssertionTime
(USART_TypeDef * USARTx, uint32_t Time)
Function description
Set DEAT (Driver Enable Assertion Time), Time value expressed
on 5 bits ([4:0] bits).
Parameters
USARTx: USART Instance
Time: Value between Min_Data=0 and Max_Data=31
Return values
None
Notes
Macro IS_UART_DRIVER_ENABLE_INSTANCE(USARTx)
can be used to check whether or not Driver Enable feature is
supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR1 DEAT LL_USART_SetDEAssertionTime
LL_USART_GetDEAssertionTime
Function name
__STATIC_INLINE uint32_t LL_USART_GetDEAssertionTime
(USART_TypeDef * USARTx)
Function description
Return DEAT (Driver Enable Assertion Time)
Parameters
USARTx: USART Instance
Return values
Time: value expressed on 5 bits ([4:0] bits) : Value between
Min_Data=0 and Max_Data=31
Notes
Macro IS_UART_DRIVER_ENABLE_INSTANCE(USARTx)
can be used to check whether or not Driver Enable feature is
supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR1 DEAT LL_USART_GetDEAssertionTime
LL_USART_EnableDEMode
Function name
__STATIC_INLINE void LL_USART_EnableDEMode
(USART_TypeDef * USARTx)
Function description
Enable Driver Enable (DE) Mode.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_UART_DRIVER_ENABLE_INSTANCE(USARTx)
can be used to check whether or not Driver Enable feature is
supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 DEM LL_USART_EnableDEMode
DocID026525 Rev 6
1199/1320
LL USART Generic Driver
UM1785
LL_USART_DisableDEMode
Function name
__STATIC_INLINE void LL_USART_DisableDEMode
(USART_TypeDef * USARTx)
Function description
Disable Driver Enable (DE) Mode.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_UART_DRIVER_ENABLE_INSTANCE(USARTx)
can be used to check whether or not Driver Enable feature is
supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 DEM LL_USART_DisableDEMode
LL_USART_IsEnabledDEMode
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledDEMode
(USART_TypeDef * USARTx)
Function description
Indicate if Driver Enable (DE) Mode is enabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro IS_UART_DRIVER_ENABLE_INSTANCE(USARTx)
can be used to check whether or not Driver Enable feature is
supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 DEM LL_USART_IsEnabledDEMode
LL_USART_SetDESignalPolarity
1200/1320
Function name
__STATIC_INLINE void LL_USART_SetDESignalPolarity
(USART_TypeDef * USARTx, uint32_t Polarity)
Function description
Select Driver Enable Polarity.
Parameters
USARTx: USART Instance
Polarity: This parameter can be one of the following values:
LL_USART_DE_POLARITY_HIGH
LL_USART_DE_POLARITY_LOW
Return values
None
Notes
Macro IS_UART_DRIVER_ENABLE_INSTANCE(USARTx)
can be used to check whether or not Driver Enable feature is
supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 DEP LL_USART_SetDESignalPolarity
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_GetDESignalPolarity
Function name
__STATIC_INLINE uint32_t LL_USART_GetDESignalPolarity
(USART_TypeDef * USARTx)
Function description
Return Driver Enable Polarity.
Parameters
USARTx: USART Instance
Return values
Returned: value can be one of the following values:
LL_USART_DE_POLARITY_HIGH
LL_USART_DE_POLARITY_LOW
Notes
Macro IS_UART_DRIVER_ENABLE_INSTANCE(USARTx)
can be used to check whether or not Driver Enable feature is
supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 DEP LL_USART_GetDESignalPolarity
LL_USART_ConfigAsyncMode
Function name
__STATIC_INLINE void LL_USART_ConfigAsyncMode
(USART_TypeDef * USARTx)
Function description
Perform basic configuration of USART for enabling use in
Asynchronous Mode (UART)
Parameters
USARTx: USART Instance
Return values
None
Notes
In UART mode, the following bits must be kept cleared:
LINEN bit in the USART_CR2 register (if LIN feature is
supported),CLKEN bit in the USART_CR2 register,SCEN bit
in the USART_CR3 register (if Smartcard feature is
supported),IREN bit in the USART_CR3 register (if Irda
feature is supported),HDSEL bit in the USART_CR3 register.
Call of this function is equivalent to following function call
sequence : Clear LINEN in CR2 using
LL_USART_DisableLIN() function (if LIN feature is
supported)Clear CLKEN in CR2 using
LL_USART_DisableSCLKOutput() functionClear SCEN in
CR3 using LL_USART_DisableSmartcard() function (if
Smartcard feature is supported)Clear IREN in CR3 using
LL_USART_DisableIrda() function (if Irda feature is
supported)Clear HDSEL in CR3 using
LL_USART_DisableHalfDuplex() function
Other remaining configurations items related to Asynchronous
Mode (as Baud Rate, Word length, Parity, ...) should be set
using dedicated functions
Reference Manual to
LL API cross
reference:
CR2 LINEN LL_USART_ConfigAsyncMode
CR2 CLKEN LL_USART_ConfigAsyncMode
CR3 SCEN LL_USART_ConfigAsyncMode
CR3 IREN LL_USART_ConfigAsyncMode
CR3 HDSEL LL_USART_ConfigAsyncMode
DocID026525 Rev 6
1201/1320
LL USART Generic Driver
UM1785
LL_USART_ConfigSyncMode
Function name
__STATIC_INLINE void LL_USART_ConfigSyncMode
(USART_TypeDef * USARTx)
Function description
Perform basic configuration of USART for enabling use in
Synchronous Mode.
Parameters
USARTx: USART Instance
Return values
None
Notes
In Synchronous mode, the following bits must be kept
cleared: LINEN bit in the USART_CR2 register (if LIN feature
is supported),SCEN bit in the USART_CR3 register (if
Smartcard feature is supported),IREN bit in the USART_CR3
register (if Irda feature is supported),HDSEL bit in the
USART_CR3 register. This function also sets the USART in
Synchronous mode.
Macro IS_USART_INSTANCE(USARTx) can be used to
check whether or not Synchronous mode is supported by the
USARTx instance.
Call of this function is equivalent to following function call
sequence : Clear LINEN in CR2 using
LL_USART_DisableLIN() function (if LIN feature is
supported)Clear IREN in CR3 using LL_USART_DisableIrda()
function (if Irda feature is supported)Clear SCEN in CR3
using LL_USART_DisableSmartcard() function (if Smartcard
feature is supported)Clear HDSEL in CR3 using
LL_USART_DisableHalfDuplex() functionSet CLKEN in CR2
using LL_USART_EnableSCLKOutput() function
Other remaining configurations items related to Synchronous
Mode (as Baud Rate, Word length, Parity, Clock Polarity, ...)
should be set using dedicated functions
Reference Manual to
LL API cross
reference:
CR2 LINEN LL_USART_ConfigSyncMode
CR2 CLKEN LL_USART_ConfigSyncMode
CR3 SCEN LL_USART_ConfigSyncMode
CR3 IREN LL_USART_ConfigSyncMode
CR3 HDSEL LL_USART_ConfigSyncMode
LL_USART_ConfigLINMode
1202/1320
Function name
__STATIC_INLINE void LL_USART_ConfigLINMode
(USART_TypeDef * USARTx)
Function description
Perform basic configuration of USART for enabling use in LIN
Mode.
Parameters
USARTx: USART Instance
Return values
None
Notes
In LIN mode, the following bits must be kept cleared: STOP
and CLKEN bits in the USART_CR2 register,SCEN bit in the
USART_CR3 register (if Smartcard feature is
supported),IREN bit in the USART_CR3 register (if Irda
feature is supported),HDSEL bit in the USART_CR3 register.
This function also set the UART/USART in LIN mode.
DocID026525 Rev 6
UM1785
LL USART Generic Driver
Macro IS_UART_LIN_INSTANCE(USARTx) can be used to
check whether or not LIN feature is supported by the USARTx
instance.
Call of this function is equivalent to following function call
sequence : Clear CLKEN in CR2 using
LL_USART_DisableSCLKOutput() functionClear STOP in
CR2 using LL_USART_SetStopBitsLength() functionClear
SCEN in CR3 using LL_USART_DisableSmartcard() function
(if Smartcard feature is supported)Clear IREN in CR3 using
LL_USART_DisableIrda() function (if Irda feature is
supported)Clear HDSEL in CR3 using
LL_USART_DisableHalfDuplex() functionSet LINEN in CR2
using LL_USART_EnableLIN() function
Other remaining configurations items related to LIN Mode (as
Baud Rate, Word length, LIN Break Detection Length, ...)
should be set using dedicated functions
Reference Manual to
LL API cross
reference:
CR2 CLKEN LL_USART_ConfigLINMode
CR2 STOP LL_USART_ConfigLINMode
CR2 LINEN LL_USART_ConfigLINMode
CR3 IREN LL_USART_ConfigLINMode
CR3 SCEN LL_USART_ConfigLINMode
CR3 HDSEL LL_USART_ConfigLINMode
LL_USART_ConfigHalfDuplexMode
Function name
__STATIC_INLINE void LL_USART_ConfigHalfDuplexMode
(USART_TypeDef * USARTx)
Function description
Perform basic configuration of USART for enabling use in Half
Duplex Mode.
Parameters
USARTx: USART Instance
Return values
None
Notes
In Half Duplex mode, the following bits must be kept cleared:
LINEN bit in the USART_CR2 register (if LIN feature is
supported),CLKEN bit in the USART_CR2 register,SCEN bit
in the USART_CR3 register (if Smartcard feature is
supported),IREN bit in the USART_CR3 register (if Irda
feature is supported), This function also sets the
UART/USART in Half Duplex mode.
Macro IS_UART_HALFDUPLEX_INSTANCE(USARTx) can
be used to check whether or not Half-Duplex mode is
supported by the USARTx instance.
Call of this function is equivalent to following function call
sequence : Clear LINEN in CR2 using
LL_USART_DisableLIN() function (if LIN feature is
supported)Clear CLKEN in CR2 using
LL_USART_DisableSCLKOutput() functionClear SCEN in
CR3 using LL_USART_DisableSmartcard() function (if
Smartcard feature is supported)Clear IREN in CR3 using
LL_USART_DisableIrda() function (if Irda feature is
supported)Set HDSEL in CR3 using
LL_USART_EnableHalfDuplex() function
Other remaining configurations items related to Half Duplex
DocID026525 Rev 6
1203/1320
LL USART Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
Mode (as Baud Rate, Word length, Parity, ...) should be set
using dedicated functions
CR2 LINEN LL_USART_ConfigHalfDuplexMode
CR2 CLKEN LL_USART_ConfigHalfDuplexMode
CR3 HDSEL LL_USART_ConfigHalfDuplexMode
CR3 SCEN LL_USART_ConfigHalfDuplexMode
CR3 IREN LL_USART_ConfigHalfDuplexMode
LL_USART_ConfigSmartcardMode
Function name
__STATIC_INLINE void LL_USART_ConfigSmartcardMode
(USART_TypeDef * USARTx)
Function description
Perform basic configuration of USART for enabling use in
Smartcard Mode.
Parameters
USARTx: USART Instance
Return values
None
Notes
In Smartcard mode, the following bits must be kept cleared:
LINEN bit in the USART_CR2 register (if LIN feature is
supported),IREN bit in the USART_CR3 register (if Irda
feature is supported),HDSEL bit in the USART_CR3 register.
This function also configures Stop bits to 1.5 bits and sets the
USART in Smartcard mode (SCEN bit). Clock Output is also
enabled (CLKEN).
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
Call of this function is equivalent to following function call
sequence : Clear LINEN in CR2 using
LL_USART_DisableLIN() function (if LIN feature is
supported)Clear IREN in CR3 using LL_USART_DisableIrda()
function (if Irda feature is supported)Clear HDSEL in CR3
using LL_USART_DisableHalfDuplex() functionConfigure
STOP in CR2 using LL_USART_SetStopBitsLength()
functionSet CLKEN in CR2 using
LL_USART_EnableSCLKOutput() functionSet SCEN in CR3
using LL_USART_EnableSmartcard() function
Other remaining configurations items related to Smartcard
Mode (as Baud Rate, Word length, Parity, ...) should be set
using dedicated functions
Reference Manual to
LL API cross
reference:
CR2 LINEN LL_USART_ConfigSmartcardMode
CR2 STOP LL_USART_ConfigSmartcardMode
CR2 CLKEN LL_USART_ConfigSmartcardMode
CR3 HDSEL LL_USART_ConfigSmartcardMode
CR3 SCEN LL_USART_ConfigSmartcardMode
LL_USART_ConfigIrdaMode
1204/1320
Function name
__STATIC_INLINE void LL_USART_ConfigIrdaMode
(USART_TypeDef * USARTx)
Function description
Perform basic configuration of USART for enabling use in Irda
DocID026525 Rev 6
UM1785
LL USART Generic Driver
Mode.
Parameters
USARTx: USART Instance
Return values
None
Notes
In IRDA mode, the following bits must be kept cleared: LINEN
bit in the USART_CR2 register (if LIN feature is
supported),STOP and CLKEN bits in the USART_CR2
register,SCEN bit in the USART_CR3 register (if Smartcard
feature is supported),HDSEL bit in the USART_CR3 register.
This function also sets the UART/USART in IRDA mode
(IREN bit).
Macro IS_IRDA_INSTANCE(USARTx) can be used to check
whether or not IrDA feature is supported by the USARTx
instance.
Call of this function is equivalent to following function call
sequence : Clear LINEN in CR2 using
LL_USART_DisableLIN() function (if LIN feature is
supported)Clear CLKEN in CR2 using
LL_USART_DisableSCLKOutput() functionClear SCEN in
CR3 using LL_USART_DisableSmartcard() function (if
Smartcard feature is supported)Clear HDSEL in CR3 using
LL_USART_DisableHalfDuplex() functionConfigure STOP in
CR2 using LL_USART_SetStopBitsLength() functionSet IREN
in CR3 using LL_USART_EnableIrda() function
Other remaining configurations items related to Irda Mode (as
Baud Rate, Word length, Power mode, ...) should be set using
dedicated functions
Reference Manual to
LL API cross
reference:
CR2 LINEN LL_USART_ConfigIrdaMode
CR2 CLKEN LL_USART_ConfigIrdaMode
CR2 STOP LL_USART_ConfigIrdaMode
CR3 SCEN LL_USART_ConfigIrdaMode
CR3 HDSEL LL_USART_ConfigIrdaMode
CR3 IREN LL_USART_ConfigIrdaMode
LL_USART_ConfigMultiProcessMode
Function name
__STATIC_INLINE void LL_USART_ConfigMultiProcessMode
(USART_TypeDef * USARTx)
Function description
Perform basic configuration of USART for enabling use in Multi
processor Mode (several USARTs connected in a network, one of
the USARTs can be the master, its TX output connected to the RX
inputs of the other slaves USARTs).
Parameters
USARTx: USART Instance
Return values
None
Notes
In MultiProcessor mode, the following bits must be kept
cleared: LINEN bit in the USART_CR2 register (if LIN feature
is supported),CLKEN bit in the USART_CR2 register,SCEN
bit in the USART_CR3 register (if Smartcard feature is
supported),IREN bit in the USART_CR3 register (if Irda
feature is supported),HDSEL bit in the USART_CR3 register.
Call of this function is equivalent to following function call
DocID026525 Rev 6
1205/1320
LL USART Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
sequence : Clear LINEN in CR2 using
LL_USART_DisableLIN() function (if LIN feature is
supported)Clear CLKEN in CR2 using
LL_USART_DisableSCLKOutput() functionClear SCEN in
CR3 using LL_USART_DisableSmartcard() function (if
Smartcard feature is supported)Clear IREN in CR3 using
LL_USART_DisableIrda() function (if Irda feature is
supported)Clear HDSEL in CR3 using
LL_USART_DisableHalfDuplex() function
Other remaining configurations items related to Multi
processor Mode (as Baud Rate, Wake Up Method, Node
address, ...) should be set using dedicated functions
CR2 LINEN LL_USART_ConfigMultiProcessMode
CR2 CLKEN LL_USART_ConfigMultiProcessMode
CR3 SCEN LL_USART_ConfigMultiProcessMode
CR3 HDSEL LL_USART_ConfigMultiProcessMode
CR3 IREN LL_USART_ConfigMultiProcessMode
LL_USART_IsActiveFlag_PE
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_PE
(USART_TypeDef * USARTx)
Function description
Check if the USART Parity Error Flag is set or not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR PE LL_USART_IsActiveFlag_PE
LL_USART_IsActiveFlag_FE
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_FE
(USART_TypeDef * USARTx)
Function description
Check if the USART Framing Error Flag is set or not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR FE LL_USART_IsActiveFlag_FE
LL_USART_IsActiveFlag_NE
1206/1320
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_NE
(USART_TypeDef * USARTx)
Function description
Check if the USART Noise error detected Flag is set or not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
DocID026525 Rev 6
UM1785
LL USART Generic Driver
Reference Manual to
LL API cross
reference:
ISR NF LL_USART_IsActiveFlag_NE
LL_USART_IsActiveFlag_ORE
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_ORE
(USART_TypeDef * USARTx)
Function description
Check if the USART OverRun Error Flag is set or not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR ORE LL_USART_IsActiveFlag_ORE
LL_USART_IsActiveFlag_IDLE
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_IDLE
(USART_TypeDef * USARTx)
Function description
Check if the USART IDLE line detected Flag is set or not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR IDLE LL_USART_IsActiveFlag_IDLE
LL_USART_IsActiveFlag_RXNE
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_RXNE
(USART_TypeDef * USARTx)
Function description
Check if the USART Read Data Register Not Empty Flag is set or
not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR RXNE LL_USART_IsActiveFlag_RXNE
LL_USART_IsActiveFlag_TC
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_TC
(USART_TypeDef * USARTx)
Function description
Check if the USART Transmission Complete Flag is set or not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
DocID026525 Rev 6
1207/1320
LL USART Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
ISR TC LL_USART_IsActiveFlag_TC
LL_USART_IsActiveFlag_TXE
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_TXE
(USART_TypeDef * USARTx)
Function description
Check if the USART Transmit Data Register Empty Flag is set or
not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR TXE LL_USART_IsActiveFlag_TXE
LL_USART_IsActiveFlag_LBD
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_LBD
(USART_TypeDef * USARTx)
Function description
Check if the USART LIN Break Detection Flag is set or not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro IS_UART_LIN_INSTANCE(USARTx) can be used to
check whether or not LIN feature is supported by the USARTx
instance.
Reference Manual to
LL API cross
reference:
ISR LBDF LL_USART_IsActiveFlag_LBD
LL_USART_IsActiveFlag_nCTS
1208/1320
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_nCTS
(USART_TypeDef * USARTx)
Function description
Check if the USART CTS interrupt Flag is set or not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro IS_UART_HWFLOW_INSTANCE(USARTx) can be
used to check whether or not Hardware Flow control feature
is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
ISR CTSIF LL_USART_IsActiveFlag_nCTS
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_IsActiveFlag_CTS
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_CTS
(USART_TypeDef * USARTx)
Function description
Check if the USART CTS Flag is set or not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro IS_UART_HWFLOW_INSTANCE(USARTx) can be
used to check whether or not Hardware Flow control feature
is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
ISR CTS LL_USART_IsActiveFlag_CTS
LL_USART_IsActiveFlag_RTO
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_RTO
(USART_TypeDef * USARTx)
Function description
Check if the USART Receiver Time Out Flag is set or not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR RTOF LL_USART_IsActiveFlag_RTO
LL_USART_IsActiveFlag_EOB
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_EOB
(USART_TypeDef * USARTx)
Function description
Check if the USART End Of Block Flag is set or not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
ISR EOBF LL_USART_IsActiveFlag_EOB
LL_USART_IsActiveFlag_ABRE
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_ABRE
(USART_TypeDef * USARTx)
Function description
Check if the USART Auto-Baud Rate Error Flag is set or not.
Parameters
USARTx: USART Instance
DocID026525 Rev 6
1209/1320
LL USART Generic Driver
Return values
UM1785
State: of bit (1 or 0).
Notes
Macro
IS_USART_AUTOBAUDRATE_DETECTION_INSTANCE(USA
RTx) can be used to check whether or not Auto Baud Rate
detection feature is supported by the USARTx instance.
Reference Manual
to LL API cross
reference:
ISR ABRE LL_USART_IsActiveFlag_ABRE
LL_USART_IsActiveFlag_ABR
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_ABR
(USART_TypeDef * USARTx)
Function description
Check if the USART Auto-Baud Rate Flag is set or not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro
IS_USART_AUTOBAUDRATE_DETECTION_INSTANCE(USA
RTx) can be used to check whether or not Auto Baud Rate
detection feature is supported by the USARTx instance.
Reference Manual
to LL API cross
reference:
ISR ABRF LL_USART_IsActiveFlag_ABR
LL_USART_IsActiveFlag_BUSY
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_BUSY
(USART_TypeDef * USARTx)
Function description
Check if the USART Busy Flag is set or not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR BUSY LL_USART_IsActiveFlag_BUSY
LL_USART_IsActiveFlag_CM
1210/1320
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_CM
(USART_TypeDef * USARTx)
Function description
Check if the USART Character Match Flag is set or not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR CMF LL_USART_IsActiveFlag_CM
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_IsActiveFlag_SBK
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_SBK
(USART_TypeDef * USARTx)
Function description
Check if the USART Send Break Flag is set or not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR SBKF LL_USART_IsActiveFlag_SBK
LL_USART_IsActiveFlag_RWU
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_RWU
(USART_TypeDef * USARTx)
Function description
Check if the USART Receive Wake Up from mute mode Flag is set
or not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR RWU LL_USART_IsActiveFlag_RWU
LL_USART_IsActiveFlag_WKUP
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_WKUP
(USART_TypeDef * USARTx)
Function description
Check if the USART Wake Up from stop mode Flag is set or not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro
IS_UART_WAKEUP_FROMSTOP_INSTANCE(USARTx) can
be used to check whether or not Wake-up from Stop mode
feature is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
ISR WUF LL_USART_IsActiveFlag_WKUP
LL_USART_IsActiveFlag_TEACK
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_TEACK
(USART_TypeDef * USARTx)
Function description
Check if the USART Transmit Enable Acknowledge Flag is set or
not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
DocID026525 Rev 6
1211/1320
LL USART Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
ISR TEACK LL_USART_IsActiveFlag_TEACK
LL_USART_IsActiveFlag_REACK
Function name
__STATIC_INLINE uint32_t LL_USART_IsActiveFlag_REACK
(USART_TypeDef * USARTx)
Function description
Check if the USART Receive Enable Acknowledge Flag is set or
not.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
ISR REACK LL_USART_IsActiveFlag_REACK
LL_USART_ClearFlag_PE
Function name
__STATIC_INLINE void LL_USART_ClearFlag_PE
(USART_TypeDef * USARTx)
Function description
Clear Parity Error Flag.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
ICR PECF LL_USART_ClearFlag_PE
LL_USART_ClearFlag_FE
Function name
__STATIC_INLINE void LL_USART_ClearFlag_FE
(USART_TypeDef * USARTx)
Function description
Clear Framing Error Flag.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
ICR FECF LL_USART_ClearFlag_FE
LL_USART_ClearFlag_NE
1212/1320
Function name
__STATIC_INLINE void LL_USART_ClearFlag_NE
(USART_TypeDef * USARTx)
Function description
Clear Noise detected Flag.
Parameters
USARTx: USART Instance
Return values
None
DocID026525 Rev 6
UM1785
LL USART Generic Driver
Reference Manual to
LL API cross
reference:
ICR NCF LL_USART_ClearFlag_NE
LL_USART_ClearFlag_ORE
Function name
__STATIC_INLINE void LL_USART_ClearFlag_ORE
(USART_TypeDef * USARTx)
Function description
Clear OverRun Error Flag.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
ICR ORECF LL_USART_ClearFlag_ORE
LL_USART_ClearFlag_IDLE
Function name
__STATIC_INLINE void LL_USART_ClearFlag_IDLE
(USART_TypeDef * USARTx)
Function description
Clear IDLE line detected Flag.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
ICR IDLECF LL_USART_ClearFlag_IDLE
LL_USART_ClearFlag_TC
Function name
__STATIC_INLINE void LL_USART_ClearFlag_TC
(USART_TypeDef * USARTx)
Function description
Clear Transmission Complete Flag.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
ICR TCCF LL_USART_ClearFlag_TC
DocID026525 Rev 6
1213/1320
LL USART Generic Driver
UM1785
LL_USART_ClearFlag_LBD
Function name
__STATIC_INLINE void LL_USART_ClearFlag_LBD
(USART_TypeDef * USARTx)
Function description
Clear LIN Break Detection Flag.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_UART_LIN_INSTANCE(USARTx) can be used to
check whether or not LIN feature is supported by the USARTx
instance.
Reference Manual to
LL API cross
reference:
ICR LBDCF LL_USART_ClearFlag_LBD
LL_USART_ClearFlag_nCTS
Function name
__STATIC_INLINE void LL_USART_ClearFlag_nCTS
(USART_TypeDef * USARTx)
Function description
Clear CTS Interrupt Flag.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_UART_HWFLOW_INSTANCE(USARTx) can be
used to check whether or not Hardware Flow control feature
is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
ICR CTSCF LL_USART_ClearFlag_nCTS
LL_USART_ClearFlag_RTO
Function name
__STATIC_INLINE void LL_USART_ClearFlag_RTO
(USART_TypeDef * USARTx)
Function description
Clear Receiver Time Out Flag.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
ICR RTOCF LL_USART_ClearFlag_RTO
LL_USART_ClearFlag_EOB
Function name
__STATIC_INLINE void LL_USART_ClearFlag_EOB
(USART_TypeDef * USARTx)
Function description
Clear End Of Block Flag.
Parameters
1214/1320
USARTx: USART Instance
DocID026525 Rev 6
UM1785
LL USART Generic Driver
Return values
None
Notes
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
ICR EOBCF LL_USART_ClearFlag_EOB
LL_USART_ClearFlag_CM
Function name
__STATIC_INLINE void LL_USART_ClearFlag_CM
(USART_TypeDef * USARTx)
Function description
Clear Character Match Flag.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
ICR CMCF LL_USART_ClearFlag_CM
LL_USART_ClearFlag_WKUP
Function name
__STATIC_INLINE void LL_USART_ClearFlag_WKUP
(USART_TypeDef * USARTx)
Function description
Clear Wake Up from stop mode Flag.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro
IS_UART_WAKEUP_FROMSTOP_INSTANCE(USARTx) can
be used to check whether or not Wake-up from Stop mode
feature is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
ICR WUCF LL_USART_ClearFlag_WKUP
LL_USART_EnableIT_IDLE
Function name
__STATIC_INLINE void LL_USART_EnableIT_IDLE
(USART_TypeDef * USARTx)
Function description
Enable IDLE Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 IDLEIE LL_USART_EnableIT_IDLE
DocID026525 Rev 6
1215/1320
LL USART Generic Driver
UM1785
LL_USART_EnableIT_RXNE
Function name
__STATIC_INLINE void LL_USART_EnableIT_RXNE
(USART_TypeDef * USARTx)
Function description
Enable RX Not Empty Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 RXNEIE LL_USART_EnableIT_RXNE
LL_USART_EnableIT_TC
Function name
__STATIC_INLINE void LL_USART_EnableIT_TC
(USART_TypeDef * USARTx)
Function description
Enable Transmission Complete Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 TCIE LL_USART_EnableIT_TC
LL_USART_EnableIT_TXE
Function name
__STATIC_INLINE void LL_USART_EnableIT_TXE
(USART_TypeDef * USARTx)
Function description
Enable TX Empty Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 TXEIE LL_USART_EnableIT_TXE
LL_USART_EnableIT_PE
1216/1320
Function name
__STATIC_INLINE void LL_USART_EnableIT_PE
(USART_TypeDef * USARTx)
Function description
Enable Parity Error Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 PEIE LL_USART_EnableIT_PE
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_EnableIT_CM
Function name
__STATIC_INLINE void LL_USART_EnableIT_CM
(USART_TypeDef * USARTx)
Function description
Enable Character Match Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 CMIE LL_USART_EnableIT_CM
LL_USART_EnableIT_RTO
Function name
__STATIC_INLINE void LL_USART_EnableIT_RTO
(USART_TypeDef * USARTx)
Function description
Enable Receiver Timeout Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 RTOIE LL_USART_EnableIT_RTO
LL_USART_EnableIT_EOB
Function name
__STATIC_INLINE void LL_USART_EnableIT_EOB
(USART_TypeDef * USARTx)
Function description
Enable End Of Block Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR1 EOBIE LL_USART_EnableIT_EOB
DocID026525 Rev 6
1217/1320
LL USART Generic Driver
UM1785
LL_USART_EnableIT_LBD
Function name
__STATIC_INLINE void LL_USART_EnableIT_LBD
(USART_TypeDef * USARTx)
Function description
Enable LIN Break Detection Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_UART_LIN_INSTANCE(USARTx) can be used to
check whether or not LIN feature is supported by the USARTx
instance.
Reference Manual to
LL API cross
reference:
CR2 LBDIE LL_USART_EnableIT_LBD
LL_USART_EnableIT_ERROR
Function name
__STATIC_INLINE void LL_USART_EnableIT_ERROR
(USART_TypeDef * USARTx)
Function description
Enable Error Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Notes
When set, Error Interrupt Enable Bit is enabling interrupt
generation in case of a framing error, overrun error or noise
flag (FE=1 or ORE=1 or NF=1 in the USARTx_ISR register).
0: Interrupt is inhibited 1: An interrupt is generated when
FE=1 or ORE=1 or NF=1 in the USARTx_ISR register.
Reference Manual to
LL API cross
reference:
CR3 EIE LL_USART_EnableIT_ERROR
LL_USART_EnableIT_CTS
1218/1320
Function name
__STATIC_INLINE void LL_USART_EnableIT_CTS
(USART_TypeDef * USARTx)
Function description
Enable CTS Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_UART_HWFLOW_INSTANCE(USARTx) can be
used to check whether or not Hardware Flow control feature
is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 CTSIE LL_USART_EnableIT_CTS
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_EnableIT_WKUP
Function name
__STATIC_INLINE void LL_USART_EnableIT_WKUP
(USART_TypeDef * USARTx)
Function description
Enable Wake Up from Stop Mode Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro
IS_UART_WAKEUP_FROMSTOP_INSTANCE(USARTx) can
be used to check whether or not Wake-up from Stop mode
feature is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 WUFIE LL_USART_EnableIT_WKUP
LL_USART_DisableIT_IDLE
Function name
__STATIC_INLINE void LL_USART_DisableIT_IDLE
(USART_TypeDef * USARTx)
Function description
Disable IDLE Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 IDLEIE LL_USART_DisableIT_IDLE
LL_USART_DisableIT_RXNE
Function name
__STATIC_INLINE void LL_USART_DisableIT_RXNE
(USART_TypeDef * USARTx)
Function description
Disable RX Not Empty Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 RXNEIE LL_USART_DisableIT_RXNE
DocID026525 Rev 6
1219/1320
LL USART Generic Driver
UM1785
LL_USART_DisableIT_TC
Function name
__STATIC_INLINE void LL_USART_DisableIT_TC
(USART_TypeDef * USARTx)
Function description
Disable Transmission Complete Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 TCIE LL_USART_DisableIT_TC
LL_USART_DisableIT_TXE
Function name
__STATIC_INLINE void LL_USART_DisableIT_TXE
(USART_TypeDef * USARTx)
Function description
Disable TX Empty Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 TXEIE LL_USART_DisableIT_TXE
LL_USART_DisableIT_PE
Function name
__STATIC_INLINE void LL_USART_DisableIT_PE
(USART_TypeDef * USARTx)
Function description
Disable Parity Error Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 PEIE LL_USART_DisableIT_PE
LL_USART_DisableIT_CM
1220/1320
Function name
__STATIC_INLINE void LL_USART_DisableIT_CM
(USART_TypeDef * USARTx)
Function description
Disable Character Match Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 CMIE LL_USART_DisableIT_CM
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_DisableIT_RTO
Function name
__STATIC_INLINE void LL_USART_DisableIT_RTO
(USART_TypeDef * USARTx)
Function description
Disable Receiver Timeout Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR1 RTOIE LL_USART_DisableIT_RTO
LL_USART_DisableIT_EOB
Function name
__STATIC_INLINE void LL_USART_DisableIT_EOB
(USART_TypeDef * USARTx)
Function description
Disable End Of Block Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR1 EOBIE LL_USART_DisableIT_EOB
LL_USART_DisableIT_LBD
Function name
__STATIC_INLINE void LL_USART_DisableIT_LBD
(USART_TypeDef * USARTx)
Function description
Disable LIN Break Detection Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_UART_LIN_INSTANCE(USARTx) can be used to
check whether or not LIN feature is supported by the USARTx
instance.
Reference Manual to
LL API cross
reference:
CR2 LBDIE LL_USART_DisableIT_LBD
LL_USART_DisableIT_ERROR
Function name
__STATIC_INLINE void LL_USART_DisableIT_ERROR
(USART_TypeDef * USARTx)
Function description
Disable Error Interrupt.
Parameters
USARTx: USART Instance
DocID026525 Rev 6
1221/1320
LL USART Generic Driver
Return values
UM1785
None
Notes
When set, Error Interrupt Enable Bit is enabling interrupt
generation in case of a framing error, overrun error or noise
flag (FE=1 or ORE=1 or NF=1 in the USARTx_ISR register).
0: Interrupt is inhibited 1: An interrupt is generated when
FE=1 or ORE=1 or NF=1 in the USARTx_ISR register.
Reference Manual to
LL API cross
reference:
CR3 EIE LL_USART_DisableIT_ERROR
LL_USART_DisableIT_CTS
Function name
__STATIC_INLINE void LL_USART_DisableIT_CTS
(USART_TypeDef * USARTx)
Function description
Disable CTS Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_UART_HWFLOW_INSTANCE(USARTx) can be
used to check whether or not Hardware Flow control feature
is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 CTSIE LL_USART_DisableIT_CTS
LL_USART_DisableIT_WKUP
Function name
__STATIC_INLINE void LL_USART_DisableIT_WKUP
(USART_TypeDef * USARTx)
Function description
Disable Wake Up from Stop Mode Interrupt.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro
IS_UART_WAKEUP_FROMSTOP_INSTANCE(USARTx) can
be used to check whether or not Wake-up from Stop mode
feature is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 WUFIE LL_USART_DisableIT_WKUP
LL_USART_IsEnabledIT_IDLE
1222/1320
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledIT_IDLE
(USART_TypeDef * USARTx)
Function description
Check if the USART IDLE Interrupt source is enabled or disabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
DocID026525 Rev 6
UM1785
LL USART Generic Driver
Reference Manual to
LL API cross
reference:
CR1 IDLEIE LL_USART_IsEnabledIT_IDLE
LL_USART_IsEnabledIT_RXNE
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledIT_RXNE
(USART_TypeDef * USARTx)
Function description
Check if the USART RX Not Empty Interrupt is enabled or
disabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 RXNEIE LL_USART_IsEnabledIT_RXNE
LL_USART_IsEnabledIT_TC
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledIT_TC
(USART_TypeDef * USARTx)
Function description
Check if the USART Transmission Complete Interrupt is enabled
or disabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 TCIE LL_USART_IsEnabledIT_TC
LL_USART_IsEnabledIT_TXE
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledIT_TXE
(USART_TypeDef * USARTx)
Function description
Check if the USART TX Empty Interrupt is enabled or disabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 TXEIE LL_USART_IsEnabledIT_TXE
LL_USART_IsEnabledIT_PE
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledIT_PE
(USART_TypeDef * USARTx)
Function description
Check if the USART Parity Error Interrupt is enabled or disabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
DocID026525 Rev 6
1223/1320
LL USART Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
CR1 PEIE LL_USART_IsEnabledIT_PE
LL_USART_IsEnabledIT_CM
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledIT_CM
(USART_TypeDef * USARTx)
Function description
Check if the USART Character Match Interrupt is enabled or
disabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 CMIE LL_USART_IsEnabledIT_CM
LL_USART_IsEnabledIT_RTO
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledIT_RTO
(USART_TypeDef * USARTx)
Function description
Check if the USART Receiver Timeout Interrupt is enabled or
disabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR1 RTOIE LL_USART_IsEnabledIT_RTO
LL_USART_IsEnabledIT_EOB
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledIT_EOB
(USART_TypeDef * USARTx)
Function description
Check if the USART End Of Block Interrupt is enabled or disabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
CR1 EOBIE LL_USART_IsEnabledIT_EOB
LL_USART_IsEnabledIT_LBD
1224/1320
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledIT_LBD
(USART_TypeDef * USARTx)
Function description
Check if the USART LIN Break Detection Interrupt is enabled or
DocID026525 Rev 6
UM1785
LL USART Generic Driver
disabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro IS_UART_LIN_INSTANCE(USARTx) can be used to
check whether or not LIN feature is supported by the USARTx
instance.
Reference Manual to
LL API cross
reference:
CR2 LBDIE LL_USART_IsEnabledIT_LBD
LL_USART_IsEnabledIT_ERROR
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledIT_ERROR
(USART_TypeDef * USARTx)
Function description
Check if the USART Error Interrupt is enabled or disabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR3 EIE LL_USART_IsEnabledIT_ERROR
LL_USART_IsEnabledIT_CTS
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledIT_CTS
(USART_TypeDef * USARTx)
Function description
Check if the USART CTS Interrupt is enabled or disabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro IS_UART_HWFLOW_INSTANCE(USARTx) can be
used to check whether or not Hardware Flow control feature
is supported by the USARTx instance.
Reference Manual to
LL API cross
reference:
CR3 CTSIE LL_USART_IsEnabledIT_CTS
LL_USART_IsEnabledIT_WKUP
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledIT_WKUP
(USART_TypeDef * USARTx)
Function description
Check if the USART Wake Up from Stop Mode Interrupt is enabled
or disabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Notes
Macro
IS_UART_WAKEUP_FROMSTOP_INSTANCE(USARTx) can
DocID026525 Rev 6
1225/1320
LL USART Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
be used to check whether or not Wake-up from Stop mode
feature is supported by the USARTx instance.
CR3 WUFIE LL_USART_IsEnabledIT_WKUP
LL_USART_EnableDMAReq_RX
Function name
__STATIC_INLINE void LL_USART_EnableDMAReq_RX
(USART_TypeDef * USARTx)
Function description
Enable DMA Mode for reception.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR3 DMAR LL_USART_EnableDMAReq_RX
LL_USART_DisableDMAReq_RX
Function name
__STATIC_INLINE void LL_USART_DisableDMAReq_RX
(USART_TypeDef * USARTx)
Function description
Disable DMA Mode for reception.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR3 DMAR LL_USART_DisableDMAReq_RX
LL_USART_IsEnabledDMAReq_RX
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledDMAReq_RX
(USART_TypeDef * USARTx)
Function description
Check if DMA Mode is enabled for reception.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR3 DMAR LL_USART_IsEnabledDMAReq_RX
LL_USART_EnableDMAReq_TX
Function name
__STATIC_INLINE void LL_USART_EnableDMAReq_TX
(USART_TypeDef * USARTx)
Function description
Enable DMA Mode for transmission.
Parameters
1226/1320
USARTx: USART Instance
DocID026525 Rev 6
UM1785
LL USART Generic Driver
Return values
None
Reference Manual to
LL API cross
reference:
CR3 DMAT LL_USART_EnableDMAReq_TX
LL_USART_DisableDMAReq_TX
Function name
__STATIC_INLINE void LL_USART_DisableDMAReq_TX
(USART_TypeDef * USARTx)
Function description
Disable DMA Mode for transmission.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR3 DMAT LL_USART_DisableDMAReq_TX
LL_USART_IsEnabledDMAReq_TX
Function name
__STATIC_INLINE uint32_t LL_USART_IsEnabledDMAReq_TX
(USART_TypeDef * USARTx)
Function description
Check if DMA Mode is enabled for transmission.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR3 DMAT LL_USART_IsEnabledDMAReq_TX
LL_USART_EnableDMADeactOnRxErr
Function name
__STATIC_INLINE void LL_USART_EnableDMADeactOnRxErr
(USART_TypeDef * USARTx)
Function description
Enable DMA Disabling on Reception Error.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
CR3 DDRE LL_USART_EnableDMADeactOnRxErr
LL_USART_DisableDMADeactOnRxErr
Function name
__STATIC_INLINE void LL_USART_DisableDMADeactOnRxErr
(USART_TypeDef * USARTx)
Function description
Disable DMA Disabling on Reception Error.
Parameters
USARTx: USART Instance
Return values
None
DocID026525 Rev 6
1227/1320
LL USART Generic Driver
Reference Manual to
LL API cross
reference:
UM1785
CR3 DDRE LL_USART_DisableDMADeactOnRxErr
LL_USART_IsEnabledDMADeactOnRxErr
Function name
__STATIC_INLINE uint32_t
LL_USART_IsEnabledDMADeactOnRxErr (USART_TypeDef *
USARTx)
Function description
Indicate if DMA Disabling on Reception Error is disabled.
Parameters
USARTx: USART Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR3 DDRE LL_USART_IsEnabledDMADeactOnRxErr
LL_USART_DMA_GetRegAddr
Function name
__STATIC_INLINE uint32_t LL_USART_DMA_GetRegAddr
(USART_TypeDef * USARTx, uint32_t Direction)
Function description
Get the data register address used for DMA transfer.
Parameters
USARTx: USART Instance
Direction: This parameter can be one of the following
values:
LL_USART_DMA_REG_DATA_TRANSMIT
LL_USART_DMA_REG_DATA_RECEIVE
Return values
Address: of data register
Reference Manual to
LL API cross
reference:
RDR RDR LL_USART_DMA_GetRegAddr
TDR TDR LL_USART_DMA_GetRegAddr
LL_USART_ReceiveData8
Function name
__STATIC_INLINE uint8_t LL_USART_ReceiveData8
(USART_TypeDef * USARTx)
Function description
Read Receiver Data register (Receive Data value, 8 bits)
Parameters
USARTx: USART Instance
Return values
Value: between Min_Data=0x00 and Max_Data=0xFF
Reference Manual to
LL API cross
reference:
RDR RDR LL_USART_ReceiveData8
LL_USART_ReceiveData9
1228/1320
Function name
__STATIC_INLINE uint16_t LL_USART_ReceiveData9
(USART_TypeDef * USARTx)
Function description
Read Receiver Data register (Receive Data value, 9 bits)
DocID026525 Rev 6
UM1785
LL USART Generic Driver
Parameters
USARTx: USART Instance
Return values
Value: between Min_Data=0x00 and Max_Data=0x1FF
Reference Manual to
LL API cross
reference:
RDR RDR LL_USART_ReceiveData9
LL_USART_TransmitData8
Function name
__STATIC_INLINE void LL_USART_TransmitData8
(USART_TypeDef * USARTx, uint8_t Value)
Function description
Write in Transmitter Data Register (Transmit Data value, 8 bits)
Parameters
USARTx: USART Instance
Value: between Min_Data=0x00 and Max_Data=0xFF
Return values
None
Reference Manual to
LL API cross
reference:
TDR TDR LL_USART_TransmitData8
LL_USART_TransmitData9
Function name
__STATIC_INLINE void LL_USART_TransmitData9
(USART_TypeDef * USARTx, uint16_t Value)
Function description
Write in Transmitter Data Register (Transmit Data value, 9 bits)
Parameters
USARTx: USART Instance
Value: between Min_Data=0x00 and Max_Data=0x1FF
Return values
None
Reference Manual to
LL API cross
reference:
TDR TDR LL_USART_TransmitData9
LL_USART_RequestAutoBaudRate
Function name
__STATIC_INLINE void LL_USART_RequestAutoBaudRate
(USART_TypeDef * USARTx)
Function description
Request an Automatic Baud Rate measurement on next received
data frame.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro
IS_USART_AUTOBAUDRATE_DETECTION_INSTANCE(USA
RTx) can be used to check whether or not Auto Baud Rate
detection feature is supported by the USARTx instance.
Reference Manual
to LL API cross
reference:
RQR ABRRQ LL_USART_RequestAutoBaudRate
DocID026525 Rev 6
1229/1320
LL USART Generic Driver
UM1785
LL_USART_RequestBreakSending
Function name
__STATIC_INLINE void LL_USART_RequestBreakSending
(USART_TypeDef * USARTx)
Function description
Request Break sending.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
RQR SBKRQ LL_USART_RequestBreakSending
LL_USART_RequestEnterMuteMode
Function name
__STATIC_INLINE void LL_USART_RequestEnterMuteMode
(USART_TypeDef * USARTx)
Function description
Put USART in mute mode and set the RWU flag.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
RQR MMRQ LL_USART_RequestEnterMuteMode
LL_USART_RequestRxDataFlush
1230/1320
Function name
__STATIC_INLINE void LL_USART_RequestRxDataFlush
(USART_TypeDef * USARTx)
Function description
Request a Receive Data flush.
Parameters
USARTx: USART Instance
Return values
None
Reference Manual to
LL API cross
reference:
RQR RXFRQ LL_USART_RequestRxDataFlush
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_RequestTxDataFlush
Function name
__STATIC_INLINE void LL_USART_RequestTxDataFlush
(USART_TypeDef * USARTx)
Function description
Request a Transmit data flush.
Parameters
USARTx: USART Instance
Return values
None
Notes
Macro IS_SMARTCARD_INSTANCE(USARTx) can be used
to check whether or not Smartcard feature is supported by the
USARTx instance.
Reference Manual to
LL API cross
reference:
RQR TXFRQ LL_USART_RequestTxDataFlush
LL_USART_DeInit
Function name
ErrorStatus LL_USART_DeInit (USART_TypeDef * USARTx)
Function description
De-initialize USART registers (Registers restored to their default
values).
Parameters
USARTx: USART Instance
Return values
An: ErrorStatus enumeration value:
SUCCESS: USART registers are de-initialized
ERROR: USART registers are not de-initialized
LL_USART_Init
Function name
ErrorStatus LL_USART_Init (USART_TypeDef * USARTx,
LL_USART_InitTypeDef * USART_InitStruct)
Function description
Initialize USART registers according to the specified parameters in
USART_InitStruct.
Parameters
USARTx: USART Instance
USART_InitStruct: pointer to a LL_USART_InitTypeDef
structure that contains the configuration information for the
specified USART peripheral.
Return values
An: ErrorStatus enumeration value:
SUCCESS: USART registers are initialized according to
USART_InitStruct content
ERROR: Problem occurred during USART Registers
initialization
Notes
As some bits in USART configuration registers can only be
written when the USART is disabled (USART_CR1_UE bit
=0), USART IP should be in disabled state prior calling this
function. Otherwise, ERROR result will be returned.
Baud rate value stored in USART_InitStruct BaudRate field,
should be valid (different from 0).
DocID026525 Rev 6
1231/1320
LL USART Generic Driver
UM1785
LL_USART_StructInit
Function name
void LL_USART_StructInit (LL_USART_InitTypeDef *
USART_InitStruct)
Function description
Set each LL_USART_InitTypeDef field to default value.
Parameters
USART_InitStruct: pointer to a LL_USART_InitTypeDef
structure whose fields will be set to default values.
Return values
None
LL_USART_ClockInit
Function name
ErrorStatus LL_USART_ClockInit (USART_TypeDef * USARTx,
LL_USART_ClockInitTypeDef * USART_ClockInitStruct)
Function description
Initialize USART Clock related settings according to the specified
parameters in the USART_ClockInitStruct.
Parameters
USARTx: USART Instance
USART_ClockInitStruct: pointer to a
LL_USART_ClockInitTypeDef structure that contains the
Clock configuration information for the specified USART
peripheral.
Return values
An: ErrorStatus enumeration value:
SUCCESS: USART registers related to Clock settings
are initialized according to USART_ClockInitStruct
content
ERROR: Problem occurred during USART Registers
initialization
Notes
As some bits in USART configuration registers can only be
written when the USART is disabled (USART_CR1_UE bit
=0), USART IP should be in disabled state prior calling this
function. Otherwise, ERROR result will be returned.
LL_USART_ClockStructInit
1232/1320
Function name
void LL_USART_ClockStructInit
(LL_USART_ClockInitTypeDef * USART_ClockInitStruct)
Function description
Set each field of a LL_USART_ClockInitTypeDef type structure to
default value.
Parameters
USART_ClockInitStruct: pointer to a
LL_USART_ClockInitTypeDef structure whose fields will be
set to default values.
Return values
None
DocID026525 Rev 6
UM1785
LL USART Generic Driver
68.3
USART Firmware driver defines
68.3.1
USART
Address Length Detection
LL_USART_ADDRESS_DETECT_4B
4-bit address detection method selected
LL_USART_ADDRESS_DETECT_7B
7-bit address detection (in 8-bit data mode)
method selected
Autobaud Detection
LL_USART_AUTOBAUD_DETECT_ON_STARTBIT
Measurement of the start bit is
used to detect the baud rate
LL_USART_AUTOBAUD_DETECT_ON_FALLINGEDGE
Falling edge to falling edge
measurement. Received frame
must start with a single bit = 1 > Frame = Start10xxxxxx
LL_USART_AUTOBAUD_DETECT_ON_7F_FRAME
0x7F frame detection
LL_USART_AUTOBAUD_DETECT_ON_55_FRAME
0x55 frame detection
Binary Data Inversion
LL_USART_BINARY_LOGIC_POSITIVE
Logical data from the data register are
send/received in positive/direct logic. (1=H,
0=L)
LL_USART_BINARY_LOGIC_NEGATIVE
Logical data from the data register are
send/received in negative/inverse logic. (1=L,
0=H). The parity bit is also inverted.
Bit Order
LL_USART_BITORDER_LSBFIRST
data is transmitted/received with data bit 0 first,
following the start bit
LL_USART_BITORDER_MSBFIRST
data is transmitted/received with the MSB first,
following the start bit
Clear Flags Defines
LL_USART_ICR_PECF
Parity error flag
LL_USART_ICR_FECF
Framing error flag
LL_USART_ICR_NCF
Noise detected flag
LL_USART_ICR_ORECF
Overrun error flag
LL_USART_ICR_IDLECF
Idle line detected flag
LL_USART_ICR_TCCF
Transmission complete flag
LL_USART_ICR_LBDCF
LIN break detection flag
LL_USART_ICR_CTSCF
CTS flag
LL_USART_ICR_RTOCF
Receiver timeout flag
LL_USART_ICR_EOBCF
End of block flag
LL_USART_ICR_CMCF
Character match flag
DocID026525 Rev 6
1233/1320
LL USART Generic Driver
LL_USART_ICR_WUCF
UM1785
Wakeup from Stop mode flag
Clock Signal
LL_USART_CLOCK_DISABLE
Clock signal not provided
LL_USART_CLOCK_ENABLE
Clock signal provided
Datawidth
LL_USART_DATAWIDTH_7B
7 bits word length : Start bit, 7 data bits, n stop bits
LL_USART_DATAWIDTH_8B
8 bits word length : Start bit, 8 data bits, n stop bits
LL_USART_DATAWIDTH_9B
9 bits word length : Start bit, 9 data bits, n stop bits
Driver Enable Polarity
LL_USART_DE_POLARITY_HIGH
DE signal is active high
LL_USART_DE_POLARITY_LOW
DE signal is active low
Communication Direction
LL_USART_DIRECTION_NONE
Transmitter and Receiver are disabled
LL_USART_DIRECTION_RX
Transmitter is disabled and Receiver is enabled
LL_USART_DIRECTION_TX
Transmitter is enabled and Receiver is disabled
LL_USART_DIRECTION_TX_RX
Transmitter and Receiver are enabled
DMA Register Data
LL_USART_DMA_REG_DATA_TRANSMIT
Get address of data register used for
transmission
LL_USART_DMA_REG_DATA_RECEIVE
Get address of data register used for
reception
Get Flags Defines
1234/1320
LL_USART_ISR_PE
Parity error flag
LL_USART_ISR_FE
Framing error flag
LL_USART_ISR_NE
Noise detected flag
LL_USART_ISR_ORE
Overrun error flag
LL_USART_ISR_IDLE
Idle line detected flag
LL_USART_ISR_RXNE
Read data register not empty flag
LL_USART_ISR_TC
Transmission complete flag
LL_USART_ISR_TXE
Transmit data register empty flag
LL_USART_ISR_LBDF
LIN break detection flag
LL_USART_ISR_CTSIF
CTS interrupt flag
LL_USART_ISR_CTS
CTS flag
LL_USART_ISR_RTOF
Receiver timeout flag
LL_USART_ISR_EOBF
End of block flag
LL_USART_ISR_ABRE
Auto baud rate error flag
LL_USART_ISR_ABRF
Auto baud rate flag
DocID026525 Rev 6
UM1785
LL USART Generic Driver
LL_USART_ISR_BUSY
Busy flag
LL_USART_ISR_CMF
Character match flag
LL_USART_ISR_SBKF
Send break flag
LL_USART_ISR_RWU
Receiver wakeup from Mute mode flag
LL_USART_ISR_WUF
Wakeup from Stop mode flag
LL_USART_ISR_TEACK
Transmit enable acknowledge flag
LL_USART_ISR_REACK
Receive enable acknowledge flag
Hardware Control
LL_USART_HWCONTROL_NONE
CTS and RTS hardware flow control disabled
LL_USART_HWCONTROL_RTS
RTS output enabled, data is only requested when
there is space in the receive buffer
LL_USART_HWCONTROL_CTS
CTS mode enabled, data is only transmitted
when the nCTS input is asserted (tied to 0)
LL_USART_HWCONTROL_RTS_CTS
CTS and RTS hardware flow control enabled
IrDA Power
LL_USART_IRDA_POWER_NORMAL
IrDA normal power mode
LL_USART_IRDA_POWER_LOW
IrDA low power mode
IT Defines
LL_USART_CR1_IDLEIE
IDLE interrupt enable
LL_USART_CR1_RXNEIE
Read data register not empty interrupt enable
LL_USART_CR1_TCIE
Transmission complete interrupt enable
LL_USART_CR1_TXEIE
Transmit data register empty interrupt enable
LL_USART_CR1_PEIE
Parity error
LL_USART_CR1_CMIE
Character match interrupt enable
LL_USART_CR1_RTOIE
Receiver timeout interrupt enable
LL_USART_CR1_EOBIE
End of Block interrupt enable
LL_USART_CR2_LBDIE
LIN break detection interrupt enable
LL_USART_CR3_EIE
Error interrupt enable
LL_USART_CR3_CTSIE
CTS interrupt enable
LL_USART_CR3_WUFIE
Wakeup from Stop mode interrupt enable
Last Clock Pulse
LL_USART_LASTCLKPULSE_NO_OUTPUT
The clock pulse of the last data bit is not
output to the SCLK pin
LL_USART_LASTCLKPULSE_OUTPUT
The clock pulse of the last data bit is output
to the SCLK pin
LIN Break Detection Length
LL_USART_LINBREAK_DETECT_10B
10-bit break detection method selected
LL_USART_LINBREAK_DETECT_11B
11-bit break detection method selected
DocID026525 Rev 6
1235/1320
LL USART Generic Driver
Oversampling
UM1785
LL_USART_OVERSAMPLING_16
Oversampling by 16
LL_USART_OVERSAMPLING_8
Oversampling by 8
Parity Control
LL_USART_PARITY_NONE
Parity control disabled
LL_USART_PARITY_EVEN
Parity control enabled and Even Parity is selected
LL_USART_PARITY_ODD
Parity control enabled and Odd Parity is selected
Clock Phase
LL_USART_PHASE_1EDGE
The first clock transition is the first data capture edge
LL_USART_PHASE_2EDGE
The second clock transition is the first data capture edge
Clock Polarity
LL_USART_POLARITY_LOW
Steady low value on SCLK pin outside transmission
window
LL_USART_POLARITY_HIGH
Steady high value on SCLK pin outside transmission
window
RX Pin Active Level Inversion
LL_USART_RXPIN_LEVEL_STANDARD
RX pin signal works using the standard logic
levels
LL_USART_RXPIN_LEVEL_INVERTED
RX pin signal values are inverted.
Stop Bits
LL_USART_STOPBITS_0_5
0.5 stop bit
LL_USART_STOPBITS_1
1 stop bit
LL_USART_STOPBITS_1_5
1.5 stop bits
LL_USART_STOPBITS_2
2 stop bits
TX Pin Active Level Inversion
LL_USART_TXPIN_LEVEL_STANDARD
TX pin signal works using the standard logic
levels
LL_USART_TXPIN_LEVEL_INVERTED
TX pin signal values are inverted.
TX RX Pins Swap
LL_USART_TXRX_STANDARD
TX/RX pins are used as defined in standard pinout
LL_USART_TXRX_SWAPPED
TX and RX pins functions are swapped.
Wakeup
LL_USART_WAKEUP_IDLELINE
USART wake up from Mute mode on Idle Line
LL_USART_WAKEUP_ADDRESSMARK
USART wake up from Mute mode on Address
Mark
Wakeup Activation
1236/1320
LL_USART_WAKEUP_ON_ADDRESS
Wake up active on address match
LL_USART_WAKEUP_ON_STARTBIT
Wake up active on Start bit detection
DocID026525 Rev 6
UM1785
LL USART Generic Driver
Wake up active on RXNE
LL_USART_WAKEUP_ON_RXNE
Exported_Macros_Helper
__LL_USART_DIV_SAMPLING8
Description:
Compute USARTDIV value according to
Peripheral Clock and expected Baud Rate in 8
bits sampling mode (32 bits value of USARTDIV
is returned)
Parameters:
__PERIPHCLK__: Peripheral Clock frequency
used for USART instance
__BAUDRATE__: Baud rate value to achieve
Return value:
USARTDIV: value to be used for BRR register
filling in OverSampling_8 case
__LL_USART_DIV_SAMPLING16
Description:
Compute USARTDIV value according to
Peripheral Clock and expected Baud Rate in 16
bits sampling mode (32 bits value of USARTDIV
is returned)
Parameters:
__PERIPHCLK__: Peripheral Clock frequency
used for USART instance
__BAUDRATE__: Baud rate value to achieve
Return value:
USARTDIV: value to be used for BRR register
filling in OverSampling_16 case
Common Write and read registers Macros
LL_USART_WriteReg
Description:
Write a value in USART register.
Parameters:
__INSTANCE__: USART Instance
__REG__: Register to be written
__VALUE__: Value to be written in the register
Return value:
None
DocID026525 Rev 6
1237/1320
LL USART Generic Driver
LL_USART_ReadReg
UM1785
Description:
Read a value in USART register.
Parameters:
__INSTANCE__: USART Instance
__REG__: Register to be read
Return value:
Register: value
1238/1320
DocID026525 Rev 6
UM1785
LL UTILS Generic Driver
69
LL UTILS Generic Driver
69.1
UTILS Firmware driver registers structures
69.1.1
LL_UTILS_PLLInitTypeDef
Data Fields
uint32_t PLLMul
uint32_t PLLDiv
Field Documentation
uint32_t LL_UTILS_PLLInitTypeDef::PLLMul
Multiplication factor for PLL VCO input clock. This parameter can be a value of
RCC_LL_EC_PLL_MULThis feature can be modified afterwards using unitary
function LL_RCC_PLL_ConfigDomain_SYS().
uint32_t LL_UTILS_PLLInitTypeDef::PLLDiv
Division factor for PLL VCO output clock. This parameter can be a value of
RCC_LL_EC_PREDIV_DIVThis feature can be modified afterwards using unitary
function LL_RCC_PLL_ConfigDomain_SYS().
69.1.2
LL_UTILS_ClkInitTypeDef
Data Fields
uint32_t AHBCLKDivider
uint32_t APB1CLKDivider
Field Documentation
uint32_t LL_UTILS_ClkInitTypeDef::AHBCLKDivider
The AHB clock (HCLK) divider. This clock is derived from the system clock (SYSCLK).
This parameter can be a value of RCC_LL_EC_SYSCLK_DIVThis feature can be
modified afterwards using unitary function LL_RCC_SetAHBPrescaler().
uint32_t LL_UTILS_ClkInitTypeDef::APB1CLKDivider
The APB1 clock (PCLK1) divider. This clock is derived from the AHB clock (HCLK).
This parameter can be a value of RCC_LL_EC_APB1_DIVThis feature can be
modified afterwards using unitary function LL_RCC_SetAPB1Prescaler().
69.2
UTILS Firmware driver API description
69.2.1
System Configuration functions
System, AHB and APB buses clocks configuration
The maximum frequency of the SYSCLK, HCLK, PCLK1 and PCLK2 is 48000000 Hz.
This section contains the following APIs:
LL_SetSystemCoreClock()
LL_PLL_ConfigSystemClock_HSI()
LL_PLL_ConfigSystemClock_HSI48()
LL_PLL_ConfigSystemClock_HSE()
DocID026525 Rev 6
1239/1320
LL UTILS Generic Driver
69.2.2
UM1785
Detailed description of functions
LL_GetUID_Word0
Function name
__STATIC_INLINE uint32_t LL_GetUID_Word0 (void )
Function description
Get Word0 of the unique device identifier (UID based on 96 bits)
Return values
UID[31:0]: X and Y coordinates on the wafer expressed in
BCD format
LL_GetUID_Word1
Function name
__STATIC_INLINE uint32_t LL_GetUID_Word1 (void )
Function description
Get Word1 of the unique device identifier (UID based on 96 bits)
Return values
UID[63:32]: Wafer number (UID[39:32]) & LOT_NUM[23:0]
(UID[63:40])
LL_GetUID_Word2
Function name
__STATIC_INLINE uint32_t LL_GetUID_Word2 (void )
Function description
Get Word2 of the unique device identifier (UID based on 96 bits)
Return values
UID[95:64]: Lot number (ASCII encoded) - LOT_NUM[55:24]
LL_GetFlashSize
Function name
__STATIC_INLINE uint32_t LL_GetFlashSize (void )
Function description
Get Flash memory size.
Return values
FLASH_SIZE[15:0]: Flash memory size
Notes
This bitfield indicates the size of the device Flash memory
expressed in Kbytes. As an example, 0x040 corresponds to
64 Kbytes.
LL_InitTick
1240/1320
Function name
__STATIC_INLINE void LL_InitTick (uint32_t HCLKFrequency,
uint32_t Ticks)
Function description
This function configures the Cortex-M SysTick source of the time
base.
Parameters
HCLKFrequency: HCLK frequency in Hz (can be calculated
thanks to RCC helper macro)
Ticks: Number of ticks
Return values
None
Notes
When a RTOS is used, it is recommended to avoid changing
the SysTick configuration by calling this function, for a delay
use rather osDelay RTOS service.
DocID026525 Rev 6
UM1785
LL UTILS Generic Driver
LL_Init1msTick
Function name
void LL_Init1msTick (uint32_t HCLKFrequency)
Function description
This function configures the Cortex-M SysTick source to have 1ms
time base.
Parameters
HCLKFrequency: HCLK frequency in Hz
Return values
None
Notes
When a RTOS is used, it is recommended to avoid changing
the Systick configuration by calling this function, for a delay
use rather osDelay RTOS service.
HCLK frequency can be calculated thanks to RCC helper
macro or function LL_RCC_GetSystemClocksFreq
LL_mDelay
Function name
void LL_mDelay (uint32_t Delay)
Function description
This function provides accurate delay (in milliseconds) based on
SysTick counter flag.
Parameters
Delay: specifies the delay time length, in milliseconds.
Return values
None
Notes
When a RTOS is used, it is recommended to avoid using
blocking delay and use rather osDelay service.
To respect 1ms timebase, user should call LL_Init1msTick
function which will configure Systick to 1ms
LL_SetSystemCoreClock
Function name
void LL_SetSystemCoreClock (uint32_t HCLKFrequency)
Function description
This function sets directly SystemCoreClock CMSIS variable.
Parameters
HCLKFrequency: HCLK frequency in Hz (can be calculated
thanks to RCC helper macro)
Return values
None
Notes
Variable can be calculated also through
SystemCoreClockUpdate function.
LL_PLL_ConfigSystemClock_HSI
Function name
ErrorStatus LL_PLL_ConfigSystemClock_HSI
(LL_UTILS_PLLInitTypeDef * UTILS_PLLInitStruct,
LL_UTILS_ClkInitTypeDef * UTILS_ClkInitStruct)
Function description
This function configures system clock with HSI as clock source of
the PLL.
Parameters
UTILS_PLLInitStruct: pointer to a
LL_UTILS_PLLInitTypeDef structure that contains the
configuration information for the PLL.
UTILS_ClkInitStruct: pointer to a LL_UTILS_ClkInitTypeDef
structure that contains the configuration information for the
DocID026525 Rev 6
1241/1320
LL UTILS Generic Driver
UM1785
BUS prescalers.
Return values
An: ErrorStatus enumeration value:
SUCCESS: Max frequency configuration done
ERROR: Max frequency configuration not done
Notes
The application need to ensure that PLL is disabled.
Function is based on the following formula: PLL output
frequency = ((HSI frequency / PREDIV) * PLLMUL)PREDIV:
Set to 2 for few devicesPLLMUL: The application software
must set correctly the PLL multiplication factor to be in the
range 16-48MHz
FLASH latency can be modified through this function.
LL_PLL_ConfigSystemClock_HSI48
Function name
ErrorStatus LL_PLL_ConfigSystemClock_HSI48
(LL_UTILS_PLLInitTypeDef * UTILS_PLLInitStruct,
LL_UTILS_ClkInitTypeDef * UTILS_ClkInitStruct)
Function description
This function configures system clock with HSI48 as clock source
of the PLL.
Parameters
UTILS_PLLInitStruct: pointer to a
LL_UTILS_PLLInitTypeDef structure that contains the
configuration information for the PLL.
UTILS_ClkInitStruct: pointer to a LL_UTILS_ClkInitTypeDef
structure that contains the configuration information for the
BUS prescalers.
Return values
An: ErrorStatus enumeration value:
SUCCESS: Max frequency configuration done
ERROR: Max frequency configuration not done
Notes
The application need to ensure that PLL is disabled.
Function is based on the following formula: PLL output
frequency = ((HSI48 frequency / PREDIV) *
PLLMUL)PLLMUL: The application software must set
correctly the PLL multiplication factor to be in the range 1648MHz
LL_PLL_ConfigSystemClock_HSE
Function name
ErrorStatus LL_PLL_ConfigSystemClock_HSE (uint32_t
HSEFrequency, uint32_t HSEBypass,
LL_UTILS_PLLInitTypeDef * UTILS_PLLInitStruct,
LL_UTILS_ClkInitTypeDef * UTILS_ClkInitStruct)
Function description
This function configures system clock with HSE as clock source of
the PLL.
Parameters
1242/1320
HSEFrequency: Value between Min_Data = 4000000 and
Max_Data = 32000000
HSEBypass: This parameter can be one of the following
values:
LL_UTILS_HSEBYPASS_ON
LL_UTILS_HSEBYPASS_OFF
UTILS_PLLInitStruct: pointer to a
DocID026525 Rev 6
UM1785
LL UTILS Generic Driver
LL_UTILS_PLLInitTypeDef structure that contains the
configuration information for the PLL.
UTILS_ClkInitStruct: pointer to a LL_UTILS_ClkInitTypeDef
structure that contains the configuration information for the
BUS prescalers.
Return values
An: ErrorStatus enumeration value:
SUCCESS: Max frequency configuration done
ERROR: Max frequency configuration not done
Notes
The application need to ensure that PLL is disabled.
Function is based on the following formula: PLL output
frequency = ((HSE frequency / PREDIV) * PLLMUL)PLLMUL:
The application software must set correctly the PLL
multiplication factor to be in the range 16-48MHz
FLASH latency can be modified through this function.
69.3
UTILS Firmware driver defines
69.3.1
UTILS
HSE Bypass activation
LL_UTILS_HSEBYPASS_OFF
HSE Bypass is not enabled
LL_UTILS_HSEBYPASS_ON
HSE Bypass is enabled
DocID026525 Rev 6
1243/1320
LL WWDG Generic Driver
UM1785
70
LL WWDG Generic Driver
70.1
WWDG Firmware driver API description
70.1.1
Detailed description of functions
LL_WWDG_Enable
Function name
__STATIC_INLINE void LL_WWDG_Enable (WWDG_TypeDef *
WWDGx)
Function description
Enable Window Watchdog.
Parameters
WWDGx: WWDG Instance
Return values
None
Notes
It is enabled by setting the WDGA bit in the WWDG_CR
register, then it cannot be disabled again except by a reset.
This bit is set by software and only cleared by hardware after
a reset. When WDGA = 1, the watchdog can generate a
reset.
Reference Manual to
LL API cross
reference:
CR WDGA LL_WWDG_Enable
LL_WWDG_IsEnabled
Function name
__STATIC_INLINE uint32_t LL_WWDG_IsEnabled
(WWDG_TypeDef * WWDGx)
Function description
Checks if Window Watchdog is enabled.
Parameters
WWDGx: WWDG Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CR WDGA LL_WWDG_IsEnabled
LL_WWDG_SetCounter
1244/1320
Function name
__STATIC_INLINE void LL_WWDG_SetCounter
(WWDG_TypeDef * WWDGx, uint32_t Counter)
Function description
Set the Watchdog counter value to provided value (7-bits T[6:0])
Parameters
WWDGx: WWDG Instance
Counter: 0..0x7F (7 bit counter value)
Return values
None
Notes
When writing to the WWDG_CR register, always write 1 in the
MSB b6 to avoid generating an immediate reset This counter
is decremented every (4096 x 2expWDGTB) PCLK cycles A
reset is produced when it rolls over from 0x40 to 0x3F (bit T6
DocID026525 Rev 6
UM1785
LL WWDG Generic Driver
becomes cleared) Setting the counter lower then 0x40 causes
an immediate reset (if WWDG enabled)
Reference Manual to
LL API cross
reference:
CR T LL_WWDG_SetCounter
LL_WWDG_GetCounter
Function name
__STATIC_INLINE uint32_t LL_WWDG_GetCounter
(WWDG_TypeDef * WWDGx)
Function description
Return current Watchdog Counter Value (7 bits counter value)
Parameters
WWDGx: WWDG Instance
Return values
7: bit Watchdog Counter value
Reference Manual to
LL API cross
reference:
CR T LL_WWDG_GetCounter
LL_WWDG_SetPrescaler
Function name
__STATIC_INLINE void LL_WWDG_SetPrescaler
(WWDG_TypeDef * WWDGx, uint32_t Prescaler)
Function description
Set the time base of the prescaler (WDGTB).
Parameters
WWDGx: WWDG Instance
Prescaler: This parameter can be one of the following
values:
LL_WWDG_PRESCALER_1
LL_WWDG_PRESCALER_2
LL_WWDG_PRESCALER_4
LL_WWDG_PRESCALER_8
Return values
None
Notes
Prescaler is used to apply ratio on PCLK clock, so that
Watchdog counter is decremented every (4096 x
2expWDGTB) PCLK cycles
Reference Manual to
LL API cross
reference:
CFR WDGTB LL_WWDG_SetPrescaler
LL_WWDG_GetPrescaler
Function name
__STATIC_INLINE uint32_t LL_WWDG_GetPrescaler
(WWDG_TypeDef * WWDGx)
Function description
Return current Watchdog Prescaler Value.
Parameters
WWDGx: WWDG Instance
Return values
Returned: value can be one of the following values:
LL_WWDG_PRESCALER_1
LL_WWDG_PRESCALER_2
LL_WWDG_PRESCALER_4
DocID026525 Rev 6
1245/1320
LL WWDG Generic Driver
UM1785
LL_WWDG_PRESCALER_8
Reference Manual to
LL API cross
reference:
CFR WDGTB LL_WWDG_GetPrescaler
LL_WWDG_SetWindow
Function name
__STATIC_INLINE void LL_WWDG_SetWindow
(WWDG_TypeDef * WWDGx, uint32_t Window)
Function description
Set the Watchdog Window value to be compared to the
downcounter (7-bits W[6:0]).
Parameters
WWDGx: WWDG Instance
Window: 0x00..0x7F (7 bit Window value)
Return values
None
Notes
This window value defines when write in the WWDG_CR
register to program Watchdog counter is allowed. Watchdog
counter value update must occur only when the counter value
is lower than the Watchdog window register value. Otherwise,
a MCU reset is generated if the 7-bit Watchdog counter value
(in the control register) is refreshed before the downcounter
has reached the watchdog window register value. Physically
is possible to set the Window lower then 0x40 but it is not
recommended. To generate an immediate reset, it is possible
to set the Counter lower than 0x40.
Reference Manual to
LL API cross
reference:
CFR W LL_WWDG_SetWindow
LL_WWDG_GetWindow
Function name
__STATIC_INLINE uint32_t LL_WWDG_GetWindow
(WWDG_TypeDef * WWDGx)
Function description
Return current Watchdog Window Value (7 bits value)
Parameters
WWDGx: WWDG Instance
Return values
7: bit Watchdog Window value
Reference Manual to
LL API cross
reference:
CFR W LL_WWDG_GetWindow
LL_WWDG_IsActiveFlag_EWKUP
1246/1320
Function name
__STATIC_INLINE uint32_t LL_WWDG_IsActiveFlag_EWKUP
(WWDG_TypeDef * WWDGx)
Function description
Indicates if the WWDG Early Wakeup Interrupt Flag is set or not.
Parameters
WWDGx: WWDG Instance
Return values
State: of bit (1 or 0).
Notes
This bit is set by hardware when the counter has reached the
DocID026525 Rev 6
UM1785
LL WWDG Generic Driver
value 0x40. It must be cleared by software by writing 0. A
write of 1 has no effect. This bit is also set if the interrupt is
not enabled.
Reference Manual to
LL API cross
reference:
SR EWIF LL_WWDG_IsActiveFlag_EWKUP
LL_WWDG_ClearFlag_EWKUP
Function name
__STATIC_INLINE void LL_WWDG_ClearFlag_EWKUP
(WWDG_TypeDef * WWDGx)
Function description
Clear WWDG Early Wakeup Interrupt Flag (EWIF)
Parameters
WWDGx: WWDG Instance
Return values
None
Reference Manual to
LL API cross
reference:
SR EWIF LL_WWDG_ClearFlag_EWKUP
LL_WWDG_EnableIT_EWKUP
Function name
__STATIC_INLINE void LL_WWDG_EnableIT_EWKUP
(WWDG_TypeDef * WWDGx)
Function description
Enable the Early Wakeup Interrupt.
Parameters
WWDGx: WWDG Instance
Return values
None
Notes
When set, an interrupt occurs whenever the counter reaches
value 0x40. This interrupt is only cleared by hardware after a
reset
Reference Manual to
LL API cross
reference:
CFR EWI LL_WWDG_EnableIT_EWKUP
LL_WWDG_IsEnabledIT_EWKUP
Function name
__STATIC_INLINE uint32_t LL_WWDG_IsEnabledIT_EWKUP
(WWDG_TypeDef * WWDGx)
Function description
Check if Early Wakeup Interrupt is enabled.
Parameters
WWDGx: WWDG Instance
Return values
State: of bit (1 or 0).
Reference Manual to
LL API cross
reference:
CFR EWI LL_WWDG_IsEnabledIT_EWKUP
DocID026525 Rev 6
1247/1320
LL WWDG Generic Driver
UM1785
70.2
WWDG Firmware driver defines
70.2.1
WWDG
IT Defines
LL_WWDG_CFR_EWI
PRESCALER
LL_WWDG_PRESCALER_1
WWDG counter clock = (PCLK1/4096)/1
LL_WWDG_PRESCALER_2
WWDG counter clock = (PCLK1/4096)/2
LL_WWDG_PRESCALER_4
WWDG counter clock = (PCLK1/4096)/4
LL_WWDG_PRESCALER_8
WWDG counter clock = (PCLK1/4096)/8
Common Write and read registers macros
LL_WWDG_WriteReg
Description:
Write a value in WWDG register.
Parameters:
__INSTANCE__: WWDG Instance
__REG__: Register to be written
__VALUE__: Value to be written in the register
Return value:
None
LL_WWDG_ReadReg
Description:
Read a value in WWDG register.
Parameters:
__INSTANCE__: WWDG Instance
__REG__: Register to be read
Return value:
Register: value
1248/1320
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
71
Correspondence between API registers and API lowlayer driver functions
71.1
ADC
Table 25: Correspondence between ADC registers and ADC low-layer driver functions
Register
Field
Function
LL_ADC_GetCommonPathInternalCh
TSEN
LL_ADC_SetCommonPathInternalCh
LL_ADC_GetCommonPathInternalCh
CCR
VBATEN
LL_ADC_SetCommonPathInternalCh
LL_ADC_GetCommonPathInternalCh
VREFEN
LL_ADC_SetCommonPathInternalCh
LL_ADC_GetDataAlignment
ALIGN
LL_ADC_SetDataAlignment
LL_ADC_GetLowPowerMode
AUTOFF
LL_ADC_SetLowPowerMode
LL_ADC_GetAnalogWDMonitChannels
AWDCH
LL_ADC_SetAnalogWDMonitChannels
LL_ADC_GetAnalogWDMonitChannels
AWDEN
LL_ADC_SetAnalogWDMonitChannels
LL_ADC_GetAnalogWDMonitChannels
AWDSGL
LL_ADC_SetAnalogWDMonitChannels
LL_ADC_REG_GetContinuousMode
CONT
CFGR1
LL_ADC_REG_SetContinuousMode
LL_ADC_REG_GetSequencerDiscont
DISCEN
LL_ADC_REG_SetSequencerDiscont
LL_ADC_REG_GetDMATransfer
DMACFG
LL_ADC_REG_SetDMATransfer
LL_ADC_REG_GetDMATransfer
DMAEN
LL_ADC_REG_SetDMATransfer
LL_ADC_REG_GetTriggerEdge
LL_ADC_REG_GetTriggerSource
EXTEN
LL_ADC_REG_IsTriggerSourceSWStart
LL_ADC_REG_SetTriggerEdge
LL_ADC_REG_SetTriggerSource
EXTSEL
LL_ADC_REG_GetTriggerSource
DocID026525 Rev 6
1249/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_ADC_REG_SetTriggerSource
LL_ADC_REG_GetOverrun
OVRMOD
LL_ADC_REG_SetOverrun
LL_ADC_GetResolution
RES
LL_ADC_SetResolution
LL_ADC_REG_GetSequencerScanDirection
SCANDIR
LL_ADC_REG_SetSequencerScanDirection
LL_ADC_GetLowPowerMode
WAIT
LL_ADC_SetLowPowerMode
LL_ADC_GetClock
CFGR2
CKMODE
LL_ADC_SetClock
LL_ADC_REG_GetSequencerChannels
LL_ADC_REG_SetSequencerChAdd
CHSEL0
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
LL_ADC_REG_GetSequencerChannels
LL_ADC_REG_SetSequencerChAdd
CHSEL1
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
LL_ADC_REG_GetSequencerChannels
LL_ADC_REG_SetSequencerChAdd
CHSEL10
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
LL_ADC_REG_GetSequencerChannels
CHSELR
LL_ADC_REG_SetSequencerChAdd
CHSEL11
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
LL_ADC_REG_GetSequencerChannels
LL_ADC_REG_SetSequencerChAdd
CHSEL12
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
LL_ADC_REG_GetSequencerChannels
LL_ADC_REG_SetSequencerChAdd
CHSEL13
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
CHSEL14
1250/1320
LL_ADC_REG_GetSequencerChannels
DocID026525 Rev 6
UM1785
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_ADC_REG_SetSequencerChAdd
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
LL_ADC_REG_GetSequencerChannels
LL_ADC_REG_SetSequencerChAdd
CHSEL15
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
LL_ADC_REG_GetSequencerChannels
LL_ADC_REG_SetSequencerChAdd
CHSEL16
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
LL_ADC_REG_GetSequencerChannels
LL_ADC_REG_SetSequencerChAdd
CHSEL17
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
LL_ADC_REG_GetSequencerChannels
LL_ADC_REG_SetSequencerChAdd
CHSEL18
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
LL_ADC_REG_GetSequencerChannels
LL_ADC_REG_SetSequencerChAdd
CHSEL2
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
LL_ADC_REG_GetSequencerChannels
LL_ADC_REG_SetSequencerChAdd
CHSEL3
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
LL_ADC_REG_GetSequencerChannels
LL_ADC_REG_SetSequencerChAdd
CHSEL4
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
LL_ADC_REG_GetSequencerChannels
LL_ADC_REG_SetSequencerChAdd
CHSEL5
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
CHSEL6
LL_ADC_REG_GetSequencerChannels
DocID026525 Rev 6
1251/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_ADC_REG_SetSequencerChAdd
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
LL_ADC_REG_GetSequencerChannels
LL_ADC_REG_SetSequencerChAdd
CHSEL7
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
LL_ADC_REG_GetSequencerChannels
LL_ADC_REG_SetSequencerChAdd
CHSEL8
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
LL_ADC_REG_GetSequencerChannels
LL_ADC_REG_SetSequencerChAdd
CHSEL9
LL_ADC_REG_SetSequencerChRem
LL_ADC_REG_SetSequencerChannels
LL_ADC_IsCalibrationOnGoing
ADCAL
LL_ADC_StartCalibration
LL_ADC_Disable
ADDIS
LL_ADC_IsDisableOngoing
LL_ADC_Enable
CR
ADEN
LL_ADC_IsEnabled
LL_ADC_REG_IsConversionOngoing
ADSTART
LL_ADC_REG_StartConversion
LL_ADC_REG_IsStopConversionOngoing
ADSTP
LL_ADC_REG_StopConversion
LL_ADC_DMA_GetRegAddr
LL_ADC_REG_ReadConversionData10
LL_ADC_REG_ReadConversionData12
DR
DATA
LL_ADC_REG_ReadConversionData32
LL_ADC_REG_ReadConversionData6
LL_ADC_REG_ReadConversionData8
LL_ADC_DisableIT_ADRDY
ADRDYIE
LL_ADC_EnableIT_ADRDY
LL_ADC_IsEnabledIT_ADRDY
IER
LL_ADC_DisableIT_AWD1
AWDIE
1252/1320
LL_ADC_EnableIT_AWD1
DocID026525 Rev 6
UM1785
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_ADC_IsEnabledIT_AWD1
LL_ADC_DisableIT_EOC
EOCIE
LL_ADC_EnableIT_EOC
LL_ADC_IsEnabledIT_EOC
LL_ADC_DisableIT_EOS
EOSEQIE
LL_ADC_EnableIT_EOS
LL_ADC_IsEnabledIT_EOS
LL_ADC_DisableIT_EOSMP
EOSMPIE
LL_ADC_EnableIT_EOSMP
LL_ADC_IsEnabledIT_EOSMP
LL_ADC_DisableIT_OVR
OVRIE
LL_ADC_EnableIT_OVR
LL_ADC_IsEnabledIT_OVR
LL_ADC_ClearFlag_ADRDY
ADRDY
LL_ADC_IsActiveFlag_ADRDY
LL_ADC_ClearFlag_AWD1
AWD
LL_ADC_IsActiveFlag_AWD1
LL_ADC_ClearFlag_EOC
EOC
LL_ADC_IsActiveFlag_EOC
ISR
LL_ADC_ClearFlag_EOS
EOSEQ
LL_ADC_IsActiveFlag_EOS
LL_ADC_ClearFlag_EOSMP
EOSMP
LL_ADC_IsActiveFlag_EOSMP
LL_ADC_ClearFlag_OVR
OVR
LL_ADC_IsActiveFlag_OVR
LL_ADC_GetSamplingTimeCommonChannels
SMPR
SMP
LL_ADC_SetSamplingTimeCommonChannels
LL_ADC_ConfigAnalogWDThresholds
HT
LL_ADC_SetAnalogWDThresholds
TR
LL_ADC_ConfigAnalogWDThresholds
LT
HT1
LL_ADC_GetAnalogWDThresholds
LT1
LL_ADC_GetAnalogWDThresholds
HT2
LL_ADC_GetAnalogWDThresholds
LT2
LL_ADC_GetAnalogWDThresholds
HT3
LL_ADC_GetAnalogWDThresholds
TR1
TR2
TR3
LL_ADC_SetAnalogWDThresholds
DocID026525 Rev 6
1253/1320
Correspondence between API registers and API
low-layer driver functions
Register
71.2
UM1785
Field
Function
LT3
LL_ADC_GetAnalogWDThresholds
BUS
Table 26: Correspondence between BUS registers and BUS low-layer driver functions
Register
Field
Function
LL_AHB1_GRP1_DisableClock
LL_AHB1_GRP1_EnableClock
CRCEN
LL_AHB1_GRP1_IsEnabledClock
LL_AHB1_GRP1_DisableClock
LL_AHB1_GRP1_EnableClock
DMA1EN
LL_AHB1_GRP1_IsEnabledClock
LL_AHB1_GRP1_DisableClock
LL_AHB1_GRP1_EnableClock
DMA2EN
LL_AHB1_GRP1_IsEnabledClock
LL_AHB1_GRP1_DisableClock
LL_AHB1_GRP1_EnableClock
FLITFEN
LL_AHB1_GRP1_IsEnabledClock
LL_AHB1_GRP1_DisableClock
GPIOAEN
LL_AHB1_GRP1_EnableClock
LL_AHB1_GRP1_IsEnabledClock
LL_AHB1_GRP1_DisableClock
AHBENR
GPIOBEN
LL_AHB1_GRP1_EnableClock
LL_AHB1_GRP1_IsEnabledClock
LL_AHB1_GRP1_DisableClock
GPIOCEN
LL_AHB1_GRP1_EnableClock
LL_AHB1_GRP1_IsEnabledClock
LL_AHB1_GRP1_DisableClock
GPIODEN
LL_AHB1_GRP1_EnableClock
LL_AHB1_GRP1_IsEnabledClock
LL_AHB1_GRP1_DisableClock
GPIOEEN
LL_AHB1_GRP1_EnableClock
LL_AHB1_GRP1_IsEnabledClock
LL_AHB1_GRP1_DisableClock
GPIOFEN
LL_AHB1_GRP1_EnableClock
LL_AHB1_GRP1_IsEnabledClock
SRAMEN
1254/1320
LL_AHB1_GRP1_DisableClock
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_AHB1_GRP1_EnableClock
LL_AHB1_GRP1_IsEnabledClock
LL_AHB1_GRP1_DisableClock
LL_AHB1_GRP1_EnableClock
TSCEN
LL_AHB1_GRP1_IsEnabledClock
LL_AHB1_GRP1_ForceReset
GPIOARST
LL_AHB1_GRP1_ReleaseReset
LL_AHB1_GRP1_ForceReset
GPIOBRST
LL_AHB1_GRP1_ReleaseReset
LL_AHB1_GRP1_ForceReset
GPIOCRST
LL_AHB1_GRP1_ReleaseReset
LL_AHB1_GRP1_ForceReset
AHBRSTR
GPIODRST
LL_AHB1_GRP1_ReleaseReset
LL_AHB1_GRP1_ForceReset
GPIOERST
LL_AHB1_GRP1_ReleaseReset
LL_AHB1_GRP1_ForceReset
GPIOFRST
LL_AHB1_GRP1_ReleaseReset
LL_AHB1_GRP1_ForceReset
TSCRST
LL_AHB1_GRP1_ReleaseReset
LL_APB1_GRP1_DisableClock
CANEN
LL_APB1_GRP1_EnableClock
LL_APB1_GRP1_IsEnabledClock
LL_APB1_GRP1_DisableClock
CECEN
LL_APB1_GRP1_EnableClock
LL_APB1_GRP1_IsEnabledClock
LL_APB1_GRP1_DisableClock
CRSEN
LL_APB1_GRP1_EnableClock
LL_APB1_GRP1_IsEnabledClock
APB1ENR
LL_APB1_GRP1_DisableClock
DACEN
LL_APB1_GRP1_EnableClock
LL_APB1_GRP1_IsEnabledClock
LL_APB1_GRP1_DisableClock
I2C1EN
LL_APB1_GRP1_EnableClock
LL_APB1_GRP1_IsEnabledClock
LL_APB1_GRP1_DisableClock
I2C2EN
LL_APB1_GRP1_EnableClock
DocID026525 Rev 6
1255/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
UM1785
Function
LL_APB1_GRP1_IsEnabledClock
LL_APB1_GRP1_DisableClock
LL_APB1_GRP1_EnableClock
PWREN
LL_APB1_GRP1_IsEnabledClock
LL_APB1_GRP1_DisableClock
LL_APB1_GRP1_EnableClock
SPI2EN
LL_APB1_GRP1_IsEnabledClock
LL_APB1_GRP1_DisableClock
LL_APB1_GRP1_EnableClock
TIM14EN
LL_APB1_GRP1_IsEnabledClock
LL_APB1_GRP1_DisableClock
LL_APB1_GRP1_EnableClock
TIM2EN
LL_APB1_GRP1_IsEnabledClock
LL_APB1_GRP1_DisableClock
LL_APB1_GRP1_EnableClock
TIM3EN
LL_APB1_GRP1_IsEnabledClock
LL_APB1_GRP1_DisableClock
LL_APB1_GRP1_EnableClock
TIM6EN
LL_APB1_GRP1_IsEnabledClock
LL_APB1_GRP1_DisableClock
LL_APB1_GRP1_EnableClock
TIM7EN
LL_APB1_GRP1_IsEnabledClock
LL_APB1_GRP1_DisableClock
USART2EN
LL_APB1_GRP1_EnableClock
LL_APB1_GRP1_IsEnabledClock
LL_APB1_GRP1_DisableClock
USART3EN
LL_APB1_GRP1_EnableClock
LL_APB1_GRP1_IsEnabledClock
LL_APB1_GRP1_DisableClock
USART4EN
LL_APB1_GRP1_EnableClock
LL_APB1_GRP1_IsEnabledClock
LL_APB1_GRP1_DisableClock
USART5EN
LL_APB1_GRP1_EnableClock
LL_APB1_GRP1_IsEnabledClock
LL_APB1_GRP1_DisableClock
USBEN
1256/1320
LL_APB1_GRP1_EnableClock
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_APB1_GRP1_IsEnabledClock
LL_APB1_GRP1_DisableClock
WWDGEN
LL_APB1_GRP1_EnableClock
LL_APB1_GRP1_IsEnabledClock
LL_APB1_GRP1_ForceReset
CANRST
LL_APB1_GRP1_ReleaseReset
LL_APB1_GRP1_ForceReset
CECRST
LL_APB1_GRP1_ReleaseReset
LL_APB1_GRP1_ForceReset
CRSRST
LL_APB1_GRP1_ReleaseReset
LL_APB1_GRP1_ForceReset
DACRST
LL_APB1_GRP1_ReleaseReset
LL_APB1_GRP1_ForceReset
I2C1RST
LL_APB1_GRP1_ReleaseReset
LL_APB1_GRP1_ForceReset
I2C2RST
LL_APB1_GRP1_ReleaseReset
LL_APB1_GRP1_ForceReset
PWRRST
LL_APB1_GRP1_ReleaseReset
LL_APB1_GRP1_ForceReset
SPI2RST
LL_APB1_GRP1_ReleaseReset
APB1RSTR
LL_APB1_GRP1_ForceReset
TIM14RST
LL_APB1_GRP1_ReleaseReset
LL_APB1_GRP1_ForceReset
TIM2RST
LL_APB1_GRP1_ReleaseReset
LL_APB1_GRP1_ForceReset
TIM3RST
LL_APB1_GRP1_ReleaseReset
LL_APB1_GRP1_ForceReset
TIM6RST
LL_APB1_GRP1_ReleaseReset
LL_APB1_GRP1_ForceReset
TIM7RST
LL_APB1_GRP1_ReleaseReset
LL_APB1_GRP1_ForceReset
USART2RST
LL_APB1_GRP1_ReleaseReset
LL_APB1_GRP1_ForceReset
USART3RST
LL_APB1_GRP1_ReleaseReset
LL_APB1_GRP1_ForceReset
USART4RST
LL_APB1_GRP1_ReleaseReset
DocID026525 Rev 6
1257/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
UM1785
Function
LL_APB1_GRP1_ForceReset
USART5RST
LL_APB1_GRP1_ReleaseReset
LL_APB1_GRP1_ForceReset
USBRST
LL_APB1_GRP1_ReleaseReset
LL_APB1_GRP1_ForceReset
WWDGRST
LL_APB1_GRP1_ReleaseReset
LL_APB1_GRP2_DisableClock
LL_APB1_GRP2_EnableClock
ADC1EN
LL_APB1_GRP2_IsEnabledClock
LL_APB1_GRP2_DisableClock
DBGMCUEN
LL_APB1_GRP2_EnableClock
LL_APB1_GRP2_IsEnabledClock
LL_APB1_GRP2_DisableClock
LL_APB1_GRP2_EnableClock
SPI1EN
LL_APB1_GRP2_IsEnabledClock
LL_APB1_GRP2_DisableClock
SYSCFGEN
LL_APB1_GRP2_EnableClock
LL_APB1_GRP2_IsEnabledClock
LL_APB1_GRP2_DisableClock
LL_APB1_GRP2_EnableClock
TIM15EN
LL_APB1_GRP2_IsEnabledClock
APB2ENR
LL_APB1_GRP2_DisableClock
LL_APB1_GRP2_EnableClock
TIM16EN
LL_APB1_GRP2_IsEnabledClock
LL_APB1_GRP2_DisableClock
LL_APB1_GRP2_EnableClock
TIM17EN
LL_APB1_GRP2_IsEnabledClock
LL_APB1_GRP2_DisableClock
LL_APB1_GRP2_EnableClock
TIM1EN
LL_APB1_GRP2_IsEnabledClock
LL_APB1_GRP2_DisableClock
USART1EN
LL_APB1_GRP2_EnableClock
LL_APB1_GRP2_IsEnabledClock
LL_APB1_GRP2_DisableClock
USART6EN
LL_APB1_GRP2_EnableClock
LL_APB1_GRP2_IsEnabledClock
1258/1320
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_APB1_GRP2_DisableClock
USART7EN
LL_APB1_GRP2_EnableClock
LL_APB1_GRP2_IsEnabledClock
LL_APB1_GRP2_DisableClock
USART8EN
LL_APB1_GRP2_EnableClock
LL_APB1_GRP2_IsEnabledClock
LL_APB1_GRP2_ForceReset
ADC1RST
LL_APB1_GRP2_ReleaseReset
LL_APB1_GRP2_ForceReset
DBGMCURST
LL_APB1_GRP2_ReleaseReset
LL_APB1_GRP2_ForceReset
SPI1RST
LL_APB1_GRP2_ReleaseReset
LL_APB1_GRP2_ForceReset
SYSCFGRST
LL_APB1_GRP2_ReleaseReset
LL_APB1_GRP2_ForceReset
TIM15RST
LL_APB1_GRP2_ReleaseReset
LL_APB1_GRP2_ForceReset
TIM16RST
LL_APB1_GRP2_ReleaseReset
APB2RSTR
LL_APB1_GRP2_ForceReset
TIM17RST
LL_APB1_GRP2_ReleaseReset
LL_APB1_GRP2_ForceReset
TIM1RST
LL_APB1_GRP2_ReleaseReset
LL_APB1_GRP2_ForceReset
USART1RST
LL_APB1_GRP2_ReleaseReset
LL_APB1_GRP2_ForceReset
USART6RST
LL_APB1_GRP2_ReleaseReset
LL_APB1_GRP2_ForceReset
USART7RST
LL_APB1_GRP2_ReleaseReset
LL_APB1_GRP2_ForceReset
USART8RST
71.3
LL_APB1_GRP2_ReleaseReset
COMP
Table 27: Correspondence between COMP registers and COMP low-layer driver functions
Register
Field
CSR
COMP1EN
Function
LL_COMP_Disable
LL_COMP_Enable
DocID026525 Rev 6
1259/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
UM1785
Function
LL_COMP_IsEnabled
LL_COMP_GetInputHysteresis
COMP1HYST
LL_COMP_SetInputHysteresis
LL_COMP_ConfigInputs
LL_COMP_GetInputPlus
COMP1INSEL
LL_COMP_SetInputPlus
LL_COMP_IsLocked
COMP1LOCK
LL_COMP_Lock
LL_COMP_GetPowerMode
COMP1MODE
LL_COMP_SetPowerMode
LL_COMP_ReadOutputLevel
COMP1OUT
LL_COMP_GetOutputSelection
COMP1OUTSEL
LL_COMP_SetOutputSelection
LL_COMP_GetOutputPolarity
COMP1POL
LL_COMP_SetOutputPolarity
LL_COMP_ConfigInputs
LL_COMP_GetInputMinus
COMP1SW1
LL_COMP_SetInputMinus
LL_COMP_Disable
LL_COMP_Enable
COMP2EN
LL_COMP_IsEnabled
LL_COMP_ConfigInputs
LL_COMP_GetInputPlus
COMP2INSEL
LL_COMP_SetInputPlus
LL_COMP_IsLocked
COMP2LOCK
LL_COMP_Lock
LL_COMP_ReadOutputLevel
COMP2OUT
LL_COMP_GetCommonWindowMode
WNDWEN
LL_COMP_SetCommonWindowMode
71.4
CORTEX
Table 28: Correspondence between CORTEX registers and CORTEX low-layer driver functions
Register
SCB_CPUID
1260/1320
Field
Function
ARCHITECTURE
LL_CPUID_GetArchitecture
IMPLEMENTER
LL_CPUID_GetImplementer
PARTNO
LL_CPUID_GetParNo
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
REVISION
LL_CPUID_GetRevision
VARIANT
LL_CPUID_GetVariant
LL_LPM_DisableEventOnPend
SEVEONPEND
LL_LPM_EnableEventOnPend
LL_LPM_EnableDeepSleep
SCB_SCR
SLEEPDEEP
LL_LPM_EnableSleep
LL_LPM_DisableSleepOnExit
SLEEPONEXIT
LL_LPM_EnableSleepOnExit
LL_SYSTICK_GetClkSource
CLKSOURCE
LL_SYSTICK_SetClkSource
LL_SYSTICK_IsActiveCounterFlag
COUNTFLAG
STK_CTRL
LL_SYSTICK_DisableIT
LL_SYSTICK_EnableIT
TICKINT
LL_SYSTICK_IsEnabledIT
71.5
CRC
Table 29: Correspondence between CRC registers and CRC low-layer driver functions
Register
Field
Function
LL_CRC_GetPolynomialSize
POLYSIZE
RESET
LL_CRC_SetPolynomialSize
LL_CRC_ResetCRCCalculationUnit
LL_CRC_GetInputDataReverseMode
CR
REV_IN
LL_CRC_SetInputDataReverseMode
LL_CRC_GetOutputDataReverseMode
REV_OUT
LL_CRC_SetOutputDataReverseMode
LL_CRC_FeedData16
LL_CRC_FeedData32
LL_CRC_FeedData8
DR
DR
LL_CRC_ReadData16
LL_CRC_ReadData32
LL_CRC_ReadData7
LL_CRC_ReadData8
LL_CRC_Read_IDR
IDR
IDR
INIT
INIT
LL_CRC_Write_IDR
LL_CRC_GetInitialData
LL_CRC_SetInitialData
DocID026525 Rev 6
1261/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
POL
POL
UM1785
Function
LL_CRC_GetPolynomialCoef
LL_CRC_SetPolynomialCoef
71.6
CRS
Table 30: Correspondence between CRS registers and CRS low-layer driver functions
Register
Field
Function
LL_CRS_ConfigSynchronization
LL_CRS_GetFreqErrorLimit
FELIM
LL_CRS_SetFreqErrorLimit
LL_CRS_ConfigSynchronization
LL_CRS_GetReloadCounter
RELOAD
LL_CRS_SetReloadCounter
LL_CRS_ConfigSynchronization
CFGR
LL_CRS_GetSyncDivider
SYNCDIV
LL_CRS_SetSyncDivider
LL_CRS_ConfigSynchronization
LL_CRS_GetSyncPolarity
SYNCPOL
LL_CRS_SetSyncPolarity
LL_CRS_ConfigSynchronization
LL_CRS_GetSyncSignalSource
SYNCSRC
LL_CRS_SetSyncSignalSource
LL_CRS_DisableAutoTrimming
AUTOTRIMEN
LL_CRS_EnableAutoTrimming
LL_CRS_IsEnabledAutoTrimming
LL_CRS_DisableFreqErrorCounter
CEN
LL_CRS_EnableFreqErrorCounter
LL_CRS_IsEnabledFreqErrorCounter
LL_CRS_DisableIT_ERR
CR
ERRIE
LL_CRS_EnableIT_ERR
LL_CRS_IsEnabledIT_ERR
LL_CRS_DisableIT_ESYNC
ESYNCIE
LL_CRS_EnableIT_ESYNC
LL_CRS_IsEnabledIT_ESYNC
SWSYNC
LL_CRS_GenerateEvent_SWSYNC
LL_CRS_DisableIT_SYNCOK
SYNCOKIE
1262/1320
LL_CRS_EnableIT_SYNCOK
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_CRS_IsEnabledIT_SYNCOK
LL_CRS_DisableIT_SYNCWARN
SYNCWARNIE
LL_CRS_EnableIT_SYNCWARN
LL_CRS_IsEnabledIT_SYNCWARN
LL_CRS_ConfigSynchronization
LL_CRS_GetHSI48SmoothTrimming
TRIM
LL_CRS_SetHSI48SmoothTrimming
ERRC
LL_CRS_ClearFlag_ERR
ESYNCC
LL_CRS_ClearFlag_ESYNC
SYNCOKC
LL_CRS_ClearFlag_SYNCOK
SYNCWARNC
LL_CRS_ClearFlag_SYNCWARN
ERRF
LL_CRS_IsActiveFlag_ERR
ESYNCF
LL_CRS_IsActiveFlag_ESYNC
FECAP
LL_CRS_GetFreqErrorCapture
FEDIR
LL_CRS_GetFreqErrorDirection
SYNCERR
LL_CRS_IsActiveFlag_SYNCERR
SYNCMISS
LL_CRS_IsActiveFlag_SYNCMISS
SYNCOKF
LL_CRS_IsActiveFlag_SYNCOK
SYNCWARNF
LL_CRS_IsActiveFlag_SYNCWARN
TRIMOVF
LL_CRS_IsActiveFlag_TRIMOVF
ICR
ISR
71.7
DAC
Table 31: Correspondence between DAC registers and DAC low-layer driver functions
Register
Field
Function
LL_DAC_GetOutputBuffer
BOFF1
LL_DAC_SetOutputBuffer
LL_DAC_GetOutputBuffer
BOFF2
LL_DAC_SetOutputBuffer
LL_DAC_DisableDMAReq
DMAEN1
CR
LL_DAC_EnableDMAReq
LL_DAC_IsDMAReqEnabled
LL_DAC_DisableDMAReq
DMAEN2
LL_DAC_EnableDMAReq
LL_DAC_IsDMAReqEnabled
LL_DAC_DisableIT_DMAUDR1
DMAUDRIE1
LL_DAC_EnableIT_DMAUDR1
DocID026525 Rev 6
1263/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
UM1785
Function
LL_DAC_IsEnabledIT_DMAUDR1
LL_DAC_DisableIT_DMAUDR2
DMAUDRIE2
LL_DAC_EnableIT_DMAUDR2
LL_DAC_IsEnabledIT_DMAUDR2
LL_DAC_Disable
EN1
LL_DAC_Enable
LL_DAC_IsEnabled
LL_DAC_Disable
EN2
LL_DAC_Enable
LL_DAC_IsEnabled
LL_DAC_GetWaveNoiseLFSR
LL_DAC_GetWaveTriangleAmplitude
MAMP1
LL_DAC_SetWaveNoiseLFSR
LL_DAC_SetWaveTriangleAmplitude
LL_DAC_GetWaveNoiseLFSR
LL_DAC_GetWaveTriangleAmplitude
MAMP2
LL_DAC_SetWaveNoiseLFSR
LL_DAC_SetWaveTriangleAmplitude
LL_DAC_DisableTrigger
TEN1
LL_DAC_EnableTrigger
LL_DAC_IsTriggerEnabled
LL_DAC_DisableTrigger
TEN2
LL_DAC_EnableTrigger
LL_DAC_IsTriggerEnabled
LL_DAC_GetTriggerSource
TSEL1
LL_DAC_SetTriggerSource
LL_DAC_GetTriggerSource
TSEL2
LL_DAC_SetTriggerSource
LL_DAC_GetWaveAutoGeneration
WAVE1
LL_DAC_SetWaveAutoGeneration
LL_DAC_GetWaveAutoGeneration
WAVE2
LL_DAC_SetWaveAutoGeneration
LL_DAC_ConvertData12LeftAligned
DHR12L1
DACC1DHR
LL_DAC_DMA_GetRegAddr
LL_DAC_ConvertData12LeftAligned
DHR12L2
1264/1320
DACC2DHR
LL_DAC_DMA_GetRegAddr
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
DACC1DHR
LL_DAC_ConvertDualData12LeftAligned
DACC2DHR
LL_DAC_ConvertDualData12LeftAligned
DHR12LD
LL_DAC_ConvertData12RightAligned
DHR12R1
DACC1DHR
DHR12R2
DACC2DHR
LL_DAC_DMA_GetRegAddr
LL_DAC_ConvertData12RightAligned
LL_DAC_DMA_GetRegAddr
DACC1DHR
LL_DAC_ConvertDualData12RightAligned
DACC2DHR
LL_DAC_ConvertDualData12RightAligned
DHR12RD
LL_DAC_ConvertData8RightAligned
DHR8R1
DACC1DHR
DHR8R2
DACC2DHR
LL_DAC_DMA_GetRegAddr
LL_DAC_ConvertData8RightAligned
LL_DAC_DMA_GetRegAddr
DACC1DHR
LL_DAC_ConvertDualData8RightAligned
DACC2DHR
LL_DAC_ConvertDualData8RightAligned
DOR1
DACC1DOR
LL_DAC_RetrieveOutputData
DOR2
DACC2DOR
LL_DAC_RetrieveOutputData
DHR8RD
LL_DAC_ClearFlag_DMAUDR1
DMAUDR1
LL_DAC_IsActiveFlag_DMAUDR1
SR
LL_DAC_ClearFlag_DMAUDR2
DMAUDR2
SWTRIG1
LL_DAC_TrigSWConversion
SWTRIG2
LL_DAC_TrigSWConversion
SWTRIGR
71.8
LL_DAC_IsActiveFlag_DMAUDR2
DMA
Table 32: Correspondence between DMA registers and DMA low-layer driver functions
Register
Field
Function
LL_DMA_ConfigTransfer
CIRC
LL_DMA_GetMode
LL_DMA_SetMode
LL_DMA_ConfigTransfer
DIR
CCR
LL_DMA_GetDataTransferDirection
LL_DMA_SetDataTransferDirection
LL_DMA_DisableChannel
EN
LL_DMA_EnableChannel
LL_DMA_IsEnabledChannel
HTIE
LL_DMA_DisableIT_HT
DocID026525 Rev 6
1265/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
UM1785
Function
LL_DMA_EnableIT_HT
LL_DMA_IsEnabledIT_HT
LL_DMA_ConfigTransfer
MEM2MEM
LL_DMA_GetDataTransferDirection
LL_DMA_SetDataTransferDirection
LL_DMA_ConfigTransfer
MINC
LL_DMA_GetMemoryIncMode
LL_DMA_SetMemoryIncMode
LL_DMA_ConfigTransfer
MSIZE
LL_DMA_GetMemorySize
LL_DMA_SetMemorySize
LL_DMA_ConfigTransfer
PINC
LL_DMA_GetPeriphIncMode
LL_DMA_SetPeriphIncMode
LL_DMA_ConfigTransfer
PL
LL_DMA_GetChannelPriorityLevel
LL_DMA_SetChannelPriorityLevel
LL_DMA_ConfigTransfer
PSIZE
LL_DMA_GetPeriphSize
LL_DMA_SetPeriphSize
LL_DMA_DisableIT_TC
TCIE
LL_DMA_EnableIT_TC
LL_DMA_IsEnabledIT_TC
LL_DMA_DisableIT_TE
TEIE
LL_DMA_EnableIT_TE
LL_DMA_IsEnabledIT_TE
LL_DMA_ConfigAddresses
LL_DMA_GetM2MDstAddress
CMAR
MA
LL_DMA_GetMemoryAddress
LL_DMA_SetM2MDstAddress
LL_DMA_SetMemoryAddress
LL_DMA_GetDataLength
CNDTR
NDT
LL_DMA_SetDataLength
LL_DMA_ConfigAddresses
CPAR
PA
LL_DMA_GetM2MSrcAddress
LL_DMA_GetPeriphAddress
1266/1320
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_DMA_SetM2MSrcAddress
LL_DMA_SetPeriphAddress
LL_DMA_GetPeriphRequest
C1S
LL_DMA_SetPeriphRequest
LL_DMA_GetPeriphRequest
C2S
LL_DMA_SetPeriphRequest
LL_DMA_GetPeriphRequest
C3S
LL_DMA_SetPeriphRequest
LL_DMA_GetPeriphRequest
CSELR
C4S
LL_DMA_SetPeriphRequest
LL_DMA_GetPeriphRequest
C5S
LL_DMA_SetPeriphRequest
LL_DMA_GetPeriphRequest
C6S
LL_DMA_SetPeriphRequest
LL_DMA_GetPeriphRequest
C7S
LL_DMA_SetPeriphRequest
CGIF1
LL_DMA_ClearFlag_GI1
CGIF2
LL_DMA_ClearFlag_GI2
CGIF3
LL_DMA_ClearFlag_GI3
CGIF4
LL_DMA_ClearFlag_GI4
CGIF5
LL_DMA_ClearFlag_GI5
CGIF6
LL_DMA_ClearFlag_GI6
CGIF7
LL_DMA_ClearFlag_GI7
CHTIF1
LL_DMA_ClearFlag_HT1
CHTIF2
LL_DMA_ClearFlag_HT2
CHTIF3
LL_DMA_ClearFlag_HT3
CHTIF4
LL_DMA_ClearFlag_HT4
CHTIF5
LL_DMA_ClearFlag_HT5
CHTIF6
LL_DMA_ClearFlag_HT6
CHTIF7
LL_DMA_ClearFlag_HT7
CTCIF1
LL_DMA_ClearFlag_TC1
CTCIF2
LL_DMA_ClearFlag_TC2
CTCIF3
LL_DMA_ClearFlag_TC3
CTCIF4
LL_DMA_ClearFlag_TC4
CTCIF5
LL_DMA_ClearFlag_TC5
CTCIF6
LL_DMA_ClearFlag_TC6
IFCR
DocID026525 Rev 6
1267/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
CTCIF7
LL_DMA_ClearFlag_TC7
CTEIF1
LL_DMA_ClearFlag_TE1
CTEIF2
LL_DMA_ClearFlag_TE2
CTEIF3
LL_DMA_ClearFlag_TE3
CTEIF4
LL_DMA_ClearFlag_TE4
CTEIF5
LL_DMA_ClearFlag_TE5
CTEIF6
LL_DMA_ClearFlag_TE6
CTEIF7
LL_DMA_ClearFlag_TE7
GIF1
LL_DMA_IsActiveFlag_GI1
GIF2
LL_DMA_IsActiveFlag_GI2
GIF3
LL_DMA_IsActiveFlag_GI3
GIF4
LL_DMA_IsActiveFlag_GI4
GIF5
LL_DMA_IsActiveFlag_GI5
GIF6
LL_DMA_IsActiveFlag_GI6
GIF7
LL_DMA_IsActiveFlag_GI7
HTIF1
LL_DMA_IsActiveFlag_HT1
HTIF2
LL_DMA_IsActiveFlag_HT2
HTIF3
LL_DMA_IsActiveFlag_HT3
HTIF4
LL_DMA_IsActiveFlag_HT4
HTIF5
LL_DMA_IsActiveFlag_HT5
HTIF6
LL_DMA_IsActiveFlag_HT6
HTIF7
LL_DMA_IsActiveFlag_HT7
TCIF1
LL_DMA_IsActiveFlag_TC1
TCIF2
LL_DMA_IsActiveFlag_TC2
TCIF3
LL_DMA_IsActiveFlag_TC3
TCIF4
LL_DMA_IsActiveFlag_TC4
TCIF5
LL_DMA_IsActiveFlag_TC5
TCIF6
LL_DMA_IsActiveFlag_TC6
TCIF7
LL_DMA_IsActiveFlag_TC7
TEIF1
LL_DMA_IsActiveFlag_TE1
TEIF2
LL_DMA_IsActiveFlag_TE2
TEIF3
LL_DMA_IsActiveFlag_TE3
TEIF4
LL_DMA_IsActiveFlag_TE4
TEIF5
LL_DMA_IsActiveFlag_TE5
TEIF6
LL_DMA_IsActiveFlag_TE6
TEIF7
LL_DMA_IsActiveFlag_TE7
ISR
1268/1320
UM1785
DocID026525 Rev 6
UM1785
71.9
Correspondence between API registers and API
low-layer driver functions
EXTI
Table 33: Correspondence between EXTI registers and EXTI low-layer driver functions
Register
Field
Function
LL_EXTI_DisableEvent_0_31
EMR
LL_EXTI_EnableEvent_0_31
EMx
LL_EXTI_IsEnabledEvent_0_31
LL_EXTI_DisableFallingTrig_0_31
FTSR
LL_EXTI_EnableFallingTrig_0_31
FTx
LL_EXTI_IsEnabledFallingTrig_0_31
LL_EXTI_DisableIT_0_31
IMR
LL_EXTI_EnableIT_0_31
IMx
LL_EXTI_IsEnabledIT_0_31
LL_EXTI_ClearFlag_0_31
PR
LL_EXTI_IsActiveFlag_0_31
PIFx
LL_EXTI_ReadFlag_0_31
LL_EXTI_DisableRisingTrig_0_31
RTSR
LL_EXTI_EnableRisingTrig_0_31
RTx
LL_EXTI_IsEnabledRisingTrig_0_31
SWIER
71.10
LL_EXTI_GenerateSWI_0_31
SWIx
GPIO
Table 34: Correspondence between GPIO registers and GPIO low-layer driver functions
Register
Field
Function
AFRH
AFSELy
AFRL
AFSELy
LL_GPIO_GetAFPin_8_15
LL_GPIO_SetAFPin_8_15
LL_GPIO_GetAFPin_0_7
LL_GPIO_SetAFPin_0_7
BRR
BRy
LL_GPIO_ResetOutputPin
BSRR
BSy
LL_GPIO_SetOutputPin
IDR
IDy
LL_GPIO_IsInputPinSet
LL_GPIO_ReadInputPort
LL_GPIO_IsAnyPinLocked
LCKK
LCKR
MODER
LL_GPIO_LockPin
LCKy
LL_GPIO_IsPinLocked
MODEy
LL_GPIO_GetPinMode
DocID026525 Rev 6
1269/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
UM1785
Function
LL_GPIO_SetPinMode
LL_GPIO_IsOutputPinSet
LL_GPIO_ReadOutputPort
ODR
ODy
LL_GPIO_TogglePin
LL_GPIO_WriteOutputPort
LL_GPIO_GetPinSpeed
OSPEEDR
OSPEEDy
LL_GPIO_SetPinSpeed
LL_GPIO_GetPinOutputType
OTYPER
OTy
PUPDR
PUPDy
LL_GPIO_SetPinOutputType
LL_GPIO_GetPinPull
71.11
LL_GPIO_SetPinPull
I2C
Table 35: Correspondence between I2C registers and I2C low-layer driver functions
Register
Field
Function
LL_I2C_DisableIT_ADDR
ADDRIE
LL_I2C_EnableIT_ADDR
LL_I2C_IsEnabledIT_ADDR
LL_I2C_DisableSMBusAlert
ALERTEN
LL_I2C_EnableSMBusAlert
LL_I2C_IsEnabledSMBusAlert
LL_I2C_ConfigFilters
LL_I2C_DisableAnalogFilter
ANFOFF
LL_I2C_EnableAnalogFilter
LL_I2C_IsEnabledAnalogFilter
LL_I2C_ConfigFilters
CR1
DNF
LL_I2C_GetDigitalFilter
LL_I2C_SetDigitalFilter
LL_I2C_DisableIT_ERR
ERRIE
LL_I2C_EnableIT_ERR
LL_I2C_IsEnabledIT_ERR
LL_I2C_DisableGeneralCall
GCEN
LL_I2C_EnableGeneralCall
LL_I2C_IsEnabledGeneralCall
LL_I2C_DisableIT_NACK
NACKIE
1270/1320
LL_I2C_EnableIT_NACK
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_I2C_IsEnabledIT_NACK
LL_I2C_DisableClockStretching
NOSTRETCH
LL_I2C_EnableClockStretching
LL_I2C_IsEnabledClockStretching
LL_I2C_Disable
PE
LL_I2C_Enable
LL_I2C_IsEnabled
LL_I2C_DisableSMBusPEC
PECEN
LL_I2C_EnableSMBusPEC
LL_I2C_IsEnabledSMBusPEC
LL_I2C_DisableDMAReq_RX
RXDMAEN
LL_I2C_EnableDMAReq_RX
LL_I2C_IsEnabledDMAReq_RX
LL_I2C_DisableIT_RX
RXIE
LL_I2C_EnableIT_RX
LL_I2C_IsEnabledIT_RX
LL_I2C_DisableSlaveByteControl
SBC
LL_I2C_EnableSlaveByteControl
LL_I2C_IsEnabledSlaveByteControl
LL_I2C_GetMode
SMBDEN
LL_I2C_SetMode
LL_I2C_GetMode
SMBHEN
LL_I2C_SetMode
LL_I2C_DisableIT_STOP
STOPIE
LL_I2C_EnableIT_STOP
LL_I2C_IsEnabledIT_STOP
LL_I2C_DisableIT_TC
TCIE
LL_I2C_EnableIT_TC
LL_I2C_IsEnabledIT_TC
LL_I2C_DisableDMAReq_TX
TXDMAEN
LL_I2C_EnableDMAReq_TX
LL_I2C_IsEnabledDMAReq_TX
LL_I2C_DisableIT_TX
TXIE
LL_I2C_EnableIT_TX
LL_I2C_IsEnabledIT_TX
WUPEN
LL_I2C_DisableWakeUpFromStop
DocID026525 Rev 6
1271/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
UM1785
Function
LL_I2C_EnableWakeUpFromStop
LL_I2C_IsEnabledWakeUpFromStop
LL_I2C_GetMasterAddressingMode
ADD10
LL_I2C_HandleTransfer
LL_I2C_SetMasterAddressingMode
LL_I2C_DisableAutoEndMode
LL_I2C_EnableAutoEndMode
AUTOEND
LL_I2C_HandleTransfer
LL_I2C_IsEnabledAutoEndMode
LL_I2C_DisableAuto10BitRead
LL_I2C_EnableAuto10BitRead
HEAD10R
LL_I2C_HandleTransfer
LL_I2C_IsEnabledAuto10BitRead
NACK
LL_I2C_AcknowledgeNextData
LL_I2C_GetTransferSize
NBYTES
LL_I2C_HandleTransfer
LL_I2C_SetTransferSize
LL_I2C_EnableSMBusPECCompare
CR2
PECBYTE
LL_I2C_IsEnabledSMBusPECCompare
LL_I2C_GetTransferRequest
RD_WRN
LL_I2C_HandleTransfer
LL_I2C_SetTransferRequest
LL_I2C_DisableReloadMode
LL_I2C_EnableReloadMode
RELOAD
LL_I2C_HandleTransfer
LL_I2C_IsEnabledReloadMode
LL_I2C_GetSlaveAddr
SADD
LL_I2C_HandleTransfer
LL_I2C_SetSlaveAddr
LL_I2C_GenerateStartCondition
START
LL_I2C_HandleTransfer
LL_I2C_GenerateStopCondition
STOP
ICR
1272/1320
LL_I2C_HandleTransfer
ADDRCF
LL_I2C_ClearFlag_ADDR
ALERTCF
LL_I2C_ClearSMBusFlag_ALERT
ARLOCF
LL_I2C_ClearFlag_ARLO
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
BERRCF
LL_I2C_ClearFlag_BERR
NACKCF
LL_I2C_ClearFlag_NACK
OVRCF
LL_I2C_ClearFlag_OVR
PECCF
LL_I2C_ClearSMBusFlag_PECERR
STOPCF
LL_I2C_ClearFlag_STOP
TIMOUTCF
LL_I2C_ClearSMBusFlag_TIMEOUT
ADDCODE
LL_I2C_GetAddressMatchCode
ADDR
LL_I2C_IsActiveFlag_ADDR
ALERT
LL_I2C_IsActiveSMBusFlag_ALERT
ARLO
LL_I2C_IsActiveFlag_ARLO
BERR
LL_I2C_IsActiveFlag_BERR
BUSY
LL_I2C_IsActiveFlag_BUSY
DIR
LL_I2C_GetTransferDirection
NACKF
LL_I2C_IsActiveFlag_NACK
OVR
LL_I2C_IsActiveFlag_OVR
PECERR
LL_I2C_IsActiveSMBusFlag_PECERR
RXNE
LL_I2C_IsActiveFlag_RXNE
STOPF
LL_I2C_IsActiveFlag_STOP
TC
LL_I2C_IsActiveFlag_TC
TCR
LL_I2C_IsActiveFlag_TCR
TIMEOUT
LL_I2C_IsActiveSMBusFlag_TIMEOUT
ISR
LL_I2C_ClearFlag_TXE
TXE
LL_I2C_IsActiveFlag_TXE
TXIS
LL_I2C_IsActiveFlag_TXIS
OA1
LL_I2C_SetOwnAddress1
LL_I2C_DisableOwnAddress1
OAR1
OA1EN
LL_I2C_EnableOwnAddress1
LL_I2C_IsEnabledOwnAddress1
OA1MODE
LL_I2C_SetOwnAddress1
OA2
LL_I2C_SetOwnAddress2
LL_I2C_DisableOwnAddress2
OAR2
OA2EN
LL_I2C_EnableOwnAddress2
LL_I2C_IsEnabledOwnAddress2
OA2MSK
LL_I2C_SetOwnAddress2
PECR
PEC
LL_I2C_GetSMBusPEC
RXDR
RXDATA
LL_I2C_DMA_GetRegAddr
DocID026525 Rev 6
1273/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
UM1785
Function
LL_I2C_ReceiveData8
LL_I2C_DisableSMBusTimeout
LL_I2C_EnableSMBusTimeout
TEXTEN
LL_I2C_IsEnabledSMBusTimeout
LL_I2C_ConfigSMBusTimeout
LL_I2C_GetSMBusTimeoutAMode
TIDLE
LL_I2C_SetSMBusTimeoutAMode
LL_I2C_ConfigSMBusTimeout
TIMEOUTR
LL_I2C_GetSMBusTimeoutA
TIMEOUTA
LL_I2C_SetSMBusTimeoutA
LL_I2C_ConfigSMBusTimeout
LL_I2C_GetSMBusTimeoutB
TIMEOUTB
LL_I2C_SetSMBusTimeoutB
LL_I2C_DisableSMBusTimeout
LL_I2C_EnableSMBusTimeout
TIMOUTEN
LL_I2C_IsEnabledSMBusTimeout
PRESC
LL_I2C_GetTimingPrescaler
SCLDEL
LL_I2C_GetDataSetupTime
SCLH
LL_I2C_GetClockHighPeriod
SCLL
LL_I2C_GetClockLowPeriod
SDADEL
LL_I2C_GetDataHoldTime
TIMINGR
LL_I2C_SetTiming
TIMINGR
LL_I2C_DMA_GetRegAddr
TXDR
TXDATA
LL_I2C_TransmitData8
71.12
I2S
Table 36: Correspondence between I2S registers and I2S low-layer driver functions
Register
Field
Function
LL_I2S_DisableIT_ERR
LL_I2S_EnableIT_ERR
ERRIE
LL_I2S_IsEnabledIT_ERR
LL_I2S_DisableDMAReq_RX
CR2
RXDMAEN
LL_I2S_EnableDMAReq_RX
LL_I2S_IsEnabledDMAReq_RX
LL_I2S_DisableIT_RXNE
RXNEIE
1274/1320
LL_I2S_EnableIT_RXNE
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_I2S_IsEnabledIT_RXNE
LL_I2S_DisableDMAReq_TX
TXDMAEN
LL_I2S_EnableDMAReq_TX
LL_I2S_IsEnabledDMAReq_TX
LL_I2S_DisableIT_TXE
LL_I2S_EnableIT_TXE
TXEIE
LL_I2S_IsEnabledIT_TXE
LL_I2S_ReceiveData16
DR
DR
LL_I2S_TransmitData16
LL_I2S_GetDataFormat
CHLEN
LL_I2S_SetDataFormat
LL_I2S_GetClockPolarity
CKPOL
LL_I2S_SetClockPolarity
LL_I2S_GetDataFormat
DATLEN
LL_I2S_SetDataFormat
LL_I2S_GetTransferMode
I2SCFG
LL_I2S_SetTransferMode
I2SCFGR
LL_I2S_Disable
LL_I2S_Enable
I2SE
LL_I2S_IsEnabled
LL_I2S_Enable
I2SMOD
LL_I2S_GetStandard
I2SSTD
LL_I2S_SetStandard
LL_I2S_GetStandard
PCMSYNC
LL_I2S_SetStandard
LL_I2S_GetPrescalerLinear
I2SDIV
LL_I2S_SetPrescalerLinear
LL_I2S_DisableMasterClock
I2SPR
MCKOE
LL_I2S_EnableMasterClock
LL_I2S_IsEnabledMasterClock
LL_I2S_GetPrescalerParity
ODD
LL_I2S_SetPrescalerParity
BSY
LL_I2S_IsActiveFlag_BSY
CHSIDE
LL_I2S_IsActiveFlag_CHSIDE
SR
LL_I2S_ClearFlag_FRE
FRE
LL_I2S_IsActiveFlag_FRE
DocID026525 Rev 6
1275/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
UM1785
Function
LL_I2S_ClearFlag_OVR
OVR
LL_I2S_IsActiveFlag_OVR
RXNE
LL_I2S_IsActiveFlag_RXNE
TXE
LL_I2S_IsActiveFlag_TXE
LL_I2S_ClearFlag_UDR
UDR
71.13
LL_I2S_IsActiveFlag_UDR
IWDG
Table 37: Correspondence between IWDG registers and IWDG low-layer driver functions
Register
Field
Function
LL_IWDG_DisableWriteAccess
LL_IWDG_Enable
KR
KEY
LL_IWDG_EnableWriteAccess
LL_IWDG_ReloadCounter
LL_IWDG_GetPrescaler
PR
PR
LL_IWDG_SetPrescaler
LL_IWDG_GetReloadCounter
RLR
RL
LL_IWDG_SetReloadCounter
LL_IWDG_IsActiveFlag_PVU
PVU
LL_IWDG_IsReady
LL_IWDG_IsActiveFlag_RVU
SR
RVU
LL_IWDG_IsReady
LL_IWDG_IsActiveFlag_WVU
WVU
LL_IWDG_IsReady
LL_IWDG_GetWindow
WINR
71.14
WIN
LL_IWDG_SetWindow
PWR
Table 38: Correspondence between PWR registers and PWR low-layer driver functions
Register
Field
Function
CSBF
LL_PWR_ClearFlag_SB
CWUF
LL_PWR_ClearFlag_WU
LL_PWR_DisableBkUpAccess
CR
DBP
LL_PWR_EnableBkUpAccess
LL_PWR_IsEnabledBkUpAccess
1276/1320
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_PWR_GetPowerMode
LL_PWR_GetRegulModeDS
LPDS
LL_PWR_SetPowerMode
LL_PWR_SetRegulModeDS
LL_PWR_GetPowerMode
PDDS
LL_PWR_SetPowerMode
LL_PWR_GetPVDLevel
PLS
LL_PWR_SetPVDLevel
LL_PWR_DisablePVD
PVDE
LL_PWR_EnablePVD
LL_PWR_IsEnabledPVD
LL_PWR_DisableWakeUpPin
EWUP1
LL_PWR_EnableWakeUpPin
LL_PWR_IsEnabledWakeUpPin
LL_PWR_DisableWakeUpPin
EWUP2
LL_PWR_EnableWakeUpPin
LL_PWR_IsEnabledWakeUpPin
LL_PWR_DisableWakeUpPin
EWUP3
LL_PWR_EnableWakeUpPin
LL_PWR_IsEnabledWakeUpPin
LL_PWR_DisableWakeUpPin
EWUP4
LL_PWR_EnableWakeUpPin
LL_PWR_IsEnabledWakeUpPin
LL_PWR_DisableWakeUpPin
CSR
EWUP5
LL_PWR_EnableWakeUpPin
LL_PWR_IsEnabledWakeUpPin
LL_PWR_DisableWakeUpPin
EWUP6
LL_PWR_EnableWakeUpPin
LL_PWR_IsEnabledWakeUpPin
LL_PWR_DisableWakeUpPin
EWUP7
LL_PWR_EnableWakeUpPin
LL_PWR_IsEnabledWakeUpPin
LL_PWR_DisableWakeUpPin
EWUP8
LL_PWR_EnableWakeUpPin
LL_PWR_IsEnabledWakeUpPin
PVDO
LL_PWR_IsActiveFlag_PVDO
DocID026525 Rev 6
1277/1320
Correspondence between API registers and API
low-layer driver functions
Register
71.15
UM1785
Field
Function
SBF
LL_PWR_IsActiveFlag_SB
VREFINTRDYF
LL_PWR_IsActiveFlag_VREFINTRDY
WUF
LL_PWR_IsActiveFlag_WU
RCC
Table 39: Correspondence between RCC registers and RCC low-layer driver functions
Register
Field
Function
LL_RCC_ForceBackupDomainReset
BDRST
LL_RCC_ReleaseBackupDomainReset
LL_RCC_LSE_DisableBypass
LSEBYP
LL_RCC_LSE_EnableBypass
LL_RCC_LSE_GetDriveCapability
LSEDRV
LL_RCC_LSE_SetDriveCapability
LL_RCC_LSE_Disable
BDCR
LSEON
LSERDY
LL_RCC_LSE_Enable
LL_RCC_LSE_IsReady
LL_RCC_DisableRTC
RTCEN
LL_RCC_EnableRTC
LL_RCC_IsEnabledRTC
LL_RCC_GetRTCClockSource
RTCSEL
LL_RCC_SetRTCClockSource
LL_RCC_GetAHBPrescaler
HPRE
LL_RCC_SetAHBPrescaler
MCO
LL_RCC_ConfigMCO
MCOPRE
LL_RCC_ConfigMCO
LL_RCC_PLL_ConfigDomain_SYS
PLLMUL
CFGR
PLLNODIV
LL_RCC_PLL_GetMultiplicator
LL_RCC_ConfigMCO
LL_RCC_PLL_ConfigDomain_SYS
PLLSRC
LL_RCC_PLL_GetMainSource
LL_RCC_GetAPB1Prescaler
PPRE
LL_RCC_SetAPB1Prescaler
SW
LL_RCC_SetSysClkSource
SWS
LL_RCC_GetSysClkSource
LL_RCC_PLL_ConfigDomain_SYS
CFGR2
1278/1320
PREDIV
LL_RCC_PLL_GetPrediv
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_RCC_GetCECClockSource
CECSW
LL_RCC_SetCECClockSource
LL_RCC_GetI2CClockSource
I2C1SW
LL_RCC_SetI2CClockSource
LL_RCC_GetUSARTClockSource
CFGR3
USART1SW
LL_RCC_SetUSARTClockSource
LL_RCC_GetUSARTClockSource
USART2SW
LL_RCC_SetUSARTClockSource
LL_RCC_GetUSARTClockSource
USART3SW
LL_RCC_SetUSARTClockSource
CSSC
LL_RCC_ClearFlag_HSECSS
CSSF
LL_RCC_IsActiveFlag_HSECSS
HSERDYC
LL_RCC_ClearFlag_HSERDY
HSERDYF
LL_RCC_IsActiveFlag_HSERDY
LL_RCC_DisableIT_HSERDY
HSERDYIE
LL_RCC_EnableIT_HSERDY
LL_RCC_IsEnabledIT_HSERDY
HSI14RDYC
LL_RCC_ClearFlag_HSI14RDY
HSI14RDYF
LL_RCC_IsActiveFlag_HSI14RDY
LL_RCC_DisableIT_HSI14RDY
HSI14RDYIE
LL_RCC_EnableIT_HSI14RDY
LL_RCC_IsEnabledIT_HSI14RDY
HSI48RDYC
LL_RCC_ClearFlag_HSI48RDY
HSI48RDYF
LL_RCC_IsActiveFlag_HSI48RDY
CIR
LL_RCC_DisableIT_HSI48RDY
HSI48RDYIE
LL_RCC_EnableIT_HSI48RDY
LL_RCC_IsEnabledIT_HSI48RDY
HSIRDYC
LL_RCC_ClearFlag_HSIRDY
HSIRDYF
LL_RCC_IsActiveFlag_HSIRDY
LL_RCC_DisableIT_HSIRDY
HSIRDYIE
LL_RCC_EnableIT_HSIRDY
LL_RCC_IsEnabledIT_HSIRDY
LSERDYC
LL_RCC_ClearFlag_LSERDY
LSERDYF
LL_RCC_IsActiveFlag_LSERDY
LL_RCC_DisableIT_LSERDY
LSERDYIE
LL_RCC_EnableIT_LSERDY
DocID026525 Rev 6
1279/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
UM1785
Function
LL_RCC_IsEnabledIT_LSERDY
LSIRDYC
LL_RCC_ClearFlag_LSIRDY
LSIRDYF
LL_RCC_IsActiveFlag_LSIRDY
LL_RCC_DisableIT_LSIRDY
LSIRDYIE
LL_RCC_EnableIT_LSIRDY
LL_RCC_IsEnabledIT_LSIRDY
PLLRDYC
LL_RCC_ClearFlag_PLLRDY
PLLRDYF
LL_RCC_IsActiveFlag_PLLRDY
LL_RCC_DisableIT_PLLRDY
PLLRDYIE
LL_RCC_EnableIT_PLLRDY
LL_RCC_IsEnabledIT_PLLRDY
LL_RCC_HSE_DisableCSS
CSSON
LL_RCC_HSE_EnableCSS
LL_RCC_HSE_DisableBypass
HSEBYP
LL_RCC_HSE_EnableBypass
LL_RCC_HSE_Disable
HSEON
LL_RCC_HSE_Enable
HSERDY
LL_RCC_HSE_IsReady
HSICAL
LL_RCC_HSI_GetCalibration
CR
LL_RCC_HSI_Disable
HSION
HSIRDY
LL_RCC_HSI_Enable
LL_RCC_HSI_IsReady
LL_RCC_HSI_GetCalibTrimming
HSITRIM
LL_RCC_HSI_SetCalibTrimming
LL_RCC_PLL_Disable
PLLON
LL_RCC_PLL_Enable
PLLRDY
LL_RCC_PLL_IsReady
HSI14CAL
LL_RCC_HSI14_GetCalibration
LL_RCC_HSI14_DisableADCControl
HSI14DIS
LL_RCC_HSI14_EnableADCControl
LL_RCC_HSI14_Disable
HSI14ON
CR2
HSI14RDY
LL_RCC_HSI14_Enable
LL_RCC_HSI14_IsReady
LL_RCC_HSI14_GetCalibTrimming
HSI14TRIM
HSI48CAL
1280/1320
LL_RCC_HSI14_SetCalibTrimming
LL_RCC_HSI48_GetCalibration
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_RCC_HSI48_Disable
HSI48ON
LL_RCC_HSI48_Enable
HSI48RDY
LL_RCC_HSI48_IsReady
IWDGRSTF
LL_RCC_IsActiveFlag_IWDGRST
LPWRRSTF
LL_RCC_IsActiveFlag_LPWRRST
LL_RCC_LSI_Disable
LSION
LL_RCC_LSI_Enable
LSIRDY
LL_RCC_LSI_IsReady
OBLRSTF
LL_RCC_IsActiveFlag_OBLRST
PINRSTF
LL_RCC_IsActiveFlag_PINRST
PORRSTF
LL_RCC_IsActiveFlag_PORRST
RMVF
LL_RCC_ClearResetFlags
SFTRSTF
LL_RCC_IsActiveFlag_SFTRST
V18PWRRSTF
LL_RCC_IsActiveFlag_V18PWRRST
WWDGRSTF
LL_RCC_IsActiveFlag_WWDGRST
CSR
71.16
RTC
Table 40: Correspondence between RTC registers and RTC low-layer driver functions
Register
Field
Function
LL_RTC_ALMA_GetDay
DT
LL_RTC_ALMA_SetDay
LL_RTC_ALMA_GetDay
LL_RTC_ALMA_GetWeekDay
DU
LL_RTC_ALMA_SetDay
LL_RTC_ALMA_SetWeekDay
LL_RTC_ALMA_ConfigTime
LL_RTC_ALMA_GetHour
HT
LL_RTC_ALMA_GetTime
ALRMAR
LL_RTC_ALMA_SetHour
LL_RTC_ALMA_ConfigTime
LL_RTC_ALMA_GetHour
HU
LL_RTC_ALMA_GetTime
LL_RTC_ALMA_SetHour
LL_RTC_ALMA_ConfigTime
MNT
LL_RTC_ALMA_GetMinute
LL_RTC_ALMA_GetTime
DocID026525 Rev 6
1281/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
UM1785
Function
LL_RTC_ALMA_SetMinute
LL_RTC_ALMA_ConfigTime
LL_RTC_ALMA_GetMinute
MNU
LL_RTC_ALMA_GetTime
LL_RTC_ALMA_SetMinute
LL_RTC_ALMA_GetMask
MSK1
LL_RTC_ALMA_SetMask
LL_RTC_ALMA_GetMask
MSK2
LL_RTC_ALMA_SetMask
LL_RTC_ALMA_GetMask
MSK3
LL_RTC_ALMA_SetMask
LL_RTC_ALMA_GetMask
MSK4
LL_RTC_ALMA_SetMask
LL_RTC_ALMA_ConfigTime
PM
LL_RTC_ALMA_GetTimeFormat
LL_RTC_ALMA_SetTimeFormat
LL_RTC_ALMA_ConfigTime
LL_RTC_ALMA_GetSecond
ST
LL_RTC_ALMA_GetTime
LL_RTC_ALMA_SetSecond
LL_RTC_ALMA_ConfigTime
LL_RTC_ALMA_GetSecond
SU
LL_RTC_ALMA_GetTime
LL_RTC_ALMA_SetSecond
LL_RTC_ALMA_DisableWeekday
WDSEL
LL_RTC_ALMA_EnableWeekday
LL_RTC_ALMA_GetSubSecondMask
MASKSS
LL_RTC_ALMA_SetSubSecondMask
ALRMASSR
LL_RTC_ALMA_GetSubSecond
SS
LL_RTC_ALMA_SetSubSecond
LL_RTC_BAK_GetRegister
BKPxR
BKP
LL_RTC_BAK_SetRegister
LL_RTC_CAL_GetMinus
CALM
LL_RTC_CAL_SetMinus
CALR
LL_RTC_CAL_IsPulseInserted
CALP
1282/1320
LL_RTC_CAL_SetPulse
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_RTC_CAL_GetPeriod
CALW16
LL_RTC_CAL_SetPeriod
LL_RTC_CAL_GetPeriod
CALW8
ADD1H
LL_RTC_CAL_SetPeriod
LL_RTC_TIME_IncHour
LL_RTC_ALMA_Disable
ALRAE
LL_RTC_ALMA_Enable
LL_RTC_DisableIT_ALRA
ALRAIE
LL_RTC_EnableIT_ALRA
LL_RTC_IsEnabledIT_ALRA
LL_RTC_TIME_DisableDayLightStore
BKP
LL_RTC_TIME_EnableDayLightStore
LL_RTC_TIME_IsDayLightStoreEnabled
LL_RTC_DisableShadowRegBypass
BYPSHAD
LL_RTC_EnableShadowRegBypass
LL_RTC_IsShadowRegBypassEnabled
LL_RTC_CAL_GetOutputFreq
COE
LL_RTC_CAL_SetOutputFreq
LL_RTC_CAL_GetOutputFreq
COSEL
CR
LL_RTC_CAL_SetOutputFreq
LL_RTC_GetHourFormat
FMT
LL_RTC_SetHourFormat
LL_RTC_GetAlarmOutEvent
OSEL
LL_RTC_SetAlarmOutEvent
LL_RTC_GetOutputPolarity
POL
LL_RTC_SetOutputPolarity
LL_RTC_DisableRefClock
REFCKON
SUB1H
LL_RTC_EnableRefClock
LL_RTC_TIME_DecHour
LL_RTC_TS_Disable
TSE
LL_RTC_TS_Enable
LL_RTC_TS_GetActiveEdge
TSEDGE
LL_RTC_TS_SetActiveEdge
LL_RTC_DisableIT_TS
TSIE
LL_RTC_EnableIT_TS
LL_RTC_IsEnabledIT_TS
DocID026525 Rev 6
1283/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
UM1785
Function
LL_RTC_WAKEUP_GetClock
WUCKSEL
LL_RTC_WAKEUP_SetClock
LL_RTC_WAKEUP_Disable
WUTE
LL_RTC_WAKEUP_Enable
LL_RTC_WAKEUP_IsEnabled
LL_RTC_DisableIT_WUT
WUTIE
LL_RTC_EnableIT_WUT
LL_RTC_IsEnabledIT_WUT
LL_RTC_DATE_Config
LL_RTC_DATE_Get
DT
LL_RTC_DATE_GetDay
LL_RTC_DATE_SetDay
LL_RTC_DATE_Config
LL_RTC_DATE_Get
DU
LL_RTC_DATE_GetDay
LL_RTC_DATE_SetDay
LL_RTC_DATE_Config
LL_RTC_DATE_Get
MT
LL_RTC_DATE_GetMonth
LL_RTC_DATE_SetMonth
LL_RTC_DATE_Config
LL_RTC_DATE_Get
DR
MU
LL_RTC_DATE_GetMonth
LL_RTC_DATE_SetMonth
LL_RTC_DATE_Config
LL_RTC_DATE_Get
WDU
LL_RTC_DATE_GetWeekDay
LL_RTC_DATE_SetWeekDay
LL_RTC_DATE_Config
LL_RTC_DATE_Get
YT
LL_RTC_DATE_GetYear
LL_RTC_DATE_SetYear
LL_RTC_DATE_Config
LL_RTC_DATE_Get
YU
LL_RTC_DATE_GetYear
LL_RTC_DATE_SetYear
1284/1320
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_RTC_ClearFlag_ALRA
ALRAF
LL_RTC_IsActiveFlag_ALRA
LL_RTC_IsActiveFlag_ALRAW
ALRAWF
LL_RTC_DisableInitMode
INIT
LL_RTC_EnableInitMode
INITF
LL_RTC_IsActiveFlag_INIT
INITS
LL_RTC_IsActiveFlag_INITS
RECALPF
LL_RTC_IsActiveFlag_RECALP
LL_RTC_ClearFlag_RS
RSF
LL_RTC_IsActiveFlag_RS
LL_RTC_IsActiveFlag_SHP
SHPF
LL_RTC_ClearFlag_TAMP1
ISR
TAMP1F
LL_RTC_IsActiveFlag_TAMP1
LL_RTC_ClearFlag_TAMP2
TAMP2F
LL_RTC_IsActiveFlag_TAMP2
LL_RTC_ClearFlag_TAMP3
TAMP3F
LL_RTC_IsActiveFlag_TAMP3
LL_RTC_ClearFlag_TS
TSF
LL_RTC_IsActiveFlag_TS
LL_RTC_ClearFlag_TSOV
TSOVF
LL_RTC_IsActiveFlag_TSOV
LL_RTC_ClearFlag_WUT
WUTF
LL_RTC_IsActiveFlag_WUT
LL_RTC_IsActiveFlag_WUTW
WUTWF
LL_RTC_GetAsynchPrescaler
PREDIV_A
LL_RTC_SetAsynchPrescaler
PRER
LL_RTC_GetSynchPrescaler
PREDIV_S
LL_RTC_SetSynchPrescaler
ADD1S
LL_RTC_TIME_Synchronize
SUBFS
LL_RTC_TIME_Synchronize
SS
LL_RTC_TIME_GetSubSecond
SHIFTR
SSR
LL_RTC_GetAlarmOutputType
ALARMOUTTYPE
LL_RTC_SetAlarmOutputType
LL_RTC_DisablePushPullMode
TAFCR
PC13MODE
PC14MODE
LL_RTC_EnablePushPullMode
LL_RTC_DisablePushPullMode
DocID026525 Rev 6
1285/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
UM1785
Function
LL_RTC_EnablePushPullMode
LL_RTC_ResetOutputPin
PC14VALUE
LL_RTC_SetOutputPin
LL_RTC_DisablePushPullMode
PC15MODE
LL_RTC_EnablePushPullMode
LL_RTC_ResetOutputPin
PC15VALUE
LL_RTC_SetOutputPin
LL_RTC_TAMPER_Disable
TAMP1E
LL_RTC_TAMPER_Enable
LL_RTC_TAMPER_DisableActiveLevel
TAMP1TRG
LL_RTC_TAMPER_EnableActiveLevel
LL_RTC_TAMPER_Disable
TAMP2E
LL_RTC_TAMPER_Enable
LL_RTC_TAMPER_DisableActiveLevel
TAMP2TRG
LL_RTC_TAMPER_EnableActiveLevel
LL_RTC_TAMPER_Disable
TAMP3E
LL_RTC_TAMPER_Enable
LL_RTC_TAMPER_DisableActiveLevel
TAMP3TRG
LL_RTC_TAMPER_EnableActiveLevel
LL_RTC_TAMPER_GetFilterCount
TAMPFLT
LL_RTC_TAMPER_SetFilterCount
LL_RTC_TAMPER_GetSamplingFreq
TAMPFREQ
LL_RTC_TAMPER_SetSamplingFreq
LL_RTC_DisableIT_TAMP
LL_RTC_EnableIT_TAMP
TAMPIE
LL_RTC_IsEnabledIT_TAMP
LL_RTC_TAMPER_GetPrecharge
TAMPPRCH
LL_RTC_TAMPER_SetPrecharge
LL_RTC_TAMPER_DisablePullUp
TAMPPUDIS
LL_RTC_TAMPER_EnablePullUp
LL_RTC_TS_DisableOnTamper
TAMPTS
LL_RTC_TS_EnableOnTamper
LL_RTC_TIME_Config
LL_RTC_TIME_Get
TR
HT
LL_RTC_TIME_GetHour
LL_RTC_TIME_SetHour
1286/1320
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_RTC_TIME_Config
LL_RTC_TIME_Get
HU
LL_RTC_TIME_GetHour
LL_RTC_TIME_SetHour
LL_RTC_TIME_Config
LL_RTC_TIME_Get
MNT
LL_RTC_TIME_GetMinute
LL_RTC_TIME_SetMinute
LL_RTC_TIME_Config
LL_RTC_TIME_Get
MNU
LL_RTC_TIME_GetMinute
LL_RTC_TIME_SetMinute
LL_RTC_TIME_Config
PM
LL_RTC_TIME_GetFormat
LL_RTC_TIME_SetFormat
LL_RTC_TIME_Config
LL_RTC_TIME_Get
ST
LL_RTC_TIME_GetSecond
LL_RTC_TIME_SetSecond
LL_RTC_TIME_Config
LL_RTC_TIME_Get
SU
LL_RTC_TIME_GetSecond
LL_RTC_TIME_SetSecond
LL_RTC_TS_GetDate
DT
LL_RTC_TS_GetDay
LL_RTC_TS_GetDate
DU
LL_RTC_TS_GetDay
LL_RTC_TS_GetDate
TSDR
MT
LL_RTC_TS_GetMonth
LL_RTC_TS_GetDate
MU
LL_RTC_TS_GetMonth
LL_RTC_TS_GetDate
WDU
TSSSR
SS
TSTR
HT
LL_RTC_TS_GetWeekDay
LL_RTC_TS_GetSubSecond
LL_RTC_TS_GetHour
LL_RTC_TS_GetTime
DocID026525 Rev 6
1287/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
UM1785
Function
LL_RTC_TS_GetHour
HU
LL_RTC_TS_GetTime
LL_RTC_TS_GetMinute
MNT
LL_RTC_TS_GetTime
LL_RTC_TS_GetMinute
MNU
PM
LL_RTC_TS_GetTime
LL_RTC_TS_GetTimeFormat
LL_RTC_TS_GetSecond
ST
LL_RTC_TS_GetTime
LL_RTC_TS_GetSecond
SU
LL_RTC_TS_GetTime
LL_RTC_DisableWriteProtection
WPR
KEY
WUTR
WUT
LL_RTC_EnableWriteProtection
LL_RTC_WAKEUP_GetAutoReload
71.17
LL_RTC_WAKEUP_SetAutoReload
SPI
Table 41: Correspondence between SPI registers and SPI low-layer driver functions
Register
Field
Function
LL_SPI_GetTransferDirection
BIDIMODE
LL_SPI_SetTransferDirection
LL_SPI_GetTransferDirection
BIDIOE
LL_SPI_SetTransferDirection
LL_SPI_GetBaudRatePrescaler
BR
LL_SPI_SetBaudRatePrescaler
LL_SPI_GetClockPhase
CPHA
LL_SPI_SetClockPhase
LL_SPI_GetClockPolarity
CR1
CPOL
LL_SPI_SetClockPolarity
LL_SPI_DisableCRC
CRCEN
LL_SPI_EnableCRC
LL_SPI_IsEnabledCRC
LL_SPI_GetCRCWidth
CRCL
1288/1320
LL_SPI_SetCRCWidth
CRCNEXT
LL_SPI_SetCRCNext
LSBFIRST
LL_SPI_GetTransferBitOrder
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_SPI_SetTransferBitOrder
LL_SPI_GetMode
MSTR
LL_SPI_SetMode
LL_SPI_GetTransferDirection
RXONLY
LL_SPI_SetTransferDirection
LL_SPI_Disable
SPE
LL_SPI_Enable
LL_SPI_IsEnabled
LL_SPI_GetMode
SSI
LL_SPI_SetMode
LL_SPI_GetNSSMode
SSM
LL_SPI_SetNSSMode
LL_SPI_GetDataWidth
DS
LL_SPI_SetDataWidth
LL_SPI_DisableIT_ERR
ERRIE
LL_SPI_EnableIT_ERR
LL_SPI_IsEnabledIT_ERR
LL_SPI_GetStandard
FRF
LL_SPI_SetStandard
LL_SPI_GetRxFIFOThreshold
FRXTH
LL_SPI_SetRxFIFOThreshold
LL_SPI_GetDMAParity_RX
LDMARX
LL_SPI_SetDMAParity_RX
LL_SPI_GetDMAParity_TX
CR2
LDMATX
LL_SPI_SetDMAParity_TX
LL_SPI_DisableNSSPulseMgt
NSSP
LL_SPI_EnableNSSPulseMgt
LL_SPI_IsEnabledNSSPulse
LL_SPI_DisableDMAReq_RX
RXDMAEN
LL_SPI_EnableDMAReq_RX
LL_SPI_IsEnabledDMAReq_RX
LL_SPI_DisableIT_RXNE
RXNEIE
LL_SPI_EnableIT_RXNE
LL_SPI_IsEnabledIT_RXNE
LL_SPI_GetNSSMode
SSOE
LL_SPI_SetNSSMode
DocID026525 Rev 6
1289/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
UM1785
Function
LL_SPI_DisableDMAReq_TX
LL_SPI_EnableDMAReq_TX
TXDMAEN
LL_SPI_IsEnabledDMAReq_TX
LL_SPI_DisableIT_TXE
LL_SPI_EnableIT_TXE
TXEIE
LL_SPI_IsEnabledIT_TXE
LL_SPI_GetCRCPolynomial
CRCPR
CRCPOLY
LL_SPI_SetCRCPolynomial
LL_SPI_DMA_GetRegAddr
LL_SPI_ReceiveData16
DR
LL_SPI_ReceiveData8
DR
LL_SPI_TransmitData16
LL_SPI_TransmitData8
RXCRCR
RXCRC
LL_SPI_GetRxCRC
BSY
LL_SPI_IsActiveFlag_BSY
LL_SPI_ClearFlag_CRCERR
CRCERR
LL_SPI_IsActiveFlag_CRCERR
LL_SPI_ClearFlag_FRE
FRE
LL_SPI_IsActiveFlag_FRE
SR
FRLVL
LL_SPI_GetRxFIFOLevel
FTLVL
LL_SPI_GetTxFIFOLevel
LL_SPI_ClearFlag_MODF
MODF
LL_SPI_IsActiveFlag_MODF
LL_SPI_ClearFlag_OVR
OVR
TXCRCR
71.18
LL_SPI_IsActiveFlag_OVR
RXNE
LL_SPI_IsActiveFlag_RXNE
TXE
LL_SPI_IsActiveFlag_TXE
TXCRC
LL_SPI_GetTxCRC
SYSTEM
Table 42: Correspondence between SYSTEM registers and SYSTEM low-layer driver functions
Register
Field
Function
LL_DBGMCU_APB1_GRP1_FreezePeriph
DBGMCU_APB1F
Z
1290/1320
DBG_CAN_STOP
LL_DBGMCU_APB1_GRP1_UnFreezePerip
h
DBG_I2C1_SMBUS_TIMEOU
LL_DBGMCU_APB1_GRP1_FreezePeriph
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
T
LL_DBGMCU_APB1_GRP1_UnFreezePerip
h
LL_DBGMCU_APB1_GRP1_FreezePeriph
DBG_IWDG_STOP
LL_DBGMCU_APB1_GRP1_UnFreezePerip
h
LL_DBGMCU_APB1_GRP1_FreezePeriph
DBG_RTC_STOP
LL_DBGMCU_APB1_GRP1_UnFreezePerip
h
LL_DBGMCU_APB1_GRP1_FreezePeriph
DBG_TIM14_STOP
LL_DBGMCU_APB1_GRP1_UnFreezePerip
h
LL_DBGMCU_APB1_GRP1_FreezePeriph
DBG_TIM2_STOP
LL_DBGMCU_APB1_GRP1_UnFreezePerip
h
LL_DBGMCU_APB1_GRP1_FreezePeriph
DBG_TIM3_STOP
LL_DBGMCU_APB1_GRP1_UnFreezePerip
h
LL_DBGMCU_APB1_GRP1_FreezePeriph
DBG_TIM6_STOP
LL_DBGMCU_APB1_GRP1_UnFreezePerip
h
LL_DBGMCU_APB1_GRP1_FreezePeriph
DBG_TIM7_STOP
LL_DBGMCU_APB1_GRP1_UnFreezePerip
h
LL_DBGMCU_APB1_GRP1_FreezePeriph
DBG_WWDG_STOP
LL_DBGMCU_APB1_GRP1_UnFreezePerip
h
LL_DBGMCU_APB1_GRP2_FreezePeriph
DBG_TIM15_STOP
LL_DBGMCU_APB1_GRP2_UnFreezePerip
h
LL_DBGMCU_APB1_GRP2_FreezePeriph
DBG_TIM16_STOP
DBGMCU_APB2F
Z
LL_DBGMCU_APB1_GRP2_UnFreezePerip
h
LL_DBGMCU_APB1_GRP2_FreezePeriph
DBG_TIM17_STOP
LL_DBGMCU_APB1_GRP2_UnFreezePerip
h
LL_DBGMCU_APB1_GRP2_FreezePeriph
DBG_TIM1_STOP
LL_DBGMCU_APB1_GRP2_UnFreezePerip
h
LL_DBGMCU_DisableDBGStandbyMode
DBG_STANDBY
DBGMCU_CR
DBG_STOP
DocID026525 Rev 6
LL_DBGMCU_EnableDBGStandbyMode
LL_DBGMCU_DisableDBGStopMode
1291/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
UM1785
Function
LL_DBGMCU_EnableDBGStopMode
DBGMCU_IDCOD
E
DEV_ID
LL_DBGMCU_GetDeviceID
REV_ID
LL_DBGMCU_GetRevisionID
LL_FLASH_GetLatency
LATENCY
LL_FLASH_SetLatency
LL_FLASH_DisablePrefetch
FLASH_ACR
PRFTBE
LL_FLASH_EnablePrefetch
LL_FLASH_IsPrefetchEnabled
PRFTBS
LL_SYSCFG_DisableFastModePlus
I2C_FMP_I2C1
LL_SYSCFG_EnableFastModePlus
LL_SYSCFG_DisableFastModePlus
I2C_FMP_I2C2
LL_SYSCFG_EnableFastModePlus
LL_SYSCFG_DisableFastModePlus
I2C_FMP_PA10
LL_SYSCFG_EnableFastModePlus
LL_SYSCFG_DisableFastModePlus
I2C_FMP_PA9
LL_SYSCFG_EnableFastModePlus
LL_SYSCFG_DisableFastModePlus
I2C_FMP_PB6
LL_SYSCFG_EnableFastModePlus
SYSCFG_CFGR1
LL_SYSCFG_DisableFastModePlus
I2C_FMP_PB7
LL_SYSCFG_EnableFastModePlus
LL_SYSCFG_DisableFastModePlus
I2C_FMP_PB8
LL_SYSCFG_EnableFastModePlus
LL_SYSCFG_DisableFastModePlus
I2C_FMP_PB9
LL_SYSCFG_EnableFastModePlus
LL_SYSCFG_GetIRModEnvelopeSignal
IR_MOD
LL_SYSCFG_SetIRModEnvelopeSignal
LL_SYSCFG_GetRemapMemory
MEM_MODE
LL_SYSCFG_SetRemapMemory
LL_SYSCFG_GetTIMBreakInputs
LOCKUP_LOCK
LL_SYSCFG_SetTIMBreakInputs
LL_SYSCFG_GetTIMBreakInputs
PVD_LOCK
SYSCFG_CFGR2
LL_SYSCFG_SetTIMBreakInputs
LL_SYSCFG_GetTIMBreakInputs
SRAM_PARITY_LOCK
LL_SYSCFG_SetTIMBreakInputs
LL_SYSCFG_ClearFlag_SP
SRAM_PEF
1292/1320
DocID026525 Rev 6
LL_SYSCFG_IsActiveFlag_SP
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
SYSCFG_EXTICR
1
SYSCFG_EXTICR
2
SYSCFG_EXTICR
3
SYSCFG_EXTICR
4
SYSCFG_ITLINE0
Field
Function
EXTI0
LL_SYSCFG_SetEXTISource
EXTI1
LL_SYSCFG_SetEXTISource
EXTI2
LL_SYSCFG_SetEXTISource
EXTI3
LL_SYSCFG_SetEXTISource
EXTI4
LL_SYSCFG_SetEXTISource
EXTI5
LL_SYSCFG_SetEXTISource
EXTI6
LL_SYSCFG_SetEXTISource
EXTI7
LL_SYSCFG_SetEXTISource
EXTI10
LL_SYSCFG_SetEXTISource
EXTI11
LL_SYSCFG_SetEXTISource
EXTI8
LL_SYSCFG_SetEXTISource
EXTI9
LL_SYSCFG_SetEXTISource
EXTI12
LL_SYSCFG_SetEXTISource
EXTI13
LL_SYSCFG_SetEXTISource
EXTI14
LL_SYSCFG_SetEXTISource
EXTI15
LL_SYSCFG_SetEXTISource
SR_EWDG
LL_SYSCFG_IsActiveFlag_WWDG
SR_PVDOUT
LL_SYSCFG_IsActiveFlag_PVDOUT
SR_VDDIO2
LL_SYSCFG_IsActiveFlag_VDDIO2
SR_DMA1_CH2
LL_SYSCFG_IsActiveFlag_DMA1_CH2
SR_DMA1_CH3
LL_SYSCFG_IsActiveFlag_DMA1_CH3
SR_DMA2_CH1
LL_SYSCFG_IsActiveFlag_DMA2_CH1
SR_DMA2_CH2
LL_SYSCFG_IsActiveFlag_DMA2_CH2
SR_DMA1_CH4
LL_SYSCFG_IsActiveFlag_DMA1_CH4
SR_DMA1_CH5
LL_SYSCFG_IsActiveFlag_DMA1_CH5
SR_DMA1_CH6
LL_SYSCFG_IsActiveFlag_DMA1_CH6
SR_DMA1_CH7
LL_SYSCFG_IsActiveFlag_DMA1_CH7
SR_DMA2_CH3
LL_SYSCFG_IsActiveFlag_DMA2_CH3
SR_DMA2_CH4
LL_SYSCFG_IsActiveFlag_DMA2_CH4
SR_DMA2_CH5
LL_SYSCFG_IsActiveFlag_DMA2_CH5
SR_ADC
LL_SYSCFG_IsActiveFlag_ADC
SR_COMP1
LL_SYSCFG_IsActiveFlag_COMP1
SR_COMP2
LL_SYSCFG_IsActiveFlag_COMP2
SR_TIM1_BRK
LL_SYSCFG_IsActiveFlag_TIM1_BRK
SR_TIM1_CCU
LL_SYSCFG_IsActiveFlag_TIM1_CCU
SR_TIM1_TRG
LL_SYSCFG_IsActiveFlag_TIM1_TRG
SYSCFG_ITLINE1
SYSCFG_ITLINE1
0
SYSCFG_ITLINE1
1
SYSCFG_ITLINE1
2
SYSCFG_ITLINE1
3
DocID026525 Rev 6
1293/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
SR_TIM1_UPD
LL_SYSCFG_IsActiveFlag_TIM1_UPD
SYSCFG_ITLINE1
4
SR_TIM1_CC
LL_SYSCFG_IsActiveFlag_TIM1_CC
SYSCFG_ITLINE1
5
SR_TIM2_GLB
LL_SYSCFG_IsActiveFlag_TIM2
SYSCFG_ITLINE1
6
SR_TIM3_GLB
LL_SYSCFG_IsActiveFlag_TIM3
SR_DAC
LL_SYSCFG_IsActiveFlag_DAC
SR_TIM6_GLB
LL_SYSCFG_IsActiveFlag_TIM6
SYSCFG_ITLINE1
8
SR_TIM7_GLB
LL_SYSCFG_IsActiveFlag_TIM7
SYSCFG_ITLINE1
9
SR_TIM14_GLB
LL_SYSCFG_IsActiveFlag_TIM14
SR_RTC_ALRA
LL_SYSCFG_IsActiveFlag_RTC_ALRA
SR_RTC_TSTAMP
LL_SYSCFG_IsActiveFlag_RTC_TSTAMP
SR_RTC_WAKEUP
LL_SYSCFG_IsActiveFlag_RTC_WAKEUP
SYSCFG_ITLINE2
0
SR_TIM15_GLB
LL_SYSCFG_IsActiveFlag_TIM15
SYSCFG_ITLINE2
1
SR_TIM16_GLB
LL_SYSCFG_IsActiveFlag_TIM16
SYSCFG_ITLINE2
2
SR_TIM17_GLB
LL_SYSCFG_IsActiveFlag_TIM17
SYSCFG_ITLINE2
3
SR_I2C1_GLB
LL_SYSCFG_IsActiveFlag_I2C1
SYSCFG_ITLINE2
4
SR_I2C2_GLB
LL_SYSCFG_IsActiveFlag_I2C2
SYSCFG_ITLINE2
5
SR_SPI1
LL_SYSCFG_IsActiveFlag_SPI1
SYSCFG_ITLINE2
6
SR_SPI2
LL_SYSCFG_IsActiveFlag_SPI2
SYSCFG_ITLINE2
7
SR_USART1_GLB
LL_SYSCFG_IsActiveFlag_USART1
SYSCFG_ITLINE2
8
SR_USART2_GLB
LL_SYSCFG_IsActiveFlag_USART2
SR_USART3_GLB
LL_SYSCFG_IsActiveFlag_USART3
SR_USART4_GLB
LL_SYSCFG_IsActiveFlag_USART4
SR_USART5_GLB
LL_SYSCFG_IsActiveFlag_USART5
SR_USART6_GLB
LL_SYSCFG_IsActiveFlag_USART6
SR_USART7_GLB
LL_SYSCFG_IsActiveFlag_USART7
SR_USART8_GLB
LL_SYSCFG_IsActiveFlag_USART8
SR_FLASH_ITF
LL_SYSCFG_IsActiveFlag_FLASH_ITF
SYSCFG_ITLINE1
7
SYSCFG_ITLINE2
SYSCFG_ITLINE2
9
SYSCFG_ITLINE3
1294/1320
UM1785
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
SYSCFG_ITLINE3
0
SR_CAN
LL_SYSCFG_IsActiveFlag_CAN
SR_CEC
LL_SYSCFG_IsActiveFlag_CEC
SR_CLK_CTRL
LL_SYSCFG_IsActiveFlag_CLK_CTRL
SR_CRS
LL_SYSCFG_IsActiveFlag_CRS
SR_EXTI0
LL_SYSCFG_IsActiveFlag_EXTI0
SR_EXTI1
LL_SYSCFG_IsActiveFlag_EXTI1
SR_EXTI2
LL_SYSCFG_IsActiveFlag_EXTI2
SR_EXTI3
LL_SYSCFG_IsActiveFlag_EXTI3
SR_EXTI10
LL_SYSCFG_IsActiveFlag_EXTI10
SR_EXTI11
LL_SYSCFG_IsActiveFlag_EXTI11
SR_EXTI12
LL_SYSCFG_IsActiveFlag_EXTI12
SR_EXTI13
LL_SYSCFG_IsActiveFlag_EXTI13
SR_EXTI14
LL_SYSCFG_IsActiveFlag_EXTI14
SR_EXTI15
LL_SYSCFG_IsActiveFlag_EXTI15
SR_EXTI4
LL_SYSCFG_IsActiveFlag_EXTI4
SR_EXTI5
LL_SYSCFG_IsActiveFlag_EXTI5
SR_EXTI6
LL_SYSCFG_IsActiveFlag_EXTI6
SR_EXTI7
LL_SYSCFG_IsActiveFlag_EXTI7
SR_EXTI8
LL_SYSCFG_IsActiveFlag_EXTI8
SR_EXTI9
LL_SYSCFG_IsActiveFlag_EXTI9
SR_TSC_EOA
LL_SYSCFG_IsActiveFlag_TSC_EOA
SR_TSC_MCE
LL_SYSCFG_IsActiveFlag_TSC_MCE
SR_DMA1_CH1
LL_SYSCFG_IsActiveFlag_DMA1_CH1
SYSCFG_ITLINE4
SYSCFG_ITLINE5
SYSCFG_ITLINE6
SYSCFG_ITLINE7
SYSCFG_ITLINE8
SYSCFG_ITLINE9
71.19
TIM
Table 43: Correspondence between TIM registers and TIM low-layer driver functions
Register
Field
ARR
ARR
Function
LL_TIM_GetAutoReload
LL_TIM_SetAutoReload
LL_TIM_DisableAutomaticOutput
AOE
LL_TIM_EnableAutomaticOutput
LL_TIM_IsEnabledAutomaticOutput
LL_TIM_DisableBRK
BDTR
BKE
LL_TIM_EnableBRK
BKP
LL_TIM_ConfigBRK
DTG
LL_TIM_OC_SetDeadTime
DocID026525 Rev 6
1295/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LOCK
LL_TIM_CC_SetLockLevel
LL_TIM_DisableAllOutputs
MOE
LL_TIM_EnableAllOutputs
LL_TIM_IsEnabledAllOutputs
OSSI
LL_TIM_SetOffStates
OSSR
LL_TIM_SetOffStates
LL_TIM_CC_DisableChannel
CC1E
LL_TIM_CC_EnableChannel
LL_TIM_CC_IsEnabledChannel
LL_TIM_CC_DisableChannel
CC1NE
LL_TIM_CC_EnableChannel
LL_TIM_CC_IsEnabledChannel
LL_TIM_IC_Config
LL_TIM_IC_GetPolarity
CC1NP
LL_TIM_IC_SetPolarity
LL_TIM_OC_GetPolarity
LL_TIM_OC_SetPolarity
LL_TIM_IC_Config
LL_TIM_IC_GetPolarity
LL_TIM_IC_SetPolarity
CC1P
CCER
LL_TIM_OC_ConfigOutput
LL_TIM_OC_GetPolarity
LL_TIM_OC_SetPolarity
LL_TIM_CC_DisableChannel
CC2E
LL_TIM_CC_EnableChannel
LL_TIM_CC_IsEnabledChannel
LL_TIM_CC_DisableChannel
CC2NE
LL_TIM_CC_EnableChannel
LL_TIM_CC_IsEnabledChannel
LL_TIM_IC_Config
LL_TIM_IC_GetPolarity
CC2NP
LL_TIM_IC_SetPolarity
LL_TIM_OC_GetPolarity
LL_TIM_OC_SetPolarity
LL_TIM_IC_Config
CC2P
1296/1320
LL_TIM_IC_GetPolarity
DocID026525 Rev 6
UM1785
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_TIM_IC_SetPolarity
LL_TIM_OC_ConfigOutput
LL_TIM_OC_GetPolarity
LL_TIM_OC_SetPolarity
LL_TIM_CC_DisableChannel
CC3E
LL_TIM_CC_EnableChannel
LL_TIM_CC_IsEnabledChannel
LL_TIM_CC_DisableChannel
CC3NE
LL_TIM_CC_EnableChannel
LL_TIM_CC_IsEnabledChannel
LL_TIM_IC_Config
LL_TIM_IC_GetPolarity
CC3NP
LL_TIM_IC_SetPolarity
LL_TIM_OC_GetPolarity
LL_TIM_OC_SetPolarity
LL_TIM_IC_Config
LL_TIM_IC_GetPolarity
LL_TIM_IC_SetPolarity
CC3P
LL_TIM_OC_ConfigOutput
LL_TIM_OC_GetPolarity
LL_TIM_OC_SetPolarity
LL_TIM_CC_DisableChannel
CC4E
LL_TIM_CC_EnableChannel
LL_TIM_CC_IsEnabledChannel
LL_TIM_IC_Config
CC4NP
LL_TIM_IC_GetPolarity
LL_TIM_IC_SetPolarity
LL_TIM_IC_Config
LL_TIM_IC_GetPolarity
LL_TIM_IC_SetPolarity
CC4P
LL_TIM_OC_ConfigOutput
LL_TIM_OC_GetPolarity
LL_TIM_OC_SetPolarity
LL_TIM_IC_Config
CCMR1
CC1S
LL_TIM_IC_GetActiveInput
LL_TIM_IC_SetActiveInput
DocID026525 Rev 6
1297/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_TIM_OC_ConfigOutput
LL_TIM_IC_Config
LL_TIM_IC_GetActiveInput
CC2S
LL_TIM_IC_SetActiveInput
LL_TIM_OC_ConfigOutput
LL_TIM_IC_Config
IC1F
LL_TIM_IC_GetFilter
LL_TIM_IC_SetFilter
LL_TIM_IC_Config
IC1PSC
LL_TIM_IC_GetPrescaler
LL_TIM_IC_SetPrescaler
LL_TIM_IC_Config
IC2F
LL_TIM_IC_GetFilter
LL_TIM_IC_SetFilter
LL_TIM_IC_Config
IC2PSC
LL_TIM_IC_GetPrescaler
LL_TIM_IC_SetPrescaler
LL_TIM_OC_DisableClear
OC1CE
LL_TIM_OC_EnableClear
LL_TIM_OC_IsEnabledClear
LL_TIM_OC_DisableFast
OC1FE
LL_TIM_OC_EnableFast
LL_TIM_OC_IsEnabledFast
LL_TIM_OC_GetMode
OC1M
LL_TIM_OC_SetMode
LL_TIM_OC_DisablePreload
OC1PE
LL_TIM_OC_EnablePreload
LL_TIM_OC_IsEnabledPreload
LL_TIM_OC_DisableClear
OC2CE
LL_TIM_OC_EnableClear
LL_TIM_OC_IsEnabledClear
LL_TIM_OC_DisableFast
OC2FE
LL_TIM_OC_EnableFast
LL_TIM_OC_IsEnabledFast
LL_TIM_OC_GetMode
OC2M
1298/1320
LL_TIM_OC_SetMode
DocID026525 Rev 6
UM1785
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_TIM_OC_DisablePreload
OC2PE
LL_TIM_OC_EnablePreload
LL_TIM_OC_IsEnabledPreload
LL_TIM_IC_Config
LL_TIM_IC_GetActiveInput
CC3S
LL_TIM_IC_SetActiveInput
LL_TIM_OC_ConfigOutput
LL_TIM_IC_Config
LL_TIM_IC_GetActiveInput
CC4S
LL_TIM_IC_SetActiveInput
LL_TIM_OC_ConfigOutput
LL_TIM_IC_Config
IC3F
LL_TIM_IC_GetFilter
LL_TIM_IC_SetFilter
LL_TIM_IC_Config
IC3PSC
LL_TIM_IC_GetPrescaler
LL_TIM_IC_SetPrescaler
LL_TIM_IC_Config
IC4F
LL_TIM_IC_GetFilter
LL_TIM_IC_SetFilter
CCMR2
LL_TIM_IC_Config
IC4PSC
LL_TIM_IC_GetPrescaler
LL_TIM_IC_SetPrescaler
LL_TIM_OC_DisableClear
OC3CE
LL_TIM_OC_EnableClear
LL_TIM_OC_IsEnabledClear
LL_TIM_OC_DisableFast
OC3FE
LL_TIM_OC_EnableFast
LL_TIM_OC_IsEnabledFast
LL_TIM_OC_GetMode
OC3M
LL_TIM_OC_SetMode
LL_TIM_OC_DisablePreload
OC3PE
LL_TIM_OC_EnablePreload
LL_TIM_OC_IsEnabledPreload
LL_TIM_OC_DisableClear
OC4CE
LL_TIM_OC_EnableClear
DocID026525 Rev 6
1299/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_TIM_OC_IsEnabledClear
LL_TIM_OC_DisableFast
OC4FE
LL_TIM_OC_EnableFast
LL_TIM_OC_IsEnabledFast
LL_TIM_OC_GetMode
OC4M
LL_TIM_OC_SetMode
LL_TIM_OC_DisablePreload
OC4PE
LL_TIM_OC_EnablePreload
LL_TIM_OC_IsEnabledPreload
LL_TIM_IC_GetCaptureCH1
CCR1
CCR1
LL_TIM_OC_GetCompareCH1
LL_TIM_OC_SetCompareCH1
LL_TIM_IC_GetCaptureCH2
CCR2
CCR2
LL_TIM_OC_GetCompareCH2
LL_TIM_OC_SetCompareCH2
LL_TIM_IC_GetCaptureCH3
CCR3
CCR3
LL_TIM_OC_GetCompareCH3
LL_TIM_OC_SetCompareCH3
LL_TIM_IC_GetCaptureCH4
CCR4
CCR4
LL_TIM_OC_GetCompareCH4
LL_TIM_OC_SetCompareCH4
LL_TIM_GetCounter
CNT
CNT
LL_TIM_SetCounter
LL_TIM_DisableARRPreload
ARPE
LL_TIM_EnableARRPreload
LL_TIM_IsEnabledARRPreload
LL_TIM_DisableCounter
CEN
LL_TIM_EnableCounter
LL_TIM_IsEnabledCounter
LL_TIM_GetClockDivision
CR1
CKD
LL_TIM_SetClockDivision
LL_TIM_GetCounterMode
CMS
LL_TIM_SetCounterMode
LL_TIM_GetCounterMode
DIR
LL_TIM_GetDirection
LL_TIM_SetCounterMode
1300/1320
DocID026525 Rev 6
UM1785
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_TIM_GetOnePulseMode
OPM
LL_TIM_SetOnePulseMode
LL_TIM_DisableUpdateEvent
UDIS
LL_TIM_EnableUpdateEvent
LL_TIM_IsEnabledUpdateEvent
LL_TIM_GetUpdateSource
URS
LL_TIM_SetUpdateSource
LL_TIM_CC_GetDMAReqTrigger
CCDS
LL_TIM_CC_SetDMAReqTrigger
LL_TIM_CC_DisablePreload
CCPC
LL_TIM_CC_EnablePreload
CCUS
LL_TIM_CC_SetUpdate
MMS
LL_TIM_SetTriggerOutput
LL_TIM_OC_ConfigOutput
OIS1
LL_TIM_OC_GetIdleState
LL_TIM_OC_SetIdleState
LL_TIM_OC_GetIdleState
OIS1N
LL_TIM_OC_SetIdleState
LL_TIM_OC_ConfigOutput
OIS2
LL_TIM_OC_GetIdleState
LL_TIM_OC_SetIdleState
CR2
LL_TIM_OC_GetIdleState
OIS2N
LL_TIM_OC_SetIdleState
LL_TIM_OC_ConfigOutput
OIS3
LL_TIM_OC_GetIdleState
LL_TIM_OC_SetIdleState
LL_TIM_OC_GetIdleState
OIS3N
LL_TIM_OC_SetIdleState
LL_TIM_OC_ConfigOutput
OIS4
LL_TIM_OC_GetIdleState
LL_TIM_OC_SetIdleState
LL_TIM_IC_DisableXORCombination
TI1S
LL_TIM_IC_EnableXORCombination
LL_TIM_IC_IsEnabledXORCombination
DBA
LL_TIM_ConfigDMABurst
DBL
LL_TIM_ConfigDMABurst
DCR
DocID026525 Rev 6
1301/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_TIM_DisableIT_BRK
BIE
LL_TIM_EnableIT_BRK
LL_TIM_IsEnabledIT_BRK
LL_TIM_DisableDMAReq_CC1
CC1DE
LL_TIM_EnableDMAReq_CC1
LL_TIM_IsEnabledDMAReq_CC1
LL_TIM_DisableIT_CC1
CC1IE
LL_TIM_EnableIT_CC1
LL_TIM_IsEnabledIT_CC1
LL_TIM_DisableDMAReq_CC2
CC2DE
LL_TIM_EnableDMAReq_CC2
LL_TIM_IsEnabledDMAReq_CC2
LL_TIM_DisableIT_CC2
CC2IE
LL_TIM_EnableIT_CC2
LL_TIM_IsEnabledIT_CC2
LL_TIM_DisableDMAReq_CC3
CC3DE
LL_TIM_EnableDMAReq_CC3
LL_TIM_IsEnabledDMAReq_CC3
DIER
LL_TIM_DisableIT_CC3
CC3IE
LL_TIM_EnableIT_CC3
LL_TIM_IsEnabledIT_CC3
LL_TIM_DisableDMAReq_CC4
CC4DE
LL_TIM_EnableDMAReq_CC4
LL_TIM_IsEnabledDMAReq_CC4
LL_TIM_DisableIT_CC4
CC4IE
LL_TIM_EnableIT_CC4
LL_TIM_IsEnabledIT_CC4
LL_TIM_DisableDMAReq_COM
COMDE
LL_TIM_EnableDMAReq_COM
LL_TIM_IsEnabledDMAReq_COM
LL_TIM_DisableIT_COM
COMIE
LL_TIM_EnableIT_COM
LL_TIM_IsEnabledIT_COM
LL_TIM_DisableDMAReq_TRIG
TDE
LL_TIM_EnableDMAReq_TRIG
LL_TIM_IsEnabledDMAReq_TRIG
1302/1320
DocID026525 Rev 6
UM1785
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_TIM_DisableIT_TRIG
TIE
LL_TIM_EnableIT_TRIG
LL_TIM_IsEnabledIT_TRIG
LL_TIM_DisableDMAReq_UPDATE
UDE
LL_TIM_EnableDMAReq_UPDATE
LL_TIM_IsEnabledDMAReq_UPDATE
LL_TIM_DisableIT_UPDATE
UIE
LL_TIM_EnableIT_UPDATE
LL_TIM_IsEnabledIT_UPDATE
BG
LL_TIM_GenerateEvent_BRK
CC1G
LL_TIM_GenerateEvent_CC1
CC2G
LL_TIM_GenerateEvent_CC2
CC3G
LL_TIM_GenerateEvent_CC3
CC4G
LL_TIM_GenerateEvent_CC4
COMG
LL_TIM_GenerateEvent_COM
TG
LL_TIM_GenerateEvent_TRIG
UG
LL_TIM_GenerateEvent_UPDATE
EGR
LL_TIM_GetPrescaler
PSC
PSC
LL_TIM_SetPrescaler
LL_TIM_GetRepetitionCounter
RCR
REP
LL_TIM_SetRepetitionCounter
LL_TIM_DisableExternalClock
LL_TIM_EnableExternalClock
ECE
LL_TIM_IsEnabledExternalClock
LL_TIM_SetClockSource
ETF
LL_TIM_ConfigETR
ETP
LL_TIM_ConfigETR
ETPS
LL_TIM_ConfigETR
LL_TIM_DisableMasterSlaveMode
SMCR
MSM
LL_TIM_EnableMasterSlaveMode
LL_TIM_IsEnabledMasterSlaveMode
OCCS
LL_TIM_SetOCRefClearInputSource
LL_TIM_SetClockSource
SMS
LL_TIM_SetEncoderMode
LL_TIM_SetSlaveMode
TS
LL_TIM_SetTriggerInput
DocID026525 Rev 6
1303/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
UM1785
Function
LL_TIM_ClearFlag_BRK
BIF
LL_TIM_IsActiveFlag_BRK
LL_TIM_ClearFlag_CC1
CC1IF
LL_TIM_IsActiveFlag_CC1
LL_TIM_ClearFlag_CC1OVR
CC1OF
LL_TIM_IsActiveFlag_CC1OVR
LL_TIM_ClearFlag_CC2
CC2IF
LL_TIM_IsActiveFlag_CC2
LL_TIM_ClearFlag_CC2OVR
CC2OF
LL_TIM_IsActiveFlag_CC2OVR
LL_TIM_ClearFlag_CC3
CC3IF
LL_TIM_IsActiveFlag_CC3
SR
LL_TIM_ClearFlag_CC3OVR
CC3OF
LL_TIM_IsActiveFlag_CC3OVR
LL_TIM_ClearFlag_CC4
CC4IF
LL_TIM_IsActiveFlag_CC4
LL_TIM_ClearFlag_CC4OVR
CC4OF
LL_TIM_IsActiveFlag_CC4OVR
LL_TIM_ClearFlag_COM
COMIF
LL_TIM_IsActiveFlag_COM
LL_TIM_ClearFlag_TRIG
TIF
LL_TIM_IsActiveFlag_TRIG
LL_TIM_ClearFlag_UPDATE
UIF
LL_TIM_IsActiveFlag_UPDATE
TIM14_OR
71.20
TI1_RMP
LL_TIM_SetRemap
USART
Table 44: Correspondence between USART registers and USART low-layer driver functions
Register
Field
BRR
BRR
Function
LL_USART_GetBaudRate
LL_USART_SetBaudRate
LL_USART_DisableIT_CM
CMIE
LL_USART_EnableIT_CM
LL_USART_IsEnabledIT_CM
CR1
LL_USART_GetDEAssertionTime
DEAT
1304/1320
LL_USART_SetDEAssertionTime
DocID026525 Rev 6
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_USART_GetDEDeassertionTime
DEDT
LL_USART_SetDEDeassertionTime
LL_USART_DisableIT_EOB
EOBIE
LL_USART_EnableIT_EOB
LL_USART_IsEnabledIT_EOB
LL_USART_DisableIT_IDLE
IDLEIE
LL_USART_EnableIT_IDLE
LL_USART_IsEnabledIT_IDLE
LL_USART_ConfigCharacter
M0
LL_USART_GetDataWidth
LL_USART_SetDataWidth
LL_USART_ConfigCharacter
M1
LL_USART_GetDataWidth
LL_USART_SetDataWidth
LL_USART_DisableMuteMode
MME
LL_USART_EnableMuteMode
LL_USART_IsEnabledMuteMode
LL_USART_GetOverSampling
OVER8
LL_USART_SetOverSampling
LL_USART_ConfigCharacter
PCE
LL_USART_GetParity
LL_USART_SetParity
LL_USART_DisableIT_PE
PEIE
LL_USART_EnableIT_PE
LL_USART_IsEnabledIT_PE
LL_USART_ConfigCharacter
PS
LL_USART_GetParity
LL_USART_SetParity
LL_USART_DisableDirectionRx
LL_USART_EnableDirectionRx
RE
LL_USART_GetTransferDirection
LL_USART_SetTransferDirection
LL_USART_DisableIT_RTO
RTOIE
LL_USART_EnableIT_RTO
LL_USART_IsEnabledIT_RTO
RXNEIE
LL_USART_DisableIT_RXNE
DocID026525 Rev 6
1305/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_USART_EnableIT_RXNE
LL_USART_IsEnabledIT_RXNE
LL_USART_DisableIT_TC
TCIE
LL_USART_EnableIT_TC
LL_USART_IsEnabledIT_TC
LL_USART_DisableDirectionTx
LL_USART_EnableDirectionTx
TE
LL_USART_GetTransferDirection
LL_USART_SetTransferDirection
LL_USART_DisableIT_TXE
TXEIE
LL_USART_EnableIT_TXE
LL_USART_IsEnabledIT_TXE
LL_USART_Disable
UE
LL_USART_Enable
LL_USART_IsEnabled
LL_USART_DisableInStopMode
UESM
LL_USART_EnableInStopMode
LL_USART_IsEnabledInStopMode
LL_USART_GetWakeUpMethod
WAKE
LL_USART_SetWakeUpMethod
LL_USART_DisableAutoBaudRate
ABREN
LL_USART_EnableAutoBaudRate
LL_USART_IsEnabledAutoBaud
LL_USART_GetAutoBaudRateMode
ABRMODE
LL_USART_SetAutoBaudRateMode
LL_USART_ConfigNodeAddress
ADD
LL_USART_GetNodeAddress
LL_USART_ConfigNodeAddress
CR2
ADDM7
LL_USART_GetNodeAddressLen
LL_USART_ConfigAsyncMode
LL_USART_ConfigHalfDuplexMode
LL_USART_ConfigIrdaMode
CLKEN
LL_USART_ConfigLINMode
LL_USART_ConfigMultiProcessMode
LL_USART_ConfigSmartcardMode
LL_USART_ConfigSyncMode
1306/1320
DocID026525 Rev 6
UM1785
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_USART_DisableSCLKOutput
LL_USART_EnableSCLKOutput
LL_USART_IsEnabledSCLKOutput
LL_USART_ConfigClock
CPHA
LL_USART_GetClockPhase
LL_USART_SetClockPhase
LL_USART_ConfigClock
CPOL
LL_USART_GetClockPolarity
LL_USART_SetClockPolarity
LL_USART_GetBinaryDataLogic
DATAINV
LL_USART_SetBinaryDataLogic
LL_USART_ConfigClock
LBCL
LL_USART_GetLastClkPulseOutput
LL_USART_SetLastClkPulseOutput
LL_USART_DisableIT_LBD
LBDIE
LL_USART_EnableIT_LBD
LL_USART_IsEnabledIT_LBD
LL_USART_GetLINBrkDetectionLen
LBDL
LL_USART_SetLINBrkDetectionLen
LL_USART_ConfigAsyncMode
LL_USART_ConfigHalfDuplexMode
LL_USART_ConfigIrdaMode
LL_USART_ConfigLINMode
LL_USART_ConfigMultiProcessMode
LINEN
LL_USART_ConfigSmartcardMode
LL_USART_ConfigSyncMode
LL_USART_DisableLIN
LL_USART_EnableLIN
LL_USART_IsEnabledLIN
LL_USART_GetTransferBitOrder
MSBFIRST
LL_USART_SetTransferBitOrder
LL_USART_DisableRxTimeout
RTOEN
LL_USART_EnableRxTimeout
LL_USART_IsEnabledRxTimeout
LL_USART_GetRXPinLevel
RXINV
LL_USART_SetRXPinLevel
DocID026525 Rev 6
1307/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_USART_ConfigCharacter
LL_USART_ConfigIrdaMode
LL_USART_ConfigLINMode
STOP
LL_USART_ConfigSmartcardMode
LL_USART_GetStopBitsLength
LL_USART_SetStopBitsLength
LL_USART_GetTXRXSwap
SWAP
LL_USART_SetTXRXSwap
LL_USART_GetTXPinLevel
TXINV
LL_USART_SetTXPinLevel
LL_USART_DisableCTSHWFlowCtrl
LL_USART_EnableCTSHWFlowCtrl
CTSE
LL_USART_GetHWFlowCtrl
LL_USART_SetHWFlowCtrl
LL_USART_DisableIT_CTS
CTSIE
LL_USART_EnableIT_CTS
LL_USART_IsEnabledIT_CTS
LL_USART_DisableDMADeactOnRxErr
DDRE
LL_USART_EnableDMADeactOnRxErr
LL_USART_IsEnabledDMADeactOnRxErr
LL_USART_DisableDEMode
DEM
LL_USART_EnableDEMode
LL_USART_IsEnabledDEMode
CR3
LL_USART_GetDESignalPolarity
DEP
LL_USART_SetDESignalPolarity
LL_USART_DisableDMAReq_RX
DMAR
LL_USART_EnableDMAReq_RX
LL_USART_IsEnabledDMAReq_RX
LL_USART_DisableDMAReq_TX
DMAT
LL_USART_EnableDMAReq_TX
LL_USART_IsEnabledDMAReq_TX
LL_USART_DisableIT_ERROR
EIE
LL_USART_EnableIT_ERROR
LL_USART_IsEnabledIT_ERROR
LL_USART_ConfigAsyncMode
HDSEL
1308/1320
LL_USART_ConfigHalfDuplexMode
DocID026525 Rev 6
UM1785
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_USART_ConfigIrdaMode
LL_USART_ConfigLINMode
LL_USART_ConfigMultiProcessMode
LL_USART_ConfigSmartcardMode
LL_USART_ConfigSyncMode
LL_USART_DisableHalfDuplex
LL_USART_EnableHalfDuplex
LL_USART_IsEnabledHalfDuplex
LL_USART_ConfigAsyncMode
LL_USART_ConfigHalfDuplexMode
LL_USART_ConfigIrdaMode
LL_USART_ConfigLINMode
IREN
LL_USART_ConfigMultiProcessMode
LL_USART_ConfigSyncMode
LL_USART_DisableIrda
LL_USART_EnableIrda
LL_USART_IsEnabledIrda
LL_USART_GetIrdaPowerMode
IRLP
LL_USART_SetIrdaPowerMode
LL_USART_DisableSmartcardNACK
NACK
LL_USART_EnableSmartcardNACK
LL_USART_IsEnabledSmartcardNACK
LL_USART_DisableOneBitSamp
ONEBIT
LL_USART_EnableOneBitSamp
LL_USART_IsEnabledOneBitSamp
LL_USART_DisableOverrunDetect
OVRDIS
LL_USART_EnableOverrunDetect
LL_USART_IsEnabledOverrunDetect
LL_USART_DisableRTSHWFlowCtrl
LL_USART_EnableRTSHWFlowCtrl
RTSE
LL_USART_GetHWFlowCtrl
LL_USART_SetHWFlowCtrl
LL_USART_GetSmartcardAutoRetryCount
SCARCNT
LL_USART_SetSmartcardAutoRetryCount
LL_USART_ConfigAsyncMode
SCEN
LL_USART_ConfigHalfDuplexMode
DocID026525 Rev 6
1309/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_USART_ConfigIrdaMode
LL_USART_ConfigLINMode
LL_USART_ConfigMultiProcessMode
LL_USART_ConfigSmartcardMode
LL_USART_ConfigSyncMode
LL_USART_DisableSmartcard
LL_USART_EnableSmartcard
LL_USART_IsEnabledSmartcard
LL_USART_DisableIT_WKUP
WUFIE
LL_USART_EnableIT_WKUP
LL_USART_IsEnabledIT_WKUP
LL_USART_GetWKUPType
WUS
LL_USART_SetWKUPType
LL_USART_GetSmartcardGuardTime
GT
LL_USART_SetSmartcardGuardTime
LL_USART_GetIrdaPrescaler
GTPR
LL_USART_GetSmartcardPrescaler
PSC
LL_USART_SetIrdaPrescaler
LL_USART_SetSmartcardPrescaler
CMCF
LL_USART_ClearFlag_CM
CTSCF
LL_USART_ClearFlag_nCTS
EOBCF
LL_USART_ClearFlag_EOB
FECF
LL_USART_ClearFlag_FE
IDLECF
LL_USART_ClearFlag_IDLE
LBDCF
LL_USART_ClearFlag_LBD
NCF
LL_USART_ClearFlag_NE
ORECF
LL_USART_ClearFlag_ORE
PECF
LL_USART_ClearFlag_PE
RTOCF
LL_USART_ClearFlag_RTO
TCCF
LL_USART_ClearFlag_TC
WUCF
LL_USART_ClearFlag_WKUP
ABRE
LL_USART_IsActiveFlag_ABRE
ABRF
LL_USART_IsActiveFlag_ABR
BUSY
LL_USART_IsActiveFlag_BUSY
CMF
LL_USART_IsActiveFlag_CM
CTS
LL_USART_IsActiveFlag_CTS
ICR
ISR
1310/1320
DocID026525 Rev 6
UM1785
UM1785
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
CTSIF
LL_USART_IsActiveFlag_nCTS
EOBF
LL_USART_IsActiveFlag_EOB
FE
LL_USART_IsActiveFlag_FE
IDLE
LL_USART_IsActiveFlag_IDLE
LBDF
LL_USART_IsActiveFlag_LBD
NF
LL_USART_IsActiveFlag_NE
ORE
LL_USART_IsActiveFlag_ORE
PE
LL_USART_IsActiveFlag_PE
REACK
LL_USART_IsActiveFlag_REACK
RTOF
LL_USART_IsActiveFlag_RTO
RWU
LL_USART_IsActiveFlag_RWU
RXNE
LL_USART_IsActiveFlag_RXNE
SBKF
LL_USART_IsActiveFlag_SBK
TC
LL_USART_IsActiveFlag_TC
TEACK
LL_USART_IsActiveFlag_TEACK
TXE
LL_USART_IsActiveFlag_TXE
WUF
LL_USART_IsActiveFlag_WKUP
LL_USART_DMA_GetRegAddr
RDR
RDR
LL_USART_ReceiveData8
LL_USART_ReceiveData9
RQR
ABRRQ
LL_USART_RequestAutoBaudRate
MMRQ
LL_USART_RequestEnterMuteMode
RXFRQ
LL_USART_RequestRxDataFlush
SBKRQ
LL_USART_RequestBreakSending
TXFRQ
LL_USART_RequestTxDataFlush
LL_USART_GetBlockLength
BLEN
RTOR
LL_USART_SetBlockLength
LL_USART_GetRxTimeout
RTO
LL_USART_SetRxTimeout
LL_USART_DMA_GetRegAddr
TDR
TDR
LL_USART_TransmitData8
LL_USART_TransmitData9
71.21
WWDG
Table 45: Correspondence between WWDG registers and WWDG low-layer driver functions
Register
Field
Function
DocID026525 Rev 6
1311/1320
Correspondence between API registers and API
low-layer driver functions
Register
Field
Function
LL_WWDG_EnableIT_EWKUP
EWI
LL_WWDG_IsEnabledIT_EWKUP
LL_WWDG_GetWindow
CFR
W
LL_WWDG_SetWindow
LL_WWDG_GetPrescaler
WDGTB
LL_WWDG_SetPrescaler
LL_WWDG_GetCounter
T
CR
LL_WWDG_SetCounter
LL_WWDG_Enable
WDGA
LL_WWDG_IsEnabled
LL_WWDG_ClearFlag_EWKUP
SR
EWIF
LL_WWDG_IsActiveFlag_EWKUP
1312/1320
DocID026525 Rev 6
UM1785
UM1785
72
FAQs
FAQs
General subjects
Why should I use the HAL drivers?
There are many advantages in using the HAL drivers:
Ease of use: you can use the HAL drivers to configure and control any peripheral
embedded within your STM32 MCU without prior in-depth knowledge of the product.
HAL drivers provide intuitive and ready-to-use APIs to configure the peripherals and
support polling, interrupt and DMA programming model to accommodate all
application requirements, thus allowing the end-user to build a complete application by
calling a few APIs.
Higher level of abstraction than a standard peripheral library allowing to transparently
manage:
Data transfers and processing using blocking mode (polling) or non-blocking
mode (interrupt or DMA)
Error management through peripheral error detection and timeout mechanism.
Generic architecture speeding up initialization and porting, thus allowing customers to
focus on innovation.
Generic set of APIs with full compatibility across the STM32 series/lines, to ease the
porting task between STM32 MCUs.
The APIs provided within the HAL drivers are feature-oriented and do not require indepth knowledge of peripheral operation.
The APIs provided are modular. They include initialization, IO operation and control
functions. The end-user has to call init function, then start the process by calling one
IO operation functions (write, read, transmit, receive, …). Most of the peripherals have
the same architecture.
The number of functions required to build a complete and useful application is very
reduced. As an example, to build a UART communication process, the user only has
to call HAL_UART_Init() then HAL_UART_Transmit() or HAL_UART_Receive().
Which STM32F0 devices are supported by the HAL drivers?
The HAL drivers are developed to support all STM32F0 devices. To ensure compatibility
between all devices and portability with others series and lines, the API is split into the
generic and the extension APIs . For more details, please refer to Section 2.4: "Devices
supported by HAL drivers".
What is the cost of using HAL drivers in term of code size and performance?
Like generic architecture drivers, the HAL drivers may induce firmware overhead.
This is due to the high abstraction level and ready-to-use APIs which allow data transfers,
errors management and offloads the user application from implementation details.
Architecture
How many files should I modify to configure the HAL drivers?
Only one file needs to be modified: stm32f0xx_hal_conf.h. You can modify this file by
disabling unused modules, or adjusting some parameters (i.e. HSE value, System
configuration, …)
DocID026525 Rev 6
1313/1320
FAQs
UM1785
A template is provided in the HAL driver folders (stm32f0xx_hal_conf_template.c).
Which header files should I include in my application to use the HAL drivers?
Only stm32f0xx_hal.h file has to be included.
What is the difference between stm32f0xx_hal_ppp.c/.h and
stm32f0xx_hal_ppp_ex.c/.h?
The HAL driver architecture supports common features across STM32 series/lines. To
support specific features, the drivers are split into two groups.
The generic APIs (stm32f0xx_hal_ppp.c): It includes the common set of APIs across
all the STM32 product lines
The extension APIs (stm32f0xx_hal_ppp_ex.c): It includes the specific APIs for
specific device part number or family.
Initialization and I/O operation functions
How do I configure the system clock?
Unlike the standard library, the system clock configuration is not performed in CMSIS
drivers file (system_stm32f0xx.c) but in the main user application by calling the two main
functions, HAL_RCC_OscConfig() and HAL_RCC_ClockConfig(). It can be modified in any
user application section.
What is the purpose of the PPP_HandleTypeDef *pHandle structure located
in each driver in addition to the Initialization structure
PPP_HandleTypeDef *pHandle is the main structure implemented in the HAL drivers. It
handles the peripheral configuration and registers, and embeds all the structures and
variables required to follow the peripheral device flow (pointer to buffer, Error code,
State,...)
However, this structure is not required to service peripherals such as GPIO, SYSTICK,
PWR, and RCC.
What is the purpose of HAL_PPP_MspInit() and HAL_PPP_MspDeInit()
functions?
These function are called within HAL_PPP_Init() and HAL_PPP_DeInit(), respectively.
They are used to perform the low level Initialization/de-initialization related to the additional
hardware resources (RCC, GPIO, NVIC and DMA).
These functions are declared in stm32f0xx_hal_msp.c. A template is provided in the HAL
driver folders (stm32f0xx_hal_msp_template.c).
When and how should I use callbacks functions (functions declared with the
attribute __weak)?
Use callback functions for the I/O operations used in DMA or interrupt mode. The PPP
process complete callbacks are called to inform the user about process completion in realtime event mode (interrupts).
The Errors callbacks are called when a processing error occurs in DMA or interrupt mode.
These callbacks are customized by the user to add user proprietary code. They can be
declared in the application. Note that the same process completion callbacks are used for
DMA and interrupt mode.
1314/1320
DocID026525 Rev 6
UM1785
FAQs
Is it mandatory to use HAL_Init() function at the beginning of the user
application?
It is mandatory to use HAL_Init() function to enable the system configuration (Prefetch,
Data instruction cache,…), configure the systTick and the NVIC priority grouping and the
hardware low level initialization.
The SysTick configuration shall be adjusted by calling HAL_RCC_ClockConfig() function,
to obtain 1 ms whatever the system clock.
Why do I need to configure the SysTick timer to use the HAL drivers?
The SysTick timer is configured to be used to generate variable increments by calling
HAL_IncTick() function in Systick ISR and retrieve the value of this variable by calling
HAL_GetTick() function.
The call HAL_GetTick() function is mandatory when using HAL drivers with Polling
Process or when using HAL_Delay().
Why is the SysTick timer configured to have 1 ms?
This is mandatory to ensure correct IO operation in particular for polling mode operation
where the 1 ms is required as timebase.
Could HAL_Delay() function block my application under certain conditions?
Care must be taken when using HAL_Delay() since this function provides accurate delay
based on a variable incremented in SysTick ISR. This implies that if HAL_Delay() is called
from a peripheral ISR process, then the SysTick interrupt must have higher priority
(numerically lower) than the peripheral interrupt, otherwise the caller ISR process will be
blocked. Use HAL_NVIC_SetPriority() function to change the SysTick interrupt priority.
What programming model sequence should I follow to use HAL drivers ?
Follow the sequence below to use the APIs provided in the HAL drivers:
1.
2.
3.
4.
5.
6.
Call HAL_Init() function to initialize the system (data cache, NVIC priority,…).
Initialize the system clock by calling HAL_RCC_OscConfig() followed by
HAL_RCC_ClockConfig().
Add HAL_IncTick() function under SysTick_Handler() ISR function to enable polling
process when using HAL_Delay() function
Start initializing your peripheral by calling HAL_PPP_Init().
Implement the hardware low level initialization (Peripheral clock, GPIO, DMA,..) by
calling HAL_PPP_MspInit() in stm32f0xx_hal_msp.c
Start your process operation by calling IO operation functions.
What is the purpose of HAL_PPP_IRQHandler() function and when should I
use it?
HAL_PPP_IRQHandler() is used to handle interrupt process. It is called under
PPP_IRQHandler() function in stm32f0xx_it.c. In this case, the end-user has to implement
only the callbacks functions (prefixed by __weak) to perform the appropriate action when
an interrupt is detected. Advanced users can implement their own code in
PPP_IRQHandler() without calling HAL_PPP_IRQHandler().
Can I use directly the macros defined in stm32f0xx_hal_ppp.h ?
Yes, you can: a set of macros is provided with the APIs. They allow accessing directly
some specific features using peripheral flags.
DocID026525 Rev 6
1315/1320
FAQs
UM1785
Where must PPP_HandleTypedef structure peripheral handler be declared?
PPP_HandleTypedef structure peripheral handler must be declared as a global variable, so
that all the structure fields are set to 0 by default. In this way, the peripheral handler default
state are set to HAL_PPP_STATE_RESET, which is the default state for each peripheral
after a system reset.
1316/1320
DocID026525 Rev 6
UM1785
73
Revision history
Revision history
Table 46: Document revision history
Date
Revision
15Oct2014
1
Initial release.
2
Macros and functions renamed for all APIs.
Updated common macros in Section 2.9: "HAL common resources".
Added LSE_STARTUP_TIMEOUT in Table 11: "Define statements used for
HAL configuration"
09Nov2015
Changes
DocID026525 Rev 6
1317/1320
Revision history
Date
UM1785
Revision
Changes
Changed GPIO_SPEED_LOW, GPIO_SPEED_MEDIUM, GPIO_SPEED_HIGH
into GPIO_SPEED_FREQ_LOW, GPIO_SPEED_FREQ_MEDIUM,
GPIO_SPEED_FREQ_HIGH in Section 2.11.2: "GPIOs".
Added low-layer driver APIs.
HAL CRC
Updated devices supporting Programmable Polynomial features:
defines and functions prototypes are available only for
STM32F071xB, STM32F072xB, STM32F078xx, STM32F091xC,
STM32F098x devices.
Updated HAL_CRC_DeInit() function (restored IDR Register to
Reset value).
HAL DMA
Added __HAL_DMA_GET_COUNTER() macro returning the
number of remaining data units in the current DMA Channel
transfer.
Provided new function HAL_DMA_Abort_IT() to abort current DMA
transfer under interrupt mode without polling for DMA enable bit.
Added __HAL_DMA_GET_GI_FLAG_INDEX macro returning
current DMA Channel Global interrupt flag
HAL FLASH
Suppress function FLASH_PageErase – become internal
HAL I2C
06Jun2016
3
Added support of repeated start feature in case of multimaster
mode (allow master to keep I2C communication with slave).
HAL PWR
Aligned EWUPx pins and PWR functions with CMSIS definitions.
HAL RCC
Added missing HAL IRQHandler and callbacks API for CRS
management.
Added missing RCC_CFGR_PLLNODIV definition for
STM32F030x4/6 devices.
Removed HSI48State from structure RCC_OscInitTypeDef when
device does not support HSI48.
Removed RCC_HSI48_OFF.
Removed flag RCC_FLAG_RMV which is write only.
Renamed RCC_CRS_SYNCWARM to RCC_CRS_SYNCWARN.
Renamed RCC_CRS_TRIMOV to RCC_CRS_TRIMOVF.
HAL SMARTCARD
Aligned SMARTCARD Stop Bits with others STM32 series.
HAL TIM
Updated HAL_TIM_ConfigOCrefClear() function to allow
TIM_CLEARINPUTSOURCE_OCREFCLR as new
ClearInputSource.
HAL UART-USART
Aligned UART-USART Stop Bits with others STM32 series.
1318/1320
DocID026525 Rev 6
UM1785
Revision history
Date
Revision
Changes
08Nov2016
4
Update for release V1.5.0 of the HAL and LL drivers. Refer to the release note
provided within the firmware package for details.
04May2017
5
Update for release V1.6.0 of the HAL and LL drivers. Refer to the release note
provided within the firmware package for details.
05Sep2017
6
Update for release V1.7.0 of the HAL and LL drivers. Refer to the release note
provided within the firmware package for details.
DocID026525 Rev 6
1319/1320
UM1785
IMPORTANT NOTICE – PLEASE READ CAREFULLY
STMicroelectronics NV and its subsidiaries (“ST”) reserve the right to make changes, corrections, enhancements, modifications, and
improvements to ST products and/or to this document at any time without notice. Purchasers should obtain the latest relevant information on ST
products before placing orders. ST products are sold pursuant to ST’s terms and conditions of sale in place at the time of order
acknowledgement.
Purchasers are solely responsible for the choice, selection, and use of ST products and ST assumes no liability for application assistance or the
design of Purchasers’ products.
No license, express or implied, to any intellectual property right is granted by ST herein.
Resale of ST products with provisions different from the information set forth herein shall void any warranty granted by ST for such product.
ST and the ST logo are trademarks of ST. All other product or service names are the property of their respective owners.
Information in this document supersedes and replaces information previously supplied in any prior versions of this document.
© 2017 STMicroelectronics – All rights reserved
1320/1320
DocID026525 Rev 6
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.3 Linearized : No Tagged PDF : Yes Language : en-US Page Layout : SinglePage Page Mode : UseNone Page Count : 1320 Creator : C2 v4.2.0220 build 670 - c2_rendition_config : Techlit_Active Producer : 䵩捲潳潦璮⁗潲搠㈰㬠浯摩晩敤⁵獩湧呥硴′⸱⸷礠ㅔ㍘ Title : Description of STM32F0 HAL and low-layer drivers Keywords : Technical Literature, 026525, Product Development, Specification, User manual, STM32CubeF0 Modify Date : 2017:09:18 11:59:50+02:00 Subject : - Author : STMICROELECTRONICS Create Date : 2017:09:05 14:19:44+02:00EXIF Metadata provided by EXIF.tools