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 IOHIDManagerRef hid_manager;
 100 static CFRunLoopRef run_loop;
 101 static HANDLE run_loop_handle;
 102
 103 static const WCHAR busidW[] = {'I','O','H','I','D',0};
 104
 105 struct platform_private
 106 {
 107     IOHIDDeviceRef device;
 108     uint8_t *buffer;
 109 };
 110
 111 static inline struct platform_private *impl_from_DEVICE_OBJECT(DEVICE_OBJECT *device)
 112 {
 113     return (struct platform_private *)get_platform_private(device);
 114 }
 115
 116 static void CFStringToWSTR(CFStringRef cstr, LPWSTR wstr, int length)
 117 {
 118     int len = min(CFStringGetLength(cstr), length-1);
 119     CFStringGetCharacters(cstr, CFRangeMake(0, len), (UniChar*)wstr);
 120     wstr[len] = 0;
 121 }
 122
 123 static DWORD CFNumberToDWORD(CFNumberRef num)
 124 {
 125     int dwNum = 0;
 126     if (num)
 127         CFNumberGetValue(num, kCFNumberIntType, &dwNum);
 128     return dwNum;
 129 }
 130
 131 static void handle_IOHIDDeviceIOHIDReportCallback(void *context,
 132         IOReturn result, void *sender, IOHIDReportType type,
 133         uint32_t reportID, uint8_t *report, CFIndex report_length)
 134 {
 135     DEVICE_OBJECT *device = (DEVICE_OBJECT*)context;
 136     process_hid_report(device, report, report_length);
 137 }
 138
 139 static int compare_platform_device(DEVICE_OBJECT *device, void *platform_dev)
 140 {
 141     struct platform_private *private = impl_from_DEVICE_OBJECT(device);
 142     IOHIDDeviceRef dev2 = (IOHIDDeviceRef)platform_dev;
 143     if (private->device != dev2)
 144         return 1;
 145     else
 146         return 0;
 147 }
 148
 149 static NTSTATUS get_reportdescriptor(DEVICE_OBJECT *device, BYTE *buffer, DWORD length, DWORD *out_length)
 150 {
 151     struct platform_private *private = impl_from_DEVICE_OBJECT(device);
 152     CFDataRef data = IOHIDDeviceGetProperty(private->device, CFSTR(kIOHIDReportDescriptorKey));
 153     int data_length = CFDataGetLength(data);
 154     const UInt8 *ptr;
 155
 156     *out_length = data_length;
 157     if (length < data_length)
 158         return STATUS_BUFFER_TOO_SMALL;
 159
 160     ptr = CFDataGetBytePtr(data);
 161     memcpy(buffer, ptr, data_length);
 162     return STATUS_SUCCESS;
 163 }
 164
 165 static NTSTATUS get_string(DEVICE_OBJECT *device, DWORD index, WCHAR *buffer, DWORD length)
 166 {
 167     struct platform_private *private = impl_from_DEVICE_OBJECT(device);
 168     CFStringRef str;
 169     switch (index)
 170     {
 171         case HID_STRING_ID_IPRODUCT:
 172             str = IOHIDDeviceGetProperty(private->device, CFSTR(kIOHIDProductKey));
 173             break;
 174         case HID_STRING_ID_IMANUFACTURER:
 175             str = IOHIDDeviceGetProperty(private->device, CFSTR(kIOHIDManufacturerKey));
 176             break;
 177         case HID_STRING_ID_ISERIALNUMBER:
 178             str = IOHIDDeviceGetProperty(private->device, CFSTR(kIOHIDSerialNumberKey));
 179             break;
 180         default:
 181             ERR("Unknown string index\n");
 182             return STATUS_NOT_IMPLEMENTED;
 183     }
 184
 185     if (str)
 186     {
 187         if (length < CFStringGetLength(str) + 1)
 188             return STATUS_BUFFER_TOO_SMALL;
 189         CFStringToWSTR(str, buffer, length);
 190     }
 191     else
 192     {
 193         if (!length) return STATUS_BUFFER_TOO_SMALL;
 194         buffer[0] = 0;
 195     }
 196
 197     return STATUS_SUCCESS;
 198 }
 199
 200 static NTSTATUS begin_report_processing(DEVICE_OBJECT *device)
 201 {
 202     DWORD length;
 203     struct platform_private *private = impl_from_DEVICE_OBJECT(device);
 204     CFNumberRef num;
 205
 206     if (private->buffer)
 207         return STATUS_SUCCESS;
 208
 209     num = IOHIDDeviceGetProperty(private->device, CFSTR(kIOHIDMaxInputReportSizeKey));
 210     length = CFNumberToDWORD(num);
 211     private->buffer = HeapAlloc(GetProcessHeap(), 0, length);
 212
 213     IOHIDDeviceRegisterInputReportCallback(private->device, private->buffer, length, handle_IOHIDDeviceIOHIDReportCallback, device);
 214     return STATUS_SUCCESS;
 215 }
 216
 217 static NTSTATUS set_output_report(DEVICE_OBJECT *device, UCHAR id, BYTE *report, DWORD length, ULONG_PTR *written)
 218 {
 219     IOReturn result;
 220     struct platform_private *private = impl_from_DEVICE_OBJECT(device);
 221     result = IOHIDDeviceSetReport(private->device, kIOHIDReportTypeOutput, id, report, length);
 222     if (result == kIOReturnSuccess)
 223     {
 224         *written = length;
 225         return STATUS_SUCCESS;
 226     }
 227     else
 228     {
 229         *written = 0;
 230         return STATUS_UNSUCCESSFUL;
 231     }
 232 }
 233
 234 static NTSTATUS get_feature_report(DEVICE_OBJECT *device, UCHAR id, BYTE *report, DWORD length, ULONG_PTR *read)
 235 {
 236     IOReturn ret;
 237     CFIndex report_length = length;
 238     struct platform_private *private = impl_from_DEVICE_OBJECT(device);
 239
 240     ret = IOHIDDeviceGetReport(private->device, kIOHIDReportTypeFeature, id, report, &report_length);
 241     if (ret == kIOReturnSuccess)
 242     {
 243         *read = report_length;
 244         return STATUS_SUCCESS;
 245     }
 246     else
 247     {
 248         *read = 0;
 249         return STATUS_UNSUCCESSFUL;
 250     }
 251 }
 252
 253 static NTSTATUS set_feature_report(DEVICE_OBJECT *device, UCHAR id, BYTE *report, DWORD length, ULONG_PTR *written)
 254 {
 255     IOReturn result;
 256     struct platform_private *private = impl_from_DEVICE_OBJECT(device);
 257
 258     result = IOHIDDeviceSetReport(private->device, kIOHIDReportTypeFeature, id, report, length);
 259     if (result == kIOReturnSuccess)
 260     {
 261         *written = length;
 262         return STATUS_SUCCESS;
 263     }
 264     else
 265     {
 266         *written = 0;
 267         return STATUS_UNSUCCESSFUL;
 268     }
 269 }
 270
 271 static const platform_vtbl iohid_vtbl =
 272 {
 273     compare_platform_device,
 274     get_reportdescriptor,
 275     get_string,
 276     begin_report_processing,
 277     set_output_report,
 278     get_feature_report,
 279     set_feature_report,
 280 };
 281
 282 static void handle_DeviceMatchingCallback(void *context, IOReturn result, void *sender, IOHIDDeviceRef IOHIDDevice)
 283 {
 284     DEVICE_OBJECT *device;
 285     DWORD vid, pid, version, uid;
 286     CFStringRef str = NULL;
 287     WCHAR serial_string[256];
 288     BOOL is_gamepad = FALSE;
 289     WORD input = -1;
 290
 291     TRACE("OS/X IOHID Device Added %p\n", IOHIDDevice);
 292
 293     vid = CFNumberToDWORD(IOHIDDeviceGetProperty(IOHIDDevice, CFSTR(kIOHIDVendorIDKey)));
 294     pid = CFNumberToDWORD(IOHIDDeviceGetProperty(IOHIDDevice, CFSTR(kIOHIDProductIDKey)));
 295     version = CFNumberToDWORD(IOHIDDeviceGetProperty(IOHIDDevice, CFSTR(kIOHIDVersionNumberKey)));
 296     str = IOHIDDeviceGetProperty(IOHIDDevice, CFSTR(kIOHIDSerialNumberKey));
 297     if (str) CFStringToWSTR(str, serial_string, ARRAY_SIZE(serial_string));
 298     uid = CFNumberToDWORD(IOHIDDeviceGetProperty(IOHIDDevice, CFSTR(kIOHIDLocationIDKey)));
 299
 300     if (IOHIDDeviceOpen(IOHIDDevice, 0) != kIOReturnSuccess)
 301     {
 302         ERR("Failed to open HID device %p (vid %04x, pid %04x)\n", IOHIDDevice, vid, pid);
 303         return;
 304     }
 305     IOHIDDeviceScheduleWithRunLoop(IOHIDDevice, CFRunLoopGetCurrent(), kCFRunLoopDefaultMode);
 306
 307     if (IOHIDDeviceConformsTo(IOHIDDevice, kHIDPage_GenericDesktop, kHIDUsage_GD_GamePad) ||
 308        IOHIDDeviceConformsTo(IOHIDDevice, kHIDPage_GenericDesktop, kHIDUsage_GD_Joystick))
 309     {
 310         if (is_xbox_gamepad(vid, pid))
 311             is_gamepad = TRUE;
 312         else
 313         {
 314             int axes=0, buttons=0;
 315             CFArrayRef element_array = IOHIDDeviceCopyMatchingElements(
 316                 IOHIDDevice, NULL, kIOHIDOptionsTypeNone);
 317
 318             if (element_array) {
 319                 CFIndex index;
 320                 CFIndex count = CFArrayGetCount(element_array);
 321                 for (index = 0; index < count; index++)
 322                 {
 323                     IOHIDElementRef element = (IOHIDElementRef)CFArrayGetValueAtIndex(element_array, index);
 324                     if (element)
 325                     {
 326                         int type = IOHIDElementGetType(element);
 327                         if (type == kIOHIDElementTypeInput_Button) buttons++;
 328                         if (type == kIOHIDElementTypeInput_Axis) axes++;
 329                         if (type == kIOHIDElementTypeInput_Misc)
 330                         {
 331                             uint32_t usage = IOHIDElementGetUsage(element);
 332                             switch (usage)
 333                             {
 334                                 case kHIDUsage_GD_X:
 335                                 case kHIDUsage_GD_Y:
 336                                 case kHIDUsage_GD_Z:
 337                                 case kHIDUsage_GD_Rx:
 338                                 case kHIDUsage_GD_Ry:
 339                                 case kHIDUsage_GD_Rz:
 340                                 case kHIDUsage_GD_Slider:
 341                                     axes ++;
 342                             }
 343                         }
 344                     }
 345                 }
 346                 CFRelease(element_array);
 347             }
 348             is_gamepad = (axes == 6  && buttons >= 14);
 349         }
 350     }
 351     if (is_gamepad)
 352         input = 0;
 353
 354     device = bus_create_hid_device(busidW, vid, pid, input,
 355             version, uid, str ? serial_string : NULL, is_gamepad,
 356             &iohid_vtbl, sizeof(struct platform_private));
 357     if (!device)
 358         ERR("Failed to create device\n");
 359     else
 360     {
 361         struct platform_private *private = impl_from_DEVICE_OBJECT(device);
 362         private->device = IOHIDDevice;
 363         private->buffer = NULL;
 364         IoInvalidateDeviceRelations(bus_pdo, BusRelations);
 365     }
 366 }
 367
 368 static void handle_RemovalCallback(void *context, IOReturn result, void *sender, IOHIDDeviceRef IOHIDDevice)
 369 {
 370     DEVICE_OBJECT *device;
 371     TRACE("OS/X IOHID Device Removed %p\n", IOHIDDevice);
 372     IOHIDDeviceRegisterInputReportCallback(IOHIDDevice, NULL, 0, NULL, NULL);
 373     /* Note: Yes, we leak the buffer. But according to research there is no
 374              safe way to deallocate that buffer. */
 375     IOHIDDeviceUnscheduleFromRunLoop(IOHIDDevice, CFRunLoopGetCurrent(), kCFRunLoopDefaultMode);
 376     IOHIDDeviceClose(IOHIDDevice, 0);
 377     device = bus_find_hid_device(&iohid_vtbl, IOHIDDevice);
 378     if (device)
 379     {
 380         bus_unlink_hid_device(device);
 381         IoInvalidateDeviceRelations(bus_pdo, BusRelations);
 382         bus_remove_hid_device(device);
 383     }
 384 }
 385
 386 /* This puts the relevant run loop for event handling into a WINE thread */
 387 static DWORD CALLBACK runloop_thread(void *args)
 388 {
 389     run_loop = CFRunLoopGetCurrent();
 390
 391     IOHIDManagerSetDeviceMatching(hid_manager, NULL);
 392     IOHIDManagerRegisterDeviceMatchingCallback(hid_manager, handle_DeviceMatchingCallback, NULL);
 393     IOHIDManagerRegisterDeviceRemovalCallback(hid_manager, handle_RemovalCallback, NULL);
 394     IOHIDManagerScheduleWithRunLoop(hid_manager, run_loop, kCFRunLoopDefaultMode);
 395
 396     CFRunLoopRun();
 397     TRACE("Run Loop exiting\n");
 398     return 1;
 399
 400 }
 401
 402 NTSTATUS iohid_driver_init(void)
 403 {
 404     hid_manager = IOHIDManagerCreate(kCFAllocatorDefault, 0L);
 405     if (!(run_loop_handle = CreateThread(NULL, 0, runloop_thread, NULL, 0, NULL)))
 406     {
 407         ERR("Failed to initialize IOHID Manager thread\n");
 408         CFRelease(hid_manager);
 409         return STATUS_UNSUCCESSFUL;
 410     }
 411
 412     TRACE("Initialization successful\n");
 413     return STATUS_SUCCESS;
 414 }
 415
 416 void iohid_driver_unload( void )
 417 {
 418     TRACE("Unloading Driver\n");
 419
 420     if (!run_loop_handle)
 421         return;
 422
 423     IOHIDManagerUnscheduleFromRunLoop(hid_manager, run_loop, kCFRunLoopDefaultMode);
 424     CFRunLoopStop(run_loop);
 425     WaitForSingleObject(run_loop_handle, INFINITE);
 426     CloseHandle(run_loop_handle);
 427     IOHIDManagerRegisterDeviceMatchingCallback(hid_manager, NULL, NULL);
 428     IOHIDManagerRegisterDeviceRemovalCallback(hid_manager, NULL, NULL);
 429     CFRelease(hid_manager);
 430     TRACE("Driver Unloaded\n");
 431 }
 432
 433 #else
 434
 435 NTSTATUS iohid_driver_init(void)
 436 {
 437     return STATUS_NOT_IMPLEMENTED;
 438 }
 439
 440 void iohid_driver_unload( void )
 441 {
 442     TRACE("Stub: Unload Driver\n");
 443 }
 444
 445 #endif /* HAVE_IOHIDMANAGERCREATE */