STM CMSIS
stm32f4xx_hal_spdifrx.h
Go to the documentation of this file.
1 
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32F4xx_HAL_SPDIFRX_H
40 #define __STM32F4xx_HAL_SPDIFRX_H
41 
42 #ifdef __cplusplus
43  extern "C" {
44 #endif
45 
46 #if defined(STM32F446xx)
47 
48 /* Includes ------------------------------------------------------------------*/
49 #include "stm32f4xx_hal_def.h"
50 
59 /* Exported types ------------------------------------------------------------*/
67 typedef struct
68 {
69  uint32_t InputSelection;
72  uint32_t Retries;
75  uint32_t WaitForActivity;
78  uint32_t ChannelSelection;
81  uint32_t DataFormat;
84  uint32_t StereoMode;
87  uint32_t PreambleTypeMask;
90  uint32_t ChannelStatusMask;
93  uint32_t ValidityBitMask;
96  uint32_t ParityErrorMask;
98 }SPDIFRX_InitTypeDef;
99 
103 typedef struct
104 {
105  uint32_t DataFormat;
108  uint32_t StereoMode;
111  uint32_t PreambleTypeMask;
114  uint32_t ChannelStatusMask;
117  uint32_t ValidityBitMask;
120  uint32_t ParityErrorMask;
122 }SPDIFRX_SetDataFormatTypeDef;
123 
127 typedef enum
128 {
129  HAL_SPDIFRX_STATE_RESET = 0x00U,
130  HAL_SPDIFRX_STATE_READY = 0x01U,
131  HAL_SPDIFRX_STATE_BUSY = 0x02U,
132  HAL_SPDIFRX_STATE_BUSY_RX = 0x03U,
133  HAL_SPDIFRX_STATE_BUSY_CX = 0x04U,
134  HAL_SPDIFRX_STATE_ERROR = 0x07U
135 }HAL_SPDIFRX_StateTypeDef;
136 
140 typedef struct
141 {
142  SPDIFRX_TypeDef *Instance; /* SPDIFRX registers base address */
143 
144  SPDIFRX_InitTypeDef Init; /* SPDIFRX communication parameters */
145 
146  uint32_t *pRxBuffPtr; /* Pointer to SPDIFRX Rx transfer buffer */
147 
148  uint32_t *pCsBuffPtr; /* Pointer to SPDIFRX Cx transfer buffer */
149 
150  __IO uint16_t RxXferSize; /* SPDIFRX Rx transfer size */
151 
152  __IO uint16_t RxXferCount; /* SPDIFRX Rx transfer counter
153  (This field is initialized at the
154  same value as transfer size at the
155  beginning of the transfer and
156  decremented when a sample is received.
157  NbSamplesReceived = RxBufferSize-RxBufferCount) */
158 
159  __IO uint16_t CsXferSize; /* SPDIFRX Rx transfer size */
160 
161  __IO uint16_t CsXferCount; /* SPDIFRX Rx transfer counter
162  (This field is initialized at the
163  same value as transfer size at the
164  beginning of the transfer and
165  decremented when a sample is received.
166  NbSamplesReceived = RxBufferSize-RxBufferCount) */
167 
168  DMA_HandleTypeDef *hdmaCsRx; /* SPDIFRX EC60958_channel_status and user_information DMA handle parameters */
169 
170  DMA_HandleTypeDef *hdmaDrRx; /* SPDIFRX Rx DMA handle parameters */
171 
172  __IO HAL_LockTypeDef Lock; /* SPDIFRX locking object */
173 
174  __IO HAL_SPDIFRX_StateTypeDef State; /* SPDIFRX communication state */
175 
176  __IO uint32_t ErrorCode; /* SPDIFRX Error code */
177 }SPDIFRX_HandleTypeDef;
182 /* Exported constants --------------------------------------------------------*/
189 #define HAL_SPDIFRX_ERROR_NONE ((uint32_t)0x00000000U)
190 #define HAL_SPDIFRX_ERROR_TIMEOUT ((uint32_t)0x00000001U)
191 #define HAL_SPDIFRX_ERROR_OVR ((uint32_t)0x00000002U)
192 #define HAL_SPDIFRX_ERROR_PE ((uint32_t)0x00000004U)
193 #define HAL_SPDIFRX_ERROR_DMA ((uint32_t)0x00000008U)
194 #define HAL_SPDIFRX_ERROR_UNKNOWN ((uint32_t)0x00000010U)
202 #define SPDIFRX_INPUT_IN0 ((uint32_t)0x00000000U)
203 #define SPDIFRX_INPUT_IN1 ((uint32_t)0x00010000U)
204 #define SPDIFRX_INPUT_IN2 ((uint32_t)0x00020000U)
205 #define SPDIFRX_INPUT_IN3 ((uint32_t)0x00030000U)
206 
213 #define SPDIFRX_MAXRETRIES_NONE ((uint32_t)0x00000000U)
214 #define SPDIFRX_MAXRETRIES_3 ((uint32_t)0x00001000U)
215 #define SPDIFRX_MAXRETRIES_15 ((uint32_t)0x00002000U)
216 #define SPDIFRX_MAXRETRIES_63 ((uint32_t)0x00003000U)
217 
224 #define SPDIFRX_WAITFORACTIVITY_OFF ((uint32_t)0x00000000U)
225 #define SPDIFRX_WAITFORACTIVITY_ON ((uint32_t)SPDIFRX_CR_WFA)
226 
233 #define SPDIFRX_PREAMBLETYPEMASK_OFF ((uint32_t)0x00000000U)
234 #define SPDIFRX_PREAMBLETYPEMASK_ON ((uint32_t)SPDIFRX_CR_PTMSK)
235 
242 #define SPDIFRX_CHANNELSTATUS_OFF ((uint32_t)0x00000000U) /* The channel status and user bits are copied into the SPDIF_DR */
243 #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*/
244 
251 #define SPDIFRX_VALIDITYMASK_OFF ((uint32_t)0x00000000U)
252 #define SPDIFRX_VALIDITYMASK_ON ((uint32_t)SPDIFRX_CR_VMSK)
253 
260 #define SPDIFRX_PARITYERRORMASK_OFF ((uint32_t)0x00000000U)
261 #define SPDIFRX_PARITYERRORMASK_ON ((uint32_t)SPDIFRX_CR_PMSK)
262 
269 #define SPDIFRX_CHANNEL_A ((uint32_t)0x00000000U)
270 #define SPDIFRX_CHANNEL_B ((uint32_t)SPDIFRX_CR_CHSEL)
271 
278 #define SPDIFRX_DATAFORMAT_LSB ((uint32_t)0x00000000U)
279 #define SPDIFRX_DATAFORMAT_MSB ((uint32_t)0x00000010U)
280 #define SPDIFRX_DATAFORMAT_32BITS ((uint32_t)0x00000020U)
281 
288 #define SPDIFRX_STEREOMODE_DISABLE ((uint32_t)0x00000000U)
289 #define SPDIFRX_STEREOMODE_ENABLE ((uint32_t)SPDIFRX_CR_RXSTEO)
290 
298 #define SPDIFRX_STATE_IDLE ((uint32_t)0xFFFFFFFCU)
299 #define SPDIFRX_STATE_SYNC ((uint32_t)0x00000001U)
300 #define SPDIFRX_STATE_RCV ((uint32_t)SPDIFRX_CR_SPDIFEN)
301 
308 #define SPDIFRX_IT_RXNE ((uint32_t)SPDIFRX_IMR_RXNEIE)
309 #define SPDIFRX_IT_CSRNE ((uint32_t)SPDIFRX_IMR_CSRNEIE)
310 #define SPDIFRX_IT_PERRIE ((uint32_t)SPDIFRX_IMR_PERRIE)
311 #define SPDIFRX_IT_OVRIE ((uint32_t)SPDIFRX_IMR_OVRIE)
312 #define SPDIFRX_IT_SBLKIE ((uint32_t)SPDIFRX_IMR_SBLKIE)
313 #define SPDIFRX_IT_SYNCDIE ((uint32_t)SPDIFRX_IMR_SYNCDIE)
314 #define SPDIFRX_IT_IFEIE ((uint32_t)SPDIFRX_IMR_IFEIE )
315 
322 #define SPDIFRX_FLAG_RXNE ((uint32_t)SPDIFRX_SR_RXNE)
323 #define SPDIFRX_FLAG_CSRNE ((uint32_t)SPDIFRX_SR_CSRNE)
324 #define SPDIFRX_FLAG_PERR ((uint32_t)SPDIFRX_SR_PERR)
325 #define SPDIFRX_FLAG_OVR ((uint32_t)SPDIFRX_SR_OVR)
326 #define SPDIFRX_FLAG_SBD ((uint32_t)SPDIFRX_SR_SBD)
327 #define SPDIFRX_FLAG_SYNCD ((uint32_t)SPDIFRX_SR_SYNCD)
328 #define SPDIFRX_FLAG_FERR ((uint32_t)SPDIFRX_SR_FERR)
329 #define SPDIFRX_FLAG_SERR ((uint32_t)SPDIFRX_SR_SERR)
330 #define SPDIFRX_FLAG_TERR ((uint32_t)SPDIFRX_SR_TERR)
331 
339 /* Exported macros -----------------------------------------------------------*/
348 #define __HAL_SPDIFRX_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = (uint16_t)SPDIFRX_CR_SPDIFEN)
349 
354 #define __HAL_SPDIFRX_IDLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= SPDIFRX_STATE_IDLE)
355 
360 #define __HAL_SPDIFRX_SYNC(__HANDLE__) ((__HANDLE__)->Instance->CR |= SPDIFRX_STATE_SYNC)
361 
362 
367 #define __HAL_SPDIFRX_RCV(__HANDLE__) ((__HANDLE__)->Instance->CR |= SPDIFRX_STATE_RCV)
368 
382 #define __HAL_SPDIFRX_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IMR |= (__INTERRUPT__))
383 #define __HAL_SPDIFRX_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IMR &= (uint16_t)(~(__INTERRUPT__)))
384 
398 #define __HAL_SPDIFRX_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->IMR & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
399 
415 #define __HAL_SPDIFRX_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
416 
428 #define __HAL_SPDIFRX_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->IFCR = (uint32_t)(__IT_CLEAR__))
429 
434 /* Exported functions --------------------------------------------------------*/
442 /* Initialization/de-initialization functions **********************************/
443 HAL_StatusTypeDef HAL_SPDIFRX_Init(SPDIFRX_HandleTypeDef *hspdif);
444 HAL_StatusTypeDef HAL_SPDIFRX_DeInit (SPDIFRX_HandleTypeDef *hspdif);
445 void HAL_SPDIFRX_MspInit(SPDIFRX_HandleTypeDef *hspdif);
446 void HAL_SPDIFRX_MspDeInit(SPDIFRX_HandleTypeDef *hspdif);
447 HAL_StatusTypeDef HAL_SPDIFRX_SetDataFormat(SPDIFRX_HandleTypeDef *hspdif, SPDIFRX_SetDataFormatTypeDef sDataFormat);
455 /* I/O operation functions ***************************************************/
456  /* Blocking mode: Polling */
457 HAL_StatusTypeDef HAL_SPDIFRX_ReceiveDataFlow(SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size, uint32_t Timeout);
458 HAL_StatusTypeDef HAL_SPDIFRX_ReceiveControlFlow(SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size, uint32_t Timeout);
459 
460  /* Non-Blocking mode: Interrupt */
461 HAL_StatusTypeDef HAL_SPDIFRX_ReceiveControlFlow_IT(SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size);
462 HAL_StatusTypeDef HAL_SPDIFRX_ReceiveDataFlow_IT(SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size);
463 void HAL_SPDIFRX_IRQHandler(SPDIFRX_HandleTypeDef *hspdif);
464 
465 /* Non-Blocking mode: DMA */
466 HAL_StatusTypeDef HAL_SPDIFRX_ReceiveControlFlow_DMA(SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size);
467 HAL_StatusTypeDef HAL_SPDIFRX_ReceiveDataFlow_DMA(SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size);
468 
469 HAL_StatusTypeDef HAL_SPDIFRX_DMAStop(SPDIFRX_HandleTypeDef *hspdif);
470 
471 /* Callbacks used in non blocking modes (Interrupt and DMA) *******************/
472 void HAL_SPDIFRX_RxHalfCpltCallback(SPDIFRX_HandleTypeDef *hspdif);
473 void HAL_SPDIFRX_RxCpltCallback(SPDIFRX_HandleTypeDef *hspdif);
474 void HAL_SPDIFRX_ErrorCallback(SPDIFRX_HandleTypeDef *hspdif);
475 void HAL_SPDIFRX_CxHalfCpltCallback(SPDIFRX_HandleTypeDef *hspdif);
476 void HAL_SPDIFRX_CxCpltCallback(SPDIFRX_HandleTypeDef *hspdif);
484 /* Peripheral Control and State functions ************************************/
485 HAL_SPDIFRX_StateTypeDef HAL_SPDIFRX_GetState(SPDIFRX_HandleTypeDef *hspdif);
486 uint32_t HAL_SPDIFRX_GetError(SPDIFRX_HandleTypeDef *hspdif);
494 /* Private types -------------------------------------------------------------*/
495 /* Private variables ---------------------------------------------------------*/
496 /* Private constants ---------------------------------------------------------*/
497 /* Private macros ------------------------------------------------------------*/
501 #define IS_SPDIFRX_INPUT_SELECT(INPUT) (((INPUT) == SPDIFRX_INPUT_IN1) || \
502  ((INPUT) == SPDIFRX_INPUT_IN2) || \
503  ((INPUT) == SPDIFRX_INPUT_IN3) || \
504  ((INPUT) == SPDIFRX_INPUT_IN0))
505 #define IS_SPDIFRX_MAX_RETRIES(RET) (((RET) == SPDIFRX_MAXRETRIES_NONE) || \
506  ((RET) == SPDIFRX_MAXRETRIES_3) || \
507  ((RET) == SPDIFRX_MAXRETRIES_15) || \
508  ((RET) == SPDIFRX_MAXRETRIES_63))
509 #define IS_SPDIFRX_WAIT_FOR_ACTIVITY(VAL) (((VAL) == SPDIFRX_WAITFORACTIVITY_ON) || \
510  ((VAL) == SPDIFRX_WAITFORACTIVITY_OFF))
511 #define IS_PREAMBLE_TYPE_MASK(VAL) (((VAL) == SPDIFRX_PREAMBLETYPEMASK_ON) || \
512  ((VAL) == SPDIFRX_PREAMBLETYPEMASK_OFF))
513 #define IS_VALIDITY_MASK(VAL) (((VAL) == SPDIFRX_VALIDITYMASK_OFF) || \
514  ((VAL) == SPDIFRX_VALIDITYMASK_ON))
515 #define IS_PARITY_ERROR_MASK(VAL) (((VAL) == SPDIFRX_PARITYERRORMASK_OFF) || \
516  ((VAL) == SPDIFRX_PARITYERRORMASK_ON))
517 #define IS_SPDIFRX_CHANNEL(CHANNEL) (((CHANNEL) == SPDIFRX_CHANNEL_A) || \
518  ((CHANNEL) == SPDIFRX_CHANNEL_B))
519 #define IS_SPDIFRX_DATA_FORMAT(FORMAT) (((FORMAT) == SPDIFRX_DATAFORMAT_LSB) || \
520  ((FORMAT) == SPDIFRX_DATAFORMAT_MSB) || \
521  ((FORMAT) == SPDIFRX_DATAFORMAT_32BITS))
522 #define IS_STEREO_MODE(MODE) (((MODE) == SPDIFRX_STEREOMODE_DISABLE) || \
523  ((MODE) == SPDIFRX_STEREOMODE_ENABLE))
524 
525 #define IS_CHANNEL_STATUS_MASK(VAL) (((VAL) == SPDIFRX_CHANNELSTATUS_ON) || \
526  ((VAL) == SPDIFRX_CHANNELSTATUS_OFF))
527 
531 /* Private functions ---------------------------------------------------------*/
546 #endif /* STM32F446xx */
547 
548 #ifdef __cplusplus
549 }
550 #endif
551 
552 
553 #endif /* __STM32F4xx_HAL_SPDIFRX_H */
554 
555 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
stm32f4xx_hal_def.h
This file contains HAL common defines, enumeration, macros and structures definitions.
SPDIFRX_TypeDef
SPDIFRX Interface.
Definition: stm32f446xx.h:746
HAL_StatusTypeDef
HAL_StatusTypeDef
HAL Status structures definition.
Definition: stm32f4xx_hal_def.h:57
__IO
#define __IO
Definition: core_cm0.h:213
HAL_LockTypeDef
HAL_LockTypeDef
HAL Lock structures definition.
Definition: stm32f4xx_hal_def.h:68
__DMA_HandleTypeDef
DMA handle Structure definition.
Definition: stm32f4xx_hal_dma.h:157