Skip to main content

HardwareConfigFaultConfig

Struct HardwareConfigFaultConfig 

Source
pub struct HardwareConfigFaultConfig {
    pub vendor_id: Option<u16>,
    pub device_id: Option<u16>,
}
Expand description

A fault configuration for overriding the device’s hardware configuration (i.e. the values reported in PCI configuration space).

When a field is Some, its value replaces the corresponding field reported by the NVMe fault controller’s PCI hardware IDs. When None, the real hardware ID value is used unchanged. Unlike most other faults in this module, hardware config faults are applied at device construction time and are therefore not gated by the fault_active flag.

§Example

Override the Vendor ID and Device ID reported in PCI config space.

use mesh::CellUpdater;
use nvme_resources::fault::FaultConfiguration;
use nvme_resources::fault::HardwareConfigFaultConfig;

pub fn hardware_config_fault() -> FaultConfiguration {
    let mut fault_start_updater = CellUpdater::new(false);
    FaultConfiguration::new(fault_start_updater.cell())
        .with_hardware_config_fault(
            HardwareConfigFaultConfig::new()
                .with_vendor_id(0x1414)
                .with_device_id(0xc03e),
        )
}

Fields§

§vendor_id: Option<u16>

Override for the device’s PCI Vendor ID. When None, the real Vendor ID is used.

§device_id: Option<u16>

Override for the device’s PCI Device ID. When None, the real Device ID is used.

Implementations§

Source§

impl HardwareConfigFaultConfig

Source

pub fn new() -> Self

Create a new no-op hardware config fault configuration. All fields default to None, meaning the real hardware values are used.

Source

pub fn with_vendor_id(self, vendor_id: u16) -> Self

Override the PCI Vendor ID reported by the device.

Source

pub fn with_device_id(self, device_id: u16) -> Self

Override the PCI Device ID reported by the device.

Trait Implementations§

Source§

impl Clone for HardwareConfigFaultConfig

Source§

fn clone(&self) -> HardwareConfigFaultConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HardwareConfigFaultConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for HardwareConfigFaultConfig

Source§

fn default() -> HardwareConfigFaultConfig

Returns the “default value” for a type. Read more
Source§

impl DefaultEncoding for HardwareConfigFaultConfig

Source§

type Encoding = TableEncoder

The encoding to use for the serialization. Read more
Source§

impl<'encoding> StructDecodeMetadata<'encoding, Resource> for HardwareConfigFaultConfig

Source§

const DECODERS: &'static [ErasedDecoderEntry]

The list of decoder vtables.
Source§

impl StructEncodeMetadata<Resource> for HardwareConfigFaultConfig

Source§

const ENCODERS: &'static [ErasedEncoderEntry]

The list of encoder vtables.
Source§

impl StructMetadata for HardwareConfigFaultConfig

Source§

const NUMBERS: &'static [u32]

The field numbers for each field.
Source§

const OFFSETS: &'static [usize]

The byte offset to each field within the struct.
Source§

impl Copy for HardwareConfigFaultConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> MeshField for T
where T: DefaultEncoding, <T as DefaultEncoding>::Encoding: FieldEncode<T, Resource> + for<'a> FieldDecode<'a, T, Resource> + Send + Sync,

§

type Encoding = <T as DefaultEncoding>::Encoding

§

impl<T> MeshPayload for T
where T: DefaultEncoding + Any + Send + 'static, <T as DefaultEncoding>::Encoding: MessageEncode<T, Resource> + for<'a> MessageDecode<'a, T, Resource> + FieldEncode<T, Resource> + for<'a> FieldDecode<'a, T, Resource> + Send + Sync,

§

type Encoding = <T as DefaultEncoding>::Encoding

§

impl<T> SerializeMessage for T
where T: 'static + MeshPayload + Send,

§

type Concrete = T

The underlying concrete message type.
§

fn compute_message_size(&mut self, sizer: MessageSizer<'_>)

Computes the message size, as in [MessageEncode::compute_message_size].
§

fn write_message(self, writer: MessageWriter<'_, '_, Resource>)

Writes the message, as in [MessageEncode::write_message].
§

fn extract(self) -> <T as SerializeMessage>::Concrete

Extract the concrete message.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more