Initialization and de-initialization functions

Initialization and Configuration functions. 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.
HAL_StatusTypeDef	HAL_SPDIFRX_DeInit (SPDIFRX_HandleTypeDef *hspdif)
	DeInitializes the SPDIFRX peripheral.
__weak void	HAL_SPDIFRX_MspInit (SPDIFRX_HandleTypeDef *hspdif)
	SPDIFRX MSP Init.
__weak void	HAL_SPDIFRX_MspDeInit (SPDIFRX_HandleTypeDef *hspdif)
	SPDIFRX MSP DeInit.
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.
HAL_StatusTypeDef	HAL_SPDIFRX_UnRegisterCallback (SPDIFRX_HandleTypeDef *hspdif, HAL_SPDIFRX_CallbackIDTypeDef CallbackID)
	Unregister a SPDIFRX Callback SPDIFRX callabck is redirected to the weak predefined callback.
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.

---

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_StatusTypeDef HAL_SPDIFRX_DeInit

(

SPDIFRX_HandleTypeDef *

hspdif

)

DeInitializes the SPDIFRX peripheral.

Parameters:

hspdif

SPDIFRX handle

Return values:

HAL

status

Definition at line 343 of file stm32h7xx_hal_spdifrx.c.

References __HAL_SPDIFRX_IDLE, assert_param, __SPDIFRX_HandleTypeDef::ErrorCode, HAL_SPDIFRX_ERROR_NONE, HAL_SPDIFRX_MspDeInit(), HAL_SPDIFRX_STATE_BUSY, HAL_SPDIFRX_STATE_RESET, __SPDIFRX_HandleTypeDef::Instance, __SPDIFRX_HandleTypeDef::MspDeInitCallback, and __SPDIFRX_HandleTypeDef::State.

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 236 of file stm32h7xx_hal_spdifrx.c.

References __HAL_SPDIFRX_IDLE, assert_param, SPDIFRX_InitTypeDef::BackupSymbolClockGen, SPDIFRX_InitTypeDef::ChannelSelection, SPDIFRX_InitTypeDef::ChannelStatusMask, __SPDIFRX_HandleTypeDef::CxCpltCallback, __SPDIFRX_HandleTypeDef::CxHalfCpltCallback, SPDIFRX_InitTypeDef::DataFormat, __SPDIFRX_HandleTypeDef::ErrorCallback, __SPDIFRX_HandleTypeDef::ErrorCode, HAL_SPDIFRX_CxCpltCallback(), HAL_SPDIFRX_CxHalfCpltCallback(), HAL_SPDIFRX_ERROR_NONE, HAL_SPDIFRX_ErrorCallback(), HAL_SPDIFRX_MspInit(), HAL_SPDIFRX_RxCpltCallback(), HAL_SPDIFRX_RxHalfCpltCallback(), HAL_SPDIFRX_STATE_BUSY, HAL_SPDIFRX_STATE_READY, HAL_SPDIFRX_STATE_RESET, __SPDIFRX_HandleTypeDef::Init, SPDIFRX_InitTypeDef::InputSelection, __SPDIFRX_HandleTypeDef::Instance, IS_CHANNEL_STATUS_MASK, IS_PARITY_ERROR_MASK, IS_PREAMBLE_TYPE_MASK, IS_SPDIFRX_CHANNEL, IS_SPDIFRX_DATA_FORMAT, IS_SPDIFRX_INPUT_SELECT, IS_SPDIFRX_MAX_RETRIES, IS_SPDIFRX_WAIT_FOR_ACTIVITY, IS_STEREO_MODE, IS_SYMBOL_CLOCK_GEN, IS_VALIDITY_MASK, __SPDIFRX_HandleTypeDef::Lock, __SPDIFRX_HandleTypeDef::MspInitCallback, SPDIFRX_InitTypeDef::ParityErrorMask, SPDIFRX_InitTypeDef::PreambleTypeMask, SPDIFRX_InitTypeDef::Retries, __SPDIFRX_HandleTypeDef::RxCpltCallback, __SPDIFRX_HandleTypeDef::RxHalfCpltCallback, __SPDIFRX_HandleTypeDef::State, SPDIFRX_InitTypeDef::StereoMode, SPDIFRX_InitTypeDef::SymbolClockGen, SPDIFRX_InitTypeDef::ValidityBitMask, and SPDIFRX_InitTypeDef::WaitForActivity.

void HAL_SPDIFRX_MspDeInit

(

SPDIFRX_HandleTypeDef *

hspdif

)

SPDIFRX MSP DeInit.

Parameters:

hspdif

SPDIFRX handle

Return values:

None

Definition at line 403 of file stm32h7xx_hal_spdifrx.c.

