Struct rp2040_hal::spi::Spi[−][src]

pub struct Spi<S: State, D: SpiDevice, const DS: u8> { /* fields omitted */ }

Expand description

Spi

Implementations

[src]

impl<S: State, D: SpiDevice, const DS: u8> Spi<S, D, DS>

[src]

pub fn free(self) -> D

Releases the underlying device.

[src]

pub fn set_baudrate<F: Into<Hertz<u32>>, B: Into<Hertz<u32>>>(
 &mut self,
 peri_frequency: F,
 baudrate: B
) -> Hertz

Set baudrate based on peripheral clock

Typically the peripheral clock is set to 125_000_000

[src]

impl<D: SpiDevice, const DS: u8> Spi<Disabled, D, DS>

[src]

pub fn new(device: D) -> Spi<Disabled, D, DS>

Create new spi device

[src]

pub fn init<F: Into<Hertz<u32>>, B: Into<Hertz<u32>>>(
 self,
 resets: &mut RESETS,
 peri_frequency: F,
 baudrate: B,
 mode: &Mode
) -> Spi<Enabled, D, DS>

Initialize the SPI

[src]

impl<D: SpiDevice, const DS: u8> Spi<Enabled, D, DS>

[src]

pub fn disable(self) -> Spi<Disabled, D, DS>

Disable the spi to reset its configuration

Trait Implementations

[src]

impl<D: SpiDevice> FullDuplex<u16> for Spi<Enabled, D, 9>

type Error = Infallible

An enumeration of SPI errors

[src]

fn read(&mut self) -> Result<u16, Error<Infallible>>

Reads the word stored in the shift register Read more

[src]

fn send(&mut self, word: u16) -> Result<(), Error<Infallible>>

Sends a word to the slave

[src]

impl<D: SpiDevice> FullDuplex<u16> for Spi<Enabled, D, 10>

type Error = Infallible

An enumeration of SPI errors

[src]

fn read(&mut self) -> Result<u16, Error<Infallible>>

Reads the word stored in the shift register Read more

[src]

fn send(&mut self, word: u16) -> Result<(), Error<Infallible>>

Sends a word to the slave

[src]

impl<D: SpiDevice> FullDuplex<u16> for Spi<Enabled, D, 11>

type Error = Infallible

An enumeration of SPI errors

[src]

fn read(&mut self) -> Result<u16, Error<Infallible>>

Reads the word stored in the shift register Read more

[src]

fn send(&mut self, word: u16) -> Result<(), Error<Infallible>>

Sends a word to the slave

[src]

impl<D: SpiDevice> FullDuplex<u16> for Spi<Enabled, D, 22>

type Error = Infallible

An enumeration of SPI errors

[src]

fn read(&mut self) -> Result<u16, Error<Infallible>>

Reads the word stored in the shift register Read more

[src]

fn send(&mut self, word: u16) -> Result<(), Error<Infallible>>

Sends a word to the slave

[src]

impl<D: SpiDevice> FullDuplex<u16> for Spi<Enabled, D, 13>

type Error = Infallible

An enumeration of SPI errors

[src]

fn read(&mut self) -> Result<u16, Error<Infallible>>

Reads the word stored in the shift register Read more

[src]

fn send(&mut self, word: u16) -> Result<(), Error<Infallible>>

Sends a word to the slave

[src]

impl<D: SpiDevice> FullDuplex<u16> for Spi<Enabled, D, 14>

type Error = Infallible

An enumeration of SPI errors

[src]

fn read(&mut self) -> Result<u16, Error<Infallible>>

Reads the word stored in the shift register Read more

[src]

fn send(&mut self, word: u16) -> Result<(), Error<Infallible>>

Sends a word to the slave

[src]

impl<D: SpiDevice> FullDuplex<u16> for Spi<Enabled, D, 15>

type Error = Infallible

An enumeration of SPI errors

[src]

fn read(&mut self) -> Result<u16, Error<Infallible>>

