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

Configuration functions related to Irda feature

Configuration functions related to Irda feature
[USART Exported Functions]

Functions

__STATIC_INLINE void LL_USART_EnableIrda (USART_TypeDef *USARTx)
 Enable IrDA mode.
__STATIC_INLINE void LL_USART_DisableIrda (USART_TypeDef *USARTx)
 Disable IrDA mode.
__STATIC_INLINE uint32_t LL_USART_IsEnabledIrda (USART_TypeDef *USARTx)
 Indicate if IrDA mode is enabled.
__STATIC_INLINE void LL_USART_SetIrdaPowerMode (USART_TypeDef *USARTx, uint32_t PowerMode)
 Configure IrDA Power Mode (Normal or Low Power)
__STATIC_INLINE uint32_t LL_USART_GetIrdaPowerMode (USART_TypeDef *USARTx)
 Retrieve IrDA Power Mode configuration (Normal or Low Power)
__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)
__STATIC_INLINE uint32_t LL_USART_GetIrdaPrescaler (USART_TypeDef *USARTx)
 Return Irda prescaler value, used for dividing the USART clock source to achieve the Irda Low Power frequency (8 bits value)

Function Documentation

__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. CR3 IREN LL_USART_DisableIrda
Parameters:
USARTxUSART Instance
Return values:
None

Definition at line 1592 of file stm32l4xx_ll_usart.h.

__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. CR3 IREN LL_USART_EnableIrda
Parameters:
USARTxUSART Instance
Return values:
None

Definition at line 1579 of file stm32l4xx_ll_usart.h.

__STATIC_INLINE uint32_t LL_USART_GetIrdaPowerMode ( 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. CR3 IRLP LL_USART_GetIrdaPowerMode
Parameters:
USARTxUSART Instance
Return values:
Returnedvalue can be one of the following values:

  • LL_USART_IRDA_POWER_NORMAL
  • LL_USART_PHASE_2EDGE

Definition at line 1636 of file stm32l4xx_ll_usart.h.

__STATIC_INLINE uint32_t LL_USART_GetIrdaPrescaler ( 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. GTPR PSC LL_USART_GetIrdaPrescaler
Parameters:
USARTxUSART Instance
Return values:
Irdaprescaler value (0..0xFF)

Definition at line 1665 of file stm32l4xx_ll_usart.h.

__STATIC_INLINE uint32_t LL_USART_IsEnabledIrda ( 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. CR3 IREN LL_USART_IsEnabledIrda
Parameters:
USARTxUSART Instance
Return values:
Stateof bit (1 or 0).

Definition at line 1605 of file stm32l4xx_ll_usart.h.

__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. CR3 IRLP LL_USART_SetIrdaPowerMode
Parameters:
USARTxUSART Instance
PowerModeThis parameter can be one of the following values:

  • LL_USART_IRDA_POWER_NORMAL
  • LL_USART_IRDA_POWER_LOW
Return values:
None

Definition at line 1621 of file stm32l4xx_ll_usart.h.

__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. GTPR PSC LL_USART_SetIrdaPrescaler
Parameters:
USARTxUSART Instance
PrescalerValue0..0xFF
Return values:
None

Definition at line 1651 of file stm32l4xx_ll_usart.h.