stm32l4xx_hal_uart.h 91 KB

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