Reads the word stored in the shift register Read more

[src]

fn send(&mut self, word: u16) -> Result<(), Error<Infallible>>

Sends a word to the slave

[src]

impl<D: SpiDevice> FullDuplex<u16> for Spi<Enabled, D, 16>

type Error = Infallible

An enumeration of SPI errors

[src]

fn read(&mut self) -> Result<u16, Error<Infallible>>

Reads the word stored in the shift register Read more

[src]

fn send(&mut self, word: u16) -> Result<(), Error<Infallible>>

Sends a word to the slave

[src]

impl<D: SpiDevice> FullDuplex<u8> for Spi<Enabled, D, 4>

type Error = Infallible

An enumeration of SPI errors

[src]

fn read(&mut self) -> Result<u8, Error<Infallible>>

Reads the word stored in the shift register Read more

[src]

fn send(&mut self, word: u8) -> Result<(), Error<Infallible>>

Sends a word to the slave

[src]

impl<D: SpiDevice> FullDuplex<u8> for Spi<Enabled, D, 5>

type Error = Infallible

An enumeration of SPI errors

[src]

fn read(&mut self) -> Result<u8, Error<Infallible>>

Reads the word stored in the shift register Read more

[src]

fn send(&mut self, word: u8) -> Result<(), Error<Infallible>>

Sends a word to the slave

[src]

impl<D: SpiDevice> FullDuplex<u8> for Spi<Enabled, D, 6>

type Error = Infallible

An enumeration of SPI errors

[src]

fn read(&mut self) -> Result<u8, Error<Infallible>>

Reads the word stored in the shift register Read more

[src]

fn send(&mut self, word: u8) -> Result<(), Error<Infallible>>

Sends a word to the slave

[src]

impl<D: SpiDevice> FullDuplex<u8> for Spi<Enabled, D, 7>

type Error = Infallible

An enumeration of SPI errors

[src]

fn read(&mut self) -> Result<u8, Error<Infallible>>

Reads the word stored in the shift register Read more

[src]

fn send(&mut self, word: u8) -> Result<(), Error<Infallible>>

Sends a word to the slave

[src]

impl<D: SpiDevice> FullDuplex<u8> for Spi<Enabled, D, 8>

type Error = Infallible

An enumeration of SPI errors

[src]

fn read(&mut self) -> Result<u8, Error<Infallible>>

Reads the word stored in the shift register Read more

[src]

fn send(&mut self, word: u8) -> Result<(), Error<Infallible>>

Sends a word to the slave

[src]

impl<D: SpiDevice> Default<u8> for Spi<Enabled, D, 8>

Auto Trait Implementations

impl<S, D, const DS: u8> RefUnwindSafe for Spi<S, D, DS> where
D: RefUnwindSafe,
S: RefUnwindSafe,

impl<S, D, const DS: u8> Send for Spi<S, D, DS> where
D: Send,
S: Send,

impl<S, D, const DS: u8> Sync for Spi<S, D, DS> where
D: Sync,
S: Sync,

impl<S, D, const DS: u8> Unpin for Spi<S, D, DS> where
D: Unpin,
S: Unpin,

impl<S, D, const DS: u8> UnwindSafe for Spi<S, D, DS> where
D: UnwindSafe,
S: UnwindSafe,

Blanket Implementations

[src]

impl<T> Any for T where
T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<W, S> Transfer<W> for S where
S: Default<W>,
W: Clone,

type Error = <S as FullDuplex<W>>::Error

Error type

[src]

pub fn transfer(
&mut self,
words: &'w mut [W]
) -> Result<&'w [W], <S as FullDuplex<W>>::Error>

Sends words to the slave. Returns the words received from the slave

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

[src]

impl<W, S> Write<W> for S where
S: Default<W>,
W: Clone,

type Error = <S as FullDuplex<W>>::Error

Error type

[src]

pub fn write(&mut self, words: &[W]) -> Result<(), <S as FullDuplex<W>>::Error>

