stm32f4xx_hal_i2s.h File Reference

Header file of I2S HAL module. More...

Go to the source code of this file.

Data Structures
struct	I2S_InitTypeDef
	I2S Init structure definition. More...
struct	__I2S_HandleTypeDef
	I2S handle Structure definition. More...

Typedefs
typedef struct __I2S_HandleTypeDef	I2S_HandleTypeDef
	I2S handle Structure definition.
typedef void(*	pI2S_CallbackTypeDef) (I2S_HandleTypeDef *hi2s)
	HAL I2S Callback pointer definition. More...

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...
enum	HAL_I2S_CallbackIDTypeDef {   HAL_I2S_TX_COMPLETE_CB_ID = 0x00U , HAL_I2S_RX_COMPLETE_CB_ID = 0x01U , HAL_I2S_TX_RX_COMPLETE_CB_ID = 0x02U , HAL_I2S_TX_HALF_COMPLETE_CB_ID = 0x03U ,   HAL_I2S_RX_HALF_COMPLETE_CB_ID = 0x04U , HAL_I2S_TX_RX_HALF_COMPLETE_CB_ID = 0x05U , HAL_I2S_ERROR_CB_ID = 0x06U , HAL_I2S_MSPINIT_CB_ID = 0x07U ,   HAL_I2S_MSPDEINIT_CB_ID = 0x08U }
	HAL I2S Callback ID enumeration definition. More...

Functions
HAL_StatusTypeDef	HAL_I2S_Init (I2S_HandleTypeDef *hi2s)
	Initializes the I2S according to the specified parameters in the I2S_InitTypeDef and create the associated handle. More...
HAL_StatusTypeDef	HAL_I2S_DeInit (I2S_HandleTypeDef *hi2s)
	DeInitializes the I2S peripheral. More...
void	HAL_I2S_MspInit (I2S_HandleTypeDef *hi2s)
	I2S MSP Init. More...
void	HAL_I2S_MspDeInit (I2S_HandleTypeDef *hi2s)
	I2S MSP DeInit. More...
HAL_StatusTypeDef	HAL_I2S_RegisterCallback (I2S_HandleTypeDef *hi2s, HAL_I2S_CallbackIDTypeDef CallbackID, pI2S_CallbackTypeDef pCallback)
	Register a User I2S Callback To be used instead of the weak predefined callback. More...
HAL_StatusTypeDef	HAL_I2S_UnRegisterCallback (I2S_HandleTypeDef *hi2s, HAL_I2S_CallbackIDTypeDef CallbackID)
	Unregister an I2S Callback I2S callback is redirected to the weak predefined callback. More...
HAL_StatusTypeDef	HAL_I2S_Transmit (I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout)
	Transmit an amount of data in blocking mode. More...
HAL_StatusTypeDef	HAL_I2S_Receive (I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout)
	Receive an amount of data in blocking mode. More...
HAL_StatusTypeDef	HAL_I2S_Transmit_IT (I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size)
	Transmit an amount of data in non-blocking mode with Interrupt. More...
HAL_StatusTypeDef	HAL_I2S_Receive_IT (I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size)
	Receive an amount of data in non-blocking mode with Interrupt. More...
void	HAL_I2S_IRQHandler (I2S_HandleTypeDef *hi2s)
	This function handles I2S interrupt request. More...
HAL_StatusTypeDef	HAL_I2S_Transmit_DMA (I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size)
	Transmit an amount of data in non-blocking mode with DMA. More...
HAL_StatusTypeDef	HAL_I2S_Receive_DMA (I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size)
	Receive an amount of data in non-blocking mode with DMA. More...
HAL_StatusTypeDef	HAL_I2S_DMAPause (I2S_HandleTypeDef *hi2s)
	Pauses the audio DMA Stream/Channel playing from the Media. More...
HAL_StatusTypeDef	HAL_I2S_DMAResume (I2S_HandleTypeDef *hi2s)
	Resumes the audio DMA Stream/Channel playing from the Media. More...
HAL_StatusTypeDef	HAL_I2S_DMAStop (I2S_HandleTypeDef *hi2s)
	Stops the audio DMA Stream/Channel playing from the Media. More...
void	HAL_I2S_TxHalfCpltCallback (I2S_HandleTypeDef *hi2s)
	Tx Transfer Half completed callbacks. More...
void	HAL_I2S_TxCpltCallback (I2S_HandleTypeDef *hi2s)
	Tx Transfer completed callbacks. More...
void	HAL_I2S_RxHalfCpltCallback (I2S_HandleTypeDef *hi2s)
	Rx Transfer half completed callbacks. More...
void	HAL_I2S_RxCpltCallback (I2S_HandleTypeDef *hi2s)
	Rx Transfer completed callbacks. More...
void	HAL_I2S_ErrorCallback (I2S_HandleTypeDef *hi2s)
	I2S error callbacks. More...
HAL_I2S_StateTypeDef	HAL_I2S_GetState (I2S_HandleTypeDef *hi2s)
	Return the I2S state. More...
uint32_t	HAL_I2S_GetError (I2S_HandleTypeDef *hi2s)
	Return the I2S error code. More...

Detailed Description

Header file of I2S HAL module.

Author

MCD Application Team

Attention

Copyright (c) 2016 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32f4xx_hal_i2s.h.