Struct simics_api_sys::description_t

#[repr(C)]
pub struct description_t {

    pub type_: description_type_t,
    pub name: *const c_char,
    pub description: *const c_char,
    pub dwarf_id: int16,
    pub bitorder: reg_bitorder_t,
    pub role: reg_role_t,
    pub memory_mapped: bool,
    pub offset: uint64,
    pub catchable: bool,
    pub msb: c_int,
    pub lsb: c_int,
    pub regsize: c_int,
    pub reg_id: c_int,
}

description_t

Fields

type_: description_type_t

Common fields

name: *const c_char

description: *const c_char

dwarf_id: int16

id used by dwarf for this register or -1 if no such id is defined. This is ABI specific, but the CPU will give the ids for the most common ABI for that architecture.

bitorder: reg_bitorder_t

Bitorder convention used in the documentation for this register or field.

role: reg_role_t

Role of this register in the ABI/HW.

memory_mapped: bool

True if the register is memory mapped.

offset: uint64

Offset into the bank for memory mapped registers.

catchable: bool

True if Core_Control_Register_Write and Core_Control_Register_Read are triggered when this register is written or read.

msb: c_int

Most and least significant bit of the register or field. Always given in le bitorder. For groups msb == -1 and lsb == 0.

lsb: c_int

Most and least significant bit of the register or field. Always given in le bitorder. For groups msb == -1 and lsb == 0.

regsize: c_int

Number of bits in the register, or the register this field is a part of.

reg_id: c_int

For registers and fields the id to pass to the get and set methods to access the register’s value. Fields have the same reg_id as the register they are a part of. Not valid for groups.

Trait Implementations

impl Clone for description_t

fn clone(&self) -> description_t

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for description_t

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

Formats the value using the given formatter.

impl Default for description_t

fn default() -> Self

Returns the “default value” for a type.

impl Hash for description_t

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for description_t

fn cmp(&self, other: &description_t) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for description_t

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

fn partial_cmp(&self, other: &description_t) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for description_t

impl Eq for description_t

impl StructuralPartialEq for description_t