Collaboration diagram for I2S Exported Types:Data Structures | |
| struct | I2S_InitTypeDef |
| I2S Init structure definition. More... | |
| struct | __I2S_HandleTypeDef |
| I2S handle Structure definition. More... | |
Typedefs | |
| typedef struct __I2S_HandleTypeDef | I2S_HandleTypeDef |
| I2S handle Structure definition. | |
| typedef void(* | pI2S_CallbackTypeDef) (I2S_HandleTypeDef *hi2s) |
| HAL I2S Callback pointer definition. More... | |
Enumerations | |
| enum | HAL_I2S_StateTypeDef { HAL_I2S_STATE_RESET = 0x00U , HAL_I2S_STATE_READY = 0x01U , HAL_I2S_STATE_BUSY = 0x02U , HAL_I2S_STATE_BUSY_TX = 0x03U , HAL_I2S_STATE_BUSY_RX = 0x04U , HAL_I2S_STATE_BUSY_TX_RX = 0x05U , HAL_I2S_STATE_TIMEOUT = 0x06U , HAL_I2S_STATE_ERROR = 0x07U } |
| HAL State structures definition. More... | |
| enum | HAL_I2S_CallbackIDTypeDef { HAL_I2S_TX_COMPLETE_CB_ID = 0x00U , HAL_I2S_RX_COMPLETE_CB_ID = 0x01U , HAL_I2S_TX_RX_COMPLETE_CB_ID = 0x02U , HAL_I2S_TX_HALF_COMPLETE_CB_ID = 0x03U , HAL_I2S_RX_HALF_COMPLETE_CB_ID = 0x04U , HAL_I2S_TX_RX_HALF_COMPLETE_CB_ID = 0x05U , HAL_I2S_ERROR_CB_ID = 0x06U , HAL_I2S_MSPINIT_CB_ID = 0x07U , HAL_I2S_MSPDEINIT_CB_ID = 0x08U } |
| HAL I2S Callback ID enumeration definition. More... | |
Detailed Description
Data Structure Documentation
◆ I2S_InitTypeDef
| struct I2S_InitTypeDef |
I2S Init structure definition.
Definition at line 46 of file stm32f4xx_hal_i2s.h.
| Data Fields | ||
|---|---|---|
| uint32_t | AudioFreq |
Specifies the frequency selected for the I2S communication. This parameter can be a value of I2S Audio Frequency |
| uint32_t | ClockSource |
Specifies the I2S Clock Source. This parameter can be a value of I2S Clock Source Definition |
| uint32_t | CPOL |
Specifies the idle state of the I2S clock. This parameter can be a value of I2S Clock Polarity |
| uint32_t | DataFormat |
Specifies the data format for the I2S communication. This parameter can be a value of I2S Data Format |
| uint32_t | FullDuplexMode |
Specifies the I2S FullDuplex mode. This parameter can be a value of I2S FullDuplex Mode |
| uint32_t | MCLKOutput |
Specifies whether the I2S MCLK output is enabled or not. This parameter can be a value of I2S MCLK Output |
| uint32_t | Mode |
Specifies the I2S operating mode. This parameter can be a value of I2S Mode |
| uint32_t | Standard |
Specifies the standard used for the I2S communication. This parameter can be a value of I2S Standard |
◆ __I2S_HandleTypeDef
| struct __I2S_HandleTypeDef |
I2S handle Structure definition.
Definition at line 90 of file 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 |
| 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) |
Field Documentation
◆ ErrorCallback
| void(* __I2S_HandleTypeDef::ErrorCallback) (struct __I2S_HandleTypeDef *hi2s) |
I2S Error callback
Definition at line 132 of file stm32f4xx_hal_i2s.h.
◆ 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.
◆ hdmarx
| DMA_HandleTypeDef* __I2S_HandleTypeDef::hdmarx |
I2S Rx DMA handle parameters
Definition at line 116 of file stm32f4xx_hal_i2s.h.
◆ hdmatx
| DMA_HandleTypeDef* __I2S_HandleTypeDef::hdmatx |
I2S Tx DMA handle parameters
Definition at line 114 of file stm32f4xx_hal_i2s.h.
◆ Init
| I2S_InitTypeDef __I2S_HandleTypeDef::Init |
I2S communication parameters
Definition at line 94 of file stm32f4xx_hal_i2s.h.
◆ Instance
| SPI_TypeDef* __I2S_HandleTypeDef::Instance |
I2S registers base address
Definition at line 92 of file stm32f4xx_hal_i2s.h.
◆ IrqHandlerISR
| void(* __I2S_HandleTypeDef::IrqHandlerISR) (struct __I2S_HandleTypeDef *hi2s) |
I2S function pointer on IrqHandler
Definition at line 112 of file stm32f4xx_hal_i2s.h.
◆ Lock
| __IO HAL_LockTypeDef __I2S_HandleTypeDef::Lock |
I2S locking object
Definition at line 118 of file stm32f4xx_hal_i2s.h.
◆ MspDeInitCallback
| void(* __I2S_HandleTypeDef::MspDeInitCallback) (struct __I2S_HandleTypeDef *hi2s) |
I2S Msp DeInit callback
Definition at line 134 of file stm32f4xx_hal_i2s.h.
◆ MspInitCallback
| void(* __I2S_HandleTypeDef::MspInitCallback) (struct __I2S_HandleTypeDef *hi2s) |
I2S Msp Init callback
Definition at line 133 of file stm32f4xx_hal_i2s.h.
◆ pRxBuffPtr
| uint16_t* __I2S_HandleTypeDef::pRxBuffPtr |
Pointer to I2S Rx transfer buffer
Definition at line 102 of file stm32f4xx_hal_i2s.h.
◆ pTxBuffPtr
| uint16_t* __I2S_HandleTypeDef::pTxBuffPtr |
Pointer to I2S Tx transfer buffer
Definition at line 96 of file stm32f4xx_hal_i2s.h.
◆ RxCpltCallback
| void(* __I2S_HandleTypeDef::RxCpltCallback) (struct __I2S_HandleTypeDef *hi2s) |
I2S Rx Completed callback
Definition at line 127 of file stm32f4xx_hal_i2s.h.
◆ RxHalfCpltCallback
| void(* __I2S_HandleTypeDef::RxHalfCpltCallback) (struct __I2S_HandleTypeDef *hi2s) |
I2S Rx Half Completed callback
Definition at line 130 of file stm32f4xx_hal_i2s.h.
◆ 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.
◆ RxXferSize
| __IO uint16_t __I2S_HandleTypeDef::RxXferSize |
I2S Rx transfer size
Definition at line 104 of file stm32f4xx_hal_i2s.h.
◆ State
| __IO HAL_I2S_StateTypeDef __I2S_HandleTypeDef::State |
I2S communication state
Definition at line 120 of file stm32f4xx_hal_i2s.h.
◆ TxCpltCallback
| void(* __I2S_HandleTypeDef::TxCpltCallback) (struct __I2S_HandleTypeDef *hi2s) |
I2S Tx Completed callback
Definition at line 126 of file stm32f4xx_hal_i2s.h.
◆ TxHalfCpltCallback
| void(* __I2S_HandleTypeDef::TxHalfCpltCallback) (struct __I2S_HandleTypeDef *hi2s) |
I2S Tx Half Completed callback
Definition at line 129 of file stm32f4xx_hal_i2s.h.
◆ TxRxCpltCallback
| void(* __I2S_HandleTypeDef::TxRxCpltCallback) (struct __I2S_HandleTypeDef *hi2s) |
I2S TxRx Completed callback
Definition at line 128 of file stm32f4xx_hal_i2s.h.
◆ TxRxHalfCpltCallback
| void(* __I2S_HandleTypeDef::TxRxHalfCpltCallback) (struct __I2S_HandleTypeDef *hi2s) |
I2S TxRx Half Completed callback
Definition at line 131 of file stm32f4xx_hal_i2s.h.
◆ TxXferCount
| __IO uint16_t __I2S_HandleTypeDef::TxXferCount |
I2S Tx transfer Counter
Definition at line 100 of file stm32f4xx_hal_i2s.h.
◆ TxXferSize
| __IO uint16_t __I2S_HandleTypeDef::TxXferSize |
I2S Tx transfer size
Definition at line 98 of file stm32f4xx_hal_i2s.h.
Typedef Documentation
◆ pI2S_CallbackTypeDef
| typedef void(* pI2S_CallbackTypeDef) (I2S_HandleTypeDef *hi2s) |
HAL I2S Callback pointer definition.
pointer to an I2S callback function
Definition at line 160 of file stm32f4xx_hal_i2s.h.
Enumeration Type Documentation
◆ HAL_I2S_CallbackIDTypeDef
HAL I2S Callback ID enumeration definition.
Definition at line 143 of file stm32f4xx_hal_i2s.h.
◆ HAL_I2S_StateTypeDef
| enum HAL_I2S_StateTypeDef |
HAL State structures definition.
Definition at line 75 of file stm32f4xx_hal_i2s.h.
