|
STM32L486xx HAL User Manual
|
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) |
| DeInitialize the USART peripheral. | |
| __weak void | HAL_USART_MspInit (USART_HandleTypeDef *husart) |
| Initialize the USART MSP. | |
| __weak void | HAL_USART_MspDeInit (USART_HandleTypeDef *husart) |
| DeInitialize the USART MSP. | |
| 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 UART Callback UART callaback is redirected to the weak predefined callback. | |
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.
(++) USART polarity
(++) USART phase
(++) USART LastBit
(++) Receiver/transmitter modes
[..]
The HAL_USART_Init() function follows the USART synchronous configuration
procedure (details for the procedure are available in reference manual).
Depending on the frame length defined by the M1 and M0 bits (7-bit, 8-bit or 9-bit), the possible USART formats are listed in the following table.
Table 1. USART frame format. +-----------------------------------------------------------------------+ | M1 bit | M0 bit | PCE bit | USART frame | |---------|---------|-----------|---------------------------------------| | 0 | 0 | 0 | | SB | 8 bit data | STB | | |---------|---------|-----------|---------------------------------------| | 0 | 0 | 1 | | SB | 7 bit data | PB | STB | | |---------|---------|-----------|---------------------------------------| | 0 | 1 | 0 | | SB | 9 bit data | STB | | |---------|---------|-----------|---------------------------------------| | 0 | 1 | 1 | | SB | 8 bit data | PB | STB | | |---------|---------|-----------|---------------------------------------| | 1 | 0 | 0 | | SB | 7 bit data | STB | | |---------|---------|-----------|---------------------------------------| | 1 | 0 | 1 | | SB | 6 bit data | PB | STB | | +-----------------------------------------------------------------------+
| HAL_StatusTypeDef HAL_USART_DeInit | ( | USART_HandleTypeDef * | husart | ) |
DeInitialize the USART peripheral.
| husart | USART handle. |
| HAL | status |
Definition at line 362 of file stm32l4xx_hal_usart.c.
References 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.
| husart | USART handle. |
| HAL | status |
Definition at line 301 of file stm32l4xx_hal_usart.c.
References __HAL_USART_DISABLE, __HAL_USART_ENABLE, assert_param, HAL_USART_MspInit(), HAL_USART_STATE_BUSY, HAL_USART_STATE_RESET, __USART_HandleTypeDef::Instance, __USART_HandleTypeDef::Lock, __USART_HandleTypeDef::MspInitCallback, __USART_HandleTypeDef::State, USART_CheckIdleState(), USART_InitCallbacksToDefault(), and USART_SetConfig().
| void HAL_USART_MspDeInit | ( | USART_HandleTypeDef * | husart | ) |
DeInitialize the USART MSP.
| husart | USART handle. |
| None |
Definition at line 420 of file stm32l4xx_hal_usart.c.
Referenced by HAL_USART_DeInit(), and HAL_USART_UnRegisterCallback().
| void HAL_USART_MspInit | ( | USART_HandleTypeDef * | husart | ) |
Initialize the USART MSP.
| husart | USART handle. |
| None |
Definition at line 405 of file stm32l4xx_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.
| husart | usart handle |
| CallbackID | ID of the callback to be registered This parameter can be one of the following values:
|
| pCallback | pointer to the Callback function |
| HAL | status + |
Definition at line 451 of file stm32l4xx_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 UART Callback UART callaback is redirected to the weak predefined callback.
| husart | uart handle |
| CallbackID | ID of the callback to be unregistered This parameter can be one of the following values:
|
| HAL | status |
Definition at line 579 of file stm32l4xx_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.
1.7.6.1