1 /** 2 ****************************************************************************** 3 * @file stm32f3xx_hal_irda.h 4 * @author MCD Application Team 5 * @brief Header file of IRDA HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2016 STMicroelectronics. 10 * All rights reserved. 11 * 12 * This software is licensed under terms that can be found in the LICENSE file 13 * in the root directory of this software component. 14 * If no LICENSE file comes with this software, it is provided AS-IS. 15 * 16 ****************************************************************************** 17 */ 18 19 /* Define to prevent recursive inclusion -------------------------------------*/ 20 #ifndef STM32F3xx_HAL_IRDA_H 21 #define STM32F3xx_HAL_IRDA_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32f3xx_hal_def.h" 29 30 /** @addtogroup STM32F3xx_HAL_Driver 31 * @{ 32 */ 33 34 /** @addtogroup IRDA 35 * @{ 36 */ 37 38 /* Exported types ------------------------------------------------------------*/ 39 /** @defgroup IRDA_Exported_Types IRDA Exported Types 40 * @{ 41 */ 42 43 /** 44 * @brief IRDA Init Structure definition 45 */ 46 typedef struct 47 { 48 uint32_t BaudRate; /*!< This member configures the IRDA communication baud rate. 49 The baud rate register is computed using the following formula: 50 Baud Rate Register = ((usart_ker_clk) / ((hirda->Init.BaudRate))) 51 where usart_ker_clk is the IRDA input clock */ 52 53 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame. 54 This parameter can be a value of @ref IRDAEx_Word_Length */ 55 56 uint32_t Parity; /*!< Specifies the parity mode. 57 This parameter can be a value of @ref IRDA_Parity 58 @note When parity is enabled, the computed parity is inserted 59 at the MSB position of the transmitted data (9th bit when 60 the word length is set to 9 data bits; 8th bit when the 61 word length is set to 8 data bits). */ 62 63 uint32_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled. 64 This parameter can be a value of @ref IRDA_Transfer_Mode */ 65 66 uint8_t Prescaler; /*!< Specifies the Prescaler value for dividing the UART/USART source clock 67 to achieve low-power frequency. 68 @note Prescaler value 0 is forbidden */ 69 70 uint16_t PowerMode; /*!< Specifies the IRDA power mode. 71 This parameter can be a value of @ref IRDA_Low_Power */ 72 73 } IRDA_InitTypeDef; 74 75 /** 76 * @brief HAL IRDA State definition 77 * @note HAL IRDA State value is a combination of 2 different substates: 78 * gState and RxState (see @ref IRDA_State_Definition). 79 * - gState contains IRDA state information related to global Handle management 80 * and also information related to Tx operations. 81 * gState value coding follow below described bitmap : 82 * b7-b6 Error information 83 * 00 : No Error 84 * 01 : (Not Used) 85 * 10 : Timeout 86 * 11 : Error 87 * b5 Peripheral initialization status 88 * 0 : Reset (Peripheral not initialized) 89 * 1 : Init done (Peripheral initialized. HAL IRDA Init function already called) 90 * b4-b3 (not used) 91 * xx : Should be set to 00 92 * b2 Intrinsic process state 93 * 0 : Ready 94 * 1 : Busy (Peripheral busy with some configuration or internal operations) 95 * b1 (not used) 96 * x : Should be set to 0 97 * b0 Tx state 98 * 0 : Ready (no Tx operation ongoing) 99 * 1 : Busy (Tx operation ongoing) 100 * - RxState contains information related to Rx operations. 101 * RxState value coding follow below described bitmap : 102 * b7-b6 (not used) 103 * xx : Should be set to 00 104 * b5 Peripheral initialization status 105 * 0 : Reset (Peripheral not initialized) 106 * 1 : Init done (Peripheral initialized) 107 * b4-b2 (not used) 108 * xxx : Should be set to 000 109 * b1 Rx state 110 * 0 : Ready (no Rx operation ongoing) 111 * 1 : Busy (Rx operation ongoing) 112 * b0 (not used) 113 * x : Should be set to 0. 114 */ 115 typedef uint32_t HAL_IRDA_StateTypeDef; 116 117 /** 118 * @brief IRDA clock sources definition 119 */ 120 typedef enum 121 { 122 IRDA_CLOCKSOURCE_PCLK1 = 0x00U, /*!< PCLK1 clock source */ 123 IRDA_CLOCKSOURCE_PCLK2 = 0x01U, /*!< PCLK2 clock source */ 124 IRDA_CLOCKSOURCE_HSI = 0x02U, /*!< HSI clock source */ 125 IRDA_CLOCKSOURCE_SYSCLK = 0x04U, /*!< SYSCLK clock source */ 126 IRDA_CLOCKSOURCE_LSE = 0x10U, /*!< LSE clock source */ 127 IRDA_CLOCKSOURCE_UNDEFINED = 0x20U /*!< Undefined clock source */ 128 } IRDA_ClockSourceTypeDef; 129 130 /** 131 * @brief IRDA handle Structure definition 132 */ 133 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1) 134 typedef struct __IRDA_HandleTypeDef 135 #else 136 typedef struct 137 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */ 138 { 139 USART_TypeDef *Instance; /*!< USART registers base address */ 140 141 IRDA_InitTypeDef Init; /*!< IRDA communication parameters */ 142 143 const uint8_t *pTxBuffPtr; /*!< Pointer to IRDA Tx transfer Buffer */ 144 145 uint16_t TxXferSize; /*!< IRDA Tx Transfer size */ 146 147 __IO uint16_t TxXferCount; /*!< IRDA Tx Transfer Counter */ 148 149 uint8_t *pRxBuffPtr; /*!< Pointer to IRDA Rx transfer Buffer */ 150 151 uint16_t RxXferSize; /*!< IRDA Rx Transfer size */ 152 153 __IO uint16_t RxXferCount; /*!< IRDA Rx Transfer Counter */ 154 155 uint16_t Mask; /*!< USART RX RDR register mask */ 156 157 DMA_HandleTypeDef *hdmatx; /*!< IRDA Tx DMA Handle parameters */ 158 159 DMA_HandleTypeDef *hdmarx; /*!< IRDA Rx DMA Handle parameters */ 160 161 HAL_LockTypeDef Lock; /*!< Locking object */ 162 163 __IO HAL_IRDA_StateTypeDef gState; /*!< IRDA state information related to global Handle management 164 and also related to Tx operations. 165 This parameter can be a value of @ref HAL_IRDA_StateTypeDef */ 166 167 __IO HAL_IRDA_StateTypeDef RxState; /*!< IRDA state information related to Rx operations. 168 This parameter can be a value of @ref HAL_IRDA_StateTypeDef */ 169 170 __IO uint32_t ErrorCode; /*!< IRDA Error code */ 171 172 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1) 173 void (* TxHalfCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Tx Half Complete Callback */ 174 175 void (* TxCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Tx Complete Callback */ 176 177 void (* RxHalfCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Rx Half Complete Callback */ 178 179 void (* RxCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Rx Complete Callback */ 180 181 void (* ErrorCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Error Callback */ 182 183 void (* AbortCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Abort Complete Callback */ 184 185 void (* AbortTransmitCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Abort Transmit Complete Callback */ 186 187 void (* AbortReceiveCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Abort Receive Complete Callback */ 188 189 190 void (* MspInitCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Msp Init callback */ 191 192 void (* MspDeInitCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Msp DeInit callback */ 193 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */ 194 195 } IRDA_HandleTypeDef; 196 197 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1) 198 /** 199 * @brief HAL IRDA Callback ID enumeration definition 200 */ 201 typedef enum 202 { 203 HAL_IRDA_TX_HALFCOMPLETE_CB_ID = 0x00U, /*!< IRDA Tx Half Complete Callback ID */ 204 HAL_IRDA_TX_COMPLETE_CB_ID = 0x01U, /*!< IRDA Tx Complete Callback ID */ 205 HAL_IRDA_RX_HALFCOMPLETE_CB_ID = 0x02U, /*!< IRDA Rx Half Complete Callback ID */ 206 HAL_IRDA_RX_COMPLETE_CB_ID = 0x03U, /*!< IRDA Rx Complete Callback ID */ 207 HAL_IRDA_ERROR_CB_ID = 0x04U, /*!< IRDA Error Callback ID */ 208 HAL_IRDA_ABORT_COMPLETE_CB_ID = 0x05U, /*!< IRDA Abort Complete Callback ID */ 209 HAL_IRDA_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x06U, /*!< IRDA Abort Transmit Complete Callback ID */ 210 HAL_IRDA_ABORT_RECEIVE_COMPLETE_CB_ID = 0x07U, /*!< IRDA Abort Receive Complete Callback ID */ 211 212 HAL_IRDA_MSPINIT_CB_ID = 0x08U, /*!< IRDA MspInit callback ID */ 213 HAL_IRDA_MSPDEINIT_CB_ID = 0x09U /*!< IRDA MspDeInit callback ID */ 214 215 } HAL_IRDA_CallbackIDTypeDef; 216 217 /** 218 * @brief HAL IRDA Callback pointer definition 219 */ 220 typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer to an IRDA callback function */ 221 222 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */ 223 224 /** 225 * @} 226 */ 227 228 /* Exported constants --------------------------------------------------------*/ 229 /** @defgroup IRDA_Exported_Constants IRDA Exported Constants 230 * @{ 231 */ 232 233 /** @defgroup IRDA_State_Definition IRDA State Code Definition 234 * @{ 235 */ 236 #define HAL_IRDA_STATE_RESET 0x00000000U /*!< Peripheral is not initialized 237 Value is allowed for gState and RxState */ 238 #define HAL_IRDA_STATE_READY 0x00000020U /*!< Peripheral Initialized and ready for use 239 Value is allowed for gState and RxState */ 240 #define HAL_IRDA_STATE_BUSY 0x00000024U /*!< An internal process is ongoing 241 Value is allowed for gState only */ 242 #define HAL_IRDA_STATE_BUSY_TX 0x00000021U /*!< Data Transmission process is ongoing 243 Value is allowed for gState only */ 244 #define HAL_IRDA_STATE_BUSY_RX 0x00000022U /*!< Data Reception process is ongoing 245 Value is allowed for RxState only */ 246 #define HAL_IRDA_STATE_BUSY_TX_RX 0x00000023U /*!< Data Transmission and Reception process is ongoing 247 Not to be used for neither gState nor RxState. 248 Value is result of combination (Or) between 249 gState and RxState values */ 250 #define HAL_IRDA_STATE_TIMEOUT 0x000000A0U /*!< Timeout state 251 Value is allowed for gState only */ 252 #define HAL_IRDA_STATE_ERROR 0x000000E0U /*!< Error 253 Value is allowed for gState only */ 254 /** 255 * @} 256 */ 257 258 /** @defgroup IRDA_Error_Definition IRDA Error Code Definition 259 * @{ 260 */ 261 #define HAL_IRDA_ERROR_NONE (0x00000000U) /*!< No error */ 262 #define HAL_IRDA_ERROR_PE (0x00000001U) /*!< Parity error */ 263 #define HAL_IRDA_ERROR_NE (0x00000002U) /*!< Noise error */ 264 #define HAL_IRDA_ERROR_FE (0x00000004U) /*!< frame error */ 265 #define HAL_IRDA_ERROR_ORE (0x00000008U) /*!< Overrun error */ 266 #define HAL_IRDA_ERROR_DMA (0x00000010U) /*!< DMA transfer error */ 267 #define HAL_IRDA_ERROR_BUSY (0x00000020U) /*!< Busy Error */ 268 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1) 269 #define HAL_IRDA_ERROR_INVALID_CALLBACK (0x00000040U) /*!< Invalid Callback error */ 270 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */ 271 /** 272 * @} 273 */ 274 275 /** @defgroup IRDA_Parity IRDA Parity 276 * @{ 277 */ 278 #define IRDA_PARITY_NONE 0x00000000U /*!< No parity */ 279 #define IRDA_PARITY_EVEN USART_CR1_PCE /*!< Even parity */ 280 #define IRDA_PARITY_ODD (USART_CR1_PCE | USART_CR1_PS) /*!< Odd parity */ 281 /** 282 * @} 283 */ 284 285 /** @defgroup IRDA_Transfer_Mode IRDA Transfer Mode 286 * @{ 287 */ 288 #define IRDA_MODE_RX USART_CR1_RE /*!< RX mode */ 289 #define IRDA_MODE_TX USART_CR1_TE /*!< TX mode */ 290 #define IRDA_MODE_TX_RX (USART_CR1_TE |USART_CR1_RE) /*!< RX and TX mode */ 291 /** 292 * @} 293 */ 294 295 /** @defgroup IRDA_Low_Power IRDA Low Power 296 * @{ 297 */ 298 #define IRDA_POWERMODE_NORMAL 0x00000000U /*!< IRDA normal power mode */ 299 #define IRDA_POWERMODE_LOWPOWER USART_CR3_IRLP /*!< IRDA low power mode */ 300 /** 301 * @} 302 */ 303 304 /** @defgroup IRDA_State IRDA State 305 * @{ 306 */ 307 #define IRDA_STATE_DISABLE 0x00000000U /*!< IRDA disabled */ 308 #define IRDA_STATE_ENABLE USART_CR1_UE /*!< IRDA enabled */ 309 /** 310 * @} 311 */ 312 313 /** @defgroup IRDA_Mode IRDA Mode 314 * @{ 315 */ 316 #define IRDA_MODE_DISABLE 0x00000000U /*!< Associated UART disabled in IRDA mode */ 317 #define IRDA_MODE_ENABLE USART_CR3_IREN /*!< Associated UART enabled in IRDA mode */ 318 /** 319 * @} 320 */ 321 322 /** @defgroup IRDA_One_Bit IRDA One Bit Sampling 323 * @{ 324 */ 325 #define IRDA_ONE_BIT_SAMPLE_DISABLE 0x00000000U /*!< One-bit sampling disabled */ 326 #define IRDA_ONE_BIT_SAMPLE_ENABLE USART_CR3_ONEBIT /*!< One-bit sampling enabled */ 327 /** 328 * @} 329 */ 330 331 /** @defgroup IRDA_DMA_Tx IRDA DMA Tx 332 * @{ 333 */ 334 #define IRDA_DMA_TX_DISABLE 0x00000000U /*!< IRDA DMA TX disabled */ 335 #define IRDA_DMA_TX_ENABLE USART_CR3_DMAT /*!< IRDA DMA TX enabled */ 336 /** 337 * @} 338 */ 339 340 /** @defgroup IRDA_DMA_Rx IRDA DMA Rx 341 * @{ 342 */ 343 #define IRDA_DMA_RX_DISABLE 0x00000000U /*!< IRDA DMA RX disabled */ 344 #define IRDA_DMA_RX_ENABLE USART_CR3_DMAR /*!< IRDA DMA RX enabled */ 345 /** 346 * @} 347 */ 348 349 /** @defgroup IRDA_Request_Parameters IRDA Request Parameters 350 * @{ 351 */ 352 #define IRDA_AUTOBAUD_REQUEST USART_RQR_ABRRQ /*!< Auto-Baud Rate Request */ 353 #define IRDA_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive Data flush Request */ 354 #define IRDA_TXDATA_FLUSH_REQUEST USART_RQR_TXFRQ /*!< Transmit data flush Request */ 355 /** 356 * @} 357 */ 358 359 /** @defgroup IRDA_Flags IRDA Flags 360 * Elements values convention: 0xXXXX 361 * - 0xXXXX : Flag mask in the ISR register 362 * @{ 363 */ 364 #define IRDA_FLAG_REACK USART_ISR_REACK /*!< IRDA receive enable acknowledge flag */ 365 #define IRDA_FLAG_TEACK USART_ISR_TEACK /*!< IRDA transmit enable acknowledge flag */ 366 #define IRDA_FLAG_BUSY USART_ISR_BUSY /*!< IRDA busy flag */ 367 #define IRDA_FLAG_ABRF USART_ISR_ABRF /*!< IRDA auto Baud rate flag */ 368 #define IRDA_FLAG_ABRE USART_ISR_ABRE /*!< IRDA auto Baud rate error */ 369 #define IRDA_FLAG_TXE USART_ISR_TXE /*!< IRDA transmit data register empty */ 370 #define IRDA_FLAG_TC USART_ISR_TC /*!< IRDA transmission complete */ 371 #define IRDA_FLAG_RXNE USART_ISR_RXNE /*!< IRDA read data register not empty */ 372 #define IRDA_FLAG_ORE USART_ISR_ORE /*!< IRDA overrun error */ 373 #define IRDA_FLAG_NE USART_ISR_NE /*!< IRDA noise error */ 374 #define IRDA_FLAG_FE USART_ISR_FE /*!< IRDA frame error */ 375 #define IRDA_FLAG_PE USART_ISR_PE /*!< IRDA parity error */ 376 /** 377 * @} 378 */ 379 380 /** @defgroup IRDA_Interrupt_definition IRDA Interrupts Definition 381 * Elements values convention: 0000ZZZZ0XXYYYYYb 382 * - YYYYY : Interrupt source position in the XX register (5bits) 383 * - XX : Interrupt source register (2bits) 384 * - 01: CR1 register 385 * - 10: CR2 register 386 * - 11: CR3 register 387 * - ZZZZ : Flag position in the ISR register(4bits) 388 * @{ 389 */ 390 #define IRDA_IT_PE 0x0028U /*!< IRDA Parity error interruption */ 391 #define IRDA_IT_TXE 0x0727U /*!< IRDA Transmit data register empty interruption */ 392 #define IRDA_IT_TC 0x0626U /*!< IRDA Transmission complete interruption */ 393 #define IRDA_IT_RXNE 0x0525U /*!< IRDA Read data register not empty interruption */ 394 #define IRDA_IT_IDLE 0x0424U /*!< IRDA Idle interruption */ 395 396 /* Elements values convention: 000000000XXYYYYYb 397 - YYYYY : Interrupt source position in the XX register (5bits) 398 - XX : Interrupt source register (2bits) 399 - 01: CR1 register 400 - 10: CR2 register 401 - 11: CR3 register */ 402 #define IRDA_IT_ERR 0x0060U /*!< IRDA Error interruption */ 403 404 /* Elements values convention: 0000ZZZZ00000000b 405 - ZZZZ : Flag position in the ISR register(4bits) */ 406 #define IRDA_IT_ORE 0x0300U /*!< IRDA Overrun error interruption */ 407 #define IRDA_IT_NE 0x0200U /*!< IRDA Noise error interruption */ 408 #define IRDA_IT_FE 0x0100U /*!< IRDA Frame error interruption */ 409 /** 410 * @} 411 */ 412 413 /** @defgroup IRDA_IT_CLEAR_Flags IRDA Interruption Clear Flags 414 * @{ 415 */ 416 #define IRDA_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */ 417 #define IRDA_CLEAR_FEF USART_ICR_FECF /*!< Framing Error Clear Flag */ 418 #define IRDA_CLEAR_NEF USART_ICR_NCF /*!< Noise Error detected Clear Flag */ 419 #define IRDA_CLEAR_OREF USART_ICR_ORECF /*!< OverRun Error Clear Flag */ 420 #define IRDA_CLEAR_IDLEF USART_ICR_IDLECF /*!< IDLE line detected Clear Flag */ 421 #define IRDA_CLEAR_TCF USART_ICR_TCCF /*!< Transmission Complete Clear Flag */ 422 /** 423 * @} 424 */ 425 426 /** @defgroup IRDA_Interruption_Mask IRDA interruptions flags mask 427 * @{ 428 */ 429 #define IRDA_IT_MASK 0x001FU /*!< IRDA Interruptions flags mask */ 430 #define IRDA_CR_MASK 0x00E0U /*!< IRDA control register mask */ 431 #define IRDA_CR_POS 5U /*!< IRDA control register position */ 432 #define IRDA_ISR_MASK 0x1F00U /*!< IRDA ISR register mask */ 433 #define IRDA_ISR_POS 8U /*!< IRDA ISR register position */ 434 /** 435 * @} 436 */ 437 438 /** 439 * @} 440 */ 441 442 /* Exported macros -----------------------------------------------------------*/ 443 /** @defgroup IRDA_Exported_Macros IRDA Exported Macros 444 * @{ 445 */ 446 447 /** @brief Reset IRDA handle state. 448 * @param __HANDLE__ IRDA handle. 449 * @retval None 450 */ 451 #if USE_HAL_IRDA_REGISTER_CALLBACKS == 1 452 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) do{ \ 453 (__HANDLE__)->gState = HAL_IRDA_STATE_RESET; \ 454 (__HANDLE__)->RxState = HAL_IRDA_STATE_RESET; \ 455 (__HANDLE__)->MspInitCallback = NULL; \ 456 (__HANDLE__)->MspDeInitCallback = NULL; \ 457 } while(0U) 458 #else 459 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) do{ \ 460 (__HANDLE__)->gState = HAL_IRDA_STATE_RESET; \ 461 (__HANDLE__)->RxState = HAL_IRDA_STATE_RESET; \ 462 } while(0U) 463 #endif /*USE_HAL_IRDA_REGISTER_CALLBACKS */ 464 465 /** @brief Flush the IRDA DR register. 466 * @param __HANDLE__ specifies the IRDA Handle. 467 * @retval None 468 */ 469 #define __HAL_IRDA_FLUSH_DRREGISTER(__HANDLE__) \ 470 do{ \ 471 SET_BIT((__HANDLE__)->Instance->RQR, IRDA_RXDATA_FLUSH_REQUEST); \ 472 SET_BIT((__HANDLE__)->Instance->RQR, IRDA_TXDATA_FLUSH_REQUEST); \ 473 } while(0U) 474 475 /** @brief Clear the specified IRDA pending flag. 476 * @param __HANDLE__ specifies the IRDA Handle. 477 * @param __FLAG__ specifies the flag to check. 478 * This parameter can be any combination of the following values: 479 * @arg @ref IRDA_CLEAR_PEF 480 * @arg @ref IRDA_CLEAR_FEF 481 * @arg @ref IRDA_CLEAR_NEF 482 * @arg @ref IRDA_CLEAR_OREF 483 * @arg @ref IRDA_CLEAR_TCF 484 * @arg @ref IRDA_CLEAR_IDLEF 485 * @retval None 486 */ 487 #define __HAL_IRDA_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__)) 488 489 /** @brief Clear the IRDA PE pending flag. 490 * @param __HANDLE__ specifies the IRDA Handle. 491 * @retval None 492 */ 493 #define __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_PEF) 494 495 496 /** @brief Clear the IRDA FE pending flag. 497 * @param __HANDLE__ specifies the IRDA Handle. 498 * @retval None 499 */ 500 #define __HAL_IRDA_CLEAR_FEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_FEF) 501 502 /** @brief Clear the IRDA NE pending flag. 503 * @param __HANDLE__ specifies the IRDA Handle. 504 * @retval None 505 */ 506 #define __HAL_IRDA_CLEAR_NEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_NEF) 507 508 /** @brief Clear the IRDA ORE pending flag. 509 * @param __HANDLE__ specifies the IRDA Handle. 510 * @retval None 511 */ 512 #define __HAL_IRDA_CLEAR_OREFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_OREF) 513 514 /** @brief Clear the IRDA IDLE pending flag. 515 * @param __HANDLE__ specifies the IRDA Handle. 516 * @retval None 517 */ 518 #define __HAL_IRDA_CLEAR_IDLEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_IDLEF) 519 520 /** @brief Check whether the specified IRDA flag is set or not. 521 * @param __HANDLE__ specifies the IRDA Handle. 522 * @param __FLAG__ specifies the flag to check. 523 * This parameter can be one of the following values: 524 * @arg @ref IRDA_FLAG_REACK Receive enable acknowledge flag 525 * @arg @ref IRDA_FLAG_TEACK Transmit enable acknowledge flag 526 * @arg @ref IRDA_FLAG_BUSY Busy flag 527 * @arg @ref IRDA_FLAG_ABRF Auto Baud rate detection flag 528 * @arg @ref IRDA_FLAG_ABRE Auto Baud rate detection error flag 529 * @arg @ref IRDA_FLAG_TXE Transmit data register empty flag 530 * @arg @ref IRDA_FLAG_TC Transmission Complete flag 531 * @arg @ref IRDA_FLAG_RXNE Receive data register not empty flag 532 * @arg @ref IRDA_FLAG_ORE OverRun Error flag 533 * @arg @ref IRDA_FLAG_NE Noise Error flag 534 * @arg @ref IRDA_FLAG_FE Framing Error flag 535 * @arg @ref IRDA_FLAG_PE Parity Error flag 536 * @retval The new state of __FLAG__ (TRUE or FALSE). 537 */ 538 #define __HAL_IRDA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__)) 539 540 541 /** @brief Enable the specified IRDA interrupt. 542 * @param __HANDLE__ specifies the IRDA Handle. 543 * @param __INTERRUPT__ specifies the IRDA interrupt source to enable. 544 * This parameter can be one of the following values: 545 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt 546 * @arg @ref IRDA_IT_TC Transmission complete interrupt 547 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt 548 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt 549 * @arg @ref IRDA_IT_PE Parity Error interrupt 550 * @arg @ref IRDA_IT_ERR Error interrupt(Frame error, noise error, overrun error) 551 * @retval None 552 */ 553 #define __HAL_IRDA_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 1U)? \ 554 ((__HANDLE__)->Instance->CR1 |= (1U << \ 555 ((__INTERRUPT__) & IRDA_IT_MASK))):\ 556 ((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 2U)? \ 557 ((__HANDLE__)->Instance->CR2 |= (1U << \ 558 ((__INTERRUPT__) & IRDA_IT_MASK))):\ 559 ((__HANDLE__)->Instance->CR3 |= (1U << \ 560 ((__INTERRUPT__) & IRDA_IT_MASK)))) 561 562 /** @brief Disable the specified IRDA interrupt. 563 * @param __HANDLE__ specifies the IRDA Handle. 564 * @param __INTERRUPT__ specifies the IRDA interrupt source to disable. 565 * This parameter can be one of the following values: 566 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt 567 * @arg @ref IRDA_IT_TC Transmission complete interrupt 568 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt 569 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt 570 * @arg @ref IRDA_IT_PE Parity Error interrupt 571 * @arg @ref IRDA_IT_ERR Error interrupt(Frame error, noise error, overrun error) 572 * @retval None 573 */ 574 #define __HAL_IRDA_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 1U)? \ 575 ((__HANDLE__)->Instance->CR1 &= ~ (1U << \ 576 ((__INTERRUPT__) & IRDA_IT_MASK))): \ 577 ((((__INTERRUPT__) & IRDA_CR_MASK) >> IRDA_CR_POS) == 2U)? \ 578 ((__HANDLE__)->Instance->CR2 &= ~ (1U << \ 579 ((__INTERRUPT__) & IRDA_IT_MASK))): \ 580 ((__HANDLE__)->Instance->CR3 &= ~ (1U << \ 581 ((__INTERRUPT__) & IRDA_IT_MASK)))) 582 583 /** @brief Check whether the specified IRDA interrupt has occurred or not. 584 * @param __HANDLE__ specifies the IRDA Handle. 585 * @param __INTERRUPT__ specifies the IRDA interrupt source to check. 586 * This parameter can be one of the following values: 587 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt 588 * @arg @ref IRDA_IT_TC Transmission complete interrupt 589 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt 590 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt 591 * @arg @ref IRDA_IT_ORE OverRun Error interrupt 592 * @arg @ref IRDA_IT_NE Noise Error interrupt 593 * @arg @ref IRDA_IT_FE Framing Error interrupt 594 * @arg @ref IRDA_IT_PE Parity Error interrupt 595 * @retval The new state of __IT__ (SET or RESET). 596 */ 597 #define __HAL_IRDA_GET_IT(__HANDLE__, __INTERRUPT__) \ 598 ((((__HANDLE__)->Instance->ISR& (0x01U << (((__INTERRUPT__) & IRDA_ISR_MASK)>>IRDA_ISR_POS))) != 0U) ? SET : RESET) 599 600 /** @brief Check whether the specified IRDA interrupt source is enabled or not. 601 * @param __HANDLE__ specifies the IRDA Handle. 602 * @param __INTERRUPT__ specifies the IRDA interrupt source to check. 603 * This parameter can be one of the following values: 604 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt 605 * @arg @ref IRDA_IT_TC Transmission complete interrupt 606 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt 607 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt 608 * @arg @ref IRDA_IT_ERR Framing, overrun or noise error interrupt 609 * @arg @ref IRDA_IT_PE Parity Error interrupt 610 * @retval The new state of __IT__ (SET or RESET). 611 */ 612 #define __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) \ 613 ((((((((__INTERRUPT__) & IRDA_CR_MASK) >>IRDA_CR_POS) == 0x01U)? (__HANDLE__)->Instance->CR1 :(((((__INTERRUPT__) \ 614 & IRDA_CR_MASK) >> IRDA_CR_POS)== 0x02U)? (__HANDLE__)->Instance->CR2 :(__HANDLE__)->Instance->CR3)) \ 615 & (0x01U <<(((uint16_t)(__INTERRUPT__)) & IRDA_IT_MASK))) != 0U) ? SET : RESET) 616 617 /** @brief Clear the specified IRDA ISR flag, in setting the proper ICR register flag. 618 * @param __HANDLE__ specifies the IRDA Handle. 619 * @param __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set 620 * to clear the corresponding interrupt 621 * This parameter can be one of the following values: 622 * @arg @ref IRDA_CLEAR_PEF Parity Error Clear Flag 623 * @arg @ref IRDA_CLEAR_FEF Framing Error Clear Flag 624 * @arg @ref IRDA_CLEAR_NEF Noise detected Clear Flag 625 * @arg @ref IRDA_CLEAR_OREF OverRun Error Clear Flag 626 * @arg @ref IRDA_CLEAR_TCF Transmission Complete Clear Flag 627 * @retval None 628 */ 629 #define __HAL_IRDA_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__)) 630 631 632 /** @brief Set a specific IRDA request flag. 633 * @param __HANDLE__ specifies the IRDA Handle. 634 * @param __REQ__ specifies the request flag to set 635 * This parameter can be one of the following values: 636 * @arg @ref IRDA_AUTOBAUD_REQUEST Auto-Baud Rate Request 637 * @arg @ref IRDA_RXDATA_FLUSH_REQUEST Receive Data flush Request 638 * @arg @ref IRDA_TXDATA_FLUSH_REQUEST Transmit data flush Request 639 * @retval None 640 */ 641 #define __HAL_IRDA_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__)) 642 643 /** @brief Enable the IRDA one bit sample method. 644 * @param __HANDLE__ specifies the IRDA Handle. 645 * @retval None 646 */ 647 #define __HAL_IRDA_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT) 648 649 /** @brief Disable the IRDA one bit sample method. 650 * @param __HANDLE__ specifies the IRDA Handle. 651 * @retval None 652 */ 653 #define __HAL_IRDA_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3\ 654 &= (uint32_t)~((uint32_t)USART_CR3_ONEBIT)) 655 656 /** @brief Enable UART/USART associated to IRDA Handle. 657 * @param __HANDLE__ specifies the IRDA Handle. 658 * @retval None 659 */ 660 #define __HAL_IRDA_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE) 661 662 /** @brief Disable UART/USART associated to IRDA Handle. 663 * @param __HANDLE__ specifies the IRDA Handle. 664 * @retval None 665 */ 666 #define __HAL_IRDA_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE) 667 668 /** 669 * @} 670 */ 671 672 /* Private macros --------------------------------------------------------*/ 673 /** @addtogroup IRDA_Private_Macros 674 * @{ 675 */ 676 677 /** @brief Ensure that IRDA Baud rate is less or equal to maximum value. 678 * @param __BAUDRATE__ specifies the IRDA Baudrate set by the user. 679 * @retval True or False 680 */ 681 #define IS_IRDA_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 115201U) 682 683 /** @brief Ensure that IRDA prescaler value is strictly larger than 0. 684 * @param __PRESCALER__ specifies the IRDA prescaler value set by the user. 685 * @retval True or False 686 */ 687 #define IS_IRDA_PRESCALER(__PRESCALER__) ((__PRESCALER__) > 0U) 688 689 /** @brief Ensure that IRDA frame parity is valid. 690 * @param __PARITY__ IRDA frame parity. 691 * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid) 692 */ 693 #define IS_IRDA_PARITY(__PARITY__) (((__PARITY__) == IRDA_PARITY_NONE) || \ 694 ((__PARITY__) == IRDA_PARITY_EVEN) || \ 695 ((__PARITY__) == IRDA_PARITY_ODD)) 696 697 /** @brief Ensure that IRDA communication mode is valid. 698 * @param __MODE__ IRDA communication mode. 699 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid) 700 */ 701 #define IS_IRDA_TX_RX_MODE(__MODE__) ((((__MODE__)\ 702 & (~((uint32_t)(IRDA_MODE_TX_RX)))) == 0x00U) && ((__MODE__) != 0x00U)) 703 704 /** @brief Ensure that IRDA power mode is valid. 705 * @param __MODE__ IRDA power mode. 706 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid) 707 */ 708 #define IS_IRDA_POWERMODE(__MODE__) (((__MODE__) == IRDA_POWERMODE_LOWPOWER) || \ 709 ((__MODE__) == IRDA_POWERMODE_NORMAL)) 710 711 /** @brief Ensure that IRDA state is valid. 712 * @param __STATE__ IRDA state mode. 713 * @retval SET (__STATE__ is valid) or RESET (__STATE__ is invalid) 714 */ 715 #define IS_IRDA_STATE(__STATE__) (((__STATE__) == IRDA_STATE_DISABLE) || \ 716 ((__STATE__) == IRDA_STATE_ENABLE)) 717 718 /** @brief Ensure that IRDA associated UART/USART mode is valid. 719 * @param __MODE__ IRDA associated UART/USART mode. 720 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid) 721 */ 722 #define IS_IRDA_MODE(__MODE__) (((__MODE__) == IRDA_MODE_DISABLE) || \ 723 ((__MODE__) == IRDA_MODE_ENABLE)) 724 725 /** @brief Ensure that IRDA sampling rate is valid. 726 * @param __ONEBIT__ IRDA sampling rate. 727 * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid) 728 */ 729 #define IS_IRDA_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == IRDA_ONE_BIT_SAMPLE_DISABLE) || \ 730 ((__ONEBIT__) == IRDA_ONE_BIT_SAMPLE_ENABLE)) 731 732 /** @brief Ensure that IRDA DMA TX mode is valid. 733 * @param __DMATX__ IRDA DMA TX mode. 734 * @retval SET (__DMATX__ is valid) or RESET (__DMATX__ is invalid) 735 */ 736 #define IS_IRDA_DMA_TX(__DMATX__) (((__DMATX__) == IRDA_DMA_TX_DISABLE) || \ 737 ((__DMATX__) == IRDA_DMA_TX_ENABLE)) 738 739 /** @brief Ensure that IRDA DMA RX mode is valid. 740 * @param __DMARX__ IRDA DMA RX mode. 741 * @retval SET (__DMARX__ is valid) or RESET (__DMARX__ is invalid) 742 */ 743 #define IS_IRDA_DMA_RX(__DMARX__) (((__DMARX__) == IRDA_DMA_RX_DISABLE) || \ 744 ((__DMARX__) == IRDA_DMA_RX_ENABLE)) 745 746 /** @brief Ensure that IRDA request is valid. 747 * @param __PARAM__ IRDA request. 748 * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid) 749 */ 750 #define IS_IRDA_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == IRDA_AUTOBAUD_REQUEST) || \ 751 ((__PARAM__) == IRDA_RXDATA_FLUSH_REQUEST) || \ 752 ((__PARAM__) == IRDA_TXDATA_FLUSH_REQUEST)) 753 /** 754 * @} 755 */ 756 757 /* Include IRDA HAL Extended module */ 758 #include "stm32f3xx_hal_irda_ex.h" 759 760 /* Exported functions --------------------------------------------------------*/ 761 /** @addtogroup IRDA_Exported_Functions IRDA Exported Functions 762 * @{ 763 */ 764 765 /** @addtogroup IRDA_Exported_Functions_Group1 Initialization and de-initialization functions 766 * @{ 767 */ 768 769 /* Initialization and de-initialization functions ****************************/ 770 HAL_StatusTypeDef HAL_IRDA_Init(IRDA_HandleTypeDef *hirda); 771 HAL_StatusTypeDef HAL_IRDA_DeInit(IRDA_HandleTypeDef *hirda); 772 void HAL_IRDA_MspInit(IRDA_HandleTypeDef *hirda); 773 void HAL_IRDA_MspDeInit(IRDA_HandleTypeDef *hirda); 774 775 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1) 776 /* Callbacks Register/UnRegister functions ***********************************/ 777 HAL_StatusTypeDef HAL_IRDA_RegisterCallback(IRDA_HandleTypeDef *hirda, HAL_IRDA_CallbackIDTypeDef CallbackID, 778 pIRDA_CallbackTypeDef pCallback); 779 HAL_StatusTypeDef HAL_IRDA_UnRegisterCallback(IRDA_HandleTypeDef *hirda, HAL_IRDA_CallbackIDTypeDef CallbackID); 780 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */ 781 782 /** 783 * @} 784 */ 785 786 /** @addtogroup IRDA_Exported_Functions_Group2 IO operation functions 787 * @{ 788 */ 789 790 /* IO operation functions *****************************************************/ 791 HAL_StatusTypeDef HAL_IRDA_Transmit(IRDA_HandleTypeDef *hirda, const uint8_t *pData, uint16_t Size, uint32_t Timeout); 792 HAL_StatusTypeDef HAL_IRDA_Receive(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout); 793 HAL_StatusTypeDef HAL_IRDA_Transmit_IT(IRDA_HandleTypeDef *hirda, const uint8_t *pData, uint16_t Size); 794 HAL_StatusTypeDef HAL_IRDA_Receive_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size); 795 HAL_StatusTypeDef HAL_IRDA_Transmit_DMA(IRDA_HandleTypeDef *hirda, const uint8_t *pData, uint16_t Size); 796 HAL_StatusTypeDef HAL_IRDA_Receive_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size); 797 HAL_StatusTypeDef HAL_IRDA_DMAPause(IRDA_HandleTypeDef *hirda); 798 HAL_StatusTypeDef HAL_IRDA_DMAResume(IRDA_HandleTypeDef *hirda); 799 HAL_StatusTypeDef HAL_IRDA_DMAStop(IRDA_HandleTypeDef *hirda); 800 /* Transfer Abort functions */ 801 HAL_StatusTypeDef HAL_IRDA_Abort(IRDA_HandleTypeDef *hirda); 802 HAL_StatusTypeDef HAL_IRDA_AbortTransmit(IRDA_HandleTypeDef *hirda); 803 HAL_StatusTypeDef HAL_IRDA_AbortReceive(IRDA_HandleTypeDef *hirda); 804 HAL_StatusTypeDef HAL_IRDA_Abort_IT(IRDA_HandleTypeDef *hirda); 805 HAL_StatusTypeDef HAL_IRDA_AbortTransmit_IT(IRDA_HandleTypeDef *hirda); 806 HAL_StatusTypeDef HAL_IRDA_AbortReceive_IT(IRDA_HandleTypeDef *hirda); 807 808 void HAL_IRDA_IRQHandler(IRDA_HandleTypeDef *hirda); 809 void HAL_IRDA_TxCpltCallback(IRDA_HandleTypeDef *hirda); 810 void HAL_IRDA_RxCpltCallback(IRDA_HandleTypeDef *hirda); 811 void HAL_IRDA_TxHalfCpltCallback(IRDA_HandleTypeDef *hirda); 812 void HAL_IRDA_RxHalfCpltCallback(IRDA_HandleTypeDef *hirda); 813 void HAL_IRDA_ErrorCallback(IRDA_HandleTypeDef *hirda); 814 void HAL_IRDA_AbortCpltCallback(IRDA_HandleTypeDef *hirda); 815 void HAL_IRDA_AbortTransmitCpltCallback(IRDA_HandleTypeDef *hirda); 816 void HAL_IRDA_AbortReceiveCpltCallback(IRDA_HandleTypeDef *hirda); 817 818 /** 819 * @} 820 */ 821 822 /* Peripheral Control functions ************************************************/ 823 824 /** @addtogroup IRDA_Exported_Functions_Group4 Peripheral State and Error functions 825 * @{ 826 */ 827 828 /* Peripheral State and Error functions ***************************************/ 829 HAL_IRDA_StateTypeDef HAL_IRDA_GetState(const IRDA_HandleTypeDef *hirda); 830 uint32_t HAL_IRDA_GetError(const IRDA_HandleTypeDef *hirda); 831 832 /** 833 * @} 834 */ 835 836 /** 837 * @} 838 */ 839 840 /** 841 * @} 842 */ 843 844 /** 845 * @} 846 */ 847 848 #ifdef __cplusplus 849 } 850 #endif 851 852 #endif /* STM32F3xx_HAL_IRDA_H */ 853 854
