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>

Returns Ok(()), or

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

fn handle_deferred_call(&self)

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 he 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, making a callback to the ReceiveClient when complete. If the Result<(), ErrorCode> of receive_buffer’s return is Ok(()), the struct will issue a received_buffer callback in the future. If the value of the Result<(), ErrorCode> is Err(), then the rx_buffer argument is returned in the Err(). Valid ErrorCode values are:

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

Abort any ongoing receive transfers and return what is in the receive buffer with the receive_complete callback. If Ok(()) is returned, there will be no callback (no call to receive was outstanding). If there was a receive outstanding, which is cancelled successfully then BUSY will be returned and there will be a callback with a Result<(), ErrorCode> of CANCEL. If there was a reception outstanding, which is not cancelled successfully, then FAIL will be returned and there will be a later callback.

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

Receive a single word of data. The word length is determined by the UART configuration: it can be 6, 7, 8, or 9 bits long. If the Result<(), ErrorCode> is Ok(()), on completion, received_word will be called on the ReceiveClient. Other valid ErrorCode values are:

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. On completion, transmitted_buffer in the TransmitClient will be called. If the Result<(), ErrorCode> returned by transmit is an Ok(()), the struct will issue a transmitted_buffer callback in the future. If the value of the Result<(), ErrorCode> is Err(), then the tx_bufferargument is returned in theErr(), along with the ErrorCode. Valid ErrorCode` values are:

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

Abort an outstanding call to transmit_word or transmit_buffer. The return code indicates whether the call has fully terminated or there will be a callback. Cancelled calls to transmit_buffer MUST always make a callback, to return the passed buffer back to the caller.

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

Transmit a single word of data asynchronously. The word length is determined by the UART configuration: it can be 6, 7, 8, or 9 bits long. If the Result<(), ErrorCode> is Ok(()), on completion, transmitted_word will be called on the TransmitClient. Other valid Result<(), ErrorCode> values are: