#include <libkern/OSByteOrder.h>
#include <libkern/c++/OSDictionary.h>
#include <libkern/c++/OSData.h>
#include <IOKit/IOMemoryDescriptor.h>
#include <IOKit/IOKitKeys.h>
#include <IOKit/usb/USB.h>
#include <IOKit/usb/IOUSBController.h>
#include <IOKit/usb/IOUSBNub.h>
#include <IOKit/usb/IOUSBPipe.h>
#include <IOKit/usb/IOUSBHubPolicyMaker.h>
#include <IOKit/usb/IOUSBLog.h>
#define super IOService
OSDefineMetaClass( IOUSBNub, IOService )
OSDefineAbstractStructors(IOUSBNub, IOService)
bool
IOUSBNub::USBCompareProperty( OSDictionary * matching, const char * key )
{
OSObject *value;
bool matches = false;
OSObject *myProperty = NULL;
value = matching->getObject( key );
if( value)
{
myProperty = copyProperty(key);
if (myProperty)
{
matches = value->isEqualTo( myProperty);
myProperty->release();
}
}
else
matches = false;
return matches;
}
bool
IOUSBNub::IsWildCardMatch( OSDictionary * matching, const char * key )
{
OSString *theString;
bool matches;
theString = OSDynamicCast(OSString, matching->getObject( key ));
if( theString)
matches = theString->isEqualTo("*");
else
matches = false;
return matches;
}
bool
IOUSBNub::USBComparePropertyWithMask( OSDictionary *matching, const char *key, const char * maskKey )
{
OSNumber * registryProperty = NULL;
OSNumber * dictionaryProperty = NULL;
OSNumber * dictionaryMask = NULL;
registryProperty = OSDynamicCast(OSNumber, getProperty(key));
dictionaryProperty = OSDynamicCast(OSNumber, matching->getObject(key));
dictionaryMask = OSDynamicCast(OSNumber, matching->getObject(maskKey));
if ( registryProperty && dictionaryProperty && dictionaryMask )
{
UInt32 registryValue = registryProperty->unsigned32BitValue();
UInt32 dictionaryValue = dictionaryProperty->unsigned32BitValue();
UInt32 mask = dictionaryMask->unsigned32BitValue();
if ( (registryValue & mask) == (dictionaryValue & mask) )
{
return true;
}
}
return false;
}
void
IOUSBNub::joinPMtree ( IOService * driver )
{
const IORegistryPlane *usbPlane = NULL;
IOUSBHubDevice *hubDevice = NULL;
IOUSBHubPolicyMaker *hubPolicyMaker = NULL;
usbPlane = getPlane(kIOUSBPlane);
if (usbPlane)
{
hubDevice = OSDynamicCast(IOUSBHubDevice, getParentEntry(usbPlane));
if (!hubDevice && getProvider())
{
hubDevice = OSDynamicCast(IOUSBHubDevice, getProvider()->getParentEntry(usbPlane));
}
if (hubDevice)
{
hubPolicyMaker = hubDevice->GetPolicyMaker();
}
else
{
USBError(1, "%s[%p]::joinPMtree - could not find the hub device", getName(), this);
}
}
if (hubPolicyMaker)
{
hubPolicyMaker->joinPMtree(driver);
}
else
{
USBLog(1, "%s[%p]::joinPMtree - no hub policy maker - calling through to super::joinPMtree", getName(), this);
super::joinPMtree(driver);
}
}
const char *
IOUSBNub::stringFromReturn( IOReturn rtn )
{
static const IONamedValue USBReturn_values[] = {
{kIOUSBUnknownPipeErr, "Pipe is invalid" },
{kIOUSBTooManyPipesErr, "Device specified too many endpoints" },
{kIOUSBNoAsyncPortErr, "Async Port has not been specified" },
{kIOUSBNotEnoughPipesErr, "Desired pipe was not found" },
{kIOUSBNotEnoughPowerErr, "There is not enough power for the device" },
{kIOUSBEndpointNotFound, "Endpoint does not exist" },
{kIOUSBConfigNotFound, "Configuration does not exist" },
{kIOUSBTransactionTimeout, "Rrequest did not finish" },
{kIOUSBTransactionReturned, "Request has been returned to the caller" },
{kIOUSBPipeStalled, "Request returned a STALL" },
{kIOUSBInterfaceNotFound, "Requested interface was not found" },
{kIOUSBLowLatencyBufferNotPreviouslyAllocated, "The buffer was not pre-allocated" },
{kIOUSBLowLatencyFrameListNotPreviouslyAllocated, "The frame list was not pre-allocated" },
{kIOUSBHighSpeedSplitError, "High Speed hub returned a split transaction error" },
{kIOUSBSyncRequestOnWLThread, "Synchronous request was issued while holding from within the workloop" },
{kIOUSBHighSpeedSplitError, "High Speed hub returned a split transaction error" },
{kIOUSBLinkErr, "USB controller error" },
{kIOUSBNotSent1Err, "The isoch transfer did not occur, scheduled too late" },
{kIOUSBNotSent2Err, "The isoch transfer did not occur, scheduled too late" },
{kIOUSBBufferUnderrunErr, "Buffer Underrun (Host hardware failure on data out, PCI busy?" },
{kIOUSBBufferOverrunErr, "Buffer Overrun (Host hardware failure on data out, PCI busy?" },
{kIOUSBReserved2Err, "Reserved error #1" },
{kIOUSBReserved1Err, "Reserved error #2" },
{kIOUSBWrongPIDErr, "Pipe stall, Bad or wrong PID" },
{kIOUSBPIDCheckErr , "Pipe stall, PID CRC error" },
{kIOUSBDataToggleErr, "Pipe stall, Bad data toggle" },
{kIOUSBBitstufErr, "Pipe stall, bitstuffing" },
{kIOUSBCRCErr, "Pipe stall, bad CRC" },
{kIOUSBDeviceNotHighSpeed, "Device is not a high speed device" },
{0, NULL }
};
const char * returnName = super::stringFromReturn(rtn);
if ( returnName =="" )
returnName = IOFindNameForValue(rtn, USBReturn_values);
return returnName;
}