prepare for release

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+- Working on full dumps of device descriptors ([#15](https://github.com/tuna-f1sh/cyme/issues/15))
+
+## [1.6.0] - 2023-11-23
+
 _A release of patches, PRs and merges :), thanks to support_
 
 ### Added
@@ -13,15 +17,20 @@ _A release of patches, PRs and merges :), thanks to support_
 - Add the display blocks `uid-class`, `uid-subc-lass`, `uid-protocol`, `class`, and `class-value` for `DeviceBlock`s and `InterfaceBlock`s. These are also added for `--more`.
 - Add `feature=udev_hwdb` to guard against systems that have udev but not hwdb support ([cross/#1377](https://github.com/cross-rs/cross/issues/1377))/([libudev-sys/#16](https://github.com/dcuddeback/libudev-sys/pull/16)).
 
-## Changed
+### Changed
 
 - 'usb-ids' crate is now a dependency rather than optional to support `lsusb::names` lookup without udev_hwdb (non-Linux). ([usb-ids.rs/#50](https://github.com/woodruffw/usb-ids.rs/pull/50)) will add extra descriptor parsing in future.
 - iString descriptors will now be retrieved in order libusb descriptor -> sysfs cache (Linux) -> udev_hwdb (bundled usb-ids `--feature=udev_hwdb`) -> usb-ids.
 
 ### Fixes
 
 - Fix ClassCode as u8 in lsusb --verbose being enum index not repr(c) base class byte.
+- Fix ClassCode as u8 in icon serializer being enum index not repc(c) base class byte.
 
 ## [1.5.2] - 2023-11-01
 
 _Changelog started._
+
+## [0.2.0] - 2022-11-16
+
+_First release._

Cargo.toml

@@ -5,7 +5,7 @@ description = "List system USB buses and devices; a modern cross-platform `lsusb
 repository = "https://github.com/tuna-f1sh/cyme"
 readme = "README.md"
 license = "GPL-3.0-or-later"
-version = "1.5.2"
+version = "1.6.0"
 edition = "2021"
 keywords = ["usb", "lsusb", "system_profiler", "macos", "libusb"]
 categories = ["command-line-utilities"]

doc/_cyme

@@ -28,7 +28,7 @@ audio\:"Speaker, microphone, sound card, MIDI"
 cdc-communications\:"The modern serial interface; appears as a UART/RS232 port on most systems"
 hid\:"Human Interface Device; game controllers, keyboards, mice etc. Also commonly used as a device data interface rather then creating something from scratch"
 physical\:"Force feedback joystick"
-image\:"Scanners, cameras"
+image\:"Still imaging device; scanners, cameras"
 printer\:"Laser printer, inkjet printer, CNC machine"
 mass-storage\:"Mass storage devices (MSD)\: USB flash drive, memory card reader, digital audio player, digital camera, external drive"
 hub\:"High speed USB hub"
@@ -40,6 +40,8 @@ personal-healthcare\:"Pulse monitor (watch)"
 audio-video\:"Webcam, TV"
 billboard\:"Describes USB-C alternate modes supported by device"
 usb-type-c-bridge\:"An interface to expose and configure the USB Type-C capabilities of Connectors on USB Hubs or Alternate Mode Adapters"
+bdp\:"This base class is defined for devices that conform to the “VESA USB BDP Device Specification” found at the VESA website. This specification defines the usable set of SubClass and Protocol values. Values outside of this defined spec are reserved. These class codes can only be used in Interface Descriptors"
+mctp\:"This base class is defined for devices that conform to the “MCTP over USB” found at the DMTF website as DSP0283. This specification defines the usable set of SubClass and Protocol values. Values outside of this defined spec are reserved. These class codes can only be used in Interface Descriptors"
 i3c-device\:"An interface to expose and configure I3C function within a USB device to allow interaction between host software and the I3C device, to drive transaction on the I3C bus to/from target devices"
 diagnostic\:"Trace and debugging equipment"
 wireless-controller\:"Wireless controllers\: Bluetooth adaptors, Microsoft RNDIS"
@@ -67,9 +69,14 @@ bus-power-used\:"macOS system_profiler only - actually bus current used in mA no
 extra-current-used\:"macOS system_profiler only - actually bus current used in mA not power!"
 bcd-device\:"The device version"
 bcd-usb\:"The supported USB version"
-class-code\:"Class of interface provided by USB IF - only available when using libusb"
-sub-class\:"Sub-class of interface provided by USB IF - only available when using libusb"
-protocol\:"Prototol code for interface provided by USB IF - only available when using libusb"))' \
+class-code\:"Base class enum of interface provided by USB IF - only available when using libusb"
+sub-class\:"Sub-class value of interface provided by USB IF - only available when using libusb"
+protocol\:"Prototol value for interface provided by USB IF - only available when using libusb"
+uid-class\:"Class name from USB IDs repository"
+uid-sub-class\:"Sub-class name from USB IDs repository"
+uid-protocol\:"Protocol name from USB IDs repository"
+class\:"Fully defined USB Class Code based on Class/SubClass/Protocol triplet"
+class-value\:"Base class as number value"))' \
 '*--blocks=[Specify the blocks which will be displayed for each device and in what order]:BLOCKS:((bus-number\:"Number of bus device is attached"
 device-number\:"Bus issued device number"
 branch-position\:"Position of device in parent branch"
@@ -91,9 +98,14 @@ bus-power-used\:"macOS system_profiler only - actually bus current used in mA no
 extra-current-used\:"macOS system_profiler only - actually bus current used in mA not power!"
 bcd-device\:"The device version"
 bcd-usb\:"The supported USB version"
-class-code\:"Class of interface provided by USB IF - only available when using libusb"
-sub-class\:"Sub-class of interface provided by USB IF - only available when using libusb"
-protocol\:"Prototol code for interface provided by USB IF - only available when using libusb"))' \
+class-code\:"Base class enum of interface provided by USB IF - only available when using libusb"
+sub-class\:"Sub-class value of interface provided by USB IF - only available when using libusb"
+protocol\:"Prototol value for interface provided by USB IF - only available when using libusb"
+uid-class\:"Class name from USB IDs repository"
+uid-sub-class\:"Sub-class name from USB IDs repository"
+uid-protocol\:"Protocol name from USB IDs repository"
+class\:"Fully defined USB Class Code based on Class/SubClass/Protocol triplet"
+class-value\:"Base class as number value"))' \
 '*--bus-blocks=[Specify the blocks which will be displayed for each bus and in what order]:BUS_BLOCKS:((bus-number\:"System bus number identifier"
 icon\:"Icon based on VID/PID"
 name\:"Bus name from descriptor or usb_ids"
@@ -111,14 +123,19 @@ max-power\:"Maximum current consumption in mA"))' \
 '*--interface-blocks=[Specify the blocks which will be displayed for each interface and in what order]:INTERFACE_BLOCKS:((name\:"Name from string descriptor"
 number\:"Interface number"
 port-path\:"Interface port path, applicable to Linux"
-class-code\:"Class of interface provided by USB IF"
-sub-class\:"Sub-class of interface provided by USB IF"
-protocol\:"Prototol code for interface provided by USB IF"
+class-code\:"Class enum of interface provided by USB IF"
+sub-class\:"Sub-class value of interface provided by USB IF"
+protocol\:"Prototol value for interface provided by USB IF"
 alt-setting\:"Interfaces can have the same number but an alternate settings defined here"
 driver\:"Driver obtained from udev on Linux only"
 sys-path\:"syspath obtained from udev on Linux only"
 num-endpoints\:"An interface can have many endpoints"
-icon\:"Icon based on ClassCode/SubCode/Protocol"))' \
+icon\:"Icon based on ClassCode/SubCode/Protocol"
+uid-class\:"Class name from USB IDs repository"
+uid-sub-class\:"Sub-class name from USB IDs repository"
+uid-protocol\:"Protocol name from USB IDs repository"
+class\:"Fully defined USB Class Code based on Class/SubClass/Protocol triplet"
+class-value\:"Base class as number value"))' \
 '*--endpoint-blocks=[Specify the blocks which will be displayed for each endpoint and in what order]:ENDPOINT_BLOCKS:((number\:"Endpoint number on interface"
 direction\:"Direction of data into endpoint"
 transfer-type\:"Type of data transfer endpoint accepts"