HID API

Collaboration diagram for HID API:

Data Structures
struct	HIDDevice
struct	HIDClient

Typedefs
typedef struct HIDClient	HIDClient
typedef struct HIDDevice	HIDDevice
typedef enum HIDAttachEvent	HIDAttachEvent
typedef int32_t(*	HIDAttachCallback) (HIDClient *client, HIDDevice *device, HIDAttachEvent attach)
typedef void(*	HIDCallback) (uint32_t handle, int32_t error, uint8_t *buffer, uint32_t bytesTransferred, void *userContext)

Enumerations
enum	HIDAttachEvent {   HID_DEVICE_DETACH = 0 ,   HID_DEVICE_ATTACH = 1 }

Functions
int32_t	HIDSetup ()
int32_t	HIDTeardown ()
int32_t	HIDAddClient (HIDClient *client, HIDAttachCallback attachCallback)
int32_t	HIDDelClient (HIDClient *client)
int32_t	HIDGetDescriptor (uint32_t handle, uint8_t descriptorType, uint8_t descriptorIndex, uint16_t languageId, uint8_t *buffer, uint32_t bufferLength, HIDCallback callback, void *userContext)
int32_t	HIDSetDescriptor (uint32_t handle, uint8_t descriptorType, uint8_t descriptorIndex, uint16_t languageId, uint8_t *buffer, uint32_t bufferLength, HIDCallback callback, void *userContext)
int32_t	HIDGetReport (uint32_t handle, uint8_t reportType, uint8_t reportId, uint8_t *buffer, uint32_t bufferLength, HIDCallback callback, void *userContext)
int32_t	HIDSetReport (uint32_t handle, uint8_t reportType, uint8_t reportId, uint8_t *buffer, uint32_t bufferLength, HIDCallback callback, void *userContext)
int32_t	HIDGetIdle (uint32_t handle, uint8_t interfaceIndex, uint8_t reportId, uint8_t *duration, HIDCallback callback, void *userContext)
int32_t	HIDSetIdle (uint32_t handle, uint8_t interfaceIndex, uint8_t reportId, uint8_t duration, HIDCallback callback, void *userContext)
int32_t	HIDSetProtocol (uint32_t handle, uint8_t interfaceIndex, uint8_t protocol, HIDCallback callback, void *userContext)
int32_t	HIDGetProtocol (uint32_t handle, uint8_t interfaceIndex, uint8_t *protocol, HIDCallback callback, void *userContext)
int32_t	HIDRead (uint32_t handle, uint8_t *buffer, uint32_t bufferLength, HIDCallback callback, void *userContext)
int32_t	HIDWrite (uint32_t handle, uint8_t *buffer, uint32_t bufferLength, HIDCallback hc, void *userContext)

Detailed Description

---

Data Structure Documentation

HIDDevice

struct HIDDevice

Definition at line 34 of file hid.h.

Data Fields
uint32_t	handle
uint32_t	physicalDeviceInst
uint16_t	vid
uint16_t	pid
uint8_t	interfaceIndex
uint8_t	subClass
uint8_t	protocol
uint16_t	maxPacketSizeRx
uint16_t	maxPacketSizeTx

HIDClient

struct HIDClient

Definition at line 58 of file hid.h.

Data Fields
HIDClient *	next
HIDAttachCallback	attachCallback

Typedef Documentation

HIDClient

typedef struct HIDClient HIDClient

Definition at line 1 of file hid.h.

HIDDevice

typedef struct HIDDevice HIDDevice

Definition at line 1 of file hid.h.

HIDAttachEvent

typedef enum HIDAttachEvent HIDAttachEvent

HIDAttachCallback

typedef int32_t(* HIDAttachCallback) (HIDClient *client, HIDDevice *device, HIDAttachEvent attach)

Definition at line 22 of file hid.h.

HIDCallback

typedef void(* HIDCallback) (uint32_t handle, int32_t error, uint8_t *buffer, uint32_t bytesTransferred, void *userContext)

Definition at line 27 of file hid.h.

Enumeration Type Documentation

HIDAttachEvent

enum HIDAttachEvent

Enumerator
HID_DEVICE_DETACH
HID_DEVICE_ATTACH

Definition at line 16 of file hid.h.

Function Documentation

HIDSetup()

int32_t HIDSetup

(

)

HIDTeardown()

int32_t HIDTeardown

(

)

HIDAddClient()

int32_t HIDAddClient	(	HIDClient *	client,
		HIDAttachCallback	attachCallback
	)

HIDDelClient()

int32_t HIDDelClient

(

HIDClient *

client

)

HIDGetDescriptor()

int32_t HIDGetDescriptor	(	uint32_t	handle,
		uint8_t	descriptorType,
		uint8_t	descriptorIndex,
		uint16_t	languageId,
		uint8_t *	buffer,
		uint32_t	bufferLength,
		HIDCallback	callback,
		void *	userContext
	)

HIDSetDescriptor()

int32_t HIDSetDescriptor	(	uint32_t	handle,
		uint8_t	descriptorType,
		uint8_t	descriptorIndex,
		uint16_t	languageId,
		uint8_t *	buffer,
		uint32_t	bufferLength,
		HIDCallback	callback,
		void *	userContext
	)

HIDGetReport()

int32_t HIDGetReport	(	uint32_t	handle,
		uint8_t	reportType,
		uint8_t	reportId,
		uint8_t *	buffer,
		uint32_t	bufferLength,
		HIDCallback	callback,
		void *	userContext
	)

HIDSetReport()

int32_t HIDSetReport	(	uint32_t	handle,
		uint8_t	reportType,
		uint8_t	reportId,
		uint8_t *	buffer,
		uint32_t	bufferLength,
		HIDCallback	callback,
		void *	userContext
	)

HIDGetIdle()

int32_t HIDGetIdle	(	uint32_t	handle,
		uint8_t	interfaceIndex,
		uint8_t	reportId,
		uint8_t *	duration,
		HIDCallback	callback,
		void *	userContext
	)

HIDSetIdle()

int32_t HIDSetIdle	(	uint32_t	handle,
		uint8_t	interfaceIndex,
		uint8_t	reportId,
		uint8_t	duration,
		HIDCallback	callback,
		void *	userContext
	)

HIDSetProtocol()

int32_t HIDSetProtocol	(	uint32_t	handle,
		uint8_t	interfaceIndex,
		uint8_t	protocol,
		HIDCallback	callback,
		void *	userContext
	)

HIDGetProtocol()

int32_t HIDGetProtocol	(	uint32_t	handle,
		uint8_t	interfaceIndex,
		uint8_t *	protocol,
		HIDCallback	callback,
		void *	userContext
	)

HIDRead()

int32_t HIDRead	(	uint32_t	handle,
		uint8_t *	buffer,
		uint32_t	bufferLength,
		HIDCallback	callback,
		void *	userContext
	)

HIDWrite()

int32_t HIDWrite	(	uint32_t	handle,
		uint8_t *	buffer,
		uint32_t	bufferLength,
		HIDCallback	hc,
		void *	userContext
	)