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.
 
 
 

430 lines
23 KiB

  1. /**
  2. ******************************************************************************
  3. * @file stm32f0xx_hal_irda_ex.h
  4. * @author MCD Application Team
  5. * @brief Header file of IRDA HAL Extended module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
  10. *
  11. * Redistribution and use in source and binary forms, with or without modification,
  12. * are permitted provided that the following conditions are met:
  13. * 1. Redistributions of source code must retain the above copyright notice,
  14. * this list of conditions and the following disclaimer.
  15. * 2. Redistributions in binary form must reproduce the above copyright notice,
  16. * this list of conditions and the following disclaimer in the documentation
  17. * and/or other materials provided with the distribution.
  18. * 3. Neither the name of STMicroelectronics nor the names of its contributors
  19. * may be used to endorse or promote products derived from this software
  20. * without specific prior written permission.
  21. *
  22. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  25. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  26. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  28. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  29. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32. *
  33. ******************************************************************************
  34. */
  35. /* Define to prevent recursive inclusion -------------------------------------*/
  36. #ifndef __STM32F0xx_HAL_IRDA_EX_H
  37. #define __STM32F0xx_HAL_IRDA_EX_H
  38. #ifdef __cplusplus
  39. extern "C" {
  40. #endif
  41. #if !defined(STM32F030x6) && !defined(STM32F030x8) && !defined(STM32F070x6) && !defined(STM32F070xB) && !defined(STM32F030xC)
  42. /* Includes ------------------------------------------------------------------*/
  43. #include "stm32f0xx_hal_def.h"
  44. /** @addtogroup STM32F0xx_HAL_Driver
  45. * @{
  46. */
  47. /** @addtogroup IRDAEx
  48. * @{
  49. */
  50. /* Exported types ------------------------------------------------------------*/
  51. /* Exported constants --------------------------------------------------------*/
  52. /** @defgroup IRDAEx_Exported_Constants IRDAEx Exported Constants
  53. * @{
  54. */
  55. /** @defgroup IRDAEx_Word_Length IRDA Word Length
  56. * @{
  57. */
  58. #if defined (STM32F042x6) || defined (STM32F048xx) || \
  59. defined (STM32F071xB) || defined (STM32F072xB) || defined (STM32F078xx) || \
  60. defined (STM32F091xC) || defined (STM32F098xx)
  61. #define IRDA_WORDLENGTH_7B ((uint32_t)USART_CR1_M1) /*!< 7-bit long frame */
  62. #define IRDA_WORDLENGTH_8B (0x00000000U) /*!< 8-bit long frame */
  63. #define IRDA_WORDLENGTH_9B ((uint32_t)USART_CR1_M0) /*!< 9-bit long frame */
  64. #else
  65. #define IRDA_WORDLENGTH_8B (0x00000000U) /*!< 8-bit long frame */
  66. #define IRDA_WORDLENGTH_9B ((uint32_t)USART_CR1_M) /*!< 9-bit long frame */
  67. #endif /* defined (STM32F042x6) || defined (STM32F048xx) || \
  68. defined (STM32F071xB) || defined (STM32F072xB) || defined (STM32F078xx) || \
  69. defined (STM32F091xC) || defined (STM32F098xx)*/
  70. /**
  71. * @}
  72. */
  73. /**
  74. * @}
  75. */
  76. /* Exported macros -----------------------------------------------------------*/
  77. /* Exported functions --------------------------------------------------------*/
  78. /* Private macros ------------------------------------------------------------*/
  79. /** @defgroup IRDAEx_Private_Macros IRDAEx Private Macros
  80. * @{
  81. */
  82. /** @brief Report the IRDA clock source.
  83. * @param __HANDLE__ specifies the IRDA Handle.
  84. * @param __CLOCKSOURCE__ output variable.
  85. * @retval IRDA clocking source, written in __CLOCKSOURCE__.
  86. */
  87. #if defined(STM32F031x6) || defined(STM32F038xx)
  88. #define IRDA_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
  89. do { \
  90. switch(__HAL_RCC_GET_USART1_SOURCE()) \
  91. { \
  92. case RCC_USART1CLKSOURCE_PCLK1: \
  93. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
  94. break; \
  95. case RCC_USART1CLKSOURCE_HSI: \
  96. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \
  97. break; \
  98. case RCC_USART1CLKSOURCE_SYSCLK: \
  99. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \
  100. break; \
  101. case RCC_USART1CLKSOURCE_LSE: \
  102. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \
  103. break; \
  104. default: \
  105. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \
  106. break; \
  107. } \
  108. } while(0)
  109. #elif defined (STM32F042x6) || defined (STM32F048xx) || \
  110. defined (STM32F051x8) || defined (STM32F058xx)
  111. #define IRDA_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
  112. do { \
  113. if((__HANDLE__)->Instance == USART1) \
  114. { \
  115. switch(__HAL_RCC_GET_USART1_SOURCE()) \
  116. { \
  117. case RCC_USART1CLKSOURCE_PCLK1: \
  118. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
  119. break; \
  120. case RCC_USART1CLKSOURCE_HSI: \
  121. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \
  122. break; \
  123. case RCC_USART1CLKSOURCE_SYSCLK: \
  124. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \
  125. break; \
  126. case RCC_USART1CLKSOURCE_LSE: \
  127. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \
  128. break; \
  129. default: \
  130. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \
  131. break; \
  132. } \
  133. } \
  134. else if((__HANDLE__)->Instance == USART2) \
  135. { \
  136. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
  137. } \
  138. else \
  139. { \
  140. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \
  141. } \
  142. } while(0)
  143. #elif defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx)
  144. #define IRDA_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
  145. do { \
  146. if((__HANDLE__)->Instance == USART1) \
  147. { \
  148. switch(__HAL_RCC_GET_USART1_SOURCE()) \
  149. { \
  150. case RCC_USART1CLKSOURCE_PCLK1: \
  151. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
  152. break; \
  153. case RCC_USART1CLKSOURCE_HSI: \
  154. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \
  155. break; \
  156. case RCC_USART1CLKSOURCE_SYSCLK: \
  157. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \
  158. break; \
  159. case RCC_USART1CLKSOURCE_LSE: \
  160. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \
  161. break; \
  162. default: \
  163. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \
  164. break; \
  165. } \
  166. } \
  167. else if((__HANDLE__)->Instance == USART2) \
  168. { \
  169. switch(__HAL_RCC_GET_USART2_SOURCE()) \
  170. { \
  171. case RCC_USART2CLKSOURCE_PCLK1: \
  172. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
  173. break; \
  174. case RCC_USART2CLKSOURCE_HSI: \
  175. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \
  176. break; \
  177. case RCC_USART2CLKSOURCE_SYSCLK: \
  178. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \
  179. break; \
  180. case RCC_USART2CLKSOURCE_LSE: \
  181. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \
  182. break; \
  183. default: \
  184. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \
  185. break; \
  186. } \
  187. } \
  188. else if((__HANDLE__)->Instance == USART3) \
  189. { \
  190. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
  191. } \
  192. else if((__HANDLE__)->Instance == USART4) \
  193. { \
  194. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
  195. } \
  196. else \
  197. { \
  198. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \
  199. } \
  200. } while(0)
  201. #elif defined(STM32F091xC) || defined(STM32F098xx)
  202. #define IRDA_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
  203. do { \
  204. if((__HANDLE__)->Instance == USART1) \
  205. { \
  206. switch(__HAL_RCC_GET_USART1_SOURCE()) \
  207. { \
  208. case RCC_USART1CLKSOURCE_PCLK1: \
  209. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
  210. break; \
  211. case RCC_USART1CLKSOURCE_HSI: \
  212. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \
  213. break; \
  214. case RCC_USART1CLKSOURCE_SYSCLK: \
  215. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \
  216. break; \
  217. case RCC_USART1CLKSOURCE_LSE: \
  218. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \
  219. break; \
  220. default: \
  221. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \
  222. break; \
  223. } \
  224. } \
  225. else if((__HANDLE__)->Instance == USART2) \
  226. { \
  227. switch(__HAL_RCC_GET_USART2_SOURCE()) \
  228. { \
  229. case RCC_USART2CLKSOURCE_PCLK1: \
  230. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
  231. break; \
  232. case RCC_USART2CLKSOURCE_HSI: \
  233. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \
  234. break; \
  235. case RCC_USART2CLKSOURCE_SYSCLK: \
  236. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \
  237. break; \
  238. case RCC_USART2CLKSOURCE_LSE: \
  239. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \
  240. break; \
  241. default: \
  242. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \
  243. break; \
  244. } \
  245. } \
  246. else if((__HANDLE__)->Instance == USART3) \
  247. { \
  248. switch(__HAL_RCC_GET_USART3_SOURCE()) \
  249. { \
  250. case RCC_USART3CLKSOURCE_PCLK1: \
  251. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
  252. break; \
  253. case RCC_USART3CLKSOURCE_HSI: \
  254. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_HSI; \
  255. break; \
  256. case RCC_USART3CLKSOURCE_SYSCLK: \
  257. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_SYSCLK; \
  258. break; \
  259. case RCC_USART3CLKSOURCE_LSE: \
  260. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_LSE; \
  261. break; \
  262. default: \
  263. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \
  264. break; \
  265. } \
  266. } \
  267. else if((__HANDLE__)->Instance == USART4) \
  268. { \
  269. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
  270. } \
  271. else if((__HANDLE__)->Instance == USART5) \
  272. { \
  273. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
  274. } \
  275. else if((__HANDLE__)->Instance == USART6) \
  276. { \
  277. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
  278. } \
  279. else if((__HANDLE__)->Instance == USART7) \
  280. { \
  281. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
  282. } \
  283. else if((__HANDLE__)->Instance == USART8) \
  284. { \
  285. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_PCLK1; \
  286. } \
  287. else \
  288. { \
  289. (__CLOCKSOURCE__) = IRDA_CLOCKSOURCE_UNDEFINED; \
  290. } \
  291. } while(0)
  292. #endif /* defined(STM32F031x6) || defined(STM32F038xx) */
  293. /** @brief Compute the mask to apply to retrieve the received data
  294. * according to the word length and to the parity bits activation.
  295. * @note If PCE = 1, the parity bit is not included in the data extracted
  296. * by the reception API().
  297. * This masking operation is not carried out in the case of
  298. * DMA transfers.
  299. * @param __HANDLE__ specifies the IRDA Handle.
  300. * @retval None, the mask to apply to the associated UART RDR register is stored in (__HANDLE__)->Mask field.
  301. */
  302. #if defined (STM32F042x6) || defined (STM32F048xx) || \
  303. defined (STM32F071xB) || defined (STM32F072xB) || defined (STM32F078xx) || \
  304. defined (STM32F091xC) || defined (STM32F098xx)
  305. #define IRDA_MASK_COMPUTATION(__HANDLE__) \
  306. do { \
  307. if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_9B) \
  308. { \
  309. if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \
  310. { \
  311. (__HANDLE__)->Mask = 0x01FFU ; \
  312. } \
  313. else \
  314. { \
  315. (__HANDLE__)->Mask = 0x00FFU ; \
  316. } \
  317. } \
  318. else if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_8B) \
  319. { \
  320. if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \
  321. { \
  322. (__HANDLE__)->Mask = 0x00FFU ; \
  323. } \
  324. else \
  325. { \
  326. (__HANDLE__)->Mask = 0x007FU ; \
  327. } \
  328. } \
  329. else if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_7B) \
  330. { \
  331. if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \
  332. { \
  333. (__HANDLE__)->Mask = 0x007FU ; \
  334. } \
  335. else \
  336. { \
  337. (__HANDLE__)->Mask = 0x003FU ; \
  338. } \
  339. } \
  340. } while(0)
  341. #else
  342. #define IRDA_MASK_COMPUTATION(__HANDLE__) \
  343. do { \
  344. if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_9B) \
  345. { \
  346. if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \
  347. { \
  348. (__HANDLE__)->Mask = 0x01FFU ; \
  349. } \
  350. else \
  351. { \
  352. (__HANDLE__)->Mask = 0x00FFU ; \
  353. } \
  354. } \
  355. else if ((__HANDLE__)->Init.WordLength == IRDA_WORDLENGTH_8B) \
  356. { \
  357. if ((__HANDLE__)->Init.Parity == IRDA_PARITY_NONE) \
  358. { \
  359. (__HANDLE__)->Mask = 0x00FFU ; \
  360. } \
  361. else \
  362. { \
  363. (__HANDLE__)->Mask = 0x007FU ; \
  364. } \
  365. } \
  366. } while(0)
  367. #endif /* defined (STM32F042x6) || defined (STM32F048xx) || \
  368. defined (STM32F071xB) || defined (STM32F072xB) || defined (STM32F078xx) || \
  369. defined (STM32F091xC) || defined(STM32F098xx) */
  370. /**
  371. * @brief Ensure that IRDA frame length is valid.
  372. * @param __LENGTH__ IRDA frame length.
  373. * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid)
  374. */
  375. #if defined (STM32F042x6) || defined (STM32F048xx) || \
  376. defined (STM32F071xB) || defined (STM32F072xB) || defined (STM32F078xx) || \
  377. defined (STM32F091xC) || defined (STM32F098xx)
  378. #define IS_IRDA_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == IRDA_WORDLENGTH_7B) || \
  379. ((__LENGTH__) == IRDA_WORDLENGTH_8B) || \
  380. ((__LENGTH__) == IRDA_WORDLENGTH_9B))
  381. #else
  382. #define IS_IRDA_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == IRDA_WORDLENGTH_8B) || \
  383. ((__LENGTH__) == IRDA_WORDLENGTH_9B))
  384. #endif /* defined (STM32F042x6) || defined (STM32F048xx) || \
  385. defined (STM32F071xB) || defined (STM32F072xB) || defined (STM32F078xx) || \
  386. defined (STM32F091xC) || defined (STM32F098xx)*/
  387. /**
  388. * @}
  389. */
  390. /* Exported functions --------------------------------------------------------*/
  391. /**
  392. * @}
  393. */
  394. /**
  395. * @}
  396. */
  397. #endif /* !defined(STM32F030x6) && !defined(STM32F030x8) && !defined(STM32F070x6) && !defined(STM32F070xB) && !defined(STM32F030xC) */
  398. #ifdef __cplusplus
  399. }
  400. #endif
  401. #endif /* __STM32F0xx_HAL_IRDA_EX_H */
  402. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/