Mercurial > public > ostc4

comparison Common/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_usart.h @ 128:c78bcbd5deda FlipDisplay

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added current STM32 standandard libraries in version independend folder structure
author Ideenmodellierer
date Sun, 17 Feb 2019 21:12:22 +0100
parents
children
comparison
equal deleted inserted replaced
127:1369f8660eaa 128:c78bcbd5deda
1 /**
2 ******************************************************************************
3 * @file stm32f4xx_hal_usart.h
4 * @author MCD Application Team
5 * @brief Header file of USART HAL module.
6 ******************************************************************************
7 * @attention
8 *
9 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
10 *
11 * Redistribution and use in source and binary forms, with or without modification,
12 * are permitted provided that the following conditions are met:
13 * 1. Redistributions of source code must retain the above copyright notice,
14 * this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
18 * 3. Neither the name of STMicroelectronics nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 *
33 ******************************************************************************
34 */
35
36 /* Define to prevent recursive inclusion -------------------------------------*/
37 #ifndef __STM32F4xx_HAL_USART_H
38 #define __STM32F4xx_HAL_USART_H
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 /* Includes ------------------------------------------------------------------*/
45 #include "stm32f4xx_hal_def.h"
46
47 /** @addtogroup STM32F4xx_HAL_Driver
48 * @{
49 */
50
51 /** @addtogroup USART
52 * @{
53 */
54
55 /* Exported types ------------------------------------------------------------*/
56 /** @defgroup USART_Exported_Types USART Exported Types
57 * @{
58 */
59
60 /**
61 * @brief USART Init Structure definition
62 */
63 typedef struct
64 {
65 uint32_t BaudRate; /*!< This member configures the Usart communication baud rate.
66 The baud rate is computed using the following formula:
67 - IntegerDivider = ((PCLKx) / (8 * (husart->Init.BaudRate)))
68 - FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 8) + 0.5 */
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 USART_Word_Length */
72
73 uint32_t StopBits; /*!< Specifies the number of stop bits transmitted.
74 This parameter can be a value of @ref USART_Stop_Bits */
75
76 uint32_t Parity; /*!< Specifies the parity mode.
77 This parameter can be a value of @ref USART_Parity
78 @note When parity is enabled, the computed parity is inserted
79 at the MSB position of the transmitted data (9th bit when
80 the word length is set to 9 data bits; 8th bit when the
81 word length is set to 8 data bits). */
82
83 uint32_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
84 This parameter can be a value of @ref USART_Mode */
85
86 uint32_t CLKPolarity; /*!< Specifies the steady state of the serial clock.
87 This parameter can be a value of @ref USART_Clock_Polarity */
88
89 uint32_t CLKPhase; /*!< Specifies the clock transition on which the bit capture is made.
90 This parameter can be a value of @ref USART_Clock_Phase */
91
92 uint32_t CLKLastBit; /*!< Specifies whether the clock pulse corresponding to the last transmitted
93 data bit (MSB) has to be output on the SCLK pin in synchronous mode.
94 This parameter can be a value of @ref USART_Last_Bit */
95 }USART_InitTypeDef;
96
97 /**
98 * @brief HAL State structures definition
99 */
100 typedef enum
101 {
102 HAL_USART_STATE_RESET = 0x00U, /*!< Peripheral is not yet Initialized */
103 HAL_USART_STATE_READY = 0x01U, /*!< Peripheral Initialized and ready for use */
104 HAL_USART_STATE_BUSY = 0x02U, /*!< an internal process is ongoing */
105 HAL_USART_STATE_BUSY_TX = 0x12U, /*!< Data Transmission process is ongoing */
106 HAL_USART_STATE_BUSY_RX = 0x22U, /*!< Data Reception process is ongoing */
107 HAL_USART_STATE_BUSY_TX_RX = 0x32U, /*!< Data Transmission Reception process is ongoing */
108 HAL_USART_STATE_TIMEOUT = 0x03U, /*!< Timeout state */
109 HAL_USART_STATE_ERROR = 0x04U /*!< Error */
110 }HAL_USART_StateTypeDef;
111
112 /**
113 * @brief USART handle Structure definition
114 */
115 typedef struct
116 {
117 USART_TypeDef *Instance; /* USART registers base address */
118
119 USART_InitTypeDef Init; /* Usart communication parameters */
120
121 uint8_t *pTxBuffPtr; /* Pointer to Usart Tx transfer Buffer */
122
123 uint16_t TxXferSize; /* Usart Tx Transfer size */
124
125 __IO uint16_t TxXferCount; /* Usart Tx Transfer Counter */
126
127 uint8_t *pRxBuffPtr; /* Pointer to Usart Rx transfer Buffer */
128
129 uint16_t RxXferSize; /* Usart Rx Transfer size */
130
131 __IO uint16_t RxXferCount; /* Usart Rx Transfer Counter */
132
133 DMA_HandleTypeDef *hdmatx; /* Usart Tx DMA Handle parameters */
134
135 DMA_HandleTypeDef *hdmarx; /* Usart Rx DMA Handle parameters */
136
137 HAL_LockTypeDef Lock; /* Locking object */
138
139 __IO HAL_USART_StateTypeDef State; /* Usart communication state */
140
141 __IO uint32_t ErrorCode; /* USART Error code */
142
143 }USART_HandleTypeDef;
144 /**
145 * @}
146 */
147
148 /* Exported constants --------------------------------------------------------*/
149 /** @defgroup USART_Exported_Constants USART Exported Constants
150 * @{
151 */
152
153 /** @defgroup USART_Error_Code USART Error Code
154 * @brief USART Error Code
155 * @{
156 */
157 #define HAL_USART_ERROR_NONE 0x00000000U /*!< No error */
158 #define HAL_USART_ERROR_PE 0x00000001U /*!< Parity error */
159 #define HAL_USART_ERROR_NE 0x00000002U /*!< Noise error */
160 #define HAL_USART_ERROR_FE 0x00000004U /*!< Frame error */
161 #define HAL_USART_ERROR_ORE 0x00000008U /*!< Overrun error */
162 #define HAL_USART_ERROR_DMA 0x00000010U /*!< DMA transfer error */
163 /**
164 * @}
165 */
166
167 /** @defgroup USART_Word_Length USART Word Length
168 * @{
169 */
170 #define USART_WORDLENGTH_8B 0x00000000U
171 #define USART_WORDLENGTH_9B ((uint32_t)USART_CR1_M)
172 /**
173 * @}
174 */
175
176 /** @defgroup USART_Stop_Bits USART Number of Stop Bits
177 * @{
178 */
179 #define USART_STOPBITS_1 0x00000000U
180 #define USART_STOPBITS_0_5 ((uint32_t)USART_CR2_STOP_0)
181 #define USART_STOPBITS_2 ((uint32_t)USART_CR2_STOP_1)
182 #define USART_STOPBITS_1_5 ((uint32_t)(USART_CR2_STOP_0 | USART_CR2_STOP_1))
183 /**
184 * @}
185 */
186
187 /** @defgroup USART_Parity USART Parity
188 * @{
189 */
190 #define USART_PARITY_NONE 0x00000000U
191 #define USART_PARITY_EVEN ((uint32_t)USART_CR1_PCE)
192 #define USART_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
193 /**
194 * @}
195 */
196
197 /** @defgroup USART_Mode USART Mode
198 * @{
199 */
200 #define USART_MODE_RX ((uint32_t)USART_CR1_RE)
201 #define USART_MODE_TX ((uint32_t)USART_CR1_TE)
202 #define USART_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE))
203 /**
204 * @}
205 */
206
207 /** @defgroup USART_Clock USART Clock
208 * @{
209 */
210 #define USART_CLOCK_DISABLE 0x00000000U
211 #define USART_CLOCK_ENABLE ((uint32_t)USART_CR2_CLKEN)
212 /**
213 * @}
214 */
215
216 /** @defgroup USART_Clock_Polarity USART Clock Polarity
217 * @{
218 */
219 #define USART_POLARITY_LOW 0x00000000U
220 #define USART_POLARITY_HIGH ((uint32_t)USART_CR2_CPOL)
221 /**
222 * @}
223 */
224
225 /** @defgroup USART_Clock_Phase USART Clock Phase
226 * @{
227 */
228 #define USART_PHASE_1EDGE 0x00000000U
229 #define USART_PHASE_2EDGE ((uint32_t)USART_CR2_CPHA)
230 /**
231 * @}
232 */
233
234 /** @defgroup USART_Last_Bit USART Last Bit
235 * @{
236 */
237 #define USART_LASTBIT_DISABLE 0x00000000U
238 #define USART_LASTBIT_ENABLE ((uint32_t)USART_CR2_LBCL)
239 /**
240 * @}
241 */
242
243 /** @defgroup USART_NACK_State USART NACK State
244 * @{
245 */
246 #define USART_NACK_ENABLE ((uint32_t)USART_CR3_NACK)
247 #define USART_NACK_DISABLE 0x00000000U
248 /**
249 * @}
250 */
251
252 /** @defgroup USART_Flags USART Flags
253 * Elements values convention: 0xXXXX
254 * - 0xXXXX : Flag mask in the SR register
255 * @{
256 */
257 #define USART_FLAG_TXE 0x00000080U
258 #define USART_FLAG_TC 0x00000040U
259 #define USART_FLAG_RXNE 0x00000020U
260 #define USART_FLAG_IDLE 0x00000010U
261 #define USART_FLAG_ORE 0x00000008U
262 #define USART_FLAG_NE 0x00000004U
263 #define USART_FLAG_FE 0x00000002U
264 #define USART_FLAG_PE 0x00000001U
265 /**
266 * @}
267 */
268
269 /** @defgroup USART_Interrupt_definition USART Interrupts Definition
270 * Elements values convention: 0xY000XXXX
271 * - XXXX : Interrupt mask in the XX register
272 * - Y : Interrupt source register (2bits)
273 * - 01: CR1 register
274 * - 10: CR2 register
275 * - 11: CR3 register
276 *
277 * @{
278 */
279 #define USART_IT_PE ((uint32_t)(USART_CR1_REG_INDEX << 28U | USART_CR1_PEIE))
280 #define USART_IT_TXE ((uint32_t)(USART_CR1_REG_INDEX << 28U | USART_CR1_TXEIE))
281 #define USART_IT_TC ((uint32_t)(USART_CR1_REG_INDEX << 28U | USART_CR1_TCIE))
282 #define USART_IT_RXNE ((uint32_t)(USART_CR1_REG_INDEX << 28U | USART_CR1_RXNEIE))
283 #define USART_IT_IDLE ((uint32_t)(USART_CR1_REG_INDEX << 28U | USART_CR1_IDLEIE))
284
285 #define USART_IT_LBD ((uint32_t)(USART_CR2_REG_INDEX << 28U | USART_CR2_LBDIE))
286
287 #define USART_IT_CTS ((uint32_t)(USART_CR3_REG_INDEX << 28U | USART_CR3_CTSIE))
288 #define USART_IT_ERR ((uint32_t)(USART_CR3_REG_INDEX << 28U | USART_CR3_EIE))
289 /**
290 * @}
291 */
292
293 /**
294 * @}
295 */
296
297 /* Exported macro ------------------------------------------------------------*/
298 /** @defgroup USART_Exported_Macros USART Exported Macros
299 * @{
300 */
301
302 /** @brief Reset USART handle state
303 * @param __HANDLE__ specifies the USART Handle.
304 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
305 * @retval None
306 */
307 #define __HAL_USART_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_USART_STATE_RESET)
308
309 /** @brief Checks whether the specified Smartcard flag is set or not.
310 * @param __HANDLE__ specifies the USART Handle.
311 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
312 * @param __FLAG__ specifies the flag to check.
313 * This parameter can be one of the following values:
314 * @arg USART_FLAG_TXE: Transmit data register empty flag
315 * @arg USART_FLAG_TC: Transmission Complete flag
316 * @arg USART_FLAG_RXNE: Receive data register not empty flag
317 * @arg USART_FLAG_IDLE: Idle Line detection flag
318 * @arg USART_FLAG_ORE: Overrun Error flag
319 * @arg USART_FLAG_NE: Noise Error flag
320 * @arg USART_FLAG_FE: Framing Error flag
321 * @arg USART_FLAG_PE: Parity Error flag
322 * @retval The new state of __FLAG__ (TRUE or FALSE).
323 */
324 #define __HAL_USART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
325
326 /** @brief Clears the specified Smartcard pending flags.
327 * @param __HANDLE__ specifies the USART Handle.
328 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
329 * @param __FLAG__ specifies the flag to check.
330 * This parameter can be any combination of the following values:
331 * @arg USART_FLAG_TC: Transmission Complete flag.
332 * @arg USART_FLAG_RXNE: Receive data register not empty flag.
333 *
334 * @note PE (Parity error), FE (Framing error), NE (Noise error), ORE (Overrun
335 * error) and IDLE (Idle line detected) flags are cleared by software
336 * sequence: a read operation to USART_SR register followed by a read
337 * operation to USART_DR register.
338 * @note RXNE flag can be also cleared by a read to the USART_DR register.
339 * @note TC flag can be also cleared by software sequence: a read operation to
340 * USART_SR register followed by a write operation to USART_DR register.
341 * @note TXE flag is cleared only by a write to the USART_DR register.
342 *
343 * @retval None
344 */
345 #define __HAL_USART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR = ~(__FLAG__))
346
347 /** @brief Clear the USART PE pending flag.
348 * @param __HANDLE__ specifies the USART Handle.
349 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
350 * @retval None
351 */
352 #define __HAL_USART_CLEAR_PEFLAG(__HANDLE__) \
353 do{ \
354 __IO uint32_t tmpreg = 0x00U; \
355 tmpreg = (__HANDLE__)->Instance->SR; \
356 tmpreg = (__HANDLE__)->Instance->DR; \
357 UNUSED(tmpreg); \
358 } while(0U)
359
360 /** @brief Clear the USART FE pending flag.
361 * @param __HANDLE__ specifies the USART Handle.
362 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
363 * @retval None
364 */
365 #define __HAL_USART_CLEAR_FEFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
366
367 /** @brief Clear the USART NE pending flag.
368 * @param __HANDLE__ specifies the USART Handle.
369 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
370 * @retval None
371 */
372 #define __HAL_USART_CLEAR_NEFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
373
374 /** @brief Clear the UART ORE pending flag.
375 * @param __HANDLE__ specifies the USART Handle.
376 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
377 * @retval None
378 */
379 #define __HAL_USART_CLEAR_OREFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
380
381 /** @brief Clear the USART IDLE pending flag.
382 * @param __HANDLE__ specifies the USART Handle.
383 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
384 * @retval None
385 */
386 #define __HAL_USART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
387
388 /** @brief Enables or disables the specified USART interrupts.
389 * @param __HANDLE__ specifies the USART Handle.
390 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
391 * @param __INTERRUPT__ specifies the USART interrupt source to check.
392 * This parameter can be one of the following values:
393 * @arg USART_IT_TXE: Transmit Data Register empty interrupt
394 * @arg USART_IT_TC: Transmission complete interrupt
395 * @arg USART_IT_RXNE: Receive Data register not empty interrupt
396 * @arg USART_IT_IDLE: Idle line detection interrupt
397 * @arg USART_IT_PE: Parity Error interrupt
398 * @arg USART_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
399 * This parameter can be: ENABLE or DISABLE.
400 * @retval None
401 */
402 #define __HAL_USART_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28U) == 1U)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & USART_IT_MASK)): \
403 (((__INTERRUPT__) >> 28U) == 2U)? ((__HANDLE__)->Instance->CR2 |= ((__INTERRUPT__) & USART_IT_MASK)): \
404 ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & USART_IT_MASK)))
405 #define __HAL_USART_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28U) == 1U)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & USART_IT_MASK)): \
406 (((__INTERRUPT__) >> 28U) == 2U)? ((__HANDLE__)->Instance->CR2 &= ~((__INTERRUPT__) & USART_IT_MASK)): \
407 ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & USART_IT_MASK)))
408
409 /** @brief Checks whether the specified USART interrupt has occurred or not.
410 * @param __HANDLE__ specifies the USART Handle.
411 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
412 * @param __IT__ specifies the USART interrupt source to check.
413 * This parameter can be one of the following values:
414 * @arg USART_IT_TXE: Transmit Data Register empty interrupt
415 * @arg USART_IT_TC: Transmission complete interrupt
416 * @arg USART_IT_RXNE: Receive Data register not empty interrupt
417 * @arg USART_IT_IDLE: Idle line detection interrupt
418 * @arg USART_IT_ERR: Error interrupt
419 * @arg USART_IT_PE: Parity Error interrupt
420 * @retval The new state of __IT__ (TRUE or FALSE).
421 */
422 #define __HAL_USART_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28U) == 1U)? (__HANDLE__)->Instance->CR1:(((((uint32_t)(__IT__)) >> 28U) == 2U)? \
423 (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & (((uint32_t)(__IT__)) & USART_IT_MASK))
424
425 /** @brief Macro to enable the USART's one bit sample method
426 * @param __HANDLE__ specifies the USART Handle.
427 * @retval None
428 */
429 #define __HAL_USART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
430
431 /** @brief Macro to disable the USART's one bit sample method
432 * @param __HANDLE__ specifies the USART Handle.
433 * @retval None
434 */
435 #define __HAL_USART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= (uint16_t)~((uint16_t)USART_CR3_ONEBIT))
436
437 /** @brief Enable USART
438 * @param __HANDLE__ specifies the USART Handle.
439 * USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
440 * @retval None
441 */
442 #define __HAL_USART_ENABLE(__HANDLE__) ( (__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
443
444 /** @brief Disable USART
445 * @param __HANDLE__ specifies the USART Handle.
446 * USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
447 * @retval None
448 */
449 #define __HAL_USART_DISABLE(__HANDLE__) ( (__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
450
451 /**
452 * @}
453 */
454 /* Exported functions --------------------------------------------------------*/
455 /** @addtogroup USART_Exported_Functions
456 * @{
457 */
458
459 /** @addtogroup USART_Exported_Functions_Group1
460 * @{
461 */
462 /* Initialization/de-initialization functions **********************************/
463 HAL_StatusTypeDef HAL_USART_Init(USART_HandleTypeDef *husart);
464 HAL_StatusTypeDef HAL_USART_DeInit(USART_HandleTypeDef *husart);
465 void HAL_USART_MspInit(USART_HandleTypeDef *husart);
466 void HAL_USART_MspDeInit(USART_HandleTypeDef *husart);
467 /**
468 * @}
469 */
470
471 /** @addtogroup USART_Exported_Functions_Group2
472 * @{
473 */
474 /* IO operation functions *******************************************************/
475 HAL_StatusTypeDef HAL_USART_Transmit(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size, uint32_t Timeout);
476 HAL_StatusTypeDef HAL_USART_Receive(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
477 HAL_StatusTypeDef HAL_USART_TransmitReceive(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
478 HAL_StatusTypeDef HAL_USART_Transmit_IT(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size);
479 HAL_StatusTypeDef HAL_USART_Receive_IT(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size);
480 HAL_StatusTypeDef HAL_USART_TransmitReceive_IT(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size);
481 HAL_StatusTypeDef HAL_USART_Transmit_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size);
482 HAL_StatusTypeDef HAL_USART_Receive_DMA(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size);
483 HAL_StatusTypeDef HAL_USART_TransmitReceive_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size);
484 HAL_StatusTypeDef HAL_USART_DMAPause(USART_HandleTypeDef *husart);
485 HAL_StatusTypeDef HAL_USART_DMAResume(USART_HandleTypeDef *husart);
486 HAL_StatusTypeDef HAL_USART_DMAStop(USART_HandleTypeDef *husart);
487 /* Transfer Abort functions */
488 HAL_StatusTypeDef HAL_USART_Abort(USART_HandleTypeDef *husart);
489 HAL_StatusTypeDef HAL_USART_Abort_IT(USART_HandleTypeDef *husart);
490
491 void HAL_USART_IRQHandler(USART_HandleTypeDef *husart);
492 void HAL_USART_TxCpltCallback(USART_HandleTypeDef *husart);
493 void HAL_USART_TxHalfCpltCallback(USART_HandleTypeDef *husart);
494 void HAL_USART_RxCpltCallback(USART_HandleTypeDef *husart);
495 void HAL_USART_RxHalfCpltCallback(USART_HandleTypeDef *husart);
496 void HAL_USART_TxRxCpltCallback(USART_HandleTypeDef *husart);
497 void HAL_USART_ErrorCallback(USART_HandleTypeDef *husart);
498 void HAL_USART_AbortCpltCallback (USART_HandleTypeDef *husart);
499 /**
500 * @}
501 */
502
503 /** @addtogroup USART_Exported_Functions_Group3
504 * @{
505 */
506 /* Peripheral State functions ************************************************/
507 HAL_USART_StateTypeDef HAL_USART_GetState(USART_HandleTypeDef *husart);
508 uint32_t HAL_USART_GetError(USART_HandleTypeDef *husart);
509 /**
510 * @}
511 */
512
513 /**
514 * @}
515 */
516 /* Private types -------------------------------------------------------------*/
517 /* Private variables ---------------------------------------------------------*/
518 /* Private constants ---------------------------------------------------------*/
519 /** @defgroup USART_Private_Constants USART Private Constants
520 * @{
521 */
522 /** @brief USART interruptions flag mask
523 *
524 */
525 #define USART_IT_MASK ((uint32_t) USART_CR1_PEIE | USART_CR1_TXEIE | USART_CR1_TCIE | USART_CR1_RXNEIE | \
526 USART_CR1_IDLEIE | USART_CR2_LBDIE | USART_CR3_CTSIE | USART_CR3_EIE )
527
528 #define USART_CR1_REG_INDEX 1U
529 #define USART_CR2_REG_INDEX 2U
530 #define USART_CR3_REG_INDEX 3U
531 /**
532 * @}
533 */
534
535 /* Private macros ------------------------------------------------------------*/
536 /** @defgroup USART_Private_Macros USART Private Macros
537 * @{
538 */
539 #define IS_USART_NACK_STATE(NACK) (((NACK) == USART_NACK_ENABLE) || \
540 ((NACK) == USART_NACK_DISABLE))
541 #define IS_USART_LASTBIT(LASTBIT) (((LASTBIT) == USART_LASTBIT_DISABLE) || \
542 ((LASTBIT) == USART_LASTBIT_ENABLE))
543 #define IS_USART_PHASE(CPHA) (((CPHA) == USART_PHASE_1EDGE) || ((CPHA) == USART_PHASE_2EDGE))
544 #define IS_USART_POLARITY(CPOL) (((CPOL) == USART_POLARITY_LOW) || ((CPOL) == USART_POLARITY_HIGH))
545 #define IS_USART_CLOCK(CLOCK) (((CLOCK) == USART_CLOCK_DISABLE) || \
546 ((CLOCK) == USART_CLOCK_ENABLE))
547 #define IS_USART_WORD_LENGTH(LENGTH) (((LENGTH) == USART_WORDLENGTH_8B) || \
548 ((LENGTH) == USART_WORDLENGTH_9B))
549 #define IS_USART_STOPBITS(STOPBITS) (((STOPBITS) == USART_STOPBITS_1) || \
550 ((STOPBITS) == USART_STOPBITS_0_5) || \
551 ((STOPBITS) == USART_STOPBITS_1_5) || \
552 ((STOPBITS) == USART_STOPBITS_2))
553 #define IS_USART_PARITY(PARITY) (((PARITY) == USART_PARITY_NONE) || \
554 ((PARITY) == USART_PARITY_EVEN) || \
555 ((PARITY) == USART_PARITY_ODD))
556 #define IS_USART_MODE(MODE) ((((MODE) & 0xFFF3U) == 0x00U) && ((MODE) != 0x00U))
557 #define IS_USART_BAUDRATE(BAUDRATE) ((BAUDRATE) < 10500001U)
558
559 #define USART_DIV(_PCLK_, _BAUD_) (((_PCLK_)*25U)/(2U*(_BAUD_)))
560 #define USART_DIVMANT(_PCLK_, _BAUD_) (USART_DIV((_PCLK_), (_BAUD_))/100U)
561 #define USART_DIVFRAQ(_PCLK_, _BAUD_) (((USART_DIV((_PCLK_), (_BAUD_)) - (USART_DIVMANT((_PCLK_), (_BAUD_)) * 100U)) * 16U + 50U) / 100U)
562 #define USART_BRR(_PCLK_, _BAUD_) ((USART_DIVMANT((_PCLK_), (_BAUD_)) << 4U)|(USART_DIVFRAQ((_PCLK_), (_BAUD_)) & 0x0FU))
563 /**
564 * @}
565 */
566
567 /* Private functions ---------------------------------------------------------*/
568 /** @defgroup USART_Private_Functions USART Private Functions
569 * @{
570 */
571
572 /**
573 * @}
574 */
575
576 /**
577 * @}
578 */
579
580 /**
581 * @}
582 */
583
584 #ifdef __cplusplus
585 }
586 #endif
587
588 #endif /* __STM32F4xx_HAL_USART_H */
589
590 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/