ADC Home > Reference Library > Reference > Hardware & Drivers > I/O Kit Framework Reference

---

IOUSBInterfaceInterface197

Overview

The object you use to access a USB device interface from user space, returned by the IOUSBFamily version 1.9.7 and above.

Discussion

The functions listed here include all of the functions defined for the IOUSBInterfaceInterface, IOUSBInterfaceInterface182, IOUSBInterfaceInterface183, IOUSBInterfaceInterface190, IOUSBInterfaceInterface192, and some new functions that are available on Mac OS X version 10.2.5 and later.

---

Functions

GetBusMicroFrameNumber

Gets the current micro frame number of the bus to which the interface and its device are attached.

GetFrameListTime

Returns the number of microseconds in each USB Frame.

GetIOUSBLibVersion

Returns the version of the IOUSBLib and the version of the IOUSBFamily.

---

GetBusMicroFrameNumber

---

Gets the current micro frame number of the bus to which the interface and its device are attached.

IOReturn ( *GetBusMicroFrameNumber)(
    void *self,
    UInt64 *microFrame,
    AbsoluteTime *atTime);  

Parameters

self

Pointer to the IOUSBInterfaceInterface.

microFrame

Pointer to UInt64 to hold the microrame number.

atTime

Pointer to an AbsoluteTime, which should be within 1ms of the time when the bus frame number was attained.

Return Value

Returns kIOReturnSuccess if successful, kIOReturnNoDevice if there is no connection to an IOService.

Discussion

The interface does not have to be open to use this function.

Availability

This function is only available with IOUSBInterfaceInterface197 and above.

---

GetFrameListTime

---

Returns the number of microseconds in each USB Frame.

IOReturn ( *GetFrameListTime)(
    void *self,
    UInt32 *microsecondsInFrame);  

Parameters

self

Pointer to the IOUSBInterfaceInterface.

microsecondsInFrame

Pointer to UInt32 to hold the number of microseconds in each USB frame.

Return Value

Returns kIOReturnSuccess if successful, kIOReturnNoDevice if there is no connection to an IOService.

Discussion

This function can be used to determine whether the device is functioning in full speed or a high speed. In the case of a full speed device, the returned value will be kUSBFullSpeedMicrosecondsInFrame. In the case of a high speed device, the return value will be kUSBHighSpeedMicrosecondsInFrame. (This API should really be called GetUSBFrameTime).

The interface does not have to be open to use this function.

Availability

This function is only available with IOUSBInterfaceInterface197 and above.

---

GetIOUSBLibVersion

---

Returns the version of the IOUSBLib and the version of the IOUSBFamily.

IOReturn ( *GetIOUSBLibVersion)(
    void *self,
    NumVersion *ioUSBLibVersion,
    NumVersion *usbFamilyVersion);  

Parameters

self

Pointer to the IOUSBInterfaceInterface.

ioUSBLibVersion

Pointer to a NumVersion structure that on return will contain the version of the IOUSBLib.

usbFamilyVersion

Pointer to a NumVersion structure that on return will contain the version of the IOUSBFamily.

Return Value

Returns kIOReturnSuccess if successful, kIOReturnNoDevice if there is no connection to an IOService.

Discussion

The interface does not have to be open to use this function.

Availability

This function is only available with IOUSBInterfaceInterface197 and above.

Did this document help you? Yes: Tell us what works for you. It’s good, but: Report typos, inaccuracies, and so forth. It wasn’t helpful: Tell us what would have helped.

 

Last Updated: 2009-02-23