aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--embassy-usb-synopsys-otg/Cargo.toml1
-rw-r--r--embassy-usb-synopsys-otg/README.md17
2 files changed, 15 insertions, 3 deletions
diff --git a/embassy-usb-synopsys-otg/Cargo.toml b/embassy-usb-synopsys-otg/Cargo.toml
index f117d0cbf..9397ff607 100644
--- a/embassy-usb-synopsys-otg/Cargo.toml
+++ b/embassy-usb-synopsys-otg/Cargo.toml
@@ -2,6 +2,7 @@
2name = "embassy-usb-synopsys-otg" 2name = "embassy-usb-synopsys-otg"
3version = "0.1.0" 3version = "0.1.0"
4edition = "2021" 4edition = "2021"
5license = "MIT OR Apache-2.0"
5description = "`embassy-usb-driver` implementation for Synopsys OTG USB controllers" 6description = "`embassy-usb-driver` implementation for Synopsys OTG USB controllers"
6keywords = ["embedded", "async", "usb", "hal", "embedded-hal"] 7keywords = ["embedded", "async", "usb", "hal", "embedded-hal"]
7categories = ["embedded", "hardware-support", "no-std", "asynchronous"] 8categories = ["embedded", "hardware-support", "no-std", "asynchronous"]
diff --git a/embassy-usb-synopsys-otg/README.md b/embassy-usb-synopsys-otg/README.md
index fa8d5d6da..5354f07bf 100644
--- a/embassy-usb-synopsys-otg/README.md
+++ b/embassy-usb-synopsys-otg/README.md
@@ -1,5 +1,16 @@
1# Embassy USB driver for the Synopsys USB OTG core 1# Embassy USB driver for the Synopsys USB OTG core
2 2
3This crate implements `embassy-usb-driver` for Synopsys USB OTG devices. If you wish to 3This crate implements [`embassy-usb-driver`](https://crates.io/crates/embassy-usb-driver) for Synopsys USB OTG devices.
4integrate this crate into your device's HAL, you will need to add device-specific initialization. 4
5For an example, check out the `embassy-stm32` crate. 5It contains the "core" of the driver that is common across all chips using
6the Synopsys OTG IP, but it doesn't contain chip-specific initialization such
7as clock setup and GPIO muxing. You most likely don't want to use this crate
8directly, but use it through a HAL that does the initialization for you.
9
10List of HALs integrating this driver:
11
12- [`embassy-stm32`](https://crates.io/crates/embassy-stm32), for STMicroelectronics STM32 chips.
13- [`esp-hal`](https://crates.io/crates/esp-hal), for Espressif ESP32 chips.
14
15If you wish to integrate this crate into your device's HAL, you will need to add the
16device-specific initialization. See the above crates for examples on how to do it. \ No newline at end of file