You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

stm32l1xx_hal_irda.h 31KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684
  1. /**
  2. ******************************************************************************
  3. * @file stm32l1xx_hal_irda.h
  4. * @author MCD Application Team
  5. * @brief Header file of IRDA HAL module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * <h2><center>&copy; Copyright (c) 2016 STMicroelectronics.
  10. * All rights reserved.</center></h2>
  11. *
  12. * This software component is licensed by ST under BSD 3-Clause license,
  13. * the "License"; You may not use this file except in compliance with the
  14. * License. You may obtain a copy of the License at:
  15. * opensource.org/licenses/BSD-3-Clause
  16. *
  17. ******************************************************************************
  18. */
  19. /* Define to prevent recursive inclusion -------------------------------------*/
  20. #ifndef __STM32L1xx_HAL_IRDA_H
  21. #define __STM32L1xx_HAL_IRDA_H
  22. #ifdef __cplusplus
  23. extern "C" {
  24. #endif
  25. /* Includes ------------------------------------------------------------------*/
  26. #include "stm32l1xx_hal_def.h"
  27. /** @addtogroup STM32L1xx_HAL_Driver
  28. * @{
  29. */
  30. /** @addtogroup IRDA
  31. * @{
  32. */
  33. /* Exported types ------------------------------------------------------------*/
  34. /** @defgroup IRDA_Exported_Types IRDA Exported Types
  35. * @{
  36. */
  37. /**
  38. * @brief IRDA Init Structure definition
  39. */
  40. typedef struct
  41. {
  42. uint32_t BaudRate; /*!< This member configures the IRDA communication baud rate.
  43. The baud rate is computed using the following formula:
  44. - IntegerDivider = ((PCLKx) / (16 * (hirda->Init.BaudRate)))
  45. - FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 16) + 0.5 */
  46. uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
  47. This parameter can be a value of @ref IRDA_Word_Length */
  48. uint32_t Parity; /*!< Specifies the parity mode.
  49. This parameter can be a value of @ref IRDA_Parity
  50. @note When parity is enabled, the computed parity is inserted
  51. at the MSB position of the transmitted data (9th bit when
  52. the word length is set to 9 data bits; 8th bit when the
  53. word length is set to 8 data bits). */
  54. uint32_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
  55. This parameter can be a value of @ref IRDA_Mode */
  56. uint8_t Prescaler; /*!< Specifies the Prescaler value to be programmed
  57. in the IrDA low-power Baud Register, for defining pulse width on which
  58. burst acceptance/rejection will be decided. This value is used as divisor
  59. of system clock to achieve required pulse width. */
  60. uint32_t IrDAMode; /*!< Specifies the IrDA mode
  61. This parameter can be a value of @ref IRDA_Low_Power */
  62. } IRDA_InitTypeDef;
  63. /**
  64. * @brief HAL IRDA State structures definition
  65. * @note HAL IRDA State value is a combination of 2 different substates: gState and RxState.
  66. * - gState contains IRDA state information related to global Handle management
  67. * and also information related to Tx operations.
  68. * gState value coding follow below described bitmap :
  69. * b7-b6 Error information
  70. * 00 : No Error
  71. * 01 : (Not Used)
  72. * 10 : Timeout
  73. * 11 : Error
  74. * b5 IP initilisation status
  75. * 0 : Reset (IP not initialized)
  76. * 1 : Init done (IP not initialized. HAL IRDA Init function already called)
  77. * b4-b3 (not used)
  78. * xx : Should be set to 00
  79. * b2 Intrinsic process state
  80. * 0 : Ready
  81. * 1 : Busy (IP busy with some configuration or internal operations)
  82. * b1 (not used)
  83. * x : Should be set to 0
  84. * b0 Tx state
  85. * 0 : Ready (no Tx operation ongoing)
  86. * 1 : Busy (Tx operation ongoing)
  87. * - RxState contains information related to Rx operations.
  88. * RxState value coding follow below described bitmap :
  89. * b7-b6 (not used)
  90. * xx : Should be set to 00
  91. * b5 IP initilisation status
  92. * 0 : Reset (IP not initialized)
  93. * 1 : Init done (IP not initialized)
  94. * b4-b2 (not used)
  95. * xxx : Should be set to 000
  96. * b1 Rx state
  97. * 0 : Ready (no Rx operation ongoing)
  98. * 1 : Busy (Rx operation ongoing)
  99. * b0 (not used)
  100. * x : Should be set to 0.
  101. */
  102. typedef enum
  103. {
  104. HAL_IRDA_STATE_RESET = 0x00U, /*!< Peripheral is not yet Initialized
  105. Value is allowed for gState and RxState */
  106. HAL_IRDA_STATE_READY = 0x20U, /*!< Peripheral Initialized and ready for use
  107. Value is allowed for gState and RxState */
  108. HAL_IRDA_STATE_BUSY = 0x24U, /*!< An internal process is ongoing
  109. Value is allowed for gState only */
  110. HAL_IRDA_STATE_BUSY_TX = 0x21U, /*!< Data Transmission process is ongoing
  111. Value is allowed for gState only */
  112. HAL_IRDA_STATE_BUSY_RX = 0x22U, /*!< Data Reception process is ongoing
  113. Value is allowed for RxState only */
  114. HAL_IRDA_STATE_BUSY_TX_RX = 0x23U, /*!< Data Transmission and Reception process is ongoing
  115. Not to be used for neither gState nor RxState.
  116. Value is result of combination (Or) between gState and RxState values */
  117. HAL_IRDA_STATE_TIMEOUT = 0xA0U, /*!< Timeout state
  118. Value is allowed for gState only */
  119. HAL_IRDA_STATE_ERROR = 0xE0U /*!< Error
  120. Value is allowed for gState only */
  121. } HAL_IRDA_StateTypeDef;
  122. /**
  123. * @brief IRDA handle Structure definition
  124. */
  125. #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
  126. typedef struct __IRDA_HandleTypeDef
  127. #else
  128. typedef struct
  129. #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
  130. {
  131. USART_TypeDef *Instance; /*!< USART registers base address */
  132. IRDA_InitTypeDef Init; /*!< IRDA communication parameters */
  133. uint8_t *pTxBuffPtr; /*!< Pointer to IRDA Tx transfer Buffer */
  134. uint16_t TxXferSize; /*!< IRDA Tx Transfer size */
  135. __IO uint16_t TxXferCount; /*!< IRDA Tx Transfer Counter */
  136. uint8_t *pRxBuffPtr; /*!< Pointer to IRDA Rx transfer Buffer */
  137. uint16_t RxXferSize; /*!< IRDA Rx Transfer size */
  138. __IO uint16_t RxXferCount; /*!< IRDA Rx Transfer Counter */
  139. DMA_HandleTypeDef *hdmatx; /*!< IRDA Tx DMA Handle parameters */
  140. DMA_HandleTypeDef *hdmarx; /*!< IRDA Rx DMA Handle parameters */
  141. HAL_LockTypeDef Lock; /*!< Locking object */
  142. __IO HAL_IRDA_StateTypeDef gState; /*!< IRDA state information related to global Handle management
  143. and also related to Tx operations.
  144. This parameter can be a value of @ref HAL_IRDA_StateTypeDef */
  145. __IO HAL_IRDA_StateTypeDef RxState; /*!< IRDA state information related to Rx operations.
  146. This parameter can be a value of @ref HAL_IRDA_StateTypeDef */
  147. __IO uint32_t ErrorCode; /*!< IRDA Error code */
  148. #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
  149. void (* TxHalfCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Tx Half Complete Callback */
  150. void (* TxCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Tx Complete Callback */
  151. void (* RxHalfCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Rx Half Complete Callback */
  152. void (* RxCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Rx Complete Callback */
  153. void (* ErrorCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Error Callback */
  154. void (* AbortCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Abort Complete Callback */
  155. void (* AbortTransmitCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Abort Transmit Complete Callback */
  156. void (* AbortReceiveCpltCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Abort Receive Complete Callback */
  157. void (* MspInitCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Msp Init callback */
  158. void (* MspDeInitCallback)(struct __IRDA_HandleTypeDef *hirda); /*!< IRDA Msp DeInit callback */
  159. #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
  160. } IRDA_HandleTypeDef;
  161. #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
  162. /**
  163. * @brief HAL IRDA Callback ID enumeration definition
  164. */
  165. typedef enum
  166. {
  167. HAL_IRDA_TX_HALFCOMPLETE_CB_ID = 0x00U, /*!< IRDA Tx Half Complete Callback ID */
  168. HAL_IRDA_TX_COMPLETE_CB_ID = 0x01U, /*!< IRDA Tx Complete Callback ID */
  169. HAL_IRDA_RX_HALFCOMPLETE_CB_ID = 0x02U, /*!< IRDA Rx Half Complete Callback ID */
  170. HAL_IRDA_RX_COMPLETE_CB_ID = 0x03U, /*!< IRDA Rx Complete Callback ID */
  171. HAL_IRDA_ERROR_CB_ID = 0x04U, /*!< IRDA Error Callback ID */
  172. HAL_IRDA_ABORT_COMPLETE_CB_ID = 0x05U, /*!< IRDA Abort Complete Callback ID */
  173. HAL_IRDA_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x06U, /*!< IRDA Abort Transmit Complete Callback ID */
  174. HAL_IRDA_ABORT_RECEIVE_COMPLETE_CB_ID = 0x07U, /*!< IRDA Abort Receive Complete Callback ID */
  175. HAL_IRDA_MSPINIT_CB_ID = 0x08U, /*!< IRDA MspInit callback ID */
  176. HAL_IRDA_MSPDEINIT_CB_ID = 0x09U /*!< IRDA MspDeInit callback ID */
  177. } HAL_IRDA_CallbackIDTypeDef;
  178. /**
  179. * @brief HAL IRDA Callback pointer definition
  180. */
  181. typedef void (*pIRDA_CallbackTypeDef)(IRDA_HandleTypeDef *hirda); /*!< pointer to an IRDA callback function */
  182. #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
  183. /**
  184. * @}
  185. */
  186. /* Exported constants --------------------------------------------------------*/
  187. /** @defgroup IRDA_Exported_Constants IRDA Exported constants
  188. * @{
  189. */
  190. /** @defgroup IRDA_Error_Code IRDA Error Code
  191. * @{
  192. */
  193. #define HAL_IRDA_ERROR_NONE 0x00000000U /*!< No error */
  194. #define HAL_IRDA_ERROR_PE 0x00000001U /*!< Parity error */
  195. #define HAL_IRDA_ERROR_NE 0x00000002U /*!< Noise error */
  196. #define HAL_IRDA_ERROR_FE 0x00000004U /*!< Frame error */
  197. #define HAL_IRDA_ERROR_ORE 0x00000008U /*!< Overrun error */
  198. #define HAL_IRDA_ERROR_DMA 0x00000010U /*!< DMA transfer error */
  199. #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
  200. #define HAL_IRDA_ERROR_INVALID_CALLBACK ((uint32_t)0x00000020U) /*!< Invalid Callback error */
  201. #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
  202. /**
  203. * @}
  204. */
  205. /** @defgroup IRDA_Word_Length IRDA Word Length
  206. * @{
  207. */
  208. #define IRDA_WORDLENGTH_8B 0x00000000U
  209. #define IRDA_WORDLENGTH_9B ((uint32_t)USART_CR1_M)
  210. /**
  211. * @}
  212. */
  213. /** @defgroup IRDA_Parity IRDA Parity
  214. * @{
  215. */
  216. #define IRDA_PARITY_NONE 0x00000000U
  217. #define IRDA_PARITY_EVEN ((uint32_t)USART_CR1_PCE)
  218. #define IRDA_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
  219. /**
  220. * @}
  221. */
  222. /** @defgroup IRDA_Mode IRDA Transfer Mode
  223. * @{
  224. */
  225. #define IRDA_MODE_RX ((uint32_t)USART_CR1_RE)
  226. #define IRDA_MODE_TX ((uint32_t)USART_CR1_TE)
  227. #define IRDA_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE))
  228. /**
  229. * @}
  230. */
  231. /** @defgroup IRDA_Low_Power IRDA Low Power
  232. * @{
  233. */
  234. #define IRDA_POWERMODE_LOWPOWER ((uint32_t)USART_CR3_IRLP)
  235. #define IRDA_POWERMODE_NORMAL 0x00000000U
  236. /**
  237. * @}
  238. */
  239. /** @defgroup IRDA_Flags IRDA Flags
  240. * Elements values convention: 0xXXXX
  241. * - 0xXXXX : Flag mask in the SR register
  242. * @{
  243. */
  244. #define IRDA_FLAG_TXE ((uint32_t)USART_SR_TXE)
  245. #define IRDA_FLAG_TC ((uint32_t)USART_SR_TC)
  246. #define IRDA_FLAG_RXNE ((uint32_t)USART_SR_RXNE)
  247. #define IRDA_FLAG_IDLE ((uint32_t)USART_SR_IDLE)
  248. #define IRDA_FLAG_ORE ((uint32_t)USART_SR_ORE)
  249. #define IRDA_FLAG_NE ((uint32_t)USART_SR_NE)
  250. #define IRDA_FLAG_FE ((uint32_t)USART_SR_FE)
  251. #define IRDA_FLAG_PE ((uint32_t)USART_SR_PE)
  252. /**
  253. * @}
  254. */
  255. /** @defgroup IRDA_Interrupt_definition IRDA Interrupt Definitions
  256. * Elements values convention: 0xY000XXXX
  257. * - XXXX : Interrupt mask in the XX register
  258. * - Y : Interrupt source register (2bits)
  259. * - 01: CR1 register
  260. * - 10: CR2 register
  261. * - 11: CR3 register
  262. * @{
  263. */
  264. #define IRDA_IT_PE ((uint32_t)(IRDA_CR1_REG_INDEX << 28U | USART_CR1_PEIE))
  265. #define IRDA_IT_TXE ((uint32_t)(IRDA_CR1_REG_INDEX << 28U | USART_CR1_TXEIE))
  266. #define IRDA_IT_TC ((uint32_t)(IRDA_CR1_REG_INDEX << 28U | USART_CR1_TCIE))
  267. #define IRDA_IT_RXNE ((uint32_t)(IRDA_CR1_REG_INDEX << 28U | USART_CR1_RXNEIE))
  268. #define IRDA_IT_IDLE ((uint32_t)(IRDA_CR1_REG_INDEX << 28U | USART_CR1_IDLEIE))
  269. #define IRDA_IT_LBD ((uint32_t)(IRDA_CR2_REG_INDEX << 28U | USART_CR2_LBDIE))
  270. #define IRDA_IT_CTS ((uint32_t)(IRDA_CR3_REG_INDEX << 28U | USART_CR3_CTSIE))
  271. #define IRDA_IT_ERR ((uint32_t)(IRDA_CR3_REG_INDEX << 28U | USART_CR3_EIE))
  272. /**
  273. * @}
  274. */
  275. /**
  276. * @}
  277. */
  278. /* Exported macro ------------------------------------------------------------*/
  279. /** @defgroup IRDA_Exported_Macros IRDA Exported Macros
  280. * @{
  281. */
  282. /** @brief Reset IRDA handle gstate & RxState
  283. * @param __HANDLE__ specifies the IRDA Handle.
  284. * IRDA Handle selects the USARTx or UARTy peripheral
  285. * (USART,UART availability and x,y values depending on device).
  286. * @retval None
  287. */
  288. #if USE_HAL_IRDA_REGISTER_CALLBACKS == 1
  289. #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) do{ \
  290. (__HANDLE__)->gState = HAL_IRDA_STATE_RESET; \
  291. (__HANDLE__)->RxState = HAL_IRDA_STATE_RESET; \
  292. (__HANDLE__)->MspInitCallback = NULL; \
  293. (__HANDLE__)->MspDeInitCallback = NULL; \
  294. } while(0U)
  295. #else
  296. #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) do{ \
  297. (__HANDLE__)->gState = HAL_IRDA_STATE_RESET; \
  298. (__HANDLE__)->RxState = HAL_IRDA_STATE_RESET; \
  299. } while(0U)
  300. #endif /*USE_HAL_IRDA_REGISTER_CALLBACKS */
  301. /** @brief Flush the IRDA DR register
  302. * @param __HANDLE__ specifies the IRDA Handle.
  303. * IRDA Handle selects the USARTx or UARTy peripheral
  304. * (USART,UART availability and x,y values depending on device).
  305. * @retval None
  306. */
  307. #define __HAL_IRDA_FLUSH_DRREGISTER(__HANDLE__) ((__HANDLE__)->Instance->DR)
  308. /** @brief Check whether the specified IRDA flag is set or not.
  309. * @param __HANDLE__ specifies the IRDA Handle.
  310. * IRDA Handle selects the USARTx or UARTy peripheral
  311. * (USART,UART availability and x,y values depending on device).
  312. * @param __FLAG__ specifies the flag to check.
  313. * This parameter can be one of the following values:
  314. * @arg IRDA_FLAG_TXE: Transmit data register empty flag
  315. * @arg IRDA_FLAG_TC: Transmission Complete flag
  316. * @arg IRDA_FLAG_RXNE: Receive data register not empty flag
  317. * @arg IRDA_FLAG_IDLE: Idle Line detection flag
  318. * @arg IRDA_FLAG_ORE: OverRun Error flag
  319. * @arg IRDA_FLAG_NE: Noise Error flag
  320. * @arg IRDA_FLAG_FE: Framing Error flag
  321. * @arg IRDA_FLAG_PE: Parity Error flag
  322. * @retval The new state of __FLAG__ (TRUE or FALSE).
  323. */
  324. #define __HAL_IRDA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
  325. /** @brief Clear the specified IRDA pending flag.
  326. * @param __HANDLE__ specifies the IRDA Handle.
  327. * IRDA Handle selects the USARTx or UARTy peripheral
  328. * (USART,UART availability and x,y values depending on device).
  329. * @param __FLAG__ specifies the flag to check.
  330. * This parameter can be any combination of the following values:
  331. * @arg IRDA_FLAG_TC: Transmission Complete flag.
  332. * @arg IRDA_FLAG_RXNE: Receive data register not empty flag.
  333. *
  334. * @note PE (Parity error), FE (Framing error), NE (Noise error), ORE (OverRun
  335. * error) and IDLE (Idle line detected) flags are cleared by software
  336. * sequence: a read operation to USART_SR register followed by a read
  337. * operation to USART_DR register.
  338. * @note RXNE flag can be also cleared by a read to the USART_DR register.
  339. * @note TC flag can be also cleared by software sequence: a read operation to
  340. * USART_SR register followed by a write operation to USART_DR register.
  341. * @note TXE flag is cleared only by a write to the USART_DR register.
  342. * @retval None
  343. */
  344. #define __HAL_IRDA_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR = ~(__FLAG__))
  345. /** @brief Clear the IRDA PE pending flag.
  346. * @param __HANDLE__ specifies the IRDA Handle.
  347. * IRDA Handle selects the USARTx or UARTy peripheral
  348. * (USART,UART availability and x,y values depending on device).
  349. * @retval None
  350. */
  351. #define __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__) \
  352. do{ \
  353. __IO uint32_t tmpreg = 0x00U; \
  354. tmpreg = (__HANDLE__)->Instance->SR; \
  355. tmpreg = (__HANDLE__)->Instance->DR; \
  356. UNUSED(tmpreg); \
  357. } while(0U)
  358. /** @brief Clear the IRDA FE pending flag.
  359. * @param __HANDLE__ specifies the IRDA Handle.
  360. * IRDA Handle selects the USARTx or UARTy peripheral
  361. * (USART,UART availability and x,y values depending on device).
  362. * @retval None
  363. */
  364. #define __HAL_IRDA_CLEAR_FEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
  365. /** @brief Clear the IRDA NE pending flag.
  366. * @param __HANDLE__ specifies the IRDA Handle.
  367. * IRDA Handle selects the USARTx or UARTy peripheral
  368. * (USART,UART availability and x,y values depending on device).
  369. * @retval None
  370. */
  371. #define __HAL_IRDA_CLEAR_NEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
  372. /** @brief Clear the IRDA ORE pending flag.
  373. * @param __HANDLE__ specifies the IRDA Handle.
  374. * IRDA Handle selects the USARTx or UARTy peripheral
  375. * (USART,UART availability and x,y values depending on device).
  376. * @retval None
  377. */
  378. #define __HAL_IRDA_CLEAR_OREFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
  379. /** @brief Clear the IRDA IDLE pending flag.
  380. * @param __HANDLE__ specifies the IRDA Handle.
  381. * IRDA Handle selects the USARTx or UARTy peripheral
  382. * (USART,UART availability and x,y values depending on device).
  383. * @retval None
  384. */
  385. #define __HAL_IRDA_CLEAR_IDLEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
  386. /** @brief Enable the specified IRDA interrupt.
  387. * @param __HANDLE__ specifies the IRDA Handle.
  388. * IRDA Handle selects the USARTx or UARTy peripheral
  389. * (USART,UART availability and x,y values depending on device).
  390. * @param __INTERRUPT__ specifies the IRDA interrupt source to enable.
  391. * This parameter can be one of the following values:
  392. * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt
  393. * @arg IRDA_IT_TC: Transmission complete interrupt
  394. * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt
  395. * @arg IRDA_IT_IDLE: Idle line detection interrupt
  396. * @arg IRDA_IT_PE: Parity Error interrupt
  397. * @arg IRDA_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
  398. * @retval None
  399. */
  400. #define __HAL_IRDA_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28U) == IRDA_CR1_REG_INDEX)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & IRDA_IT_MASK)): \
  401. (((__INTERRUPT__) >> 28U) == IRDA_CR2_REG_INDEX)? ((__HANDLE__)->Instance->CR2 |= ((__INTERRUPT__) & IRDA_IT_MASK)): \
  402. ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & IRDA_IT_MASK)))
  403. /** @brief Disable the specified IRDA interrupt.
  404. * @param __HANDLE__ specifies the IRDA Handle.
  405. * IRDA Handle selects the USARTx or UARTy peripheral
  406. * (USART,UART availability and x,y values depending on device).
  407. * @param __INTERRUPT__ specifies the IRDA interrupt source to disable.
  408. * This parameter can be one of the following values:
  409. * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt
  410. * @arg IRDA_IT_TC: Transmission complete interrupt
  411. * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt
  412. * @arg IRDA_IT_IDLE: Idle line detection interrupt
  413. * @arg IRDA_IT_PE: Parity Error interrupt
  414. * @arg IRDA_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
  415. * @retval None
  416. */
  417. #define __HAL_IRDA_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28U) == IRDA_CR1_REG_INDEX)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & IRDA_IT_MASK)): \
  418. (((__INTERRUPT__) >> 28U) == IRDA_CR2_REG_INDEX)? ((__HANDLE__)->Instance->CR2 &= ~((__INTERRUPT__) & IRDA_IT_MASK)): \
  419. ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & IRDA_IT_MASK)))
  420. /** @brief Check whether the specified IRDA interrupt has occurred or not.
  421. * @param __HANDLE__ specifies the IRDA Handle.
  422. * IRDA Handle selects the USARTx or UARTy peripheral
  423. * (USART,UART availability and x,y values depending on device).
  424. * @param __IT__ specifies the IRDA interrupt source to check.
  425. * This parameter can be one of the following values:
  426. * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt
  427. * @arg IRDA_IT_TC: Transmission complete interrupt
  428. * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt
  429. * @arg IRDA_IT_IDLE: Idle line detection interrupt
  430. * @arg IRDA_IT_ERR: Error interrupt
  431. * @arg IRDA_IT_PE: Parity Error interrupt
  432. * @retval The new state of __IT__ (TRUE or FALSE).
  433. */
  434. #define __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28U) == IRDA_CR1_REG_INDEX)? (__HANDLE__)->Instance->CR1:(((((uint32_t)(__IT__)) >> 28U) == IRDA_CR2_REG_INDEX)? \
  435. (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & (((uint32_t)(__IT__)) & IRDA_IT_MASK))
  436. /** @brief Macro to enable the IRDA's one bit sample method
  437. * @param __HANDLE__ specifies the IRDA Handle.
  438. * @retval None
  439. */
  440. #define __HAL_IRDA_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 |= USART_CR3_ONEBIT)
  441. /** @brief Macro to disable the IRDA's one bit sample method
  442. * @param __HANDLE__ specifies the IRDA Handle.
  443. * @retval None
  444. */
  445. #define __HAL_IRDA_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= (uint16_t)~((uint16_t)USART_CR3_ONEBIT))
  446. /** @brief Enable UART/USART associated to IRDA Handle
  447. * @param __HANDLE__ specifies the IRDA Handle.
  448. * IRDA Handle selects the USARTx or UARTy peripheral
  449. * (USART,UART availability and x,y values depending on device).
  450. * @retval None
  451. */
  452. #define __HAL_IRDA_ENABLE(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->CR1, USART_CR1_UE))
  453. /** @brief Disable UART/USART associated to IRDA Handle
  454. * @param __HANDLE__ specifies the IRDA Handle.
  455. * IRDA Handle selects the USARTx or UARTy peripheral
  456. * (USART,UART availability and x,y values depending on device).
  457. * @retval None
  458. */
  459. #define __HAL_IRDA_DISABLE(__HANDLE__) (CLEAR_BIT((__HANDLE__)->Instance->CR1, USART_CR1_UE))
  460. /**
  461. * @}
  462. */
  463. /* Exported functions --------------------------------------------------------*/
  464. /** @addtogroup IRDA_Exported_Functions
  465. * @{
  466. */
  467. /** @addtogroup IRDA_Exported_Functions_Group1
  468. * @{
  469. */
  470. /* Initialization/de-initialization functions **********************************/
  471. HAL_StatusTypeDef HAL_IRDA_Init(IRDA_HandleTypeDef *hirda);
  472. HAL_StatusTypeDef HAL_IRDA_DeInit(IRDA_HandleTypeDef *hirda);
  473. void HAL_IRDA_MspInit(IRDA_HandleTypeDef *hirda);
  474. void HAL_IRDA_MspDeInit(IRDA_HandleTypeDef *hirda);
  475. #if (USE_HAL_IRDA_REGISTER_CALLBACKS == 1)
  476. /* Callbacks Register/UnRegister functions ***********************************/
  477. HAL_StatusTypeDef HAL_IRDA_RegisterCallback(IRDA_HandleTypeDef *hirda, HAL_IRDA_CallbackIDTypeDef CallbackID, pIRDA_CallbackTypeDef pCallback);
  478. HAL_StatusTypeDef HAL_IRDA_UnRegisterCallback(IRDA_HandleTypeDef *hirda, HAL_IRDA_CallbackIDTypeDef CallbackID);
  479. #endif /* USE_HAL_IRDA_REGISTER_CALLBACKS */
  480. /**
  481. * @}
  482. */
  483. /** @addtogroup IRDA_Exported_Functions_Group2
  484. * @{
  485. */
  486. /* IO operation functions *******************************************************/
  487. HAL_StatusTypeDef HAL_IRDA_Transmit(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  488. HAL_StatusTypeDef HAL_IRDA_Receive(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  489. HAL_StatusTypeDef HAL_IRDA_Transmit_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
  490. HAL_StatusTypeDef HAL_IRDA_Receive_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
  491. HAL_StatusTypeDef HAL_IRDA_Transmit_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
  492. HAL_StatusTypeDef HAL_IRDA_Receive_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
  493. HAL_StatusTypeDef HAL_IRDA_DMAPause(IRDA_HandleTypeDef *hirda);
  494. HAL_StatusTypeDef HAL_IRDA_DMAResume(IRDA_HandleTypeDef *hirda);
  495. HAL_StatusTypeDef HAL_IRDA_DMAStop(IRDA_HandleTypeDef *hirda);
  496. /* Transfer Abort functions */
  497. HAL_StatusTypeDef HAL_IRDA_Abort(IRDA_HandleTypeDef *hirda);
  498. HAL_StatusTypeDef HAL_IRDA_AbortTransmit(IRDA_HandleTypeDef *hirda);
  499. HAL_StatusTypeDef HAL_IRDA_AbortReceive(IRDA_HandleTypeDef *hirda);
  500. HAL_StatusTypeDef HAL_IRDA_Abort_IT(IRDA_HandleTypeDef *hirda);
  501. HAL_StatusTypeDef HAL_IRDA_AbortTransmit_IT(IRDA_HandleTypeDef *hirda);
  502. HAL_StatusTypeDef HAL_IRDA_AbortReceive_IT(IRDA_HandleTypeDef *hirda);
  503. void HAL_IRDA_IRQHandler(IRDA_HandleTypeDef *hirda);
  504. void HAL_IRDA_TxCpltCallback(IRDA_HandleTypeDef *hirda);
  505. void HAL_IRDA_RxCpltCallback(IRDA_HandleTypeDef *hirda);
  506. void HAL_IRDA_TxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
  507. void HAL_IRDA_RxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
  508. void HAL_IRDA_ErrorCallback(IRDA_HandleTypeDef *hirda);
  509. void HAL_IRDA_AbortCpltCallback(IRDA_HandleTypeDef *hirda);
  510. void HAL_IRDA_AbortTransmitCpltCallback(IRDA_HandleTypeDef *hirda);
  511. void HAL_IRDA_AbortReceiveCpltCallback(IRDA_HandleTypeDef *hirda);
  512. /**
  513. * @}
  514. */
  515. /** @addtogroup IRDA_Exported_Functions_Group3
  516. * @{
  517. */
  518. /* Peripheral State functions **************************************************/
  519. HAL_IRDA_StateTypeDef HAL_IRDA_GetState(IRDA_HandleTypeDef *hirda);
  520. uint32_t HAL_IRDA_GetError(IRDA_HandleTypeDef *hirda);
  521. /**
  522. * @}
  523. */
  524. /**
  525. * @}
  526. */
  527. /* Private types -------------------------------------------------------------*/
  528. /* Private variables ---------------------------------------------------------*/
  529. /* Private constants ---------------------------------------------------------*/
  530. /** @defgroup IRDA_Private_Constants IRDA Private Constants
  531. * @{
  532. */
  533. /** @brief IRDA interruptions flag mask
  534. *
  535. */
  536. #define IRDA_IT_MASK ((uint32_t) USART_CR1_PEIE | USART_CR1_TXEIE | USART_CR1_TCIE | USART_CR1_RXNEIE | \
  537. USART_CR1_IDLEIE | USART_CR2_LBDIE | USART_CR3_CTSIE | USART_CR3_EIE )
  538. #define IRDA_CR1_REG_INDEX 1U
  539. #define IRDA_CR2_REG_INDEX 2U
  540. #define IRDA_CR3_REG_INDEX 3U
  541. /**
  542. * @}
  543. */
  544. /* Private macros --------------------------------------------------------*/
  545. /** @defgroup IRDA_Private_Macros IRDA Private Macros
  546. * @{
  547. */
  548. #define IS_IRDA_WORD_LENGTH(LENGTH) (((LENGTH) == IRDA_WORDLENGTH_8B) || \
  549. ((LENGTH) == IRDA_WORDLENGTH_9B))
  550. #define IS_IRDA_PARITY(PARITY) (((PARITY) == IRDA_PARITY_NONE) || \
  551. ((PARITY) == IRDA_PARITY_EVEN) || \
  552. ((PARITY) == IRDA_PARITY_ODD))
  553. #define IS_IRDA_MODE(MODE) ((((MODE) & 0x0000FFF3U) == 0x00U) && ((MODE) != 0x00000000U))
  554. #define IS_IRDA_POWERMODE(MODE) (((MODE) == IRDA_POWERMODE_LOWPOWER) || \
  555. ((MODE) == IRDA_POWERMODE_NORMAL))
  556. #define IS_IRDA_BAUDRATE(BAUDRATE) ((BAUDRATE) < 115201U)
  557. #define IRDA_DIV(_PCLK_, _BAUD_) (((_PCLK_)*25U)/(4U*(_BAUD_)))
  558. #define IRDA_DIVMANT(_PCLK_, _BAUD_) (IRDA_DIV((_PCLK_), (_BAUD_))/100U)
  559. #define IRDA_DIVFRAQ(_PCLK_, _BAUD_) (((IRDA_DIV((_PCLK_), (_BAUD_)) - (IRDA_DIVMANT((_PCLK_), (_BAUD_)) * 100U)) * 16U + 50U) / 100U)
  560. /* UART BRR = mantissa + overflow + fraction
  561. = (UART DIVMANT << 4) + (UART DIVFRAQ & 0xF0) + (UART DIVFRAQ & 0x0FU) */
  562. #define IRDA_BRR(_PCLK_, _BAUD_) (((IRDA_DIVMANT((_PCLK_), (_BAUD_)) << 4U) + \
  563. (IRDA_DIVFRAQ((_PCLK_), (_BAUD_)) & 0xF0U)) + \
  564. (IRDA_DIVFRAQ((_PCLK_), (_BAUD_)) & 0x0FU))
  565. /**
  566. * @}
  567. */
  568. /* Private functions ---------------------------------------------------------*/
  569. /** @defgroup IRDA_Private_Functions IRDA Private Functions
  570. * @{
  571. */
  572. /**
  573. * @}
  574. */
  575. /**
  576. * @}
  577. */
  578. /**
  579. * @}
  580. */
  581. #ifdef __cplusplus
  582. }
  583. #endif
  584. #endif /* __STM32L1xx_HAL_IRDA_H */
  585. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/