USART Initialization and de-initialization functions

Initialization and Configuration functions. More...

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.
__weak void	HAL_USART_MspInit (USART_HandleTypeDef *husart)
	USART MSP Init.
__weak void	HAL_USART_MspDeInit (USART_HandleTypeDef *husart)
	USART MSP DeInit.
HAL_StatusTypeDef	HAL_USART_RegisterCallback (USART_HandleTypeDef *husart, HAL_USART_CallbackIDTypeDef CallbackID, pUSART_CallbackTypeDef pCallback)
	Register a User USART Callback To be used instead of the weak predefined callback.
HAL_StatusTypeDef	HAL_USART_UnRegisterCallback (USART_HandleTypeDef *husart, HAL_USART_CallbackIDTypeDef CallbackID)
	Unregister an USART Callback USART callaback is redirected to the weak predefined callback.

---

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 manuals
    (RM0008 for STM32F10Xxx MCUs and RM0041 for STM32F100xx MCUs)).

---

Function Documentation

HAL_StatusTypeDef HAL_USART_DeInit

(

USART_HandleTypeDef *

husart

)

DeInitializes the USART peripheral.

Parameters:

husart

Pointer to a USART_HandleTypeDef structure that contains the configuration information for the specified USART module.

Return values:

HAL

status

Definition at line 354 of file stm32f1xx_hal_usart.c.

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

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.

Parameters:

husart

Pointer to a USART_HandleTypeDef structure that contains the configuration information for the specified USART module.

Return values:

HAL

status

Definition at line 295 of file stm32f1xx_hal_usart.c.

References __HAL_USART_ENABLE, assert_param, __USART_HandleTypeDef::ErrorCode, 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::MspInitCallback, __USART_HandleTypeDef::State, USART_InitCallbacksToDefault(), and USART_SetConfig().

void HAL_USART_MspDeInit

(

USART_HandleTypeDef *

husart

)

USART MSP DeInit.

Parameters:

husart

Pointer to a USART_HandleTypeDef structure that contains the configuration information for the specified USART module.

Return values:

None

Definition at line 412 of file stm32f1xx_hal_usart.c.

Referenced by HAL_USART_DeInit(), and HAL_USART_UnRegisterCallback().

void HAL_USART_MspInit

(

USART_HandleTypeDef *

husart

)

USART MSP Init.

Parameters:

husart

Pointer to a USART_HandleTypeDef structure that contains the configuration information for the specified USART module.

Return values:

None

Definition at line 397 of file stm32f1xx_hal_usart.c.

Referenced by HAL_USART_Init(), and HAL_USART_UnRegisterCallback().

HAL_StatusTypeDef HAL_USART_RegisterCallback	(	USART_HandleTypeDef *	husart,
		HAL_USART_CallbackIDTypeDef	CallbackID,
		pUSART_CallbackTypeDef	pCallback
	)

Register a User USART Callback To be used instead of the weak predefined callback.

Parameters:

husart	usart handle
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_USART_TX_HALFCOMPLETE_CB_ID Tx Half Complete Callback ID HAL_USART_TX_COMPLETE_CB_ID Tx Complete Callback ID HAL_USART_RX_HALFCOMPLETE_CB_ID Rx Half Complete Callback ID HAL_USART_RX_COMPLETE_CB_ID Rx Complete Callback ID HAL_USART_TX_RX_COMPLETE_CB_ID Rx Complete Callback ID HAL_USART_ERROR_CB_ID Error Callback ID HAL_USART_ABORT_COMPLETE_CB_ID Abort Complete Callback ID HAL_USART_MSPINIT_CB_ID MspInit Callback ID HAL_USART_MSPDEINIT_CB_ID MspDeInit Callback ID
pCallback	pointer to the Callback function

Return values:

HAL

status +

Definition at line 440 of file stm32f1xx_hal_usart.c.

