From b452a6bcf6858893a85882614e2dcde5a3405748 Mon Sep 17 00:00:00 2001 From: Dario Nieuwenhuis Date: Thu, 11 Jan 2024 18:18:35 +0100 Subject: [PATCH 1/4] Centralize license and MSRV boilerplate into the repo readme. --- LICENSE-APACHE | 2 +- LICENSE-MIT | 2 +- README.md | 8 +++++++- cyw43-pio/README.md | 14 -------------- cyw43/README.md | 15 --------------- embassy-boot/boot/README.md | 15 --------------- embassy-boot/nrf/README.md | 15 --------------- embassy-boot/rp/README.md | 14 -------------- embassy-boot/stm32/README.md | 14 -------------- embassy-executor-macros/README.md | 10 ---------- embassy-futures/README.md | 15 --------------- embassy-hal-internal/README.md | 10 ---------- embassy-net-adin1110/README.md | 10 ---------- embassy-net-driver-channel/README.md | 10 ---------- embassy-net-driver/README.md | 10 ---------- embassy-net-enc28j60/README.md | 10 ---------- embassy-net-esp-hosted/README.md | 11 ----------- embassy-net-ppp/README.md | 10 ---------- embassy-net-tuntap/README.md | 10 ---------- embassy-net-wiznet/README.md | 11 ----------- embassy-net/README.md | 10 ---------- embassy-nrf/README.md | 15 --------------- embassy-rp/README.md | 14 -------------- embassy-sync/README.md | 14 -------------- embassy-usb-dfu/README.md | 14 -------------- embassy-usb-driver/README.md | 15 --------------- embassy-usb-logger/README.md | 14 -------------- embassy-usb/README.md | 16 ---------------- 28 files changed, 9 insertions(+), 319 deletions(-) diff --git a/LICENSE-APACHE b/LICENSE-APACHE index ea4fa15c9..8f7956e20 100644 --- a/LICENSE-APACHE +++ b/LICENSE-APACHE @@ -186,7 +186,7 @@ APPENDIX: How to apply the Apache License to your work. same "printed page" as the copyright notice for easier identification within third-party archives. -Copyright 2019-2022 Embassy project contributors +Copyright (c) Embassy project contributors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/LICENSE-MIT b/LICENSE-MIT index 87c052836..1fe5730a4 100644 --- a/LICENSE-MIT +++ b/LICENSE-MIT @@ -1,4 +1,4 @@ -Copyright (c) 2019-2022 Embassy project contributors +Copyright (c) Embassy project contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated diff --git a/README.md b/README.md index d2a24dfcc..24347a43f 100644 --- a/README.md +++ b/README.md @@ -145,7 +145,7 @@ EMBedded ASYnc! :) ## License -This work is licensed under either of +Embassy is licensed under either of - Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or ) @@ -153,5 +153,11 @@ This work is licensed under either of at your option. +## Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. + [1]: https://github.com/embassy-rs/embassy/wiki/Getting-Started [2]: https://github.com/embassy-rs/embassy/wiki/Running-the-Examples diff --git a/cyw43-pio/README.md b/cyw43-pio/README.md index 2b22db360..4a2b2aa4b 100644 --- a/cyw43-pio/README.md +++ b/cyw43-pio/README.md @@ -1,17 +1,3 @@ # cyw43-pio RP2040 PIO driver for the nonstandard half-duplex SPI used in the Pico W. The PIO driver offloads SPI communication with the WiFi chip and improves throughput. - -## Minimum supported Rust version (MSRV) - -Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/cyw43/README.md b/cyw43/README.md index 2c24c7d36..dabdf0471 100644 --- a/cyw43/README.md +++ b/cyw43/README.md @@ -44,18 +44,3 @@ This example implements a TCP echo server on port 1234. You can try connecting t nc 192.168.0.250 1234 ``` Send it some data, you should see it echoed back and printed in the firmware's logs. - -## Minimum supported Rust version (MSRV) - -Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. - diff --git a/embassy-boot/boot/README.md b/embassy-boot/boot/README.md index 3fc81f24b..3c2d45e96 100644 --- a/embassy-boot/boot/README.md +++ b/embassy-boot/boot/README.md @@ -33,18 +33,3 @@ The bootloader supports different hardware in separate crates: * `embassy-boot-nrf` - for the nRF microcontrollers. * `embassy-boot-rp` - for the RP2040 microcontrollers. * `embassy-boot-stm32` - for the STM32 microcontrollers. - - -## Minimum supported Rust version (MSRV) - -`embassy-boot` is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-boot/nrf/README.md b/embassy-boot/nrf/README.md index fe581823d..9dc5b0eb9 100644 --- a/embassy-boot/nrf/README.md +++ b/embassy-boot/nrf/README.md @@ -9,18 +9,3 @@ An adaptation of `embassy-boot` for nRF. * Load applications with or without the softdevice. * Configure bootloader partitions based on linker script. * Using watchdog timer to detect application failure. - - -## Minimum supported Rust version (MSRV) - -`embassy-boot-nrf` is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-boot/rp/README.md b/embassy-boot/rp/README.md index 315d655e3..b664145a9 100644 --- a/embassy-boot/rp/README.md +++ b/embassy-boot/rp/README.md @@ -10,17 +10,3 @@ NOTE: The applications using this bootloader should not link with the `link-rp.x * Configure bootloader partitions based on linker script. * Load applications from active partition. - -## Minimum supported Rust version (MSRV) - -`embassy-boot-rp` is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-boot/stm32/README.md b/embassy-boot/stm32/README.md index b4d7ba5a4..f6dadc8e7 100644 --- a/embassy-boot/stm32/README.md +++ b/embassy-boot/stm32/README.md @@ -8,17 +8,3 @@ An adaptation of `embassy-boot` for STM32. * Configure bootloader partitions based on linker script. * Load applications from active partition. - -## Minimum supported Rust version (MSRV) - -`embassy-boot-stm32` is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-executor-macros/README.md b/embassy-executor-macros/README.md index a959c85d5..3a8d49aa1 100644 --- a/embassy-executor-macros/README.md +++ b/embassy-executor-macros/README.md @@ -3,13 +3,3 @@ An [Embassy](https://embassy.dev) project. NOTE: Do not use this crate directly. The macros are re-exported by `embassy-executor`. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-futures/README.md b/embassy-futures/README.md index 7add22c7b..b28a8431a 100644 --- a/embassy-futures/README.md +++ b/embassy-futures/README.md @@ -11,18 +11,3 @@ ideal for embedded systems. ## Interoperability Futures from this crate can run on any executor. - -## Minimum supported Rust version (MSRV) - -Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. - diff --git a/embassy-hal-internal/README.md b/embassy-hal-internal/README.md index 6b060d1c0..1adce5b33 100644 --- a/embassy-hal-internal/README.md +++ b/embassy-hal-internal/README.md @@ -4,13 +4,3 @@ An [Embassy](https://embassy.dev) project. Internal implementation details for Embassy HALs. DO NOT USE DIRECTLY. Embassy HALs (`embassy-nrf`, `embassy-stm32`, `embassy-rp`) already reexport everything you need to use them effectively. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-net-adin1110/README.md b/embassy-net-adin1110/README.md index 8ea10b714..39a38960d 100644 --- a/embassy-net-adin1110/README.md +++ b/embassy-net-adin1110/README.md @@ -76,13 +76,3 @@ Summary: Size/request: 289 B Size/sec: 51.11 KiB ``` - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. diff --git a/embassy-net-driver-channel/README.md b/embassy-net-driver-channel/README.md index 90a216388..1955624d1 100644 --- a/embassy-net-driver-channel/README.md +++ b/embassy-net-driver-channel/README.md @@ -84,13 +84,3 @@ These `embassy-net` drivers are implemented using this crate. You can look at th ## Interoperability This crate can run on any executor. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. diff --git a/embassy-net-driver/README.md b/embassy-net-driver/README.md index 6a757380d..24fcaafc4 100644 --- a/embassy-net-driver/README.md +++ b/embassy-net-driver/README.md @@ -16,13 +16,3 @@ packet queues for RX and TX. ## Interoperability This crate can run on any executor. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. diff --git a/embassy-net-enc28j60/README.md b/embassy-net-enc28j60/README.md index 39011ca13..5c663b52e 100644 --- a/embassy-net-enc28j60/README.md +++ b/embassy-net-enc28j60/README.md @@ -7,13 +7,3 @@ Based on [@japaric](https://github.com/japaric)'s [`enc28j60`](https://github.co ## Interoperability This crate can run on any executor. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. diff --git a/embassy-net-esp-hosted/README.md b/embassy-net-esp-hosted/README.md index 3c9cc4c9e..f6c216835 100644 --- a/embassy-net-esp-hosted/README.md +++ b/embassy-net-esp-hosted/README.md @@ -14,14 +14,3 @@ See [`examples`](https://github.com/embassy-rs/embassy/tree/main/examples/nrf528 This crate can run on any executor. It supports any SPI driver implementing [`embedded-hal-async`](https://crates.io/crates/embedded-hal-async). - - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. diff --git a/embassy-net-ppp/README.md b/embassy-net-ppp/README.md index 58d67395a..0eb7cee87 100644 --- a/embassy-net-ppp/README.md +++ b/embassy-net-ppp/README.md @@ -7,13 +7,3 @@ This crate can run on any executor. It supports any serial port implementing [`embedded-io-async`](https://crates.io/crates/embedded-io-async). - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. diff --git a/embassy-net-tuntap/README.md b/embassy-net-tuntap/README.md index c5d9e746c..60a4a1bd9 100644 --- a/embassy-net-tuntap/README.md +++ b/embassy-net-tuntap/README.md @@ -5,13 +5,3 @@ ## Interoperability This crate can run on any executor. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. diff --git a/embassy-net-wiznet/README.md b/embassy-net-wiznet/README.md index b8e4bdc8e..786aab18d 100644 --- a/embassy-net-wiznet/README.md +++ b/embassy-net-wiznet/README.md @@ -14,14 +14,3 @@ See [`examples`](https://github.com/embassy-rs/embassy/tree/main/examples/rp) di This crate can run on any executor. It supports any SPI driver implementing [`embedded-hal-async`](https://crates.io/crates/embedded-hal-async). - - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. diff --git a/embassy-net/README.md b/embassy-net/README.md index 52d048e6a..94aa6f550 100644 --- a/embassy-net/README.md +++ b/embassy-net/README.md @@ -51,13 +51,3 @@ This crate can run on any executor. [`embassy-time`](https://crates.io/crates/embassy-time) is used for timekeeping and timeouts. You must link an `embassy-time` driver in your project to use this crate. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. diff --git a/embassy-nrf/README.md b/embassy-nrf/README.md index 39de3854b..5e2bd86de 100644 --- a/embassy-nrf/README.md +++ b/embassy-nrf/README.md @@ -43,18 +43,3 @@ as the methods without the suffix will be allocating a statically sized buffer ( Note that the methods that read data like [`read`](spim::Spim::read) and [`transfer_in_place`](spim::Spim::transfer_in_place) do not have the corresponding `_from_ram` variants as mutable slices always reside in RAM. - -## Minimum supported Rust version (MSRV) - -Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. - diff --git a/embassy-rp/README.md b/embassy-rp/README.md index cd79fe501..1d14eca52 100644 --- a/embassy-rp/README.md +++ b/embassy-rp/README.md @@ -7,17 +7,3 @@ for many peripherals. The benefit of using the async APIs is that the HAL takes complete operations in low power mod and handling interrupts, so that applications can focus on more important matters. NOTE: The Embassy HALs can be used both for non-async and async operations. For async, you can choose which runtime you want to use. - -## Minimum supported Rust version (MSRV) - -Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-sync/README.md b/embassy-sync/README.md index 55618f72d..c2e13799e 100644 --- a/embassy-sync/README.md +++ b/embassy-sync/README.md @@ -17,17 +17,3 @@ Synchronization primitives and data structures with async support: ## Interoperability Futures from this crate can run on any executor. - -## Minimum supported Rust version (MSRV) - -Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-usb-dfu/README.md b/embassy-usb-dfu/README.md index d8bc19bfd..bdd5b033a 100644 --- a/embassy-usb-dfu/README.md +++ b/embassy-usb-dfu/README.md @@ -4,17 +4,3 @@ An implementation of the USB DFU 1.1 protocol using embassy-boot. It has 2 compo * DFU protocol mode, enabled by the `dfu` feature. This mode corresponds to the transfer phase DFU protocol described by the USB IF. It supports DFU_DNLOAD requests if marked by the user, and will automatically reset the chip once a DFU transaction has been completed. It also responds to DFU_GETSTATUS, DFU_GETSTATE, DFU_ABORT, and DFU_CLRSTATUS with no user intervention. * DFU runtime mode, enabled by the `application feature`. This mode allows users to expose a DFU interface on their USB device, informing the host of the capability to DFU over USB, and allowing the host to reset the device into its bootloader to complete a DFU operation. Supports DFU_GETSTATUS and DFU_DETACH. When detach/reset is seen by the device as described by the standard, will write a new DFU magic number into the bootloader state in flash, and reset the system. - -## Minimum supported Rust version (MSRV) - -Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-usb-driver/README.md b/embassy-usb-driver/README.md index 93aef7596..7628a6937 100644 --- a/embassy-usb-driver/README.md +++ b/embassy-usb-driver/README.md @@ -15,18 +15,3 @@ instead of this one. ## Interoperability This crate can run on any executor. - -## Minimum supported Rust version (MSRV) - -This crate requires nightly Rust, due to using "async fn in trait" support. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. - diff --git a/embassy-usb-logger/README.md b/embassy-usb-logger/README.md index 6cb18e87d..81b0dcd0e 100644 --- a/embassy-usb-logger/README.md +++ b/embassy-usb-logger/README.md @@ -13,17 +13,3 @@ async fn logger_task(driver: Driver<'static, USB>) { embassy_usb_logger::run!(1024, log::LevelFilter::Info, driver); } ``` - -## Minimum supported Rust version (MSRV) - -Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-usb/README.md b/embassy-usb/README.md index a3d45b561..da656e8e9 100644 --- a/embassy-usb/README.md +++ b/embassy-usb/README.md @@ -23,22 +23,6 @@ with different values, compilation fails. Max amount of interfaces that can be created in one device. Default: 4. - ## Interoperability This crate can run on any executor. - -## Minimum supported Rust version (MSRV) - -This crate requires nightly Rust, due to using "async fn in trait" support. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. - From e0775fbc8ab1ecc83bce42fe6e11accf481bc9e1 Mon Sep 17 00:00:00 2001 From: Dario Nieuwenhuis Date: Thu, 11 Jan 2024 18:55:59 +0100 Subject: [PATCH 2/4] Flatten embassy-boot dir tree --- .github/ci/doc.sh | 8 ++++---- .github/ci/test.sh | 6 +++--- ci.sh | 8 ++++---- {embassy-boot/nrf => embassy-boot-nrf}/Cargo.toml | 10 +++++----- {embassy-boot/nrf => embassy-boot-nrf}/README.md | 0 {embassy-boot/boot => embassy-boot-nrf}/src/fmt.rs | 0 {embassy-boot/nrf => embassy-boot-nrf}/src/lib.rs | 0 {embassy-boot/rp => embassy-boot-rp}/Cargo.toml | 10 +++++----- {embassy-boot/rp => embassy-boot-rp}/README.md | 0 {embassy-boot/rp => embassy-boot-rp}/build.rs | 0 {embassy-boot/nrf => embassy-boot-rp}/src/fmt.rs | 0 {embassy-boot/rp => embassy-boot-rp}/src/lib.rs | 0 {embassy-boot/stm32 => embassy-boot-stm32}/Cargo.toml | 10 +++++----- {embassy-boot/stm32 => embassy-boot-stm32}/README.md | 0 {embassy-boot/stm32 => embassy-boot-stm32}/build.rs | 0 {embassy-boot/rp => embassy-boot-stm32}/src/fmt.rs | 0 {embassy-boot/stm32 => embassy-boot-stm32}/src/lib.rs | 0 embassy-boot/{boot => }/Cargo.toml | 8 ++++---- embassy-boot/{boot => }/README.md | 0 embassy-boot/{boot => }/src/boot_loader.rs | 0 .../{boot => }/src/digest_adapters/ed25519_dalek.rs | 0 embassy-boot/{boot => }/src/digest_adapters/mod.rs | 0 embassy-boot/{boot => }/src/digest_adapters/salty.rs | 0 embassy-boot/{boot => }/src/firmware_updater/asynch.rs | 0 .../{boot => }/src/firmware_updater/blocking.rs | 0 embassy-boot/{boot => }/src/firmware_updater/mod.rs | 0 embassy-boot/{stm32 => }/src/fmt.rs | 0 embassy-boot/{boot => }/src/lib.rs | 0 embassy-boot/{boot => }/src/mem_flash.rs | 0 embassy-boot/{boot => }/src/test_flash/asynch.rs | 0 embassy-boot/{boot => }/src/test_flash/blocking.rs | 0 embassy-boot/{boot => }/src/test_flash/mod.rs | 0 embassy-usb-dfu/Cargo.toml | 2 +- examples/boot/application/nrf/Cargo.toml | 4 ++-- examples/boot/application/rp/Cargo.toml | 2 +- examples/boot/application/stm32f3/Cargo.toml | 2 +- examples/boot/application/stm32f7/Cargo.toml | 2 +- examples/boot/application/stm32h7/Cargo.toml | 2 +- examples/boot/application/stm32l0/Cargo.toml | 2 +- examples/boot/application/stm32l1/Cargo.toml | 2 +- examples/boot/application/stm32l4/Cargo.toml | 2 +- examples/boot/application/stm32wb-dfu/Cargo.toml | 2 +- examples/boot/application/stm32wl/Cargo.toml | 2 +- examples/boot/bootloader/nrf/Cargo.toml | 2 +- examples/boot/bootloader/rp/Cargo.toml | 2 +- examples/boot/bootloader/stm32/Cargo.toml | 2 +- examples/boot/bootloader/stm32wb-dfu/Cargo.toml | 2 +- 47 files changed, 46 insertions(+), 46 deletions(-) rename {embassy-boot/nrf => embassy-boot-nrf}/Cargo.toml (76%) rename {embassy-boot/nrf => embassy-boot-nrf}/README.md (100%) rename {embassy-boot/boot => embassy-boot-nrf}/src/fmt.rs (100%) rename {embassy-boot/nrf => embassy-boot-nrf}/src/lib.rs (100%) rename {embassy-boot/rp => embassy-boot-rp}/Cargo.toml (83%) rename {embassy-boot/rp => embassy-boot-rp}/README.md (100%) rename {embassy-boot/rp => embassy-boot-rp}/build.rs (100%) rename {embassy-boot/nrf => embassy-boot-rp}/src/fmt.rs (100%) rename {embassy-boot/rp => embassy-boot-rp}/src/lib.rs (100%) rename {embassy-boot/stm32 => embassy-boot-stm32}/Cargo.toml (84%) rename {embassy-boot/stm32 => embassy-boot-stm32}/README.md (100%) rename {embassy-boot/stm32 => embassy-boot-stm32}/build.rs (100%) rename {embassy-boot/rp => embassy-boot-stm32}/src/fmt.rs (100%) rename {embassy-boot/stm32 => embassy-boot-stm32}/src/lib.rs (100%) rename embassy-boot/{boot => }/Cargo.toml (87%) rename embassy-boot/{boot => }/README.md (100%) rename embassy-boot/{boot => }/src/boot_loader.rs (100%) rename embassy-boot/{boot => }/src/digest_adapters/ed25519_dalek.rs (100%) rename embassy-boot/{boot => }/src/digest_adapters/mod.rs (100%) rename embassy-boot/{boot => }/src/digest_adapters/salty.rs (100%) rename embassy-boot/{boot => }/src/firmware_updater/asynch.rs (100%) rename embassy-boot/{boot => }/src/firmware_updater/blocking.rs (100%) rename embassy-boot/{boot => }/src/firmware_updater/mod.rs (100%) rename embassy-boot/{stm32 => }/src/fmt.rs (100%) rename embassy-boot/{boot => }/src/lib.rs (100%) rename embassy-boot/{boot => }/src/mem_flash.rs (100%) rename embassy-boot/{boot => }/src/test_flash/asynch.rs (100%) rename embassy-boot/{boot => }/src/test_flash/blocking.rs (100%) rename embassy-boot/{boot => }/src/test_flash/mod.rs (100%) diff --git a/.github/ci/doc.sh b/.github/ci/doc.sh index 0bbe7f690..aaccb8a67 100755 --- a/.github/ci/doc.sh +++ b/.github/ci/doc.sh @@ -16,10 +16,10 @@ mv rust-toolchain-nightly.toml rust-toolchain.toml # which makes rustup very sad rustc --version > /dev/null -docserver-builder -i ./embassy-boot/boot -o webroot/crates/embassy-boot/git.zup -docserver-builder -i ./embassy-boot/nrf -o webroot/crates/embassy-boot-nrf/git.zup -docserver-builder -i ./embassy-boot/rp -o webroot/crates/embassy-boot-rp/git.zup -docserver-builder -i ./embassy-boot/stm32 -o webroot/crates/embassy-boot-stm32/git.zup +docserver-builder -i ./embassy-boot -o webroot/crates/embassy-boot/git.zup +docserver-builder -i ./embassy-boot-nrf -o webroot/crates/embassy-boot-nrf/git.zup +docserver-builder -i ./embassy-boot-rp -o webroot/crates/embassy-boot-rp/git.zup +docserver-builder -i ./embassy-boot-stm32 -o webroot/crates/embassy-boot-stm32/git.zup docserver-builder -i ./embassy-embedded-hal -o webroot/crates/embassy-embedded-hal/git.zup docserver-builder -i ./embassy-executor -o webroot/crates/embassy-executor/git.zup docserver-builder -i ./embassy-futures -o webroot/crates/embassy-futures/git.zup diff --git a/.github/ci/test.sh b/.github/ci/test.sh index b6a5bcd56..8a58939f6 100755 --- a/.github/ci/test.sh +++ b/.github/ci/test.sh @@ -14,9 +14,9 @@ cargo test --manifest-path ./embassy-hal-internal/Cargo.toml cargo test --manifest-path ./embassy-time/Cargo.toml --features generic-queue,mock-driver cargo test --manifest-path ./embassy-time-driver/Cargo.toml -cargo test --manifest-path ./embassy-boot/boot/Cargo.toml -cargo test --manifest-path ./embassy-boot/boot/Cargo.toml --features ed25519-dalek -cargo test --manifest-path ./embassy-boot/boot/Cargo.toml --features ed25519-salty +cargo test --manifest-path ./embassy-boot/Cargo.toml +cargo test --manifest-path ./embassy-boot/Cargo.toml --features ed25519-dalek +cargo test --manifest-path ./embassy-boot/Cargo.toml --features ed25519-salty cargo test --manifest-path ./embassy-nrf/Cargo.toml --no-default-features --features nrf52840,time-driver-rtc1,gpiote diff --git a/ci.sh b/ci.sh index ac0457679..7805c8ad1 100755 --- a/ci.sh +++ b/ci.sh @@ -136,10 +136,10 @@ cargo batch \ --- build --release --manifest-path cyw43/Cargo.toml --target thumbv6m-none-eabi --features 'defmt,firmware-logs' \ --- build --release --manifest-path cyw43-pio/Cargo.toml --target thumbv6m-none-eabi --features '' \ --- build --release --manifest-path cyw43-pio/Cargo.toml --target thumbv6m-none-eabi --features 'overclock' \ - --- build --release --manifest-path embassy-boot/nrf/Cargo.toml --target thumbv7em-none-eabi --features embassy-nrf/nrf52840 \ - --- build --release --manifest-path embassy-boot/nrf/Cargo.toml --target thumbv8m.main-none-eabihf --features embassy-nrf/nrf9160-ns \ - --- build --release --manifest-path embassy-boot/rp/Cargo.toml --target thumbv6m-none-eabi \ - --- build --release --manifest-path embassy-boot/stm32/Cargo.toml --target thumbv7em-none-eabi --features embassy-stm32/stm32wl55jc-cm4 \ + --- build --release --manifest-path embassy-boot-nrf/Cargo.toml --target thumbv7em-none-eabi --features embassy-nrf/nrf52840 \ + --- build --release --manifest-path embassy-boot-nrf/Cargo.toml --target thumbv8m.main-none-eabihf --features embassy-nrf/nrf9160-ns \ + --- build --release --manifest-path embassy-boot-rp/Cargo.toml --target thumbv6m-none-eabi \ + --- build --release --manifest-path embassy-boot-stm32/Cargo.toml --target thumbv7em-none-eabi --features embassy-stm32/stm32wl55jc-cm4 \ --- build --release --manifest-path docs/modules/ROOT/examples/basic/Cargo.toml --target thumbv7em-none-eabi \ --- build --release --manifest-path docs/modules/ROOT/examples/layer-by-layer/blinky-pac/Cargo.toml --target thumbv7em-none-eabi \ --- build --release --manifest-path docs/modules/ROOT/examples/layer-by-layer/blinky-hal/Cargo.toml --target thumbv7em-none-eabi \ diff --git a/embassy-boot/nrf/Cargo.toml b/embassy-boot-nrf/Cargo.toml similarity index 76% rename from embassy-boot/nrf/Cargo.toml rename to embassy-boot-nrf/Cargo.toml index 9f74fb126..7fc53648a 100644 --- a/embassy-boot/nrf/Cargo.toml +++ b/embassy-boot-nrf/Cargo.toml @@ -12,8 +12,8 @@ categories = [ ] [package.metadata.embassy_docs] -src_base = "https://github.com/embassy-rs/embassy/blob/embassy-boot-nrf-v$VERSION/embassy-boot/nrf/src/" -src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-boot/nrf/src/" +src_base = "https://github.com/embassy-rs/embassy/blob/embassy-boot-nrf-v$VERSION/embassy-boot-nrf/src/" +src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-boot-nrf/src/" features = ["embassy-nrf/nrf52840"] target = "thumbv7em-none-eabi" @@ -22,9 +22,9 @@ target = "thumbv7em-none-eabi" [dependencies] defmt = { version = "0.3", optional = true } -embassy-sync = { version = "0.5.0", path = "../../embassy-sync" } -embassy-nrf = { path = "../../embassy-nrf" } -embassy-boot = { path = "../boot", default-features = false } +embassy-sync = { version = "0.5.0", path = "../embassy-sync" } +embassy-nrf = { version = "0.1.0", path = "../embassy-nrf", default-features = false } +embassy-boot = { version = "0.1.0", path = "../embassy-boot" } cortex-m = { version = "0.7.6" } cortex-m-rt = { version = "0.7" } embedded-storage = "0.3.1" diff --git a/embassy-boot/nrf/README.md b/embassy-boot-nrf/README.md similarity index 100% rename from embassy-boot/nrf/README.md rename to embassy-boot-nrf/README.md diff --git a/embassy-boot/boot/src/fmt.rs b/embassy-boot-nrf/src/fmt.rs similarity index 100% rename from embassy-boot/boot/src/fmt.rs rename to embassy-boot-nrf/src/fmt.rs diff --git a/embassy-boot/nrf/src/lib.rs b/embassy-boot-nrf/src/lib.rs similarity index 100% rename from embassy-boot/nrf/src/lib.rs rename to embassy-boot-nrf/src/lib.rs diff --git a/embassy-boot/rp/Cargo.toml b/embassy-boot-rp/Cargo.toml similarity index 83% rename from embassy-boot/rp/Cargo.toml rename to embassy-boot-rp/Cargo.toml index 90bab0996..dacb27747 100644 --- a/embassy-boot/rp/Cargo.toml +++ b/embassy-boot-rp/Cargo.toml @@ -13,7 +13,7 @@ categories = [ [package.metadata.embassy_docs] src_base = "https://github.com/embassy-rs/embassy/blob/embassy-boot-rp-v$VERSION/src/" -src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-boot/rp/src/" +src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-boot-rp/src/" target = "thumbv6m-none-eabi" [lib] @@ -23,10 +23,10 @@ defmt = { version = "0.3", optional = true } defmt-rtt = { version = "0.4", optional = true } log = { version = "0.4", optional = true } -embassy-sync = { version = "0.5.0", path = "../../embassy-sync" } -embassy-rp = { path = "../../embassy-rp", default-features = false } -embassy-boot = { path = "../boot", default-features = false } -embassy-time = { path = "../../embassy-time" } +embassy-sync = { version = "0.5.0", path = "../embassy-sync" } +embassy-rp = { version = "0.1.0", path = "../embassy-rp", default-features = false } +embassy-boot = { version = "0.1.0", path = "../embassy-boot" } +embassy-time = { version = "0.2.0", path = "../embassy-time" } cortex-m = { version = "0.7.6" } cortex-m-rt = { version = "0.7" } diff --git a/embassy-boot/rp/README.md b/embassy-boot-rp/README.md similarity index 100% rename from embassy-boot/rp/README.md rename to embassy-boot-rp/README.md diff --git a/embassy-boot/rp/build.rs b/embassy-boot-rp/build.rs similarity index 100% rename from embassy-boot/rp/build.rs rename to embassy-boot-rp/build.rs diff --git a/embassy-boot/nrf/src/fmt.rs b/embassy-boot-rp/src/fmt.rs similarity index 100% rename from embassy-boot/nrf/src/fmt.rs rename to embassy-boot-rp/src/fmt.rs diff --git a/embassy-boot/rp/src/lib.rs b/embassy-boot-rp/src/lib.rs similarity index 100% rename from embassy-boot/rp/src/lib.rs rename to embassy-boot-rp/src/lib.rs diff --git a/embassy-boot/stm32/Cargo.toml b/embassy-boot-stm32/Cargo.toml similarity index 84% rename from embassy-boot/stm32/Cargo.toml rename to embassy-boot-stm32/Cargo.toml index 70919b76d..f4e31bae8 100644 --- a/embassy-boot/stm32/Cargo.toml +++ b/embassy-boot-stm32/Cargo.toml @@ -12,8 +12,8 @@ categories = [ ] [package.metadata.embassy_docs] -src_base = "https://github.com/embassy-rs/embassy/blob/embassy-boot-nrf-v$VERSION/embassy-boot/stm32/src/" -src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-boot/stm32/src/" +src_base = "https://github.com/embassy-rs/embassy/blob/embassy-boot-nrf-v$VERSION/embassy-boot-stm32/src/" +src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-boot-stm32/src/" features = ["embassy-stm32/stm32f429zi"] target = "thumbv7em-none-eabi" @@ -24,9 +24,9 @@ defmt = { version = "0.3", optional = true } defmt-rtt = { version = "0.4", optional = true } log = { version = "0.4", optional = true } -embassy-sync = { version = "0.5.0", path = "../../embassy-sync" } -embassy-stm32 = { path = "../../embassy-stm32", default-features = false } -embassy-boot = { path = "../boot", default-features = false } +embassy-sync = { version = "0.5.0", path = "../embassy-sync" } +embassy-stm32 = { version = "0.1.0", path = "../embassy-stm32", default-features = false } +embassy-boot = { version = "0.1.0", path = "../embassy-boot" } cortex-m = { version = "0.7.6" } cortex-m-rt = { version = "0.7" } embedded-storage = "0.3.1" diff --git a/embassy-boot/stm32/README.md b/embassy-boot-stm32/README.md similarity index 100% rename from embassy-boot/stm32/README.md rename to embassy-boot-stm32/README.md diff --git a/embassy-boot/stm32/build.rs b/embassy-boot-stm32/build.rs similarity index 100% rename from embassy-boot/stm32/build.rs rename to embassy-boot-stm32/build.rs diff --git a/embassy-boot/rp/src/fmt.rs b/embassy-boot-stm32/src/fmt.rs similarity index 100% rename from embassy-boot/rp/src/fmt.rs rename to embassy-boot-stm32/src/fmt.rs diff --git a/embassy-boot/stm32/src/lib.rs b/embassy-boot-stm32/src/lib.rs similarity index 100% rename from embassy-boot/stm32/src/lib.rs rename to embassy-boot-stm32/src/lib.rs diff --git a/embassy-boot/boot/Cargo.toml b/embassy-boot/Cargo.toml similarity index 87% rename from embassy-boot/boot/Cargo.toml rename to embassy-boot/Cargo.toml index 3c84ffcd3..a70849018 100644 --- a/embassy-boot/boot/Cargo.toml +++ b/embassy-boot/Cargo.toml @@ -12,8 +12,8 @@ categories = [ ] [package.metadata.embassy_docs] -src_base = "https://github.com/embassy-rs/embassy/blob/embassy-boot-v$VERSION/embassy-boot/boot/src/" -src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-boot/boot/src/" +src_base = "https://github.com/embassy-rs/embassy/blob/embassy-boot-v$VERSION/embassy-boot/src/" +src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-boot/src/" target = "thumbv7em-none-eabi" features = ["defmt"] @@ -27,8 +27,8 @@ defmt = { version = "0.3", optional = true } digest = "0.10" log = { version = "0.4", optional = true } ed25519-dalek = { version = "2", default_features = false, features = ["digest"], optional = true } -embassy-embedded-hal = { version = "0.1.0", path = "../../embassy-embedded-hal" } -embassy-sync = { version = "0.5.0", path = "../../embassy-sync" } +embassy-embedded-hal = { version = "0.1.0", path = "../embassy-embedded-hal" } +embassy-sync = { version = "0.5.0", path = "../embassy-sync" } embedded-storage = "0.3.1" embedded-storage-async = { version = "0.4.1" } salty = { version = "0.3", optional = true } diff --git a/embassy-boot/boot/README.md b/embassy-boot/README.md similarity index 100% rename from embassy-boot/boot/README.md rename to embassy-boot/README.md diff --git a/embassy-boot/boot/src/boot_loader.rs b/embassy-boot/src/boot_loader.rs similarity index 100% rename from embassy-boot/boot/src/boot_loader.rs rename to embassy-boot/src/boot_loader.rs diff --git a/embassy-boot/boot/src/digest_adapters/ed25519_dalek.rs b/embassy-boot/src/digest_adapters/ed25519_dalek.rs similarity index 100% rename from embassy-boot/boot/src/digest_adapters/ed25519_dalek.rs rename to embassy-boot/src/digest_adapters/ed25519_dalek.rs diff --git a/embassy-boot/boot/src/digest_adapters/mod.rs b/embassy-boot/src/digest_adapters/mod.rs similarity index 100% rename from embassy-boot/boot/src/digest_adapters/mod.rs rename to embassy-boot/src/digest_adapters/mod.rs diff --git a/embassy-boot/boot/src/digest_adapters/salty.rs b/embassy-boot/src/digest_adapters/salty.rs similarity index 100% rename from embassy-boot/boot/src/digest_adapters/salty.rs rename to embassy-boot/src/digest_adapters/salty.rs diff --git a/embassy-boot/boot/src/firmware_updater/asynch.rs b/embassy-boot/src/firmware_updater/asynch.rs similarity index 100% rename from embassy-boot/boot/src/firmware_updater/asynch.rs rename to embassy-boot/src/firmware_updater/asynch.rs diff --git a/embassy-boot/boot/src/firmware_updater/blocking.rs b/embassy-boot/src/firmware_updater/blocking.rs similarity index 100% rename from embassy-boot/boot/src/firmware_updater/blocking.rs rename to embassy-boot/src/firmware_updater/blocking.rs diff --git a/embassy-boot/boot/src/firmware_updater/mod.rs b/embassy-boot/src/firmware_updater/mod.rs similarity index 100% rename from embassy-boot/boot/src/firmware_updater/mod.rs rename to embassy-boot/src/firmware_updater/mod.rs diff --git a/embassy-boot/stm32/src/fmt.rs b/embassy-boot/src/fmt.rs similarity index 100% rename from embassy-boot/stm32/src/fmt.rs rename to embassy-boot/src/fmt.rs diff --git a/embassy-boot/boot/src/lib.rs b/embassy-boot/src/lib.rs similarity index 100% rename from embassy-boot/boot/src/lib.rs rename to embassy-boot/src/lib.rs diff --git a/embassy-boot/boot/src/mem_flash.rs b/embassy-boot/src/mem_flash.rs similarity index 100% rename from embassy-boot/boot/src/mem_flash.rs rename to embassy-boot/src/mem_flash.rs diff --git a/embassy-boot/boot/src/test_flash/asynch.rs b/embassy-boot/src/test_flash/asynch.rs similarity index 100% rename from embassy-boot/boot/src/test_flash/asynch.rs rename to embassy-boot/src/test_flash/asynch.rs diff --git a/embassy-boot/boot/src/test_flash/blocking.rs b/embassy-boot/src/test_flash/blocking.rs similarity index 100% rename from embassy-boot/boot/src/test_flash/blocking.rs rename to embassy-boot/src/test_flash/blocking.rs diff --git a/embassy-boot/boot/src/test_flash/mod.rs b/embassy-boot/src/test_flash/mod.rs similarity index 100% rename from embassy-boot/boot/src/test_flash/mod.rs rename to embassy-boot/src/test_flash/mod.rs diff --git a/embassy-usb-dfu/Cargo.toml b/embassy-usb-dfu/Cargo.toml index ee110ee87..2d8895123 100644 --- a/embassy-usb-dfu/Cargo.toml +++ b/embassy-usb-dfu/Cargo.toml @@ -17,7 +17,7 @@ categories = [ bitflags = "2.4.1" cortex-m = { version = "0.7.7", features = ["inline-asm"], optional = true } defmt = { version = "0.3.5", optional = true } -embassy-boot = { version = "0.1.1", path = "../embassy-boot/boot" } +embassy-boot = { version = "0.1.1", path = "../embassy-boot" } # embassy-embedded-hal = { version = "0.1.0", path = "../embassy-embedded-hal" } embassy-futures = { version = "0.1.1", path = "../embassy-futures" } embassy-sync = { version = "0.5.0", path = "../embassy-sync" } diff --git a/examples/boot/application/nrf/Cargo.toml b/examples/boot/application/nrf/Cargo.toml index eba9a0579..7b62d9a20 100644 --- a/examples/boot/application/nrf/Cargo.toml +++ b/examples/boot/application/nrf/Cargo.toml @@ -9,8 +9,8 @@ embassy-sync = { version = "0.5.0", path = "../../../../embassy-sync" } embassy-executor = { version = "0.4.0", path = "../../../../embassy-executor", features = ["task-arena-size-16384", "arch-cortex-m", "executor-thread", "integrated-timers", "arch-cortex-m", "executor-thread"] } embassy-time = { version = "0.2", path = "../../../../embassy-time", features = [] } embassy-nrf = { version = "0.1.0", path = "../../../../embassy-nrf", features = ["time-driver-rtc1", "gpiote", ] } -embassy-boot = { version = "0.1.0", path = "../../../../embassy-boot/boot", features = [] } -embassy-boot-nrf = { version = "0.1.0", path = "../../../../embassy-boot/nrf", features = [] } +embassy-boot = { version = "0.1.0", path = "../../../../embassy-boot", features = [] } +embassy-boot-nrf = { version = "0.1.0", path = "../../../../embassy-boot-nrf", features = [] } embassy-embedded-hal = { version = "0.1.0", path = "../../../../embassy-embedded-hal" } defmt = { version = "0.3", optional = true } diff --git a/examples/boot/application/rp/Cargo.toml b/examples/boot/application/rp/Cargo.toml index 38c9f8cff..ccaa9f8ef 100644 --- a/examples/boot/application/rp/Cargo.toml +++ b/examples/boot/application/rp/Cargo.toml @@ -9,7 +9,7 @@ embassy-sync = { version = "0.5.0", path = "../../../../embassy-sync" } embassy-executor = { version = "0.4.0", path = "../../../../embassy-executor", features = ["task-arena-size-16384", "arch-cortex-m", "executor-thread", "integrated-timers", "arch-cortex-m", "executor-thread"] } embassy-time = { version = "0.2", path = "../../../../embassy-time", features = [] } embassy-rp = { version = "0.1.0", path = "../../../../embassy-rp", features = ["time-driver", ] } -embassy-boot-rp = { version = "0.1.0", path = "../../../../embassy-boot/rp", features = [] } +embassy-boot-rp = { version = "0.1.0", path = "../../../../embassy-boot-rp", features = [] } embassy-embedded-hal = { version = "0.1.0", path = "../../../../embassy-embedded-hal" } defmt = "0.3" diff --git a/examples/boot/application/stm32f3/Cargo.toml b/examples/boot/application/stm32f3/Cargo.toml index 9c0aeb463..f4bc285bf 100644 --- a/examples/boot/application/stm32f3/Cargo.toml +++ b/examples/boot/application/stm32f3/Cargo.toml @@ -9,7 +9,7 @@ embassy-sync = { version = "0.5.0", path = "../../../../embassy-sync" } embassy-executor = { version = "0.4.0", path = "../../../../embassy-executor", features = ["task-arena-size-8192", "arch-cortex-m", "executor-thread", "integrated-timers"] } embassy-time = { version = "0.2", path = "../../../../embassy-time", features = [ "tick-hz-32_768"] } embassy-stm32 = { version = "0.1.0", path = "../../../../embassy-stm32", features = ["stm32f303re", "time-driver-any", "exti"] } -embassy-boot-stm32 = { version = "0.1.0", path = "../../../../embassy-boot/stm32" } +embassy-boot-stm32 = { version = "0.1.0", path = "../../../../embassy-boot-stm32" } embassy-embedded-hal = { version = "0.1.0", path = "../../../../embassy-embedded-hal" } defmt = { version = "0.3", optional = true } diff --git a/examples/boot/application/stm32f7/Cargo.toml b/examples/boot/application/stm32f7/Cargo.toml index e81ff618e..575220ade 100644 --- a/examples/boot/application/stm32f7/Cargo.toml +++ b/examples/boot/application/stm32f7/Cargo.toml @@ -9,7 +9,7 @@ embassy-sync = { version = "0.5.0", path = "../../../../embassy-sync" } embassy-executor = { version = "0.4.0", path = "../../../../embassy-executor", features = ["task-arena-size-8192", "arch-cortex-m", "executor-thread", "integrated-timers"] } embassy-time = { version = "0.2", path = "../../../../embassy-time", features = [ "tick-hz-32_768"] } embassy-stm32 = { version = "0.1.0", path = "../../../../embassy-stm32", features = ["stm32f767zi", "time-driver-any", "exti"] } -embassy-boot-stm32 = { version = "0.1.0", path = "../../../../embassy-boot/stm32", features = [] } +embassy-boot-stm32 = { version = "0.1.0", path = "../../../../embassy-boot-stm32", features = [] } embassy-embedded-hal = { version = "0.1.0", path = "../../../../embassy-embedded-hal" } defmt = { version = "0.3", optional = true } diff --git a/examples/boot/application/stm32h7/Cargo.toml b/examples/boot/application/stm32h7/Cargo.toml index f75ffc8e6..12c34565a 100644 --- a/examples/boot/application/stm32h7/Cargo.toml +++ b/examples/boot/application/stm32h7/Cargo.toml @@ -9,7 +9,7 @@ embassy-sync = { version = "0.5.0", path = "../../../../embassy-sync" } embassy-executor = { version = "0.4.0", path = "../../../../embassy-executor", features = ["task-arena-size-8192", "arch-cortex-m", "executor-thread", "integrated-timers"] } embassy-time = { version = "0.2", path = "../../../../embassy-time", features = [ "tick-hz-32_768"] } embassy-stm32 = { version = "0.1.0", path = "../../../../embassy-stm32", features = ["stm32h743zi", "time-driver-any", "exti"] } -embassy-boot-stm32 = { version = "0.1.0", path = "../../../../embassy-boot/stm32", features = [] } +embassy-boot-stm32 = { version = "0.1.0", path = "../../../../embassy-boot-stm32", features = [] } embassy-embedded-hal = { version = "0.1.0", path = "../../../../embassy-embedded-hal" } defmt = { version = "0.3", optional = true } diff --git a/examples/boot/application/stm32l0/Cargo.toml b/examples/boot/application/stm32l0/Cargo.toml index f58bd9557..9f705dc26 100644 --- a/examples/boot/application/stm32l0/Cargo.toml +++ b/examples/boot/application/stm32l0/Cargo.toml @@ -9,7 +9,7 @@ embassy-sync = { version = "0.5.0", path = "../../../../embassy-sync" } embassy-executor = { version = "0.4.0", path = "../../../../embassy-executor", features = ["task-arena-size-8192", "arch-cortex-m", "executor-thread", "integrated-timers"] } embassy-time = { version = "0.2", path = "../../../../embassy-time", features = [ "tick-hz-32_768"] } embassy-stm32 = { version = "0.1.0", path = "../../../../embassy-stm32", features = ["stm32l072cz", "time-driver-any", "exti", "memory-x"] } -embassy-boot-stm32 = { version = "0.1.0", path = "../../../../embassy-boot/stm32", features = [] } +embassy-boot-stm32 = { version = "0.1.0", path = "../../../../embassy-boot-stm32", features = [] } embassy-embedded-hal = { version = "0.1.0", path = "../../../../embassy-embedded-hal" } defmt = { version = "0.3", optional = true } diff --git a/examples/boot/application/stm32l1/Cargo.toml b/examples/boot/application/stm32l1/Cargo.toml index 887126f9d..7ba5f143b 100644 --- a/examples/boot/application/stm32l1/Cargo.toml +++ b/examples/boot/application/stm32l1/Cargo.toml @@ -9,7 +9,7 @@ embassy-sync = { version = "0.5.0", path = "../../../../embassy-sync" } embassy-executor = { version = "0.4.0", path = "../../../../embassy-executor", features = ["task-arena-size-8192", "arch-cortex-m", "executor-thread", "integrated-timers"] } embassy-time = { version = "0.2", path = "../../../../embassy-time", features = [ "tick-hz-32_768"] } embassy-stm32 = { version = "0.1.0", path = "../../../../embassy-stm32", features = ["stm32l151cb-a", "time-driver-any", "exti"] } -embassy-boot-stm32 = { version = "0.1.0", path = "../../../../embassy-boot/stm32", features = [] } +embassy-boot-stm32 = { version = "0.1.0", path = "../../../../embassy-boot-stm32", features = [] } embassy-embedded-hal = { version = "0.1.0", path = "../../../../embassy-embedded-hal" } defmt = { version = "0.3", optional = true } diff --git a/examples/boot/application/stm32l4/Cargo.toml b/examples/boot/application/stm32l4/Cargo.toml index d5fabac82..08cb87e0b 100644 --- a/examples/boot/application/stm32l4/Cargo.toml +++ b/examples/boot/application/stm32l4/Cargo.toml @@ -9,7 +9,7 @@ embassy-sync = { version = "0.5.0", path = "../../../../embassy-sync" } embassy-executor = { version = "0.4.0", path = "../../../../embassy-executor", features = ["task-arena-size-8192", "arch-cortex-m", "executor-thread", "integrated-timers"] } embassy-time = { version = "0.2", path = "../../../../embassy-time", features = [ "tick-hz-32_768"] } embassy-stm32 = { version = "0.1.0", path = "../../../../embassy-stm32", features = ["stm32l475vg", "time-driver-any", "exti"] } -embassy-boot-stm32 = { version = "0.1.0", path = "../../../../embassy-boot/stm32", features = [] } +embassy-boot-stm32 = { version = "0.1.0", path = "../../../../embassy-boot-stm32", features = [] } embassy-embedded-hal = { version = "0.1.0", path = "../../../../embassy-embedded-hal" } defmt = { version = "0.3", optional = true } diff --git a/examples/boot/application/stm32wb-dfu/Cargo.toml b/examples/boot/application/stm32wb-dfu/Cargo.toml index 394546b75..58bba66d7 100644 --- a/examples/boot/application/stm32wb-dfu/Cargo.toml +++ b/examples/boot/application/stm32wb-dfu/Cargo.toml @@ -9,7 +9,7 @@ embassy-sync = { version = "0.5.0", path = "../../../../embassy-sync" } embassy-executor = { version = "0.4.0", path = "../../../../embassy-executor", features = ["task-arena-size-8192", "arch-cortex-m", "executor-thread", "integrated-timers"] } embassy-time = { version = "0.2", path = "../../../../embassy-time", features = [ "tick-hz-32_768"] } embassy-stm32 = { version = "0.1.0", path = "../../../../embassy-stm32", features = ["stm32wb55rg", "time-driver-any", "exti"] } -embassy-boot-stm32 = { version = "0.1.0", path = "../../../../embassy-boot/stm32", features = [] } +embassy-boot-stm32 = { version = "0.1.0", path = "../../../../embassy-boot-stm32", features = [] } embassy-embedded-hal = { version = "0.1.0", path = "../../../../embassy-embedded-hal" } embassy-usb = { version = "0.1.0", path = "../../../../embassy-usb" } embassy-usb-dfu = { version = "0.1.0", path = "../../../../embassy-usb-dfu", features = ["application", "cortex-m"] } diff --git a/examples/boot/application/stm32wl/Cargo.toml b/examples/boot/application/stm32wl/Cargo.toml index 6c4dc7975..7ce560de2 100644 --- a/examples/boot/application/stm32wl/Cargo.toml +++ b/examples/boot/application/stm32wl/Cargo.toml @@ -9,7 +9,7 @@ embassy-sync = { version = "0.5.0", path = "../../../../embassy-sync" } embassy-executor = { version = "0.4.0", path = "../../../../embassy-executor", features = ["task-arena-size-8192", "arch-cortex-m", "executor-thread", "integrated-timers"] } embassy-time = { version = "0.2", path = "../../../../embassy-time", features = [ "tick-hz-32_768"] } embassy-stm32 = { version = "0.1.0", path = "../../../../embassy-stm32", features = ["stm32wl55jc-cm4", "time-driver-any", "exti"] } -embassy-boot-stm32 = { version = "0.1.0", path = "../../../../embassy-boot/stm32", features = [] } +embassy-boot-stm32 = { version = "0.1.0", path = "../../../../embassy-boot-stm32", features = [] } embassy-embedded-hal = { version = "0.1.0", path = "../../../../embassy-embedded-hal" } defmt = { version = "0.3", optional = true } diff --git a/examples/boot/bootloader/nrf/Cargo.toml b/examples/boot/bootloader/nrf/Cargo.toml index a7273175f..3e41d1479 100644 --- a/examples/boot/bootloader/nrf/Cargo.toml +++ b/examples/boot/bootloader/nrf/Cargo.toml @@ -10,7 +10,7 @@ defmt = { version = "0.3", optional = true } defmt-rtt = { version = "0.4", optional = true } embassy-nrf = { path = "../../../../embassy-nrf", features = [] } -embassy-boot-nrf = { path = "../../../../embassy-boot/nrf" } +embassy-boot-nrf = { path = "../../../../embassy-boot-nrf" } cortex-m = { version = "0.7.6", features = ["inline-asm", "critical-section-single-core"] } embassy-sync = { version = "0.5.0", path = "../../../../embassy-sync" } cortex-m-rt = { version = "0.7" } diff --git a/examples/boot/bootloader/rp/Cargo.toml b/examples/boot/bootloader/rp/Cargo.toml index 5bc61e9ec..3cf61a002 100644 --- a/examples/boot/bootloader/rp/Cargo.toml +++ b/examples/boot/bootloader/rp/Cargo.toml @@ -10,7 +10,7 @@ defmt = { version = "0.3", optional = true } defmt-rtt = { version = "0.4", optional = true } embassy-rp = { path = "../../../../embassy-rp", features = [] } -embassy-boot-rp = { path = "../../../../embassy-boot/rp" } +embassy-boot-rp = { path = "../../../../embassy-boot-rp" } embassy-sync = { version = "0.5.0", path = "../../../../embassy-sync" } embassy-time = { path = "../../../../embassy-time", features = [] } diff --git a/examples/boot/bootloader/stm32/Cargo.toml b/examples/boot/bootloader/stm32/Cargo.toml index 2d88b0f78..74c01b0f4 100644 --- a/examples/boot/bootloader/stm32/Cargo.toml +++ b/examples/boot/bootloader/stm32/Cargo.toml @@ -10,7 +10,7 @@ defmt = { version = "0.3", optional = true } defmt-rtt = { version = "0.4", optional = true } embassy-stm32 = { path = "../../../../embassy-stm32", features = [] } -embassy-boot-stm32 = { path = "../../../../embassy-boot/stm32" } +embassy-boot-stm32 = { path = "../../../../embassy-boot-stm32" } cortex-m = { version = "0.7.6", features = ["inline-asm", "critical-section-single-core"] } embassy-sync = { version = "0.5.0", path = "../../../../embassy-sync" } cortex-m-rt = { version = "0.7" } diff --git a/examples/boot/bootloader/stm32wb-dfu/Cargo.toml b/examples/boot/bootloader/stm32wb-dfu/Cargo.toml index ada073970..96635afa2 100644 --- a/examples/boot/bootloader/stm32wb-dfu/Cargo.toml +++ b/examples/boot/bootloader/stm32wb-dfu/Cargo.toml @@ -10,7 +10,7 @@ defmt = { version = "0.3", optional = true } defmt-rtt = { version = "0.4", optional = true } embassy-stm32 = { path = "../../../../embassy-stm32", features = ["stm32wb55rg"] } -embassy-boot-stm32 = { path = "../../../../embassy-boot/stm32" } +embassy-boot-stm32 = { path = "../../../../embassy-boot-stm32" } cortex-m = { version = "0.7.6", features = ["inline-asm", "critical-section-single-core"] } embassy-sync = { version = "0.5.0", path = "../../../../embassy-sync" } cortex-m-rt = { version = "0.7" } From ddacbf68aff53447bdfac7db2380a9f0aaaf0b83 Mon Sep 17 00:00:00 2001 From: Dario Nieuwenhuis Date: Thu, 11 Jan 2024 18:56:17 +0100 Subject: [PATCH 3/4] net-esp-hosted: fix readme. --- embassy-net-esp-hosted/README.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/embassy-net-esp-hosted/README.md b/embassy-net-esp-hosted/README.md index f6c216835..524231e6c 100644 --- a/embassy-net-esp-hosted/README.md +++ b/embassy-net-esp-hosted/README.md @@ -1,14 +1,9 @@ # ESP-Hosted `embassy-net` integration -[`embassy-net`](https://crates.io/crates/embassy-net) integration for Espressif SoCs running the the ESP-Hosted stack. +[`embassy-net`](https://crates.io/crates/embassy-net) integration for Espressif SoCs running the the [ESP-Hosted](https://github.com/espressif/esp-hosted) stack. See [`examples`](https://github.com/embassy-rs/embassy/tree/main/examples/nrf52840) directory for usage examples with the nRF52840. -## Supported chips - -- W5500 -- W5100S - ## Interoperability This crate can run on any executor. From 0af44292a0862b1c115def1ed1a48e29daae241c Mon Sep 17 00:00:00 2001 From: Dario Nieuwenhuis Date: Thu, 11 Jan 2024 19:10:56 +0100 Subject: [PATCH 4/4] usb: add readme. --- embassy-usb/README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/embassy-usb/README.md b/embassy-usb/README.md index da656e8e9..7411fcf52 100644 --- a/embassy-usb/README.md +++ b/embassy-usb/README.md @@ -1,6 +1,28 @@ # embassy-usb -TODO crate description +Async USB device stack for embedded devices in Rust. + +## Features + +- Native async. +- Fully lock-free: endpoints are separate objects that can be used independently without needing a central mutex. If the driver supports it, they can even be used from different priority levels. +- Suspend/resume, remote wakeup. +- USB composite devices. +- Ergonomic descriptor builder. +- Ready-to-use implementations for a few USB classes (note you can still implement any class yourself oustide the crate). + - Serial ports (CDC ACM) + - Ethernet (CDC NCM) + - Human Interface Devices (HID) + - MIDI + +## Adding support for new hardware + +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. + +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 +trait has not had breaking changes. ## Configuration