stm32f7xx_hal_spdifrx.h File Reference

Header file of SPDIFRX HAL module. More...

#include "stm32f7xx_hal_def.h"

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	SPDIFRX_HandleTypeDef
	SPDIFRX handle Structure definition. More...

Macros
#define	HAL_SPDIFRX_ERROR_NONE   ((uint32_t)0x00000000U)
#define	HAL_SPDIFRX_ERROR_TIMEOUT   ((uint32_t)0x00000001U)
#define	HAL_SPDIFRX_ERROR_OVR   ((uint32_t)0x00000002U)
#define	HAL_SPDIFRX_ERROR_PE   ((uint32_t)0x00000004U)
#define	HAL_SPDIFRX_ERROR_DMA   ((uint32_t)0x00000008U)
#define	HAL_SPDIFRX_ERROR_UNKNOWN   ((uint32_t)0x00000010U)
#define	SPDIFRX_INPUT_IN0   ((uint32_t)0x00000000U)
#define	SPDIFRX_INPUT_IN1   ((uint32_t)0x00010000U)
#define	SPDIFRX_INPUT_IN2   ((uint32_t)0x00020000U)
#define	SPDIFRX_INPUT_IN3   ((uint32_t)0x00030000U)
#define	SPDIFRX_MAXRETRIES_NONE   ((uint32_t)0x00000000U)
#define	SPDIFRX_MAXRETRIES_3   ((uint32_t)0x00001000U)
#define	SPDIFRX_MAXRETRIES_15   ((uint32_t)0x00002000U)
#define	SPDIFRX_MAXRETRIES_63   ((uint32_t)0x00003000U)
#define	SPDIFRX_WAITFORACTIVITY_OFF   ((uint32_t)0x00000000U)
#define	SPDIFRX_WAITFORACTIVITY_ON   ((uint32_t)SPDIFRX_CR_WFA)
#define	SPDIFRX_PREAMBLETYPEMASK_OFF   ((uint32_t)0x00000000U)
#define	SPDIFRX_PREAMBLETYPEMASK_ON   ((uint32_t)SPDIFRX_CR_PTMSK)
#define	SPDIFRX_CHANNELSTATUS_OFF   ((uint32_t)0x00000000U) /* The channel status and user bits are copied into the SPDIF_DR */
#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*/
#define	SPDIFRX_VALIDITYMASK_OFF   ((uint32_t)0x00000000U)
#define	SPDIFRX_VALIDITYMASK_ON   ((uint32_t)SPDIFRX_CR_VMSK)
#define	SPDIFRX_PARITYERRORMASK_OFF   ((uint32_t)0x00000000U)
#define	SPDIFRX_PARITYERRORMASK_ON   ((uint32_t)SPDIFRX_CR_PMSK)
#define	SPDIFRX_CHANNEL_A   ((uint32_t)0x00000000U)
#define	SPDIFRX_CHANNEL_B   ((uint32_t)SPDIFRX_CR_CHSEL)
#define	SPDIFRX_DATAFORMAT_LSB   ((uint32_t)0x00000000U)
#define	SPDIFRX_DATAFORMAT_MSB   ((uint32_t)0x00000010U)
#define	SPDIFRX_DATAFORMAT_32BITS   ((uint32_t)0x00000020U)
#define	SPDIFRX_STEREOMODE_DISABLE   ((uint32_t)0x00000000U)
#define	SPDIFRX_STEREOMODE_ENABLE   ((uint32_t)SPDIFRX_CR_RXSTEO)
#define	SPDIFRX_STATE_IDLE   ((uint32_t)0xFFFFFFFCU)
#define	SPDIFRX_STATE_SYNC   ((uint32_t)0x00000001U)
#define	SPDIFRX_STATE_RCV   ((uint32_t)SPDIFRX_CR_SPDIFEN)
#define	SPDIFRX_IT_RXNE   ((uint32_t)SPDIFRX_IMR_RXNEIE)
#define	SPDIFRX_IT_CSRNE   ((uint32_t)SPDIFRX_IMR_CSRNEIE)
#define	SPDIFRX_IT_PERRIE   ((uint32_t)SPDIFRX_IMR_PERRIE)
#define	SPDIFRX_IT_OVRIE   ((uint32_t)SPDIFRX_IMR_OVRIE)
#define	SPDIFRX_IT_SBLKIE   ((uint32_t)SPDIFRX_IMR_SBLKIE)
#define	SPDIFRX_IT_SYNCDIE   ((uint32_t)SPDIFRX_IMR_SYNCDIE)
#define	SPDIFRX_IT_IFEIE   ((uint32_t)SPDIFRX_IMR_IFEIE )
#define	SPDIFRX_FLAG_RXNE   ((uint32_t)SPDIFRX_SR_RXNE)
#define	SPDIFRX_FLAG_CSRNE   ((uint32_t)SPDIFRX_SR_CSRNE)
#define	SPDIFRX_FLAG_PERR   ((uint32_t)SPDIFRX_SR_PERR)
#define	SPDIFRX_FLAG_OVR   ((uint32_t)SPDIFRX_SR_OVR)
#define	SPDIFRX_FLAG_SBD   ((uint32_t)SPDIFRX_SR_SBD)
#define	SPDIFRX_FLAG_SYNCD   ((uint32_t)SPDIFRX_SR_SYNCD)
#define	SPDIFRX_FLAG_FERR   ((uint32_t)SPDIFRX_SR_FERR)
#define	SPDIFRX_FLAG_SERR   ((uint32_t)SPDIFRX_SR_SERR)
#define	SPDIFRX_FLAG_TERR   ((uint32_t)SPDIFRX_SR_TERR)
#define	__HAL_SPDIFRX_RESET_HANDLE_STATE(__HANDLE__)   ((__HANDLE__)->State = (uint16_t)SPDIFRX_CR_SPDIFEN)
	Reset SPDIFRX handle state. More...
