stm32f4xx_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 struct __IRDA_HandleTypeDef else typedef struct endif	IRDA_HandleTypeDef
	IRDA handle Structure definition.
typedef void(*	pIRDA_CallbackTypeDef) (IRDA_HandleTypeDef *hirda)
	HAL IRDA Callback pointer 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	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)
	Initializes the IRDA mode according to the specified parameters in the IRDA_InitTypeDef and create the associated handle. More...
HAL_StatusTypeDef	HAL_IRDA_DeInit (IRDA_HandleTypeDef *hirda)
	DeInitializes the IRDA peripheral. More...
void	HAL_IRDA_MspInit (IRDA_HandleTypeDef *hirda)
	IRDA MSP Init. More...
void	HAL_IRDA_MspDeInit (IRDA_HandleTypeDef *hirda)
	IRDA MSP DeInit. 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, const uint8_t *pData, uint16_t Size, uint32_t Timeout)
	Sends 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, const uint8_t *pData, uint16_t Size)
	Send an amount of data in non blocking mode. More...
HAL_StatusTypeDef	HAL_IRDA_Receive_IT (IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size)
	Receive an amount of data in non blocking mode. More...
HAL_StatusTypeDef	HAL_IRDA_Transmit_DMA (IRDA_HandleTypeDef *hirda, const 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)
	Receives an amount of data in DMA mode. More...
HAL_StatusTypeDef	HAL_IRDA_DMAPause (IRDA_HandleTypeDef *hirda)
	Pauses the DMA Transfer. More...
HAL_StatusTypeDef	HAL_IRDA_DMAResume (IRDA_HandleTypeDef *hirda)
	Resumes the DMA Transfer. More...
HAL_StatusTypeDef	HAL_IRDA_DMAStop (IRDA_HandleTypeDef *hirda)
	Stops 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)
	This function handles IRDA interrupt request. More...
void	HAL_IRDA_TxCpltCallback (IRDA_HandleTypeDef *hirda)
	Tx Transfer complete callback. More...
void	HAL_IRDA_RxCpltCallback (IRDA_HandleTypeDef *hirda)
	Rx Transfer complete 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 Transmit Complete callback. More...
void	HAL_IRDA_AbortReceiveCpltCallback (IRDA_HandleTypeDef *hirda)
	IRDA Abort Receive Complete callback. More...
HAL_IRDA_StateTypeDef	HAL_IRDA_GetState (const IRDA_HandleTypeDef *hirda)
	Return the IRDA state. More...
uint32_t	HAL_IRDA_GetError (const IRDA_HandleTypeDef *hirda)
	Return the IRDA error code. More...

Detailed Description

Header file of IRDA HAL module.

Author

MCD Application Team

Attention

Copyright (c) 2016 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32f4xx_hal_irda.h.