Merge branch 'master' into release/0.3

rust-embedded-community · Nov 13, 2023 · 00317ce · 00317ce
2 parents 8e2daef + eac466e
commit 00317ce
Show file tree

Hide file tree

Showing 11 changed files with 185 additions and 263 deletions.
diff --git a/.github/workflows/rustfmt.yml b/.github/workflows/rustfmt.yml
@@ -16,3 +16,6 @@ jobs:
           components: rustfmt
       - run: cargo fmt --all -- --check
       - run: cargo clippy --all-features
+      - run: cargo clippy --features defmt
+      - run: cargo clippy --features control-buffer-256
+      - run: cargo clippy
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,7 +21,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Breaking
 * Acess numeric form of `EndpointType` variants now require a `.to_bm_attributes()`. ([#60](https://github.com/rust-embedded-community/usb-device/pull/60))
 * `DescriptorWriter::iad()` now requires a `Option<StringIndex>` to optionally specify a string for describing the function ([#121](https://github.com/rust-embedded-community/usb-device/pull/121))
-* `.manufacturer()`, `.product()` and `.serial_number()` of `UsbDeviceBuilder` now require `&[&str]` to specify strings match with each LANGIDs supported by device. ([#122](https://github.com/rust-embedded-community/usb-device/pull/122))
+* `.manufacturer()`, `.product()` and `.serial_number()` of `UsbDeviceBuilder` are now replaced with the `strings()` function that accepts a `StringDescriptor` list to allow multilanguage support ([#122](https://github.com/rust-embedded-community/usb-device/pull/122))
+* Various methods of the `UsbDeviceBuilder` now return `Result<>` types instead of internally panicking.
 
 ### Changed
 * `EndpointType` enum now has fields for isochronous synchronization and usage ([#60](https://github.com/rust-embedded-community/usb-device/pull/60)).

diff --git a/Cargo.toml b/Cargo.toml
@@ -13,6 +13,7 @@ repository = "https://github.com/mvirkkunen/usb-device"
 defmt = { version = "0.3", optional = true }
 portable-atomic = { version = "1.2.0", default-features = false }
 num_enum = { version = "0.6.1", default-features = false }
+heapless = "0.7"
 
 [dev-dependencies]
 rusb = "0.9.1"

diff --git a/src/control_pipe.rs b/src/control_pipe.rs
@@ -154,12 +154,12 @@ impl<B: UsbBus> ControlPipe<'_, B> {
             | ControlState::DataInLast
             | ControlState::DataInZlp
             | ControlState::StatusOut => {
-                self.ep_out.read(&mut []).ok();
+                let _ = self.ep_out.read(&mut []);
                 self.state = ControlState::Idle;
             }
             _ => {
                 // Discard the packet
-                self.ep_out.read(&mut []).ok();
+                let _ = self.ep_out.read(&mut []);
 
                 // Unexpected OUT packet
                 self.set_error()
@@ -235,7 +235,7 @@ impl<B: UsbBus> ControlPipe<'_, B> {
             _ => return Err(UsbError::InvalidState),
         };
 
-        self.ep_in.write(&[]).ok();
+        let _ = self.ep_in.write(&[]);
         self.state = ControlState::StatusIn;
         Ok(())
     }

diff --git a/src/descriptor.rs b/src/descriptor.rs
@@ -116,11 +116,29 @@ impl DescriptorWriter<'_> {
                 config.product_id as u8,
                 (config.product_id >> 8) as u8, // idProduct
                 config.device_release as u8,
-                (config.device_release >> 8) as u8,    // bcdDevice
-                config.manufacturer.map_or(0, |_| 1),  // iManufacturer
-                config.product.map_or(0, |_| 2),       // iProduct
-                config.serial_number.map_or(0, |_| 3), // iSerialNumber
-                1,                                     // bNumConfigurations
+                (config.device_release >> 8) as u8, // bcdDevice
+                config.string_descriptors.first().map_or(0, |lang| {
+                    if lang.manufacturer.is_some() {
+                        1
+                    } else {
+                        0
+                    }
+                }),
+                config.string_descriptors.first().map_or(0, |lang| {
+                    if lang.product.is_some() {
+                        2
+                    } else {
+                        0
+                    }
+                }),
+                config.string_descriptors.first().map_or(0, |lang| {
+                    if lang.serial.is_some() {
+                        3
+                    } else {
+                        0
+                    }
+                }),
+                1, // bNumConfigurations
             ],
         )
     }

diff --git a/src/descriptor/lang_id.rs b/src/descriptor/lang_id.rs
@@ -15,7 +15,7 @@ impl From<LangID> for u16 {
 }
 
 #[allow(missing_docs)]
-#[derive(Clone, Copy, PartialEq, TryFromPrimitive)]
+#[derive(Clone, Copy, PartialEq, Debug, TryFromPrimitive)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u16)]
 pub enum LangID {
@@ -349,7 +349,7 @@ pub enum LangID {
     MN_MONG_MN = 0x0C50,
     DZ_BT = 0x0C51,
     TMZ_MA = 0x0C5F,
-    QUZ_PE = 0x0C6b,
+    QUZ_PE = 0x0C6B,
     LOCALE_CUSTOM_UNSPECIFIED = 0x1000,
     AR_LY = 0x1001,
     ZH_SG = 0x1004,