Struct EndpointConfig 

#[non_exhaustive]
pub struct EndpointConfig {
    pub addr: Option<EndpointAddress>,
    pub ep_type: EndpointType,
    pub max_packet_size: u16,
    pub interval_ms: u8,
    pub buffers: u8,
    pub max_burst: u8,
    pub max_streams: u8,
    pub mult: u8,
    pub bytes_per_interval: u32,
}

Configuration to allocate an endpoint with.

The driver must allocate an endpoint with exactly the given addr (if any), ep_type, max_packet_size and interval_ms, or fail. The docs of the other fields say whether the driver may deviate from them.

The SuperSpeed fields are those of the endpoint’s SuperSpeed Endpoint Companion descriptor, and 0 for an endpoint that has none.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

addr: Option<EndpointAddress>

Endpoint’s address, or None for the driver to pick one.

ep_type: EndpointType

Endpoint’s type.

max_packet_size: u16

Max packet size, in bytes.

interval_ms: u8

Polling interval, in milliseconds.

buffers: u8

Number of packets the hardware may buffer for the endpoint.

More buffers let the hardware move the next packet while software is still busy with the previous one, at the cost of more packet memory.

This is just a best-effort hint for the driver. Drivers may use a lower value if there is not enough packet memory, or completely ignore it.

max_burst: u8

SuperSpeed bMaxBurst: the endpoint bursts up to max_burst + 1 packets.

Drivers may use a lower value, and report it in EndpointInfo::max_burst.

max_streams: u8

SuperSpeed bulk MaxStreams: the endpoint has 2^max_streams streams, or none when 0.

mult: u8

SuperSpeed isochronous Mult: the endpoint moves up to mult + 1 bursts per service interval.

bytes_per_interval: u32

SuperSpeed periodic wBytesPerInterval, or the dwBytesPerInterval of a SuperSpeedPlus isochronous endpoint: the bytes the endpoint moves per service interval.

Implementations

impl EndpointConfig

pub const fn new( addr: Option<EndpointAddress>, ep_type: EndpointType, max_packet_size: u16, interval_ms: u8, ) -> Self

An endpoint with one buffer and all SuperSpeed fields 0.

Trait Implementations

impl Clone for EndpointConfig

fn clone(&self) -> EndpointConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EndpointConfig

impl Debug for EndpointConfig

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

Formats the value using the given formatter.

impl Eq for EndpointConfig

impl Format for EndpointConfig

where Option<EndpointAddress>: Format, EndpointType: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl PartialEq for EndpointConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EndpointConfig