STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
USART Initialization and de-initialization functions

Initialization and Configuration functions. More...

Collaboration diagram for USART Initialization and de-initialization functions:

Functions

HAL_StatusTypeDef HAL_USART_Init (USART_HandleTypeDef *husart)
 Initialize the USART mode according to the specified parameters in the USART_InitTypeDef and initialize the associated handle.
 
HAL_StatusTypeDef HAL_USART_DeInit (USART_HandleTypeDef *husart)
 DeInitializes the USART peripheral.
 
void HAL_USART_MspInit (USART_HandleTypeDef *husart)
 USART MSP Init.
 
void HAL_USART_MspDeInit (USART_HandleTypeDef *husart)
 USART MSP DeInit.
 

Detailed Description

Initialization and Configuration functions.

  ==============================================================================
              ##### 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
      (++) Parity: If the parity is enabled, then the MSB bit of the data written
           in the data register is transmitted but is changed by the parity bit.
           Depending on the frame length defined by the M bit (8-bits or 9-bits),
           please refer to Reference manual for possible USART frame formats.
      (++) USART polarity
      (++) USART phase
      (++) USART LastBit
      (++) Receiver/transmitter modes

  [..]
    The HAL_USART_Init() function follows the USART  synchronous configuration
    procedures (details for the procedures are available in reference manual
    (RM0430 for STM32F4X3xx MCUs and RM0402 for STM32F412xx MCUs
     RM0383 for STM32F411xC/E MCUs and RM0401 for STM32F410xx MCUs
     RM0090 for STM32F4X5xx/STM32F4X7xx/STM32F429xx/STM32F439xx MCUs
     RM0390 for STM32F446xx MCUs and RM0386 for STM32F469xx/STM32F479xx MCUs)).

Function Documentation

◆ HAL_USART_Init()

HAL_StatusTypeDef HAL_USART_Init ( USART_HandleTypeDef * husart)

#include <stm32f4xx_hal_usart.h>

Initialize the USART mode according to the specified parameters in the USART_InitTypeDef and initialize the associated handle.

Parameters
husartPointer to a USART_HandleTypeDef structure that contains the configuration information for the specified USART module.
Return values
HALstatus

Definition at line 300 of file stm32f4xx_hal_usart.c.

References __HAL_USART_ENABLE, assert_param, __USART_HandleTypeDef::ErrorCode, HAL_ERROR, HAL_OK, HAL_UNLOCKED, HAL_USART_ERROR_NONE, HAL_USART_MspInit(), HAL_USART_STATE_BUSY, HAL_USART_STATE_READY, HAL_USART_STATE_RESET, __USART_HandleTypeDef::Instance, __USART_HandleTypeDef::Lock, __USART_HandleTypeDef::State, and USART_SetConfig().

◆ HAL_USART_DeInit()

HAL_StatusTypeDef HAL_USART_DeInit ( USART_HandleTypeDef * husart)

#include <stm32f4xx_hal_usart.h>

DeInitializes the USART peripheral.

Parameters
husartPointer to a USART_HandleTypeDef structure that contains the configuration information for the specified USART module.
Return values
HALstatus

Definition at line 359 of file stm32f4xx_hal_usart.c.

References __HAL_UNLOCK, __HAL_USART_DISABLE, assert_param, __USART_HandleTypeDef::ErrorCode, HAL_ERROR, HAL_OK, HAL_USART_ERROR_NONE, HAL_USART_MspDeInit(), HAL_USART_STATE_BUSY, HAL_USART_STATE_RESET, __USART_HandleTypeDef::Instance, and __USART_HandleTypeDef::State.

◆ HAL_USART_MspInit()

__weak void HAL_USART_MspInit ( USART_HandleTypeDef * husart)

#include <stm32f4xx_hal_usart.h>

USART MSP Init.

Parameters
husartPointer to a USART_HandleTypeDef structure that contains the configuration information for the specified USART module.
Return values
None

Definition at line 402 of file stm32f4xx_hal_usart.c.

References UNUSED.

Referenced by HAL_USART_Init().

◆ HAL_USART_MspDeInit()

__weak void HAL_USART_MspDeInit ( USART_HandleTypeDef * husart)

#include <stm32f4xx_hal_usart.h>

USART MSP DeInit.

Parameters
husartPointer to a USART_HandleTypeDef structure that contains the configuration information for the specified USART module.
Return values
None

Definition at line 417 of file stm32f4xx_hal_usart.c.

References UNUSED.

Referenced by HAL_USART_DeInit().