dlls/hidclass.sys/hid.h

   1 /*
   2  * Copyright 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
  19 #include "ntstatus.h"
  20 #define WIN32_NO_STATUS
  21 #include "windef.h"
  22 #include "winbase.h"
  23 #include "winternl.h"
  24 #include "winioctl.h"
  25 #include "ddk/wdm.h"
  26 #include "hidusage.h"
  27 #include "ddk/hidport.h"
  28 #include "ddk/hidclass.h"
  29 #include "ddk/hidpi.h"
  30 #include "cfgmgr32.h"
  31 #include "wine/list.h"
  32 #include "wine/hid.h"
  33
  34 #define DEFAULT_POLL_INTERVAL 200
  35 #define MAX_POLL_INTERVAL_MSEC 10000
  36
  37 /* Ring buffer functions */
  38 struct ReportRingBuffer;
  39
  40 typedef struct _BASE_DEVICE_EXTENSION
  41 {
  42     union
  43     {
  44         struct
  45         {
  46             /* this must be the first member */
  47             HID_DEVICE_EXTENSION hid_ext;
  48
  49             DEVICE_OBJECT *child_pdo;
  50         } fdo;
  51
  52         struct
  53         {
  54             DEVICE_OBJECT *parent_fdo;
  55
  56             HID_COLLECTION_INFORMATION information;
  57             struct hid_preparsed_data *preparsed_data;
  58
  59             ULONG poll_interval;
  60             HANDLE halt_event;
  61             HANDLE thread;
  62             UINT32 rawinput_handle;
  63
  64             KSPIN_LOCK report_queues_lock;
  65             struct list report_queues;
  66
  67             UNICODE_STRING link_name;
  68
  69             KSPIN_LOCK irp_queue_lock;
  70             LIST_ENTRY irp_queue;
  71
  72             KSPIN_LOCK lock;
  73             BOOL removed;
  74
  75             BOOL is_mouse;
  76             UNICODE_STRING mouse_link_name;
  77             BOOL is_keyboard;
  78             UNICODE_STRING keyboard_link_name;
  79         } pdo;
  80     } u;
  81
  82     /* These are unique to the parent FDO, but stored in the children as well
  83      * for convenience. */
  84     WCHAR device_id[MAX_DEVICE_ID_LEN];
  85     WCHAR instance_id[MAX_DEVICE_ID_LEN];
  86
  87     BOOL is_fdo;
  88 } BASE_DEVICE_EXTENSION;
  89
  90 struct hid_report
  91 {
  92     LONG  ref;
  93     ULONG length;
  94     BYTE  buffer[1];
  95 };
  96
  97 struct hid_report_queue
  98 {
  99     struct list        entry;
 100     KSPIN_LOCK         lock;
 101     ULONG              length;
 102     ULONG              read_idx;
 103     ULONG              write_idx;
 104     struct hid_report *reports[512];
 105 };
 106
 107 typedef struct _minidriver
 108 {
 109     struct list entry;
 110
 111     HID_MINIDRIVER_REGISTRATION minidriver;
 112
 113     PDRIVER_UNLOAD DriverUnload;
 114
 115     PDRIVER_ADD_DEVICE AddDevice;
 116     PDRIVER_DISPATCH PNPDispatch;
 117 } minidriver;
 118
 119 void call_minidriver( ULONG code, DEVICE_OBJECT *device, void *in_buff, ULONG in_size,
 120                       void *out_buff, ULONG out_size, IO_STATUS_BLOCK *io ) DECLSPEC_HIDDEN;
 121
 122 /* Internal device functions */
 123 void HID_StartDeviceThread(DEVICE_OBJECT *device) DECLSPEC_HIDDEN;
 124
 125 IRP *pop_irp_from_queue(BASE_DEVICE_EXTENSION *ext) DECLSPEC_HIDDEN;
 126
 127 NTSTATUS WINAPI pdo_ioctl(DEVICE_OBJECT *device, IRP *irp) DECLSPEC_HIDDEN;
 128 NTSTATUS WINAPI pdo_read(DEVICE_OBJECT *device, IRP *irp) DECLSPEC_HIDDEN;
 129 NTSTATUS WINAPI pdo_write(DEVICE_OBJECT *device, IRP *irp) DECLSPEC_HIDDEN;
 130 NTSTATUS WINAPI pdo_create(DEVICE_OBJECT *device, IRP *irp) DECLSPEC_HIDDEN;
 131 NTSTATUS WINAPI pdo_close(DEVICE_OBJECT *device, IRP *irp) DECLSPEC_HIDDEN;
 132
 133 /* Parsing HID Report Descriptors into preparsed data */
 134 struct hid_preparsed_data *parse_descriptor( BYTE *descriptor, unsigned int length ) DECLSPEC_HIDDEN;