#define	__HAL_SPDIFRX_IDLE(__HANDLE__)   ((__HANDLE__)->Instance->CR &= SPDIFRX_STATE_IDLE)
	Disable the specified SPDIFRX peripheral (IDLE State). More...
#define	__HAL_SPDIFRX_SYNC(__HANDLE__)   ((__HANDLE__)->Instance->CR |= SPDIFRX_STATE_SYNC)
	Enable the specified SPDIFRX peripheral (SYNC State). More...
#define	__HAL_SPDIFRX_RCV(__HANDLE__)   ((__HANDLE__)->Instance->CR |= SPDIFRX_STATE_RCV)
	Enable the specified SPDIFRX peripheral (RCV State). More...
#define	__HAL_SPDIFRX_ENABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->IMR |= (__INTERRUPT__))
	Enable or disable the specified SPDIFRX interrupts. More...
#define	__HAL_SPDIFRX_DISABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->IMR &= (uint16_t)(~(__INTERRUPT__)))
#define	__HAL_SPDIFRX_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)   ((((__HANDLE__)->Instance->IMR & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
	Checks if the specified SPDIFRX interrupt source is enabled or disabled. More...
#define	__HAL_SPDIFRX_GET_FLAG(__HANDLE__, __FLAG__)   ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
	Checks whether the specified SPDIFRX flag is set or not. More...
#define	__HAL_SPDIFRX_CLEAR_IT(__HANDLE__, __IT_CLEAR__)   ((__HANDLE__)->Instance->IFCR = (uint32_t)(__IT_CLEAR__))
	Clears the specified SPDIFRX SR flag, in setting the proper IFCR register bit. More...
#define	IS_SPDIFRX_INPUT_SELECT(INPUT)
#define	IS_SPDIFRX_MAX_RETRIES(RET)
#define	IS_SPDIFRX_WAIT_FOR_ACTIVITY(VAL)
#define	IS_PREAMBLE_TYPE_MASK(VAL)
#define	IS_VALIDITY_MASK(VAL)
#define	IS_PARITY_ERROR_MASK(VAL)
#define	IS_SPDIFRX_CHANNEL(CHANNEL)
#define	IS_SPDIFRX_DATA_FORMAT(FORMAT)
#define	IS_STEREO_MODE(MODE)
#define	IS_CHANNEL_STATUS_MASK(VAL)

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

Functions
HAL_StatusTypeDef	HAL_SPDIFRX_Init (SPDIFRX_HandleTypeDef *hspdif)
HAL_StatusTypeDef	HAL_SPDIFRX_DeInit (SPDIFRX_HandleTypeDef *hspdif)
void	HAL_SPDIFRX_MspInit (SPDIFRX_HandleTypeDef *hspdif)
	SPDIFRX MSP Init. More...
void	HAL_SPDIFRX_MspDeInit (SPDIFRX_HandleTypeDef *hspdif)
HAL_StatusTypeDef	HAL_SPDIFRX_SetDataFormat (SPDIFRX_HandleTypeDef *hspdif, SPDIFRX_SetDataFormatTypeDef sDataFormat)
HAL_StatusTypeDef	HAL_SPDIFRX_ReceiveDataFlow (SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size, uint32_t Timeout)
HAL_StatusTypeDef	HAL_SPDIFRX_ReceiveControlFlow (SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size, uint32_t Timeout)
HAL_StatusTypeDef	HAL_SPDIFRX_ReceiveControlFlow_IT (SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size)
HAL_StatusTypeDef	HAL_SPDIFRX_ReceiveDataFlow_IT (SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size)
void	HAL_SPDIFRX_IRQHandler (SPDIFRX_HandleTypeDef *hspdif)
HAL_StatusTypeDef	HAL_SPDIFRX_ReceiveControlFlow_DMA (SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size)
HAL_StatusTypeDef	HAL_SPDIFRX_ReceiveDataFlow_DMA (SPDIFRX_HandleTypeDef *hspdif, uint32_t *pData, uint16_t Size)
HAL_StatusTypeDef	HAL_SPDIFRX_DMAStop (SPDIFRX_HandleTypeDef *hspdif)
void	HAL_SPDIFRX_RxHalfCpltCallback (SPDIFRX_HandleTypeDef *hspdif)
void	HAL_SPDIFRX_RxCpltCallback (SPDIFRX_HandleTypeDef *hspdif)
void	HAL_SPDIFRX_ErrorCallback (SPDIFRX_HandleTypeDef *hspdif)
void	HAL_SPDIFRX_CxHalfCpltCallback (SPDIFRX_HandleTypeDef *hspdif)
void	HAL_SPDIFRX_CxCpltCallback (SPDIFRX_HandleTypeDef *hspdif)
HAL_SPDIFRX_StateTypeDef	HAL_SPDIFRX_GetState (SPDIFRX_HandleTypeDef *hspdif)
uint32_t	HAL_SPDIFRX_GetError (SPDIFRX_HandleTypeDef *hspdif)

Detailed Description

Header file of SPDIFRX HAL module.

Author

MCD Application Team

Version

V1.1.0

Date

22-April-2016

Attention

© COPYRIGHT(c) 2016 STMicroelectronics

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file stm32f7xx_hal_spdifrx.h.