stm32h7xx_hal_irda.h 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850
  1. /**
  2. ******************************************************************************
  3. * @file stm32h7xx_hal_irda.h
  4. * @author MCD Application Team
  5. * @version V1.0.0
  6. * @date 21-April-2017
  7. * @brief Header file of IRDA HAL module.
  8. ******************************************************************************
  9. * @attention
  10. *
  11. * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
  12. *
  13. * Redistribution and use in source and binary forms, with or without modification,
  14. * are permitted provided that the following conditions are met:
  15. * 1. Redistributions of source code must retain the above copyright notice,
  16. * this list of conditions and the following disclaimer.
  17. * 2. Redistributions in binary form must reproduce the above copyright notice,
  18. * this list of conditions and the following disclaimer in the documentation
  19. * and/or other materials provided with the distribution.
  20. * 3. Neither the name of STMicroelectronics nor the names of its contributors
  21. * may be used to endorse or promote products derived from this software
  22. * without specific prior written permission.
  23. *
  24. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34. *
  35. ******************************************************************************
  36. */
  37. /* Define to prevent recursive inclusion -------------------------------------*/
  38. #ifndef __STM32H7xx_HAL_IRDA_H
  39. #define __STM32H7xx_HAL_IRDA_H
  40. #ifdef __cplusplus
  41. extern "C" {
  42. #endif
  43. /* Includes ------------------------------------------------------------------*/
  44. #include "stm32h7xx_hal_def.h"
  45. /** @addtogroup STM32H7xx_HAL_Driver
  46. * @{
  47. */
  48. /** @addtogroup IRDA
  49. * @{
  50. */
  51. /* Exported types ------------------------------------------------------------*/
  52. /** @defgroup IRDA_Exported_Types IRDA Exported Types
  53. * @{
  54. */
  55. /**
  56. * @brief IRDA Init Structure definition
  57. */
  58. typedef struct
  59. {
  60. uint32_t BaudRate; /*!< This member configures the IRDA communication baud rate.
  61. The baud rate register is computed using the following formula:
  62. Baud Rate Register = ((PCLKx) / ((hirda->Init.BaudRate))) */
  63. uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
  64. This parameter can be a value of @ref IRDA_Word_Length */
  65. uint32_t Parity; /*!< Specifies the parity mode.
  66. This parameter can be a value of @ref IRDA_Parity
  67. @note When parity is enabled, the computed parity is inserted
  68. at the MSB position of the transmitted data (9th bit when
  69. the word length is set to 9 data bits; 8th bit when the
  70. word length is set to 8 data bits). */
  71. uint32_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
  72. This parameter can be a value of @ref IRDA_Transfer_Mode */
  73. uint8_t Prescaler; /*!< Specifies the Prescaler value for dividing the UART/USART source clock
  74. to achieve low-power frequency.
  75. @note Prescaler value 0 is forbidden */
  76. uint16_t PowerMode; /*!< Specifies the IRDA power mode.
  77. This parameter can be a value of @ref IRDA_Low_Power */
  78. }IRDA_InitTypeDef;
  79. /**
  80. * @brief HAL IRDA State structures definition
  81. * @note HAL IRDA State value is a combination of 2 different substates: gState and RxState.
  82. * - gState contains IRDA state information related to global Handle management
  83. * and also information related to Tx operations.
  84. * gState value coding follow below described bitmap :
  85. * b7-b6 Error information
  86. * 00 : No Error
  87. * 01 : (Not Used)
  88. * 10 : Timeout
  89. * 11 : Error
  90. * b5 IP initilisation status
  91. * 0 : Reset (IP not initialized)
  92. * 1 : Init done (IP not initialized. HAL IRDA Init function already called)
  93. * b4-b3 (not used)
  94. * xx : Should be set to 00
  95. * b2 Intrinsic process state
  96. * 0 : Ready
  97. * 1 : Busy (IP busy with some configuration or internal operations)
  98. * b1 (not used)
  99. * x : Should be set to 0
  100. * b0 Tx state
  101. * 0 : Ready (no Tx operation ongoing)
  102. * 1 : Busy (Tx operation ongoing)
  103. * - RxState contains information related to Rx operations.
  104. * RxState value coding follow below described bitmap :
  105. * b7-b6 (not used)
  106. * xx : Should be set to 00
  107. * b5 IP initilisation status
  108. * 0 : Reset (IP not initialized)
  109. * 1 : Init done (IP not initialized)
  110. * b4-b2 (not used)
  111. * xxx : Should be set to 000
  112. * b1 Rx state
  113. * 0 : Ready (no Rx operation ongoing)
  114. * 1 : Busy (Rx operation ongoing)
  115. * b0 (not used)
  116. * x : Should be set to 0.
  117. */
  118. typedef enum
  119. {
  120. HAL_IRDA_STATE_RESET = 0x00U, /*!< Peripheral is not initialized
  121. Value is allowed for gState and RxState */
  122. HAL_IRDA_STATE_READY = 0x20U, /*!< Peripheral Initialized and ready for use
  123. Value is allowed for gState and RxState */
  124. HAL_IRDA_STATE_BUSY = 0x24U, /*!< an internal process is ongoing
  125. Value is allowed for gState only */
  126. HAL_IRDA_STATE_BUSY_TX = 0x21U, /*!< Data Transmission process is ongoing
  127. Value is allowed for gState only */
  128. HAL_IRDA_STATE_BUSY_RX = 0x22U, /*!< Data Reception process is ongoing
  129. Value is allowed for RxState only */
  130. HAL_IRDA_STATE_BUSY_TX_RX = 0x23U, /*!< Data Transmission and Reception process is ongoing
  131. Not to be used for neither gState nor RxState.
  132. Value is result of combination (Or) between gState and RxState values */
  133. HAL_IRDA_STATE_TIMEOUT = 0xA0U, /*!< Timeout state
  134. Value is allowed for gState only */
  135. HAL_IRDA_STATE_ERROR = 0xE0U /*!< Error
  136. Value is allowed for gState only */
  137. }HAL_IRDA_StateTypeDef;
  138. /**
  139. * @brief HAL IRDA Error Code structure definition
  140. */
  141. typedef enum
  142. {
  143. HAL_IRDA_ERROR_NONE = 0x00, /*!< No error */
  144. HAL_IRDA_ERROR_PE = 0x01, /*!< Parity error */
  145. HAL_IRDA_ERROR_NE = 0x02, /*!< Noise error */
  146. HAL_IRDA_ERROR_FE = 0x04, /*!< frame error */
  147. HAL_IRDA_ERROR_ORE = 0x08, /*!< Overrun error */
  148. HAL_IRDA_ERROR_DMA = 0x10, /*!< DMA transfer error */
  149. HAL_IRDA_ERROR_BUSY = 0x20 /*!< Busy Error */
  150. }HAL_IRDA_ErrorTypeDef;
  151. /**
  152. * @brief IRDA clock sources definition
  153. */
  154. typedef enum
  155. {
  156. IRDA_CLOCKSOURCE_D2PCLK1 = 0x00, /*!< Domain2 PCLK1 clock source */
  157. IRDA_CLOCKSOURCE_D2PCLK2 = 0x01, /*!< Domain2 PCLK2 clock source */
  158. IRDA_CLOCKSOURCE_D3PCLK1 = 0x02, /*!< Domain3 PCLK1 clock source */
  159. IRDA_CLOCKSOURCE_PLL2Q = 0x04, /*!< PLL2Q clock source */
  160. IRDA_CLOCKSOURCE_HSI = 0x08, /*!< HSI clock source */
  161. IRDA_CLOCKSOURCE_CSI = 0x10, /*!< CSI clock source */
  162. IRDA_CLOCKSOURCE_LSE = 0x20, /*!< LSE clock source */
  163. IRDA_CLOCKSOURCE_PLL3Q = 0x40, /*!< PCLK2 clock source */
  164. IRDA_CLOCKSOURCE_UNDEFINED = 0x80 /*!< Undefined clock source */
  165. }IRDA_ClockSourceTypeDef;
  166. /**
  167. * @brief IRDA handle Structure definition
  168. */
  169. typedef struct
  170. {
  171. USART_TypeDef *Instance; /*!< IRDA registers base address */
  172. IRDA_InitTypeDef Init; /*!< IRDA communication parameters */
  173. uint8_t *pTxBuffPtr; /*!< Pointer to IRDA Tx transfer Buffer */
  174. uint16_t TxXferSize; /*!< IRDA Tx Transfer size */
  175. __IO uint16_t TxXferCount; /*!< IRDA Tx Transfer Counter */
  176. uint8_t *pRxBuffPtr; /*!< Pointer to IRDA Rx transfer Buffer */
  177. uint16_t RxXferSize; /*!< IRDA Rx Transfer size */
  178. __IO uint16_t RxXferCount; /*!< IRDA Rx Transfer Counter */
  179. uint16_t Mask; /*!< IRDA RX RDR register mask */
  180. DMA_HandleTypeDef *hdmatx; /*!< IRDA Tx DMA Handle parameters */
  181. DMA_HandleTypeDef *hdmarx; /*!< IRDA Rx DMA Handle parameters */
  182. HAL_LockTypeDef Lock; /*!< Locking object */
  183. __IO HAL_IRDA_StateTypeDef gState; /*!< IRDA state information related to global Handle management
  184. and also related to Tx operations.
  185. This parameter can be a value of @ref HAL_IRDA_StateTypeDef */
  186. __IO HAL_IRDA_StateTypeDef RxState; /*!< IRDA state information related to Rx operations.
  187. This parameter can be a value of @ref HAL_IRDA_StateTypeDef */
  188. uint32_t ErrorCode; /*!< IRDA Error code */
  189. }IRDA_HandleTypeDef;
  190. /**
  191. * @brief IRDA Configuration enumeration values definition
  192. */
  193. typedef enum
  194. {
  195. IRDA_BAUDRATE = 0x00, /*!< IRDA Baud rate */
  196. IRDA_PARITY = 0x01, /*!< IRDA frame parity */
  197. IRDA_WORDLENGTH = 0x02, /*!< IRDA frame length */
  198. IRDA_MODE = 0x03, /*!< IRDA communication mode */
  199. IRDA_PRESCALER = 0x04, /*!< IRDA prescaling */
  200. IRDA_POWERMODE = 0x05 /*!< IRDA power mode */
  201. }IRDA_ControlTypeDef;
  202. /**
  203. * @}
  204. */
  205. /* Exported constants --------------------------------------------------------*/
  206. /** @defgroup IRDA_Exported_Constants IRDA Exported Constants
  207. * @{
  208. */
  209. /** @defgroup IRDA_Word_Length IRDA Word Length
  210. * @{
  211. */
  212. #define IRDA_WORDLENGTH_7B ((uint32_t)USART_CR1_M1) /*!< 7-bit long frame */
  213. #define IRDA_WORDLENGTH_8B ((uint32_t)0x00000000) /*!< 8-bit long frame */
  214. #define IRDA_WORDLENGTH_9B ((uint32_t)USART_CR1_M0) /*!< 9-bit long frame */
  215. /**
  216. * @}
  217. */
  218. /** @defgroup IRDA_Parity IRDA Parity
  219. * @{
  220. */
  221. #define IRDA_PARITY_NONE ((uint32_t)0x00000000) /*!< No parity */
  222. #define IRDA_PARITY_EVEN ((uint32_t)USART_CR1_PCE) /*!< Even parity */
  223. #define IRDA_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS)) /*!< Odd parity */
  224. /**
  225. * @}
  226. */
  227. /** @defgroup IRDA_Transfer_Mode IRDA Transfer Mode
  228. * @{
  229. */
  230. #define IRDA_MODE_RX ((uint32_t)USART_CR1_RE) /*!< RX mode */
  231. #define IRDA_MODE_TX ((uint32_t)USART_CR1_TE) /*!< TX mode */
  232. #define IRDA_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE)) /*!< RX and TX mode */
  233. /**
  234. * @}
  235. */
  236. /** @defgroup IRDA_Low_Power IRDA Low Power
  237. * @{
  238. */
  239. #define IRDA_POWERMODE_NORMAL ((uint32_t)0x00000000) /*!< IRDA normal power mode */
  240. #define IRDA_POWERMODE_LOWPOWER ((uint32_t)USART_CR3_IRLP) /*!< IRDA low power mode */
  241. /**
  242. * @}
  243. */
  244. /** @defgroup IRDA_State IRDA State
  245. * @{
  246. */
  247. #define IRDA_STATE_DISABLE ((uint32_t)0x00000000) /*!< IRDA disabled */
  248. #define IRDA_STATE_ENABLE ((uint32_t)USART_CR1_UE) /*!< IRDA enabled */
  249. /**
  250. * @}
  251. */
  252. /** @defgroup IRDA_Mode IRDA Mode
  253. * @{
  254. */
  255. #define IRDA_MODE_DISABLE ((uint32_t)0x00000000) /*!< Associated UART disabled in IRDA mode */
  256. #define IRDA_MODE_ENABLE ((uint32_t)USART_CR3_IREN) /*!< Associated UART enabled in IRDA mode */
  257. /**
  258. * @}
  259. */
  260. /** @defgroup IRDA_One_Bit IRDA One Bit Sampling
  261. * @{
  262. */
  263. #define IRDA_ONE_BIT_SAMPLE_DISABLE ((uint32_t)0x00000000) /*!< One-bit sampling disabled */
  264. #define IRDA_ONE_BIT_SAMPLE_ENABLE ((uint32_t)USART_CR3_ONEBIT) /*!< One-bit sampling enabled */
  265. /**
  266. * @}
  267. */
  268. /** @defgroup IRDA_DMA_Tx IRDA DMA Tx
  269. * @{
  270. */
  271. #define IRDA_DMA_TX_DISABLE ((uint32_t)0x00000000) /*!< IRDA DMA TX disabled */
  272. #define IRDA_DMA_TX_ENABLE ((uint32_t)USART_CR3_DMAT) /*!< IRDA DMA TX enabled */
  273. /**
  274. * @}
  275. */
  276. /** @defgroup IRDA_DMA_Rx IRDA DMA Rx
  277. * @{
  278. */
  279. #define IRDA_DMA_RX_DISABLE ((uint32_t)0x00000000) /*!< IRDA DMA RX disabled */
  280. #define IRDA_DMA_RX_ENABLE ((uint32_t)USART_CR3_DMAR) /*!< IRDA DMA RX enabled */
  281. /**
  282. * @}
  283. */
  284. /** @defgroup IRDA_Request_Parameters IRDA Request Parameters
  285. * @{
  286. */
  287. #define IRDA_AUTOBAUD_REQUEST ((uint16_t)USART_RQR_ABRRQ) /*!< Auto-Baud Rate Request */
  288. #define IRDA_RXDATA_FLUSH_REQUEST ((uint16_t)USART_RQR_RXFRQ) /*!< Receive Data flush Request */
  289. #define IRDA_TXDATA_FLUSH_REQUEST ((uint16_t)USART_RQR_TXFRQ) /*!< Transmit data flush Request */
  290. /**
  291. * @}
  292. */
  293. /** @defgroup IRDA_Flags IRDA Flags
  294. * Elements values convention: 0xXXXX
  295. * - 0xXXXX : Flag mask in the ISR register
  296. * @{
  297. */
  298. #define IRDA_FLAG_REACK ((uint32_t)0x00400000) /*!< IRDA Receive enable acknowledge flag */
  299. #define IRDA_FLAG_TEACK ((uint32_t)0x00200000) /*!< IRDA Transmit enable acknowledge flag */
  300. #define IRDA_FLAG_BUSY ((uint32_t)0x00010000) /*!< IRDA Busy flag */
  301. #define IRDA_FLAG_ABRF ((uint32_t)0x00008000) /*!< IRDA Auto baud rate flag */
  302. #define IRDA_FLAG_ABRE ((uint32_t)0x00004000) /*!< IRDA Auto baud rate error */
  303. #define IRDA_FLAG_TXE ((uint32_t)0x00000080) /*!< IRDA Transmit data register empty */
  304. #define IRDA_FLAG_TC ((uint32_t)0x00000040) /*!< IRDA Transmission complete */
  305. #define IRDA_FLAG_RXNE ((uint32_t)0x00000020) /*!< IRDA Read data register not empty */
  306. #define IRDA_FLAG_ORE ((uint32_t)0x00000008) /*!< IRDA Overrun error */
  307. #define IRDA_FLAG_NE ((uint32_t)0x00000004) /*!< IRDA Noise error */
  308. #define IRDA_FLAG_FE ((uint32_t)0x00000002) /*!< IRDA Framing error */
  309. #define IRDA_FLAG_PE ((uint32_t)0x00000001) /*!< IRDA Parity error */
  310. /**
  311. * @}
  312. */
  313. /** @defgroup IRDA_Interrupt_definition IRDA Interrupts Definition
  314. * Elements values convention: 0000ZZZZ0XXYYYYYb
  315. * - YYYYY : Interrupt source position in the XX register (5bits)
  316. * - XX : Interrupt source register (2bits)
  317. * - 01: CR1 register
  318. * - 10: CR2 register
  319. * - 11: CR3 register
  320. * - ZZZZ : Flag position in the ISR register(4bits)
  321. * @{
  322. */
  323. #define IRDA_IT_PE ((uint16_t)0x0028) /*!< IRDA Parity error interruption */
  324. #define IRDA_IT_TXE ((uint16_t)0x0727) /*!< IRDA Transmit data register empty interruption */
  325. #define IRDA_IT_TC ((uint16_t)0x0626) /*!< IRDA Transmission complete interruption */
  326. #define IRDA_IT_RXNE ((uint16_t)0x0525) /*!< IRDA Read data register not empty interruption */
  327. #define IRDA_IT_IDLE ((uint16_t)0x0424) /*!< IRDA Idle interruption */
  328. #define IRDA_IT_ERR ((uint16_t)0x0060) /*!< IRDA Error interruption */
  329. #define IRDA_IT_ORE ((uint16_t)0x0300) /*!< IRDA Overrun error interruption */
  330. #define IRDA_IT_NE ((uint16_t)0x0200) /*!< IRDA Noise error interruption */
  331. #define IRDA_IT_FE ((uint16_t)0x0100) /*!< IRDA Frame error interruption */
  332. /**
  333. * @}
  334. */
  335. /** @defgroup IRDA_IT_CLEAR_Flags IRDA Interruption Clear Flags
  336. * @{
  337. */
  338. #define IRDA_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */
  339. #define IRDA_CLEAR_FEF USART_ICR_FECF /*!< Framing Error Clear Flag */
  340. #define IRDA_CLEAR_NEF USART_ICR_NCF /*!< Noise detected Clear Flag */
  341. #define IRDA_CLEAR_OREF USART_ICR_ORECF /*!< OverRun Error Clear Flag */
  342. #define IRDA_CLEAR_IDLEF USART_ICR_IDLECF /*!< IDLE line detected Clear Flag */
  343. #define IRDA_CLEAR_TCF USART_ICR_TCCF /*!< Transmission Complete Clear Flag */
  344. /**
  345. * @}
  346. */
  347. /** @defgroup IRDA_Interruption_Mask IRDA interruptions flags mask
  348. * @{
  349. */
  350. #define IRDA_IT_MASK ((uint16_t)0x001F) /*!< IRDA Interruptions flags mask */
  351. /**
  352. * @}
  353. */
  354. /**
  355. * @}
  356. */
  357. /* Exported macros -----------------------------------------------------------*/
  358. /** @defgroup IRDA_Exported_Macros IRDA Exported Macros
  359. * @{
  360. */
  361. /** @brief Reset IRDA handle state.
  362. * @param __HANDLE__: IRDA handle.
  363. * @retval None
  364. */
  365. #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) do{ \
  366. (__HANDLE__)->gState = HAL_IRDA_STATE_RESET; \
  367. (__HANDLE__)->RxState = HAL_IRDA_STATE_RESET; \
  368. } while(0)
  369. /** @brief Flush the IRDA DR register.
  370. * @param __HANDLE__: specifies the IRDA Handle.
  371. * @retval None
  372. */
  373. #define __HAL_IRDA_FLUSH_DRREGISTER(__HANDLE__) \
  374. do{ \
  375. SET_BIT((__HANDLE__)->Instance->RQR, IRDA_RXDATA_FLUSH_REQUEST); \
  376. SET_BIT((__HANDLE__)->Instance->RQR, IRDA_TXDATA_FLUSH_REQUEST); \
  377. } while(0)
  378. /** @brief Clear the specified IRDA pending flag.
  379. * @param __HANDLE__: specifies the IRDA Handle.
  380. * @param __FLAG__: specifies the flag to check.
  381. * This parameter can be any combination of the following values:
  382. * @arg @ref IRDA_CLEAR_PEF
  383. * @arg @ref IRDA_CLEAR_FEF
  384. * @arg @ref IRDA_CLEAR_NEF
  385. * @arg @ref IRDA_CLEAR_OREF
  386. * @arg @ref IRDA_CLEAR_TCF
  387. * @arg @ref IRDA_CLEAR_IDLEF
  388. * @retval None
  389. */
  390. #define __HAL_IRDA_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
  391. /** @brief Clear the IRDA PE pending flag.
  392. * @param __HANDLE__: specifies the IRDA Handle.
  393. * @retval None
  394. */
  395. #define __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_PEF)
  396. /** @brief Clear the IRDA FE pending flag.
  397. * @param __HANDLE__: specifies the IRDA Handle.
  398. * @retval None
  399. */
  400. #define __HAL_IRDA_CLEAR_FEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_FEF)
  401. /** @brief Clear the IRDA NE pending flag.
  402. * @param __HANDLE__: specifies the IRDA Handle.
  403. * @retval None
  404. */
  405. #define __HAL_IRDA_CLEAR_NEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_NEF)
  406. /** @brief Clear the IRDA ORE pending flag.
  407. * @param __HANDLE__: specifies the IRDA Handle.
  408. * @retval None
  409. */
  410. #define __HAL_IRDA_CLEAR_OREFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_OREF)
  411. /** @brief Clear the IRDA IDLE pending flag.
  412. * @param __HANDLE__: specifies the IRDA Handle.
  413. * @retval None
  414. */
  415. #define __HAL_IRDA_CLEAR_IDLEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_IDLEF)
  416. /** @brief Check whether the specified IRDA flag is set or not.
  417. * @param __HANDLE__: specifies the IRDA Handle.
  418. * @param __FLAG__: specifies the flag to check.
  419. * This parameter can be one of the following values:
  420. * @arg @ref IRDA_FLAG_REACK Receive enable acknowledge flag
  421. * @arg @ref IRDA_FLAG_TEACK Transmit enable acknowledge flag
  422. * @arg @ref IRDA_FLAG_BUSY Busy flag
  423. * @arg @ref IRDA_FLAG_ABRF Auto Baud rate detection flag
  424. * @arg @ref IRDA_FLAG_ABRE Auto Baud rate detection error flag
  425. * @arg @ref IRDA_FLAG_TXE Transmit data register empty flag
  426. * @arg @ref IRDA_FLAG_TC Transmission Complete flag
  427. * @arg @ref IRDA_FLAG_RXNE Receive data register not empty flag
  428. * @arg @ref IRDA_FLAG_ORE OverRun Error flag
  429. * @arg @ref IRDA_FLAG_NE Noise Error flag
  430. * @arg @ref IRDA_FLAG_FE Framing Error flag
  431. * @arg @ref IRDA_FLAG_PE Parity Error flag
  432. * @retval The new state of __FLAG__ (TRUE or FALSE).
  433. */
  434. #define __HAL_IRDA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
  435. /** @brief Enable the specified IRDA interrupt.
  436. * @param __HANDLE__: specifies the IRDA Handle.
  437. * @param __INTERRUPT__: specifies the IRDA interrupt source to enable.
  438. * This parameter can be one of the following values:
  439. * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
  440. * @arg @ref IRDA_IT_TC Transmission complete interrupt
  441. * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
  442. * @arg @ref IRDA_IT_IDLE Idle line detection interrupt
  443. * @arg @ref IRDA_IT_PE Parity Error interrupt
  444. * @arg @ref IRDA_IT_ERR Error interrupt(Frame error, noise error, overrun error)
  445. * @retval None
  446. */
  447. #define __HAL_IRDA_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1)? ((__HANDLE__)->Instance->CR1 |= (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \
  448. ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2)? ((__HANDLE__)->Instance->CR2 |= (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \
  449. ((__HANDLE__)->Instance->CR3 |= (1U << ((__INTERRUPT__) & IRDA_IT_MASK))))
  450. /** @brief Disable the specified IRDA interrupt.
  451. * @param __HANDLE__: specifies the IRDA Handle.
  452. * @param __INTERRUPT__: specifies the IRDA interrupt source to disable.
  453. * This parameter can be one of the following values:
  454. * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
  455. * @arg @ref IRDA_IT_TC Transmission complete interrupt
  456. * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
  457. * @arg @ref IRDA_IT_IDLE Idle line detection interrupt
  458. * @arg @ref IRDA_IT_PE Parity Error interrupt
  459. * @arg @ref IRDA_IT_ERR Error interrupt(Frame error, noise error, overrun error)
  460. * @retval None
  461. */
  462. #define __HAL_IRDA_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1)? ((__HANDLE__)->Instance->CR1 &= ~ (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \
  463. ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2)? ((__HANDLE__)->Instance->CR2 &= ~ (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \
  464. ((__HANDLE__)->Instance->CR3 &= ~ (1U << ((__INTERRUPT__) & IRDA_IT_MASK))))
  465. /** @brief Check whether the specified IRDA interrupt has occurred or not.
  466. * @param __HANDLE__: specifies the IRDA Handle.
  467. * @param __IT__: specifies the IRDA interrupt source to check.
  468. * This parameter can be one of the following values:
  469. * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
  470. * @arg @ref IRDA_IT_TC Transmission complete interrupt
  471. * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
  472. * @arg @ref IRDA_IT_IDLE Idle line detection interrupt
  473. * @arg @ref IRDA_IT_ORE OverRun Error interrupt
  474. * @arg @ref IRDA_IT_NE Noise Error interrupt
  475. * @arg @ref IRDA_IT_FE Framing Error interrupt
  476. * @arg @ref IRDA_IT_PE Parity Error interrupt
  477. * @retval The new state of __IT__ (TRUE or FALSE).
  478. */
  479. #define __HAL_IRDA_GET_IT(__HANDLE__, __IT__) ((__HANDLE__)->Instance->ISR & ((uint32_t)1U << ((__IT__)>> 0x08)))
  480. /** @brief Check whether the specified IRDA interrupt source is enabled or not.
  481. * @param __HANDLE__: specifies the IRDA Handle.
  482. * @param __IT__: specifies the IRDA interrupt source to check.
  483. * This parameter can be one of the following values:
  484. * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
  485. * @arg @ref IRDA_IT_TC Transmission complete interrupt
  486. * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
  487. * @arg @ref IRDA_IT_IDLE Idle line detection interrupt
  488. * @arg @ref IRDA_IT_ERR Framing, overrun or noise error interrupt
  489. * @arg @ref IRDA_IT_PE Parity Error interrupt
  490. * @retval The new state of __IT__ (TRUE or FALSE).
  491. */
  492. #define __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __IT__) ((((((uint8_t)(__IT__)) >> 5U) == 1)? (__HANDLE__)->Instance->CR1:(((((uint8_t)(__IT__)) >> 5U) == 2)? \
  493. (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & ((uint32_t)1 << (((uint16_t)(__IT__)) & IRDA_IT_MASK)))
  494. /** @brief Clear the specified IRDA ISR flag, in setting the proper ICR register flag.
  495. * @param __HANDLE__: specifies the IRDA Handle.
  496. * @param __IT_CLEAR__: specifies the interrupt clear register flag that needs to be set
  497. * to clear the corresponding interrupt
  498. * This parameter can be one of the following values:
  499. * @arg @ref IRDA_CLEAR_PEF Parity Error Clear Flag
  500. * @arg @ref IRDA_CLEAR_FEF Framing Error Clear Flag
  501. * @arg @ref IRDA_CLEAR_NEF Noise detected Clear Flag
  502. * @arg @ref IRDA_CLEAR_OREF OverRun Error Clear Flag
  503. * @arg @ref IRDA_CLEAR_TCF Transmission Complete Clear Flag
  504. * @retval None
  505. */
  506. #define __HAL_IRDA_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
  507. /** @brief Set a specific IRDA request flag.
  508. * @param __HANDLE__: specifies the IRDA Handle.
  509. * @param __REQ__: specifies the request flag to set
  510. * This parameter can be one of the following values:
  511. * @arg @ref IRDA_AUTOBAUD_REQUEST Auto-Baud Rate Request
  512. * @arg @ref IRDA_RXDATA_FLUSH_REQUEST Receive Data flush Request
  513. * @arg @ref IRDA_TXDATA_FLUSH_REQUEST Transmit data flush Request
  514. *
  515. * @retval None
  516. */
  517. #define __HAL_IRDA_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
  518. /** @brief Enable the IRDA one bit sample method.
  519. * @param __HANDLE__: specifies the IRDA Handle.
  520. * @retval None
  521. */
  522. #define __HAL_IRDA_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
  523. /** @brief Disable the IRDA one bit sample method.
  524. * @param __HANDLE__: specifies the IRDA Handle.
  525. * @retval None
  526. */
  527. #define __HAL_IRDA_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= (uint32_t)~((uint32_t)USART_CR3_ONEBIT))
  528. /** @brief Enable UART/USART associated to IRDA Handle.
  529. * @param __HANDLE__: specifies the IRDA Handle.
  530. * @retval None
  531. */
  532. #define __HAL_IRDA_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
  533. /** @brief Disable UART/USART associated to IRDA Handle.
  534. * @param __HANDLE__: specifies the IRDA Handle.
  535. * @retval None
  536. */
  537. #define __HAL_IRDA_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
  538. /**
  539. * @}
  540. */
  541. /* Private macros --------------------------------------------------------*/
  542. /** @defgroup IRDA_Private_Macros IRDA Private Macros
  543. * @{
  544. */
  545. /** @brief Compute the mask to apply to retrieve the received data
  546. * according to the word length and to the parity bits activation.
  547. * @param __HANDLE__: specifies the IRDA Handle.
  548. * @retval None, the mask to apply to the associated UART RDR register is stored in (__HANDLE__)->Mask field.
  549. */
  550. #define IRDA_MASK_COMPUTATION(__HANDLE__) \
  551. do { \
  552. if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_9B) \
  553. { \
  554. if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \
  555. { \
  556. (__HANDLE__)->Mask = 0x01FF ; \
  557. } \
  558. else \
  559. { \
  560. (__HANDLE__)->Mask = 0x00FF ; \
  561. } \
  562. } \
  563. else if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_8B) \
  564. { \
  565. if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \
  566. { \
  567. (__HANDLE__)->Mask = 0x00FF ; \
  568. } \
  569. else \
  570. { \
  571. (__HANDLE__)->Mask = 0x007F ; \
  572. } \
  573. } \
  574. else if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_7B) \
  575. { \
  576. if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \
  577. { \
  578. (__HANDLE__)->Mask = 0x007F ; \
  579. } \
  580. else \
  581. { \
  582. (__HANDLE__)->Mask = 0x003F ; \
  583. } \
  584. } \
  585. } while(0)
  586. /** @brief Ensure that IRDA Baud rate is less or equal to maximum value.
  587. * @param __BAUDRATE__: specifies the IRDA Baudrate set by the user.
  588. * @retval True or False
  589. */
  590. #define IS_IRDA_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 115201)
  591. /** @brief Ensure that IRDA prescaler value is strictly larger than 0.
  592. * @param __PRESCALER__: specifies the IRDA prescaler value set by the user.
  593. * @retval True or False
  594. */
  595. #define IS_IRDA_PRESCALER(__PRESCALER__) ((__PRESCALER__) > 0)
  596. /**
  597. * @brief Ensure that IRDA frame length is valid.
  598. * @param __LENGTH__: IRDA frame length.
  599. * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid)
  600. */
  601. #define IS_IRDA_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == IRDA_WORDLENGTH_7B) || \
  602. ((__LENGTH__) == IRDA_WORDLENGTH_8B) || \
  603. ((__LENGTH__) == IRDA_WORDLENGTH_9B))
  604. /**
  605. * @brief Ensure that IRDA frame parity is valid.
  606. * @param __PARITY__: IRDA frame parity.
  607. * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid)
  608. */
  609. #define IS_IRDA_PARITY(__PARITY__) (((__PARITY__) == IRDA_PARITY_NONE) || \
  610. ((__PARITY__) == IRDA_PARITY_EVEN) || \
  611. ((__PARITY__) == IRDA_PARITY_ODD))
  612. /**
  613. * @brief Ensure that IRDA communication mode is valid.
  614. * @param __MODE__: IRDA communication mode.
  615. * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
  616. */
  617. #define IS_IRDA_TX_RX_MODE(__MODE__) ((((__MODE__) & (~((uint32_t)(IRDA_MODE_TX_RX)))) == (uint32_t)0x00) && ((__MODE__) != (uint32_t)0x00))
  618. /**
  619. * @brief Ensure that IRDA power mode is valid.
  620. * @param __MODE__: IRDA power mode.
  621. * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
  622. */
  623. #define IS_IRDA_POWERMODE(__MODE__) (((__MODE__) == IRDA_POWERMODE_LOWPOWER) || \
  624. ((__MODE__) == IRDA_POWERMODE_NORMAL))
  625. /**
  626. * @brief Ensure that IRDA state is valid.
  627. * @param __STATE__: IRDA state mode.
  628. * @retval SET (__STATE__ is valid) or RESET (__STATE__ is invalid)
  629. */
  630. #define IS_IRDA_STATE(__STATE__) (((__STATE__) == IRDA_STATE_DISABLE) || \
  631. ((__STATE__) == IRDA_STATE_ENABLE))
  632. /**
  633. * @brief Ensure that IRDA associated UART/USART mode is valid.
  634. * @param __MODE__: IRDA associated UART/USART mode.
  635. * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
  636. */
  637. #define IS_IRDA_MODE(__MODE__) (((__MODE__) == IRDA_MODE_DISABLE) || \
  638. ((__MODE__) == IRDA_MODE_ENABLE))
  639. /**
  640. * @brief Ensure that IRDA sampling rate is valid.
  641. * @param __ONEBIT__: IRDA sampling rate.
  642. * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid)
  643. */
  644. #define IS_IRDA_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == IRDA_ONE_BIT_SAMPLE_DISABLE) || \
  645. ((__ONEBIT__) == IRDA_ONE_BIT_SAMPLE_ENABLE))
  646. /**
  647. * @brief Ensure that IRDA DMA TX mode is valid.
  648. * @param __DMATX__: IRDA DMA TX mode.
  649. * @retval SET (__DMATX__ is valid) or RESET (__DMATX__ is invalid)
  650. */
  651. #define IS_IRDA_DMA_TX(__DMATX__) (((__DMATX__) == IRDA_DMA_TX_DISABLE) || \
  652. ((__DMATX__) == IRDA_DMA_TX_ENABLE))
  653. /**
  654. * @brief Ensure that IRDA DMA RX mode is valid.
  655. * @param __DMARX__: IRDA DMA RX mode.
  656. * @retval SET (__DMARX__ is valid) or RESET (__DMARX__ is invalid)
  657. */
  658. #define IS_IRDA_DMA_RX(__DMARX__) (((__DMARX__) == IRDA_DMA_RX_DISABLE) || \
  659. ((__DMARX__) == IRDA_DMA_RX_ENABLE))
  660. /**
  661. * @brief Ensure that IRDA request is valid.
  662. * @param __PARAM__: IRDA request.
  663. * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid)
  664. */
  665. #define IS_IRDA_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == IRDA_AUTOBAUD_REQUEST) || \
  666. ((__PARAM__) == IRDA_RXDATA_FLUSH_REQUEST) || \
  667. ((__PARAM__) == IRDA_TXDATA_FLUSH_REQUEST))
  668. /**
  669. * @}
  670. */
  671. /* Include IRDA HAL Extended module */
  672. #include "stm32h7xx_hal_irda_ex.h"
  673. /* Exported functions --------------------------------------------------------*/
  674. /** @addtogroup IRDA_Exported_Functions IRDA Exported Functions
  675. * @{
  676. */
  677. /** @addtogroup IRDA_Exported_Functions_Group1 Initialization and de-initialization functions
  678. * @{
  679. */
  680. /* Initialization and de-initialization functions ****************************/
  681. HAL_StatusTypeDef HAL_IRDA_Init(IRDA_HandleTypeDef *hirda);
  682. HAL_StatusTypeDef HAL_IRDA_DeInit(IRDA_HandleTypeDef *hirda);
  683. void HAL_IRDA_MspInit(IRDA_HandleTypeDef *hirda);
  684. void HAL_IRDA_MspDeInit(IRDA_HandleTypeDef *hirda);
  685. /**
  686. * @}
  687. */
  688. /** @addtogroup IRDA_Exported_Functions_Group2 IO operation functions
  689. * @{
  690. */
  691. /* IO operation functions *****************************************************/
  692. HAL_StatusTypeDef HAL_IRDA_Transmit(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  693. HAL_StatusTypeDef HAL_IRDA_Receive(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  694. HAL_StatusTypeDef HAL_IRDA_Transmit_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
  695. HAL_StatusTypeDef HAL_IRDA_Receive_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
  696. HAL_StatusTypeDef HAL_IRDA_Transmit_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
  697. HAL_StatusTypeDef HAL_IRDA_Receive_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
  698. HAL_StatusTypeDef HAL_IRDA_DMAPause(IRDA_HandleTypeDef *hirda);
  699. HAL_StatusTypeDef HAL_IRDA_DMAResume(IRDA_HandleTypeDef *hirda);
  700. HAL_StatusTypeDef HAL_IRDA_DMAStop(IRDA_HandleTypeDef *hirda);
  701. HAL_StatusTypeDef HAL_IRDA_Abort(IRDA_HandleTypeDef *hirda);
  702. HAL_StatusTypeDef HAL_IRDA_AbortTransmit(IRDA_HandleTypeDef *hirda);
  703. HAL_StatusTypeDef HAL_IRDA_AbortReceive(IRDA_HandleTypeDef *hirda);
  704. HAL_StatusTypeDef HAL_IRDA_Abort_IT(IRDA_HandleTypeDef *hirda);
  705. HAL_StatusTypeDef HAL_IRDA_AbortTransmit_IT(IRDA_HandleTypeDef *hirda);
  706. HAL_StatusTypeDef HAL_IRDA_AbortReceive_IT(IRDA_HandleTypeDef *hirda);
  707. void HAL_IRDA_IRQHandler(IRDA_HandleTypeDef *hirda);
  708. void HAL_IRDA_TxCpltCallback(IRDA_HandleTypeDef *hirda);
  709. void HAL_IRDA_RxCpltCallback(IRDA_HandleTypeDef *hirda);
  710. void HAL_IRDA_TxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
  711. void HAL_IRDA_RxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
  712. void HAL_IRDA_ErrorCallback(IRDA_HandleTypeDef *hirda);
  713. void HAL_IRDA_AbortCpltCallback (IRDA_HandleTypeDef *hirda);
  714. void HAL_IRDA_AbortTransmitCpltCallback (IRDA_HandleTypeDef *hirda);
  715. void HAL_IRDA_AbortReceiveCpltCallback (IRDA_HandleTypeDef *hirda);
  716. /**
  717. * @}
  718. */
  719. /* Peripheral Control functions ************************************************/
  720. /** @addtogroup IRDA_Exported_Functions_Group4 Peripheral State and Error functions
  721. * @{
  722. */
  723. /* Peripheral State and Error functions ***************************************/
  724. HAL_IRDA_StateTypeDef HAL_IRDA_GetState(IRDA_HandleTypeDef *hirda);
  725. uint32_t HAL_IRDA_GetError(IRDA_HandleTypeDef *hirda);
  726. /**
  727. * @}
  728. */
  729. /**
  730. * @}
  731. */
  732. /**
  733. * @}
  734. */
  735. /**
  736. * @}
  737. */
  738. #ifdef __cplusplus
  739. }
  740. #endif
  741. #endif /* __STM32H7xx_HAL_IRDA_H */
  742. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/