Dileep
Dileep

Reputation: 2435

How to create a program to list all the USB devices in a Mac?

I have a limited exposure to the Mac OS X operating system and now I have started using Xcode and am studying about I/O kit. I need to create a program in Xcode under command line tool in order to list all USB devices connected in a Mac system. Those who have previous experience under this, please help me. If anyone could provide me with sample code then it will be of great use, as I am looking for starting point.

Upvotes: 22

Views: 20410

Answers (4)

Hasturkun
Hasturkun

Reputation: 36412

You can adapt USBPrivateDataSample to your needs, the sample sets up a notifier, lists the currently attached devices, then waits for device attach/detach. If you do, you will want to remove the usbVendor and usbProduct matching dictionaries, so all USB devices are matched.

Alternately, you can use IOServiceGetMatchingServices to get an iterator for all current matching services, using a dictionary created by IOServiceMatching(kIOUSBDeviceClassName).

Here's a short sample (which I've never run):

#include <IOKit/IOKitLib.h>
#include <IOKit/usb/IOUSBLib.h>

int main(int argc, const char *argv[])
{
    CFMutableDictionaryRef matchingDict;
    io_iterator_t iter;
    kern_return_t kr;
    io_service_t device;

    /* set up a matching dictionary for the class */
    matchingDict = IOServiceMatching(kIOUSBDeviceClassName);
    if (matchingDict == NULL)
    {
        return -1; // fail
    }

    /* Now we have a dictionary, get an iterator.*/
    kr = IOServiceGetMatchingServices(kIOMasterPortDefault, matchingDict, &iter);
    if (kr != KERN_SUCCESS)
    {
        return -1;
    }

    /* iterate */
    while ((device = IOIteratorNext(iter)))
    {
        /* do something with device, eg. check properties */
        /* ... */
        /* And free the reference taken before continuing to the next item */
        IOObjectRelease(device);
    }

   /* Done, release the iterator */
   IOObjectRelease(iter);
   return 0;
}

Upvotes: 24

Michael N
Michael N

Reputation: 559

Here's a Swift version to list connected USB devices:

import IOKit
import IOKit.ps
import IOKit.usb

func findMatchingPorts() -> Bool {
    
    print("------------------")
    print("findMatchingPorts")
    print("------------------")

    var matchingDict : CFMutableDictionary?
    
    var iter : io_iterator_t = 0
    var kr : kern_return_t
    var device : io_service_t
    
    /* set up a matching dictionary for the class */
    
    matchingDict = IOServiceMatching(kIOUSBDeviceClassName)
    
    if matchingDict == nil {
        
        // no matching ports
        
        print("no matching ports")
        
        return false
        
    }
    
    /* Now we have a dictionary, get an iterator.*/
    
    kr = IOServiceGetMatchingServices(
        kIOMasterPortDefault,
        matchingDict,
        &iter
    )
    
    if (kr != KERN_SUCCESS) {
        
        // fail
        
        print("fail")

        return false
        
    }
    
    /* iterate */
            
    repeat {
        
        device = IOIteratorNext(iter)

        guard device != 0 else {
            
            break
            
        }
        
        /* do something with device, eg. check properties */
        /* ... */
        /* And free the reference taken before continuing to the next item */
        
        print("device: \(device)")
        print(device.name())
        
        // release device reference
        
        IOObjectRelease(device)
        
    } while (true)
    
    /* Done, release the iterator */
    
    IOObjectRelease(iter)
    
    print("done")

    return true
    
}

extension io_service_t {
    /// - Returns: The device's name.
    func name() -> String? {
        let buf = UnsafeMutablePointer<io_name_t>.allocate(capacity: 1)
        defer { buf.deallocate() }
        return buf.withMemoryRebound(to: CChar.self, capacity: MemoryLayout<io_name_t>.size) {
            if IORegistryEntryGetName(self, $0) == KERN_SUCCESS {
                return String(cString: $0)
            }
            return nil
        }
    }
}

Upvotes: 0

Paul R
Paul R

Reputation: 213110

You just need to access the IOKit Registry. You may well be able to use the ioreg tool to do this (e.g. run it via system() or popen()). If not then you can at least use it to verify your code:

Info on ioreg tool:

$ man ioreg

Get list of USB devices:

$ ioreg -Src IOUSBDevice

Upvotes: 7

Nicholas Smith
Nicholas Smith

Reputation: 11754

If you run system_profiler SPUSBDataType it'll list all the USB devices connected to the system, you can then interact with that data either by dumping it into a text file or reading it from the command into the application and working with it there.

Upvotes: 3

Related Questions