Data transfers functions. More...

Collaboration diagram for IO operation functions:

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

Detailed Description

Data transfers functions.

===============================================================================
                     ##### IO operation functions #####
===============================================================================
    [..]
    This subsection provides a set of functions allowing to manage the SPDIFRX data
    transfers.

    (#) There is two mode of transfer:
        (++) Blocking mode : The communication is performed in the polling mode.
             The status of all data processing is returned by the same function
             after finishing transfer.
        (++) No-Blocking mode : The communication is performed using Interrupts
             or DMA. These functions return the status of the transfer start-up.
             The end of the data processing will be indicated through the
             dedicated SPDIFRX IRQ when using Interrupt mode or the DMA IRQ when
             using DMA mode.

    (#) Blocking mode functions are :
        (++) HAL_SPDIFRX_ReceiveDataFlow()
        (++) HAL_SPDIFRX_ReceiveControlFlow()
                (+@) Do not use blocking mode to receive both control and data flow at the same time.

    (#) No-Blocking mode functions with Interrupt are :
        (++) HAL_SPDIFRX_ReceiveControlFlow_IT()
        (++) HAL_SPDIFRX_ReceiveDataFlow_IT()

    (#) No-Blocking mode functions with DMA are :
        (++) HAL_SPDIFRX_ReceiveControlFlow_DMA()
        (++) HAL_SPDIFRX_ReceiveDataFlow_DMA()

    (#) A set of Transfer Complete Callbacks are provided in No_Blocking mode:
        (++) HAL_SPDIFRX_RxCpltCallback()
        (++) HAL_SPDIFRX_CxCpltCallback()

Function Documentation

◆ HAL_SPDIFRX_CxCpltCallback()

__weak void HAL_SPDIFRX_CxCpltCallback ( SPDIFRX_HandleTypeDef * hspdif )

Rx Transfer (Control flow) completed callbacks.

Parameters

hspdif SPDIFRX handle

Return values

None

Definition at line 1359 of file stm32f4xx_hal_spdifrx.c.

◆ HAL_SPDIFRX_CxHalfCpltCallback()

__weak void HAL_SPDIFRX_CxHalfCpltCallback ( SPDIFRX_HandleTypeDef * hspdif )

Rx (Control flow) Transfer half completed callbacks.

Parameters

hspdif SPDIFRX handle

Return values

None

Definition at line 1344 of file stm32f4xx_hal_spdifrx.c.

◆ HAL_SPDIFRX_DMAStop()

HAL_StatusTypeDef HAL_SPDIFRX_DMAStop ( SPDIFRX_HandleTypeDef * hspdif )

stop the audio stream receive from the Media.

Parameters

hspdif SPDIFRX handle

Return values

None

Definition at line 1230 of file stm32f4xx_hal_spdifrx.c.

◆ HAL_SPDIFRX_ErrorCallback()

__weak void HAL_SPDIFRX_ErrorCallback ( SPDIFRX_HandleTypeDef * hspdif )

SPDIFRX error callbacks.

Parameters

hspdif SPDIFRX handle

Return values

None

Definition at line 1374 of file stm32f4xx_hal_spdifrx.c.

◆ HAL_SPDIFRX_IRQHandler()

void HAL_SPDIFRX_IRQHandler ( SPDIFRX_HandleTypeDef * hspdif )

This function handles SPDIFRX interrupt request.

Parameters

hspdif SPDIFRX handle

Return values

HAL status

Definition at line 1265 of file stm32f4xx_hal_spdifrx.c.

◆ HAL_SPDIFRX_ReceiveControlFlow()

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.

Parameters

hspdif	pointer to a SPDIFRX_HandleTypeDef structure that contains the configuration information for SPDIFRX module.
pData	Pointer to data buffer
Size	Amount of data to be received
Timeout	Timeout duration

Return values

HAL status

Definition at line 782 of file stm32f4xx_hal_spdifrx.c.

◆ HAL_SPDIFRX_ReceiveControlFlow_DMA()

HAL_StatusTypeDef HAL_SPDIFRX_ReceiveControlFlow_DMA	(	SPDIFRX_HandleTypeDef *	hspdif,
		uint32_t *	pData,
		uint16_t	Size
	)

Receive an amount of data (Control Flow) with DMA.

Parameters

hspdif	SPDIFRX handle
pData	a 32-bit pointer to the Receive data buffer.
Size	number of data (Control Flow) sample to be received

Return values

HAL status

Definition at line 1129 of file stm32f4xx_hal_spdifrx.c.

◆ HAL_SPDIFRX_ReceiveControlFlow_IT()

HAL_StatusTypeDef HAL_SPDIFRX_ReceiveControlFlow_IT	(	SPDIFRX_HandleTypeDef *	hspdif,
		uint32_t *	pData,
		uint16_t	Size
	)

Receive an amount of data (Control Flow) with Interrupt.

Parameters

hspdif	SPDIFRX handle
pData	a 32-bit pointer to the Receive data buffer.
Size	number of data sample (Control Flow) to be received

Return values

HAL status

Definition at line 940 of file stm32f4xx_hal_spdifrx.c.

◆ HAL_SPDIFRX_ReceiveDataFlow()

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.

Parameters

hspdif	pointer to SPDIFRX_HandleTypeDef structure that contains the configuration information for SPDIFRX module.
pData	Pointer to data buffer
Size	Amount of data to be received
Timeout	Timeout duration

Return values

HAL status

Definition at line 708 of file stm32f4xx_hal_spdifrx.c.

◆ HAL_SPDIFRX_ReceiveDataFlow_DMA()

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.

Parameters

hspdif	SPDIFRX handle
pData	a 32-bit pointer to the Receive data buffer.
Size	number of data sample to be received

Return values

HAL status

Definition at line 1026 of file stm32f4xx_hal_spdifrx.c.

◆ HAL_SPDIFRX_ReceiveDataFlow_IT()

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.

Parameters

hspdif	SPDIFRX handle
pData	a 32-bit pointer to the Receive data buffer.
Size	number of data sample to be received .

Return values

HAL status

Definition at line 854 of file stm32f4xx_hal_spdifrx.c.

◆ HAL_SPDIFRX_RxCpltCallback()

__weak void HAL_SPDIFRX_RxCpltCallback ( SPDIFRX_HandleTypeDef * hspdif )

Rx Transfer (Data flow) completed callbacks.

Parameters

hspdif SPDIFRX handle

Return values

None

Definition at line 1329 of file stm32f4xx_hal_spdifrx.c.

◆ HAL_SPDIFRX_RxHalfCpltCallback()

__weak void HAL_SPDIFRX_RxHalfCpltCallback ( SPDIFRX_HandleTypeDef * hspdif )

Rx Transfer (Data flow) half completed callbacks.

Parameters

hspdif SPDIFRX handle

Return values

None

Definition at line 1314 of file stm32f4xx_hal_spdifrx.c.

Functions

Detailed Description

Function Documentation

◆ HAL_SPDIFRX_CxCpltCallback()

◆ HAL_SPDIFRX_CxHalfCpltCallback()

◆ HAL_SPDIFRX_DMAStop()

◆ HAL_SPDIFRX_ErrorCallback()

◆ HAL_SPDIFRX_IRQHandler()

◆ HAL_SPDIFRX_ReceiveControlFlow()

◆ HAL_SPDIFRX_ReceiveControlFlow_DMA()

◆ HAL_SPDIFRX_ReceiveControlFlow_IT()

◆ HAL_SPDIFRX_ReceiveDataFlow()

◆ HAL_SPDIFRX_ReceiveDataFlow_DMA()

◆ HAL_SPDIFRX_ReceiveDataFlow_IT()

◆ HAL_SPDIFRX_RxCpltCallback()

◆ HAL_SPDIFRX_RxHalfCpltCallback()