/** \file * * This file contains special DoxyGen information for the generation of the main page and other special * documentation pages. It is not a project source file. */ /** \mainpage Generic HID Device * * \section SSec_Info USB Information: * * The following table gives a rundown of the USB utilization of this demo. * * * * * * * * * * * * * * * * * * * * * * *
USB Mode:Device
USB Class:Human Interface Device (HID)
USB Subclass:N/A
Relevant Standards:USBIF HID Specification, USBIF HID Usage Tables
Usable Speeds:Low Speed Mode, Full Speed Mode
* * \section SSec_Description Project Description: * * Generic HID device demonstration application. This gives a simple reference application * for implementing a generic HID device, using the basic USB HID drivers in all modern * OSes (i.e. no special drivers required). It accepts and sends up to 255 byte reports to * and from a USB Host, and by default transmits the last sent report back to the host. * * On startup the system will automatically enumerate and function as a vendor HID device. * When controlled by a custom HID class application, reports can be sent and received by * both the standard data endpoint and control request methods defined in the HID specification. * * \section SSec_Options Project Options * * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. * * * * * * * * * * * * * * * * * * * * * * *
Define Name:Location:Description:
GENERIC_REPORT_SIZEDescriptors.hThis token defines the size of the device reports, both sent and received. The value must be an * integer ranging from 1 to 255.
INTERRUPT_CONTROL_ENDPOINTMakefile CDEFSWhen defined, this causes the demo to enable interrupts for the control endpoint, * which services control requests from the host. If not defined, the control endpoint * is serviced via polling using the task scheduler.
INTERRUPT_DATA_ENDPOINTMakefile CDEFSWhen defined, this causes the demo to enable interrupts for the data endpoints, * which services incomming LED reports and outgoing key status reports to and from the host. * If not defined, the data endpoints are serviced via polling using the task scheduler.
*/