Classes | Typedefs | Enumerations
Collaboration diagram for IRDA Exported Types:

Classes

struct  IRDA_HandleTypeDef
 IRDA handle Structure definition. More...
 
struct  IRDA_InitTypeDef
 IRDA Init Structure definition. More...
 

Typedefs

typedef uint32_t HAL_IRDA_StateTypeDef
 HAL IRDA State definition. More...
 

Enumerations

enum  HAL_IRDA_StateTypeDef {
  HAL_IRDA_STATE_RESET = 0x00U, HAL_IRDA_STATE_READY = 0x20U, HAL_IRDA_STATE_BUSY = 0x24U, HAL_IRDA_STATE_BUSY_TX = 0x21U,
  HAL_IRDA_STATE_BUSY_RX = 0x22U, HAL_IRDA_STATE_BUSY_TX_RX = 0x23U, HAL_IRDA_STATE_TIMEOUT = 0xA0U, HAL_IRDA_STATE_ERROR = 0xE0U
}
 HAL IRDA State structures definition. More...
 
enum  IRDA_ClockSourceTypeDef {
  IRDA_CLOCKSOURCE_PCLK1 = 0x00U, IRDA_CLOCKSOURCE_PCLK2 = 0x01U, IRDA_CLOCKSOURCE_HSI = 0x02U, IRDA_CLOCKSOURCE_SYSCLK = 0x04U,
  IRDA_CLOCKSOURCE_LSE = 0x10U, IRDA_CLOCKSOURCE_UNDEFINED = 0x20U
}
 IRDA clock sources definition. More...
 

Detailed Description

Typedef Documentation

◆ HAL_IRDA_StateTypeDef

typedef uint32_t HAL_IRDA_StateTypeDef

HAL IRDA State definition.

Note
HAL IRDA State value is a combination of 2 different substates: gState and RxState (see IRDA State Code Definition).
  • gState contains IRDA state information related to global Handle management and also information related to Tx operations. gState value coding follow below described bitmap : b7-b6 Error information 00 : No Error 01 : (Not Used) 10 : Timeout 11 : Error b5 Peripheral initialization status 0 : Reset (Peripheral not initialized) 1 : Init done (Peripheral not initialized. HAL IRDA Init function already called) b4-b3 (not used) xx : Should be set to 00 b2 Intrinsic process state 0 : Ready 1 : Busy (Peripheral busy with some configuration or internal operations) b1 (not used) x : Should be set to 0 b0 Tx state 0 : Ready (no Tx operation ongoing) 1 : Busy (Tx operation ongoing)
  • RxState contains information related to Rx operations. RxState value coding follow below described bitmap : b7-b6 (not used) xx : Should be set to 00 b5 Peripheral initialization status 0 : Reset (Peripheral not initialized) 1 : Init done (Peripheral not initialized) b4-b2 (not used) xxx : Should be set to 000 b1 Rx state 0 : Ready (no Rx operation ongoing) 1 : Busy (Rx operation ongoing) b0 (not used) x : Should be set to 0.

Definition at line 115 of file stm32f7xx_hal_irda.h.

Enumeration Type Documentation

◆ HAL_IRDA_StateTypeDef

HAL IRDA State structures definition.

Note
HAL IRDA State value is a combination of 2 different substates: gState and RxState.
  • gState contains IRDA state information related to global Handle management and also information related to Tx operations. gState value coding follow below described bitmap : b7-b6 Error information 00 : No Error 01 : (Not Used) 10 : Timeout 11 : Error b5 IP initilisation status 0 : Reset (IP not initialized) 1 : Init done (IP not initialized. HAL IRDA Init function already called) b4-b3 (not used) xx : Should be set to 00 b2 Intrinsic process state 0 : Ready 1 : Busy (IP busy with some configuration or internal operations) b1 (not used) x : Should be set to 0 b0 Tx state 0 : Ready (no Tx operation ongoing) 1 : Busy (Tx operation ongoing)
  • RxState contains information related to Rx operations. RxState value coding follow below described bitmap : b7-b6 (not used) xx : Should be set to 00 b5 IP initilisation status 0 : Reset (IP not initialized) 1 : Init done (IP not initialized) b4-b2 (not used) xxx : Should be set to 000 b1 Rx state 0 : Ready (no Rx operation ongoing) 1 : Busy (Rx operation ongoing) b0 (not used) x : Should be set to 0.
Enumerator
HAL_IRDA_STATE_RESET 

Peripheral is not yet Initialized Value is allowed for gState and RxState

HAL_IRDA_STATE_READY 

Peripheral Initialized and ready for use Value is allowed for gState and RxState

HAL_IRDA_STATE_BUSY 

An internal process is ongoing Value is allowed for gState only

HAL_IRDA_STATE_BUSY_TX 

Data Transmission process is ongoing Value is allowed for gState only

HAL_IRDA_STATE_BUSY_RX 

Data Reception process is ongoing Value is allowed for RxState only

HAL_IRDA_STATE_BUSY_TX_RX 

Data Transmission and Reception process is ongoing Not to be used for neither gState nor RxState. Value is result of combination (Or) between gState and RxState values

HAL_IRDA_STATE_TIMEOUT 

Timeout state Value is allowed for gState only

HAL_IRDA_STATE_ERROR 

Error Value is allowed for gState only

Definition at line 114 of file stm32f4xx_hal_irda.h.

◆ IRDA_ClockSourceTypeDef

IRDA clock sources definition.

Enumerator
IRDA_CLOCKSOURCE_PCLK1 

PCLK1 clock source

IRDA_CLOCKSOURCE_PCLK2 

PCLK2 clock source

IRDA_CLOCKSOURCE_HSI 

HSI clock source

IRDA_CLOCKSOURCE_SYSCLK 

SYSCLK clock source

IRDA_CLOCKSOURCE_LSE 

LSE clock source

IRDA_CLOCKSOURCE_UNDEFINED 

Undefined clock source

Definition at line 120 of file stm32f7xx_hal_irda.h.



picovoice_driver
Author(s):
autogenerated on Fri Apr 1 2022 02:15:07