STM32F4xx_HAL_Driver  1.8.3
stm32f4xx_hal_spdifrx.h File Reference

Header file of SPDIFRX HAL module. More...

Go to the source code of this file.

Data Structures

struct  SPDIFRX_InitTypeDef
 SPDIFRX Init structure definition. More...
 
struct  SPDIFRX_SetDataFormatTypeDef
 SPDIFRX SetDataFormat structure definition. More...
 
struct  endif
 ADC handle Structure definition. More...
 

Typedefs

typedef struct __SPDIFRX_HandleTypeDef else typedef struct endif SPDIFRX_HandleTypeDef
 SPDIFRX handle Structure definition.
 
typedef void(* pSPDIFRX_CallbackTypeDef) (SPDIFRX_HandleTypeDef *hspdif)
 HAL SPDIFRX Callback pointer definition. More...
 

Enumerations

enum  HAL_SPDIFRX_StateTypeDef {
  HAL_SPDIFRX_STATE_RESET = 0x00U , HAL_SPDIFRX_STATE_READY = 0x01U , HAL_SPDIFRX_STATE_BUSY = 0x02U , HAL_SPDIFRX_STATE_BUSY_RX = 0x03U ,
  HAL_SPDIFRX_STATE_BUSY_CX = 0x04U , HAL_SPDIFRX_STATE_ERROR = 0x07U
}
 HAL State structures definition. More...
 
enum  HAL_SPDIFRX_CallbackIDTypeDef {
  HAL_SPDIFRX_RX_HALF_CB_ID = 0x00U , HAL_SPDIFRX_RX_CPLT_CB_ID = 0x01U , HAL_SPDIFRX_CX_HALF_CB_ID = 0x02U , HAL_SPDIFRX_CX_CPLT_CB_ID = 0x03U ,
  HAL_SPDIFRX_ERROR_CB_ID = 0x04U , HAL_SPDIFRX_MSPINIT_CB_ID = 0x05U , HAL_SPDIFRX_MSPDEINIT_CB_ID = 0x06U
}
 HAL SPDIFRX Callback ID enumeration definition. More...
 

Functions

HAL_StatusTypeDef HAL_SPDIFRX_Init (SPDIFRX_HandleTypeDef *hspdif)
 Initializes the SPDIFRX according to the specified parameters in the SPDIFRX_InitTypeDef and create the associated handle. More...
 
HAL_StatusTypeDef HAL_SPDIFRX_DeInit (SPDIFRX_HandleTypeDef *hspdif)
 DeInitializes the SPDIFRX peripheral. More...
 
void HAL_SPDIFRX_MspInit (SPDIFRX_HandleTypeDef *hspdif)
 SPDIFRX MSP Init. More...
 
void HAL_SPDIFRX_MspDeInit (SPDIFRX_HandleTypeDef *hspdif)
 SPDIFRX MSP DeInit. More...
 
HAL_StatusTypeDef HAL_SPDIFRX_SetDataFormat (SPDIFRX_HandleTypeDef *hspdif, SPDIFRX_SetDataFormatTypeDef sDataFormat)
 Set the SPDIFRX data format according to the specified parameters in the SPDIFRX_InitTypeDef. More...
 
HAL_StatusTypeDef HAL_SPDIFRX_RegisterCallback (SPDIFRX_HandleTypeDef *hspdif, HAL_SPDIFRX_CallbackIDTypeDef CallbackID, pSPDIFRX_CallbackTypeDef pCallback)
 Register a User SPDIFRX Callback To be used instead of the weak predefined callback. More...
 
HAL_StatusTypeDef HAL_SPDIFRX_UnRegisterCallback (SPDIFRX_HandleTypeDef *hspdif, HAL_SPDIFRX_CallbackIDTypeDef CallbackID)
 Unregister a SPDIFRX Callback SPDIFRX callback is redirected to the weak predefined callback. More...
 
HAL_StatusTypeDef HAL_SPDIFRX_ReceiveDataFlow (SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size, uint32_t Timeout)
 Receives an amount of data (Data Flow) in blocking mode. More...
 
HAL_StatusTypeDef HAL_SPDIFRX_ReceiveControlFlow (SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size, uint32_t Timeout)
 Receives an amount of data (Control Flow) in blocking mode. More...
 
HAL_StatusTypeDef HAL_SPDIFRX_ReceiveControlFlow_IT (SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size)
 Receive an amount of data (Control Flow) with Interrupt. More...
 
HAL_StatusTypeDef HAL_SPDIFRX_ReceiveDataFlow_IT (SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size)
 Receive an amount of data (Data Flow) in non-blocking mode with Interrupt. More...
 
void HAL_SPDIFRX_IRQHandler (SPDIFRX_HandleTypeDef *hspdif)
 This function handles SPDIFRX interrupt request. More...
 
HAL_StatusTypeDef HAL_SPDIFRX_ReceiveControlFlow_DMA (SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size)
 Receive an amount of data (Control Flow) with DMA. More...
 
HAL_StatusTypeDef HAL_SPDIFRX_ReceiveDataFlow_DMA (SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size)
 Receive an amount of data (Data Flow) mode with DMA. More...
 
HAL_StatusTypeDef HAL_SPDIFRX_DMAStop (SPDIFRX_HandleTypeDef *hspdif)
 stop the audio stream receive from the Media. More...
 
void HAL_SPDIFRX_RxHalfCpltCallback (SPDIFRX_HandleTypeDef *hspdif)
 Rx Transfer (Data flow) half completed callbacks. More...
 
void HAL_SPDIFRX_RxCpltCallback (SPDIFRX_HandleTypeDef *hspdif)
 Rx Transfer (Data flow) completed callbacks. More...
 
void HAL_SPDIFRX_ErrorCallback (SPDIFRX_HandleTypeDef *hspdif)
 SPDIFRX error callbacks. More...
 
void HAL_SPDIFRX_CxHalfCpltCallback (SPDIFRX_HandleTypeDef *hspdif)
 Rx (Control flow) Transfer half completed callbacks. More...
 
void HAL_SPDIFRX_CxCpltCallback (SPDIFRX_HandleTypeDef *hspdif)
 Rx Transfer (Control flow) completed callbacks. More...
 
HAL_SPDIFRX_StateTypeDef HAL_SPDIFRX_GetState (SPDIFRX_HandleTypeDef const *const hspdif)
 Return the SPDIFRX state. More...
 
uint32_t HAL_SPDIFRX_GetError (SPDIFRX_HandleTypeDef const *const hspdif)
 Return the SPDIFRX error code. More...
 

Detailed Description

Header file of SPDIFRX HAL module.

Author
MCD Application Team
Attention

Copyright (c) 2016 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32f4xx_hal_spdifrx.h.