Configuration functions related to Irda feature

Collaboration diagram for Configuration functions related to Irda feature:

Functions
__STATIC_INLINE void	LL_USART_EnableIrda (USART_TypeDef *USARTx)
	Enable IrDA mode. More...
__STATIC_INLINE void	LL_USART_DisableIrda (USART_TypeDef *USARTx)
	Disable IrDA mode. More...
__STATIC_INLINE uint32_t	LL_USART_IsEnabledIrda (const USART_TypeDef *USARTx)
	Indicate if IrDA mode is enabled. More...
__STATIC_INLINE void	LL_USART_SetIrdaPowerMode (USART_TypeDef *USARTx, uint32_t PowerMode)
	Configure IrDA Power Mode (Normal or Low Power) More...
__STATIC_INLINE uint32_t	LL_USART_GetIrdaPowerMode (const USART_TypeDef *USARTx)
	Retrieve IrDA Power Mode configuration (Normal or Low Power) More...
__STATIC_INLINE void	LL_USART_SetIrdaPrescaler (USART_TypeDef *USARTx, uint32_t PrescalerValue)
	Set Irda prescaler value, used for dividing the USART clock source to achieve the Irda Low Power frequency (8 bits value) More...
__STATIC_INLINE uint32_t	LL_USART_GetIrdaPrescaler (const USART_TypeDef *USARTx)
	Return Irda prescaler value, used for dividing the USART clock source to achieve the Irda Low Power frequency (8 bits value) More...

Detailed Description

Function Documentation

LL_USART_DisableIrda()

__STATIC_INLINE void LL_USART_DisableIrda

(

USART_TypeDef *

USARTx

)

Disable IrDA mode.

Note

Macro IS_IRDA_INSTANCE(USARTx) can be used to check whether or not IrDA feature is supported by the USARTx instance. @rmtoll CR3 IREN LL_USART_DisableIrda

Parameters

USARTx

USART Instance

Return values

None

Definition at line 1099 of file stm32f4xx_ll_usart.h.

LL_USART_EnableIrda()

__STATIC_INLINE void LL_USART_EnableIrda

(

USART_TypeDef *

USARTx

)

Enable IrDA mode.

Note

Macro IS_IRDA_INSTANCE(USARTx) can be used to check whether or not IrDA feature is supported by the USARTx instance. @rmtoll CR3 IREN LL_USART_EnableIrda

Parameters

USARTx

USART Instance

Return values

None

Definition at line 1086 of file stm32f4xx_ll_usart.h.

LL_USART_GetIrdaPowerMode()

__STATIC_INLINE uint32_t LL_USART_GetIrdaPowerMode

(

const USART_TypeDef *

USARTx

)

Retrieve IrDA Power Mode configuration (Normal or Low Power)

Note

Macro IS_IRDA_INSTANCE(USARTx) can be used to check whether or not IrDA feature is supported by the USARTx instance. @rmtoll CR3 IRLP LL_USART_GetIrdaPowerMode

Parameters

USARTx

USART Instance

Return values

Returned

value can be one of the following values: LL_USART_IRDA_POWER_NORMAL LL_USART_PHASE_2EDGE

Definition at line 1143 of file stm32f4xx_ll_usart.h.

LL_USART_GetIrdaPrescaler()

__STATIC_INLINE uint32_t LL_USART_GetIrdaPrescaler

(

const USART_TypeDef *

USARTx

)

Return Irda prescaler value, used for dividing the USART clock source to achieve the Irda Low Power frequency (8 bits value)

Note

Macro IS_IRDA_INSTANCE(USARTx) can be used to check whether or not IrDA feature is supported by the USARTx instance. @rmtoll GTPR PSC LL_USART_GetIrdaPrescaler

Parameters

USARTx

USART Instance

Return values

Irda	prescaler value (Value between Min_Data=0x00 and Max_Data=0xFF)

Definition at line 1172 of file stm32f4xx_ll_usart.h.

LL_USART_IsEnabledIrda()

__STATIC_INLINE uint32_t LL_USART_IsEnabledIrda

(

const USART_TypeDef *

USARTx

)

Indicate if IrDA mode is enabled.

Note

Macro IS_IRDA_INSTANCE(USARTx) can be used to check whether or not IrDA feature is supported by the USARTx instance. @rmtoll CR3 IREN LL_USART_IsEnabledIrda

Parameters

USARTx

USART Instance

Return values

State

of bit (1 or 0).

Definition at line 1112 of file stm32f4xx_ll_usart.h.

LL_USART_SetIrdaPowerMode()

__STATIC_INLINE void LL_USART_SetIrdaPowerMode	(	USART_TypeDef *	USARTx,
		uint32_t	PowerMode
	)

Configure IrDA Power Mode (Normal or Low Power)

Note

Macro IS_IRDA_INSTANCE(USARTx) can be used to check whether or not IrDA feature is supported by the USARTx instance. @rmtoll CR3 IRLP LL_USART_SetIrdaPowerMode

Parameters

USARTx	USART Instance
PowerMode	This parameter can be one of the following values: LL_USART_IRDA_POWER_NORMAL LL_USART_IRDA_POWER_LOW

Return values

None

Definition at line 1128 of file stm32f4xx_ll_usart.h.

LL_USART_SetIrdaPrescaler()

__STATIC_INLINE void LL_USART_SetIrdaPrescaler	(	USART_TypeDef *	USARTx,
		uint32_t	PrescalerValue
	)

Set Irda prescaler value, used for dividing the USART clock source to achieve the Irda Low Power frequency (8 bits value)

Note

Macro IS_IRDA_INSTANCE(USARTx) can be used to check whether or not IrDA feature is supported by the USARTx instance. @rmtoll GTPR PSC LL_USART_SetIrdaPrescaler

Parameters

USARTx	USART Instance
PrescalerValue	Value between Min_Data=0x00 and Max_Data=0xFF

Return values

None

Definition at line 1158 of file stm32f4xx_ll_usart.h.