Struct stm32_i2s_v12x::driver::Status

pub struct Status<MS, DIR, STD> { /* private fields */ }

Content of the status register.

• MS: Master or Slave
• DIR: communication direction, Transmit or Receive
• STD: I2S standard, eg Philips

Implementations

impl<MS, DIR, STD> Status<MS, DIR, STD>

pub fn bsy(&self) -> bool

Get the BSY flag. If true the I2s device is busy communicating.

impl<MS, DIR, STD> Status<MS, DIR, STD>

where STD: ChannelFlag,

pub fn chside(&self) -> Channel

Get the CHSIDE flag. It indicate the channel that has been received or will be transmitted.

This flag is updated when TXE or RXNE flags are set. This flag is meaningless and therefore not reliable in case of an error. This flag is not meaningful when using the PCM standard.

impl<DIR, STD> Status<Slave, DIR, STD>

pub fn fre(&self) -> bool

Get the FRE flag. If true, a frame error occurred.

This flag is set by hardware when the WS line changes at an unexpected moment. Usually, this indicates a synchronisation issue. This flag can only be set in Slave mode and therefore can only be read in this mode.

This flag is cleared when reading the status register.

impl<MS, STD> Status<MS, Receive, STD>

pub fn ovr(&self) -> bool

Get the OVR flag. If true an overrun error occurred.

This flag is set when data are received and the previous data have not yet been read. As a result, the incoming data are lost. Since this flag can happen only in Receive mode, it can only be read in this mode.

This flag is cleared by a read operation on the data register followed by a read to the status register.

pub fn rxne(&self) -> bool

Get the RXNE flag. If true a valid received data is present in the Rx buffer.

This flag can only happen in reception mode and therefore can only be read in this mode.

This flag is cleared when the data register is read.

impl<MS, STD> Status<MS, Transmit, STD>

pub fn txe(&self) -> bool

Get the TXE flag. If true the Tx buffer is empty and the next sample can be loaded into it.

This flag can only happen in transmission mode and therefore can only be read in this mode.

This flag is cleared by writing into the data register or by disabling the I2s peripheral.

impl<STD> Status<Slave, Transmit, STD>

pub fn udr(&self) -> bool

Get the UDR flag. If true an underrun error occurred.

This flag is set when the first clock for data transmission appears while the software has not yet loaded any value into the data register. This flag can only be set in Slave Transmit mode and therefore can only be read in this mode.

This flag is cleared by reading the status register.