tstOpenUSBDev.cpp revision 230bd8589bba39933ac5ec21482d6186d675e604
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * Testcase that attempts to locate and open the specfied device.
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * Copyright (C) 2006-2007 Oracle Corporation
c55c68b6a3324172e9dc207926215845880b0f90vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
c55c68b6a3324172e9dc207926215845880b0f90vboxsync * available from http://www.virtualbox.org. This file is free software;
c55c68b6a3324172e9dc207926215845880b0f90vboxsync * you can redistribute it and/or modify it under the terms of the GNU
c55c68b6a3324172e9dc207926215845880b0f90vboxsync * General Public License (GPL) as published by the Free Software
c55c68b6a3324172e9dc207926215845880b0f90vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
c55c68b6a3324172e9dc207926215845880b0f90vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
c55c68b6a3324172e9dc207926215845880b0f90vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
59190ecd61435d19ba3515b876272aee7bd12298vboxsync/*******************************************************************************
59190ecd61435d19ba3515b876272aee7bd12298vboxsync* Header Files *
59190ecd61435d19ba3515b876272aee7bd12298vboxsync*******************************************************************************/
59190ecd61435d19ba3515b876272aee7bd12298vboxsync#include <IOKit/storage/IOStorageDeviceCharacteristics.h>
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * Gets an unsigned 32-bit integer value.
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * @returns Success indicator (true/false).
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * @param DictRef The dictionary.
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * @param KeyStrRef The key name.
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * @param pu32 Where to store the key value.
59190ecd61435d19ba3515b876272aee7bd12298vboxsyncstatic bool tstDictGetU32(CFMutableDictionaryRef DictRef, CFStringRef KeyStrRef, uint32_t *pu32)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync CFTypeRef ValRef = CFDictionaryGetValue(DictRef, KeyStrRef);
59190ecd61435d19ba3515b876272aee7bd12298vboxsync if (CFNumberGetValue((CFNumberRef)ValRef, kCFNumberSInt32Type, pu32))
59190ecd61435d19ba3515b876272aee7bd12298vboxsync return true;
59190ecd61435d19ba3515b876272aee7bd12298vboxsync return false;
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * Gets an unsigned 64-bit integer value.
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * @returns Success indicator (true/false).
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * @param DictRef The dictionary.
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * @param KeyStrRef The key name.
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * @param pu64 Where to store the key value.
59190ecd61435d19ba3515b876272aee7bd12298vboxsyncstatic bool tstDictGetU64(CFMutableDictionaryRef DictRef, CFStringRef KeyStrRef, uint64_t *pu64)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync CFTypeRef ValRef = CFDictionaryGetValue(DictRef, KeyStrRef);
59190ecd61435d19ba3515b876272aee7bd12298vboxsync if (CFNumberGetValue((CFNumberRef)ValRef, kCFNumberSInt64Type, pu64))
59190ecd61435d19ba3515b876272aee7bd12298vboxsync return true;
59190ecd61435d19ba3515b876272aee7bd12298vboxsync return false;
59190ecd61435d19ba3515b876272aee7bd12298vboxsyncstatic int tstDoWork(io_object_t USBDevice, mach_port_t MasterPort, const char *argv0)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * Create a plugin interface for the device and query its IOUSBDeviceInterface.
59190ecd61435d19ba3515b876272aee7bd12298vboxsync IOReturn irc = IOCreatePlugInInterfaceForService(USBDevice, kIOUSBDeviceUserClientTypeID,
59190ecd61435d19ba3515b876272aee7bd12298vboxsync kIOCFPlugInInterfaceID, &ppPlugInInterface, &Score);
59190ecd61435d19ba3515b876272aee7bd12298vboxsync HRESULT hrc = (*ppPlugInInterface)->QueryInterface(ppPlugInInterface,
59190ecd61435d19ba3515b876272aee7bd12298vboxsync irc = IODestroyPlugInInterface(ppPlugInInterface); Assert(irc == kIOReturnSuccess);
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * Try open the device for exclusive access.
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * Re-enumerate the device and bail out.
59190ecd61435d19ba3515b876272aee7bd12298vboxsync RTPrintf("%s: Failed to re-enumerate the device, irc=%#x (vrc=%Rrc).\n", argv0, irc, vrc);
59190ecd61435d19ba3515b876272aee7bd12298vboxsync RTPrintf("%s: The device is being used by another process (irc=kIOReturnExclusiveAccess)\n", argv0);
59190ecd61435d19ba3515b876272aee7bd12298vboxsync RTPrintf("%s: Failed to open the device, irc=%#x (vrc=%Rrc).\n", argv0, irc, vrc);
59190ecd61435d19ba3515b876272aee7bd12298vboxsync RTPrintf("%s: Failed to create plugin interface for the device, hrc=%#x (vrc=%Rrc).\n", argv0, hrc, vrc);
59190ecd61435d19ba3515b876272aee7bd12298vboxsync RTPrintf("%s: Failed to open the device, plug-in creation failed with irc=%#x (vrc=%Rrc).\n", argv0, irc, vrc);
59190ecd61435d19ba3515b876272aee7bd12298vboxsync "Criteria:\n"
59190ecd61435d19ba3515b876272aee7bd12298vboxsync " -l <location>\n"
59190ecd61435d19ba3515b876272aee7bd12298vboxsync " -s <session>\n"
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * Show help if not arguments.
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * Parse arguments.
59190ecd61435d19ba3515b876272aee7bd12298vboxsync RTGetOptInit(&GetState, argc, argv, g_aOptions, RT_ELEMENTS(g_aOptions), 1, 0 /* fFlags */);
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * Open the master port.
59190ecd61435d19ba3515b876272aee7bd12298vboxsync RTPrintf("%s: IOMasterPort -> %x\n", argv[0], krc);
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * Iterate the USB devices and find all that matches.
59190ecd61435d19ba3515b876272aee7bd12298vboxsync CFMutableDictionaryRef RefMatchingDict = IOServiceMatching(kIOUSBDeviceClassName);
59190ecd61435d19ba3515b876272aee7bd12298vboxsync RTPrintf("%s: IOServiceMatching failed\n", argv[0]);
59190ecd61435d19ba3515b876272aee7bd12298vboxsync IOReturn irc = IOServiceGetMatchingServices(MasterPort, RefMatchingDict, &USBDevices);
59190ecd61435d19ba3515b876272aee7bd12298vboxsync RTPrintf("%s: IOServiceGetMatchingServices -> %#x\n", argv[0], irc);
59190ecd61435d19ba3515b876272aee7bd12298vboxsync RefMatchingDict = NULL; /* the reference is consumed by IOServiceGetMatchingServices. */
59190ecd61435d19ba3515b876272aee7bd12298vboxsync unsigned cDevices = 0;
59190ecd61435d19ba3515b876272aee7bd12298vboxsync unsigned cMatches = 0;
59190ecd61435d19ba3515b876272aee7bd12298vboxsync krc = IORegistryEntryCreateCFProperties(USBDevice, &PropsRef, kCFAllocatorDefault, kNilOptions);
59190ecd61435d19ba3515b876272aee7bd12298vboxsync || ( tstDictGetU64(PropsRef, CFSTR("sessionID"), &u64CurSessionId)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync || ( tstDictGetU32(PropsRef, CFSTR(kUSBDevicePropertyLocationID), &u32CurLocationId)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync * Bitch if we didn't find anything matching the criteria.
59190ecd61435d19ba3515b876272aee7bd12298vboxsync RTPrintf("%s: No matching devices found from a total of %d.\n", argv[0], cDevices);