Moved all source to the trunk directory.
[pub/lufa.git] / LUFA / Drivers / USB / Class / HIDReportData.h
diff --git a/LUFA/Drivers/USB/Class/HIDReportData.h b/LUFA/Drivers/USB/Class/HIDReportData.h
new file mode 100644 (file)
index 0000000..1bb8676
--- /dev/null
@@ -0,0 +1,128 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2009.\r
+              \r
+  dean [at] fourwalledcubicle [dot] com\r
+      www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, and distribute this software\r
+  and its documentation for any purpose and without fee is hereby\r
+  granted, provided that the above copyright notice appear in all\r
+  copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting\r
+  documentation, and that the name of the author not be used in\r
+  advertising or publicity pertaining to distribution of the\r
+  software without specific, written prior permission.\r
+\r
+  The author disclaim all warranties with regard to this\r
+  software, including all implied warranties of merchantability\r
+  and fitness.  In no event shall the author be liable for any\r
+  special, indirect or consequential damages or any damages\r
+  whatsoever resulting from loss of use, data or profits, whether\r
+  in an action of contract, negligence or other tortious action,\r
+  arising out of or in connection with the use or performance of\r
+  this software.\r
+*/\r
+\r
+/** \file\r
+ *\r
+ *  Constants for HID report item attributes. Refer to the HID specification for details on each\r
+ *  flag's meaning when applied to an IN, OUT or FEATURE item.\r
+ */\r
+\r
+#ifndef __HIDREPORTDATA_H__\r
+#define __HIDREPORTDATA_H__\r
+\r
+       /* Public Interface - May be used in end-application: */\r
+               /* Macros: */\r
+                       /** HID_ReportItem_t.ItemFlags flag for constant data. */\r
+                       #define IOF_CONSTANT             (1 << 0)\r
+\r
+                       /** HID_ReportItem_t.ItemFlags flag for data. */\r
+                       #define IOF_DATA                 (0 << 0)\r
+\r
+                       /** HID_ReportItem_t.ItemFlags flag for variable data. */\r
+                       #define IOF_VARIABLE             (1 << 1)\r
+\r
+                       /** HID_ReportItem_t.ItemFlags flag for array data. */\r
+                       #define IOF_ARRAY                (0 << 1)\r
+\r
+                       /** HID_ReportItem_t.ItemFlags flag for relative data. */\r
+                       #define IOF_RELATIVE             (1 << 2)\r
+\r
+                       /** HID_ReportItem_t.ItemFlags flag for absolute data. */\r
+                       #define IOF_ABSOLUTE             (0 << 2)\r
+\r
+                       /** HID_ReportItem_t.ItemFlags flag for wrapped value data. */\r
+                       #define IOF_WRAP                 (1 << 3)\r
+\r
+                       /** HID_ReportItem_t.ItemFlags flag for non-wrapped value data. */\r
+                       #define IOF_NOWRAP               (0 << 3)\r
+\r
+                       /** HID_ReportItem_t.ItemFlags flag for non linear data. */\r
+                       #define IOF_NONLINEAR            (1 << 4)\r
+\r
+                       /** HID_ReportItem_t.ItemFlags flag for linear data. */\r
+                       #define IOF_LINEAR               (0 << 4)\r
+\r
+                       /** HID_ReportItem_t.ItemFlags flag for no preferred state. */\r
+                       #define IOF_NOPREFERRED          (1 << 5)\r
+\r
+                       /** HID_ReportItem_t.ItemFlags flag for preferred state items. */\r
+                       #define IOF_PREFERREDSTATE       (0 << 5)\r
+\r
+                       /** HID_ReportItem_t.ItemFlags flag for null state items. */\r
+                       #define IOF_NULLSTATE            (1 << 6)\r
+\r
+                       /** HID_ReportItem_t.ItemFlags flag for no null position data. */\r
+                       #define IOF_NONULLPOSITION       (0 << 6)\r
+\r
+                       /** HID_ReportItem_t.ItemFlags flag for buffered bytes. */\r
+                       #define IOF_BUFFEREDBYTES        (1 << 8)\r
+\r
+                       /** HID_ReportItem_t.ItemFlags flag for bitfield data. */\r
+                       #define IOF_BITFIELD             (0 << 8)\r
+\r
+       /* Private Interface - For use in library only: */\r
+       #if !defined(__DOXYGEN__)\r
+               /* Macros: */\r
+                       #define DATA_SIZE_MASK           0b00000011\r
+                       #define TYPE_MASK                0b00001100\r
+                       #define TAG_MASK                 0b11110000\r
+\r
+                       #define DATA_SIZE_0              0b00000000\r
+                       #define DATA_SIZE_1              0b00000001\r
+                       #define DATA_SIZE_2              0b00000010\r
+                       #define DATA_SIZE_4              0b00000011\r
+                       \r
+                       #define TYPE_MAIN                0b00000000\r
+                       #define TYPE_GLOBAL              0b00000100\r
+                       #define TYPE_LOCAL               0b00001000\r
+                       \r
+                       #define TAG_MAIN_INPUT           0b10000000\r
+                       #define TAG_MAIN_OUTPUT          0b10010000\r
+                       #define TAG_MAIN_COLLECTION      0b10100000\r
+                       #define TAG_MAIN_FEATURE         0b10110000\r
+                       #define TAG_MAIN_ENDCOLLECTION   0b11000000\r
+                       #define TAG_GLOBAL_USAGEPAGE     0b00000000\r
+                       #define TAG_GLOBAL_LOGICALMIN    0b00010000\r
+                       #define TAG_GLOBAL_LOGICALMAX    0b00100000\r
+                       #define TAG_GLOBAL_PHYSMIN       0b00110000\r
+                       #define TAG_GLOBAL_PHYSMAX       0b01000000\r
+                       #define TAG_GLOBAL_UNITEXP       0b01010000\r
+                       #define TAG_GLOBAL_UNIT          0b01100000\r
+                       #define TAG_GLOBAL_REPORTSIZE    0b01110000\r
+                       #define TAG_GLOBAL_REPORTID      0b10000000\r
+                       #define TAG_GLOBAL_REPORTCOUNT   0b10010000\r
+                       #define TAG_GLOBAL_PUSH          0b10100000\r
+                       #define TAG_GLOBAL_POP           0b10110000\r
+                       #define TAG_LOCAL_USAGE          0b00000000\r
+                       #define TAG_LOCAL_USAGEMIN       0b00010000\r
+                       #define TAG_LOCAL_USAGEMAX       0b00100000\r
+       #endif\r
+               \r
+#endif\r