|
38
|
1 /**
|
|
|
2 ******************************************************************************
|
|
|
3 * @file stm32f4xx_hal_irda.h
|
|
|
4 * @author MCD Application Team
|
|
|
5 * @version V1.2.0
|
|
|
6 * @date 26-December-2014
|
|
|
7 * @brief Header file of IRDA HAL module.
|
|
|
8 ******************************************************************************
|
|
|
9 * @attention
|
|
|
10 *
|
|
|
11 * <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
|
|
|
12 *
|
|
|
13 * Redistribution and use in source and binary forms, with or without modification,
|
|
|
14 * are permitted provided that the following conditions are met:
|
|
|
15 * 1. Redistributions of source code must retain the above copyright notice,
|
|
|
16 * this list of conditions and the following disclaimer.
|
|
|
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
|
18 * this list of conditions and the following disclaimer in the documentation
|
|
|
19 * and/or other materials provided with the distribution.
|
|
|
20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
|
|
|
21 * may be used to endorse or promote products derived from this software
|
|
|
22 * without specific prior written permission.
|
|
|
23 *
|
|
|
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
|
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
|
27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
|
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
|
30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
|
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
|
32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
34 *
|
|
|
35 ******************************************************************************
|
|
|
36 */
|
|
|
37
|
|
|
38 /* Define to prevent recursive inclusion -------------------------------------*/
|
|
|
39 #ifndef __STM32F4xx_HAL_IRDA_H
|
|
|
40 #define __STM32F4xx_HAL_IRDA_H
|
|
|
41
|
|
|
42 #ifdef __cplusplus
|
|
|
43 extern "C" {
|
|
|
44 #endif
|
|
|
45
|
|
|
46 /* Includes ------------------------------------------------------------------*/
|
|
|
47 #include "stm32f4xx_hal_def.h"
|
|
|
48
|
|
|
49 /** @addtogroup STM32F4xx_HAL_Driver
|
|
|
50 * @{
|
|
|
51 */
|
|
|
52
|
|
|
53 /** @addtogroup IRDA
|
|
|
54 * @{
|
|
|
55 */
|
|
|
56
|
|
|
57 /* Exported types ------------------------------------------------------------*/
|
|
|
58 /** @defgroup IRDA_Exported_Types USART Exported Types
|
|
|
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 is computed using the following formula:
|
|
|
68 - IntegerDivider = ((PCLKx) / (8 * (hirda->Init.BaudRate)))
|
|
|
69 - FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 8) + 0.5 */
|
|
|
70
|
|
|
71 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
|
|
|
72 This parameter can be a value of @ref IRDA_Word_Length */
|
|
|
73
|
|
|
74
|
|
|
75 uint32_t Parity; /*!< Specifies the parity mode.
|
|
|
76 This parameter can be a value of @ref IRDA_Parity
|
|
|
77 @note When parity is enabled, the computed parity is inserted
|
|
|
78 at the MSB position of the transmitted data (9th bit when
|
|
|
79 the word length is set to 9 data bits; 8th bit when the
|
|
|
80 word length is set to 8 data bits). */
|
|
|
81
|
|
|
82 uint32_t Mode; /*!< Specifies wether the Receive or Transmit mode is enabled or disabled.
|
|
|
83 This parameter can be a value of @ref IRDA_Mode */
|
|
|
84
|
|
|
85 uint8_t Prescaler; /*!< Specifies the Prescaler */
|
|
|
86
|
|
|
87 uint32_t IrDAMode; /*!< Specifies the IrDA mode
|
|
|
88 This parameter can be a value of @ref IRDA_Low_Power */
|
|
|
89 }IRDA_InitTypeDef;
|
|
|
90
|
|
|
91 /**
|
|
|
92 * @brief HAL State structures definition
|
|
|
93 */
|
|
|
94 typedef enum
|
|
|
95 {
|
|
|
96 HAL_IRDA_STATE_RESET = 0x00, /*!< Peripheral is not yet Initialized */
|
|
|
97 HAL_IRDA_STATE_READY = 0x01, /*!< Peripheral Initialized and ready for use */
|
|
|
98 HAL_IRDA_STATE_BUSY = 0x02, /*!< An internal process is ongoing */
|
|
|
99 HAL_IRDA_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */
|
|
|
100 HAL_IRDA_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */
|
|
|
101 HAL_IRDA_STATE_BUSY_TX_RX = 0x32, /*!< Data Transmission and Reception process is ongoing */
|
|
|
102 HAL_IRDA_STATE_TIMEOUT = 0x03, /*!< Timeout state */
|
|
|
103 HAL_IRDA_STATE_ERROR = 0x04 /*!< Error */
|
|
|
104 }HAL_IRDA_StateTypeDef;
|
|
|
105
|
|
|
106 /**
|
|
|
107 * @brief IRDA handle Structure definition
|
|
|
108 */
|
|
|
109 typedef struct
|
|
|
110 {
|
|
|
111 USART_TypeDef *Instance; /* USART registers base address */
|
|
|
112
|
|
|
113 IRDA_InitTypeDef Init; /* IRDA communication parameters */
|
|
|
114
|
|
|
115 uint8_t *pTxBuffPtr; /* Pointer to IRDA Tx transfer Buffer */
|
|
|
116
|
|
|
117 uint16_t TxXferSize; /* IRDA Tx Transfer size */
|
|
|
118
|
|
|
119 uint16_t TxXferCount; /* IRDA Tx Transfer Counter */
|
|
|
120
|
|
|
121 uint8_t *pRxBuffPtr; /* Pointer to IRDA Rx transfer Buffer */
|
|
|
122
|
|
|
123 uint16_t RxXferSize; /* IRDA Rx Transfer size */
|
|
|
124
|
|
|
125 uint16_t RxXferCount; /* IRDA Rx Transfer Counter */
|
|
|
126
|
|
|
127 DMA_HandleTypeDef *hdmatx; /* IRDA Tx DMA Handle parameters */
|
|
|
128
|
|
|
129 DMA_HandleTypeDef *hdmarx; /* IRDA Rx DMA Handle parameters */
|
|
|
130
|
|
|
131 HAL_LockTypeDef Lock; /* Locking object */
|
|
|
132
|
|
|
133 __IO HAL_IRDA_StateTypeDef State; /* IRDA communication state */
|
|
|
134
|
|
|
135 __IO uint32_t ErrorCode; /* IRDA Error code */
|
|
|
136
|
|
|
137 }IRDA_HandleTypeDef;
|
|
|
138 /**
|
|
|
139 * @}
|
|
|
140 */
|
|
|
141
|
|
|
142 /* Exported constants --------------------------------------------------------*/
|
|
|
143 /** @defgroup IRDA_Exported_Constants IRDA Exported constants
|
|
|
144 * @{
|
|
|
145 */
|
|
|
146 /** @defgroup IRDA_Error_Code IRDA Error Code
|
|
|
147 * @brief IRDA Error Code
|
|
|
148 * @{
|
|
|
149 */
|
|
|
150 #define HAL_IRDA_ERROR_NONE ((uint32_t)0x00000000) /*!< No error */
|
|
|
151 #define HAL_IRDA_ERROR_PE ((uint32_t)0x00000001) /*!< Parity error */
|
|
|
152 #define HAL_IRDA_ERROR_NE ((uint32_t)0x00000002) /*!< Noise error */
|
|
|
153 #define HAL_IRDA_ERROR_FE ((uint32_t)0x00000004) /*!< Frame error */
|
|
|
154 #define HAL_IRDA_ERROR_ORE ((uint32_t)0x00000008) /*!< Overrun error */
|
|
|
155 #define HAL_IRDA_ERROR_DMA ((uint32_t)0x00000010) /*!< DMA transfer error */
|
|
|
156 /**
|
|
|
157 * @}
|
|
|
158 */
|
|
|
159
|
|
|
160 /** @defgroup IRDA_Word_Length IRDA Word Length
|
|
|
161 * @{
|
|
|
162 */
|
|
|
163 #define IRDA_WORDLENGTH_8B ((uint32_t)0x00000000)
|
|
|
164 #define IRDA_WORDLENGTH_9B ((uint32_t)USART_CR1_M)
|
|
|
165 /**
|
|
|
166 * @}
|
|
|
167 */
|
|
|
168
|
|
|
169 /** @defgroup IRDA_Parity IRDA Parity
|
|
|
170 * @{
|
|
|
171 */
|
|
|
172 #define IRDA_PARITY_NONE ((uint32_t)0x00000000)
|
|
|
173 #define IRDA_PARITY_EVEN ((uint32_t)USART_CR1_PCE)
|
|
|
174 #define IRDA_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
|
|
|
175 /**
|
|
|
176 * @}
|
|
|
177 */
|
|
|
178
|
|
|
179 /** @defgroup IRDA_Mode IRDA Transfer Mode
|
|
|
180 * @{
|
|
|
181 */
|
|
|
182 #define IRDA_MODE_RX ((uint32_t)USART_CR1_RE)
|
|
|
183 #define IRDA_MODE_TX ((uint32_t)USART_CR1_TE)
|
|
|
184 #define IRDA_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE))
|
|
|
185 /**
|
|
|
186 * @}
|
|
|
187 */
|
|
|
188
|
|
|
189 /** @defgroup IRDA_Low_Power IRDA Low Power
|
|
|
190 * @{
|
|
|
191 */
|
|
|
192 #define IRDA_POWERMODE_LOWPOWER ((uint32_t)USART_CR3_IRLP)
|
|
|
193 #define IRDA_POWERMODE_NORMAL ((uint32_t)0x00000000)
|
|
|
194 /**
|
|
|
195 * @}
|
|
|
196 */
|
|
|
197
|
|
|
198 /** @defgroup IRDA_Flags IRDA Flags
|
|
|
199 * Elements values convention: 0xXXXX
|
|
|
200 * - 0xXXXX : Flag mask in the SR register
|
|
|
201 * @{
|
|
|
202 */
|
|
|
203 #define IRDA_FLAG_TXE ((uint32_t)0x00000080)
|
|
|
204 #define IRDA_FLAG_TC ((uint32_t)0x00000040)
|
|
|
205 #define IRDA_FLAG_RXNE ((uint32_t)0x00000020)
|
|
|
206 #define IRDA_FLAG_IDLE ((uint32_t)0x00000010)
|
|
|
207 #define IRDA_FLAG_ORE ((uint32_t)0x00000008)
|
|
|
208 #define IRDA_FLAG_NE ((uint32_t)0x00000004)
|
|
|
209 #define IRDA_FLAG_FE ((uint32_t)0x00000002)
|
|
|
210 #define IRDA_FLAG_PE ((uint32_t)0x00000001)
|
|
|
211 /**
|
|
|
212 * @}
|
|
|
213 */
|
|
|
214
|
|
|
215 /** @defgroup IRDA_Interrupt_definition IRDA Interrupt Definitions
|
|
|
216 * Elements values convention: 0xY000XXXX
|
|
|
217 * - XXXX : Interrupt mask in the XX register
|
|
|
218 * - Y : Interrupt source register (2bits)
|
|
|
219 * - 01: CR1 register
|
|
|
220 * - 10: CR2 register
|
|
|
221 * - 11: CR3 register
|
|
|
222 * @{
|
|
|
223 */
|
|
|
224 #define IRDA_IT_PE ((uint32_t)(IRDA_CR1_REG_INDEX << 28 | USART_CR1_PEIE))
|
|
|
225 #define IRDA_IT_TXE ((uint32_t)(IRDA_CR1_REG_INDEX << 28 | USART_CR1_TXEIE))
|
|
|
226 #define IRDA_IT_TC ((uint32_t)(IRDA_CR1_REG_INDEX << 28 | USART_CR1_TCIE))
|
|
|
227 #define IRDA_IT_RXNE ((uint32_t)(IRDA_CR1_REG_INDEX << 28 | USART_CR1_RXNEIE))
|
|
|
228 #define IRDA_IT_IDLE ((uint32_t)(IRDA_CR1_REG_INDEX << 28 | USART_CR1_IDLEIE))
|
|
|
229
|
|
|
230 #define IRDA_IT_LBD ((uint32_t)(IRDA_CR2_REG_INDEX << 28 | USART_CR2_LBDIE))
|
|
|
231
|
|
|
232 #define IRDA_IT_CTS ((uint32_t)(IRDA_CR3_REG_INDEX << 28 | USART_CR3_CTSIE))
|
|
|
233 #define IRDA_IT_ERR ((uint32_t)(IRDA_CR3_REG_INDEX << 28 | USART_CR3_EIE))
|
|
|
234 /**
|
|
|
235 * @}
|
|
|
236 */
|
|
|
237
|
|
|
238 /**
|
|
|
239 * @}
|
|
|
240 */
|
|
|
241
|
|
|
242 /* Exported macro ------------------------------------------------------------*/
|
|
|
243 /** @defgroup IRDA_Exported_Macros IRDA Exported Macros
|
|
|
244 * @{
|
|
|
245 */
|
|
|
246
|
|
|
247 /** @brief Reset IRDA handle state
|
|
|
248 * @param __HANDLE__: specifies the USART Handle.
|
|
|
249 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
|
|
|
250 * UART peripheral.
|
|
|
251 * @retval None
|
|
|
252 */
|
|
|
253 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_IRDA_STATE_RESET)
|
|
|
254
|
|
|
255 /** @brief Flushs the IRDA DR register
|
|
|
256 * @param __HANDLE__: specifies the USART Handle.
|
|
|
257 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
|
|
|
258 * UART peripheral.
|
|
|
259 */
|
|
|
260 #define __HAL_IRDA_FLUSH_DRREGISTER(__HANDLE__) ((__HANDLE__)->Instance->DR)
|
|
|
261
|
|
|
262 /** @brief Checks whether the specified IRDA flag is set or not.
|
|
|
263 * @param __HANDLE__: specifies the USART Handle.
|
|
|
264 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
|
|
|
265 * UART peripheral.
|
|
|
266 * @param __FLAG__: specifies the flag to check.
|
|
|
267 * This parameter can be one of the following values:
|
|
|
268 * @arg IRDA_FLAG_TXE: Transmit data register empty flag
|
|
|
269 * @arg IRDA_FLAG_TC: Transmission Complete flag
|
|
|
270 * @arg IRDA_FLAG_RXNE: Receive data register not empty flag
|
|
|
271 * @arg IRDA_FLAG_IDLE: Idle Line detection flag
|
|
|
272 * @arg IRDA_FLAG_ORE: OverRun Error flag
|
|
|
273 * @arg IRDA_FLAG_NE: Noise Error flag
|
|
|
274 * @arg IRDA_FLAG_FE: Framing Error flag
|
|
|
275 * @arg IRDA_FLAG_PE: Parity Error flag
|
|
|
276 * @retval The new state of __FLAG__ (TRUE or FALSE).
|
|
|
277 */
|
|
|
278 #define __HAL_IRDA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
|
|
|
279
|
|
|
280 /** @brief Clears the specified IRDA pending flag.
|
|
|
281 * @param __HANDLE__: specifies the USART Handle.
|
|
|
282 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
|
|
|
283 * UART peripheral.
|
|
|
284 * @param __FLAG__: specifies the flag to check.
|
|
|
285 * This parameter can be any combination of the following values:
|
|
|
286 * @arg IRDA_FLAG_TC: Transmission Complete flag.
|
|
|
287 * @arg IRDA_FLAG_RXNE: Receive data register not empty flag.
|
|
|
288 *
|
|
|
289 * @note PE (Parity error), FE (Framing error), NE (Noise error), ORE (OverRun
|
|
|
290 * error) and IDLE (Idle line detected) flags are cleared by software
|
|
|
291 * sequence: a read operation to USART_SR register followed by a read
|
|
|
292 * operation to USART_DR register.
|
|
|
293 * @note RXNE flag can be also cleared by a read to the USART_DR register.
|
|
|
294 * @note TC flag can be also cleared by software sequence: a read operation to
|
|
|
295 * USART_SR register followed by a write operation to USART_DR register.
|
|
|
296 * @note TXE flag is cleared only by a write to the USART_DR register.
|
|
|
297 *
|
|
|
298 * @retval None
|
|
|
299 */
|
|
|
300 #define __HAL_IRDA_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR = ~(__FLAG__))
|
|
|
301
|
|
|
302 /** @brief Clear the IRDA PE pending flag.
|
|
|
303 * @param __HANDLE__: specifies the USART Handle.
|
|
|
304 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
|
|
|
305 * UART peripheral.
|
|
|
306 * @retval None
|
|
|
307 */
|
|
|
308 #define __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__) \
|
|
|
309 do{ \
|
|
|
310 __IO uint32_t tmpreg; \
|
|
|
311 tmpreg = (__HANDLE__)->Instance->SR; \
|
|
|
312 UNUSED(tmpreg); \
|
|
|
313 } while(0)
|
|
|
314
|
|
|
315 /** @brief Clear the IRDA FE pending flag.
|
|
|
316 * @param __HANDLE__: specifies the USART Handle.
|
|
|
317 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
|
|
|
318 * UART peripheral.
|
|
|
319 * @retval None
|
|
|
320 */
|
|
|
321 #define __HAL_IRDA_CLEAR_FEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
|
|
|
322
|
|
|
323 /** @brief Clear the IRDA NE pending flag.
|
|
|
324 * @param __HANDLE__: specifies the USART Handle.
|
|
|
325 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
|
|
|
326 * UART peripheral.
|
|
|
327 * @retval None
|
|
|
328 */
|
|
|
329 #define __HAL_IRDA_CLEAR_NEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
|
|
|
330
|
|
|
331 /** @brief Clear the IRDA ORE pending flag.
|
|
|
332 * @param __HANDLE__: specifies the USART Handle.
|
|
|
333 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
|
|
|
334 * UART peripheral.
|
|
|
335 * @retval None
|
|
|
336 */
|
|
|
337 #define __HAL_IRDA_CLEAR_OREFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
|
|
|
338
|
|
|
339 /** @brief Clear the IRDA IDLE pending flag.
|
|
|
340 * @param __HANDLE__: specifies the USART Handle.
|
|
|
341 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
|
|
|
342 * UART peripheral.
|
|
|
343 * @retval None
|
|
|
344 */
|
|
|
345 #define __HAL_IRDA_CLEAR_IDLEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
|
|
|
346
|
|
|
347 /** @brief Enables or disables the specified IRDA interrupt.
|
|
|
348 * @param __HANDLE__: specifies the USART Handle.
|
|
|
349 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
|
|
|
350 * UART peripheral.
|
|
|
351 * @param __INTERRUPT__: specifies the IRDA interrupt source to check.
|
|
|
352 * This parameter can be one of the following values:
|
|
|
353 * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt
|
|
|
354 * @arg IRDA_IT_TC: Transmission complete interrupt
|
|
|
355 * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt
|
|
|
356 * @arg IRDA_IT_IDLE: Idle line detection interrupt
|
|
|
357 * @arg IRDA_IT_PE: Parity Error interrupt
|
|
|
358 * @arg IRDA_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
|
|
|
359 * @retval None
|
|
|
360 */
|
|
|
361 #define __HAL_IRDA_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == 1)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & IRDA_IT_MASK)): \
|
|
|
362 (((__INTERRUPT__) >> 28) == 2)? ((__HANDLE__)->Instance->CR2 |= ((__INTERRUPT__) & IRDA_IT_MASK)): \
|
|
|
363 ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & IRDA_IT_MASK)))
|
|
|
364 #define __HAL_IRDA_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == 1)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & IRDA_IT_MASK)): \
|
|
|
365 (((__INTERRUPT__) >> 28) == 2)? ((__HANDLE__)->Instance->CR2 &= ~((__INTERRUPT__) & IRDA_IT_MASK)): \
|
|
|
366 ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & IRDA_IT_MASK)))
|
|
|
367
|
|
|
368 /** @brief Checks whether the specified IRDA interrupt has occurred or not.
|
|
|
369 * @param __HANDLE__: specifies the USART Handle.
|
|
|
370 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
|
|
|
371 * UART peripheral.
|
|
|
372 * @param __IT__: specifies the IRDA interrupt source to check.
|
|
|
373 * This parameter can be one of the following values:
|
|
|
374 * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt
|
|
|
375 * @arg IRDA_IT_TC: Transmission complete interrupt
|
|
|
376 * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt
|
|
|
377 * @arg IRDA_IT_IDLE: Idle line detection interrupt
|
|
|
378 * @arg USART_IT_ERR: Error interrupt
|
|
|
379 * @arg IRDA_IT_PE: Parity Error interrupt
|
|
|
380 * @retval The new state of __IT__ (TRUE or FALSE).
|
|
|
381 */
|
|
|
382 #define __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28) == 1)? (__HANDLE__)->Instance->CR1:(((((uint32_t)(__IT__)) >> 28) == 2)? \
|
|
|
383 (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & (((uint32_t)(__IT__)) & IRDA_IT_MASK))
|
|
|
384
|
|
|
385 /** @brief Macro to enable the IRDA's one bit sample method
|
|
|
386 * @param __HANDLE__: specifies the IRDA Handle.
|
|
|
387 * @retval None
|
|
|
388 */
|
|
|
389 #define __HAL_IRDA_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
|
|
|
390
|
|
|
391 /** @brief Macro to disable the IRDA's one bit sample method
|
|
|
392 * @param __HANDLE__: specifies the IRDA Handle.
|
|
|
393 * @retval None
|
|
|
394 */
|
|
|
395 #define __HAL_IRDA_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= (uint16_t)~((uint16_t)USART_CR3_ONEBIT))
|
|
|
396
|
|
|
397 /** @brief Enable UART/USART associated to IRDA Handle
|
|
|
398 * @param __HANDLE__: specifies the IRDA Handle.
|
|
|
399 * IRDA Handle selects the USARTx or UARTy peripheral
|
|
|
400 * (USART,UART availability and x,y values depending on device).
|
|
|
401 * @retval None
|
|
|
402 */
|
|
|
403 #define __HAL_IRDA_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
|
|
|
404
|
|
|
405 /** @brief Disable UART/USART associated to IRDA Handle
|
|
|
406 * @param __HANDLE__: specifies the IRDA Handle.
|
|
|
407 * IRDA Handle selects the USARTx or UARTy peripheral
|
|
|
408 * (USART,UART availability and x,y values depending on device).
|
|
|
409 * @retval None
|
|
|
410 */
|
|
|
411 #define __HAL_IRDA_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
|
|
|
412
|
|
|
413 /**
|
|
|
414 * @}
|
|
|
415 */
|
|
|
416
|
|
|
417 /* Exported functions --------------------------------------------------------*/
|
|
|
418 /** @addtogroup IRDA_Exported_Functions
|
|
|
419 * @{
|
|
|
420 */
|
|
|
421
|
|
|
422 /** @addtogroup IRDA_Exported_Functions_Group1
|
|
|
423 * @{
|
|
|
424 */
|
|
|
425 /* Initialization/de-initialization functions **********************************/
|
|
|
426 HAL_StatusTypeDef HAL_IRDA_Init(IRDA_HandleTypeDef *hirda);
|
|
|
427 HAL_StatusTypeDef HAL_IRDA_DeInit(IRDA_HandleTypeDef *hirda);
|
|
|
428 void HAL_IRDA_MspInit(IRDA_HandleTypeDef *hirda);
|
|
|
429 void HAL_IRDA_MspDeInit(IRDA_HandleTypeDef *hirda);
|
|
|
430 /**
|
|
|
431 * @}
|
|
|
432 */
|
|
|
433
|
|
|
434 /** @addtogroup IRDA_Exported_Functions_Group2
|
|
|
435 * @{
|
|
|
436 */
|
|
|
437 /* IO operation functions *******************************************************/
|
|
|
438 HAL_StatusTypeDef HAL_IRDA_Transmit(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
|
|
|
439 HAL_StatusTypeDef HAL_IRDA_Receive(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
|
|
|
440 HAL_StatusTypeDef HAL_IRDA_Transmit_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
|
|
|
441 HAL_StatusTypeDef HAL_IRDA_Receive_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
|
|
|
442 HAL_StatusTypeDef HAL_IRDA_Transmit_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
|
|
|
443 HAL_StatusTypeDef HAL_IRDA_Receive_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
|
|
|
444 HAL_StatusTypeDef HAL_IRDA_DMAPause(IRDA_HandleTypeDef *hirda);
|
|
|
445 HAL_StatusTypeDef HAL_IRDA_DMAResume(IRDA_HandleTypeDef *hirda);
|
|
|
446 HAL_StatusTypeDef HAL_IRDA_DMAStop(IRDA_HandleTypeDef *hirda);
|
|
|
447 void HAL_IRDA_IRQHandler(IRDA_HandleTypeDef *hirda);
|
|
|
448 void HAL_IRDA_TxCpltCallback(IRDA_HandleTypeDef *hirda);
|
|
|
449 void HAL_IRDA_RxCpltCallback(IRDA_HandleTypeDef *hirda);
|
|
|
450 void HAL_IRDA_TxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
|
|
|
451 void HAL_IRDA_RxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
|
|
|
452 void HAL_IRDA_ErrorCallback(IRDA_HandleTypeDef *hirda);
|
|
|
453 /**
|
|
|
454 * @}
|
|
|
455 */
|
|
|
456
|
|
|
457 /** @addtogroup IRDA_Exported_Functions_Group3
|
|
|
458 * @{
|
|
|
459 */
|
|
|
460 /* Peripheral State functions **************************************************/
|
|
|
461 HAL_IRDA_StateTypeDef HAL_IRDA_GetState(IRDA_HandleTypeDef *hirda);
|
|
|
462 uint32_t HAL_IRDA_GetError(IRDA_HandleTypeDef *hirda);
|
|
|
463 /**
|
|
|
464 * @}
|
|
|
465 */
|
|
|
466
|
|
|
467 /**
|
|
|
468 * @}
|
|
|
469 */
|
|
|
470
|
|
|
471 /* Private types -------------------------------------------------------------*/
|
|
|
472 /* Private variables ---------------------------------------------------------*/
|
|
|
473 /* Private constants ---------------------------------------------------------*/
|
|
|
474 /** @defgroup IRDA_Private_Constants IRDA Private Constants
|
|
|
475 * @{
|
|
|
476 */
|
|
|
477
|
|
|
478 /** @brief IRDA interruptions flag mask
|
|
|
479 *
|
|
|
480 */
|
|
|
481 #define IRDA_IT_MASK ((uint32_t) USART_CR1_PEIE | USART_CR1_TXEIE | USART_CR1_TCIE | USART_CR1_RXNEIE | \
|
|
|
482 USART_CR1_IDLEIE | USART_CR2_LBDIE | USART_CR3_CTSIE | USART_CR3_EIE )
|
|
|
483
|
|
|
484
|
|
|
485 #define IRDA_CR1_REG_INDEX 1
|
|
|
486 #define IRDA_CR2_REG_INDEX 2
|
|
|
487 #define IRDA_CR3_REG_INDEX 3
|
|
|
488 /**
|
|
|
489 * @}
|
|
|
490 */
|
|
|
491
|
|
|
492 /* Private macros --------------------------------------------------------*/
|
|
|
493 /** @defgroup IRDA_Private_Macros IRDA Private Macros
|
|
|
494 * @{
|
|
|
495 */
|
|
|
496 #define IS_IRDA_WORD_LENGTH(LENGTH) (((LENGTH) == IRDA_WORDLENGTH_8B) || \
|
|
|
497 ((LENGTH) == IRDA_WORDLENGTH_9B))
|
|
|
498 #define IS_IRDA_PARITY(PARITY) (((PARITY) == IRDA_PARITY_NONE) || \
|
|
|
499 ((PARITY) == IRDA_PARITY_EVEN) || \
|
|
|
500 ((PARITY) == IRDA_PARITY_ODD))
|
|
|
501 #define IS_IRDA_MODE(MODE) ((((MODE) & (uint32_t)0x0000FFF3) == 0x00) && ((MODE) != (uint32_t)0x000000))
|
|
|
502 #define IS_IRDA_POWERMODE(MODE) (((MODE) == IRDA_POWERMODE_LOWPOWER) || \
|
|
|
503 ((MODE) == IRDA_POWERMODE_NORMAL))
|
|
|
504 #define IS_IRDA_BAUDRATE(BAUDRATE) ((BAUDRATE) < 115201)
|
|
|
505
|
|
|
506 #define IRDA_DIV(_PCLK_, _BAUD_) (((_PCLK_)*25)/(4*(_BAUD_)))
|
|
|
507 #define IRDA_DIVMANT(_PCLK_, _BAUD_) (IRDA_DIV((_PCLK_), (_BAUD_))/100)
|
|
|
508 #define IRDA_DIVFRAQ(_PCLK_, _BAUD_) (((IRDA_DIV((_PCLK_), (_BAUD_)) - (IRDA_DIVMANT((_PCLK_), (_BAUD_)) * 100)) * 16 + 50) / 100)
|
|
|
509 #define IRDA_BRR(_PCLK_, _BAUD_) ((IRDA_DIVMANT((_PCLK_), (_BAUD_)) << 4)|(IRDA_DIVFRAQ((_PCLK_), (_BAUD_)) & 0x0F))
|
|
|
510
|
|
|
511 /**
|
|
|
512 * @}
|
|
|
513 */
|
|
|
514
|
|
|
515 /* Private functions ---------------------------------------------------------*/
|
|
|
516 /** @defgroup IRDA_Private_Functions IRDA Private Functions
|
|
|
517 * @{
|
|
|
518 */
|
|
|
519
|
|
|
520 /**
|
|
|
521 * @}
|
|
|
522 */
|
|
|
523
|
|
|
524 /**
|
|
|
525 * @}
|
|
|
526 */
|
|
|
527
|
|
|
528 /**
|
|
|
529 * @}
|
|
|
530 */
|
|
|
531
|
|
|
532 #ifdef __cplusplus
|
|
|
533 }
|
|
|
534 #endif
|
|
|
535
|
|
|
536 #endif /* __STM32F4xx_HAL_IRDA_H */
|
|
|
537
|
|
|
538 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|
