I2S Exported Types

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

---

Typedef Documentation

typedef struct __I2S_HandleTypeDef I2S_HandleTypeDef

I2S handle Structure definition.

typedef void(* pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s)

HAL I2S Callback pointer definition.

pointer to an I2S callback function

Definition at line 161 of file stm32f4xx_hal_i2s.h.

---

Enumeration Type Documentation

enum HAL_I2S_CallbackIDTypeDef

HAL I2S Callback ID enumeration definition.

Enumerator:

HAL_I2S_TX_COMPLETE_CB_ID	I2S Tx Completed callback ID
HAL_I2S_RX_COMPLETE_CB_ID	I2S Rx Completed callback ID
HAL_I2S_TX_RX_COMPLETE_CB_ID	I2S TxRx Completed callback ID
HAL_I2S_TX_HALF_COMPLETE_CB_ID	I2S Tx Half Completed callback ID
HAL_I2S_RX_HALF_COMPLETE_CB_ID	I2S Rx Half Completed callback ID
HAL_I2S_TX_RX_HALF_COMPLETE_CB_ID	I2S TxRx Half Completed callback ID
HAL_I2S_ERROR_CB_ID	I2S Error callback ID
HAL_I2S_MSPINIT_CB_ID	I2S Msp Init callback ID
HAL_I2S_MSPDEINIT_CB_ID	I2S Msp DeInit callback ID

Definition at line 144 of file stm32f4xx_hal_i2s.h.

enum HAL_I2S_StateTypeDef

HAL State structures definition.

Enumerator:

HAL_I2S_STATE_RESET	I2S not yet initialized or disabled
HAL_I2S_STATE_READY	I2S initialized and ready for use
HAL_I2S_STATE_BUSY	I2S internal process is ongoing
HAL_I2S_STATE_BUSY_TX	Data Transmission process is ongoing
HAL_I2S_STATE_BUSY_RX	Data Reception process is ongoing
HAL_I2S_STATE_BUSY_TX_RX	Data Transmission and Reception process is ongoing
HAL_I2S_STATE_TIMEOUT	I2S timeout state
HAL_I2S_STATE_ERROR	I2S error state

Definition at line 76 of file stm32f4xx_hal_i2s.h.