Struct spidev::SpidevOptions

pub struct SpidevOptions {
    pub bits_per_word: Option<u8>,
    pub max_speed_hz: Option<u32>,
    pub lsb_first: Option<bool>,
    pub spi_mode: Option<SpiModeFlags>,
}

Options that control defaults for communication on a device

Individual settings may be overridden via parameters that are specified as part of any individual SpiTransfer when using transfer or transfer_multiple.

Options that are not configured with one of the builder functions will not be modified in the kernel when configure is called.

Fields

bits_per_word: Option<u8>

max_speed_hz: Option<u32>

lsb_first: Option<bool>

spi_mode: Option<SpiModeFlags>

Implementations

impl SpidevOptions

pub fn new() -> SpidevOptions

Create a new, empty set of options

pub fn bits_per_word(&mut self, bits_per_word: u8) -> &mut Self

The number of bits in each SPI transfer word

The value zero signifies eight bits.

pub fn max_speed_hz(&mut self, max_speed_hz: u32) -> &mut Self

The maximum SPI transfer speed, in Hz

The controller can’t necessarily assign that specific clock speed.

pub fn lsb_first(&mut self, lsb_first: bool) -> &mut Self

The bit justification used to transfer SPI words

Zero indicates MSB-first; other values indicate the less common LSB-first encoding. In both cases the specified value is right-justified in each word, so that unused (TX) or undefined (RX) bits are in the MSBs.

pub fn mode(&mut self, mode: SpiModeFlags) -> &mut Self

Set the SPI Transfer Mode

Use the constants SPI_MODE_0..SPI_MODE_3; or if you prefer you can combine SPI_CPOL (clock polarity, idle high iff this is set) or SPI_CPHA (clock phase, sample on trailing edge iff this is set) flags.

Note that this API will always prefer to use SPI_IOC_WR_MODE rathern than the 32-bit one to target the greatest number of kernels. SPI_IOC_WR_MODE32 is only present in 3.15+ kernels. SPI_IOC_WR_MODE32 will be used iff bits higher than those in 8bits are provided (e.g. Dual/Quad Tx/Rx).

pub fn build(&self) -> Self

Finalize and build the SpidevOptions

Trait Implementations

impl Clone for SpidevOptions

fn clone(&self) -> SpidevOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpidevOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SpidevOptions

fn default() -> SpidevOptions

Returns the “default value” for a type.

impl PartialEq<SpidevOptions> for SpidevOptions

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Copy for SpidevOptions

impl StructuralPartialEq for SpidevOptions