py32f002b_hal_usart.h 27 KB

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