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 "parse.h"
  33
  34 #define DEFAULT_POLL_INTERVAL 200
  35 #define MAX_POLL_INTERVAL_MSEC 10000
  36
  37 typedef NTSTATUS (WINAPI *pAddDevice)(DRIVER_OBJECT *DriverObject, DEVICE_OBJECT *PhysicalDeviceObject);
  38
  39 /* Ring buffer functions */
  40 struct ReportRingBuffer;
  41
  42 typedef struct _BASE_DEVICE_EXTENSION {
  43     HID_DEVICE_EXTENSION deviceExtension;
  44
  45     HID_COLLECTION_INFORMATION information;
  46     WINE_HIDP_PREPARSED_DATA *preparseData;
  47
  48     ULONG poll_interval;
  49     WCHAR *device_name;
  50     WCHAR *link_name;
  51     WCHAR device_id[MAX_DEVICE_ID_LEN];
  52     WCHAR instance_id[MAX_DEVICE_ID_LEN];
  53     struct ReportRingBuffer *ring_buffer;
  54     HANDLE halt_event;
  55     HANDLE thread;
  56
  57     LIST_ENTRY irp_queue;
  58
  59     /* Minidriver Specific stuff will end up here */
  60 } BASE_DEVICE_EXTENSION;
  61
  62 void RingBuffer_Write(struct ReportRingBuffer *buffer, void *data) DECLSPEC_HIDDEN;
  63 UINT RingBuffer_AddPointer(struct ReportRingBuffer *buffer) DECLSPEC_HIDDEN;
  64 void RingBuffer_RemovePointer(struct ReportRingBuffer *ring, UINT index) DECLSPEC_HIDDEN;
  65 void RingBuffer_Read(struct ReportRingBuffer *ring, UINT index, void *output, UINT *size) DECLSPEC_HIDDEN;
  66 void RingBuffer_ReadNew(struct ReportRingBuffer *buffer, UINT index, void *output, UINT *size) DECLSPEC_HIDDEN;
  67 UINT RingBuffer_GetBufferSize(struct ReportRingBuffer *buffer) DECLSPEC_HIDDEN;
  68 UINT RingBuffer_GetSize(struct ReportRingBuffer *buffer) DECLSPEC_HIDDEN;
  69 void RingBuffer_Destroy(struct ReportRingBuffer *buffer) DECLSPEC_HIDDEN;
  70 struct ReportRingBuffer* RingBuffer_Create(UINT buffer_size) DECLSPEC_HIDDEN;
  71 NTSTATUS RingBuffer_SetSize(struct ReportRingBuffer *buffer, UINT size) DECLSPEC_HIDDEN;
  72
  73 typedef struct _hiddevice
  74 {
  75     struct list entry;
  76     DEVICE_OBJECT *device;
  77 } hid_device;
  78
  79 typedef struct _minidriver
  80 {
  81     struct list entry;
  82
  83     HID_MINIDRIVER_REGISTRATION minidriver;
  84
  85     PDRIVER_UNLOAD DriverUnload;
  86
  87     pAddDevice AddDevice;
  88     PDRIVER_DISPATCH PNPDispatch;
  89     struct list device_list;
  90 } minidriver;
  91
  92 NTSTATUS call_minidriver(ULONG code, DEVICE_OBJECT *device, void *in_buff, ULONG in_size, void *out_buff, ULONG out_size) DECLSPEC_HIDDEN;
  93 minidriver* find_minidriver(DRIVER_OBJECT* driver) DECLSPEC_HIDDEN;
  94
  95 /* Internal device functions */
  96 NTSTATUS HID_CreateDevice(DEVICE_OBJECT *native_device, HID_MINIDRIVER_REGISTRATION *driver, DEVICE_OBJECT **device) DECLSPEC_HIDDEN;
  97 NTSTATUS HID_LinkDevice(DEVICE_OBJECT *device) DECLSPEC_HIDDEN;
  98 void HID_DeleteDevice(HID_MINIDRIVER_REGISTRATION *driver, DEVICE_OBJECT *device) DECLSPEC_HIDDEN;
  99 void HID_StartDeviceThread(DEVICE_OBJECT *device) DECLSPEC_HIDDEN;
 100
 101 NTSTATUS WINAPI HID_Device_ioctl(DEVICE_OBJECT *device, IRP *irp) DECLSPEC_HIDDEN;
 102 NTSTATUS WINAPI HID_Device_read(DEVICE_OBJECT *device, IRP *irp) DECLSPEC_HIDDEN;
 103 NTSTATUS WINAPI HID_Device_write(DEVICE_OBJECT *device, IRP *irp) DECLSPEC_HIDDEN;
 104 NTSTATUS WINAPI HID_Device_create(DEVICE_OBJECT *device, IRP *irp) DECLSPEC_HIDDEN;
 105 NTSTATUS WINAPI HID_Device_close(DEVICE_OBJECT *device, IRP *irp) DECLSPEC_HIDDEN;
 106 NTSTATUS WINAPI HID_PNP_Dispatch(DEVICE_OBJECT *device, IRP *irp) DECLSPEC_HIDDEN;
 107
 108 /* Pseudo-Plug and Play support*/
 109 NTSTATUS WINAPI PNP_AddDevice(DRIVER_OBJECT *driver, DEVICE_OBJECT* PDO) DECLSPEC_HIDDEN;
 110 NTSTATUS PNP_RemoveDevice(minidriver *minidriver, DEVICE_OBJECT* device, IRP* irp) DECLSPEC_HIDDEN;
 111
 112 /* Parsing HID Report Descriptors into preparsed data */
 113 WINE_HIDP_PREPARSED_DATA* ParseDescriptor(BYTE *descriptor, unsigned int length) DECLSPEC_HIDDEN;