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