stm32l4xx_hal_uart.h 90 KB

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