stm32f3xx_hal_uart.h 78 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588
  1. /**
  2. ******************************************************************************
  3. * @file stm32f3xx_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 STM32F3xx_HAL_UART_H
  20. #define STM32F3xx_HAL_UART_H
  21. #ifdef __cplusplus
  22. extern "C" {
  23. #endif
  24. /* Includes ------------------------------------------------------------------*/
  25. #include "stm32f3xx_hal_def.h"
  26. /** @addtogroup STM32F3xx_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 register is computed using the following formula:
  43. - If oversampling is 16 or in LIN mode,
  44. Baud Rate Register = ((uart_ker_ck) / ((huart->Init.BaudRate)))
  45. - If oversampling is 8,
  46. Baud Rate Register[15:4] = ((2 * uart_ker_ck) /
  47. ((huart->Init.BaudRate)))[15:4]
  48. Baud Rate Register[3] = 0
  49. Baud Rate Register[2:0] = (((2 * uart_ker_ck) /
  50. ((huart->Init.BaudRate)))[3:0]) >> 1
  51. where uart_ker_ck is the UART input clock */
  52. uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
  53. This parameter can be a value of @ref UARTEx_Word_Length. */
  54. uint32_t StopBits; /*!< Specifies the number of stop bits transmitted.
  55. This parameter can be a value of @ref UART_Stop_Bits. */
  56. uint32_t Parity; /*!< Specifies the parity mode.
  57. This parameter can be a value of @ref UART_Parity
  58. @note When parity is enabled, the computed parity is inserted
  59. at the MSB position of the transmitted data (9th bit when
  60. the word length is set to 9 data bits; 8th bit when the
  61. word length is set to 8 data bits). */
  62. uint32_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
  63. This parameter can be a value of @ref UART_Mode. */
  64. uint32_t HwFlowCtl; /*!< Specifies whether the hardware flow control mode is enabled
  65. or disabled.
  66. This parameter can be a value of @ref UART_Hardware_Flow_Control. */
  67. uint32_t OverSampling; /*!< Specifies whether the Over sampling 8 is enabled or disabled,
  68. to achieve higher speed (up to f_PCLK/8).
  69. This parameter can be a value of @ref UART_Over_Sampling. */
  70. uint32_t OneBitSampling; /*!< Specifies whether a single sample or three samples' majority vote is selected.
  71. Selecting the single sample method increases the receiver tolerance to clock
  72. deviations. This parameter can be a value of @ref UART_OneBit_Sampling. */
  73. } UART_InitTypeDef;
  74. /**
  75. * @brief UART Advanced Features initialization structure definition
  76. */
  77. typedef struct
  78. {
  79. uint32_t AdvFeatureInit; /*!< Specifies which advanced UART features is initialized. Several
  80. Advanced Features may be initialized at the same time .
  81. This parameter can be a value of
  82. @ref UART_Advanced_Features_Initialization_Type. */
  83. uint32_t TxPinLevelInvert; /*!< Specifies whether the TX pin active level is inverted.
  84. This parameter can be a value of @ref UART_Tx_Inv. */
  85. uint32_t RxPinLevelInvert; /*!< Specifies whether the RX pin active level is inverted.
  86. This parameter can be a value of @ref UART_Rx_Inv. */
  87. uint32_t DataInvert; /*!< Specifies whether data are inverted (positive/direct logic
  88. vs negative/inverted logic).
  89. This parameter can be a value of @ref UART_Data_Inv. */
  90. uint32_t Swap; /*!< Specifies whether TX and RX pins are swapped.
  91. This parameter can be a value of @ref UART_Rx_Tx_Swap. */
  92. uint32_t OverrunDisable; /*!< Specifies whether the reception overrun detection is disabled.
  93. This parameter can be a value of @ref UART_Overrun_Disable. */
  94. uint32_t DMADisableonRxError; /*!< Specifies whether the DMA is disabled in case of reception error.
  95. This parameter can be a value of @ref UART_DMA_Disable_on_Rx_Error. */
  96. uint32_t AutoBaudRateEnable; /*!< Specifies whether auto Baud rate detection is enabled.
  97. This parameter can be a value of @ref UART_AutoBaudRate_Enable. */
  98. uint32_t AutoBaudRateMode; /*!< If auto Baud rate detection is enabled, specifies how the rate
  99. detection is carried out.
  100. This parameter can be a value of @ref UART_AutoBaud_Rate_Mode. */
  101. uint32_t MSBFirst; /*!< Specifies whether MSB is sent first on UART line.
  102. This parameter can be a value of @ref UART_MSB_First. */
  103. } UART_AdvFeatureInitTypeDef;
  104. /**
  105. * @brief HAL UART State definition
  106. * @note HAL UART State value is a combination of 2 different substates:
  107. * gState and RxState (see @ref UART_State_Definition).
  108. * - gState contains UART state information related to global Handle management
  109. * and also information related to Tx operations.
  110. * gState value coding follow below described bitmap :
  111. * b7-b6 Error information
  112. * 00 : No Error
  113. * 01 : (Not Used)
  114. * 10 : Timeout
  115. * 11 : Error
  116. * b5 Peripheral initialization status
  117. * 0 : Reset (Peripheral not initialized)
  118. * 1 : Init done (Peripheral initialized. HAL UART Init function already called)
  119. * b4-b3 (not used)
  120. * xx : Should be set to 00
  121. * b2 Intrinsic process state
  122. * 0 : Ready
  123. * 1 : Busy (Peripheral busy with some configuration or internal operations)
  124. * b1 (not used)
  125. * x : Should be set to 0
  126. * b0 Tx state
  127. * 0 : Ready (no Tx operation ongoing)
  128. * 1 : Busy (Tx operation ongoing)
  129. * - RxState contains information related to Rx operations.
  130. * RxState value coding follow below described bitmap :
  131. * b7-b6 (not used)
  132. * xx : Should be set to 00
  133. * b5 Peripheral initialization status
  134. * 0 : Reset (Peripheral not initialized)
  135. * 1 : Init done (Peripheral initialized)
  136. * b4-b2 (not used)
  137. * xxx : Should be set to 000
  138. * b1 Rx state
  139. * 0 : Ready (no Rx operation ongoing)
  140. * 1 : Busy (Rx operation ongoing)
  141. * b0 (not used)
  142. * x : Should be set to 0.
  143. */
  144. typedef uint32_t HAL_UART_StateTypeDef;
  145. /**
  146. * @brief UART clock sources definition
  147. */
  148. typedef enum
  149. {
  150. UART_CLOCKSOURCE_PCLK1 = 0x00U, /*!< PCLK1 clock source */
  151. UART_CLOCKSOURCE_PCLK2 = 0x01U, /*!< PCLK2 clock source */
  152. UART_CLOCKSOURCE_HSI = 0x02U, /*!< HSI clock source */
  153. UART_CLOCKSOURCE_SYSCLK = 0x04U, /*!< SYSCLK clock source */
  154. UART_CLOCKSOURCE_LSE = 0x08U, /*!< LSE clock source */
  155. UART_CLOCKSOURCE_UNDEFINED = 0x10U /*!< Undefined clock source */
  156. } UART_ClockSourceTypeDef;
  157. /**
  158. * @brief HAL UART Reception type definition
  159. * @note HAL UART Reception type value aims to identify which type of Reception is ongoing.
  160. * This parameter can be a value of @ref UART_Reception_Type_Values :
  161. * HAL_UART_RECEPTION_STANDARD = 0x00U,
  162. * HAL_UART_RECEPTION_TOIDLE = 0x01U,
  163. * HAL_UART_RECEPTION_TORTO = 0x02U,
  164. * HAL_UART_RECEPTION_TOCHARMATCH = 0x03U,
  165. */
  166. typedef uint32_t HAL_UART_RxTypeTypeDef;
  167. /**
  168. * @brief HAL UART Rx Event type definition
  169. * @note HAL UART Rx Event type value aims to identify which type of Event has occurred
  170. * leading to call of the RxEvent callback.
  171. * This parameter can be a value of @ref UART_RxEvent_Type_Values :
  172. * HAL_UART_RXEVENT_TC = 0x00U,
  173. * HAL_UART_RXEVENT_HT = 0x01U,
  174. * HAL_UART_RXEVENT_IDLE = 0x02U,
  175. */
  176. typedef uint32_t HAL_UART_RxEventTypeTypeDef;
  177. /**
  178. * @brief UART handle Structure definition
  179. */
  180. typedef struct __UART_HandleTypeDef
  181. {
  182. USART_TypeDef *Instance; /*!< UART registers base address */
  183. UART_InitTypeDef Init; /*!< UART communication parameters */
  184. UART_AdvFeatureInitTypeDef AdvancedInit; /*!< UART Advanced Features initialization parameters */
  185. const uint8_t *pTxBuffPtr; /*!< Pointer to UART Tx transfer Buffer */
  186. uint16_t TxXferSize; /*!< UART Tx Transfer size */
  187. __IO uint16_t TxXferCount; /*!< UART Tx Transfer Counter */
  188. uint8_t *pRxBuffPtr; /*!< Pointer to UART Rx transfer Buffer */
  189. uint16_t RxXferSize; /*!< UART Rx Transfer size */
  190. __IO uint16_t RxXferCount; /*!< UART Rx Transfer Counter */
  191. uint16_t Mask; /*!< UART Rx RDR register mask */
  192. __IO HAL_UART_RxTypeTypeDef ReceptionType; /*!< Type of ongoing reception */
  193. __IO HAL_UART_RxEventTypeTypeDef RxEventType; /*!< Type of Rx Event */
  194. void (*RxISR)(struct __UART_HandleTypeDef *huart); /*!< Function pointer on Rx IRQ handler */
  195. void (*TxISR)(struct __UART_HandleTypeDef *huart); /*!< Function pointer on Tx IRQ handler */
  196. DMA_HandleTypeDef *hdmatx; /*!< UART Tx DMA Handle parameters */
  197. DMA_HandleTypeDef *hdmarx; /*!< UART Rx DMA Handle parameters */
  198. HAL_LockTypeDef Lock; /*!< Locking object */
  199. __IO HAL_UART_StateTypeDef gState; /*!< UART state information related to global Handle management
  200. and also related to Tx operations. This parameter
  201. can be a value of @ref HAL_UART_StateTypeDef */
  202. __IO HAL_UART_StateTypeDef RxState; /*!< UART state information related to Rx operations. This
  203. parameter can be a value of @ref HAL_UART_StateTypeDef */
  204. __IO uint32_t ErrorCode; /*!< UART Error code */
  205. #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
  206. void (* TxHalfCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Tx Half Complete Callback */
  207. void (* TxCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Tx Complete Callback */
  208. void (* RxHalfCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Rx Half Complete Callback */
  209. void (* RxCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Rx Complete Callback */
  210. void (* ErrorCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Error Callback */
  211. void (* AbortCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Abort Complete Callback */
  212. void (* AbortTransmitCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Abort Transmit Complete Callback */
  213. void (* AbortReceiveCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Abort Receive Complete Callback */
  214. void (* WakeupCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Wakeup Callback */
  215. void (* RxEventCallback)(struct __UART_HandleTypeDef *huart, uint16_t Pos); /*!< UART Reception Event Callback */
  216. void (* MspInitCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Msp Init callback */
  217. void (* MspDeInitCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Msp DeInit callback */
  218. #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
  219. } UART_HandleTypeDef;
  220. #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
  221. /**
  222. * @brief HAL UART Callback ID enumeration definition
  223. */
  224. typedef enum
  225. {
  226. HAL_UART_TX_HALFCOMPLETE_CB_ID = 0x00U, /*!< UART Tx Half Complete Callback ID */
  227. HAL_UART_TX_COMPLETE_CB_ID = 0x01U, /*!< UART Tx Complete Callback ID */
  228. HAL_UART_RX_HALFCOMPLETE_CB_ID = 0x02U, /*!< UART Rx Half Complete Callback ID */
  229. HAL_UART_RX_COMPLETE_CB_ID = 0x03U, /*!< UART Rx Complete Callback ID */
  230. HAL_UART_ERROR_CB_ID = 0x04U, /*!< UART Error Callback ID */
  231. HAL_UART_ABORT_COMPLETE_CB_ID = 0x05U, /*!< UART Abort Complete Callback ID */
  232. HAL_UART_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x06U, /*!< UART Abort Transmit Complete Callback ID */
  233. HAL_UART_ABORT_RECEIVE_COMPLETE_CB_ID = 0x07U, /*!< UART Abort Receive Complete Callback ID */
  234. HAL_UART_WAKEUP_CB_ID = 0x08U, /*!< UART Wakeup Callback ID */
  235. HAL_UART_MSPINIT_CB_ID = 0x0BU, /*!< UART MspInit callback ID */
  236. HAL_UART_MSPDEINIT_CB_ID = 0x0CU /*!< UART MspDeInit callback ID */
  237. } HAL_UART_CallbackIDTypeDef;
  238. /**
  239. * @brief HAL UART Callback pointer definition
  240. */
  241. typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer to an UART callback function */
  242. typedef void (*pUART_RxEventCallbackTypeDef)
  243. (struct __UART_HandleTypeDef *huart, uint16_t Pos); /*!< pointer to a UART Rx Event specific callback function */
  244. #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
  245. /**
  246. * @}
  247. */
  248. /* Exported constants --------------------------------------------------------*/
  249. /** @defgroup UART_Exported_Constants UART Exported Constants
  250. * @{
  251. */
  252. /** @defgroup UART_State_Definition UART State Code Definition
  253. * @{
  254. */
  255. #define HAL_UART_STATE_RESET 0x00000000U /*!< Peripheral is not initialized
  256. Value is allowed for gState and RxState */
  257. #define HAL_UART_STATE_READY 0x00000020U /*!< Peripheral Initialized and ready for use
  258. Value is allowed for gState and RxState */
  259. #define HAL_UART_STATE_BUSY 0x00000024U /*!< an internal process is ongoing
  260. Value is allowed for gState only */
  261. #define HAL_UART_STATE_BUSY_TX 0x00000021U /*!< Data Transmission process is ongoing
  262. Value is allowed for gState only */
  263. #define HAL_UART_STATE_BUSY_RX 0x00000022U /*!< Data Reception process is ongoing
  264. Value is allowed for RxState only */
  265. #define HAL_UART_STATE_BUSY_TX_RX 0x00000023U /*!< Data Transmission and Reception process is ongoing
  266. Not to be used for neither gState nor RxState.Value is result
  267. of combination (Or) between gState and RxState values */
  268. #define HAL_UART_STATE_TIMEOUT 0x000000A0U /*!< Timeout state
  269. Value is allowed for gState only */
  270. #define HAL_UART_STATE_ERROR 0x000000E0U /*!< Error
  271. Value is allowed for gState only */
  272. /**
  273. * @}
  274. */
  275. /** @defgroup UART_Error_Definition UART Error Definition
  276. * @{
  277. */
  278. #define HAL_UART_ERROR_NONE (0x00000000U) /*!< No error */
  279. #define HAL_UART_ERROR_PE (0x00000001U) /*!< Parity error */
  280. #define HAL_UART_ERROR_NE (0x00000002U) /*!< Noise error */
  281. #define HAL_UART_ERROR_FE (0x00000004U) /*!< Frame error */
  282. #define HAL_UART_ERROR_ORE (0x00000008U) /*!< Overrun error */
  283. #define HAL_UART_ERROR_DMA (0x00000010U) /*!< DMA transfer error */
  284. #define HAL_UART_ERROR_RTO (0x00000020U) /*!< Receiver Timeout error */
  285. #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
  286. #define HAL_UART_ERROR_INVALID_CALLBACK (0x00000040U) /*!< Invalid Callback error */
  287. #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
  288. /**
  289. * @}
  290. */
  291. /** @defgroup UART_Stop_Bits UART Number of Stop Bits
  292. * @{
  293. */
  294. #define UART_STOPBITS_0_5 USART_CR2_STOP_0 /*!< UART frame with 0.5 stop bit */
  295. #define UART_STOPBITS_1 0x00000000U /*!< UART frame with 1 stop bit */
  296. #define UART_STOPBITS_1_5 (USART_CR2_STOP_0 | USART_CR2_STOP_1) /*!< UART frame with 1.5 stop bits */
  297. #define UART_STOPBITS_2 USART_CR2_STOP_1 /*!< UART frame with 2 stop bits */
  298. /**
  299. * @}
  300. */
  301. /** @defgroup UART_Parity UART Parity
  302. * @{
  303. */
  304. #define UART_PARITY_NONE 0x00000000U /*!< No parity */
  305. #define UART_PARITY_EVEN USART_CR1_PCE /*!< Even parity */
  306. #define UART_PARITY_ODD (USART_CR1_PCE | USART_CR1_PS) /*!< Odd parity */
  307. /**
  308. * @}
  309. */
  310. /** @defgroup UART_Hardware_Flow_Control UART Hardware Flow Control
  311. * @{
  312. */
  313. #define UART_HWCONTROL_NONE 0x00000000U /*!< No hardware control */
  314. #define UART_HWCONTROL_RTS USART_CR3_RTSE /*!< Request To Send */
  315. #define UART_HWCONTROL_CTS USART_CR3_CTSE /*!< Clear To Send */
  316. #define UART_HWCONTROL_RTS_CTS (USART_CR3_RTSE | USART_CR3_CTSE) /*!< Request and Clear To Send */
  317. /**
  318. * @}
  319. */
  320. /** @defgroup UART_Mode UART Transfer Mode
  321. * @{
  322. */
  323. #define UART_MODE_RX USART_CR1_RE /*!< RX mode */
  324. #define UART_MODE_TX USART_CR1_TE /*!< TX mode */
  325. #define UART_MODE_TX_RX (USART_CR1_TE |USART_CR1_RE) /*!< RX and TX mode */
  326. /**
  327. * @}
  328. */
  329. /** @defgroup UART_State UART State
  330. * @{
  331. */
  332. #define UART_STATE_DISABLE 0x00000000U /*!< UART disabled */
  333. #define UART_STATE_ENABLE USART_CR1_UE /*!< UART enabled */
  334. /**
  335. * @}
  336. */
  337. /** @defgroup UART_Over_Sampling UART Over Sampling
  338. * @{
  339. */
  340. #define UART_OVERSAMPLING_16 0x00000000U /*!< Oversampling by 16 */
  341. #define UART_OVERSAMPLING_8 USART_CR1_OVER8 /*!< Oversampling by 8 */
  342. /**
  343. * @}
  344. */
  345. /** @defgroup UART_OneBit_Sampling UART One Bit Sampling Method
  346. * @{
  347. */
  348. #define UART_ONE_BIT_SAMPLE_DISABLE 0x00000000U /*!< One-bit sampling disable */
  349. #define UART_ONE_BIT_SAMPLE_ENABLE USART_CR3_ONEBIT /*!< One-bit sampling enable */
  350. /**
  351. * @}
  352. */
  353. /** @defgroup UART_AutoBaud_Rate_Mode UART Advanced Feature AutoBaud Rate Mode
  354. * @{
  355. */
  356. #define UART_ADVFEATURE_AUTOBAUDRATE_ONSTARTBIT 0x00000000U /*!< Auto Baud rate detection
  357. on start bit */
  358. #define UART_ADVFEATURE_AUTOBAUDRATE_ONFALLINGEDGE USART_CR2_ABRMODE_0 /*!< Auto Baud rate detection
  359. on falling edge */
  360. #define UART_ADVFEATURE_AUTOBAUDRATE_ON0X7FFRAME USART_CR2_ABRMODE_1 /*!< Auto Baud rate detection
  361. on 0x7F frame detection */
  362. #define UART_ADVFEATURE_AUTOBAUDRATE_ON0X55FRAME USART_CR2_ABRMODE /*!< Auto Baud rate detection
  363. on 0x55 frame detection */
  364. /**
  365. * @}
  366. */
  367. /** @defgroup UART_Receiver_Timeout UART Receiver Timeout
  368. * @{
  369. */
  370. #define UART_RECEIVER_TIMEOUT_DISABLE 0x00000000U /*!< UART Receiver Timeout disable */
  371. #define UART_RECEIVER_TIMEOUT_ENABLE USART_CR2_RTOEN /*!< UART Receiver Timeout enable */
  372. /**
  373. * @}
  374. */
  375. /** @defgroup UART_LIN UART Local Interconnection Network mode
  376. * @{
  377. */
  378. #define UART_LIN_DISABLE 0x00000000U /*!< Local Interconnect Network disable */
  379. #define UART_LIN_ENABLE USART_CR2_LINEN /*!< Local Interconnect Network enable */
  380. /**
  381. * @}
  382. */
  383. /** @defgroup UART_LIN_Break_Detection UART LIN Break Detection
  384. * @{
  385. */
  386. #define UART_LINBREAKDETECTLENGTH_10B 0x00000000U /*!< LIN 10-bit break detection length */
  387. #define UART_LINBREAKDETECTLENGTH_11B USART_CR2_LBDL /*!< LIN 11-bit break detection length */
  388. /**
  389. * @}
  390. */
  391. /** @defgroup UART_DMA_Tx UART DMA Tx
  392. * @{
  393. */
  394. #define UART_DMA_TX_DISABLE 0x00000000U /*!< UART DMA TX disabled */
  395. #define UART_DMA_TX_ENABLE USART_CR3_DMAT /*!< UART DMA TX enabled */
  396. /**
  397. * @}
  398. */
  399. /** @defgroup UART_DMA_Rx UART DMA Rx
  400. * @{
  401. */
  402. #define UART_DMA_RX_DISABLE 0x00000000U /*!< UART DMA RX disabled */
  403. #define UART_DMA_RX_ENABLE USART_CR3_DMAR /*!< UART DMA RX enabled */
  404. /**
  405. * @}
  406. */
  407. /** @defgroup UART_Half_Duplex_Selection UART Half Duplex Selection
  408. * @{
  409. */
  410. #define UART_HALF_DUPLEX_DISABLE 0x00000000U /*!< UART half-duplex disabled */
  411. #define UART_HALF_DUPLEX_ENABLE USART_CR3_HDSEL /*!< UART half-duplex enabled */
  412. /**
  413. * @}
  414. */
  415. /** @defgroup UART_WakeUp_Methods UART WakeUp Methods
  416. * @{
  417. */
  418. #define UART_WAKEUPMETHOD_IDLELINE 0x00000000U /*!< UART wake-up on idle line */
  419. #define UART_WAKEUPMETHOD_ADDRESSMARK USART_CR1_WAKE /*!< UART wake-up on address mark */
  420. /**
  421. * @}
  422. */
  423. /** @defgroup UART_Request_Parameters UART Request Parameters
  424. * @{
  425. */
  426. #define UART_AUTOBAUD_REQUEST USART_RQR_ABRRQ /*!< Auto-Baud Rate Request */
  427. #define UART_SENDBREAK_REQUEST USART_RQR_SBKRQ /*!< Send Break Request */
  428. #define UART_MUTE_MODE_REQUEST USART_RQR_MMRQ /*!< Mute Mode Request */
  429. #define UART_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive Data flush Request */
  430. #define UART_TXDATA_FLUSH_REQUEST USART_RQR_TXFRQ /*!< Transmit data flush Request */
  431. /**
  432. * @}
  433. */
  434. /** @defgroup UART_Advanced_Features_Initialization_Type UART Advanced Feature Initialization Type
  435. * @{
  436. */
  437. #define UART_ADVFEATURE_NO_INIT 0x00000000U /*!< No advanced feature initialization */
  438. #define UART_ADVFEATURE_TXINVERT_INIT 0x00000001U /*!< TX pin active level inversion */
  439. #define UART_ADVFEATURE_RXINVERT_INIT 0x00000002U /*!< RX pin active level inversion */
  440. #define UART_ADVFEATURE_DATAINVERT_INIT 0x00000004U /*!< Binary data inversion */
  441. #define UART_ADVFEATURE_SWAP_INIT 0x00000008U /*!< TX/RX pins swap */
  442. #define UART_ADVFEATURE_RXOVERRUNDISABLE_INIT 0x00000010U /*!< RX overrun disable */
  443. #define UART_ADVFEATURE_DMADISABLEONERROR_INIT 0x00000020U /*!< DMA disable on Reception Error */
  444. #define UART_ADVFEATURE_AUTOBAUDRATE_INIT 0x00000040U /*!< Auto Baud rate detection initialization */
  445. #define UART_ADVFEATURE_MSBFIRST_INIT 0x00000080U /*!< Most significant bit sent/received first */
  446. /**
  447. * @}
  448. */
  449. /** @defgroup UART_Tx_Inv UART Advanced Feature TX Pin Active Level Inversion
  450. * @{
  451. */
  452. #define UART_ADVFEATURE_TXINV_DISABLE 0x00000000U /*!< TX pin active level inversion disable */
  453. #define UART_ADVFEATURE_TXINV_ENABLE USART_CR2_TXINV /*!< TX pin active level inversion enable */
  454. /**
  455. * @}
  456. */
  457. /** @defgroup UART_Rx_Inv UART Advanced Feature RX Pin Active Level Inversion
  458. * @{
  459. */
  460. #define UART_ADVFEATURE_RXINV_DISABLE 0x00000000U /*!< RX pin active level inversion disable */
  461. #define UART_ADVFEATURE_RXINV_ENABLE USART_CR2_RXINV /*!< RX pin active level inversion enable */
  462. /**
  463. * @}
  464. */
  465. /** @defgroup UART_Data_Inv UART Advanced Feature Binary Data Inversion
  466. * @{
  467. */
  468. #define UART_ADVFEATURE_DATAINV_DISABLE 0x00000000U /*!< Binary data inversion disable */
  469. #define UART_ADVFEATURE_DATAINV_ENABLE USART_CR2_DATAINV /*!< Binary data inversion enable */
  470. /**
  471. * @}
  472. */
  473. /** @defgroup UART_Rx_Tx_Swap UART Advanced Feature RX TX Pins Swap
  474. * @{
  475. */
  476. #define UART_ADVFEATURE_SWAP_DISABLE 0x00000000U /*!< TX/RX pins swap disable */
  477. #define UART_ADVFEATURE_SWAP_ENABLE USART_CR2_SWAP /*!< TX/RX pins swap enable */
  478. /**
  479. * @}
  480. */
  481. /** @defgroup UART_Overrun_Disable UART Advanced Feature Overrun Disable
  482. * @{
  483. */
  484. #define UART_ADVFEATURE_OVERRUN_ENABLE 0x00000000U /*!< RX overrun enable */
  485. #define UART_ADVFEATURE_OVERRUN_DISABLE USART_CR3_OVRDIS /*!< RX overrun disable */
  486. /**
  487. * @}
  488. */
  489. /** @defgroup UART_AutoBaudRate_Enable UART Advanced Feature Auto BaudRate Enable
  490. * @{
  491. */
  492. #define UART_ADVFEATURE_AUTOBAUDRATE_DISABLE 0x00000000U /*!< RX Auto Baud rate detection enable */
  493. #define UART_ADVFEATURE_AUTOBAUDRATE_ENABLE USART_CR2_ABREN /*!< RX Auto Baud rate detection disable */
  494. /**
  495. * @}
  496. */
  497. /** @defgroup UART_DMA_Disable_on_Rx_Error UART Advanced Feature DMA Disable On Rx Error
  498. * @{
  499. */
  500. #define UART_ADVFEATURE_DMA_ENABLEONRXERROR 0x00000000U /*!< DMA enable on Reception Error */
  501. #define UART_ADVFEATURE_DMA_DISABLEONRXERROR USART_CR3_DDRE /*!< DMA disable on Reception Error */
  502. /**
  503. * @}
  504. */
  505. /** @defgroup UART_MSB_First UART Advanced Feature MSB First
  506. * @{
  507. */
  508. #define UART_ADVFEATURE_MSBFIRST_DISABLE 0x00000000U /*!< Most significant bit sent/received
  509. first disable */
  510. #define UART_ADVFEATURE_MSBFIRST_ENABLE USART_CR2_MSBFIRST /*!< Most significant bit sent/received
  511. first enable */
  512. /**
  513. * @}
  514. */
  515. /** @defgroup UART_Stop_Mode_Enable UART Advanced Feature Stop Mode Enable
  516. * @{
  517. */
  518. #define UART_ADVFEATURE_STOPMODE_DISABLE 0x00000000U /*!< UART stop mode disable */
  519. #define UART_ADVFEATURE_STOPMODE_ENABLE USART_CR1_UESM /*!< UART stop mode enable */
  520. /**
  521. * @}
  522. */
  523. /** @defgroup UART_Mute_Mode UART Advanced Feature Mute Mode Enable
  524. * @{
  525. */
  526. #define UART_ADVFEATURE_MUTEMODE_DISABLE 0x00000000U /*!< UART mute mode disable */
  527. #define UART_ADVFEATURE_MUTEMODE_ENABLE USART_CR1_MME /*!< UART mute mode enable */
  528. /**
  529. * @}
  530. */
  531. /** @defgroup UART_CR2_ADDRESS_LSB_POS UART Address-matching LSB Position In CR2 Register
  532. * @{
  533. */
  534. #define UART_CR2_ADDRESS_LSB_POS 24U /*!< UART address-matching LSB position in CR2 register */
  535. /**
  536. * @}
  537. */
  538. /** @defgroup UART_WakeUp_from_Stop_Selection UART WakeUp From Stop Selection
  539. * @{
  540. */
  541. #define UART_WAKEUP_ON_ADDRESS 0x00000000U /*!< UART wake-up on address */
  542. #define UART_WAKEUP_ON_STARTBIT USART_CR3_WUS_1 /*!< UART wake-up on start bit */
  543. #define UART_WAKEUP_ON_READDATA_NONEMPTY USART_CR3_WUS /*!< UART wake-up on receive data register
  544. not empty or RXFIFO is not empty */
  545. /**
  546. * @}
  547. */
  548. /** @defgroup UART_DriverEnable_Polarity UART DriverEnable Polarity
  549. * @{
  550. */
  551. #define UART_DE_POLARITY_HIGH 0x00000000U /*!< Driver enable signal is active high */
  552. #define UART_DE_POLARITY_LOW USART_CR3_DEP /*!< Driver enable signal is active low */
  553. /**
  554. * @}
  555. */
  556. /** @defgroup UART_CR1_DEAT_ADDRESS_LSB_POS UART Driver Enable Assertion Time LSB Position In CR1 Register
  557. * @{
  558. */
  559. #define UART_CR1_DEAT_ADDRESS_LSB_POS 21U /*!< UART Driver Enable assertion time LSB
  560. position in CR1 register */
  561. /**
  562. * @}
  563. */
  564. /** @defgroup UART_CR1_DEDT_ADDRESS_LSB_POS UART Driver Enable DeAssertion Time LSB Position In CR1 Register
  565. * @{
  566. */
  567. #define UART_CR1_DEDT_ADDRESS_LSB_POS 16U /*!< UART Driver Enable de-assertion time LSB
  568. position in CR1 register */
  569. /**
  570. * @}
  571. */
  572. /** @defgroup UART_Interruption_Mask UART Interruptions Flag Mask
  573. * @{
  574. */
  575. #define UART_IT_MASK 0x001FU /*!< UART interruptions flags mask */
  576. /**
  577. * @}
  578. */
  579. /** @defgroup UART_TimeOut_Value UART polling-based communications time-out value
  580. * @{
  581. */
  582. #define HAL_UART_TIMEOUT_VALUE 0x1FFFFFFU /*!< UART polling-based communications time-out value */
  583. /**
  584. * @}
  585. */
  586. /** @defgroup UART_Flags UART Status Flags
  587. * Elements values convention: 0xXXXX
  588. * - 0xXXXX : Flag mask in the ISR register
  589. * @{
  590. */
  591. #define UART_FLAG_REACK USART_ISR_REACK /*!< UART receive enable acknowledge flag */
  592. #define UART_FLAG_TEACK USART_ISR_TEACK /*!< UART transmit enable acknowledge flag */
  593. #define UART_FLAG_WUF USART_ISR_WUF /*!< UART wake-up from stop mode flag */
  594. #define UART_FLAG_RWU USART_ISR_RWU /*!< UART receiver wake-up from mute mode flag */
  595. #define UART_FLAG_SBKF USART_ISR_SBKF /*!< UART send break flag */
  596. #define UART_FLAG_CMF USART_ISR_CMF /*!< UART character match flag */
  597. #define UART_FLAG_BUSY USART_ISR_BUSY /*!< UART busy flag */
  598. #define UART_FLAG_ABRF USART_ISR_ABRF /*!< UART auto Baud rate flag */
  599. #define UART_FLAG_ABRE USART_ISR_ABRE /*!< UART auto Baud rate error */
  600. #define UART_FLAG_RTOF USART_ISR_RTOF /*!< UART receiver timeout flag */
  601. #define UART_FLAG_CTS USART_ISR_CTS /*!< UART clear to send flag */
  602. #define UART_FLAG_CTSIF USART_ISR_CTSIF /*!< UART clear to send interrupt flag */
  603. #define UART_FLAG_LBDF USART_ISR_LBDF /*!< UART LIN break detection flag */
  604. #define UART_FLAG_TXE USART_ISR_TXE /*!< UART transmit data register empty */
  605. #define UART_FLAG_TC USART_ISR_TC /*!< UART transmission complete */
  606. #define UART_FLAG_RXNE USART_ISR_RXNE /*!< UART read data register not empty */
  607. #define UART_FLAG_IDLE USART_ISR_IDLE /*!< UART idle flag */
  608. #define UART_FLAG_ORE USART_ISR_ORE /*!< UART overrun error */
  609. #define UART_FLAG_NE USART_ISR_NE /*!< UART noise error */
  610. #define UART_FLAG_FE USART_ISR_FE /*!< UART frame error */
  611. #define UART_FLAG_PE USART_ISR_PE /*!< UART parity error */
  612. /**
  613. * @}
  614. */
  615. /** @defgroup UART_Interrupt_definition UART Interrupts Definition
  616. * Elements values convention: 000ZZZZZ0XXYYYYYb
  617. * - YYYYY : Interrupt source position in the XX register (5bits)
  618. * - XX : Interrupt source register (2bits)
  619. * - 01: CR1 register
  620. * - 10: CR2 register
  621. * - 11: CR3 register
  622. * - ZZZZZ : Flag position in the ISR register(5bits)
  623. * Elements values convention: 000000000XXYYYYYb
  624. * - YYYYY : Interrupt source position in the XX register (5bits)
  625. * - XX : Interrupt source register (2bits)
  626. * - 01: CR1 register
  627. * - 10: CR2 register
  628. * - 11: CR3 register
  629. * Elements values convention: 0000ZZZZ00000000b
  630. * - ZZZZ : Flag position in the ISR register(4bits)
  631. * @{
  632. */
  633. #define UART_IT_PE 0x0028U /*!< UART parity error interruption */
  634. #define UART_IT_TXE 0x0727U /*!< UART transmit data register empty interruption */
  635. #define UART_IT_TC 0x0626U /*!< UART transmission complete interruption */
  636. #define UART_IT_RXNE 0x0525U /*!< UART read data register not empty interruption */
  637. #define UART_IT_IDLE 0x0424U /*!< UART idle interruption */
  638. #define UART_IT_LBD 0x0846U /*!< UART LIN break detection interruption */
  639. #define UART_IT_CTS 0x096AU /*!< UART CTS interruption */
  640. #define UART_IT_CM 0x112EU /*!< UART character match interruption */
  641. #define UART_IT_WUF 0x1476U /*!< UART wake-up from stop mode interruption */
  642. #define UART_IT_RTO 0x0B3AU /*!< UART receiver timeout interruption */
  643. #define UART_IT_ERR 0x0060U /*!< UART error interruption */
  644. #define UART_IT_ORE 0x0300U /*!< UART overrun error interruption */
  645. #define UART_IT_NE 0x0200U /*!< UART noise error interruption */
  646. #define UART_IT_FE 0x0100U /*!< UART frame error interruption */
  647. /**
  648. * @}
  649. */
  650. /** @defgroup UART_IT_CLEAR_Flags UART Interruption Clear Flags
  651. * @{
  652. */
  653. #define UART_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */
  654. #define UART_CLEAR_FEF USART_ICR_FECF /*!< Framing Error Clear Flag */
  655. #define UART_CLEAR_NEF USART_ICR_NCF /*!< Noise Error detected Clear Flag */
  656. #define UART_CLEAR_OREF USART_ICR_ORECF /*!< Overrun Error Clear Flag */
  657. #define UART_CLEAR_IDLEF USART_ICR_IDLECF /*!< IDLE line detected Clear Flag */
  658. #define UART_CLEAR_TCF USART_ICR_TCCF /*!< Transmission Complete Clear Flag */
  659. #define UART_CLEAR_LBDF USART_ICR_LBDCF /*!< LIN Break Detection Clear Flag */
  660. #define UART_CLEAR_CTSF USART_ICR_CTSCF /*!< CTS Interrupt Clear Flag */
  661. #define UART_CLEAR_CMF USART_ICR_CMCF /*!< Character Match Clear Flag */
  662. #define UART_CLEAR_WUF USART_ICR_WUCF /*!< Wake Up from stop mode Clear Flag */
  663. #define UART_CLEAR_RTOF USART_ICR_RTOCF /*!< UART receiver timeout clear flag */
  664. /**
  665. * @}
  666. */
  667. /** @defgroup UART_Reception_Type_Values UART Reception type values
  668. * @{
  669. */
  670. #define HAL_UART_RECEPTION_STANDARD (0x00000000U) /*!< Standard reception */
  671. #define HAL_UART_RECEPTION_TOIDLE (0x00000001U) /*!< Reception till completion or IDLE event */
  672. #define HAL_UART_RECEPTION_TORTO (0x00000002U) /*!< Reception till completion or RTO event */
  673. #define HAL_UART_RECEPTION_TOCHARMATCH (0x00000003U) /*!< Reception till completion or CM event */
  674. /**
  675. * @}
  676. */
  677. /** @defgroup UART_RxEvent_Type_Values UART RxEvent type values
  678. * @{
  679. */
  680. #define HAL_UART_RXEVENT_TC (0x00000000U) /*!< RxEvent linked to Transfer Complete event */
  681. #define HAL_UART_RXEVENT_HT (0x00000001U) /*!< RxEvent linked to Half Transfer event */
  682. #define HAL_UART_RXEVENT_IDLE (0x00000002U) /*!< RxEvent linked to IDLE event */
  683. /**
  684. * @}
  685. */
  686. /**
  687. * @}
  688. */
  689. /* Exported macros -----------------------------------------------------------*/
  690. /** @defgroup UART_Exported_Macros UART Exported Macros
  691. * @{
  692. */
  693. /** @brief Reset UART handle states.
  694. * @param __HANDLE__ UART handle.
  695. * @retval None
  696. */
  697. #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
  698. #define __HAL_UART_RESET_HANDLE_STATE(__HANDLE__) do{ \
  699. (__HANDLE__)->gState = HAL_UART_STATE_RESET; \
  700. (__HANDLE__)->RxState = HAL_UART_STATE_RESET; \
  701. (__HANDLE__)->MspInitCallback = NULL; \
  702. (__HANDLE__)->MspDeInitCallback = NULL; \
  703. } while(0U)
  704. #else
  705. #define __HAL_UART_RESET_HANDLE_STATE(__HANDLE__) do{ \
  706. (__HANDLE__)->gState = HAL_UART_STATE_RESET; \
  707. (__HANDLE__)->RxState = HAL_UART_STATE_RESET; \
  708. } while(0U)
  709. #endif /*USE_HAL_UART_REGISTER_CALLBACKS */
  710. /** @brief Flush the UART Data registers.
  711. * @param __HANDLE__ specifies the UART Handle.
  712. * @retval None
  713. */
  714. #define __HAL_UART_FLUSH_DRREGISTER(__HANDLE__) \
  715. do{ \
  716. SET_BIT((__HANDLE__)->Instance->RQR, UART_RXDATA_FLUSH_REQUEST); \
  717. SET_BIT((__HANDLE__)->Instance->RQR, UART_TXDATA_FLUSH_REQUEST); \
  718. } while(0U)
  719. /** @brief Clear the specified UART pending flag.
  720. * @param __HANDLE__ specifies the UART Handle.
  721. * @param __FLAG__ specifies the flag to check.
  722. * This parameter can be any combination of the following values:
  723. * @arg @ref UART_CLEAR_PEF Parity Error Clear Flag
  724. * @arg @ref UART_CLEAR_FEF Framing Error Clear Flag
  725. * @arg @ref UART_CLEAR_NEF Noise detected Clear Flag
  726. * @arg @ref UART_CLEAR_OREF Overrun Error Clear Flag
  727. * @arg @ref UART_CLEAR_IDLEF IDLE line detected Clear Flag
  728. * @arg @ref UART_CLEAR_TCF Transmission Complete Clear Flag
  729. * @arg @ref UART_CLEAR_RTOF Receiver Timeout clear flag
  730. * @arg @ref UART_CLEAR_LBDF LIN Break Detection Clear Flag
  731. * @arg @ref UART_CLEAR_CTSF CTS Interrupt Clear Flag
  732. * @arg @ref UART_CLEAR_CMF Character Match Clear Flag
  733. * @arg @ref UART_CLEAR_WUF Wake Up from stop mode Clear Flag
  734. * @retval None
  735. */
  736. #define __HAL_UART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
  737. /** @brief Clear the UART PE pending flag.
  738. * @param __HANDLE__ specifies the UART Handle.
  739. * @retval None
  740. */
  741. #define __HAL_UART_CLEAR_PEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_PEF)
  742. /** @brief Clear the UART FE pending flag.
  743. * @param __HANDLE__ specifies the UART Handle.
  744. * @retval None
  745. */
  746. #define __HAL_UART_CLEAR_FEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_FEF)
  747. /** @brief Clear the UART NE pending flag.
  748. * @param __HANDLE__ specifies the UART Handle.
  749. * @retval None
  750. */
  751. #define __HAL_UART_CLEAR_NEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_NEF)
  752. /** @brief Clear the UART ORE pending flag.
  753. * @param __HANDLE__ specifies the UART Handle.
  754. * @retval None
  755. */
  756. #define __HAL_UART_CLEAR_OREFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_OREF)
  757. /** @brief Clear the UART IDLE pending flag.
  758. * @param __HANDLE__ specifies the UART Handle.
  759. * @retval None
  760. */
  761. #define __HAL_UART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_IDLEF)
  762. /** @brief Check whether the specified UART flag is set or not.
  763. * @param __HANDLE__ specifies the UART Handle.
  764. * @param __FLAG__ specifies the flag to check.
  765. * This parameter can be one of the following values:
  766. * @arg @ref UART_FLAG_REACK Receive enable acknowledge flag
  767. * @arg @ref UART_FLAG_TEACK Transmit enable acknowledge flag
  768. * @arg @ref UART_FLAG_WUF Wake up from stop mode flag
  769. * @arg @ref UART_FLAG_RWU Receiver wake up flag (if the UART in mute mode)
  770. * @arg @ref UART_FLAG_SBKF Send Break flag
  771. * @arg @ref UART_FLAG_CMF Character match flag
  772. * @arg @ref UART_FLAG_BUSY Busy flag
  773. * @arg @ref UART_FLAG_ABRF Auto Baud rate detection flag
  774. * @arg @ref UART_FLAG_ABRE Auto Baud rate detection error flag
  775. * @arg @ref UART_FLAG_CTS CTS Change flag
  776. * @arg @ref UART_FLAG_LBDF LIN Break detection flag
  777. * @arg @ref UART_FLAG_TXE Transmit data register empty flag
  778. * @arg @ref UART_FLAG_TC Transmission Complete flag
  779. * @arg @ref UART_FLAG_RXNE Receive data register not empty flag
  780. * @arg @ref UART_FLAG_RTOF Receiver Timeout flag
  781. * @arg @ref UART_FLAG_IDLE Idle Line detection flag
  782. * @arg @ref UART_FLAG_ORE Overrun Error flag
  783. * @arg @ref UART_FLAG_NE Noise Error flag
  784. * @arg @ref UART_FLAG_FE Framing Error flag
  785. * @arg @ref UART_FLAG_PE Parity Error flag
  786. * @retval The new state of __FLAG__ (TRUE or FALSE).
  787. */
  788. #define __HAL_UART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
  789. /** @brief Enable the specified UART interrupt.
  790. * @param __HANDLE__ specifies the UART Handle.
  791. * @param __INTERRUPT__ specifies the UART interrupt source to enable.
  792. * This parameter can be one of the following values:
  793. * @arg @ref UART_IT_WUF Wakeup from stop mode interrupt
  794. * @arg @ref UART_IT_CM Character match interrupt
  795. * @arg @ref UART_IT_CTS CTS change interrupt
  796. * @arg @ref UART_IT_LBD LIN Break detection interrupt
  797. * @arg @ref UART_IT_TXE Transmit Data Register empty interrupt
  798. * @arg @ref UART_IT_TC Transmission complete interrupt
  799. * @arg @ref UART_IT_RXNE Receive Data register not empty interrupt
  800. * @arg @ref UART_IT_RTO Receive Timeout interrupt
  801. * @arg @ref UART_IT_IDLE Idle line detection interrupt
  802. * @arg @ref UART_IT_PE Parity Error interrupt
  803. * @arg @ref UART_IT_ERR Error interrupt (frame error, noise error, overrun error)
  804. * @retval None
  805. */
  806. #define __HAL_UART_ENABLE_IT(__HANDLE__, __INTERRUPT__) (\
  807. ((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U)?\
  808. ((__HANDLE__)->Instance->CR1 |= (1U <<\
  809. ((__INTERRUPT__) & UART_IT_MASK))): \
  810. ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U)?\
  811. ((__HANDLE__)->Instance->CR2 |= (1U <<\
  812. ((__INTERRUPT__) & UART_IT_MASK))): \
  813. ((__HANDLE__)->Instance->CR3 |= (1U <<\
  814. ((__INTERRUPT__) & UART_IT_MASK))))
  815. /** @brief Disable the specified UART interrupt.
  816. * @param __HANDLE__ specifies the UART Handle.
  817. * @param __INTERRUPT__ specifies the UART interrupt source to disable.
  818. * This parameter can be one of the following values:
  819. * @arg @ref UART_IT_WUF Wakeup from stop mode interrupt
  820. * @arg @ref UART_IT_CM Character match interrupt
  821. * @arg @ref UART_IT_CTS CTS change interrupt
  822. * @arg @ref UART_IT_LBD LIN Break detection interrupt
  823. * @arg @ref UART_IT_TXE Transmit Data Register empty interrupt
  824. * @arg @ref UART_IT_TC Transmission complete interrupt
  825. * @arg @ref UART_IT_RXNE Receive Data register not empty interrupt
  826. * @arg @ref UART_IT_RTO Receive Timeout interrupt
  827. * @arg @ref UART_IT_IDLE Idle line detection interrupt
  828. * @arg @ref UART_IT_PE Parity Error interrupt
  829. * @arg @ref UART_IT_ERR Error interrupt (Frame error, noise error, overrun error)
  830. * @retval None
  831. */
  832. #define __HAL_UART_DISABLE_IT(__HANDLE__, __INTERRUPT__) (\
  833. ((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U)?\
  834. ((__HANDLE__)->Instance->CR1 &= ~ (1U <<\
  835. ((__INTERRUPT__) & UART_IT_MASK))): \
  836. ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U)?\
  837. ((__HANDLE__)->Instance->CR2 &= ~ (1U <<\
  838. ((__INTERRUPT__) & UART_IT_MASK))): \
  839. ((__HANDLE__)->Instance->CR3 &= ~ (1U <<\
  840. ((__INTERRUPT__) & UART_IT_MASK))))
  841. /** @brief Check whether the specified UART interrupt has occurred or not.
  842. * @param __HANDLE__ specifies the UART Handle.
  843. * @param __INTERRUPT__ specifies the UART interrupt to check.
  844. * This parameter can be one of the following values:
  845. * @arg @ref UART_IT_WUF Wakeup from stop mode interrupt
  846. * @arg @ref UART_IT_CM Character match interrupt
  847. * @arg @ref UART_IT_CTS CTS change interrupt
  848. * @arg @ref UART_IT_LBD LIN Break detection interrupt
  849. * @arg @ref UART_IT_TXE Transmit Data Register empty interrupt
  850. * @arg @ref UART_IT_TC Transmission complete interrupt
  851. * @arg @ref UART_IT_RXNE Receive Data register not empty interrupt
  852. * @arg @ref UART_IT_RTO Receive Timeout interrupt
  853. * @arg @ref UART_IT_IDLE Idle line detection interrupt
  854. * @arg @ref UART_IT_PE Parity Error interrupt
  855. * @arg @ref UART_IT_ERR Error interrupt (Frame error, noise error, overrun error)
  856. * @retval The new state of __INTERRUPT__ (SET or RESET).
  857. */
  858. #define __HAL_UART_GET_IT(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->ISR\
  859. & (1U << ((__INTERRUPT__)>> 8U))) != RESET) ? SET : RESET)
  860. /** @brief Check whether the specified UART interrupt source is enabled or not.
  861. * @param __HANDLE__ specifies the UART Handle.
  862. * @param __INTERRUPT__ specifies the UART interrupt source to check.
  863. * This parameter can be one of the following values:
  864. * @arg @ref UART_IT_WUF Wakeup from stop mode interrupt
  865. * @arg @ref UART_IT_CM Character match interrupt
  866. * @arg @ref UART_IT_CTS CTS change interrupt
  867. * @arg @ref UART_IT_LBD LIN Break detection interrupt
  868. * @arg @ref UART_IT_TXE Transmit Data Register empty interrupt
  869. * @arg @ref UART_IT_TC Transmission complete interrupt
  870. * @arg @ref UART_IT_RXNE Receive Data register not empty interrupt
  871. * @arg @ref UART_IT_RTO Receive Timeout interrupt
  872. * @arg @ref UART_IT_IDLE Idle line detection interrupt
  873. * @arg @ref UART_IT_PE Parity Error interrupt
  874. * @arg @ref UART_IT_ERR Error interrupt (Frame error, noise error, overrun error)
  875. * @retval The new state of __INTERRUPT__ (SET or RESET).
  876. */
  877. #define __HAL_UART_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U) ?\
  878. (__HANDLE__)->Instance->CR1 : \
  879. (((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U) ?\
  880. (__HANDLE__)->Instance->CR2 : \
  881. (__HANDLE__)->Instance->CR3)) & (1U <<\
  882. (((uint16_t)(__INTERRUPT__)) &\
  883. UART_IT_MASK))) != RESET) ? SET : RESET)
  884. /** @brief Clear the specified UART ISR flag, in setting the proper ICR register flag.
  885. * @param __HANDLE__ specifies the UART Handle.
  886. * @param __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set
  887. * to clear the corresponding interrupt
  888. * This parameter can be one of the following values:
  889. * @arg @ref UART_CLEAR_PEF Parity Error Clear Flag
  890. * @arg @ref UART_CLEAR_FEF Framing Error Clear Flag
  891. * @arg @ref UART_CLEAR_NEF Noise detected Clear Flag
  892. * @arg @ref UART_CLEAR_OREF Overrun Error Clear Flag
  893. * @arg @ref UART_CLEAR_IDLEF IDLE line detected Clear Flag
  894. * @arg @ref UART_CLEAR_RTOF Receiver timeout clear flag
  895. * @arg @ref UART_CLEAR_TCF Transmission Complete Clear Flag
  896. * @arg @ref UART_CLEAR_LBDF LIN Break Detection Clear Flag
  897. * @arg @ref UART_CLEAR_CTSF CTS Interrupt Clear Flag
  898. * @arg @ref UART_CLEAR_CMF Character Match Clear Flag
  899. * @arg @ref UART_CLEAR_WUF Wake Up from stop mode Clear Flag
  900. * @retval None
  901. */
  902. #define __HAL_UART_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
  903. /** @brief Set a specific UART request flag.
  904. * @param __HANDLE__ specifies the UART Handle.
  905. * @param __REQ__ specifies the request flag to set
  906. * This parameter can be one of the following values:
  907. * @arg @ref UART_AUTOBAUD_REQUEST Auto-Baud Rate Request
  908. * @arg @ref UART_SENDBREAK_REQUEST Send Break Request
  909. * @arg @ref UART_MUTE_MODE_REQUEST Mute Mode Request
  910. * @arg @ref UART_RXDATA_FLUSH_REQUEST Receive Data flush Request
  911. * @arg @ref UART_TXDATA_FLUSH_REQUEST Transmit data flush Request
  912. * @retval None
  913. */
  914. #define __HAL_UART_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
  915. /** @brief Enable the UART one bit sample method.
  916. * @param __HANDLE__ specifies the UART Handle.
  917. * @retval None
  918. */
  919. #define __HAL_UART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
  920. /** @brief Disable the UART one bit sample method.
  921. * @param __HANDLE__ specifies the UART Handle.
  922. * @retval None
  923. */
  924. #define __HAL_UART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= ~USART_CR3_ONEBIT)
  925. /** @brief Enable UART.
  926. * @param __HANDLE__ specifies the UART Handle.
  927. * @retval None
  928. */
  929. #define __HAL_UART_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
  930. /** @brief Disable UART.
  931. * @param __HANDLE__ specifies the UART Handle.
  932. * @retval None
  933. */
  934. #define __HAL_UART_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
  935. /** @brief Enable CTS flow control.
  936. * @note This macro allows to enable CTS hardware flow control for a given UART instance,
  937. * without need to call HAL_UART_Init() function.
  938. * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
  939. * @note As macro is expected to be used for modifying CTS Hw flow control feature activation, without need
  940. * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
  941. * - UART instance should have already been initialised (through call of HAL_UART_Init() )
  942. * - macro could only be called when corresponding UART instance is disabled
  943. * (i.e. __HAL_UART_DISABLE(__HANDLE__)) and should be followed by an Enable
  944. * macro (i.e. __HAL_UART_ENABLE(__HANDLE__)).
  945. * @param __HANDLE__ specifies the UART Handle.
  946. * @retval None
  947. */
  948. #define __HAL_UART_HWCONTROL_CTS_ENABLE(__HANDLE__) \
  949. do{ \
  950. ATOMIC_SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE); \
  951. (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_CTSE; \
  952. } while(0U)
  953. /** @brief Disable CTS flow control.
  954. * @note This macro allows to disable CTS hardware flow control for a given UART instance,
  955. * without need to call HAL_UART_Init() function.
  956. * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
  957. * @note As macro is expected to be used for modifying CTS Hw flow control feature activation, without need
  958. * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
  959. * - UART instance should have already been initialised (through call of HAL_UART_Init() )
  960. * - macro could only be called when corresponding UART instance is disabled
  961. * (i.e. __HAL_UART_DISABLE(__HANDLE__)) and should be followed by an Enable
  962. * macro (i.e. __HAL_UART_ENABLE(__HANDLE__)).
  963. * @param __HANDLE__ specifies the UART Handle.
  964. * @retval None
  965. */
  966. #define __HAL_UART_HWCONTROL_CTS_DISABLE(__HANDLE__) \
  967. do{ \
  968. ATOMIC_CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE); \
  969. (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_CTSE); \
  970. } while(0U)
  971. /** @brief Enable RTS flow control.
  972. * @note This macro allows to enable RTS hardware flow control for a given UART instance,
  973. * without need to call HAL_UART_Init() function.
  974. * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
  975. * @note As macro is expected to be used for modifying RTS Hw flow control feature activation, without need
  976. * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
  977. * - UART instance should have already been initialised (through call of HAL_UART_Init() )
  978. * - macro could only be called when corresponding UART instance is disabled
  979. * (i.e. __HAL_UART_DISABLE(__HANDLE__)) and should be followed by an Enable
  980. * macro (i.e. __HAL_UART_ENABLE(__HANDLE__)).
  981. * @param __HANDLE__ specifies the UART Handle.
  982. * @retval None
  983. */
  984. #define __HAL_UART_HWCONTROL_RTS_ENABLE(__HANDLE__) \
  985. do{ \
  986. ATOMIC_SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE); \
  987. (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_RTSE; \
  988. } while(0U)
  989. /** @brief Disable RTS flow control.
  990. * @note This macro allows to disable RTS hardware flow control for a given UART instance,
  991. * without need to call HAL_UART_Init() function.
  992. * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
  993. * @note As macro is expected to be used for modifying RTS Hw flow control feature activation, without need
  994. * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
  995. * - UART instance should have already been initialised (through call of HAL_UART_Init() )
  996. * - macro could only be called when corresponding UART instance is disabled
  997. * (i.e. __HAL_UART_DISABLE(__HANDLE__)) and should be followed by an Enable
  998. * macro (i.e. __HAL_UART_ENABLE(__HANDLE__)).
  999. * @param __HANDLE__ specifies the UART Handle.
  1000. * @retval None
  1001. */
  1002. #define __HAL_UART_HWCONTROL_RTS_DISABLE(__HANDLE__) \
  1003. do{ \
  1004. ATOMIC_CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE);\
  1005. (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_RTSE); \
  1006. } while(0U)
  1007. /**
  1008. * @}
  1009. */
  1010. /* Private macros --------------------------------------------------------*/
  1011. /** @defgroup UART_Private_Macros UART Private Macros
  1012. * @{
  1013. */
  1014. /** @brief BRR division operation to set BRR register in 8-bit oversampling mode.
  1015. * @param __PCLK__ UART clock.
  1016. * @param __BAUD__ Baud rate set by the user.
  1017. * @retval Division result
  1018. */
  1019. #define UART_DIV_SAMPLING8(__PCLK__, __BAUD__) ((((__PCLK__)*2U) + ((__BAUD__)/2U)) / (__BAUD__))
  1020. /** @brief BRR division operation to set BRR register in 16-bit oversampling mode.
  1021. * @param __PCLK__ UART clock.
  1022. * @param __BAUD__ Baud rate set by the user.
  1023. * @retval Division result
  1024. */
  1025. #define UART_DIV_SAMPLING16(__PCLK__, __BAUD__) (((__PCLK__) + ((__BAUD__)/2U)) / (__BAUD__))
  1026. /** @brief Check UART Baud rate.
  1027. * @param __BAUDRATE__ Baudrate specified by the user.
  1028. * The maximum Baud Rate is derived from the maximum clock on F3 (i.e. 72 MHz)
  1029. * divided by the smallest oversampling used on the USART (i.e. 8)
  1030. * @retval SET (__BAUDRATE__ is valid) or RESET (__BAUDRATE__ is invalid)
  1031. */
  1032. #define IS_UART_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 9000001U)
  1033. /** @brief Check UART assertion time.
  1034. * @param __TIME__ 5-bit value assertion time.
  1035. * @retval Test result (TRUE or FALSE).
  1036. */
  1037. #define IS_UART_ASSERTIONTIME(__TIME__) ((__TIME__) <= 0x1FU)
  1038. /** @brief Check UART deassertion time.
  1039. * @param __TIME__ 5-bit value deassertion time.
  1040. * @retval Test result (TRUE or FALSE).
  1041. */
  1042. #define IS_UART_DEASSERTIONTIME(__TIME__) ((__TIME__) <= 0x1FU)
  1043. /**
  1044. * @brief Ensure that UART frame number of stop bits is valid.
  1045. * @param __STOPBITS__ UART frame number of stop bits.
  1046. * @retval SET (__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid)
  1047. */
  1048. #define IS_UART_STOPBITS(__STOPBITS__) (((__STOPBITS__) == UART_STOPBITS_0_5) || \
  1049. ((__STOPBITS__) == UART_STOPBITS_1) || \
  1050. ((__STOPBITS__) == UART_STOPBITS_1_5) || \
  1051. ((__STOPBITS__) == UART_STOPBITS_2))
  1052. /**
  1053. * @brief Ensure that UART frame parity is valid.
  1054. * @param __PARITY__ UART frame parity.
  1055. * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid)
  1056. */
  1057. #define IS_UART_PARITY(__PARITY__) (((__PARITY__) == UART_PARITY_NONE) || \
  1058. ((__PARITY__) == UART_PARITY_EVEN) || \
  1059. ((__PARITY__) == UART_PARITY_ODD))
  1060. /**
  1061. * @brief Ensure that UART hardware flow control is valid.
  1062. * @param __CONTROL__ UART hardware flow control.
  1063. * @retval SET (__CONTROL__ is valid) or RESET (__CONTROL__ is invalid)
  1064. */
  1065. #define IS_UART_HARDWARE_FLOW_CONTROL(__CONTROL__)\
  1066. (((__CONTROL__) == UART_HWCONTROL_NONE) || \
  1067. ((__CONTROL__) == UART_HWCONTROL_RTS) || \
  1068. ((__CONTROL__) == UART_HWCONTROL_CTS) || \
  1069. ((__CONTROL__) == UART_HWCONTROL_RTS_CTS))
  1070. /**
  1071. * @brief Ensure that UART communication mode is valid.
  1072. * @param __MODE__ UART communication mode.
  1073. * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
  1074. */
  1075. #define IS_UART_MODE(__MODE__) ((((__MODE__) & (~((uint32_t)(UART_MODE_TX_RX)))) == 0x00U) && ((__MODE__) != 0x00U))
  1076. /**
  1077. * @brief Ensure that UART state is valid.
  1078. * @param __STATE__ UART state.
  1079. * @retval SET (__STATE__ is valid) or RESET (__STATE__ is invalid)
  1080. */
  1081. #define IS_UART_STATE(__STATE__) (((__STATE__) == UART_STATE_DISABLE) || \
  1082. ((__STATE__) == UART_STATE_ENABLE))
  1083. /**
  1084. * @brief Ensure that UART oversampling is valid.
  1085. * @param __SAMPLING__ UART oversampling.
  1086. * @retval SET (__SAMPLING__ is valid) or RESET (__SAMPLING__ is invalid)
  1087. */
  1088. #define IS_UART_OVERSAMPLING(__SAMPLING__) (((__SAMPLING__) == UART_OVERSAMPLING_16) || \
  1089. ((__SAMPLING__) == UART_OVERSAMPLING_8))
  1090. /**
  1091. * @brief Ensure that UART frame sampling is valid.
  1092. * @param __ONEBIT__ UART frame sampling.
  1093. * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid)
  1094. */
  1095. #define IS_UART_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == UART_ONE_BIT_SAMPLE_DISABLE) || \
  1096. ((__ONEBIT__) == UART_ONE_BIT_SAMPLE_ENABLE))
  1097. /**
  1098. * @brief Ensure that UART auto Baud rate detection mode is valid.
  1099. * @param __MODE__ UART auto Baud rate detection mode.
  1100. * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
  1101. */
  1102. #define IS_UART_ADVFEATURE_AUTOBAUDRATEMODE(__MODE__) (((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ONSTARTBIT) || \
  1103. ((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ONFALLINGEDGE) || \
  1104. ((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ON0X7FFRAME) || \
  1105. ((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ON0X55FRAME))
  1106. /**
  1107. * @brief Ensure that UART receiver timeout setting is valid.
  1108. * @param __TIMEOUT__ UART receiver timeout setting.
  1109. * @retval SET (__TIMEOUT__ is valid) or RESET (__TIMEOUT__ is invalid)
  1110. */
  1111. #define IS_UART_RECEIVER_TIMEOUT(__TIMEOUT__) (((__TIMEOUT__) == UART_RECEIVER_TIMEOUT_DISABLE) || \
  1112. ((__TIMEOUT__) == UART_RECEIVER_TIMEOUT_ENABLE))
  1113. /** @brief Check the receiver timeout value.
  1114. * @note The maximum UART receiver timeout value is 0xFFFFFF.
  1115. * @param __TIMEOUTVALUE__ receiver timeout value.
  1116. * @retval Test result (TRUE or FALSE)
  1117. */
  1118. #define IS_UART_RECEIVER_TIMEOUT_VALUE(__TIMEOUTVALUE__) ((__TIMEOUTVALUE__) <= 0xFFFFFFU)
  1119. /**
  1120. * @brief Ensure that UART LIN state is valid.
  1121. * @param __LIN__ UART LIN state.
  1122. * @retval SET (__LIN__ is valid) or RESET (__LIN__ is invalid)
  1123. */
  1124. #define IS_UART_LIN(__LIN__) (((__LIN__) == UART_LIN_DISABLE) || \
  1125. ((__LIN__) == UART_LIN_ENABLE))
  1126. /**
  1127. * @brief Ensure that UART LIN break detection length is valid.
  1128. * @param __LENGTH__ UART LIN break detection length.
  1129. * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid)
  1130. */
  1131. #define IS_UART_LIN_BREAK_DETECT_LENGTH(__LENGTH__) (((__LENGTH__) == UART_LINBREAKDETECTLENGTH_10B) || \
  1132. ((__LENGTH__) == UART_LINBREAKDETECTLENGTH_11B))
  1133. /**
  1134. * @brief Ensure that UART DMA TX state is valid.
  1135. * @param __DMATX__ UART DMA TX state.
  1136. * @retval SET (__DMATX__ is valid) or RESET (__DMATX__ is invalid)
  1137. */
  1138. #define IS_UART_DMA_TX(__DMATX__) (((__DMATX__) == UART_DMA_TX_DISABLE) || \
  1139. ((__DMATX__) == UART_DMA_TX_ENABLE))
  1140. /**
  1141. * @brief Ensure that UART DMA RX state is valid.
  1142. * @param __DMARX__ UART DMA RX state.
  1143. * @retval SET (__DMARX__ is valid) or RESET (__DMARX__ is invalid)
  1144. */
  1145. #define IS_UART_DMA_RX(__DMARX__) (((__DMARX__) == UART_DMA_RX_DISABLE) || \
  1146. ((__DMARX__) == UART_DMA_RX_ENABLE))
  1147. /**
  1148. * @brief Ensure that UART half-duplex state is valid.
  1149. * @param __HDSEL__ UART half-duplex state.
  1150. * @retval SET (__HDSEL__ is valid) or RESET (__HDSEL__ is invalid)
  1151. */
  1152. #define IS_UART_HALF_DUPLEX(__HDSEL__) (((__HDSEL__) == UART_HALF_DUPLEX_DISABLE) || \
  1153. ((__HDSEL__) == UART_HALF_DUPLEX_ENABLE))
  1154. /**
  1155. * @brief Ensure that UART wake-up method is valid.
  1156. * @param __WAKEUP__ UART wake-up method .
  1157. * @retval SET (__WAKEUP__ is valid) or RESET (__WAKEUP__ is invalid)
  1158. */
  1159. #define IS_UART_WAKEUPMETHOD(__WAKEUP__) (((__WAKEUP__) == UART_WAKEUPMETHOD_IDLELINE) || \
  1160. ((__WAKEUP__) == UART_WAKEUPMETHOD_ADDRESSMARK))
  1161. /**
  1162. * @brief Ensure that UART request parameter is valid.
  1163. * @param __PARAM__ UART request parameter.
  1164. * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid)
  1165. */
  1166. #define IS_UART_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == UART_AUTOBAUD_REQUEST) || \
  1167. ((__PARAM__) == UART_SENDBREAK_REQUEST) || \
  1168. ((__PARAM__) == UART_MUTE_MODE_REQUEST) || \
  1169. ((__PARAM__) == UART_RXDATA_FLUSH_REQUEST) || \
  1170. ((__PARAM__) == UART_TXDATA_FLUSH_REQUEST))
  1171. /**
  1172. * @brief Ensure that UART advanced features initialization is valid.
  1173. * @param __INIT__ UART advanced features initialization.
  1174. * @retval SET (__INIT__ is valid) or RESET (__INIT__ is invalid)
  1175. */
  1176. #define IS_UART_ADVFEATURE_INIT(__INIT__) ((__INIT__) <= (UART_ADVFEATURE_NO_INIT | \
  1177. UART_ADVFEATURE_TXINVERT_INIT | \
  1178. UART_ADVFEATURE_RXINVERT_INIT | \
  1179. UART_ADVFEATURE_DATAINVERT_INIT | \
  1180. UART_ADVFEATURE_SWAP_INIT | \
  1181. UART_ADVFEATURE_RXOVERRUNDISABLE_INIT | \
  1182. UART_ADVFEATURE_DMADISABLEONERROR_INIT | \
  1183. UART_ADVFEATURE_AUTOBAUDRATE_INIT | \
  1184. UART_ADVFEATURE_MSBFIRST_INIT))
  1185. /**
  1186. * @brief Ensure that UART frame TX inversion setting is valid.
  1187. * @param __TXINV__ UART frame TX inversion setting.
  1188. * @retval SET (__TXINV__ is valid) or RESET (__TXINV__ is invalid)
  1189. */
  1190. #define IS_UART_ADVFEATURE_TXINV(__TXINV__) (((__TXINV__) == UART_ADVFEATURE_TXINV_DISABLE) || \
  1191. ((__TXINV__) == UART_ADVFEATURE_TXINV_ENABLE))
  1192. /**
  1193. * @brief Ensure that UART frame RX inversion setting is valid.
  1194. * @param __RXINV__ UART frame RX inversion setting.
  1195. * @retval SET (__RXINV__ is valid) or RESET (__RXINV__ is invalid)
  1196. */
  1197. #define IS_UART_ADVFEATURE_RXINV(__RXINV__) (((__RXINV__) == UART_ADVFEATURE_RXINV_DISABLE) || \
  1198. ((__RXINV__) == UART_ADVFEATURE_RXINV_ENABLE))
  1199. /**
  1200. * @brief Ensure that UART frame data inversion setting is valid.
  1201. * @param __DATAINV__ UART frame data inversion setting.
  1202. * @retval SET (__DATAINV__ is valid) or RESET (__DATAINV__ is invalid)
  1203. */
  1204. #define IS_UART_ADVFEATURE_DATAINV(__DATAINV__) (((__DATAINV__) == UART_ADVFEATURE_DATAINV_DISABLE) || \
  1205. ((__DATAINV__) == UART_ADVFEATURE_DATAINV_ENABLE))
  1206. /**
  1207. * @brief Ensure that UART frame RX/TX pins swap setting is valid.
  1208. * @param __SWAP__ UART frame RX/TX pins swap setting.
  1209. * @retval SET (__SWAP__ is valid) or RESET (__SWAP__ is invalid)
  1210. */
  1211. #define IS_UART_ADVFEATURE_SWAP(__SWAP__) (((__SWAP__) == UART_ADVFEATURE_SWAP_DISABLE) || \
  1212. ((__SWAP__) == UART_ADVFEATURE_SWAP_ENABLE))
  1213. /**
  1214. * @brief Ensure that UART frame overrun setting is valid.
  1215. * @param __OVERRUN__ UART frame overrun setting.
  1216. * @retval SET (__OVERRUN__ is valid) or RESET (__OVERRUN__ is invalid)
  1217. */
  1218. #define IS_UART_OVERRUN(__OVERRUN__) (((__OVERRUN__) == UART_ADVFEATURE_OVERRUN_ENABLE) || \
  1219. ((__OVERRUN__) == UART_ADVFEATURE_OVERRUN_DISABLE))
  1220. /**
  1221. * @brief Ensure that UART auto Baud rate state is valid.
  1222. * @param __AUTOBAUDRATE__ UART auto Baud rate state.
  1223. * @retval SET (__AUTOBAUDRATE__ is valid) or RESET (__AUTOBAUDRATE__ is invalid)
  1224. */
  1225. #define IS_UART_ADVFEATURE_AUTOBAUDRATE(__AUTOBAUDRATE__) (((__AUTOBAUDRATE__) == \
  1226. UART_ADVFEATURE_AUTOBAUDRATE_DISABLE) || \
  1227. ((__AUTOBAUDRATE__) == UART_ADVFEATURE_AUTOBAUDRATE_ENABLE))
  1228. /**
  1229. * @brief Ensure that UART DMA enabling or disabling on error setting is valid.
  1230. * @param __DMA__ UART DMA enabling or disabling on error setting.
  1231. * @retval SET (__DMA__ is valid) or RESET (__DMA__ is invalid)
  1232. */
  1233. #define IS_UART_ADVFEATURE_DMAONRXERROR(__DMA__) (((__DMA__) == UART_ADVFEATURE_DMA_ENABLEONRXERROR) || \
  1234. ((__DMA__) == UART_ADVFEATURE_DMA_DISABLEONRXERROR))
  1235. /**
  1236. * @brief Ensure that UART frame MSB first setting is valid.
  1237. * @param __MSBFIRST__ UART frame MSB first setting.
  1238. * @retval SET (__MSBFIRST__ is valid) or RESET (__MSBFIRST__ is invalid)
  1239. */
  1240. #define IS_UART_ADVFEATURE_MSBFIRST(__MSBFIRST__) (((__MSBFIRST__) == UART_ADVFEATURE_MSBFIRST_DISABLE) || \
  1241. ((__MSBFIRST__) == UART_ADVFEATURE_MSBFIRST_ENABLE))
  1242. /**
  1243. * @brief Ensure that UART stop mode state is valid.
  1244. * @param __STOPMODE__ UART stop mode state.
  1245. * @retval SET (__STOPMODE__ is valid) or RESET (__STOPMODE__ is invalid)
  1246. */
  1247. #define IS_UART_ADVFEATURE_STOPMODE(__STOPMODE__) (((__STOPMODE__) == UART_ADVFEATURE_STOPMODE_DISABLE) || \
  1248. ((__STOPMODE__) == UART_ADVFEATURE_STOPMODE_ENABLE))
  1249. /**
  1250. * @brief Ensure that UART mute mode state is valid.
  1251. * @param __MUTE__ UART mute mode state.
  1252. * @retval SET (__MUTE__ is valid) or RESET (__MUTE__ is invalid)
  1253. */
  1254. #define IS_UART_MUTE_MODE(__MUTE__) (((__MUTE__) == UART_ADVFEATURE_MUTEMODE_DISABLE) || \
  1255. ((__MUTE__) == UART_ADVFEATURE_MUTEMODE_ENABLE))
  1256. /**
  1257. * @brief Ensure that UART wake-up selection is valid.
  1258. * @param __WAKE__ UART wake-up selection.
  1259. * @retval SET (__WAKE__ is valid) or RESET (__WAKE__ is invalid)
  1260. */
  1261. #define IS_UART_WAKEUP_SELECTION(__WAKE__) (((__WAKE__) == UART_WAKEUP_ON_ADDRESS) || \
  1262. ((__WAKE__) == UART_WAKEUP_ON_STARTBIT) || \
  1263. ((__WAKE__) == UART_WAKEUP_ON_READDATA_NONEMPTY))
  1264. /**
  1265. * @brief Ensure that UART driver enable polarity is valid.
  1266. * @param __POLARITY__ UART driver enable polarity.
  1267. * @retval SET (__POLARITY__ is valid) or RESET (__POLARITY__ is invalid)
  1268. */
  1269. #define IS_UART_DE_POLARITY(__POLARITY__) (((__POLARITY__) == UART_DE_POLARITY_HIGH) || \
  1270. ((__POLARITY__) == UART_DE_POLARITY_LOW))
  1271. /**
  1272. * @}
  1273. */
  1274. /* Include UART HAL Extended module */
  1275. #include "stm32f3xx_hal_uart_ex.h"
  1276. /* Exported functions --------------------------------------------------------*/
  1277. /** @addtogroup UART_Exported_Functions UART Exported Functions
  1278. * @{
  1279. */
  1280. /** @addtogroup UART_Exported_Functions_Group1 Initialization and de-initialization functions
  1281. * @{
  1282. */
  1283. /* Initialization and de-initialization functions ****************************/
  1284. HAL_StatusTypeDef HAL_UART_Init(UART_HandleTypeDef *huart);
  1285. HAL_StatusTypeDef HAL_HalfDuplex_Init(UART_HandleTypeDef *huart);
  1286. HAL_StatusTypeDef HAL_LIN_Init(UART_HandleTypeDef *huart, uint32_t BreakDetectLength);
  1287. HAL_StatusTypeDef HAL_MultiProcessor_Init(UART_HandleTypeDef *huart, uint8_t Address, uint32_t WakeUpMethod);
  1288. HAL_StatusTypeDef HAL_UART_DeInit(UART_HandleTypeDef *huart);
  1289. void HAL_UART_MspInit(UART_HandleTypeDef *huart);
  1290. void HAL_UART_MspDeInit(UART_HandleTypeDef *huart);
  1291. /* Callbacks Register/UnRegister functions ***********************************/
  1292. #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
  1293. HAL_StatusTypeDef HAL_UART_RegisterCallback(UART_HandleTypeDef *huart, HAL_UART_CallbackIDTypeDef CallbackID,
  1294. pUART_CallbackTypeDef pCallback);
  1295. HAL_StatusTypeDef HAL_UART_UnRegisterCallback(UART_HandleTypeDef *huart, HAL_UART_CallbackIDTypeDef CallbackID);
  1296. HAL_StatusTypeDef HAL_UART_RegisterRxEventCallback(UART_HandleTypeDef *huart, pUART_RxEventCallbackTypeDef pCallback);
  1297. HAL_StatusTypeDef HAL_UART_UnRegisterRxEventCallback(UART_HandleTypeDef *huart);
  1298. #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
  1299. /**
  1300. * @}
  1301. */
  1302. /** @addtogroup UART_Exported_Functions_Group2 IO operation functions
  1303. * @{
  1304. */
  1305. /* IO operation functions *****************************************************/
  1306. HAL_StatusTypeDef HAL_UART_Transmit(UART_HandleTypeDef *huart, const uint8_t *pData, uint16_t Size, uint32_t Timeout);
  1307. HAL_StatusTypeDef HAL_UART_Receive(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  1308. HAL_StatusTypeDef HAL_UART_Transmit_IT(UART_HandleTypeDef *huart, const uint8_t *pData, uint16_t Size);
  1309. HAL_StatusTypeDef HAL_UART_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
  1310. HAL_StatusTypeDef HAL_UART_Transmit_DMA(UART_HandleTypeDef *huart, const uint8_t *pData, uint16_t Size);
  1311. HAL_StatusTypeDef HAL_UART_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
  1312. HAL_StatusTypeDef HAL_UART_DMAPause(UART_HandleTypeDef *huart);
  1313. HAL_StatusTypeDef HAL_UART_DMAResume(UART_HandleTypeDef *huart);
  1314. HAL_StatusTypeDef HAL_UART_DMAStop(UART_HandleTypeDef *huart);
  1315. /* Transfer Abort functions */
  1316. HAL_StatusTypeDef HAL_UART_Abort(UART_HandleTypeDef *huart);
  1317. HAL_StatusTypeDef HAL_UART_AbortTransmit(UART_HandleTypeDef *huart);
  1318. HAL_StatusTypeDef HAL_UART_AbortReceive(UART_HandleTypeDef *huart);
  1319. HAL_StatusTypeDef HAL_UART_Abort_IT(UART_HandleTypeDef *huart);
  1320. HAL_StatusTypeDef HAL_UART_AbortTransmit_IT(UART_HandleTypeDef *huart);
  1321. HAL_StatusTypeDef HAL_UART_AbortReceive_IT(UART_HandleTypeDef *huart);
  1322. void HAL_UART_IRQHandler(UART_HandleTypeDef *huart);
  1323. void HAL_UART_TxHalfCpltCallback(UART_HandleTypeDef *huart);
  1324. void HAL_UART_TxCpltCallback(UART_HandleTypeDef *huart);
  1325. void HAL_UART_RxHalfCpltCallback(UART_HandleTypeDef *huart);
  1326. void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart);
  1327. void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart);
  1328. void HAL_UART_AbortCpltCallback(UART_HandleTypeDef *huart);
  1329. void HAL_UART_AbortTransmitCpltCallback(UART_HandleTypeDef *huart);
  1330. void HAL_UART_AbortReceiveCpltCallback(UART_HandleTypeDef *huart);
  1331. void HAL_UARTEx_RxEventCallback(UART_HandleTypeDef *huart, uint16_t Size);
  1332. /**
  1333. * @}
  1334. */
  1335. /** @addtogroup UART_Exported_Functions_Group3 Peripheral Control functions
  1336. * @{
  1337. */
  1338. /* Peripheral Control functions ************************************************/
  1339. void HAL_UART_ReceiverTimeout_Config(UART_HandleTypeDef *huart, uint32_t TimeoutValue);
  1340. HAL_StatusTypeDef HAL_UART_EnableReceiverTimeout(UART_HandleTypeDef *huart);
  1341. HAL_StatusTypeDef HAL_UART_DisableReceiverTimeout(UART_HandleTypeDef *huart);
  1342. HAL_StatusTypeDef HAL_LIN_SendBreak(UART_HandleTypeDef *huart);
  1343. HAL_StatusTypeDef HAL_MultiProcessor_EnableMuteMode(UART_HandleTypeDef *huart);
  1344. HAL_StatusTypeDef HAL_MultiProcessor_DisableMuteMode(UART_HandleTypeDef *huart);
  1345. void HAL_MultiProcessor_EnterMuteMode(UART_HandleTypeDef *huart);
  1346. HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter(UART_HandleTypeDef *huart);
  1347. HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver(UART_HandleTypeDef *huart);
  1348. /**
  1349. * @}
  1350. */
  1351. /** @addtogroup UART_Exported_Functions_Group4 Peripheral State and Error functions
  1352. * @{
  1353. */
  1354. /* Peripheral State and Errors functions **************************************************/
  1355. HAL_UART_StateTypeDef HAL_UART_GetState(const UART_HandleTypeDef *huart);
  1356. uint32_t HAL_UART_GetError(const UART_HandleTypeDef *huart);
  1357. /**
  1358. * @}
  1359. */
  1360. /**
  1361. * @}
  1362. */
  1363. /* Private functions -----------------------------------------------------------*/
  1364. /** @addtogroup UART_Private_Functions UART Private Functions
  1365. * @{
  1366. */
  1367. #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
  1368. void UART_InitCallbacksToDefault(UART_HandleTypeDef *huart);
  1369. #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
  1370. HAL_StatusTypeDef UART_SetConfig(UART_HandleTypeDef *huart);
  1371. HAL_StatusTypeDef UART_CheckIdleState(UART_HandleTypeDef *huart);
  1372. HAL_StatusTypeDef UART_WaitOnFlagUntilTimeout(UART_HandleTypeDef *huart, uint32_t Flag, FlagStatus Status,
  1373. uint32_t Tickstart, uint32_t Timeout);
  1374. void UART_AdvFeatureConfig(UART_HandleTypeDef *huart);
  1375. HAL_StatusTypeDef UART_Start_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
  1376. HAL_StatusTypeDef UART_Start_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
  1377. /**
  1378. * @}
  1379. */
  1380. /* Private variables -----------------------------------------------------------*/
  1381. /**
  1382. * @}
  1383. */
  1384. /**
  1385. * @}
  1386. */
  1387. #ifdef __cplusplus
  1388. }
  1389. #endif
  1390. #endif /* STM32F3xx_HAL_UART_H */