Referenced by HAL_SPDIFRX_DeInit(), and HAL_SPDIFRX_UnRegisterCallback().

void HAL_SPDIFRX_MspInit

(

SPDIFRX_HandleTypeDef *

hspdif

)

SPDIFRX MSP Init.

Parameters:

hspdif

SPDIFRX handle

Return values:

None

Definition at line 388 of file stm32h7xx_hal_spdifrx.c.

Referenced by HAL_SPDIFRX_Init(), and HAL_SPDIFRX_UnRegisterCallback().

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 430 of file stm32h7xx_hal_spdifrx.c.

References __SPDIFRX_HandleTypeDef::CxCpltCallback, __SPDIFRX_HandleTypeDef::CxHalfCpltCallback, __SPDIFRX_HandleTypeDef::ErrorCallback, __SPDIFRX_HandleTypeDef::ErrorCode, HAL_SPDIFRX_CX_CPLT_CB_ID, HAL_SPDIFRX_CX_HALF_CB_ID, HAL_SPDIFRX_ERROR_CB_ID, HAL_SPDIFRX_ERROR_INVALID_CALLBACK, HAL_SPDIFRX_MSPDEINIT_CB_ID, HAL_SPDIFRX_MSPINIT_CB_ID, HAL_SPDIFRX_RX_CPLT_CB_ID, HAL_SPDIFRX_RX_HALF_CB_ID, HAL_SPDIFRX_STATE_READY, HAL_SPDIFRX_STATE_RESET, __SPDIFRX_HandleTypeDef::MspDeInitCallback, __SPDIFRX_HandleTypeDef::MspInitCallback, __SPDIFRX_HandleTypeDef::RxCpltCallback, __SPDIFRX_HandleTypeDef::RxHalfCpltCallback, and __SPDIFRX_HandleTypeDef::State.

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 611 of file stm32h7xx_hal_spdifrx.c.

References assert_param, SPDIFRX_SetDataFormatTypeDef::ChannelStatusMask, SPDIFRX_SetDataFormatTypeDef::DataFormat, __SPDIFRX_HandleTypeDef::Instance, IS_CHANNEL_STATUS_MASK, IS_PARITY_ERROR_MASK, IS_PREAMBLE_TYPE_MASK, IS_SPDIFRX_DATA_FORMAT, IS_STEREO_MODE, IS_VALIDITY_MASK, SPDIFRX_SetDataFormatTypeDef::ParityErrorMask, SPDIFRX_SetDataFormatTypeDef::PreambleTypeMask, SPDIFRX_STATE_RCV, SPDIFRX_SetDataFormatTypeDef::StereoMode, and SPDIFRX_SetDataFormatTypeDef::ValidityBitMask.

HAL_StatusTypeDef HAL_SPDIFRX_UnRegisterCallback	(	SPDIFRX_HandleTypeDef *	hspdif,
		HAL_SPDIFRX_CallbackIDTypeDef	CallbackID
	)

Unregister a SPDIFRX Callback SPDIFRX callabck 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 531 of file stm32h7xx_hal_spdifrx.c.

References __SPDIFRX_HandleTypeDef::CxCpltCallback, __SPDIFRX_HandleTypeDef::CxHalfCpltCallback, __SPDIFRX_HandleTypeDef::ErrorCallback, __SPDIFRX_HandleTypeDef::ErrorCode, HAL_SPDIFRX_CX_CPLT_CB_ID, HAL_SPDIFRX_CX_HALF_CB_ID, HAL_SPDIFRX_CxCpltCallback(), HAL_SPDIFRX_CxHalfCpltCallback(), HAL_SPDIFRX_ERROR_CB_ID, HAL_SPDIFRX_ERROR_INVALID_CALLBACK, HAL_SPDIFRX_ErrorCallback(), HAL_SPDIFRX_MspDeInit(), HAL_SPDIFRX_MSPDEINIT_CB_ID, HAL_SPDIFRX_MspInit(), HAL_SPDIFRX_MSPINIT_CB_ID, HAL_SPDIFRX_RX_CPLT_CB_ID, HAL_SPDIFRX_RX_HALF_CB_ID, HAL_SPDIFRX_RxCpltCallback(), HAL_SPDIFRX_RxHalfCpltCallback(), HAL_SPDIFRX_STATE_READY, HAL_SPDIFRX_STATE_RESET, __SPDIFRX_HandleTypeDef::MspDeInitCallback, __SPDIFRX_HandleTypeDef::MspInitCallback, __SPDIFRX_HandleTypeDef::RxCpltCallback, __SPDIFRX_HandleTypeDef::RxHalfCpltCallback, and __SPDIFRX_HandleTypeDef::State.