Peripheral Control functions

UART control functions. More...

Collaboration diagram for Peripheral Control functions:

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_LIN_SendBreak()

HAL_StatusTypeDef HAL_LIN_SendBreak

(

UART_HandleTypeDef *

huart

)

#include <stm32f4xx_hal_uart.h>

Transmits break characters.

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 2753 of file stm32f4xx_hal_uart.c.

References __HAL_LOCK, __HAL_UNLOCK, assert_param, __UART_HandleTypeDef::gState, HAL_OK, HAL_UART_STATE_BUSY, HAL_UART_STATE_READY, and __UART_HandleTypeDef::Instance.

HAL_MultiProcessor_EnterMuteMode()

HAL_StatusTypeDef HAL_MultiProcessor_EnterMuteMode

(

UART_HandleTypeDef *

huart

)

#include <stm32f4xx_hal_uart.h>

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

HAL

status

Definition at line 2780 of file stm32f4xx_hal_uart.c.

References __HAL_LOCK, __HAL_UNLOCK, assert_param, __UART_HandleTypeDef::gState, HAL_OK, HAL_UART_RXEVENT_TC, HAL_UART_STATE_BUSY, HAL_UART_STATE_READY, __UART_HandleTypeDef::Instance, and __UART_HandleTypeDef::RxEventType.

HAL_MultiProcessor_ExitMuteMode()

HAL_StatusTypeDef HAL_MultiProcessor_ExitMuteMode

(

UART_HandleTypeDef *

huart

)

#include <stm32f4xx_hal_uart.h>

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

HAL

status

Definition at line 2808 of file stm32f4xx_hal_uart.c.

References __HAL_LOCK, __HAL_UNLOCK, assert_param, __UART_HandleTypeDef::gState, HAL_OK, HAL_UART_RXEVENT_TC, HAL_UART_STATE_BUSY, HAL_UART_STATE_READY, __UART_HandleTypeDef::Instance, and __UART_HandleTypeDef::RxEventType.

HAL_HalfDuplex_EnableTransmitter()

HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter

(

UART_HandleTypeDef *

huart

)

#include <stm32f4xx_hal_uart.h>

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

HAL

status

Definition at line 2836 of file stm32f4xx_hal_uart.c.

References __HAL_LOCK, __HAL_UNLOCK, __UART_HandleTypeDef::gState, HAL_OK, HAL_UART_STATE_BUSY, HAL_UART_STATE_READY, and __UART_HandleTypeDef::Instance.

HAL_HalfDuplex_EnableReceiver()

HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver

(

UART_HandleTypeDef *

huart

)

#include <stm32f4xx_hal_uart.h>

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

HAL

status

Definition at line 2871 of file stm32f4xx_hal_uart.c.

References __HAL_LOCK, __HAL_UNLOCK, __UART_HandleTypeDef::gState, HAL_OK, HAL_UART_STATE_BUSY, HAL_UART_STATE_READY, and __UART_HandleTypeDef::Instance.