embassy-usb-host

Crates

git

Versions

default

Flavors

EndpointDescriptor

Struct EndpointDescriptor 

Source
pub struct EndpointDescriptor {
    pub endpoint_address: u8,
    pub attributes: u8,
    pub max_packet_size: u16,
    pub interval: u8,
}
Expand description

Standard USB Endpoint Descriptor.

Contains information to determine the bandwidth requirements. (USB 2.0 §9.6.6)

Fields§

§endpoint_address: u8

Endpoint address.

Contains the endpoint number and direction.

§attributes: u8

Endpoint attribute bitmap.

§max_packet_size: u16

Maximum packet size (11 bits).

For high-speed isochronous and interrupt endpoints, it also specifies aditional transaction opportunities.

§interval: u8

Polling interval.

The meaning of this value depends on the transfer type and speed.

Implementations§

Source§

impl EndpointDescriptor

Source

pub fn ep_dir(&self) -> Direction

Returns the endpoint direction.

Source

pub fn ep_type(&self) -> EndpointType

Returns the endpoint transfer type.

Source

pub fn ep_number(&self) -> u8

Endpoint number (0-15).

Source

pub fn is_in(&self) -> bool

True if this is an IN endpoint.

Source

pub fn transfer_type(&self) -> u8

Transfer type (0=Control, 1=Isochronous, 2=Bulk, 3=Interrupt).

Trait Implementations§

Source§

impl Clone for EndpointDescriptor

Source§

fn clone(&self) -> EndpointDescriptor

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 EndpointDescriptor

Source§

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

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

impl ExtendableDescriptor for EndpointDescriptor

Source§

const MIN_LEN: u8 = 7u8

Minimum length of the descriptor. Read more
Source§

fn match_bytes(bytes: &[u8]) -> Result<(), DescriptorError>

Matches bytes with this descriptor. Read more
Source§

fn prepare_bytes(bytes: &mut [u8], len: u8) -> Result<(), DescriptorError>
where Self: WritableDescriptor,

Prepares bytes to receive descriptor data. Read more
Source§

impl Format for EndpointDescriptor

Source§

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

Writes the defmt representation of self to fmt.
Source§

impl From<EndpointDescriptor> for EndpointInfo

Source§

fn from(value: EndpointDescriptor) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for EndpointDescriptor

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl USBDescriptor for EndpointDescriptor

Source§

const BUF_SIZE: usize = 7usize

Size of the byte buffer. Read more
Source§

const DESC_TYPE: u8 = 5u8

Descriptor type. Read more
Source§

type Error = DescriptorError

Source§

fn try_from_bytes(bytes: &[u8]) -> Result<Self, Self::Error>

Source§

const DESC_SUBTYPE: Option<u8> = None

Descriptor subtype. Read more
Source§

impl WritableDescriptor for EndpointDescriptor

Source§

fn write_to_bytes(&self, bytes: &mut [u8]) -> Result<usize, Self::Error>

Writes this descriptor to the start of the byte buffer bytes. Read more
Source§

fn write_to_bytes_partial(&self, bytes: &mut [u8]) -> Result<usize, Self::Error>

Writes this descriptor to the start of the byte buffer bytes. Read more
Source§

impl Copy for EndpointDescriptor

Source§

impl Eq for EndpointDescriptor

Source§

impl StructuralPartialEq for EndpointDescriptor

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.

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.

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.