Add USB devices by christoph-zededa · Pull Request #424 · jaypipes/ghw

christoph-zededa · 2025-08-29T16:56:58Z

This PR adds USB devices to the list of devices.

The code basically iterates over /sys/bus/usb/devices, follows the symlinks and reads uevent, interface and product.

For the snapshot, the symlinks in /sys/bus/usb/devices are added as well as the aforementioned files.

christoph-zededa · 2025-09-01T12:10:03Z

Fixed the build errors for Mac OS X and the linting errors about missing error-return-checks.

jaypipes · 2025-09-02T13:53:09Z

@christoph-zededa thanks so much for this submission! I'll try to do a full review later today or tomorrow :)

ffromani

many thanks for the submission. I think that a usb package will benefit the project.
I'm very wary to add more deps, we should rather head to remove them all.
This is especially true if we can get similar (or identical?) results using golang code and peeking around in /sys.
Other than that, the code looks reasonnable, but I think we can use a bit more tests.

At glance, API additions (user-facing APIs) looks good but I'll leave the final word to @jaypipes

ffromani · 2025-10-10T08:53:53Z

-		}
-		if err := showAccelerator(cmd, args); err != nil {
-			return err
+		fmt.Println("------------------------------")


minor: we should avoid fixed size separators; either avoid them for now or automatically align to the longest line, this approach will likely require extra code and/or a 3rd party helper.

I forgot to remove it after debugging. Now it is gone.

ffromani · 2025-10-10T08:56:23Z

 		info.Baseboard.String(),
 		info.Product.String(),
 		info.PCI.String(),
+		info.USB.String(),


unrelated: this scales pretty poorly and is too hard to extend, I'll file a PR to send an improvement ASAP

ffromani · 2025-10-10T08:56:46Z

 }

 type Paths struct {
+	ChrootSys              string


this should probably be "SysRoot"

I renamed it to SysRoot

ffromani · 2025-10-10T08:57:28Z

 	fileSpecs := ExpectedCloneStaticContent()
 	fileSpecs = append(fileSpecs, ExpectedCloneNetContent()...)
+	fileSpecs = append(fileSpecs, ExpectedCloneUSBContent()...)
 	fileSpecs = append(fileSpecs, ExpectedClonePCIContent()...)
 	fileSpecs = append(fileSpecs, ExpectedCloneGPUContent()...)


likewise, this code probably deserves some cleanup, I'll take care in a different PR

ffromani · 2025-10-10T08:59:33Z

+/*
+#cgo pkg-config: libusb-1.0
+*/


Unless this provide critical functionalities we can't replace with our code, I think we should avoid this especially becase it requires C code

The idea behind this is to use libusb on Mac OS X and use sysfs directly on Linux.
Perhaps it is better that I remove the OS X implementation now and later create another PR so this can be discussed there?

ok, this is an important clarification which changes the perspective a bit. I would prefer this approach you outline in your last comment, but please don't do any change just yet, let's wait for @jaypipes 's review.

@christoph-zededa yes, let's separate out the MacOSX support from the Linux support please. That way we can do a clean PR review on the Linux support and get that merged while we decide on a path forward for Mac.

I removed it from this PR.

ffromani · 2025-10-10T09:00:00Z

+import (
+	"runtime"
+
+	"github.com/pkg/errors"


please use the native errors in new code

europaul · 2025-11-19T10:48:59Z

@jaypipes @ffromani could you give this PR another look? I think it might have been forgotten :)

jaypipes · 2025-11-19T14:58:44Z

@jaypipes @ffromani could you give this PR another look? I think it might have been forgotten :)

@europaul yes, sorry, was at Kubecon last week and behind on reviews. will get to this today or tomorrow! sorry for the delay!

jaypipes

@christoph-zededa please pull the latest main and rebase this branch in order to bring in the latest go.mod and other changes. I've left some comments inline for you as well.

So sorry for the long delay in reviewing and thank you again for the submission!

jaypipes · 2025-09-03T16:41:28Z

+	"github.com/spf13/cobra"
+)
+
+// netCmd represents the install command


Suggested change

// netCmd represents the install command

// usbCmd represents the `usb` command

jaypipes · 2025-09-03T16:41:47Z

+	RunE:  showUSB,
+}
+
+// showNetwork show network information for the host system.


Suggested change

// showNetwork show network information for the host system.

// showUSB shows USB information for the host system.

jaypipes · 2025-09-03T16:43:21Z

+	"github.com/jaypipes/ghw/pkg/option"
+)
+
+type USB struct {


I think this struct should be called Device.

I renamed it to Device.

jaypipes · 2025-09-03T16:54:11Z

+
+	}
+
+	return str.String()


This would probably be easier to read like this:

