Header file of I2S HAL module. More...

#include "stm32f7xx_hal_def.h"

Data Structures
struct	I2S_InitTypeDef
	I2S Init structure definition. More...

struct	I2S_HandleTypeDef
	I2S handle Structure definition. More...

Macros
#define	HAL_I2S_ERROR_NONE ((uint32_t)0x00000000U)

#define	HAL_I2S_ERROR_TIMEOUT ((uint32_t)0x00000001U)

#define	HAL_I2S_ERROR_OVR ((uint32_t)0x00000002U)

#define	HAL_I2S_ERROR_UDR ((uint32_t)0x00000004U)

#define	HAL_I2S_ERROR_DMA ((uint32_t)0x00000008U)

#define	HAL_I2S_ERROR_UNKNOW ((uint32_t)0x00000010U)

#define	I2S_CLOCK_EXTERNAL ((uint32_t)0x00000001U)

#define	I2S_CLOCK_PLL ((uint32_t)0x00000002U)

#define	I2S_MODE_SLAVE_TX ((uint32_t)0x00000000U)

#define	I2S_MODE_SLAVE_RX ((uint32_t)0x00000100U)

#define	I2S_MODE_MASTER_TX ((uint32_t)0x00000200U)

#define	I2S_MODE_MASTER_RX ((uint32_t)0x00000300U)

#define	I2S_STANDARD_PHILIPS ((uint32_t)0x00000000U)

#define	I2S_STANDARD_MSB ((uint32_t)0x00000010U)

#define	I2S_STANDARD_LSB ((uint32_t)0x00000020U)

#define	I2S_STANDARD_PCM_SHORT ((uint32_t)0x00000030U)

#define	I2S_STANDARD_PCM_LONG ((uint32_t)0x000000B0U)

#define	I2S_DATAFORMAT_16B ((uint32_t)0x00000000U)

#define	I2S_DATAFORMAT_16B_EXTENDED ((uint32_t)0x00000001U)

#define	I2S_DATAFORMAT_24B ((uint32_t)0x00000003U)

#define	I2S_DATAFORMAT_32B ((uint32_t)0x00000005U)

#define	I2S_MCLKOUTPUT_ENABLE ((uint32_t)SPI_I2SPR_MCKOE)

#define	I2S_MCLKOUTPUT_DISABLE ((uint32_t)0x00000000U)

#define	I2S_AUDIOFREQ_192K ((uint32_t)192000U)

#define	I2S_AUDIOFREQ_96K ((uint32_t)96000U)

#define	I2S_AUDIOFREQ_48K ((uint32_t)48000U)

#define	I2S_AUDIOFREQ_44K ((uint32_t)44100U)

#define	I2S_AUDIOFREQ_32K ((uint32_t)32000U)

#define	I2S_AUDIOFREQ_22K ((uint32_t)22050U)

#define	I2S_AUDIOFREQ_16K ((uint32_t)16000U)

#define	I2S_AUDIOFREQ_11K ((uint32_t)11025U)

#define	I2S_AUDIOFREQ_8K ((uint32_t)8000U)

#define	I2S_AUDIOFREQ_DEFAULT ((uint32_t)2U)

#define	I2S_CPOL_LOW ((uint32_t)0x00000000U)

#define	I2S_CPOL_HIGH ((uint32_t)SPI_I2SCFGR_CKPOL)

#define	I2S_IT_TXE SPI_CR2_TXEIE

#define	I2S_IT_RXNE SPI_CR2_RXNEIE

#define	I2S_IT_ERR SPI_CR2_ERRIE

#define	I2S_FLAG_TXE SPI_SR_TXE

#define	I2S_FLAG_RXNE SPI_SR_RXNE

#define	I2S_FLAG_UDR SPI_SR_UDR

#define	I2S_FLAG_OVR SPI_SR_OVR

#define	I2S_FLAG_FRE SPI_SR_FRE

#define	I2S_FLAG_CHSIDE SPI_SR_CHSIDE

#define	I2S_FLAG_BSY SPI_SR_BSY

#define	__HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
	Reset I2S handle state. More...

#define	__HAL_I2S_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR \|= SPI_I2SCFGR_I2SE)
	Enable or disable the specified SPI peripheral (in I2S mode). More...

#define	__HAL_I2S_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR &= ~SPI_I2SCFGR_I2SE)

#define	__HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 \|= (__INTERRUPT__))
	Enable or disable the specified I2S interrupts. More...

