diff options
| author | Dániel Buga <[email protected]> | 2024-04-26 18:28:41 +0200 |
|---|---|---|
| committer | Dániel Buga <[email protected]> | 2024-04-26 18:28:41 +0200 |
| commit | 3dc54c8c445cd193110d5c18a695d18761bf04d9 (patch) | |
| tree | 7d099e3417e1346950a2db2bbd5fdc0d17573e31 | |
| parent | 7ce2594eb78a0160928d6a39b778f552f034ddc3 (diff) | |
Add some metadata
| -rw-r--r-- | embassy-time/Cargo.toml | 6 | ||||
| -rw-r--r-- | embassy-usb-driver/Cargo.toml | 2 | ||||
| -rw-r--r-- | embassy-usb-synopsys-otg/Cargo.toml | 14 | ||||
| -rw-r--r-- | embassy-usb-synopsys-otg/README.md | 6 |
4 files changed, 23 insertions, 5 deletions
diff --git a/embassy-time/Cargo.toml b/embassy-time/Cargo.toml index 6b0a0f22d..ca7ad2d09 100644 --- a/embassy-time/Cargo.toml +++ b/embassy-time/Cargo.toml | |||
| @@ -42,7 +42,7 @@ generic-queue = [] | |||
| 42 | 42 | ||
| 43 | #! The following features set how many timers are used for the generic queue. At most one | 43 | #! The following features set how many timers are used for the generic queue. At most one |
| 44 | #! `generic-queue-*` feature can be enabled. If none is enabled, a default of 64 timers is used. | 44 | #! `generic-queue-*` feature can be enabled. If none is enabled, a default of 64 timers is used. |
| 45 | #! | 45 | #! |
| 46 | #! When using embassy-time from libraries, you should *not* enable any `generic-queue-*` feature, to allow the | 46 | #! When using embassy-time from libraries, you should *not* enable any `generic-queue-*` feature, to allow the |
| 47 | #! end user to pick. | 47 | #! end user to pick. |
| 48 | 48 | ||
| @@ -60,7 +60,7 @@ generic-queue-128 = ["generic-queue"] | |||
| 60 | #! ### Tick Rate | 60 | #! ### Tick Rate |
| 61 | #! | 61 | #! |
| 62 | #! At most 1 `tick-*` feature can be enabled. If none is enabled, a default of 1MHz is used. | 62 | #! At most 1 `tick-*` feature can be enabled. If none is enabled, a default of 1MHz is used. |
| 63 | #! | 63 | #! |
| 64 | #! If the time driver in use supports using arbitrary tick rates, you can enable one `tick-*` | 64 | #! If the time driver in use supports using arbitrary tick rates, you can enable one `tick-*` |
| 65 | #! feature from your binary crate to set the tick rate. The driver will use configured tick rate. | 65 | #! feature from your binary crate to set the tick rate. The driver will use configured tick rate. |
| 66 | #! If the time driver supports a fixed tick rate, it will enable one feature itself, so you should | 66 | #! If the time driver supports a fixed tick rate, it will enable one feature itself, so you should |
| @@ -71,7 +71,7 @@ generic-queue-128 = ["generic-queue"] | |||
| 71 | #! <details> | 71 | #! <details> |
| 72 | #! <summary>Available tick rates:</summary> | 72 | #! <summary>Available tick rates:</summary> |
| 73 | #! <!-- Next line must be left empty for the features to render correctly! --> | 73 | #! <!-- Next line must be left empty for the features to render correctly! --> |
| 74 | #! | 74 | #! |
| 75 | 75 | ||
| 76 | # BEGIN TICKS | 76 | # BEGIN TICKS |
| 77 | # Generated by gen_tick.py. DO NOT EDIT. | 77 | # Generated by gen_tick.py. DO NOT EDIT. |
diff --git a/embassy-usb-driver/Cargo.toml b/embassy-usb-driver/Cargo.toml index 837878621..00ed60cf9 100644 --- a/embassy-usb-driver/Cargo.toml +++ b/embassy-usb-driver/Cargo.toml | |||
| @@ -12,7 +12,7 @@ documentation = "https://docs.embassy.dev/embassy-usb-driver" | |||
| 12 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html | 12 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html |
| 13 | 13 | ||
| 14 | [package.metadata.embassy_docs] | 14 | [package.metadata.embassy_docs] |
| 15 | src_base = "https://github.com/embassy-rs/embassy/blob/embassy-usb-driver-v$VERSION/embassy-usb/src/" | 15 | src_base = "https://github.com/embassy-rs/embassy/blob/embassy-usb-driver-v$VERSION/embassy-usb-driver/src/" |
| 16 | src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-usb-driver/src/" | 16 | src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-usb-driver/src/" |
| 17 | features = ["defmt"] | 17 | features = ["defmt"] |
| 18 | target = "thumbv7em-none-eabi" | 18 | target = "thumbv7em-none-eabi" |
diff --git a/embassy-usb-synopsys-otg/Cargo.toml b/embassy-usb-synopsys-otg/Cargo.toml index 5693acc38..b0562627b 100644 --- a/embassy-usb-synopsys-otg/Cargo.toml +++ b/embassy-usb-synopsys-otg/Cargo.toml | |||
| @@ -2,12 +2,26 @@ | |||
| 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 | description = "`embassy-usb-driver` implementation for Synopsys OTG USB controllers" | ||
| 6 | keywords = ["embedded", "async", "usb", "hal", "embedded-hal"] | ||
| 7 | categories = ["embedded", "hardware-support", "no-std", "asynchronous"] | ||
| 8 | repository = "https://github.com/embassy-rs/embassy" | ||
| 9 | documentation = "https://docs.embassy.dev/embassy-usb-synopsys-otg" | ||
| 5 | 10 | ||
| 6 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html | 11 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html |
| 7 | 12 | ||
| 13 | [package.metadata.embassy_docs] | ||
| 14 | src_base = "https://github.com/embassy-rs/embassy/blob/embassy-usb-synopsys-otg-v$VERSION/embassy-usb-synopsys-otg/src/" | ||
| 15 | src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-usb-synopsys-otg/src/" | ||
| 16 | features = ["defmt"] | ||
| 17 | target = "thumbv7em-none-eabi" | ||
| 18 | |||
| 8 | [dependencies] | 19 | [dependencies] |
| 9 | critical-section = "1.1" | 20 | critical-section = "1.1" |
| 10 | futures = { version = "0.3.17", default-features = false } | 21 | futures = { version = "0.3.17", default-features = false } |
| 11 | 22 | ||
| 12 | embassy-sync = { version = "0.5.0", path = "../embassy-sync" } | 23 | embassy-sync = { version = "0.5.0", path = "../embassy-sync" } |
| 13 | embassy-usb-driver = {version = "0.1.0", path = "../embassy-usb-driver" } | 24 | embassy-usb-driver = {version = "0.1.0", path = "../embassy-usb-driver" } |
| 25 | |||
| 26 | defmt = { version = "0.3", optional = true } | ||
| 27 | log = { version = "0.4.14", optional = true } | ||
diff --git a/embassy-usb-synopsys-otg/README.md b/embassy-usb-synopsys-otg/README.md index c3f914896..fa8d5d6da 100644 --- a/embassy-usb-synopsys-otg/README.md +++ b/embassy-usb-synopsys-otg/README.md | |||
| @@ -1 +1,5 @@ | |||
| 1 | # Embassy USB driver for the Synopsys OTG core | 1 | # Embassy USB driver for the Synopsys USB OTG core |
| 2 | |||
| 3 | This crate implements `embassy-usb-driver` for Synopsys USB OTG devices. If you wish to | ||
| 4 | integrate this crate into your device's HAL, you will need to add device-specific initialization. | ||
| 5 | For an example, check out the `embassy-stm32` crate. | ||
