STM CMSIS
stm32f4xx_hal_irda.h
Go to the documentation of this file.
1 
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32F4xx_HAL_IRDA_H
40 #define __STM32F4xx_HAL_IRDA_H
41 
42 #ifdef __cplusplus
43  extern "C" {
44 #endif
45 
46 /* Includes ------------------------------------------------------------------*/
47 #include "stm32f4xx_hal_def.h"
48 
57 /* Exported types ------------------------------------------------------------*/
64 typedef struct
65 {
66  uint32_t BaudRate;
71  uint32_t WordLength;
74  uint32_t Parity;
81  uint32_t Mode;
84  uint8_t Prescaler;
86  uint32_t IrDAMode;
88 }IRDA_InitTypeDef;
89 
129 typedef enum
130 {
131  HAL_IRDA_STATE_RESET = 0x00U,
133  HAL_IRDA_STATE_READY = 0x20U,
135  HAL_IRDA_STATE_BUSY = 0x24U,
137  HAL_IRDA_STATE_BUSY_TX = 0x21U,
139  HAL_IRDA_STATE_BUSY_RX = 0x22U,
141  HAL_IRDA_STATE_BUSY_TX_RX = 0x23U,
144  HAL_IRDA_STATE_TIMEOUT = 0xA0U,
146  HAL_IRDA_STATE_ERROR = 0xE0U
148 }HAL_IRDA_StateTypeDef;
149 
153 typedef struct
154 {
155  USART_TypeDef *Instance; /* USART registers base address */
156 
157  IRDA_InitTypeDef Init; /* IRDA communication parameters */
158 
159  uint8_t *pTxBuffPtr; /* Pointer to IRDA Tx transfer Buffer */
160 
161  uint16_t TxXferSize; /* IRDA Tx Transfer size */
162 
163  uint16_t TxXferCount; /* IRDA Tx Transfer Counter */
164 
165  uint8_t *pRxBuffPtr; /* Pointer to IRDA Rx transfer Buffer */
166 
167  uint16_t RxXferSize; /* IRDA Rx Transfer size */
168 
169  uint16_t RxXferCount; /* IRDA Rx Transfer Counter */
170 
171  DMA_HandleTypeDef *hdmatx; /* IRDA Tx DMA Handle parameters */
172 
173  DMA_HandleTypeDef *hdmarx; /* IRDA Rx DMA Handle parameters */
174 
175  HAL_LockTypeDef Lock; /* Locking object */
176 
177  __IO HAL_IRDA_StateTypeDef gState; /* IRDA state information related to global Handle management
178  and also related to Tx operations.
179  This parameter can be a value of @ref HAL_IRDA_StateTypeDef */
180 
181  __IO HAL_IRDA_StateTypeDef RxState; /* IRDA state information related to Rx operations.
182  This parameter can be a value of @ref HAL_IRDA_StateTypeDef */
183 
184  __IO uint32_t ErrorCode; /* IRDA Error code */
185 
186 }IRDA_HandleTypeDef;
191 /* Exported constants --------------------------------------------------------*/
199 #define HAL_IRDA_ERROR_NONE ((uint32_t)0x00000000U)
200 #define HAL_IRDA_ERROR_PE ((uint32_t)0x00000001U)
201 #define HAL_IRDA_ERROR_NE ((uint32_t)0x00000002U)
202 #define HAL_IRDA_ERROR_FE ((uint32_t)0x00000004U)
203 #define HAL_IRDA_ERROR_ORE ((uint32_t)0x00000008U)
204 #define HAL_IRDA_ERROR_DMA ((uint32_t)0x00000010U)
212 #define IRDA_WORDLENGTH_8B ((uint32_t)0x00000000U)
213 #define IRDA_WORDLENGTH_9B ((uint32_t)USART_CR1_M)
214 
221 #define IRDA_PARITY_NONE ((uint32_t)0x00000000U)
222 #define IRDA_PARITY_EVEN ((uint32_t)USART_CR1_PCE)
223 #define IRDA_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
224 
231 #define IRDA_MODE_RX ((uint32_t)USART_CR1_RE)
232 #define IRDA_MODE_TX ((uint32_t)USART_CR1_TE)
233 #define IRDA_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE))
234 
241 #define IRDA_POWERMODE_LOWPOWER ((uint32_t)USART_CR3_IRLP)
242 #define IRDA_POWERMODE_NORMAL ((uint32_t)0x00000000U)
243 
252 #define IRDA_FLAG_TXE ((uint32_t)0x00000080U)
253 #define IRDA_FLAG_TC ((uint32_t)0x00000040U)
254 #define IRDA_FLAG_RXNE ((uint32_t)0x00000020U)
255 #define IRDA_FLAG_IDLE ((uint32_t)0x00000010U)
256 #define IRDA_FLAG_ORE ((uint32_t)0x00000008U)
257 #define IRDA_FLAG_NE ((uint32_t)0x00000004U)
258 #define IRDA_FLAG_FE ((uint32_t)0x00000002U)
259 #define IRDA_FLAG_PE ((uint32_t)0x00000001U)
260 
273 #define IRDA_IT_PE ((uint32_t)(IRDA_CR1_REG_INDEX << 28U | USART_CR1_PEIE))
274 #define IRDA_IT_TXE ((uint32_t)(IRDA_CR1_REG_INDEX << 28U | USART_CR1_TXEIE))
275 #define IRDA_IT_TC ((uint32_t)(IRDA_CR1_REG_INDEX << 28U | USART_CR1_TCIE))
276 #define IRDA_IT_RXNE ((uint32_t)(IRDA_CR1_REG_INDEX << 28U | USART_CR1_RXNEIE))
277 #define IRDA_IT_IDLE ((uint32_t)(IRDA_CR1_REG_INDEX << 28U | USART_CR1_IDLEIE))
278 
279 #define IRDA_IT_LBD ((uint32_t)(IRDA_CR2_REG_INDEX << 28U | USART_CR2_LBDIE))
280 
281 #define IRDA_IT_CTS ((uint32_t)(IRDA_CR3_REG_INDEX << 28U | USART_CR3_CTSIE))
282 #define IRDA_IT_ERR ((uint32_t)(IRDA_CR3_REG_INDEX << 28U | USART_CR3_EIE))
283 
291 /* Exported macro ------------------------------------------------------------*/
302 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) do{ \
303  (__HANDLE__)->gState = HAL_IRDA_STATE_RESET; \
304  (__HANDLE__)->RxState = HAL_IRDA_STATE_RESET; \
305  } while(0)
306 
312 #define __HAL_IRDA_FLUSH_DRREGISTER(__HANDLE__) ((__HANDLE__)->Instance->DR)
313 
330 #define __HAL_IRDA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
331 
352 #define __HAL_IRDA_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR = ~(__FLAG__))
353 
360 #define __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__) \
361  do{ \
362  __IO uint32_t tmpreg = 0x00U; \
363  tmpreg = (__HANDLE__)->Instance->SR; \
364  UNUSED(tmpreg); \
365  } while(0)
366 
373 #define __HAL_IRDA_CLEAR_FEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
374 
381 #define __HAL_IRDA_CLEAR_NEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
382 
389 #define __HAL_IRDA_CLEAR_OREFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
390 
397 #define __HAL_IRDA_CLEAR_IDLEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
398 
413 #define __HAL_IRDA_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28U) == 1U)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & IRDA_IT_MASK)): \
414  (((__INTERRUPT__) >> 28U) == 2U)? ((__HANDLE__)->Instance->CR2 |= ((__INTERRUPT__) & IRDA_IT_MASK)): \
415  ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & IRDA_IT_MASK)))
416 #define __HAL_IRDA_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28U) == 1U)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & IRDA_IT_MASK)): \
417  (((__INTERRUPT__) >> 28U) == 2U)? ((__HANDLE__)->Instance->CR2 &= ~((__INTERRUPT__) & IRDA_IT_MASK)): \
418  ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & IRDA_IT_MASK)))
419 
434 #define __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28U) == 1U)? (__HANDLE__)->Instance->CR1:(((((uint32_t)(__IT__)) >> 28U) == 2U)? \
435  (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & (((uint32_t)(__IT__)) & IRDA_IT_MASK))
436 
441 #define __HAL_IRDA_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
442 
447 #define __HAL_IRDA_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= (uint16_t)~((uint16_t)USART_CR3_ONEBIT))
448 
455 #define __HAL_IRDA_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
456 
463 #define __HAL_IRDA_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
464 
469 /* Exported functions --------------------------------------------------------*/
477 /* Initialization/de-initialization functions **********************************/
478 HAL_StatusTypeDef HAL_IRDA_Init(IRDA_HandleTypeDef *hirda);
479 HAL_StatusTypeDef HAL_IRDA_DeInit(IRDA_HandleTypeDef *hirda);
480 void HAL_IRDA_MspInit(IRDA_HandleTypeDef *hirda);
481 void HAL_IRDA_MspDeInit(IRDA_HandleTypeDef *hirda);
489 /* IO operation functions *******************************************************/
490 HAL_StatusTypeDef HAL_IRDA_Transmit(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
491 HAL_StatusTypeDef HAL_IRDA_Receive(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
492 HAL_StatusTypeDef HAL_IRDA_Transmit_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
493 HAL_StatusTypeDef HAL_IRDA_Receive_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
494 HAL_StatusTypeDef HAL_IRDA_Transmit_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
495 HAL_StatusTypeDef HAL_IRDA_Receive_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
496 HAL_StatusTypeDef HAL_IRDA_DMAPause(IRDA_HandleTypeDef *hirda);
497 HAL_StatusTypeDef HAL_IRDA_DMAResume(IRDA_HandleTypeDef *hirda);
498 HAL_StatusTypeDef HAL_IRDA_DMAStop(IRDA_HandleTypeDef *hirda);
499 
500 void HAL_IRDA_IRQHandler(IRDA_HandleTypeDef *hirda);
501 void HAL_IRDA_TxCpltCallback(IRDA_HandleTypeDef *hirda);
502 void HAL_IRDA_RxCpltCallback(IRDA_HandleTypeDef *hirda);
503 void HAL_IRDA_TxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
504 void HAL_IRDA_RxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
505 void HAL_IRDA_ErrorCallback(IRDA_HandleTypeDef *hirda);
513 /* Peripheral State functions **************************************************/
514 HAL_IRDA_StateTypeDef HAL_IRDA_GetState(IRDA_HandleTypeDef *hirda);
515 uint32_t HAL_IRDA_GetError(IRDA_HandleTypeDef *hirda);
524 /* Private types -------------------------------------------------------------*/
525 /* Private variables ---------------------------------------------------------*/
526 /* Private constants ---------------------------------------------------------*/
534 #define IRDA_IT_MASK ((uint32_t) USART_CR1_PEIE | USART_CR1_TXEIE | USART_CR1_TCIE | USART_CR1_RXNEIE | \
535  USART_CR1_IDLEIE | USART_CR2_LBDIE | USART_CR3_CTSIE | USART_CR3_EIE )
536 
537 #define IRDA_CR1_REG_INDEX 1U
538 #define IRDA_CR2_REG_INDEX 2U
539 #define IRDA_CR3_REG_INDEX 3U
540 
544 /* Private macros --------------------------------------------------------*/
548 #define IS_IRDA_WORD_LENGTH(LENGTH) (((LENGTH) == IRDA_WORDLENGTH_8B) || \
549  ((LENGTH) == IRDA_WORDLENGTH_9B))
550 #define IS_IRDA_PARITY(PARITY) (((PARITY) == IRDA_PARITY_NONE) || \
551  ((PARITY) == IRDA_PARITY_EVEN) || \
552  ((PARITY) == IRDA_PARITY_ODD))
553 #define IS_IRDA_MODE(MODE) ((((MODE) & (uint32_t)0x0000FFF3U) == 0x00U) && ((MODE) != (uint32_t)0x00000000U))
554 #define IS_IRDA_POWERMODE(MODE) (((MODE) == IRDA_POWERMODE_LOWPOWER) || \
555  ((MODE) == IRDA_POWERMODE_NORMAL))
556 #define IS_IRDA_BAUDRATE(BAUDRATE) ((BAUDRATE) < 115201U)
557 
558 #define IRDA_DIV(_PCLK_, _BAUD_) (((_PCLK_)*25U)/(4U*(_BAUD_)))
559 #define IRDA_DIVMANT(_PCLK_, _BAUD_) (IRDA_DIV((_PCLK_), (_BAUD_))/100U)
560 #define IRDA_DIVFRAQ(_PCLK_, _BAUD_) (((IRDA_DIV((_PCLK_), (_BAUD_)) - (IRDA_DIVMANT((_PCLK_), (_BAUD_)) * 100U)) * 16U + 50U) / 100U)
561 /* UART BRR = mantissa + overflow + fraction
562  = (UART DIVMANT << 4) + (UART DIVFRAQ & 0xF0) + (UART DIVFRAQ & 0x0FU) */
563 #define IRDA_BRR(_PCLK_, _BAUD_) (((IRDA_DIVMANT((_PCLK_), (_BAUD_)) << 4U) + \
564  (IRDA_DIVFRAQ((_PCLK_), (_BAUD_)) & 0xF0U)) + \
565  (IRDA_DIVFRAQ((_PCLK_), (_BAUD_)) & 0x0FU))
566 
571 /* Private functions ---------------------------------------------------------*/
588 #ifdef __cplusplus
589 }
590 #endif
591 
592 #endif /* __STM32F4xx_HAL_IRDA_H */
593 
594 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
IRDA_InitTypeDef::IrDAMode
uint32_t IrDAMode
Definition: stm32f4xx_hal_irda.h:86
stm32f4xx_hal_def.h
This file contains HAL common defines, enumeration, macros and structures definitions.
HAL_IRDA_STATE_BUSY_TX_RX
Definition: stm32f4xx_hal_irda.h:141
IRDA_InitTypeDef::Parity
uint32_t Parity
Definition: stm32f4xx_hal_irda.h:74
HAL_IRDA_STATE_BUSY_RX
Definition: stm32f4xx_hal_irda.h:139
HAL_IRDA_StateTypeDef
HAL_IRDA_StateTypeDef
HAL IRDA State structures definition.
Definition: stm32f4xx_hal_irda.h:129
IRDA_InitTypeDef
IRDA Init Structure definition.
Definition: stm32f4xx_hal_irda.h:64
IRDA_HandleTypeDef
IRDA handle Structure definition.
Definition: stm32f4xx_hal_irda.h:153
HAL_IRDA_STATE_RESET
Definition: stm32f4xx_hal_irda.h:131
HAL_StatusTypeDef
HAL_StatusTypeDef
HAL Status structures definition.
Definition: stm32f4xx_hal_def.h:57
__IO
#define __IO
Definition: core_cm0.h:213
IRDA_InitTypeDef::WordLength
uint32_t WordLength
Definition: stm32f4xx_hal_irda.h:71
USART_TypeDef
Universal Synchronous Asynchronous Receiver Transmitter.
Definition: stm32f401xc.h:518
IRDA_InitTypeDef::Mode
uint32_t Mode
Definition: stm32f4xx_hal_irda.h:81
HAL_IRDA_STATE_READY
Definition: stm32f4xx_hal_irda.h:133
IRDA_InitTypeDef::Prescaler
uint8_t Prescaler
Definition: stm32f4xx_hal_irda.h:84
HAL_LockTypeDef
HAL_LockTypeDef
HAL Lock structures definition.
Definition: stm32f4xx_hal_def.h:68
HAL_IRDA_STATE_ERROR
Definition: stm32f4xx_hal_irda.h:146
__DMA_HandleTypeDef
DMA handle Structure definition.
Definition: stm32f4xx_hal_dma.h:157
HAL_IRDA_STATE_BUSY
Definition: stm32f4xx_hal_irda.h:135
HAL_IRDA_STATE_BUSY_TX
Definition: stm32f4xx_hal_irda.h:137
IRDA_InitTypeDef::BaudRate
uint32_t BaudRate
Definition: stm32f4xx_hal_irda.h:66
HAL_IRDA_STATE_TIMEOUT
Definition: stm32f4xx_hal_irda.h:144