X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/2440ca268ac444c1aed2441cefe9e25a767d961a..d1e52660368d34d693131f6aff3c8fd8584162e5:/LUFA/Drivers/USB/Class/Host/HIDReportData.h

diff --git a/LUFA/Drivers/USB/Class/Host/HIDReportData.h b/LUFA/Drivers/USB/Class/Host/HIDReportData.h
new file mode 100644
index 000000000..eee38be04
--- /dev/null
+++ b/LUFA/Drivers/USB/Class/Host/HIDReportData.h
@@ -0,0 +1,140 @@
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2009.
+              
+  dean [at] fourwalledcubicle [dot] com
+      www.fourwalledcubicle.com
+*/
+
+/*
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, and distribute this software
+  and its documentation for any purpose and without fee is hereby
+  granted, 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
+  software without specific, written prior permission.
+
+  The author disclaim all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *
+ *  Constants for HID report item attributes. Refer to the HID specification for details on each
+ *  flag's meaning when applied to an IN, OUT or FEATURE item.
+ */
+
+/** \ingroup Group_HIDParser
+ *  @defgroup Group_HIDIOFConst Input/Output/Feature Masks
+ *
+ *  Masks indicating the type of Input, Output of Feature HID report item.
+ *
+ *  @{
+ */
+ 
+#ifndef __HIDREPORTDATA_H__
+#define __HIDREPORTDATA_H__
+
+	/* Public Interface - May be used in end-application: */
+		/* Macros: */
+			/** HID_ReportItem_t.ItemFlags flag for constant data. */
+			#define IOF_CONSTANT             (1 << 0)
+
+			/** HID_ReportItem_t.ItemFlags flag for data. */
+			#define IOF_DATA                 (0 << 0)
+
+			/** HID_ReportItem_t.ItemFlags flag for variable data. */
+			#define IOF_VARIABLE             (1 << 1)
+
+			/** HID_ReportItem_t.ItemFlags flag for array data. */
+			#define IOF_ARRAY                (0 << 1)
+
+			/** HID_ReportItem_t.ItemFlags flag for relative data. */
+			#define IOF_RELATIVE             (1 << 2)
+
+			/** HID_ReportItem_t.ItemFlags flag for absolute data. */
+			#define IOF_ABSOLUTE             (0 << 2)
+
+			/** HID_ReportItem_t.ItemFlags flag for wrapped value data. */
+			#define IOF_WRAP                 (1 << 3)
+
+			/** HID_ReportItem_t.ItemFlags flag for non-wrapped value data. */
+			#define IOF_NOWRAP               (0 << 3)
+
+			/** HID_ReportItem_t.ItemFlags flag for non linear data. */
+			#define IOF_NONLINEAR            (1 << 4)
+
+			/** HID_ReportItem_t.ItemFlags flag for linear data. */
+			#define IOF_LINEAR               (0 << 4)
+
+			/** HID_ReportItem_t.ItemFlags flag for no preferred state. */
+			#define IOF_NOPREFERRED          (1 << 5)
+
+			/** HID_ReportItem_t.ItemFlags flag for preferred state items. */
+			#define IOF_PREFERREDSTATE       (0 << 5)
+
+			/** HID_ReportItem_t.ItemFlags flag for null state items. */
+			#define IOF_NULLSTATE            (1 << 6)
+
+			/** HID_ReportItem_t.ItemFlags flag for no null position data. */
+			#define IOF_NONULLPOSITION       (0 << 6)
+
+			/** HID_ReportItem_t.ItemFlags flag for buffered bytes. */
+			#define IOF_BUFFEREDBYTES        (1 << 8)
+
+			/** HID_ReportItem_t.ItemFlags flag for bit field data. */
+			#define IOF_BITFIELD             (0 << 8)
+
+	/* Private Interface - For use in library only: */
+	#if !defined(__DOXYGEN__)
+		/* Macros: */
+			#define DATA_SIZE_MASK           0x03
+			#define TYPE_MASK                0x0C
+			#define TAG_MASK                 0xF0
+
+			#define DATA_SIZE_0              0x00
+			#define DATA_SIZE_1              0x01
+			#define DATA_SIZE_2              0x02
+			#define DATA_SIZE_4              0x03
+			
+			#define TYPE_MAIN                0x00
+			#define TYPE_GLOBAL              0x04
+			#define TYPE_LOCAL               0x08
+			
+			#define TAG_MAIN_INPUT           0x80
+			#define TAG_MAIN_OUTPUT          0x90
+			#define TAG_MAIN_COLLECTION      0xA0
+			#define TAG_MAIN_FEATURE         0xB0
+			#define TAG_MAIN_ENDCOLLECTION   0xC0
+
+			#define TAG_GLOBAL_USAGEPAGE     0x00
+			#define TAG_GLOBAL_LOGICALMIN    0x10
+			#define TAG_GLOBAL_LOGICALMAX    0x20
+			#define TAG_GLOBAL_PHYSMIN       0x30
+			#define TAG_GLOBAL_PHYSMAX       0x40
+			#define TAG_GLOBAL_UNITEXP       0x50
+			#define TAG_GLOBAL_UNIT          0x60
+			#define TAG_GLOBAL_REPORTSIZE    0x70
+			#define TAG_GLOBAL_REPORTID      0x80
+			#define TAG_GLOBAL_REPORTCOUNT   0x90
+			#define TAG_GLOBAL_PUSH          0xA0
+			#define TAG_GLOBAL_POP           0xB0
+			
+			#define TAG_LOCAL_USAGE          0x00
+			#define TAG_LOCAL_USAGEMIN       0x10
+			#define TAG_LOCAL_USAGEMAX       0x20
+	#endif
+
+/** @} */
+		
+#endif