Struct capsules_extra::usb::cdc::CdcAcm

pub struct CdcAcm<'a, U: 'a, A: 'a + Alarm<'a>> { /* private fields */ }

Implementation of the Abstract Control Model (ACM) for the Communications Class Device (CDC) over USB.

Implementations

impl<'a, U: UsbController<'a>, A: 'a + Alarm<'a>> CdcAcm<'a, U, A>

pub fn new( controller: &'a U, max_ctrl_packet_size: u8, vendor_id: u16, product_id: u16, strings: &'static [&'static str; 3], timeout_alarm: &'a A, host_initiated_function: Option<&'a (dyn Fn() + 'a)>, ) -> Self

pub fn controller(&self) -> &'a U

Trait Implementations

impl<'a, U: UsbController<'a>, A: 'a + Alarm<'a>> AlarmClient for CdcAcm<'a, U, A>

fn alarm(&self)

Callback indicating the alarm time has been reached. The alarm MUST be disabled when this is called. If a new alarm is needed, the client can call Alarm::set_alarm.

impl<'a, U: UsbController<'a>, A: 'a + Alarm<'a>> Client<'a> for CdcAcm<'a, U, A>

fn ctrl_setup(&'a self, endpoint: usize) -> CtrlSetupResult

Handle a Control Setup transaction.

CDC uses special values here, and we can use these to know when a CDC client is connected or not.

fn ctrl_in(&'a self, endpoint: usize) -> CtrlInResult

Handle a Control In transaction

fn ctrl_out(&'a self, endpoint: usize, packet_bytes: u32) -> CtrlOutResult

Handle a Control Out transaction

fn ctrl_status_complete(&'a self, endpoint: usize)

Handle the completion of a Control transfer

fn packet_in(&'a self, transfer_type: TransferType, endpoint: usize) -> InResult

Handle a Bulk/Interrupt IN transaction.

This is called when we can send data to the host. It should get called when we tell the controller we want to resume the IN endpoint (meaning we know we have data to send) and afterwards until we return hil::usb::InResult::Delay from this function. That means we can use this as a callback to mean that the transmission finished by waiting until this function is called when we don’t have anything left to send.

fn packet_out( &'a self, transfer_type: TransferType, endpoint: usize, packet_bytes: u32, ) -> OutResult

Handle a Bulk/Interrupt OUT transaction

fn enable(&'a self)

fn attach(&'a self)

fn bus_reset(&'a self)

fn ctrl_status(&'a self, endpoint: usize)

fn packet_transmitted(&'a self, _endpoint: usize)

impl<'a, U: UsbController<'a>, A: 'a + Alarm<'a>> Configure for CdcAcm<'a, U, A>

fn configure(&self, _parameters: Parameters) -> Result<(), ErrorCode>

Set the configuration parameters for the UART bus.

impl<'a, U: UsbController<'a>, A: 'a + Alarm<'a>> DeferredCallClient for CdcAcm<'a, U, A>

fn handle_deferred_call(&self)

Software interrupt function that is called when the deferred call is triggered.

fn register(&'static self)

impl<'a, U: UsbController<'a>, A: 'a + Alarm<'a>> Receive<'a> for CdcAcm<'a, U, A>

fn set_receive_client(&self, client: &'a dyn ReceiveClient)

Set the receive client, which will be called when reads complete.

fn receive_buffer( &self, rx_buffer: &'static mut [u8], rx_len: usize, ) -> Result<(), (ErrorCode, &'static mut [u8])>

Receive rx_len bytes into rx_buffer.

fn receive_abort(&self) -> Result<(), ErrorCode>

Abort any ongoing receive transfers and return what has been received.

fn receive_word(&self) -> Result<(), ErrorCode>

Receive a single word of data.

impl<'a, U: UsbController<'a>, A: 'a + Alarm<'a>> Transmit<'a> for CdcAcm<'a, U, A>

fn set_transmit_client(&self, client: &'a dyn TransmitClient)

Set the transmit client, which will be called when transmissions complete.

fn transmit_buffer( &self, tx_buffer: &'static mut [u8], tx_len: usize, ) -> Result<(), (ErrorCode, &'static mut [u8])>

Transmit a buffer of data.

fn transmit_abort(&self) -> Result<(), ErrorCode>

Abort an outstanding call to transmit_word or transmit_buffer.

fn transmit_word(&self, _word: u32) -> Result<(), ErrorCode>

Transmit a single word of data asynchronously.