Skip to content

feat: provide iConfiguration descriptor in enumerator if present #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
facchinm wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat: provide iConfiguration descriptor in enumerator if present #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c7a32a6
wip: start supporting boards with iConfiguration field
facchinm Apr 17, 2026
f96d0d8
darwin: implement iConfiguration retrieve
facchinm Apr 20, 2026
bf72454
windows: implement iConfiguration retrieve
facchinm Apr 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions enumerator/enumerator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ package enumerator
// PortDetails contains detailed information about USB serial port.
// Use GetDetailedPortsList function to retrieve it.
type PortDetails struct {
Name string
IsUSB bool
VID string
PID string
SerialNumber string
Name string
IsUSB bool
VID string
PID string
SerialNumber string
Configuration string

// Manufacturer string

Expand Down
7 changes: 7 additions & 0 deletions enumerator/syscall_windows.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

142 changes: 142 additions & 0 deletions enumerator/usb_darwin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,139 @@ package enumerator

// #cgo LDFLAGS: -framework CoreFoundation -framework IOKit
// #include <IOKit/IOKitLib.h>
// #include <IOKit/IOCFPlugIn.h>
// #include <IOKit/usb/IOUSBLib.h>
// #include <CoreFoundation/CoreFoundation.h>
// #include <stdlib.h>
//
// static char *copyUSBConfigurationString(io_service_t service) {
// IOCFPlugInInterface **plugin = NULL;
// IOUSBDeviceInterface **device = NULL;
// IOUSBConfigurationDescriptorPtr configDesc = NULL;
// SInt32 score = 0;
// HRESULT result = S_OK;
// kern_return_t kr;
// UInt8 currentConfig = 0;
// UInt8 numConfigs = 0;
// UInt8 stringIndex = 0;
// UInt8 index;
// UInt16 langID = 0x0409;
// IOUSBDevRequest request;
// UInt8 buffer[1024];
// UInt16 descriptorLength;
// CFStringRef configuration = NULL;
// CFIndex outputSize;
// char *output = NULL;
// UInt8 isOpen = 0;
//
// kr = IOCreatePlugInInterfaceForService(service,
// kIOUSBDeviceUserClientTypeID,
// kIOCFPlugInInterfaceID,
// &plugin,
// &score);
// if (kr != kIOReturnSuccess || plugin == NULL) {
// goto cleanup;
// }
//
// result = (*plugin)->QueryInterface(plugin,
// CFUUIDGetUUIDBytes(kIOUSBDeviceInterfaceID),
// (LPVOID *)&device);
// (*plugin)->Release(plugin);
// plugin = NULL;
// if (result != S_OK || device == NULL) {
// goto cleanup;
// }
//
// kr = (*device)->USBDeviceOpen(device);
// if (kr != kIOReturnSuccess) {
// goto cleanup;
// }
// isOpen = 1;
//
// kr = (*device)->GetConfiguration(device, &currentConfig);
// if (kr != kIOReturnSuccess || currentConfig == 0) {
// goto cleanup;
// }
//
// kr = (*device)->GetNumberOfConfigurations(device, &numConfigs);
// if (kr != kIOReturnSuccess) {
// goto cleanup;
// }
// for (index = 0; index < numConfigs; index++) {
// kr = (*device)->GetConfigurationDescriptorPtr(device, index, &configDesc);
// if (kr == kIOReturnSuccess && configDesc != NULL && configDesc->bConfigurationValue == currentConfig) {
// stringIndex = configDesc->iConfiguration;
// break;
// }
// }
// if (stringIndex == 0) {
// goto cleanup;
// }
//
// request.bmRequestType = USBmakebmRequestType(kUSBIn, kUSBStandard, kUSBDevice);
// request.bRequest = kUSBRqGetDescriptor;
// request.wValue = (kUSBStringDesc << 8);
// request.wIndex = 0;
// request.wLength = sizeof(buffer);
// request.pData = buffer;
// kr = (*device)->DeviceRequest(device, &request);
// if (kr == kIOReturnSuccess && request.wLenDone >= 4) {
// langID = (UInt16)buffer[2] | ((UInt16)buffer[3] << 8);
// }
//
// request.bmRequestType = USBmakebmRequestType(kUSBIn, kUSBStandard, kUSBDevice);
// request.bRequest = kUSBRqGetDescriptor;
// request.wValue = ((UInt16)kUSBStringDesc << 8) | stringIndex;
// request.wIndex = langID;
// request.wLength = sizeof(buffer);
// request.pData = buffer;
// kr = (*device)->DeviceRequest(device, &request);
// if (kr != kIOReturnSuccess || request.wLenDone < 2) {
// goto cleanup;
// }
//
// descriptorLength = buffer[0];
// if (descriptorLength > request.wLenDone) {
// descriptorLength = request.wLenDone;
// }
// if (descriptorLength <= 2) {
// goto cleanup;
// }
//
// configuration = CFStringCreateWithBytes(kCFAllocatorDefault,
// buffer + 2,
// descriptorLength - 2,
// kCFStringEncodingUTF16LE,
// false);
// if (configuration == NULL) {
// goto cleanup;
// }
//
// outputSize = CFStringGetMaximumSizeForEncoding(CFStringGetLength(configuration), kCFStringEncodingUTF8) + 1;
// output = (char *)malloc((size_t)outputSize);
// if (output == NULL) {
// goto cleanup;
// }
// if (!CFStringGetCString(configuration, output, outputSize, kCFStringEncodingUTF8)) {
// free(output);
// output = NULL;
// }
//
// cleanup:
// if (configuration != NULL) {
// CFRelease(configuration);
// }
// if (device != NULL && isOpen) {
// (*device)->USBDeviceClose(device);
// }
// if (device != NULL) {
// (*device)->Release(device);
// }
// if (plugin != NULL) {
// (*plugin)->Release(plugin);
// }
// return output;
// }
import "C"
import (
"errors"
Expand Down Expand Up @@ -70,6 +201,7 @@ func extractPortInfo(service io_registry_entry_t) (*PortDetails, error) {
vid, _ := usbDevice.GetIntProperty("idVendor", C.kCFNumberSInt16Type)
pid, _ := usbDevice.GetIntProperty("idProduct", C.kCFNumberSInt16Type)
serialNumber, _ := usbDevice.GetStringProperty("USB Serial Number")
configuration, _ := usbDevice.GetUSBConfigurationString()
//product, _ := usbDevice.GetStringProperty("USB Product Name")
//manufacturer, _ := usbDevice.GetStringProperty("USB Vendor Name")
//fmt.Println(product + " - " + manufacturer)
Expand All @@ -78,6 +210,7 @@ func extractPortInfo(service io_registry_entry_t) (*PortDetails, error) {
port.VID = fmt.Sprintf("%04X", vid)
port.PID = fmt.Sprintf("%04X", pid)
port.SerialNumber = serialNumber
port.Configuration = configuration
}
return port, nil
}
Expand Down Expand Up @@ -197,6 +330,15 @@ func (me *io_registry_entry_t) GetStringProperty(key string) (string, error) {
return C.GoString(&buff[0]), nil
}

func (me *io_registry_entry_t) GetUSBConfigurationString() (string, error) {
configuration := C.copyUSBConfigurationString(C.io_service_t(*me))
if configuration == nil {
return "", errors.New("USB configuration string not available")
}
defer C.free(unsafe.Pointer(configuration))
return C.GoString(configuration), nil
}

func (me *io_registry_entry_t) GetIntProperty(key string, intType C.CFNumberType) (int, error) {
property, err := me.CreateCFProperty(key)
if err != nil {
Expand Down
5 changes: 5 additions & 0 deletions enumerator/usb_linux.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,10 @@ func parseUSBSysFS(usbDevicePath string, details *PortDetails) error {
if err != nil {
return err
}

configuration, _ := readLine(filepath.Join(usbDevicePath, "configuration"))
// It's not an error if the configuration file is not present, so we ignore it.

//manufacturer, err := readLine(filepath.Join(usbDevicePath, "manufacturer"))
//if err != nil {
// return err
Expand All @@ -89,6 +93,7 @@ func parseUSBSysFS(usbDevicePath string, details *PortDetails) error {
details.VID = vid
details.PID = pid
details.SerialNumber = serial
details.Configuration = configuration
//details.Manufacturer = manufacturer
//details.Product = product
return nil
Expand Down
Loading
Loading