embassy-usb

Crates

git

Versions

default

Flavors

Skip to main content

CdcAcmHost

Struct CdcAcmHost 

Source
pub struct CdcAcmHost<'d, A: UsbHostAllocator<'d>> { /* private fields */ }
Expand description

CDC ACM host driver.

Provides read/write access to a CDC ACM (virtual serial port) USB device.

Implementations§

Source§

impl<'d, A: UsbHostAllocator<'d>> CdcAcmHost<'d, A>

Source

pub fn new( alloc: &A, config_desc: &[u8], enum_info: &EnumerationInfo, ) -> Result<Self, CdcAcmError>

Create a new CDC ACM host driver.

Parses the config descriptor to find CDC ACM endpoints and allocates channels.

Source

pub fn new_with_info( alloc: &A, info: CdcAcmInfo, enum_info: &EnumerationInfo, ) -> Result<Self, CdcAcmError>

Create a CDC ACM host driver from an already-probed CdcAcmInfo.

This is the allocation half of HostClass::open; it does not parse the configuration descriptor again.

Source

pub async fn set_line_coding( &mut self, coding: &LineCoding, ) -> Result<(), CdcAcmError>

Set the line coding (baud rate, data bits, parity, stop bits).

Source

pub async fn set_control_line_state( &mut self, dtr: bool, rts: bool, ) -> Result<(), CdcAcmError>

Set the control line state (DTR, RTS).

Source

pub async fn read(&mut self, buf: &mut [u8]) -> Result<usize, CdcAcmError>

Read data from the CDC ACM device.

Source

pub async fn write(&mut self, data: &[u8]) -> Result<usize, CdcAcmError>

Write data to the CDC ACM device.

Trait Implementations§

Source§

impl<'d, A: UsbHostAllocator<'d>> ErrorType for CdcAcmHost<'d, A>

Source§

type Error = CdcAcmError

Error type of all the IO operations on this type.
Source§

impl<'d, A: UsbHostAllocator<'d>> HostClass<'d, A> for CdcAcmHost<'d, A>

Source§

const NAME: &'static str = "CDC ACM"

Human-readable class name, used for logging.
Source§

type Info = CdcAcmInfo

Cheap, owned description of the interface(s) and endpoints to use. Read more
Source§

fn probe(_enum_info: &EnumerationInfo, cfg: &[u8]) -> Option<Self::Info>

Find the class in an enumerated device. Returns None when the class is not present. This must not allocate pipes or issue control requests. Read more
Source§

async fn open( alloc: &A, _cfg: &[u8], info: Self::Info, enum_info: &EnumerationInfo, ) -> Result<Self, ClassError>

Allocate pipes and perform any class-specific setup.
Source§

fn is_present(enum_info: &EnumerationInfo, cfg: &[u8]) -> bool

Convenience wrapper around probe.
Source§

impl<'d, A: UsbHostAllocator<'d>> Read for CdcAcmHost<'d, A>

Source§

async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Self::Error>

Read some bytes from this source into the specified buffer, returning how many bytes were read. Read more
Source§

async fn read_exact( &mut self, buf: &mut [u8], ) -> Result<(), ReadExactError<Self::Error>>

Read the exact number of bytes required to fill buf. Read more
Source§

impl<'d, A: UsbHostAllocator<'d>> Write for CdcAcmHost<'d, A>

Source§

async fn write(&mut self, buf: &[u8]) -> Result<usize, Self::Error>

Write a buffer into this writer, returning how many bytes were written. Read more
Source§

async fn flush(&mut self) -> Result<(), Self::Error>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.
Source§

async fn write_all(&mut self, buf: &[u8]) -> Result<(), Self::Error>

Write an entire buffer into this writer. Read more

Auto Trait Implementations§

§

impl<'d, A> Forget for CdcAcmHost<'d, A>

§

impl<'d, A> Freeze for CdcAcmHost<'d, A>

§

impl<'d, A> Move for CdcAcmHost<'d, A>

§

impl<'d, A> RefUnwindSafe for CdcAcmHost<'d, A>

§

impl<'d, A> Send for CdcAcmHost<'d, A>
where <A as UsbHostAllocator<'d>>::Pipe<Control, InOut>: Send, <A as UsbHostAllocator<'d>>::Pipe<Bulk, In>: Send, <A as UsbHostAllocator<'d>>::Pipe<Bulk, Out>: Send,

§

impl<'d, A> Sync for CdcAcmHost<'d, A>
where <A as UsbHostAllocator<'d>>::Pipe<Control, InOut>: Sync, <A as UsbHostAllocator<'d>>::Pipe<Bulk, In>: Sync, <A as UsbHostAllocator<'d>>::Pipe<Bulk, Out>: Sync,

§

impl<'d, A> Unpin for CdcAcmHost<'d, A>
where <A as UsbHostAllocator<'d>>::Pipe<Control, InOut>: Unpin, <A as UsbHostAllocator<'d>>::Pipe<Bulk, In>: Unpin, <A as UsbHostAllocator<'d>>::Pipe<Bulk, Out>: Unpin,

§

impl<'d, A> UnsafeUnpin for CdcAcmHost<'d, A>

§

impl<'d, A> UnwindSafe for CdcAcmHost<'d, A>

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.