Sends words to the slave, ignoring all the incoming words

[src]

impl<W, S> WriteIter<W> for S where
S: Default<W>,
W: Clone,

type Error = <S as FullDuplex<W>>::Error

Error type

[src]

pub fn write_iter<WI>(
 &mut self,
 words: WI
) -> Result<(), <S as FullDuplex<W>>::Error> where
 WI: IntoIterator<Item = W>,

Sends words to the slave, ignoring all the incoming words

Struct rp2040_hal::spi::Spi[−][src]

Implementations

impl<S: State, D: SpiDevice, const DS: u8> Spi<S, D, DS>

pub fn free(self) -> D

pub fn set_baudrate<F: Into<Hertz<u32>>, B: Into<Hertz<u32>>>( &mut self, peri_frequency: F, baudrate: B) -> Hertz

impl<D: SpiDevice, const DS: u8> Spi<Disabled, D, DS>

pub fn new(device: D) -> Spi<Disabled, D, DS>

pub fn init<F: Into<Hertz<u32>>, B: Into<Hertz<u32>>>( self, resets: &mut RESETS, peri_frequency: F, baudrate: B, mode: &Mode) -> Spi<Enabled, D, DS>

impl<D: SpiDevice, const DS: u8> Spi<Enabled, D, DS>

pub fn disable(self) -> Spi<Disabled, D, DS>

Trait Implementations

impl<D: SpiDevice> FullDuplex<u16> for Spi<Enabled, D, 9>

type Error = Infallible

fn read(&mut self) -> Result<u16, Error<Infallible>>

fn send(&mut self, word: u16) -> Result<(), Error<Infallible>>

impl<D: SpiDevice> FullDuplex<u16> for Spi<Enabled, D, 10>

type Error = Infallible

fn read(&mut self) -> Result<u16, Error<Infallible>>

fn send(&mut self, word: u16) -> Result<(), Error<Infallible>>

impl<D: SpiDevice> FullDuplex<u16> for Spi<Enabled, D, 11>

type Error = Infallible

fn read(&mut self) -> Result<u16, Error<Infallible>>

fn send(&mut self, word: u16) -> Result<(), Error<Infallible>>

impl<D: SpiDevice> FullDuplex<u16> for Spi<Enabled, D, 22>

type Error = Infallible

fn read(&mut self) -> Result<u16, Error<Infallible>>

fn send(&mut self, word: u16) -> Result<(), Error<Infallible>>

impl<D: SpiDevice> FullDuplex<u16> for Spi<Enabled, D, 13>

type Error = Infallible

fn read(&mut self) -> Result<u16, Error<Infallible>>

fn send(&mut self, word: u16) -> Result<(), Error<Infallible>>

impl<D: SpiDevice> FullDuplex<u16> for Spi<Enabled, D, 14>

type Error = Infallible

fn read(&mut self) -> Result<u16, Error<Infallible>>

fn send(&mut self, word: u16) -> Result<(), Error<Infallible>>

impl<D: SpiDevice> FullDuplex<u16> for Spi<Enabled, D, 15>

type Error = Infallible

fn read(&mut self) -> Result<u16, Error<Infallible>>

fn send(&mut self, word: u16) -> Result<(), Error<Infallible>>

impl<D: SpiDevice> FullDuplex<u16> for Spi<Enabled, D, 16>

type Error = Infallible

fn read(&mut self) -> Result<u16, Error<Infallible>>

fn send(&mut self, word: u16) -> Result<(), Error<Infallible>>

impl<D: SpiDevice> FullDuplex<u8> for Spi<Enabled, D, 4>

type Error = Infallible

fn read(&mut self) -> Result<u8, Error<Infallible>>

fn send(&mut self, word: u8) -> Result<(), Error<Infallible>>

impl<D: SpiDevice> FullDuplex<u8> for Spi<Enabled, D, 5>

type Error = Infallible

fn read(&mut self) -> Result<u8, Error<Infallible>>

