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