projects / pub / USBasp.git / blob
? search:


f02f1fd09e980ad796af70b85f62724155e1360c
[pub/USBasp.git] / LUFA / Drivers / USB / Class / HIDParser.h
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2009.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.fourwalledcubicle.com
7 */
8
9 /*
10 Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)
11
12 Permission to use, copy, modify, and distribute this software
13 and its documentation for any purpose and without fee is hereby
14 granted, provided that the above copyright notice appear in all
15 copies and that both that the copyright notice and this
16 permission notice and warranty disclaimer appear in supporting
17 documentation, and that the name of the author not be used in
18 advertising or publicity pertaining to distribution of the
19 software without specific, written prior permission.
20
21 The author disclaim all warranties with regard to this
22 software, including all implied warranties of merchantability
23 and fitness. In no event shall the author be liable for any
24 special, indirect or consequential damages or any damages
25 whatsoever resulting from loss of use, data or profits, whether
26 in an action of contract, negligence or other tortious action,
27 arising out of or in connection with the use or performance of
28 this software.
29 */
30
31 /** \file
32 *
33 * USB Human Interface Device (HID) Class report descriptor processing routines. This file allows for the easy
34 * parsing of the complex HID report descriptor, which describes the data that the device transmits to the host.
35 *
36 */
37
38 /** \ingroup Group_USB
39 * @defgroup Group_HIDParser HID Report Parser
40 *
41 * Functions, macros, variables, enums and types related to the parsing of HID class device report descriptors.
42 *
43 * The processed HID report is presented back to the user application as a flat structure containing each report
44 * item's IN, OUT and FEATURE (if desired) items along with each item's attributes.
45 *
46 * This library portion also allows for easy setting and retrieval of data from a HID report, including devices
47 * with multiple reports on the one HID interface.
48 *
49 * By default, FEATURE reports and IN/OUT reports with constant data are ignored in the HID report when processed
50 * to save on memory. This can be overridden by defining the HID_ENABLE_FEATURE_PROCESSING or
51 * HID_INCLUDE_CONSTANT_DATA_ITEMS tokens in the user project makefile, passing them to the compiler via the -D
52 * switch.
53 *
54 * @{
55 */
56
57 #ifndef __HIDPARSER_H__
58 #define __HIDPARSER_H__
59
60 /* Includes: */
61 #include <string.h>
62 #include <stdbool.h>
63
64 #include "HIDReportData.h"
65
66 #include "../../../Common/Common.h"
67
68 /* Enable C linkage for C++ Compilers: */
69 #if defined(__cplusplus)
70 extern "C" {
71 #endif
72
73 /* Preprocessor checks and defines: */
74 #if !defined(HID_STATETABLE_STACK_DEPTH) || defined(__DOXYGEN__)
75 /** Constant indicating the maximum stack depth of the state table. A larger state table
76 * allows for more PUSH/POP report items to be nested, but consumes more memory. By default
77 * this is set to 3 levels (allowing for two PUSHes to be nested) but this can be overridden by
78 * defining HID_STATETABLE_STACK_DEPTH to another value in the user project makefile, passing the
79 * define to the compiler using the -D compiler switch.
80 */
81 #define HID_STATETABLE_STACK_DEPTH 3
82 #endif
83
84 #if !defined(HID_USAGE_STACK_DEPTH) || defined(__DOXYGEN__)
85 /** Constant indicating the maximum stack depth of the usage table. A larger usage table
86 * allows for more USAGE items to be indicated sequentially for REPORT COUNT entries of more than
87 * one, but requires more stack space. By default this is set to 8 levels (allowing for a report
88 * item with a count of 8) but this can be overridden by defining HID_USAGE_STACK_DEPTH to another
89 * value in the user project makefile, passing the define to the compiler using the -D compiler
90 * switch.
91 */
92 #define HID_USAGE_STACK_DEPTH 8
93 #endif
94
95 #if !defined(HID_MAX_COLLECTIONS) || defined(__DOXYGEN__)
96 /** Constant indicating the maximum number of COLLECTION items (nested or unnested) that can be
97 * processed in the report item descriptor. A large value allows for more COLLECTION items to be
98 * processed, but consumes more memory. By default this is set to 5 collections, but this can be
99 * overridden by defining HID_MAX_COLLECTIONS to another value in the user project makefile, passing
100 * the define to the compiler using the -D compiler switch.
101 */
102 #define HID_MAX_COLLECTIONS 5
103 #endif
104
105 #if !defined(HID_MAX_REPORTITEMS) || defined(__DOXYGEN__)
106 /** Constant indicating the maximum number of report items (IN, OUT or FEATURE if enabled) that can be
107 * processed in the report item descriptor. A large value allows for more report items to be
108 * processed, but consumes more memory. By default this is set to 30 items, but this can be
109 * overridden by defining HID_MAX_REPORTITEMS to another value in the user project makefile, passing
110 * the define to the compiler using the -D compiler switch.
111 */
112 #define HID_MAX_REPORTITEMS 30
113 #endif
114
115 /* Public Interface - May be used in end-application: */
116 /* Enums: */
117 /** Enum for indicating what type of report item an entry in a HID_ReportInfo_t ReportItem array is */
118 enum HID_ReportItemTypes_t
119 {
120 REPORT_ITEM_TYPE_In = 0, /**< Indicates that the item is an IN report type. */
121 REPORT_ITEM_TYPE_Out = 1, /**< Indicates that the item is an OUT report type. */
122 REPORT_ITEM_TYPE_Feature = 2, /**< Indicates that the item is a FEATURE report type. */
123 };
124
125 /** Enum for the possible error codes in the return value of the ProcessHIDReport() function */
126 enum HID_Parse_ErrorCodes_t
127 {
128 HID_PARSE_Successful = 0, /**< Successful parse of the HID report descriptor, no error. */
129 HID_PARSE_HIDStackOverflow = 1, /**< More than HID_STATETABLE_STACK_DEPTH nested PUSHes in the report. */
130 HID_PARSE_HIDStackUnderflow = 2, /**< A POP was found when the state table stack was empty. */
131 HID_PARSE_InsufficientReportItems = 3, /**< More than HID_MAX_REPORTITEMS report items in the report. */
132 HID_PARSE_UnexpectedEndCollection = 4, /**< END COLLECTION found without matching COLLECTION item. */
133 HID_PARSE_InsufficientCollectionPaths = 5, /**< More than HID_MAX_COLLECTIONS collections in the report. */
134 HID_PARSE_UsageStackOverflow = 6, /**< More than HID_USAGE_STACK_DEPTH usages listed in a row. */
135 };
136
137 /* Type Defines: */
138 /** Type define for an attribute with both minimum and maximum values (e.g. Logical Min/Max). */
139 typedef struct
140 {
141 uint32_t Minimum; /**< Minimum value for the attribute. */
142 uint32_t Maximum; /**< Maximum value for the attribute. */
143 } HID_MinMax_t;
144
145 /** Type define for the Unit attributes of a report item. */
146 typedef struct
147 {
148 uint32_t Type; /**< Unit type (refer to HID specifications for details). */
149 uint8_t Exponent; /**< Unit exponent (refer to HID specifications for details). */
150 } HID_Unit_t;
151
152 /** Type define for the Usage attributes of a report item. */
153 typedef struct
154 {
155 uint16_t Page; /**< Usage page of the report item. */
156 uint16_t Usage; /**< Usage of the report item. */
157 HID_MinMax_t MinMax; /**< Usage minimum and maximum of the report item. */
158 } HID_Usage_t;
159
160 /** Type define for a COLLECTION object. Contains the collection attributes and a reference to the
161 * parent collection if any.
162 */
163 typedef struct CollectionPath
164 {
165 uint8_t Type; /**< Collection type (for example "Generic Desktop"). */
166 HID_Usage_t Usage; /**< Collection usage. */
167 struct CollectionPath* Parent; /**< Reference to parent collection, or NULL if root collection. */
168 } HID_CollectionPath_t;
169
170 /** Type define for all the data attributes of a report item, except flags. */
171 typedef struct
172 {
173 uint8_t BitSize; /**< Size in bits of the report item's data. */
174
175 HID_Usage_t Usage; /**< Usage of the report item. */
176 HID_Unit_t Unit; /**< Unit type and exponent of the report item. */
177 HID_MinMax_t Logical; /**< Logical minimum and maximum of the report item. */
178 HID_MinMax_t Physical; /**< Physical minimum and maximum of the report item. */
179 } HID_ReportItem_Attributes_t;
180
181 /** Type define for a report item (IN, OUT or FEATURE) attributes and other details. */
182 typedef struct
183 {
184 uint16_t BitOffset; /**< Bit offset in the IN, OUT or FEATURE report of the item. */
185 uint8_t ItemType; /**< Report item type, a value in HID_Types_t. */
186 uint16_t ItemFlags; /**< Item data flags, such as constant/variable, etc. */
187 uint8_t ReportID; /**< Report ID this item belongs to, or 0x00 if device has only one report */
188 HID_CollectionPath_t* CollectionPath; /**< Collection path of the item. */
189
190 HID_ReportItem_Attributes_t Attributes; /**< Report item attributes. */
191
192 uint32_t Value; /**< Current value of the report item. */
193 } HID_ReportItem_t;
194
195 /** Type define for a complete processed HID report, including all report item data and collections. */
196 typedef struct
197 {
198 uint8_t TotalReportItems; /**< Total number of report items stored in the
199 * ReportItems array. */
200
201 HID_ReportItem_t ReportItems[HID_MAX_REPORTITEMS]; /**< Report items array, including
202 * all IN, OUT and FEATURE items. */
203
204 HID_CollectionPath_t CollectionPaths[HID_MAX_COLLECTIONS]; /**< All collection items, referenced
205 * by the report items. */
206 } HID_ReportInfo_t;
207
208 /* Function Prototypes: */
209 /** Function to process a given HID report returned from an attached device, and store it into a given
210 * HID_ReportInfo_t structure.
211 *
212 * \param ReportData Buffer containing the device's HID report table
213 * \param ReportSize Size in bytes of the HID report table
214 * \param ParserData Pointer to a HID_ReportInfo_t instance for the parser output
215 *
216 * \return A value in the HID_Parse_ErrorCodes_t enum
217 */
218 uint8_t USB_ProcessHIDReport(const uint8_t* ReportData, uint16_t ReportSize, HID_ReportInfo_t* const ParserData)
219 ATTR_NON_NULL_PTR_ARG(1, 3);
220
221 /** Extracts the given report item's value out of the given HID report and places it into the Value
222 * member of the report item's HID_ReportItem_t structure.
223 *
224 * \param ReportData Buffer containing an IN or FEATURE report from an attached device
225 * \param ReportItem Pointer to the report item of interest in a HID_ReportInfo_t ReportItem array
226 *
227 * \returns Boolean true if the item to retrieve was located in the given report, false otherwise
228 */
229 bool USB_GetHIDReportItemInfo(const uint8_t* ReportData, HID_ReportItem_t* const ReportItem)
230 ATTR_NON_NULL_PTR_ARG(1, 2);
231
232 /** Retrieves the given report item's value out of the Value member of the report item's
233 * HID_ReportItem_t structure and places it into the correct position in the HID report
234 * buffer. The report buffer is assumed to have the appropriate bits cleared before calling
235 * this function (i.e., the buffer should be explicitly cleared before report values are added).
236 *
237 * If the device has multiple HID reports, the report ID is set to the report ID of the given item.
238 *
239 * \param ReportData Buffer holding the current OUT report data
240 * \param ReportItem Pointer to the report item of interest in a HID_ReportInfo_t ReportItem array
241 */
242 void USB_SetHIDReportItemInfo(uint8_t* ReportData, const HID_ReportItem_t* ReportItem)
243 ATTR_NON_NULL_PTR_ARG(1, 2);
244
245 /* Private Interface - For use in library only: */
246 #if !defined(__DOXYGEN__)
247 /* Type Defines: */
248 typedef struct
249 {
250 HID_ReportItem_Attributes_t Attributes;
251 uint8_t ReportCount;
252 uint8_t ReportID;
253 } HID_StateTable_t;
254 #endif
255
256 /* Disable C linkage for C++ Compilers: */
257 #if defined(__cplusplus)
258 }
259 #endif
260
261 #endif
262
263 /** @} */
USB isp AVR programmer