[1166] | 1 | /*
|
---|
| 2 | * hidclass.h
|
---|
| 3 | *
|
---|
| 4 | * HID class driver interface
|
---|
| 5 | *
|
---|
| 6 | * This file is part of the w32api package.
|
---|
| 7 | *
|
---|
| 8 | * Contributors:
|
---|
| 9 | * Created by Casper S. Hornstrup <chorns@users.sourceforge.net>
|
---|
| 10 | *
|
---|
| 11 | * THIS SOFTWARE IS NOT COPYRIGHTED
|
---|
| 12 | *
|
---|
| 13 | * This source code is offered for use in the public domain. You may
|
---|
| 14 | * use, modify or distribute it freely.
|
---|
| 15 | *
|
---|
| 16 | * This code is distributed in the hope that it will be useful but
|
---|
| 17 | * WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY
|
---|
| 18 | * DISCLAIMED. This includes but is not limited to warranties of
|
---|
| 19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
---|
| 20 | *
|
---|
| 21 | */
|
---|
| 22 |
|
---|
| 23 | #ifndef __HIDCLASS_H
|
---|
| 24 | #define __HIDCLASS_H
|
---|
| 25 |
|
---|
| 26 | #include "hidpi.h"
|
---|
| 27 |
|
---|
| 28 | #ifdef __cplusplus
|
---|
| 29 | extern "C" {
|
---|
| 30 | #endif
|
---|
| 31 |
|
---|
| 32 | #define HID_REVISION 0x00000001
|
---|
| 33 |
|
---|
| 34 | DEFINE_GUID (GUID_DEVINTERFACE_HID, \
|
---|
| 35 | 0x4D1E55B2L, 0xF16F, 0x11CF, 0x88, 0xCB, 0x00, 0x11, 0x11, 0x00, 0x00, 0x30);
|
---|
| 36 | DEFINE_GUID (GUID_HID_INTERFACE_NOTIFY, \
|
---|
| 37 | 0x2c4e2e88L, 0x25e6, 0x4c33, 0x88, 0x2f, 0x3d, 0x82, 0xe6, 0x07, 0x36, 0x81);
|
---|
| 38 | DEFINE_GUID (GUID_HID_INTERFACE_HIDPARSE, \
|
---|
| 39 | 0xf5c315a5, 0x69ac, 0x4bc2, 0x92, 0x79, 0xd0, 0xb6, 0x45, 0x76, 0xf4, 0x4b);
|
---|
| 40 |
|
---|
| 41 | #define GUID_CLASS_INPUT GUID_DEVINTERFACE_HID
|
---|
| 42 |
|
---|
| 43 | #define GUID_CLASS_INPUT_STR "4D1E55B2-F16F-11CF-88CB-001111000030"
|
---|
| 44 |
|
---|
| 45 |
|
---|
| 46 | #define HID_CTL_CODE(id) \
|
---|
| 47 | CTL_CODE (FILE_DEVICE_KEYBOARD, (id), METHOD_NEITHER, FILE_ANY_ACCESS)
|
---|
| 48 | #define HID_BUFFER_CTL_CODE(id) \
|
---|
| 49 | CTL_CODE (FILE_DEVICE_KEYBOARD, (id), METHOD_BUFFERED, FILE_ANY_ACCESS)
|
---|
| 50 | #define HID_IN_CTL_CODE(id) \
|
---|
| 51 | CTL_CODE (FILE_DEVICE_KEYBOARD, (id), METHOD_IN_DIRECT, FILE_ANY_ACCESS)
|
---|
| 52 | #define HID_OUT_CTL_CODE(id) \
|
---|
| 53 | CTL_CODE (FILE_DEVICE_KEYBOARD, (id), METHOD_OUT_DIRECT, FILE_ANY_ACCESS)
|
---|
| 54 |
|
---|
| 55 |
|
---|
| 56 | #define IOCTL_GET_PHYSICAL_DESCRIPTOR HID_OUT_CTL_CODE(102)
|
---|
| 57 | #define IOCTL_HID_FLUSH_QUEUE HID_CTL_CODE(101)
|
---|
| 58 | #define IOCTL_HID_GET_COLLECTION_DESCRIPTOR HID_CTL_CODE(100)
|
---|
| 59 | #define IOCTL_HID_GET_COLLECTION_INFORMATION HID_BUFFER_CTL_CODE(106)
|
---|
| 60 | #define IOCTL_HID_GET_FEATURE HID_OUT_CTL_CODE(100)
|
---|
| 61 | #define IOCTL_HID_GET_HARDWARE_ID HID_OUT_CTL_CODE(103)
|
---|
| 62 | #define IOCTL_HID_GET_INDEXED_STRING HID_OUT_CTL_CODE(120)
|
---|
| 63 | #define IOCTL_HID_GET_INPUT_REPORT HID_OUT_CTL_CODE(104)
|
---|
| 64 | #define IOCTL_HID_GET_MANUFACTURER_STRING HID_OUT_CTL_CODE(110)
|
---|
| 65 | #define IOCTL_GET_NUM_DEVICE_INPUT_BUFFERS HID_BUFFER_CTL_CODE(104)
|
---|
| 66 | #define IOCTL_HID_GET_POLL_FREQUENCY_MSEC HID_BUFFER_CTL_CODE(102)
|
---|
| 67 | #define IOCTL_HID_GET_PRODUCT_STRING HID_OUT_CTL_CODE(111)
|
---|
| 68 | #define IOCTL_HID_GET_SERIALNUMBER_STRING HID_OUT_CTL_CODE(112)
|
---|
| 69 | #define IOCTL_HID_SET_FEATURE HID_IN_CTL_CODE(100)
|
---|
| 70 | #define IOCTL_SET_NUM_DEVICE_INPUT_BUFFERS HID_BUFFER_CTL_CODE(105)
|
---|
| 71 | #define IOCTL_HID_SET_OUTPUT_REPORT HID_IN_CTL_CODE(101)
|
---|
| 72 | #define IOCTL_HID_SET_POLL_FREQUENCY_MSEC HID_BUFFER_CTL_CODE(103)
|
---|
| 73 |
|
---|
| 74 | #define IOCTL_HID_GET_DRIVER_CONFIG HID_BUFFER_CTL_CODE(100)
|
---|
| 75 | #define IOCTL_HID_SET_DRIVER_CONFIG HID_BUFFER_CTL_CODE(101)
|
---|
| 76 | #define IOCTL_HID_GET_MS_GENRE_DESCRIPTOR HID_OUT_CTL_CODE(121)
|
---|
| 77 |
|
---|
| 78 | /* FIXME: these values are wrong! */
|
---|
| 79 | #define IOCTL_HID_GET_STRING 0
|
---|
| 80 | #define IOCTL_HID_GET_DEVICE_ATTRIBUTES 1
|
---|
| 81 | #define IOCTL_HID_GET_DEVICE_DESCRIPTOR 2
|
---|
| 82 | #define IOCTL_HID_READ_REPORT 3
|
---|
| 83 | #define IOCTL_HID_WRITE_REPORT 4
|
---|
| 84 | #define IOCTL_HID_GET_REPORT_DESCRIPTOR 5
|
---|
| 85 |
|
---|
| 86 | typedef enum _HID_STRING_TYPE
|
---|
| 87 | {
|
---|
| 88 | HID_STRING_INDEXED = 0,
|
---|
| 89 | HID_STRING_ID_IMANUFACTURER,
|
---|
| 90 | HID_STRING_ID_IPRODUCT,
|
---|
| 91 | HID_STRING_ID_ISERIALNUMBER,
|
---|
| 92 | HID_STRING_MAX
|
---|
| 93 | } HID_STRING_TYPE;
|
---|
| 94 |
|
---|
| 95 | enum DeviceObjectState {
|
---|
| 96 | DeviceObjectStarted = 0,
|
---|
| 97 | DeviceObjectStopped,
|
---|
| 98 | DeviceObjectRemoved
|
---|
| 99 | };
|
---|
| 100 |
|
---|
| 101 | typedef VOID (NTAPI *PHID_STATUS_CHANGE)(
|
---|
| 102 | PVOID Context,
|
---|
| 103 | enum DeviceObjectState State);
|
---|
| 104 |
|
---|
| 105 | typedef NTSTATUS (NTAPI *PHIDP_GETCAPS)(
|
---|
| 106 | IN PHIDP_PREPARSED_DATA PreparsedData,
|
---|
| 107 | OUT PHIDP_CAPS Capabilities);
|
---|
| 108 |
|
---|
| 109 | typedef struct _HID_COLLECTION_INFORMATION {
|
---|
| 110 | ULONG DescriptorSize;
|
---|
| 111 | BOOLEAN Polled;
|
---|
| 112 | UCHAR Reserved1[1];
|
---|
| 113 | USHORT VendorID;
|
---|
| 114 | USHORT ProductID;
|
---|
| 115 | USHORT VersionNumber;
|
---|
| 116 | } HID_COLLECTION_INFORMATION, *PHID_COLLECTION_INFORMATION;
|
---|
| 117 |
|
---|
| 118 | typedef struct _HID_DRIVER_CONFIG {
|
---|
| 119 | ULONG Size;
|
---|
| 120 | ULONG RingBufferSize;
|
---|
| 121 | } HID_DRIVER_CONFIG, *PHID_DRIVER_CONFIG;
|
---|
| 122 |
|
---|
| 123 | typedef struct _HID_INTERFACE_HIDPARSE {
|
---|
| 124 | #ifdef __cplusplus
|
---|
| 125 | INTERFACE i;
|
---|
| 126 | #else
|
---|
| 127 | /* GCC doesn't support including unnamed structs, so INTERFACE is
|
---|
| 128 | expanded here */
|
---|
| 129 | USHORT Size;
|
---|
| 130 | USHORT Version;
|
---|
| 131 | PVOID Context;
|
---|
| 132 | PINTERFACE_REFERENCE InterfaceReference;
|
---|
| 133 | PINTERFACE_DEREFERENCE InterfaceDereference;
|
---|
| 134 | #endif
|
---|
| 135 | PHIDP_GETCAPS HidpGetCaps;
|
---|
| 136 | } HID_INTERFACE_HIDPARSE, *PHID_INTERFACE_HIDPARSE;
|
---|
| 137 |
|
---|
| 138 | typedef struct _HID_INTERFACE_NOTIFY_PNP {
|
---|
| 139 | #ifdef __cplusplus
|
---|
| 140 | INTERFACE i;
|
---|
| 141 | #else
|
---|
| 142 | /* GCC doesn't support including unnamed structs, so INTERFACE is
|
---|
| 143 | expanded here */
|
---|
| 144 | USHORT Size;
|
---|
| 145 | USHORT Version;
|
---|
| 146 | PVOID Context;
|
---|
| 147 | PINTERFACE_REFERENCE InterfaceReference;
|
---|
| 148 | PINTERFACE_DEREFERENCE InterfaceDereference;
|
---|
| 149 | #endif
|
---|
| 150 | PHID_STATUS_CHANGE StatusChangeFn;
|
---|
| 151 | PVOID CallbackContext;
|
---|
| 152 | } HID_INTERFACE_NOTIFY_PNP, *PHID_INTERFACE_NOTIFY_PNP;
|
---|
| 153 |
|
---|
| 154 | typedef struct _HID_XFER_PACKET {
|
---|
| 155 | PUCHAR reportBuffer;
|
---|
| 156 | ULONG reportBufferLen;
|
---|
| 157 | UCHAR reportId;
|
---|
| 158 | } HID_XFER_PACKET, *PHID_XFER_PACKET;
|
---|
| 159 |
|
---|
| 160 | #ifdef __cplusplus
|
---|
| 161 | }
|
---|
| 162 | #endif
|
---|
| 163 |
|
---|
| 164 | #endif /* __HIDCLASS_H */
|
---|