_HID_DEVICE Struct Reference

#include <hid.h>

Data Fields
DEVICE	device
	The Device entry for this HID.
uint32_t	hidid
	Unique Id of this HID in the HID device table.
uint32_t	hidstate
	HID device state (eg HID_STATE_ATTACHED).
HID_CONSUMER *	consumer
	The consumer which is bound to this device (or nil if not bound).
hid_device_get_idle_proc	devicegetidle
	A device specific GetIdle method (If supported by provider).
hid_device_set_idle_proc	devicesetidle
	A device specific SetIdle method (If supported by provider).
hid_device_get_report_proc	devicegetreport
	A device specific GetReport method (If supported by provider).
hid_device_set_report_proc	devicesetreport
	A device specific SetReport method (If supported by provider).
hid_device_allocate_report_proc	deviceallocatereport
	A device specific AllocateReport method (If supported by provider).
hid_device_release_report_proc	devicereleasereport
	A device specific ReleaseReport method (If supported by provider).
hid_device_submit_report_proc	devicesubmitreport
	A device specific SubmitReport method (If supported by provider).
hid_device_cancel_report_proc	devicecancelreport
	A device specific CancelReport method (If supported by provider).
hid_device_get_protocol_proc	devicegetprotocol
	A device specific GetProtocol method (If supported by provider).
hid_device_set_protocol_proc	devicesetprotocol
	A device specific SetProtocol method (If supported by provider).
hid_device_get_interval_proc	devicegetinterval
	A device specific GetInterval method (If supported by provider).
hid_device_set_interval_proc	devicesetinterval
	A device specific SetInterval method (If supported by provider).
hid_device_get_report_descriptor_proc	devicegetreportdescriptor
	A device specific GetReportDescriptor method (If supported by provider).
hid_device_get_physical_descriptor_set0_proc	devicegetphysicaldescriptorset0
	A device specific GetPhysicalDescriptorSet0 method (If supported by provider).
hid_device_get_physical_descriptor_set_proc	devicegetphysicaldescriptorset
	A device specific GetPhysicalDescriptorSet method (If supported by provider).
MUTEX_HANDLE	lock
	HID device lock.
void *	privatedata
	Private data for the consumer of this HID device (If applicable).
HID_COLLECTION *	collections
	The parsed report descriptor with collections, reports and usages.
uint32_t	collectioncount
	The number of top level collections contained in the report descriptor.
HID_REPORT_DESCRIPTOR *	descriptor
	The raw report descriptor obtained from the device.
uint32_t	descriptorsize
	The size of the data pointed to by Descriptor.
uint32_t	receivecount
uint32_t	receiveerrors
HID_DEVICE *	prev
	Previous entry in Device table.
HID_DEVICE *	next
	Next entry in Device table.

Field Documentation

device

DEVICE device

The Device entry for this HID.

hidid

uint32_t hidid

Unique Id of this HID in the HID device table.

hidstate

uint32_t hidstate

HID device state (eg HID_STATE_ATTACHED).

consumer

HID_CONSUMER* consumer

The consumer which is bound to this device (or nil if not bound).

devicegetidle

hid_device_get_idle_proc devicegetidle

A device specific GetIdle method (If supported by provider).

devicesetidle

hid_device_set_idle_proc devicesetidle

A device specific SetIdle method (If supported by provider).

devicegetreport

hid_device_get_report_proc devicegetreport

A device specific GetReport method (If supported by provider).

devicesetreport

hid_device_set_report_proc devicesetreport

A device specific SetReport method (If supported by provider).

deviceallocatereport

hid_device_allocate_report_proc deviceallocatereport

A device specific AllocateReport method (If supported by provider).

devicereleasereport

hid_device_release_report_proc devicereleasereport

A device specific ReleaseReport method (If supported by provider).

devicesubmitreport

hid_device_submit_report_proc devicesubmitreport

A device specific SubmitReport method (If supported by provider).

devicecancelreport

hid_device_cancel_report_proc devicecancelreport

A device specific CancelReport method (If supported by provider).

devicegetprotocol

hid_device_get_protocol_proc devicegetprotocol

A device specific GetProtocol method (If supported by provider).

devicesetprotocol

hid_device_set_protocol_proc devicesetprotocol

A device specific SetProtocol method (If supported by provider).

devicegetinterval

hid_device_get_interval_proc devicegetinterval

A device specific GetInterval method (If supported by provider).

devicesetinterval

hid_device_set_interval_proc devicesetinterval

A device specific SetInterval method (If supported by provider).

devicegetreportdescriptor

hid_device_get_report_descriptor_proc devicegetreportdescriptor

A device specific GetReportDescriptor method (If supported by provider).

devicegetphysicaldescriptorset0

hid_device_get_physical_descriptor_set0_proc devicegetphysicaldescriptorset0

A device specific GetPhysicalDescriptorSet0 method (If supported by provider).

devicegetphysicaldescriptorset

hid_device_get_physical_descriptor_set_proc devicegetphysicaldescriptorset

A device specific GetPhysicalDescriptorSet method (If supported by provider).

lock

MUTEX_HANDLE lock

HID device lock.

privatedata

void* privatedata

Private data for the consumer of this HID device (If applicable).

collections

HID_COLLECTION* collections

The parsed report descriptor with collections, reports and usages.

collectioncount

uint32_t collectioncount

The number of top level collections contained in the report descriptor.

descriptor

HID_REPORT_DESCRIPTOR* descriptor

The raw report descriptor obtained from the device.

descriptorsize

uint32_t descriptorsize

The size of the data pointed to by Descriptor.

receivecount

uint32_t receivecount

receiveerrors

uint32_t receiveerrors

prev

HID_DEVICE* prev

Previous entry in Device table.

next

HID_DEVICE* next

Next entry in Device table.

---

The documentation for this struct was generated from the following file:

• ultibo/hid.h