I2S handle Structure definition. More...

#include <stm32f4xx_hal_i2s.h>

Data Fields
SPI_TypeDef *	Instance
I2S_InitTypeDef	Init
uint16_t *	pTxBuffPtr
__IO uint16_t	TxXferSize
__IO uint16_t	TxXferCount
uint16_t *	pRxBuffPtr
__IO uint16_t	RxXferSize
__IO uint16_t	RxXferCount
void(*	IrqHandlerISR )(struct __I2S_HandleTypeDef *hi2s)
DMA_HandleTypeDef *	hdmatx
DMA_HandleTypeDef *	hdmarx
__IO HAL_LockTypeDef	Lock
__IO HAL_I2S_StateTypeDef	State
__IO uint32_t	ErrorCode
void(*	TxCpltCallback )(struct __I2S_HandleTypeDef *hi2s)
void(*	RxCpltCallback )(struct __I2S_HandleTypeDef *hi2s)
void(*	TxRxCpltCallback )(struct __I2S_HandleTypeDef *hi2s)
void(*	TxHalfCpltCallback )(struct __I2S_HandleTypeDef *hi2s)
void(*	RxHalfCpltCallback )(struct __I2S_HandleTypeDef *hi2s)
void(*	TxRxHalfCpltCallback )(struct __I2S_HandleTypeDef *hi2s)
void(*	ErrorCallback )(struct __I2S_HandleTypeDef *hi2s)
void(*	MspInitCallback )(struct __I2S_HandleTypeDef *hi2s)
void(*	MspDeInitCallback )(struct __I2S_HandleTypeDef *hi2s)

Detailed Description

I2S handle Structure definition.

Definition at line 91 of file stm32f4xx_hal_i2s.h.

Field Documentation

void(* __I2S_HandleTypeDef::ErrorCallback)(struct __I2S_HandleTypeDef *hi2s)

I2S Error callback

Definition at line 133 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Init(), HAL_I2S_RegisterCallback(), HAL_I2S_UnRegisterCallback(), HAL_I2SEx_FullDuplex_IRQHandler(), I2S_DMAError(), I2S_IRQHandler(), and I2SEx_TxRxDMAError().

__IO uint32_t __I2S_HandleTypeDef::ErrorCode

I2S Error code This parameter can be a value of I2S Error

Definition at line 123 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_DeInit(), HAL_I2S_DMAStop(), HAL_I2S_GetError(), HAL_I2S_Init(), HAL_I2S_Receive(), HAL_I2S_Receive_DMA(), HAL_I2S_Receive_IT(), HAL_I2S_RegisterCallback(), HAL_I2S_Transmit(), HAL_I2S_Transmit_DMA(), HAL_I2S_Transmit_IT(), HAL_I2S_UnRegisterCallback(), HAL_I2SEx_FullDuplex_IRQHandler(), HAL_I2SEx_TransmitReceive(), HAL_I2SEx_TransmitReceive_DMA(), HAL_I2SEx_TransmitReceive_IT(), I2S_DMAError(), I2S_IRQHandler(), and I2SEx_TxRxDMAError().

DMA_HandleTypeDef* __I2S_HandleTypeDef::hdmarx

I2S Rx DMA handle parameters

Definition at line 117 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_DMAStop(), HAL_I2S_Receive_DMA(), and HAL_I2SEx_TransmitReceive_DMA().

DMA_HandleTypeDef* __I2S_HandleTypeDef::hdmatx

I2S Tx DMA handle parameters

Definition at line 115 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_DMAStop(), HAL_I2S_Transmit_DMA(), and HAL_I2SEx_TransmitReceive_DMA().

I2S_InitTypeDef __I2S_HandleTypeDef::Init

I2S communication parameters

Definition at line 95 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_DMAStop(), HAL_I2S_Init(), HAL_I2SEx_FullDuplex_IRQHandler(), and HAL_I2SEx_TransmitReceive_IT().

SPI_TypeDef* __I2S_HandleTypeDef::Instance

void(* __I2S_HandleTypeDef::IrqHandlerISR)(struct __I2S_HandleTypeDef *hi2s)

I2S function pointer on IrqHandler

Definition at line 113 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Init(), and HAL_I2S_IRQHandler().

__IO HAL_LockTypeDef __I2S_HandleTypeDef::Lock

I2S locking object

Definition at line 119 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

void(* __I2S_HandleTypeDef::MspDeInitCallback)(struct __I2S_HandleTypeDef *hi2s)

I2S Msp DeInit callback

Definition at line 135 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_DeInit(), HAL_I2S_RegisterCallback(), and HAL_I2S_UnRegisterCallback().

void(* __I2S_HandleTypeDef::MspInitCallback)(struct __I2S_HandleTypeDef *hi2s)

I2S Msp Init callback

Definition at line 134 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Init(), HAL_I2S_RegisterCallback(), and HAL_I2S_UnRegisterCallback().

uint16_t* __I2S_HandleTypeDef::pRxBuffPtr

Pointer to I2S Rx transfer buffer

Definition at line 103 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Receive(), HAL_I2S_Receive_DMA(), HAL_I2S_Receive_IT(), HAL_I2SEx_TransmitReceive_DMA(), HAL_I2SEx_TransmitReceive_IT(), I2S_Receive_IT(), I2SEx_RxISR_I2S(), and I2SEx_RxISR_I2SExt().

uint16_t* __I2S_HandleTypeDef::pTxBuffPtr

Pointer to I2S Tx transfer buffer

Definition at line 97 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Transmit(), HAL_I2S_Transmit_DMA(), HAL_I2S_Transmit_IT(), HAL_I2SEx_TransmitReceive_DMA(), HAL_I2SEx_TransmitReceive_IT(), I2S_Transmit_IT(), I2SEx_TxISR_I2S(), and I2SEx_TxISR_I2SExt().

void(* __I2S_HandleTypeDef::RxCpltCallback)(struct __I2S_HandleTypeDef *hi2s)

I2S Rx Completed callback

Definition at line 128 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Init(), HAL_I2S_RegisterCallback(), HAL_I2S_UnRegisterCallback(), I2S_DMARxCplt(), and I2S_Receive_IT().

void(* __I2S_HandleTypeDef::RxHalfCpltCallback)(struct __I2S_HandleTypeDef *hi2s)

I2S Rx Half Completed callback

Definition at line 131 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Init(), HAL_I2S_RegisterCallback(), HAL_I2S_UnRegisterCallback(), and I2S_DMARxHalfCplt().

__IO uint16_t __I2S_HandleTypeDef::RxXferCount

I2S Rx transfer counter (This field is initialized at the same value as transfer size at the beginning of the transfer and decremented when a sample is received NbSamplesReceived = RxBufferSize-RxBufferCount)

Definition at line 107 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Receive(), HAL_I2S_Receive_DMA(), HAL_I2S_Receive_IT(), HAL_I2SEx_TransmitReceive(), HAL_I2SEx_TransmitReceive_DMA(), HAL_I2SEx_TransmitReceive_IT(), I2S_DMAError(), I2S_DMARxCplt(), I2S_Receive_IT(), I2SEx_RxISR_I2S(), I2SEx_RxISR_I2SExt(), I2SEx_TxISR_I2S(), I2SEx_TxISR_I2SExt(), I2SEx_TxRxDMACplt(), and I2SEx_TxRxDMAError().