Struct WpeCaravel 

pub struct WpeCaravel {
    pub clk_period_ps: u32,
    pub baud: u32,
    pub pins: WpePins,
}

The engine on Caravel: its clock period, the host’s baud rate, and the pin plan.

Fields

clk_period_ps: u32

baud: u32

pins: WpePins

Implementations

impl WpeCaravel

pub fn clks_per_bit(&self) -> u64

System cycles per UART bit, the nearest the clock can make the baud rate.

pub fn baud_error_ppm(&self) -> u64

How far that bit period is from the baud rate’s, in parts per million.

pub fn read_round_trip_ps(&self, memory: &OffchipMemory) -> u64

A read’s round trip from the edge’s SCLK flop to its sample flop, outside the macro: the falling edge crosses the harness and the board, the part drives after tACLK, and the data crosses back. The edge samples half an SCLK period after that falling edge, so the half period must cover it.

pub fn half_sclk_ps(&self, memory: &OffchipMemory) -> u64

Half an SCLK period at the engine’s clock.

pub fn check(&self, memory: &OffchipMemory) -> Result<(), WpeCaravelUnplaceable>

Refuse pins, a baud rate the clock cannot make, a clock the edge is not timed for, or a UART the off-chip memories could lose bytes on. These are the wiring’s own rules, which hold in simulation with ideal pins; WpeCaravel::check_harness adds the rule the chip’s harness imposes.

pub fn check_harness( &self, memory: &OffchipMemory, ) -> Result<(), WpeCaravelUnplaceable>

WpeCaravel::check, and a read window the round trip through Caravel’s harness and the board fits: the configuration a chip can be built with.

Trait Implementations

impl Clone for WpeCaravel

fn clone(&self) -> WpeCaravel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WpeCaravel

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

Formats the value using the given formatter.

impl PartialEq for WpeCaravel

fn eq(&self, other: &WpeCaravel) -> 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 WpeCaravel

impl Eq for WpeCaravel

impl StructuralPartialEq for WpeCaravel