|
STM32L486xx HAL User Manual
|
00001 /** 00002 ****************************************************************************** 00003 * @file stm32l4xx_hal_irda.h 00004 * @author MCD Application Team 00005 * @brief Header file of IRDA HAL module. 00006 ****************************************************************************** 00007 * @attention 00008 * 00009 * <h2><center>© COPYRIGHT(c) 2017 STMicroelectronics</center></h2> 00010 * 00011 * Redistribution and use in source and binary forms, with or without modification, 00012 * are permitted provided that the following conditions are met: 00013 * 1. Redistributions of source code must retain the above copyright notice, 00014 * this list of conditions and the following disclaimer. 00015 * 2. Redistributions in binary form must reproduce the above copyright notice, 00016 * this list of conditions and the following disclaimer in the documentation 00017 * and/or other materials provided with the distribution. 00018 * 3. Neither the name of STMicroelectronics nor the names of its contributors 00019 * may be used to endorse or promote products derived from this software 00020 * without specific prior written permission. 00021 * 00022 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 00023 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00024 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 00025 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 00026 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 00027 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 00028 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 00029 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 00030 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 00031 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00032 * 00033 ****************************************************************************** 00034 */ 00035 00036 /* Define to prevent recursive inclusion -------------------------------------*/ 00037 #ifndef __STM32L4xx_HAL_IRDA_H 00038 #define __STM32L4xx_HAL_IRDA_H 00039 00040 #ifdef __cplusplus 00041 extern "C" { 00042 #endif 00043 00044 /* Includes ------------------------------------------------------------------*/ 00045 #include "stm32l4xx_hal_def.h" 00046 00047 /** @addtogroup STM32L4xx_HAL_Driver 00048 * @{ 00049 */ 00050 00051 /** @addtogroup IRDA 00052 * @{ 00053 */ 00054 00055 /* Exported types ------------------------------------------------------------*/ 00056 /** @defgroup IRDA_Exported_Types IRDA Exported Types 00057 * @{ 00058 */ 00059 00060 /** 00061 * @brief IRDA Init Structure definition 00062 */ 00063 typedef struct 00064 { 00065 uint32_t BaudRate; /*!< This member configures the IRDA communication baud rate. 00066 The baud rate register is computed using the following formula: 00067 Baud Rate Register = ((usart_ker_ckpres) / ((hirda->Init.BaudRate))) 00068 where usart_ker_ckpres is the IRDA input clock divided by a prescaler */ 00069 00070 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame. 00071 This parameter can be a value of @ref IRDA_Word_Length */ 00072 00073 uint32_t Parity; /*!< Specifies the parity mode. 00074 This parameter can be a value of @ref IRDA_Parity 00075 @note When parity is enabled, the computed parity is inserted 00076 at the MSB position of the transmitted data (9th bit when 00077 the word length is set to 9 data bits; 8th bit when the 00078 word length is set to 8 data bits). */ 00079 00080 uint32_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled. 00081 This parameter can be a value of @ref IRDA_Transfer_Mode */ 00082 00083 uint8_t Prescaler; /*!< Specifies the Prescaler value for dividing the UART/USART source clock 00084 to achieve low-power frequency. 00085 @note Prescaler value 0 is forbidden */ 00086 00087 uint16_t PowerMode; /*!< Specifies the IRDA power mode. 00088 This parameter can be a value of @ref IRDA_Low_Power */ 00089 00090 #if defined(USART_PRESC_PRESCALER) 00091 uint32_t ClockPrescaler; /*!< Specifies the prescaler value used to divide the IRDA clock source. 00092 This parameter can be a value of @ref IRDA_ClockPrescaler. */ 00093 #endif 00094 00095 } IRDA_InitTypeDef; 00096 00097 /** 00098 * @brief HAL IRDA State structures definition 00099 * @note HAL IRDA State value is a combination of 2 different substates: gState and RxState. 00100 * - gState contains IRDA state information related to global Handle management 00101 * and also information related to Tx operations. 00102 * gState value coding follow below described bitmap : 00103 * b7-b6 Error information 00104 * 00 : No Error 00105 * 01 : (Not Used) 00106 * 10 : Timeout 00107 * 11 : Error 00108 * b5 IP initilisation status 00109 * 0 : Reset (IP not initialized) 00110 * 1 : Init done (IP not initialized. HAL IRDA Init function already called) 00111 * b4-b3 (not used) 00112 * xx : Should be set to 00 00113 * b2 Intrinsic process state 00114 * 0 : Ready 00115 * 1 : Busy (IP busy with some configuration or internal operations) 00116 * b1 (not used) 00117 * x : Should be set to 0 00118 * b0 Tx state 00119 * 0 : Ready (no Tx operation ongoing) 00120 * 1 : Busy (Tx operation ongoing) 00121 * - RxState contains information related to Rx operations. 00122 * RxState value coding follow below described bitmap : 00123 * b7-b6 (not used) 00124 * xx : Should be set to 00 00125 * b5 IP initilisation status 00126 * 0 : Reset (IP not initialized) 00127 * 1 : Init done (IP not initialized) 00128 * b4-b2 (not used) 00129 * xxx : Should be set to 000 00130 * b1 Rx state 00131 * 0 : Ready (no Rx operation ongoing) 00132 * 1 : Busy (Rx operation ongoing) 00133 * b0 (not used) 00134 * x : Should be set to 0. 00135 */ 00136 typedef enum 00137 { 00138 HAL_IRDA_STATE_RESET = 0x00U, /*!< Peripheral is not initialized 00139 Value is allowed for gState and RxState */ 00140 HAL_IRDA_STATE_READY = 0x20U, /*!< Peripheral Initialized and ready for use 00141 Value is allowed for gState and RxState */ 00142 HAL_IRDA_STATE_BUSY = 0x24U, /*!< an internal process is ongoing 00143 Value is allowed for gState only */ 00144 HAL_IRDA_STATE_BUSY_TX = 0x21U, /*!< Data Transmission process is ongoing 00145 Value is allowed for gState only */ 00146 HAL_IRDA_STATE_BUSY_RX = 0x22U, /*!< Data Reception process is ongoing 00147 Value is allowed for RxState only */ 00148 HAL_IRDA_STATE_BUSY_TX_RX = 0x23U, /*!< Data Transmission and Reception process is ongoing 00149 Not to be used for neither gState nor RxState. 00150 Value is result of combination (Or) between gState and RxState values */ 00151 HAL_IRDA_STATE_TIMEOUT = 0xA0U, /*!< Timeout state 00152 Value is allowed for gState only */ 00153 HAL_IRDA_STATE_ERROR = 0xE0U /*!< Error 00154 Value is allowed for gState only */ 00155 } HAL_IRDA_StateTypeDef; 00156 00157 /** 00158 * @brief IRDA clock sources definition 00159 */ 00160 typedef enum 00161 { 00162 IRDA_CLOCKSOURCE_PCLK1 = 0x00U, /*!< PCLK1 clock source */ 00163 IRDA_CLOCKSOURCE_PCLK2 = 0x01U, /*!< PCLK2 clock source */ 00164 IRDA_CLOCKSOURCE_HSI = 0x02U, /*!< HSI clock source */ 00165 IRDA_CLOCKSOURCE_SYSCLK = 0x04U, /*!< SYSCLK clock source */ 00166 IRDA_CLOCKSOURCE_LSE = 0x08U, /*!< LSE clock source */ 00167 IRDA_CLOCKSOURCE_UNDEFINED = 0x10U /*!< Undefined clock source */ 00168 } IRDA_ClockSourceTypeDef; 00169 00170 /** 00171 * @brief IRDA handle Structure definition 00172 */ 00173 typedef struct __IRDA_HandleTypeDef 00174 { 00175 USART_TypeDef *Instance; /*!< USART registers base address */ 00176 00177 IRDA_InitTypeDef Init; /*!< IRDA communication parameters */ 00178 00179 uint8_t *pTxBuffPtr; /*!< Pointer to IRDA Tx transfer Buffer */ 00180 00181 uint16_t TxXferSize; /*!< IRDA Tx Transfer size */ 00182 00183 __IO uint16_t TxXferCount; /*!< IRDA Tx Transfer Counter */ 00184 00185 uint8_t *pRxBuffPtr; /*!< Pointer to IRDA Rx transfer Buffer */ 00186 00187 uint16_t RxXferSize; /*!< IRDA Rx Transfer size */ 00188 00189 __IO uint16_t RxXferCount; /*!< IRDA Rx Transfer Counter */ 00190 00191 uint16_t Mask; /*!< USART RX RDR register mask */ 00192 00193 DMA_HandleTypeDef *hdmatx; /*!< IRDA Tx DMA Handle parameters */ 00194 00195 DMA_HandleTypeDef *hdmarx; /*!< IRDA Rx DMA Handle parameters */ 00196 00197 HAL_LockTypeDef Lock; /*!< Locking object */ 00198 00199 __IO HAL_IRDA_StateTypeDef gState; /*!< IRDA state information related to global Handle management 00200 and also related to Tx operations. 00201 This parameter can be a value of @ref HAL_IRDA_StateTypeDef */ 00202 00203 __IO HAL_IRDA_StateTypeDef RxState; /*!< IRDA state information related to Rx operations. 00204 This parameter can be a value of @ref HAL_IRDA_StateTypeDef */ 00205 00206 uint32_t ErrorCode; /*!< IRDA Error code */ 00207 00208 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1) 00209 void (* TxHalfCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Tx Half Complete Callback */ 00210 00211 void (* TxCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Tx Complete Callback */ 00212 00213 void (* RxHalfCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Rx Half Complete Callback */ 00214 00215 void (* RxCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Rx Complete Callback */ 00216 00217 void (* ErrorCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Error Callback */ 00218 00219 void (* AbortCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Abort Complete Callback */ 00220 00221 void (* AbortTransmitCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Abort Transmit Complete Callback */ 00222 00223 void (* AbortReceiveCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Abort Receive Complete Callback */ 00224 00225 00226 void (* MspInitCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Msp Init callback */ 00227 00228 void (* MspDeInitCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Msp DeInit callback */ 00229 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */ 00230 00231 } IRDA_HandleTypeDef; 00232 00233 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1) 00234 /** 00235 * @brief HAL IRDA Callback ID enumeration definition 00236 */ 00237 typedef enum 00238 { 00239 HAL_IRDA_TX_HALFCOMPLETE_CB_ID = 0x00U, /*!< IRDA Tx Half Complete Callback ID */ 00240 HAL_IRDA_TX_COMPLETE_CB_ID = 0x01U, /*!< IRDA Tx Complete Callback ID */ 00241 HAL_IRDA_RX_HALFCOMPLETE_CB_ID = 0x02U, /*!< IRDA Rx Half Complete Callback ID */ 00242 HAL_IRDA_RX_COMPLETE_CB_ID = 0x03U, /*!< IRDA Rx Complete Callback ID */ 00243 HAL_IRDA_ERROR_CB_ID = 0x04U, /*!< IRDA Error Callback ID */ 00244 HAL_IRDA_ABORT_COMPLETE_CB_ID = 0x05U, /*!< IRDA Abort Complete Callback ID */ 00245 HAL_IRDA_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x06U, /*!< IRDA Abort Transmit Complete Callback ID */ 00246 HAL_IRDA_ABORT_RECEIVE_COMPLETE_CB_ID = 0x07U, /*!< IRDA Abort Receive Complete Callback ID */ 00247 00248 HAL_IRDA_MSPINIT_CB_ID = 0x08U, /*!< IRDA MspInit callback ID */ 00249 HAL_IRDA_MSPDEINIT_CB_ID = 0x09U /*!< IRDA MspDeInit callback ID */ 00250 00251 } HAL_IRDA_CallbackIDTypeDef; 00252 00253 /** 00254 * @brief HAL IRDA Callback pointer definition 00255 */ 00256 typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer to an IRDA callback function */ 00257 00258 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */ 00259 00260 /** 00261 * @brief IRDA Configuration enumeration values definition 00262 */ 00263 typedef enum 00264 { 00265 IRDA_BAUDRATE = 0x00U, /*!< IRDA Baud rate */ 00266 IRDA_PARITY = 0x01U, /*!< IRDA frame parity */ 00267 IRDA_WORDLENGTH = 0x02U, /*!< IRDA frame length */ 00268 IRDA_MODE = 0x03U, /*!< IRDA communication mode */ 00269 IRDA_PRESCALER = 0x04U, /*!< IRDA prescaling */ 00270 IRDA_POWERMODE = 0x05U /*!< IRDA power mode */ 00271 } IRDA_ControlTypeDef; 00272 00273 /** 00274 * @} 00275 */ 00276 00277 /* Exported constants --------------------------------------------------------*/ 00278 /** @defgroup IRDA_Exported_Constants IRDA Exported Constants 00279 * @{ 00280 */ 00281 00282 /** @defgroup IRDA_Error_Definition IRDA Error Code Definition 00283 * @{ 00284 */ 00285 #define HAL_IRDA_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */ 00286 #define HAL_IRDA_ERROR_PE ((uint32_t)0x00000001U) /*!< Parity error */ 00287 #define HAL_IRDA_ERROR_NE ((uint32_t)0x00000002U) /*!< Noise error */ 00288 #define HAL_IRDA_ERROR_FE ((uint32_t)0x00000004U) /*!< frame error */ 00289 #define HAL_IRDA_ERROR_ORE ((uint32_t)0x00000008U) /*!< Overrun error */ 00290 #define HAL_IRDA_ERROR_DMA ((uint32_t)0x00000010U) /*!< DMA transfer error */ 00291 #define HAL_IRDA_ERROR_BUSY ((uint32_t)0x00000020U) /*!< Busy Error */ 00292 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1) 00293 #define HAL_IRDA_ERROR_INVALID_CALLBACK ((uint32_t)0x00000040U) /*!< Invalid Callback error */ 00294 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */ 00295 /** 00296 * @} 00297 */ 00298 00299 /** @defgroup IRDA_Word_Length IRDA Word Length 00300 * @{ 00301 */ 00302 #define IRDA_WORDLENGTH_7B USART_CR1_M1 /*!< 7-bit long frame */ 00303 #define IRDA_WORDLENGTH_8B 0x00000000U /*!< 8-bit long frame */ 00304 #define IRDA_WORDLENGTH_9B USART_CR1_M0 /*!< 9-bit long frame */ 00305 /** 00306 * @} 00307 */ 00308 00309 /** @defgroup IRDA_Parity IRDA Parity 00310 * @{ 00311 */ 00312 #define IRDA_PARITY_NONE 0x00000000U /*!< No parity */ 00313 #define IRDA_PARITY_EVEN USART_CR1_PCE /*!< Even parity */ 00314 #define IRDA_PARITY_ODD (USART_CR1_PCE | USART_CR1_PS) /*!< Odd parity */ 00315 /** 00316 * @} 00317 */ 00318 00319 /** @defgroup IRDA_Transfer_Mode IRDA Transfer Mode 00320 * @{ 00321 */ 00322 #define IRDA_MODE_RX USART_CR1_RE /*!< RX mode */ 00323 #define IRDA_MODE_TX USART_CR1_TE /*!< TX mode */ 00324 #define IRDA_MODE_TX_RX (USART_CR1_TE |USART_CR1_RE) /*!< RX and TX mode */ 00325 /** 00326 * @} 00327 */ 00328 00329 /** @defgroup IRDA_Low_Power IRDA Low Power 00330 * @{ 00331 */ 00332 #define IRDA_POWERMODE_NORMAL 0x00000000U /*!< IRDA normal power mode */ 00333 #define IRDA_POWERMODE_LOWPOWER USART_CR3_IRLP /*!< IRDA low power mode */ 00334 /** 00335 * @} 00336 */ 00337 00338 #if defined(USART_PRESC_PRESCALER) 00339 /** @defgroup IRDA_ClockPrescaler Clock Prescaler 00340 * @{ 00341 */ 00342 #define IRDA_PRESCALER_DIV1 0x00000000U /*!< fclk_pres = fclk */ 00343 #define IRDA_PRESCALER_DIV2 0x00000001U /*!< fclk_pres = fclk/2 */ 00344 #define IRDA_PRESCALER_DIV4 0x00000002U /*!< fclk_pres = fclk/4 */ 00345 #define IRDA_PRESCALER_DIV6 0x00000003U /*!< fclk_pres = fclk/6 */ 00346 #define IRDA_PRESCALER_DIV8 0x00000004U /*!< fclk_pres = fclk/8 */ 00347 #define IRDA_PRESCALER_DIV10 0x00000005U /*!< fclk_pres = fclk/10 */ 00348 #define IRDA_PRESCALER_DIV12 0x00000006U /*!< fclk_pres = fclk/12 */ 00349 #define IRDA_PRESCALER_DIV16 0x00000007U /*!< fclk_pres = fclk/16 */ 00350 #define IRDA_PRESCALER_DIV32 0x00000008U /*!< fclk_pres = fclk/32 */ 00351 #define IRDA_PRESCALER_DIV64 0x00000009U /*!< fclk_pres = fclk/64 */ 00352 #define IRDA_PRESCALER_DIV128 0x0000000AU /*!< fclk_pres = fclk/128 */ 00353 #define IRDA_PRESCALER_DIV256 0x0000000BU /*!< fclk_pres = fclk/256 */ 00354 /** 00355 * @} 00356 */ 00357 #endif 00358 00359 /** @defgroup IRDA_State IRDA State 00360 * @{ 00361 */ 00362 #define IRDA_STATE_DISABLE 0x00000000U /*!< IRDA disabled */ 00363 #define IRDA_STATE_ENABLE USART_CR1_UE /*!< IRDA enabled */ 00364 /** 00365 * @} 00366 */ 00367 00368 /** @defgroup IRDA_Mode IRDA Mode 00369 * @{ 00370 */ 00371 #define IRDA_MODE_DISABLE 0x00000000U /*!< Associated UART disabled in IRDA mode */ 00372 #define IRDA_MODE_ENABLE USART_CR3_IREN /*!< Associated UART enabled in IRDA mode */ 00373 /** 00374 * @} 00375 */ 00376 00377 /** @defgroup IRDA_One_Bit IRDA One Bit Sampling 00378 * @{ 00379 */ 00380 #define IRDA_ONE_BIT_SAMPLE_DISABLE 0x00000000U /*!< One-bit sampling disabled */ 00381 #define IRDA_ONE_BIT_SAMPLE_ENABLE USART_CR3_ONEBIT /*!< One-bit sampling enabled */ 00382 /** 00383 * @} 00384 */ 00385 00386 /** @defgroup IRDA_DMA_Tx IRDA DMA Tx 00387 * @{ 00388 */ 00389 #define IRDA_DMA_TX_DISABLE 0x00000000U /*!< IRDA DMA TX disabled */ 00390 #define IRDA_DMA_TX_ENABLE USART_CR3_DMAT /*!< IRDA DMA TX enabled */ 00391 /** 00392 * @} 00393 */ 00394 00395 /** @defgroup IRDA_DMA_Rx IRDA DMA Rx 00396 * @{ 00397 */ 00398 #define IRDA_DMA_RX_DISABLE 0x00000000U /*!< IRDA DMA RX disabled */ 00399 #define IRDA_DMA_RX_ENABLE USART_CR3_DMAR /*!< IRDA DMA RX enabled */ 00400 /** 00401 * @} 00402 */ 00403 00404 /** @defgroup IRDA_Request_Parameters IRDA Request Parameters 00405 * @{ 00406 */ 00407 #define IRDA_AUTOBAUD_REQUEST USART_RQR_ABRRQ /*!< Auto-Baud Rate Request */ 00408 #define IRDA_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive Data flush Request */ 00409 #define IRDA_TXDATA_FLUSH_REQUEST USART_RQR_TXFRQ /*!< Transmit data flush Request */ 00410 /** 00411 * @} 00412 */ 00413 00414 /** @defgroup IRDA_Flags IRDA Flags 00415 * Elements values convention: 0xXXXX 00416 * - 0xXXXX : Flag mask in the ISR register 00417 * @{ 00418 */ 00419 #define IRDA_FLAG_REACK USART_ISR_REACK /*!< IRDA receive enable acknowledge flag */ 00420 #define IRDA_FLAG_TEACK USART_ISR_TEACK /*!< IRDA transmit enable acknowledge flag */ 00421 #define IRDA_FLAG_BUSY USART_ISR_BUSY /*!< IRDA busy flag */ 00422 #define IRDA_FLAG_ABRF USART_ISR_ABRF /*!< IRDA auto Baud rate flag */ 00423 #define IRDA_FLAG_ABRE USART_ISR_ABRE /*!< IRDA auto Baud rate error */ 00424 #if defined(USART_CR1_FIFOEN) 00425 #define IRDA_FLAG_TXE USART_ISR_TXE_TXFNF /*!< IRDA transmit data register empty */ 00426 #else 00427 #define IRDA_FLAG_TXE USART_ISR_TXE /*!< IRDA transmit data register empty */ 00428 #endif 00429 #define IRDA_FLAG_TC USART_ISR_TC /*!< IRDA transmission complete */ 00430 #if defined(USART_CR1_FIFOEN) 00431 #define IRDA_FLAG_RXNE USART_ISR_RXNE_RXFNE /*!< IRDA read data register not empty */ 00432 #else 00433 #define IRDA_FLAG_RXNE USART_ISR_RXNE /*!< IRDA read data register not empty */ 00434 #endif 00435 #define IRDA_FLAG_ORE USART_ISR_ORE /*!< IRDA overrun error */ 00436 #define IRDA_FLAG_NE USART_ISR_NE /*!< IRDA noise error */ 00437 #define IRDA_FLAG_FE USART_ISR_FE /*!< IRDA frame error */ 00438 #define IRDA_FLAG_PE USART_ISR_PE /*!< IRDA parity error */ 00439 /** 00440 * @} 00441 */ 00442 00443 /** @defgroup IRDA_Interrupt_definition IRDA Interrupts Definition 00444 * Elements values convention: 0000ZZZZ0XXYYYYYb 00445 * - YYYYY : Interrupt source position in the XX register (5bits) 00446 * - XX : Interrupt source register (2bits) 00447 * - 01: CR1 register 00448 * - 10: CR2 register 00449 * - 11: CR3 register 00450 * - ZZZZ : Flag position in the ISR register(4bits) 00451 * @{ 00452 */ 00453 #define IRDA_IT_PE 0x0028U /*!< IRDA Parity error interruption */ 00454 #define IRDA_IT_TXE 0x0727U /*!< IRDA Transmit data register empty interruption */ 00455 #define IRDA_IT_TC 0x0626U /*!< IRDA Transmission complete interruption */ 00456 #define IRDA_IT_RXNE 0x0525U /*!< IRDA Read data register not empty interruption */ 00457 #define IRDA_IT_IDLE 0x0424U /*!< IRDA Idle interruption */ 00458 00459 /* Elements values convention: 000000000XXYYYYYb 00460 - YYYYY : Interrupt source position in the XX register (5bits) 00461 - XX : Interrupt source register (2bits) 00462 - 01: CR1 register 00463 - 10: CR2 register 00464 - 11: CR3 register */ 00465 #define IRDA_IT_ERR 0x0060U /*!< IRDA Error interruption */ 00466 00467 /* Elements values convention: 0000ZZZZ00000000b 00468 - ZZZZ : Flag position in the ISR register(4bits) */ 00469 #define IRDA_IT_ORE 0x0300U /*!< IRDA Overrun error interruption */ 00470 #define IRDA_IT_NE 0x0200U /*!< IRDA Noise error interruption */ 00471 #define IRDA_IT_FE 0x0100U /*!< IRDA Frame error interruption */ 00472 /** 00473 * @} 00474 */ 00475 00476 /** @defgroup IRDA_IT_CLEAR_Flags IRDA Interruption Clear Flags 00477 * @{ 00478 */ 00479 #define IRDA_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */ 00480 #define IRDA_CLEAR_FEF USART_ICR_FECF /*!< Framing Error Clear Flag */ 00481 #define IRDA_CLEAR_NEF USART_ICR_NECF /*!< Noise Error detected Clear Flag */ 00482 #define IRDA_CLEAR_OREF USART_ICR_ORECF /*!< OverRun Error Clear Flag */ 00483 #define IRDA_CLEAR_IDLEF USART_ICR_IDLECF /*!< IDLE line detected Clear Flag */ 00484 #define IRDA_CLEAR_TCF USART_ICR_TCCF /*!< Transmission Complete Clear Flag */ 00485 /** 00486 * @} 00487 */ 00488 00489 /** @defgroup IRDA_Interruption_Mask IRDA interruptions flags mask 00490 * @{ 00491 */ 00492 #define IRDA_IT_MASK 0x001FU /*!< IRDA Interruptions flags mask */ 00493 /** 00494 * @} 00495 */ 00496 00497 /** 00498 * @} 00499 */ 00500 00501 00502 /* Exported macros -----------------------------------------------------------*/ 00503 /** @defgroup IRDA_Exported_Macros IRDA Exported Macros 00504 * @{ 00505 */ 00506 00507 /** @brief Reset IRDA handle state. 00508 * @param __HANDLE__ IRDA handle. 00509 * @retval None 00510 */ 00511 #if USE_HAL_IRDA_REGISTER_CALLBACKS == 1 00512 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) do{ \ 00513 (__HANDLE__)->gState = HAL_IRDA_STATE_RESET; \ 00514 (__HANDLE__)->RxState = HAL_IRDA_STATE_RESET; \ 00515 (__HANDLE__)->MspInitCallback = NULL; \ 00516 (__HANDLE__)->MspDeInitCallback = NULL; \ 00517 } while(0) 00518 #else 00519 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) do{ \ 00520 (__HANDLE__)->gState = HAL_IRDA_STATE_RESET; \ 00521 (__HANDLE__)->RxState = HAL_IRDA_STATE_RESET; \ 00522 } while(0) 00523 #endif /*USE_HAL_IRDA_REGISTER_CALLBACKS */ 00524 00525 /** @brief Flush the IRDA DR register. 00526 * @param __HANDLE__ specifies the IRDA Handle. 00527 * @retval None 00528 */ 00529 #define __HAL_IRDA_FLUSH_DRREGISTER(__HANDLE__) \ 00530 do{ \ 00531 SET_BIT((__HANDLE__)->Instance->RQR, IRDA_RXDATA_FLUSH_REQUEST); \ 00532 SET_BIT((__HANDLE__)->Instance->RQR, IRDA_TXDATA_FLUSH_REQUEST); \ 00533 } while(0) 00534 00535 /** @brief Clear the specified IRDA pending flag. 00536 * @param __HANDLE__ specifies the IRDA Handle. 00537 * @param __FLAG__ specifies the flag to check. 00538 * This parameter can be any combination of the following values: 00539 * @arg @ref IRDA_CLEAR_PEF 00540 * @arg @ref IRDA_CLEAR_FEF 00541 * @arg @ref IRDA_CLEAR_NEF 00542 * @arg @ref IRDA_CLEAR_OREF 00543 * @arg @ref IRDA_CLEAR_TCF 00544 * @arg @ref IRDA_CLEAR_IDLEF 00545 * @retval None 00546 */ 00547 #define __HAL_IRDA_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__)) 00548 00549 /** @brief Clear the IRDA PE pending flag. 00550 * @param __HANDLE__ specifies the IRDA Handle. 00551 * @retval None 00552 */ 00553 #define __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_PEF) 00554 00555 00556 /** @brief Clear the IRDA FE pending flag. 00557 * @param __HANDLE__ specifies the IRDA Handle. 00558 * @retval None 00559 */ 00560 #define __HAL_IRDA_CLEAR_FEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_FEF) 00561 00562 /** @brief Clear the IRDA NE pending flag. 00563 * @param __HANDLE__ specifies the IRDA Handle. 00564 * @retval None 00565 */ 00566 #define __HAL_IRDA_CLEAR_NEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_NEF) 00567 00568 /** @brief Clear the IRDA ORE pending flag. 00569 * @param __HANDLE__ specifies the IRDA Handle. 00570 * @retval None 00571 */ 00572 #define __HAL_IRDA_CLEAR_OREFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_OREF) 00573 00574 /** @brief Clear the IRDA IDLE pending flag. 00575 * @param __HANDLE__ specifies the IRDA Handle. 00576 * @retval None 00577 */ 00578 #define __HAL_IRDA_CLEAR_IDLEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_IDLEF) 00579 00580 /** @brief Check whether the specified IRDA flag is set or not. 00581 * @param __HANDLE__ specifies the IRDA Handle. 00582 * @param __FLAG__ specifies the flag to check. 00583 * This parameter can be one of the following values: 00584 * @arg @ref IRDA_FLAG_REACK Receive enable acknowledge flag 00585 * @arg @ref IRDA_FLAG_TEACK Transmit enable acknowledge flag 00586 * @arg @ref IRDA_FLAG_BUSY Busy flag 00587 * @arg @ref IRDA_FLAG_ABRF Auto Baud rate detection flag 00588 * @arg @ref IRDA_FLAG_ABRE Auto Baud rate detection error flag 00589 * @arg @ref IRDA_FLAG_TXE Transmit data register empty flag 00590 * @arg @ref IRDA_FLAG_TC Transmission Complete flag 00591 * @arg @ref IRDA_FLAG_RXNE Receive data register not empty flag 00592 * @arg @ref IRDA_FLAG_ORE OverRun Error flag 00593 * @arg @ref IRDA_FLAG_NE Noise Error flag 00594 * @arg @ref IRDA_FLAG_FE Framing Error flag 00595 * @arg @ref IRDA_FLAG_PE Parity Error flag 00596 * @retval The new state of __FLAG__ (TRUE or FALSE). 00597 */ 00598 #define __HAL_IRDA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__)) 00599 00600 00601 /** @brief Enable the specified IRDA interrupt. 00602 * @param __HANDLE__ specifies the IRDA Handle. 00603 * @param __INTERRUPT__ specifies the IRDA interrupt source to enable. 00604 * This parameter can be one of the following values: 00605 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt 00606 * @arg @ref IRDA_IT_TC Transmission complete interrupt 00607 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt 00608 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt 00609 * @arg @ref IRDA_IT_PE Parity Error interrupt 00610 * @arg @ref IRDA_IT_ERR Error interrupt(Frame error, noise error, overrun error) 00611 * @retval None 00612 */ 00613 #define __HAL_IRDA_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1)? ((__HANDLE__)->Instance->CR1 |= (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \ 00614 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2)? ((__HANDLE__)->Instance->CR2 |= (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \ 00615 ((__HANDLE__)->Instance->CR3 |= (1U << ((__INTERRUPT__) & IRDA_IT_MASK)))) 00616 00617 /** @brief Disable the specified IRDA interrupt. 00618 * @param __HANDLE__ specifies the IRDA Handle. 00619 * @param __INTERRUPT__ specifies the IRDA interrupt source to disable. 00620 * This parameter can be one of the following values: 00621 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt 00622 * @arg @ref IRDA_IT_TC Transmission complete interrupt 00623 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt 00624 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt 00625 * @arg @ref IRDA_IT_PE Parity Error interrupt 00626 * @arg @ref IRDA_IT_ERR Error interrupt(Frame error, noise error, overrun error) 00627 * @retval None 00628 */ 00629 #define __HAL_IRDA_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1)? ((__HANDLE__)->Instance->CR1 &= ~ (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \ 00630 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2)? ((__HANDLE__)->Instance->CR2 &= ~ (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \ 00631 ((__HANDLE__)->Instance->CR3 &= ~ (1U << ((__INTERRUPT__) & IRDA_IT_MASK)))) 00632 00633 00634 /** @brief Check whether the specified IRDA interrupt has occurred or not. 00635 * @param __HANDLE__ specifies the IRDA Handle. 00636 * @param __INTERRUPT__ specifies the IRDA interrupt source to check. 00637 * This parameter can be one of the following values: 00638 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt 00639 * @arg @ref IRDA_IT_TC Transmission complete interrupt 00640 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt 00641 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt 00642 * @arg @ref IRDA_IT_ORE OverRun Error interrupt 00643 * @arg @ref IRDA_IT_NE Noise Error interrupt 00644 * @arg @ref IRDA_IT_FE Framing Error interrupt 00645 * @arg @ref IRDA_IT_PE Parity Error interrupt 00646 * @retval The new state of __IT__ (SET or RESET). 00647 */ 00648 #define __HAL_IRDA_GET_IT(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->ISR & (0x01U << ((__INTERRUPT__)>> 0x08U))) != RESET) ? SET : RESET) 00649 00650 /** @brief Check whether the specified IRDA interrupt source is enabled or not. 00651 * @param __HANDLE__ specifies the IRDA Handle. 00652 * @param __INTERRUPT__ specifies the IRDA interrupt source to check. 00653 * This parameter can be one of the following values: 00654 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt 00655 * @arg @ref IRDA_IT_TC Transmission complete interrupt 00656 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt 00657 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt 00658 * @arg @ref IRDA_IT_ERR Framing, overrun or noise error interrupt 00659 * @arg @ref IRDA_IT_PE Parity Error interrupt 00660 * @retval The new state of __IT__ (SET or RESET). 00661 */ 00662 #define __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((((((uint8_t)(__INTERRUPT__)) >> 0x05U) == 0x01U)? (__HANDLE__)->Instance->CR1 : \ 00663 (((((uint8_t)(__INTERRUPT__)) >> 0x05U) == 0x02U)? (__HANDLE__)->Instance->CR2 : \ 00664 (__HANDLE__)->Instance->CR3)) & (0x01U << (((uint16_t)(__INTERRUPT__)) & IRDA_IT_MASK))) != RESET) ? SET : RESET) 00665 00666 /** @brief Clear the specified IRDA ISR flag, in setting the proper ICR register flag. 00667 * @param __HANDLE__ specifies the IRDA Handle. 00668 * @param __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set 00669 * to clear the corresponding interrupt 00670 * This parameter can be one of the following values: 00671 * @arg @ref IRDA_CLEAR_PEF Parity Error Clear Flag 00672 * @arg @ref IRDA_CLEAR_FEF Framing Error Clear Flag 00673 * @arg @ref IRDA_CLEAR_NEF Noise detected Clear Flag 00674 * @arg @ref IRDA_CLEAR_OREF OverRun Error Clear Flag 00675 * @arg @ref IRDA_CLEAR_TCF Transmission Complete Clear Flag 00676 * @retval None 00677 */ 00678 #define __HAL_IRDA_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__)) 00679 00680 00681 /** @brief Set a specific IRDA request flag. 00682 * @param __HANDLE__ specifies the IRDA Handle. 00683 * @param __REQ__ specifies the request flag to set 00684 * This parameter can be one of the following values: 00685 * @arg @ref IRDA_AUTOBAUD_REQUEST Auto-Baud Rate Request 00686 * @arg @ref IRDA_RXDATA_FLUSH_REQUEST Receive Data flush Request 00687 * @arg @ref IRDA_TXDATA_FLUSH_REQUEST Transmit data flush Request 00688 * 00689 * @retval None 00690 */ 00691 #define __HAL_IRDA_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__)) 00692 00693 /** @brief Enable the IRDA one bit sample method. 00694 * @param __HANDLE__ specifies the IRDA Handle. 00695 * @retval None 00696 */ 00697 #define __HAL_IRDA_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT) 00698 00699 /** @brief Disable the IRDA one bit sample method. 00700 * @param __HANDLE__ specifies the IRDA Handle. 00701 * @retval None 00702 */ 00703 #define __HAL_IRDA_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= (uint32_t)~((uint32_t)USART_CR3_ONEBIT)) 00704 00705 /** @brief Enable UART/USART associated to IRDA Handle. 00706 * @param __HANDLE__ specifies the IRDA Handle. 00707 * @retval None 00708 */ 00709 #define __HAL_IRDA_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE) 00710 00711 /** @brief Disable UART/USART associated to IRDA Handle. 00712 * @param __HANDLE__ specifies the IRDA Handle. 00713 * @retval None 00714 */ 00715 #define __HAL_IRDA_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE) 00716 00717 /** 00718 * @} 00719 */ 00720 00721 /* Private macros --------------------------------------------------------*/ 00722 /** @addtogroup IRDA_Private_Macros 00723 * @{ 00724 */ 00725 00726 /** @brief Compute the mask to apply to retrieve the received data 00727 * according to the word length and to the parity bits activation. 00728 * @param __HANDLE__ specifies the IRDA Handle. 00729 * @retval None, the mask to apply to the associated UART RDR register is stored in (__HANDLE__)->Mask field. 00730 */ 00731 #define IRDA_MASK_COMPUTATION(__HANDLE__) \ 00732 do { \ 00733 if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_9B) \ 00734 { \ 00735 if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \ 00736 { \ 00737 (__HANDLE__)->Mask = 0x01FF ; \ 00738 } \ 00739 else \ 00740 { \ 00741 (__HANDLE__)->Mask = 0x00FF ; \ 00742 } \ 00743 } \ 00744 else if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_8B) \ 00745 { \ 00746 if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \ 00747 { \ 00748 (__HANDLE__)->Mask = 0x00FF ; \ 00749 } \ 00750 else \ 00751 { \ 00752 (__HANDLE__)->Mask = 0x007F ; \ 00753 } \ 00754 } \ 00755 else if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_7B) \ 00756 { \ 00757 if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \ 00758 { \ 00759 (__HANDLE__)->Mask = 0x007F ; \ 00760 } \ 00761 else \ 00762 { \ 00763 (__HANDLE__)->Mask = 0x003F ; \ 00764 } \ 00765 } \ 00766 } while(0) 00767 00768 /** @brief Ensure that IRDA Baud rate is less or equal to maximum value. 00769 * @param __BAUDRATE__ specifies the IRDA Baudrate set by the user. 00770 * @retval True or False 00771 */ 00772 #define IS_IRDA_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 115201) 00773 00774 /** @brief Ensure that IRDA prescaler value is strictly larger than 0. 00775 * @param __PRESCALER__ specifies the IRDA prescaler value set by the user. 00776 * @retval True or False 00777 */ 00778 #define IS_IRDA_PRESCALER(__PRESCALER__) ((__PRESCALER__) > 0) 00779 00780 /** 00781 * @brief Ensure that IRDA frame length is valid. 00782 * @param __LENGTH__ IRDA frame length. 00783 * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid) 00784 */ 00785 #define IS_IRDA_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == IRDA_WORDLENGTH_7B) || \ 00786 ((__LENGTH__) == IRDA_WORDLENGTH_8B) || \ 00787 ((__LENGTH__) == IRDA_WORDLENGTH_9B)) 00788 00789 /** 00790 * @brief Ensure that IRDA frame parity is valid. 00791 * @param __PARITY__ IRDA frame parity. 00792 * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid) 00793 */ 00794 #define IS_IRDA_PARITY(__PARITY__) (((__PARITY__) == IRDA_PARITY_NONE) || \ 00795 ((__PARITY__) == IRDA_PARITY_EVEN) || \ 00796 ((__PARITY__) == IRDA_PARITY_ODD)) 00797 00798 /** 00799 * @brief Ensure that IRDA communication mode is valid. 00800 * @param __MODE__ IRDA communication mode. 00801 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid) 00802 */ 00803 #define IS_IRDA_TX_RX_MODE(__MODE__) ((((__MODE__) & (~((uint32_t)(IRDA_MODE_TX_RX)))) == 0x00U) && ((__MODE__) != 0x00U)) 00804 00805 /** 00806 * @brief Ensure that IRDA power mode is valid. 00807 * @param __MODE__ IRDA power mode. 00808 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid) 00809 */ 00810 #define IS_IRDA_POWERMODE(__MODE__) (((__MODE__) == IRDA_POWERMODE_LOWPOWER) || \ 00811 ((__MODE__) == IRDA_POWERMODE_NORMAL)) 00812 00813 #if defined(USART_PRESC_PRESCALER) 00814 /** 00815 * @brief Ensure that IRDA clock Prescaler is valid. 00816 * @param __CLOCKPRESCALER__ IRDA clock Prescaler value. 00817 * @retval SET (__CLOCKPRESCALER__ is valid) or RESET (__CLOCKPRESCALER__ is invalid) 00818 */ 00819 #define IS_IRDA_CLOCKPRESCALER(__CLOCKPRESCALER__) (((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV1) || \ 00820 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV2) || \ 00821 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV4) || \ 00822 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV6) || \ 00823 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV8) || \ 00824 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV10) || \ 00825 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV12) || \ 00826 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV16) || \ 00827 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV32) || \ 00828 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV64) || \ 00829 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV128) || \ 00830 ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV256)) 00831 #endif 00832 00833 /** 00834 * @brief Ensure that IRDA state is valid. 00835 * @param __STATE__ IRDA state mode. 00836 * @retval SET (__STATE__ is valid) or RESET (__STATE__ is invalid) 00837 */ 00838 #define IS_IRDA_STATE(__STATE__) (((__STATE__) == IRDA_STATE_DISABLE) || \ 00839 ((__STATE__) == IRDA_STATE_ENABLE)) 00840 00841 /** 00842 * @brief Ensure that IRDA associated UART/USART mode is valid. 00843 * @param __MODE__ IRDA associated UART/USART mode. 00844 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid) 00845 */ 00846 #define IS_IRDA_MODE(__MODE__) (((__MODE__) == IRDA_MODE_DISABLE) || \ 00847 ((__MODE__) == IRDA_MODE_ENABLE)) 00848 00849 /** 00850 * @brief Ensure that IRDA sampling rate is valid. 00851 * @param __ONEBIT__ IRDA sampling rate. 00852 * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid) 00853 */ 00854 #define IS_IRDA_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == IRDA_ONE_BIT_SAMPLE_DISABLE) || \ 00855 ((__ONEBIT__) == IRDA_ONE_BIT_SAMPLE_ENABLE)) 00856 00857 /** 00858 * @brief Ensure that IRDA DMA TX mode is valid. 00859 * @param __DMATX__ IRDA DMA TX mode. 00860 * @retval SET (__DMATX__ is valid) or RESET (__DMATX__ is invalid) 00861 */ 00862 #define IS_IRDA_DMA_TX(__DMATX__) (((__DMATX__) == IRDA_DMA_TX_DISABLE) || \ 00863 ((__DMATX__) == IRDA_DMA_TX_ENABLE)) 00864 00865 /** 00866 * @brief Ensure that IRDA DMA RX mode is valid. 00867 * @param __DMARX__ IRDA DMA RX mode. 00868 * @retval SET (__DMARX__ is valid) or RESET (__DMARX__ is invalid) 00869 */ 00870 #define IS_IRDA_DMA_RX(__DMARX__) (((__DMARX__) == IRDA_DMA_RX_DISABLE) || \ 00871 ((__DMARX__) == IRDA_DMA_RX_ENABLE)) 00872 00873 /** 00874 * @brief Ensure that IRDA request is valid. 00875 * @param __PARAM__ IRDA request. 00876 * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid) 00877 */ 00878 #define IS_IRDA_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == IRDA_AUTOBAUD_REQUEST) || \ 00879 ((__PARAM__) == IRDA_RXDATA_FLUSH_REQUEST) || \ 00880 ((__PARAM__) == IRDA_TXDATA_FLUSH_REQUEST)) 00881 /** 00882 * @} 00883 */ 00884 00885 /* Include IRDA HAL Extended module */ 00886 #include "stm32l4xx_hal_irda_ex.h" 00887 00888 /* Exported functions --------------------------------------------------------*/ 00889 /** @addtogroup IRDA_Exported_Functions IRDA Exported Functions 00890 * @{ 00891 */ 00892 00893 /** @addtogroup IRDA_Exported_Functions_Group1 Initialization and de-initialization functions 00894 * @{ 00895 */ 00896 00897 /* Initialization and de-initialization functions ****************************/ 00898 HAL_StatusTypeDef HAL_IRDA_Init(IRDA_HandleTypeDef *hirda); 00899 HAL_StatusTypeDef HAL_IRDA_DeInit(IRDA_HandleTypeDef *hirda); 00900 void HAL_IRDA_MspInit(IRDA_HandleTypeDef *hirda); 00901 void HAL_IRDA_MspDeInit(IRDA_HandleTypeDef *hirda); 00902 00903 #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1) 00904 /* Callbacks Register/UnRegister functions ***********************************/ 00905 HAL_StatusTypeDef HAL_IRDA_RegisterCallback(IRDA_HandleTypeDef *hirda, HAL_IRDA_CallbackIDTypeDef CallbackID, pIRDA_CallbackTypeDef pCallback); 00906 HAL_StatusTypeDef HAL_IRDA_UnRegisterCallback(IRDA_HandleTypeDef *hirda, HAL_IRDA_CallbackIDTypeDef CallbackID); 00907 #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */ 00908 00909 /** 00910 * @} 00911 */ 00912 00913 /** @addtogroup IRDA_Exported_Functions_Group2 IO operation functions 00914 * @{ 00915 */ 00916 00917 /* IO operation functions *****************************************************/ 00918 HAL_StatusTypeDef HAL_IRDA_Transmit(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout); 00919 HAL_StatusTypeDef HAL_IRDA_Receive(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout); 00920 HAL_StatusTypeDef HAL_IRDA_Transmit_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size); 00921 HAL_StatusTypeDef HAL_IRDA_Receive_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size); 00922 HAL_StatusTypeDef HAL_IRDA_Transmit_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size); 00923 HAL_StatusTypeDef HAL_IRDA_Receive_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size); 00924 HAL_StatusTypeDef HAL_IRDA_DMAPause(IRDA_HandleTypeDef *hirda); 00925 HAL_StatusTypeDef HAL_IRDA_DMAResume(IRDA_HandleTypeDef *hirda); 00926 HAL_StatusTypeDef HAL_IRDA_DMAStop(IRDA_HandleTypeDef *hirda); 00927 /* Transfer Abort functions */ 00928 HAL_StatusTypeDef HAL_IRDA_Abort(IRDA_HandleTypeDef *hirda); 00929 HAL_StatusTypeDef HAL_IRDA_AbortTransmit(IRDA_HandleTypeDef *hirda); 00930 HAL_StatusTypeDef HAL_IRDA_AbortReceive(IRDA_HandleTypeDef *hirda); 00931 HAL_StatusTypeDef HAL_IRDA_Abort_IT(IRDA_HandleTypeDef *hirda); 00932 HAL_StatusTypeDef HAL_IRDA_AbortTransmit_IT(IRDA_HandleTypeDef *hirda); 00933 HAL_StatusTypeDef HAL_IRDA_AbortReceive_IT(IRDA_HandleTypeDef *hirda); 00934 00935 void HAL_IRDA_IRQHandler(IRDA_HandleTypeDef *hirda); 00936 void HAL_IRDA_TxCpltCallback(IRDA_HandleTypeDef *hirda); 00937 void HAL_IRDA_RxCpltCallback(IRDA_HandleTypeDef *hirda); 00938 void HAL_IRDA_TxHalfCpltCallback(IRDA_HandleTypeDef *hirda); 00939 void HAL_IRDA_RxHalfCpltCallback(IRDA_HandleTypeDef *hirda); 00940 void HAL_IRDA_ErrorCallback(IRDA_HandleTypeDef *hirda); 00941 void HAL_IRDA_AbortCpltCallback(IRDA_HandleTypeDef *hirda); 00942 void HAL_IRDA_AbortTransmitCpltCallback(IRDA_HandleTypeDef *hirda); 00943 void HAL_IRDA_AbortReceiveCpltCallback(IRDA_HandleTypeDef *hirda); 00944 00945 /** 00946 * @} 00947 */ 00948 00949 /* Peripheral Control functions ************************************************/ 00950 00951 /** @addtogroup IRDA_Exported_Functions_Group4 Peripheral State and Error functions 00952 * @{ 00953 */ 00954 00955 /* Peripheral State and Error functions ***************************************/ 00956 HAL_IRDA_StateTypeDef HAL_IRDA_GetState(IRDA_HandleTypeDef *hirda); 00957 uint32_t HAL_IRDA_GetError(IRDA_HandleTypeDef *hirda); 00958 00959 /** 00960 * @} 00961 */ 00962 00963 /** 00964 * @} 00965 */ 00966 00967 /** 00968 * @} 00969 */ 00970 00971 /** 00972 * @} 00973 */ 00974 00975 #ifdef __cplusplus 00976 } 00977 #endif 00978 00979 #endif /* __STM32L4xx_HAL_IRDA_H */ 00980 00981 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
1.7.6.1