ST STM32F2 User Manual

UM1940
HAL I2S Generic Driver
DocID028236 Rev 2
321/1371
HAL_I2S_IRQHandler
Function name
void HAL_I2S_IRQHandler (I2S_HandleTypeDef * hi2s)
Function description
This function handles I2S interrupt request.
Parameters
hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
Return values
None:
HAL_I2S_Transmit_DMA
Function name
HAL_StatusTypeDef HAL_I2S_Transmit_DMA
(I2S_HandleTypeDef * hi2s, uint16_t * pData, uint16_t Size)
Function description
Transmit an amount of data in non-blocking mode with DMA.
Parameters
hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
pData: a 16-bit pointer to the Transmit data buffer.
Size: number of data sample to be sent:
Return values
HAL: status
Notes
When a 16-bit data frame or a 16-bit data frame extended is
selected during the I2S configuration phase, the Size
parameter means the number of 16-bit data length in the
transaction and when a 24-bit data frame or a 32-bit data
frame is selected the Size parameter means the number of
16-bit data length.
The I2S is kept enabled at the end of transaction to avoid the
clock de-synchronization between Master and Slave(example:
audio streaming).
HAL_I2S_Receive_DMA
Function name
HAL_StatusTypeDef HAL_I2S_Receive_DMA
(I2S_HandleTypeDef * hi2s, uint16_t * pData, uint16_t Size)
Function description
Receive an amount of data in non-blocking mode with DMA.
Parameters
hi2s: pointer to a I2S_HandleTypeDef structure that contains
the configuration information for I2S module
pData: a 16-bit pointer to the Receive data buffer.
Size: number of data sample to be sent:
Return values
HAL: status
Notes
When a 16-bit data frame or a 16-bit data frame extended is
selected during the I2S configuration phase, the Size
parameter means the number of 16-bit data length in the
transaction and when a 24-bit data frame or a 32-bit data
frame is selected the Size parameter means the number of
16-bit data length.
The I2S is kept enabled at the end of transaction to avoid the
clock de-synchronization between Master and Slave(example:
audio streaming).

ST STM32F2 Specifications

General

Brand	ST
Model	STM32F2
Category	Microcontrollers
Language	English