Struct microbit::hal::spis::Spis

pub struct Spis<T> where
    T: Instance,  { /* private fields */ }

Interface to a SPIS instance.

Implementations

impl<T> Spis<T> where
    T: Instance, 

pub fn new(spis: T, pins: Pins) -> Spis<T>

Takes ownership of the raw SPIS peripheral and relevant pins, returning a safe wrapper.

pub fn set_default_char(&self, def: u8) -> &Spis<T>

Sets the ´default´ character (character clocked out in case of an ignored transaction).

pub fn set_orc(&self, orc: u8) -> &Spis<T>

Sets the over-read character (character sent on over-read of the transmit buffer).

pub fn set_order(&self, order: Order) -> &Spis<T>

Sets bit order.

pub fn set_polarity(&self, polarity: Polarity) -> &Spis<T>

Sets serial clock (SCK) polarity.

pub fn set_phase(&self, phase: Phase) -> &Spis<T>

Sets serial clock (SCK) phase.

pub fn set_mode(&self, mode: Mode) -> &Spis<T>

Sets SPI mode.

pub fn enable(&self) -> &Spis<T>

Enables the SPIS instance.

pub fn disable(&self) -> &Spis<T>

Disables the SPIS module.

pub fn acquire(&self) -> &Spis<T>

Requests acquiring the SPIS semaphore and waits until acquired.

pub fn try_acquire(&self) -> Result<&Spis<T>, Error>

Requests acquiring the SPIS semaphore, returning an error if not possible.

Note: The semaphore will still be requested, and will be made available at a later point.

pub fn release(&self) -> &Spis<T>

Releases the SPIS semaphore, enabling the SPIS to acquire it.

pub fn enable_interrupt(&self, event: SpisEvent) -> &Spis<T>

Enables interrupt for specified event.

pub fn disable_interrupt(&self, event: SpisEvent) -> &Spis<T>

Disables interrupt for specified event.

pub fn auto_acquire(&self, enabled: bool) -> &Spis<T>

Automatically acquire the semaphore after transfer has ended.

pub fn reset_events(&self)

Resets all events.

pub fn reset_event(&self, event: SpisEvent)

Resets specified event.

pub fn is_event_triggered(&self, event: SpisEvent) -> bool

Checks if specified event has been triggered.

pub fn is_done(&self) -> bool

Checks if the granted transfer is done.

pub fn is_acquired(&self) -> bool

Checks if the semaphore is acquired.

pub fn is_overread(&self) -> bool

Checks if last transaction overread.

pub fn is_overflow(&self) -> bool

Checks if last transaction overflowed.

pub fn amount(&self) -> u32

Returns number of bytes received in last granted transaction.

pub fn semaphore_status(&self) -> SemaphoreStatus

Returns the semaphore status.

pub fn event_acquired(&self) -> &Reg<EVENTS_ACQUIRED_SPEC>

Returns reference to Acquired event endpoint for PPI.

pub fn event_end(&self) -> &Reg<EVENTS_END_SPEC>

Returns reference to End event endpoint for PPI.

pub fn event_end_rx(&self) -> &Reg<EVENTS_ENDRX_SPEC>

Returns reference to EndRx event endpoint for PPI.

pub fn task_acquire(&self) -> &Reg<TASKS_ACQUIRE_SPEC>

Returns reference to Acquire task endpoint for PPI.

pub fn task_release(&self) -> &Reg<TASKS_RELEASE_SPEC>

Returns reference to Release task endpoint for PPI.

pub fn transfer<W, B>(
    self,
    buffer: B
) -> Result<Transfer<T, B>, (Error, Spis<T>, B)> where
    B: 'static + WriteBuffer<Word = W>, 

Full duplex DMA transfer. Transmits the given buffer while simultaneously receiving data into the same buffer until it is filled. Buffer must be located in RAM. Returns a value that represents the in-progress DMA transfer.

pub fn transfer_split<TxW, RxW, TxB, RxB>(
    self,
    tx_buffer: TxB,
    rx_buffer: RxB
) -> Result<TransferSplit<T, TxB, RxB>, (Error, Spis<T>, TxB, RxB)> where
    TxB: 'static + ReadBuffer<Word = TxW>,
    RxB: 'static + WriteBuffer<Word = RxW>, 

Full duplex DMA transfer. Transmits the given tx_buffer while simultaneously receiving data into the given rx_buffer until it is filled. The buffers must be located in RAM. Returns a value that represents the in-progress DMA transfer.

pub fn free(self) -> (T, Pins)

Returns the raw interface to the underlying SPIS peripheral.