Struct simics_api_sys::bindings::register_view_interface

#[repr(C)]
pub struct register_view_interface {
    pub description: Option<unsafe extern "C" fn(obj: *mut conf_object_t) -> *const c_char>,
    pub big_endian_bitorder: Option<unsafe extern "C" fn(obj: *mut conf_object_t) -> bool>,
    pub number_of_registers: Option<unsafe extern "C" fn(obj: *mut conf_object_t) -> c_uint>,
    pub register_info: Option<unsafe extern "C" fn(obj: *mut conf_object_t, reg: c_uint) -> attr_value_t>,
    pub get_register_value: Option<unsafe extern "C" fn(obj: *mut conf_object_t, reg: c_uint) -> uint64>,
    pub set_register_value: Option<unsafe extern "C" fn(obj: *mut conf_object_t, reg: c_uint, val: uint64)>,
}

Fields

description: Option<unsafe extern "C" fn(obj: *mut conf_object_t) -> *const c_char>

big_endian_bitorder: Option<unsafe extern "C" fn(obj: *mut conf_object_t) -> bool>

number_of_registers: Option<unsafe extern "C" fn(obj: *mut conf_object_t) -> c_uint>

register_info: Option<unsafe extern "C" fn(obj: *mut conf_object_t, reg: c_uint) -> attr_value_t>

Returns the static information about a register in the list [NAME, DESC, SIZE, OFFSET, BITFIELDS, BIG_ENDIAN_BYTE_ORDER]. All but the two last element in the list are required and the client should tolerate if more than 6 elements are presented in the list. NAME must be a valid identifier. DESC is a short description of the register. SIZE is the number of bytes of the register, could only be 1, 2, 4, or 8. OFFSET is the offset into the bank and can be Nil denoting non-memory-mapped registers. BITFIELDS is optional and if present, is a list where each element itself being a list of [NAME, DESC, LSB, MSB] where NAME and DESC is the identifier and description of the field and LSB and MSB are the least significant and the most significant bit in little-endian bitorder. MSB is optional and if omitted, is assumed to be the same as LSB, i.e., the bitfield specifies a single bit. BIG_ENDIAN_BYTE_ORDER is an optional boolean value, assumed to be False if omitted. It controls the byte order of the register’s memory-mapped representation; the byte at OFFSET is the most significant byte if BIG_ENDIAN_BYTE_ORDER is True, and the least significant byte otherwise.

get_register_value: Option<unsafe extern "C" fn(obj: *mut conf_object_t, reg: c_uint) -> uint64>

Get the current value of a register, must be side-effect free.

set_register_value: Option<unsafe extern "C" fn(obj: *mut conf_object_t, reg: c_uint, val: uint64)>

Set the current value of a register, must be side-effect free except from updating the value.

Trait Implementations

impl Clone for register_view_interface

fn clone(&self) -> register_view_interface

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for register_view_interface

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

Formats the value using the given formatter.

impl Default for register_view_interface

fn default() -> register_view_interface

Returns the “default value” for a type.

impl Hash for register_view_interface

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 register_view_interface

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

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

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

impl Eq for register_view_interface

impl StructuralPartialEq for register_view_interface