Merge pull request #172 from nix-community/fix/rmi-bus-type

feat: use linux input Bus enum with udev data

pkg/hwinfo/input.go

@@ -1,7 +1,11 @@
 package hwinfo
 
 import (
+	"errors"
 	"fmt"
+	"log/slog"
+
+	"github.com/numtide/nixos-facter/pkg/udev"
 
 	"github.com/numtide/nixos-facter/pkg/linux/input"
 )
@@ -10,15 +14,26 @@ import (
 // error.
 // It accepts a deviceIdx to ensure it continues on from the last device index generated by hwinfo.
 func captureTouchpads(deviceIdx uint) ([]HardwareDevice, error) {
-	inputDevices, err := input.ReadDevices(nil, true)
+	inputDevices, err := input.ReadDevices(nil)
 	if err != nil {
 		return nil, fmt.Errorf("failed to read input devices: %w", err)
 	}
 
 	var result []HardwareDevice //nolint:prealloc
 
 	for _, inputDevice := range inputDevices {
-		if !inputDevice.Udev.Input.IsTouchpad {
+
+		path := "/sys" + inputDevice.Sysfs
+
+		udevData, err := udev.Read(path)
+		if errors.Is(err, udev.ErrNotFound) {
+			slog.Warn("udev data not found", "name", inputDevice.Name, "sysfs", inputDevice.Sysfs)
+			continue
+		} else if err != nil {
+			return nil, fmt.Errorf("failed to fetch udev data for device %q with udev data: %w", path, err)
+		}
+
+		if !udevData.Input.IsTouchpad {
 			// currently, we are only interested in touchpads, as hwinfo does not capture them
 			// eventually, we may take over more of the input processing that hwinfo performs
 			continue
@@ -35,11 +50,11 @@ func captureTouchpads(deviceIdx uint) ([]HardwareDevice, error) {
 			Class:     HardwareClassMouse,
 			BaseClass: NewBaseClassID(BaseClassTouchpad),
 			Vendor: &ID{
-				Name:  inputDevice.Udev.Vendor,
+				Name:  udevData.Vendor,
 				Value: inputDevice.Vendor,
 			},
 			Device: &ID{
-				Name:  inputDevice.Udev.Model,
+				Name:  udevData.Model,
 				Value: inputDevice.Product,
 			},
 			SysfsID: inputDevice.Sysfs,

pkg/linux/input/input.go

@@ -2,16 +2,12 @@ package input
 
 import (
 	"bufio"
-	"errors"
 	"fmt"
 	"io"
-	"log/slog"
 	"os"
 	"regexp"
 	"strconv"
 	"strings"
-
-	"github.com/numtide/nixos-facter/pkg/udev"
 )
 
 //go:generate enumer -type=Bus -json -text -trimprefix Bus -output=./input_bus.go
@@ -74,7 +70,6 @@ type Device struct {
 	Sysfs        string
 	Phys         string
 	Capabilities map[string]string
-	Udev         *udev.Udev
 }
 
 func (d *Device) Path() string {
@@ -101,7 +96,7 @@ func (d *Device) EventHandler() string {
 	return ""
 }
 
-func ReadDevices(r io.ReadCloser, udevAnnotate bool) ([]*Device, error) {
+func ReadDevices(r io.ReadCloser) ([]*Device, error) {
 	var err error
 
 	if r == nil {
@@ -123,17 +118,6 @@ func ReadDevices(r io.ReadCloser, udevAnnotate bool) ([]*Device, error) {
 		line := scanner.Text()
 
 		if line == "" {
-			// try to append udev data
-			if udevAnnotate {
-				device.Udev, err = udev.Read("/sys" + device.Sysfs)
-
-				if errors.Is(err, udev.ErrNotFound) {
-					slog.Warn("udev data not found", "name", device.Name, "sysfs", device.Sysfs)
-				} else if err != nil {
-					return nil, fmt.Errorf("failed to annotate with udev data: %w", err)
-				}
-			}
-
 			devices = append(devices, device)
 			device = nil
 

pkg/linux/input/input_test.go

@@ -56,7 +56,7 @@ func TestReadDevices(t *testing.T) {
 	as := require.New(t)
 	r := io.NopCloser(bytes.NewReader([]byte(devices)))
 
-	devices, err := input.ReadDevices(r, false)
+	devices, err := input.ReadDevices(r)
 	as.NoError(err)
 
 	expected := []*input.Device{

pkg/udev/udev.go

@@ -51,27 +51,8 @@ import (
 	"fmt"
 	"strconv"
 	"unsafe"
-)
-
-//go:generate enumer -type=Bus -json -text -transform=snake -trimprefix Bus -output=./udev_bus.go
-type Bus int //nolint:recvcheck
 
-const (
-	BusAta Bus = iota // ATA (IDE) devices
-	BusBluetooth
-	BusI8042
-	BusI2c      // Inter-Integrated Circuit
-	BusIeee1394 // Firewire
-	BusPci
-	BusPciExpress
-	BusPcmcia   // Personal Computer Memory Card International Association
-	BusPlatform // Devices on a system's motherboard
-	BusScsi
-	BusSerial
-	BusSerio // Serial interface controller devices
-	BusSpi   // Serial Peripheral Interface connected devices
-	BusUsb
-	BusVirtio
+	"github.com/numtide/nixos-facter/pkg/linux/input"
 )
 
 //go:generate enumer -type=Type -json -text -trimprefix Type -output=./udev_type.go
@@ -210,7 +191,7 @@ func NewUdevPci(env map[string]string) (*Pci, error) {
 }
 
 type Udev struct {
-	Bus         Bus
+	Bus         input.Bus
 	Type        Type
 	Model       string
 	ModelID     uint16
@@ -270,11 +251,11 @@ func NewUdev(env map[string]string) (*Udev, error) {
 	var err error
 
 	switch result.Bus {
-	case BusUsb:
+	case input.BusUsb:
 		if result.Usb, err = NewUdevUsb(env); err != nil {
 			return nil, fmt.Errorf("failed to parse usb: %w", err)
 		}
-	case BusPci:
+	case input.BusPci:
 		if result.Pci, err = NewUdevPci(env); err != nil {
 			return nil, fmt.Errorf("failed to parse pci: %w", err)
 		}