STM32H735xx HAL User Manual
Functions
Configuration
I2S Exported Functions

Functions

__STATIC_INLINE void LL_I2S_SetDataFormat (SPI_TypeDef *SPIx, uint32_t DataLength)
 Set I2S Data frame format.
__STATIC_INLINE uint32_t LL_I2S_GetDataFormat (SPI_TypeDef *SPIx)
 Get I2S Data frame format.
__STATIC_INLINE void LL_I2S_SetChannelLengthType (SPI_TypeDef *SPIx, uint32_t ChannelLengthType)
 Set I2S Channel Length Type.
__STATIC_INLINE uint32_t LL_I2S_GetChannelLengthType (SPI_TypeDef *SPIx)
 Get I2S Channel Length Type.
__STATIC_INLINE void LL_I2S_EnableWordSelectInversion (SPI_TypeDef *SPIx)
 Invert the default polarity of WS signal.
__STATIC_INLINE void LL_I2S_DisableWordSelectInversion (SPI_TypeDef *SPIx)
 Use the default polarity of WS signal.
__STATIC_INLINE uint32_t LL_I2S_IsEnabledWordSelectInversion (SPI_TypeDef *SPIx)
 Check if polarity of WS signal is inverted.
__STATIC_INLINE void LL_I2S_SetClockPolarity (SPI_TypeDef *SPIx, uint32_t ClockPolarity)
 Set 2S Clock Polarity.
__STATIC_INLINE uint32_t LL_I2S_GetClockPolarity (SPI_TypeDef *SPIx)
 Get 2S Clock Polarity.
__STATIC_INLINE void LL_I2S_SetStandard (SPI_TypeDef *SPIx, uint32_t Standard)
 Set I2S standard.
__STATIC_INLINE uint32_t LL_I2S_GetStandard (SPI_TypeDef *SPIx)
 Get I2S standard.
__STATIC_INLINE void LL_I2S_SetTransferMode (SPI_TypeDef *SPIx, uint32_t Standard)
 Set I2S config.
__STATIC_INLINE uint32_t LL_I2S_GetTransferMode (SPI_TypeDef *SPIx)
 Get I2S config.
__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 and disable I2S mode.
__STATIC_INLINE void LL_I2S_EnableIOSwap (SPI_TypeDef *SPIx)
 Swap the SDO and SDI pin.
__STATIC_INLINE void LL_I2S_DisableIOSwap (SPI_TypeDef *SPIx)
 Restore default function for SDO and SDI pin.
__STATIC_INLINE uint32_t LL_I2S_IsEnabledIOSwap (SPI_TypeDef *SPIx)
 Check if SDO and SDI pin are swapped.
__STATIC_INLINE void LL_I2S_EnableGPIOControl (SPI_TypeDef *SPIx)
 Enable GPIO control.
__STATIC_INLINE void LL_I2S_DisableGPIOControl (SPI_TypeDef *SPIx)
 Disable GPIO control.
__STATIC_INLINE uint32_t LL_I2S_IsEnabledGPIOControl (SPI_TypeDef *SPIx)
 Check if GPIO control is active.
__STATIC_INLINE void LL_I2S_EnableIOLock (SPI_TypeDef *SPIx)
 Lock the AF configuration of associated IOs.
__STATIC_INLINE uint32_t LL_I2S_IsEnabledIOLock (SPI_TypeDef *SPIx)
 Check if the the SPI_CFG2 register is locked.
__STATIC_INLINE void LL_I2S_SetTransferBitOrder (SPI_TypeDef *SPIx, uint32_t BitOrder)
 Set Transfer Bit Order.
__STATIC_INLINE uint32_t LL_I2S_GetTransferBitOrder (SPI_TypeDef *SPIx)
 Get Transfer Bit Order.
__STATIC_INLINE void LL_I2S_StartTransfer (SPI_TypeDef *SPIx)
 Start effective transfer on wire.
__STATIC_INLINE uint32_t LL_I2S_IsActiveTransfer (SPI_TypeDef *SPIx)
 Check if there is an unfinished transfer.
__STATIC_INLINE void LL_I2S_SetFIFOThreshold (SPI_TypeDef *SPIx, uint32_t Threshold)
 Set threshold of FIFO that triggers a transfer event.
__STATIC_INLINE uint32_t LL_I2S_GetFIFOThreshold (SPI_TypeDef *SPIx)
 Get threshold of FIFO that triggers a transfer event.