fn send(&mut self, word: u8) -> Result<(), Error<Infallible>>

impl<D: SpiDevice> FullDuplex<u8> for Spi<Enabled, D, 6>

type Error = Infallible

fn read(&mut self) -> Result<u8, Error<Infallible>>

fn send(&mut self, word: u8) -> Result<(), Error<Infallible>>

impl<D: SpiDevice> FullDuplex<u8> for Spi<Enabled, D, 7>

type Error = Infallible

fn read(&mut self) -> Result<u8, Error<Infallible>>

fn send(&mut self, word: u8) -> Result<(), Error<Infallible>>

impl<D: SpiDevice> FullDuplex<u8> for Spi<Enabled, D, 8>

type Error = Infallible

fn read(&mut self) -> Result<u8, Error<Infallible>>

fn send(&mut self, word: u8) -> Result<(), Error<Infallible>>

impl<D: SpiDevice> Default<u16> for Spi<Enabled, D, 9>

impl<D: SpiDevice> Default<u16> for Spi<Enabled, D, 10>

impl<D: SpiDevice> Default<u16> for Spi<Enabled, D, 11>

impl<D: SpiDevice> Default<u16> for Spi<Enabled, D, 22>

impl<D: SpiDevice> Default<u16> for Spi<Enabled, D, 13>

impl<D: SpiDevice> Default<u16> for Spi<Enabled, D, 14>

impl<D: SpiDevice> Default<u16> for Spi<Enabled, D, 15>

impl<D: SpiDevice> Default<u16> for Spi<Enabled, D, 16>

impl<D: SpiDevice> Default<u16> for Spi<Enabled, D, 9>

impl<D: SpiDevice> Default<u16> for Spi<Enabled, D, 10>

impl<D: SpiDevice> Default<u16> for Spi<Enabled, D, 11>

impl<D: SpiDevice> Default<u16> for Spi<Enabled, D, 22>

impl<D: SpiDevice> Default<u16> for Spi<Enabled, D, 11>

impl<D: SpiDevice> Default<u16> for Spi<Enabled, D, 13>

impl<D: SpiDevice> Default<u16> for Spi<Enabled, D, 14>

impl<D: SpiDevice> Default<u16> for Spi<Enabled, D, 15>

impl<D: SpiDevice> Default<u16> for Spi<Enabled, D, 16>

pub fn set_baudrate<F: Into<Hertz<u32>>, B: Into<Hertz<u32>>>(
&mut self,
peri_frequency: F,
baudrate: B
) -> Hertz

pub fn init<F: Into<Hertz<u32>>, B: Into<Hertz<u32>>>(
self,
resets: &mut RESETS,
peri_frequency: F,
baudrate: B,
mode: &Mode
) -> Spi<Enabled, D, DS>

impl<S, D, const DS: u8> RefUnwindSafe for Spi<S, D, DS> where
D: RefUnwindSafe,
S: RefUnwindSafe,

impl<S, D, const DS: u8> Send for Spi<S, D, DS> where
D: Send,
S: Send,

impl<S, D, const DS: u8> Sync for Spi<S, D, DS> where
D: Sync,
S: Sync,

impl<S, D, const DS: u8> Unpin for Spi<S, D, DS> where
D: Unpin,
S: Unpin,

impl<S, D, const DS: u8> UnwindSafe for Spi<S, D, DS> where
D: UnwindSafe,
S: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<W, S> Transfer<W> for S where
S: Default<W>,
W: Clone,

pub fn transfer(
&mut self,
words: &'w mut [W]
) -> Result<&'w [W], <S as FullDuplex<W>>::Error>

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<W, S> Write<W> for S where
S: Default<W>,
W: Clone,

impl<W, S> WriteIter<W> for S where
S: Default<W>,
W: Clone,

pub fn write_iter<WI>(
&mut self,
words: WI
) -> Result<(), <S as FullDuplex<W>>::Error> where
WI: IntoIterator<Item = W>,