References __USART_HandleTypeDef::AbortCpltCallback, __USART_HandleTypeDef::ErrorCallback, __USART_HandleTypeDef::ErrorCode, HAL_USART_ABORT_COMPLETE_CB_ID, HAL_USART_ERROR_CB_ID, HAL_USART_ERROR_INVALID_CALLBACK, HAL_USART_MSPDEINIT_CB_ID, HAL_USART_MSPINIT_CB_ID, HAL_USART_RX_COMPLETE_CB_ID, HAL_USART_RX_HALFCOMPLETE_CB_ID, HAL_USART_STATE_READY, HAL_USART_STATE_RESET, HAL_USART_TX_COMPLETE_CB_ID, HAL_USART_TX_HALFCOMPLETE_CB_ID, HAL_USART_TX_RX_COMPLETE_CB_ID, __USART_HandleTypeDef::MspDeInitCallback, __USART_HandleTypeDef::MspInitCallback, __USART_HandleTypeDef::RxCpltCallback, __USART_HandleTypeDef::RxHalfCpltCallback, __USART_HandleTypeDef::State, __USART_HandleTypeDef::TxCpltCallback, __USART_HandleTypeDef::TxHalfCpltCallback, and __USART_HandleTypeDef::TxRxCpltCallback.

HAL_StatusTypeDef HAL_USART_UnRegisterCallback	(	USART_HandleTypeDef *	husart,
		HAL_USART_CallbackIDTypeDef	CallbackID
	)

Unregister an USART Callback USART callaback is redirected to the weak predefined callback.

Parameters:

husart

usart handle

CallbackID

ID of the callback to be unregistered This parameter can be one of the following values: HAL_USART_TX_HALFCOMPLETE_CB_ID Tx Half Complete Callback ID HAL_USART_TX_COMPLETE_CB_ID Tx Complete Callback ID HAL_USART_RX_HALFCOMPLETE_CB_ID Rx Half Complete Callback ID HAL_USART_RX_COMPLETE_CB_ID Rx Complete Callback ID HAL_USART_TX_RX_COMPLETE_CB_ID Rx Complete Callback ID HAL_USART_ERROR_CB_ID Error Callback ID HAL_USART_ABORT_COMPLETE_CB_ID Abort Complete Callback ID HAL_USART_MSPINIT_CB_ID MspInit Callback ID HAL_USART_MSPDEINIT_CB_ID MspDeInit Callback ID

Return values:

HAL

status

Definition at line 556 of file stm32f1xx_hal_usart.c.

References __USART_HandleTypeDef::AbortCpltCallback, __USART_HandleTypeDef::ErrorCallback, __USART_HandleTypeDef::ErrorCode, HAL_USART_ABORT_COMPLETE_CB_ID, HAL_USART_AbortCpltCallback(), HAL_USART_ERROR_CB_ID, HAL_USART_ERROR_INVALID_CALLBACK, HAL_USART_ErrorCallback(), HAL_USART_MspDeInit(), HAL_USART_MSPDEINIT_CB_ID, HAL_USART_MspInit(), HAL_USART_MSPINIT_CB_ID, HAL_USART_RX_COMPLETE_CB_ID, HAL_USART_RX_HALFCOMPLETE_CB_ID, HAL_USART_RxCpltCallback(), HAL_USART_RxHalfCpltCallback(), HAL_USART_STATE_READY, HAL_USART_STATE_RESET, HAL_USART_TX_COMPLETE_CB_ID, HAL_USART_TX_HALFCOMPLETE_CB_ID, HAL_USART_TX_RX_COMPLETE_CB_ID, HAL_USART_TxCpltCallback(), HAL_USART_TxHalfCpltCallback(), HAL_USART_TxRxCpltCallback(), __USART_HandleTypeDef::MspDeInitCallback, __USART_HandleTypeDef::MspInitCallback, __USART_HandleTypeDef::RxCpltCallback, __USART_HandleTypeDef::RxHalfCpltCallback, __USART_HandleTypeDef::State, __USART_HandleTypeDef::TxCpltCallback, __USART_HandleTypeDef::TxHalfCpltCallback, and __USART_HandleTypeDef::TxRxCpltCallback.