Struct Chip

pub struct Chip {
    pub inner: Box<dyn ChipImpl>,
}

A wrapper around a chip that implements ChipImpl. This allows us to create and use chips without knowing their type, but we can still downcast to the concrete type if we need to.

Fields

inner: Box<dyn ChipImpl>

Implementations

impl Chip

pub fn gs_open<T: Clone + Send + Sync + 'static>( arch: Arch, backend: CallbackStorage<T>, ) -> Result<Grayskull, PlatformError>

pub fn wh_open<T: Clone + Send + Sync + 'static>( arch: Arch, backend: CallbackStorage<T>, ) -> Result<Wormhole, PlatformError>

pub fn open<T: Clone + Send + Sync + 'static>( arch: Arch, backend: CallbackStorage<T>, ) -> Result<Chip, PlatformError>

impl Chip

pub fn as_wh(&self) -> Option<&Wormhole>

Downcast to a wormhole chip

pub fn as_gs(&self) -> Option<&Grayskull>

Downcast to a grayskull chip

Trait Implementations

impl ChipImpl for Chip

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 From<Box<dyn ChipImpl>> for Chip

fn from(inner: Box<dyn ChipImpl>) -> Self

Converts to this type from the input type.

impl HlComms for Chip

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>>