buildtool/windows/tools/include/hidclass.h

/**
 * This file is part of the mingw-w64 runtime package.
 * No warranty is given; refer to the file DISCLAIMER within this package.
 */

#include <winapifamily.h>
#include <basetyps.h>

#if WINAPI_FAMILY_PARTITION (WINAPI_PARTITION_DESKTOP)
#define GUID_CLASS_INPUT GUID_DEVINTERFACE_HID

DEFINE_GUID (GUID_DEVINTERFACE_HID, 0x4d1e55b2, 0xf16f, 0x11cf, 0x88, 0xcb, 0x00, 0x11, 0x11, 0x00, 0x00, 0x30);
DEFINE_GUID (GUID_HID_INTERFACE_NOTIFY, 0x2c4e2e88, 0x25e6, 0x4c33, 0x88, 0x2f, 0x3d, 0x82, 0xe6, 0x07, 0x36, 0x81);
DEFINE_GUID (GUID_HID_INTERFACE_HIDPARSE, 0xf5c315a5, 0x69ac, 0x4bc2, 0x92, 0x79, 0xd0, 0xb6, 0x45, 0x76, 0xf4, 0x4b);
#endif

#ifndef __HIDCLASS_H__
#define __HIDCLASS_H__

#if WINAPI_FAMILY_PARTITION (WINAPI_PARTITION_DESKTOP)

#define GUID_CLASS_INPUT_STR "4D1E55B2-F16F-11CF-88CB-001111000030"

#define HID_REVISION 0x00000001

#define HID_CTL_CODE(id) CTL_CODE (FILE_DEVICE_KEYBOARD,(id), METHOD_NEITHER, FILE_ANY_ACCESS)
#define HID_BUFFER_CTL_CODE(id) CTL_CODE (FILE_DEVICE_KEYBOARD,(id), METHOD_BUFFERED, FILE_ANY_ACCESS)
#define HID_IN_CTL_CODE(id) CTL_CODE (FILE_DEVICE_KEYBOARD,(id), METHOD_IN_DIRECT, FILE_ANY_ACCESS)
#define HID_OUT_CTL_CODE(id) CTL_CODE (FILE_DEVICE_KEYBOARD,(id), METHOD_OUT_DIRECT, FILE_ANY_ACCESS)

#define IOCTL_HID_GET_DRIVER_CONFIG HID_BUFFER_CTL_CODE (100)
#define IOCTL_HID_SET_DRIVER_CONFIG HID_BUFFER_CTL_CODE (101)
#define IOCTL_HID_GET_POLL_FREQUENCY_MSEC HID_BUFFER_CTL_CODE (102)
#define IOCTL_HID_SET_POLL_FREQUENCY_MSEC HID_BUFFER_CTL_CODE (103)
#define IOCTL_GET_NUM_DEVICE_INPUT_BUFFERS HID_BUFFER_CTL_CODE (104)
#define IOCTL_SET_NUM_DEVICE_INPUT_BUFFERS HID_BUFFER_CTL_CODE (105)
#define IOCTL_HID_GET_COLLECTION_INFORMATION HID_BUFFER_CTL_CODE (106)

#define IOCTL_HID_GET_COLLECTION_DESCRIPTOR HID_CTL_CODE (100)
#define IOCTL_HID_FLUSH_QUEUE HID_CTL_CODE (101)
#define IOCTL_HID_SET_FEATURE HID_IN_CTL_CODE (100)
#define IOCTL_HID_SET_OUTPUT_REPORT HID_IN_CTL_CODE (101)
#define IOCTL_HID_GET_FEATURE HID_OUT_CTL_CODE (100)
#define IOCTL_GET_PHYSICAL_DESCRIPTOR HID_OUT_CTL_CODE (102)
#define IOCTL_HID_GET_HARDWARE_ID HID_OUT_CTL_CODE (103)
#define IOCTL_HID_GET_INPUT_REPORT HID_OUT_CTL_CODE (104)
#define IOCTL_HID_GET_MANUFACTURER_STRING HID_OUT_CTL_CODE (110)
#define IOCTL_HID_GET_PRODUCT_STRING HID_OUT_CTL_CODE (111)
#define IOCTL_HID_GET_SERIALNUMBER_STRING HID_OUT_CTL_CODE (112)
#define IOCTL_HID_GET_INDEXED_STRING HID_OUT_CTL_CODE (120)
#define IOCTL_HID_GET_MS_GENRE_DESCRIPTOR HID_OUT_CTL_CODE (121)
#define IOCTL_HID_ENABLE_SECURE_READ HID_CTL_CODE (130)
#define IOCTL_HID_DISABLE_SECURE_READ HID_CTL_CODE (131)

typedef struct _HID_XFER_PACKET {
  PUCHAR reportBuffer;
  ULONG reportBufferLen;
  UCHAR reportId;
} HID_XFER_PACKET,*PHID_XFER_PACKET;

#ifdef NT_INCLUDED
enum DeviceObjectState {
  DeviceObjectStarted,
  DeviceObjectStopped,
  DeviceObjectRemoved
};

typedef VOID (*PHID_STATUS_CHANGE) (PVOID Context, enum DeviceObjectState State);

typedef struct _HID_INTERFACE_NOTIFY_PNP {
#ifdef __cplusplus
  INTERFACE i;
#else
  /* inline instead.  See miniport.h/wdm.h of ddk */
  USHORT Size;
  USHORT Version;
  PVOID Context;
  PINTERFACE_REFERENCE InterfaceReference;
  PINTERFACE_DEREFERENCE InterfaceDereference;
#endif
  PHID_STATUS_CHANGE StatusChangeFn;
  PVOID CallbackContext;
} HID_INTERFACE_NOTIFY_PNP,*PHID_INTERFACE_NOTIFY_PNP;

#ifdef __HIDPI_H__
typedef NTSTATUS (__stdcall *PHIDP_GETCAPS) (PHIDP_PREPARSED_DATA PreparsedData, PHIDP_CAPS Capabilities);

typedef struct _HID_INTERFACE_HIDPARSE {
#ifdef __cplusplus
  INTERFACE i;
#else
  /* inline instead.  See miniport.h/wdm.h of ddk */
  USHORT Size;
  USHORT Version;
  PVOID Context;
  PINTERFACE_REFERENCE InterfaceReference;
  PINTERFACE_DEREFERENCE InterfaceDereference;
#endif
  PHIDP_GETCAPS HidpGetCaps;
} HID_INTERFACE_HIDPARSE,*PHID_INTERFACE_HIDPARSE;
#endif
#endif

typedef struct _HID_COLLECTION_INFORMATION {
  ULONG DescriptorSize;
  BOOLEAN Polled;
  UCHAR Reserved1[1];
  USHORT VendorID;
  USHORT ProductID;
  USHORT VersionNumber;
} HID_COLLECTION_INFORMATION,*PHID_COLLECTION_INFORMATION;

typedef struct _HID_DRIVER_CONFIG {
  ULONG Size;
  ULONG RingBufferSize;
} HID_DRIVER_CONFIG,*PHID_DRIVER_CONFIG;
#endif
#endif