In the earlier guide on led blink with STM32F401RE Nucleo-64 board we used a HAL function that toggled one of the pin of the board. The program and coding was done using the STM32Cube IDE. The STM32F401RE Nucleo-64 board is a popular development platform based on the STM32F401RE microcontroller, which is part of the STM32F4 series. It provides a wide range of peripherals and features, and developers often use Hardware Abstraction Layer (HAL) libraries provided by STMicroelectronics to interact with these peripherals(GPIO,ADC,USART,Timer,I2C,SPI etc). The HAL library simplifies low-level hardware access by providing a consistent API for various peripherals. These functions are alike to Arduino functions like Arduino uses digitalWrite() and the corresponding HAL function would be HAL_GPIO_WritePin(). So it would be easier to learn STM32 programming by learning the HAL functions first and use and test them for each peripheral. So I wanted to list all the important and regularly required HAL functions and what they do.
Below are list of common HAL functions used for interacting with peripherals on the STM32F401RE Nucleo-64 board:
1. GPIO (General Purpose Input/Output)
HAL_GPIO_Init(): Initializes GPIO pins.HAL_GPIO_WritePin(): Sets or resets a pin's output state. Example:LED blink with STM32 Nucleo-64 board with Hal read write functionsHAL_GPIO_ReadPin(): Reads the input state of a pin. Example: Read Button with STM32 Nucleo-64HAL_GPIO_TogglePin(): Toggles the output state of a pin. See example STM32 Nucleo Led Blink Tutorial with Proteus SimulationHAL_GPIO_EXTI_IRQHandler(): STM32 programming example of handles external interrupt events.HAL_GPIO_EXTI_Callback(): STM32 programming example of user-defined callback for external interrupts.
2. UART (Universal Asynchronous Receiver Transmitter)
HAL_UART_Init(): STM32 programming example of Initializes UART communication.HAL_UART_Transmit():STM32 programming example of Sends data over UART.HAL_UART_Receive(): STM32 programming example of Receives data over UART.HAL_UART_Transmit_IT(): STM32 programming example of Sends data using interrupt-driven mode.HAL_UART_Receive_IT(): STM32 programming example of Receives data using interrupt-driven mode.HAL_UART_Transmit_DMA(): STM32 programming example of Sends data using DMA.HAL_UART_Receive_DMA():STM32 programming example of Receives data using DMA.HAL_UART_ErrorCallback(): STM32 programming example of Callback for UART errors.
3. SPI (Serial Peripheral Interface)
HAL_SPI_Init(): STM32 programming example of Initializes SPI communication.HAL_SPI_Transmit(): STM32 programming example of Sends data over SPI.HAL_SPI_Receive(): STM32 programming example of Receives data over SPI.HAL_SPI_TransmitReceive(): STM32 programming example of Simultaneously sends and receives data over SPI.HAL_SPI_Transmit_IT(): STM32 programming example of Sends data using interrupt-driven mode.HAL_SPI_Receive_IT(): STM32 programming example of Receives data using interrupt-driven mode.HAL_SPI_Transmit_DMA(): STM32 programming example of Sends data using DMA.HAL_SPI_Receive_DMA(): STM32 programming example of Receives data using DMA.HAL_SPI_ErrorCallback(): STM32 programming example of Callback for SPI errors.
4. I2C (Inter-Integrated Circuit)
HAL_I2C_Init(): Initializes I2C communication.HAL_I2C_Master_Transmit(): Sends data as an I2C master.HAL_I2C_Master_Receive(): Receives data as an I2C master.HAL_I2C_Slave_Transmit(): Sends data as an I2C slave.HAL_I2C_Slave_Receive(): Receives data as an I2C slave.HAL_I2C_Mem_Write(): Writes data to a specific memory address on the I2C device.HAL_I2C_Mem_Read(): Reads data from a specific memory address on the I2C device.HAL_I2C_ErrorCallback(): Callback for I2C errors.
5. TIM (Timer)
HAL_TIM_Base_Init(): Initializes a basic timer.HAL_TIM_PWM_Init(): Initializes PWM generation.HAL_TIM_PWM_Start(): Starts PWM signal generation.HAL_TIM_PWM_Stop(): Stops PWM signal generation.HAL_TIM_Encoder_Init(): Initializes an encoder interface.HAL_TIM_IC_Init(): Initializes input capture mode.HAL_TIM_OC_Init(): Initializes output compare mode.HAL_TIM_PeriodElapsedCallback(): Callback for timer period elapsed events.
6. ADC (Analog-to-Digital Converter)
HAL_ADC_Init(): Initializes the ADC peripheral.HAL_ADC_Start(): Starts ADC conversion.HAL_ADC_Stop(): Stops ADC conversion.HAL_ADC_PollForConversion(): Polls for ADC conversion completion.HAL_ADC_GetValue(): Retrieves the converted ADC value.HAL_ADC_Start_IT(): Starts ADC conversion in interrupt mode.HAL_ADC_ConvCpltCallback(): Callback for ADC conversion complete events.
7. DAC (Digital-to-Analog Converter)
HAL_DAC_Init(): Initializes the DAC peripheral.HAL_DAC_Start(): Starts DAC conversion.HAL_DAC_Stop(): Stops DAC conversion.HAL_DAC_SetValue(): Sets the output value of the DAC.HAL_DAC_Start_DMA(): Starts DAC conversion using DMA.
8. RTC (Real-Time Clock)
HAL_RTC_Init(): Initializes the RTC peripheral.HAL_RTC_SetTime(): Sets the RTC time.HAL_RTC_GetTime(): Retrieves the current RTC time.HAL_RTC_SetDate(): Sets the RTC date.HAL_RTC_GetDate(): Retrieves the current RTC date.HAL_RTC_Alarm_IRQHandler(): Handles RTC alarm interrupts.
9. DMA (Direct Memory Access)
HAL_DMA_Init(): Initializes the DMA peripheral.HAL_DMA_Start(): Starts DMA transfer.HAL_DMA_Abort(): Aborts ongoing DMA transfer.HAL_DMA_PollForTransfer(): Polls for DMA transfer completion.HAL_DMA_IRQHandler(): Handles DMA interrupts.
10. SYSTICK (System Tick Timer)
HAL_SYSTICK_Config(): Configures the system tick timer.HAL_SYSTICK_CLKSourceConfig(): Configures the clock source for the system tick timer.HAL_SYSTICK_Callback(): Callback for system tick events.
11. EXTI (External Interrupt)
HAL_NVIC_SetPriority(): Sets the priority of an interrupt.HAL_NVIC_EnableIRQ(): Enables an interrupt.HAL_NVIC_DisableIRQ(): Disables an interrupt.HAL_EXTI_Callback(): User-defined callback for external interrupt events.
12. FLASH
HAL_FLASH_Unlock(): Unlocks the FLASH control register.HAL_FLASH_Lock(): Locks the FLASH control register.HAL_FLASH_Program(): Programs data into FLASH memory.HAL_FLASH_OB_Unlock(): Unlocks the option bytes.HAL_FLASH_OB_Lock(): Locks the option bytes.
13. CRC (Cyclic Redundancy Check)
HAL_CRC_Init(): Initializes the CRC peripheral.HAL_CRC_Calculate(): Calculates the CRC value of a data buffer.
14. RCC (Reset and Clock Control)
HAL_RCC_OscConfig(): Configures the oscillator.HAL_RCC_ClockConfig(): Configures the system clock.HAL_RCC_GetClockConfig(): Retrieves the current clock configuration.
15. PWR (Power Control)
HAL_PWR_EnterSLEEPMode(): Enters sleep mode.HAL_PWR_EnterSTOPMode(): Enters stop mode.HAL_PWR_EnterSTANDBYMode(): Enters standby mode.
These are some of the most commonly used HAL functions for the STM32F401RE Nucleo-64 board. The HAL library provides a consistent and easy-to-use interface for interacting with the microcontroller's peripherals, making it easier for developers to focus on application logic rather than low-level hardware details.
