Struct mycelium_kernel::drivers::pci::register::Command

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

A PCI device’s Command register.

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

Implementations

impl Command

pub const IO_SPACE_ENABLED: Pack16<bool, Command> = _

I/O Space Enabled

If set to 1 the device can respond to I/O Space accesses; otherwise, the device’s response is disabled.

pub const MEMORY_SPACE_ENABLED: Pack16<bool, Command> = _

Memory Space Enabled

If set to 1 the device can respond to Memory Space accesses; otherwise, the device’s response is disabled.

pub const BUS_MASTER: Pack16<bool, Command> = _

Bus Master

If set to 1, the device can behave as a bus master; otherwise, the device can not generate PCI accesses.

pub const SPECIAL_CYCLE_ENABLE: Pack16<bool, Command> = _

Special Cycle Enabled

If set to 1 the device can monitor Special Cycle operations; otherwise, the device will ignore them.

pub const MEMORY_WRITE_AND_INVALIDATE_ENABLED: Pack16<bool, Command> = _

Memory Write and Invalidate Enabled

If set to 1 the device can generate the Memory Write and Invalidate command; otherwise, the Memory Write command must be used.

pub const VGA_PALETTE_SNOOP: Pack16<bool, Command> = _

VGA Palette Snoop

If set to 1 the device does not respond to palette register writes and will snoop the data; otherwise, the device will treat palette write accesses like all other accesses.

pub const PARITY_ERROR_RESPONSE_ENABLED: Pack16<bool, Command> = _

Parity Error Response enabled

If set to 1 the device will take its normal action when a parity error is detected; otherwise, when an error is detected, the device will set bit 15 of the Status register (DETECTED_PARITY_ERROR), but will not assert the PERR# (Parity Error) pin and will continue operation as normal.

pub const SERR_ENABLED: Pack16<bool, Command> = _

SERR# Enabled

If set to 1 the SERR# driver is enabled; otherwise, the driver is disabled.

pub const FAST_BACK_TO_BACK_ENABLED: Pack16<bool, Command> = _

Fast Back-To-Back Enabled

If set to 1, indicates a device is allowed to generate fast back-to-back transactions; otherwise, fast back-to-back transactions are only allowed to the same agent.

pub const INTERRUPT_DISABLE: Pack16<bool, Command> = _

Interrupt Disable

If set to 1, the assertion of the devices INTx# signal is disabled; otherwise, assertion of the signal is enabled.

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

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

pub const fn new() -> Command

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, Command>, value: T) -> Command

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, Command>, value: T) -> &mut Command

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, Command>) -> 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, Command> ) -> 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.

Trait Implementations

impl Binary for Command

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

Formats the value using the given formatter.

impl Clone for Command

fn clone(&self) -> Command

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl Display for Command

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

Formats the value using the given formatter.

impl From<u16> for Command

fn from(val: u16) -> Command

Converts to this type from the input type.

impl FromBits<u32> for Command

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

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

Formats the value using the given formatter.

impl PartialEq for Command

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

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

Formats the value using the given formatter.

impl Copy for Command

impl Eq for Command

impl StructuralEq for Command

impl StructuralPartialEq for Command