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 (if desired) 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  *  By default, FEATURE reports and IN/OUT reports with constant data are ignored in the HID report when processed
  55  *  to save on memory. This can be overridden by defining the HID_ENABLE_FEATURE_PROCESSING or
  56  *  HID_INCLUDE_CONSTANT_DATA_ITEMS tokens in the user project makefile, passing them to the compiler via the -D
  57  *  switch.
  58  *
  59  *  @{
  60  */
  61
  62 #ifndef __HIDPARSER_H__
  63 #define __HIDPARSER_H__
  64
  65         /* Includes: */
  66                 #include <string.h>
  67                 #include <stdbool.h>
  68
  69                 #include "HIDReportData.h"
  70
  71                 #include "../../../../Common/Common.h"
  72
  73         /* Enable C linkage for C++ Compilers: */
  74                 #if defined(__cplusplus)
  75                         extern "C" {
  76                 #endif
  77
  78         /* Preprocessor checks and defines: */
  79                 #if !defined(HID_STATETABLE_STACK_DEPTH) || defined(__DOXYGEN__)
  80                         /** Constant indicating the maximum stack depth of the state table. A larger state table
  81                          *  allows for more PUSH/POP report items to be nested, but consumes more memory. By default
  82                          *  this is set to 2 levels (allowing non-nested PUSH items) but this can be overridden by
  83                          *  defining HID_STATETABLE_STACK_DEPTH to another value in the user project makefile, passing the
  84                          *  define to the compiler using the -D compiler switch.
  85                          */
  86                         #define HID_STATETABLE_STACK_DEPTH    2
  87                 #endif
  88
  89                 #if !defined(HID_USAGE_STACK_DEPTH) || defined(__DOXYGEN__)
  90                         /** Constant indicating the maximum stack depth of the usage table. A larger usage table
  91                          *  allows for more USAGE items to be indicated sequentially for REPORT COUNT entries of more than
  92                          *  one, but requires more stack space. By default this is set to 8 levels (allowing for a report
  93                          *  item with a count of 8) but this can be overridden by defining HID_USAGE_STACK_DEPTH to another
  94                          *  value in the user project makefile, passing the define to the compiler using the -D compiler
  95                          *  switch.
  96                          */
  97                         #define HID_USAGE_STACK_DEPTH         8
  98                 #endif
  99
 100                 #if !defined(HID_MAX_COLLECTIONS) || defined(__DOXYGEN__)
 101                         /** Constant indicating the maximum number of COLLECTION items (nested or unnested) that can be
 102                          *  processed in the report item descriptor. A large value allows for more COLLECTION items to be
 103                          *  processed, but consumes more memory. By default this is set to 5 collections, but this can be
 104                          *  overridden by defining HID_MAX_COLLECTIONS to another value in the user project makefile, passing
 105                          *  the define to the compiler using the -D compiler switch.
 106                          */
 107                         #define HID_MAX_COLLECTIONS           5
 108                 #endif
 109
 110                 #if !defined(HID_MAX_REPORTITEMS) || defined(__DOXYGEN__)
 111                         /** Constant indicating the maximum number of report items (IN, OUT or FEATURE if enabled) that can be
 112                          *  processed in the report item descriptor. A large value allows for more report items to be
 113                          *  processed, but consumes more memory. By default this is set to 30 items, but this can be
 114                          *  overridden by defining HID_MAX_REPORTITEMS to another value in the user project makefile, passing
 115                          *  the define to the compiler using the -D compiler switch.
 116                          */
 117                         #define HID_MAX_REPORTITEMS           30
 118                 #endif
 119
 120         /* Public Interface - May be used in end-application: */
 121                 /* Enums: */
 122                         /** Enum for indicating what type of report item an entry in a \ref HID_ReportInfo_t ReportItem array is */
 123                         enum HID_ReportItemTypes_t
 124                         {
 125                                 REPORT_ITEM_TYPE_In                   = 0, /**< Indicates that the item is an IN report type. */
 126                                 REPORT_ITEM_TYPE_Out                  = 1, /**< Indicates that the item is an OUT report type. */
 127                                 REPORT_ITEM_TYPE_Feature              = 2, /**< Indicates that the item is a FEATURE report type. */
 128                         };
 129
 130                         /** Enum for the possible error codes in the return value of the \ref USB_ProcessHIDReport() function */
 131                         enum HID_Parse_ErrorCodes_t
 132                         {
 133                                 HID_PARSE_Successful                  = 0, /**< Successful parse of the HID report descriptor, no error. */
 134                                 HID_PARSE_HIDStackOverflow            = 1, /**< More than \ref HID_STATETABLE_STACK_DEPTH nested PUSHes in the report. */
 135                                 HID_PARSE_HIDStackUnderflow           = 2, /**< A POP was found when the state table stack was empty. */
 136                                 HID_PARSE_InsufficientReportItems     = 3, /**< More than \ref HID_MAX_REPORTITEMS report items in the report. */
 137                                 HID_PARSE_UnexpectedEndCollection     = 4, /**< An END COLLECTION item found without matching COLLECTION item. */
 138                                 HID_PARSE_InsufficientCollectionPaths = 5, /**< More than \ref HID_MAX_COLLECTIONS collections in the report. */
 139                                 HID_PARSE_UsageStackOverflow          = 6, /**< More than \ref HID_USAGE_STACK_DEPTH usages listed in a row. */
 140                         };
 141
 142                 /* Type Defines: */
 143                         /** Type define for an attribute with both minimum and maximum values (e.g. Logical Min/Max). */
 144                         typedef struct
 145                         {
 146                                 uint32_t                     Minimum; /**< Minimum value for the attribute. */
 147                                 uint32_t                     Maximum; /**< Maximum value for the attribute. */
 148                         } HID_MinMax_t;
 149
 150                         /** Type define for the Unit attributes of a report item. */
 151                         typedef struct
 152                         {
 153                                 uint32_t                     Type;     /**< Unit type (refer to HID specifications for details). */
 154                                 uint8_t                      Exponent; /**< Unit exponent (refer to HID specifications for details). */
 155                         } HID_Unit_t;
 156
 157                         /** Type define for the Usage attributes of a report item. */
 158                         typedef struct
 159                         {
 160                                 uint16_t                     Page;   /**< Usage page of the report item. */
 161                                 uint16_t                     Usage;  /**< Usage of the report item. */
 162                                 HID_MinMax_t                 MinMax; /**< Usage minimum and maximum of the report item. */
 163                         } HID_Usage_t;
 164
 165                         /** Type define for a COLLECTION object. Contains the collection attributes and a reference to the
 166                          *  parent collection if any.
 167                          */
 168                         typedef struct CollectionPath
 169                         {
 170                                 uint8_t                      Type;   /**< Collection type (e.g. "Generic Desktop"). */
 171                                 HID_Usage_t                  Usage;  /**< Collection usage. */
 172                                 struct CollectionPath*       Parent; /**< Reference to parent collection, or NULL if root collection. */
 173                         } HID_CollectionPath_t;
 174
 175                         /** Type define for all the data attributes of a report item, except flags. */
 176                         typedef struct
 177                         {
 178                                 uint8_t                      BitSize;  /**< Size in bits of the report item's data. */
 179
 180                                 HID_Usage_t                  Usage;    /**< Usage of the report item. */
 181                                 HID_Unit_t                   Unit;     /**< Unit type and exponent of the report item. */
 182                                 HID_MinMax_t                 Logical;  /**< Logical minimum and maximum of the report item. */
 183                                 HID_MinMax_t                 Physical; /**< Physical minimum and maximum of the report item. */
 184                         } HID_ReportItem_Attributes_t;
 185
 186                         /** Type define for a report item (IN, OUT or FEATURE) attributes and other details. */
 187                         typedef struct
 188                         {
 189                                 uint16_t                     BitOffset;      /**< Bit offset in the IN, OUT or FEATURE report of the item. */
 190                                 uint8_t                      ItemType;       /**< Report item type, a value in HID_Types_t. */
 191                                 uint16_t                     ItemFlags;      /**< Item data flags, such as constant/variable, etc. */
 192                                 uint8_t                      ReportID;       /**< Report ID this item belongs to, or 0x00 if device has only one report */
 193                                 HID_CollectionPath_t*        CollectionPath; /**< Collection path of the item. */
 194
 195                                 HID_ReportItem_Attributes_t  Attributes;     /**< Report item attributes. */
 196
 197                                 uint32_t                     Value;          /**< Current value of the report item. */
 198                         } HID_ReportItem_t;
 199
 200                         /** Type define for a complete processed HID report, including all report item data and collections. */
 201                         typedef struct
 202                         {
 203                                 uint8_t                      TotalReportItems; /**< Total number of report items stored in the
 204                                                                                 *   ReportItems array.
 205                                                                                 */
 206                                 HID_ReportItem_t             ReportItems[HID_MAX_REPORTITEMS]; /**< Report items array, including
 207                                                                                             *   all IN, OUT and FEATURE items.
 208                                                                                                 */
 209                                 HID_CollectionPath_t         CollectionPaths[HID_MAX_COLLECTIONS]; /**< All collection items, referenced
 210                                                                                                     *   by the report items.
 211                                                                                                     */
 212                                 bool                         UsingMultipleReports; /**< Indicates if the device has at least one REPORT ID
 213                                                                                     *   element in its HID report descriptor.
 214                                                                                     */
 215                         } HID_ReportInfo_t;
 216
 217                 /* Function Prototypes: */
 218                         /** Function to process a given HID report returned from an attached device, and store it into a given
 219                          *  \ref HID_ReportInfo_t structure.
 220                          *
 221                          *  \param[in] ReportData  Buffer containing the device's HID report table
 222                          *  \param[in] ReportSize  Size in bytes of the HID report table
 223                          *  \param[out] ParserData  Pointer to a \ref HID_ReportInfo_t instance for the parser output
 224                          *
 225                          *  \return A value in the \ref HID_Parse_ErrorCodes_t enum
 226                          */
 227                         uint8_t USB_ProcessHIDReport(const uint8_t* ReportData, uint16_t ReportSize, HID_ReportInfo_t* const ParserData)
 228                                                      ATTR_NON_NULL_PTR_ARG(1, 3);
 229
 230                         /** Extracts the given report item's value out of the given HID report and places it into the Value
 231                          *  member of the report item's \ref HID_ReportItem_t structure.
 232                          *
 233                          *  \param[in] ReportData  Buffer containing an IN or FEATURE report from an attached device
 234                          *  \param[in,out] ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array
 235                          *
 236                          *  \returns Boolean true if the item to retrieve was located in the given report, false otherwise
 237                          */
 238                         bool USB_GetHIDReportItemInfo(const uint8_t* ReportData, HID_ReportItem_t* const ReportItem)
 239                                                       ATTR_NON_NULL_PTR_ARG(1, 2);
 240
 241                         /** Retrieves the given report item's value out of the Value member of the report item's
 242                          *  \ref HID_ReportItem_t structure and places it into the correct position in the HID report
 243                          *  buffer. The report buffer is assumed to have the appropriate bits cleared before calling
 244                          *  this function (i.e., the buffer should be explicitly cleared before report values are added).
 245                          *
 246                          *  If the device has multiple HID reports, the first byte in the report is set to the report ID of the given item.
 247                          *
 248                          *  \param[out] ReportData  Buffer holding the current OUT or FEATURE report data
 249                          *  \param[in] ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array
 250                          */
 251                         void USB_SetHIDReportItemInfo(uint8_t* ReportData, const HID_ReportItem_t* ReportItem)
 252                                                       ATTR_NON_NULL_PTR_ARG(1, 2);
 253
 254         /* Private Interface - For use in library only: */
 255         #if !defined(__DOXYGEN__)
 256                 /* Type Defines: */
 257                         typedef struct
 258                         {
 259                                  HID_ReportItem_Attributes_t Attributes;
 260                                  uint8_t                     ReportCount;
 261                                  uint8_t                     ReportID;
 262                         } HID_StateTable_t;
 263         #endif
 264
 265         /* Disable C linkage for C++ Compilers: */
 266                 #if defined(__cplusplus)
 267                         }
 268                 #endif
 269
 270 #endif
 271
 272 /** @} */