Initialization and de-initialization functions

Initialization and Configuration functions. More...

Collaboration diagram for Initialization and de-initialization functions:

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...

Detailed Description

Initialization and Configuration functions.

===============================================================================
##### Initialization and de-initialization functions #####
===============================================================================
[..]  This subsection provides a set of functions allowing to initialize and
      de-initialize the SPDIFRX peripheral:

(+) User must Implement HAL_SPDIFRX_MspInit() function in which he configures
    all related peripherals resources (CLOCK, GPIO, DMA, IT and NVIC ).

(+) Call the function HAL_SPDIFRX_Init() to configure the SPDIFRX peripheral with
    the selected configuration:
(++) Input Selection (IN0, IN1,...)
(++) Maximum allowed re-tries during synchronization phase
(++) Wait for activity on SPDIF selected input
(++) Channel status selection (from channel A or B)
(++) Data format (LSB, MSB, ...)
(++) Stereo mode
(++) User bits masking (PT,C,U,V,...)

(+) Call the function HAL_SPDIFRX_DeInit() to restore the default configuration
    of the selected SPDIFRXx peripheral.

Function Documentation

HAL_SPDIFRX_DeInit()

HAL_StatusTypeDef HAL_SPDIFRX_DeInit

(

SPDIFRX_HandleTypeDef *

hspdif

)

DeInitializes the SPDIFRX peripheral.

Parameters

hspdif

SPDIFRX handle

Return values

HAL

status

Definition at line 339 of file stm32f4xx_hal_spdifrx.c.

HAL_SPDIFRX_Init()

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.

Parameters

hspdif

SPDIFRX handle

Return values

HAL

status

Definition at line 244 of file stm32f4xx_hal_spdifrx.c.

HAL_SPDIFRX_MspDeInit()

__weak void HAL_SPDIFRX_MspDeInit

(

SPDIFRX_HandleTypeDef *

hspdif

)

SPDIFRX MSP DeInit.

Parameters

hspdif

SPDIFRX handle

Return values

None

Definition at line 399 of file stm32f4xx_hal_spdifrx.c.

HAL_SPDIFRX_MspInit()

__weak void HAL_SPDIFRX_MspInit

(

SPDIFRX_HandleTypeDef *

hspdif

)

SPDIFRX MSP Init.

Parameters

hspdif

SPDIFRX handle

Return values

None

Definition at line 384 of file stm32f4xx_hal_spdifrx.c.

HAL_SPDIFRX_RegisterCallback()

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.

Parameters

hspdif	SPDIFRX handle
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_SPDIFRX_RX_HALF_CB_ID SPDIFRX Data flow half completed callback ID HAL_SPDIFRX_RX_CPLT_CB_ID SPDIFRX Data flow completed callback ID HAL_SPDIFRX_CX_HALF_CB_ID SPDIFRX Control flow half completed callback ID HAL_SPDIFRX_CX_CPLT_CB_ID SPDIFRX Control flow completed callback ID HAL_SPDIFRX_ERROR_CB_ID SPDIFRX error callback ID HAL_SPDIFRX_MSPINIT_CB_ID MspInit callback ID HAL_SPDIFRX_MSPDEINIT_CB_ID MspDeInit callback ID
pCallback	pointer to the Callback function

Return values

HAL

status

Definition at line 426 of file stm32f4xx_hal_spdifrx.c.

HAL_SPDIFRX_SetDataFormat()

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.

Parameters

hspdif	SPDIFRX handle
sDataFormat	SPDIFRX data format

Return values

HAL

status

Definition at line 609 of file stm32f4xx_hal_spdifrx.c.

HAL_SPDIFRX_UnRegisterCallback()

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.

Parameters

hspdif

SPDIFRX handle

CallbackID

ID of the callback to be unregistered This parameter can be one of the following values: HAL_SPDIFRX_RX_HALF_CB_ID SPDIFRX Data flow half completed callback ID HAL_SPDIFRX_RX_CPLT_CB_ID SPDIFRX Data flow completed callback ID HAL_SPDIFRX_CX_HALF_CB_ID SPDIFRX Control flow half completed callback ID HAL_SPDIFRX_CX_CPLT_CB_ID SPDIFRX Control flow completed callback ID HAL_SPDIFRX_ERROR_CB_ID SPDIFRX error callback ID HAL_SPDIFRX_MSPINIT_CB_ID MspInit callback ID HAL_SPDIFRX_MSPDEINIT_CB_ID MspDeInit callback ID

Return values

HAL

status

Definition at line 528 of file stm32f4xx_hal_spdifrx.c.