USART Exported Macros

Macros
#define	__HAL_USART_RESET_HANDLE_STATE(__HANDLE__)   ((__HANDLE__)->State = HAL_USART_STATE_RESET)
	Reset USART handle state. More...
#define	__HAL_USART_GET_FLAG(__HANDLE__, __FLAG__)   (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
	Checks whether the specified USART flag is set or not. More...
#define	__HAL_USART_ENABLE_IT(__HANDLE__, __INTERRUPT__)
	Enables the specified USART interrupt. More...
#define	__HAL_USART_DISABLE_IT(__HANDLE__, __INTERRUPT__)
	Disables the specified USART interrupt. More...
#define	__HAL_USART_GET_IT(__HANDLE__, __IT__)   ((__HANDLE__)->Instance->ISR & ((uint32_t)1 << ((__IT__)>> 0x08)))
	Checks whether the specified USART interrupt has occurred or not. More...
#define	__HAL_USART_GET_IT_SOURCE(__HANDLE__, __IT__)
	Checks whether the specified USART interrupt source is enabled. More...
#define	__HAL_USART_CLEAR_IT(__HANDLE__, __IT_CLEAR__)   ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
	Clears the specified USART ISR flag, in setting the proper ICR register flag. More...
#define	__HAL_USART_SEND_REQ(__HANDLE__, __REQ__)   ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
	Set a specific USART request flag. More...
#define	__HAL_USART_ENABLE(__HANDLE__)    ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
	Enable USART. More...
#define	__HAL_USART_DISABLE(__HANDLE__)    ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
	Disable USART. More...

Detailed Description

Macro Definition Documentation

#define __HAL_USART_CLEAR_IT	(		__HANDLE__,
			__IT_CLEAR__
	)		((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))

Clears the specified USART ISR flag, in setting the proper ICR register flag.

Parameters

<strong>HANDLE</strong>

specifies the USART Handle.

<strong>IT_CLEAR</strong>

specifies the interrupt clear register flag that needs to be set to clear the corresponding interrupt This parameter can be one of the following values: USART_CLEAR_PEF: Parity Error Clear Flag USART_CLEAR_FEF: Framing Error Clear Flag USART_CLEAR_NEF: Noise detected Clear Flag USART_CLEAR_OREF: OverRun Error Clear Flag USART_CLEAR_IDLEF: IDLE line detected Clear Flag USART_CLEAR_TCF: Transmission Complete Clear Flag USART_CLEAR_CTSF: CTS Interrupt Clear Flag

Return values

None

Definition at line 451 of file stm32f7xx_hal_usart.h.

#define __HAL_USART_DISABLE

(

__HANDLE__

)

((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)

Disable USART.

Parameters

<strong>HANDLE</strong>

specifies the USART Handle.

Return values

None

Definition at line 474 of file stm32f7xx_hal_usart.h.

#define __HAL_USART_DISABLE_IT	(		__HANDLE__,
			__INTERRUPT__
	)

Value:

