From 9ddf8b08e448caca3825fc47aa737247323d8725 Mon Sep 17 00:00:00 2001 From: Ulf Lilleengen Date: Tue, 19 Dec 2023 16:33:05 +0100 Subject: [PATCH] docs: document usb-logger and usb-dfu --- embassy-usb-dfu/README.md | 20 +++++++++++++++++++ embassy-usb-dfu/src/application.rs | 1 + embassy-usb-dfu/src/consts.rs | 12 ++++++++--- embassy-usb-dfu/src/{bootloader.rs => dfu.rs} | 1 + embassy-usb-dfu/src/lib.rs | 11 +++++++--- embassy-usb-logger/README.md | 14 +++++++++++++ 6 files changed, 53 insertions(+), 6 deletions(-) create mode 100644 embassy-usb-dfu/README.md rename embassy-usb-dfu/src/{bootloader.rs => dfu.rs} (99%) diff --git a/embassy-usb-dfu/README.md b/embassy-usb-dfu/README.md new file mode 100644 index 00000000..d8bc19bf --- /dev/null +++ b/embassy-usb-dfu/README.md @@ -0,0 +1,20 @@ +# embassy-usb-dfu + +An implementation of the USB DFU 1.1 protocol using embassy-boot. It has 2 components depending on which feature is enabled by the user. + +* 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-dfu/src/application.rs b/embassy-usb-dfu/src/application.rs index 75689db2..f0d7626f 100644 --- a/embassy-usb-dfu/src/application.rs +++ b/embassy-usb-dfu/src/application.rs @@ -24,6 +24,7 @@ pub struct Control<'d, STATE: NorFlash, RST: Reset> { } impl<'d, STATE: NorFlash, RST: Reset> Control<'d, STATE, RST> { + /// Create a new DFU instance to expose a DFU interface. pub fn new(firmware_state: BlockingFirmwareState<'d, STATE>, attrs: DfuAttributes) -> Self { Control { firmware_state, diff --git a/embassy-usb-dfu/src/consts.rs b/embassy-usb-dfu/src/consts.rs index b359a107..f8a056e5 100644 --- a/embassy-usb-dfu/src/consts.rs +++ b/embassy-usb-dfu/src/consts.rs @@ -1,3 +1,4 @@ +//! USB DFU constants. pub(crate) const USB_CLASS_APPN_SPEC: u8 = 0xFE; pub(crate) const APPN_SPEC_SUBCLASS_DFU: u8 = 0x01; #[allow(unused)] @@ -18,10 +19,15 @@ defmt::bitflags! { #[cfg(not(feature = "defmt"))] bitflags::bitflags! { + /// Attributes supported by the DFU controller. pub struct DfuAttributes: u8 { + /// Generate WillDetache sequence on bus. const WILL_DETACH = 0b0000_1000; + /// Device can communicate during manifestation phase. const MANIFESTATION_TOLERANT = 0b0000_0100; + /// Capable of upload. const CAN_UPLOAD = 0b0000_0010; + /// Capable of download. const CAN_DOWNLOAD = 0b0000_0001; } } @@ -29,7 +35,7 @@ bitflags::bitflags! { #[derive(Copy, Clone, PartialEq, Eq)] #[repr(u8)] #[allow(unused)] -pub enum State { +pub(crate) enum State { AppIdle = 0, AppDetach = 1, DfuIdle = 2, @@ -46,7 +52,7 @@ pub enum State { #[derive(Copy, Clone, PartialEq, Eq)] #[repr(u8)] #[allow(unused)] -pub enum Status { +pub(crate) enum Status { Ok = 0x00, ErrTarget = 0x01, ErrFile = 0x02, @@ -67,7 +73,7 @@ pub enum Status { #[derive(Copy, Clone, PartialEq, Eq)] #[repr(u8)] -pub enum Request { +pub(crate) enum Request { Detach = 0, Dnload = 1, Upload = 2, diff --git a/embassy-usb-dfu/src/bootloader.rs b/embassy-usb-dfu/src/dfu.rs similarity index 99% rename from embassy-usb-dfu/src/bootloader.rs rename to embassy-usb-dfu/src/dfu.rs index d41e6280..e99aa70c 100644 --- a/embassy-usb-dfu/src/bootloader.rs +++ b/embassy-usb-dfu/src/dfu.rs @@ -23,6 +23,7 @@ pub struct Control<'d, DFU: NorFlash, STATE: NorFlash, RST: Reset, const BLOCK_S } impl<'d, DFU: NorFlash, STATE: NorFlash, RST: Reset, const BLOCK_SIZE: usize> Control<'d, DFU, STATE, RST, BLOCK_SIZE> { + /// Create a new DFU instance to handle DFU transfers. pub fn new(updater: BlockingFirmwareUpdater<'d, DFU, STATE>, attrs: DfuAttributes) -> Self { Self { updater, diff --git a/embassy-usb-dfu/src/lib.rs b/embassy-usb-dfu/src/lib.rs index 389bb33f..eaa4b6e3 100644 --- a/embassy-usb-dfu/src/lib.rs +++ b/embassy-usb-dfu/src/lib.rs @@ -1,12 +1,14 @@ #![no_std] +#![doc = include_str!("../README.md")] +#![warn(missing_docs)] mod fmt; pub mod consts; #[cfg(feature = "dfu")] -mod bootloader; +mod dfu; #[cfg(feature = "dfu")] -pub use self::bootloader::*; +pub use self::dfu::*; #[cfg(feature = "application")] mod application; @@ -17,7 +19,7 @@ pub use self::application::*; all(feature = "dfu", feature = "application"), not(any(feature = "dfu", feature = "application")) ))] -compile_error!("usb-dfu must be compiled with exactly one of `bootloader`, or `application` features"); +compile_error!("usb-dfu must be compiled with exactly one of `dfu`, or `application` features"); /// Provides a platform-agnostic interface for initiating a system reset. /// @@ -26,9 +28,11 @@ compile_error!("usb-dfu must be compiled with exactly one of `bootloader`, or `a /// /// If alternate behaviour is desired, a custom implementation of Reset can be provided as a type argument to the usb_dfu function. pub trait Reset { + /// Reset the device. fn sys_reset() -> !; } +/// Reset immediately. #[cfg(feature = "esp32c3-hal")] pub struct ResetImmediate; @@ -40,6 +44,7 @@ impl Reset for ResetImmediate { } } +/// Reset immediately. #[cfg(feature = "cortex-m")] pub struct ResetImmediate; diff --git a/embassy-usb-logger/README.md b/embassy-usb-logger/README.md index 81b0dcd0..6cb18e87 100644 --- a/embassy-usb-logger/README.md +++ b/embassy-usb-logger/README.md @@ -13,3 +13,17 @@ 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.