Peripheral Control functions

UART control functions. More...

Functions
HAL_StatusTypeDef	HAL_LIN_SendBreak (UART_HandleTypeDef *huart)
	Transmit break characters. More...
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). More...
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). More...
void	HAL_MultiProcessor_EnterMuteMode (UART_HandleTypeDef *huart)
	Enter UART mute mode (means UART actually enters mute mode). More...
HAL_StatusTypeDef	HAL_HalfDuplex_EnableTransmitter (UART_HandleTypeDef *huart)
	Enable the UART transmitter and disable the UART receiver. More...
HAL_StatusTypeDef	HAL_HalfDuplex_EnableReceiver (UART_HandleTypeDef *huart)
	Enable the UART receiver and disable the UART transmitter. More...

Detailed Description

UART control functions.

 ===============================================================================
                      ##### Peripheral Control functions #####
 ===============================================================================
    [..]
    This subsection provides a set of functions allowing to control the UART.
     (+) 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_HalfDuplex_EnableReceiver()

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 2719 of file stm32l4xx_hal_uart.c.

{
  __HAL_LOCK(huart);
  huart->gState = HAL_UART_STATE_BUSY;

  /* Clear TE and RE bits */
  CLEAR_BIT(huart->Instance->CR1, (USART_CR1_TE | USART_CR1_RE));

  /* Enable the USART's receive interface by setting the RE bit in the USART CR1 register */
  SET_BIT(huart->Instance->CR1, USART_CR1_RE);

  huart->gState = HAL_UART_STATE_READY;

  __HAL_UNLOCK(huart);

  return HAL_OK;
}

HAL_HalfDuplex_EnableTransmitter()

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 2696 of file stm32l4xx_hal_uart.c.

{
  __HAL_LOCK(huart);
  huart->gState = HAL_UART_STATE_BUSY;

  /* Clear TE and RE bits */
  CLEAR_BIT(huart->Instance->CR1, (USART_CR1_TE | USART_CR1_RE));

  /* Enable the USART's transmit interface by setting the TE bit in the USART CR1 register */
  SET_BIT(huart->Instance->CR1, USART_CR1_TE);

  huart->gState = HAL_UART_STATE_READY;

  __HAL_UNLOCK(huart);

  return HAL_OK;
}

HAL_LIN_SendBreak()

HAL_StatusTypeDef HAL_LIN_SendBreak

(

UART_HandleTypeDef *

huart

)

Transmit break characters.

Parameters

huart

UART handle.

Return values

HAL

status

Definition at line 2743 of file stm32l4xx_hal_uart.c.

{
  /* Check the parameters */
  assert_param(IS_UART_LIN_INSTANCE(huart->Instance));

  __HAL_LOCK(huart);

  huart->gState = HAL_UART_STATE_BUSY;

  /* Send break characters */
  __HAL_UART_SEND_REQ(huart, UART_SENDBREAK_REQUEST);

  huart->gState = HAL_UART_STATE_READY;

  __HAL_UNLOCK(huart);

  return HAL_OK;
}

HAL_MultiProcessor_DisableMuteMode()

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 2666 of file stm32l4xx_hal_uart.c.

{
  __HAL_LOCK(huart);

  huart->gState = HAL_UART_STATE_BUSY;

  /* Disable USART mute mode by clearing the MME bit in the CR1 register */
  CLEAR_BIT(huart->Instance->CR1, USART_CR1_MME);

  huart->gState = HAL_UART_STATE_READY;

  return (UART_CheckIdleState(huart));
}

HAL_MultiProcessor_EnableMuteMode()

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 2646 of file stm32l4xx_hal_uart.c.

{
  __HAL_LOCK(huart);

  huart->gState = HAL_UART_STATE_BUSY;

  /* Enable USART mute mode by setting the MME bit in the CR1 register */
  SET_BIT(huart->Instance->CR1, USART_CR1_MME);

  huart->gState = HAL_UART_STATE_READY;

  return (UART_CheckIdleState(huart));
}

HAL_MultiProcessor_EnterMuteMode()

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 2686 of file stm32l4xx_hal_uart.c.

{
  __HAL_UART_SEND_REQ(huart, UART_MUTE_MODE_REQUEST);
}