projects / pub / USBasp.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Add const qualifiers to Host mode Class drivers.
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / 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 * \section Sec_Dependencies Module Source Dependencies
42 * The following files must be built with any user project that uses this module:
43 * - LUFA/Drivers/USB/Class/Host/HIDParser.c
44 *
45 * \section Module Description
46 * Functions, macros, variables, enums and types related to the parsing of HID class device report descriptors.
47 *
48 * The processed HID report is presented back to the user application as a flat structure containing each report
49 * item's IN, OUT and FEATURE items along with each item's attributes.
50 *
51 * This library portion also allows for easy setting and retrieval of data from a HID report, including devices
52 * with multiple reports on the one HID interface.
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 2 levels (allowing non-nested PUSH items) 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 2
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) that can be processed
107 * in the report item descriptor and stored in the user HID Report Info structure. A large value allows
108 * for more report items to be stored, but consumes more memory. By default this is set to 20 items,
109 * but this can be overridden by defining HID_MAX_REPORTITEMS to another value in the user project
110 * makefile, and passing the define to the compiler using the -D compiler switch.
111 */
112 #define HID_MAX_REPORTITEMS 20
113 #endif
114
115 #if !defined(HID_MAX_REPORT_IDS) || defined(__DOXYGEN__)
116 /** Constant indicating the maximum number of unique report IDs that can be processed in the report item
117 * descriptor for the report size information array in the user HID Report Info structure. A large value
118 * allows for more report ID report sizes to be stored, but consumes more memory. By default this is set
119 * to 5 items, but this can be overridden by defining HID_MAX_REPORT_IDS to another value in the user project
120 * makefile, and passing the define to the compiler using the -D compiler switch. Note that IN, OUT and FEATURE
121 * items sharing the same report ID consume only one size item in the array.
122 */
123 #define HID_MAX_REPORT_IDS 5
124 #endif
125
126 /* Public Interface - May be used in end-application: */
127 /* Enums: */
128 /** Enum for indicating what type of report item an entry in a \ref HID_ReportInfo_t ReportItem array is */
129 enum HID_ReportItemTypes_t
130 {
131 REPORT_ITEM_TYPE_In = 0, /**< Indicates that the item is an IN report type. */
132 REPORT_ITEM_TYPE_Out = 1, /**< Indicates that the item is an OUT report type. */
133 REPORT_ITEM_TYPE_Feature = 2, /**< Indicates that the item is a FEATURE report type. */
134 };
135
136 /** Enum for the possible error codes in the return value of the \ref USB_ProcessHIDReport() function */
137 enum HID_Parse_ErrorCodes_t
138 {
139 HID_PARSE_Successful = 0, /**< Successful parse of the HID report descriptor, no error. */
140 HID_PARSE_HIDStackOverflow = 1, /**< More than \ref HID_STATETABLE_STACK_DEPTH nested PUSHes in the report. */
141 HID_PARSE_HIDStackUnderflow = 2, /**< A POP was found when the state table stack was empty. */
142 HID_PARSE_InsufficientReportItems = 3, /**< More than \ref HID_MAX_REPORTITEMS report items in the report. */
143 HID_PARSE_UnexpectedEndCollection = 4, /**< An END COLLECTION item found without matching COLLECTION item. */
144 HID_PARSE_InsufficientCollectionPaths = 5, /**< More than \ref HID_MAX_COLLECTIONS collections in the report. */
145 HID_PARSE_UsageStackOverflow = 6, /**< More than \ref HID_USAGE_STACK_DEPTH usages listed in a row. */
146 HID_PARSE_InsufficientReportIDItems = 7, /**< More than \ref HID_MAX_REPORT_IDS report IDs in the device. */
147 };
148
149 /* Type Defines: */
150 /** Type define for an attribute with both minimum and maximum values (e.g. Logical Min/Max). */
151 typedef struct
152 {
153 uint32_t Minimum; /**< Minimum value for the attribute. */
154 uint32_t Maximum; /**< Maximum value for the attribute. */
155 } HID_MinMax_t;
156
157 /** Type define for the Unit attributes of a report item. */
158 typedef struct
159 {
160 uint32_t Type; /**< Unit type (refer to HID specifications for details). */
161 uint8_t Exponent; /**< Unit exponent (refer to HID specifications for details). */
162 } HID_Unit_t;
163
164 /** Type define for the Usage attributes of a report item. */
165 typedef struct
166 {
167 uint16_t Page; /**< Usage page of the report item. */
168 uint16_t Usage; /**< Usage of the report item. */
169 HID_MinMax_t MinMax; /**< Usage minimum and maximum of the report item. */
170 } HID_Usage_t;
171
172 /** Type define for a COLLECTION object. Contains the collection attributes and a reference to the
173 * parent collection if any.
174 */
175 typedef struct CollectionPath
176 {
177 uint8_t Type; /**< Collection type (e.g. "Generic Desktop"). */
178 HID_Usage_t Usage; /**< Collection usage. */
179 struct CollectionPath* Parent; /**< Reference to parent collection, or NULL if root collection. */
180 } HID_CollectionPath_t;
181
182 /** Type define for all the data attributes of a report item, except flags. */
183 typedef struct
184 {
185 uint8_t BitSize; /**< Size in bits of the report item's data. */
186
187 HID_Usage_t Usage; /**< Usage of the report item. */
188 HID_Unit_t Unit; /**< Unit type and exponent of the report item. */
189 HID_MinMax_t Logical; /**< Logical minimum and maximum of the report item. */
190 HID_MinMax_t Physical; /**< Physical minimum and maximum of the report item. */
191 } HID_ReportItem_Attributes_t;
192
193 /** Type define for a report item (IN, OUT or FEATURE) attributes and other details. */
194 typedef struct
195 {
196 uint16_t BitOffset; /**< Bit offset in the IN, OUT or FEATURE report of the item. */
197 uint8_t ItemType; /**< Report item type, a value in HID_Types_t. */
198 uint16_t ItemFlags; /**< Item data flags, such as constant/variable, etc. */
199 uint8_t ReportID; /**< Report ID this item belongs to, or 0x00 if device has only one report */
200 HID_CollectionPath_t* CollectionPath; /**< Collection path of the item. */
201
202 HID_ReportItem_Attributes_t Attributes; /**< Report item attributes. */
203
204 uint32_t Value; /**< Current value of the report item. */
205 } HID_ReportItem_t;
206
207 /** Type define for a report item size information structure */
208 typedef struct
209 {
210 uint8_t ReportID; /** Report ID of the report within the HID interface */
211 uint8_t ReportSizeBits[3]; /** Total number of bits in each report type for the given Report ID,
212 * indexed by the \ref HID_ReportItemTypes_t enum
213 */
214 } HID_ReportSizeInfo_t;
215
216 /** Type define for a complete processed HID report, including all report item data and collections. */
217 typedef struct
218 {
219 uint8_t TotalReportItems; /**< Total number of report items stored in the
220 * ReportItems array.
221 */
222 HID_ReportItem_t ReportItems[HID_MAX_REPORTITEMS]; /**< Report items array, including
223 * all IN, OUT and FEATURE items.
224 */
225 HID_CollectionPath_t CollectionPaths[HID_MAX_COLLECTIONS]; /**< All collection items, referenced
226 * by the report items.
227 */
228 uint8_t TotalDeviceReports; /** Number of reports within the HID interface */
229 HID_ReportSizeInfo_t ReportIDSizes[HID_MAX_REPORT_IDS]; /** Report sizes for each report in the interface */
230 bool UsingReportIDs; /**< Indicates if the device has at least one REPORT ID
231 * element in its HID report descriptor.
232 */
233 } HID_ReportInfo_t;
234
235 /* Function Prototypes: */
236 /** Function to process a given HID report returned from an attached device, and store it into a given
237 * \ref HID_ReportInfo_t structure.
238 *
239 * \param[in] ReportData Buffer containing the device's HID report table
240 * \param[in] ReportSize Size in bytes of the HID report table
241 * \param[out] ParserData Pointer to a \ref HID_ReportInfo_t instance for the parser output
242 *
243 * \return A value in the \ref HID_Parse_ErrorCodes_t enum
244 */
245 uint8_t USB_ProcessHIDReport(const uint8_t* ReportData, uint16_t ReportSize, HID_ReportInfo_t* const ParserData)
246 ATTR_NON_NULL_PTR_ARG(1, 3);
247
248 /** Extracts the given report item's value out of the given HID report and places it into the Value
249 * member of the report item's \ref HID_ReportItem_t structure.
250 *
251 * \param[in] ReportData Buffer containing an IN or FEATURE report from an attached device
252 * \param[in,out] ReportItem Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array
253 *
254 * \returns Boolean true if the item to retrieve was located in the given report, false otherwise
255 */
256 bool USB_GetHIDReportItemInfo(const uint8_t* ReportData, HID_ReportItem_t* const ReportItem)
257 ATTR_NON_NULL_PTR_ARG(1, 2);
258
259 /** Retrieves the given report item's value out of the Value member of the report item's
260 * \ref HID_ReportItem_t structure and places it into the correct position in the HID report
261 * buffer. The report buffer is assumed to have the appropriate bits cleared before calling
262 * this function (i.e., the buffer should be explicitly cleared before report values are added).
263 *
264 * If the device has multiple HID reports, the first byte in the report is set to the report ID of the given item.
265 *
266 * \param[out] ReportData Buffer holding the current OUT or FEATURE report data
267 * \param[in] ReportItem Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array
268 */
269 void USB_SetHIDReportItemInfo(uint8_t* ReportData, const HID_ReportItem_t* ReportItem)
270 ATTR_NON_NULL_PTR_ARG(1, 2);
271
272 /** Retrieves the size of a given HID report in bytes from it's Report ID.
273 *
274 * \param[in] ParserData Pointer to a \ref HID_ReportInfo_t instance containing the parser output
275 * \param[in] ReportID Report ID of the report whose size is to be retrieved
276 * \param[in] ReportType Type of the report whose size is to be determined, a valued from the
277 * \ref HID_ReportItemTypes_t enum
278 *
279 * \return Size of the report in bytes, or 0 if the report does not exist
280 */
281 uint16_t USB_GetHIDReportSize(HID_ReportInfo_t* const ParserData, const uint8_t ReportID,
282 const uint8_t ReportType) ATTR_NON_NULL_PTR_ARG(1);
283
284 /** Callback routine for the HID Report Parser. This callback <b>must</b> be implemented by the user code when
285 * the parser is used, to determine what report IN, OUT and FEATURE item's information is stored into the user
286 * HID_ReportInfo_t structure. This can be used to filter only those items the application will be using, so that
287 * no RAM is wasted storing the attributes for report items which will never be referenced by the application.
288 *
289 * \param CurrentItemAttributes Pointer to the current report item attributes for user checking
290 *
291 * \return Boolean true if the item should be stored into the HID_ReportInfo_t structure, false if it should be ignored
292 */
293 bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_Attributes_t* CurrentItemAttributes);
294
295 /* Private Interface - For use in library only: */
296 #if !defined(__DOXYGEN__)
297 /* Type Defines: */
298 typedef struct
299 {
300 HID_ReportItem_Attributes_t Attributes;
301 uint8_t ReportCount;
302 uint8_t ReportID;
303 } HID_StateTable_t;
304 #endif
305
306 /* Disable C linkage for C++ Compilers: */
307 #if defined(__cplusplus)
308 }
309 #endif
310
311 #endif
312
313 /** @} */
USB isp AVR programmer