itsscb/embassy
1
0
Fork 0
mirror of https://github.com/embassy-rs/embassy.git synced 2025-09-26 20:00:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add information about existing USB IP implementations

Browse Source
This commit is contained in:
decaday 2025-03-19 11:37:35 +08:00
parent 9d672c44d1
commit 9806f78ea0
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
embassy-usb/README.md
View File

@ -20,6 +20,11 @@ Async USB device stack for embedded devices in Rust.
To add `embassy-usb` support for new hardware (i.e. a new MCU chip), you have to write a driver that implements To add `embassy-usb` support for new hardware (i.e. a new MCU chip), you have to write a driver that implements
the [`embassy-usb-driver`](https://crates.io/crates/embassy-usb-driver) traits. the [`embassy-usb-driver`](https://crates.io/crates/embassy-usb-driver) traits.
Before writing a new driver, you can first verify whether the chip uses a common USB IP. Several widely used USB IPs already have implementations available, such as:
- **Synopsys OTG (dwc2)**: Available at [embassy-usb-synopsys-otg](https://crates.io/crates/embassy-usb-synopsys-otg). This IP is used by vendors like STMicroelectronics, Espressif, and others.
- **Musbmhdrc (musb)**: Available at [musb](https://crates.io/crates/musb). This IP is used by vendors like TI, MediaTek, Puya, and others.
Driver crates should depend only on `embassy-usb-driver`, not on the main `embassy-usb` crate. Driver crates should depend only on `embassy-usb-driver`, not on the main `embassy-usb` crate.
This allows existing drivers to continue working for newer `embassy-usb` major versions, without needing an update, if the driver This allows existing drivers to continue working for newer `embassy-usb` major versions, without needing an update, if the driver
trait has not had breaking changes. trait has not had breaking changes.