Struct stm32_metapac::sai::regs::Cr1

#[repr(transparent)]
pub struct Cr1(pub u32);

Configuration register 1

Tuple Fields

0: u32

Implementations

impl Cr1

pub const fn mode(&self) -> Mode

SAIx audio block mode immediately

pub fn set_mode(&mut self, val: Mode)

SAIx audio block mode immediately

pub const fn prtcfg(&self) -> Prtcfg

Protocol configuration. These bits are set and cleared by software. These bits have to be configured when the audio block is disabled.

pub fn set_prtcfg(&mut self, val: Prtcfg)

Protocol configuration. These bits are set and cleared by software. These bits have to be configured when the audio block is disabled.

pub const fn ds(&self) -> Ds

Data size. These bits are set and cleared by software. These bits are ignored when the SPDIF protocols are selected (bit PRTCFG[1:0]), because the frame and the data size are fixed in such case. When the companding mode is selected through COMP[1:0] bits, DS[1:0] are ignored since the data size is fixed to 8 bits by the algorithm. These bits must be configured when the audio block is disabled.

pub fn set_ds(&mut self, val: Ds)

Data size. These bits are set and cleared by software. These bits are ignored when the SPDIF protocols are selected (bit PRTCFG[1:0]), because the frame and the data size are fixed in such case. When the companding mode is selected through COMP[1:0] bits, DS[1:0] are ignored since the data size is fixed to 8 bits by the algorithm. These bits must be configured when the audio block is disabled.

pub const fn lsbfirst(&self) -> Lsbfirst

Least significant bit first. This bit is set and cleared by software. It must be configured when the audio block is disabled. This bit has no meaning in AC97 audio protocol since AC97 data are always transferred with the MSB first. This bit has no meaning in SPDIF audio protocol since in SPDIF data are always transferred with LSB first.

pub fn set_lsbfirst(&mut self, val: Lsbfirst)

Least significant bit first. This bit is set and cleared by software. It must be configured when the audio block is disabled. This bit has no meaning in AC97 audio protocol since AC97 data are always transferred with the MSB first. This bit has no meaning in SPDIF audio protocol since in SPDIF data are always transferred with LSB first.

pub const fn ckstr(&self) -> Ckstr

Clock strobing edge. This bit is set and cleared by software. It must be configured when the audio block is disabled. This bit has no meaning in SPDIF audio protocol.

pub fn set_ckstr(&mut self, val: Ckstr)

Clock strobing edge. This bit is set and cleared by software. It must be configured when the audio block is disabled. This bit has no meaning in SPDIF audio protocol.

pub const fn syncen(&self) -> Syncen

Synchronization enable. These bits are set and cleared by software. They must be configured when the audio sub-block is disabled. Note: The audio sub-block should be configured as asynchronous when SPDIF mode is enabled.

pub fn set_syncen(&mut self, val: Syncen)

Synchronization enable. These bits are set and cleared by software. They must be configured when the audio sub-block is disabled. Note: The audio sub-block should be configured as asynchronous when SPDIF mode is enabled.

pub const fn mono(&self) -> Mono

Mono mode. This bit is set and cleared by software. It is meaningful only when the number of slots is equal to 2. When the mono mode is selected, slot 0 data are duplicated on slot 1 when the audio block operates as a transmitter. In reception mode, the slot1 is discarded and only the data received from slot 0 are stored. Refer to Section: Mono/stereo mode for more details.

pub fn set_mono(&mut self, val: Mono)

Mono mode. This bit is set and cleared by software. It is meaningful only when the number of slots is equal to 2. When the mono mode is selected, slot 0 data are duplicated on slot 1 when the audio block operates as a transmitter. In reception mode, the slot1 is discarded and only the data received from slot 0 are stored. Refer to Section: Mono/stereo mode for more details.

pub const fn outdriv(&self) -> Outdriv

Output drive. This bit is set and cleared by software. Note: This bit has to be set before enabling the audio block and after the audio block configuration.

pub fn set_outdriv(&mut self, val: Outdriv)

Output drive. This bit is set and cleared by software. Note: This bit has to be set before enabling the audio block and after the audio block configuration.

pub const fn saien(&self) -> bool

Audio block enable where x is A or B. This bit is set by software. To switch off the audio block, the application software must program this bit to 0 and poll the bit till it reads back 0, meaning that the block is completely disabled. Before setting this bit to 1, check that it is set to 0, otherwise the enable command will not be taken into account. This bit allows to control the state of SAIx audio block. If it is disabled when an audio frame transfer is ongoing, the ongoing transfer completes and the cell is fully disabled at the end of this audio frame transfer. Note: When SAIx block is configured in master mode, the clock must be present on the input of SAIx before setting SAIXEN bit.

pub fn set_saien(&mut self, val: bool)

Audio block enable where x is A or B. This bit is set by software. To switch off the audio block, the application software must program this bit to 0 and poll the bit till it reads back 0, meaning that the block is completely disabled. Before setting this bit to 1, check that it is set to 0, otherwise the enable command will not be taken into account. This bit allows to control the state of SAIx audio block. If it is disabled when an audio frame transfer is ongoing, the ongoing transfer completes and the cell is fully disabled at the end of this audio frame transfer. Note: When SAIx block is configured in master mode, the clock must be present on the input of SAIx before setting SAIXEN bit.

pub const fn dmaen(&self) -> bool

DMA enable. This bit is set and cleared by software. Note: Since the audio block defaults to operate as a transmitter after reset, the MODE[1:0] bits must be configured before setting DMAEN to avoid a DMA request in receiver mode.

pub fn set_dmaen(&mut self, val: bool)

DMA enable. This bit is set and cleared by software. Note: Since the audio block defaults to operate as a transmitter after reset, the MODE[1:0] bits must be configured before setting DMAEN to avoid a DMA request in receiver mode.

pub const fn nodiv(&self) -> Nodiv

No fixed divider between MCLK and FS

pub fn set_nodiv(&mut self, val: Nodiv)

No fixed divider between MCLK and FS

pub const fn mckdiv(&self) -> u8

Master clock divider. These bits are set and cleared by software. These bits are meaningless when the audio block operates in slave mode. They have to be configured when the audio block is disabled. Others: the master clock frequency is calculated accordingly to the following formula:

pub fn set_mckdiv(&mut self, val: u8)

Master clock divider. These bits are set and cleared by software. These bits are meaningless when the audio block operates in slave mode. They have to be configured when the audio block is disabled. Others: the master clock frequency is calculated accordingly to the following formula:

pub const fn osr(&self) -> bool

Oversampling ratio for master clock

pub fn set_osr(&mut self, val: bool)

Oversampling ratio for master clock

pub const fn mcken(&self) -> bool

Master clock generation enable

pub fn set_mcken(&mut self, val: bool)

Master clock generation enable

Trait Implementations

impl Clone for Cr1

fn clone(&self) -> Cr1

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Cr1

fn default() -> Cr1

Returns the “default value” for a type.

impl PartialEq for Cr1

fn eq(&self, other: &Cr1) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Cr1

impl Eq for Cr1

impl StructuralPartialEq for Cr1