STM32F439xx HAL User Manual
Functions
Configuration
I2S Exported Functions

Functions

__STATIC_INLINE void LL_I2S_Enable (SPI_TypeDef *SPIx)
 Select I2S mode and Enable I2S peripheral.
__STATIC_INLINE void LL_I2S_Disable (SPI_TypeDef *SPIx)
 Disable I2S peripheral.
__STATIC_INLINE uint32_t LL_I2S_IsEnabled (SPI_TypeDef *SPIx)
 Check if I2S peripheral is enabled.
__STATIC_INLINE void LL_I2S_SetDataFormat (SPI_TypeDef *SPIx, uint32_t DataFormat)
 Set I2S data frame length.
__STATIC_INLINE uint32_t LL_I2S_GetDataFormat (SPI_TypeDef *SPIx)
 Get I2S data frame length.
__STATIC_INLINE void LL_I2S_SetClockPolarity (SPI_TypeDef *SPIx, uint32_t ClockPolarity)
 Set I2S clock polarity.
__STATIC_INLINE uint32_t LL_I2S_GetClockPolarity (SPI_TypeDef *SPIx)
 Get I2S clock polarity.
__STATIC_INLINE void LL_I2S_SetStandard (SPI_TypeDef *SPIx, uint32_t Standard)
 Set I2S standard protocol.
__STATIC_INLINE uint32_t LL_I2S_GetStandard (SPI_TypeDef *SPIx)
 Get I2S standard protocol.
__STATIC_INLINE void LL_I2S_SetTransferMode (SPI_TypeDef *SPIx, uint32_t Mode)
 Set I2S transfer mode.
__STATIC_INLINE uint32_t LL_I2S_GetTransferMode (SPI_TypeDef *SPIx)
 Get I2S transfer mode.
__STATIC_INLINE void LL_I2S_SetPrescalerLinear (SPI_TypeDef *SPIx, uint8_t PrescalerLinear)
 Set I2S linear prescaler.
__STATIC_INLINE uint32_t LL_I2S_GetPrescalerLinear (SPI_TypeDef *SPIx)
 Get I2S linear prescaler.
__STATIC_INLINE void LL_I2S_SetPrescalerParity (SPI_TypeDef *SPIx, uint32_t PrescalerParity)
 Set I2S parity prescaler.
__STATIC_INLINE uint32_t LL_I2S_GetPrescalerParity (SPI_TypeDef *SPIx)
 Get I2S parity prescaler.
__STATIC_INLINE void LL_I2S_EnableMasterClock (SPI_TypeDef *SPIx)
 Enable the master clock ouput (Pin MCK)
__STATIC_INLINE void LL_I2S_DisableMasterClock (SPI_TypeDef *SPIx)
 Disable the master clock ouput (Pin MCK)
__STATIC_INLINE uint32_t LL_I2S_IsEnabledMasterClock (SPI_TypeDef *SPIx)
 Check if the master clock ouput (Pin MCK) is enabled.

Function Documentation

__STATIC_INLINE void LL_I2S_Disable ( SPI_TypeDef *  SPIx)

Disable I2S peripheral.

Reference Manual to LL API cross reference:
I2SCFGR I2SE LL_I2S_Disable
Parameters:
SPIxSPI Instance
Return values:
None

Definition at line 1397 of file stm32f4xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_DisableMasterClock ( SPI_TypeDef *  SPIx)

Disable the master clock ouput (Pin MCK)

Reference Manual to LL API cross reference:
I2SPR MCKOE LL_I2S_DisableMasterClock
Parameters:
SPIxSPI Instance
Return values:
None

Definition at line 1606 of file stm32f4xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_Enable ( SPI_TypeDef *  SPIx)

Select I2S mode and Enable I2S peripheral.

Reference Manual to LL API cross reference:
I2SCFGR I2SMOD LL_I2S_Enable
I2SCFGR I2SE LL_I2S_Enable
Parameters:
SPIxSPI Instance
Return values:
None

Definition at line 1386 of file stm32f4xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_EnableMasterClock ( SPI_TypeDef *  SPIx)

Enable the master clock ouput (Pin MCK)

Reference Manual to LL API cross reference:
I2SPR MCKOE LL_I2S_EnableMasterClock
Parameters:
SPIxSPI Instance
Return values:
None

Definition at line 1595 of file stm32f4xx_ll_spi.h.

__STATIC_INLINE uint32_t LL_I2S_GetClockPolarity ( SPI_TypeDef *  SPIx)

Get I2S clock polarity.

Reference Manual to LL API cross reference:
I2SCFGR CKPOL LL_I2S_GetClockPolarity
Parameters:
SPIxSPI Instance
Return values:
Returnedvalue can be one of the following values:

Definition at line 1468 of file stm32f4xx_ll_spi.h.

__STATIC_INLINE uint32_t LL_I2S_GetDataFormat ( SPI_TypeDef *  SPIx)

Get I2S data frame length.

Reference Manual to LL API cross reference:
I2SCFGR DATLEN LL_I2S_GetDataFormat
I2SCFGR CHLEN LL_I2S_GetDataFormat
Parameters:
SPIxSPI Instance
Return values:
Returnedvalue can be one of the following values:

Definition at line 1441 of file stm32f4xx_ll_spi.h.

