aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUlf Lilleengen <[email protected]>2025-03-19 08:57:50 +0100
committerGitHub <[email protected]>2025-03-19 08:57:50 +0100
commit8bce1fe03ef889b82862f9debc32b2aca8e0bda2 (patch)
tree4429bf773c6c89eb45fc5b67b7684456df2cfffa
parent8987bf201a401b252397312526bcb270c9b81f3a (diff)
parent0f0030651c4d0fdc8809b341e9b27d7626128cf6 (diff)
Merge pull request #3973 from decaday/docs/add-musb-and-py32
Add py32-hal and musb to docs and READMEs
-rw-r--r--README.md1
-rw-r--r--docs/pages/hal.adoc4
-rw-r--r--docs/pages/overview.adoc1
-rw-r--r--embassy-usb/README.md5
4 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index ee5c42245..e9f0d3b24 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,7 @@ Rust's <a href="https://rust-lang.github.io/async-book/">async/await</a> allows
19 - Embassy HAL support for Espressif chips, as well as Async WiFi, Bluetooth and ESP-NOW, is being developed in the [esp-rs/esp-hal](https://github.com/esp-rs/esp-hal) repository. 19 - Embassy HAL support for Espressif chips, as well as Async WiFi, Bluetooth and ESP-NOW, is being developed in the [esp-rs/esp-hal](https://github.com/esp-rs/esp-hal) repository.
20 - <a href="https://github.com/ch32-rs/ch32-hal">ch32-hal</a>, for the WCH 32-bit RISC-V(CH32V) series of chips. 20 - <a href="https://github.com/ch32-rs/ch32-hal">ch32-hal</a>, for the WCH 32-bit RISC-V(CH32V) series of chips.
21 - <a href="https://github.com/AlexCharlton/mpfs-hal">mpfs-hal</a>, for the Microchip PolarFire SoC. 21 - <a href="https://github.com/AlexCharlton/mpfs-hal">mpfs-hal</a>, for the Microchip PolarFire SoC.
22 - <a href="https://github.com/py32-rs/py32-hal">py32-hal</a>, for the Puya Semiconductor PY32 series of microcontrollers.
22 23
23- **Time that Just Works** - 24- **Time that Just Works** -
24No more messing with hardware timers. <a href="https://docs.embassy.dev/embassy-time">embassy_time</a> provides Instant, Duration and Timer types that are globally available and never overflow. 25No more messing with hardware timers. <a href="https://docs.embassy.dev/embassy-time">embassy_time</a> provides Instant, Duration and Timer types that are globally available and never overflow.
diff --git a/docs/pages/hal.adoc b/docs/pages/hal.adoc
index e1a29751e..3c6839792 100644
--- a/docs/pages/hal.adoc
+++ b/docs/pages/hal.adoc
@@ -13,4 +13,6 @@ For the ESP32 series, there is an link:https://github.com/esp-rs/esp-hal[esp-hal
13 13
14For the WCH 32-bit RISC-V series, there is an link:https://github.com/ch32-rs/ch32-hal[ch32-hal], which you can use. 14For the WCH 32-bit RISC-V series, there is an link:https://github.com/ch32-rs/ch32-hal[ch32-hal], which you can use.
15 15
16For the Microchip PolarFire SoC, there is link:https://github.com/AlexCharlton/mpfs-hal[mpfs-hal]. \ No newline at end of file 16For the Microchip PolarFire SoC, there is link:https://github.com/AlexCharlton/mpfs-hal[mpfs-hal].
17
18For the Puya Semiconductor PY32 series, there is link:https://github.com/py32-rs/py32-hal[py32-hal]. \ No newline at end of file
diff --git a/docs/pages/overview.adoc b/docs/pages/overview.adoc
index 9b93ba10c..abc7d25de 100644
--- a/docs/pages/overview.adoc
+++ b/docs/pages/overview.adoc
@@ -32,6 +32,7 @@ The Embassy project maintains HALs for select hardware, but you can still use HA
32* link:https://github.com/esp-rs[esp-rs], for the Espressif Systems ESP32 series of chips. 32* link:https://github.com/esp-rs[esp-rs], for the Espressif Systems ESP32 series of chips.
33* link:https://github.com/ch32-rs/ch32-hal[ch32-hal], for the WCH 32-bit RISC-V(CH32V) series of chips. 33* link:https://github.com/ch32-rs/ch32-hal[ch32-hal], for the WCH 32-bit RISC-V(CH32V) series of chips.
34* link:https://github.com/AlexCharlton/mpfs-hal[mpfs-hal], for the Microchip PolarFire SoC. 34* link:https://github.com/AlexCharlton/mpfs-hal[mpfs-hal], for the Microchip PolarFire SoC.
35* link:https://github.com/py32-rs/py32-hal[py32-hal], for the Puya Semiconductor PY32 series of chips.
35 36
36NOTE: A common question is if one can use the Embassy HALs standalone. Yes, it is possible! There are no dependency on the executor within the HALs. You can even use them without async, 37NOTE: A common question is if one can use the Embassy HALs standalone. Yes, it is possible! There are no dependency on the executor within the HALs. You can even use them without async,
37as they implement both the link:https://github.com/rust-embedded/embedded-hal[Embedded HAL] blocking and async traits. 38as they implement both the link:https://github.com/rust-embedded/embedded-hal[Embedded HAL] blocking and async traits.
diff --git a/embassy-usb/README.md b/embassy-usb/README.md
index 400fc6695..a053c940b 100644
--- a/embassy-usb/README.md
+++ b/embassy-usb/README.md
@@ -20,6 +20,11 @@ Async USB device stack for embedded devices in Rust.
20To add `embassy-usb` support for new hardware (i.e. a new MCU chip), you have to write a driver that implements 20To add `embassy-usb` support for new hardware (i.e. a new MCU chip), you have to write a driver that implements
21the [`embassy-usb-driver`](https://crates.io/crates/embassy-usb-driver) traits. 21the [`embassy-usb-driver`](https://crates.io/crates/embassy-usb-driver) traits.
22 22
23Before 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:
24
25- **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.
26- **Musbmhdrc (musb)**: Available at [musb](https://crates.io/crates/musb). This IP is used by vendors like TI, MediaTek, Puya, and others.
27
23Driver crates should depend only on `embassy-usb-driver`, not on the main `embassy-usb` crate. 28Driver crates should depend only on `embassy-usb-driver`, not on the main `embassy-usb` crate.
24This allows existing drivers to continue working for newer `embassy-usb` major versions, without needing an update, if the driver 29This allows existing drivers to continue working for newer `embassy-usb` major versions, without needing an update, if the driver
25trait has not had breaking changes. 30trait has not had breaking changes.