dlls/winebus.sys/bus_iohid.c

   1 /*  Bus like function for mac HID devices
   2  *
   3  * Copyright 2016 CodeWeavers, Aric Stewart
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  18  */
  19
  20 #include "config.h"
  21 #include "wine/port.h"
  22
  23 #include <stdarg.h>
  24
  25 #if defined(HAVE_IOKIT_HID_IOHIDLIB_H)
  26 #define DWORD UInt32
  27 #define LPDWORD UInt32*
  28 #define LONG SInt32
  29 #define LPLONG SInt32*
  30 #define E_PENDING __carbon_E_PENDING
  31 #define ULONG __carbon_ULONG
  32 #define E_INVALIDARG __carbon_E_INVALIDARG
  33 #define E_OUTOFMEMORY __carbon_E_OUTOFMEMORY
  34 #define E_HANDLE __carbon_E_HANDLE
  35 #define E_ACCESSDENIED __carbon_E_ACCESSDENIED
  36 #define E_UNEXPECTED __carbon_E_UNEXPECTED
  37 #define E_FAIL __carbon_E_FAIL
  38 #define E_ABORT __carbon_E_ABORT
  39 #define E_POINTER __carbon_E_POINTER
  40 #define E_NOINTERFACE __carbon_E_NOINTERFACE
  41 #define E_NOTIMPL __carbon_E_NOTIMPL
  42 #define S_FALSE __carbon_S_FALSE
  43 #define S_OK __carbon_S_OK
  44 #define HRESULT_FACILITY __carbon_HRESULT_FACILITY
  45 #define IS_ERROR __carbon_IS_ERROR
  46 #define FAILED __carbon_FAILED
  47 #define SUCCEEDED __carbon_SUCCEEDED
  48 #define MAKE_HRESULT __carbon_MAKE_HRESULT
  49 #define HRESULT __carbon_HRESULT
  50 #define STDMETHODCALLTYPE __carbon_STDMETHODCALLTYPE
  51 #define PAGE_SHIFT __carbon_PAGE_SHIFT
  52 #include <IOKit/IOKitLib.h>
  53 #include <IOKit/hid/IOHIDLib.h>
  54 #undef ULONG
  55 #undef E_INVALIDARG
  56 #undef E_OUTOFMEMORY
  57 #undef E_HANDLE
  58 #undef E_ACCESSDENIED
  59 #undef E_UNEXPECTED
  60 #undef E_FAIL
  61 #undef E_ABORT
  62 #undef E_POINTER
  63 #undef E_NOINTERFACE
  64 #undef E_NOTIMPL
  65 #undef S_FALSE
  66 #undef S_OK
  67 #undef HRESULT_FACILITY
  68 #undef IS_ERROR
  69 #undef FAILED
  70 #undef SUCCEEDED
  71 #undef MAKE_HRESULT
  72 #undef HRESULT
  73 #undef STDMETHODCALLTYPE
  74 #undef DWORD
  75 #undef LPDWORD
  76 #undef LONG
  77 #undef LPLONG
  78 #undef E_PENDING
  79 #undef PAGE_SHIFT
  80 #endif /* HAVE_IOKIT_HID_IOHIDLIB_H */
  81
  82 #define NONAMELESSUNION
  83
  84 #include "ntstatus.h"
  85 #define WIN32_NO_STATUS
  86 #include "windef.h"
  87 #include "winbase.h"
  88 #include "winternl.h"
  89 #include "winioctl.h"
  90 #include "ddk/wdm.h"
  91 #include "ddk/hidtypes.h"
  92 #include "wine/debug.h"
  93
  94 #include "bus.h"
  95
  96 WINE_DEFAULT_DEBUG_CHANNEL(plugplay);
  97 #ifdef HAVE_IOHIDMANAGERCREATE
  98
  99 static DRIVER_OBJECT *iohid_driver_obj = NULL;
 100 static IOHIDManagerRef hid_manager;
 101
 102 static const WCHAR busidW[] = {'I','O','H','I','D',0};
 103
 104 #include "initguid.h"
 105 DEFINE_GUID(GUID_DEVCLASS_IOHID, 0x989D309D,0x0470,0x4E1A,0x89,0x38,0x50,0x1F,0x42,0xBD,0x9A,0xCD);
 106
 107 struct platform_private
 108 {
 109     IOHIDDeviceRef device;
 110     uint8_t *buffer;
 111 };
 112
 113 static inline struct platform_private *impl_from_DEVICE_OBJECT(DEVICE_OBJECT *device)
 114 {
 115     return (struct platform_private *)get_platform_private(device);
 116 }
 117
 118 static void CFStringToWSTR(CFStringRef cstr, LPWSTR wstr, int length)
 119 {
 120     int len = min(CFStringGetLength(cstr), length-1);
 121     CFStringGetCharacters(cstr, CFRangeMake(0, len), (UniChar*)wstr);
 122     wstr[len] = 0;
 123 }
 124
 125 static DWORD CFNumberToDWORD(CFNumberRef num)
 126 {
 127     int dwNum = 0;
 128     if (num)
 129         CFNumberGetValue(num, kCFNumberIntType, &dwNum);
 130     return dwNum;
 131 }
 132
 133 static void handle_IOHIDDeviceIOHIDReportCallback(void *context,
 134         IOReturn result, void *sender, IOHIDReportType type,
 135         uint32_t reportID, uint8_t *report, CFIndex report_length)
 136 {
 137     DEVICE_OBJECT *device = (DEVICE_OBJECT*)context;
 138     process_hid_report(device, report, report_length);
 139 }
 140
 141 static int compare_platform_device(DEVICE_OBJECT *device, void *platform_dev)
 142 {
 143     struct platform_private *private = impl_from_DEVICE_OBJECT(device);
 144     IOHIDDeviceRef dev2 = (IOHIDDeviceRef)platform_dev;
 145     if (private->device != dev2)
 146         return 1;
 147     else
 148         return 0;
 149 }
 150
 151 static NTSTATUS get_reportdescriptor(DEVICE_OBJECT *device, BYTE *buffer, DWORD length, DWORD *out_length)
 152 {
 153     struct platform_private *private = impl_from_DEVICE_OBJECT(device);
 154     CFDataRef data = IOHIDDeviceGetProperty(private->device, CFSTR(kIOHIDReportDescriptorKey));
 155     int data_length = CFDataGetLength(data);
 156     const UInt8 *ptr;
 157
 158     *out_length = data_length;
 159     if (length < data_length)
 160         return STATUS_BUFFER_TOO_SMALL;
 161
 162     ptr = CFDataGetBytePtr(data);
 163     memcpy(buffer, ptr, data_length);
 164     return STATUS_SUCCESS;
 165 }
 166
 167 static NTSTATUS get_string(DEVICE_OBJECT *device, DWORD index, WCHAR *buffer, DWORD length)
 168 {
 169     struct platform_private *private = impl_from_DEVICE_OBJECT(device);
 170     CFStringRef str;
 171     switch (index)
 172     {
 173         case HID_STRING_ID_IPRODUCT:
 174             str = IOHIDDeviceGetProperty(private->device, CFSTR(kIOHIDProductKey));
 175             break;
 176         case HID_STRING_ID_IMANUFACTURER:
 177             str = IOHIDDeviceGetProperty(private->device, CFSTR(kIOHIDManufacturerKey));
 178             break;
 179         case HID_STRING_ID_ISERIALNUMBER:
 180             str = IOHIDDeviceGetProperty(private->device, CFSTR(kIOHIDSerialNumberKey));
 181             break;
 182         default:
 183             ERR("Unknown string index\n");
 184             return STATUS_NOT_IMPLEMENTED;
 185     }
 186
 187     if (str)
 188     {
 189         if (length < CFStringGetLength(str) + 1)
 190             return STATUS_BUFFER_TOO_SMALL;
 191         CFStringToWSTR(str, buffer, length);
 192     }
 193     else
 194     {
 195         if (!length) return STATUS_BUFFER_TOO_SMALL;
 196         buffer[0] = 0;
 197     }
 198
 199     return STATUS_SUCCESS;
 200 }
 201
 202 static NTSTATUS begin_report_processing(DEVICE_OBJECT *device)
 203 {
 204     DWORD length;
 205     struct platform_private *private = impl_from_DEVICE_OBJECT(device);
 206     CFNumberRef num;
 207
 208     if (private->buffer)
 209         return STATUS_SUCCESS;
 210
 211     num = IOHIDDeviceGetProperty(private->device, CFSTR(kIOHIDMaxInputReportSizeKey));
 212     length = CFNumberToDWORD(num);
 213     private->buffer = HeapAlloc(GetProcessHeap(), 0, length);
 214
 215     IOHIDDeviceRegisterInputReportCallback(private->device, private->buffer, length, handle_IOHIDDeviceIOHIDReportCallback, device);
 216     return STATUS_SUCCESS;
 217 }
 218
 219 static NTSTATUS set_output_report(DEVICE_OBJECT *device, UCHAR id, BYTE *report, DWORD length, ULONG_PTR *written)
 220 {
 221     IOReturn result;
 222     struct platform_private *private = impl_from_DEVICE_OBJECT(device);
 223     result = IOHIDDeviceSetReport(private->device, kIOHIDReportTypeOutput, id, report, length);
 224     if (result == kIOReturnSuccess)
 225     {
 226         *written = length;
 227         return STATUS_SUCCESS;
 228     }
 229     else
 230     {
 231         *written = 0;
 232         return STATUS_UNSUCCESSFUL;
 233     }
 234 }
 235
 236 static NTSTATUS get_feature_report(DEVICE_OBJECT *device, UCHAR id, BYTE *report, DWORD length, ULONG_PTR *read)
 237 {
 238     IOReturn ret;
 239     CFIndex report_length = length;
 240     struct platform_private *private = impl_from_DEVICE_OBJECT(device);
 241
 242     ret = IOHIDDeviceGetReport(private->device, kIOHIDReportTypeFeature, id, report, &report_length);
 243     if (ret == kIOReturnSuccess)
 244     {
 245         *read = report_length;
 246         return STATUS_SUCCESS;
 247     }
 248     else
 249     {
 250         *read = 0;
 251         return STATUS_UNSUCCESSFUL;
 252     }
 253 }
 254
 255 static NTSTATUS set_feature_report(DEVICE_OBJECT *device, UCHAR id, BYTE *report, DWORD length, ULONG_PTR *written)
 256 {
 257     IOReturn result;
 258     struct platform_private *private = impl_from_DEVICE_OBJECT(device);
 259
 260     result = IOHIDDeviceSetReport(private->device, kIOHIDReportTypeFeature, id, report, length);
 261     if (result == kIOReturnSuccess)
 262     {
 263         *written = length;
 264         return STATUS_SUCCESS;
 265     }
 266     else
 267     {
 268         *written = 0;
 269         return STATUS_UNSUCCESSFUL;
 270     }
 271 }
 272
 273 static const platform_vtbl iohid_vtbl =
 274 {
 275     compare_platform_device,
 276     get_reportdescriptor,
 277     get_string,
 278     begin_report_processing,
 279     set_output_report,
 280     get_feature_report,
 281     set_feature_report,
 282 };
 283
 284 static void handle_DeviceMatchingCallback(void *context, IOReturn result, void *sender, IOHIDDeviceRef IOHIDDevice)
 285 {
 286     DEVICE_OBJECT *device;
 287     DWORD vid, pid, version;
 288     CFStringRef str = NULL;
 289     WCHAR serial_string[256];
 290     BOOL is_gamepad = FALSE;
 291
 292     TRACE("OS/X IOHID Device Added %p\n", IOHIDDevice);
 293
 294     vid = CFNumberToDWORD(IOHIDDeviceGetProperty(IOHIDDevice, CFSTR(kIOHIDVendorIDKey)));
 295     pid = CFNumberToDWORD(IOHIDDeviceGetProperty(IOHIDDevice, CFSTR(kIOHIDProductIDKey)));
 296     version = CFNumberToDWORD(IOHIDDeviceGetProperty(IOHIDDevice, CFSTR(kIOHIDVersionNumberKey)));
 297     str = IOHIDDeviceGetProperty(IOHIDDevice, CFSTR(kIOHIDSerialNumberKey));
 298     if (str) CFStringToWSTR(str, serial_string, sizeof(serial_string) / sizeof(WCHAR));
 299
 300     if (IOHIDDeviceConformsTo(IOHIDDevice, kHIDPage_GenericDesktop, kHIDUsage_GD_GamePad) ||
 301        IOHIDDeviceConformsTo(IOHIDDevice, kHIDPage_GenericDesktop, kHIDUsage_GD_Joystick))
 302     {
 303         if (is_xbox_gamepad(vid, pid))
 304             is_gamepad = TRUE;
 305         else
 306         {
 307             int axes=0, buttons=0;
 308             CFArrayRef element_array = IOHIDDeviceCopyMatchingElements(
 309                 IOHIDDevice, NULL, kIOHIDOptionsTypeNone);
 310
 311             if (element_array) {
 312                 CFIndex index;
 313                 CFIndex count = CFArrayGetCount(element_array);
 314                 for (index = 0; index < count; index++)
 315                 {
 316                     IOHIDElementRef element = (IOHIDElementRef)CFArrayGetValueAtIndex(element_array, index);
 317                     if (element)
 318                     {
 319                         int type = IOHIDElementGetType(element);
 320                         if (type == kIOHIDElementTypeInput_Button) buttons++;
 321                         if (type == kIOHIDElementTypeInput_Axis) axes++;
 322                         if (type == kIOHIDElementTypeInput_Misc)
 323                         {
 324                             uint32_t usage = IOHIDElementGetUsage(element);
 325                             switch (usage)
 326                             {
 327                                 case kHIDUsage_GD_X:
 328                                 case kHIDUsage_GD_Y:
 329                                 case kHIDUsage_GD_Z:
 330                                 case kHIDUsage_GD_Rx:
 331                                 case kHIDUsage_GD_Ry:
 332                                 case kHIDUsage_GD_Rz:
 333                                 case kHIDUsage_GD_Slider:
 334                                     axes ++;
 335                             }
 336                         }
 337                     }
 338                 }
 339                 CFRelease(element_array);
 340             }
 341             is_gamepad = (axes == 6  && buttons >= 14);
 342         }
 343     }
 344
 345     device = bus_create_hid_device(iohid_driver_obj, busidW, vid, pid, version, 0, str?serial_string:NULL, is_gamepad, &GUID_DEVCLASS_IOHID, &iohid_vtbl, sizeof(struct platform_private));
 346     if (!device)
 347         ERR("Failed to create device\n");
 348     else
 349     {
 350         struct platform_private *private = impl_from_DEVICE_OBJECT(device);
 351         private->device = IOHIDDevice;
 352         private->buffer = NULL;
 353         IoInvalidateDeviceRelations(device, BusRelations);
 354     }
 355 }
 356
 357 static void handle_RemovalCallback(void *context, IOReturn result, void *sender, IOHIDDeviceRef IOHIDDevice)
 358 {
 359     DEVICE_OBJECT *device;
 360     TRACE("OS/X IOHID Device Removed %p\n", IOHIDDevice);
 361     IOHIDDeviceRegisterInputReportCallback(IOHIDDevice, NULL, 0, NULL, NULL);
 362     /* Note: Yes, we leak the buffer. But according to research there is no
 363              safe way to deallocate that buffer. */
 364     device = bus_find_hid_device(&iohid_vtbl, IOHIDDevice);
 365     if (device)
 366     {
 367         IoInvalidateDeviceRelations(device, RemovalRelations);
 368         bus_remove_hid_device(device);
 369     }
 370 }
 371
 372 /* This puts the relevant run loop for event handling into a WINE thread */
 373 static DWORD CALLBACK runloop_thread(void *args)
 374 {
 375     CFRunLoopRef run_loop = CFRunLoopGetCurrent();
 376
 377     IOHIDManagerSetDeviceMatching(hid_manager, NULL);
 378     IOHIDManagerRegisterDeviceMatchingCallback(hid_manager, handle_DeviceMatchingCallback, NULL);
 379     IOHIDManagerRegisterDeviceRemovalCallback(hid_manager, handle_RemovalCallback, NULL);
 380     IOHIDManagerScheduleWithRunLoop(hid_manager, run_loop, kCFRunLoopDefaultMode);
 381     if (IOHIDManagerOpen( hid_manager, 0 ) != kIOReturnSuccess)
 382     {
 383         ERR("Couldn't open IOHIDManager.\n");
 384         IOHIDManagerUnscheduleFromRunLoop(hid_manager, run_loop, kCFRunLoopDefaultMode);
 385         CFRelease(hid_manager);
 386         return 0;
 387     }
 388
 389     CFRunLoopRun();
 390     TRACE("Run Loop exiting\n");
 391
 392     IOHIDManagerRegisterDeviceMatchingCallback(hid_manager, NULL, NULL);
 393     IOHIDManagerRegisterDeviceRemovalCallback(hid_manager, NULL, NULL);
 394     IOHIDManagerUnscheduleFromRunLoop(hid_manager, run_loop, kCFRunLoopDefaultMode);
 395     CFRelease(hid_manager);
 396     return 1;
 397 }
 398
 399 NTSTATUS WINAPI iohid_driver_init(DRIVER_OBJECT *driver, UNICODE_STRING *registry_path)
 400 {
 401     HANDLE run_loop_handle;
 402
 403     TRACE("(%p, %s)\n", driver, debugstr_w(registry_path->Buffer));
 404
 405     iohid_driver_obj = driver;
 406     driver->MajorFunction[IRP_MJ_PNP] = common_pnp_dispatch;
 407     driver->MajorFunction[IRP_MJ_INTERNAL_DEVICE_CONTROL] = hid_internal_dispatch;
 408     hid_manager = IOHIDManagerCreate(kCFAllocatorDefault, 0L);
 409     if (!(run_loop_handle = CreateThread(NULL, 0, runloop_thread, NULL, 0, NULL)))
 410     {
 411         ERR("Failed to initialize IOHID Manager thread\n");
 412         iohid_driver_obj = NULL;
 413         CFRelease(hid_manager);
 414         return STATUS_UNSUCCESSFUL;
 415     }
 416
 417     CloseHandle(run_loop_handle);
 418     return STATUS_SUCCESS;
 419 }
 420
 421 #else
 422
 423 NTSTATUS WINAPI iohid_driver_init(DRIVER_OBJECT *driver, UNICODE_STRING *registry_path)
 424 {
 425     WARN("IOHID Support not compiled into Wine.\n");
 426     return STATUS_NOT_IMPLEMENTED;
 427 }
 428
 429 #endif /* HAVE_IOHIDMANAGERCREATE */