attrs := map[string]string{ "driver": u.Driver, "type", u.Type, "vendor_id", u.VendorID, "product_id", u.ProductID, "product", u.Product, "revision_id": u.RevisionID, "interface": u.Interface, } return strings.Join( lo.MapToSlice( attrs, func (k, v string) string { return fmt.Sprintf("%s=%q", k, v) }, ), " ", )

We use the samber/lo library for generic manipulations like the above.

I don't see this library yet in go.mod, but I can add it.

One thing I see that with the map it is now unordered:
before:

christoph@ponyhof ~/p/g/c/ghwc (usb)> go build && ./ghwc usb USB (19 USBs) driver=hub type=9/0/1 vendorID=1d6b productID=2 revisionID=617 driver=hub type=9/0/3 vendorID=1d6b productID=3 revisionID=617 driver=hub type=9/0/1 vendorID=1d6b productID=2 revisionID=617 driver=usb type=224/1/1 vendorID=8087 productID=33 revisionID=0 driver=btusb type=224/1/1 vendorID=8087 productID=33 revisionID=0 driver=btusb type=224/1/1 vendorID=8087 productID=33 revisionID=0 driver=usb type=255/16/255 vendorID=6cb productID=fc revisionID=0 type=255/16/255 vendorID=6cb productID=fc revisionID=0 driver=usb type=239/2/1 vendorID=174f productID=1813 product="Integrated Camera" revisionID=1015 driver=uvcvideo type=239/2/1 vendorID=174f productID=1813 revisionID=1015 interface="Integrated Camera" driver=uvcvideo type=239/2/1 vendorID=174f productID=1813 revisionID=1015 driver=uvcvideo type=239/2/1 vendorID=174f productID=1813 revisionID=1015 interface="Integrated IR Camera" driver=uvcvideo type=239/2/1 vendorID=174f productID=1813 revisionID=1015 type=239/2/1 vendorID=174f productID=1813 revisionID=1015 interface="Camera DFU Device" driver=hub type=9/0/3 vendorID=1d6b productID=3 revisionID=617 driver=usb type=9/0/1 vendorID=1d6b productID=2 product="xHCI Host Controller" revisionID=617 driver=usb type=9/0/3 vendorID=1d6b productID=3 product="xHCI Host Controller" revisionID=617 driver=usb type=9/0/1 vendorID=1d6b productID=2 product="xHCI Host Controller" revisionID=617 driver=usb type=9/0/3 vendorID=1d6b productID=3 product="xHCI Host Controller" revisionID=617

after:

christoph@ponyhof ~/p/g/c/ghwc (usb)> go build && ./ghwc usb USB (19 USBs) vendor_id="1d6b" product_id="2" product="" revision_id="617" interface="" driver="hub" type="9/0/1" interface="" driver="hub" type="9/0/3" vendor_id="1d6b" product_id="3" product="" revision_id="617" product="" revision_id="617" interface="" driver="hub" type="9/0/1" vendor_id="1d6b" product_id="2" product_id="33" product="" revision_id="0" interface="" driver="usb" type="224/1/1" vendor_id="8087" revision_id="0" interface="" driver="btusb" type="224/1/1" vendor_id="8087" product_id="33" product="" product="" revision_id="0" interface="" driver="btusb" type="224/1/1" vendor_id="8087" product_id="33" vendor_id="6cb" product_id="fc" product="" revision_id="0" interface="" driver="usb" type="255/16/255" revision_id="0" interface="" driver="" type="255/16/255" vendor_id="6cb" product_id="fc" product="" vendor_id="174f" product_id="1813" product="Integrated Camera" revision_id="1015" interface="" driver="usb" type="239/2/1" type="239/2/1" vendor_id="174f" product_id="1813" product="" revision_id="1015" interface="Integrated Camera" driver="uvcvideo" type="239/2/1" vendor_id="174f" product_id="1813" product="" revision_id="1015" interface="" driver="uvcvideo" driver="uvcvideo" type="239/2/1" vendor_id="174f" product_id="1813" product="" revision_id="1015" interface="Integrated IR Camera" type="239/2/1" vendor_id="174f" product_id="1813" product="" revision_id="1015" interface="" driver="uvcvideo" product_id="1813" product="" revision_id="1015" interface="Camera DFU Device" driver="" type="239/2/1" vendor_id="174f" driver="hub" type="9/0/3" vendor_id="1d6b" product_id="3" product="" revision_id="617" interface="" vendor_id="1d6b" product_id="2" product="xHCI Host Controller" revision_id="617" interface="" driver="usb" type="9/0/1" revision_id="617" interface="" driver="usb" type="9/0/3" vendor_id="1d6b" product_id="3" product="xHCI Host Controller" revision_id="617" interface="" driver="usb" type="9/0/1" vendor_id="1d6b" product_id="2" product="xHCI Host Controller" interface="" driver="usb" type="9/0/3" vendor_id="1d6b" product_id="3" product="xHCI Host Controller" revision_id="617"

