Struct ShellControl 

pub struct ShellControl {

    pub run_state: RunState,
    pub config: LaunchConfig,
    pub ap_done: bool,
    pub gier: bool,
    pub ier: b2,
    pub isr: b2,
    pub terminal_code: b8,
    pub error_flags: b16,
    pub first_error_job: b32,
    pub first_error_detail: b32,
    pub summary_aw_handshake: bool,
    pub summary_w_handshake: bool,
    pub summary_b_handshake: bool,
    pub summary_b_canonical: bool,
    pub axil_aw_pending: bool,
    pub axil_awaddr: b8,
    pub axil_aw_locked_at_accept: bool,
    pub axil_w_pending: bool,
    pub axil_wdata: b32,
    pub axil_wstrb: b4,
    pub axil_w_locked_at_accept: bool,
    pub axil_bvalid: bool,
    pub axil_bresp: b2,
    pub axil_rvalid: bool,
    pub axil_rdata: b32,
    pub axil_rresp: b2,
    pub axil_r_ap_ctrl: bool,
    pub reader_state: ReaderState,
    pub reader_job: b32,
    pub input_job_valid: bool,
    pub scoreboard: [JobEntry; 12],
    pub ingress_valid: bool,
    pub capture_active: bool,
    pub capture_slot: b1,
    pub capture_beat: b6,
    pub capture_job: b32,
    pub capture_cluster: b2,
    pub frame_queue: FrameQueue,
    pub writer_state: WriterState,
    pub writer_slot: b1,
    pub writer_job: b32,
    pub writer_beat: b6,
    pub read_issue_beat: b6,
    pub read_pending: bool,
    pub prefetch_count: b2,
    pub writer_early_b_drained: bool,
    pub abort_cleaned: bool,
    pub input_ar_count: b16,
    pub input_r_count: b16,
    pub core_admission_count: b16,
    pub frame_capture_count: b16,
    pub core_error_count: b16,
    pub payload_aw_count: b16,
    pub payload_b_count: b16,
    pub payload_w_count: b32,
    pub memory_completed_count: b16,
    pub memory_completion_timing: MemoryCompletionTiming,
    pub run_cycle: b64,
    pub payload_cycles: b64,
    pub output_stall_cycles: b64,
    pub first_admission_seen: bool,
    pub first_admission_cycle: b64,
    pub first_capture_seen: bool,
    pub first_capture_cycle: b64,
    pub core_latency_cycles: b64,
    pub capture_span_cycles: b64,
}

Resettable shell ownership and audit state.

Fields

run_state: RunState

Whole-run state.

config: LaunchConfig

Host launch arguments.

ap_done: bool

HLS-compatible sticky completion bit.

gier: bool

Global interrupt enable.

ier: b2

Done/error interrupt mask.

isr: b2

Toggle-on-write sticky done/error status.

terminal_code: b8

Most recent terminal code.

error_flags: b16

Sticky union of run error causes.

first_error_job: b32

First job associated with an error.

first_error_detail: b32

First error detail.

summary_aw_handshake: bool

Terminal summary address was accepted.

summary_w_handshake: bool

Terminal summary data was accepted.

summary_b_handshake: bool

Terminal summary response was drained.

summary_b_canonical: bool

Terminal summary response was exact ID-zero OKAY.

axil_aw_pending: bool

Independently retained AXI4-Lite write address.

axil_awaddr: b8

Retained AXI4-Lite write address.

axil_aw_locked_at_accept: bool

Configuration/run lock state sampled when the write address transferred.

axil_w_pending: bool

Independently retained AXI4-Lite write data.

axil_wdata: b32

Retained AXI4-Lite write data.

axil_wstrb: b4

Retained AXI4-Lite byte strobes.

axil_w_locked_at_accept: bool

Configuration/run lock state sampled when the write data transferred.

axil_bvalid: bool

Retained AXI4-Lite write response.

axil_bresp: b2

Retained AXI4-Lite write response code.

axil_rvalid: bool

Retained AXI4-Lite read response.

