stm32f1xx_hal_uart.h 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915
  1. /**
  2. ******************************************************************************
  3. * @file stm32f1xx_hal_uart.h
  4. * @author MCD Application Team
  5. * @brief Header file of UART HAL module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * Copyright (c) 2016 STMicroelectronics.
  10. * All rights reserved.
  11. *
  12. * This software is licensed under terms that can be found in the LICENSE file
  13. * in the root directory of this software component.
  14. * If no LICENSE file comes with this software, it is provided AS-IS.
  15. *
  16. ******************************************************************************
  17. */
  18. /* Define to prevent recursive inclusion -------------------------------------*/
  19. #ifndef __STM32F1xx_HAL_UART_H
  20. #define __STM32F1xx_HAL_UART_H
  21. #ifdef __cplusplus
  22. extern "C" {
  23. #endif
  24. /* Includes ------------------------------------------------------------------*/
  25. #include "stm32f1xx_hal_def.h"
  26. /** @addtogroup STM32F1xx_HAL_Driver
  27. * @{
  28. */
  29. /** @addtogroup UART
  30. * @{
  31. */
  32. /* Exported types ------------------------------------------------------------*/
  33. /** @defgroup UART_Exported_Types UART Exported Types
  34. * @{
  35. */
  36. /**
  37. * @brief UART Init Structure definition
  38. */
  39. typedef struct
  40. {
  41. uint32_t BaudRate; /*!< This member configures the UART communication baud rate.
  42. The baud rate is computed using the following formula:
  43. - IntegerDivider = ((PCLKx) / (16 * (huart->Init.BaudRate)))
  44. - FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 16) + 0.5 */
  45. uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
  46. This parameter can be a value of @ref UART_Word_Length */
  47. uint32_t StopBits; /*!< Specifies the number of stop bits transmitted.
  48. This parameter can be a value of @ref UART_Stop_Bits */
  49. uint32_t Parity; /*!< Specifies the parity mode.
  50. This parameter can be a value of @ref UART_Parity
  51. @note When parity is enabled, the computed parity is inserted
  52. at the MSB position of the transmitted data (9th bit when
  53. the word length is set to 9 data bits; 8th bit when the
  54. word length is set to 8 data bits). */
  55. uint32_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
  56. This parameter can be a value of @ref UART_Mode */
  57. uint32_t HwFlowCtl; /*!< Specifies whether the hardware flow control mode is enabled or disabled.
  58. This parameter can be a value of @ref UART_Hardware_Flow_Control */
  59. uint32_t OverSampling; /*!< Specifies whether the Over sampling 8 is enabled or disabled, to achieve higher speed (up to fPCLK/8).
  60. This parameter can be a value of @ref UART_Over_Sampling. This feature is only available
  61. on STM32F100xx family, so OverSampling parameter should always be set to 16. */
  62. } UART_InitTypeDef;
  63. /**
  64. * @brief HAL UART State structures definition
  65. * @note HAL UART State value is a combination of 2 different substates: gState and RxState.
  66. * - gState contains UART state information related to global Handle management
  67. * and also information related to Tx operations.
  68. * gState value coding follow below described bitmap :
  69. * b7-b6 Error information
  70. * 00 : No Error
  71. * 01 : (Not Used)
  72. * 10 : Timeout
  73. * 11 : Error
  74. * b5 Peripheral initialization status
  75. * 0 : Reset (Peripheral not initialized)
  76. * 1 : Init done (Peripheral initialized. HAL UART Init function already called)
  77. * b4-b3 (not used)
  78. * xx : Should be set to 00
  79. * b2 Intrinsic process state
  80. * 0 : Ready
  81. * 1 : Busy (Peripheral busy with some configuration or internal operations)
  82. * b1 (not used)
  83. * x : Should be set to 0
  84. * b0 Tx state
  85. * 0 : Ready (no Tx operation ongoing)
  86. * 1 : Busy (Tx operation ongoing)
  87. * - RxState contains information related to Rx operations.
  88. * RxState value coding follow below described bitmap :
  89. * b7-b6 (not used)
  90. * xx : Should be set to 00
  91. * b5 Peripheral initialization status
  92. * 0 : Reset (Peripheral not initialized)
  93. * 1 : Init done (Peripheral initialized)
  94. * b4-b2 (not used)
  95. * xxx : Should be set to 000
  96. * b1 Rx state
  97. * 0 : Ready (no Rx operation ongoing)
  98. * 1 : Busy (Rx operation ongoing)
  99. * b0 (not used)
  100. * x : Should be set to 0.
  101. */
  102. typedef enum
  103. {
  104. HAL_UART_STATE_RESET = 0x00U, /*!< Peripheral is not yet Initialized
  105. Value is allowed for gState and RxState */
  106. HAL_UART_STATE_READY = 0x20U, /*!< Peripheral Initialized and ready for use
  107. Value is allowed for gState and RxState */
  108. HAL_UART_STATE_BUSY = 0x24U, /*!< an internal process is ongoing
  109. Value is allowed for gState only */
  110. HAL_UART_STATE_BUSY_TX = 0x21U, /*!< Data Transmission process is ongoing
  111. Value is allowed for gState only */
  112. HAL_UART_STATE_BUSY_RX = 0x22U, /*!< Data Reception process is ongoing
  113. Value is allowed for RxState only */
  114. HAL_UART_STATE_BUSY_TX_RX = 0x23U, /*!< Data Transmission and Reception process is ongoing
  115. Not to be used for neither gState nor RxState.
  116. Value is result of combination (Or) between gState and RxState values */
  117. HAL_UART_STATE_TIMEOUT = 0xA0U, /*!< Timeout state
  118. Value is allowed for gState only */
  119. HAL_UART_STATE_ERROR = 0xE0U /*!< Error
  120. Value is allowed for gState only */
  121. } HAL_UART_StateTypeDef;
  122. /**
  123. * @brief HAL UART Reception type definition
  124. * @note HAL UART Reception type value aims to identify which type of Reception is ongoing.
  125. * This parameter can be a value of @ref UART_Reception_Type_Values :
  126. * HAL_UART_RECEPTION_STANDARD = 0x00U,
  127. * HAL_UART_RECEPTION_TOIDLE = 0x01U,
  128. */
  129. typedef uint32_t HAL_UART_RxTypeTypeDef;
  130. /**
  131. * @brief HAL UART Rx Event type definition
  132. * @note HAL UART Rx Event type value aims to identify which type of Event has occurred
  133. * leading to call of the RxEvent callback.
  134. * This parameter can be a value of @ref UART_RxEvent_Type_Values :
  135. * HAL_UART_RXEVENT_TC = 0x00U,
  136. * HAL_UART_RXEVENT_HT = 0x01U,
  137. * HAL_UART_RXEVENT_IDLE = 0x02U,
  138. */
  139. typedef uint32_t HAL_UART_RxEventTypeTypeDef;
  140. /**
  141. * @brief UART handle Structure definition
  142. */
  143. typedef struct __UART_HandleTypeDef
  144. {
  145. USART_TypeDef *Instance; /*!< UART registers base address */
  146. UART_InitTypeDef Init; /*!< UART communication parameters */
  147. const uint8_t *pTxBuffPtr; /*!< Pointer to UART Tx transfer Buffer */
  148. uint16_t TxXferSize; /*!< UART Tx Transfer size */
  149. __IO uint16_t TxXferCount; /*!< UART Tx Transfer Counter */
  150. uint8_t *pRxBuffPtr; /*!< Pointer to UART Rx transfer Buffer */
  151. uint16_t RxXferSize; /*!< UART Rx Transfer size */
  152. __IO uint16_t RxXferCount; /*!< UART Rx Transfer Counter */
  153. __IO HAL_UART_RxTypeTypeDef ReceptionType; /*!< Type of ongoing reception */
  154. __IO HAL_UART_RxEventTypeTypeDef RxEventType; /*!< Type of Rx Event */
  155. DMA_HandleTypeDef *hdmatx; /*!< UART Tx DMA Handle parameters */
  156. DMA_HandleTypeDef *hdmarx; /*!< UART Rx DMA Handle parameters */
  157. HAL_LockTypeDef Lock; /*!< Locking object */
  158. __IO HAL_UART_StateTypeDef gState; /*!< UART state information related to global Handle management
  159. and also related to Tx operations.
  160. This parameter can be a value of @ref HAL_UART_StateTypeDef */
  161. __IO HAL_UART_StateTypeDef RxState; /*!< UART state information related to Rx operations.
  162. This parameter can be a value of @ref HAL_UART_StateTypeDef */
  163. __IO uint32_t ErrorCode; /*!< UART Error code */
  164. #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
  165. void (* TxHalfCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Tx Half Complete Callback */
  166. void (* TxCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Tx Complete Callback */
  167. void (* RxHalfCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Rx Half Complete Callback */
  168. void (* RxCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Rx Complete Callback */
  169. void (* ErrorCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Error Callback */
  170. void (* AbortCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Abort Complete Callback */
  171. void (* AbortTransmitCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Abort Transmit Complete Callback */
  172. void (* AbortReceiveCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Abort Receive Complete Callback */
  173. void (* WakeupCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Wakeup Callback */
  174. void (* RxEventCallback)(struct __UART_HandleTypeDef *huart, uint16_t Pos); /*!< UART Reception Event Callback */
  175. void (* MspInitCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Msp Init callback */
  176. void (* MspDeInitCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Msp DeInit callback */
  177. #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
  178. } UART_HandleTypeDef;
  179. #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
  180. /**
  181. * @brief HAL UART Callback ID enumeration definition
  182. */
  183. typedef enum
  184. {
  185. HAL_UART_TX_HALFCOMPLETE_CB_ID = 0x00U, /*!< UART Tx Half Complete Callback ID */
  186. HAL_UART_TX_COMPLETE_CB_ID = 0x01U, /*!< UART Tx Complete Callback ID */
  187. HAL_UART_RX_HALFCOMPLETE_CB_ID = 0x02U, /*!< UART Rx Half Complete Callback ID */
  188. HAL_UART_RX_COMPLETE_CB_ID = 0x03U, /*!< UART Rx Complete Callback ID */
  189. HAL_UART_ERROR_CB_ID = 0x04U, /*!< UART Error Callback ID */
  190. HAL_UART_ABORT_COMPLETE_CB_ID = 0x05U, /*!< UART Abort Complete Callback ID */
  191. HAL_UART_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x06U, /*!< UART Abort Transmit Complete Callback ID */
  192. HAL_UART_ABORT_RECEIVE_COMPLETE_CB_ID = 0x07U, /*!< UART Abort Receive Complete Callback ID */
  193. HAL_UART_WAKEUP_CB_ID = 0x08U, /*!< UART Wakeup Callback ID */
  194. HAL_UART_MSPINIT_CB_ID = 0x0BU, /*!< UART MspInit callback ID */
  195. HAL_UART_MSPDEINIT_CB_ID = 0x0CU /*!< UART MspDeInit callback ID */
  196. } HAL_UART_CallbackIDTypeDef;
  197. /**
  198. * @brief HAL UART Callback pointer definition
  199. */
  200. typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer to an UART callback function */
  201. typedef void (*pUART_RxEventCallbackTypeDef)(struct __UART_HandleTypeDef *huart, uint16_t Pos); /*!< pointer to a UART Rx Event specific callback function */
  202. #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
  203. /**
  204. * @}
  205. */
  206. /* Exported constants --------------------------------------------------------*/
  207. /** @defgroup UART_Exported_Constants UART Exported Constants
  208. * @{
  209. */
  210. /** @defgroup UART_Error_Code UART Error Code
  211. * @{
  212. */
  213. #define HAL_UART_ERROR_NONE 0x00000000U /*!< No error */
  214. #define HAL_UART_ERROR_PE 0x00000001U /*!< Parity error */
  215. #define HAL_UART_ERROR_NE 0x00000002U /*!< Noise error */
  216. #define HAL_UART_ERROR_FE 0x00000004U /*!< Frame error */
  217. #define HAL_UART_ERROR_ORE 0x00000008U /*!< Overrun error */
  218. #define HAL_UART_ERROR_DMA 0x00000010U /*!< DMA transfer error */
  219. #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
  220. #define HAL_UART_ERROR_INVALID_CALLBACK 0x00000020U /*!< Invalid Callback error */
  221. #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
  222. /**
  223. * @}
  224. */
  225. /** @defgroup UART_Word_Length UART Word Length
  226. * @{
  227. */
  228. #define UART_WORDLENGTH_8B 0x00000000U
  229. #define UART_WORDLENGTH_9B ((uint32_t)USART_CR1_M)
  230. /**
  231. * @}
  232. */
  233. /** @defgroup UART_Stop_Bits UART Number of Stop Bits
  234. * @{
  235. */
  236. #define UART_STOPBITS_1 0x00000000U
  237. #define UART_STOPBITS_2 ((uint32_t)USART_CR2_STOP_1)
  238. /**
  239. * @}
  240. */
  241. /** @defgroup UART_Parity UART Parity
  242. * @{
  243. */
  244. #define UART_PARITY_NONE 0x00000000U
  245. #define UART_PARITY_EVEN ((uint32_t)USART_CR1_PCE)
  246. #define UART_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
  247. /**
  248. * @}
  249. */
  250. /** @defgroup UART_Hardware_Flow_Control UART Hardware Flow Control
  251. * @{
  252. */
  253. #define UART_HWCONTROL_NONE 0x00000000U
  254. #define UART_HWCONTROL_RTS ((uint32_t)USART_CR3_RTSE)
  255. #define UART_HWCONTROL_CTS ((uint32_t)USART_CR3_CTSE)
  256. #define UART_HWCONTROL_RTS_CTS ((uint32_t)(USART_CR3_RTSE | USART_CR3_CTSE))
  257. /**
  258. * @}
  259. */
  260. /** @defgroup UART_Mode UART Transfer Mode
  261. * @{
  262. */
  263. #define UART_MODE_RX ((uint32_t)USART_CR1_RE)
  264. #define UART_MODE_TX ((uint32_t)USART_CR1_TE)
  265. #define UART_MODE_TX_RX ((uint32_t)(USART_CR1_TE | USART_CR1_RE))
  266. /**
  267. * @}
  268. */
  269. /** @defgroup UART_State UART State
  270. * @{
  271. */
  272. #define UART_STATE_DISABLE 0x00000000U
  273. #define UART_STATE_ENABLE ((uint32_t)USART_CR1_UE)
  274. /**
  275. * @}
  276. */
  277. /** @defgroup UART_Over_Sampling UART Over Sampling
  278. * @{
  279. */
  280. #define UART_OVERSAMPLING_16 0x00000000U
  281. #if defined(USART_CR1_OVER8)
  282. #define UART_OVERSAMPLING_8 ((uint32_t)USART_CR1_OVER8)
  283. #endif /* USART_CR1_OVER8 */
  284. /**
  285. * @}
  286. */
  287. /** @defgroup UART_LIN_Break_Detection_Length UART LIN Break Detection Length
  288. * @{
  289. */
  290. #define UART_LINBREAKDETECTLENGTH_10B 0x00000000U
  291. #define UART_LINBREAKDETECTLENGTH_11B ((uint32_t)USART_CR2_LBDL)
  292. /**
  293. * @}
  294. */
  295. /** @defgroup UART_WakeUp_functions UART Wakeup Functions
  296. * @{
  297. */
  298. #define UART_WAKEUPMETHOD_IDLELINE 0x00000000U
  299. #define UART_WAKEUPMETHOD_ADDRESSMARK ((uint32_t)USART_CR1_WAKE)
  300. /**
  301. * @}
  302. */
  303. /** @defgroup UART_Flags UART FLags
  304. * Elements values convention: 0xXXXX
  305. * - 0xXXXX : Flag mask in the SR register
  306. * @{
  307. */
  308. #define UART_FLAG_CTS ((uint32_t)USART_SR_CTS)
  309. #define UART_FLAG_LBD ((uint32_t)USART_SR_LBD)
  310. #define UART_FLAG_TXE ((uint32_t)USART_SR_TXE)
  311. #define UART_FLAG_TC ((uint32_t)USART_SR_TC)
  312. #define UART_FLAG_RXNE ((uint32_t)USART_SR_RXNE)
  313. #define UART_FLAG_IDLE ((uint32_t)USART_SR_IDLE)
  314. #define UART_FLAG_ORE ((uint32_t)USART_SR_ORE)
  315. #define UART_FLAG_NE ((uint32_t)USART_SR_NE)
  316. #define UART_FLAG_FE ((uint32_t)USART_SR_FE)
  317. #define UART_FLAG_PE ((uint32_t)USART_SR_PE)
  318. /**
  319. * @}
  320. */
  321. /** @defgroup UART_Interrupt_definition UART Interrupt Definitions
  322. * Elements values convention: 0xY000XXXX
  323. * - XXXX : Interrupt mask (16 bits) in the Y register
  324. * - Y : Interrupt source register (2bits)
  325. * - 0001: CR1 register
  326. * - 0010: CR2 register
  327. * - 0011: CR3 register
  328. * @{
  329. */
  330. #define UART_IT_PE ((uint32_t)(UART_CR1_REG_INDEX << 28U | USART_CR1_PEIE))
  331. #define UART_IT_TXE ((uint32_t)(UART_CR1_REG_INDEX << 28U | USART_CR1_TXEIE))
  332. #define UART_IT_TC ((uint32_t)(UART_CR1_REG_INDEX << 28U | USART_CR1_TCIE))
  333. #define UART_IT_RXNE ((uint32_t)(UART_CR1_REG_INDEX << 28U | USART_CR1_RXNEIE))
  334. #define UART_IT_IDLE ((uint32_t)(UART_CR1_REG_INDEX << 28U | USART_CR1_IDLEIE))
  335. #define UART_IT_LBD ((uint32_t)(UART_CR2_REG_INDEX << 28U | USART_CR2_LBDIE))
  336. #define UART_IT_CTS ((uint32_t)(UART_CR3_REG_INDEX << 28U | USART_CR3_CTSIE))
  337. #define UART_IT_ERR ((uint32_t)(UART_CR3_REG_INDEX << 28U | USART_CR3_EIE))
  338. /**
  339. * @}
  340. */
  341. /** @defgroup UART_Reception_Type_Values UART Reception type values
  342. * @{
  343. */
  344. #define HAL_UART_RECEPTION_STANDARD (0x00000000U) /*!< Standard reception */
  345. #define HAL_UART_RECEPTION_TOIDLE (0x00000001U) /*!< Reception till completion or IDLE event */
  346. /**
  347. * @}
  348. */
  349. /** @defgroup UART_RxEvent_Type_Values UART RxEvent type values
  350. * @{
  351. */
  352. #define HAL_UART_RXEVENT_TC (0x00000000U) /*!< RxEvent linked to Transfer Complete event */
  353. #define HAL_UART_RXEVENT_HT (0x00000001U) /*!< RxEvent linked to Half Transfer event */
  354. #define HAL_UART_RXEVENT_IDLE (0x00000002U)
  355. /**
  356. * @}
  357. */
  358. /**
  359. * @}
  360. */
  361. /* Exported macro ------------------------------------------------------------*/
  362. /** @defgroup UART_Exported_Macros UART Exported Macros
  363. * @{
  364. */
  365. /** @brief Reset UART handle gstate & RxState
  366. * @param __HANDLE__ specifies the UART Handle.
  367. * UART Handle selects the USARTx or UARTy peripheral
  368. * (USART,UART availability and x,y values depending on device).
  369. * @retval None
  370. */
  371. #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
  372. #define __HAL_UART_RESET_HANDLE_STATE(__HANDLE__) do{ \
  373. (__HANDLE__)->gState = HAL_UART_STATE_RESET; \
  374. (__HANDLE__)->RxState = HAL_UART_STATE_RESET; \
  375. (__HANDLE__)->MspInitCallback = NULL; \
  376. (__HANDLE__)->MspDeInitCallback = NULL; \
  377. } while(0U)
  378. #else
  379. #define __HAL_UART_RESET_HANDLE_STATE(__HANDLE__) do{ \
  380. (__HANDLE__)->gState = HAL_UART_STATE_RESET; \
  381. (__HANDLE__)->RxState = HAL_UART_STATE_RESET; \
  382. } while(0U)
  383. #endif /*USE_HAL_UART_REGISTER_CALLBACKS */
  384. /** @brief Flushes the UART DR register
  385. * @param __HANDLE__ specifies the UART Handle.
  386. * UART Handle selects the USARTx or UARTy peripheral
  387. * (USART,UART availability and x,y values depending on device).
  388. */
  389. #define __HAL_UART_FLUSH_DRREGISTER(__HANDLE__) ((__HANDLE__)->Instance->DR)
  390. /** @brief Checks whether the specified UART flag is set or not.
  391. * @param __HANDLE__ specifies the UART Handle.
  392. * UART Handle selects the USARTx or UARTy peripheral
  393. * (USART,UART availability and x,y values depending on device).
  394. * @param __FLAG__ specifies the flag to check.
  395. * This parameter can be one of the following values:
  396. * @arg UART_FLAG_CTS: CTS Change flag (not available for UART4 and UART5)
  397. * @arg UART_FLAG_LBD: LIN Break detection flag
  398. * @arg UART_FLAG_TXE: Transmit data register empty flag
  399. * @arg UART_FLAG_TC: Transmission Complete flag
  400. * @arg UART_FLAG_RXNE: Receive data register not empty flag
  401. * @arg UART_FLAG_IDLE: Idle Line detection flag
  402. * @arg UART_FLAG_ORE: Overrun Error flag
  403. * @arg UART_FLAG_NE: Noise Error flag
  404. * @arg UART_FLAG_FE: Framing Error flag
  405. * @arg UART_FLAG_PE: Parity Error flag
  406. * @retval The new state of __FLAG__ (TRUE or FALSE).
  407. */
  408. #define __HAL_UART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
  409. /** @brief Clears the specified UART pending flag.
  410. * @param __HANDLE__ specifies the UART Handle.
  411. * UART Handle selects the USARTx or UARTy peripheral
  412. * (USART,UART availability and x,y values depending on device).
  413. * @param __FLAG__ specifies the flag to check.
  414. * This parameter can be any combination of the following values:
  415. * @arg UART_FLAG_CTS: CTS Change flag (not available for UART4 and UART5).
  416. * @arg UART_FLAG_LBD: LIN Break detection flag.
  417. * @arg UART_FLAG_TC: Transmission Complete flag.
  418. * @arg UART_FLAG_RXNE: Receive data register not empty flag.
  419. *
  420. * @note PE (Parity error), FE (Framing error), NE (Noise error), ORE (Overrun
  421. * error) and IDLE (Idle line detected) flags are cleared by software
  422. * sequence: a read operation to USART_SR register followed by a read
  423. * operation to USART_DR register.
  424. * @note RXNE flag can be also cleared by a read to the USART_DR register.
  425. * @note TC flag can be also cleared by software sequence: a read operation to
  426. * USART_SR register followed by a write operation to USART_DR register.
  427. * @note TXE flag is cleared only by a write to the USART_DR register.
  428. *
  429. * @retval None
  430. */
  431. #define __HAL_UART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR = ~(__FLAG__))
  432. /** @brief Clears the UART PE pending flag.
  433. * @param __HANDLE__ specifies the UART Handle.
  434. * UART Handle selects the USARTx or UARTy peripheral
  435. * (USART,UART availability and x,y values depending on device).
  436. * @retval None
  437. */
  438. #define __HAL_UART_CLEAR_PEFLAG(__HANDLE__) \
  439. do{ \
  440. __IO uint32_t tmpreg = 0x00U; \
  441. tmpreg = (__HANDLE__)->Instance->SR; \
  442. tmpreg = (__HANDLE__)->Instance->DR; \
  443. UNUSED(tmpreg); \
  444. } while(0U)
  445. /** @brief Clears the UART FE pending flag.
  446. * @param __HANDLE__ specifies the UART Handle.
  447. * UART Handle selects the USARTx or UARTy peripheral
  448. * (USART,UART availability and x,y values depending on device).
  449. * @retval None
  450. */
  451. #define __HAL_UART_CLEAR_FEFLAG(__HANDLE__) __HAL_UART_CLEAR_PEFLAG(__HANDLE__)
  452. /** @brief Clears the UART NE pending flag.
  453. * @param __HANDLE__ specifies the UART Handle.
  454. * UART Handle selects the USARTx or UARTy peripheral
  455. * (USART,UART availability and x,y values depending on device).
  456. * @retval None
  457. */
  458. #define __HAL_UART_CLEAR_NEFLAG(__HANDLE__) __HAL_UART_CLEAR_PEFLAG(__HANDLE__)
  459. /** @brief Clears the UART ORE pending flag.
  460. * @param __HANDLE__ specifies the UART Handle.
  461. * UART Handle selects the USARTx or UARTy peripheral
  462. * (USART,UART availability and x,y values depending on device).
  463. * @retval None
  464. */
  465. #define __HAL_UART_CLEAR_OREFLAG(__HANDLE__) __HAL_UART_CLEAR_PEFLAG(__HANDLE__)
  466. /** @brief Clears the UART IDLE pending flag.
  467. * @param __HANDLE__ specifies the UART Handle.
  468. * UART Handle selects the USARTx or UARTy peripheral
  469. * (USART,UART availability and x,y values depending on device).
  470. * @retval None
  471. */
  472. #define __HAL_UART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_UART_CLEAR_PEFLAG(__HANDLE__)
  473. /** @brief Enable the specified UART interrupt.
  474. * @param __HANDLE__ specifies the UART Handle.
  475. * UART Handle selects the USARTx or UARTy peripheral
  476. * (USART,UART availability and x,y values depending on device).
  477. * @param __INTERRUPT__ specifies the UART interrupt source to enable.
  478. * This parameter can be one of the following values:
  479. * @arg UART_IT_CTS: CTS change interrupt
  480. * @arg UART_IT_LBD: LIN Break detection interrupt
  481. * @arg UART_IT_TXE: Transmit Data Register empty interrupt
  482. * @arg UART_IT_TC: Transmission complete interrupt
  483. * @arg UART_IT_RXNE: Receive Data register not empty interrupt
  484. * @arg UART_IT_IDLE: Idle line detection interrupt
  485. * @arg UART_IT_PE: Parity Error interrupt
  486. * @arg UART_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
  487. * @retval None
  488. */
  489. #define __HAL_UART_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28U) == UART_CR1_REG_INDEX)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & UART_IT_MASK)): \
  490. (((__INTERRUPT__) >> 28U) == UART_CR2_REG_INDEX)? ((__HANDLE__)->Instance->CR2 |= ((__INTERRUPT__) & UART_IT_MASK)): \
  491. ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & UART_IT_MASK)))
  492. /** @brief Disable the specified UART interrupt.
  493. * @param __HANDLE__ specifies the UART Handle.
  494. * UART Handle selects the USARTx or UARTy peripheral
  495. * (USART,UART availability and x,y values depending on device).
  496. * @param __INTERRUPT__ specifies the UART interrupt source to disable.
  497. * This parameter can be one of the following values:
  498. * @arg UART_IT_CTS: CTS change interrupt
  499. * @arg UART_IT_LBD: LIN Break detection interrupt
  500. * @arg UART_IT_TXE: Transmit Data Register empty interrupt
  501. * @arg UART_IT_TC: Transmission complete interrupt
  502. * @arg UART_IT_RXNE: Receive Data register not empty interrupt
  503. * @arg UART_IT_IDLE: Idle line detection interrupt
  504. * @arg UART_IT_PE: Parity Error interrupt
  505. * @arg UART_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
  506. * @retval None
  507. */
  508. #define __HAL_UART_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28U) == UART_CR1_REG_INDEX)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & UART_IT_MASK)): \
  509. (((__INTERRUPT__) >> 28U) == UART_CR2_REG_INDEX)? ((__HANDLE__)->Instance->CR2 &= ~((__INTERRUPT__) & UART_IT_MASK)): \
  510. ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & UART_IT_MASK)))
  511. /** @brief Checks whether the specified UART interrupt source is enabled or not.
  512. * @param __HANDLE__ specifies the UART Handle.
  513. * UART Handle selects the USARTx or UARTy peripheral
  514. * (USART,UART availability and x,y values depending on device).
  515. * @param __IT__ specifies the UART interrupt source to check.
  516. * This parameter can be one of the following values:
  517. * @arg UART_IT_CTS: CTS change interrupt (not available for UART4 and UART5)
  518. * @arg UART_IT_LBD: LIN Break detection interrupt
  519. * @arg UART_IT_TXE: Transmit Data Register empty interrupt
  520. * @arg UART_IT_TC: Transmission complete interrupt
  521. * @arg UART_IT_RXNE: Receive Data register not empty interrupt
  522. * @arg UART_IT_IDLE: Idle line detection interrupt
  523. * @arg UART_IT_ERR: Error interrupt
  524. * @retval The new state of __IT__ (TRUE or FALSE).
  525. */
  526. #define __HAL_UART_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28U) == UART_CR1_REG_INDEX)? (__HANDLE__)->Instance->CR1:(((((uint32_t)(__IT__)) >> 28U) == UART_CR2_REG_INDEX)? \
  527. (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & (((uint32_t)(__IT__)) & UART_IT_MASK))
  528. /** @brief Enable CTS flow control
  529. * @note This macro allows to enable CTS hardware flow control for a given UART instance,
  530. * without need to call HAL_UART_Init() function.
  531. * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
  532. * @note As macro is expected to be used for modifying CTS Hw flow control feature activation, without need
  533. * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
  534. * - UART instance should have already been initialised (through call of HAL_UART_Init() )
  535. * - macro could only be called when corresponding UART instance is disabled (i.e __HAL_UART_DISABLE(__HANDLE__))
  536. * and should be followed by an Enable macro (i.e __HAL_UART_ENABLE(__HANDLE__)).
  537. * @param __HANDLE__ specifies the UART Handle.
  538. * The Handle Instance can be any USARTx (supporting the HW Flow control feature).
  539. * It is used to select the USART peripheral (USART availability and x value depending on device).
  540. * @retval None
  541. */
  542. #define __HAL_UART_HWCONTROL_CTS_ENABLE(__HANDLE__) \
  543. do{ \
  544. ATOMIC_SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE); \
  545. (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_CTSE; \
  546. } while(0U)
  547. /** @brief Disable CTS flow control
  548. * @note This macro allows to disable CTS hardware flow control for a given UART instance,
  549. * without need to call HAL_UART_Init() function.
  550. * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
  551. * @note As macro is expected to be used for modifying CTS Hw flow control feature activation, without need
  552. * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
  553. * - UART instance should have already been initialised (through call of HAL_UART_Init() )
  554. * - macro could only be called when corresponding UART instance is disabled (i.e __HAL_UART_DISABLE(__HANDLE__))
  555. * and should be followed by an Enable macro (i.e __HAL_UART_ENABLE(__HANDLE__)).
  556. * @param __HANDLE__ specifies the UART Handle.
  557. * The Handle Instance can be any USARTx (supporting the HW Flow control feature).
  558. * It is used to select the USART peripheral (USART availability and x value depending on device).
  559. * @retval None
  560. */
  561. #define __HAL_UART_HWCONTROL_CTS_DISABLE(__HANDLE__) \
  562. do{ \
  563. ATOMIC_CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE); \
  564. (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_CTSE); \
  565. } while(0U)
  566. /** @brief Enable RTS flow control
  567. * This macro allows to enable RTS hardware flow control for a given UART instance,
  568. * without need to call HAL_UART_Init() function.
  569. * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
  570. * @note As macro is expected to be used for modifying RTS Hw flow control feature activation, without need
  571. * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
  572. * - UART instance should have already been initialised (through call of HAL_UART_Init() )
  573. * - macro could only be called when corresponding UART instance is disabled (i.e __HAL_UART_DISABLE(__HANDLE__))
  574. * and should be followed by an Enable macro (i.e __HAL_UART_ENABLE(__HANDLE__)).
  575. * @param __HANDLE__ specifies the UART Handle.
  576. * The Handle Instance can be any USARTx (supporting the HW Flow control feature).
  577. * It is used to select the USART peripheral (USART availability and x value depending on device).
  578. * @retval None
  579. */
  580. #define __HAL_UART_HWCONTROL_RTS_ENABLE(__HANDLE__) \
  581. do{ \
  582. ATOMIC_SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE); \
  583. (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_RTSE; \
  584. } while(0U)
  585. /** @brief Disable RTS flow control
  586. * This macro allows to disable RTS hardware flow control for a given UART instance,
  587. * without need to call HAL_UART_Init() function.
  588. * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
  589. * @note As macro is expected to be used for modifying RTS Hw flow control feature activation, without need
  590. * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
  591. * - UART instance should have already been initialised (through call of HAL_UART_Init() )
  592. * - macro could only be called when corresponding UART instance is disabled (i.e __HAL_UART_DISABLE(__HANDLE__))
  593. * and should be followed by an Enable macro (i.e __HAL_UART_ENABLE(__HANDLE__)).
  594. * @param __HANDLE__ specifies the UART Handle.
  595. * The Handle Instance can be any USARTx (supporting the HW Flow control feature).
  596. * It is used to select the USART peripheral (USART availability and x value depending on device).
  597. * @retval None
  598. */
  599. #define __HAL_UART_HWCONTROL_RTS_DISABLE(__HANDLE__) \
  600. do{ \
  601. ATOMIC_CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE);\
  602. (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_RTSE); \
  603. } while(0U)
  604. #if defined(USART_CR3_ONEBIT)
  605. /** @brief Macro to enable the UART's one bit sample method
  606. * @param __HANDLE__ specifies the UART Handle.
  607. * @retval None
  608. */
  609. #define __HAL_UART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
  610. /** @brief Macro to disable the UART's one bit sample method
  611. * @param __HANDLE__ specifies the UART Handle.
  612. * @retval None
  613. */
  614. #define __HAL_UART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3\
  615. &= (uint16_t)~((uint16_t)USART_CR3_ONEBIT))
  616. #endif /* UART_ONE_BIT_SAMPLE_Feature */
  617. /** @brief Enable UART
  618. * @param __HANDLE__ specifies the UART Handle.
  619. * @retval None
  620. */
  621. #define __HAL_UART_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
  622. /** @brief Disable UART
  623. * @param __HANDLE__ specifies the UART Handle.
  624. * @retval None
  625. */
  626. #define __HAL_UART_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
  627. /**
  628. * @}
  629. */
  630. /* Exported functions --------------------------------------------------------*/
  631. /** @addtogroup UART_Exported_Functions
  632. * @{
  633. */
  634. /** @addtogroup UART_Exported_Functions_Group1 Initialization and de-initialization functions
  635. * @{
  636. */
  637. /* Initialization/de-initialization functions **********************************/
  638. HAL_StatusTypeDef HAL_UART_Init(UART_HandleTypeDef *huart);
  639. HAL_StatusTypeDef HAL_HalfDuplex_Init(UART_HandleTypeDef *huart);
  640. HAL_StatusTypeDef HAL_LIN_Init(UART_HandleTypeDef *huart, uint32_t BreakDetectLength);
  641. HAL_StatusTypeDef HAL_MultiProcessor_Init(UART_HandleTypeDef *huart, uint8_t Address, uint32_t WakeUpMethod);
  642. HAL_StatusTypeDef HAL_UART_DeInit(UART_HandleTypeDef *huart);
  643. void HAL_UART_MspInit(UART_HandleTypeDef *huart);
  644. void HAL_UART_MspDeInit(UART_HandleTypeDef *huart);
  645. /* Callbacks Register/UnRegister functions ***********************************/
  646. #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
  647. HAL_StatusTypeDef HAL_UART_RegisterCallback(UART_HandleTypeDef *huart, HAL_UART_CallbackIDTypeDef CallbackID,
  648. pUART_CallbackTypeDef pCallback);
  649. HAL_StatusTypeDef HAL_UART_UnRegisterCallback(UART_HandleTypeDef *huart, HAL_UART_CallbackIDTypeDef CallbackID);
  650. HAL_StatusTypeDef HAL_UART_RegisterRxEventCallback(UART_HandleTypeDef *huart, pUART_RxEventCallbackTypeDef pCallback);
  651. HAL_StatusTypeDef HAL_UART_UnRegisterRxEventCallback(UART_HandleTypeDef *huart);
  652. #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
  653. /**
  654. * @}
  655. */
  656. /** @addtogroup UART_Exported_Functions_Group2 IO operation functions
  657. * @{
  658. */
  659. /* IO operation functions *******************************************************/
  660. HAL_StatusTypeDef HAL_UART_Transmit(UART_HandleTypeDef *huart, const uint8_t *pData, uint16_t Size, uint32_t Timeout);
  661. HAL_StatusTypeDef HAL_UART_Receive(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  662. HAL_StatusTypeDef HAL_UART_Transmit_IT(UART_HandleTypeDef *huart, const uint8_t *pData, uint16_t Size);
  663. HAL_StatusTypeDef HAL_UART_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
  664. HAL_StatusTypeDef HAL_UART_Transmit_DMA(UART_HandleTypeDef *huart, const uint8_t *pData, uint16_t Size);
  665. HAL_StatusTypeDef HAL_UART_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
  666. HAL_StatusTypeDef HAL_UART_DMAPause(UART_HandleTypeDef *huart);
  667. HAL_StatusTypeDef HAL_UART_DMAResume(UART_HandleTypeDef *huart);
  668. HAL_StatusTypeDef HAL_UART_DMAStop(UART_HandleTypeDef *huart);
  669. HAL_StatusTypeDef HAL_UARTEx_ReceiveToIdle(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint16_t *RxLen,
  670. uint32_t Timeout);
  671. HAL_StatusTypeDef HAL_UARTEx_ReceiveToIdle_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
  672. HAL_StatusTypeDef HAL_UARTEx_ReceiveToIdle_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
  673. HAL_UART_RxEventTypeTypeDef HAL_UARTEx_GetRxEventType(UART_HandleTypeDef *huart);
  674. /* Transfer Abort functions */
  675. HAL_StatusTypeDef HAL_UART_Abort(UART_HandleTypeDef *huart);
  676. HAL_StatusTypeDef HAL_UART_AbortTransmit(UART_HandleTypeDef *huart);
  677. HAL_StatusTypeDef HAL_UART_AbortReceive(UART_HandleTypeDef *huart);
  678. HAL_StatusTypeDef HAL_UART_Abort_IT(UART_HandleTypeDef *huart);
  679. HAL_StatusTypeDef HAL_UART_AbortTransmit_IT(UART_HandleTypeDef *huart);
  680. HAL_StatusTypeDef HAL_UART_AbortReceive_IT(UART_HandleTypeDef *huart);
  681. void HAL_UART_IRQHandler(UART_HandleTypeDef *huart);
  682. void HAL_UART_TxCpltCallback(UART_HandleTypeDef *huart);
  683. void HAL_UART_TxHalfCpltCallback(UART_HandleTypeDef *huart);
  684. void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart);
  685. void HAL_UART_RxHalfCpltCallback(UART_HandleTypeDef *huart);
  686. void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart);
  687. void HAL_UART_AbortCpltCallback(UART_HandleTypeDef *huart);
  688. void HAL_UART_AbortTransmitCpltCallback(UART_HandleTypeDef *huart);
  689. void HAL_UART_AbortReceiveCpltCallback(UART_HandleTypeDef *huart);
  690. void HAL_UARTEx_RxEventCallback(UART_HandleTypeDef *huart, uint16_t Size);
  691. /**
  692. * @}
  693. */
  694. /** @addtogroup UART_Exported_Functions_Group3
  695. * @{
  696. */
  697. /* Peripheral Control functions ************************************************/
  698. HAL_StatusTypeDef HAL_LIN_SendBreak(UART_HandleTypeDef *huart);
  699. HAL_StatusTypeDef HAL_MultiProcessor_EnterMuteMode(UART_HandleTypeDef *huart);
  700. HAL_StatusTypeDef HAL_MultiProcessor_ExitMuteMode(UART_HandleTypeDef *huart);
  701. HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter(UART_HandleTypeDef *huart);
  702. HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver(UART_HandleTypeDef *huart);
  703. /**
  704. * @}
  705. */
  706. /** @addtogroup UART_Exported_Functions_Group4
  707. * @{
  708. */
  709. /* Peripheral State functions **************************************************/
  710. HAL_UART_StateTypeDef HAL_UART_GetState(const UART_HandleTypeDef *huart);
  711. uint32_t HAL_UART_GetError(const UART_HandleTypeDef *huart);
  712. /**
  713. * @}
  714. */
  715. /**
  716. * @}
  717. */
  718. /* Private types -------------------------------------------------------------*/
  719. /* Private variables ---------------------------------------------------------*/
  720. /* Private constants ---------------------------------------------------------*/
  721. /** @defgroup UART_Private_Constants UART Private Constants
  722. * @{
  723. */
  724. /** @brief UART interruptions flag mask
  725. *
  726. */
  727. #define UART_IT_MASK 0x0000FFFFU
  728. #define UART_CR1_REG_INDEX 1U
  729. #define UART_CR2_REG_INDEX 2U
  730. #define UART_CR3_REG_INDEX 3U
  731. /**
  732. * @}
  733. */
  734. /* Private macros ------------------------------------------------------------*/
  735. /** @defgroup UART_Private_Macros UART Private Macros
  736. * @{
  737. */
  738. #define IS_UART_WORD_LENGTH(LENGTH) (((LENGTH) == UART_WORDLENGTH_8B) || \
  739. ((LENGTH) == UART_WORDLENGTH_9B))
  740. #define IS_UART_LIN_WORD_LENGTH(LENGTH) (((LENGTH) == UART_WORDLENGTH_8B))
  741. #define IS_UART_STOPBITS(STOPBITS) (((STOPBITS) == UART_STOPBITS_1) || \
  742. ((STOPBITS) == UART_STOPBITS_2))
  743. #define IS_UART_PARITY(PARITY) (((PARITY) == UART_PARITY_NONE) || \
  744. ((PARITY) == UART_PARITY_EVEN) || \
  745. ((PARITY) == UART_PARITY_ODD))
  746. #define IS_UART_HARDWARE_FLOW_CONTROL(CONTROL)\
  747. (((CONTROL) == UART_HWCONTROL_NONE) || \
  748. ((CONTROL) == UART_HWCONTROL_RTS) || \
  749. ((CONTROL) == UART_HWCONTROL_CTS) || \
  750. ((CONTROL) == UART_HWCONTROL_RTS_CTS))
  751. #define IS_UART_MODE(MODE) ((((MODE) & 0x0000FFF3U) == 0x00U) && ((MODE) != 0x00U))
  752. #define IS_UART_STATE(STATE) (((STATE) == UART_STATE_DISABLE) || \
  753. ((STATE) == UART_STATE_ENABLE))
  754. #if defined(USART_CR1_OVER8)
  755. #define IS_UART_OVERSAMPLING(SAMPLING) (((SAMPLING) == UART_OVERSAMPLING_16) || \
  756. ((SAMPLING) == UART_OVERSAMPLING_8))
  757. #endif /* USART_CR1_OVER8 */
  758. #define IS_UART_LIN_OVERSAMPLING(SAMPLING) (((SAMPLING) == UART_OVERSAMPLING_16))
  759. #define IS_UART_LIN_BREAK_DETECT_LENGTH(LENGTH) (((LENGTH) == UART_LINBREAKDETECTLENGTH_10B) || \
  760. ((LENGTH) == UART_LINBREAKDETECTLENGTH_11B))
  761. #define IS_UART_WAKEUPMETHOD(WAKEUP) (((WAKEUP) == UART_WAKEUPMETHOD_IDLELINE) || \
  762. ((WAKEUP) == UART_WAKEUPMETHOD_ADDRESSMARK))
  763. #define IS_UART_BAUDRATE(BAUDRATE) ((BAUDRATE) <= 4500000U)
  764. #define IS_UART_ADDRESS(ADDRESS) ((ADDRESS) <= 0x0FU)
  765. #define UART_DIV_SAMPLING16(_PCLK_, _BAUD_) (((_PCLK_)*25U)/(4U*(_BAUD_)))
  766. #define UART_DIVMANT_SAMPLING16(_PCLK_, _BAUD_) (UART_DIV_SAMPLING16((_PCLK_), (_BAUD_))/100U)
  767. #define UART_DIVFRAQ_SAMPLING16(_PCLK_, _BAUD_) ((((UART_DIV_SAMPLING16((_PCLK_), (_BAUD_)) - (UART_DIVMANT_SAMPLING16((_PCLK_), (_BAUD_)) * 100U)) * 16U)\
  768. + 50U) / 100U)
  769. /* UART BRR = mantissa + overflow + fraction
  770. = (UART DIVMANT << 4) + (UART DIVFRAQ & 0xF0) + (UART DIVFRAQ & 0x0FU) */
  771. #define UART_BRR_SAMPLING16(_PCLK_, _BAUD_) (((UART_DIVMANT_SAMPLING16((_PCLK_), (_BAUD_)) << 4U) + \
  772. (UART_DIVFRAQ_SAMPLING16((_PCLK_), (_BAUD_)) & 0xF0U)) + \
  773. (UART_DIVFRAQ_SAMPLING16((_PCLK_), (_BAUD_)) & 0x0FU))
  774. #define UART_DIV_SAMPLING8(_PCLK_, _BAUD_) (((_PCLK_)*25U)/(2U*(_BAUD_)))
  775. #define UART_DIVMANT_SAMPLING8(_PCLK_, _BAUD_) (UART_DIV_SAMPLING8((_PCLK_), (_BAUD_))/100U)
  776. #define UART_DIVFRAQ_SAMPLING8(_PCLK_, _BAUD_) ((((UART_DIV_SAMPLING8((_PCLK_), (_BAUD_)) - (UART_DIVMANT_SAMPLING8((_PCLK_), (_BAUD_)) * 100U)) * 8U)\
  777. + 50U) / 100U)
  778. /* UART BRR = mantissa + overflow + fraction
  779. = (UART DIVMANT << 4) + ((UART DIVFRAQ & 0xF8) << 1) + (UART DIVFRAQ & 0x07U) */
  780. #define UART_BRR_SAMPLING8(_PCLK_, _BAUD_) (((UART_DIVMANT_SAMPLING8((_PCLK_), (_BAUD_)) << 4U) + \
  781. ((UART_DIVFRAQ_SAMPLING8((_PCLK_), (_BAUD_)) & 0xF8U) << 1U)) + \
  782. (UART_DIVFRAQ_SAMPLING8((_PCLK_), (_BAUD_)) & 0x07U))
  783. /**
  784. * @}
  785. */
  786. /* Private functions ---------------------------------------------------------*/
  787. /** @defgroup UART_Private_Functions UART Private Functions
  788. * @{
  789. */
  790. HAL_StatusTypeDef UART_Start_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
  791. HAL_StatusTypeDef UART_Start_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
  792. /**
  793. * @}
  794. */
  795. /**
  796. * @}
  797. */
  798. /**
  799. * @}
  800. */
  801. #ifdef __cplusplus
  802. }
  803. #endif
  804. #endif /* __STM32F1xx_HAL_UART_H */