IRDA Exported Types

Data Structures
struct	IRDA_InitTypeDef
	IRDA Init Structure definition. More...
struct	__IRDA_HandleTypeDef
	IRDA handle Structure definition. More...
Typedefs
typedef uint32_t	HAL_IRDA_StateTypeDef
	HAL IRDA State definition.
typedef struct __IRDA_HandleTypeDef	IRDA_HandleTypeDef
	IRDA handle Structure definition.
typedef void(*	pIRDA_CallbackTypeDef )(IRDA_HandleTypeDef *hirda)
	HAL IRDA Callback pointer definition.
Enumerations
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...
enum	HAL_IRDA_CallbackIDTypeDef {   HAL_IRDA_TX_HALFCOMPLETE_CB_ID = 0x00U, HAL_IRDA_TX_COMPLETE_CB_ID = 0x01U, HAL_IRDA_RX_HALFCOMPLETE_CB_ID = 0x02U, HAL_IRDA_RX_COMPLETE_CB_ID = 0x03U,   HAL_IRDA_ERROR_CB_ID = 0x04U, HAL_IRDA_ABORT_COMPLETE_CB_ID = 0x05U, HAL_IRDA_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x06U, HAL_IRDA_ABORT_RECEIVE_COMPLETE_CB_ID = 0x07U,   HAL_IRDA_MSPINIT_CB_ID = 0x08U, HAL_IRDA_MSPDEINIT_CB_ID = 0x09U }
	HAL IRDA Callback ID enumeration definition. More...

---

Typedef Documentation

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 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 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 120 of file stm32l4xx_hal_irda.h.

typedef struct __IRDA_HandleTypeDef IRDA_HandleTypeDef

IRDA handle Structure definition.

typedef void(* pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda)

HAL IRDA Callback pointer definition.

pointer to an IRDA callback function

Definition at line 225 of file stm32l4xx_hal_irda.h.

---

Enumeration Type Documentation

enum HAL_IRDA_CallbackIDTypeDef

HAL IRDA Callback ID enumeration definition.

Enumerator:

HAL_IRDA_TX_HALFCOMPLETE_CB_ID	IRDA Tx Half Complete Callback ID
HAL_IRDA_TX_COMPLETE_CB_ID	IRDA Tx Complete Callback ID
HAL_IRDA_RX_HALFCOMPLETE_CB_ID	IRDA Rx Half Complete Callback ID
HAL_IRDA_RX_COMPLETE_CB_ID	IRDA Rx Complete Callback ID
HAL_IRDA_ERROR_CB_ID	IRDA Error Callback ID
HAL_IRDA_ABORT_COMPLETE_CB_ID	IRDA Abort Complete Callback ID
HAL_IRDA_ABORT_TRANSMIT_COMPLETE_CB_ID	IRDA Abort Transmit Complete Callback ID
HAL_IRDA_ABORT_RECEIVE_COMPLETE_CB_ID	IRDA Abort Receive Complete Callback ID
HAL_IRDA_MSPINIT_CB_ID	IRDA MspInit callback ID
HAL_IRDA_MSPDEINIT_CB_ID	IRDA MspDeInit callback ID

Definition at line 206 of file stm32l4xx_hal_irda.h.

enum 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 125 of file stm32l4xx_hal_irda.h.