aboutsummaryrefslogtreecommitdiff
path: root/embassy-usb-synopsys-otg/README.md
blob: ba3c8116a70d5003d379c0b39c6c8e438a4290b2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# Embassy USB driver for the Synopsys USB OTG core

This crate implements [`embassy-usb-driver`](https://crates.io/crates/embassy-usb-driver) for Synopsys USB OTG devices.

It contains the "core" of the driver that is common across all chips using
the Synopsys OTG IP, but it doesn't contain chip-specific initialization such
as clock setup and GPIO muxing. You most likely don't want to use this crate
directly, but use it through a HAL that does the initialization for you.

List of HALs integrating this driver:

- [`embassy-stm32`](https://crates.io/crates/embassy-stm32), for STMicroelectronics STM32 chips.
- [`esp-hal`](https://crates.io/crates/esp-hal), for Espressif ESP32 chips.

If you wish to integrate this crate into your device's HAL, you will need to add the
device-specific initialization. See the above crates for examples on how to do it.