Struct Bist

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

Built-In Self Test (BIST) register.

Implementations

impl Bist

pub const COMPLETION_CODE: Pack8<u8, Bist>

The completion code set by running a built-in self test.

If the test completed successfully, this should be 0.

pub const START_BIST: Pack8<bool, Bist>

Start BIST

Set to 1 by the OS to start a BIST. This bit is reset when BIST completes. If BIST does not complete after 2 seconds the device should be failed by system software.

pub const BIST_CAPABLE: Pack8<bool, Bist>

BIST Capable

If this is 1, the device supports BIST. If it is 0, this device does not support a built-in self test.

pub const fn from_bits(bits: u8) -> Bist

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

pub const fn new() -> Bist

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

pub const fn bits(self) -> u8

Returns the raw bit representatiion of self as an integer.

pub fn with<T>(self, field: Pack8<T, Bist>, value: T) -> Bist

where T: FromBits<u8>,

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

where T: FromBits<u8>,

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

pub fn get<T>(self, field: Pack8<T, Bist>) -> T

where T: FromBits<u8>,

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: Pack8<T, Bist>, ) -> Result<T, <T as FromBits<u8>>::Error>

where T: FromBits<u8>,

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 Bist

pub fn completion_code(self) -> Option<u8>

Returns the device’s BIST completion code, if a BIST has completed.

If the BIST is still in progress, this method returns None.

Trait Implementations

impl Binary for Bist

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

Formats the value using the given formatter.

impl Clone for Bist

fn clone(&self) -> Bist

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bist

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

Formats the value using the given formatter.

impl Display for Bist

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

Formats the value using the given formatter.

impl From<u8> for Bist

fn from(val: u8) -> Bist

Converts to this type from the input type.

impl LowerHex for Bist

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

Formats the value using the given formatter.

impl PartialEq for Bist

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

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

Formats the value using the given formatter.

impl Copy for Bist

impl Eq for Bist

impl StructuralPartialEq for Bist