From 3dc54c8c445cd193110d5c18a695d18761bf04d9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?D=C3=A1niel=20Buga?= <bugadani@gmail.com>
Date: Fri, 26 Apr 2024 18:28:41 +0200
Subject: [PATCH] Add some metadata

---
 embassy-time/Cargo.toml             |  6 +++---
 embassy-usb-driver/Cargo.toml       |  2 +-
 embassy-usb-synopsys-otg/Cargo.toml | 14 ++++++++++++++
 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 = []
 
 #! The following features set how many timers are used for the generic queue. At most one
 #! `generic-queue-*` feature can be enabled. If none is enabled, a default of 64 timers is used.
-#! 
+#!
 #! When using embassy-time from libraries, you should *not* enable any `generic-queue-*` feature, to allow the
 #! end user to pick.
 
@@ -60,7 +60,7 @@ generic-queue-128 = ["generic-queue"]
 #! ### Tick Rate
 #!
 #! At most 1 `tick-*` feature can be enabled. If none is enabled, a default of 1MHz is used.
-#! 
+#!
 #! If the time driver in use supports using arbitrary tick rates, you can enable one `tick-*`
 #! feature from your binary crate to set the tick rate. The driver will use configured tick rate.
 #! 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"]
 #! <details>
 #!   <summary>Available tick rates:</summary>
 #! <!-- Next line must be left empty for the features to render correctly! -->
-#! 
+#!
 
 # BEGIN TICKS
 # 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"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [package.metadata.embassy_docs]
-src_base = "https://github.com/embassy-rs/embassy/blob/embassy-usb-driver-v$VERSION/embassy-usb/src/"
+src_base = "https://github.com/embassy-rs/embassy/blob/embassy-usb-driver-v$VERSION/embassy-usb-driver/src/"
 src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-usb-driver/src/"
 features = ["defmt"]
 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 @@
 name = "embassy-usb-synopsys-otg"
 version = "0.1.0"
 edition = "2021"
+description = "`embassy-usb-driver` implementation for Synopsys OTG USB controllers"
+keywords = ["embedded", "async", "usb", "hal", "embedded-hal"]
+categories = ["embedded", "hardware-support", "no-std", "asynchronous"]
+repository = "https://github.com/embassy-rs/embassy"
+documentation = "https://docs.embassy.dev/embassy-usb-synopsys-otg"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
+[package.metadata.embassy_docs]
+src_base = "https://github.com/embassy-rs/embassy/blob/embassy-usb-synopsys-otg-v$VERSION/embassy-usb-synopsys-otg/src/"
+src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-usb-synopsys-otg/src/"
+features = ["defmt"]
+target = "thumbv7em-none-eabi"
+
 [dependencies]
 critical-section = "1.1"
 futures = { version = "0.3.17", default-features = false }
 
 embassy-sync = { version = "0.5.0", path = "../embassy-sync" }
 embassy-usb-driver = {version = "0.1.0", path = "../embassy-usb-driver" }
+
+defmt = { version = "0.3", optional = true }
+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 @@
-# Embassy USB driver for the Synopsys OTG core
+# Embassy USB driver for the Synopsys USB OTG core
+
+This crate implements `embassy-usb-driver` for Synopsys USB OTG devices. If you wish to
+integrate this crate into your device's HAL, you will need to add device-specific initialization.
+For an example, check out the `embassy-stm32` crate.