STM32H735xx HAL User Manual
Data Fields
__I2S_HandleTypeDef Struct Reference
I2S Exported Types

I2S handle Structure definition. More...

#include <stm32h7xx_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(* 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
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 98 of file stm32h7xx_hal_i2s.h.

Field Documentation

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

I2S Error callback

Definition at line 143 of file stm32h7xx_hal_i2s.h.

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

__IO uint32_t __I2S_HandleTypeDef::ErrorCode

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

Definition at line 133 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_DeInit(), HAL_I2S_DMAPause(), HAL_I2S_DMAResume(), HAL_I2S_DMAStop(), HAL_I2S_GetError(), HAL_I2S_Init(), HAL_I2S_IRQHandler(), 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_TransmitReceive(), HAL_I2SEx_TransmitReceive_DMA(), HAL_I2SEx_TransmitReceive_IT(), and I2S_DMAError().

DMA_HandleTypeDef* __I2S_HandleTypeDef::hdmarx

I2S Rx DMA handle parameters

Definition at line 127 of file stm32h7xx_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 125 of file stm32h7xx_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 102 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_DMAPause(), HAL_I2S_Init(), HAL_I2S_Receive(), HAL_I2S_Receive_IT(), HAL_I2S_Transmit(), HAL_I2S_Transmit_IT(), HAL_I2SEx_TransmitReceive(), HAL_I2SEx_TransmitReceive_IT(), I2S_Receive_16Bit_IT(), I2S_Receive_32Bit_IT(), I2S_Transmit_16Bit_IT(), and I2S_Transmit_32Bit_IT().

SPI_TypeDef* __I2S_HandleTypeDef::Instance

I2S registers base address

Definition at line 100 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_DeInit(), HAL_I2S_DMAPause(), HAL_I2S_DMAResume(), HAL_I2S_DMAStop(), HAL_I2S_Init(), HAL_I2S_IRQHandler(), HAL_I2S_Receive(), HAL_I2S_Receive_DMA(), HAL_I2S_Receive_IT(), HAL_I2S_Transmit(), HAL_I2S_Transmit_DMA(), HAL_I2S_Transmit_IT(), HAL_I2SEx_TransmitReceive(), HAL_I2SEx_TransmitReceive_DMA(), HAL_I2SEx_TransmitReceive_IT(), I2S_DMAError(), I2S_DMARxCplt(), I2S_DMATxCplt(), I2S_Receive_16Bit_IT(), I2S_Receive_32Bit_IT(), I2S_Transmit_16Bit_IT(), and I2S_Transmit_32Bit_IT().

__IO HAL_LockTypeDef __I2S_HandleTypeDef::Lock

I2S locking object

Definition at line 129 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Init().

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

I2S Msp DeInit callback

Definition at line 145 of file stm32h7xx_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 144 of file stm32h7xx_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 110 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Receive(), HAL_I2S_Receive_DMA(), HAL_I2S_Receive_IT(), HAL_I2S_Transmit(), HAL_I2S_Transmit_DMA(), HAL_I2S_Transmit_IT(), HAL_I2SEx_TransmitReceive(), HAL_I2SEx_TransmitReceive_DMA(), HAL_I2SEx_TransmitReceive_IT(), I2S_Receive_16Bit_IT(), and I2S_Receive_32Bit_IT().

uint16_t* __I2S_HandleTypeDef::pTxBuffPtr

Pointer to I2S Tx transfer buffer

Definition at line 104 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Receive(), HAL_I2S_Receive_DMA(), HAL_I2S_Receive_IT(), HAL_I2S_Transmit(), HAL_I2S_Transmit_DMA(), HAL_I2S_Transmit_IT(), HAL_I2SEx_TransmitReceive(), HAL_I2SEx_TransmitReceive_DMA(), HAL_I2SEx_TransmitReceive_IT(), I2S_Transmit_16Bit_IT(), and I2S_Transmit_32Bit_IT().

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

I2S Rx Completed callback

Definition at line 138 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Init(), HAL_I2S_RegisterCallback(), HAL_I2S_UnRegisterCallback(), I2S_DMARxCplt(), I2S_Receive_16Bit_IT(), and I2S_Receive_32Bit_IT().

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

I2S Rx Half Completed callback

Definition at line 141 of file stm32h7xx_hal_i2s.h.

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

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

