stm32f4xx_hal_usart.h 26 KB

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