stm32l1xx_hal_usart.h 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579
  1. /**
  2. ******************************************************************************
  3. * @file stm32l1xx_hal_usart.h
  4. * @author MCD Application Team
  5. * @version V1.0.0
  6. * @date 5-September-2014
  7. * @brief This file contains all the functions prototypes for the USART
  8. * firmware library.
  9. ******************************************************************************
  10. * @attention
  11. *
  12. * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
  13. *
  14. * Redistribution and use in source and binary forms, with or without modification,
  15. * are permitted provided that the following conditions are met:
  16. * 1. Redistributions of source code must retain the above copyright notice,
  17. * this list of conditions and the following disclaimer.
  18. * 2. Redistributions in binary form must reproduce the above copyright notice,
  19. * this list of conditions and the following disclaimer in the documentation
  20. * and/or other materials provided with the distribution.
  21. * 3. Neither the name of STMicroelectronics nor the names of its contributors
  22. * may be used to endorse or promote products derived from this software
  23. * without specific prior written permission.
  24. *
  25. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  26. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  28. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  29. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  31. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  33. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  34. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35. *
  36. ******************************************************************************
  37. */
  38. /* Define to prevent recursive inclusion -------------------------------------*/
  39. #ifndef __STM32L1xx_HAL_USART_H
  40. #define __STM32L1xx_HAL_USART_H
  41. #ifdef __cplusplus
  42. extern "C" {
  43. #endif
  44. /* Includes ------------------------------------------------------------------*/
  45. #include "stm32l1xx_hal_def.h"
  46. /** @addtogroup STM32L1xx_HAL_Driver
  47. * @{
  48. */
  49. /** @addtogroup USART
  50. * @{
  51. */
  52. /* Exported types ------------------------------------------------------------*/
  53. /** @defgroup USART_Exported_Types USART Exported Types
  54. * @{
  55. */
  56. /**
  57. * @brief USART Init Structure definition
  58. */
  59. typedef struct
  60. {
  61. uint32_t BaudRate; /*!< This member configures the Usart communication baud rate.
  62. The baud rate is computed using the following formula:
  63. - IntegerDivider = ((PCLKx) / (8 * (husart->Init.BaudRate)))
  64. - FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 8) + 0.5 */
  65. uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
  66. This parameter can be a value of @ref USART_Word_Length */
  67. uint32_t StopBits; /*!< Specifies the number of stop bits transmitted.
  68. This parameter can be a value of @ref USART_Stop_Bits */
  69. uint32_t Parity; /*!< Specifies the parity mode.
  70. This parameter can be a value of @ref USART_Parity
  71. @note When parity is enabled, the computed parity is inserted
  72. at the MSB position of the transmitted data (9th bit when
  73. the word length is set to 9 data bits; 8th bit when the
  74. word length is set to 8 data bits). */
  75. uint32_t Mode; /*!< Specifies wether the Receive or Transmit mode is enabled or disabled.
  76. This parameter can be a value of @ref USART_Mode */
  77. uint32_t CLKPolarity; /*!< Specifies the steady state of the serial clock.
  78. This parameter can be a value of @ref USART_Clock_Polarity */
  79. uint32_t CLKPhase; /*!< Specifies the clock transition on which the bit capture is made.
  80. This parameter can be a value of @ref USART_Clock_Phase */
  81. uint32_t CLKLastBit; /*!< Specifies whether the clock pulse corresponding to the last transmitted
  82. data bit (MSB) has to be output on the SCLK pin in synchronous mode.
  83. This parameter can be a value of @ref USART_Last_Bit */
  84. }USART_InitTypeDef;
  85. /**
  86. * @brief HAL State structures definition
  87. */
  88. typedef enum
  89. {
  90. HAL_USART_STATE_RESET = 0x00, /*!< Peripheral is not initialized */
  91. HAL_USART_STATE_READY = 0x01, /*!< Peripheral Initialized and ready for use */
  92. HAL_USART_STATE_BUSY = 0x02, /*!< an internal process is ongoing */
  93. HAL_USART_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */
  94. HAL_USART_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */
  95. HAL_USART_STATE_BUSY_TX_RX = 0x32, /*!< Data Transmission Reception process is ongoing */
  96. HAL_USART_STATE_TIMEOUT = 0x03, /*!< Timeout state */
  97. HAL_USART_STATE_ERROR = 0x04 /*!< Error */
  98. }HAL_USART_StateTypeDef;
  99. /**
  100. * @brief HAL USART Error Code structure definition
  101. */
  102. typedef enum
  103. {
  104. HAL_USART_ERROR_NONE = 0x00, /*!< No error */
  105. HAL_USART_ERROR_PE = 0x01, /*!< Parity error */
  106. HAL_USART_ERROR_NE = 0x02, /*!< Noise error */
  107. HAL_USART_ERROR_FE = 0x04, /*!< frame error */
  108. HAL_USART_ERROR_ORE = 0x08, /*!< Overrun error */
  109. HAL_USART_ERROR_DMA = 0x10 /*!< DMA transfer error */
  110. }HAL_USART_ErrorTypeDef;
  111. /**
  112. * @brief USART handle Structure definition
  113. */
  114. typedef struct
  115. {
  116. USART_TypeDef *Instance; /* USART registers base address */
  117. USART_InitTypeDef Init; /* Usart communication parameters */
  118. uint8_t *pTxBuffPtr; /* Pointer to Usart Tx transfer Buffer */
  119. uint16_t TxXferSize; /* Usart Tx Transfer size */
  120. __IO uint16_t TxXferCount; /* Usart Tx Transfer Counter */
  121. uint8_t *pRxBuffPtr; /* Pointer to Usart Rx transfer Buffer */
  122. uint16_t RxXferSize; /* Usart Rx Transfer size */
  123. __IO uint16_t RxXferCount; /* Usart Rx Transfer Counter */
  124. DMA_HandleTypeDef *hdmatx; /* Usart Tx DMA Handle parameters */
  125. DMA_HandleTypeDef *hdmarx; /* Usart Rx DMA Handle parameters */
  126. HAL_LockTypeDef Lock; /* Locking object */
  127. __IO HAL_USART_StateTypeDef State; /* Usart communication state */
  128. __IO HAL_USART_ErrorTypeDef ErrorCode; /* USART Error code */
  129. }USART_HandleTypeDef;
  130. /**
  131. * @}
  132. */
  133. /* Exported constants --------------------------------------------------------*/
  134. /** @defgroup USART_Exported_Constants USART Exported constants
  135. * @{
  136. */
  137. /** @defgroup USART_Word_Length USART Word Length
  138. * @{
  139. */
  140. #define USART_WORDLENGTH_8B ((uint32_t)0x00000000)
  141. #define USART_WORDLENGTH_9B ((uint32_t)USART_CR1_M)
  142. #define IS_USART_WORD_LENGTH(LENGTH) (((LENGTH) == USART_WORDLENGTH_8B) || \
  143. ((LENGTH) == USART_WORDLENGTH_9B))
  144. /**
  145. * @}
  146. */
  147. /** @defgroup USART_Stop_Bits USART Number of Stop Bits
  148. * @{
  149. */
  150. #define USART_STOPBITS_1 ((uint32_t)0x00000000)
  151. #define USART_STOPBITS_0_5 ((uint32_t)USART_CR2_STOP_0)
  152. #define USART_STOPBITS_2 ((uint32_t)USART_CR2_STOP_1)
  153. #define USART_STOPBITS_1_5 ((uint32_t)(USART_CR2_STOP_0 | USART_CR2_STOP_1))
  154. #define IS_USART_STOPBITS(STOPBITS) (((STOPBITS) == USART_STOPBITS_1) || \
  155. ((STOPBITS) == USART_STOPBITS_0_5) || \
  156. ((STOPBITS) == USART_STOPBITS_1_5) || \
  157. ((STOPBITS) == USART_STOPBITS_2))
  158. /**
  159. * @}
  160. */
  161. /** @defgroup USART_Parity USART Parity
  162. * @{
  163. */
  164. #define USART_PARITY_NONE ((uint32_t)0x00000000)
  165. #define USART_PARITY_EVEN ((uint32_t)USART_CR1_PCE)
  166. #define USART_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
  167. #define IS_USART_PARITY(PARITY) (((PARITY) == USART_PARITY_NONE) || \
  168. ((PARITY) == USART_PARITY_EVEN) || \
  169. ((PARITY) == USART_PARITY_ODD))
  170. /**
  171. * @}
  172. */
  173. /** @defgroup USART_Mode USART Mode
  174. * @{
  175. */
  176. #define USART_MODE_RX ((uint32_t)USART_CR1_RE)
  177. #define USART_MODE_TX ((uint32_t)USART_CR1_TE)
  178. #define USART_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE))
  179. #define IS_USART_MODE(MODE) ((((MODE) & (uint32_t)0x0000FFF3) == 0x00) && ((MODE) != (uint32_t)0x00000000))
  180. /**
  181. * @}
  182. */
  183. /** @defgroup USART_Clock USART Clock
  184. * @{
  185. */
  186. #define USART_CLOCK_DISABLED ((uint32_t)0x00000000)
  187. #define USART_CLOCK_ENABLED ((uint32_t)USART_CR2_CLKEN)
  188. #define IS_USART_CLOCK(CLOCK) (((CLOCK) == USART_CLOCK_DISABLED) || \
  189. ((CLOCK) == USART_CLOCK_ENABLED))
  190. /**
  191. * @}
  192. */
  193. /** @defgroup USART_Clock_Polarity USART Clock Polarity
  194. * @{
  195. */
  196. #define USART_POLARITY_LOW ((uint32_t)0x00000000)
  197. #define USART_POLARITY_HIGH ((uint32_t)USART_CR2_CPOL)
  198. #define IS_USART_POLARITY(CPOL) (((CPOL) == USART_POLARITY_LOW) || ((CPOL) == USART_POLARITY_HIGH))
  199. /**
  200. * @}
  201. */
  202. /** @defgroup USART_Clock_Phase USART Clock Phase
  203. * @{
  204. */
  205. #define USART_PHASE_1EDGE ((uint32_t)0x00000000)
  206. #define USART_PHASE_2EDGE ((uint32_t)USART_CR2_CPHA)
  207. #define IS_USART_PHASE(CPHA) (((CPHA) == USART_PHASE_1EDGE) || ((CPHA) == USART_PHASE_2EDGE))
  208. /**
  209. * @}
  210. */
  211. /** @defgroup USART_Last_Bit USART Last Bit
  212. * @{
  213. */
  214. #define USART_LASTBIT_DISABLE ((uint32_t)0x00000000)
  215. #define USART_LASTBIT_ENABLE ((uint32_t)USART_CR2_LBCL)
  216. #define IS_USART_LASTBIT(LASTBIT) (((LASTBIT) == USART_LASTBIT_DISABLE) || \
  217. ((LASTBIT) == USART_LASTBIT_ENABLE))
  218. /**
  219. * @}
  220. */
  221. /** @defgroup USART_NACK_State USART NACK State
  222. * @{
  223. */
  224. #define USARTNACK_ENABLED ((uint32_t)USART_CR3_NACK)
  225. #define USARTNACK_DISABLED ((uint32_t)0x00000000)
  226. #define IS_USART_NACK_STATE(NACK) (((NACK) == USARTNACK_ENABLED) || \
  227. ((NACK) == USARTNACK_DISABLED))
  228. /**
  229. * @}
  230. */
  231. /** @defgroup USART_Flags USART Flags
  232. * Elements values convention: 0xXXXX
  233. * - 0xXXXX : Flag mask in the SR register
  234. * @{
  235. */
  236. #define USART_FLAG_CTS ((uint32_t)USART_SR_CTS)
  237. #define USART_FLAG_LBD ((uint32_t)USART_SR_LBD)
  238. #define USART_FLAG_TXE ((uint32_t)USART_SR_TXE)
  239. #define USART_FLAG_TC ((uint32_t)USART_SR_TC)
  240. #define USART_FLAG_RXNE ((uint32_t)USART_SR_RXNE)
  241. #define USART_FLAG_IDLE ((uint32_t)USART_SR_IDLE)
  242. #define USART_FLAG_ORE ((uint32_t)USART_SR_ORE)
  243. #define USART_FLAG_NE ((uint32_t)USART_SR_NE)
  244. #define USART_FLAG_FE ((uint32_t)USART_SR_FE)
  245. #define USART_FLAG_PE ((uint32_t)USART_SR_PE)
  246. /**
  247. * @}
  248. */
  249. /** @defgroup USART_Interrupt_definition USART Interrupts Definition
  250. * Elements values convention: 0xY000XXXX
  251. * - XXXX : Interrupt mask in the XX register
  252. * - Y : Interrupt source register (4bits)
  253. * - 01: CR1 register
  254. * - 10: CR2 register
  255. * - 11: CR3 register
  256. *
  257. * @{
  258. */
  259. #define USART_IT_PE ((uint32_t)0x10000100)
  260. #define USART_IT_TXE ((uint32_t)0x10000080)
  261. #define USART_IT_TC ((uint32_t)0x10000040)
  262. #define USART_IT_RXNE ((uint32_t)0x10000020)
  263. #define USART_IT_IDLE ((uint32_t)0x10000010)
  264. #define USART_IT_LBD ((uint32_t)0x20000040)
  265. #define USART_IT_CTS ((uint32_t)0x30000400)
  266. #define USART_IT_ERR ((uint32_t)0x30000001)
  267. /**
  268. * @}
  269. */
  270. /** @defgroup USART_Interruption_Mask USART interruptions flag mask
  271. * @{
  272. */
  273. #define USART_IT_MASK ((uint32_t)0x0000FFFF)
  274. /**
  275. * @}
  276. */
  277. /**
  278. * @}
  279. */
  280. /* Exported macro ------------------------------------------------------------*/
  281. /** @defgroup USART_Exported_Macros USART Exported Macros
  282. * @{
  283. */
  284. /** @brief Reset USART handle state
  285. * @param __HANDLE__: specifies the USART Handle.
  286. * This parameter can be USARTx where x: 1, 2 or 3 to select the USART peripheral.
  287. * @retval None
  288. */
  289. #define __HAL_USART_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_USART_STATE_RESET)
  290. /** @brief Checks whether the specified USART flag is set or not.
  291. * @param __HANDLE__: specifies the USART Handle.
  292. * This parameter can be USARTx where x: 1, 2 or 3 to select the USART peripheral.
  293. * @param __FLAG__: specifies the flag to check.
  294. * This parameter can be one of the following values:
  295. * @arg USART_FLAG_TXE: Transmit data register empty flag
  296. * @arg USART_FLAG_TC: Transmission Complete flag
  297. * @arg USART_FLAG_RXNE: Receive data register not empty flag
  298. * @arg USART_FLAG_IDLE: Idle Line detection flag
  299. * @arg USART_FLAG_ORE: OverRun Error flag
  300. * @arg USART_FLAG_NE: Noise Error flag
  301. * @arg USART_FLAG_FE: Framing Error flag
  302. * @arg USART_FLAG_PE: Parity Error flag
  303. * @retval The new state of __FLAG__ (TRUE or FALSE).
  304. */
  305. #define __HAL_USART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
  306. /** @brief Clears the specified USART pending flags.
  307. * @param __HANDLE__: specifies the USART Handle.
  308. * This parameter can be USARTx where x: 1, 2 or 3 to select the USART peripheral.
  309. * @param __FLAG__: specifies the flag to check.
  310. * This parameter can be any combination of the following values:
  311. * @arg USART_FLAG_TC: Transmission Complete flag.
  312. * @arg USART_FLAG_RXNE: Receive data register not empty flag.
  313. *
  314. * @note PE (Parity error), FE (Framing error), NE (Noise error), ORE (OverRun
  315. * error) and IDLE (Idle line detected) flags are cleared by software
  316. * sequence: a read operation to USART_SR register followed by a read
  317. * operation to USART_DR register.
  318. * @note RXNE flag can be also cleared by a read to the USART_DR register.
  319. * @note TC flag can be also cleared by software sequence: a read operation to
  320. * USART_SR register followed by a write operation to USART_DR register.
  321. * @note TXE flag is cleared only by a write to the USART_DR register.
  322. *
  323. * @retval None
  324. */
  325. #define __HAL_USART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR = ~(__FLAG__))
  326. /** @brief Clear the USART PE pending flag.
  327. * @param __HANDLE__: specifies the USART Handle.
  328. * This parameter can be USARTx where x: 1, 2 or 3 to select the USART peripheral.
  329. * @retval None
  330. */
  331. #define __HAL_USART_CLEAR_PEFLAG(__HANDLE__) do{(__HANDLE__)->Instance->SR;\
  332. (__HANDLE__)->Instance->DR;}while(0)
  333. /** @brief Clear the USART FE pending flag.
  334. * @param __HANDLE__: specifies the USART Handle.
  335. * This parameter can be USARTx where x: 1, 2 or 3 to select the USART peripheral.
  336. * @retval None
  337. */
  338. #define __HAL_USART_CLEAR_FEFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
  339. /** @brief Clear the USART NE pending flag.
  340. * @param __HANDLE__: specifies the USART Handle.
  341. * This parameter can be USARTx where x: 1, 2 or 3 to select the USART peripheral.
  342. * @retval None
  343. */
  344. #define __HAL_USART_CLEAR_NEFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
  345. /** @brief Clear the USART ORE pending flag.
  346. * @param __HANDLE__: specifies the USART Handle.
  347. * This parameter can be USARTx where x: 1, 2 or 3 to select the USART peripheral.
  348. * @retval None
  349. */
  350. #define __HAL_USART_CLEAR_OREFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
  351. /** @brief Clear the USART IDLE pending flag.
  352. * @param __HANDLE__: specifies the USART Handle.
  353. * This parameter can be USARTx where x: 1, 2 or 3 to select the USART peripheral.
  354. * @retval None
  355. */
  356. #define __HAL_USART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
  357. /** @brief Enables or disables the specified Usart interrupts.
  358. * @param __HANDLE__: specifies the USART Handle.
  359. * This parameter can be USARTx where x: 1, 2 or 3 to select the USART peripheral.
  360. * @param __INTERRUPT__: specifies the USART interrupt source to check.
  361. * This parameter can be one of the following values:
  362. * @arg USART_IT_TXE: Transmit Data Register empty interrupt
  363. * @arg USART_IT_TC: Transmission complete interrupt
  364. * @arg USART_IT_RXNE: Receive Data register not empty interrupt
  365. * @arg USART_IT_IDLE: Idle line detection interrupt
  366. * @arg USART_IT_PE: Parity Error interrupt
  367. * @arg USART_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
  368. * @retval None
  369. */
  370. #define __HAL_USART_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == 1)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & USART_IT_MASK)): \
  371. (((__INTERRUPT__) >> 28) == 2)? ((__HANDLE__)->Instance->CR2 |= ((__INTERRUPT__) & USART_IT_MASK)): \
  372. ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & USART_IT_MASK)))
  373. #define __HAL_USART_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == 1)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & USART_IT_MASK)): \
  374. (((__INTERRUPT__) >> 28) == 2)? ((__HANDLE__)->Instance->CR2 &= ~((__INTERRUPT__) & USART_IT_MASK)): \
  375. ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & USART_IT_MASK)))
  376. /** @brief Checks whether the specified Usart interrupt has occurred or not.
  377. * @param __HANDLE__: specifies the USART Handle.
  378. * This parameter can be USARTx where x: 1, 2 or 3 to select the USART peripheral.
  379. * @param __IT__: specifies the USART interrupt source to check.
  380. * This parameter can be one of the following values:
  381. * @arg USART_IT_TXE: Transmit Data Register empty interrupt
  382. * @arg USART_IT_TC: Transmission complete interrupt
  383. * @arg USART_IT_RXNE: Receive Data register not empty interrupt
  384. * @arg USART_IT_IDLE: Idle line detection interrupt
  385. * @arg USART_IT_ERR: Error interrupt
  386. * @arg USART_IT_PE: Parity Error interrupt
  387. * @retval The new state of __IT__ (TRUE or FALSE).
  388. */
  389. #define __HAL_USART_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28) == 1)? (__HANDLE__)->Instance->CR1:(((((uint32_t)(__IT__)) >> 28) == 2)? \
  390. (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & (((uint32_t)(__IT__)) & USART_IT_MASK))
  391. /** @brief Enable USART
  392. * @param __HANDLE__: specifies the USART Handle.
  393. * The Handle Instance can be USARTx where x: 1, 2, 3 to select the USART peripheral
  394. * @retval None
  395. */
  396. #define __HAL_USART_ENABLE(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CR1,(USART_CR1_UE))
  397. /** @brief Disable USART
  398. * @param __HANDLE__: specifies the USART Handle.
  399. * The Handle Instance can be USARTx where x: 1, 2, 3 to select the USART peripheral
  400. * @retval None
  401. */
  402. #define __HAL_USART_DISABLE(__HANDLE__) CLEAR_BIT((__HANDLE__)->Instance->CR1,(USART_CR1_UE))
  403. /**
  404. * @}
  405. */
  406. /* Private macros --------------------------------------------------------*/
  407. /** @defgroup USART_Private_Macros USART Private Macros
  408. * @{
  409. */
  410. #define USART_DIV(__PCLK__, __BAUD__) (((__PCLK__)*25)/(4*(__BAUD__)))
  411. #define USART_DIVMANT(__PCLK__, __BAUD__) (USART_DIV((__PCLK__), (__BAUD__))/100)
  412. #define USART_DIVFRAQ(__PCLK__, __BAUD__) (((USART_DIV((__PCLK__), (__BAUD__)) - (USART_DIVMANT((__PCLK__), (__BAUD__)) * 100)) * 16 + 50) / 100)
  413. #define USART_BRR(__PCLK__, __BAUD__) ((USART_DIVMANT((__PCLK__), (__BAUD__)) << 4)|(USART_DIVFRAQ((__PCLK__), (__BAUD__)) & 0x0F))
  414. /** @brief Check USART Baud rate
  415. * @param __BAUDRATE__: Baudrate specified by the user
  416. * The maximum Baud Rate is derived from the maximum clock on APB (i.e. 32 MHz)
  417. * divided by the smallest oversampling used on the USART (i.e. 8)
  418. * @retval Test result (TRUE or FALSE)
  419. */
  420. #define IS_USART_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 4000001)
  421. /**
  422. * @}
  423. */
  424. /* Exported functions --------------------------------------------------------*/
  425. /** @addtogroup USART_Exported_Functions USART Exported Functions
  426. * @{
  427. */
  428. /** @addtogroup USART_Exported_Functions_Group1 USART Initialization and de-initialization functions
  429. * @{
  430. */
  431. /* Initialization and de-initialization functions ******************************/
  432. HAL_StatusTypeDef HAL_USART_Init(USART_HandleTypeDef *husart);
  433. HAL_StatusTypeDef HAL_USART_DeInit(USART_HandleTypeDef *husart);
  434. void HAL_USART_MspInit(USART_HandleTypeDef *husart);
  435. void HAL_USART_MspDeInit(USART_HandleTypeDef *husart);
  436. /**
  437. * @}
  438. */
  439. /** @addtogroup USART_Exported_Functions_Group2 IO operation functions
  440. * @{
  441. */
  442. /* IO operation functions *******************************************************/
  443. HAL_StatusTypeDef HAL_USART_Transmit(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size, uint32_t Timeout);
  444. HAL_StatusTypeDef HAL_USART_Receive(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
  445. HAL_StatusTypeDef HAL_USART_TransmitReceive(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
  446. HAL_StatusTypeDef HAL_USART_Transmit_IT(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size);
  447. HAL_StatusTypeDef HAL_USART_Receive_IT(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size);
  448. HAL_StatusTypeDef HAL_USART_TransmitReceive_IT(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size);
  449. HAL_StatusTypeDef HAL_USART_Transmit_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size);
  450. HAL_StatusTypeDef HAL_USART_Receive_DMA(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size);
  451. HAL_StatusTypeDef HAL_USART_TransmitReceive_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size);
  452. HAL_StatusTypeDef HAL_USART_DMAPause(USART_HandleTypeDef *husart);
  453. HAL_StatusTypeDef HAL_USART_DMAResume(USART_HandleTypeDef *husart);
  454. HAL_StatusTypeDef HAL_USART_DMAStop(USART_HandleTypeDef *husart);
  455. void HAL_USART_IRQHandler(USART_HandleTypeDef *husart);
  456. void HAL_USART_TxCpltCallback(USART_HandleTypeDef *husart);
  457. void HAL_USART_TxHalfCpltCallback(USART_HandleTypeDef *husart);
  458. void HAL_USART_RxCpltCallback(USART_HandleTypeDef *husart);
  459. void HAL_USART_RxHalfCpltCallback(USART_HandleTypeDef *husart);
  460. void HAL_USART_TxRxCpltCallback(USART_HandleTypeDef *husart);
  461. void HAL_USART_ErrorCallback(USART_HandleTypeDef *husart);
  462. /**
  463. * @}
  464. */
  465. /* Peripheral Control functions ***********************************************/
  466. /** @addtogroup USART_Exported_Functions_Group3 Peripheral State and Errors functions
  467. * @{
  468. */
  469. /* Peripheral State and Error functions ***************************************/
  470. HAL_USART_StateTypeDef HAL_USART_GetState(USART_HandleTypeDef *husart);
  471. uint32_t HAL_USART_GetError(USART_HandleTypeDef *husart);
  472. /**
  473. * @}
  474. */
  475. /**
  476. * @}
  477. */
  478. /**
  479. * @}
  480. */
  481. /**
  482. * @}
  483. */
  484. #ifdef __cplusplus
  485. }
  486. #endif
  487. #endif /* __STM32L1xx_HAL_USART_H */
  488. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/