STM32G0 HAL库详解：2000+页深度解析

版权申诉

5星 · 超过95%的资源 153 浏览量更新于2024-07-20 1 收藏 13.91MB PDF 举报

"STM32Cube是STMicroelectronics推出的一项创新举措，旨在通过减少开发工作量、时间和成本，显著提升开发者的产品开发效率。该框架涵盖了STM32系列的所有产品。STM32Cube主要包含以下组件： 1. STM32CubeMX：这是一个图形化的软件配置工具，用户可以通过图形向导生成C语言初始化代码，极大地简化了项目设置过程。 2. 丰富的嵌入式软件平台，按系列提供（如STM32CubeG0针对STM32G0系列）： - STM32CubeHAL：这是一个抽象层软件，确保在整个STM32产品系列间实现最大化的移植性。HAL驱动提供了所有外设的API接口，这些API通用且易于使用。 - Low-layer (LL) API：提供了一个快速、轻量级的专家导向层，它比HAL更接近硬件。LL API仅对一部分外设可用，适合需要更底层控制的专家使用。 - 一致性的一组中间件组件，包括FAT文件系统、RTOS（实时操作系统）、USB和USB PD，这些中间件为应用程序开发提供了丰富的功能支持。 - 全套的嵌入式软件实用程序，附带大量示例代码，帮助开发者快速上手。 STM32CubeHAL驱动层提供了一组简单、通用、多实例的API，用于与上层应用、库和栈进行交互。这些API设计得直观易用，使得开发者可以专注于应用逻辑，而不是底层硬件细节。 STM32G0系列是STM32家族中的一员，其HAL库为开发者提供了全面的支持，无论是在初始化配置、外设操作，还是在系统级的集成上，都大大降低了开发难度，提高了开发效率。同时，低层API的提供，使得在性能和灵活性之间取得了平衡，满足了不同层次开发者的需求。 STM32CubeMX和STM32CubeHAL的组合，为开发者提供了一站式的开发环境，从硬件配置到软件编写，都提供了强大而全面的工具支持，确保了STM32G0系列在各种应用场景中的高效利用。"

IP/module

STM32G0C1xx

STM32G0B1xx

STM32G0B0xx

STM32G081xx

STM32G071xx

STM32G070xx

STM32G061xx

STM32G051xx

STM32G050xx

STM32G041xx

STM32G031xx

STM32G030xx

stm32g0xx_hal_rcc.c Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

stm32g0xx_hal_rcc_ex.c Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

stm32g0xx_hal_rng.c Yes No No Yes No No Yes No No Yes No No

stm32g0xx_hal_rtc.c Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

stm32g0xx_hal_rtc_ex.c Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

stm32g0xx_hal_smartcard.c Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

stm32g0xx_hal_smartcard_ex.c Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

stm32g0xx_hal_smbus.c Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

stm32g0xx_hal_spi.c Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

stm32g0xx_hal_spi_ex.c Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

stm32g0xx_hal_tim.c Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

stm32g0xx_hal_tim_ex.c Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

stm32g0xx_hal_uart.c Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

stm32g0xx_hal_uart_ex.c Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

stm32g0xx_hal_usart.c Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

stm32g0xx_hal_usart_ex.c Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

stm32g0xx_hal_wwdg.c Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

UM2319

Devices supported by HAL drivers

UM2319 - Rev 2

page 16/2202

3.5 HAL driver rules

3.5.1 HAL API naming rules

The following naming rules are used in HAL drivers:

Table 6. HAL API naming rules

Generic Family specific Device specific

File names stm32g0xx_hal_ppp (c/h) stm32g0xx_hal_ppp_ex (c/h) stm32g0xx_ 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_MODE

HAL_PPPEx_Function

HAL_PPPEx_FeatureFunction_MODE

Handle

name

PPP_HandleTypedef NA NA

Init

structure

name

PPP_InitTypeDef NA PPP_InitTypeDef

Enum name HAL_PPP_StructnameTypeDef NA NA

• The PPP prefix refers to the peripheral functional mode and not to the peripheral itself. For example, if the

USAR

T, 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 STM32G0 reference manuals.

• Peripheral registers are declared in the PPP_TypeDef structure (for example ADC_TypeDef) in

stm32g0xxx.h header file:

stm32g0xxx.h corresponds to stm32g081xx.h, stm32g071xx.h and stm32g070xx.h.

• Peripheral function names are prefixed by HAL_, then the corresponding peripheral acronym in uppercase

