Arrow / Mbed OS DAPLink Reset
Embed: (wiki syntax)

« Back to documentation index

Peripheral Control functions

Peripheral Control functions
[UART Exported Functions]

UART control functions. More...

Functions

HAL_StatusTypeDef HAL_LIN_SendBreak (UART_HandleTypeDef *huart)
 Transmits break characters.
HAL_StatusTypeDef HAL_MultiProcessor_EnterMuteMode (UART_HandleTypeDef *huart)
 Enters the UART in mute mode.
HAL_StatusTypeDef HAL_MultiProcessor_ExitMuteMode (UART_HandleTypeDef *huart)
 Exits the UART mute mode: wake up software.
HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter (UART_HandleTypeDef *huart)
 Enables the UART transmitter and disables the UART receiver.
HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver (UART_HandleTypeDef *huart)
 Enables the UART receiver and disables the UART transmitter.

Detailed Description

UART control functions.

  ==============================================================================
                      ##### Peripheral Control functions #####
  ==============================================================================  
  [..]
    This subsection provides a set of functions allowing to control the UART:
    (+) HAL_LIN_SendBreak() API can be helpful to transmit the break character.
    (+) HAL_MultiProcessor_EnterMuteMode() API can be helpful to enter the UART in mute mode. 
    (+) HAL_MultiProcessor_ExitMuteMode() API can be helpful to exit the UART mute mode by software.
    (+) HAL_HalfDuplex_EnableTransmitter() API to enable the UART transmitter and disables the UART receiver in Half Duplex mode
    (+) HAL_HalfDuplex_EnableReceiver() API to enable the UART receiver and disables the UART transmitter in Half Duplex mode
    

Function Documentation

HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver ( UART_HandleTypeDef *  huart )

Enables the UART receiver and disables the UART transmitter.

Parameters:
huart,:Pointer to a UART_HandleTypeDef structure that contains the configuration information for the specified UART module.
Return values:
HALstatus

Definition at line 1470 of file stm32f1xx_hal_uart.c.

HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter ( UART_HandleTypeDef *  huart )

Enables the UART transmitter and disables the UART receiver.

Parameters:
huart,:Pointer to a UART_HandleTypeDef structure that contains the configuration information for the specified UART module.
Return values:
HALstatus

Definition at line 1444 of file stm32f1xx_hal_uart.c.

HAL_StatusTypeDef HAL_LIN_SendBreak ( UART_HandleTypeDef *  huart )

Transmits break characters.

Parameters:
huart,:Pointer to a UART_HandleTypeDef structure that contains the configuration information for the specified UART module.
Return values:
HALstatus

Definition at line 1363 of file stm32f1xx_hal_uart.c.

HAL_StatusTypeDef HAL_MultiProcessor_EnterMuteMode ( UART_HandleTypeDef *  huart )

Enters the UART in mute mode.

Parameters:
huart,:Pointer to a UART_HandleTypeDef structure that contains the configuration information for the specified UART module.
Return values:
HALstatus

Definition at line 1390 of file stm32f1xx_hal_uart.c.

HAL_StatusTypeDef HAL_MultiProcessor_ExitMuteMode ( UART_HandleTypeDef *  huart )

Exits the UART mute mode: wake up software.

Parameters:
huart,:Pointer to a UART_HandleTypeDef structure that contains the configuration information for the specified UART module.
Return values:
HALstatus

Definition at line 1417 of file stm32f1xx_hal_uart.c.