UART control functions. More...

Functions
void	HAL_UART_ReceiverTimeout_Config (UART_HandleTypeDef *huart, uint32_t TimeoutValue)
	Update on the fly the receiver timeout value in RTOR register.
HAL_StatusTypeDef	HAL_UART_EnableReceiverTimeout (UART_HandleTypeDef *huart)
	Enable the UART receiver timeout feature.
HAL_StatusTypeDef	HAL_UART_DisableReceiverTimeout (UART_HandleTypeDef *huart)
	Disable the UART receiver timeout feature.
HAL_StatusTypeDef	HAL_MultiProcessor_EnableMuteMode (UART_HandleTypeDef *huart)
	Enable UART in mute mode (does not mean UART enters mute mode; to enter mute mode, HAL_MultiProcessor_EnterMuteMode() API must be called).
HAL_StatusTypeDef	HAL_MultiProcessor_DisableMuteMode (UART_HandleTypeDef *huart)
	Disable UART mute mode (does not mean the UART actually exits mute mode as it may not have been in mute mode at this very moment).
void	HAL_MultiProcessor_EnterMuteMode (UART_HandleTypeDef *huart)
	Enter UART mute mode (means UART actually enters mute mode).
HAL_StatusTypeDef	HAL_HalfDuplex_EnableTransmitter (UART_HandleTypeDef *huart)
	Enable the UART transmitter and disable the UART receiver.
HAL_StatusTypeDef	HAL_HalfDuplex_EnableReceiver (UART_HandleTypeDef *huart)
	Enable the UART receiver and disable the UART transmitter.
HAL_StatusTypeDef	HAL_LIN_SendBreak (UART_HandleTypeDef *huart)
	Transmit break characters.

Detailed Description

UART control functions.

 ===============================================================================
                      ##### Peripheral Control functions #####
 ===============================================================================
    [..]
    This subsection provides a set of functions allowing to control the UART.
     (+) HAL_UART_ReceiverTimeout_Config() API allows to configure the receiver timeout value on the fly
     (+) HAL_UART_EnableReceiverTimeout() API enables the receiver timeout feature
     (+) HAL_UART_DisableReceiverTimeout() API disables the receiver timeout feature
     (+) HAL_MultiProcessor_EnableMuteMode() API enables mute mode
     (+) HAL_MultiProcessor_DisableMuteMode() API disables mute mode
     (+) HAL_MultiProcessor_EnterMuteMode() API enters mute mode
     (+) UART_SetConfig() API configures the UART peripheral
     (+) UART_AdvFeatureConfig() API optionally configures the UART advanced features
     (+) UART_CheckIdleState() API ensures that TEACK and/or REACK are set after initialization
     (+) HAL_HalfDuplex_EnableTransmitter() API disables receiver and enables transmitter
     (+) HAL_HalfDuplex_EnableReceiver() API disables transmitter and enables receiver
     (+) HAL_LIN_SendBreak() API transmits the break characters

Function Documentation

HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver ( UART_HandleTypeDef * huart )

Enable the UART receiver and disable the UART transmitter.

Parameters:

huart UART handle.

Return values:

HAL status.

Definition at line 3013 of file stm32l4xx_hal_uart.c.

References __UART_HandleTypeDef::gState, HAL_UART_STATE_BUSY, HAL_UART_STATE_READY, and __UART_HandleTypeDef::Instance.

HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter ( UART_HandleTypeDef * huart )

Enable the UART transmitter and disable the UART receiver.

Parameters:

huart UART handle.

Return values:

HAL status

Definition at line 2990 of file stm32l4xx_hal_uart.c.

References __UART_HandleTypeDef::gState, HAL_UART_STATE_BUSY, HAL_UART_STATE_READY, and __UART_HandleTypeDef::Instance.

HAL_StatusTypeDef HAL_LIN_SendBreak ( UART_HandleTypeDef * huart )

Transmit break characters.

Parameters:

huart UART handle.

Return values:

HAL status

Definition at line 3037 of file stm32l4xx_hal_uart.c.

References __HAL_UART_SEND_REQ, assert_param, __UART_HandleTypeDef::gState, HAL_UART_STATE_BUSY, HAL_UART_STATE_READY, __UART_HandleTypeDef::Instance, and UART_SENDBREAK_REQUEST.

HAL_StatusTypeDef HAL_MultiProcessor_DisableMuteMode ( UART_HandleTypeDef * huart )

Disable UART mute mode (does not mean the UART actually exits mute mode as it may not have been in mute mode at this very moment).

Parameters:

huart UART handle.

Return values:

HAL status

Definition at line 2960 of file stm32l4xx_hal_uart.c.

References __UART_HandleTypeDef::gState, HAL_UART_STATE_BUSY, HAL_UART_STATE_READY, __UART_HandleTypeDef::Instance, and UART_CheckIdleState().

HAL_StatusTypeDef HAL_MultiProcessor_EnableMuteMode ( UART_HandleTypeDef * huart )

Enable UART in mute mode (does not mean UART enters mute mode; to enter mute mode, HAL_MultiProcessor_EnterMuteMode() API must be called).

Parameters:

huart UART handle.

Return values:

HAL status

Definition at line 2940 of file stm32l4xx_hal_uart.c.

References __UART_HandleTypeDef::gState, HAL_UART_STATE_BUSY, HAL_UART_STATE_READY, __UART_HandleTypeDef::Instance, and UART_CheckIdleState().

void HAL_MultiProcessor_EnterMuteMode ( UART_HandleTypeDef * huart )

Enter UART mute mode (means UART actually enters mute mode).

Note:: To exit from mute mode, HAL_MultiProcessor_DisableMuteMode() API must be called.

Parameters:

huart UART handle.

Return values:

None

Definition at line 2980 of file stm32l4xx_hal_uart.c.

References __HAL_UART_SEND_REQ, and UART_MUTE_MODE_REQUEST.

HAL_StatusTypeDef HAL_UART_DisableReceiverTimeout ( UART_HandleTypeDef * huart )

Disable the UART receiver timeout feature.

Parameters:

huart Pointer to a UART_HandleTypeDef structure that contains the configuration information for the specified UART module.

Return values:

HAL status

Definition at line 2902 of file stm32l4xx_hal_uart.c.

References __UART_HandleTypeDef::gState, HAL_UART_STATE_BUSY, HAL_UART_STATE_READY, and __UART_HandleTypeDef::Instance.

HAL_StatusTypeDef HAL_UART_EnableReceiverTimeout ( UART_HandleTypeDef * huart )

Enable the UART receiver timeout feature.

Parameters:

huart Pointer to a UART_HandleTypeDef structure that contains the configuration information for the specified UART module.

Return values:

HAL status

Definition at line 2864 of file stm32l4xx_hal_uart.c.

References __UART_HandleTypeDef::gState, HAL_UART_STATE_BUSY, HAL_UART_STATE_READY, and __UART_HandleTypeDef::Instance.

void HAL_UART_ReceiverTimeout_Config	(	UART_HandleTypeDef *	huart,
		uint32_t	TimeoutValue
	)

Update on the fly the receiver timeout value in RTOR register.

Parameters:

huart	Pointer to a UART_HandleTypeDef structure that contains the configuration information for the specified UART module.
TimeoutValue	receiver timeout value in number of baud blocks. The timeout value must be less or equal to 0x0FFFFFFFF.

Return values:

None

Definition at line 2849 of file stm32l4xx_hal_uart.c.

References assert_param, __UART_HandleTypeDef::Instance, and IS_UART_RECEIVER_TIMEOUT_VALUE.

Functions

Detailed Description

Function Documentation