axil_rdata: b32

Retained AXI4-Lite read data.

axil_rresp: b2

Retained AXI4-Lite read response code.

axil_r_ap_ctrl: bool

The retained read response came from AP_CTRL.

reader_state: ReaderState

HBM0 single-outstanding state.

reader_job: b32

Sequential job currently owned by the reader.

input_job_valid: bool

A checked HBM0 line is retained.

scoreboard: [JobEntry; 12]

Signer ownership table.

ingress_valid: bool

One registered signer beat is retained before validation.

capture_active: bool

A frame currently owns one BRAM slot.

capture_slot: b1

BRAM slot owned by capture.

capture_beat: b6

Next capture beat in 0..=34.

capture_job: b32

Frame job identity retained from beat zero.

capture_cluster: b2

Frame source cluster retained from beat zero.

frame_queue: FrameQueue

Oldest-first queue of complete BRAM frames.

writer_state: WriterState

HBM1 payload writer state.

writer_slot: b1

Committed writer slot.

writer_job: b32

Committed writer job.

writer_beat: b6

Next data beat to transfer.

read_issue_beat: b6

Next BRAM beat to request.

read_pending: bool

The current BRAM output belongs to the writer prefetch.

prefetch_count: b2

Registered write-prefetch occupancy in 0..=2.

writer_early_b_drained: bool

A protocol-invalid payload B was drained before final W acceptance.

abort_cleaned: bool

Abort-mode uncommitted-state cleanup has occurred.

input_ar_count: b16

Accepted HBM0 addresses.

input_r_count: b16

Checked HBM0 responses.

core_admission_count: b16

Signer admissions.

frame_capture_count: b16

Complete canonical frames captured.

core_error_count: b16

Explicit signer error completions.

payload_aw_count: b16

Accepted payload write addresses.

payload_b_count: b16

Drained payload write responses.

payload_w_count: b32

Accepted payload data beats.

memory_completed_count: b16

Payloads retired by exact ID-zero OKAY B responses.

memory_completion_timing: MemoryCompletionTiming

Canonical payload B retirement timing, excluding the summary response.

run_cycle: b64

Execute/abort cycle cursor.

payload_cycles: b64

Execute/abort payload interval.

output_stall_cycles: b64

Cycles the signer output was unable to enter the ingress register.

first_admission_seen: bool

At least one signer admission has occurred.

first_admission_cycle: b64

Cycle of first signer admission.

first_capture_seen: bool

At least one complete frame has reached BRAM.

first_capture_cycle: b64

Cycle of first complete frame capture.

core_latency_cycles: b64

First admission through last complete frame, inclusive.

capture_span_cycles: b64

First-to-last complete-frame span.

Trait Implementations

impl Clone for ShellControl

fn clone(&self) -> ShellControl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShellControl

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

Formats the value using the given formatter.

impl Default for ShellControl

fn default() -> Self

Returns the “default value” for a type.

impl Digital for ShellControl

const BITS: usize

Associated constant that gives the total number of bits needed to represent the value.

fn static_kind() -> Kind

Returns the [Kind] (run time type descriptor) of the value as a static method

fn bin(self) -> Box<[BitX]>

Returns the binary representation of the value as a vector of [BitX].

fn dont_care() -> Self

Returns a “don’t care” value for the type.

fn bits() -> usize

Returns the number of bits needed to represent the value.

fn kind(&self) -> Kind

Returns the [Kind] (run time type descriptor) of the value.

fn typed_bits(self) -> TypedBits

Returns the value as a [TypedBits], which includes both the bits and the kind.

fn discriminant(self) -> TypedBits

Returns the discriminant of the value as a [TypedBits].

fn variant_kind(self) -> Kind

Returns the [Kind] of the variant if the value is an enum with variants.

fn binary_string(self) -> String

Returns the binary representation of the value as a string of ‘0’, ‘1’, and ‘X’.

impl PartialEq for ShellControl

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

impl Eq for ShellControl

impl StructuralPartialEq for ShellControl