Library Interface

This section describes the Application Programming Interface (API) functions of the USB Device HID library.

Refer to each section for a detailed description.

a) Functions

	Name	Description
	USB_DEVICE_HID_EventHandlerSet	This function registers a event handler for the specified HID function driver instance.
	USB_DEVICE_HID_ReportReceive	This function submits the buffer to HID function driver library to receive a report from host to device.
	USB_DEVICE_HID_ReportSend	This function submits the buffer to HID function driver library to send a report from device to host.
	USB_DEVICE_HID_TransferCancel	This function cancels a scheduled HID Device data transfer.

b) Data Types and Constants

	Name	Description
	USB_DEVICE_HID_EVENT	USB Device HID Function Driver Events
	USB_DEVICE_HID_EVENT_DATA_GET_IDLE	USB Device HID Get Idle Event Data Type.
	USB_DEVICE_HID_EVENT_DATA_GET_REPORT	USB Device HID Get Report Event Data Type.
	USB_DEVICE_HID_EVENT_DATA_REPORT_RECEIVED	USB Device HID Report Received Event Data Type.
	USB_DEVICE_HID_EVENT_DATA_REPORT_SENT	USB Device HID Report Sent Event Data Type.
	USB_DEVICE_HID_EVENT_DATA_SET_IDLE	USB Device HID Set Idle Event Data Type.
	USB_DEVICE_HID_EVENT_DATA_SET_REPORT	USB Device HID Set Report Event Data Type.
	USB_DEVICE_HID_EVENT_DATA_SET_PROTOCOL	USB Device HID Set Protocol Event Data Type.
	USB_DEVICE_HID_INDEX	USB device HID Function Driver Index.
	USB_DEVICE_HID_TRANSFER_HANDLE	USB Device HID Function Driver Transfer Handle Definition.
	USB_DEVICE_HID_EVENT_HANDLER	USB Device HID Event Handler Function Pointer Type.
	USB_DEVICE_HID_EVENT_RESPONSE	USB Device HID Function Driver Event Callback Response Type
	USB_DEVICE_HID_RESULT	USB Device HID Function Driver USB Device HID Result enumeration.
	USB_DEVICE_HID_EVENT_RESPONSE_NONE	USB Device HID Function Driver Event Handler Response Type None.
	USB_DEVICE_HID_TRANSFER_HANDLE_INVALID	USB Device HID Function Driver Invalid Transfer Handle Definition.
	USB_DEVICE_HID_INIT	USB Device HID Function Driver Initialization Data Structure
	USB_DEVICE_HID_FUNCTION_DRIVER	This is a pointer to a group of HID Function Driver callback function pointers.
	USB_DEVICE_HID_INDEX_0	USB Device HID Function Driver Index Constants
	USB_DEVICE_HID_INDEX_1	This is macro USB_DEVICE_HID_INDEX_1.
	USB_DEVICE_HID_INDEX_2	This is macro USB_DEVICE_HID_INDEX_2.
	USB_DEVICE_HID_INDEX_3	This is macro USB_DEVICE_HID_INDEX_3.
	USB_DEVICE_HID_INDEX_4	This is macro USB_DEVICE_HID_INDEX_4.
	USB_DEVICE_HID_INDEX_5	This is macro USB_DEVICE_HID_INDEX_5.
	USB_DEVICE_HID_INDEX_6	This is macro USB_DEVICE_HID_INDEX_6.
	USB_DEVICE_HID_INDEX_7	This is macro USB_DEVICE_HID_INDEX_7.

USB Libraries Help > USB Device Libraries > USB HID Device Library > Library Interface

MPLAB Harmony USB Stack

Contents | Home

Previous | Up | Next

Documentation Feedback
Microchip Support