UM1725

HAL UART Generic Driver

(UART_HandleTypeDef * huart)

Function Description

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

Function Name

HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver

(UART_HandleTypeDef * huart)

Function Description

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

Function Name

HAL_UART_StateTypeDef HAL_UART_GetState

(UART_HandleTypeDef * huart)

Function Description

Returns the UART state.

Parameters

huart: pointer to a UART_HandleTypeDef structure that

contains the configuration information for the specified UART

module.

Return values

HAL state

Function Name

uint32_t HAL_UART_GetError (UART_HandleTypeDef * huart)

Function Description

Return the UART error code.

Parameters

huart: : pointer to a UART_HandleTypeDef structure that

contains the configuration information for the specified UART.

Return values

UART Error Code

HAL UART Generic Driver

HAL_UART_ERROR_DMA

DMA transfer error

UART Exported Macros

__HAL_UART_RESET_HANDLE_STATE

Description:

Reset UART handle state.

Parameters:

__HANDLE__: specifies the UART

Handle. This parameter can be

UARTx where x: 1, 2, 3, 4, 5, 6, 7 or

8 to select the USART or UART

peripheral.

Return value:

None

__HAL_UART_FLUSH_DRREGISTER

Description:

Flushes the UART DR register.

Parameters:

__HANDLE__: specifies the UART

Handle.

__HAL_UART_GET_FLAG

Description:

Checks whether the specified UART

flag is set or not.

Parameters:

__HANDLE__: specifies the UART

Handle. This parameter can be

UARTx where x: 1, 2, 3, 4, 5, 6, 7 or

8 to select the USART or UART

peripheral.

__FLAG__: specifies the flag to

check. This parameter can be one of

the following values:

UART_FLAG_CTS: CTS

Change flag (not available for

UART4 and UART5)

UART_FLAG_LBD: LIN Break

detection flag

UART_FLAG_TXE: Transmit

data register empty flag

UART_FLAG_TC:

Transmission Complete flag

UART_FLAG_RXNE: Receive

data register not empty flag

UART_FLAG_IDLE: Idle Line

detection flag

UART_FLAG_ORE: Overrun

Error flag

UART_FLAG_NE: Noise Error

flag

UART_FLAG_FE: Framing

856/900

DOCID025834 Rev 2

UM1725

Error flag

UART_FLAG_PE: Parity Error

flag

Return value:

The: new state of __FLAG__ (TRUE

or FALSE).

__HAL_UART_CLEAR_FLAG

Description:

Clears the specified UART pending

flag.

Parameters:

__HANDLE__: specifies the UART

Handle. This parameter can be

UARTx where x: 1, 2, 3, 4, 5, 6, 7 or

8 to select the USART or UART

peripheral.

__FLAG__: specifies the flag to

check. This parameter can be any

combination of the following values:

UART_FLAG_CTS: CTS

Change flag (not available for

UART4 and UART5).

UART_FLAG_LBD: LIN Break

detection flag.

UART_FLAG_TC:

Transmission Complete flag.

UART_FLAG_RXNE: Receive

data register not empty flag.

Return value:

None

Notes:

PE (Parity error), FE (Framing error),

NE (Noise error), ORE (Overrun

error) and IDLE (Idle line detected)

flags are cleared by software

sequence: a read operation to

USART_SR register followed by a

read operation to USART_DR

register. RXNE flag can be also

cleared by a read to the USART_DR

register. TC flag can be also cleared

by software sequence: a read

operation to USART_SR register

followed by a write operation to

USART_DR register. TXE flag is

cleared only by a write to the

USART_DR register.

__HAL_UART_CLEAR_PEFLAG

Description:

Clear the UART PE pending flag.

DOCID025834 Rev 2

Parameters:

__HANDLE__: specifies the UART

Handle. This parameter can be

UARTx where x: 1, 2, 3, 4, 5, 6, 7 or

8 to select the USART or UART

peripheral.

Return value:

None

__HAL_UART_CLEAR_FEFLAG

Description:

Clear the UART FE pending flag.

Parameters:

__HANDLE__: specifies the UART

Handle. This parameter can be

UARTx where x: 1, 2, 3, 4, 5, 6, 7 or

8 to select the USART or UART

peripheral.

Return value:

None

__HAL_UART_CLEAR_NEFLAG

Description:

Clear the UART NE pending flag.

Parameters:

__HANDLE__: specifies the UART

Handle. This parameter can be

UARTx where x: 1, 2, 3, 4, 5, 6, 7 or

8 to select the USART or UART

peripheral.

Return value:

None

__HAL_UART_CLEAR_OREFLAG

Description:

Clear the UART ORE pending flag.

Parameters:

__HANDLE__: specifies the UART

Handle. This parameter can be

UARTx where x: 1, 2, 3, 4, 5, 6, 7 or

8 to select the USART or UART

peripheral.

Return value:

None

__HAL_UART_CLEAR_IDLEFLAG

Description:

Clear the UART IDLE pending flag.

Parameters:

__HANDLE__: specifies the UART

858/900

DOCID025834 Rev 2

UM1725

Handle. This parameter can be

