Struct DeviceImplInfo

pub struct DeviceImplInfo {

    pub device_features: Option<u32>,
    pub tx_depth: Option<u16>,
    pub rx_depth: Option<u16>,
    pub rx_threshold: Option<u16>,
    pub max_buffer_parts: Option<u8>,
    pub max_buffer_length: Option<u32>,
    pub buffer_alignment: Option<u32>,
    pub min_rx_buffer_length: Option<u32>,
    pub min_tx_buffer_length: Option<u32>,
    pub tx_head_length: Option<u16>,
    pub tx_tail_length: Option<u16>,
    pub rx_accel: Option<Vec<RxAcceleration>>,
    pub tx_accel: Option<Vec<TxAcceleration>>,
    /* private fields */
}

Static device information. DeviceImplInfo must not change for the entire lifetime of a device.

Fields

device_features: Option<u32>

Device features Required.

tx_depth: Option<u16>

Maximum depth of tx frames in device’s outgoing queue. Required.

rx_depth: Option<u16>

Maximum number of rx frames in a device’s incoming queue. Required.

rx_threshold: Option<u16>

Rx depth threshold at which the device should be fed new rx buffers.

New buffer notifications from [NetworkDeviceIfc] may be skipped while the number of rx buffers held by the implementation is larger than rx_threshold. It is invalid to provide a value larger than rx_depth. rx_threshold = rx_depth is functionally equivalent to rx_threshold = rx_depth - 1.

A large value (close to rx_depth) may cause considerable CPU thrash for small rx completion transaction sizes, while a small value may cause the implementation to be starved of buffers. The typical choice of value is rx_depth / 2. Required.

max_buffer_parts: Option<u8>

Maximum virtual discontiguous buffer parts accepted by the device.

Devices that can’t perform scatter-gather operations must set max_buffer_parts to 1.

Must be in the range [1, MAX_BUFFER_PARTS]. Required.

max_buffer_length: Option<u32>

Maximum total length of buffers. May be set to zero for no maximum.

Devices that do not support scatter-gather DMA may set this to a value smaller than a page size to guarantee compatibility. Required.

buffer_alignment: Option<u32>

Alignment requirement for buffers relative to the start of VMOs.

Must be greater than zero. Required.

min_rx_buffer_length: Option<u32>

The minimum rx buffer length for correct operation, in bytes. Required.

min_tx_buffer_length: Option<u32>

The minimum tx buffer length for correct operation, in bytes.

This length accounts only for the buffer’s body, and should not account for tx_head_length or tx_tail_length. Required.

tx_head_length: Option<u16>

Number of bytes requested as header bytes on tx buffers.

If set to zero, tx buffers will never contain header space. Otherwise, tx buffers will start at the beginning of the header space, and the header region will be informed. Required.

tx_tail_length: Option<u16>

Number of bytes requested as tail bytes on tx buffers.

If set to zero, tx buffers will never contain tail space. Otherwise, tx buffers will end at the end of the tail space, and the tail region will be informed. Required.

rx_accel: Option<Vec<RxAcceleration>>

Available Rx acceleration flags for this device, as defined in [fuchsia.hardware.network/RxAcceleration].

rx_accel maps the RX_ACCEL_* flags in the frame descriptors with semantic acceleration features described by RxAcceleration. Position n of rx_accel conveys the meaning of the RX_ACCEL_n flag. Required.

tx_accel: Option<Vec<TxAcceleration>>

Available tx acceleration flags for this device, as defined in [fuchsia.hardware.network/TxAcceleration].

tx_accel maps the TX_ACCEL_* flags in the frame descriptors with semantic acceleration features described by TxAcceleration. Position n of tx_accel conveys the meaning of the TX_ACCEL_n flag. Required.

Trait Implementations

impl Clone for DeviceImplInfo

fn clone(&self) -> DeviceImplInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceImplInfo

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<DeviceImplInfo, D> for DeviceImplInfo

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for DeviceImplInfo

fn default() -> DeviceImplInfo

Returns the “default value” for a type.

impl<D: ResourceDialect> Encode<DeviceImplInfo, D> for &DeviceImplInfo

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl PartialEq for DeviceImplInfo

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

type Owned = DeviceImplInfo

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for DeviceImplInfo

type Borrowed<'a> = &'a DeviceImplInfo

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow(value: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Persistable for DeviceImplInfo

impl StructuralPartialEq for DeviceImplInfo