New subject: [PATCH v3 1/7] winebus.sys: Add OS/X IOHID bus

7 Nov 2016

On 04.11.2016 13:45, Aric Stewart wrote:
...
v2: remove Unload code as it will never be triggered
v3: Suggestions from Ken Thomases
    Merge Implement adding IOHID devices into this patch
Signed-off-by: Aric Stewart <aric(a)codeweavers.com>
---
 dlls/winebus.sys/Makefile.in |   3 +-
 dlls/winebus.sys/bus.h       |   1 +
 dlls/winebus.sys/bus_iohid.c | 255 +++++++++++++++++++++++++++++++++++++++++++
 dlls/winebus.sys/main.c      |   3 +
 4 files changed, 261 insertions(+), 1 deletion(-)
 create mode 100644 dlls/winebus.sys/bus_iohid.c
v2-0001-winebus.sys-Add-OS-X-IOHID-bus.txt

diff --git a/dlls/winebus.sys/Makefile.in b/dlls/winebus.sys/Makefile.in
index 9d3a0c2..ac02533 100644
--- a/dlls/winebus.sys/Makefile.in
+++ b/dlls/winebus.sys/Makefile.in
@@ -1,9 +1,10 @@
 MODULE    = winebus.sys
 IMPORTS   = ntoskrnl setupapi
-EXTRALIBS = $(UDEV_LIBS)
+EXTRALIBS = $(IOKIT_LIBS) $(UDEV_LIBS)
 EXTRAINCL = $(UDEV_CFLAGS)
 EXTRADLLFLAGS = -Wb,--subsystem,native
C_SRCS = \
+	bus_iohid.c \
  bus_udev.c \
  main.c
diff --git a/dlls/winebus.sys/bus.h b/dlls/winebus.sys/bus.h
index 45a65e2..effbd4a 100644
--- a/dlls/winebus.sys/bus.h
+++ b/dlls/winebus.sys/bus.h
@@ -18,6 +18,7 @@
/* Busses */
 NTSTATUS WINAPI udev_driver_init(DRIVER_OBJECT *driver, UNICODE_STRING *registry_path) DECLSPEC_HIDDEN;
+NTSTATUS WINAPI iohid_driver_init(DRIVER_OBJECT *driver, UNICODE_STRING *registry_path) DECLSPEC_HIDDEN;
/* Native device function table */
 typedef struct