followed by an underscore. The first letter of each word is in uppercase (for example

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 (for

example ADC_InitTypeDef).

• The structure containing the Specific configuration parameters for the PPP peripheral are named

PPP_xxxxConfTypeDef (for example 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 (for example HAL_TIM_Init()).

• The functions used to reset the PPP peripheral registers to their default values are named HAL_PPP_DeInit

(for example HAL_TIM_DeInit()).

• The MODE suffix refers to the process mode, which can be polling, interrupt or DMA. As an example, when

the DMA is used in addition to the native resources, the function should be called:

HAL_PPP_Function_DMA().

• The Feature prefix should refer to the new feature.

Example: HAL_ADCEx_InjectedStart()() refers to the injection mode.

UM2319

HAL driver rules

UM2319 - Rev 2

page 17/2202

3.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:

Note: 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 stm32g0xx_hal_cortex.c file.

• When a status bit or a flag is read from registers, it is composed of shifted values depending on the number

of read values and of their size. In this case, the returned status width is 32 bits. Example:

STATUS = XX | (YY << 16) or STATUS = XX | (YY << 8) | (YY << 16) | (YY << 24).

• The PPP handles are valid before using the HAL_PPP_Init() API. The init function performs a check before

modifying the handle fields.

HAL_PPP_Init(PPP_HandleTypeDef)

if(hppp == NULL)

{

return HAL_ERROR;

}

UM2319

HAL driver rules

UM2319 - Rev 2

page 18/2202

• 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)

3.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 stm32g0xx_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()

Example: HAL_USART_MspInit()

Called from HAL_PPP_Init() API function to perform peripheral system level initialization

(GPIOs, clock, DMA, interrupt)

HAL_PPP_ProcessCpltCallback

Example: HAL_USART_TxCpltCallback

Called by peripheral or DMA interrupt handler when the process completes

HAL_PPP_ErrorCallback

Example: HAL_USART_ErrorCallback

Called by peripheral or DMA interrupt handler when an error occurs

3.6 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_W

rite(),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 (such as PWM, OC and 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.

UM2319

HAL generic APIs

UM2319 - Rev 2

page 19/2202

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 run time 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.

able 9. HAL generic APIs

Function group Common API name Description

Initialization group

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.

IO operation group

HAL_ADC_Start ()

This function starts ADC conversions when the polling method is

used

HAL_ADC_Stop ()

This function stops ADC conversions when the polling method is

used

HAL_ADC_PollForConversion()

This function allows waiting for the end of conversions when the

polling

method is used. In this case, a timout value is specified by

the user according to the application.

HAL_ADC_Start_IT()

This function starts ADC conversions when the interrupt method is

used

HAL_ADC_Stop_IT()

This function stops ADC conversions when the interrupt method is

used

HAL_ADC_IRQHandler() This function handles ADC interrupt requests

HAL_ADC_ConvCpltCallback()

Callback function called in the IT subroutine to indicate the end of

the current process or when a DMA transfer has completed

HAL_ADC_ErrorCallback()

Callback function called in the IT subroutine if a peripheral error or a

DMA transfer error occurred

Control group

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

State and Errors

group

HAL_ADC_GetState()

This function allows getting in run time the peripheral and the data

flow states.

HAL_ADC_GetError()

This fuction allows getting in run time the error that occurred during

IT routine

3.7 HAL extension APIs

3.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, stm32g0xx_hal_ppp_ex.c, that includes all the specific

functions and define statements (stm32g0xx_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

UM2319

HAL extension APIs

UM2319 - Rev 2

page 20/2202

剩余2201页未读，继续阅读

嘣！嘣嘣嘣嘣！

粉丝: 0
资源: 2

STM32G0 HAL库详解：2000+页深度解析

UM2570_STM32G4的HAL和LL驱动程序介绍 - 用户手册.pdf

stm32g0b.zip

UM2570_STM32G4的HAL和LL驱动程序介绍20201105.pdf

STM32G4 HAL和低层驱动器的描述.pdf

UM2303_介绍STM32CubeG0的用户手册_ENV4_20190402.pdf STM32G0xx系列固件库驱动库软件开发包使用说明英文

UM2321_STM32CubeG0示范固件用户手册_ENV2_20190421.pdf STM32G0xx系列固件库驱动库软件开发包使用说明英文

从STM32G4系列的STM32CubeG4开始的用户手册_ENV2_20201118.pdf STM32G4xx系列固件库驱动库软件开发包使用说明英文

AN5315_STM32G4系列的STM32Cube固件示例.pdf

STM32G0 cube例程

MyProject_STM32G030C8T6.zip

最新资源