Struct mycelium_kernel::drivers::pci::register::Status

pub struct Status(/* private fields */);

A PCI device’s Status register.

See https://wiki.osdev.org/Pci#Status_Register

Implementations

impl Status

pub const INTERRUPT_STATUS: Pack16<bool, Status> = _

Interrupt Status.

Represents the state of the device’s INTx# signal. If set to 1 and bit 10 of the Command register ([INTERRUPT_DISABLE]) is set to 0, the signal will be asserted; otherwise, the signal will be ignored.

pub const CAPABILITIES_LIST: Pack16<bool, Status> = _

Capabilities List

If set to 1, the device implements the pointer for a New Capabilities linked list at offset 0x34; otherwise, the linked list is not available.

pub const IS_66MHZ_CAPABLE: Pack16<bool, Status> = _

66 MHz Capable

If set to 1 the device is capable of running at 66 MHz; otherwise, the device runs at 33 MHz.

pub const FAST_BACK_TO_BACK_CAPABLE: Pack16<bool, Status> = _

Fast Back-To-Back Capable

If set to 1 the device can accept fast back-to-back transactions that are not from the same agent; otherwise, transactions can only be accepted from the same agent.

pub const MASTER_DATA_PARITY_ERROR: Pack16<bool, Status> = _

Master Data Parity Error

This bit is only set when the following conditions are met. The bus agent asserted PERR# on a read or observed an assertion of PERR# on a write, the agent setting the bit acted as the bus master for the operation in which the error occurred, and bit 6 of the Command register (PARITY_ERROR_RESPONSE bit) is set to 1.

pub const DEVSEL_TIMING: Pack16<DevselTiming, Status> = _

DEVSEL# Timing

Read-only bits that represent the slowest time that a device will assert DEVSEL# for any bus command except Configuration Space read and writes. A value of 0x0 represents fast timing, a value of 0x1 represents medium timing, and a value of 0x2 represents slow timing.

pub const SIGNALLED_TARGET_ABORT: Pack16<bool, Status> = _

Signalled Target Abort

This bit will be set to 1 whenever a target device terminates a transaction with Target-Abort.

pub const RECEIVED_TARGET_ABORT: Pack16<bool, Status> = _

Received Target Abort

This bit will be set to 1, by a master device, whenever its transaction is terminated with Target-Abort.

pub const RECEIVED_MASTER_ABORT: Pack16<bool, Status> = _

Received Master Abort

This bit will be set to 1, by a master device, whenever its transaction (except for Special Cycle transactions) is terminated with Master-Abort.

pub const SIGNALLED_SYSTEM_ERROR: Pack16<bool, Status> = _

Signalled System Error

This bit will be set to 1 whenever the device asserts SERR#.

pub const DETECTED_PARITY_ERROR: Pack16<bool, Status> = _

Detected Parity Error

This bit will be set to 1 whenever the device detects a parity error, even if parity error handling is disabled.

pub const fn from_bits(bits: u16) -> Status

Constructs a new instance of Self from the provided raw bits.

pub const fn new() -> Status

Constructs a new instance of Self with all bits set to 0.

pub const fn bits(self) -> u16

Returns the raw bit representatiion of self as an integer.

pub fn with<T>(self, field: Pack16<T, Status>, value: T) -> Status

where T: FromBits<u16>,

Packs the bit representation of value into self at the bit range designated by field, returning a new bitfield.

pub fn set<T>(&mut self, field: Pack16<T, Status>, value: T) -> &mut Status

where T: FromBits<u16>,

Packs the bit representation of value into self at the range designated by field, mutating self in place.

pub fn get<T>(self, field: Pack16<T, Status>) -> T

where T: FromBits<u16>,

Unpacks the bit range represented by field from self, and converts it into a T-typed value.

Panics

This method panics if self does not contain a valid bit pattern for a T-typed value, as determined by T’s FromBits::try_from_bits implementation.

pub fn try_get<T>( self, field: Pack16<T, Status> ) -> Result<T, <T as FromBits<u16>>::Error>

where T: FromBits<u16>,

Unpacks the bit range represented by field from self and attempts to convert it into a T-typed value.

Returns

• Ok(T) if a T-typed value could be constructed from the bits in src
• Err(T::Error) if src does not contain a valid bit pattern for a T-typed value, as determined by T’s [FromBits::try_from_bits implementation.

pub fn assert_valid()

Asserts that all the packing specs for this type are valid.

This is intended to be used in unit tests.

pub fn display_ascii(&self) -> impl Display

Returns a value that formats this bitfield in a multi-line format, using only ASCII characters.

This is equivalent to formatting this bitfield using a {} display specifier, but will never use Unicode box-drawing characters, even when an upstream formatter uses the {:#} fmt::Display specifier. This is intended for use on platforms where Unicode box drawing characters are never available.

pub fn display_unicode(&self) -> impl Display

Returns a value that formats this bitfield in a multi-line format, always using Unicode box-drawing characters.

This is equivalent to formatting this bitfield using a {:#} format specifier, but will always use Unicode box-drawing characters, even when an upstream formatter uses the {} fmt::Display specifier.

impl Status

pub fn received_abort(self) -> bool

Returns true if this device received an abort (either a Master Abort or Target Abort).

This returns true if the Status::RECEIVED_MASTER_ABORT or Status::RECEIVED_TARGET_ABORT bits are set.

Trait Implementations

impl Binary for Status

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

Formats the value using the given formatter.

impl Clone for Status

fn clone(&self) -> Status

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Status

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

Formats the value using the given formatter.

impl Display for Status

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

Formats the value using the given formatter.

impl From<u16> for Status

fn from(val: u16) -> Status

Converts to this type from the input type.

impl FromBits<u32> for Status

const BITS: u32 = 16u32

The number of bits required to represent a value of this type.

type Error = Infallible

The error type returned by Self::try_from_bits when an invalid bit pattern is encountered.

fn try_from_bits(bits: u32) -> Result<Status, <Status as FromBits<u32>>::Error>

Attempt to convert bits into a value of this type.

fn into_bits(self) -> u32

Convert self into a raw bit representation.

impl LowerHex for Status

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

Formats the value using the given formatter.

impl PartialEq for Status

fn eq(&self, other: &Status) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl UpperHex for Status

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

Formats the value using the given formatter.

impl Copy for Status

impl Eq for Status

impl StructuralEq for Status

impl StructuralPartialEq for Status