include/ddk/hidclass.h

   1 /*
   2  * Copyright (C) 2015 Aric Stewart
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18 #ifndef __HIDCLASS_H
  19 #define __HIDCLASS_H
  20
  21 #ifdef __cplusplus
  22 extern "C" {
  23 #endif
  24
  25 #define HID_REVISION 1
  26
  27 DEFINE_GUID (GUID_DEVINTERFACE_HID, \
  28   0x4D1E55B2L, 0xF16F, 0x11CF, 0x88, 0xCB, 0x00, 0x11, 0x11, 0x00, 0x00, 0x30);
  29
  30 #define HID_CTL_CODE(id) \
  31   CTL_CODE (FILE_DEVICE_KEYBOARD, (id), METHOD_NEITHER, FILE_ANY_ACCESS)
  32 #define HID_BUFFER_CTL_CODE(id) \
  33   CTL_CODE (FILE_DEVICE_KEYBOARD, (id), METHOD_BUFFERED, FILE_ANY_ACCESS)
  34 #define HID_IN_CTL_CODE(id) \
  35   CTL_CODE (FILE_DEVICE_KEYBOARD, (id), METHOD_IN_DIRECT, FILE_ANY_ACCESS)
  36 #define HID_OUT_CTL_CODE(id) \
  37   CTL_CODE (FILE_DEVICE_KEYBOARD, (id), METHOD_OUT_DIRECT, FILE_ANY_ACCESS)
  38
  39 #define IOCTL_GET_PHYSICAL_DESCRIPTOR         HID_OUT_CTL_CODE(102)
  40 #define IOCTL_HID_FLUSH_QUEUE                 HID_CTL_CODE(101)
  41 #define IOCTL_HID_GET_COLLECTION_DESCRIPTOR   HID_CTL_CODE(100)
  42 #define IOCTL_HID_GET_COLLECTION_INFORMATION  HID_BUFFER_CTL_CODE(106)
  43 #define IOCTL_HID_GET_FEATURE                 HID_OUT_CTL_CODE(100)
  44 #define IOCTL_HID_GET_HARDWARE_ID             HID_OUT_CTL_CODE(103)
  45 #define IOCTL_HID_GET_INDEXED_STRING          HID_OUT_CTL_CODE(120)
  46 #define IOCTL_HID_GET_INPUT_REPORT            HID_OUT_CTL_CODE(104)
  47 #define IOCTL_HID_GET_MANUFACTURER_STRING     HID_OUT_CTL_CODE(110)
  48 #define IOCTL_GET_NUM_DEVICE_INPUT_BUFFERS    HID_BUFFER_CTL_CODE(104)
  49 #define IOCTL_HID_GET_POLL_FREQUENCY_MSEC     HID_BUFFER_CTL_CODE(102)
  50 #define IOCTL_HID_GET_PRODUCT_STRING          HID_OUT_CTL_CODE(111)
  51 #define IOCTL_HID_GET_SERIALNUMBER_STRING     HID_OUT_CTL_CODE(112)
  52 #define IOCTL_HID_SET_FEATURE                 HID_IN_CTL_CODE(100)
  53 #define IOCTL_SET_NUM_DEVICE_INPUT_BUFFERS    HID_BUFFER_CTL_CODE(105)
  54 #define IOCTL_HID_SET_OUTPUT_REPORT           HID_IN_CTL_CODE(101)
  55 #define IOCTL_HID_SET_POLL_FREQUENCY_MSEC     HID_BUFFER_CTL_CODE(103)
  56
  57 #define IOCTL_HID_GET_DRIVER_CONFIG           HID_BUFFER_CTL_CODE(100)
  58 #define IOCTL_HID_SET_DRIVER_CONFIG           HID_BUFFER_CTL_CODE(101)
  59 #define IOCTL_HID_GET_MS_GENRE_DESCRIPTOR     HID_OUT_CTL_CODE(121)
  60
  61 typedef struct _HID_COLLECTION_INFORMATION {
  62     ULONG   DescriptorSize;
  63     BOOLEAN Polled;
  64     UCHAR   Reserved1[1];
  65     USHORT  VendorID;
  66     USHORT  ProductID;
  67     USHORT  VersionNumber;
  68 } HID_COLLECTION_INFORMATION, *PHID_COLLECTION_INFORMATION;
  69
  70 typedef struct _HID_XFER_PACKET {
  71   PUCHAR reportBuffer;
  72   ULONG  reportBufferLen;
  73   UCHAR  reportId;
  74 } HID_XFER_PACKET, *PHID_XFER_PACKET;
  75
  76 #ifdef __cplusplus
  77 }
  78 #endif
  79
  80 #endif /* __HIDCLASS_H */