I2S_HandleTypeDef Struct Reference

I2S handle Structure definition. More...

#include <bf0_hal_i2s.h>

Data Fields
I2S_TypeDef *	Instance
I2S_InitTypeDef	Init
uint32_t *	pTxBuffPtr
__IO uint32_t	TxXferSize
__IO uint32_t	TxXferCount
uint32_t *	pRxBuffPtr
__IO uint32_t	RxXferSize
__IO uint32_t	RxXferCount
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

I2S_TypeDef* I2S_HandleTypeDef::Instance

I2S registers base address

Lock

__IO HAL_LockTypeDef I2S_HandleTypeDef::Lock

I2S locking object

pRxBuffPtr

uint32_t* I2S_HandleTypeDef::pRxBuffPtr

Pointer to I2S Rx transfer buffer

pTxBuffPtr

uint32_t* I2S_HandleTypeDef::pTxBuffPtr

Pointer to I2S Tx transfer buffer

RxXferCount

__IO uint32_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 uint32_t I2S_HandleTypeDef::RxXferSize

I2S Rx transfer size

State

__IO HAL_I2S_StateTypeDef I2S_HandleTypeDef::State

I2S communication state

TxXferCount

__IO uint32_t I2S_HandleTypeDef::TxXferCount

I2S Tx transfer Counter

TxXferSize

__IO uint32_t I2S_HandleTypeDef::TxXferSize

I2S Tx transfer size

---

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

• drivers/include/bf0_hal_i2s.h