ADC Home > Reference Library > Reference > Darwin > Kernel Framework Reference

---

IOHIDInterface

Overview

In kernel interface to a HID device.

---

Functions

free

Free the IOHIDInterface object.

init

Initialize an IOHIDInterface object.

matchPropertyTable

Called by the provider during a match

start

Start up the driver using the given provider.

---

free

---

Free the IOHIDInterface object.

protected

virtual void free(); 

Discussion

Release all resources that were previously allocated, then call super::free() to propagate the call to our superclass.

---

init

---

Initialize an IOHIDInterface object.

public

virtual bool init(
    OSDictionary *dictionary = 0 ); 

Parameters

A

dictionary A property table associated with this IOHIDInterface instance.

Return Value

True on sucess, or false otherwise.

Discussion

Prime the IOHIDInterface object and prepare it to support a probe() or a start() call. This implementation will simply call super::init().

---

matchPropertyTable

---

Called by the provider during a match

public

virtual bool matchPropertyTable( 
    OSDictionary *table, 
    SInt32 *score); 

Parameters

table

The property table that this device will match against

Discussion

Compare the properties in the supplied table to this object's properties.

---

start

---

Start up the driver using the given provider.

public

virtual bool start(
    IOService *provider ); 

Parameters

provider

The provider that the driver was matched to, and selected to run with.

Return Value

True on success, or false otherwise.

Discussion

IOHIDInterface will allocate resources. Before returning true to indicate success, registerService() is called to trigger client matching.

Typedefs

---

CompletionAction

---

See Also:

IOHIDInterface::CompletionAction

public

typedef void ( *CompletionAction)( 
    OSObject *target, 
    void *refcon, 
    IOReturn status, 
    UInt32 bufferSizeRemaining); 

Fields

target

refcon

status

Completion status.

bufferSizeRemaining

Bytes left to be transferred.

Discussion

Function called when HID I/O completes.

---

InterruptReportAction

---

Callback to handle an asynchronous report received from the HID device.

See Also:

IOHIDInterface::InterruptReportAction

public

typedef void ( *InterruptReportAction)( 
    OSObject *target, 
    AbsoluteTime timestamp, 
    IOMemoryDescriptor *report, 
    IOHIDReportType type, 
    UInt32 reportID, 
    void *refcon); 

Fields

target

Pointer to your data object.

timestamp

Time when the report was delivered.

report

A memory descriptor that describes the report.

reportType

The type of report.

reportID

The ID of the report.

refcon

void * pointer to more data.

Discussion

This callback is set when calling IOHIDInterface::open.

---

IOHIDInterface::CompletionAction

---

See Also:

CompletionAction

public

typedef void ( *CompletionAction)( 
    OSObject *target, 
    void *refcon, 
    IOReturn status, 
    UInt32 bufferSizeRemaining); 

Fields

target

refcon

status

Completion status.

bufferSizeRemaining

Bytes left to be transferred.

Discussion

Function called when HID I/O completes.

---

IOHIDInterface::InterruptReportAction

---

Callback to handle an asynchronous report received from the HID device.

See Also:

InterruptReportAction

public

typedef void ( *InterruptReportAction)( 
    OSObject *target, 
    AbsoluteTime timestamp, 
    IOMemoryDescriptor *report, 
    IOHIDReportType type, 
    UInt32 reportID, 
    void *refcon); 

Fields

target

Pointer to your data object.

timestamp

Time when the report was delivered.

report

A memory descriptor that describes the report.

reportType

The type of report.

reportID

The ID of the report.

refcon

void * pointer to more data.

Discussion

This callback is set when calling IOHIDInterface::open.

Member Data

---

_reserved

---

See Also:

reserved

private

ExpansionData * _reserved; 

Discussion

Reserved for future use. (Internal use only)

---

reserved

---

See Also:

_reserved

private

ExpansionData * _reserved; 

Discussion

Reserved for future use. (Internal use only)

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: 2008-12-19