__STATIC_INLINE void LL_I2S_SetPrescalerLinear (SPI_TypeDef *SPIx, uint32_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 Output (Pin MCK)
__STATIC_INLINE void LL_I2S_DisableMasterClock (SPI_TypeDef *SPIx)
 Disable the Master Clock Output (Pin MCK)
__STATIC_INLINE uint32_t LL_I2S_IsEnabledMasterClock (SPI_TypeDef *SPIx)
 Check if the master clock output (Pin MCK) is enabled.

Function Documentation

__STATIC_INLINE void LL_I2S_Disable ( SPI_TypeDef *  SPIx)

Disable I2S peripheral and disable I2S mode.

Reference Manual to LL API cross reference:
CR1 SPE LL_I2S_Disable
I2SCFGR I2SMOD LL_I2S_Disable
Parameters:
SPIxSPI Handle
Return values:
None

Definition at line 3043 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_DisableGPIOControl ( SPI_TypeDef *  SPIx)

Disable GPIO control.

Note:
This configuration can not be changed when I2S is enabled.
Reference Manual to LL API cross reference:
CFG2 AFCNTR LL_I2S_DisableGPIOControl
Parameters:
SPIxSPI Instance
Return values:
None

Definition at line 3103 of file stm32h7xx_ll_spi.h.

References LL_SPI_DisableGPIOControl().

__STATIC_INLINE void LL_I2S_DisableIOSwap ( SPI_TypeDef *  SPIx)

Restore default function for SDO and SDI pin.

Note:
This configuration can not be changed when I2S is enabled.
Reference Manual to LL API cross reference:
CFG2 IOSWP LL_I2S_DisableIOSwap
Parameters:
SPIxSPI Instance
Return values:
None

Definition at line 3068 of file stm32h7xx_ll_spi.h.

References LL_SPI_DisableIOSwap().

__STATIC_INLINE void LL_I2S_DisableMasterClock ( SPI_TypeDef *  SPIx)

Disable the Master Clock Output (Pin MCK)

Reference Manual to LL API cross reference:
I2SCFGR MCKOE LL_I2S_DisableMasterClock
Parameters:
SPIxSPI Handle
Return values:
None

Definition at line 3300 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_DisableWordSelectInversion ( SPI_TypeDef *  SPIx)

Use the default polarity of WS signal.

Reference Manual to LL API cross reference:
I2SCFGR WSINV LL_I2S_DisableWordSelectInversion
Parameters:
SPIxSPI Handle
Return values:
None

Definition at line 2910 of file stm32h7xx_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
CR1 SPE LL_I2S_Enable
Parameters:
SPIxSPI Handle
Return values:
None

Definition at line 3030 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_EnableGPIOControl ( SPI_TypeDef *  SPIx)

Enable GPIO control.

Note:
This configuration can not be changed when I2S is enabled.
Reference Manual to LL API cross reference:
CFG2 AFCNTR LL_I2S_EnableGPIOControl
Parameters:
SPIxSPI Instance
Return values:
None

Definition at line 3091 of file stm32h7xx_ll_spi.h.

References LL_SPI_EnableGPIOControl().

__STATIC_INLINE void LL_I2S_EnableIOLock ( SPI_TypeDef *  SPIx)

Lock the AF configuration of associated IOs.

Note:
Once this bit is set, the SPI_CFG2 register content can not be modified until a hardware reset occurs. The reset of the IOLock bit is done by hardware. for that, LL_SPI_DisableIOLock can not exist.
Reference Manual to LL API cross reference:
CR1 IOLOCK LL_SPI_EnableIOLock
Parameters:
SPIxSPI Instance
Return values:
None

Definition at line 3127 of file stm32h7xx_ll_spi.h.

References LL_SPI_EnableIOLock().

__STATIC_INLINE void LL_I2S_EnableIOSwap ( SPI_TypeDef *  SPIx)

Swap the SDO and SDI pin.

Note:
This configuration can not be changed when I2S is enabled.
Reference Manual to LL API cross reference:
CFG2 IOSWP LL_I2S_EnableIOSwap
Parameters:
SPIxSPI Instance
Return values:
None

Definition at line 3056 of file stm32h7xx_ll_spi.h.

References LL_SPI_EnableIOSwap().

__STATIC_INLINE void LL_I2S_EnableMasterClock ( SPI_TypeDef *  SPIx)

Enable the Master Clock Output (Pin MCK)

Reference Manual to LL API cross reference:
I2SCFGR MCKOE LL_I2S_EnableMasterClock
Parameters:
SPIxSPI Handle
Return values:
None

Definition at line 3289 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_EnableWordSelectInversion ( SPI_TypeDef *  SPIx)

Invert the default polarity of WS signal.

Reference Manual to LL API cross reference:
I2SCFGR WSINV LL_I2S_EnableWordSelectInversion
Parameters:
SPIxSPI Handle
Return values:
None

Definition at line 2899 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE uint32_t LL_I2S_GetChannelLengthType ( SPI_TypeDef *  SPIx)

Get I2S Channel Length Type.

Note:
This feature is useful with SLAVE only
Reference Manual to LL API cross reference:
I2SCFGR FIXCH LL_I2S_GetChannelLengthType
Parameters:
SPIxSPI Handle
Return values:
Returnvalue can be one of the following values:

Definition at line 2888 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE uint32_t LL_I2S_GetClockPolarity ( SPI_TypeDef *  SPIx)

Get 2S Clock Polarity.

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

Definition at line 2948 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE uint32_t LL_I2S_GetDataFormat ( SPI_TypeDef *  SPIx)

Get I2S Data frame format.

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

Definition at line 2859 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE uint32_t LL_I2S_GetFIFOThreshold ( SPI_TypeDef *  SPIx)

Get threshold of FIFO that triggers a transfer event.

Reference Manual to LL API cross reference:
CFG1 FTHLV LL_I2S_GetFIFOThreshold
Parameters:
SPIxSPI Instance
Return values:
Returnedvalue can be one of the following values:

Definition at line 3227 of file stm32h7xx_ll_spi.h.

References LL_SPI_GetFIFOThreshold().

__STATIC_INLINE uint32_t LL_I2S_GetPrescalerLinear ( SPI_TypeDef *  SPIx)

Get I2S linear prescaler.

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

Definition at line 3251 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE uint32_t LL_I2S_GetPrescalerParity ( SPI_TypeDef *  SPIx)

Get I2S parity prescaler.

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

Definition at line 3278 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE uint32_t LL_I2S_GetStandard ( SPI_TypeDef *  SPIx)

Get I2S standard.

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

Definition at line 2983 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE uint32_t LL_I2S_GetTransferBitOrder ( SPI_TypeDef *  SPIx)

Get Transfer Bit Order.

Reference Manual to LL API cross reference:
CFG2 LSBFRST LL_I2S_GetTransferBitOrder
Parameters:
SPIxSPI Instance
Return values:
Returnedvalue can be one of the following values:

Definition at line 3165 of file stm32h7xx_ll_spi.h.

References LL_SPI_GetTransferBitOrder().

__STATIC_INLINE uint32_t LL_I2S_GetTransferMode ( SPI_TypeDef *  SPIx)

Get I2S config.

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

Definition at line 3018 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE uint32_t LL_I2S_IsActiveTransfer ( SPI_TypeDef *  SPIx)

Check if there is an unfinished transfer.

Reference Manual to LL API cross reference:
CR1 CSTART LL_I2S_IsTransferActive
Parameters:
SPIxSPI Instance
Return values:
Stateof bit (1 or 0)

Definition at line 3187 of file stm32h7xx_ll_spi.h.

References LL_SPI_IsActiveMasterTransfer().

__STATIC_INLINE uint32_t LL_I2S_IsEnabledGPIOControl ( SPI_TypeDef *  SPIx)

Check if GPIO control is active.

Reference Manual to LL API cross reference:
CFG2 AFCNTR LL_I2S_IsEnabledGPIOControl
Parameters:
SPIxSPI Instance
Return values:
Stateof bit (1 or 0)

Definition at line 3114 of file stm32h7xx_ll_spi.h.

References LL_SPI_IsEnabledGPIOControl().

__STATIC_INLINE uint32_t LL_I2S_IsEnabledIOLock ( SPI_TypeDef *  SPIx)

Check if the the SPI_CFG2 register is locked.

Reference Manual to LL API cross reference:
CR1 IOLOCK LL_I2S_IsEnabledIOLock
Parameters:
SPIxSPI Instance
Return values:
Stateof bit (1 or 0)

Definition at line 3138 of file stm32h7xx_ll_spi.h.

References LL_SPI_IsEnabledIOLock().

__STATIC_INLINE uint32_t LL_I2S_IsEnabledIOSwap ( SPI_TypeDef *  SPIx)

Check if SDO and SDI pin are swapped.

Reference Manual to LL API cross reference:
CFG2 IOSWP LL_I2S_IsEnabledIOSwap
Parameters:
SPIxSPI Instance
Return values:
Stateof bit (1 or 0)

Definition at line 3079 of file stm32h7xx_ll_spi.h.

References LL_SPI_IsEnabledIOSwap().

__STATIC_INLINE uint32_t LL_I2S_IsEnabledMasterClock ( SPI_TypeDef *  SPIx)

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

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

Definition at line 3311 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE uint32_t LL_I2S_IsEnabledWordSelectInversion ( SPI_TypeDef *  SPIx)

Check if polarity of WS signal is inverted.

Reference Manual to LL API cross reference:
I2SCFGR WSINV LL_I2S_IsEnabledWordSelectInversion
Parameters:
SPIxSPI Handle
Return values:
Stateof bit (1 or 0)

Definition at line 2921 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_SetChannelLengthType ( SPI_TypeDef *  SPIx,
uint32_t  ChannelLengthType 
)

Set I2S Channel Length Type.

Note:
This feature is useful with SLAVE only
Reference Manual to LL API cross reference:
I2SCFGR FIXCH LL_I2S_SetChannelLengthType
Parameters:
SPIxSPI Handle
ChannelLengthTypeThis parameter can be one of the following values:
Return values:
None

Definition at line 2874 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_SetClockPolarity ( SPI_TypeDef *  SPIx,
uint32_t  ClockPolarity 
)

Set 2S Clock Polarity.

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

Definition at line 2935 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_SetDataFormat ( SPI_TypeDef *  SPIx,
uint32_t  DataLength 
)

Set I2S Data frame format.

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

Definition at line 2841 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_SetFIFOThreshold ( SPI_TypeDef *  SPIx,
uint32_t  Threshold 
)

Set threshold of FIFO that triggers a transfer event.

Note:
This configuration can not be changed when I2S is enabled.
Reference Manual to LL API cross reference:
CFG1 FTHLV LL_I2S_SetFIFOThreshold
Parameters:
SPIxSPI Instance
ThresholdThis parameter can be one of the following values:
Return values:
None

Definition at line 3208 of file stm32h7xx_ll_spi.h.

References LL_SPI_SetFIFOThreshold().

__STATIC_INLINE void LL_I2S_SetPrescalerLinear ( SPI_TypeDef *  SPIx,
uint32_t  PrescalerLinear 
)

Set I2S linear prescaler.

Reference Manual to LL API cross reference:
I2SCFGR I2SDIV LL_I2S_SetPrescalerLinear
Parameters:
SPIxSPI Instance
PrescalerLinearValue between Min_Data=0x00 and Max_Data=0xFF
Note:
PrescalerLinear '1' is not authorized with parity LL_I2S_PRESCALER_PARITY_ODD
Return values:
None

Definition at line 3240 of file stm32h7xx_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:
I2SCFGR ODD LL_I2S_SetPrescalerParity
Parameters:
SPIxSPI Instance
PrescalerParityThis parameter can be one of the following values:
Return values:
None

Definition at line 3265 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_SetStandard ( SPI_TypeDef *  SPIx,
uint32_t  Standard 
)

Set I2S standard.

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

Definition at line 2966 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_SetTransferBitOrder ( SPI_TypeDef *  SPIx,
uint32_t  BitOrder 
)

Set Transfer Bit Order.

Note:
This configuration can not be changed when I2S is enabled.
Reference Manual to LL API cross reference:
CFG2 LSBFRST LL_I2S_SetTransferBitOrder
Parameters:
SPIxSPI Instance
BitOrderThis parameter can be one of the following values:
Return values:
None

Definition at line 3153 of file stm32h7xx_ll_spi.h.

References LL_SPI_SetTransferBitOrder().

__STATIC_INLINE void LL_I2S_SetTransferMode ( SPI_TypeDef *  SPIx,
uint32_t  Standard 
)

Set I2S config.

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

Definition at line 3001 of file stm32h7xx_ll_spi.h.

__STATIC_INLINE void LL_I2S_StartTransfer ( SPI_TypeDef *  SPIx)

Start effective transfer on wire.

Reference Manual to LL API cross reference:
CR1 CSTART LL_I2S_StartTransfer
Parameters:
SPIxSPI Instance
Return values:
None

Definition at line 3176 of file stm32h7xx_ll_spi.h.

References LL_SPI_StartMasterTransfer().