I2S handle Structure definition. More...

#include <stm32h7xx_hal_i2s.h>

Data Fields
SPI_TypeDef *	Instance
I2S_InitTypeDef	Init
const uint16_t *	pTxBuffPtr
__IO uint16_t	TxXferSize
__IO uint16_t	TxXferCount
uint16_t *	pRxBuffPtr
__IO uint16_t	RxXferSize
__IO uint16_t	RxXferCount
void(*)	RxISR (struct __I2S_HandleTypeDef *hi2s)
void(*)	TxISR (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.

Field Documentation

◆ ErrorCode

__IO uint32_t __I2S_HandleTypeDef::ErrorCode

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

◆ hdmarx

DMA_HandleTypeDef* __I2S_HandleTypeDef::hdmarx

I2S Rx DMA handle parameters

◆ hdmatx

DMA_HandleTypeDef* __I2S_HandleTypeDef::hdmatx

I2S Tx DMA handle parameters

◆ Init

I2S_InitTypeDef __I2S_HandleTypeDef::Init

I2S communication parameters

◆ Instance

SPI_TypeDef* __I2S_HandleTypeDef::Instance

I2S registers base address

◆ Lock

__IO HAL_LockTypeDef __I2S_HandleTypeDef::Lock

I2S locking object

◆ pRxBuffPtr

uint16_t* __I2S_HandleTypeDef::pRxBuffPtr

Pointer to I2S Rx transfer buffer

◆ pTxBuffPtr

const uint16_t* __I2S_HandleTypeDef::pTxBuffPtr

Pointer to I2S Tx transfer buffer

◆ RxISR

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

function pointer on Rx ISR

◆ 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)

◆ RxXferSize

__IO uint16_t __I2S_HandleTypeDef::RxXferSize

I2S Rx transfer size

◆ State

__IO HAL_I2S_StateTypeDef __I2S_HandleTypeDef::State

I2S communication state

◆ TxISR

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

function pointer on Tx ISR

◆ TxXferCount

__IO uint16_t __I2S_HandleTypeDef::TxXferCount

I2S Tx transfer Counter

◆ TxXferSize

__IO uint16_t __I2S_HandleTypeDef::TxXferSize

I2S Tx transfer size

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

bsps/arm/stm32h7/include/stm32h7xx_hal_i2s.h

Data Fields