function pointer on Rx ISR

Definition at line 121 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_IRQHandler(), HAL_I2S_Receive_IT(), and HAL_I2SEx_TransmitReceive_IT().

__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 114 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Receive(), HAL_I2S_Receive_DMA(), HAL_I2S_Receive_IT(), HAL_I2S_Transmit(), HAL_I2S_Transmit_DMA(), HAL_I2S_Transmit_IT(), HAL_I2SEx_TransmitReceive(), HAL_I2SEx_TransmitReceive_DMA(), HAL_I2SEx_TransmitReceive_IT(), I2S_DMAError(), I2S_DMARxCplt(), I2S_Receive_16Bit_IT(), and I2S_Receive_32Bit_IT().

__IO uint16_t __I2S_HandleTypeDef::RxXferSize

I2S Rx transfer size

Definition at line 112 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Receive(), HAL_I2S_Receive_DMA(), HAL_I2S_Receive_IT(), HAL_I2S_Transmit(), HAL_I2S_Transmit_DMA(), HAL_I2S_Transmit_IT(), HAL_I2SEx_TransmitReceive(), HAL_I2SEx_TransmitReceive_DMA(), and HAL_I2SEx_TransmitReceive_IT().

__IO HAL_I2S_StateTypeDef __I2S_HandleTypeDef::State

I2S communication state

Definition at line 131 of file stm32h7xx_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_IRQHandler(), 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_TransmitReceive(), HAL_I2SEx_TransmitReceive_DMA(), HAL_I2SEx_TransmitReceive_IT(), I2S_DMAError(), I2S_DMARxCplt(), I2S_DMATxCplt(), I2S_Receive_16Bit_IT(), I2S_Receive_32Bit_IT(), I2S_Transmit_16Bit_IT(), I2S_Transmit_32Bit_IT(), and I2S_WaitFlagStateUntilTimeout().

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

I2S Tx Completed callback

Definition at line 137 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Init(), HAL_I2S_RegisterCallback(), HAL_I2S_UnRegisterCallback(), I2S_DMATxCplt(), I2S_Transmit_16Bit_IT(), and I2S_Transmit_32Bit_IT().

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

I2S Tx Half Completed callback

Definition at line 140 of file stm32h7xx_hal_i2s.h.

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

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

function pointer on Tx ISR

Definition at line 123 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_IRQHandler(), HAL_I2S_Transmit_IT(), and HAL_I2SEx_TransmitReceive_IT().

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

I2S TxRx Completed callback

Definition at line 139 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Init(), HAL_I2S_RegisterCallback(), HAL_I2S_UnRegisterCallback(), I2S_Receive_16Bit_IT(), I2S_Receive_32Bit_IT(), and I2SEx_DMATxRxCplt().

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

I2S TxRx Half Completed callback

Definition at line 142 of file stm32h7xx_hal_i2s.h.

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

__IO uint16_t __I2S_HandleTypeDef::TxXferCount

I2S Tx transfer Counter

Definition at line 108 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Receive(), HAL_I2S_Receive_DMA(), HAL_I2S_Receive_IT(), HAL_I2S_Transmit(), HAL_I2S_Transmit_DMA(), HAL_I2S_Transmit_IT(), HAL_I2SEx_TransmitReceive(), HAL_I2SEx_TransmitReceive_DMA(), HAL_I2SEx_TransmitReceive_IT(), I2S_DMAError(), I2S_DMATxCplt(), I2S_Transmit_16Bit_IT(), and I2S_Transmit_32Bit_IT().

__IO uint16_t __I2S_HandleTypeDef::TxXferSize

I2S Tx transfer size

Definition at line 106 of file stm32h7xx_hal_i2s.h.

Referenced by HAL_I2S_Receive(), HAL_I2S_Receive_DMA(), HAL_I2S_Receive_IT(), HAL_I2S_Transmit(), HAL_I2S_Transmit_DMA(), HAL_I2S_Transmit_IT(), HAL_I2SEx_TransmitReceive(), HAL_I2SEx_TransmitReceive_DMA(), and HAL_I2SEx_TransmitReceive_IT().

The documentation for this struct was generated from the following file:
Generated on Tue Nov 30 2021 10:04:02 for STM32H735xx HAL User Manual by   doxygen 1.7.6.1