stm32f1xx_hal_irda.h 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559
  1. /**
  2. ******************************************************************************
  3. * @file stm32f1xx_hal_irda.h
  4. * @author MCD Application Team
  5. * @version V1.0.4
  6. * @date 29-April-2016
  7. * @brief Header file of IRDA HAL module.
  8. ******************************************************************************
  9. * @attention
  10. *
  11. * <h2><center>&copy; COPYRIGHT(c) 2016 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 __STM32F1xx_HAL_IRDA_H
  39. #define __STM32F1xx_HAL_IRDA_H
  40. #ifdef __cplusplus
  41. extern "C" {
  42. #endif
  43. /* Includes ------------------------------------------------------------------*/
  44. #include "stm32f1xx_hal_def.h"
  45. /** @addtogroup STM32F1xx_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 is computed using the following formula:
  62. - IntegerDivider = ((PCLKx) / (16 * (hirda->Init.BaudRate)))
  63. - FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 16) + 0.5 */
  64. uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
  65. This parameter can be a value of @ref IRDA_Word_Length */
  66. uint32_t Parity; /*!< Specifies the parity mode.
  67. This parameter can be a value of @ref IRDA_Parity
  68. @note When parity is enabled, the computed parity is inserted
  69. at the MSB position of the transmitted data (9th bit when
  70. the word length is set to 9 data bits; 8th bit when the
  71. word length is set to 8 data bits). */
  72. uint32_t Mode; /*!< Specifies wether the Receive or Transmit mode is enabled or disabled.
  73. This parameter can be a value of @ref IRDA_Transfer_Mode */
  74. uint8_t Prescaler; /*!< Specifies the Prescaler value prescaler value to be programmed
  75. in the IrDA low-power Baud Register, for defining pulse width on which
  76. burst acceptance/rejection will be decided. This value is used as divisor
  77. of system clock to achieve required pulse width. */
  78. uint32_t IrDAMode; /*!< Specifies the IrDA mode
  79. This parameter can be a value of @ref IRDA_Low_Power */
  80. }IRDA_InitTypeDef;
  81. /**
  82. * @brief HAL IRDA State structures definition
  83. */
  84. typedef enum
  85. {
  86. HAL_IRDA_STATE_RESET = 0x00, /*!< Peripheral is not initialized */
  87. HAL_IRDA_STATE_READY = 0x01, /*!< Peripheral Initialized and ready for use */
  88. HAL_IRDA_STATE_BUSY = 0x02, /*!< an internal process is ongoing */
  89. HAL_IRDA_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */
  90. HAL_IRDA_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */
  91. HAL_IRDA_STATE_BUSY_TX_RX = 0x32, /*!< Data Transmission and Reception process is ongoing */
  92. HAL_IRDA_STATE_TIMEOUT = 0x03, /*!< Timeout state */
  93. HAL_IRDA_STATE_ERROR = 0x04 /*!< Error */
  94. }HAL_IRDA_StateTypeDef;
  95. /**
  96. * @brief IRDA handle Structure definition
  97. */
  98. typedef struct
  99. {
  100. USART_TypeDef *Instance; /*!< USART registers base address */
  101. IRDA_InitTypeDef Init; /*!< IRDA communication parameters */
  102. uint8_t *pTxBuffPtr; /*!< Pointer to IRDA Tx transfer Buffer */
  103. uint16_t TxXferSize; /*!< IRDA Tx Transfer size */
  104. uint16_t TxXferCount; /*!< IRDA Tx Transfer Counter */
  105. uint8_t *pRxBuffPtr; /*!< Pointer to IRDA Rx transfer Buffer */
  106. uint16_t RxXferSize; /*!< IRDA Rx Transfer size */
  107. uint16_t RxXferCount; /*!< IRDA Rx Transfer Counter */
  108. DMA_HandleTypeDef *hdmatx; /*!< IRDA Tx DMA Handle parameters */
  109. DMA_HandleTypeDef *hdmarx; /*!< IRDA Rx DMA Handle parameters */
  110. HAL_LockTypeDef Lock; /*!< Locking object */
  111. __IO HAL_IRDA_StateTypeDef State; /*!< IRDA communication state */
  112. __IO uint32_t ErrorCode; /*!< IRDA Error code */
  113. }IRDA_HandleTypeDef;
  114. /**
  115. * @}
  116. */
  117. /* Exported constants --------------------------------------------------------*/
  118. /** @defgroup IRDA_Exported_Constants IRDA Exported constants
  119. * @{
  120. */
  121. /** @defgroup IRDA_Error_Codes IRDA Error Codes
  122. * @{
  123. */
  124. #define HAL_IRDA_ERROR_NONE ((uint32_t)0x00) /*!< No error */
  125. #define HAL_IRDA_ERROR_PE ((uint32_t)0x01) /*!< Parity error */
  126. #define HAL_IRDA_ERROR_NE ((uint32_t)0x02) /*!< Noise error */
  127. #define HAL_IRDA_ERROR_FE ((uint32_t)0x04) /*!< frame error */
  128. #define HAL_IRDA_ERROR_ORE ((uint32_t)0x08) /*!< Overrun error */
  129. #define HAL_IRDA_ERROR_DMA ((uint32_t)0x10) /*!< DMA transfer error */
  130. /**
  131. * @}
  132. */
  133. /** @defgroup IRDA_Word_Length IRDA Word Length
  134. * @{
  135. */
  136. #define IRDA_WORDLENGTH_8B ((uint32_t)0x00000000)
  137. #define IRDA_WORDLENGTH_9B ((uint32_t)USART_CR1_M)
  138. /**
  139. * @}
  140. */
  141. /** @defgroup IRDA_Parity IRDA Parity
  142. * @{
  143. */
  144. #define IRDA_PARITY_NONE ((uint32_t)0x00000000)
  145. #define IRDA_PARITY_EVEN ((uint32_t)USART_CR1_PCE)
  146. #define IRDA_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
  147. /**
  148. * @}
  149. */
  150. /** @defgroup IRDA_Transfer_Mode IRDA Transfer Mode
  151. * @{
  152. */
  153. #define IRDA_MODE_RX ((uint32_t)USART_CR1_RE)
  154. #define IRDA_MODE_TX ((uint32_t)USART_CR1_TE)
  155. #define IRDA_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE))
  156. /**
  157. * @}
  158. */
  159. /** @defgroup IRDA_Low_Power IRDA Low Power
  160. * @{
  161. */
  162. #define IRDA_POWERMODE_LOWPOWER ((uint32_t)USART_CR3_IRLP)
  163. #define IRDA_POWERMODE_NORMAL ((uint32_t)0x00000000)
  164. /**
  165. * @}
  166. */
  167. /** @defgroup IRDA_Flags IRDA Flags
  168. * Elements values convention: 0xXXXX
  169. * - 0xXXXX : Flag mask in the SR register
  170. * @{
  171. */
  172. #define IRDA_FLAG_TXE ((uint32_t)USART_SR_TXE)
  173. #define IRDA_FLAG_TC ((uint32_t)USART_SR_TC)
  174. #define IRDA_FLAG_RXNE ((uint32_t)USART_SR_RXNE)
  175. #define IRDA_FLAG_IDLE ((uint32_t)USART_SR_IDLE)
  176. #define IRDA_FLAG_ORE ((uint32_t)USART_SR_ORE)
  177. #define IRDA_FLAG_NE ((uint32_t)USART_SR_NE)
  178. #define IRDA_FLAG_FE ((uint32_t)USART_SR_FE)
  179. #define IRDA_FLAG_PE ((uint32_t)USART_SR_PE)
  180. /**
  181. * @}
  182. */
  183. /** @defgroup IRDA_Interrupt_definition IRDA Interrupt Definitions
  184. * Elements values convention: 0xY000XXXX
  185. * - XXXX : Interrupt mask (16 bits) in the Y register
  186. * - Y : Interrupt source register (4 bits)
  187. * - 0001: CR1 register
  188. * - 0010: CR2 register
  189. * - 0011: CR3 register
  190. *
  191. * @{
  192. */
  193. #define IRDA_IT_PE ((uint32_t)(IRDA_CR1_REG_INDEX << 28 | USART_CR1_PEIE))
  194. #define IRDA_IT_TXE ((uint32_t)(IRDA_CR1_REG_INDEX << 28 | USART_CR1_TXEIE))
  195. #define IRDA_IT_TC ((uint32_t)(IRDA_CR1_REG_INDEX << 28 | USART_CR1_TCIE))
  196. #define IRDA_IT_RXNE ((uint32_t)(IRDA_CR1_REG_INDEX << 28 | USART_CR1_RXNEIE))
  197. #define IRDA_IT_IDLE ((uint32_t)(IRDA_CR1_REG_INDEX << 28 | USART_CR1_IDLEIE))
  198. #define IRDA_IT_LBD ((uint32_t)(IRDA_CR2_REG_INDEX << 28 | USART_CR2_LBDIE))
  199. #define IRDA_IT_CTS ((uint32_t)(IRDA_CR3_REG_INDEX << 28 | USART_CR3_CTSIE))
  200. #define IRDA_IT_ERR ((uint32_t)(IRDA_CR3_REG_INDEX << 28 | USART_CR3_EIE))
  201. /**
  202. * @}
  203. */
  204. /**
  205. * @}
  206. */
  207. /* Exported macro ------------------------------------------------------------*/
  208. /** @defgroup IRDA_Exported_Macros IRDA Exported Macros
  209. * @{
  210. */
  211. /** @brief Reset IRDA handle state
  212. * @param __HANDLE__: specifies the IRDA Handle.
  213. * IRDA Handle selects the USARTx or UARTy peripheral
  214. * (USART,UART availability and x,y values depending on device).
  215. * @retval None
  216. */
  217. #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_IRDA_STATE_RESET)
  218. /** @brief Flush the IRDA DR register
  219. * @param __HANDLE__: specifies the USART Handle.
  220. * IRDA Handle selects the USARTx or UARTy peripheral
  221. * (USART,UART availability and x,y values depending on device).
  222. */
  223. #define __HAL_IRDA_FLUSH_DRREGISTER(__HANDLE__) ((__HANDLE__)->Instance->DR)
  224. /** @brief Check whether the specified IRDA flag is set or not.
  225. * @param __HANDLE__: specifies the IRDA Handle.
  226. * IRDA Handle selects the USARTx or UARTy peripheral
  227. * (USART,UART availability and x,y values depending on device).
  228. * @param __FLAG__: specifies the flag to check.
  229. * This parameter can be one of the following values:
  230. * @arg IRDA_FLAG_TXE: Transmit data register empty flag
  231. * @arg IRDA_FLAG_TC: Transmission Complete flag
  232. * @arg IRDA_FLAG_RXNE: Receive data register not empty flag
  233. * @arg IRDA_FLAG_IDLE: Idle Line detection flag
  234. * @arg IRDA_FLAG_ORE: OverRun Error flag
  235. * @arg IRDA_FLAG_NE: Noise Error flag
  236. * @arg IRDA_FLAG_FE: Framing Error flag
  237. * @arg IRDA_FLAG_PE: Parity Error flag
  238. * @retval The new state of __FLAG__ (TRUE or FALSE).
  239. */
  240. #define __HAL_IRDA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
  241. /** @brief Clear the specified IRDA pending flag.
  242. * @param __HANDLE__: specifies the IRDA Handle.
  243. * IRDA Handle selects the USARTx or UARTy peripheral
  244. * (USART,UART availability and x,y values depending on device).
  245. * @param __FLAG__: specifies the flag to check.
  246. * This parameter can be any combination of the following values:
  247. * @arg IRDA_FLAG_TC: Transmission Complete flag.
  248. * @arg IRDA_FLAG_RXNE: Receive data register not empty flag.
  249. *
  250. * @note PE (Parity error), FE (Framing error), NE (Noise error), ORE (OverRun
  251. * error) and IDLE (Idle line detected) flags are cleared by software
  252. * sequence: a read operation to USART_SR register followed by a read
  253. * operation to USART_DR register.
  254. * @note RXNE flag can be also cleared by a read to the USART_DR register.
  255. * @note TC flag can be also cleared by software sequence: a read operation to
  256. * USART_SR register followed by a write operation to USART_DR register.
  257. * @note TXE flag is cleared only by a write to the USART_DR register.
  258. *
  259. * @retval None
  260. */
  261. #define __HAL_IRDA_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR = ~(__FLAG__))
  262. /** @brief Clear the IRDA PE pending flag.
  263. * @param __HANDLE__: specifies the IRDA Handle.
  264. * IRDA Handle selects the USARTx or UARTy peripheral
  265. * (USART,UART availability and x,y values depending on device).
  266. * @retval None
  267. */
  268. #define __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__) \
  269. do{ \
  270. __IO uint32_t tmpreg; \
  271. tmpreg = (__HANDLE__)->Instance->SR; \
  272. tmpreg = (__HANDLE__)->Instance->DR; \
  273. UNUSED(tmpreg); \
  274. }while(0) \
  275. /** @brief Clear the IRDA FE pending flag.
  276. * @param __HANDLE__: specifies the IRDA Handle.
  277. * IRDA Handle selects the USARTx or UARTy peripheral
  278. * (USART,UART availability and x,y values depending on device).
  279. * @retval None
  280. */
  281. #define __HAL_IRDA_CLEAR_FEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
  282. /** @brief Clear the IRDA NE pending flag.
  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. #define __HAL_IRDA_CLEAR_NEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
  289. /** @brief Clear the IRDA ORE pending flag.
  290. * @param __HANDLE__: specifies the IRDA Handle.
  291. * IRDA Handle selects the USARTx or UARTy peripheral
  292. * (USART,UART availability and x,y values depending on device).
  293. * @retval None
  294. */
  295. #define __HAL_IRDA_CLEAR_OREFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
  296. /** @brief Clear the IRDA IDLE pending flag.
  297. * @param __HANDLE__: specifies the IRDA Handle.
  298. * IRDA Handle selects the USARTx or UARTy peripheral
  299. * (USART,UART availability and x,y values depending on device).
  300. * @retval None
  301. */
  302. #define __HAL_IRDA_CLEAR_IDLEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
  303. /** @brief Enable the specified IRDA interrupt.
  304. * @param __HANDLE__: specifies the IRDA Handle.
  305. * IRDA Handle selects the USARTx or UARTy peripheral
  306. * (USART,UART availability and x,y values depending on device).
  307. * @param __INTERRUPT__: specifies the IRDA interrupt source to enable.
  308. * This parameter can be one of the following values:
  309. * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt
  310. * @arg IRDA_IT_TC: Transmission complete interrupt
  311. * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt
  312. * @arg IRDA_IT_IDLE: Idle line detection interrupt
  313. * @arg IRDA_IT_PE: Parity Error interrupt
  314. * @arg IRDA_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
  315. * @retval None
  316. */
  317. #define __HAL_IRDA_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == IRDA_CR1_REG_INDEX)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & IRDA_IT_MASK)): \
  318. (((__INTERRUPT__) >> 28) == IRDA_CR2_REG_INDEX)? ((__HANDLE__)->Instance->CR2 |= ((__INTERRUPT__) & IRDA_IT_MASK)): \
  319. ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & IRDA_IT_MASK)))
  320. /** @brief Disable the specified IRDA interrupt.
  321. * @param __HANDLE__: specifies the IRDA Handle.
  322. * IRDA Handle selects the USARTx or UARTy peripheral
  323. * (USART,UART availability and x,y values depending on device).
  324. * @param __INTERRUPT__: specifies the IRDA interrupt source to disable.
  325. * This parameter can be one of the following values:
  326. * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt
  327. * @arg IRDA_IT_TC: Transmission complete interrupt
  328. * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt
  329. * @arg IRDA_IT_IDLE: Idle line detection interrupt
  330. * @arg IRDA_IT_PE: Parity Error interrupt
  331. * @arg IRDA_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
  332. * @retval None
  333. */
  334. #define __HAL_IRDA_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == IRDA_CR1_REG_INDEX)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & IRDA_IT_MASK)): \
  335. (((__INTERRUPT__) >> 28) == IRDA_CR2_REG_INDEX)? ((__HANDLE__)->Instance->CR2 &= ~((__INTERRUPT__) & IRDA_IT_MASK)): \
  336. ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & IRDA_IT_MASK)))
  337. /** @brief Check whether the specified IRDA interrupt has occurred or not.
  338. * @param __HANDLE__: specifies the IRDA Handle.
  339. * IRDA Handle selects the USARTx or UARTy peripheral
  340. * (USART,UART availability and x,y values depending on device).
  341. * @param __IT__: specifies the IRDA interrupt source to check.
  342. * This parameter can be one of the following values:
  343. * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt
  344. * @arg IRDA_IT_TC: Transmission complete interrupt
  345. * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt
  346. * @arg IRDA_IT_IDLE: Idle line detection interrupt
  347. * @arg IRDA_IT_ERR: Error interrupt
  348. * @arg IRDA_IT_PE: Parity Error interrupt
  349. * @retval The new state of __IT__ (TRUE or FALSE).
  350. */
  351. #define __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28) == IRDA_CR1_REG_INDEX)? (__HANDLE__)->Instance->CR1:((((__IT__) >> 28) == IRDA_CR2_REG_INDEX)? \
  352. (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & (((uint32_t)(__IT__)) & IRDA_IT_MASK))
  353. /** @brief Enable UART/USART associated to IRDA Handle
  354. * @param __HANDLE__: specifies the IRDA Handle.
  355. * IRDA Handle selects the USARTx or UARTy peripheral
  356. * (USART,UART availability and x,y values depending on device).
  357. * @retval None
  358. */
  359. #define __HAL_IRDA_ENABLE(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->CR1, USART_CR1_UE))
  360. /** @brief Disable UART/USART associated to IRDA Handle
  361. * @param __HANDLE__: specifies the IRDA Handle.
  362. * IRDA Handle selects the USARTx or UARTy peripheral
  363. * (USART,UART availability and x,y values depending on device).
  364. * @retval None
  365. */
  366. #define __HAL_IRDA_DISABLE(__HANDLE__) (CLEAR_BIT((__HANDLE__)->Instance->CR1, USART_CR1_UE))
  367. /**
  368. * @}
  369. */
  370. /* Private macros --------------------------------------------------------*/
  371. /** @defgroup IRDA_Private_Macros IRDA Private Macros
  372. * @{
  373. */
  374. #define IRDA_CR1_REG_INDEX 1
  375. #define IRDA_CR2_REG_INDEX 2
  376. #define IRDA_CR3_REG_INDEX 3
  377. #define IRDA_DIV(__PCLK__, __BAUD__) (((__PCLK__)*25)/(4*(__BAUD__)))
  378. #define IRDA_DIVMANT(__PCLK__, __BAUD__) (IRDA_DIV((__PCLK__), (__BAUD__))/100)
  379. #define IRDA_DIVFRAQ(__PCLK__, __BAUD__) (((IRDA_DIV((__PCLK__), (__BAUD__)) - (IRDA_DIVMANT((__PCLK__), (__BAUD__)) * 100)) * 16 + 50) / 100)
  380. /* UART BRR = mantissa + overflow + fraction
  381. = (UART DIVMANT << 4) + (UART DIVFRAQ & 0xF0) + (UART DIVFRAQ & 0x0F) */
  382. #define IRDA_BRR(_PCLK_, _BAUD_) (((IRDA_DIVMANT((_PCLK_), (_BAUD_)) << 4) + \
  383. (IRDA_DIVFRAQ((_PCLK_), (_BAUD_)) & 0xF0)) + \
  384. (IRDA_DIVFRAQ((_PCLK_), (_BAUD_)) & 0x0F))
  385. /** Ensure that IRDA Baud rate is less or equal to maximum value
  386. * __BAUDRATE__: specifies the IRDA Baudrate set by the user.
  387. * The maximum Baud Rate is 115200bps
  388. * Returns : True or False
  389. */
  390. #define IS_IRDA_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 115201)
  391. #define IS_IRDA_WORD_LENGTH(LENGTH) (((LENGTH) == IRDA_WORDLENGTH_8B) || \
  392. ((LENGTH) == IRDA_WORDLENGTH_9B))
  393. #define IS_IRDA_PARITY(PARITY) (((PARITY) == IRDA_PARITY_NONE) || \
  394. ((PARITY) == IRDA_PARITY_EVEN) || \
  395. ((PARITY) == IRDA_PARITY_ODD))
  396. #define IS_IRDA_MODE(MODE) ((((MODE) & (~((uint32_t)IRDA_MODE_TX_RX))) == 0x00) && \
  397. ((MODE) != (uint32_t)0x00000000))
  398. #define IS_IRDA_POWERMODE(MODE) (((MODE) == IRDA_POWERMODE_LOWPOWER) || \
  399. ((MODE) == IRDA_POWERMODE_NORMAL))
  400. /** IRDA interruptions flag mask
  401. *
  402. */
  403. #define IRDA_IT_MASK ((uint32_t) USART_CR1_PEIE | USART_CR1_TXEIE | USART_CR1_TCIE | USART_CR1_RXNEIE | \
  404. USART_CR1_IDLEIE | USART_CR2_LBDIE | USART_CR3_CTSIE | USART_CR3_EIE )
  405. /**
  406. * @}
  407. */
  408. /* Exported functions --------------------------------------------------------*/
  409. /** @addtogroup IRDA_Exported_Functions IRDA Exported Functions
  410. * @{
  411. */
  412. /** @addtogroup IRDA_Exported_Functions_Group1 Initialization and de-initialization functions
  413. * @{
  414. */
  415. /* Initialization and de-initialization functions ****************************/
  416. HAL_StatusTypeDef HAL_IRDA_Init(IRDA_HandleTypeDef *hirda);
  417. HAL_StatusTypeDef HAL_IRDA_DeInit(IRDA_HandleTypeDef *hirda);
  418. void HAL_IRDA_MspInit(IRDA_HandleTypeDef *hirda);
  419. void HAL_IRDA_MspDeInit(IRDA_HandleTypeDef *hirda);
  420. /**
  421. * @}
  422. */
  423. /** @addtogroup IRDA_Exported_Functions_Group2 IO operation functions
  424. * @{
  425. */
  426. /* IO operation functions *****************************************************/
  427. HAL_StatusTypeDef HAL_IRDA_Transmit(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  428. HAL_StatusTypeDef HAL_IRDA_Receive(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  429. HAL_StatusTypeDef HAL_IRDA_Transmit_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
  430. HAL_StatusTypeDef HAL_IRDA_Receive_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
  431. HAL_StatusTypeDef HAL_IRDA_Transmit_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
  432. HAL_StatusTypeDef HAL_IRDA_Receive_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
  433. HAL_StatusTypeDef HAL_IRDA_DMAPause(IRDA_HandleTypeDef *hirda);
  434. HAL_StatusTypeDef HAL_IRDA_DMAResume(IRDA_HandleTypeDef *hirda);
  435. HAL_StatusTypeDef HAL_IRDA_DMAStop(IRDA_HandleTypeDef *hirda);
  436. void HAL_IRDA_IRQHandler(IRDA_HandleTypeDef *hirda);
  437. void HAL_IRDA_TxCpltCallback(IRDA_HandleTypeDef *hirda);
  438. void HAL_IRDA_RxCpltCallback(IRDA_HandleTypeDef *hirda);
  439. void HAL_IRDA_TxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
  440. void HAL_IRDA_RxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
  441. void HAL_IRDA_ErrorCallback(IRDA_HandleTypeDef *hirda);
  442. /**
  443. * @}
  444. */
  445. /** @addtogroup IRDA_Exported_Functions_Group3 Peripheral State and Errors functions
  446. * @{
  447. */
  448. /* Peripheral State and Error functions ***************************************/
  449. HAL_IRDA_StateTypeDef HAL_IRDA_GetState(IRDA_HandleTypeDef *hirda);
  450. uint32_t HAL_IRDA_GetError(IRDA_HandleTypeDef *hirda);
  451. /**
  452. * @}
  453. */
  454. /**
  455. * @}
  456. */
  457. /**
  458. * @}
  459. */
  460. /**
  461. * @}
  462. */
  463. #ifdef __cplusplus
  464. }
  465. #endif
  466. #endif /* __STM32F1xx_HAL_IRDA_H */
  467. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/