/* MIT License Copyright (c) 2017 Benjamin "Nefarius" Höglinger Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #define WIN32_LEAN_AND_MEAN #include #include #include #include #include "ViGEm/km/BusShared.h" #include "ViGEm/Client.h" #include // // STL // #include #include #include #include // // Boost // #include #include #include #include #include #include "Internal.h" #include "NotificationRequestPool.h" typedef BOOL(WINAPI *MINIDUMPWRITEDUMP)( HANDLE hProcess, DWORD dwPid, HANDLE hFile, MINIDUMP_TYPE DumpType, CONST PMINIDUMP_EXCEPTION_INFORMATION ExceptionParam, CONST PMINIDUMP_USER_STREAM_INFORMATION UserStreamParam, CONST PMINIDUMP_CALLBACK_INFORMATION CallbackParam ); LONG WINAPI vigem_internal_exception_handler(struct _EXCEPTION_POINTERS* apExceptionInfo); // // Initializes a virtual gamepad object. // PVIGEM_TARGET FORCEINLINE VIGEM_TARGET_ALLOC_INIT( _In_ VIGEM_TARGET_TYPE Type ) { auto target = static_cast(malloc(sizeof(VIGEM_TARGET))); if (!target) return nullptr; memset(target, 0, sizeof(VIGEM_TARGET)); target->Size = sizeof(VIGEM_TARGET); target->State = VIGEM_TARGET_INITIALIZED; target->Type = Type; return target; } LONG WINAPI vigem_internal_exception_handler(struct _EXCEPTION_POINTERS* apExceptionInfo) { const auto mhLib = LoadLibrary(L"dbghelp.dll"); const auto pDump = reinterpret_cast(GetProcAddress(mhLib, "MiniDumpWriteDump")); const auto hFile = CreateFile( L"ViGEmClient.dmp", GENERIC_WRITE, FILE_SHARE_WRITE, nullptr, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, nullptr ); if (hFile != INVALID_HANDLE_VALUE) { _MINIDUMP_EXCEPTION_INFORMATION ExInfo; ExInfo.ThreadId = GetCurrentThreadId(); ExInfo.ExceptionPointers = apExceptionInfo; ExInfo.ClientPointers = FALSE; pDump(GetCurrentProcess(), GetCurrentProcessId(), hFile, MiniDumpNormal, &ExInfo, nullptr, nullptr); CloseHandle(hFile); } return EXCEPTION_CONTINUE_SEARCH; } PVIGEM_CLIENT vigem_alloc() { SetUnhandledExceptionFilter(vigem_internal_exception_handler); const auto driver = static_cast(malloc(sizeof(VIGEM_CLIENT))); if (!driver) return nullptr; RtlZeroMemory(driver, sizeof(VIGEM_CLIENT)); driver->hBusDevice = INVALID_HANDLE_VALUE; return driver; } void vigem_free(PVIGEM_CLIENT vigem) { if (vigem) free(vigem); } VIGEM_ERROR vigem_connect(PVIGEM_CLIENT vigem) { if (!vigem) return VIGEM_ERROR_BUS_INVALID_HANDLE; SP_DEVICE_INTERFACE_DATA deviceInterfaceData = { 0 }; deviceInterfaceData.cbSize = sizeof(deviceInterfaceData); DWORD memberIndex = 0; DWORD requiredSize = 0; auto error = VIGEM_ERROR_BUS_NOT_FOUND; // check for already open handle as re-opening accidentally would destroy all live targets if (vigem->hBusDevice != INVALID_HANDLE_VALUE) { return VIGEM_ERROR_BUS_ALREADY_CONNECTED; } const auto deviceInfoSet = SetupDiGetClassDevs( &GUID_DEVINTERFACE_BUSENUM_VIGEM, nullptr, nullptr, DIGCF_PRESENT | DIGCF_DEVICEINTERFACE ); // enumerate device instances while (SetupDiEnumDeviceInterfaces( deviceInfoSet, nullptr, &GUID_DEVINTERFACE_BUSENUM_VIGEM, memberIndex++, &deviceInterfaceData )) { // get required target buffer size SetupDiGetDeviceInterfaceDetail(deviceInfoSet, &deviceInterfaceData, nullptr, 0, &requiredSize, nullptr); // allocate target buffer const auto detailDataBuffer = static_cast(malloc(requiredSize)); detailDataBuffer->cbSize = sizeof(SP_DEVICE_INTERFACE_DETAIL_DATA); // get detail buffer if (!SetupDiGetDeviceInterfaceDetail( deviceInfoSet, &deviceInterfaceData, detailDataBuffer, requiredSize, &requiredSize, nullptr )) { SetupDiDestroyDeviceInfoList(deviceInfoSet); free(detailDataBuffer); error = VIGEM_ERROR_BUS_NOT_FOUND; continue; } // bus found, open it vigem->hBusDevice = CreateFile( detailDataBuffer->DevicePath, GENERIC_READ | GENERIC_WRITE, FILE_SHARE_READ | FILE_SHARE_WRITE, nullptr, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL | FILE_FLAG_NO_BUFFERING | FILE_FLAG_WRITE_THROUGH | FILE_FLAG_OVERLAPPED, nullptr ); // check bus open result if (vigem->hBusDevice == INVALID_HANDLE_VALUE) { error = VIGEM_ERROR_BUS_ACCESS_FAILED; free(detailDataBuffer); continue; } DWORD transferred = 0; OVERLAPPED lOverlapped = { 0 }; lOverlapped.hEvent = CreateEvent(nullptr, FALSE, FALSE, nullptr); VIGEM_CHECK_VERSION version; VIGEM_CHECK_VERSION_INIT(&version, VIGEM_COMMON_VERSION); // send compiled library version to driver to check compatibility DeviceIoControl( vigem->hBusDevice, IOCTL_VIGEM_CHECK_VERSION, &version, version.Size, nullptr, 0, &transferred, &lOverlapped ); // wait for result if (GetOverlappedResult(vigem->hBusDevice, &lOverlapped, &transferred, TRUE) != 0) { error = VIGEM_ERROR_NONE; free(detailDataBuffer); CloseHandle(lOverlapped.hEvent); break; } error = VIGEM_ERROR_BUS_VERSION_MISMATCH; CloseHandle(lOverlapped.hEvent); free(detailDataBuffer); } SetupDiDestroyDeviceInfoList(deviceInfoSet); return error; } void vigem_disconnect(PVIGEM_CLIENT vigem) { if (!vigem) return; if (vigem->hBusDevice != INVALID_HANDLE_VALUE) { CloseHandle(vigem->hBusDevice); RtlZeroMemory(vigem, sizeof(VIGEM_CLIENT)); vigem->hBusDevice = INVALID_HANDLE_VALUE; } } PVIGEM_TARGET vigem_target_x360_alloc(void) { const auto target = VIGEM_TARGET_ALLOC_INIT(Xbox360Wired); if (!target) return nullptr; target->VendorId = 0x045E; target->ProductId = 0x028E; return target; } PVIGEM_TARGET vigem_target_ds4_alloc(void) { const auto target = VIGEM_TARGET_ALLOC_INIT(DualShock4Wired); if (!target) return nullptr; target->VendorId = 0x054C; target->ProductId = 0x05C4; return target; } void vigem_target_free(PVIGEM_TARGET target) { if (target) free(target); } VIGEM_ERROR vigem_target_add(PVIGEM_CLIENT vigem, PVIGEM_TARGET target) { if (!vigem) return VIGEM_ERROR_BUS_INVALID_HANDLE; if (!target) return VIGEM_ERROR_INVALID_TARGET; if (vigem->hBusDevice == INVALID_HANDLE_VALUE) return VIGEM_ERROR_BUS_NOT_FOUND; if (target->State == VIGEM_TARGET_NEW) return VIGEM_ERROR_TARGET_UNINITIALIZED; if (target->State == VIGEM_TARGET_CONNECTED) return VIGEM_ERROR_ALREADY_CONNECTED; DWORD transferred = 0; VIGEM_PLUGIN_TARGET plugin; OVERLAPPED lOverlapped = { 0 }; lOverlapped.hEvent = CreateEvent(nullptr, FALSE, FALSE, nullptr); for (target->SerialNo = 1; target->SerialNo <= VIGEM_TARGETS_MAX; target->SerialNo++) { VIGEM_PLUGIN_TARGET_INIT(&plugin, target->SerialNo, target->Type); plugin.VendorId = target->VendorId; plugin.ProductId = target->ProductId; DeviceIoControl( vigem->hBusDevice, IOCTL_VIGEM_PLUGIN_TARGET, &plugin, plugin.Size, nullptr, 0, &transferred, &lOverlapped ); if (GetOverlappedResult(vigem->hBusDevice, &lOverlapped, &transferred, TRUE) != 0) { target->State = VIGEM_TARGET_CONNECTED; CloseHandle(lOverlapped.hEvent); return VIGEM_ERROR_NONE; } } CloseHandle(lOverlapped.hEvent); return VIGEM_ERROR_NO_FREE_SLOT; } VIGEM_ERROR vigem_target_add_async(PVIGEM_CLIENT vigem, PVIGEM_TARGET target, PFN_VIGEM_TARGET_ADD_RESULT result) { if (!vigem) return VIGEM_ERROR_BUS_INVALID_HANDLE; if (!target) return VIGEM_ERROR_INVALID_TARGET; if (vigem->hBusDevice == INVALID_HANDLE_VALUE) return VIGEM_ERROR_BUS_NOT_FOUND; if (target->State == VIGEM_TARGET_NEW) return VIGEM_ERROR_TARGET_UNINITIALIZED; if (target->State == VIGEM_TARGET_CONNECTED) return VIGEM_ERROR_ALREADY_CONNECTED; std::thread _async{ []( PVIGEM_TARGET _Target, PVIGEM_CLIENT _Client, PFN_VIGEM_TARGET_ADD_RESULT _Result) { DWORD transferred = 0; VIGEM_PLUGIN_TARGET plugin; OVERLAPPED lOverlapped = { 0 }; lOverlapped.hEvent = CreateEvent(nullptr, FALSE, FALSE, nullptr); for (_Target->SerialNo = 1; _Target->SerialNo <= VIGEM_TARGETS_MAX; _Target->SerialNo++) { VIGEM_PLUGIN_TARGET_INIT(&plugin, _Target->SerialNo, _Target->Type); plugin.VendorId = _Target->VendorId; plugin.ProductId = _Target->ProductId; DeviceIoControl( _Client->hBusDevice, IOCTL_VIGEM_PLUGIN_TARGET, &plugin, plugin.Size, nullptr, 0, &transferred, &lOverlapped ); if (GetOverlappedResult(_Client->hBusDevice, &lOverlapped, &transferred, TRUE) != 0) { _Target->State = VIGEM_TARGET_CONNECTED; CloseHandle(lOverlapped.hEvent); if (_Result) _Result(_Client, _Target, VIGEM_ERROR_NONE); return; } } CloseHandle(lOverlapped.hEvent); if (_Result) _Result(_Client, _Target, VIGEM_ERROR_NO_FREE_SLOT); }, target, vigem, result }; _async.detach(); return VIGEM_ERROR_NONE; } VIGEM_ERROR vigem_target_remove(PVIGEM_CLIENT vigem, PVIGEM_TARGET target) { if (!vigem) return VIGEM_ERROR_BUS_INVALID_HANDLE; if (!target) return VIGEM_ERROR_INVALID_TARGET; if (vigem->hBusDevice == INVALID_HANDLE_VALUE) return VIGEM_ERROR_BUS_NOT_FOUND; if (target->State == VIGEM_TARGET_NEW) return VIGEM_ERROR_TARGET_UNINITIALIZED; if (target->State != VIGEM_TARGET_CONNECTED) return VIGEM_ERROR_TARGET_NOT_PLUGGED_IN; DWORD transfered = 0; VIGEM_UNPLUG_TARGET unplug; OVERLAPPED lOverlapped = { 0 }; lOverlapped.hEvent = CreateEvent(nullptr, FALSE, FALSE, nullptr); VIGEM_UNPLUG_TARGET_INIT(&unplug, target->SerialNo); DeviceIoControl( vigem->hBusDevice, IOCTL_VIGEM_UNPLUG_TARGET, &unplug, unplug.Size, nullptr, 0, &transfered, &lOverlapped ); if (GetOverlappedResult(vigem->hBusDevice, &lOverlapped, &transfered, TRUE) != 0) { target->State = VIGEM_TARGET_DISCONNECTED; CloseHandle(lOverlapped.hEvent); return VIGEM_ERROR_NONE; } CloseHandle(lOverlapped.hEvent); return VIGEM_ERROR_REMOVAL_FAILED; } VIGEM_ERROR vigem_target_x360_register_notification( PVIGEM_CLIENT vigem, PVIGEM_TARGET target, PFN_VIGEM_X360_NOTIFICATION notification ) { if (!vigem) return VIGEM_ERROR_BUS_INVALID_HANDLE; if (!target) return VIGEM_ERROR_INVALID_TARGET; if (vigem->hBusDevice == INVALID_HANDLE_VALUE) return VIGEM_ERROR_BUS_NOT_FOUND; if (target->SerialNo == 0 || notification == nullptr) return VIGEM_ERROR_INVALID_TARGET; if (target->Notification == reinterpret_cast(notification)) return VIGEM_ERROR_CALLBACK_ALREADY_REGISTERED; // TODO: tidy up this mess target->Notification = reinterpret_cast(notification); target->pool = std::make_shared( vigem, target, PFN_VIGEM_X360_NOTIFICATION(target->Notification) ); return VIGEM_ERROR_NONE; } VIGEM_ERROR vigem_target_ds4_register_notification( PVIGEM_CLIENT vigem, PVIGEM_TARGET target, PFN_VIGEM_DS4_NOTIFICATION notification ) { if (!vigem) return VIGEM_ERROR_BUS_INVALID_HANDLE; if (!target) return VIGEM_ERROR_INVALID_TARGET; if (vigem->hBusDevice == INVALID_HANDLE_VALUE) return VIGEM_ERROR_BUS_NOT_FOUND; if (target->SerialNo == 0 || notification == nullptr) return VIGEM_ERROR_INVALID_TARGET; if (target->Notification == reinterpret_cast(notification)) return VIGEM_ERROR_CALLBACK_ALREADY_REGISTERED; target->Notification = reinterpret_cast(notification); std::vector threadList; for (int i = 0; i < VIGEM_INVERTED_CALL_THREAD_COUNT; i++) { threadList.emplace_back(std::thread([]( PVIGEM_TARGET _Target, PVIGEM_CLIENT _Client) { DWORD error = ERROR_SUCCESS; DWORD transferred = 0; OVERLAPPED lOverlapped = { 0 }; lOverlapped.hEvent = CreateEvent(nullptr, FALSE, FALSE, nullptr); DS4_REQUEST_NOTIFICATION notify; DS4_REQUEST_NOTIFICATION_INIT(¬ify, _Target->SerialNo); do { DeviceIoControl(_Client->hBusDevice, IOCTL_DS4_REQUEST_NOTIFICATION, ¬ify, notify.Size, ¬ify, notify.Size, &transferred, &lOverlapped); if (GetOverlappedResult(_Client->hBusDevice, &lOverlapped, &transferred, TRUE) != 0) { if (_Target->Notification == NULL) { if (lOverlapped.hEvent) CloseHandle(lOverlapped.hEvent); return; } PFN_VIGEM_DS4_NOTIFICATION(_Target->Notification)( _Client, _Target, notify.Report.LargeMotor, notify.Report.SmallMotor, notify.Report.LightbarColor); } else { error = GetLastError(); } } while (error != ERROR_OPERATION_ABORTED && error != ERROR_ACCESS_DENIED); if (lOverlapped.hEvent) CloseHandle(lOverlapped.hEvent); }, target, vigem)); } std::for_each(threadList.begin(), threadList.end(), std::mem_fn(&std::thread::detach)); return VIGEM_ERROR_NONE; } void vigem_target_x360_unregister_notification(PVIGEM_TARGET target) { target->Notification = NULL; } void vigem_target_ds4_unregister_notification(PVIGEM_TARGET target) { target->Notification = NULL; } void vigem_target_set_vid(PVIGEM_TARGET target, USHORT vid) { target->VendorId = vid; } void vigem_target_set_pid(PVIGEM_TARGET target, USHORT pid) { target->ProductId = pid; } USHORT vigem_target_get_vid(PVIGEM_TARGET target) { return target->VendorId; } USHORT vigem_target_get_pid(PVIGEM_TARGET target) { return target->ProductId; } VIGEM_ERROR vigem_target_x360_update( PVIGEM_CLIENT vigem, PVIGEM_TARGET target, XUSB_REPORT report ) { if (!vigem) return VIGEM_ERROR_BUS_INVALID_HANDLE; if (!target) return VIGEM_ERROR_INVALID_TARGET; if (vigem->hBusDevice == INVALID_HANDLE_VALUE) return VIGEM_ERROR_BUS_NOT_FOUND; if (target->SerialNo == 0) return VIGEM_ERROR_INVALID_TARGET; DWORD transferred = 0; OVERLAPPED lOverlapped = { 0 }; lOverlapped.hEvent = CreateEvent(nullptr, FALSE, FALSE, nullptr); XUSB_SUBMIT_REPORT xsr; XUSB_SUBMIT_REPORT_INIT(&xsr, target->SerialNo); xsr.Report = report; DeviceIoControl( vigem->hBusDevice, IOCTL_XUSB_SUBMIT_REPORT, &xsr, xsr.Size, nullptr, 0, &transferred, &lOverlapped ); if (GetOverlappedResult(vigem->hBusDevice, &lOverlapped, &transferred, TRUE) == 0) { if (GetLastError() == ERROR_ACCESS_DENIED) { CloseHandle(lOverlapped.hEvent); return VIGEM_ERROR_INVALID_TARGET; } } CloseHandle(lOverlapped.hEvent); return VIGEM_ERROR_NONE; } VIGEM_ERROR vigem_target_ds4_update( PVIGEM_CLIENT vigem, PVIGEM_TARGET target, DS4_REPORT report ) { if (!vigem) return VIGEM_ERROR_BUS_INVALID_HANDLE; if (!target) return VIGEM_ERROR_INVALID_TARGET; if (vigem->hBusDevice == INVALID_HANDLE_VALUE) return VIGEM_ERROR_BUS_NOT_FOUND; if (target->SerialNo == 0) return VIGEM_ERROR_INVALID_TARGET; DWORD transferred = 0; OVERLAPPED lOverlapped = { 0 }; lOverlapped.hEvent = CreateEvent(nullptr, FALSE, FALSE, nullptr); DS4_SUBMIT_REPORT dsr; DS4_SUBMIT_REPORT_INIT(&dsr, target->SerialNo); dsr.Report = report; DeviceIoControl( vigem->hBusDevice, IOCTL_DS4_SUBMIT_REPORT, &dsr, dsr.Size, nullptr, 0, &transferred, &lOverlapped ); if (GetOverlappedResult(vigem->hBusDevice, &lOverlapped, &transferred, TRUE) == 0) { if (GetLastError() == ERROR_ACCESS_DENIED) { CloseHandle(lOverlapped.hEvent); return VIGEM_ERROR_INVALID_TARGET; } } CloseHandle(lOverlapped.hEvent); return VIGEM_ERROR_NONE; } ULONG vigem_target_get_index(PVIGEM_TARGET target) { return target->SerialNo; } VIGEM_TARGET_TYPE vigem_target_get_type(PVIGEM_TARGET target) { return target->Type; } BOOL vigem_target_is_attached(PVIGEM_TARGET target) { return (target->State == VIGEM_TARGET_CONNECTED); } VIGEM_ERROR vigem_target_x360_get_user_index( PVIGEM_CLIENT vigem, PVIGEM_TARGET target, PULONG index ) { if (!vigem) return VIGEM_ERROR_BUS_INVALID_HANDLE; if (!target) return VIGEM_ERROR_INVALID_TARGET; if (vigem->hBusDevice == INVALID_HANDLE_VALUE) return VIGEM_ERROR_BUS_NOT_FOUND; if (target->SerialNo == 0 || target->Type != Xbox360Wired) return VIGEM_ERROR_INVALID_TARGET; DWORD transferred = 0; OVERLAPPED lOverlapped = { 0 }; lOverlapped.hEvent = CreateEvent(nullptr, FALSE, FALSE, nullptr); XUSB_GET_USER_INDEX gui; XUSB_GET_USER_INDEX_INIT(&gui, target->SerialNo); DeviceIoControl( vigem->hBusDevice, IOCTL_XUSB_GET_USER_INDEX, &gui, gui.Size, &gui, gui.Size, &transferred, &lOverlapped ); if (GetOverlappedResult(vigem->hBusDevice, &lOverlapped, &transferred, TRUE) == 0) { const auto error = GetLastError(); if (error == ERROR_ACCESS_DENIED) { CloseHandle(lOverlapped.hEvent); return VIGEM_ERROR_INVALID_TARGET; } if (error == ERROR_INVALID_DEVICE_OBJECT_PARAMETER) { CloseHandle(lOverlapped.hEvent); return VIGEM_ERROR_XUSB_USERINDEX_OUT_OF_RANGE; } } CloseHandle(lOverlapped.hEvent); *index = gui.UserIndex; return VIGEM_ERROR_NONE; }