UARTx where x: 1, 2, 3, 4, 5, 6, 7 or

8 to select the USART or UART

peripheral.

Return value:

None

UART_IT_MASK

Description:

Enable the specified UART interrupt.

Parameters:

__HANDLE__: specifies the UART

Handle. This parameter can be

UARTx where x: 1, 2, 3, 4, 5, 6, 7 or

8 to select the USART or UART

peripheral.

__INTERRUPT__: specifies the

UART interrupt source to enable.

This parameter can be one of the

following values:

UART_IT_CTS: CTS change

interrupt

UART_IT_LBD: LIN Break

detection interrupt

UART_IT_TXE: Transmit Data

Register empty interrupt

UART_IT_TC: Transmission

complete interrupt

UART_IT_RXNE: Receive Data

register not empty interrupt

UART_IT_IDLE: Idle line

detection interrupt

UART_IT_PE: Parity Error

interrupt

UART_IT_ERR: Error

interrupt(Frame error, noise

error, overrun error)

Return value:

None

__HAL_UART_ENABLE_IT

__HAL_UART_DISABLE_IT

Description:

Disable the specified UART

interrupt.

Parameters:

__HANDLE__: specifies the UART

Handle. This parameter can be

UARTx where x: 1, 2, 3, 4, 5, 6, 7 or

8 to select the USART or UART

peripheral.

__INTERRUPT__: specifies the

HAL UART Generic Driver

UART interrupt source to disable.

This parameter can be one of the

following values:

UART_IT_CTS: CTS change

interrupt

UART_IT_LBD: LIN Break

detection interrupt

UART_IT_TXE: Transmit Data

Register empty interrupt

UART_IT_TC: Transmission

complete interrupt

UART_IT_RXNE: Receive Data

register not empty interrupt

UART_IT_IDLE: Idle line

detection interrupt

UART_IT_PE: Parity Error

interrupt

UART_IT_ERR: Error

interrupt(Frame error, noise

error, overrun error)

Return value:

None

__HAL_UART_GET_IT_SOURCE

Description:

Checks whether the specified UART

interrupt has occurred or not.

Parameters:

__HANDLE__: specifies the UART

Handle. This parameter can be

UARTx where x: 1, 2, 3, 4, 5, 6, 7 or

8 to select the USART or UART

peripheral.

__IT__: specifies the UART interrupt

source to check. This parameter can

be one of the following values:

UART_IT_CTS: CTS change

interrupt (not available for

UART4 and UART5)

UART_IT_LBD: LIN Break

detection interrupt

UART_IT_TXE: Transmit Data

Register empty interrupt

UART_IT_TC: Transmission

complete interrupt

UART_IT_RXNE: Receive Data

register not empty interrupt

UART_IT_IDLE: Idle line

detection interrupt

USART_IT_ERR: Error interrupt

Return value:

The: new state of __IT__ (TRUE or

860/900

DOCID025834 Rev 2

FALSE).

__HAL_UART_HWCONTROL_CTS_ENABLE

Description:

Enable CTS flow control This macro

allows to enable CTS hardware flow

control for a given UART instance,

without need to call

Parameters:

__HANDLE__: specifies the UART

Handle. The Handle Instance can be

USART1, USART2 or LPUART.

Return value:

None

Notes:

As macro is expected to be used for

modifying CTS Hw flow control

feature activation, without need for

USART instance Deinit/Init, following

conditions for macro call should be

fulfilled : UART instance should have

already been initialised (through call

of HAL_UART_Init() )macro could

only be called when corresponding

UART instance is disabled (i.e

__HAL_UART_DISABLE(__HANDL

E__)) and should be followed by an

Enable macro (i.e

__HAL_UART_ENABLE(__HANDLE

__)).

__HAL_UART_HWCONTROL_CTS_DISABLE

Description:

Disable CTS flow control This macro

allows to disable CTS hardware flow

control for a given UART instance,

without need to call

Parameters:

__HANDLE__: specifies the UART

Handle. The Handle Instance can be

USART1, USART2 or LPUART.

Return value:

None

Notes:

As macro is expected to be used for

modifying CTS Hw flow control

feature activation, without need for

USART instance Deinit/Init, following

conditions for macro call should be

fulfilled : UART instance should have

already been initialised (through call

of HAL_UART_Init() )macro could

only be called when corresponding

UART instance is disabled (i.e

__HAL_UART_DISABLE(__HANDL

E__)) and should be followed by an

Enable macro (i.e

__HAL_UART_ENABLE(__HANDLE

__)).

__HAL_UART_HWCONTROL_RTS_ENABLE

Description:

Enable RTS flow control This macro

allows to enable RTS hardware flow

control for a given UART instance,

without need to call

Parameters:

__HANDLE__: specifies the UART

Handle. The Handle Instance can be

USART1, USART2 or LPUART.

Return value:

None

Notes:

As macro is expected to be used for

modifying RTS Hw flow control

feature activation, without need for

USART instance Deinit/Init, following

conditions for macro call should be

fulfilled : UART instance should have

already been initialised (through call

of HAL_UART_Init() )macro could

only be called when corresponding

UART instance is disabled (i.e