(((((uint8_t)(__INTERRUPT__)) >> 5U) == 1)? ((__HANDLE__)->Instance->CR1 &= ~ (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
                                                            ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2)? ((__HANDLE__)->Instance->CR2 &= ~ (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
                                                            ((__HANDLE__)->Instance->CR3 &= ~ (1U << ((__INTERRUPT__) & USART_IT_MASK))))

Disables the specified USART interrupt.

Parameters

<strong>HANDLE</strong>

specifies the USART Handle.

<strong>INTERRUPT</strong>

specifies the USART interrupt source to disable. This parameter can be one of the following values: USART_IT_TXE: Transmit Data Register empty interrupt USART_IT_TC: Transmission complete interrupt USART_IT_RXNE: Receive Data register not empty interrupt USART_IT_IDLE: Idle line detection interrupt USART_IT_PE: Parity Error interrupt USART_IT_ERR: Error interrupt(Frame error, noise error, overrun error)

Return values

None

Definition at line 397 of file stm32f7xx_hal_usart.h.

#define __HAL_USART_ENABLE

(

__HANDLE__

)

((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)

Enable USART.

Parameters

<strong>HANDLE</strong>

specifies the USART Handle.

Return values

None

Definition at line 468 of file stm32f7xx_hal_usart.h.

#define __HAL_USART_ENABLE_IT	(		__HANDLE__,
			__INTERRUPT__
	)

Value:

(((((uint8_t)(__INTERRUPT__)) >> 5U) == 1)? ((__HANDLE__)->Instance->CR1 |= (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
                                                            ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2)? ((__HANDLE__)->Instance->CR2 |= (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
                                                            ((__HANDLE__)->Instance->CR3 |= (1U << ((__INTERRUPT__) & USART_IT_MASK))))

Enables the specified USART interrupt.

Parameters

<strong>HANDLE</strong>

specifies the USART Handle

<strong>INTERRUPT</strong>

specifies the USART interrupt source to enable. This parameter can be one of the following values: USART_IT_TXE: Transmit Data Register empty interrupt USART_IT_TC: Transmission complete interrupt USART_IT_RXNE: Receive Data register not empty interrupt USART_IT_IDLE: Idle line detection interrupt USART_IT_PE: Parity Error interrupt USART_IT_ERR: Error interrupt(Frame error, noise error, overrun error)

Return values

None

Definition at line 381 of file stm32f7xx_hal_usart.h.

#define __HAL_USART_GET_FLAG	(		__HANDLE__,
			__FLAG__
	)		(((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))

Checks whether the specified USART flag is set or not.

Parameters

<strong>HANDLE</strong>

specifies the USART Handle

<strong>FLAG</strong>

specifies the flag to check. This parameter can be one of the following values: USART_FLAG_REACK: Receive enable acknowledge flag USART_FLAG_TEACK: Transmit enable acknowledge flag USART_FLAG_BUSY: Busy flag USART_FLAG_CTS: CTS Change flag USART_FLAG_TXE: Transmit data register empty flag USART_FLAG_TC: Transmission Complete flag USART_FLAG_RXNE: Receive data register not empty flag USART_FLAG_IDLE: Idle Line detection flag USART_FLAG_ORE: OverRun Error flag USART_FLAG_NE: Noise Error flag USART_FLAG_FE: Framing Error flag USART_FLAG_PE: Parity Error flag

Return values

The	new state of FLAG (TRUE or FALSE).

Definition at line 366 of file stm32f7xx_hal_usart.h.

#define __HAL_USART_GET_IT	(		__HANDLE__,
			__IT__
	)		((__HANDLE__)->Instance->ISR & ((uint32_t)1 << ((__IT__)>> 0x08)))

Checks whether the specified USART interrupt has occurred or not.

Parameters

<strong>HANDLE</strong>

specifies the USART Handle

<strong>IT</strong>

specifies the USART interrupt source to check. This parameter can be one of the following values: USART_IT_TXE: Transmit Data Register empty interrupt USART_IT_TC: Transmission complete interrupt USART_IT_RXNE: Receive Data register not empty interrupt USART_IT_IDLE: Idle line detection interrupt USART_IT_ORE: OverRun Error interrupt USART_IT_NE: Noise Error interrupt USART_IT_FE: Framing Error interrupt USART_IT_PE: Parity Error interrupt

Return values

The	new state of IT (TRUE or FALSE).

Definition at line 416 of file stm32f7xx_hal_usart.h.

#define __HAL_USART_GET_IT_SOURCE	(		__HANDLE__,
			__IT__
	)

Value:

((((((uint8_t)(__IT__)) >> 5) == 1)? (__HANDLE__)->Instance->CR1:(((((uint8_t)(__IT__)) >> 5) == 2)? \
                                                   (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & ((uint32_t)1 << \
                                                   (((uint16_t)(__IT__)) & USART_IT_MASK)))

Checks whether the specified USART interrupt source is enabled.

Parameters

<strong>HANDLE</strong>

specifies the USART Handle.

<strong>IT</strong>

specifies the USART interrupt source to check. This parameter can be one of the following values: USART_IT_TXE: Transmit Data Register empty interrupt USART_IT_TC: Transmission complete interrupt USART_IT_RXNE: Receive Data register not empty interrupt USART_IT_IDLE: Idle line detection interrupt USART_IT_ORE: OverRun Error interrupt USART_IT_NE: Noise Error interrupt USART_IT_FE: Framing Error interrupt USART_IT_PE: Parity Error interrupt

Return values

The	new state of IT (TRUE or FALSE).

Definition at line 432 of file stm32f7xx_hal_usart.h.

#define __HAL_USART_RESET_HANDLE_STATE

(

__HANDLE__

)

((__HANDLE__)->State = HAL_USART_STATE_RESET)

Reset USART handle state.

Parameters

<strong>HANDLE</strong>

USART handle.

Return values

None

Definition at line 346 of file stm32f7xx_hal_usart.h.

#define __HAL_USART_SEND_REQ	(		__HANDLE__,
			__REQ__
	)		((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))

Set a specific USART request flag.

Parameters

<strong>HANDLE</strong>	specifies the USART Handle.
<strong>REQ</strong>	specifies the request flag to set This parameter can be one of the following values: USART_RXDATA_FLUSH_REQUEST: Receive Data flush Request USART_TXDATA_FLUSH_REQUEST: Transmit data flush Request

Return values

None

Definition at line 462 of file stm32f7xx_hal_usart.h.