diff options
| author | Dario Nieuwenhuis <[email protected]> | 2024-04-30 17:23:38 +0200 |
|---|---|---|
| committer | Dario Nieuwenhuis <[email protected]> | 2024-04-30 17:24:32 +0200 |
| commit | ecc910b76dbfa2064f42e6917a7b5654a89b81ed (patch) | |
| tree | eecff3cb7d6097fe1a29b97378db7e7fd01bfa02 | |
| parent | 56a7b10064b830b1be1933085a5845d0d6be5f2e (diff) | |
Release embassy-usb-synopsys-otg v0.1.0
| -rw-r--r-- | embassy-usb-synopsys-otg/Cargo.toml | 1 | ||||
| -rw-r--r-- | embassy-usb-synopsys-otg/README.md | 17 |
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 @@ | |||
| 2 | name = "embassy-usb-synopsys-otg" | 2 | name = "embassy-usb-synopsys-otg" |
| 3 | version = "0.1.0" | 3 | version = "0.1.0" |
| 4 | edition = "2021" | 4 | edition = "2021" |
| 5 | license = "MIT OR Apache-2.0" | ||
| 5 | description = "`embassy-usb-driver` implementation for Synopsys OTG USB controllers" | 6 | description = "`embassy-usb-driver` implementation for Synopsys OTG USB controllers" |
| 6 | keywords = ["embedded", "async", "usb", "hal", "embedded-hal"] | 7 | keywords = ["embedded", "async", "usb", "hal", "embedded-hal"] |
| 7 | categories = ["embedded", "hardware-support", "no-std", "asynchronous"] | 8 | categories = ["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 | ||
| 3 | This crate implements `embassy-usb-driver` for Synopsys USB OTG devices. If you wish to | 3 | This crate implements [`embassy-usb-driver`](https://crates.io/crates/embassy-usb-driver) for Synopsys USB OTG devices. |
| 4 | integrate this crate into your device's HAL, you will need to add device-specific initialization. | 4 | |
| 5 | For an example, check out the `embassy-stm32` crate. | 5 | It contains the "core" of the driver that is common across all chips using |
| 6 | the Synopsys OTG IP, but it doesn't contain chip-specific initialization such | ||
| 7 | as clock setup and GPIO muxing. You most likely don't want to use this crate | ||
| 8 | directly, but use it through a HAL that does the initialization for you. | ||
| 9 | |||
| 10 | List 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 | |||
| 15 | If you wish to integrate this crate into your device's HAL, you will need to add the | ||
| 16 | device-specific initialization. See the above crates for examples on how to do it. \ No newline at end of file | ||