#define	__HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 &= ~(__INTERRUPT__))

#define	__HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
	Checks if the specified I2S interrupt source is enabled or disabled. More...

#define	__HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
	Checks whether the specified I2S flag is set or not. More...

#define	__HAL_I2S_CLEAR_OVRFLAG(__HANDLE__)
	Clears the I2S OVR pending flag. More...

#define	__HAL_I2S_CLEAR_UDRFLAG(__HANDLE__)
	Clears the I2S UDR pending flag. More...

#define	IS_I2S_CLOCKSOURCE(CLOCK)

#define	IS_I2S_MODE(MODE)

#define	IS_I2S_STANDARD(STANDARD)

#define	IS_I2S_DATA_FORMAT(FORMAT)

#define	IS_I2S_MCLK_OUTPUT(OUTPUT)

#define	IS_I2S_AUDIO_FREQ(FREQ)

#define	IS_I2S_CPOL(CPOL)

Enumerations
enum	HAL_I2S_StateTypeDef { HAL_I2S_STATE_RESET = 0x00U, HAL_I2S_STATE_READY = 0x01U, HAL_I2S_STATE_BUSY = 0x02U, HAL_I2S_STATE_BUSY_TX = 0x03U, HAL_I2S_STATE_BUSY_RX = 0x04U, HAL_I2S_STATE_BUSY_TX_RX = 0x05U, HAL_I2S_STATE_TIMEOUT = 0x06U, HAL_I2S_STATE_ERROR = 0x07U }
	HAL State structures definition. More...

Functions
HAL_StatusTypeDef	HAL_I2S_Init (I2S_HandleTypeDef *hi2s)

HAL_StatusTypeDef	HAL_I2S_DeInit (I2S_HandleTypeDef *hi2s)

void	HAL_I2S_MspInit (I2S_HandleTypeDef *hi2s)

void	HAL_I2S_MspDeInit (I2S_HandleTypeDef *hi2s)

HAL_StatusTypeDef	HAL_I2S_Transmit (I2S_HandleTypeDef hi2s, uint16_t pData, uint16_t Size, uint32_t Timeout)

HAL_StatusTypeDef	HAL_I2S_Receive (I2S_HandleTypeDef hi2s, uint16_t pData, uint16_t Size, uint32_t Timeout)

HAL_StatusTypeDef	HAL_I2S_Transmit_IT (I2S_HandleTypeDef hi2s, uint16_t pData, uint16_t Size)

HAL_StatusTypeDef	HAL_I2S_Receive_IT (I2S_HandleTypeDef hi2s, uint16_t pData, uint16_t Size)

void	HAL_I2S_IRQHandler (I2S_HandleTypeDef *hi2s)

HAL_StatusTypeDef	HAL_I2S_Transmit_DMA (I2S_HandleTypeDef hi2s, uint16_t pData, uint16_t Size)

HAL_StatusTypeDef	HAL_I2S_Receive_DMA (I2S_HandleTypeDef hi2s, uint16_t pData, uint16_t Size)

HAL_StatusTypeDef	HAL_I2S_DMAPause (I2S_HandleTypeDef *hi2s)

HAL_StatusTypeDef	HAL_I2S_DMAResume (I2S_HandleTypeDef *hi2s)

HAL_StatusTypeDef	HAL_I2S_DMAStop (I2S_HandleTypeDef *hi2s)

void	HAL_I2S_TxHalfCpltCallback (I2S_HandleTypeDef *hi2s)

void	HAL_I2S_TxCpltCallback (I2S_HandleTypeDef *hi2s)

void	HAL_I2S_RxHalfCpltCallback (I2S_HandleTypeDef *hi2s)

void	HAL_I2S_RxCpltCallback (I2S_HandleTypeDef *hi2s)

void	HAL_I2S_ErrorCallback (I2S_HandleTypeDef *hi2s)

HAL_I2S_StateTypeDef	HAL_I2S_GetState (I2S_HandleTypeDef *hi2s)

uint32_t	HAL_I2S_GetError (I2S_HandleTypeDef *hi2s)

Detailed Description

Header file of I2S HAL module.

Author: MCD Application Team

Version: V1.1.0

Date: 22-April-2016

Attention

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

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
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.
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_i2s.h.

Data Structures

Macros

Enumerations

Functions

Detailed Description

© COPYRIGHT(c) 2016 STMicroelectronics