stm32l4xx_hal_irda.h File Reference

Header file of IRDA HAL module. More...

Go to the source code of this file.

Data Structures
struct	IRDA_InitTypeDef
	IRDA Init Structure definition. More...
struct	endif
	ADC handle Structure definition. More...

Typedefs
typedef uint32_t	HAL_IRDA_StateTypeDef
	HAL IRDA State definition. More...
typedef struct __IRDA_HandleTypeDef else typedef struct endif	IRDA_HandleTypeDef
	IRDA handle Structure definition. More...
typedef void(*	pIRDA_CallbackTypeDef) (IRDA_HandleTypeDef *hirda)
	HAL IRDA Callback pointer definition. More...

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...

Functions
HAL_StatusTypeDef	HAL_IRDA_Init (IRDA_HandleTypeDef *hirda)
	Initialize the IRDA mode according to the specified parameters in the IRDA_InitTypeDef and initialize the associated handle. More...
HAL_StatusTypeDef	HAL_IRDA_DeInit (IRDA_HandleTypeDef *hirda)
	DeInitialize the IRDA peripheral. More...
void	HAL_IRDA_MspInit (IRDA_HandleTypeDef *hirda)
	Initialize the IRDA MSP. More...
void	HAL_IRDA_MspDeInit (IRDA_HandleTypeDef *hirda)
	DeInitialize the IRDA MSP. More...
HAL_StatusTypeDef	HAL_IRDA_RegisterCallback (IRDA_HandleTypeDef *hirda, HAL_IRDA_CallbackIDTypeDef CallbackID, pIRDA_CallbackTypeDef pCallback)
	Register a User IRDA Callback To be used instead of the weak predefined callback. More...
HAL_StatusTypeDef	HAL_IRDA_UnRegisterCallback (IRDA_HandleTypeDef *hirda, HAL_IRDA_CallbackIDTypeDef CallbackID)
	Unregister an IRDA callback IRDA callback is redirected to the weak predefined callback. More...
HAL_StatusTypeDef	HAL_IRDA_Transmit (IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout)
	Send an amount of data in blocking mode. More...
HAL_StatusTypeDef	HAL_IRDA_Receive (IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout)
	Receive an amount of data in blocking mode. More...
HAL_StatusTypeDef	HAL_IRDA_Transmit_IT (IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size)
	Send an amount of data in interrupt mode. More...
HAL_StatusTypeDef	HAL_IRDA_Receive_IT (IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size)
	Receive an amount of data in interrupt mode. More...
HAL_StatusTypeDef	HAL_IRDA_Transmit_DMA (IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size)
	Send an amount of data in DMA mode. More...
HAL_StatusTypeDef	HAL_IRDA_Receive_DMA (IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size)
	Receive an amount of data in DMA mode. More...
HAL_StatusTypeDef	HAL_IRDA_DMAPause (IRDA_HandleTypeDef *hirda)
	Pause the DMA Transfer. More...
HAL_StatusTypeDef	HAL_IRDA_DMAResume (IRDA_HandleTypeDef *hirda)
	Resume the DMA Transfer. More...
HAL_StatusTypeDef	HAL_IRDA_DMAStop (IRDA_HandleTypeDef *hirda)
	Stop the DMA Transfer. More...
HAL_StatusTypeDef	HAL_IRDA_Abort (IRDA_HandleTypeDef *hirda)
	Abort ongoing transfers (blocking mode). More...
HAL_StatusTypeDef	HAL_IRDA_AbortTransmit (IRDA_HandleTypeDef *hirda)
	Abort ongoing Transmit transfer (blocking mode). More...
HAL_StatusTypeDef	HAL_IRDA_AbortReceive (IRDA_HandleTypeDef *hirda)
	Abort ongoing Receive transfer (blocking mode). More...
HAL_StatusTypeDef	HAL_IRDA_Abort_IT (IRDA_HandleTypeDef *hirda)
	Abort ongoing transfers (Interrupt mode). More...
HAL_StatusTypeDef	HAL_IRDA_AbortTransmit_IT (IRDA_HandleTypeDef *hirda)
	Abort ongoing Transmit transfer (Interrupt mode). More...
HAL_StatusTypeDef	HAL_IRDA_AbortReceive_IT (IRDA_HandleTypeDef *hirda)
	Abort ongoing Receive transfer (Interrupt mode). More...
void	HAL_IRDA_IRQHandler (IRDA_HandleTypeDef *hirda)
	Handle IRDA interrupt request. More...
void	HAL_IRDA_TxCpltCallback (IRDA_HandleTypeDef *hirda)
	Tx Transfer completed callback. More...
void	HAL_IRDA_RxCpltCallback (IRDA_HandleTypeDef *hirda)
	Rx Transfer completed callback. More...
void	HAL_IRDA_TxHalfCpltCallback (IRDA_HandleTypeDef *hirda)
	Tx Half Transfer completed callback. More...
void	HAL_IRDA_RxHalfCpltCallback (IRDA_HandleTypeDef *hirda)
	Rx Half Transfer complete callback. More...
void	HAL_IRDA_ErrorCallback (IRDA_HandleTypeDef *hirda)
	IRDA error callback. More...
void	HAL_IRDA_AbortCpltCallback (IRDA_HandleTypeDef *hirda)
	IRDA Abort Complete callback. More...
void	HAL_IRDA_AbortTransmitCpltCallback (IRDA_HandleTypeDef *hirda)
	IRDA Abort Complete callback. More...
void	HAL_IRDA_AbortReceiveCpltCallback (IRDA_HandleTypeDef *hirda)
	IRDA Abort Receive Complete callback. More...
HAL_IRDA_StateTypeDef	HAL_IRDA_GetState (IRDA_HandleTypeDef *hirda)
	Return the IRDA handle state. More...
uint32_t	HAL_IRDA_GetError (IRDA_HandleTypeDef *hirda)
	Return the IRDA handle error code. More...

Detailed Description

Header file of IRDA HAL module.

Author

MCD Application Team

Attention

© Copyright (c) 2017 STMicroelectronics. All rights reserved.

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32l4xx_hal_irda.h.