diff --git a/dlls/winebus.sys/bus_iohid.c b/dlls/winebus.sys/bus_iohid.c
new file mode 100644
index 0000000..e47ed13
--- /dev/null
+++ b/dlls/winebus.sys/bus_iohid.c
@@ -0,0 +1,255 @@
+/*  Bus like function for mac HID devices
+ *
+ * Copyright 2016 CodeWeavers, Aric Stewart
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+#include "config.h"
+#include "wine/port.h"
+
+#include <stdarg.h>
+
+#if defined(HAVE_IOKIT_HID_IOHIDLIB_H)
+#define DWORD UInt32
+#define LPDWORD UInt32*
+#define LONG SInt32
+#define LPLONG SInt32*
+#define E_PENDING __carbon_E_PENDING
+#define ULONG __carbon_ULONG
+#define E_INVALIDARG __carbon_E_INVALIDARG
+#define E_OUTOFMEMORY __carbon_E_OUTOFMEMORY
+#define E_HANDLE __carbon_E_HANDLE
+#define E_ACCESSDENIED __carbon_E_ACCESSDENIED
+#define E_UNEXPECTED __carbon_E_UNEXPECTED
+#define E_FAIL __carbon_E_FAIL
+#define E_ABORT __carbon_E_ABORT
+#define E_POINTER __carbon_E_POINTER
+#define E_NOINTERFACE __carbon_E_NOINTERFACE
+#define E_NOTIMPL __carbon_E_NOTIMPL
+#define S_FALSE __carbon_S_FALSE
+#define S_OK __carbon_S_OK
+#define HRESULT_FACILITY __carbon_HRESULT_FACILITY
+#define IS_ERROR __carbon_IS_ERROR
+#define FAILED __carbon_FAILED
+#define SUCCEEDED __carbon_SUCCEEDED
+#define MAKE_HRESULT __carbon_MAKE_HRESULT
+#define HRESULT __carbon_HRESULT
+#define STDMETHODCALLTYPE __carbon_STDMETHODCALLTYPE
+#define PAGE_SHIFT __carbon_PAGE_SHIFT
+#include <IOKit/IOKitLib.h>
+#include <IOKit/hid/IOHIDLib.h>
+#undef ULONG
+#undef E_INVALIDARG
+#undef E_OUTOFMEMORY
+#undef E_HANDLE
+#undef E_ACCESSDENIED
+#undef E_UNEXPECTED
+#undef E_FAIL
+#undef E_ABORT
+#undef E_POINTER
+#undef E_NOINTERFACE
+#undef E_NOTIMPL
+#undef S_FALSE
+#undef S_OK
+#undef HRESULT_FACILITY
+#undef IS_ERROR
+#undef FAILED
+#undef SUCCEEDED
+#undef MAKE_HRESULT
+#undef HRESULT
+#undef STDMETHODCALLTYPE
+#undef DWORD
+#undef LPDWORD
+#undef LONG
+#undef LPLONG
+#undef E_PENDING
+#undef PAGE_SHIFT
+#endif /* HAVE_IOKIT_HID_IOHIDLIB_H */
+
+#define NONAMELESSUNION
+
+#include "ntstatus.h"
+#define WIN32_NO_STATUS
+#include "windef.h"
+#include "winbase.h"
+#include "winternl.h"
+#include "winioctl.h"
+#include "ddk/wdm.h"
+#include "wine/debug.h"
+
+#include "bus.h"
+
+WINE_DEFAULT_DEBUG_CHANNEL(plugplay);
+#ifdef HAVE_IOHIDMANAGERCREATE
+
+static DRIVER_OBJECT *iohid_driver_obj = NULL;
+static IOHIDManagerRef hid_manager;
+
+static const WCHAR busidW[] = {'I','O','H','I','D',0};
+
+#include "initguid.h"
+DEFINE_GUID(GUID_DEVCLASS_IOHID, 0x989D309D,0x0470,0x4E1A,0x89,0x38,0x50,0x1F,0x42,0xBD,0x9A,0xCD);
+
+static void CFStringToWSTR(CFStringRef cstr, LPWSTR wstr, int length)
+{
+    int len = min(CFStringGetLength(cstr), length-1);
+    CFStringGetCharacters(cstr, CFRangeMake(0, len), wstr);
Are you sure it doesn't cause a compiler warning? Winemac code always uses casts from WCHAR* to UniChar*.
...
+    wstr[len] = 0;
+}
+
+static DWORD CFNumberToDWORD(CFNumberRef num)
+{
+    int dwNum = 0;
+    if (num)
+        CFNumberGetValue(num, kCFNumberIntType, &dwNum);
+    return dwNum;
+}
+
+static int compare_platform_device(DEVICE_OBJECT *device, void *platform_dev)
+{
+    return 0;
+}
+
+static NTSTATUS get_reportdescriptor(DEVICE_OBJECT *device, BYTE *buffer, DWORD length, DWORD *out_length)
+{
+    return STATUS_NOT_IMPLEMENTED;
+}
+
+static NTSTATUS get_string(DEVICE_OBJECT *device, DWORD index, WCHAR *buffer, DWORD length)
+{
+    return STATUS_NOT_IMPLEMENTED;
+}
+
+static NTSTATUS begin_report_processing(DEVICE_OBJECT *device)
+{
+    return STATUS_NOT_IMPLEMENTED;
+}
+
+static NTSTATUS set_output_report(DEVICE_OBJECT *device, UCHAR id, BYTE *report, DWORD length, ULONG_PTR *written)
+{
+    *written = 0;
+    return STATUS_NOT_IMPLEMENTED;
+}
+
+static NTSTATUS get_feature_report(DEVICE_OBJECT *device, UCHAR id, BYTE *report, DWORD length, ULONG_PTR *read)
+{
+    *read = 0;
+    return STATUS_NOT_IMPLEMENTED;
+}
+
+static NTSTATUS set_feature_report(DEVICE_OBJECT *device, UCHAR id, BYTE *report, DWORD length, ULONG_PTR *written)
+{
+    *written = 0;
+    return STATUS_NOT_IMPLEMENTED;
+}
+
+static const platform_vtbl iohid_vtbl = {
Usually "{" is on the next line.
...
+    compare_platform_device,
+    get_reportdescriptor,
+    get_string,
+    begin_report_processing,
+    set_output_report,
+    get_feature_report,
+    set_feature_report,
+};
+
+static void handle_DeviceMatchingCallback(void *inContext, IOReturn inResult, void *inSender, IOHIDDeviceRef  inIOHIDDeviceRef)
Those parameter names sound a bit unusual. Why is there always an "in" prefix in front?
And why are there two spaces in front of "inIOHIDDeviceRef"?
...
+{
+    DEVICE_OBJECT *device;
+    DWORD vid, pid, version;
+    CFStringRef str = NULL;
+    WCHAR serial_string[256];
+    BOOL is_gamepad;
+
+    TRACE("OS/X IOHID Device Added %p\n", inIOHIDDeviceRef);
+
+    vid = CFNumberToDWORD(IOHIDDeviceGetProperty(inIOHIDDeviceRef, CFSTR(kIOHIDVendorIDKey)));
+    pid = CFNumberToDWORD(IOHIDDeviceGetProperty(inIOHIDDeviceRef, CFSTR(kIOHIDProductIDKey)));
+    version = CFNumberToDWORD(IOHIDDeviceGetProperty(inIOHIDDeviceRef, CFSTR(kIOHIDVersionNumberKey)));
+    str = IOHIDDeviceGetProperty(inIOHIDDeviceRef, CFSTR(kIOHIDSerialNumberKey));
+    if (str) CFStringToWSTR(str, serial_string, sizeof(serial_string) / sizeof(WCHAR));
+
+    is_gamepad = (IOHIDDeviceConformsTo(inIOHIDDeviceRef, kHIDPage_GenericDesktop, kHIDUsage_GD_GamePad) ||
+       IOHIDDeviceConformsTo(inIOHIDDeviceRef, kHIDPage_GenericDesktop, kHIDUsage_GD_Joystick));
+
+    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(inIOHIDDeviceRef));
+    if (!device)
+        ERR("Failed to create device\n");
+    else
+    {
+        IOHIDDeviceRef* ext = get_platform_private(device);
+        *ext = inIOHIDDeviceRef;
I think it would be better to use a struct, even if you only want to store
one value at the moment. Also, please use a helper function to avoid casts
in the rest of the driver code, similar to how it is done for udev.
...
+        IoInvalidateDeviceRelations(device, BusRelations);
+    }
+}
+
+/* This puts the relevant run loop for event handling into a WINE thread */
+static DWORD CALLBACK runloop_thread(VOID *args)
Usually you should always use lowercase "void" in Wine code.
...
+{
+    DRIVER_OBJECT *driver = (DRIVER_OBJECT*)args;
+    CFRunLoopRef run_loop = CFRunLoopGetCurrent();
+
+    IOHIDManagerSetDeviceMatching(hid_manager, NULL);
+    IOHIDManagerRegisterDeviceMatchingCallback(hid_manager, handle_DeviceMatchingCallback, driver);
There is no need to pass "driver" as context when you don't use it in the callback.
...
+    IOHIDManagerScheduleWithRunLoop(hid_manager, run_loop, kCFRunLoopDefaultMode);
+    if (IOHIDManagerOpen( hid_manager, 0 ) != kIOReturnSuccess)
+    {
+        ERR("Couldn't open IOHIDManager.\n");
+        IOHIDManagerUnscheduleFromRunLoop(hid_manager, run_loop, kCFRunLoopDefaultMode);
+        CFRelease(hid_manager);
+        return 0;
+    }
+
+    CFRunLoopRun();
+    TRACE("Run Loop exiting\n");
+
+    IOHIDManagerRegisterDeviceMatchingCallback(hid_manager, NULL, NULL);
+    IOHIDManagerUnscheduleFromRunLoop(hid_manager, run_loop, kCFRunLoopDefaultMode);
Can you be sure that run_loop is still valid here?
...
+    CFRelease(hid_manager);
+    return 1;
+}
+
+NTSTATUS WINAPI iohid_driver_init(DRIVER_OBJECT *driver, UNICODE_STRING *registry_path)
+{
+    HANDLE run_loop_handle;
+
+    TRACE("(%p, %s)\n", driver, debugstr_w(registry_path->Buffer));
+
+    iohid_driver_obj = driver;
+    driver->MajorFunction[IRP_MJ_PNP] = common_pnp_dispatch;
+    driver->MajorFunction[IRP_MJ_INTERNAL_DEVICE_CONTROL] = hid_internal_dispatch;
+    hid_manager = IOHIDManagerCreate(kCFAllocatorDefault, 0L);
+    if (!(run_loop_handle = CreateThread(NULL, 0, runloop_thread, driver, 0, NULL)))
+    {
+        ERR("Failed to initialize IOHID Manager thread\n");
+        iohid_driver_obj = NULL;
+        CFRelease(hid_manager);
+        return STATUS_UNSUCCESSFUL;
+    }
+
+    CloseHandle(run_loop_handle);
+    return STATUS_SUCCESS;
+}
+
+#else
+
+NTSTATUS WINAPI iohid_driver_init(DRIVER_OBJECT *driver, UNICODE_STRING *registry_path)
+{
+    WARN("IOHID Support not compiled into Wine.\n");
+    return STATUS_NOT_IMPLEMENTED;
+}
+
+#endif /* HAVE_IOHIDMANAGERCREATE */
diff --git a/dlls/winebus.sys/main.c b/dlls/winebus.sys/main.c
index 791ccbb..ed95435 100644
--- a/dlls/winebus.sys/main.c
+++ b/dlls/winebus.sys/main.c
@@ -628,10 +628,13 @@ NTSTATUS WINAPI DriverEntry( DRIVER_OBJECT *driver, UNICODE_STRING *path )
 {
     static const WCHAR udevW[] = {'\\','D','r','i','v','e','r','\\','U','D','E','V',0};
     static UNICODE_STRING udev = {sizeof(udevW) - sizeof(WCHAR), sizeof(udevW), (WCHAR *)udevW};
+    static const WCHAR iohidW[] = {'\\','D','r','i','v','e','r','\\','I','O','H','I','D',0};
+    static UNICODE_STRING iohid = {sizeof(iohidW) - sizeof(WCHAR), sizeof(iohidW), (WCHAR *)iohidW};
TRACE( "(%p, %s)\n", driver, debugstr_w(path->Buffer) );
IoCreateDriver(&udev, udev_driver_init);
+    IoCreateDriver(&iohid, iohid_driver_init);
return STATUS_SUCCESS;
 }


    

Re: [PATCH v3 1/7] winebus.sys: Add OS/X IOHID bus

Sebastian Lackner

Ken Thomases

tags

participants (2)