Struct Wormhole

pub struct Wormhole {
    pub chip_if: Arc<dyn ChipInterface + Send + Sync>,
    pub arc_if: Arc<dyn ChipComms + Send + Sync>,
    pub is_remote: bool,
    pub use_arc_for_spi: bool,
    pub arc_addrs: ArcMsgAddr,
    pub eth_locations: [EthCore; 16],
    pub eth_addrs: EthAddresses,
    /* private fields */
}

Implementation of the interface for a Wormhole both the local and remote Wormhole chips are represented by this struct

Fields

chip_if: Arc<dyn ChipInterface + Send + Sync>

arc_if: Arc<dyn ChipComms + Send + Sync>

is_remote: bool

use_arc_for_spi: bool

arc_addrs: ArcMsgAddr

eth_locations: [EthCore; 16]

eth_addrs: EthAddresses

Implementations

impl Wormhole

pub fn get_local_chip_coord(&self) -> Result<EthAddr, PlatformError>

impl Wormhole

pub fn init_eth_addrs(&mut self) -> Result<(), PlatformError>

pub fn get_if<T: ChipInterface>(&self) -> Option<&T>

pub fn open_remote( &self, addr: impl IntoChip<EthAddr>, ) -> Result<Wormhole, PlatformError>

pub fn spi_write(&self, addr: u32, value: &[u8]) -> Result<(), Box<dyn Error>>

pub fn spi_read( &self, addr: u32, value: &mut [u8], ) -> Result<(), Box<dyn Error>>

Trait Implementations

impl ChipImpl for Wormhole

fn update_init_state( &mut self, status: &mut InitStatus, ) -> Result<ChipInitResult, PlatformError>

Update the initialization state of the chip. The primary purpose of this function is to tell the caller when it is safe to starting interacting with the chip.

fn get_arch(&self) -> Arch

Returns the current arch of the chip, can be used to avoid needing to ducktype when downcasting.

fn arc_msg(&self, msg: ArcMsgOptions) -> Result<ArcMsgOk, PlatformError>

Send an arc_msg to the underlying chip.

fn get_neighbouring_chips(&self) -> Result<Vec<NeighbouringChip>, PlatformError>

Get a list of neighbouring chips. Will return an empty list for gs and up to four chips for wh.

fn as_any(&self) -> &dyn Any

Convinence function to downcast to a concrete type.

fn get_telemetry(&self) -> Result<Telemetry, PlatformError>

Get telemetry information from the chip. The information is not cached, so should not be called repeatedly.

fn get_device_info(&self) -> Result<Option<DeviceInfo>, PlatformError>

Get information about the underlying chip transport. This is a hack to get the physical id of the chip.

impl Clone for Wormhole

fn clone(&self) -> Wormhole

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl HlComms for &Wormhole

fn comms_obj(&self) -> (&dyn ChipComms, &dyn ChipInterface)

fn noc_read( &self, noc_id: u8, x: u8, y: u8, addr: u64, data: &mut [u8], ) -> Result<(), Box<dyn Error>>

fn noc_write( &self, noc_id: u8, x: u8, y: u8, addr: u64, data: &[u8], ) -> Result<(), Box<dyn Error>>

fn noc_broadcast( &self, noc_id: u8, addr: u64, data: &[u8], ) -> Result<(), Box<dyn Error>>

fn noc_read32( &self, noc_id: u8, x: u8, y: u8, addr: u64, ) -> Result<u32, Box<dyn Error>>

fn noc_write32( &self, noc_id: u8, x: u8, y: u8, addr: u64, value: u32, ) -> Result<(), Box<dyn Error>>

fn noc_broadcast32( &self, noc_id: u8, addr: u64, value: u32, ) -> Result<(), Box<dyn Error>>

fn axi_read(&self, addr: u64, data: &mut [u8]) -> Result<(), Box<dyn Error>>

fn axi_write(&self, addr: u64, data: &[u8]) -> Result<(), Box<dyn Error>>

fn axi_read32(&self, addr: u64) -> Result<u32, Box<dyn Error>>

fn axi_write32(&self, addr: u64, value: u32) -> Result<(), Box<dyn Error>>

impl HlComms for Wormhole

fn comms_obj(&self) -> (&dyn ChipComms, &dyn ChipInterface)

fn noc_read( &self, noc_id: u8, x: u8, y: u8, addr: u64, data: &mut [u8], ) -> Result<(), Box<dyn Error>>

fn noc_write( &self, noc_id: u8, x: u8, y: u8, addr: u64, data: &[u8], ) -> Result<(), Box<dyn Error>>

fn noc_broadcast( &self, noc_id: u8, addr: u64, data: &[u8], ) -> Result<(), Box<dyn Error>>

fn noc_read32( &self, noc_id: u8, x: u8, y: u8, addr: u64, ) -> Result<u32, Box<dyn Error>>

fn noc_write32( &self, noc_id: u8, x: u8, y: u8, addr: u64, value: u32, ) -> Result<(), Box<dyn Error>>

fn noc_broadcast32( &self, noc_id: u8, addr: u64, value: u32, ) -> Result<(), Box<dyn Error>>

fn axi_read(&self, addr: u64, data: &mut [u8]) -> Result<(), Box<dyn Error>>

fn axi_write(&self, addr: u64, data: &[u8]) -> Result<(), Box<dyn Error>>

fn axi_read32(&self, addr: u64) -> Result<u32, Box<dyn Error>>

fn axi_write32(&self, addr: u64, value: u32) -> Result<(), Box<dyn Error>>