lib/drivers/hidparser/parser.h

   1
   2 #pragma once
   3 #include <ntddk.h>
   4 #include <assert.h>
   5 #include <pshpack1.h>
   6 #include "hidparser.h"
   7 #include <ntddkbd.h>
   8
   9  /*
  10   * Copyright 2007, Haiku, Inc. All Rights Reserved.
  11   * Distributed under the terms of the MIT License.
  12   */
  13
  14 #define HID_REPORT_TYPE_ANY                     0x07
  15
  16
  17 #define ITEM_TYPE_MAIN                                          0x0
  18 #define ITEM_TYPE_GLOBAL                                        0x1
  19 #define ITEM_TYPE_LOCAL                                         0x2
  20 #define ITEM_TYPE_LONG                                          0x3
  21
  22 #define ITEM_TAG_MAIN_INPUT                                     0x8
  23 #define ITEM_TAG_MAIN_OUTPUT                            0x9
  24 #define ITEM_TAG_MAIN_FEATURE                           0xb
  25 #define ITEM_TAG_MAIN_COLLECTION                        0xa
  26 #define ITEM_TAG_MAIN_END_COLLECTION            0xc
  27
  28 #define ITEM_TAG_GLOBAL_USAGE_PAGE                      0x0
  29 #define ITEM_TAG_GLOBAL_LOGICAL_MINIMUM         0x1
  30 #define ITEM_TAG_GLOBAL_LOGICAL_MAXIMUM         0x2
  31 #define ITEM_TAG_GLOBAL_PHYSICAL_MINIMUM        0x3
  32 #define ITEM_TAG_GLOBAL_PHYSICAL_MAXIMUM        0x4
  33 #define ITEM_TAG_GLOBAL_UNIT_EXPONENT           0x5
  34 #define ITEM_TAG_GLOBAL_UNIT                            0x6
  35 #define ITEM_TAG_GLOBAL_REPORT_SIZE                     0x7
  36 #define ITEM_TAG_GLOBAL_REPORT_ID                       0x8
  37 #define ITEM_TAG_GLOBAL_REPORT_COUNT            0x9
  38 #define ITEM_TAG_GLOBAL_PUSH                            0xa
  39 #define ITEM_TAG_GLOBAL_POP                                     0xb
  40
  41 #define ITEM_TAG_LOCAL_USAGE                            0x0
  42 #define ITEM_TAG_LOCAL_USAGE_MINIMUM            0x1
  43 #define ITEM_TAG_LOCAL_USAGE_MAXIMUM            0x2
  44 #define ITEM_TAG_LOCAL_DESIGNATOR_INDEX         0x3
  45 #define ITEM_TAG_LOCAL_DESIGNATOR_MINIMUM       0x4
  46 #define ITEM_TAG_LOCAL_DESIGNATOR_MAXIMUM       0x5
  47 #define ITEM_TAG_LOCAL_STRING_INDEX                     0x7
  48 #define ITEM_TAG_LOCAL_STRING_MINIMUM           0x8
  49 #define ITEM_TAG_LOCAL_STRING_MAXIMUM           0x9
  50 #define ITEM_TAG_LOCAL_DELIMITER                        0xa
  51
  52 #define ITEM_TAG_LONG                                           0xf
  53
  54 #define COLLECTION_PHYSICAL                                     0x00
  55 #define COLLECTION_APPLICATION                          0x01
  56 #define COLLECTION_LOGICAL                                      0x02
  57 #define COLLECTION_REPORT                                       0x03
  58 #define COLLECTION_NAMED_ARRAY                          0x04
  59 #define COLLECTION_USAGE_SWITCH                         0x05
  60 #define COLLECTION_USAGE_MODIFIER                       0x06
  61 #define COLLECTION_ALL                                          0xff
  62
  63 #define UNIT_SYSTEM                                                     0x0
  64 #define UNIT_LENGTH                                                     0x1
  65 #define UNIT_MASS                                                       0x2
  66 #define UNIT_TIME                                                       0x3
  67 #define UNIT_TEMPERATURE                                        0x4
  68 #define UNIT_CURRENT                                            0x5
  69 #define UNIT_LUMINOUS_INTENSITY                         0x6
  70
  71 #define USAGE_PAGE_SHIFT                                        16
  72 #define USAGE_PAGE_MASK                                         0xffff
  73 #define USAGE_ID_SHIFT                                          0
  74 #define USAGE_ID_MASK                                           0xffff
  75
  76 typedef struct
  77 {
  78     UCHAR Size:2;
  79     UCHAR Type:2;
  80     UCHAR Tag:4;
  81 }ITEM_PREFIX, *PITEM_PREFIX;
  82
  83 typedef struct
  84 {
  85     ITEM_PREFIX Prefix;
  86
  87     union
  88     {
  89         UCHAR UData8[4];
  90         CHAR  SData8[4];
  91         USHORT UData16[2];
  92         SHORT SData16[2];
  93         ULONG UData32;
  94         LONG SData32;
  95     }Data;
  96
  97 }SHORT_ITEM, *PSHORT_ITEM;
  98
  99 typedef struct
 100 {
 101     ITEM_PREFIX Prefix;
 102     UCHAR DataSize;
 103     UCHAR LongItemTag;
 104     UCHAR Data[0];
 105
 106 }LONG_ITEM,*PLONG_ITEM;
 107
 108
 109 #define  LBITFIELD9(b1,b2,b3,b4,b5,b6,b7,b8,b9)    USHORT b9,b8,b7,b6,b5,b4,b3,b2,b1
 110 typedef struct
 111 {
 112     USHORT DataConstant:1;
 113     USHORT ArrayVariable:1;
 114     USHORT Relative:1;
 115     USHORT Wrap:1;
 116     USHORT NonLinear:1;
 117     USHORT NoPreferred:1;
 118     USHORT NullState:1;
 119     USHORT IsVolatile:1;
 120     USHORT BitsBytes:1;
 121     UCHAR    reserved[2];
 122
 123 }MAIN_ITEM_DATA, *PMAIN_ITEM_DATA;
 124
 125 typedef struct __GLOBAL_ITEM_STATE_
 126 {
 127     USHORT UsagePage;
 128     ULONG  LogicalMinimum;
 129     ULONG  LogicialMaximum;
 130     ULONG  PhysicalMinimum;
 131     ULONG  PhysicalMaximum;
 132     UCHAR  UnitExponent;
 133     UCHAR  Unit;
 134     ULONG  ReportSize;
 135     ULONG  ReportCount;
 136     UCHAR  ReportId;
 137     struct __GLOBAL_ITEM_STATE__ * Next;
 138 }GLOBAL_ITEM_STATE, *PGLOBAL_ITEM_STATE;
 139
 140
 141 typedef struct usage_value
 142 {
 143     union
 144     {
 145         struct {
 146             USHORT UsageId;
 147             USHORT UsagePage;
 148         }s;
 149         ULONG  Extended;
 150     }u;
 151
 152    UCHAR IsExtended;
 153 }USAGE_VALUE, *PUSAGE_VALUE;
 154
 155
 156 typedef struct
 157 {
 158     PUSAGE_VALUE    UsageStack;
 159     ULONG           UsageStackUsed;
 160     ULONG           UsageStackAllocated;
 161
 162     USAGE_VALUE     UsageMinimum;
 163     USAGE_VALUE     UsageMaximum;
 164
 165     UCHAR           UsageMinimumSet;
 166     UCHAR           UsageMaximumSet;
 167
 168     ULONG           DesignatorIndex;
 169     UCHAR           DesignatorIndexSet;
 170
 171     ULONG           DesignatorMinimum;
 172     ULONG           DesignatorMaximum;
 173
 174     UCHAR           StringIndex;
 175     UCHAR           StringIndexSet;
 176     UCHAR           StringMinimum;
 177     UCHAR           StringMaximum;
 178
 179 }LOCAL_ITEM_STATE, *PLOCAL_ITEM_STATE;
 180
 181 typedef struct
 182 {
 183     ULONG ByteOffset;
 184     UCHAR Shift;
 185     ULONG Mask;
 186     UCHAR BitCount;
 187     UCHAR HasData;
 188     UCHAR Array;
 189     UCHAR Relative;
 190     ULONG Minimum;
 191     ULONG Maximum;
 192     ULONG UsageMinimum;
 193     ULONG UsageMaximum;
 194     ULONG Data;
 195     UCHAR Valid;
 196 }HID_REPORT_ITEM, *PHID_REPORT_ITEM;
 197
 198 struct _HID_REPORT;
 199
 200 typedef struct __HID_COLLECTION__
 201 {
 202     struct __HID_COLLECTION__ * Root;
 203
 204     UCHAR Type;
 205     ULONG Usage;
 206     UCHAR StringID;
 207     UCHAR PhysicalID;
 208     ULONG NodeCount;
 209     struct __HID_COLLECTION__ ** Nodes;
 210
 211     ULONG ItemCount;
 212     ULONG ItemCountAllocated;
 213
 214     PHID_REPORT_ITEM * Items;
 215
 216     ULONG ReportCount;
 217     struct _HID_REPORT ** Reports;
 218
 219 }HID_COLLECTION, *PHID_COLLECTION;
 220
 221 typedef struct _HID_REPORT
 222 {
 223     UCHAR Type;
 224     UCHAR ReportID;
 225     ULONG ReportSize;
 226
 227     ULONG ItemCount;
 228     ULONG ItemAllocated;
 229     PHID_REPORT_ITEM* Items;
 230
 231 }HID_REPORT, *PHID_REPORT;
 232
 233 typedef struct
 234 {
 235     //
 236     // global item state
 237     //
 238     GLOBAL_ITEM_STATE GlobalItemState;
 239
 240     //
 241     // local item state
 242     //
 243     LOCAL_ITEM_STATE LocalItemState;
 244
 245     //
 246     // root collection
 247     //
 248     PHID_COLLECTION RootCollection;
 249
 250     //
 251     // uses report ids
 252     //
 253     UCHAR UseReportIDs;
 254
 255     //
 256     // collection index
 257     //
 258     ULONG CollectionIndex;
 259
 260 }HID_PARSER_CONTEXT, *PHID_PARSER_CONTEXT;
 261
 262 HIDPARSER_STATUS
 263 HidParser_ParseReportDescriptor(
 264     PHID_PARSER Parser,
 265     PUCHAR Report,
 266     ULONG ReportSize);
 267
 268 ULONG
 269 HidParser_NumberOfTopCollections(
 270     IN PHID_PARSER Parser);
 271
 272 #define HID_REPORT_TYPE_INPUT           0x01
 273 #define HID_REPORT_TYPE_OUTPUT          0x02
 274 #define HID_REPORT_TYPE_FEATURE         0x04
 275
 276 HIDPARSER_STATUS
 277 HidParser_GetCollectionUsagePage(
 278     IN PHID_PARSER Parser,
 279     IN ULONG CollectionNumber,
 280     OUT PUSHORT Usage,
 281     OUT PUSHORT UsagePage);
 282
 283 ULONG
 284 HidParser_GetReportLength(
 285     IN PHID_PARSER Parser,
 286     IN ULONG CollectionIndex,
 287     IN ULONG ReportType);
 288
 289 UCHAR
 290 HidParser_IsReportIDUsed(
 291     IN PHID_PARSER Parser);
 292
 293 ULONG
 294 HidParser_GetReportItemCountFromReportType(
 295     IN PHID_PARSER Parser,
 296     IN ULONG CollectionNumber,
 297     IN ULONG ReportType);
 298
 299 ULONG
 300 HidParser_GetReportItemTypeCountFromReportType(
 301     IN PHID_PARSER Parser,
 302     IN ULONG CollectionNumber,
 303     IN ULONG ReportType,
 304     IN ULONG bData);
 305
 306 ULONG
 307 HidParser_GetContextSize(
 308     IN PHID_PARSER Parser,
 309     IN ULONG CollectionNumber);
 310
 311 VOID
 312 HidParser_FreeContext(
 313     IN PHID_PARSER Parser,
 314     IN PUCHAR Context,
 315     IN ULONG ContextLength);
 316
 317 ULONG
 318 HidParser_GetTotalCollectionCount(
 319     IN PHID_PARSER Parser);
 320
 321 ULONG
 322 HidParser_GetMaxUsageListLengthWithReportAndPage(
 323     IN PHID_PARSER Parser,
 324     IN ULONG CollectionNumber,
 325     IN ULONG  ReportType,
 326     IN USAGE  UsagePage  OPTIONAL);
 327
 328 HIDPARSER_STATUS
 329 HidParser_GetSpecificValueCapsWithReport(
 330     IN PHID_PARSER Parser,
 331     IN ULONG CollectionNumber,
 332     IN ULONG ReportType,
 333     IN USHORT UsagePage,
 334     IN USHORT Usage,
 335     OUT PHIDP_VALUE_CAPS  ValueCaps,
 336     IN OUT PULONG  ValueCapsLength);
 337
 338
 339 HIDPARSER_STATUS
 340 HidParser_GetUsagesWithReport(
 341     IN PHID_PARSER Parser,
 342     IN ULONG CollectionNumber,
 343     IN ULONG  ReportType,
 344     IN USAGE  UsagePage,
 345     OUT USAGE  *UsageList,
 346     IN OUT PULONG UsageLength,
 347     IN PCHAR  ReportDescriptor,
 348     IN ULONG  ReportDescriptorLength);
 349
 350 HIDPARSER_STATUS
 351 HidParser_GetScaledUsageValueWithReport(
 352     IN PHID_PARSER Parser,
 353     IN ULONG CollectionNumber,
 354     IN ULONG ReportType,
 355     IN USAGE UsagePage,
 356     IN USAGE  Usage,
 357     OUT PLONG UsageValue,
 358     IN PCHAR ReportDescriptor,
 359     IN ULONG ReportDescriptorLength);
 360
 361 ULONG
 362 HidParser_GetCollectionNumberFromParserContext(
 363     IN PHID_PARSER Parser);
 364