1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
//! CDC-ACM USB serial port implementation for [usb-device](https://crates.io/crates/usb-device). //! //! CDC-ACM is a USB class that's supported out of the box by most operating systems and used for //! implementing modems and generic serial ports. The [`SerialPort`](crate::SerialPort) class //! implements a stream-like buffered serial port that can be used similarly to a normal UART. //! //! The crate also contains [`CdcAcmClass`](CdcAcmClass) which is a lower-level implementation that //! has less overhead, but requires more care to use correctly. //! //! Example //! ======= //! //! A full example requires the use of a hardware-driver, but the hardware independent part is as //! follows: //! //! ``` //! let mut serial = SerialPort::new(&usb_bus); //! //! let mut usb_dev = UsbDeviceBuilder::new(&usb_bus, UsbVidPid(0x16c0, 0x27dd)) //! .product("Serial port") //! .device_class(USB_CLASS_CDC) //! .build(); //! //! loop { //! if !usb_dev.poll(&mut [&mut serial]) { //! continue; //! } //! //! let mut buf = [0u8; 64]; //! //! match serial.read(&mut buf[..]) { //! Ok(count) => { //! // count bytes were read to &buf[..count] //! }, //! Err(UsbError::WouldBlock) => // No data received //! Err(err) => // An error occurred //! }; //! //! match serial.write(&[0x3a, 0x29]) { //! Ok(count) => { //! // count bytes were written //! }, //! Err(UsbError::WouldBlock) => // No data could be written (buffers full) //! Err(err) => // An error occurred //! }; //! } //! ``` #![no_std] mod buffer; mod cdc_acm; mod serial_port; pub use usb_device::{Result, UsbError}; pub use crate::cdc_acm::*; pub use crate::serial_port::*; pub use crate::buffer::DefaultBufferStore;