Description of STM32F4 HAL and LL drivers.pdf

STM32Cube

is STMicroelectronics's original initiative to ease developers' life by reducing

development efforts, time and cost. STM32Cube

covers the STM32 portfolio.

STM32Cube

Version 1.x includes:

 The STM32CubeMX, a graphical software configuration tool that allows generating C initialization

code using graphical wizards.

 A comprehensive embedded software platform, delivered per series (such as STM32CubeF4 for

 All embedded software utilities coming 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). It is composed of generic

and extension APIs. It is directly built around a generic architecture and allows the built-upon layers,

such as the middleware layer, to implement their functions without knowing in-depth how to use the

MCU. This structure improves the library code reusability and guarantees easy portability to other

devices.

The HAL drivers include a complete set of ready-to-use APIs which simplify the user application

implementation. As an example, the communication peripherals contain APIs to initialize and configure

the peripheral, to manage data transfers based on polling, to handle interrupts or DMA, and to manage

(PWM), and so on.

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. Run-time 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 FSMC, USB, SDMMC).

The HAL and LL 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.

The source code of drivers is developed in Strict ANSI-C, which makes it independent from the

development tools. It is checked with CodeSonar

the given API to build your application.

Contents

2.2.3 Specific process structures .............................................................. 41

2.3 API classification ............................................................................. 41

2.4 Devices supported by HAL drivers .................................................. 42

2.5 HAL driver rules .............................................................................. 47

2.5.1 HAL API naming rules ...................................................................... 47

2.5.2 HAL general naming rules ................................................................ 48

2.5.3 HAL interrupt handler and callback functions ................................... 49

2.6 HAL generic APIs ............................................................................ 49

2.7 HAL extension APIs ........................................................................ 51

2.7.1 HAL extension model overview ........................................................ 51

2.11.2 GPIOs ............................................................................................... 57

2.11.3 Cortex NVIC and SysTick timer ........................................................ 58

2.11.4 PWR ................................................................................................. 59

2.11.5 EXTI .................................................................................................. 59

2.11.6 DMA .................................................................................................. 60

2.12 How to use HAL drivers .................................................................. 61

2.12.1 HAL usage models ........................................................................... 61

2.12.2 HAL initialization ............................................................................... 62

2.12.3 HAL IO operation process ................................................................ 64

2.12.4 Timeout and error management ....................................................... 67

4.1 Low Layer driver used in standalone mode ..................................... 80

4.2 Mixed use of Low Layer APIs and HAL drivers ............................... 80

5.1 HAL Firmware driver API description .............................................. 81

5.1.1 How to use this driver ....................................................................... 81

5.1.2 Initialization and de-initialization functions ....................................... 81

5.1.3 HAL Control functions....................................................................... 81

5.1.4 Detailed description of functions ...................................................... 82

5.2 HAL Firmware driver defines ........................................................... 86

6.1.4 ADC_HandleTypeDef ....................................................................... 91

6.2 ADC Firmware driver API description .............................................. 92

6.2.1 ADC Peripheral features................................................................... 92

6.2.2 How to use this driver ....................................................................... 92

6.2.3 Initialization and de-initialization functions ....................................... 94

6.2.4 IO operation functions ...................................................................... 95

6.2.5 Peripheral Control functions ............................................................. 95

6.2.6 Peripheral State and errors functions ............................................... 95

6.2.7 Detailed description of functions ...................................................... 96

6.3 ADC Firmware driver defines ........................................................ 101

8.1 CAN Firmware driver registers structures ..................................... 117