View Source Wafer.Driver.Circuits.SPI (wafer v1.1.0)

A connection to a chip via Circuits's SPI driver.

Implements the Wafer.Conn behaviour as well as the Wafer.SPI protocol.

Summary

driver_option()

option()

options()

t()

acquire(opts)

Acquire a connection to a peripheral using the Circuits' SPI driver on the specified bus and address.

@type driver_option() ::
  {:mode, 0..3}
  | {:bits_per_word, 0..16}
  | {:speed_hz, pos_integer()}
  | {:delay_us, non_neg_integer()}

@type option() :: {:bus_name, binary()}

@type options() :: [option() | driver_option()]

@type t() :: %Wafer.Driver.Circuits.SPI{bus: binary(), ref: reference()}

@spec acquire(options()) :: {:ok, t()} | {:error, reason :: any()}

Acquire a connection to a peripheral using the Circuits' SPI driver on the specified bus and address.