STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
IRDA_InitTypeDef Struct Reference

IRDA Init Structure definition. More...

#include <stm32f4xx_hal_irda.h>

Collaboration diagram for IRDA_InitTypeDef:

Data Fields

uint32_t BaudRate
 
uint32_t WordLength
 
uint32_t Parity
 
uint32_t Mode
 
uint8_t Prescaler
 
uint32_t IrDAMode
 

Detailed Description

IRDA Init Structure definition.

Definition at line 45 of file stm32f4xx_hal_irda.h.

Field Documentation

◆ BaudRate

uint32_t IRDA_InitTypeDef::BaudRate

This member configures the IRDA communication baud rate. The baud rate is computed using the following formula:

  • IntegerDivider = ((PCLKx) / (8 * (hirda->Init.BaudRate)))
  • FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 8) + 0.5

Definition at line 47 of file stm32f4xx_hal_irda.h.

Referenced by IRDA_SetConfig().

◆ WordLength

uint32_t IRDA_InitTypeDef::WordLength

Specifies the number of data bits transmitted or received in a frame. This parameter can be a value of IRDA Word Length

Definition at line 52 of file stm32f4xx_hal_irda.h.

Referenced by HAL_IRDA_Receive(), HAL_IRDA_Transmit(), IRDA_Receive_IT(), IRDA_SetConfig(), and IRDA_Transmit_IT().

◆ Parity

uint32_t IRDA_InitTypeDef::Parity

Specifies the parity mode. This parameter can be a value of IRDA Parity

Note
When parity is enabled, the computed parity is inserted at the MSB position of the transmitted data (9th bit when the word length is set to 9 data bits; 8th bit when the word length is set to 8 data bits).

Definition at line 55 of file stm32f4xx_hal_irda.h.

Referenced by HAL_IRDA_DMAResume(), HAL_IRDA_Receive(), HAL_IRDA_Receive_DMA(), HAL_IRDA_Receive_IT(), HAL_IRDA_Transmit(), IRDA_Receive_IT(), IRDA_SetConfig(), and IRDA_Transmit_IT().

◆ Mode

uint32_t IRDA_InitTypeDef::Mode

Specifies whether the Receive or Transmit mode is enabled or disabled. This parameter can be a value of IRDA Transfer Mode

Definition at line 62 of file stm32f4xx_hal_irda.h.

Referenced by IRDA_SetConfig().

◆ Prescaler

uint8_t IRDA_InitTypeDef::Prescaler

Specifies the Prescaler value to be programmed in the IrDA low-power Baud Register, for defining pulse width on which burst acceptance/rejection will be decided. This value is used as divisor of system clock to achieve required pulse width.

Definition at line 65 of file stm32f4xx_hal_irda.h.

Referenced by HAL_IRDA_Init().

◆ IrDAMode

uint32_t IRDA_InitTypeDef::IrDAMode

Specifies the IrDA mode This parameter can be a value of IRDA Low Power

Definition at line 70 of file stm32f4xx_hal_irda.h.

Referenced by HAL_IRDA_Init(), and IRDA_SetConfig().


The documentation for this struct was generated from the following file: