summaryrefslogtreecommitdiffstats
path: root/Projects/HIDReportViewer/HIDReportViewer.txt
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2017-07-07 17:55:23 +0200
committerJack Humbert <jack.humb@gmail.com>2017-07-07 17:55:23 +0200
commit60b30c036397cb5627fa374bb930794b225daa29 (patch)
treee156c2d6b27f01db6985f2cc560c9c345d48fdac /Projects/HIDReportViewer/HIDReportViewer.txt
downloadqmk_firmware-60b30c036397cb5627fa374bb930794b225daa29.tar.gz
qmk_firmware-60b30c036397cb5627fa374bb930794b225daa29.tar.xz
Squashed 'lib/lufa/' content from commit 385d40300
git-subtree-dir: lib/lufa git-subtree-split: 385d4030035dbaf41591309dbde47653bd03841b
Diffstat (limited to 'Projects/HIDReportViewer/HIDReportViewer.txt')
-rw-r--r--Projects/HIDReportViewer/HIDReportViewer.txt64
1 files changed, 64 insertions, 0 deletions
diff --git a/Projects/HIDReportViewer/HIDReportViewer.txt b/Projects/HIDReportViewer/HIDReportViewer.txt
new file mode 100644
index 000000000..fccc892c6
--- /dev/null
+++ b/Projects/HIDReportViewer/HIDReportViewer.txt
@@ -0,0 +1,64 @@
+/** \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 HID Device Report Viewer Programmer Project
+ *
+ * \section Sec_Compat Project Compatibility:
+ *
+ * The following list indicates what microcontrollers are compatible with this project.
+ *
+ * \li Series 7 USB AVRs (AT90USBxxx7)
+ *
+ * \section Sec_Info USB Information:
+ *
+ * The following table gives a rundown of the USB utilization of this project.
+ *
+ * <table>
+ * <tr>
+ * <td><b>USB Mode:</b></td>
+ * <td>Host</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Class:</b></td>
+ * <td>Human Interface Device (HID)</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Subclass:</b></td>
+ * <td>N/A</td>
+ * </tr>
+ * <tr>
+ * <td><b>Relevant Standards:</b></td>
+ * <td>USBIF HID Specification \n
+ * USBIF HID Usage Tables</td>
+ * </tr>
+ * <tr>
+ * <td><b>Supported USB Speeds:</b></td>
+ * <td>Low Speed Mode \n
+ * Full Speed Mode</td>
+ * </tr>
+ * </table>
+ *
+ * \section Sec_Description Project Description:
+ *
+ * Firmware for a HID Report viewer. This project is designed to aid in the debugging of USB HID Hosts, where the contents of an
+ * unknown HID device's HID Report need to be examined. Once a HID device has been plugged into this application, the HID report
+ * descriptor will be parsed using the internal LUFA HID report parser, and the results dumped to the serial port in a human
+ * readable format. This output will contain information on the sizes of the reports within the device's HID interface, as well as
+ * information on each report element (size, usage, minimum/maximum values, etc.).
+ *
+ * \section Sec_Options Project Options
+ *
+ * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
+ *
+ * <table>
+ * <tr>
+ * <td>
+ * None
+ * </td>
+ * </tr>
+ * </table>
+ */
+