__STATIC_INLINE uint32_t LL_I2S_GetPrescalerLinear ( SPI_TypeDef *  SPIx)

Get I2S linear prescaler.

Reference Manual to LL API cross reference:
I2SPR I2SDIV LL_I2S_GetPrescalerLinear
Parameters:
SPIxSPI Instance
Return values:
PrescalerLinearValue between Min_Data=0x02 and Max_Data=0xFF

Definition at line 1557 of file stm32f4xx_ll_spi.h.

__STATIC_INLINE uint32_t LL_I2S_GetPrescalerParity ( SPI_TypeDef *  SPIx)

Get I2S parity prescaler.

Reference Manual to LL API cross reference:
I2SPR ODD LL_I2S_GetPrescalerParity
Parameters:
SPIxSPI Instance
Return values:
Returnedvalue can be one of the following values:

Definition at line 1584 of file stm32f4xx_ll_spi.h.

__STATIC_INLINE uint32_t LL_I2S_GetStandard ( SPI_TypeDef *  SPIx)

Get I2S standard protocol.

Reference Manual to LL API cross reference:
I2SCFGR I2SSTD LL_I2S_GetStandard
I2SCFGR PCMSYNC LL_I2S_GetStandard
Parameters:
SPIxSPI Instance
Return values:
Returnedvalue can be one of the following values:

Definition at line 1503 of file stm32f4xx_ll_spi.h.

__STATIC_INLINE uint32_t LL_I2S_GetTransferMode ( SPI_TypeDef *  SPIx)

Get I2S transfer mode.

Reference Manual to LL API cross reference:
I2SCFGR I2SCFG LL_I2S_GetTransferMode
Parameters:
SPIxSPI Instance
Return values:
Returnedvalue can be one of the following values:

Definition at line 1534 of file stm32f4xx_ll_spi.h.

__STATIC_INLINE uint32_t LL_I2S_IsEnabled ( SPI_TypeDef *  SPIx)

Check if I2S peripheral is enabled.

Reference Manual to LL API cross reference:
I2SCFGR I2SE LL_I2S_IsEnabled
Parameters:
SPIxSPI Instance
Return values:
Stateof bit (1 or 0).

Definition at line 1408 of file stm32f4xx_ll_spi.h.

Referenced by LL_I2S_Init(), and LL_I2S_InitFullDuplex().

__STATIC_INLINE uint32_t LL_I2S_IsEnabledMasterClock ( SPI_TypeDef *  SPIx)

Check if the master clock ouput (Pin MCK) is enabled.

Reference Manual to LL API cross reference:
I2SPR MCKOE LL_I2S_IsEnabledMasterClock
Parameters:
SPIxSPI Instance
Return values:
Stateof bit (1 or 0).

Definition at line 1617 of file stm32f4xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_SetClockPolarity ( SPI_TypeDef *  SPIx,
uint32_t  ClockPolarity 
)

Set I2S clock polarity.

Reference Manual to LL API cross reference:
I2SCFGR CKPOL LL_I2S_SetClockPolarity
Parameters:
SPIxSPI Instance
ClockPolarityThis parameter can be one of the following values:
Return values:
None

Definition at line 1455 of file stm32f4xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_SetDataFormat ( SPI_TypeDef *  SPIx,
uint32_t  DataFormat 
)

Set I2S data frame length.

Reference Manual to LL API cross reference:
I2SCFGR DATLEN LL_I2S_SetDataFormat
I2SCFGR CHLEN LL_I2S_SetDataFormat
Parameters:
SPIxSPI Instance
DataFormatThis parameter can be one of the following values:
Return values:
None

Definition at line 1425 of file stm32f4xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_SetPrescalerLinear ( SPI_TypeDef *  SPIx,
uint8_t  PrescalerLinear 
)

Set I2S linear prescaler.

Reference Manual to LL API cross reference:
I2SPR I2SDIV LL_I2S_SetPrescalerLinear
Parameters:
SPIxSPI Instance
PrescalerLinearValue between Min_Data=0x02 and Max_Data=0xFF
Return values:
None

Definition at line 1546 of file stm32f4xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_SetPrescalerParity ( SPI_TypeDef *  SPIx,
uint32_t  PrescalerParity 
)

Set I2S parity prescaler.

Reference Manual to LL API cross reference:
I2SPR ODD LL_I2S_SetPrescalerParity
Parameters:
SPIxSPI Instance
PrescalerParityThis parameter can be one of the following values:
Return values:
None

Definition at line 1571 of file stm32f4xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_SetStandard ( SPI_TypeDef *  SPIx,
uint32_t  Standard 
)

Set I2S standard protocol.

Reference Manual to LL API cross reference:
I2SCFGR I2SSTD LL_I2S_SetStandard
I2SCFGR PCMSYNC LL_I2S_SetStandard
Parameters:
SPIxSPI Instance
StandardThis parameter can be one of the following values:
Return values:
None

Definition at line 1486 of file stm32f4xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_SetTransferMode ( SPI_TypeDef *  SPIx,
uint32_t  Mode 
)

Set I2S transfer mode.

Reference Manual to LL API cross reference:
I2SCFGR I2SCFG LL_I2S_SetTransferMode
Parameters:
SPIxSPI Instance
ModeThis parameter can be one of the following values:
Return values:
None

Definition at line 1519 of file stm32f4xx_ll_spi.h.