训练营PLSR题目
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.
 
 
 
 
 
 

605 line
25 KiB

  1. /**
  2. ******************************************************************************
  3. * @file stm32f4xx_hal_spdifrx.h
  4. * @author MCD Application Team
  5. * @brief Header file of SPDIFRX HAL module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * Copyright (c) 2016 STMicroelectronics.
  10. * All rights reserved.
  11. *
  12. * This software is licensed under terms that can be found in the LICENSE file
  13. * in the root directory of this software component.
  14. * If no LICENSE file comes with this software, it is provided AS-IS.
  15. *
  16. ******************************************************************************
  17. */
  18. /* Define to prevent recursive inclusion -------------------------------------*/
  19. #ifndef STM32F4xx_HAL_SPDIFRX_H
  20. #define STM32F4xx_HAL_SPDIFRX_H
  21. #ifdef __cplusplus
  22. extern "C" {
  23. #endif
  24. /* Includes ------------------------------------------------------------------*/
  25. #include "stm32f4xx_hal_def.h"
  26. #if defined(STM32F446xx)
  27. /** @addtogroup STM32F4xx_HAL_Driver
  28. * @{
  29. */
  30. #if defined (SPDIFRX)
  31. /** @addtogroup SPDIFRX
  32. * @{
  33. */
  34. /* Exported types ------------------------------------------------------------*/
  35. /** @defgroup SPDIFRX_Exported_Types SPDIFRX Exported Types
  36. * @{
  37. */
  38. /**
  39. * @brief SPDIFRX Init structure definition
  40. */
  41. typedef struct
  42. {
  43. uint32_t InputSelection; /*!< Specifies the SPDIF input selection.
  44. This parameter can be a value of @ref SPDIFRX_Input_Selection */
  45. uint32_t Retries; /*!< Specifies the Maximum allowed re-tries during synchronization phase.
  46. This parameter can be a value of @ref SPDIFRX_Max_Retries */
  47. uint32_t WaitForActivity; /*!< Specifies the wait for activity on SPDIF selected input.
  48. This parameter can be a value of @ref SPDIFRX_Wait_For_Activity. */
  49. uint32_t ChannelSelection; /*!< Specifies whether the control flow will take the channel status from channel A or B.
  50. This parameter can be a value of @ref SPDIFRX_Channel_Selection */
  51. uint32_t DataFormat; /*!< Specifies the Data samples format (LSB, MSB, ...).
  52. This parameter can be a value of @ref SPDIFRX_Data_Format */
  53. uint32_t StereoMode; /*!< Specifies whether the peripheral is in stereo or mono mode.
  54. This parameter can be a value of @ref SPDIFRX_Stereo_Mode */
  55. uint32_t PreambleTypeMask; /*!< Specifies whether The preamble type bits are copied or not into the received frame.
  56. This parameter can be a value of @ref SPDIFRX_PT_Mask */
  57. uint32_t ChannelStatusMask; /*!< Specifies whether the channel status and user bits are copied or not into the received frame.
  58. This parameter can be a value of @ref SPDIFRX_ChannelStatus_Mask */
  59. uint32_t ValidityBitMask; /*!< Specifies whether the validity bit is copied or not into the received frame.
  60. This parameter can be a value of @ref SPDIFRX_V_Mask */
  61. uint32_t ParityErrorMask; /*!< Specifies whether the parity error bit is copied or not into the received frame.
  62. This parameter can be a value of @ref SPDIFRX_PE_Mask */
  63. } SPDIFRX_InitTypeDef;
  64. /**
  65. * @brief SPDIFRX SetDataFormat structure definition
  66. */
  67. typedef struct
  68. {
  69. uint32_t DataFormat; /*!< Specifies the Data samples format (LSB, MSB, ...).
  70. This parameter can be a value of @ref SPDIFRX_Data_Format */
  71. uint32_t StereoMode; /*!< Specifies whether the peripheral is in stereo or mono mode.
  72. This parameter can be a value of @ref SPDIFRX_Stereo_Mode */
  73. uint32_t PreambleTypeMask; /*!< Specifies whether The preamble type bits are copied or not into the received frame.
  74. This parameter can be a value of @ref SPDIFRX_PT_Mask */
  75. uint32_t ChannelStatusMask; /*!< Specifies whether the channel status and user bits are copied or not into the received frame.
  76. This parameter can be a value of @ref SPDIFRX_ChannelStatus_Mask */
  77. uint32_t ValidityBitMask; /*!< Specifies whether the validity bit is copied or not into the received frame.
  78. This parameter can be a value of @ref SPDIFRX_V_Mask */
  79. uint32_t ParityErrorMask; /*!< Specifies whether the parity error bit is copied or not into the received frame.
  80. This parameter can be a value of @ref SPDIFRX_PE_Mask */
  81. } SPDIFRX_SetDataFormatTypeDef;
  82. /**
  83. * @brief HAL State structures definition
  84. */
  85. typedef enum
  86. {
  87. HAL_SPDIFRX_STATE_RESET = 0x00U, /*!< SPDIFRX not yet initialized or disabled */
  88. HAL_SPDIFRX_STATE_READY = 0x01U, /*!< SPDIFRX initialized and ready for use */
  89. HAL_SPDIFRX_STATE_BUSY = 0x02U, /*!< SPDIFRX internal process is ongoing */
  90. HAL_SPDIFRX_STATE_BUSY_RX = 0x03U, /*!< SPDIFRX internal Data Flow RX process is ongoing */
  91. HAL_SPDIFRX_STATE_BUSY_CX = 0x04U, /*!< SPDIFRX internal Control Flow RX process is ongoing */
  92. HAL_SPDIFRX_STATE_ERROR = 0x07U /*!< SPDIFRX error state */
  93. } HAL_SPDIFRX_StateTypeDef;
  94. /**
  95. * @brief SPDIFRX handle Structure definition
  96. */
  97. #if (USE_HAL_SPDIFRX_REGISTER_CALLBACKS == 1)
  98. typedef struct __SPDIFRX_HandleTypeDef
  99. #else
  100. typedef struct
  101. #endif /* USE_HAL_SPDIFRX_REGISTER_CALLBACKS */
  102. {
  103. SPDIFRX_TypeDef *Instance; /* SPDIFRX registers base address */
  104. SPDIFRX_InitTypeDef Init; /* SPDIFRX communication parameters */
  105. uint32_t *pRxBuffPtr; /* Pointer to SPDIFRX Rx transfer buffer */
  106. uint32_t *pCsBuffPtr; /* Pointer to SPDIFRX Cx transfer buffer */
  107. __IO uint16_t RxXferSize; /* SPDIFRX Rx transfer size */
  108. __IO uint16_t RxXferCount; /* SPDIFRX Rx transfer counter
  109. (This field is initialized at the
  110. same value as transfer size at the
  111. beginning of the transfer and
  112. decremented when a sample is received.
  113. NbSamplesReceived = RxBufferSize-RxBufferCount) */
  114. __IO uint16_t CsXferSize; /* SPDIFRX Rx transfer size */
  115. __IO uint16_t CsXferCount; /* SPDIFRX Rx transfer counter
  116. (This field is initialized at the
  117. same value as transfer size at the
  118. beginning of the transfer and
  119. decremented when a sample is received.
  120. NbSamplesReceived = RxBufferSize-RxBufferCount) */
  121. DMA_HandleTypeDef *hdmaCsRx; /* SPDIFRX EC60958_channel_status and user_information DMA handle parameters */
  122. DMA_HandleTypeDef *hdmaDrRx; /* SPDIFRX Rx DMA handle parameters */
  123. __IO HAL_LockTypeDef Lock; /* SPDIFRX locking object */
  124. __IO HAL_SPDIFRX_StateTypeDef State; /* SPDIFRX communication state */
  125. __IO uint32_t ErrorCode; /* SPDIFRX Error code */
  126. #if (USE_HAL_SPDIFRX_REGISTER_CALLBACKS == 1)
  127. void (*RxHalfCpltCallback)(struct __SPDIFRX_HandleTypeDef *hspdif); /*!< SPDIFRX Data flow half completed callback */
  128. void (*RxCpltCallback)(struct __SPDIFRX_HandleTypeDef *hspdif); /*!< SPDIFRX Data flow completed callback */
  129. void (*CxHalfCpltCallback)(struct __SPDIFRX_HandleTypeDef *hspdif); /*!< SPDIFRX Control flow half completed callback */
  130. void (*CxCpltCallback)(struct __SPDIFRX_HandleTypeDef *hspdif); /*!< SPDIFRX Control flow completed callback */
  131. void (*ErrorCallback)(struct __SPDIFRX_HandleTypeDef *hspdif); /*!< SPDIFRX error callback */
  132. void (* MspInitCallback)(struct __SPDIFRX_HandleTypeDef *hspdif); /*!< SPDIFRX Msp Init callback */
  133. void (* MspDeInitCallback)(struct __SPDIFRX_HandleTypeDef *hspdif); /*!< SPDIFRX Msp DeInit callback */
  134. #endif /* USE_HAL_SPDIFRX_REGISTER_CALLBACKS */
  135. } SPDIFRX_HandleTypeDef;
  136. /**
  137. * @}
  138. */
  139. #if (USE_HAL_SPDIFRX_REGISTER_CALLBACKS == 1)
  140. /**
  141. * @brief HAL SPDIFRX Callback ID enumeration definition
  142. */
  143. typedef enum
  144. {
  145. HAL_SPDIFRX_RX_HALF_CB_ID = 0x00U, /*!< SPDIFRX Data flow half completed callback ID */
  146. HAL_SPDIFRX_RX_CPLT_CB_ID = 0x01U, /*!< SPDIFRX Data flow completed callback */
  147. HAL_SPDIFRX_CX_HALF_CB_ID = 0x02U, /*!< SPDIFRX Control flow half completed callback */
  148. HAL_SPDIFRX_CX_CPLT_CB_ID = 0x03U, /*!< SPDIFRX Control flow completed callback */
  149. HAL_SPDIFRX_ERROR_CB_ID = 0x04U, /*!< SPDIFRX error callback */
  150. HAL_SPDIFRX_MSPINIT_CB_ID = 0x05U, /*!< SPDIFRX Msp Init callback ID */
  151. HAL_SPDIFRX_MSPDEINIT_CB_ID = 0x06U /*!< SPDIFRX Msp DeInit callback ID */
  152. } HAL_SPDIFRX_CallbackIDTypeDef;
  153. /**
  154. * @brief HAL SPDIFRX Callback pointer definition
  155. */
  156. typedef void (*pSPDIFRX_CallbackTypeDef)(SPDIFRX_HandleTypeDef *hspdif); /*!< pointer to an SPDIFRX callback function */
  157. #endif /* USE_HAL_SPDIFRX_REGISTER_CALLBACKS */
  158. /* Exported constants --------------------------------------------------------*/
  159. /** @defgroup SPDIFRX_Exported_Constants SPDIFRX Exported Constants
  160. * @{
  161. */
  162. /** @defgroup SPDIFRX_ErrorCode SPDIFRX Error Code
  163. * @{
  164. */
  165. #define HAL_SPDIFRX_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
  166. #define HAL_SPDIFRX_ERROR_TIMEOUT ((uint32_t)0x00000001U) /*!< Timeout error */
  167. #define HAL_SPDIFRX_ERROR_OVR ((uint32_t)0x00000002U) /*!< OVR error */
  168. #define HAL_SPDIFRX_ERROR_PE ((uint32_t)0x00000004U) /*!< Parity error */
  169. #define HAL_SPDIFRX_ERROR_DMA ((uint32_t)0x00000008U) /*!< DMA transfer error */
  170. #define HAL_SPDIFRX_ERROR_UNKNOWN ((uint32_t)0x00000010U) /*!< Unknown Error error */
  171. #if (USE_HAL_SPDIFRX_REGISTER_CALLBACKS == 1)
  172. #define HAL_SPDIFRX_ERROR_INVALID_CALLBACK ((uint32_t)0x00000020U) /*!< Invalid Callback error */
  173. #endif /* USE_HAL_SPDIFRX_REGISTER_CALLBACKS */
  174. /**
  175. * @}
  176. */
  177. /** @defgroup SPDIFRX_Input_Selection SPDIFRX Input Selection
  178. * @{
  179. */
  180. #define SPDIFRX_INPUT_IN0 ((uint32_t)0x00000000U)
  181. #define SPDIFRX_INPUT_IN1 ((uint32_t)0x00010000U)
  182. #define SPDIFRX_INPUT_IN2 ((uint32_t)0x00020000U)
  183. #define SPDIFRX_INPUT_IN3 ((uint32_t)0x00030000U)
  184. /**
  185. * @}
  186. */
  187. /** @defgroup SPDIFRX_Max_Retries SPDIFRX Maximum Retries
  188. * @{
  189. */
  190. #define SPDIFRX_MAXRETRIES_NONE ((uint32_t)0x00000000U)
  191. #define SPDIFRX_MAXRETRIES_3 ((uint32_t)0x00001000U)
  192. #define SPDIFRX_MAXRETRIES_15 ((uint32_t)0x00002000U)
  193. #define SPDIFRX_MAXRETRIES_63 ((uint32_t)0x00003000U)
  194. /**
  195. * @}
  196. */
  197. /** @defgroup SPDIFRX_Wait_For_Activity SPDIFRX Wait For Activity
  198. * @{
  199. */
  200. #define SPDIFRX_WAITFORACTIVITY_OFF ((uint32_t)0x00000000U)
  201. #define SPDIFRX_WAITFORACTIVITY_ON ((uint32_t)SPDIFRX_CR_WFA)
  202. /**
  203. * @}
  204. */
  205. /** @defgroup SPDIFRX_PT_Mask SPDIFRX Preamble Type Mask
  206. * @{
  207. */
  208. #define SPDIFRX_PREAMBLETYPEMASK_OFF ((uint32_t)0x00000000U)
  209. #define SPDIFRX_PREAMBLETYPEMASK_ON ((uint32_t)SPDIFRX_CR_PTMSK)
  210. /**
  211. * @}
  212. */
  213. /** @defgroup SPDIFRX_ChannelStatus_Mask SPDIFRX Channel Status Mask
  214. * @{
  215. */
  216. #define SPDIFRX_CHANNELSTATUS_OFF ((uint32_t)0x00000000U) /* The channel status and user bits are copied into the SPDIF_DR */
  217. #define SPDIFRX_CHANNELSTATUS_ON ((uint32_t)SPDIFRX_CR_CUMSK) /* The channel status and user bits are not copied into the SPDIF_DR, zeros are written instead*/
  218. /**
  219. * @}
  220. */
  221. /** @defgroup SPDIFRX_V_Mask SPDIFRX Validity Mask
  222. * @{
  223. */
  224. #define SPDIFRX_VALIDITYMASK_OFF ((uint32_t)0x00000000U)
  225. #define SPDIFRX_VALIDITYMASK_ON ((uint32_t)SPDIFRX_CR_VMSK)
  226. /**
  227. * @}
  228. */
  229. /** @defgroup SPDIFRX_PE_Mask SPDIFRX Parity Error Mask
  230. * @{
  231. */
  232. #define SPDIFRX_PARITYERRORMASK_OFF ((uint32_t)0x00000000U)
  233. #define SPDIFRX_PARITYERRORMASK_ON ((uint32_t)SPDIFRX_CR_PMSK)
  234. /**
  235. * @}
  236. */
  237. /** @defgroup SPDIFRX_Channel_Selection SPDIFRX Channel Selection
  238. * @{
  239. */
  240. #define SPDIFRX_CHANNEL_A ((uint32_t)0x00000000U)
  241. #define SPDIFRX_CHANNEL_B ((uint32_t)SPDIFRX_CR_CHSEL)
  242. /**
  243. * @}
  244. */
  245. /** @defgroup SPDIFRX_Data_Format SPDIFRX Data Format
  246. * @{
  247. */
  248. #define SPDIFRX_DATAFORMAT_LSB ((uint32_t)0x00000000U)
  249. #define SPDIFRX_DATAFORMAT_MSB ((uint32_t)0x00000010U)
  250. #define SPDIFRX_DATAFORMAT_32BITS ((uint32_t)0x00000020U)
  251. /**
  252. * @}
  253. */
  254. /** @defgroup SPDIFRX_Stereo_Mode SPDIFRX Stereo Mode
  255. * @{
  256. */
  257. #define SPDIFRX_STEREOMODE_DISABLE ((uint32_t)0x00000000U)
  258. #define SPDIFRX_STEREOMODE_ENABLE ((uint32_t)SPDIFRX_CR_RXSTEO)
  259. /**
  260. * @}
  261. */
  262. /** @defgroup SPDIFRX_State SPDIFRX State
  263. * @{
  264. */
  265. #define SPDIFRX_STATE_IDLE ((uint32_t)0xFFFFFFFCU)
  266. #define SPDIFRX_STATE_SYNC ((uint32_t)0x00000001U)
  267. #define SPDIFRX_STATE_RCV ((uint32_t)SPDIFRX_CR_SPDIFEN)
  268. /**
  269. * @}
  270. */
  271. /** @defgroup SPDIFRX_Interrupts_Definition SPDIFRX Interrupts Definition
  272. * @{
  273. */
  274. #define SPDIFRX_IT_RXNE ((uint32_t)SPDIFRX_IMR_RXNEIE)
  275. #define SPDIFRX_IT_CSRNE ((uint32_t)SPDIFRX_IMR_CSRNEIE)
  276. #define SPDIFRX_IT_PERRIE ((uint32_t)SPDIFRX_IMR_PERRIE)
  277. #define SPDIFRX_IT_OVRIE ((uint32_t)SPDIFRX_IMR_OVRIE)
  278. #define SPDIFRX_IT_SBLKIE ((uint32_t)SPDIFRX_IMR_SBLKIE)
  279. #define SPDIFRX_IT_SYNCDIE ((uint32_t)SPDIFRX_IMR_SYNCDIE)
  280. #define SPDIFRX_IT_IFEIE ((uint32_t)SPDIFRX_IMR_IFEIE )
  281. /**
  282. * @}
  283. */
  284. /** @defgroup SPDIFRX_Flags_Definition SPDIFRX Flags Definition
  285. * @{
  286. */
  287. #define SPDIFRX_FLAG_RXNE ((uint32_t)SPDIFRX_SR_RXNE)
  288. #define SPDIFRX_FLAG_CSRNE ((uint32_t)SPDIFRX_SR_CSRNE)
  289. #define SPDIFRX_FLAG_PERR ((uint32_t)SPDIFRX_SR_PERR)
  290. #define SPDIFRX_FLAG_OVR ((uint32_t)SPDIFRX_SR_OVR)
  291. #define SPDIFRX_FLAG_SBD ((uint32_t)SPDIFRX_SR_SBD)
  292. #define SPDIFRX_FLAG_SYNCD ((uint32_t)SPDIFRX_SR_SYNCD)
  293. #define SPDIFRX_FLAG_FERR ((uint32_t)SPDIFRX_SR_FERR)
  294. #define SPDIFRX_FLAG_SERR ((uint32_t)SPDIFRX_SR_SERR)
  295. #define SPDIFRX_FLAG_TERR ((uint32_t)SPDIFRX_SR_TERR)
  296. /**
  297. * @}
  298. */
  299. /**
  300. * @}
  301. */
  302. /* Exported macros -----------------------------------------------------------*/
  303. /** @defgroup SPDIFRX_Exported_macros SPDIFRX Exported Macros
  304. * @{
  305. */
  306. /** @brief Reset SPDIFRX handle state
  307. * @param __HANDLE__ SPDIFRX handle.
  308. * @retval None
  309. */
  310. #if (USE_HAL_SPDIFRX_REGISTER_CALLBACKS == 1)
  311. #define __HAL_SPDIFRX_RESET_HANDLE_STATE(__HANDLE__) do{\
  312. (__HANDLE__)->State = HAL_SPDIFRX_STATE_RESET;\
  313. (__HANDLE__)->MspInitCallback = NULL;\
  314. (__HANDLE__)->MspDeInitCallback = NULL;\
  315. }while(0)
  316. #else
  317. #define __HAL_SPDIFRX_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SPDIFRX_STATE_RESET)
  318. #endif /* USE_HAL_SPDIFRX_REGISTER_CALLBACKS */
  319. /** @brief Disable the specified SPDIFRX peripheral (IDLE State).
  320. * @param __HANDLE__ specifies the SPDIFRX Handle.
  321. * @retval None
  322. */
  323. #define __HAL_SPDIFRX_IDLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= SPDIFRX_STATE_IDLE)
  324. /** @brief Enable the specified SPDIFRX peripheral (SYNC State).
  325. * @param __HANDLE__ specifies the SPDIFRX Handle.
  326. * @retval None
  327. */
  328. #define __HAL_SPDIFRX_SYNC(__HANDLE__) ((__HANDLE__)->Instance->CR |= SPDIFRX_STATE_SYNC)
  329. /** @brief Enable the specified SPDIFRX peripheral (RCV State).
  330. * @param __HANDLE__ specifies the SPDIFRX Handle.
  331. * @retval None
  332. */
  333. #define __HAL_SPDIFRX_RCV(__HANDLE__) ((__HANDLE__)->Instance->CR |= SPDIFRX_STATE_RCV)
  334. /** @brief Enable or disable the specified SPDIFRX interrupts.
  335. * @param __HANDLE__ specifies the SPDIFRX Handle.
  336. * @param __INTERRUPT__ specifies the interrupt source to enable or disable.
  337. * This parameter can be one of the following values:
  338. * @arg SPDIFRX_IT_RXNE
  339. * @arg SPDIFRX_IT_CSRNE
  340. * @arg SPDIFRX_IT_PERRIE
  341. * @arg SPDIFRX_IT_OVRIE
  342. * @arg SPDIFRX_IT_SBLKIE
  343. * @arg SPDIFRX_IT_SYNCDIE
  344. * @arg SPDIFRX_IT_IFEIE
  345. * @retval None
  346. */
  347. #define __HAL_SPDIFRX_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IMR |= (__INTERRUPT__))
  348. #define __HAL_SPDIFRX_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IMR\
  349. &= (uint16_t)(~(__INTERRUPT__)))
  350. /** @brief Checks if the specified SPDIFRX interrupt source is enabled or disabled.
  351. * @param __HANDLE__ specifies the SPDIFRX Handle.
  352. * @param __INTERRUPT__ specifies the SPDIFRX interrupt source to check.
  353. * This parameter can be one of the following values:
  354. * @arg SPDIFRX_IT_RXNE
  355. * @arg SPDIFRX_IT_CSRNE
  356. * @arg SPDIFRX_IT_PERRIE
  357. * @arg SPDIFRX_IT_OVRIE
  358. * @arg SPDIFRX_IT_SBLKIE
  359. * @arg SPDIFRX_IT_SYNCDIE
  360. * @arg SPDIFRX_IT_IFEIE
  361. * @retval The new state of __IT__ (TRUE or FALSE).
  362. */
  363. #define __HAL_SPDIFRX_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->IMR\
  364. & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
  365. /** @brief Checks whether the specified SPDIFRX flag is set or not.
  366. * @param __HANDLE__ specifies the SPDIFRX Handle.
  367. * @param __FLAG__ specifies the flag to check.
  368. * This parameter can be one of the following values:
  369. * @arg SPDIFRX_FLAG_RXNE
  370. * @arg SPDIFRX_FLAG_CSRNE
  371. * @arg SPDIFRX_FLAG_PERR
  372. * @arg SPDIFRX_FLAG_OVR
  373. * @arg SPDIFRX_FLAG_SBD
  374. * @arg SPDIFRX_FLAG_SYNCD
  375. * @arg SPDIFRX_FLAG_FERR
  376. * @arg SPDIFRX_FLAG_SERR
  377. * @arg SPDIFRX_FLAG_TERR
  378. * @retval The new state of __FLAG__ (TRUE or FALSE).
  379. */
  380. #define __HAL_SPDIFRX_GET_FLAG(__HANDLE__, __FLAG__) (((((__HANDLE__)->Instance->SR)\
  381. & (__FLAG__)) == (__FLAG__)) ? SET : RESET)
  382. /** @brief Clears the specified SPDIFRX SR flag, in setting the proper IFCR register bit.
  383. * @param __HANDLE__ specifies the USART Handle.
  384. * @param __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set
  385. * to clear the corresponding interrupt
  386. * This parameter can be one of the following values:
  387. * @arg SPDIFRX_FLAG_PERR
  388. * @arg SPDIFRX_FLAG_OVR
  389. * @arg SPDIFRX_SR_SBD
  390. * @arg SPDIFRX_SR_SYNCD
  391. * @retval None
  392. */
  393. #define __HAL_SPDIFRX_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->IFCR = (uint32_t)(__IT_CLEAR__))
  394. /**
  395. * @}
  396. */
  397. /* Exported functions --------------------------------------------------------*/
  398. /** @addtogroup SPDIFRX_Exported_Functions
  399. * @{
  400. */
  401. /** @addtogroup SPDIFRX_Exported_Functions_Group1
  402. * @{
  403. */
  404. /* Initialization/de-initialization functions **********************************/
  405. HAL_StatusTypeDef HAL_SPDIFRX_Init(SPDIFRX_HandleTypeDef *hspdif);
  406. HAL_StatusTypeDef HAL_SPDIFRX_DeInit(SPDIFRX_HandleTypeDef *hspdif);
  407. void HAL_SPDIFRX_MspInit(SPDIFRX_HandleTypeDef *hspdif);
  408. void HAL_SPDIFRX_MspDeInit(SPDIFRX_HandleTypeDef *hspdif);
  409. HAL_StatusTypeDef HAL_SPDIFRX_SetDataFormat(SPDIFRX_HandleTypeDef *hspdif, SPDIFRX_SetDataFormatTypeDef sDataFormat);
  410. /* Callbacks Register/UnRegister functions ***********************************/
  411. #if (USE_HAL_SPDIFRX_REGISTER_CALLBACKS == 1)
  412. HAL_StatusTypeDef HAL_SPDIFRX_RegisterCallback(SPDIFRX_HandleTypeDef *hspdif, HAL_SPDIFRX_CallbackIDTypeDef CallbackID,
  413. pSPDIFRX_CallbackTypeDef pCallback);
  414. HAL_StatusTypeDef HAL_SPDIFRX_UnRegisterCallback(SPDIFRX_HandleTypeDef *hspdif,
  415. HAL_SPDIFRX_CallbackIDTypeDef CallbackID);
  416. #endif /* USE_HAL_SPDIFRX_REGISTER_CALLBACKS */
  417. /**
  418. * @}
  419. */
  420. /** @addtogroup SPDIFRX_Exported_Functions_Group2
  421. * @{
  422. */
  423. /* I/O operation functions ***************************************************/
  424. /* Blocking mode: Polling */
  425. HAL_StatusTypeDef HAL_SPDIFRX_ReceiveDataFlow(SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size,
  426. uint32_t Timeout);
  427. HAL_StatusTypeDef HAL_SPDIFRX_ReceiveControlFlow(SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size,
  428. uint32_t Timeout);
  429. /* Non-Blocking mode: Interrupt */
  430. HAL_StatusTypeDef HAL_SPDIFRX_ReceiveControlFlow_IT(SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size);
  431. HAL_StatusTypeDef HAL_SPDIFRX_ReceiveDataFlow_IT(SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size);
  432. void HAL_SPDIFRX_IRQHandler(SPDIFRX_HandleTypeDef *hspdif);
  433. /* Non-Blocking mode: DMA */
  434. HAL_StatusTypeDef HAL_SPDIFRX_ReceiveControlFlow_DMA(SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size);
  435. HAL_StatusTypeDef HAL_SPDIFRX_ReceiveDataFlow_DMA(SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size);
  436. HAL_StatusTypeDef HAL_SPDIFRX_DMAStop(SPDIFRX_HandleTypeDef *hspdif);
  437. /* Callbacks used in non blocking modes (Interrupt and DMA) *******************/
  438. void HAL_SPDIFRX_RxHalfCpltCallback(SPDIFRX_HandleTypeDef *hspdif);
  439. void HAL_SPDIFRX_RxCpltCallback(SPDIFRX_HandleTypeDef *hspdif);
  440. void HAL_SPDIFRX_ErrorCallback(SPDIFRX_HandleTypeDef *hspdif);
  441. void HAL_SPDIFRX_CxHalfCpltCallback(SPDIFRX_HandleTypeDef *hspdif);
  442. void HAL_SPDIFRX_CxCpltCallback(SPDIFRX_HandleTypeDef *hspdif);
  443. /**
  444. * @}
  445. */
  446. /** @addtogroup SPDIFRX_Exported_Functions_Group3
  447. * @{
  448. */
  449. /* Peripheral Control and State functions ************************************/
  450. HAL_SPDIFRX_StateTypeDef HAL_SPDIFRX_GetState(SPDIFRX_HandleTypeDef const *const hspdif);
  451. uint32_t HAL_SPDIFRX_GetError(SPDIFRX_HandleTypeDef const *const hspdif);
  452. /**
  453. * @}
  454. */
  455. /**
  456. * @}
  457. */
  458. /* Private types -------------------------------------------------------------*/
  459. /* Private variables ---------------------------------------------------------*/
  460. /* Private constants ---------------------------------------------------------*/
  461. /* Private macros ------------------------------------------------------------*/
  462. /** @defgroup SPDIFRX_Private_Macros SPDIFRX Private Macros
  463. * @{
  464. */
  465. #define IS_SPDIFRX_INPUT_SELECT(INPUT) (((INPUT) == SPDIFRX_INPUT_IN1) || \
  466. ((INPUT) == SPDIFRX_INPUT_IN2) || \
  467. ((INPUT) == SPDIFRX_INPUT_IN3) || \
  468. ((INPUT) == SPDIFRX_INPUT_IN0))
  469. #define IS_SPDIFRX_MAX_RETRIES(RET) (((RET) == SPDIFRX_MAXRETRIES_NONE) || \
  470. ((RET) == SPDIFRX_MAXRETRIES_3) || \
  471. ((RET) == SPDIFRX_MAXRETRIES_15) || \
  472. ((RET) == SPDIFRX_MAXRETRIES_63))
  473. #define IS_SPDIFRX_WAIT_FOR_ACTIVITY(VAL) (((VAL) == SPDIFRX_WAITFORACTIVITY_ON) || \
  474. ((VAL) == SPDIFRX_WAITFORACTIVITY_OFF))
  475. #define IS_PREAMBLE_TYPE_MASK(VAL) (((VAL) == SPDIFRX_PREAMBLETYPEMASK_ON) || \
  476. ((VAL) == SPDIFRX_PREAMBLETYPEMASK_OFF))
  477. #define IS_VALIDITY_MASK(VAL) (((VAL) == SPDIFRX_VALIDITYMASK_OFF) || \
  478. ((VAL) == SPDIFRX_VALIDITYMASK_ON))
  479. #define IS_PARITY_ERROR_MASK(VAL) (((VAL) == SPDIFRX_PARITYERRORMASK_OFF) || \
  480. ((VAL) == SPDIFRX_PARITYERRORMASK_ON))
  481. #define IS_SPDIFRX_CHANNEL(CHANNEL) (((CHANNEL) == SPDIFRX_CHANNEL_A) || \
  482. ((CHANNEL) == SPDIFRX_CHANNEL_B))
  483. #define IS_SPDIFRX_DATA_FORMAT(FORMAT) (((FORMAT) == SPDIFRX_DATAFORMAT_LSB) || \
  484. ((FORMAT) == SPDIFRX_DATAFORMAT_MSB) || \
  485. ((FORMAT) == SPDIFRX_DATAFORMAT_32BITS))
  486. #define IS_STEREO_MODE(MODE) (((MODE) == SPDIFRX_STEREOMODE_DISABLE) || \
  487. ((MODE) == SPDIFRX_STEREOMODE_ENABLE))
  488. #define IS_CHANNEL_STATUS_MASK(VAL) (((VAL) == SPDIFRX_CHANNELSTATUS_ON) || \
  489. ((VAL) == SPDIFRX_CHANNELSTATUS_OFF))
  490. /**
  491. * @}
  492. */
  493. /* Private functions ---------------------------------------------------------*/
  494. /** @defgroup SPDIFRX_Private_Functions SPDIFRX Private Functions
  495. * @{
  496. */
  497. /**
  498. * @}
  499. */
  500. /**
  501. * @}
  502. */
  503. #endif /* SPDIFRX */
  504. /**
  505. * @}
  506. */
  507. #endif /* STM32F446xx */
  508. #ifdef __cplusplus
  509. }
  510. #endif
  511. #endif /* STM32F4xx_HAL_SPDIFRX_H */