Add tag for the 120219 release.

[pub/USBasp.git] / Demos / Host / LowLevel / JoystickHostWithParser / HIDReport.h

diff --git a/Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.h b/Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.h
index 8fb0456..195e8a7 100644 (file)
--- a/Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.h
+++ b/Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2012.
+
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in
   all copies and that both that the copyright notice and this
-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
@@ -38,49 +38,33 @@
 
        /* Includes: */
                #include <LUFA/Drivers/USB/USB.h>
-               #include <LUFA/Drivers/USB/Class/Host/HIDParser.h>
-               
+
                #include "JoystickHostWithParser.h"
 
        /* Macros: */
-               /** HID Report Descriptor Usage for a Joystick */
-               #define USAGE_JOYSTICK              0x04
-
-               /** HID Report Descriptor Usage Page value for a toggle button */
+               /** HID Report Descriptor Usage Page value for a toggle button. */
                #define USAGE_PAGE_BUTTON           0x09
 
-               /** HID Report Descriptor Usage Page value for a Generic Desktop Control */
+               /** HID Report Descriptor Usage Page value for a Generic Desktop Control. */
                #define USAGE_PAGE_GENERIC_DCTRL    0x01
 
-               /** HID Report Descriptor Usage value for a X axis movement */
+               /** HID Report Descriptor Usage for a Joystick. */
+               #define USAGE_JOYSTICK              0x04
+
+               /** HID Report Descriptor Usage value for a X axis movement. */
                #define USAGE_X                     0x30
 
-               /** HID Report Descriptor Usage value for a Y axis movement */
+               /** HID Report Descriptor Usage value for a Y axis movement. */
                #define USAGE_Y                     0x31
 
        /* Enums: */
-               /** Enum for the possible return codes of the GetHIDReportData() function. */
+               /** Enum for the possible return codes of the \ref GetHIDReportData() function. */
                enum JoystickHostWithParser_GetHIDReportDataCodes_t
                {
                        ParseSuccessful         = 0, /**< HID report descriptor parsed successfully */
                        ParseError              = 1, /**< Failed to fully process the HID report descriptor */
                        ParseControlError       = 2, /**< Control error occurred while trying to read the device HID descriptor */
                };
-               
-       /* Type Defines: */
-               /** Type define for a HID descriptor. */
-               typedef struct
-               {
-                       USB_Descriptor_Header_t  Header; /**< Regular descriptor header containing the descriptor's type and length */
-                               
-                       uint16_t                 HIDSpec; /**< Implemented HID class specification, in BCD encoded format */
-                       uint8_t                  CountryCode; /**< Country code value for localized hardware */
-               
-                       uint8_t                  TotalHIDDescriptors; /**< Total number of HID report descriptors in the current interface */
-
-                       uint8_t                  HIDReportType; /**< HID report type of the first HID report descriptor */
-                       uint16_t                 HIDReportLength; /**< Total size in bytes of the first HID report descriptor */
-               } USB_Descriptor_HID_t;
 
        /* External Variables: */
                extern uint16_t         HIDReportSize;
@@ -88,7 +72,8 @@
 
        /* Function Prototypes: */
                uint8_t GetHIDReportData(void);
-               
-               bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* CurrentItem);
-               
+
+               bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem);
+
 #endif
+