for now I have not included the change in the PR

I don't see this library yet in go.mod, but I can add it.

Doh, you are totally correct @christoph-zededa! I've used samber/lo in so many of my other libraries I just assumed we were using it in ghw!

@christoph-zededa good point about the ordering. OK, let's leave this alone then :)

jaypipes · 2025-10-13T14:45:48Z

+/*
+#cgo pkg-config: libusb-1.0
+*/


@christoph-zededa yes, let's separate out the MacOSX support from the Linux support please. That way we can do a clean PR review on the Linux support and get that merged while we decide on a path forward for Mac.

christoph-zededa · 2025-11-25T18:37:43Z

I removed the Mac support.

instead of checking every return manually, use a for-loop Signed-off-by: Christoph Ostarek <christoph@zededa.com>

jaypipes

sorry @christoph-zededa noticed one thing, see inline comment.

jaypipes · 2025-11-28T15:20:07Z

+// Info describes all network interface controllers (NICs) in the host system.
+type Info struct {
+	ctx  *context.Context
+	USBs []*Device `json:"usbs"`


Just noticed, this should be Devices not USBs

jaypipes · 2025-12-01T12:39:01Z

+// Info describes all network interface controllers (NICs) in the host system.
+type Info struct {
+	ctx     *context.Context
+	Devices []*Device `json:"usbs"`


Suggested change

Devices []*Device `json:"usbs"`

Devices []*Device `json:"devices"`

Fixed. Sorry, I am still in Monday mode ;-)

LOL, no worries @christoph-zededa! Really glad you have been so patient with us in this review! :)

basically this code iterates over entries in `/sys/bus/usb/devices/` and reads out information from the `uevent` file and some other files Signed-off-by: Christoph Ostarek <christoph@zededa.com>

jaypipes

Thank you @christoph-zededa! :)

christoph-zededa force-pushed the usb branch 3 times, most recently from 215b125 to 03aa3e7 Compare September 1, 2025 12:09

christoph-zededa force-pushed the usb branch 2 times, most recently from 11861e0 to 67402b7 Compare September 1, 2025 16:59

christoph-zededa force-pushed the usb branch from 67402b7 to 1a152f1 Compare September 3, 2025 15:17

ffromani reviewed Oct 10, 2025

View reviewed changes

christoph-zededa force-pushed the usb branch 2 times, most recently from f2e3a5f to 8031e2b Compare October 13, 2025 14:23

jaypipes requested changes Nov 19, 2025

View reviewed changes

christoph-zededa force-pushed the usb branch 3 times, most recently from 51cebaf to e8bf258 Compare November 25, 2025 18:35

rootCommand: make code less-repetitive

cf7ba43

instead of checking every return manually, use a for-loop Signed-off-by: Christoph Ostarek <christoph@zededa.com>

christoph-zededa force-pushed the usb branch from e8bf258 to 0c52706 Compare November 25, 2025 18:38

christoph-zededa requested a review from jaypipes November 25, 2025 18:40

jaypipes approved these changes Nov 28, 2025

View reviewed changes

jaypipes requested changes Nov 28, 2025

View reviewed changes

christoph-zededa force-pushed the usb branch from 0c52706 to 265dea2 Compare December 1, 2025 11:09

jaypipes reviewed Dec 1, 2025

View reviewed changes

usb: add initial support for USB on Linux

9a8b541

basically this code iterates over entries in `/sys/bus/usb/devices/` and reads out information from the `uevent` file and some other files Signed-off-by: Christoph Ostarek <christoph@zededa.com>

christoph-zededa force-pushed the usb branch from 265dea2 to 9a8b541 Compare December 1, 2025 12:55

jaypipes approved these changes Dec 1, 2025

View reviewed changes

jaypipes merged commit 706bdae into jaypipes:main Dec 1, 2025
14 checks passed

	// netCmd represents the install command
	// usbCmd represents the `usb` command

	// showNetwork show network information for the host system.
	// showUSB shows USB information for the host system.

	Devices []*Device `json:"usbs"`
	Devices []*Device `json:"devices"`

Conversation

christoph-zededa commented Aug 29, 2025

Uh oh!

christoph-zededa commented Sep 1, 2025

Uh oh!

jaypipes commented Sep 2, 2025

Uh oh!

ffromani left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

europaul commented Nov 19, 2025

Uh oh!

jaypipes commented Nov 19, 2025

Uh oh!

jaypipes left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

christoph-zededa commented Nov 25, 2025

Uh oh!

jaypipes left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!