Hal Drivers for L4

Dependents:   BSP OneHopeOnePrayer FINAL_AUDIO_RECORD AudioDemo

Fork of STM32L4xx_HAL_Driver by Senior Design: Sound Monitor

Embed: (wiki syntax)

« Back to documentation index

Peripheral Control functions

Peripheral Control functions
[UART Exported Functions]

UART control functions. More...

Functions

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_MultiProcessor_EnableMuteMode() API enables mute mode
     (+) HAL_MultiProcessor_DisableMuteMode() API disables mute mode
     (+) HAL_MultiProcessor_EnterMuteMode() API enters mute mode
     (+) HAL_MultiProcessor_EnableMuteMode() API enables 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
     (+) UART_Wakeup_AddressConfig() API configures the wake-up from stop mode parameters
     (+) 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:
HALstatus.

Definition at line 1371 of file stm32l4xx_hal_uart.c.

HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter ( UART_HandleTypeDef *  huart )

Enable the UART transmitter and disable the UART receiver.

Parameters:
huart,:UART handle.
Return values:
HALstatus

Definition at line 1347 of file stm32l4xx_hal_uart.c.

HAL_StatusTypeDef HAL_LIN_SendBreak ( UART_HandleTypeDef *  huart )

Transmit break characters.

Parameters:
huart,:UART handle.
Return values:
HALstatus

Definition at line 1395 of file stm32l4xx_hal_uart.c.

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:
HALstatus

Definition at line 1316 of file stm32l4xx_hal_uart.c.

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:
HALstatus

Definition at line 1295 of file stm32l4xx_hal_uart.c.

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