I2S handle Structure definition. More...

#include <stm32f4xx_hal_i2s.h>

Collaboration diagram for __I2S_HandleTypeDef:

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

Detailed Description

I2S handle Structure definition.

Definition at line 90 of file stm32f4xx_hal_i2s.h.

Field Documentation

◆ Instance

SPI_TypeDef* __I2S_HandleTypeDef::Instance

I2S registers base address

Definition at line 92 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_DeInit(), HAL_I2S_DMAPause(), HAL_I2S_DMAResume(), HAL_I2S_DMAStop(), HAL_I2S_Init(), HAL_I2S_Receive(), HAL_I2S_Receive_DMA(), HAL_I2S_Receive_IT(), HAL_I2S_Transmit(), HAL_I2S_Transmit_DMA(), HAL_I2S_Transmit_IT(), I2S_DMAError(), I2S_DMARxCplt(), I2S_DMATxCplt(), I2S_IRQHandler(), I2S_Receive_IT(), and I2S_Transmit_IT().

◆ Init

I2S_InitTypeDef __I2S_HandleTypeDef::Init

I2S communication parameters

Definition at line 94 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_DMAStop(), and HAL_I2S_Init().

◆ pTxBuffPtr

uint16_t* __I2S_HandleTypeDef::pTxBuffPtr

Pointer to I2S Tx transfer buffer

Definition at line 96 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Transmit(), HAL_I2S_Transmit_DMA(), HAL_I2S_Transmit_IT(), and I2S_Transmit_IT().

◆ TxXferSize

__IO uint16_t __I2S_HandleTypeDef::TxXferSize

I2S Tx transfer size

Definition at line 98 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Transmit(), HAL_I2S_Transmit_DMA(), and HAL_I2S_Transmit_IT().

◆ TxXferCount

__IO uint16_t __I2S_HandleTypeDef::TxXferCount

I2S Tx transfer Counter

Definition at line 100 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Transmit(), HAL_I2S_Transmit_DMA(), HAL_I2S_Transmit_IT(), I2S_DMAError(), I2S_DMATxCplt(), and I2S_Transmit_IT().

◆ pRxBuffPtr

uint16_t* __I2S_HandleTypeDef::pRxBuffPtr

Pointer to I2S Rx transfer buffer

Definition at line 102 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Receive(), HAL_I2S_Receive_DMA(), HAL_I2S_Receive_IT(), and I2S_Receive_IT().

◆ RxXferSize

__IO uint16_t __I2S_HandleTypeDef::RxXferSize

I2S Rx transfer size

Definition at line 104 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Receive(), HAL_I2S_Receive_DMA(), and HAL_I2S_Receive_IT().

◆ RxXferCount

__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 106 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Receive(), HAL_I2S_Receive_DMA(), HAL_I2S_Receive_IT(), I2S_DMAError(), I2S_DMARxCplt(), and I2S_Receive_IT().

◆ IrqHandlerISR

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

I2S function pointer on IrqHandler

Definition at line 112 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Init(), and HAL_I2S_IRQHandler().

◆ hdmatx

DMA_HandleTypeDef* __I2S_HandleTypeDef::hdmatx

I2S Tx DMA handle parameters

Definition at line 114 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_DMAStop(), and HAL_I2S_Transmit_DMA().

◆ hdmarx

DMA_HandleTypeDef* __I2S_HandleTypeDef::hdmarx

I2S Rx DMA handle parameters

Definition at line 116 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_DMAStop(), and HAL_I2S_Receive_DMA().

◆ Lock

__IO HAL_LockTypeDef __I2S_HandleTypeDef::Lock

I2S locking object

Definition at line 118 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

◆ State

__IO HAL_I2S_StateTypeDef __I2S_HandleTypeDef::State

I2S communication state

Definition at line 120 of file stm32f4xx_hal_i2s.h.

Referenced by HAL_I2S_DeInit(), HAL_I2S_DMAPause(), HAL_I2S_DMAResume(), HAL_I2S_DMAStop(), HAL_I2S_GetState(), HAL_I2S_Init(), HAL_I2S_Receive(), HAL_I2S_Receive_DMA(), HAL_I2S_Receive_IT(), HAL_I2S_Transmit(), HAL_I2S_Transmit_DMA(), HAL_I2S_Transmit_IT(), I2S_DMAError(), I2S_DMARxCplt(), I2S_DMATxCplt(), I2S_IRQHandler(), I2S_Receive_IT(), I2S_Transmit_IT(), and I2S_WaitFlagStateUntilTimeout().

◆ ErrorCode

__IO uint32_t __I2S_HandleTypeDef::ErrorCode

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

Definition at line 122 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_Transmit(), HAL_I2S_Transmit_DMA(), HAL_I2S_Transmit_IT(), I2S_DMAError(), and I2S_IRQHandler().

The documentation for this struct was generated from the following file:

stm32f4xx_hal_i2s.h

Data Fields