Struct usbd_serial::CdcAcmClass

pub struct CdcAcmClass<'a, B: UsbBus> { /* private fields */ }

Packet level implementation of a CDC-ACM serial port.

This class can be used directly and it has the least overhead due to directly reading and writing USB packets with no intermediate buffers, but it will not act like a stream-like serial port. The following constraints must be followed if you use this class directly:

• read_packet must be called with a buffer large enough to hold max_packet_size bytes, and the method will return a WouldBlock error if there is no packet to be read.
• write_packet must not be called with a buffer larger than max_packet_size bytes, and the method will return a WouldBlock error if the previous packet has not been sent yet.
• If you write a packet that is exactly max_packet_size bytes long, it won’t be processed by the host operating system until a subsequent shorter packet is sent. A zero-length packet (ZLP) can be sent if there is no other data to send. This is because USB bulk transactions must be terminated with a short packet, even if the bulk endpoint is used for stream-like data.

Implementations

impl<'a, B: UsbBus> CdcAcmClass<'a, B>

pub fn new<'alloc: 'a>( alloc: &'alloc UsbBusAllocator<B>, max_packet_size: u16 ) -> CdcAcmClass<'a, B>

Creates a new CdcAcmClass with the provided UsbBus and max_packet_size in bytes. For full-speed devices, max_packet_size has to be one of 8, 16, 32 or 64.

pub fn new_with_interface_names<'alloc: 'a>( alloc: &'alloc UsbBusAllocator<B>, max_packet_size: u16, comm_if_name: Option<&'static str>, data_if_name: Option<&'static str> ) -> CdcAcmClass<'a, B>

Creates a new CdcAcmClass with the provided UsbBus and max_packet_size in bytes. For full-speed devices, max_packet_size has to be one of 8, 16, 32 or 64. Additionally, this lets you specify optional names for the CDC interfaces, to better organize composite devices.

pub fn max_packet_size(&self) -> u16

Gets the maximum packet size in bytes.

pub fn line_coding(&self) -> &LineCoding

Gets the current line coding. The line coding contains information that’s mainly relevant for USB to UART serial port emulators, and can be ignored if not relevant.

pub fn dtr(&self) -> bool

Gets the DTR (data terminal ready) state

pub fn rts(&self) -> bool

Gets the RTS (request to send) state

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

Writes a single packet into the IN endpoint.

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

Reads a single packet from the OUT endpoint.

pub fn write_ep(&self) -> &EndpointIn<'a, B>

Gets the IN endpoint.

pub fn write_ep_mut(&mut self) -> &mut EndpointIn<'a, B>

Mutably gets the IN endpoint.

pub fn read_ep(&self) -> &EndpointOut<'a, B>

Gets the OUT endpoint.

pub fn read_ep_mut(&mut self) -> &mut EndpointOut<'a, B>

Mutably gets the OUT endpoint.

Trait Implementations

impl<B: UsbBus> UsbClass<B> for CdcAcmClass<'_, B>

fn get_configuration_descriptors( &self, writer: &mut DescriptorWriter<'_> ) -> Result<()>

Called when a GET_DESCRIPTOR request is received for a configuration descriptor. When called, the implementation should write its interface, endpoint and any extra class descriptors into writer. The configuration descriptor itself will be written by UsbDevice and shouldn’t be written by classes.

fn get_string(&self, index: StringIndex, _lang_id: LangID) -> Option<&str>

Gets a class-specific string descriptor.

fn reset(&mut self)

Called after a USB reset after the bus reset sequence is complete.

fn control_in(&mut self, xfer: ControlIn<'_, '_, '_, B>)

Called when a control request is received with direction DeviceToHost.

fn control_out(&mut self, xfer: ControlOut<'_, '_, '_, B>)

Called when a control request is received with direction HostToDevice.

fn get_bos_descriptors( &self, writer: &mut BosWriter<'_, '_> ) -> Result<(), UsbError>

Called when a GET_DESCRIPTOR request is received for a BOS descriptor. When called, the implementation should write its blobs such as capability descriptors into writer. The BOS descriptor itself will be written by UsbDevice and shouldn’t be written by classes.

fn poll(&mut self)

Called whenever the UsbDevice is polled.

fn endpoint_setup(&mut self, addr: EndpointAddress)

Called when endpoint with address addr has received a SETUP packet. Implementing this shouldn’t be necessary in most cases, but is provided for completeness’ sake.

fn endpoint_out(&mut self, addr: EndpointAddress)

Called when endpoint with address addr has received data (OUT packet).

fn endpoint_in_complete(&mut self, addr: EndpointAddress)

Called when endpoint with address addr has completed transmitting data (IN packet).

fn get_alt_setting(&mut self, interface: InterfaceNumber) -> Option<u8>

Called when the interfaces alternate setting state is requested.

fn set_alt_setting( &mut self, interface: InterfaceNumber, alternative: u8 ) -> bool

Called when the interfaces alternate setting state is altered.