Updated links in README.md

Fix Y touchpad resolution comment

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 💬 Community support
+    url: https://vigem.org/Community-Support/
+    about: Use these resources for support.
+  - name: 📖 Documentation
+    url: https://vigem.org/projects/
+    about: Extended documentation about the projects.
+  - name: ❓ Other issue?
+    url: https://forums.vigem.org/
+    about: Search on the community forums.

.github/ISSUE_TEMPLATE/use-this-for-problems-with-the-setup.md

@@ -0,0 +1,30 @@
+---
+name: Setup issues
+about: Use this if you have problems with the setup
+
+---
+
+## README first
+
+Before you report issues with the setup, make sure to check the following things **first**:
+
+- Are you on anything older than Windows **10**? Windows XP/Vista/7/8/8.1 **are not supported** so don't report this as an issue, it is intentional.
+- [Have you chosen the right setup for your CPU architecture?](https://vigem.org/research/How-to-check-architecture/)
+  - You **can not mix these**, make sure to download and run the correct setup.
+  - **ARM/ARM64** is **not supported**. See above link to check for yourself.
+
+## I verified all that and am still stuck
+
+Please provide the following **log files** and attach them to the issue. Failing to do so will result in the issue being closed without any further comment.
+
+### Setup log
+
+Run the setup from the command line (either old-school `cmd` or PowerShell) with the following additional arguments: `/L*V .\install.log`
+
+This will generate the log file `install.log` in the same directory the setup resides in. Attach it once the setup is "done" failing.
+
+Last but not least look for `C:\Windows\INF\setupapi.dev.log` and attach it as well.
+
+Optionally compress both files down if it gives you troubles uploading.
+
+Your compliance is appreciated! 😘

.github/workflows/support.yml

@@ -0,0 +1,25 @@
+name: 'Support Requests'
+
+on:
+  issues:
+    types: [labeled, unlabeled, reopened]
+
+permissions:
+  issues: write
+
+jobs:
+  action:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: dessant/support-requests@v2
+        with:
+          github-token: ${{ github.token }}
+          support-label: 'support'
+          issue-comment: >
+            :wave: @{issue-author}, we use the issue tracker exclusively
+            for bug reports and feature requests. However, this issue appears
+            to be a support request. Please use our support channels
+            to get help with the project.
+          close-issue: true
+          lock-issue: true
+          issue-lock-reason: 'off-topic'

.gitignore

@@ -23,6 +23,7 @@ mono_crash.*
 [Rr]eleases/
 x64/
 x86/
+[Ww][Ii][Nn]32/
 [Aa][Rr][Mm]/
 [Aa][Rr][Mm]64/
 bld/
@@ -61,6 +62,9 @@ project.lock.json
 project.fragment.lock.json
 artifacts/
 
+# ASP.NET Scaffolding
+ScaffoldingReadMe.txt
+
 # StyleCop
 StyleCopReport.xml
 
@@ -350,4 +354,12 @@ healthchecksdb
 MigrationBackup/
 
 # Ionide (cross platform F# VS Code tools) working folder
-.ionide/
+.ionide/
+
+# Fody - auto-generated XML schema
+FodyWeavers.xsd
+/disk1/ViGEmBus_x64.cab
+/setup.inf
+/setup.rpt
+/drivers
+/_setup

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "client"]
-	path = client
-	url = https://github.com/ViGEm/ViGEmClient.git

LICENSE

@@ -1,21 +1,29 @@
-MIT License
+BSD 3-Clause License
 
-Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
+Copyright (c) 2016-2020, Nefarius Software Solutions e.U.
+All rights reserved.
 
-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:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
 
-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.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -2,12 +2,19 @@
 
 Windows kernel-mode driver emulating well-known USB game controllers.
 
-[![Build status](https://ci.appveyor.com/api/projects/status/rv74ufluwib52dq2?svg=true)](https://ci.appveyor.com/project/nefarius/vigembus) [![Discord](https://img.shields.io/discord/346756263763378176.svg)](https://discord.vigem.org) [![Website](https://img.shields.io/website-up-down-green-red/https/vigem.org.svg?label=ViGEm.org)](https://vigem.org/) [![PayPal Donate](https://img.shields.io/badge/paypal-donate-blue.svg)](<https://paypal.me/NefariusMaximus>) [![Support on Patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](<https://www.patreon.com/nefarius>) [![GitHub followers](https://img.shields.io/github/followers/nefarius.svg?style=social&label=Follow)](https://github.com/nefarius) [![Twitter Follow](https://img.shields.io/twitter/follow/nefariusmaximus.svg?style=social&label=Follow)](https://twitter.com/nefariusmaximus)
+[![Build status](https://ci.appveyor.com/api/projects/status/rv74ufluwib52dq2?svg=true)](https://ci.appveyor.com/project/nefarius/vigembus) [![Discord](https://img.shields.io/discord/346756263763378176.svg)](https://discord.vigem.org) [![Website](https://img.shields.io/website-up-down-green-red/https/vigem.org.svg?label=ViGEm.org)](https://vigem.org/) [![GitHub followers](https://img.shields.io/github/followers/nefarius.svg?style=social&label=Follow)](https://github.com/nefarius) [![Twitter Follow](https://img.shields.io/twitter/follow/nefariusmaximus.svg?style=social&label=Follow)](https://twitter.com/nefariusmaximus)
+
+<sub>(This project is available under a free and permissive license, but needs financial support to sustain its continued improvements. In addition to maintenance and stability there are many desirable features yet to be added. If your company is using components of ViGEm, please consider reaching out.)</sub>
+
+Businesses: support continued development via invoiced technical support, maintenance, sponsoring contracts:
+<br>&nbsp;&nbsp;_E-mail: vigem @ nefarius dot at_
+
+Individuals: support continued maintenance and development via [PayPal](https://paypal.me/NefariusMaximus) donations.
+
+----
 
 ## About
 
-**Disclaimer:** this project is for software developers. To make it do something useful you'll also need a [feeder application](<https://docs.vigem.org/#!vigem-feeder.md>).  
-
 The `ViGEmBus` driver and `ViGEmClient` libraries represent the core of the Virtual Gamepad Emulation Framework (or `ViGEm` , for short). `ViGEm` aims for a 100% accurate [emulation](<https://en.wikipedia.org/wiki/Emulator>) of well-known gaming peripherals as pure software-based devices at kernel level. As it mimics "the real thing" games and other processes require no additional modification whatsoever to detect `ViGEm`-based devices (no Proxy-DLLs or API-Hooking) and simply work out of the box. While the (now obsolete) [Scarlett.Crush Productions Virtual Bus Driver](<https://github.com/nefarius/ScpVBus>) is the spiritual father of this project, `ViGEm` has been designed and written from the ground up utilizing Microsoft's [Kernel-Mode Driver Framework](https://en.wikipedia.org/wiki/Kernel-Mode_Driver_Framework).
 
 ### Emulated devices
@@ -30,23 +37,30 @@ A few examples of the most common use cases for `ViGEm` are:
 
 ## Supported Systems
 
-The driver is built for Windows 7/8.1/10 (x86 and amd64).
+### Version 1.16 and below
+
+The driver is built for Windows 7/8.1/10/Server 2016/Server 2019 (x86 and amd64).
+
+### Version 1.17 and above
+
+The driver is built for Windows 10/Server 2016/Server 2019 only (x86 and amd64).
+
+## License
+
+The ViGEm Bus Driver is licensed under the **BSD-3-Clause**, see [LICENSE](./LICENSE.md) for more information.
 
 ## How to build
 
 ### Prerequisites
 
-- Visual Studio **2017** ([Community Edition](https://www.visualstudio.com/thank-you-downloading-visual-studio/?sku=Community&rel=15) is just fine)
-- [WDK for Windows 10, version 1803](https://developer.microsoft.com/en-us/windows/hardware/windows-driver-kit)
-- [.NET Core SDK 2.1](https://www.microsoft.com/net/download/dotnet-core/2.1) (or greater, required for building only)
+- [Step 1: Install Visual Studio 2019](https://docs.microsoft.com/en-us/windows-hardware/drivers/other-wdk-downloads#step-1-install-visual-studio)
+- [Step 2: Install WDK for Windows 10, version 2004](https://docs.microsoft.com/en-us/windows-hardware/drivers/other-wdk-downloads#step-2-install-the-wdk)
+- [Step 3: Clone the Driver Module Framework (DMF)](https://github.com/microsoft/DMF) into the same parent directory.
+  - Build the `DmfK` project with Release and Debug configurations for all architectures (x64 and Win32).
 
-You can either build directly within Visual Studio or in PowerShell by running the build script:
+You can build directly within Visual Studio.
 
-```PowerShell
-.\build.ps1 -configuration release
-```
-
-Do bear in mind that you'll need to **sign** the driver to use it without [test mode](<https://technet.microsoft.com/en-us/ff553484(v=vs.96)>).
+Do bear in mind that you'll need to **sign** the driver to use it without [test mode](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/the-testsigning-boot-configuration-option#enable-or-disable-use-of-test-signed-code).
 
 ## Contribute
 
@@ -54,7 +68,7 @@ Do bear in mind that you'll need to **sign** the driver to use it without [test
 
 Found a bug and want it fixed? Open a detailed issue on the [GitHub issue tracker](../../issues)!
 
-Have an idea for a new feature? [Check out the project board](https://projects.vigem.org/public/board/27281599595f5fbe5f915884fb9ca2de92726e74173f1ac434300b2d40af), maybe it's already on there! If not, let's have a chat about your request on [Discord](https://discord.vigem.org) or the [community forums](https://forums.vigem.org).
+Have an idea for a new feature? Let's have a chat about your request on [Discord](https://discord.vigem.org) or the [community forums](https://forums.vigem.org).
 
 ### Questions & Support
 
@@ -62,32 +76,39 @@ Please respect that the GitHub issue tracker isn't a helpdesk. We offer a [Disco
 
 ## Installation
 
-To grab the latest signed binaries for use or redistribution [head over to releases](../../releases/latest) and download the latest setup. It will take care of everything.
+Pre-built production-signed binaries are provided by `Nefarius Software Solutions e.U.` and [available as an all-in-one setup](../../releases/latest).
 
 ## Sponsors
 
 Sponsors listed here have helped the project flourish by either financial support or by gifting licenses:
 
 - [3dRudder](https://www.3drudder.com/)
-- [Parsec](https://parsecgaming.com/)
-- [Rainway, Inc](https://rainway.io/)
+- [Parsec](https://parsec.app/)
+- [Rainway, Inc](https://rainway.com/)
 - [JetBrains](https://www.jetbrains.com/resharper/)
 - [Advanced Installer](https://www.advancedinstaller.com/)
 - [ICAROS](https://www.icaros.com/)
 
 ## Known users of ViGEm
 
-A brief listing of projects/companies/vendors known to build upon the powers of ViGEm. This list is non-exhaustive, if you'd like to see your project included, contact us!
+A brief listing of projects/companies/vendors known to build upon the powers of ViGEm.
+
+This list is non-exhaustive, if you'd like to see your project included, contact us!
 
 - [3dRudder](https://www.3drudder.com/)
-- [Parsec](https://parsecgaming.com/)
+- [Parsec](https://parsec.app/)
 - [GloSC](https://github.com/Alia5/GloSC)
 - [UCR](https://github.com/Snoothy/UCR)
 - [InputMapper](https://inputmapper.com/)
 - [Oculus VR, LLC.](https://www.oculus.com/)
-- [Rainway, Inc](https://rainway.io/)
+- [Rainway, Inc](https://rainway.com/)
 - [WiimoteHook](https://forum.cemu.info/showthread.php/140-WiimoteHook-Nintendo-Wii-Remote-with-Motion-Rumble-and-Nunchuk-support)
 - [XJoy](https://github.com/sam0x17/XJoy)
-- [HP](https://www8.hp.com/us/en/campaigns/gamingpcs/overview.html)
+- [HP](https://www8.hp.com/us/en/gaming/omen.html)
 - [DS4Windows](https://ryochan7.github.io/ds4windows-site/)
 - [XOutput](https://github.com/csutorasa/XOutput)
+- [RdpGamepad](https://github.com/microsoft/RdpGamepad)
+- [Touchmote](https://github.com/Ryochan7/Touchmote/tree/ryochan7)
+- [Mi-ViGEm](https://github.com/grayver/mi-vigem)
+- [BetterJoy](https://github.com/Davidobot/BetterJoy)
+- [Regame - Cloud Gaming Engine](https://github.com/ksyun-kenc/liuguang)

ViGEmBus.ddf

@@ -1,21 +0,0 @@
-.OPTION EXPLICIT
-.Set CabinetFileCountThreshold=0
-.Set FolderFileCountThreshold=0
-.Set FolderSizeThreshold=0
-.Set MaxCabinetSize=0
-.Set MaxDiskFileCount=0
-.Set MaxDiskSize=0
-.Set CompressionType=MSZIP
-.Set Cabinet=on
-.Set Compress=on
-.Set CabinetNameTemplate=ViGEmBus.cab
-.Set DestinationDir=ViGEmBus
-.\artifacts\ViGEmBus.inf
-.Set DestinationDir=ViGEmBus\x64
-.\artifacts\x64\ViGEmBus.sys
-.\artifacts\x64\ViGEmBus.pdb
-.\artifacts\x64\WdfCoinstaller01009.dll
-.Set DestinationDir=ViGEmBus\x86
-.\artifacts\x86\ViGEmBus.sys
-.\artifacts\x86\ViGEmBus.pdb
-.\artifacts\x86\WdfCoinstaller01009.dll

ViGEmBus.sln

@@ -1,40 +1,142 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 15
-VisualStudioVersion = 15.0.27130.2024
+# Visual Studio Version 16
+VisualStudioVersion = 16.0.29613.14
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "ViGEmBus", "sys\ViGEmBus.vcxproj", "{040101B0-EE5C-4EF1-99EE-9F81C795C001}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "_build", "build\_build.csproj", "{E1E264A8-6100-429F-BA23-F00FFF7D126B}"
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SDK", "SDK", "{733360FF-9D9F-4C67-86D1-B20881C17000}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Driver", "Driver", "{0182EE0E-A2FB-4525-9FEA-1910B12B21C8}"
+EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "ViGEmClient", "sdk\src\ViGEmClient.vcxproj", "{7DB06674-1F4F-464B-8E1C-172E9587F9DC}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Setup", "Setup", "{D138F6D3-3E59-49F6-8C6E-1C3AEB56CF7B}"
+EndProject
+Project("{930C7802-8A8C-48F9-8165-68863BCCD9DD}") = "ViGEmBusSetup", "setup\ViGEmBusSetup.wixproj", "{C722B85E-FC7D-475F-A518-C8E13ECDB201}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "_build", "build\_build.csproj", "{C2BA387E-D491-4FB7-8BEE-99D77E8949E7}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug_DLL|x64 = Debug_DLL|x64
+		Debug_DLL|x86 = Debug_DLL|x86
+		Debug_LIB|x64 = Debug_LIB|x64
+		Debug_LIB|x86 = Debug_LIB|x86
 		Debug|x64 = Debug|x64
 		Debug|x86 = Debug|x86
+		Release_DLL|x64 = Release_DLL|x64
+		Release_DLL|x86 = Release_DLL|x86
+		Release_LIB|x64 = Release_LIB|x64
+		Release_LIB|x86 = Release_LIB|x86
 		Release|x64 = Release|x64
 		Release|x86 = Release|x86
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Debug_DLL|x64.ActiveCfg = Debug|x64
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Debug_DLL|x64.Build.0 = Debug|x64
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Debug_DLL|x64.Deploy.0 = Debug|x64
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Debug_DLL|x86.ActiveCfg = Debug|Win32
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Debug_DLL|x86.Build.0 = Debug|Win32
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Debug_DLL|x86.Deploy.0 = Debug|Win32
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Debug_LIB|x64.ActiveCfg = Debug|x64
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Debug_LIB|x64.Build.0 = Debug|x64
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Debug_LIB|x64.Deploy.0 = Debug|x64
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Debug_LIB|x86.ActiveCfg = Debug|Win32
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Debug_LIB|x86.Build.0 = Debug|Win32
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Debug_LIB|x86.Deploy.0 = Debug|Win32
 		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Debug|x64.ActiveCfg = Debug|x64
 		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Debug|x64.Build.0 = Debug|x64
 		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Debug|x64.Deploy.0 = Debug|x64
 		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Debug|x86.ActiveCfg = Debug|Win32
 		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Debug|x86.Build.0 = Debug|Win32
 		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Debug|x86.Deploy.0 = Debug|Win32
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Release_DLL|x64.ActiveCfg = Release|x64
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Release_DLL|x64.Build.0 = Release|x64
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Release_DLL|x64.Deploy.0 = Release|x64
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Release_DLL|x86.ActiveCfg = Release|Win32
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Release_DLL|x86.Build.0 = Release|Win32
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Release_DLL|x86.Deploy.0 = Release|Win32
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Release_LIB|x64.ActiveCfg = Release|x64
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Release_LIB|x64.Build.0 = Release|x64
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Release_LIB|x64.Deploy.0 = Release|x64
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Release_LIB|x86.ActiveCfg = Release|Win32
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Release_LIB|x86.Build.0 = Release|Win32
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Release_LIB|x86.Deploy.0 = Release|Win32
 		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Release|x64.ActiveCfg = Release|x64
 		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Release|x64.Build.0 = Release|x64
 		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Release|x64.Deploy.0 = Release|x64
 		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Release|x86.ActiveCfg = Release|Win32
 		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Release|x86.Build.0 = Release|Win32
 		{040101B0-EE5C-4EF1-99EE-9F81C795C001}.Release|x86.Deploy.0 = Release|Win32
-		{E1E264A8-6100-429F-BA23-F00FFF7D126B}.Debug|x64.ActiveCfg = Debug|Any CPU
-		{E1E264A8-6100-429F-BA23-F00FFF7D126B}.Debug|x86.ActiveCfg = Debug|Any CPU
-		{E1E264A8-6100-429F-BA23-F00FFF7D126B}.Release|x64.ActiveCfg = Release|Any CPU
-		{E1E264A8-6100-429F-BA23-F00FFF7D126B}.Release|x86.ActiveCfg = Release|Any CPU
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug_DLL|x64.ActiveCfg = Debug_DLL|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug_DLL|x64.Build.0 = Debug_DLL|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug_DLL|x86.ActiveCfg = Debug_DLL|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug_DLL|x86.Build.0 = Debug_DLL|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug_LIB|x64.ActiveCfg = Debug_LIB|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug_LIB|x64.Build.0 = Debug_LIB|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug_LIB|x86.ActiveCfg = Debug_LIB|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug_LIB|x86.Build.0 = Debug_LIB|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug|x64.ActiveCfg = Debug_DLL|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug|x64.Build.0 = Debug_DLL|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug|x86.ActiveCfg = Debug_LIB|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug|x86.Build.0 = Debug_LIB|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release_DLL|x64.ActiveCfg = Release_DLL|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release_DLL|x64.Build.0 = Release_DLL|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release_DLL|x86.ActiveCfg = Release_DLL|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release_DLL|x86.Build.0 = Release_DLL|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release_LIB|x64.ActiveCfg = Release_LIB|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release_LIB|x64.Build.0 = Release_LIB|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release_LIB|x86.ActiveCfg = Release_LIB|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release_LIB|x86.Build.0 = Release_LIB|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release|x64.ActiveCfg = Release_LIB|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release|x64.Build.0 = Release_LIB|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release|x86.ActiveCfg = Release_DLL|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release|x86.Build.0 = Release_DLL|Win32
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Debug_DLL|x64.ActiveCfg = Release|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Debug_DLL|x64.Build.0 = Release|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Debug_DLL|x86.ActiveCfg = Debug|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Debug_DLL|x86.Build.0 = Debug|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Debug_LIB|x64.ActiveCfg = Release|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Debug_LIB|x64.Build.0 = Release|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Debug_LIB|x86.ActiveCfg = Debug|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Debug_LIB|x86.Build.0 = Debug|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Debug|x64.ActiveCfg = Debug|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Debug|x86.ActiveCfg = Debug|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Debug|x86.Build.0 = Debug|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Release_DLL|x64.ActiveCfg = Release|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Release_DLL|x64.Build.0 = Release|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Release_DLL|x86.ActiveCfg = Release|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Release_DLL|x86.Build.0 = Release|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Release_LIB|x64.ActiveCfg = Release|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Release_LIB|x64.Build.0 = Release|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Release_LIB|x86.ActiveCfg = Release|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Release_LIB|x86.Build.0 = Release|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Release|x64.ActiveCfg = Release|x64
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Release|x64.Build.0 = Release|x64
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Release|x86.ActiveCfg = Release|x86
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201}.Release|x86.Build.0 = Release|x86
+		{C2BA387E-D491-4FB7-8BEE-99D77E8949E7}.Debug_DLL|x64.ActiveCfg = Debug|Any CPU
+		{C2BA387E-D491-4FB7-8BEE-99D77E8949E7}.Debug_DLL|x86.ActiveCfg = Debug|Any CPU
+		{C2BA387E-D491-4FB7-8BEE-99D77E8949E7}.Debug_LIB|x64.ActiveCfg = Debug|Any CPU
+		{C2BA387E-D491-4FB7-8BEE-99D77E8949E7}.Debug_LIB|x86.ActiveCfg = Debug|Any CPU
+		{C2BA387E-D491-4FB7-8BEE-99D77E8949E7}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{C2BA387E-D491-4FB7-8BEE-99D77E8949E7}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{C2BA387E-D491-4FB7-8BEE-99D77E8949E7}.Release_DLL|x64.ActiveCfg = Release|Any CPU
+		{C2BA387E-D491-4FB7-8BEE-99D77E8949E7}.Release_DLL|x86.ActiveCfg = Release|Any CPU
+		{C2BA387E-D491-4FB7-8BEE-99D77E8949E7}.Release_LIB|x64.ActiveCfg = Release|Any CPU
+		{C2BA387E-D491-4FB7-8BEE-99D77E8949E7}.Release_LIB|x86.ActiveCfg = Release|Any CPU
+		{C2BA387E-D491-4FB7-8BEE-99D77E8949E7}.Release|x64.ActiveCfg = Release|Any CPU
+		{C2BA387E-D491-4FB7-8BEE-99D77E8949E7}.Release|x86.ActiveCfg = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
+	GlobalSection(NestedProjects) = preSolution
+		{040101B0-EE5C-4EF1-99EE-9F81C795C001} = {0182EE0E-A2FB-4525-9FEA-1910B12B21C8}
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC} = {733360FF-9D9F-4C67-86D1-B20881C17000}
+		{C722B85E-FC7D-475F-A518-C8E13ECDB201} = {D138F6D3-3E59-49F6-8C6E-1C3AEB56CF7B}
+	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {D5CD61FD-80BB-4E0E-840C-BAF66ABB1CF0}
 	EndGlobalSection

ViGEmBus_x64.ddf

@@ -0,0 +1,18 @@
+; ViGEmBus cab file for attestation submission
+.OPTION EXPLICIT
+.Set CabinetFileCountThreshold=0
+.Set FolderFileCountThreshold=0
+.Set FolderSizeThreshold=0
+.Set MaxCabinetSize=0
+.Set MaxDiskFileCount=0
+.Set MaxDiskSize=0
+.Set CompressionType=MSZIP
+.Set Cabinet=on
+.Set Compress=on
+; x64
+.Set CabinetNameTemplate=ViGEmBus_x64.cab
+.Set DestinationDir=ViGEmBus_x64
+LICENSE
+bin\x64\ViGEmBus.pdb
+bin\x64\ViGEmBus\ViGEmBus.inf
+bin\x64\ViGEmBus\ViGEmBus.sys

ViGEmBus_x86.ddf

@@ -0,0 +1,18 @@
+; ViGEmBus cab file for attestation submission
+.OPTION EXPLICIT
+.Set CabinetFileCountThreshold=0
+.Set FolderFileCountThreshold=0
+.Set FolderSizeThreshold=0
+.Set MaxCabinetSize=0
+.Set MaxDiskFileCount=0
+.Set MaxDiskSize=0
+.Set CompressionType=MSZIP
+.Set Cabinet=on
+.Set Compress=on
+; x86
+.Set CabinetNameTemplate=ViGEmBus_x86.cab
+.Set DestinationDir=ViGEmBus_x86
+LICENSE
+bin\x86\ViGEmBus.pdb
+bin\x86\ViGEmBus\ViGEmBus.inf
+bin\x86\ViGEmBus\ViGEmBus.sys

appveyor.yml

@@ -1,21 +1,38 @@
-version: 1.16.{build}.0
-image: Visual Studio 2017
+version: 1.18.{build}.0
+image: Visual Studio 2019
+skip_commits:
+  files:
+    - '**/*.md'
+cache:
+- C:\projects\DMF
+platform:
+- x86
+- x64
+configuration:
+- Release
 install:
+- ps: iwr "https://download.microsoft.com/download/c/f/8/cf80b955-d578-4635-825c-2801911f9d79/wdk/wdksetup.exe" -OutFile wdksetup.exe
+- cmd: .\wdksetup.exe /features + /q /norestart
 - cmd: git submodule -q update --init
+- cmd: git clone -q https://github.com/microsoft/DMF.git C:\projects\DMF 2> nul || set ERRORLEVEL=0
+- cmd: |
+    cd "C:\projects\DMF"
+    git pull > NUL
+    cd %appveyor_build_folder%
+before_build:
+- ps: Invoke-WebRequest "https://github.com/nefarius/vpatch/releases/latest/download/vpatch.exe" -OutFile vpatch.exe
+- cmd: vpatch.exe --stamp-version "%APPVEYOR_BUILD_VERSION%" --target-file ".\sys\ViGEmBus.vcxproj" --vcxproj.inf-time-stamp
+- cmd: vpatch.exe --stamp-version "%APPVEYOR_BUILD_VERSION%" --target-file ".\sys\ViGEmBus.rc" --resource.file-version --resource.product-version
 build_script:
-- ps: .\build.ps1 -configuration release
+- cmd: .\build.cmd
 after_build:
-- ps: |
-    Invoke-WebRequest "https://downloads.vigem.org/other/pavel-a/ddverpatch/verpatch-1.0.15.1-x86-codeplex.zip" -OutFile verpatch-1.0.15.1-x86-codeplex.zip
-    Expand-Archive verpatch-1.0.15.1-x86-codeplex.zip -DestinationPath .
-    .\verpatch.exe .\artifacts\x64\ViGEmBus.sys "$env:APPVEYOR_BUILD_VERSION"
-    .\verpatch.exe .\artifacts\x64\ViGEmBus.sys /pv "$env:APPVEYOR_BUILD_VERSION"
-    .\verpatch.exe .\artifacts\x86\ViGEmBus.sys "$env:APPVEYOR_BUILD_VERSION"
-    .\verpatch.exe .\artifacts\x86\ViGEmBus.sys /pv "$env:APPVEYOR_BUILD_VERSION"
-    makecab.exe /f ViGEmBus.ddf
+- cmd: makecab.exe /f ViGEmBus_%PLATFORM%.ddf
 artifacts:
-- path: disk1\ViGEmBus.cab
-  name: ViGEmBus_unsigned_x86_amd64
+- path: 'bin**\$(APPVEYOR_PROJECT_NAME)\*.inf'
+- path: 'bin**\$(APPVEYOR_PROJECT_NAME)\*.sys'
+- path: 'bin**\*.pdb'
+- path: 'disk1\*.cab'
+- path: 'bin**\*.msi'
 deploy:
 - provider: Environment
   name: BUILDBOT

build.cmd

@@ -0,0 +1,7 @@
+:; set -eo pipefail
+:; SCRIPT_DIR=$(cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd)
+:; ${SCRIPT_DIR}/build.sh "$@"
+:; exit $?
+
+@ECHO OFF
+powershell -ExecutionPolicy ByPass -NoProfile %0\..\build.ps1 %*

build.ps1

@@ -1,13 +1,12 @@
 [CmdletBinding()]
 Param(
-    #[switch]$CustomParam,
     [Parameter(Position=0,Mandatory=$false,ValueFromRemainingArguments=$true)]
     [string[]]$BuildArguments
 )
 
-Write-Output "Windows PowerShell $($Host.Version)"
+Write-Output "PowerShell $($PSVersionTable.PSEdition) version $($PSVersionTable.PSVersion)"
 
-Set-StrictMode -Version 2.0; $ErrorActionPreference = "Stop"; $ConfirmPreference = "None"; trap { $host.SetShouldExit(1) }
+Set-StrictMode -Version 2.0; $ErrorActionPreference = "Stop"; $ConfirmPreference = "None"; trap { Write-Error $_ -ErrorAction Continue; exit 1 }
 $PSScriptRoot = Split-Path $MyInvocation.MyCommand.Path -Parent
 
 ###########################################################################
@@ -18,12 +17,12 @@ $BuildProjectFile = "$PSScriptRoot\build\_build.csproj"
 $TempDirectory = "$PSScriptRoot\\.tmp"
 
 $DotNetGlobalFile = "$PSScriptRoot\\global.json"
-$DotNetInstallUrl = "https://raw.githubusercontent.com/dotnet/cli/master/scripts/obtain/dotnet-install.ps1"
-$DotNetReleasesUrl = "https://raw.githubusercontent.com/dotnet/core/master/release-notes/releases.json"
+$DotNetInstallUrl = "https://dot.net/v1/dotnet-install.ps1"
+$DotNetChannel = "Current"
 
 $env:DOTNET_SKIP_FIRST_TIME_EXPERIENCE = 1
 $env:DOTNET_CLI_TELEMETRY_OPTOUT = 1
-$env:NUGET_XMLDOC_MODE = "skip"
+$env:DOTNET_MULTILEVEL_LOOKUP = 0
 
 ###########################################################################
 # EXECUTION
@@ -34,32 +33,37 @@ function ExecSafe([scriptblock] $cmd) {
     if ($LASTEXITCODE) { exit $LASTEXITCODE }
 }
 
-# If global.json exists, load expected version
-if (Test-Path $DotNetGlobalFile) {
-    $DotNetVersion = $(Get-Content $DotNetGlobalFile | Out-String | ConvertFrom-Json).sdk.version
-}
-
-# If dotnet is installed locally, and expected version is not set or installation matches the expected version
-if ((Get-Command "dotnet" -ErrorAction SilentlyContinue) -ne $null -and `
-     (!(Test-Path variable:DotNetVersion) -or $(& dotnet --version) -eq $DotNetVersion)) {
+# If dotnet CLI is installed globally and it matches requested version, use for execution
+if ($null -ne (Get-Command "dotnet" -ErrorAction SilentlyContinue) -and `
+     $(dotnet --version) -and $LASTEXITCODE -eq 0) {
     $env:DOTNET_EXE = (Get-Command "dotnet").Path
 }
 else {
-    $DotNetDirectory = "$TempDirectory\dotnet-win"
-    $env:DOTNET_EXE = "$DotNetDirectory\dotnet.exe"
+    # Download install script
+    $DotNetInstallFile = "$TempDirectory\dotnet-install.ps1"
+    New-Item -ItemType Directory -Path $TempDirectory -Force | Out-Null
+    [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
+    (New-Object System.Net.WebClient).DownloadFile($DotNetInstallUrl, $DotNetInstallFile)
 
-    # If expected version is not set, get latest version
-    if (!(Test-Path variable:DotNetVersion)) {
-        $DotNetVersion = $(Invoke-WebRequest -UseBasicParsing $DotNetReleasesUrl | ConvertFrom-Json)[0]."version-sdk"
+    # If global.json exists, load expected version
+    if (Test-Path $DotNetGlobalFile) {
+        $DotNetGlobal = $(Get-Content $DotNetGlobalFile | Out-String | ConvertFrom-Json)
+        if ($DotNetGlobal.PSObject.Properties["sdk"] -and $DotNetGlobal.sdk.PSObject.Properties["version"]) {
+            $DotNetVersion = $DotNetGlobal.sdk.version
+        }
     }
 
-    # Download and execute install script
-    $DotNetInstallFile = "$TempDirectory\dotnet-install.ps1"
-    md -force $TempDirectory > $null
-    (New-Object System.Net.WebClient).DownloadFile($DotNetInstallUrl, $DotNetInstallFile)
-    ExecSafe { & $DotNetInstallFile -InstallDir $DotNetDirectory -Version $DotNetVersion -NoPath }
+    # Install by channel or version
+    $DotNetDirectory = "$TempDirectory\dotnet-win"
+    if (!(Test-Path variable:DotNetVersion)) {
+        ExecSafe { & $DotNetInstallFile -InstallDir $DotNetDirectory -Channel $DotNetChannel -NoPath }
+    } else {
+        ExecSafe { & $DotNetInstallFile -InstallDir $DotNetDirectory -Version $DotNetVersion -NoPath }
+    }
+    $env:DOTNET_EXE = "$DotNetDirectory\dotnet.exe"
 }
 
 Write-Output "Microsoft (R) .NET Core SDK version $(& $env:DOTNET_EXE --version)"
 
-ExecSafe { & $env:DOTNET_EXE run --project $BuildProjectFile -- $BuildArguments }
+ExecSafe { & $env:DOTNET_EXE build $BuildProjectFile /nodeReuse:false /p:UseSharedCompilation=false -nologo -clp:NoSummary --verbosity quiet }
+ExecSafe { & $env:DOTNET_EXE run --project $BuildProjectFile --no-build -- $BuildArguments }

build.sh

@@ -1,16 +1,6 @@
 #!/usr/bin/env bash
 
-echo $(bash --version 2>&1 | head -n 1)
-
-#CUSTOMPARAM=0
-BUILD_ARGUMENTS=()
-for i in "$@"; do
-    case $(echo $1 | awk '{print tolower($0)}') in
-        # -custom-param) CUSTOMPARAM=1;;
-        *) BUILD_ARGUMENTS+=("$1") ;;
-    esac
-    shift
-done
+bash --version 2>&1 | head -n 1
 
 set -eo pipefail
 SCRIPT_DIR=$(cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd)
@@ -23,46 +13,50 @@ BUILD_PROJECT_FILE="$SCRIPT_DIR/build/_build.csproj"
 TEMP_DIRECTORY="$SCRIPT_DIR//.tmp"
 
 DOTNET_GLOBAL_FILE="$SCRIPT_DIR//global.json"
-DOTNET_INSTALL_URL="https://raw.githubusercontent.com/dotnet/cli/master/scripts/obtain/dotnet-install.sh"
-DOTNET_RELEASES_URL="https://raw.githubusercontent.com/dotnet/core/master/release-notes/releases.json"
+DOTNET_INSTALL_URL="https://dot.net/v1/dotnet-install.sh"
+DOTNET_CHANNEL="Current"
 
 export DOTNET_CLI_TELEMETRY_OPTOUT=1
 export DOTNET_SKIP_FIRST_TIME_EXPERIENCE=1
-export NUGET_XMLDOC_MODE="skip"
+export DOTNET_MULTILEVEL_LOOKUP=0
 
 ###########################################################################
 # EXECUTION
 ###########################################################################
 
 function FirstJsonValue {
-    perl -nle 'print $1 if m{"'$1'": "([^"\-]+)",?}' <<< ${@:2}
+    perl -nle 'print $1 if m{"'"$1"'": "([^"]+)",?}' <<< "${@:2}"
 }
 
-# If global.json exists, load expected version
-if [ -f "$DOTNET_GLOBAL_FILE" ]; then
-    DOTNET_VERSION=$(FirstJsonValue "version" $(cat "$DOTNET_GLOBAL_FILE"))
-fi
-
-# If dotnet is installed locally, and expected version is not set or installation matches the expected version
-if [[ -x "$(command -v dotnet)" && (-z ${DOTNET_VERSION+x} || $(dotnet --version) == "$DOTNET_VERSION") ]]; then
+# If dotnet CLI is installed globally and it matches requested version, use for execution
+if [ -x "$(command -v dotnet)" ] && dotnet --version &>/dev/null; then
     export DOTNET_EXE="$(command -v dotnet)"
 else
-    DOTNET_DIRECTORY="$TEMP_DIRECTORY/dotnet-unix"
-    export DOTNET_EXE="$DOTNET_DIRECTORY/dotnet"
-    
-    # If expected version is not set, get latest version
-    if [ -z ${DOTNET_VERSION+x} ]; then
-        DOTNET_VERSION=$(FirstJsonValue "version-sdk" $(curl -s "$DOTNET_RELEASES_URL"))
-    fi
-    
-    # Download and execute install script
+    # Download install script
     DOTNET_INSTALL_FILE="$TEMP_DIRECTORY/dotnet-install.sh"
     mkdir -p "$TEMP_DIRECTORY"
     curl -Lsfo "$DOTNET_INSTALL_FILE" "$DOTNET_INSTALL_URL"
     chmod +x "$DOTNET_INSTALL_FILE"
-    "$DOTNET_INSTALL_FILE" --install-dir "$DOTNET_DIRECTORY" --version "$DOTNET_VERSION" --no-path
+
+    # If global.json exists, load expected version
+    if [[ -f "$DOTNET_GLOBAL_FILE" ]]; then
+        DOTNET_VERSION=$(FirstJsonValue "version" "$(cat "$DOTNET_GLOBAL_FILE")")
+        if [[ "$DOTNET_VERSION" == ""  ]]; then
+            unset DOTNET_VERSION
+        fi
+    fi
+
+    # Install by channel or version
+    DOTNET_DIRECTORY="$TEMP_DIRECTORY/dotnet-unix"
+    if [[ -z ${DOTNET_VERSION+x} ]]; then
+        "$DOTNET_INSTALL_FILE" --install-dir "$DOTNET_DIRECTORY" --channel "$DOTNET_CHANNEL" --no-path
+    else
+        "$DOTNET_INSTALL_FILE" --install-dir "$DOTNET_DIRECTORY" --version "$DOTNET_VERSION" --no-path
+    fi
+    export DOTNET_EXE="$DOTNET_DIRECTORY/dotnet"
 fi
 
 echo "Microsoft (R) .NET Core SDK version $("$DOTNET_EXE" --version)"
 
-"$DOTNET_EXE" run --project "$BUILD_PROJECT_FILE" -- ${BUILD_ARGUMENTS[@]}
+"$DOTNET_EXE" build "$BUILD_PROJECT_FILE" /nodeReuse:false /p:UseSharedCompilation=false -nologo -clp:NoSummary --verbosity quiet
+"$DOTNET_EXE" run --project "$BUILD_PROJECT_FILE" --no-build -- "$@"

build/.editorconfig

@@ -0,0 +1,11 @@
+[*.cs]
+dotnet_style_qualification_for_field = false:warning
+dotnet_style_qualification_for_property = false:warning
+dotnet_style_qualification_for_method = false:warning
+dotnet_style_qualification_for_event = false:warning
+dotnet_style_require_accessibility_modifiers = never:warning
+
+csharp_style_expression_bodied_methods = true:silent
+csharp_style_expression_bodied_properties = true:warning
+csharp_style_expression_bodied_indexers = true:warning
+csharp_style_expression_bodied_accessors = true:warning

build/Build.cs

@@ -1,31 +1,40 @@
 using System;
-using System.IO;
+using System.Linq;
 using Nuke.Common;
-using Nuke.Common.BuildServers;
+using Nuke.Common.CI;
+using Nuke.Common.CI.AppVeyor;
+using Nuke.Common.Execution;
 using Nuke.Common.Git;
+using Nuke.Common.IO;
 using Nuke.Common.ProjectModel;
-using Nuke.Common.Tools.GitVersion;
+using Nuke.Common.Tooling;
 using Nuke.Common.Tools.MSBuild;
-using Vestris.ResourceLib;
+using Nuke.Common.Utilities.Collections;
 using static Nuke.Common.EnvironmentInfo;
 using static Nuke.Common.IO.FileSystemTasks;
 using static Nuke.Common.IO.PathConstruction;
 using static Nuke.Common.Tools.MSBuild.MSBuildTasks;
 
-internal class Build : NukeBuild
+[CheckBuildProjectConfigurations]
+class Build : NukeBuild
 {
-    [GitRepository] private readonly GitRepository GitRepository;
-    [GitVersion] private readonly GitVersion GitVersion;
+    /// Support plugins are available for:
+    ///   - JetBrains ReSharper        https://nuke.build/resharper
+    ///   - JetBrains Rider            https://nuke.build/rider
+    ///   - Microsoft VisualStudio     https://nuke.build/visualstudio
+    ///   - Microsoft VSCode           https://nuke.build/vscode
 
-    [Solution("ViGEmBus.sln")] private readonly Solution Solution;
+    public static int Main () => Execute<Build>(x => x.Compile);
 
-    private AbsolutePath ArtifactsDirectory => RootDirectory / "artifacts";
+    [Parameter("Configuration to build - Default is 'Debug' (local) or 'Release' (server)")]
+    readonly Configuration Configuration = IsLocalBuild ? Configuration.Debug : Configuration.Release;
 
-    private Target Clean => _ => _
-        .Executes(() => { EnsureCleanDirectory(ArtifactsDirectory); });
+    [Solution] readonly Solution Solution;
+    [GitRepository] readonly GitRepository GitRepository;
 
-    private Target Restore => _ => _
-        .DependsOn(Clean)
+    AbsolutePath DmfSolution => RootDirectory / "../DMF/Dmf.sln";
+
+    Target Restore => _ => _
         .Executes(() =>
         {
             MSBuild(s => s
@@ -33,8 +42,30 @@ internal class Build : NukeBuild
                 .SetTargets("Restore"));
         });
 
-    private Target Compile => _ => _
-        .DependsOn(Restore)
+    Target BuildDmf => _ => _
+        .Executes(() =>
+        {
+            if (IsLocalBuild)
+                return;
+
+            Console.WriteLine($"DMF solution path: {DmfSolution}");
+
+            var platform = MSBuildTargetPlatform.x64;
+
+            if (AppVeyor.Instance.Platform != null && AppVeyor.Instance.Platform.Equals("x86"))
+                platform = MSBuildTargetPlatform.Win32;
+
+            MSBuild(s => s
+                .SetTargetPath(DmfSolution)
+                .SetTargets("Rebuild")
+                .SetConfiguration(Configuration)
+                .SetTargetPlatform(platform)
+                .SetMaxCpuCount(Environment.ProcessorCount)
+                .SetNodeReuse(IsLocalBuild));
+        });
+
+    Target Compile => _ => _
+        .DependsOn(BuildDmf)
         .Executes(() =>
         {
             MSBuild(s => s
@@ -42,70 +73,7 @@ internal class Build : NukeBuild
                 .SetTargets("Rebuild")
                 .SetConfiguration(Configuration)
                 .SetMaxCpuCount(Environment.ProcessorCount)
-                .SetNodeReuse(IsLocalBuild)
-                .SetTargetPlatform(MSBuildTargetPlatform.x64));
-
-            MSBuild(s => s
-                .SetTargetPath(Solution)
-                .SetTargets("Rebuild")
-                .SetConfiguration(Configuration)
-                .SetMaxCpuCount(Environment.ProcessorCount)
-                .SetNodeReuse(IsLocalBuild)
-                .SetTargetPlatform(MSBuildTargetPlatform.x86));
-
-            #region Ugly hack, fix me!
-
-            EnsureExistingDirectory(Path.Combine(ArtifactsDirectory, @"x64"));
-            EnsureExistingDirectory(Path.Combine(ArtifactsDirectory, @"x86"));
-
-            File.Copy(
-                Path.Combine(WorkingDirectory, @"bin\x64\ViGEmBus.inf"),
-                Path.Combine(ArtifactsDirectory, @"ViGEmBus.inf")
-            );
-
-            File.Copy(
-                Path.Combine(WorkingDirectory, @"bin\x64\ViGEmBus.pdb"),
-                Path.Combine(ArtifactsDirectory, @"x64\ViGEmBus.pdb")
-            );
-            File.Copy(
-                Path.Combine(WorkingDirectory, @"bin\x64\ViGEmBus\ViGEmBus.sys"),
-                Path.Combine(ArtifactsDirectory, @"x64\ViGEmBus.sys")
-            );
-            File.Copy(
-                Path.Combine(WorkingDirectory, @"bin\x64\ViGEmBus\WdfCoinstaller01009.dll"),
-                Path.Combine(ArtifactsDirectory, @"x64\WdfCoinstaller01009.dll")
-            );
-
-            File.Copy(
-                Path.Combine(WorkingDirectory, @"bin\x86\ViGEmBus.pdb"),
-                Path.Combine(ArtifactsDirectory, @"x86\ViGEmBus.pdb")
-            );
-            File.Copy(
-                Path.Combine(WorkingDirectory, @"bin\x86\ViGEmBus\ViGEmBus.sys"),
-                Path.Combine(ArtifactsDirectory, @"x86\ViGEmBus.sys")
-            );
-            File.Copy(
-                Path.Combine(WorkingDirectory, @"bin\x86\ViGEmBus\WdfCoinstaller01009.dll"),
-                Path.Combine(ArtifactsDirectory, @"x86\WdfCoinstaller01009.dll")
-            );
-
-            #endregion
+                .SetNodeReuse(IsLocalBuild));
         });
 
-    private Target Pack => _ => _
-        .DependsOn(Compile)
-        .Executes(() =>
-        {
-            MSBuild(s => s
-                .SetTargetPath(Solution)
-                .SetTargets("Restore", "Pack")
-                .SetPackageOutputPath(ArtifactsDirectory)
-                .SetConfiguration(Configuration)
-                .EnableIncludeSymbols());
-        });
-
-    public static int Main()
-    {
-        return Execute<Build>(x => x.Compile);
-    }
-}
+}

build/Configuration.cs

@@ -0,0 +1,16 @@
+using System;
+using System.ComponentModel;
+using System.Linq;
+using Nuke.Common.Tooling;
+
+[TypeConverter(typeof(TypeConverter<Configuration>))]
+public class Configuration : Enumeration
+{
+    public static Configuration Debug = new Configuration { Value = nameof(Debug) };
+    public static Configuration Release = new Configuration { Value = nameof(Release) };
+
+    public static implicit operator string(Configuration configuration)
+    {
+        return configuration.Value;
+    }
+}

build/_build.csproj

@@ -1,38 +1,16 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>netcoreapp2.0</TargetFramework>
-    <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
     <RootNamespace></RootNamespace>
-    <IsPackable>False</IsPackable>
     <NoWarn>CS0649;CS0169</NoWarn>
+    <NukeRootDirectory>..</NukeRootDirectory>
+    <NukeScriptDirectory>..</NukeScriptDirectory>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Nuke.Common" Version="0.9.1" />
-    <PackageReference Include="GitVersion.CommandLine" Version="3.6.5" />
-    <PackageReference Include="Vestris.ResourceLib" Version="2.0.0" />
-  </ItemGroup>
-
-  <ItemGroup>
-    <NukeMetadata Include="**\*.json" Exclude="bin\**;obj\**" />
-    <NukeExternalFiles Include="**\*.*.ext" Exclude="bin\**;obj\**" />
-    <None Remove="*.csproj.DotSettings;*.ref.*.txt" />
-    <None Remove="default.json" />
-    <NukeMetadata Remove="default.json" />
-    <EmbeddedResource Include="default.json" />
-    
-    <!-- Common build related files -->
-    <None Include="..\build.ps1" />
-    <None Include="..\build.sh" />
-    <None Include="..\.nuke" />     
-    <None Include="..\global.json" Condition="Exists('..\global.json')" />
-    <None Include="..\nuget.config" Condition="Exists('..\nuget.config')" />
-    <None Include="..\Jenkinsfile" Condition="Exists('..\Jenkinsfile')" />
-    <None Include="..\appveyor.yml" Condition="Exists('..\appveyor.yml')" />
-    <None Include="..\.travis.yml" Condition="Exists('..\.travis.yml')" />
-    <None Include="..\GitVersion.yml" Condition="Exists('..\GitVersion.yml')" />
+    <PackageReference Include="Nuke.Common" Version="6.1.1" />
   </ItemGroup>
 
 </Project>

build/_build.csproj.DotSettings

@@ -0,0 +1,27 @@
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=HeapView_002EDelegateAllocation/@EntryIndexedValue">DO_NOT_SHOW</s:String>
+	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=VariableHidesOuterVariable/@EntryIndexedValue">DO_NOT_SHOW</s:String>
+	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=ClassNeverInstantiated_002EGlobal/@EntryIndexedValue">DO_NOT_SHOW</s:String>
+	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=MemberCanBeMadeStatic_002ELocal/@EntryIndexedValue">DO_NOT_SHOW</s:String>
+	<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpCodeStyle/DEFAULT_INTERNAL_MODIFIER/@EntryValue">Implicit</s:String>
+	<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpCodeStyle/DEFAULT_PRIVATE_MODIFIER/@EntryValue">Implicit</s:String>
+	<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpCodeStyle/METHOD_OR_OPERATOR_BODY/@EntryValue">ExpressionBody</s:String>
+	<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpCodeStyle/ThisQualifier/INSTANCE_MEMBERS_QUALIFY_MEMBERS/@EntryValue">0</s:String>
+	<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/ANONYMOUS_METHOD_DECLARATION_BRACES/@EntryValue">NEXT_LINE</s:String>
+	<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/KEEP_USER_LINEBREAKS/@EntryValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/WRAP_AFTER_INVOCATION_LPAR/@EntryValue">False</s:Boolean>
+	<s:Int64 x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/MAX_ATTRIBUTE_LENGTH_FOR_SAME_LINE/@EntryValue">120</s:Int64>
+	<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/PLACE_FIELD_ATTRIBUTE_ON_SAME_LINE_EX/@EntryValue">IF_OWNER_IS_SINGLE_LINE</s:String>
+	<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/WRAP_ARGUMENTS_STYLE/@EntryValue">WRAP_IF_LONG</s:String>
+	<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/PLACE_SIMPLE_ANONYMOUSMETHOD_ON_SINGLE_LINE/@EntryValue">False</s:Boolean>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=PrivateInstanceFields/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /&gt;</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=PrivateStaticFields/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /&gt;</s:String>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpAttributeForSingleLineMethodUpgrade/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpKeepExistingMigration/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpPlaceEmbeddedOnSameLineMigration/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpRenamePlacementToArrangementMigration/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpUseContinuousIndentInsideBracesMigration/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EAddAccessorOwnerDeclarationBracesMigration/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002ECSharpPlaceAttributeOnSameLineMigration/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EMigrateBlankLinesAroundFieldToBlankLinesAroundProperty/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EMigrateThisQualifierSettings/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

build/default.json

@@ -1,10 +0,0 @@
-{
-  "Version": {
-    "CompanyName": "Benjamin Hoeglinger-Stelzer",
-    "FileDescription": "Virtual Gamepad Emulation Framework Bus Driver",
-    "InternalName": "ViGEmBus.sys",
-    "LegalCopyright": "Copyright (C) 2016-2018 Benjamin Hoeglinger-Stelzer All Rights Reserved",
-    "OriginalFilename": "ViGEmBus.sys",
-    "ProductName": "Virtual Gamepad Emulation Framework Bus Driver"
-  }
-}

drivers/README.md

@@ -0,0 +1,3 @@
+# Drivers directory
+
+Place the attestation signed driver files into the corresponding sub-directories and locally build the setup and sign it afterwards for production release.

drivers/devcon-LICENSE

@@ -0,0 +1,23 @@
+The Microsoft Public License (MS-PL)
+Copyright (c) 2015 Microsoft
+
+This license governs use of the accompanying software. If you use the software, you
+ accept this license. If you do not accept the license, do not use the software.
+
+1. Definitions
+ The terms "reproduce," "reproduction," "derivative works," and "distribution" have the
+ same meaning here as under U.S. copyright law.
+ A "contribution" is the original software, or any additions or changes to the software.
+ A "contributor" is any person that distributes its contribution under this license.
+ "Licensed patents" are a contributor's patent claims that read directly on its contribution.
+
+2. Grant of Rights
+ (A) Copyright Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free copyright license to reproduce its contribution, prepare derivative works of its contribution, and distribute its contribution or any derivative works that you create.
+ (B) Patent Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free license under its licensed patents to make, have made, use, sell, offer for sale, import, and/or otherwise dispose of its contribution in the software or derivative works of the contribution in the software.
+
+3. Conditions and Limitations
+ (A) No Trademark License- This license does not grant you rights to use any contributors' name, logo, or trademarks.
+ (B) If you bring a patent claim against any contributor over patents that you claim are infringed by the software, your patent license from such contributor to the software ends automatically.
+ (C) If you distribute any portion of the software, you must retain all copyright, patent, trademark, and attribution notices that are present in the software.
+ (D) If you distribute any portion of the software in source code form, you may do so only under this license by including a complete copy of this license with your distribution. If you distribute any portion of the software in compiled or object code form, you may only do so under a license that complies with this license.
+ (E) The software is licensed "as-is." You bear the risk of using it. The contributors give no express warranties, guarantees or conditions. You may have additional consumer rights under your local laws which this license cannot change. To the extent permitted under your local laws, the contributors exclude the implied warranties of merchantability, fitness for a particular purpose and non-infringement.

include/ViGEmBusDriver.h

@@ -1,87 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-* 
-* MIT License
-* 
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-* 
-* 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.
-*/
-
-
-// {A77BC4D5-6AF7-4E69-8DC4-6B88A6028CE6}
-// ReSharper disable once CppMissingIncludeGuard
-DEFINE_GUID(GUID_VIGEM_INTERFACE_PDO,
-    0xA77BC4D5, 0x6AF7, 0x4E69, 0x8D, 0xC4, 0x6B, 0x88, 0xA6, 0x02, 0x8C, 0xE6);
-
-// {A8BA2D1F-894F-464A-B0CE-7A0C8FD65DF1}
-DEFINE_GUID(GUID_DEVCLASS_VIGEM_RAWPDO,
-    0xA8BA2D1F, 0x894F, 0x464A, 0xB0, 0xCE, 0x7A, 0x0C, 0x8F, 0xD6, 0x5D, 0xF1);
-
-#pragma once
-
-
-//
-// Describes the current stage a PDO completed
-// 
-typedef enum _VIGEM_PDO_STAGE
-{
-    ViGEmPdoCreate,
-    ViGEmPdoPrepareHardware,
-    ViGEmPdoInitFinished
-
-} VIGEM_PDO_STAGE, *PVIGEM_PDO_STAGE;
-
-//
-// PDO stage result callback definition
-// 
-typedef
-VOID
-(*PVIGEM_BUS_PDO_STAGE_RESULT)(
-    _In_ PINTERFACE InterfaceHeader,
-    _In_ VIGEM_PDO_STAGE Stage,
-    _In_ ULONG Serial,
-    _In_ NTSTATUS Status
-    );
-
-typedef struct _VIGEM_BUS_INTERFACE {
-    // 
-    // Standard interface header, must be present
-    // 
-    INTERFACE InterfaceHeader;
-
-    //
-    // PDO stage result callback
-    // 
-    PVIGEM_BUS_PDO_STAGE_RESULT BusPdoStageResult;
-
-} VIGEM_BUS_INTERFACE, *PVIGEM_BUS_INTERFACE;
-
-#define VIGEM_BUS_INTERFACE_VERSION      1
-
-VOID FORCEINLINE BUS_PDO_REPORT_STAGE_RESULT(
-    VIGEM_BUS_INTERFACE Interface, 
-    VIGEM_PDO_STAGE Stage,
-    ULONG Serial,
-    NTSTATUS Status
-)
-{
-    (*Interface.BusPdoStageResult)(&Interface.InterfaceHeader, Stage, Serial, Status);
-}
-

sdk/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior (example):
+1. Start program '...'
+2. Click on '....'
+3. Plug in device '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**System details (please complete the following information):**
+ - OS: [e.g. Windows 10 1803]
+ - Feeder software: [e.g. VDX, DS4Windows, ...]
+ - Driver Version: [e.g. 1.14.3.0]
+
+**Additional context**
+Add any other context about the problem here.

sdk/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

sdk/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1 @@
+# TBD :smiley:

sdk/.gitignore

@@ -0,0 +1,70 @@
+################################################################################
+# This .gitignore file was automatically created by Microsoft(R) Visual Studio.
+################################################################################
+
+/.vs/ViGEmBus/v15
+/build/bin/Release
+/build/obj/Release
+/lib
+/packages
+/sys/x64/Release
+/x64/Release
+/x64/Release (dynamic)
+/x64/Release (static)
+/.tmp
+/lib/Release (static)
+/Release
+/sys/Release
+/Release (static)
+/build/bin/Debug
+/build/obj/Debug
+/bin
+/sys/x64
+/x64
+*.user
+/.vs/config
+/sys/RCa21300
+/sys/RCb21300
+/build/*.dotsettings
+/artifacts
+/.vs/ViGEmBus/DesignTimeBuild
+/build/obj
+/.vs/ViGEmClient
+/src/Release (static)
+/src/x64/Debug (static)
+/src/x64/Release (dynamic)
+/src/x64/Release (static)
+*.TMP
+/src/Debug_LIB
+/src/x64/Debug_LIB
+/x64/Debug_LIB
+/Debug_LIB
+*.aps
+/Release_LIB
+/src/Release_LIB
+/src/x64
+/src/Debug_DLL
+/src/Release_DLL
+/app/Tester/Debug
+/Debug
+/app/Tester/x64/Debug
+/app/Tester/x64/Release/Tester.tlog
+/app/Tester/x64/Release/Tester.log
+/app/Tester/x64/Release/Tester.obj
+/app/Tester/x64/Release/vc141.pdb
+/app/Tester/x64/Release/vcpkg.applocal.log
+/app/Tester/Release/Tester.tlog/CL.command.1.tlog
+/app/Tester/Release/Tester.tlog/CL.read.1.tlog
+/app/Tester/Release/Tester.tlog/CL.write.1.tlog
+/app/Tester/Release/Tester.tlog/link.command.1.tlog
+/app/Tester/Release/Tester.tlog/link.read.1.tlog
+/app/Tester/Release/Tester.tlog/link.write.1.tlog
+/app/Tester/Release/Tester.tlog/Tester.lastbuildstate
+/app/Tester/Release/Tester.tlog/Tester.write.1u.tlog
+/app/Tester/Release/Tester.Build.CppClean.log
+/app/Tester/Release/Tester.log
+/app/Tester/Release/Tester.obj
+/app/Tester/Release/vc141.pdb
+/app/Tester/Release/vcpkg.applocal.log
+/app/Tester/x64/Release/Tester.Build.CppClean.log
+/app/Tester/x64/Release

sdk/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Benjamin Höglinger-Stelzer
+
+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.

sdk/README.md

@@ -0,0 +1,194 @@
+# ViGEm Client Native SDK
+
+C/C++ developer SDK for communication with [`ViGEmBus`](https://github.com/ViGEm/ViGEmBus).
+
+[![Build status](https://ci.appveyor.com/api/projects/status/k806d3m2egjr0j56?svg=true)](https://ci.appveyor.com/project/nefarius/vigemclient) [![Discord](https://img.shields.io/discord/346756263763378176.svg)](https://discord.vigem.org)
+
+## About
+
+**TL;DR:** use this if you want to create virtual game controllers from your C/C++ application 😊
+
+The `ViGEmClient` provides a small library exposing a simple API for creating and "feeding" (periodically updating it with new input data) virtual game controllers through [`ViGEmBus`](https://github.com/ViGEm/ViGEmBus). The library takes care of discovering a compatible instance of the bus driver on the users system and abstracting away the inner workings of the emulation framework. You can use and distribute it with your project as either a static component (recommended) or a dynamic library (DLL). This library is **not** thread-safe, ensure proper synchronization in a multi-threaded environment.
+
+## How to build
+
+### Prerequisites
+
+- Visual Studio **2019** ([Community Edition](https://www.visualstudio.com/thank-you-downloading-visual-studio/?sku=Community&rel=16) is just fine)
+  - When linking statically, make sure to also link against `setupapi.lib`
+
+## Contribute
+
+### Bugs & Features
+
+Found a bug and want it fixed? Open a detailed issue on the [GitHub issue tracker](../../issues)!
+
+Have an idea for a new feature? Let's have a chat about your request on [Discord](https://discord.vigem.org) or the [community forums](https://forums.vigem.org).
+
+### Questions & Support
+
+Please respect that the GitHub issue tracker isn't a helpdesk. We offer a [Discord server](https://discord.vigem.org) and [forums](https://forums.vigem.org), where you're welcome to check out and engage in discussions!
+
+## How to use
+
+### Integration
+
+Integrating this library into your project is pretty straight-forward, there are no additional 3rd party dependencies. You can either `git submodule` or `git subtree` this repository directly into your source tree or use the provided [`vcpkg`](https://github.com/microsoft/vcpkg) package manager integration [found here](https://github.com/ViGEm/ViGEmClient.vcpkg) (recommended, can be updates with ease). The library tries to handle driver compatibility internally so static linking is recommended to avoid DLL hell 😊
+
+### API usage
+
+For a general overview of the provided types and functions [take a look at the main include file](./include/ViGEm/Client.h).
+
+Now, onwards to a practical example 😉 First, include some basic headers:
+
+```cpp
+//
+// Windows basic types 'n' fun
+//
+#define WIN32_LEAN_AND_MEAN
+#include <windows.h>
+
+//
+// Optional depending on your use case
+//
+#include <Xinput.h>
+
+//
+// The ViGEm API
+//
+#include <ViGEm/Client.h>
+
+//
+// Link against SetupAPI
+//
+#pragma comment(lib, "setupapi.lib")
+```
+
+To initialize the API call `vigem_alloc` which gives you an opaque handle to the underlying driver:
+
+```cpp
+const auto client = vigem_alloc();
+
+if (client == nullptr)
+{
+    std::cerr << "Uh, not enough memory to do that?!" << std::endl;
+    return -1;
+}
+```
+
+Establish connection to the driver:
+
+```cpp
+const auto retval = vigem_connect(client);
+
+if (!VIGEM_SUCCESS(retval))
+{
+    std::cerr << "ViGEm Bus connection failed with error code: 0x" << std::hex << retval << std::endl;
+    return -1;
+}
+```
+
+👉 Note: this is an "expensive" operation, it's recommended you do this once in your project, not every frame for performance benefits.
+
+---
+
+With this handle we're prepared to spawn (connect) and feed (supply with periodic input updates) one or many emulated controller devices. So let's spawn an Xbox 360 controller:
+
+```cpp
+//
+// Allocate handle to identify new pad
+//
+const auto pad = vigem_target_x360_alloc();
+
+//
+// Add client to the bus, this equals a plug-in event
+//
+const auto pir = vigem_target_add(client, pad);
+
+//
+// Error handling
+//
+if (!VIGEM_SUCCESS(pir))
+{
+    std::cerr << "Target plugin failed with error code: 0x" << std::hex << retval << std::endl;
+    return -1;
+}
+
+XINPUT_STATE state;
+
+//
+// Grab the input from a physical X36ß pad in this example
+//
+XInputGetState(0, &state);
+
+//
+// The XINPUT_GAMEPAD structure is identical to the XUSB_REPORT structure
+// so we can simply take it "as-is" and cast it.
+//
+// Call this function on every input state change e.g. in a loop polling
+// another joystick or network device or thermometer or... you get the idea.
+//
+vigem_target_x360_update(client, pad, *reinterpret_cast<XUSB_REPORT*>(&state.Gamepad));
+
+//
+// We're done with this pad, free resources (this disconnects the virtual device)
+//
+vigem_target_remove(client, pad);
+vigem_target_free(pad);
+```
+
+---
+
+Alright, so we got the feeding side of things done, but what about the other direction? After all, the virtual device can receive some state changes as well (for the Xbox 360 device the LED ring can change and rumble/vibration requests can arrive) and this information is of interest for us. This is achieved by defining a notification callback like so:
+
+```cpp
+//
+// Define the callback function
+//
+VOID CALLBACK notification(
+    PVIGEM_CLIENT Client,
+    PVIGEM_TARGET Target,
+    UCHAR LargeMotor,
+    UCHAR SmallMotor,
+    UCHAR LedNumber,
+    LPVOID UserData
+)
+{
+    static int count = 1;
+
+    std::cout.width(3);
+    std::cout << count++ << " ";
+    std::cout.width(3);
+    std::cout << (int)LargeMotor << " ";
+    std::cout.width(3);
+    std::cout << (int)SmallMotor << std::endl;
+}
+```
+
+Register it:
+
+```cpp
+const auto retval = vigem_target_x360_register_notification(client, pad, &notification, nullptr);
+
+//
+// Error handling
+//
+if (!VIGEM_SUCCESS(retval))
+{
+    std::cerr << "Registering for notification failed with error code: 0x" << std::hex << retval << std::endl;
+    return -1;
+}
+```
+
+The function `notification` will now get invoked every time a rumble request was sent to the virtual controller and can get handled accordingly. This is a blocking call and the invocation will take place in the order the underlying requests arrived.
+
+---
+
+Once ViGEm interaction is no longer required (e.g. the application is about to end) the acquired resources need to be freed properly:
+
+```cpp
+vigem_disconnect(client);
+vigem_free(client);
+```
+
+After that the `client` handle will become invalid and must not be used again.

sdk/ViGEmClient.sln

@@ -0,0 +1,55 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 16
+VisualStudioVersion = 16.0.29709.97
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "ViGEmClient", "src\ViGEmClient.vcxproj", "{7DB06674-1F4F-464B-8E1C-172E9587F9DC}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug_DLL|x64 = Debug_DLL|x64
+		Debug_DLL|x86 = Debug_DLL|x86
+		Debug_LIB|x64 = Debug_LIB|x64
+		Debug_LIB|x86 = Debug_LIB|x86
+		Debug|x64 = Debug|x64
+		Debug|x86 = Debug|x86
+		Release_DLL|x64 = Release_DLL|x64
+		Release_DLL|x86 = Release_DLL|x86
+		Release_LIB|x64 = Release_LIB|x64
+		Release_LIB|x86 = Release_LIB|x86
+		Release|x64 = Release|x64
+		Release|x86 = Release|x86
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug_DLL|x64.ActiveCfg = Debug_DLL|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug_DLL|x64.Build.0 = Debug_DLL|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug_DLL|x86.ActiveCfg = Debug_DLL|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug_DLL|x86.Build.0 = Debug_DLL|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug_LIB|x64.ActiveCfg = Debug_LIB|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug_LIB|x64.Build.0 = Debug_LIB|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug_LIB|x86.ActiveCfg = Debug_LIB|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug_LIB|x86.Build.0 = Debug_LIB|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug|x64.ActiveCfg = Debug_LIB|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug|x64.Build.0 = Debug_LIB|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug|x86.ActiveCfg = Debug_LIB|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Debug|x86.Build.0 = Debug_LIB|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release_DLL|x64.ActiveCfg = Release_DLL|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release_DLL|x64.Build.0 = Release_DLL|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release_DLL|x86.ActiveCfg = Release_DLL|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release_DLL|x86.Build.0 = Release_DLL|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release_LIB|x64.ActiveCfg = Release_LIB|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release_LIB|x64.Build.0 = Release_LIB|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release_LIB|x86.ActiveCfg = Release_LIB|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release_LIB|x86.Build.0 = Release_LIB|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release|x64.ActiveCfg = Release_LIB|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release|x64.Build.0 = Release_LIB|x64
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release|x86.ActiveCfg = Release_LIB|Win32
+		{7DB06674-1F4F-464B-8E1C-172E9587F9DC}.Release|x86.Build.0 = Release_LIB|Win32
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {D5CD61FD-80BB-4E0E-840C-BAF66ABB1CF0}
+	EndGlobalSection
+EndGlobal

sdk/appveyor.yml

@@ -0,0 +1,24 @@
+version: 1.17.{build}.0
+image: Visual Studio 2019
+platform:
+- x86
+- x64
+configuration:
+- Release_DLL
+install:
+- cmd: git submodule -q update --init
+before_build:
+- ps: Invoke-WebRequest "https://github.com/nefarius/vpatch/releases/latest/download/vpatch.exe" -OutFile vpatch.exe
+- cmd: vpatch.exe --stamp-version "%APPVEYOR_BUILD_VERSION%" --target-file ".\src\%APPVEYOR_PROJECT_NAME%.vcxproj" --vcxproj.inf-time-stamp
+- cmd: vpatch.exe --stamp-version "%APPVEYOR_BUILD_VERSION%" --target-file ".\src\%APPVEYOR_PROJECT_NAME%.rc" --resource.file-version --resource.product-version
+build:
+  project: $(APPVEYOR_BUILD_FOLDER)\$(APPVEYOR_PROJECT_NAME).sln
+artifacts:
+- path: 'bin**\*.lib'
+- path: 'bin**\*.dll'
+- path: 'bin**\*.pdb'
+deploy:
+- provider: Environment
+  name: BUILDBOT
+  on:
+    appveyor_repo_tag: true

sdk/include/ViGEm/Client.h

@@ -0,0 +1,456 @@
+/*
+MIT License
+
+Copyright (c) 2017-2019 Nefarius Software Solutions e.U. and Contributors
+
+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.
+*/
+
+
+#ifndef ViGEmClient_h__
+#define ViGEmClient_h__
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include "ViGEm/Common.h"
+
+#ifdef VIGEM_DYNAMIC
+#ifdef VIGEM_EXPORTS
+#define VIGEM_API __declspec(dllexport)
+#else
+#define VIGEM_API __declspec(dllimport)
+#endif
+#else
+#define VIGEM_API
+#endif
+        
+    /** Values that represent ViGEm errors */
+    typedef enum _VIGEM_ERRORS
+    {
+        VIGEM_ERROR_NONE = 0x20000000,
+        VIGEM_ERROR_BUS_NOT_FOUND = 0xE0000001,
+        VIGEM_ERROR_NO_FREE_SLOT = 0xE0000002,
+        VIGEM_ERROR_INVALID_TARGET = 0xE0000003,
+        VIGEM_ERROR_REMOVAL_FAILED = 0xE0000004,
+        VIGEM_ERROR_ALREADY_CONNECTED = 0xE0000005,
+        VIGEM_ERROR_TARGET_UNINITIALIZED = 0xE0000006,
+        VIGEM_ERROR_TARGET_NOT_PLUGGED_IN = 0xE0000007,
+        VIGEM_ERROR_BUS_VERSION_MISMATCH = 0xE0000008,
+        VIGEM_ERROR_BUS_ACCESS_FAILED = 0xE0000009,
+        VIGEM_ERROR_CALLBACK_ALREADY_REGISTERED = 0xE0000010,
+        VIGEM_ERROR_CALLBACK_NOT_FOUND = 0xE0000011,
+        VIGEM_ERROR_BUS_ALREADY_CONNECTED = 0xE0000012,
+        VIGEM_ERROR_BUS_INVALID_HANDLE = 0xE0000013,
+        VIGEM_ERROR_XUSB_USERINDEX_OUT_OF_RANGE = 0xE0000014,
+		VIGEM_ERROR_INVALID_PARAMETER = 0xE0000015,
+    	VIGEM_ERROR_NOT_SUPPORTED = 0xE0000016
+
+    } VIGEM_ERROR;
+
+/**
+ * A macro that defines if the API succeeded
+ *
+ * @author	Benjamin "Nefarius" H<>glinger-Stelzer
+ * @date	01.09.2020
+ *
+ * @param 	_val_	The error value.
+ */
+#define VIGEM_SUCCESS(_val_) (_val_ == VIGEM_ERROR_NONE)
+
+    /** Defines an alias representing a driver connection object */
+    typedef struct _VIGEM_CLIENT_T *PVIGEM_CLIENT;
+
+    /** Defines an alias representing a target device object */
+    typedef struct _VIGEM_TARGET_T *PVIGEM_TARGET;
+
+    typedef
+        _Function_class_(EVT_VIGEM_TARGET_ADD_RESULT)
+        VOID CALLBACK
+        EVT_VIGEM_TARGET_ADD_RESULT(
+            PVIGEM_CLIENT Client,
+            PVIGEM_TARGET Target,
+            VIGEM_ERROR Result
+        );
+
+    typedef EVT_VIGEM_TARGET_ADD_RESULT *PFN_VIGEM_TARGET_ADD_RESULT;
+
+    typedef
+        _Function_class_(EVT_VIGEM_X360_NOTIFICATION)
+        VOID CALLBACK
+        EVT_VIGEM_X360_NOTIFICATION(
+            PVIGEM_CLIENT Client,
+            PVIGEM_TARGET Target,
+            UCHAR LargeMotor,
+            UCHAR SmallMotor,
+            UCHAR LedNumber,
+            LPVOID UserData
+        );
+
+    typedef EVT_VIGEM_X360_NOTIFICATION *PFN_VIGEM_X360_NOTIFICATION;
+
+    typedef
+        _Function_class_(EVT_VIGEM_DS4_NOTIFICATION)
+        VOID CALLBACK
+        EVT_VIGEM_DS4_NOTIFICATION(
+            PVIGEM_CLIENT Client,
+            PVIGEM_TARGET Target,
+            UCHAR LargeMotor,
+            UCHAR SmallMotor,
+            DS4_LIGHTBAR_COLOR LightbarColor,
+            LPVOID UserData
+        );
+
+    typedef EVT_VIGEM_DS4_NOTIFICATION *PFN_VIGEM_DS4_NOTIFICATION;
+
+    /**
+     *  Allocates an object representing a driver connection
+     *
+     * @author	Benjamin "Nefarius" H<>glinger-Stelzer
+     * @date	28.08.2017
+     *
+     * @returns	A PVIGEM_CLIENT object.
+     */
+    VIGEM_API PVIGEM_CLIENT vigem_alloc(void);
+
+    /**
+     * Frees up memory used by the driver connection object
+     *
+     * @author	Benjamin "Nefarius" H<>glinger-Stelzer
+     * @date	28.08.2017
+     *
+     * @param 	vigem	The PVIGEM_CLIENT object.
+     */
+    VIGEM_API void vigem_free(PVIGEM_CLIENT vigem);
+
+    /**
+     * Initializes the driver object and establishes a connection to the emulation bus
+     *          driver. Returns an error if no compatible bus device has been found.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger-Stelzer
+     * @date	28.08.2017
+     *
+     * @param 	vigem	The PVIGEM_CLIENT object.
+     *
+     * @returns	A VIGEM_ERROR.
+     */
+    VIGEM_API VIGEM_ERROR vigem_connect(PVIGEM_CLIENT vigem);
+
+    /**
+     * Disconnects from the bus device and resets the driver object state. The driver object
+     *           may be reused again after calling this function. When called, all targets which may
+     *           still be connected will be destroyed automatically. Be aware, that allocated target
+     *           objects won't be automatically freed, this has to be taken care of by the caller.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger-Stelzer
+     * @date	28.08.2017
+     *
+     * @param 	vigem	The PVIGEM_CLIENT object.
+     */
+    VIGEM_API void vigem_disconnect(PVIGEM_CLIENT vigem);
+
+    /**
+     * Allocates an object representing an Xbox 360 Controller device.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger-Stelzer
+     * @date	28.08.2017
+     *
+     * @returns	A PVIGEM_TARGET representing an Xbox 360 Controller device.
+     */
+    VIGEM_API PVIGEM_TARGET vigem_target_x360_alloc(void);
+
+    /**
+     * Allocates an object representing a DualShock 4 Controller device.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger-Stelzer
+     * @date	28.08.2017
+     *
+     * @returns	A PVIGEM_TARGET representing a DualShock 4 Controller device.
+     */
+    VIGEM_API PVIGEM_TARGET vigem_target_ds4_alloc(void);
+
+    /**
+     * Frees up memory used by the target device object. This does not automatically remove
+     *          the associated device from the bus, if present. If the target device doesn't get
+     *          removed before this call, the device becomes orphaned until the owning process is
+     *          terminated.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger-Stelzer
+     * @date	28.08.2017
+     *
+     * @param 	target	The target device object.
+     */
+    VIGEM_API void vigem_target_free(PVIGEM_TARGET target);
+
+    /**
+     * Adds a provided target device to the bus driver, which is equal to a device plug-in
+     *          event of a physical hardware device. This function blocks until the target device is
+     *          in full operational mode.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger-Stelzer
+     * @date	28.08.2017
+     *
+     * @param 	vigem 	The driver connection object.
+     * @param 	target	The target device object.
+     *
+     * @returns	A VIGEM_ERROR.
+     */
+    VIGEM_API VIGEM_ERROR vigem_target_add(PVIGEM_CLIENT vigem, PVIGEM_TARGET target);
+
+    /**
+     * Adds a provided target device to the bus driver, which is equal to a device plug-in
+     *          event of a physical hardware device. This function immediately returns. An optional
+     *          callback may be registered which gets called on error or if the target device has
+     *          become fully operational.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger-Stelzer
+     * @date	28.08.2017
+     *
+     * @param 	vigem 	The driver connection object.
+     * @param 	target	The target device object.
+     * @param 	result	An optional function getting called when the target device becomes available.
+     *
+     * @returns	A VIGEM_ERROR.
+     */
+    VIGEM_API VIGEM_ERROR vigem_target_add_async(PVIGEM_CLIENT vigem, PVIGEM_TARGET target, PFN_VIGEM_TARGET_ADD_RESULT result);
+
+    /**
+     * Removes a provided target device from the bus driver, which is equal to a device
+     *           unplug event of a physical hardware device. The target device object may be reused
+     *           after this function is called. If this function is never called on target device
+     *           objects, they will be removed from the bus when the owning process terminates.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger
+     * @date	28.08.2017
+     *
+     * @param 	vigem 	The driver connection object.
+     * @param 	target	The target device object.
+     *
+     * @returns	A VIGEM_ERROR.
+     */
+    VIGEM_API VIGEM_ERROR vigem_target_remove(PVIGEM_CLIENT vigem, PVIGEM_TARGET target);
+
+    /**
+     * Registers a function which gets called, when LED index or vibration state changes
+     *                 occur on the provided target device. This function fails if the provided
+     *                 target device isn't fully operational or in an erroneous state.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger
+     * @date	28.08.2017
+     *
+     * @param 	vigem			The driver connection object.
+     * @param 	target			The target device object.
+     * @param 	notification	The notification callback.
+     * @param 	userData		The user data passed to the notification callback.
+     *
+     * @returns	A VIGEM_ERROR.
+     */
+    VIGEM_API VIGEM_ERROR vigem_target_x360_register_notification(PVIGEM_CLIENT vigem, PVIGEM_TARGET target, PFN_VIGEM_X360_NOTIFICATION notification, LPVOID userData);
+
+    /**
+     * Registers a function which gets called, when LightBar or vibration state changes
+     *                 occur on the provided target device. This function fails if the provided
+     *                 target device isn't fully operational or in an erroneous state.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger
+     * @date	28.08.2017
+     *
+     * @param 	vigem			The driver connection object.
+     * @param 	target			The target device object.
+     * @param 	notification	The notification callback.
+     * @param 	userData		The user data passed to the notification callback.
+     *
+     * @returns	A VIGEM_ERROR.
+     */
+    VIGEM_API VIGEM_ERROR vigem_target_ds4_register_notification(PVIGEM_CLIENT vigem, PVIGEM_TARGET target, PFN_VIGEM_DS4_NOTIFICATION notification, LPVOID userData);
+
+    /**
+     * Removes a previously registered callback function from the provided target object.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger
+     * @date	28.08.2017
+     *
+     * @param 	target	The target device object.
+     */
+    VIGEM_API void vigem_target_x360_unregister_notification(PVIGEM_TARGET target);
+
+    /**
+     * Removes a previously registered callback function from the provided target object.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger
+     * @date	28.08.2017
+     *
+     * @param 	target	The target device object.
+     */
+    VIGEM_API void vigem_target_ds4_unregister_notification(PVIGEM_TARGET target);
+
+    /**
+     * Overrides the default Vendor ID value with the provided one.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger
+     * @date	28.08.2017
+     *
+     * @param 	target	The target device object.
+     * @param 	vid   	The Vendor ID to set.
+     */
+    VIGEM_API void vigem_target_set_vid(PVIGEM_TARGET target, USHORT vid);
+
+    /**
+     * Overrides the default Product ID value with the provided one.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger
+     * @date	28.08.2017
+     *
+     * @param 	target	The target device object.
+     * @param 	pid   	The Product ID to set.
+     */
+    VIGEM_API void vigem_target_set_pid(PVIGEM_TARGET target, USHORT pid);
+
+    /**
+     * Returns the Vendor ID of the provided target device object.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger
+     * @date	28.08.2017
+     *
+     * @param 	target	The target device object.
+     *
+     * @returns	The Vendor ID.
+     */
+    VIGEM_API USHORT vigem_target_get_vid(PVIGEM_TARGET target);
+
+    /**
+     * Returns the Product ID of the provided target device object.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger
+     * @date	28.08.2017
+     *
+     * @param 	target	The target device object.
+     *
+     * @returns	The Product ID.
+     */
+    VIGEM_API USHORT vigem_target_get_pid(PVIGEM_TARGET target);
+
+    /**
+     * Sends a state report to the provided target device.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger
+     * @date	28.08.2017
+     *
+     * @param 	vigem 	The driver connection object.
+     * @param 	target	The target device object.
+     * @param 	report	The report to send to the target device.
+     *
+     * @returns	A VIGEM_ERROR.
+     */
+    VIGEM_API VIGEM_ERROR vigem_target_x360_update(PVIGEM_CLIENT vigem, PVIGEM_TARGET target, XUSB_REPORT report);
+
+    /**
+     * Sends a state report to the provided target device.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger
+     * @date	28.08.2017
+     *
+     * @param 	vigem 	The driver connection object.
+     * @param 	target	The target device object.
+     * @param 	report	The report to send to the target device.
+     *
+     * @returns	A VIGEM_ERROR.
+     */
+    VIGEM_API VIGEM_ERROR vigem_target_ds4_update(PVIGEM_CLIENT vigem, PVIGEM_TARGET target, DS4_REPORT report);
+
+    /**
+     * Sends a full size state report to the provided target device.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger-Stelzer
+     * @date	07.09.2020
+     *
+     * @param 	vigem 	The driver connection object.
+     * @param 	target	The target device object.
+     * @param 	report	The report buffer.
+     *
+     * @returns	A VIGEM_ERROR.
+     */
+    VIGEM_API VIGEM_ERROR vigem_target_ds4_update_ex(PVIGEM_CLIENT vigem, PVIGEM_TARGET target, DS4_REPORT_EX report);
+
+    /**
+     * Returns the internal index (serial number) the bus driver assigned to the provided
+     *               target device object. Note that this value is specific to the inner workings of
+     *               the bus driver, it does not reflect related values like player index or device
+     *               arrival order experienced by other APIs. It may be used to identify the target
+     *               device object for its lifetime. This value becomes invalid once the target
+     *               device is removed from the bus and may change on the next addition of the
+     *               device.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger
+     * @date	28.08.2017
+     *
+     * @param 	target	The target device object.
+     *
+     * @returns	The internally used index of the target device.
+     */
+    VIGEM_API ULONG vigem_target_get_index(PVIGEM_TARGET target);
+
+    /**
+     * Returns the type of the provided target device object.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger
+     * @date	28.08.2017
+     *
+     * @param 	target	The target device object.
+     *
+     * @returns	A VIGEM_TARGET_TYPE.
+     */
+    VIGEM_API VIGEM_TARGET_TYPE vigem_target_get_type(PVIGEM_TARGET target);
+
+    /**
+     * Returns TRUE if the provided target device object is currently attached to the bus,
+     *              FALSE otherwise.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger
+     * @date	30.08.2017
+     *
+     * @param 	target	The target device object.
+     *
+     * @returns	TRUE if device is attached to the bus, FALSE otherwise.
+     */
+    VIGEM_API BOOL vigem_target_is_attached(PVIGEM_TARGET target);
+
+    /**
+     * Returns the user index of the emulated Xenon device. This value correspondents to the
+     *                (zero-based) index number representing the player number via LED present on a
+     *                physical controller and is compatible to the dwUserIndex property of the
+     *                XInput* APIs.
+     *
+     * @author	Benjamin "Nefarius" H<>glinger
+     * @date	10.05.2018
+     *
+     * @param 	vigem 	The driver connection object.
+     * @param 	target	The target device object.
+     * @param 	index 	The (zero-based) user index of the Xenon device.
+     *
+     * @returns	A VIGEM_ERROR.
+     */
+    VIGEM_API VIGEM_ERROR vigem_target_x360_get_user_index(PVIGEM_CLIENT vigem, PVIGEM_TARGET target, PULONG index);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // ViGEmClient_h__

sdk/include/ViGEm/Common.h

@@ -0,0 +1,256 @@
+/*
+MIT License
+
+Copyright (c) 2017-2019 Nefarius Software Solutions e.U. and Contributors
+
+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.
+*/
+
+
+#pragma once
+
+//
+// Represents the desired target type for the emulated device.
+//  
+typedef enum _VIGEM_TARGET_TYPE
+{
+    // 
+    // Microsoft Xbox 360 Controller (wired)
+    // 
+    Xbox360Wired = 0,
+    //
+    // Sony DualShock 4 (wired)
+    // 
+    DualShock4Wired = 2 // NOTE: 1 skipped on purpose to maintain compatibility
+
+} VIGEM_TARGET_TYPE, *PVIGEM_TARGET_TYPE;
+
+//
+// Possible XUSB report buttons.
+// 
+typedef enum _XUSB_BUTTON
+{
+    XUSB_GAMEPAD_DPAD_UP            = 0x0001,
+    XUSB_GAMEPAD_DPAD_DOWN          = 0x0002,
+    XUSB_GAMEPAD_DPAD_LEFT          = 0x0004,
+    XUSB_GAMEPAD_DPAD_RIGHT         = 0x0008,
+    XUSB_GAMEPAD_START              = 0x0010,
+    XUSB_GAMEPAD_BACK               = 0x0020,
+    XUSB_GAMEPAD_LEFT_THUMB         = 0x0040,
+    XUSB_GAMEPAD_RIGHT_THUMB        = 0x0080,
+    XUSB_GAMEPAD_LEFT_SHOULDER      = 0x0100,
+    XUSB_GAMEPAD_RIGHT_SHOULDER     = 0x0200,
+    XUSB_GAMEPAD_GUIDE              = 0x0400,
+    XUSB_GAMEPAD_A                  = 0x1000,
+    XUSB_GAMEPAD_B                  = 0x2000,
+    XUSB_GAMEPAD_X                  = 0x4000,
+    XUSB_GAMEPAD_Y                  = 0x8000
+
+} XUSB_BUTTON, *PXUSB_BUTTON;
+
+//
+// Represents an XINPUT_GAMEPAD-compatible report structure.
+// 
+typedef struct _XUSB_REPORT
+{
+    USHORT wButtons;
+    BYTE bLeftTrigger;
+    BYTE bRightTrigger;
+    SHORT sThumbLX;
+    SHORT sThumbLY;
+    SHORT sThumbRX;
+    SHORT sThumbRY;
+
+} XUSB_REPORT, *PXUSB_REPORT;
+
+//
+// Initializes a _XUSB_REPORT structure.
+// 
+VOID FORCEINLINE XUSB_REPORT_INIT(
+    _Out_ PXUSB_REPORT Report
+)
+{
+    RtlZeroMemory(Report, sizeof(XUSB_REPORT));
+}
+
+//
+// The color value (RGB) of a DualShock 4 Lightbar
+// 
+typedef struct _DS4_LIGHTBAR_COLOR
+{
+    //
+    // Red part of the Lightbar (0-255).
+    //
+    UCHAR Red;
+
+    //
+    // Green part of the Lightbar (0-255).
+    //
+    UCHAR Green;
+
+    //
+    // Blue part of the Lightbar (0-255).
+    //
+    UCHAR Blue;
+
+} DS4_LIGHTBAR_COLOR, *PDS4_LIGHTBAR_COLOR;
+
+//
+// DualShock 4 digital buttons
+// 
+typedef enum _DS4_BUTTONS
+{
+    DS4_BUTTON_THUMB_RIGHT      = 1 << 15,
+    DS4_BUTTON_THUMB_LEFT       = 1 << 14,
+    DS4_BUTTON_OPTIONS          = 1 << 13,
+    DS4_BUTTON_SHARE            = 1 << 12,
+    DS4_BUTTON_TRIGGER_RIGHT    = 1 << 11,
+    DS4_BUTTON_TRIGGER_LEFT     = 1 << 10,
+    DS4_BUTTON_SHOULDER_RIGHT   = 1 << 9,
+    DS4_BUTTON_SHOULDER_LEFT    = 1 << 8,
+    DS4_BUTTON_TRIANGLE         = 1 << 7,
+    DS4_BUTTON_CIRCLE           = 1 << 6,
+    DS4_BUTTON_CROSS            = 1 << 5,
+    DS4_BUTTON_SQUARE           = 1 << 4
+
+} DS4_BUTTONS, *PDS4_BUTTONS;
+
+//
+// DualShock 4 special buttons
+// 
+typedef enum _DS4_SPECIAL_BUTTONS
+{
+    DS4_SPECIAL_BUTTON_PS           = 1 << 0,
+    DS4_SPECIAL_BUTTON_TOUCHPAD     = 1 << 1
+
+} DS4_SPECIAL_BUTTONS, *PDS4_SPECIAL_BUTTONS;
+
+//
+// DualShock 4 directional pad (HAT) values
+// 
+typedef enum _DS4_DPAD_DIRECTIONS
+{
+    DS4_BUTTON_DPAD_NONE        = 0x8,
+    DS4_BUTTON_DPAD_NORTHWEST   = 0x7,
+    DS4_BUTTON_DPAD_WEST        = 0x6,
+    DS4_BUTTON_DPAD_SOUTHWEST   = 0x5,
+    DS4_BUTTON_DPAD_SOUTH       = 0x4,
+    DS4_BUTTON_DPAD_SOUTHEAST   = 0x3,
+    DS4_BUTTON_DPAD_EAST        = 0x2,
+    DS4_BUTTON_DPAD_NORTHEAST   = 0x1,
+    DS4_BUTTON_DPAD_NORTH       = 0x0
+
+} DS4_DPAD_DIRECTIONS, *PDS4_DPAD_DIRECTIONS;
+
+//
+// DualShock 4 HID Input report
+// 
+typedef struct _DS4_REPORT
+{
+    BYTE bThumbLX;
+    BYTE bThumbLY;
+    BYTE bThumbRX;
+    BYTE bThumbRY;
+    USHORT wButtons;
+    BYTE bSpecial;
+    BYTE bTriggerL;
+    BYTE bTriggerR;
+
+} DS4_REPORT, *PDS4_REPORT;
+
+//
+// Sets the current state of the D-PAD on a DualShock 4 report.
+// 
+VOID FORCEINLINE DS4_SET_DPAD(
+    _Out_ PDS4_REPORT Report,
+    _In_ DS4_DPAD_DIRECTIONS Dpad
+)
+{
+    Report->wButtons &= ~0xF;
+    Report->wButtons |= (USHORT)Dpad;
+}
+
+VOID FORCEINLINE DS4_REPORT_INIT(
+    _Out_ PDS4_REPORT Report
+)
+{
+    RtlZeroMemory(Report, sizeof(DS4_REPORT));
+
+    Report->bThumbLX = 0x80;
+    Report->bThumbLY = 0x80;
+    Report->bThumbRX = 0x80;
+    Report->bThumbRY = 0x80;
+
+    DS4_SET_DPAD(Report, DS4_BUTTON_DPAD_NONE);
+}
+
+#include <pshpack1.h> // pack structs tightly
+//
+// DualShock 4 HID Touchpad structure
+//
+typedef struct _DS4_TOUCH
+{
+    BYTE bPacketCounter;    // timestamp / packet counter associated with touch event
+    BYTE bIsUpTrackingNum1; // 0 means down; active low
+                            // unique to each finger down, so for a lift and repress the value is incremented
+    BYTE bTouchData1[3];    // Two 12 bits values (for X and Y) 
+                            // middle byte holds last 4 bits of X and the starting 4 bits of Y
+    BYTE bIsUpTrackingNum2; // second touch data immediately follows data of first touch 
+    BYTE bTouchData2[3];    // resolution is 1920x942
+} DS4_TOUCH, * PDS4_TOUCH;
+
+//
+// DualShock 4 v1 complete HID Input report
+//
+typedef struct _DS4_REPORT_EX
+{
+	union
+	{
+		struct
+		{
+			BYTE bThumbLX;
+			BYTE bThumbLY;
+			BYTE bThumbRX;
+			BYTE bThumbRY;
+			USHORT wButtons;
+			BYTE bSpecial;
+			BYTE bTriggerL;
+			BYTE bTriggerR;
+			USHORT wTimestamp;
+			BYTE bBatteryLvl;
+			SHORT wGyroX;
+			SHORT wGyroY;
+			SHORT wGyroZ;
+			SHORT wAccelX;
+			SHORT wAccelY;
+			SHORT wAccelZ;
+			BYTE _bUnknown1[5];
+			BYTE bBatteryLvlSpecial;
+			// really should have a enum to show everything that this can represent (USB charging, battery level; EXT, headset, microphone connected)
+			BYTE _bUnknown2[2];
+			BYTE bTouchPacketsN; // 0x00 to 0x03 (USB max)
+			DS4_TOUCH sCurrentTouch;
+			DS4_TOUCH sPreviousTouch[2];
+		} Report;
+
+		UCHAR ReportBuffer[63];
+	};
+} DS4_REPORT_EX, *PDS4_REPORT_EX;
+
+#include <poppack.h>

sdk/include/ViGEm/Util.h

@@ -0,0 +1,50 @@
+#pragma once
+
+#include "ViGEm/Common.h"
+#include <limits.h>
+
+VOID FORCEINLINE XUSB_TO_DS4_REPORT(
+    _Out_ PXUSB_REPORT Input,
+    _Out_ PDS4_REPORT Output
+)
+{
+    if (Input->wButtons & XUSB_GAMEPAD_BACK) Output->wButtons |= DS4_BUTTON_SHARE;
+    if (Input->wButtons & XUSB_GAMEPAD_START) Output->wButtons |= DS4_BUTTON_OPTIONS;
+    if (Input->wButtons & XUSB_GAMEPAD_LEFT_THUMB) Output->wButtons |= DS4_BUTTON_THUMB_LEFT;
+    if (Input->wButtons & XUSB_GAMEPAD_RIGHT_THUMB) Output->wButtons |= DS4_BUTTON_THUMB_RIGHT;
+    if (Input->wButtons & XUSB_GAMEPAD_LEFT_SHOULDER) Output->wButtons |= DS4_BUTTON_SHOULDER_LEFT;
+    if (Input->wButtons & XUSB_GAMEPAD_RIGHT_SHOULDER) Output->wButtons |= DS4_BUTTON_SHOULDER_RIGHT;
+    if (Input->wButtons & XUSB_GAMEPAD_GUIDE) Output->bSpecial |= DS4_SPECIAL_BUTTON_PS;
+    if (Input->wButtons & XUSB_GAMEPAD_A) Output->wButtons |= DS4_BUTTON_CROSS;
+    if (Input->wButtons & XUSB_GAMEPAD_B) Output->wButtons |= DS4_BUTTON_CIRCLE;
+    if (Input->wButtons & XUSB_GAMEPAD_X) Output->wButtons |= DS4_BUTTON_SQUARE;
+    if (Input->wButtons & XUSB_GAMEPAD_Y) Output->wButtons |= DS4_BUTTON_TRIANGLE;
+
+    Output->bTriggerL = Input->bLeftTrigger;
+    Output->bTriggerR = Input->bRightTrigger;
+
+    if (Input->bLeftTrigger > 0)Output->wButtons |= DS4_BUTTON_TRIGGER_LEFT;
+    if (Input->bRightTrigger > 0)Output->wButtons |= DS4_BUTTON_TRIGGER_RIGHT;
+
+    if (Input->wButtons & XUSB_GAMEPAD_DPAD_UP) DS4_SET_DPAD(Output, DS4_BUTTON_DPAD_NORTH);
+    if (Input->wButtons & XUSB_GAMEPAD_DPAD_RIGHT) DS4_SET_DPAD(Output, DS4_BUTTON_DPAD_EAST);
+    if (Input->wButtons & XUSB_GAMEPAD_DPAD_DOWN) DS4_SET_DPAD(Output, DS4_BUTTON_DPAD_SOUTH);
+    if (Input->wButtons & XUSB_GAMEPAD_DPAD_LEFT) DS4_SET_DPAD(Output, DS4_BUTTON_DPAD_WEST);
+
+    if (Input->wButtons & XUSB_GAMEPAD_DPAD_UP
+        && Input->wButtons & XUSB_GAMEPAD_DPAD_RIGHT) DS4_SET_DPAD(Output, DS4_BUTTON_DPAD_NORTHEAST);
+    if (Input->wButtons & XUSB_GAMEPAD_DPAD_RIGHT
+        && Input->wButtons & XUSB_GAMEPAD_DPAD_DOWN) DS4_SET_DPAD(Output, DS4_BUTTON_DPAD_SOUTHEAST);
+    if (Input->wButtons & XUSB_GAMEPAD_DPAD_DOWN
+        && Input->wButtons & XUSB_GAMEPAD_DPAD_LEFT) DS4_SET_DPAD(Output, DS4_BUTTON_DPAD_SOUTHWEST);
+    if (Input->wButtons & XUSB_GAMEPAD_DPAD_LEFT
+        && Input->wButtons & XUSB_GAMEPAD_DPAD_UP) DS4_SET_DPAD(Output, DS4_BUTTON_DPAD_NORTHWEST);
+
+    Output->bThumbLX = ((Input->sThumbLX + ((USHRT_MAX / 2) + 1)) / 257);
+    Output->bThumbLY = (-(Input->sThumbLY + ((USHRT_MAX / 2) - 1)) / 257);
+    Output->bThumbLY = (Output->bThumbLY == 0) ? 0xFF : Output->bThumbLY;
+    Output->bThumbRX = ((Input->sThumbRX + ((USHRT_MAX / 2) + 1)) / 257);
+    Output->bThumbRY = (-(Input->sThumbRY + ((USHRT_MAX / 2) + 1)) / 257);
+    Output->bThumbRY = (Output->bThumbRY == 0) ? 0xFF : Output->bThumbRY;
+}
+

sdk/include/ViGEm/km/BusShared.h

@@ -0,0 +1,467 @@
+/*
+MIT License
+
+Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
+
+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.
+*/
+
+
+//
+// GUID identifying the bus device. Used by client library to detect and communicate.
+// 
+// IMPORTANT: make sure to change this value if you fork it or introduce 
+//				breaking changes!
+// 
+// {96E42B22-F5E9-42F8-B043-ED0F932F014F}
+DEFINE_GUID(GUID_DEVINTERFACE_BUSENUM_VIGEM,
+    0x96E42B22, 0xF5E9, 0x42F8, 0xB0, 0x43, 0xED, 0x0F, 0x93, 0x2F, 0x01, 0x4F);
+
+#pragma once
+
+#include "ViGEm/Common.h"
+
+//
+// Common version for user-mode library and driver compatibility
+// 
+// On initialization, the user-mode library has this number embedded
+// and sends it to the bus on its enumeration. The bus compares this
+// number to the one it was compiled with. If they match, the bus
+// access is permitted and success reported. If they mismatch, an
+// error is reported and the user-mode library skips this instance.
+// 
+#define VIGEM_COMMON_VERSION            0x0001
+
+#define FILE_DEVICE_BUSENUM             FILE_DEVICE_BUS_EXTENDER
+#define BUSENUM_IOCTL(_index_)          CTL_CODE(FILE_DEVICE_BUSENUM, _index_, METHOD_BUFFERED, FILE_READ_DATA)
+#define BUSENUM_W_IOCTL(_index_)        CTL_CODE(FILE_DEVICE_BUSENUM, _index_, METHOD_BUFFERED, FILE_WRITE_DATA)
+#define BUSENUM_R_IOCTL(_index_)        CTL_CODE(FILE_DEVICE_BUSENUM, _index_, METHOD_BUFFERED, FILE_READ_DATA)
+#define BUSENUM_RW_IOCTL(_index_)       CTL_CODE(FILE_DEVICE_BUSENUM, _index_, METHOD_BUFFERED, FILE_WRITE_DATA | FILE_READ_DATA)
+
+#define IOCTL_VIGEM_BASE 0x801
+
+// 
+// IO control codes
+// 
+#define IOCTL_VIGEM_PLUGIN_TARGET       BUSENUM_W_IOCTL (IOCTL_VIGEM_BASE + 0x000)
+#define IOCTL_VIGEM_UNPLUG_TARGET       BUSENUM_W_IOCTL (IOCTL_VIGEM_BASE + 0x001)
+#define IOCTL_VIGEM_CHECK_VERSION       BUSENUM_W_IOCTL (IOCTL_VIGEM_BASE + 0x002)
+#define IOCTL_VIGEM_WAIT_DEVICE_READY   BUSENUM_W_IOCTL (IOCTL_VIGEM_BASE + 0x003)
+
+#define IOCTL_XUSB_REQUEST_NOTIFICATION BUSENUM_RW_IOCTL(IOCTL_VIGEM_BASE + 0x200)
+#define IOCTL_XUSB_SUBMIT_REPORT        BUSENUM_W_IOCTL (IOCTL_VIGEM_BASE + 0x201)
+#define IOCTL_DS4_SUBMIT_REPORT         BUSENUM_W_IOCTL (IOCTL_VIGEM_BASE + 0x202)
+#define IOCTL_DS4_REQUEST_NOTIFICATION  BUSENUM_W_IOCTL (IOCTL_VIGEM_BASE + 0x203)
+//#define IOCTL_XGIP_SUBMIT_REPORT        BUSENUM_W_IOCTL (IOCTL_VIGEM_BASE + 0x204)
+//#define IOCTL_XGIP_SUBMIT_INTERRUPT     BUSENUM_W_IOCTL (IOCTL_VIGEM_BASE + 0x205)
+#define IOCTL_XUSB_GET_USER_INDEX       BUSENUM_RW_IOCTL(IOCTL_VIGEM_BASE + 0x206)
+
+
+//
+//  Data structure used in PlugIn and UnPlug ioctls
+//
+
+#pragma region Plugin
+
+//
+// Data structure used in IOCTL_VIGEM_PLUGIN_TARGET requests.
+// 
+typedef struct _VIGEM_PLUGIN_TARGET
+{
+    //
+    // sizeof (struct _BUSENUM_HARDWARE)
+    //
+    IN ULONG Size;
+
+    //
+    // Serial number of target device.
+    // 
+    IN ULONG SerialNo;
+
+    // 
+    // Type of the target device to emulate.
+    // 
+    VIGEM_TARGET_TYPE TargetType;
+
+    //
+    // If set, the vendor ID the emulated device is reporting
+    // 
+    USHORT VendorId;
+
+    //
+    // If set, the product ID the emulated device is reporting
+    // 
+    USHORT ProductId;
+
+} VIGEM_PLUGIN_TARGET, *PVIGEM_PLUGIN_TARGET;
+
+//
+// Initializes a VIGEM_PLUGIN_TARGET structure.
+// 
+VOID FORCEINLINE VIGEM_PLUGIN_TARGET_INIT(
+    _Out_ PVIGEM_PLUGIN_TARGET PlugIn,
+          _In_ ULONG SerialNo,
+          _In_ VIGEM_TARGET_TYPE TargetType
+)
+{
+    RtlZeroMemory(PlugIn, sizeof(VIGEM_PLUGIN_TARGET));
+
+    PlugIn->Size = sizeof(VIGEM_PLUGIN_TARGET);
+    PlugIn->SerialNo = SerialNo;
+    PlugIn->TargetType = TargetType;
+}
+
+#pragma endregion 
+
+#pragma region Unplug
+
+//
+// Data structure used in IOCTL_VIGEM_UNPLUG_TARGET requests.
+// 
+typedef struct _VIGEM_UNPLUG_TARGET
+{
+    //
+    // sizeof (struct _REMOVE_HARDWARE)
+    //
+    IN ULONG Size;
+
+    //
+    // Serial number of target device.
+    // 
+    ULONG SerialNo;
+
+} VIGEM_UNPLUG_TARGET, *PVIGEM_UNPLUG_TARGET;
+
+//
+// Initializes a VIGEM_UNPLUG_TARGET structure.
+// 
+VOID FORCEINLINE VIGEM_UNPLUG_TARGET_INIT(
+    _Out_ PVIGEM_UNPLUG_TARGET UnPlug,
+          _In_ ULONG SerialNo
+)
+{
+    RtlZeroMemory(UnPlug, sizeof(VIGEM_UNPLUG_TARGET));
+
+    UnPlug->Size = sizeof(VIGEM_UNPLUG_TARGET);
+    UnPlug->SerialNo = SerialNo;
+}
+
+#pragma endregion
+
+#pragma region Check version
+
+typedef struct _VIGEM_CHECK_VERSION
+{
+    IN ULONG Size;
+
+    IN ULONG Version;
+
+} VIGEM_CHECK_VERSION, *PVIGEM_CHECK_VERSION;
+
+VOID FORCEINLINE VIGEM_CHECK_VERSION_INIT(
+    _Out_ PVIGEM_CHECK_VERSION CheckVersion,
+    _In_ ULONG Version
+)
+{
+    RtlZeroMemory(CheckVersion, sizeof(VIGEM_CHECK_VERSION));
+
+    CheckVersion->Size = sizeof(VIGEM_CHECK_VERSION);
+    CheckVersion->Version = Version;
+}
+
+#pragma endregion
+
+#pragma region Wait device ready
+
+typedef struct _VIGEM_WAIT_DEVICE_READY
+{
+    IN ULONG Size;
+
+    IN ULONG SerialNo;
+
+} VIGEM_WAIT_DEVICE_READY, * PVIGEM_WAIT_DEVICE_READY;
+
+VOID FORCEINLINE VIGEM_WAIT_DEVICE_READY_INIT(
+    _Out_ PVIGEM_WAIT_DEVICE_READY WaitReady,
+    _In_ ULONG SerialNo
+)
+{
+    RtlZeroMemory(WaitReady, sizeof(VIGEM_WAIT_DEVICE_READY));
+
+    WaitReady->Size = sizeof(VIGEM_WAIT_DEVICE_READY);
+    WaitReady->SerialNo = SerialNo;
+}
+
+#pragma endregion 
+
+#pragma region XUSB (aka Xbox 360 device) section
+
+//
+// Data structure used in IOCTL_XUSB_REQUEST_NOTIFICATION requests.
+// 
+typedef struct _XUSB_REQUEST_NOTIFICATION
+{
+    //
+    // sizeof(struct _XUSB_REQUEST_NOTIFICATION)
+    // 
+    ULONG Size;
+
+    //
+    // Serial number of target device.
+    // 
+    ULONG SerialNo;
+
+    //
+    // Vibration intensity value of the large motor (0-255).
+    // 
+    UCHAR LargeMotor;
+
+    //
+    // Vibration intensity value of the small motor (0-255).
+    // 
+    UCHAR SmallMotor;
+
+    //
+    // Index number of the slot/LED that XUSB.sys has assigned.
+    // 
+    UCHAR LedNumber;
+
+} XUSB_REQUEST_NOTIFICATION, *PXUSB_REQUEST_NOTIFICATION;
+
+//
+// Initializes a XUSB_REQUEST_NOTIFICATION structure.
+// 
+VOID FORCEINLINE XUSB_REQUEST_NOTIFICATION_INIT(
+    _Out_ PXUSB_REQUEST_NOTIFICATION Request,
+          _In_ ULONG SerialNo
+)
+{
+    RtlZeroMemory(Request, sizeof(XUSB_REQUEST_NOTIFICATION));
+
+    Request->Size = sizeof(XUSB_REQUEST_NOTIFICATION);
+    Request->SerialNo = SerialNo;
+}
+
+//
+// Data structure used in IOCTL_XUSB_SUBMIT_REPORT requests.
+// 
+typedef struct _XUSB_SUBMIT_REPORT
+{
+    //
+    // sizeof(struct _XUSB_SUBMIT_REPORT)
+    // 
+    ULONG Size;
+
+    //
+    // Serial number of target device.
+    // 
+    ULONG SerialNo;
+
+    //
+    // Report to submit to the target device.
+    // 
+    XUSB_REPORT Report;
+
+} XUSB_SUBMIT_REPORT, *PXUSB_SUBMIT_REPORT;
+
+//
+// Initializes an XUSB report.
+// 
+VOID FORCEINLINE XUSB_SUBMIT_REPORT_INIT(
+    _Out_ PXUSB_SUBMIT_REPORT Report,
+    _In_ ULONG SerialNo
+)
+{
+    RtlZeroMemory(Report, sizeof(XUSB_SUBMIT_REPORT));
+
+    Report->Size = sizeof(XUSB_SUBMIT_REPORT);
+    Report->SerialNo = SerialNo;
+}
+
+typedef struct _XUSB_GET_USER_INDEX
+{
+    //
+    // sizeof(struct _XUSB_GET_USER_INDEX)
+    // 
+    ULONG Size;
+
+    //
+    // Serial number of target device.
+    // 
+    ULONG SerialNo;
+
+    //
+    // User index of target device.
+    // 
+    OUT ULONG UserIndex;
+
+} XUSB_GET_USER_INDEX, *PXUSB_GET_USER_INDEX;
+
+//
+// Initializes XUSB_GET_USER_INDEX structure.
+// 
+VOID FORCEINLINE XUSB_GET_USER_INDEX_INIT(
+    _Out_ PXUSB_GET_USER_INDEX GetRequest,
+    _In_ ULONG SerialNo
+)
+{
+    RtlZeroMemory(GetRequest, sizeof(XUSB_GET_USER_INDEX));
+
+    GetRequest->Size = sizeof(XUSB_GET_USER_INDEX);
+    GetRequest->SerialNo = SerialNo;
+}
+
+#pragma endregion
+
+#pragma region DualShock 4 section
+
+typedef struct _DS4_OUTPUT_REPORT
+{
+    //
+    // Vibration intensity value of the small motor (0-255).
+    // 
+    UCHAR SmallMotor;
+
+    //
+    // Vibration intensity value of the large motor (0-255).
+    // 
+    UCHAR LargeMotor;
+
+    //
+    // Color values of the Lightbar.
+    //
+    DS4_LIGHTBAR_COLOR LightbarColor;
+
+} DS4_OUTPUT_REPORT, *PDS4_OUTPUT_REPORT;
+
+//
+// Data structure used in IOCTL_DS4_REQUEST_NOTIFICATION requests.
+// 
+typedef struct _DS4_REQUEST_NOTIFICATION
+{
+    //
+    // sizeof(struct _XUSB_REQUEST_NOTIFICATION)
+    // 
+    ULONG Size;
+
+    //
+    // Serial number of target device.
+    // 
+    ULONG SerialNo;
+
+    //
+    // The HID output report
+    // 
+    DS4_OUTPUT_REPORT Report;
+
+} DS4_REQUEST_NOTIFICATION, *PDS4_REQUEST_NOTIFICATION;
+
+//
+// Initializes a DS4_REQUEST_NOTIFICATION structure.
+// 
+VOID FORCEINLINE DS4_REQUEST_NOTIFICATION_INIT(
+    _Out_ PDS4_REQUEST_NOTIFICATION Request,
+    _In_ ULONG SerialNo
+)
+{
+    RtlZeroMemory(Request, sizeof(DS4_REQUEST_NOTIFICATION));
+
+    Request->Size = sizeof(DS4_REQUEST_NOTIFICATION);
+    Request->SerialNo = SerialNo;
+}
+
+//
+// DualShock 4 request data
+// 
+typedef struct _DS4_SUBMIT_REPORT
+{
+    //
+    // sizeof(struct _DS4_SUBMIT_REPORT)
+    // 
+    ULONG Size;
+
+    //
+    // Serial number of target device.
+    // 
+    ULONG SerialNo;
+
+    //
+    // HID Input report
+    // 
+    DS4_REPORT Report;
+
+} DS4_SUBMIT_REPORT, *PDS4_SUBMIT_REPORT;
+
+//
+// Initializes a DualShock 4 report.
+// 
+VOID FORCEINLINE DS4_SUBMIT_REPORT_INIT(
+    _Out_ PDS4_SUBMIT_REPORT Report,
+    _In_ ULONG SerialNo
+)
+{
+    RtlZeroMemory(Report, sizeof(DS4_SUBMIT_REPORT));
+
+    Report->Size = sizeof(DS4_SUBMIT_REPORT);
+    Report->SerialNo = SerialNo;
+
+    DS4_REPORT_INIT(&Report->Report);
+}
+
+#include <pshpack1.h>
+
+//
+// DualShock 4 extended report request
+// 
+typedef struct _DS4_SUBMIT_REPORT_EX
+{
+    //
+     // sizeof(struct _DS4_SUBMIT_REPORT_EX)
+     // 
+    _In_ ULONG Size;
+
+    //
+    // Serial number of target device.
+    // 
+    _In_ ULONG SerialNo;
+
+    //
+    // Full size HID report excluding fixed Report ID.
+    // 
+    _In_ DS4_REPORT_EX Report;
+
+} DS4_SUBMIT_REPORT_EX, * PDS4_SUBMIT_REPORT_EX;
+
+#include <poppack.h>
+
+//
+// Initializes a DualShock 4 extended report.
+// 
+VOID FORCEINLINE DS4_SUBMIT_REPORT_EX_INIT(
+    _Out_ PDS4_SUBMIT_REPORT_EX Report,
+    _In_ ULONG SerialNo
+)
+{
+    RtlZeroMemory(Report, sizeof(DS4_SUBMIT_REPORT_EX));
+
+    Report->Size = sizeof(DS4_SUBMIT_REPORT_EX);
+    Report->SerialNo = SerialNo;
+}
+
+#pragma endregion

sdk/src/Internal.h

@@ -0,0 +1,71 @@
+/*
+MIT License
+
+Copyright (c) 2017-2019 Nefarius Software Solutions e.U. and Contributors
+
+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.
+*/
+
+
+#pragma once
+
+//
+// TODO: this is... not optimal. Improve in the future.
+// 
+#define VIGEM_TARGETS_MAX   USHRT_MAX
+
+
+//
+// Represents a driver connection object.
+// 
+typedef struct _VIGEM_CLIENT_T
+{
+    HANDLE hBusDevice;
+
+} VIGEM_CLIENT;
+
+//
+// Represents the (connection) state of a target device object.
+// 
+typedef enum _VIGEM_TARGET_STATE
+{
+    VIGEM_TARGET_NEW,
+    VIGEM_TARGET_INITIALIZED,
+    VIGEM_TARGET_CONNECTED,
+    VIGEM_TARGET_DISCONNECTED
+} VIGEM_TARGET_STATE, *PVIGEM_TARGET_STATE;
+
+
+
+//
+// Represents a virtual gamepad object.
+// 
+typedef struct _VIGEM_TARGET_T
+{
+    ULONG Size;
+    ULONG SerialNo;
+    VIGEM_TARGET_STATE State;
+    USHORT VendorId;
+    USHORT ProductId;
+    VIGEM_TARGET_TYPE Type;
+    FARPROC Notification;
+    LPVOID NotificationUserData;
+
+	HANDLE cancelNotificationThreadEvent;
+} VIGEM_TARGET;

sdk/src/README.md

@@ -0,0 +1,8 @@
+# ViGEm user-mode client library
+This static library provides the gateway to the bus drivers functionalities. It offers:
+ * Searching and connecting to a library-compatible bus device on the system
+ * Attaching and removing a (artificially limited) number of virtual devices
+ * Feeding the emulated devices (aka providing input state changes) 
+
+## Dependencies
+In addition to this library you'll need to link against `setupapi.lib`.

sdk/src/ViGEmClient.rc

@@ -0,0 +1,110 @@
+// Microsoft Visual C++ generated resource script.
+//
+#include "resource.h"
+
+#define APSTUDIO_READONLY_SYMBOLS
+/////////////////////////////////////////////////////////////////////////////
+//
+// Generated from the TEXTINCLUDE 2 resource.
+//
+#include "winres.h"
+
+/////////////////////////////////////////////////////////////////////////////
+#undef APSTUDIO_READONLY_SYMBOLS
+
+/////////////////////////////////////////////////////////////////////////////
+// English (United States) resources
+
+#if !defined(AFX_RESOURCE_DLL) || defined(AFX_TARG_ENU)
+LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US
+#pragma code_page(1252)
+
+#ifdef APSTUDIO_INVOKED
+/////////////////////////////////////////////////////////////////////////////
+//
+// TEXTINCLUDE
+//
+
+1 TEXTINCLUDE 
+BEGIN
+    "resource.h\0"
+END
+
+2 TEXTINCLUDE 
+BEGIN
+    "#include ""winres.h""\r\n"
+    "\0"
+END
+
+3 TEXTINCLUDE 
+BEGIN
+    "\r\n"
+    "\0"
+END
+
+#endif    // APSTUDIO_INVOKED
+
+#endif    // English (United States) resources
+/////////////////////////////////////////////////////////////////////////////
+
+
+/////////////////////////////////////////////////////////////////////////////
+// English (United Kingdom) resources
+
+#if !defined(AFX_RESOURCE_DLL) || defined(AFX_TARG_ENG)
+LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_UK
+#pragma code_page(1252)
+
+/////////////////////////////////////////////////////////////////////////////
+//
+// Version
+//
+
+VS_VERSION_INFO VERSIONINFO
+ FILEVERSION 1,0,0,1
+ PRODUCTVERSION 1,0,0,1
+ FILEFLAGSMASK 0x3fL
+#ifdef _DEBUG
+ FILEFLAGS 0x1L
+#else
+ FILEFLAGS 0x0L
+#endif
+ FILEOS 0x40004L
+ FILETYPE 0x2L
+ FILESUBTYPE 0x0L
+BEGIN
+    BLOCK "StringFileInfo"
+    BEGIN
+        BLOCK "080904b0"
+        BEGIN
+            VALUE "CompanyName", "Nefarius Software Solutions e.U."
+            VALUE "FileDescription", "Virtual Gamepad Emulation Framework User-Mode Library"
+            VALUE "FileVersion", "1.0.0.1"
+            VALUE "InternalName", "ViGEmClient.dll"
+            VALUE "LegalCopyright", "Copyright (C) 2017-2020 Nefarius Software Solutions e.U."
+            VALUE "OriginalFilename", "ViGEmClient.dll"
+            VALUE "ProductName", "Virtual Gamepad Emulation Framework User-Mode Library"
+            VALUE "ProductVersion", "1.0.0.1"
+        END
+    END
+    BLOCK "VarFileInfo"
+    BEGIN
+        VALUE "Translation", 0x809, 1200
+    END
+END
+
+#endif    // English (United Kingdom) resources
+/////////////////////////////////////////////////////////////////////////////
+
+
+
+#ifndef APSTUDIO_INVOKED
+/////////////////////////////////////////////////////////////////////////////
+//
+// Generated from the TEXTINCLUDE 3 resource.
+//
+
+
+/////////////////////////////////////////////////////////////////////////////
+#endif    // not APSTUDIO_INVOKED
+

sdk/src/ViGEmClient.vcxproj

@@ -0,0 +1,318 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project DefaultTargets="Build" ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <ItemGroup Label="ProjectConfigurations">
+    <ProjectConfiguration Include="Debug_DLL|Win32">
+      <Configuration>Debug_DLL</Configuration>
+      <Platform>Win32</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Debug_DLL|x64">
+      <Configuration>Debug_DLL</Configuration>
+      <Platform>x64</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Debug_LIB|Win32">
+      <Configuration>Debug_LIB</Configuration>
+      <Platform>Win32</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Release_DLL|Win32">
+      <Configuration>Release_DLL</Configuration>
+      <Platform>Win32</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Release_DLL|x64">
+      <Configuration>Release_DLL</Configuration>
+      <Platform>x64</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Release_LIB|Win32">
+      <Configuration>Release_LIB</Configuration>
+      <Platform>Win32</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Debug_LIB|x64">
+      <Configuration>Debug_LIB</Configuration>
+      <Platform>x64</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Release_LIB|x64">
+      <Configuration>Release_LIB</Configuration>
+      <Platform>x64</Platform>
+    </ProjectConfiguration>
+  </ItemGroup>
+  <PropertyGroup Label="Globals">
+    <ProjectGuid>{7DB06674-1F4F-464B-8E1C-172E9587F9DC}</ProjectGuid>
+    <Keyword>Win32Proj</Keyword>
+    <RootNamespace>ViGEmClient</RootNamespace>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(WindowsTargetPlatformVersion)'==''">
+    <!-- Latest Target Version property -->
+    <LatestTargetPlatformVersion>$([Microsoft.Build.Utilities.ToolLocationHelper]::GetLatestSDKTargetPlatformVersion('Windows', '10.0'))</LatestTargetPlatformVersion>
+    <WindowsTargetPlatformVersion Condition="'$(WindowsTargetPlatformVersion)' == ''">10.0</WindowsTargetPlatformVersion>
+    <TargetPlatformVersion>$(WindowsTargetPlatformVersion)</TargetPlatformVersion>
+  </PropertyGroup>
+  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug_LIB|Win32'" Label="Configuration">
+    <ConfigurationType>StaticLibrary</ConfigurationType>
+    <UseDebugLibraries>true</UseDebugLibraries>
+    <PlatformToolset>v142</PlatformToolset>
+    <CharacterSet>Unicode</CharacterSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug_DLL|Win32'" Label="Configuration">
+    <ConfigurationType>DynamicLibrary</ConfigurationType>
+    <UseDebugLibraries>true</UseDebugLibraries>
+    <PlatformToolset>v142</PlatformToolset>
+    <CharacterSet>Unicode</CharacterSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release_LIB|Win32'" Label="Configuration">
+    <ConfigurationType>StaticLibrary</ConfigurationType>
+    <UseDebugLibraries>false</UseDebugLibraries>
+    <PlatformToolset>v142</PlatformToolset>
+    <WholeProgramOptimization>true</WholeProgramOptimization>
+    <CharacterSet>Unicode</CharacterSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release_DLL|Win32'" Label="Configuration">
+    <ConfigurationType>DynamicLibrary</ConfigurationType>
+    <UseDebugLibraries>false</UseDebugLibraries>
+    <PlatformToolset>v142</PlatformToolset>
+    <WholeProgramOptimization>true</WholeProgramOptimization>
+    <CharacterSet>Unicode</CharacterSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug_LIB|x64'" Label="Configuration">
+    <ConfigurationType>StaticLibrary</ConfigurationType>
+    <UseDebugLibraries>true</UseDebugLibraries>
+    <PlatformToolset>v142</PlatformToolset>
+    <CharacterSet>Unicode</CharacterSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug_DLL|x64'" Label="Configuration">
+    <ConfigurationType>DynamicLibrary</ConfigurationType>
+    <UseDebugLibraries>true</UseDebugLibraries>
+    <PlatformToolset>v142</PlatformToolset>
+    <CharacterSet>Unicode</CharacterSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release_LIB|x64'" Label="Configuration">
+    <ConfigurationType>StaticLibrary</ConfigurationType>
+    <UseDebugLibraries>false</UseDebugLibraries>
+    <PlatformToolset>v142</PlatformToolset>
+    <WholeProgramOptimization>true</WholeProgramOptimization>
+    <CharacterSet>Unicode</CharacterSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release_DLL|x64'" Label="Configuration">
+    <ConfigurationType>DynamicLibrary</ConfigurationType>
+    <UseDebugLibraries>false</UseDebugLibraries>
+    <PlatformToolset>v142</PlatformToolset>
+    <WholeProgramOptimization>true</WholeProgramOptimization>
+    <CharacterSet>Unicode</CharacterSet>
+  </PropertyGroup>
+  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />
+  <ImportGroup Label="ExtensionSettings">
+  </ImportGroup>
+  <ImportGroup Label="Shared">
+  </ImportGroup>
+  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug_LIB|Win32'">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <ImportGroup Condition="'$(Configuration)|$(Platform)'=='Debug_DLL|Win32'" Label="PropertySheets">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release_LIB|Win32'">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <ImportGroup Condition="'$(Configuration)|$(Platform)'=='Release_DLL|Win32'" Label="PropertySheets">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug_LIB|x64'">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <ImportGroup Condition="'$(Configuration)|$(Platform)'=='Debug_DLL|x64'" Label="PropertySheets">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release_LIB|x64'">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <ImportGroup Condition="'$(Configuration)|$(Platform)'=='Release_DLL|x64'" Label="PropertySheets">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <PropertyGroup Label="UserMacros" />
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug_LIB|Win32'">
+    <IncludePath>$(ProjectDir)../include;$(VC_IncludePath);$(WindowsSDK_IncludePath);</IncludePath>
+    <OutDir>$(SolutionDir)lib\debug\$(PlatformShortName)\</OutDir>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug_DLL|Win32'">
+    <IncludePath>$(ProjectDir)../include;$(VC_IncludePath);$(WindowsSDK_IncludePath);</IncludePath>
+    <OutDir>$(SolutionDir)bin\debug\$(PlatformShortName)\</OutDir>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release_LIB|Win32'">
+    <IncludePath>$(ProjectDir)../include;$(VC_IncludePath);$(WindowsSDK_IncludePath);</IncludePath>
+    <OutDir>$(SolutionDir)lib\release\$(PlatformShortName)\</OutDir>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release_DLL|Win32'">
+    <IncludePath>$(ProjectDir)../include;$(VC_IncludePath);$(WindowsSDK_IncludePath);</IncludePath>
+    <OutDir>$(SolutionDir)bin\release\$(PlatformShortName)\</OutDir>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug_LIB|x64'">
+    <IncludePath>$(ProjectDir)../include;$(VC_IncludePath);$(WindowsSDK_IncludePath);</IncludePath>
+    <OutDir>$(SolutionDir)lib\debug\$(PlatformShortName)\</OutDir>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug_DLL|x64'">
+    <IncludePath>$(ProjectDir)../include;$(VC_IncludePath);$(WindowsSDK_IncludePath);</IncludePath>
+    <OutDir>$(SolutionDir)bin\debug\$(PlatformShortName)\</OutDir>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release_LIB|x64'">
+    <IncludePath>$(ProjectDir)../include;$(VC_IncludePath);$(WindowsSDK_IncludePath);</IncludePath>
+    <OutDir>$(SolutionDir)lib\release\$(PlatformShortName)\</OutDir>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release_DLL|x64'">
+    <IncludePath>$(ProjectDir)../include;$(VC_IncludePath);$(WindowsSDK_IncludePath);</IncludePath>
+    <OutDir>$(SolutionDir)bin\release\$(PlatformShortName)\</OutDir>
+  </PropertyGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug_LIB|Win32'">
+    <ClCompile>
+      <PrecompiledHeader>
+      </PrecompiledHeader>
+      <WarningLevel>Level3</WarningLevel>
+      <Optimization>Disabled</Optimization>
+      <PreprocessorDefinitions>WIN32_LEAN_AND_MEAN;WIN32;_DEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <SDLCheck>true</SDLCheck>
+      <RuntimeLibrary>MultiThreadedDebug</RuntimeLibrary>
+    </ClCompile>
+    <Link>
+      <SubSystem>Windows</SubSystem>
+    </Link>
+    <Lib>
+      <TargetMachine>MachineX86</TargetMachine>
+    </Lib>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug_DLL|Win32'">
+    <ClCompile>
+      <PrecompiledHeader>
+      </PrecompiledHeader>
+      <WarningLevel>Level3</WarningLevel>
+      <Optimization>Disabled</Optimization>
+      <PreprocessorDefinitions>WIN32_LEAN_AND_MEAN;VIGEM_DYNAMIC;VIGEM_EXPORTS;WIN32;_DEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <SDLCheck>true</SDLCheck>
+      <RuntimeLibrary>MultiThreadedDebug</RuntimeLibrary>
+    </ClCompile>
+    <Link>
+      <SubSystem>Windows</SubSystem>
+      <AdditionalDependencies>setupapi.lib;kernel32.lib;user32.lib;gdi32.lib;winspool.lib;comdlg32.lib;advapi32.lib;shell32.lib;ole32.lib;oleaut32.lib;uuid.lib;odbc32.lib;odbccp32.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug_LIB|x64'">
+    <ClCompile>
+      <PrecompiledHeader>
+      </PrecompiledHeader>
+      <WarningLevel>Level3</WarningLevel>
+      <Optimization>Disabled</Optimization>
+      <PreprocessorDefinitions>WIN32_LEAN_AND_MEAN;_DEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <SDLCheck>true</SDLCheck>
+      <RuntimeLibrary>MultiThreadedDebug</RuntimeLibrary>
+    </ClCompile>
+    <Link>
+      <SubSystem>Windows</SubSystem>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug_DLL|x64'">
+    <ClCompile>
+      <PrecompiledHeader>
+      </PrecompiledHeader>
+      <WarningLevel>Level3</WarningLevel>
+      <Optimization>Disabled</Optimization>
+      <PreprocessorDefinitions>WIN32_LEAN_AND_MEAN;VIGEM_DYNAMIC;VIGEM_EXPORTS;_DEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <SDLCheck>true</SDLCheck>
+      <RuntimeLibrary>MultiThreadedDebug</RuntimeLibrary>
+    </ClCompile>
+    <Link>
+      <SubSystem>Windows</SubSystem>
+      <AdditionalDependencies>setupapi.lib;kernel32.lib;user32.lib;gdi32.lib;winspool.lib;comdlg32.lib;advapi32.lib;shell32.lib;ole32.lib;oleaut32.lib;uuid.lib;odbc32.lib;odbccp32.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release_LIB|Win32'">
+    <ClCompile>
+      <WarningLevel>Level3</WarningLevel>
+      <PrecompiledHeader>
+      </PrecompiledHeader>
+      <Optimization>MaxSpeed</Optimization>
+      <FunctionLevelLinking>true</FunctionLevelLinking>
+      <IntrinsicFunctions>true</IntrinsicFunctions>
+      <PreprocessorDefinitions>WIN32_LEAN_AND_MEAN;WIN32;NDEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <SDLCheck>true</SDLCheck>
+      <RuntimeLibrary>MultiThreaded</RuntimeLibrary>
+    </ClCompile>
+    <Link>
+      <SubSystem>Windows</SubSystem>
+      <EnableCOMDATFolding>true</EnableCOMDATFolding>
+      <OptimizeReferences>true</OptimizeReferences>
+    </Link>
+    <Lib>
+      <TargetMachine>MachineX86</TargetMachine>
+    </Lib>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release_DLL|Win32'">
+    <ClCompile>
+      <WarningLevel>Level3</WarningLevel>
+      <PrecompiledHeader>
+      </PrecompiledHeader>
+      <Optimization>MaxSpeed</Optimization>
+      <FunctionLevelLinking>true</FunctionLevelLinking>
+      <IntrinsicFunctions>true</IntrinsicFunctions>
+      <PreprocessorDefinitions>WIN32_LEAN_AND_MEAN;VIGEM_DYNAMIC;VIGEM_EXPORTS;WIN32;NDEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <SDLCheck>true</SDLCheck>
+      <RuntimeLibrary>MultiThreaded</RuntimeLibrary>
+    </ClCompile>
+    <Link>
+      <SubSystem>Windows</SubSystem>
+      <EnableCOMDATFolding>true</EnableCOMDATFolding>
+      <OptimizeReferences>true</OptimizeReferences>
+      <AdditionalDependencies>setupapi.lib;kernel32.lib;user32.lib;gdi32.lib;winspool.lib;comdlg32.lib;advapi32.lib;shell32.lib;ole32.lib;oleaut32.lib;uuid.lib;odbc32.lib;odbccp32.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release_LIB|x64'">
+    <ClCompile>
+      <WarningLevel>Level3</WarningLevel>
+      <PrecompiledHeader>
+      </PrecompiledHeader>
+      <Optimization>MaxSpeed</Optimization>
+      <FunctionLevelLinking>true</FunctionLevelLinking>
+      <IntrinsicFunctions>true</IntrinsicFunctions>
+      <PreprocessorDefinitions>WIN32_LEAN_AND_MEAN;NDEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <SDLCheck>true</SDLCheck>
+      <RuntimeLibrary>MultiThreaded</RuntimeLibrary>
+    </ClCompile>
+    <Link>
+      <SubSystem>Windows</SubSystem>
+      <EnableCOMDATFolding>true</EnableCOMDATFolding>
+      <OptimizeReferences>true</OptimizeReferences>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release_DLL|x64'">
+    <ClCompile>
+      <WarningLevel>Level3</WarningLevel>
+      <PrecompiledHeader>
+      </PrecompiledHeader>
+      <Optimization>MaxSpeed</Optimization>
+      <FunctionLevelLinking>true</FunctionLevelLinking>
+      <IntrinsicFunctions>true</IntrinsicFunctions>
+      <PreprocessorDefinitions>WIN32_LEAN_AND_MEAN;VIGEM_DYNAMIC;VIGEM_EXPORTS;NDEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <SDLCheck>true</SDLCheck>
+      <RuntimeLibrary>MultiThreaded</RuntimeLibrary>
+    </ClCompile>
+    <Link>
+      <SubSystem>Windows</SubSystem>
+      <EnableCOMDATFolding>true</EnableCOMDATFolding>
+      <OptimizeReferences>true</OptimizeReferences>
+      <AdditionalDependencies>setupapi.lib;kernel32.lib;user32.lib;gdi32.lib;winspool.lib;comdlg32.lib;advapi32.lib;shell32.lib;ole32.lib;oleaut32.lib;uuid.lib;odbc32.lib;odbccp32.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemGroup>
+    <ClInclude Include="..\include\ViGEm\Client.h" />
+    <ClInclude Include="..\include\ViGEm\Common.h" />
+    <ClInclude Include="..\include\ViGEm\Util.h" />
+    <ClInclude Include="..\include\ViGEm\km\BusShared.h" />
+    <ClInclude Include="Internal.h" />
+    <ClInclude Include="resource.h" />
+  </ItemGroup>
+  <ItemGroup>
+    <ClCompile Include="ViGEmClient.cpp" />
+  </ItemGroup>
+  <ItemGroup>
+    <ResourceCompile Include="ViGEmClient.rc" />
+  </ItemGroup>
+  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
+  <ImportGroup Label="ExtensionTargets">
+  </ImportGroup>
+</Project>

sdk/src/ViGEmClient.vcxproj.filters

@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <ItemGroup>
+    <Filter Include="Source Files">
+      <UniqueIdentifier>{4FC737F1-C7A5-4376-A066-2A32D752A2FF}</UniqueIdentifier>
+      <Extensions>cpp;c;cc;cxx;def;odl;idl;hpj;bat;asm;asmx</Extensions>
+    </Filter>
+    <Filter Include="Header Files">
+      <UniqueIdentifier>{93995380-89BD-4b04-88EB-625FBE52EBFB}</UniqueIdentifier>
+      <Extensions>h;hh;hpp;hxx;hm;inl;inc;xsd</Extensions>
+    </Filter>
+    <Filter Include="Resource Files">
+      <UniqueIdentifier>{67DA6AB6-F800-4c08-8B7A-83BB121AAD01}</UniqueIdentifier>
+      <Extensions>rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms</Extensions>
+    </Filter>
+    <Filter Include="Header Files\ViGEm">
+      <UniqueIdentifier>{3355fb06-3745-4161-8c61-b8bca15ff8fa}</UniqueIdentifier>
+    </Filter>
+    <Filter Include="Header Files\ViGEm\km">
+      <UniqueIdentifier>{e0df94ae-e213-4f04-981d-02d6d321df28}</UniqueIdentifier>
+    </Filter>
+  </ItemGroup>
+  <ItemGroup>
+    <ClInclude Include="Internal.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+    <ClInclude Include="resource.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+    <ClInclude Include="..\include\ViGEm\km\BusShared.h">
+      <Filter>Header Files\ViGEm\km</Filter>
+    </ClInclude>
+    <ClInclude Include="..\include\ViGEm\Client.h">
+      <Filter>Header Files\ViGEm</Filter>
+    </ClInclude>
+    <ClInclude Include="..\include\ViGEm\Common.h">
+      <Filter>Header Files\ViGEm</Filter>
+    </ClInclude>
+    <ClInclude Include="..\include\ViGEm\Util.h">
+      <Filter>Header Files\ViGEm</Filter>
+    </ClInclude>
+  </ItemGroup>
+  <ItemGroup>
+    <ClCompile Include="ViGEmClient.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
+  </ItemGroup>
+  <ItemGroup>
+    <ResourceCompile Include="ViGEmClient.rc">
+      <Filter>Resource Files</Filter>
+    </ResourceCompile>
+  </ItemGroup>
+</Project>

sdk/src/resource.h

@@ -0,0 +1,14 @@
+//{{NO_DEPENDENCIES}}
+// Microsoft Visual C++ generated include file.
+// Used by ViGEmClient.rc
+
+// Next default values for new objects
+// 
+#ifdef APSTUDIO_INVOKED
+#ifndef APSTUDIO_READONLY_SYMBOLS
+#define _APS_NEXT_RESOURCE_VALUE        101
+#define _APS_NEXT_COMMAND_VALUE         40001
+#define _APS_NEXT_CONTROL_VALUE         1001
+#define _APS_NEXT_SYMED_VALUE           101
+#endif
+#endif

setup/Product.wxs

@@ -0,0 +1,155 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
+
+  <!-- https://stackoverflow.com/a/18630847 -->
+  <?if $(var.Platform) = x64 ?>
+  <?define Win64 = "yes" ?>
+  <?define PlatformProgramFilesFolder = "ProgramFiles64Folder" ?>
+  <?define ArchDir = "x64" ?>
+  <?define WixQuietExec="WixQuietExec64"?>
+  <?else ?>
+  <?define Win64 = "no" ?>
+  <?define PlatformProgramFilesFolder = "ProgramFilesFolder" ?>
+  <?define ArchDir = "x86" ?>
+  <?define WixQuietExec="WixQuietExec"?>
+  <?endif ?>
+
+  <!-- change build flow if running under CI -->
+  <?ifdef env.APPVEYOR?>
+  <?define IsCI = "yes" ?>
+  <?else ?>
+  <?define IsCI = "no" ?>
+  <?endif ?>
+
+  <!-- use driver file version for installer -->
+  <?define VERSION = "!(bind.FileVersion.ViGEmBus.sys)" ?>
+
+  <!-- basic product properties -->
+  <Product Id="*" Name="Nefarius Virtual Gamepad Emulation Bus Driver" Language="1033" Version="$(var.VERSION)"
+           Manufacturer="Nefarius Software Solutions e.U."
+           UpgradeCode="0A4A02DE-0BE3-4BF4-91F0-1EA47AD26881">
+    <Package InstallerVersion="200" Compressed="yes" InstallScope="perMachine" />
+
+    <!-- use single MSI file only -->
+    <MediaTemplate EmbedCab="yes" />
+
+    <!-- set setup icon and uninstall options -->
+    <Icon Id="ViGEm.ico" SourceFile="ViGEm.ico" />
+    <Property Id="ARPPRODUCTICON" Value="ViGEm.ico" />
+    <Property Id="ARPURLINFOABOUT" Value="https://github.com/ViGEm/ViGEmBus" />
+    <Property Id="ARPNOREPAIR" Value="yes" Secure="yes" /> 
+
+    <!-- always perform major upgrade and remove previous versions -->
+    <Property Id="PREVIOUSVERSIONSINSTALLED" Secure="yes" />
+    <Upgrade Id="0A4A02DE-0BE3-4BF4-91F0-1EA47AD26881">
+      <UpgradeVersion
+        Minimum="1.0.0.0" Maximum="$(var.VERSION)"
+        Property="PREVIOUSVERSIONSINSTALLED"
+        IncludeMinimum="yes" IncludeMaximum="no" />
+    </Upgrade>
+
+    <!-- don't allow downgrades -->
+    <MajorUpgrade DowngradeErrorMessage="A newer version of [ProductName] is already installed." />
+
+    <!-- https://stackoverflow.com/a/31991006 -->
+    <Property Id="WIN10FOUND">
+      <DirectorySearch Id="searchSystem" Path="[SystemFolder]" Depth="0">
+        <FileSearch Id="searchFile" Name="advapi32.dll" MinVersion="6.3.10000.0"/>
+      </DirectorySearch>
+    </Property>
+
+    <!-- https://stackoverflow.com/a/23061358 -->
+    <Condition Message="This application can only be installed on Windows 10.">
+      <![CDATA[Installed OR WIN10FOUND]]>
+    </Condition>
+
+    <!-- write version value to registry -->
+    <DirectoryRef Id="TARGETDIR">
+      <Component Id="RegistryEntries" Guid="85C87E47-E2C7-4684-A3FB-6F7853A86B41">
+        <RegistryKey Root="HKLM"
+                     Key="SOFTWARE\Nefarius Software Solutions e.U.\ViGEm Bus Driver">
+          <RegistryValue Type="string" Name="Version" Value="$(var.VERSION)" KeyPath="yes"/>
+        </RegistryKey>
+      </Component>
+    </DirectoryRef>
+
+    <!-- main feature are the driver files and some version registry values -->
+    <Feature Id="ProductFeature" Title="Nefarius Virtual Gamepad Emulation Bus Driver" Level="1">
+      <ComponentGroupRef Id="ProductComponents" />
+      <ComponentRef Id="RegistryEntries" />
+    </Feature>
+
+    <!-- build installation command -->
+    <CustomAction Id="DevconInstallPropertyAssign"
+                  Property="DevconInstallQuiet"
+                  Value="&quot;[INSTALLFOLDER]devcon.exe&quot; install &quot;[INSTALLFOLDER]ViGEmBus.inf&quot; Nefarius\ViGEmBus\Gen1"
+                  Execute="immediate" />
+
+    <!-- execute installation with suppressed UI -->
+    <CustomAction Id="DevconInstallQuiet" BinaryKey="WixCA" DllEntry="$(var.WixQuietExec)"
+                  Execute="deferred" Return="check" Impersonate="no" />
+
+    <!-- build removal command -->
+    <CustomAction Id="DevconRemovePropertyAssign"
+                  Property="DevconRemoveQuiet"
+                  Value="&quot;[INSTALLFOLDER]devcon.exe&quot; /r remove &quot;Nefarius\ViGEmBus\Gen1&quot;"
+                  Execute="immediate" />
+
+    <!-- execute removal with suppressed UI -->
+    <CustomAction Id="DevconRemoveQuiet" BinaryKey="WixCA" DllEntry="$(var.WixQuietExec)"
+                  Execute="deferred" Return="ignore" Impersonate="no" />
+
+    <!-- custom installation and removal actions -->
+    <InstallExecuteSequence>
+      <Custom Action="DevconInstallPropertyAssign" Before="DevconInstallQuiet">NOT Installed AND NOT REMOVE</Custom>
+      <Custom Action="DevconRemovePropertyAssign" Before="DevconRemoveQuiet">REMOVE="ALL"</Custom>
+      <Custom Action="DevconInstallQuiet" Before="InstallFinalize">NOT Installed AND NOT REMOVE</Custom>
+      <Custom Action='DevconRemoveQuiet' After='InstallInitialize'>REMOVE="ALL"</Custom>
+    </InstallExecuteSequence>
+
+    <!-- use LICENSE as EULA, not technically an EULA but for now it has to do -->
+    <WixVariable Id="WixUILicenseRtf" Value="$(var.ProjectDir)LICENSE.rtf" />
+
+    <!-- use minimalistic UI with EULA approval -->
+    <UIRef Id="WixUI_Minimal" />
+
+  </Product>
+
+  <!-- build program files directory -->
+  <Fragment>
+    <Directory Id="TARGETDIR" Name="SourceDir">
+      <Directory Id="$(var.PlatformProgramFilesFolder)">
+        <!-- the "e.U." is butchered so omitted -->
+        <Directory Id="NSS" Name="Nefarius Software Solutions">
+          <Directory Id="INSTALLFOLDER" Name="Virtual Gamepad Emulation Bus Driver" />
+        </Directory>
+      </Directory>
+    </Directory>
+  </Fragment>
+
+  <!-- include necessary files -->
+  <Fragment>
+    <ComponentGroup Id="ProductComponents" Directory="INSTALLFOLDER">
+      <Component Id="ProductComponent" Guid="9DB08B36-09FC-48F5-8BDA-2EE24687B5DF" Win64="$(var.Win64)">
+        <?if $(var.IsCI) = "no" ?>
+          <!-- local build -->
+          <File Name="ViGEmBus.sys" Source="$(var.SolutionDir)\drivers\$(var.ArchDir)\ViGEmBus.sys" />
+          <File Name="ViGEmBus.inf" Source="$(var.SolutionDir)\drivers\$(var.ArchDir)\ViGEmBus.inf" />
+          <File Name="ViGEmBus.cat" Source="$(var.SolutionDir)\drivers\$(var.ArchDir)\ViGEmBus.cat" />
+          <File Name="devcon.exe" Source="$(var.SolutionDir)\drivers\$(var.ArchDir)\devcon.exe" />
+          <File Name="devcon-LICENSE" Source="$(var.SolutionDir)\drivers\devcon-LICENSE" />
+          <File Name="LICENSE" Source="$(var.SolutionDir)\LICENSE" />
+        <?else ?>
+          <!-- CI build -->
+          <File Name="ViGEmBus.sys" Source="$(var.SolutionDir)bin\$(var.ArchDir)\ViGEmBus\ViGEmBus.sys" />
+          <File Name="ViGEmBus.inf" Source="$(var.SolutionDir)bin\$(var.ArchDir)\ViGEmBus\ViGEmBus.inf" />
+          <File Name="ViGEmBus.cat" Source="$(var.SolutionDir)bin\$(var.ArchDir)\ViGEmBus\ViGEmBus.cat" />
+          <File Name="devcon.exe" Source="$(var.SolutionDir)drivers\$(var.ArchDir)\devcon.exe" />
+          <File Name="devcon-LICENSE" Source="$(var.SolutionDir)drivers\devcon-LICENSE" />
+          <File Name="LICENSE" Source="$(var.SolutionDir)LICENSE" />
+        <?endif ?>
+      </Component>
+    </ComponentGroup>
+  </Fragment>
+</Wix>

setup/ViGEmBusSetup.wixproj

@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="4.0" DefaultTargets="Build" InitialTargets="EnsureWixToolsetInstalled" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+    <Platform Condition=" '$(Platform)' == '' ">x86</Platform>
+    <ProductVersion>3.10</ProductVersion>
+    <ProjectGuid>c722b85e-fc7d-475f-a518-c8e13ecdb201</ProjectGuid>
+    <SchemaVersion>2.0</SchemaVersion>
+    <OutputName>ViGEmBusSetup_$(Platform)</OutputName>
+    <OutputType>Package</OutputType>
+    <!-- https://stackoverflow.com/a/18630847 -->
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
+    <OutputPath>bin\$(Platform)\$(Configuration)\</OutputPath>
+    <IntermediateOutputPath>obj\$(Platform)\$(Configuration)\</IntermediateOutputPath>
+    <DefineConstants>Debug</DefineConstants>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
+    <OutputPath>$(SolutionDir)bin\$(Platform)\</OutputPath>
+    <IntermediateOutputPath>obj\$(Platform)\$(Configuration)\</IntermediateOutputPath>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' ">
+    <DefineConstants>Debug</DefineConstants>
+    <OutputPath>bin\$(Platform)\$(Configuration)\</OutputPath>
+    <IntermediateOutputPath>obj\$(Platform)\$(Configuration)\</IntermediateOutputPath>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' ">
+    <OutputPath>$(SolutionDir)bin\$(Platform)\</OutputPath>
+    <IntermediateOutputPath>obj\$(Platform)\$(Configuration)\</IntermediateOutputPath>
+  </PropertyGroup>
+  <ItemGroup>
+    <Compile Include="Product.wxs" />
+  </ItemGroup>
+  <ItemGroup>
+    <Content Include="ViGEm.ico" />
+  </ItemGroup>
+  <ItemGroup>
+    <WixExtension Include="WixUIExtension">
+      <HintPath>$(WixExtDir)\WixUIExtension.dll</HintPath>
+      <Name>WixUIExtension</Name>
+    </WixExtension>
+    <WixExtension Include="WixUtilExtension">
+      <HintPath>$(WixExtDir)\WixUtilExtension.dll</HintPath>
+      <Name>WixUtilExtension</Name>
+    </WixExtension>
+  </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\sys\ViGEmBus.vcxproj">
+      <Name>ViGEmBus</Name>
+      <Project>{040101b0-ee5c-4ef1-99ee-9f81c795c001}</Project>
+      <Private>True</Private>
+      <DoNotHarvest>True</DoNotHarvest>
+      <RefProjectOutputGroups>Binaries;Content;Satellites</RefProjectOutputGroups>
+      <RefTargetDir>INSTALLFOLDER</RefTargetDir>
+    </ProjectReference>
+  </ItemGroup>
+  <Import Project="$(WixTargetsPath)" Condition=" '$(WixTargetsPath)' != '' " />
+  <Import Project="$(MSBuildExtensionsPath32)\Microsoft\WiX\v3.x\Wix.targets" Condition=" '$(WixTargetsPath)' == '' AND Exists('$(MSBuildExtensionsPath32)\Microsoft\WiX\v3.x\Wix.targets') " />
+  <Target Name="EnsureWixToolsetInstalled" Condition=" '$(WixTargetsImported)' != 'true' ">
+    <Error Text="The WiX Toolset v3.11 (or newer) build tools must be installed to build this project. To download the WiX Toolset, see http://wixtoolset.org/releases/" />
+  </Target>
+  <!--
+	To modify your build process, add your task inside one of the targets below and uncomment it.
+	Other similar extension points exist, see Wix.targets.
+	<Target Name="BeforeBuild">
+	</Target>
+	<Target Name="AfterBuild">
+	</Target>
+	-->
+</Project>

sys/ByteArray.c

@@ -1,218 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-*
-* MIT License
-*
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-*
-* 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.
-*/
-
-
-#include "ByteArray.h"
-#include "trace.h"
-#include "bytearray.tmh"
-
-//
-// Helpers
-//
-
-ULONG_PTR align_to_page_size(ULONG_PTR val)
-{
-    return (val + (PAGE_SIZE - 1)) & -PAGE_SIZE;
-}
-
-
-//
-// Forward declarations
-//
-
-NTSTATUS IncreaseCapacityByteArray(IN PBYTE_ARRAY Array, IN ULONG NumElements);
-
-
-//
-// Implementation
-//
-
-NTSTATUS InitByteArray(IN OUT PBYTE_ARRAY Array)
-{
-    //
-    // Initialize size and default capacity
-    Array->Size = 0;
-    Array->Capacity = INITIAL_ARRAY_CAPACITY;
-
-    //
-    // Allocate memory
-    Array->Data = (UCHAR*)ExAllocatePoolWithTag(PagedPool, Array->Capacity, ARRAY_POOL_TAG);
-    if (Array->Data == NULL)
-        return STATUS_INSUFFICIENT_RESOURCES;
-
-    return STATUS_SUCCESS;
-}
-
-NTSTATUS AppendElementByteArray(IN PBYTE_ARRAY Array, IN PVOID Element)
-{
-    //
-    // Make sure there is room to expand into
-    if (((Array->Size + 1) * sizeof(UCHAR)) > Array->Capacity)
-    {
-        //
-        // Increase capacity
-        NTSTATUS status = IncreaseCapacityByteArray(Array, sizeof(UCHAR));
-        if (!NT_SUCCESS(status))
-            return status;
-    }
-
-    //
-    // Append the element and increment the size
-    RtlCopyMemory(Array->Data + (Array->Size * sizeof(UCHAR)), Element, sizeof(UCHAR));
-
-    //
-    // Increment size
-    Array->Size += 1;
-
-    return STATUS_SUCCESS;
-}
-
-NTSTATUS AppendElementsByteArray(IN PBYTE_ARRAY Array, IN PVOID Elements, IN ULONG NumElements)
-{
-    //
-    // Make sure there is room to expand into
-    if ((Array->Size + NumElements) * sizeof(UCHAR) > Array->Capacity)
-    {
-        //
-        // Increase capacity
-        NTSTATUS status = IncreaseCapacityByteArray(Array, NumElements);
-        if (!NT_SUCCESS(status))
-            return status;
-    }
-
-    //
-    // Append the elements and increase the size
-    RtlCopyMemory(Array->Data + (Array->Size * sizeof(UCHAR)), Elements, NumElements * sizeof(UCHAR));
-
-    //
-    // Increase size
-    Array->Size += NumElements;
-
-    return STATUS_SUCCESS;
-}
-
-NTSTATUS IncreaseCapacityByteArray(IN PBYTE_ARRAY Array, IN ULONG NumElements)
-{
-    UCHAR* NewData = NULL;
-
-    //
-    // Align new size to the immediate next page boundary
-    Array->Capacity = align_to_page_size((Array->Size + NumElements) * sizeof(UCHAR));
-
-    //
-    // Allocate new data with new capacity
-    NewData = (UCHAR*)ExAllocatePoolWithTag(PagedPool, Array->Capacity, ARRAY_POOL_TAG);
-    if (NewData == NULL)
-        return STATUS_INSUFFICIENT_RESOURCES;
-
-    //
-    // Copy old data over
-    RtlCopyMemory(NewData, Array->Data, Array->Size * sizeof(UCHAR));
-
-    //
-    // Free old data
-    ExFreePoolWithTag(Array->Data, ARRAY_POOL_TAG);
-
-    //
-    // Set data pointer to new allocation
-    Array->Data = NewData;
-
-    return STATUS_SUCCESS;
-}
-
-NTSTATUS GetElementByteArray(IN PBYTE_ARRAY Array, IN ULONG Index, OUT PVOID Element)
-{
-    //
-    // Check array bounds
-    if (Index >= Array->Size || (LONG)Index < 0)
-        return STATUS_ARRAY_BOUNDS_EXCEEDED;
-
-    //
-    // Copy data over
-    RtlCopyMemory(Element, Array->Data + (Index * sizeof(UCHAR)), sizeof(UCHAR));
-
-    return STATUS_SUCCESS;
-}
-
-NTSTATUS GetElementsByteArray(IN PBYTE_ARRAY Array, IN ULONG Index, OUT PVOID Elements, IN ULONG NumElements)
-{
-    //
-    // Check array bounds
-    if (Index >= Array->Size || (LONG)Index < 0)
-        return STATUS_ARRAY_BOUNDS_EXCEEDED;
-
-    //
-    // Copy data over
-    RtlCopyMemory(Elements, Array->Data + (Index * sizeof(UCHAR)), NumElements * sizeof(UCHAR));
-
-    return STATUS_SUCCESS;
-}
-
-NTSTATUS SetElementByteArray(IN PBYTE_ARRAY Array, IN ULONG Index, IN PVOID Element)
-{
-    //
-    // Check array bounds
-    if (Index >= Array->Size || (LONG)Index < 0)
-        return STATUS_ARRAY_BOUNDS_EXCEEDED;
-
-    //
-    // Copy data over
-    RtlCopyMemory(Array->Data + (Index * sizeof(UCHAR)), Element, sizeof(UCHAR));
-
-    return STATUS_SUCCESS;
-}
-
-NTSTATUS SetElementsByteArray(IN PBYTE_ARRAY Array, IN ULONG Index, IN PVOID Elements, IN ULONG NumElements)
-{
-    //
-    // Check array bounds
-    if (Index >= Array->Size || (LONG)Index < 0)
-        return STATUS_ARRAY_BOUNDS_EXCEEDED;
-
-    //
-    // Copy data over
-    RtlCopyMemory(Array->Data + (Index * sizeof(UCHAR)), Elements, NumElements * sizeof(UCHAR));
-
-    return STATUS_SUCCESS;
-}
-
-NTSTATUS FreeByteArray(IN PBYTE_ARRAY Array)
-{
-    if (Array->Data == NULL)
-        return STATUS_MEMORY_NOT_ALLOCATED;
-
-    //
-    // Free data
-    ExFreePoolWithTag(Array->Data, ARRAY_POOL_TAG);
-
-    //
-    // Null out everything
-    Array->Data = NULL;
-    Array->Size = 0;
-    Array->Capacity = 0;
-
-    return STATUS_SUCCESS;
-}

sys/ByteArray.h

@@ -1,56 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-*
-* MIT License
-*
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-*
-* 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.
-*/
-
-
-#pragma once
-
-#include <ntifs.h>
-
-#define INITIAL_ARRAY_CAPACITY PAGE_SIZE
-#define ARRAY_POOL_TAG    'arrA'
-
-typedef struct _BYTE_ARRAY
-{
-    UCHAR* Data;        //> array of data we're storing
-    ULONG_PTR Size;        //> slots used so far
-    ULONG_PTR Capacity;    //> total available memory
-} BYTE_ARRAY, *PBYTE_ARRAY;
-
-NTSTATUS InitByteArray(IN OUT PBYTE_ARRAY Array);
-
-NTSTATUS AppendElementByteArray(IN PBYTE_ARRAY Array, IN PVOID Element);
-
-NTSTATUS AppendElementsByteArray(IN PBYTE_ARRAY Array, IN PVOID Elements, IN ULONG NumElements);
-
-NTSTATUS GetElementByteArray(IN PBYTE_ARRAY Array, IN ULONG Index, OUT PVOID Element);
-
-NTSTATUS GetElementsByteArray(IN PBYTE_ARRAY Array, IN ULONG Index, OUT PVOID Elements, IN ULONG NumElements);
-
-NTSTATUS SetElementByteArray(IN PBYTE_ARRAY Array, IN ULONG Index, IN PVOID Element);
-
-NTSTATUS SetElementsByteArray(IN PBYTE_ARRAY Array, IN ULONG Index, IN PVOID Elements, IN ULONG NumElements);
-
-NTSTATUS FreeByteArray(IN PBYTE_ARRAY Array);

sys/CRTCPP.hpp

@@ -0,0 +1,166 @@
+/*
+* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
+*
+* BSD 3-Clause License
+*
+* Copyright (c) 2018-2020, Nefarius Software Solutions e.U. and Contributors
+* All rights reserved.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*
+* 1. Redistributions of source code must retain the above copyright notice, this
+*    list of conditions and the following disclaimer.
+*
+* 2. Redistributions in binary form must reproduce the above copyright notice,
+*    this list of conditions and the following disclaimer in the documentation
+*    and/or other materials provided with the distribution.
+*
+* 3. Neither the name of the copyright holder nor the names of its
+*    contributors may be used to endorse or promote products derived from
+*    this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+
+#pragma once
+
+constexpr auto cpp_pool_tag = 'EGiV';
+
+#ifdef _AMD64_
+
+void* operator new
+(
+    size_t size
+    )
+{
+    return ExAllocatePoolZero(NonPagedPoolNx, size, cpp_pool_tag);
+}
+
+void* operator new[]
+(
+    size_t size
+    )
+{
+    return ExAllocatePoolZero(NonPagedPoolNx, size, cpp_pool_tag);
+}
+
+void operator delete
+(
+    void* what
+    )
+{
+    if (what == nullptr)
+    {
+        return;
+    }
+	
+    ExFreePoolWithTag(what, cpp_pool_tag);
+}
+
+void operator delete
+(
+    void* what,
+    size_t size
+    )
+{
+    UNREFERENCED_PARAMETER(size);
+	
+    if (what == nullptr)
+    {
+        return;
+    }
+
+    ExFreePoolWithTag(what, cpp_pool_tag);
+}
+
+void operator delete[]
+(
+    void* what,
+    size_t size
+    )
+{
+    UNREFERENCED_PARAMETER(size);
+	
+    if (what == nullptr)
+    {
+        return;
+    }
+	
+    ExFreePoolWithTag(what, cpp_pool_tag);
+}
+
+#else
+
+void* __CRTDECL operator new
+(
+    size_t size
+    )
+{
+    return ExAllocatePoolZero(NonPagedPoolNx, size, cpp_pool_tag);
+}
+
+void* __CRTDECL operator new[]
+(
+    size_t size
+    )
+{
+    return ExAllocatePoolZero(NonPagedPoolNx, size, cpp_pool_tag);
+}
+
+void __CRTDECL operator delete
+(
+    void* what
+    )
+{
+    if (what == nullptr)
+    {
+        return;
+    }
+
+    ExFreePoolWithTag(what, cpp_pool_tag);
+}
+
+void __CRTDECL operator delete
+(
+    void* what,
+    size_t size
+    )
+{
+    UNREFERENCED_PARAMETER(size);
+
+    if (what == nullptr)
+    {
+        return;
+    }
+
+    ExFreePoolWithTag(what, cpp_pool_tag);
+}
+
+void __CRTDECL operator delete[]
+(
+    void* what,
+    size_t size
+    )
+{
+    UNREFERENCED_PARAMETER(size);
+
+    if (what == nullptr)
+    {
+        return;
+    }
+
+    ExFreePoolWithTag(what, cpp_pool_tag);
+}
+
+#endif

sys/Context.h

@@ -1,196 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-*
-* MIT License
-*
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-*
-* 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.
-*/
-
-
-#pragma once
-
-//
-// Used to identify children in the device list of the bus.
-// 
-typedef struct _PDO_IDENTIFICATION_DESCRIPTION
-{
-    WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER Header; // should contain this header
-
-    //
-    // Unique serial number of the device on the bus
-    // 
-    ULONG SerialNo;
-
-    // 
-    // PID of the process creating this PDO
-    // 
-    DWORD OwnerProcessId;
-
-    //
-    // Device type this PDO is emulating
-    // 
-    VIGEM_TARGET_TYPE TargetType;
-
-    //
-    // If set, the vendor ID the emulated device is reporting
-    // 
-    USHORT VendorId;
-
-    //
-    // If set, the product ID the emulated device is reporting
-    // 
-    USHORT ProductId;
-
-    //
-    // Is the current device owner another driver?
-    // 
-    BOOLEAN OwnerIsDriver;
-
-    //
-    // SessionId associated with file handle.  Used to map file handles to emulated gamepad devices
-    // 
-    LONG SessionId;
-
-} PDO_IDENTIFICATION_DESCRIPTION, *PPDO_IDENTIFICATION_DESCRIPTION;
-
-//
-// The PDO device-extension (context).
-//
-typedef struct _PDO_DEVICE_DATA
-{
-    //
-    // Unique serial number of the device on the bus
-    // 
-    ULONG SerialNo;
-
-    // 
-    // PID of the process creating this PDO
-    // 
-    DWORD OwnerProcessId;
-
-    //
-    // Device type this PDO is emulating
-    // 
-    VIGEM_TARGET_TYPE TargetType;
-
-    //
-    // If set, the vendor ID the emulated device is reporting
-    // 
-    USHORT VendorId;
-
-    //
-    // If set, the product ID the emulated device is reporting
-    // 
-    USHORT ProductId;
-
-    //
-    // Interface for PDO to FDO communication
-    // 
-    VIGEM_BUS_INTERFACE BusInterface;
-
-    //
-    // Queue for incoming data interrupt transfer
-    //
-    WDFQUEUE PendingUsbInRequests;
-
-    //
-    // Queue for inverted calls
-    //
-    WDFQUEUE PendingNotificationRequests;
-
-} PDO_DEVICE_DATA, *PPDO_DEVICE_DATA;
-
-WDF_DECLARE_CONTEXT_TYPE_WITH_NAME(PDO_DEVICE_DATA, PdoGetData)
-
-//
-// FDO (bus device) context data
-// 
-typedef struct _FDO_DEVICE_DATA
-{
-    //
-    // Counter of interface references
-    // 
-    LONG InterfaceReferenceCounter;
-
-    //
-    // Next SessionId to assign to a file handle
-    // 
-    LONG NextSessionId;
-
-    //
-    // Collection holding pending plugin requests
-    // 
-    WDFCOLLECTION PendingPluginRequests;
-
-    //
-    // Sync lock for pending request collection
-    // 
-    WDFSPINLOCK PendingPluginRequestsLock;
-
-    //
-    // Periodic timer sweeping up orphaned requests
-    // 
-    WDFTIMER PendingPluginRequestsCleanupTimer;
-
-} FDO_DEVICE_DATA, *PFDO_DEVICE_DATA;
-
-#define FDO_FIRST_SESSION_ID 100
-
-WDF_DECLARE_CONTEXT_TYPE_WITH_NAME(FDO_DEVICE_DATA, FdoGetData)
-
-// 
-// Context data associated with file objects created by user mode applications
-// 
-typedef struct _FDO_FILE_DATA
-{
-    //
-    // SessionId associated with file handle.  Used to map file handles to emulated gamepad devices
-    // 
-    LONG SessionId;
-
-} FDO_FILE_DATA, *PFDO_FILE_DATA;
-
-WDF_DECLARE_CONTEXT_TYPE_WITH_NAME(FDO_FILE_DATA, FileObjectGetData)
-
-//
-// Context data for plugin requests
-// 
-typedef struct _FDO_PLUGIN_REQUEST_DATA
-{
-    //
-    // Unique serial number of the device on the bus
-    // 
-    ULONG Serial;
-
-    //
-    // High resolution timestamp taken when this request got moved to pending state
-    // 
-    LARGE_INTEGER Timestamp;
-
-    //
-    // Performance counter system frequency taken upon fetching timestamp
-    // 
-    LARGE_INTEGER Frequency;
-
-} FDO_PLUGIN_REQUEST_DATA, *PFDO_PLUGIN_REQUEST_DATA;
-
-WDF_DECLARE_CONTEXT_TYPE_WITH_NAME(FDO_PLUGIN_REQUEST_DATA, PluginRequestGetData)
-

sys/Debugging.hpp

@@ -0,0 +1,9 @@
+//
+// Don't compile in verbose tracing on release builds
+// 
+#ifndef DBG
+#ifdef TraceDbg
+#undef TraceDbg
+#define TraceDbg(...) { /* nothing to see here :) */ };
+#endif
+#endif

sys/Driver.c

@@ -1,662 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-*
-* MIT License
-*
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-*
-* 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.
-*/
-
-
-#include "busenum.h"
-#include <wdmguid.h>
-#include "driver.tmh"
-
-#ifdef ALLOC_PRAGMA
-#pragma alloc_text (INIT, DriverEntry)
-#pragma alloc_text (PAGE, Bus_EvtDeviceAdd)
-#pragma alloc_text (PAGE, Bus_DeviceFileCreate)
-#pragma alloc_text (PAGE, Bus_FileClose)
-#pragma alloc_text (PAGE, Bus_EvtDriverContextCleanup)
-#pragma alloc_text (PAGE, Bus_PdoStageResult)
-#endif
-
-
-//
-// Driver entry routine.
-// 
-NTSTATUS DriverEntry(IN PDRIVER_OBJECT DriverObject, IN PUNICODE_STRING RegistryPath)
-{
-    WDF_DRIVER_CONFIG       config;
-    NTSTATUS                status;
-    WDFDRIVER               driver;
-    WDF_OBJECT_ATTRIBUTES   attributes;
-
-    KdPrint((DRIVERNAME "Virtual Gamepad Emulation Bus Driver [built: %s %s]\n", __DATE__, __TIME__));
-
-    //
-    // Initialize WPP Tracing
-    //
-    WPP_INIT_TRACING(DriverObject, RegistryPath);
-
-    TraceEvents(TRACE_LEVEL_INFORMATION,
-        TRACE_DRIVER,
-        "Loading Virtual Gamepad Emulation Bus Driver [built: %s %s]",
-        __DATE__, __TIME__);
-
-    //
-    // Register cleanup callback
-    // 
-    WDF_OBJECT_ATTRIBUTES_INIT(&attributes);
-    attributes.EvtCleanupCallback = Bus_EvtDriverContextCleanup;
-
-    WDF_DRIVER_CONFIG_INIT(&config, Bus_EvtDeviceAdd);
-
-    status = WdfDriverCreate(DriverObject, RegistryPath, &attributes, &config, &driver);
-
-    if (!NT_SUCCESS(status))
-    {
-        WPP_CLEANUP(DriverObject);
-        KdPrint((DRIVERNAME "WdfDriverCreate failed with status 0x%x\n", status));
-    }
-
-    return status;
-}
-
-//
-// Bus-device creation routine.
-// 
-NTSTATUS Bus_EvtDeviceAdd(IN WDFDRIVER Driver, IN PWDFDEVICE_INIT DeviceInit)
-{
-    WDF_CHILD_LIST_CONFIG       config;
-    NTSTATUS                    status;
-    WDFDEVICE                   device;
-    WDF_IO_QUEUE_CONFIG         queueConfig;
-    PNP_BUS_INFORMATION         busInfo;
-    WDFQUEUE                    queue;
-    WDF_FILEOBJECT_CONFIG       foConfig;
-    WDF_OBJECT_ATTRIBUTES       fdoAttributes;
-    WDF_OBJECT_ATTRIBUTES       fileHandleAttributes;
-    WDF_OBJECT_ATTRIBUTES       collectionAttributes;
-    WDF_OBJECT_ATTRIBUTES       timerAttributes;
-    PFDO_DEVICE_DATA            pFDOData;
-    VIGEM_BUS_INTERFACE         busInterface;
-    PINTERFACE                  interfaceHeader;
-    WDF_TIMER_CONFIG            reqTimerCfg;
-
-    UNREFERENCED_PARAMETER(Driver);
-
-    PAGED_CODE();
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Entry");
-
-    WdfDeviceInitSetDeviceType(DeviceInit, FILE_DEVICE_BUS_EXTENDER);
-    // More than one process may talk to the bus at the same time
-    WdfDeviceInitSetExclusive(DeviceInit, FALSE);
-    // Bus is power policy owner over all PDOs
-    WdfDeviceInitSetPowerPolicyOwnership(DeviceInit, TRUE);
-
-#pragma region Prepare child list
-
-    WDF_CHILD_LIST_CONFIG_INIT(&config, sizeof(PDO_IDENTIFICATION_DESCRIPTION), Bus_EvtDeviceListCreatePdo);
-
-    config.EvtChildListIdentificationDescriptionCompare = Bus_EvtChildListIdentificationDescriptionCompare;
-
-    WdfFdoInitSetDefaultChildListConfig(DeviceInit, &config, WDF_NO_OBJECT_ATTRIBUTES);
-
-#pragma endregion
-
-#pragma region Assign File Object Configuration
-
-    WDF_FILEOBJECT_CONFIG_INIT(&foConfig, Bus_DeviceFileCreate, Bus_FileClose, NULL);
-
-    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&fileHandleAttributes, FDO_FILE_DATA);
-
-    WdfDeviceInitSetFileObjectConfig(DeviceInit, &foConfig, &fileHandleAttributes);
-
-#pragma endregion
-
-#pragma region Create FDO
-
-    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&fdoAttributes, FDO_DEVICE_DATA);
-
-    status = WdfDeviceCreate(&DeviceInit, &fdoAttributes, &device);
-
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DRIVER,
-            "WdfDeviceCreate failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    pFDOData = FdoGetData(device);
-    if (pFDOData == NULL)
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DRIVER,
-            "FdoGetData failed");
-        return STATUS_UNSUCCESSFUL;
-    }
-
-    pFDOData->InterfaceReferenceCounter = 0;
-    pFDOData->NextSessionId = FDO_FIRST_SESSION_ID;
-
-#pragma endregion
-
-#pragma region Create pending requests collection & lock
-
-    WDF_OBJECT_ATTRIBUTES_INIT(&collectionAttributes);
-    collectionAttributes.ParentObject = device;
-
-    status = WdfCollectionCreate(&collectionAttributes, &pFDOData->PendingPluginRequests);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DRIVER,
-            "WdfCollectionCreate failed with status %!STATUS!",
-            status);
-        return STATUS_UNSUCCESSFUL;
-    }
-
-    WDF_OBJECT_ATTRIBUTES_INIT(&collectionAttributes);
-    collectionAttributes.ParentObject = device;
-
-    status = WdfSpinLockCreate(&collectionAttributes, &pFDOData->PendingPluginRequestsLock);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DRIVER,
-            "WdfSpinLockCreate failed with status %!STATUS!",
-            status);
-        return STATUS_UNSUCCESSFUL;
-    }
-
-#pragma endregion
-
-#pragma region Create timer for sweeping up orphaned requests
-
-    WDF_TIMER_CONFIG_INIT_PERIODIC(
-        &reqTimerCfg,
-        Bus_PlugInRequestCleanUpEvtTimerFunc,
-        ORC_TIMER_START_DELAY
-    );
-    WDF_OBJECT_ATTRIBUTES_INIT(&timerAttributes);
-    timerAttributes.ParentObject = device;
-
-    status = WdfTimerCreate(&reqTimerCfg, &timerAttributes, &pFDOData->PendingPluginRequestsCleanupTimer);
-    if (!NT_SUCCESS(status)) {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DRIVER,
-            "WdfTimerCreate failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-#pragma endregion
-
-#pragma region Add query interface
-
-    // 
-    // Set up the common interface header
-    // 
-    interfaceHeader = &busInterface.InterfaceHeader;
-
-    interfaceHeader->Size = sizeof(VIGEM_BUS_INTERFACE);
-    interfaceHeader->Version = VIGEM_BUS_INTERFACE_VERSION;
-    interfaceHeader->Context = (PVOID)device;
-
-    // 
-    // We don't pay any particular attention to the reference
-    // counting of this interface, but we MUST specify routines for
-    // it. Luckily the framework provides dummy routines
-    // 
-    interfaceHeader->InterfaceReference = WdfDeviceInterfaceReferenceNoOp;
-    interfaceHeader->InterfaceDereference = WdfDeviceInterfaceDereferenceNoOp;
-
-    busInterface.BusPdoStageResult = Bus_PdoStageResult;
-
-    WDF_QUERY_INTERFACE_CONFIG queryInterfaceConfig;
-
-    WDF_QUERY_INTERFACE_CONFIG_INIT(&queryInterfaceConfig,
-        interfaceHeader,
-        &GUID_VIGEM_INTERFACE_PDO,
-        WDF_NO_EVENT_CALLBACK);
-
-    status = WdfDeviceAddQueryInterface(device,
-        &queryInterfaceConfig);
-
-    if (!NT_SUCCESS(status)) {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DRIVER,
-            "WdfDeviceAddQueryInterface failed with status %!STATUS!",
-            status);
-        return(status);
-    }
-
-#pragma endregion
-
-#pragma region Create default I/O queue for FDO
-
-    WDF_IO_QUEUE_CONFIG_INIT_DEFAULT_QUEUE(&queueConfig, WdfIoQueueDispatchParallel);
-
-    queueConfig.EvtIoDeviceControl = Bus_EvtIoDeviceControl;
-    queueConfig.EvtIoInternalDeviceControl = Bus_EvtIoInternalDeviceControl;
-    queueConfig.EvtIoDefault = Bus_EvtIoDefault;
-
-    __analysis_assume(queueConfig.EvtIoStop != 0);
-    status = WdfIoQueueCreate(device, &queueConfig, WDF_NO_OBJECT_ATTRIBUTES, &queue);
-    __analysis_assume(queueConfig.EvtIoStop == 0);
-
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DRIVER,
-            "WdfIoQueueCreate failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-#pragma endregion
-
-#pragma region Expose FDO interface
-
-    status = WdfDeviceCreateDeviceInterface(device, &GUID_DEVINTERFACE_BUSENUM_VIGEM, NULL);
-
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DRIVER,
-            "WdfDeviceCreateDeviceInterface failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-#pragma endregion
-
-#pragma region Set bus information
-
-    busInfo.BusTypeGuid = GUID_BUS_TYPE_USB;
-    busInfo.LegacyBusType = PNPBus;
-    busInfo.BusNumber = 0;
-
-    WdfDeviceSetBusInformationForChildren(device, &busInfo);
-
-#pragma endregion
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Exit with status %!STATUS!", status);
-
-    return status;
-}
-
-// Gets called when the user-land process (or kernel driver) exits or closes the handle,
-// and all IO has completed.
-// 
-_Use_decl_annotations_
-VOID
-Bus_DeviceFileCreate(
-    _In_ WDFDEVICE     Device,
-    _In_ WDFREQUEST    Request,
-    _In_ WDFFILEOBJECT FileObject
-)
-{
-    NTSTATUS         status = STATUS_INVALID_PARAMETER;
-    PFDO_FILE_DATA   pFileData = NULL;
-    PFDO_DEVICE_DATA pFDOData = NULL;
-    LONG             refCount = 0;
-    LONG             sessionId = 0;
-
-    UNREFERENCED_PARAMETER(Request);
-
-    PAGED_CODE();
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Entry");
-
-    pFileData = FileObjectGetData(FileObject);
-
-    if (pFileData == NULL)
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DRIVER,
-            "FileObjectGetData failed to return file object from WDFFILEOBJECT 0x%p",
-            FileObject);
-    }
-    else
-    {
-        pFDOData = FdoGetData(Device);
-        if (pFDOData == NULL)
-        {
-            TraceEvents(TRACE_LEVEL_ERROR,
-                TRACE_DRIVER,
-                "FdoGetData failed");
-            status = STATUS_NO_SUCH_DEVICE;
-        }
-        else
-        {
-            refCount = InterlockedIncrement(&pFDOData->InterfaceReferenceCounter);
-            sessionId = InterlockedIncrement(&pFDOData->NextSessionId);
-
-            pFileData->SessionId = sessionId;
-            status = STATUS_SUCCESS;
-
-            TraceEvents(TRACE_LEVEL_INFORMATION,
-                TRACE_DRIVER,
-                "File/session id = %d, device ref. count = %d",
-                (int)sessionId, (int)refCount);
-        }
-    }
-
-    WdfRequestComplete(Request, status);
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Exit with status %!STATUS!", status);
-}
-
-//
-// Gets called when the user-land process (or kernel driver) exits or closes the handle.
-// 
-_Use_decl_annotations_
-VOID
-Bus_FileClose(
-    WDFFILEOBJECT FileObject
-)
-{
-    WDFDEVICE                      device;
-    WDFDEVICE                      hChild;
-    NTSTATUS                       status;
-    WDFCHILDLIST                   list;
-    WDF_CHILD_LIST_ITERATOR        iterator;
-    WDF_CHILD_RETRIEVE_INFO        childInfo;
-    PDO_IDENTIFICATION_DESCRIPTION description;
-    PFDO_FILE_DATA                 pFileData = NULL;
-    PFDO_DEVICE_DATA               pFDOData = NULL;
-    LONG                           refCount = 0;
-
-    PAGED_CODE();
-
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Entry");
-
-    // Check common context
-    pFileData = FileObjectGetData(FileObject);
-    if (pFileData == NULL)
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DRIVER,
-            "FileObjectGetData failed to return file object from WDFFILEOBJECT 0x%p",
-            FileObject);
-        return;
-    }
-
-    device = WdfFileObjectGetDevice(FileObject);
-
-    pFDOData = FdoGetData(device);
-    if (pFDOData == NULL)
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DRIVER,
-            "FdoGetData failed");
-        status = STATUS_NO_SUCH_DEVICE;
-    }
-    else
-    {
-        refCount = InterlockedDecrement(&pFDOData->InterfaceReferenceCounter);
-
-        TraceEvents(TRACE_LEVEL_INFORMATION,
-            TRACE_DRIVER,
-            "Device ref. count = %d",
-            (int)refCount);
-    }
-
-    list = WdfFdoGetDefaultChildList(device);
-
-    WDF_CHILD_LIST_ITERATOR_INIT(&iterator, WdfRetrievePresentChildren);
-
-    WdfChildListBeginIteration(list, &iterator);
-
-    for (;;)
-    {
-        WDF_CHILD_RETRIEVE_INFO_INIT(&childInfo, &description.Header);
-        WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT(&description.Header, sizeof(description));
-
-        status = WdfChildListRetrieveNextDevice(list, &iterator, &hChild, &childInfo);
-        if (!NT_SUCCESS(status) || status == STATUS_NO_MORE_ENTRIES)
-        {
-            break;
-        }
-
-        TraceEvents(TRACE_LEVEL_VERBOSE,
-            TRACE_DRIVER,
-            "PDO properties: status = %!STATUS!, pdoPID = %d, curPID = %d, pdoSID = %d, curSID = %d, internal = %d",
-            (int)childInfo.Status,
-            (int)description.OwnerProcessId,
-            (int)CURRENT_PROCESS_ID(),
-            (int)description.SessionId,
-            (int)pFileData->SessionId,
-            (int)description.OwnerIsDriver
-        );
-
-        // Only unplug devices with matching session id
-        if (childInfo.Status == WdfChildListRetrieveDeviceSuccess
-            && description.SessionId == pFileData->SessionId
-            && !description.OwnerIsDriver)
-        {
-            TraceEvents(TRACE_LEVEL_INFORMATION,
-                TRACE_DRIVER,
-                "Unplugging device with serial %d",
-                description.SerialNo);
-
-            // "Unplug" child
-            status = WdfChildListUpdateChildDescriptionAsMissing(list, &description.Header);
-            if (!NT_SUCCESS(status))
-            {
-                TraceEvents(TRACE_LEVEL_ERROR,
-                    TRACE_DRIVER,
-                    "WdfChildListUpdateChildDescriptionAsMissing failed with status %!STATUS!",
-                    status);
-            }
-        }
-    }
-
-    WdfChildListEndIteration(list, &iterator);
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Exit with status %!STATUS!", status);
-}
-
-VOID
-Bus_EvtDriverContextCleanup(
-    _In_ WDFOBJECT DriverObject
-)
-/*++
-Routine Description:
-
-    Free all the resources allocated in DriverEntry.
-
-Arguments:
-
-    DriverObject - handle to a WDF Driver object.
-
-Return Value:
-
-    VOID.
-
---*/
-{
-    UNREFERENCED_PARAMETER(DriverObject);
-
-    PAGED_CODE();
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Entry");
-
-    //
-    // Stop WPP Tracing
-    //
-    WPP_CLEANUP(WdfDriverWdmGetDriverObject((WDFDRIVER)DriverObject));
-
-}
-
-//
-// Called by PDO when a boot-up stage has been completed
-// 
-_Use_decl_annotations_
-VOID
-Bus_PdoStageResult(
-    _In_ PINTERFACE InterfaceHeader,
-    _In_ VIGEM_PDO_STAGE Stage,
-    _In_ ULONG Serial,
-    _In_ NTSTATUS Status
-)
-{
-    ULONG               i;
-    PFDO_DEVICE_DATA    pFdoData;
-    WDFREQUEST          curRequest;
-    ULONG               curSerial;
-    ULONG               items;
-
-    UNREFERENCED_PARAMETER(InterfaceHeader);
-
-    PAGED_CODE();
-
-    TraceEvents(TRACE_LEVEL_INFORMATION,
-        TRACE_DRIVER,
-        "%!FUNC! Entry (stage = %d, serial = %d, status = %!STATUS!)",
-        Stage, Serial, Status);
-
-    pFdoData = FdoGetData(InterfaceHeader->Context);
-
-    //
-    // If any stage fails or is last stage, get associated request and complete it
-    // 
-    if (!NT_SUCCESS(Status) || Stage == ViGEmPdoInitFinished)
-    {
-        WdfSpinLockAcquire(pFdoData->PendingPluginRequestsLock);
-
-        items = WdfCollectionGetCount(pFdoData->PendingPluginRequests);
-
-        TraceEvents(TRACE_LEVEL_INFORMATION,
-            TRACE_DRIVER,
-            "Items count: %d",
-            items);
-
-        for (i = 0; i < items; i++)
-        {
-            curRequest = WdfCollectionGetItem(pFdoData->PendingPluginRequests, i);
-            curSerial = PluginRequestGetData(curRequest)->Serial;
-
-            TraceEvents(TRACE_LEVEL_INFORMATION,
-                TRACE_DRIVER,
-                "Serial: %d, curSerial: %d",
-                Serial, curSerial);
-
-            if (Serial == curSerial)
-            {
-                WdfRequestComplete(curRequest, Status);
-
-                WdfCollectionRemove(pFdoData->PendingPluginRequests, curRequest);
-
-                TraceEvents(TRACE_LEVEL_INFORMATION,
-                    TRACE_DRIVER,
-                    "Removed item with serial: %d",
-                    curSerial);
-
-                break;
-            }
-        }
-        WdfSpinLockRelease(pFdoData->PendingPluginRequestsLock);
-    }
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Exit");
-}
-
-_Use_decl_annotations_
-VOID
-Bus_PlugInRequestCleanUpEvtTimerFunc(
-    WDFTIMER  Timer
-)
-{
-    ULONG                       i;
-    PFDO_DEVICE_DATA            pFdoData;
-    WDFREQUEST                  curRequest;
-    ULONG                       items;
-    WDFDEVICE                   device;
-    PFDO_PLUGIN_REQUEST_DATA    pPluginData;
-    LONGLONG                    freq;
-    LARGE_INTEGER               pcNow;
-    LONGLONG                    ellapsed;
-
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Entry");
-
-    device = WdfTimerGetParentObject(Timer);
-    pFdoData = FdoGetData(device);
-
-    WdfSpinLockAcquire(pFdoData->PendingPluginRequestsLock);
-
-    items = WdfCollectionGetCount(pFdoData->PendingPluginRequests);
-
-    TraceEvents(TRACE_LEVEL_INFORMATION,
-        TRACE_DRIVER,
-        "Items count: %d",
-        items);
-
-    //
-    // Collection is empty; no need to keep timer running
-    // 
-    if (items == 0)
-    {
-        TraceEvents(TRACE_LEVEL_VERBOSE,
-            TRACE_DRIVER,
-            "Collection is empty, stopping periodic timer");
-        WdfTimerStop(Timer, FALSE);
-    }
-
-    for (i = 0; i < items; i++)
-    {
-        curRequest = WdfCollectionGetItem(pFdoData->PendingPluginRequests, i);
-        pPluginData = PluginRequestGetData(curRequest);
-
-        freq = pPluginData->Frequency.QuadPart / ORC_PC_FREQUENCY_DIVIDER;
-        pcNow = KeQueryPerformanceCounter(NULL);
-        ellapsed = (pcNow.QuadPart - pPluginData->Timestamp.QuadPart) / freq;
-
-        TraceEvents(TRACE_LEVEL_VERBOSE,
-            TRACE_DRIVER,
-            "PDO (serial = %d) plugin request age: %llu ms",
-            pPluginData->Serial, ellapsed);
-
-        if (ellapsed >= ORC_REQUEST_MAX_AGE)
-        {
-            WdfRequestComplete(curRequest, STATUS_SUCCESS);
-
-            WdfCollectionRemove(pFdoData->PendingPluginRequests, curRequest);
-
-            TraceEvents(TRACE_LEVEL_INFORMATION,
-                TRACE_DRIVER,
-                "Removed item with serial: %d",
-                pPluginData->Serial);
-
-            break;
-        }
-    }
-    WdfSpinLockRelease(pFdoData->PendingPluginRequestsLock);
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Exit");
-}
-

sys/Driver.cpp

@@ -0,0 +1,480 @@
+/*
+* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
+*
+* BSD 3-Clause License
+*
+* Copyright (c) 2018-2020, Nefarius Software Solutions e.U. and Contributors
+* All rights reserved.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*
+* 1. Redistributions of source code must retain the above copyright notice, this
+*    list of conditions and the following disclaimer.
+*
+* 2. Redistributions in binary form must reproduce the above copyright notice,
+*    this list of conditions and the following disclaimer in the documentation
+*    and/or other materials provided with the distribution.
+*
+* 3. Neither the name of the copyright holder nor the names of its
+*    contributors may be used to endorse or promote products derived from
+*    this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+
+#include "Driver.h"
+#include "trace.h"
+#include "Driver.tmh"
+#include <wdmguid.h>
+
+#ifdef ALLOC_PRAGMA
+#pragma alloc_text (INIT, DriverEntry)
+#pragma alloc_text (PAGE, Bus_EvtDeviceAdd)
+#pragma alloc_text (PAGE, Bus_DeviceFileCreate)
+#pragma alloc_text (PAGE, Bus_FileClose)
+#pragma alloc_text (PAGE, Bus_EvtDriverContextCleanup)
+#endif
+
+#include "Queue.hpp"
+#include "EmulationTargetPDO.hpp"
+#include "XusbPdo.hpp"
+#include "Ds4Pdo.hpp"
+
+#include "Debugging.hpp"
+
+using ViGEm::Bus::Core::PDO_IDENTIFICATION_DESCRIPTION;
+using ViGEm::Bus::Core::EmulationTargetPDO;
+using ViGEm::Bus::Targets::EmulationTargetXUSB;
+using ViGEm::Bus::Targets::EmulationTargetDS4;
+
+
+EXTERN_C_START
+
+//
+// Driver entry routine.
+// 
+NTSTATUS DriverEntry(IN PDRIVER_OBJECT DriverObject, IN PUNICODE_STRING RegistryPath)
+{
+	WDF_DRIVER_CONFIG       config;
+	NTSTATUS                status;
+	WDFDRIVER               driver;
+	WDF_OBJECT_ATTRIBUTES   attributes;
+
+	KdPrint((DRIVERNAME "Virtual Gamepad Emulation Bus Driver [built: %s %s]\n", __DATE__, __TIME__));
+
+	//
+	// Initialize WPP Tracing
+	//
+	WPP_INIT_TRACING(DriverObject, RegistryPath);
+
+	TraceEvents(TRACE_LEVEL_INFORMATION,
+		TRACE_DRIVER,
+		"Loading Virtual Gamepad Emulation Bus Driver"
+	);
+
+	ExInitializeDriverRuntime(DrvRtPoolNxOptIn);
+
+	//
+	// Register cleanup callback
+	// 
+	WDF_OBJECT_ATTRIBUTES_INIT(&attributes);
+	attributes.EvtCleanupCallback = Bus_EvtDriverContextCleanup;
+
+	WDF_DRIVER_CONFIG_INIT(&config, Bus_EvtDeviceAdd);
+
+	status = WdfDriverCreate(DriverObject, RegistryPath, &attributes, &config, &driver);
+
+	if (!NT_SUCCESS(status))
+	{
+		WPP_CLEANUP(DriverObject);
+		KdPrint((DRIVERNAME "WdfDriverCreate failed with status 0x%x\n", status));
+	}
+
+	return status;
+}
+
+//
+// Bus-device creation routine.
+// 
+NTSTATUS Bus_EvtDeviceAdd(IN WDFDRIVER Driver, IN PWDFDEVICE_INIT DeviceInit)
+{
+	WDF_CHILD_LIST_CONFIG       config;
+	NTSTATUS                    status;
+	WDFDEVICE                   device;
+	WDF_IO_QUEUE_CONFIG         queueConfig;
+	PNP_BUS_INFORMATION         busInfo;
+	WDFQUEUE                    queue;
+	WDF_FILEOBJECT_CONFIG       foConfig;
+	WDF_OBJECT_ATTRIBUTES       fdoAttributes;
+	WDF_OBJECT_ATTRIBUTES       fileHandleAttributes;
+	PFDO_DEVICE_DATA            pFDOData;
+	PWSTR                       pSymbolicNameList;
+
+	UNREFERENCED_PARAMETER(Driver);
+
+	PAGED_CODE();
+
+	TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Entry");
+
+#pragma region Check for duplicated FDO
+
+	//
+	// Note: this could be avoided if converted to non-PNP driver
+	// and use of named device object. Food for thought for future.
+	// 
+
+	status = IoGetDeviceInterfaces(
+		&GUID_DEVINTERFACE_BUSENUM_VIGEM,
+		NULL,
+		0, // Important!
+		&pSymbolicNameList
+	);
+	if (NT_SUCCESS(status))
+	{
+		const bool deviceAlreadyExists = (0 != *pSymbolicNameList);
+		ExFreePool(pSymbolicNameList);
+
+		if (deviceAlreadyExists)
+		{
+			TraceEvents(TRACE_LEVEL_ERROR,
+				TRACE_DRIVER,
+				"Device with interface GUID {%!GUID!} already exists (%ws)",
+				&GUID_DEVINTERFACE_BUSENUM_VIGEM,
+				pSymbolicNameList
+			);
+
+			return STATUS_RESOURCE_IN_USE;
+		}
+	}
+	else
+	{
+		TraceEvents(TRACE_LEVEL_WARNING,
+			TRACE_DRIVER,
+			"IoGetDeviceInterfaces failed with status %!STATUS!",
+			status);
+	}
+
+#pragma endregion
+
+	WdfDeviceInitSetDeviceType(DeviceInit, FILE_DEVICE_BUS_EXTENDER);
+	// More than one process may talk to the bus at the same time
+	WdfDeviceInitSetExclusive(DeviceInit, FALSE);
+	// Bus is power policy owner over all PDOs
+	WdfDeviceInitSetPowerPolicyOwnership(DeviceInit, TRUE);
+
+#pragma region Prepare child list
+
+	WDF_CHILD_LIST_CONFIG_INIT(&config, sizeof(PDO_IDENTIFICATION_DESCRIPTION), Bus_EvtDeviceListCreatePdo);
+
+	config.EvtChildListIdentificationDescriptionCompare = EmulationTargetPDO::EvtChildListIdentificationDescriptionCompare;
+
+	WdfFdoInitSetDefaultChildListConfig(DeviceInit, &config, WDF_NO_OBJECT_ATTRIBUTES);
+
+#pragma endregion
+
+#pragma region Assign File Object Configuration
+
+	WDF_FILEOBJECT_CONFIG_INIT(&foConfig, Bus_DeviceFileCreate, Bus_FileClose, NULL);
+
+	WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&fileHandleAttributes, FDO_FILE_DATA);
+
+	WdfDeviceInitSetFileObjectConfig(DeviceInit, &foConfig, &fileHandleAttributes);
+
+#pragma endregion
+
+#pragma region Create FDO
+
+	WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&fdoAttributes, FDO_DEVICE_DATA);
+
+	status = WdfDeviceCreate(&DeviceInit, &fdoAttributes, &device);
+
+	if (!NT_SUCCESS(status))
+	{
+		TraceEvents(TRACE_LEVEL_ERROR,
+			TRACE_DRIVER,
+			"WdfDeviceCreate failed with status %!STATUS!",
+			status);
+		return status;
+	}
+
+	pFDOData = FdoGetData(device);
+	if (pFDOData == NULL)
+	{
+		TraceEvents(TRACE_LEVEL_ERROR,
+			TRACE_DRIVER,
+			"FdoGetData failed");
+		return STATUS_UNSUCCESSFUL;
+	}
+
+	pFDOData->InterfaceReferenceCounter = 0;
+	pFDOData->NextSessionId = FDO_FIRST_SESSION_ID;
+
+#pragma endregion
+
+#pragma region Create default I/O queue for FDO
+
+	WDF_IO_QUEUE_CONFIG_INIT_DEFAULT_QUEUE(&queueConfig, WdfIoQueueDispatchParallel);
+
+	queueConfig.EvtIoDeviceControl = Bus_EvtIoDeviceControl;
+
+	__analysis_assume(queueConfig.EvtIoStop != 0);
+	status = WdfIoQueueCreate(device, &queueConfig, WDF_NO_OBJECT_ATTRIBUTES, &queue);
+	__analysis_assume(queueConfig.EvtIoStop == 0);
+
+	if (!NT_SUCCESS(status))
+	{
+		TraceEvents(TRACE_LEVEL_ERROR,
+			TRACE_DRIVER,
+			"WdfIoQueueCreate failed with status %!STATUS!",
+			status);
+		return status;
+	}
+
+#pragma endregion
+
+#pragma region Expose FDO interface
+
+	status = WdfDeviceCreateDeviceInterface(device, &GUID_DEVINTERFACE_BUSENUM_VIGEM, NULL);
+
+	if (!NT_SUCCESS(status))
+	{
+		TraceEvents(TRACE_LEVEL_ERROR,
+			TRACE_DRIVER,
+			"WdfDeviceCreateDeviceInterface failed with status %!STATUS!",
+			status);
+		return status;
+	}
+
+#pragma endregion
+
+#pragma region Set bus information
+
+	busInfo.BusTypeGuid = GUID_BUS_TYPE_USB;
+	busInfo.LegacyBusType = PNPBus;
+	busInfo.BusNumber = 0;
+
+	WdfDeviceSetBusInformationForChildren(device, &busInfo);
+
+#pragma endregion
+
+	TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Exit with status %!STATUS!", status);
+
+	return status;
+}
+
+// Gets called when the user-land process (or kernel driver) exits or closes the handle,
+// and all IO has completed.
+// 
+_Use_decl_annotations_
+VOID
+Bus_DeviceFileCreate(
+	_In_ WDFDEVICE     Device,
+	_In_ WDFREQUEST    Request,
+	_In_ WDFFILEOBJECT FileObject
+)
+{
+	NTSTATUS         status = STATUS_INVALID_PARAMETER;
+	PFDO_FILE_DATA   pFileData = NULL;
+	PFDO_DEVICE_DATA pFDOData = NULL;
+	LONG             refCount = 0;
+	LONG             sessionId = 0;
+
+	UNREFERENCED_PARAMETER(Request);
+
+	PAGED_CODE();
+
+	TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Entry");
+
+	pFileData = FileObjectGetData(FileObject);
+
+	if (pFileData == NULL)
+	{
+		TraceEvents(TRACE_LEVEL_ERROR,
+			TRACE_DRIVER,
+			"FileObjectGetData failed to return file object from WDFFILEOBJECT 0x%p",
+			FileObject);
+	}
+	else
+	{
+		pFDOData = FdoGetData(Device);
+		if (pFDOData == NULL)
+		{
+			TraceEvents(TRACE_LEVEL_ERROR,
+				TRACE_DRIVER,
+				"FdoGetData failed");
+			status = STATUS_NO_SUCH_DEVICE;
+		}
+		else
+		{
+			refCount = InterlockedIncrement(&pFDOData->InterfaceReferenceCounter);
+			sessionId = InterlockedIncrement(&pFDOData->NextSessionId);
+
+			pFileData->SessionId = sessionId;
+			status = STATUS_SUCCESS;
+
+			TraceEvents(TRACE_LEVEL_INFORMATION,
+				TRACE_DRIVER,
+				"File/session id = %d, device ref. count = %d",
+				(int)sessionId, (int)refCount);
+		}
+	}
+
+	WdfRequestComplete(Request, status);
+
+	TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Exit with status %!STATUS!", status);
+}
+
+//
+// Gets called when the user-land process (or kernel driver) exits or closes the handle.
+// 
+_Use_decl_annotations_
+VOID
+Bus_FileClose(
+	WDFFILEOBJECT FileObject
+)
+{
+	WDFDEVICE                      device;
+	WDFDEVICE                      hChild;
+	NTSTATUS                       status;
+	WDFCHILDLIST                   list;
+	WDF_CHILD_LIST_ITERATOR        iterator;
+	WDF_CHILD_RETRIEVE_INFO        childInfo;
+	PDO_IDENTIFICATION_DESCRIPTION description;
+	PFDO_FILE_DATA                 pFileData = NULL;
+	PFDO_DEVICE_DATA               pFDOData = NULL;
+	LONG                           refCount = 0;
+
+	PAGED_CODE();
+
+
+	TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Entry");
+
+	// Check common context
+	pFileData = FileObjectGetData(FileObject);
+	if (pFileData == NULL)
+	{
+		TraceEvents(TRACE_LEVEL_ERROR,
+			TRACE_DRIVER,
+			"FileObjectGetData failed to return file object from WDFFILEOBJECT 0x%p",
+			FileObject);
+		return;
+	}
+
+	device = WdfFileObjectGetDevice(FileObject);
+
+	pFDOData = FdoGetData(device);
+	if (pFDOData == NULL)
+	{
+		TraceEvents(TRACE_LEVEL_ERROR,
+			TRACE_DRIVER,
+			"FdoGetData failed");
+		status = STATUS_NO_SUCH_DEVICE;
+	}
+	else
+	{
+		refCount = InterlockedDecrement(&pFDOData->InterfaceReferenceCounter);
+
+		TraceEvents(TRACE_LEVEL_INFORMATION,
+			TRACE_DRIVER,
+			"Device ref. count = %d",
+			(int)refCount);
+	}
+
+	list = WdfFdoGetDefaultChildList(device);
+
+	WDF_CHILD_LIST_ITERATOR_INIT(&iterator, WdfRetrievePresentChildren);
+
+	WdfChildListBeginIteration(list, &iterator);
+
+	for (;;)
+	{
+		WDF_CHILD_RETRIEVE_INFO_INIT(&childInfo, &description.Header);
+		WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT(&description.Header, sizeof(description));
+
+		status = WdfChildListRetrieveNextDevice(list, &iterator, &hChild, &childInfo);
+		if (!NT_SUCCESS(status) || status == STATUS_NO_MORE_ENTRIES)
+		{
+			break;
+		}
+
+		//TraceEvents(TRACE_LEVEL_VERBOSE,
+		//    TRACE_DRIVER,
+		//    "PDO properties: status = %!STATUS!, pdoPID = %d, curPID = %d, pdoSID = %d, curSID = %d, internal = %d",
+		//    (int)childInfo.Status,
+		//    (int)description.OwnerProcessId,
+		//    (int)CURRENT_PROCESS_ID(),
+		//    (int)description.SessionId,
+		//    (int)pFileData->SessionId,
+		//    (int)description.OwnerIsDriver
+		//);
+
+		// Only unplug devices with matching session id
+		if (childInfo.Status == WdfChildListRetrieveDeviceSuccess
+			&& description.SessionId == pFileData->SessionId)
+		{
+			TraceEvents(TRACE_LEVEL_INFORMATION,
+				TRACE_DRIVER,
+				"Unplugging device with serial %d",
+				description.SerialNo);
+
+			// "Unplug" child
+			status = WdfChildListUpdateChildDescriptionAsMissing(list, &description.Header);
+			if (!NT_SUCCESS(status))
+			{
+				TraceEvents(TRACE_LEVEL_ERROR,
+					TRACE_DRIVER,
+					"WdfChildListUpdateChildDescriptionAsMissing failed with status %!STATUS!",
+					status);
+			}
+		}
+	}
+
+	WdfChildListEndIteration(list, &iterator);
+
+	TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Exit with status %!STATUS!", status);
+}
+
+VOID
+Bus_EvtDriverContextCleanup(
+	_In_ WDFOBJECT DriverObject
+)
+/*++
+Routine Description:
+
+	Free all the resources allocated in DriverEntry.
+
+Arguments:
+
+	DriverObject - handle to a WDF Driver object.
+
+Return Value:
+
+	VOID.
+
+--*/
+{
+	UNREFERENCED_PARAMETER(DriverObject);
+
+	PAGED_CODE();
+
+	TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Entry");
+
+	//
+	// Stop WPP Tracing
+	//
+	WPP_CLEANUP(WdfDriverWdmGetDriverObject((WDFDRIVER)DriverObject));
+
+}
+
+EXTERN_C_END

sys/Driver.h

@@ -0,0 +1,127 @@
+/*
+* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
+*
+* BSD 3-Clause License
+*
+* Copyright (c) 2018-2020, Nefarius Software Solutions e.U. and Contributors
+* All rights reserved.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*
+* 1. Redistributions of source code must retain the above copyright notice, this
+*    list of conditions and the following disclaimer.
+*
+* 2. Redistributions in binary form must reproduce the above copyright notice,
+*    this list of conditions and the following disclaimer in the documentation
+*    and/or other materials provided with the distribution.
+*
+* 3. Neither the name of the copyright holder nor the names of its
+*    contributors may be used to endorse or promote products derived from
+*    this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+
+#pragma once
+
+#pragma warning(disable:5040)
+#include <DmfModules.Library.h>
+#pragma warning(default:5040)
+#include <ntddk.h>
+#include <wdf.h>
+#define NTSTRSAFE_LIB
+#include <ntstrsafe.h>
+
+
+#pragma region Macros
+
+#define DRIVERNAME                      "ViGEm: "
+
+#pragma endregion
+
+//
+// FDO (bus device) context data
+// 
+typedef struct _FDO_DEVICE_DATA
+{
+    //
+    // Counter of interface references
+    // 
+    LONG InterfaceReferenceCounter;
+
+    //
+    // Next SessionId to assign to a file handle
+    // 
+    LONG NextSessionId;
+
+} FDO_DEVICE_DATA, * PFDO_DEVICE_DATA;
+
+#define FDO_FIRST_SESSION_ID 100
+
+WDF_DECLARE_CONTEXT_TYPE_WITH_NAME(FDO_DEVICE_DATA, FdoGetData)
+
+// 
+// Context data associated with file objects created by user mode applications
+// 
+typedef struct _FDO_FILE_DATA
+{
+    //
+    // SessionId associated with file handle.  Used to map file handles to emulated gamepad devices
+    // 
+    LONG SessionId;
+
+} FDO_FILE_DATA, * PFDO_FILE_DATA;
+
+WDF_DECLARE_CONTEXT_TYPE_WITH_NAME(FDO_FILE_DATA, FileObjectGetData)
+
+
+EXTERN_C_START
+
+#pragma region WDF callback prototypes
+
+DRIVER_INITIALIZE DriverEntry;
+
+EVT_WDF_DRIVER_DEVICE_ADD Bus_EvtDeviceAdd;
+
+EVT_WDF_DEVICE_FILE_CREATE Bus_DeviceFileCreate;
+
+EVT_WDF_FILE_CLOSE Bus_FileClose;
+
+EVT_WDF_CHILD_LIST_CREATE_DEVICE Bus_EvtDeviceListCreatePdo;
+
+EVT_WDF_OBJECT_CONTEXT_CLEANUP Bus_EvtDriverContextCleanup;
+
+#pragma endregion
+
+#pragma region Bus enumeration-specific functions
+
+NTSTATUS
+Bus_PlugInDevice(
+    _In_ WDFDEVICE Device,
+    _In_ WDFREQUEST Request,
+    _In_ BOOLEAN IsInternal,
+    _Out_ size_t* Transferred
+);
+
+NTSTATUS
+Bus_UnPlugDevice(
+    _In_ WDFDEVICE Device,
+    _In_ WDFREQUEST Request,
+    _In_ BOOLEAN IsInternal,
+    _Out_ size_t* Transferred
+);
+
+#pragma endregion
+
+EXTERN_C_END

sys/Ds4.c

@@ -1,468 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-*
-* MIT License
-*
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-*
-* 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.
-*/
-
-
-#include "busenum.h"
-#include <hidclass.h>
-#include "ds4.tmh"
-
-NTSTATUS Ds4_PreparePdo(PWDFDEVICE_INIT DeviceInit, PUNICODE_STRING DeviceId, PUNICODE_STRING DeviceDescription)
-{
-    NTSTATUS status;
-    UNICODE_STRING buffer;
-
-    // prepare device description
-    status = RtlUnicodeStringInit(DeviceDescription, L"Virtual DualShock 4 Controller");
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DS4,
-            "RtlUnicodeStringInit failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    // Set hardware IDs
-    RtlUnicodeStringInit(&buffer, L"USB\\VID_054C&PID_05C4&REV_0100");
-
-    status = WdfPdoInitAddHardwareID(DeviceInit, &buffer);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DS4,
-            "WdfPdoInitAddHardwareID failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    RtlUnicodeStringCopy(DeviceId, &buffer);
-
-    RtlUnicodeStringInit(&buffer, L"USB\\VID_054C&PID_05C4");
-
-    status = WdfPdoInitAddHardwareID(DeviceInit, &buffer);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DS4,
-            "WdfPdoInitAddHardwareID failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    // Set compatible IDs
-    RtlUnicodeStringInit(&buffer, L"USB\\Class_03&SubClass_00&Prot_00");
-
-    status = WdfPdoInitAddCompatibleID(DeviceInit, &buffer);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DS4,
-            "WdfPdoInitAddCompatibleID (#01) failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    RtlUnicodeStringInit(&buffer, L"USB\\Class_03&SubClass_00");
-
-    status = WdfPdoInitAddCompatibleID(DeviceInit, &buffer);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DS4,
-            "WdfPdoInitAddCompatibleID (#02) failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    RtlUnicodeStringInit(&buffer, L"USB\\Class_03");
-
-    status = WdfPdoInitAddCompatibleID(DeviceInit, &buffer);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DS4,
-            "WdfPdoInitAddCompatibleID (#03) failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    return STATUS_SUCCESS;
-}
-
-NTSTATUS Ds4_PrepareHardware(WDFDEVICE Device)
-{
-    NTSTATUS status;
-    WDF_QUERY_INTERFACE_CONFIG ifaceCfg;
-    INTERFACE devinterfaceHid;
-
-    devinterfaceHid.Size = sizeof(INTERFACE);
-    devinterfaceHid.Version = 1;
-    devinterfaceHid.Context = (PVOID)Device;
-
-    devinterfaceHid.InterfaceReference = WdfDeviceInterfaceReferenceNoOp;
-    devinterfaceHid.InterfaceDereference = WdfDeviceInterfaceDereferenceNoOp;
-
-    // Expose GUID_DEVINTERFACE_HID so HIDUSB can initialize
-    WDF_QUERY_INTERFACE_CONFIG_INIT(&ifaceCfg, (PINTERFACE)&devinterfaceHid, &GUID_DEVINTERFACE_HID, NULL);
-
-    status = WdfDeviceAddQueryInterface(Device, &ifaceCfg);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DS4,
-            "WdfDeviceAddQueryInterface failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    PDS4_DEVICE_DATA ds4Data = Ds4GetData(Device);
-
-    // Set default HID input report (everything zero`d)
-    UCHAR DefaultHidReport[DS4_REPORT_SIZE] =
-    {
-        0x01, 0x82, 0x7F, 0x7E, 0x80, 0x08, 0x00, 0x58,
-        0x00, 0x00, 0xFD, 0x63, 0x06, 0x03, 0x00, 0xFE,
-        0xFF, 0xFC, 0xFF, 0x79, 0xFD, 0x1B, 0x14, 0xD1,
-        0xE9, 0x00, 0x00, 0x00, 0x00, 0x00, 0x1B, 0x00,
-        0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00, 0x80,
-        0x00, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00,
-        0x80, 0x00, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00,
-        0x00, 0x80, 0x00, 0x00, 0x00, 0x00, 0x80, 0x00
-    };
-
-    // Initialize HID reports to defaults
-    RtlCopyBytes(ds4Data->Report, DefaultHidReport, DS4_REPORT_SIZE);
-    RtlZeroMemory(&ds4Data->OutputReport, sizeof(DS4_OUTPUT_REPORT));
-
-    // Start pending IRP queue flush timer
-    WdfTimerStart(ds4Data->PendingUsbInRequestsTimer, DS4_QUEUE_FLUSH_PERIOD);
-
-    return STATUS_SUCCESS;
-}
-
-NTSTATUS Ds4_AssignPdoContext(WDFDEVICE Device, PPDO_IDENTIFICATION_DESCRIPTION Description)
-{
-    NTSTATUS            status;
-    PDS4_DEVICE_DATA    ds4 = Ds4GetData(Device);
-
-    // Initialize periodic timer
-    WDF_TIMER_CONFIG timerConfig;
-    WDF_TIMER_CONFIG_INIT_PERIODIC(&timerConfig, Ds4_PendingUsbRequestsTimerFunc, DS4_QUEUE_FLUSH_PERIOD);
-
-    // Timer object attributes
-    WDF_OBJECT_ATTRIBUTES timerAttribs;
-    WDF_OBJECT_ATTRIBUTES_INIT(&timerAttribs);
-
-    // PDO is parent
-    timerAttribs.ParentObject = Device;
-
-    // Create timer
-    status = WdfTimerCreate(&timerConfig, &timerAttribs, &ds4->PendingUsbInRequestsTimer);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DS4,
-            "WdfTimerCreate failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    // Load/generate MAC address
-
-    // TODO: tidy up this region
-
-    WDFKEY keyParams, keyTargets, keyDS, keySerial;
-    UNICODE_STRING keyName, valueName;
-
-    status = WdfDriverOpenParametersRegistryKey(WdfGetDriver(), STANDARD_RIGHTS_ALL, WDF_NO_OBJECT_ATTRIBUTES, &keyParams);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DS4,
-            "WdfDriverOpenParametersRegistryKey failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    RtlUnicodeStringInit(&keyName, L"Targets");
-
-    status = WdfRegistryCreateKey(
-        keyParams,
-        &keyName,
-        KEY_ALL_ACCESS,
-        REG_OPTION_NON_VOLATILE,
-        NULL,
-        WDF_NO_OBJECT_ATTRIBUTES,
-        &keyTargets
-    );
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DS4,
-            "WdfRegistryCreateKey failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    RtlUnicodeStringInit(&keyName, L"DualShock");
-
-    status = WdfRegistryCreateKey(
-        keyTargets,
-        &keyName,
-        KEY_ALL_ACCESS,
-        REG_OPTION_NON_VOLATILE,
-        NULL,
-        WDF_NO_OBJECT_ATTRIBUTES,
-        &keyDS
-    );
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DS4,
-            "WdfRegistryCreateKey failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    DECLARE_UNICODE_STRING_SIZE(serialPath, 4);
-    RtlUnicodeStringPrintf(&serialPath, L"%04d", Description->SerialNo);
-
-    status = WdfRegistryCreateKey(
-        keyDS,
-        &serialPath,
-        KEY_ALL_ACCESS,
-        REG_OPTION_NON_VOLATILE,
-        NULL,
-        WDF_NO_OBJECT_ATTRIBUTES,
-        &keySerial
-    );
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DS4,
-            "WdfRegistryCreateKey failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    RtlUnicodeStringInit(&valueName, L"TargetMacAddress");
-
-    status = WdfRegistryQueryValue(keySerial, &valueName, sizeof(MAC_ADDRESS), &ds4->TargetMacAddress, NULL, NULL);
-
-    TraceEvents(TRACE_LEVEL_INFORMATION,
-        TRACE_DS4,
-        "MAC-Address: %02X:%02X:%02X:%02X:%02X:%02X\n",
-        ds4->TargetMacAddress.Vendor0,
-        ds4->TargetMacAddress.Vendor1,
-        ds4->TargetMacAddress.Vendor2,
-        ds4->TargetMacAddress.Nic0,
-        ds4->TargetMacAddress.Nic1,
-        ds4->TargetMacAddress.Nic2);
-
-    if (status == STATUS_OBJECT_NAME_NOT_FOUND)
-    {
-        GenerateRandomMacAddress(&ds4->TargetMacAddress);
-
-        status = WdfRegistryAssignValue(keySerial, &valueName, REG_BINARY, sizeof(MAC_ADDRESS), (PVOID)&ds4->TargetMacAddress);
-        if (!NT_SUCCESS(status))
-        {
-            TraceEvents(TRACE_LEVEL_ERROR,
-                TRACE_DS4,
-                "WdfRegistryAssignValue failed with status %!STATUS!",
-                status);
-            return status;
-        }
-    }
-    else if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_DS4,
-            "WdfRegistryQueryValue failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    WdfRegistryClose(keySerial);
-    WdfRegistryClose(keyDS);
-    WdfRegistryClose(keyTargets);
-    WdfRegistryClose(keyParams);
-
-    return STATUS_SUCCESS;
-}
-
-VOID Ds4_GetConfigurationDescriptorType(PUCHAR Buffer, ULONG Length)
-{
-    UCHAR Ds4DescriptorData[DS4_DESCRIPTOR_SIZE] =
-    {
-        0x09,        // bLength
-        0x02,        // bDescriptorType (Configuration)
-        0x29, 0x00,  // wTotalLength 41
-        0x01,        // bNumInterfaces 1
-        0x01,        // bConfigurationValue
-        0x00,        // iConfiguration (String Index)
-        0xC0,        // bmAttributes Self Powered
-        0xFA,        // bMaxPower 500mA
-
-        0x09,        // bLength
-        0x04,        // bDescriptorType (Interface)
-        0x00,        // bInterfaceNumber 0
-        0x00,        // bAlternateSetting
-        0x02,        // bNumEndpoints 2
-        0x03,        // bInterfaceClass
-        0x00,        // bInterfaceSubClass
-        0x00,        // bInterfaceProtocol
-        0x00,        // iInterface (String Index)
-
-        0x09,        // bLength
-        0x21,        // bDescriptorType (HID)
-        0x11, 0x01,  // bcdHID 1.11
-        0x00,        // bCountryCode
-        0x01,        // bNumDescriptors
-        0x22,        // bDescriptorType[0] (HID)
-        0xD3, 0x01,  // wDescriptorLength[0] 467
-
-        0x07,        // bLength
-        0x05,        // bDescriptorType (Endpoint)
-        0x84,        // bEndpointAddress (IN/D2H)
-        0x03,        // bmAttributes (Interrupt)
-        0x40, 0x00,  // wMaxPacketSize 64
-        0x05,        // bInterval 5 (unit depends on device speed)
-
-        0x07,        // bLength
-        0x05,        // bDescriptorType (Endpoint)
-        0x03,        // bEndpointAddress (OUT/H2D)
-        0x03,        // bmAttributes (Interrupt)
-        0x40, 0x00,  // wMaxPacketSize 64
-        0x05,        // bInterval 5 (unit depends on device speed)
-
-                     // 41 bytes
-
-                     // best guess: USB Standard Descriptor
-    };
-
-    RtlCopyBytes(Buffer, Ds4DescriptorData, Length);
-}
-
-VOID Ds4_GetDeviceDescriptorType(PUSB_DEVICE_DESCRIPTOR pDescriptor, PPDO_DEVICE_DATA pCommon)
-{
-    pDescriptor->bLength = 0x12;
-    pDescriptor->bDescriptorType = USB_DEVICE_DESCRIPTOR_TYPE;
-    pDescriptor->bcdUSB = 0x0200; // USB v2.0
-    pDescriptor->bDeviceClass = 0x00; // per Interface
-    pDescriptor->bDeviceSubClass = 0x00;
-    pDescriptor->bDeviceProtocol = 0x00;
-    pDescriptor->bMaxPacketSize0 = 0x40;
-    pDescriptor->idVendor = pCommon->VendorId;
-    pDescriptor->idProduct = pCommon->ProductId;
-    pDescriptor->bcdDevice = 0x0100;
-    pDescriptor->iManufacturer = 0x01;
-    pDescriptor->iProduct = 0x02;
-    pDescriptor->iSerialNumber = 0x00;
-    pDescriptor->bNumConfigurations = 0x01;
-}
-
-VOID Ds4_SelectConfiguration(PUSBD_INTERFACE_INFORMATION pInfo)
-{
-    TraceEvents(TRACE_LEVEL_VERBOSE,
-        TRACE_DS4,
-        ">> >> >> URB_FUNCTION_SELECT_CONFIGURATION: Length %d, Interface %d, Alternate %d, Pipes %d",
-        (int)pInfo->Length,
-        (int)pInfo->InterfaceNumber,
-        (int)pInfo->AlternateSetting,
-        pInfo->NumberOfPipes);
-
-    pInfo->Class = 0x03; // HID
-    pInfo->SubClass = 0x00;
-    pInfo->Protocol = 0x00;
-
-    pInfo->InterfaceHandle = (USBD_INTERFACE_HANDLE)0xFFFF0000;
-
-    pInfo->Pipes[0].MaximumTransferSize = 0x00400000;
-    pInfo->Pipes[0].MaximumPacketSize = 0x40;
-    pInfo->Pipes[0].EndpointAddress = 0x84;
-    pInfo->Pipes[0].Interval = 0x05;
-    pInfo->Pipes[0].PipeType = 0x03;
-    pInfo->Pipes[0].PipeHandle = (USBD_PIPE_HANDLE)0xFFFF0084;
-    pInfo->Pipes[0].PipeFlags = 0x00;
-
-    pInfo->Pipes[1].MaximumTransferSize = 0x00400000;
-    pInfo->Pipes[1].MaximumPacketSize = 0x40;
-    pInfo->Pipes[1].EndpointAddress = 0x03;
-    pInfo->Pipes[1].Interval = 0x05;
-    pInfo->Pipes[1].PipeType = 0x03;
-    pInfo->Pipes[1].PipeHandle = (USBD_PIPE_HANDLE)0xFFFF0003;
-    pInfo->Pipes[1].PipeFlags = 0x00;
-}
-
-//
-// Completes pending I/O requests if feeder is too slow.
-// 
-VOID Ds4_PendingUsbRequestsTimerFunc(
-    _In_ WDFTIMER Timer
-)
-{
-    NTSTATUS                status;
-    WDFREQUEST              usbRequest;
-    WDFDEVICE               hChild;
-    PDS4_DEVICE_DATA        ds4Data;
-    PIRP                    pendingIrp;
-    PIO_STACK_LOCATION      irpStack;
-    PPDO_DEVICE_DATA        pdoData;
-
-    TraceEvents(TRACE_LEVEL_VERBOSE, TRACE_DS4, "%!FUNC! Entry");
-
-    hChild = WdfTimerGetParentObject(Timer);
-    pdoData = PdoGetData(hChild);
-    ds4Data = Ds4GetData(hChild);
-
-    // Get pending USB request
-    status = WdfIoQueueRetrieveNextRequest(pdoData->PendingUsbInRequests, &usbRequest);
-
-    if (NT_SUCCESS(status))
-    {
-        // Get pending IRP
-        pendingIrp = WdfRequestWdmGetIrp(usbRequest);
-        irpStack = IoGetCurrentIrpStackLocation(pendingIrp);
-
-        // Get USB request block
-        PURB urb = (PURB)irpStack->Parameters.Others.Argument1;
-
-        // Get transfer buffer
-        PUCHAR Buffer = (PUCHAR)urb->UrbBulkOrInterruptTransfer.TransferBuffer;
-        // Set buffer length to report size
-        urb->UrbBulkOrInterruptTransfer.TransferBufferLength = DS4_REPORT_SIZE;
-
-        // Copy cached report to transfer buffer 
-        if (Buffer)
-            RtlCopyBytes(Buffer, ds4Data->Report, DS4_REPORT_SIZE);
-
-        // Complete pending request
-        WdfRequestComplete(usbRequest, status);
-    }
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DS4, "%!FUNC! Exit with status %!STATUS!", status);
-}
-

sys/Ds4.h

@@ -1,114 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-*
-* MIT License
-*
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-*
-* 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.
-*/
-
-
-#pragma once
-
-#define HID_GET_FEATURE_REPORT_SIZE_0                   0x31
-#define HID_GET_FEATURE_REPORT_SIZE_1                   0x25
-#define HID_GET_FEATURE_REPORT_MAC_ADDRESSES_SIZE       0x10
-
-#define HID_SET_FEATURE_REPORT_SIZE_0                   0x17
-#define HID_SET_FEATURE_REPORT_SIZE_1                   0x11
-
-#define HID_REPORT_ID_0                                 0xA3
-#define HID_REPORT_ID_1                                 0x02
-#define HID_REPORT_MAC_ADDRESSES_ID                     0x12
-#define HID_REPORT_ID_3                                 0x13
-#define HID_REPORT_ID_4                                 0x14
-
-#define DS4_DESCRIPTOR_SIZE                             0x0029
-#if defined(_X86_)
-#define DS4_CONFIGURATION_SIZE                          0x0050
-#else
-#define DS4_CONFIGURATION_SIZE                          0x0070
-#endif
-#define DS4_HID_REPORT_DESCRIPTOR_SIZE                  0x01D3
-
-#define DS4_MANUFACTURER_NAME_LENGTH                    0x38
-#define DS4_PRODUCT_NAME_LENGTH                         0x28
-#define DS4_OUTPUT_BUFFER_OFFSET                        0x04
-#define DS4_OUTPUT_BUFFER_LENGTH                        0x05
-
-#define DS4_REPORT_SIZE                                 0x40
-#define DS4_QUEUE_FLUSH_PERIOD                          0x05
-
-
-//
-// DS4-specific device context data.
-// 
-typedef struct _DS4_DEVICE_DATA
-{
-    //
-    // HID Input Report buffer
-    //
-    UCHAR Report[DS4_REPORT_SIZE];
-
-    //
-    // Output report cache
-    //
-    DS4_OUTPUT_REPORT OutputReport;
-
-    //
-    // Timer for dispatching interrupt transfer
-    //
-    WDFTIMER PendingUsbInRequestsTimer;
-
-    //
-    // Auto-generated MAC address of the target device
-    //
-    MAC_ADDRESS TargetMacAddress;
-
-    //
-    // Default MAC address of the host (not used)
-    //
-    MAC_ADDRESS HostMacAddress;
-
-} DS4_DEVICE_DATA, *PDS4_DEVICE_DATA;
-
-WDF_DECLARE_CONTEXT_TYPE_WITH_NAME(DS4_DEVICE_DATA, Ds4GetData)
-
-
-EVT_WDF_TIMER Ds4_PendingUsbRequestsTimerFunc;
-
-NTSTATUS
-Bus_Ds4SubmitReport(
-    WDFDEVICE Device,
-    ULONG SerialNo,
-    PDS4_SUBMIT_REPORT Report,
-    _In_ BOOLEAN FromInterface
-);
-
-//
-// DS4-specific functions
-// 
-NTSTATUS Ds4_PreparePdo(PWDFDEVICE_INIT DeviceInit, PUNICODE_STRING DeviceId, PUNICODE_STRING DeviceDescription);
-NTSTATUS Ds4_PrepareHardware(WDFDEVICE Device);
-NTSTATUS Ds4_AssignPdoContext(WDFDEVICE Device, PPDO_IDENTIFICATION_DESCRIPTION Description);
-VOID Ds4_GetConfigurationDescriptorType(PUCHAR Buffer, ULONG Length);
-VOID Ds4_GetDeviceDescriptorType(PUSB_DEVICE_DESCRIPTOR pDescriptor, PPDO_DEVICE_DATA pCommon);
-VOID Ds4_SelectConfiguration(PUSBD_INTERFACE_INFORMATION pInfo);
-

sys/Ds4Pdo.hpp

@@ -0,0 +1,164 @@
+/*
+* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
+*
+* BSD 3-Clause License
+*
+* Copyright (c) 2018-2020, Nefarius Software Solutions e.U. and Contributors
+* All rights reserved.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*
+* 1. Redistributions of source code must retain the above copyright notice, this
+*    list of conditions and the following disclaimer.
+*
+* 2. Redistributions in binary form must reproduce the above copyright notice,
+*    this list of conditions and the following disclaimer in the documentation
+*    and/or other materials provided with the distribution.
+*
+* 3. Neither the name of the copyright holder nor the names of its
+*    contributors may be used to endorse or promote products derived from
+*    this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+
+#pragma once
+
+#include "EmulationTargetPDO.hpp"
+#include <ViGEm/km/BusShared.h>
+
+
+namespace ViGEm::Bus::Targets
+{
+	//
+	// Represents a MAC address.
+	//
+	typedef struct _MAC_ADDRESS
+	{
+		UCHAR Vendor0;
+		UCHAR Vendor1;
+		UCHAR Vendor2;
+		UCHAR Nic0;
+		UCHAR Nic1;
+		UCHAR Nic2;
+	} MAC_ADDRESS, * PMAC_ADDRESS;
+	
+	constexpr unsigned char hid_get_report_id(struct _URB_CONTROL_VENDOR_OR_CLASS_REQUEST* pReq)
+	{
+		return pReq->Value & 0xFF;
+	}
+
+	constexpr unsigned char hid_get_report_type(struct _URB_CONTROL_VENDOR_OR_CLASS_REQUEST* pReq)
+	{
+		return (pReq->Value >> 8) & 0xFF;
+	}
+
+	class EmulationTargetDS4 : public Core::EmulationTargetPDO
+	{
+	public:
+		EmulationTargetDS4(ULONG Serial, LONG SessionId, USHORT VendorId = 0x054C, USHORT ProductId = 0x05C4);
+
+		NTSTATUS PdoPrepareDevice(PWDFDEVICE_INIT DeviceInit,
+		                          PUNICODE_STRING DeviceId,
+		                          PUNICODE_STRING DeviceDescription) override;
+
+		NTSTATUS PdoPrepareHardware() override;
+
+		NTSTATUS PdoInitContext() override;
+
+		VOID GetConfigurationDescriptorType(PUCHAR Buffer, ULONG Length) override;
+
+		NTSTATUS UsbGetDeviceDescriptorType(PUSB_DEVICE_DESCRIPTOR pDescriptor) override;
+
+		NTSTATUS SelectConfiguration(PURB Urb) override;
+
+		void AbortPipe() override;
+		
+		NTSTATUS UsbClassInterface(PURB Urb) override;
+		
+		NTSTATUS UsbGetDescriptorFromInterface(PURB Urb) override;
+		
+		NTSTATUS UsbSelectInterface(PURB Urb) override;
+		
+		NTSTATUS UsbGetStringDescriptorType(PURB Urb) override;
+		
+		NTSTATUS UsbBulkOrInterruptTransfer(_URB_BULK_OR_INTERRUPT_TRANSFER* pTransfer, WDFREQUEST Request) override;
+		
+		NTSTATUS UsbControlTransfer(PURB Urb) override;
+		
+		NTSTATUS SubmitReportImpl(PVOID NewReport) override;
+		
+	private:
+		static EVT_WDF_TIMER PendingUsbRequestsTimerFunc;
+
+		static VOID ReverseByteArray(PUCHAR Array, INT Length);
+
+		static VOID GenerateRandomMacAddress(PMAC_ADDRESS Address);
+
+	protected:
+		void ProcessPendingNotification(WDFQUEUE Queue) override;
+	private:
+		static PCWSTR _deviceDescription;
+
+		static const int HID_REQUEST_GET_REPORT = 0x01;
+		static const int HID_REQUEST_SET_REPORT = 0x09;
+		static const int HID_REPORT_TYPE_FEATURE = 0x03;
+
+		static const int HID_REPORT_ID_0 = 0xA3;
+		static const int HID_REPORT_ID_1 = 0x02;
+		static const int HID_REPORT_MAC_ADDRESSES_ID = 0x12;
+		static const int HID_REPORT_ID_3 = 0x13;
+		static const int HID_REPORT_ID_4 = 0x14;
+
+		static const int DS4_DESCRIPTOR_SIZE = 0x0029;
+#if defined(_X86_)
+		static const int DS4_CONFIGURATION_SIZE = 0x0050;
+#else
+		static const int DS4_CONFIGURATION_SIZE = 0x0070;
+#endif
+
+		static const int DS4_MANUFACTURER_NAME_LENGTH = 0x38;
+		static const int DS4_PRODUCT_NAME_LENGTH = 0x28;
+		static const int DS4_OUTPUT_BUFFER_OFFSET = 0x04;
+		static const int DS4_OUTPUT_BUFFER_LENGTH = 0x05;
+
+		static const int DS4_REPORT_SIZE = 0x40;
+		static const int DS4_QUEUE_FLUSH_PERIOD = 0x05;
+
+		//
+		// HID Input Report buffer
+		//
+		UCHAR _Report[DS4_REPORT_SIZE];
+
+		//
+		// Output report cache
+		//
+		DS4_OUTPUT_REPORT _OutputReport;
+
+		//
+		// Timer for dispatching interrupt transfer
+		//
+		WDFTIMER _PendingUsbInRequestsTimer;
+
+		//
+		// Auto-generated MAC address of the target device
+		//
+		MAC_ADDRESS _TargetMacAddress;
+
+		//
+		// Default MAC address of the host (not used)
+		//
+		MAC_ADDRESS _HostMacAddress;	
+	};
+}

sys/EmulationTargetPDO.hpp

@@ -0,0 +1,300 @@
+/*
+* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
+*
+* BSD 3-Clause License
+*
+* Copyright (c) 2018-2020, Nefarius Software Solutions e.U. and Contributors
+* All rights reserved.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*
+* 1. Redistributions of source code must retain the above copyright notice, this
+*    list of conditions and the following disclaimer.
+*
+* 2. Redistributions in binary form must reproduce the above copyright notice,
+*    this list of conditions and the following disclaimer in the documentation
+*    and/or other materials provided with the distribution.
+*
+* 3. Neither the name of the copyright holder nor the names of its
+*    contributors may be used to endorse or promote products derived from
+*    this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+
+#pragma once
+
+#pragma warning(disable:5040)
+#include <DmfModules.Library.h>
+#pragma warning(default:5040)
+#include <ntddk.h>
+#include <wdf.h>
+#include <ntintsafe.h>
+
+#include <usb.h>
+#include <usbbusif.h>
+
+#include <ViGEm/Common.h>
+
+//
+// Some insane macro-magic =3
+// 
+#define P99_PROTECT(...) __VA_ARGS__
+#define COPY_BYTE_ARRAY(_dst_, _bytes_)   do {BYTE b[] = _bytes_; \
+                                            RtlCopyMemory(_dst_, b, RTL_NUMBER_OF_V1(b)); } while (0)
+
+namespace ViGEm::Bus::Core
+{
+	typedef struct _PDO_IDENTIFICATION_DESCRIPTION* PPDO_IDENTIFICATION_DESCRIPTION;
+
+	class EmulationTargetPDO
+	{
+	public:
+		EmulationTargetPDO(ULONG Serial, LONG SessionId, USHORT VendorId, USHORT ProductId);
+
+		virtual ~EmulationTargetPDO() = default;
+
+		static bool GetPdoByTypeAndSerial(
+			IN WDFDEVICE ParentDevice,
+			IN VIGEM_TARGET_TYPE Type,
+			IN ULONG SerialNo,
+			OUT EmulationTargetPDO** Object
+		);
+
+		static NTSTATUS EnqueueWaitDeviceReady(
+			WDFDEVICE ParentDevice,
+			ULONG SerialNo,
+			WDFREQUEST Request);
+
+		static EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COMPARE EvtChildListIdentificationDescriptionCompare;
+
+		virtual NTSTATUS PdoPrepareDevice(PWDFDEVICE_INIT DeviceInit,
+			PUNICODE_STRING DeviceId,
+			PUNICODE_STRING DeviceDescription) = 0;
+
+		virtual NTSTATUS PdoPrepareHardware() = 0;
+
+		virtual NTSTATUS PdoInitContext() = 0;
+
+		NTSTATUS PdoCreateDevice(_In_ WDFDEVICE ParentDevice,
+			_In_ PWDFDEVICE_INIT DeviceInit);
+
+		bool operator==(EmulationTargetPDO& other) const
+		{
+			return (other._SerialNo == this->_SerialNo);
+		}
+
+		virtual NTSTATUS UsbGetDeviceDescriptorType(PUSB_DEVICE_DESCRIPTOR pDescriptor) = 0;
+
+		NTSTATUS UsbSelectConfiguration(PURB Urb);
+
+		void UsbAbortPipe();
+
+		NTSTATUS UsbGetConfigurationDescriptorType(PURB Urb);
+
+		virtual NTSTATUS UsbClassInterface(PURB Urb) = 0;
+
+		virtual NTSTATUS UsbGetDescriptorFromInterface(PURB Urb) = 0;
+
+		virtual NTSTATUS UsbSelectInterface(PURB Urb) = 0;
+
+		virtual NTSTATUS UsbGetStringDescriptorType(PURB Urb) = 0;
+
+		virtual NTSTATUS UsbBulkOrInterruptTransfer(struct _URB_BULK_OR_INTERRUPT_TRANSFER* pTransfer,
+			WDFREQUEST Request) = 0;
+
+		virtual NTSTATUS UsbControlTransfer(PURB Urb) = 0;
+
+		NTSTATUS SubmitReport(PVOID NewReport);
+
+		NTSTATUS EnqueueNotification(WDFREQUEST Request) const;
+
+		bool IsOwnerProcess() const;
+
+		VIGEM_TARGET_TYPE GetType() const;
+
+		NTSTATUS PdoPrepare(WDFDEVICE ParentDevice);
+
+	private:
+		static unsigned long current_process_id();
+
+		static EVT_WDF_DEVICE_CONTEXT_CLEANUP EvtDeviceContextCleanup;
+
+		static bool GetPdoBySerial(
+			IN WDFDEVICE ParentDevice,
+			IN ULONG SerialNo,
+			OUT EmulationTargetPDO** Object
+		);
+
+		NTSTATUS EnqueueWaitDeviceReady(WDFREQUEST Request);
+		
+		HANDLE _WaitDeviceReadyCompletionWorkerThreadHandle{};
+
+	protected:
+		static const ULONG _maxHardwareIdLength = 0xFF;
+
+		static const int MAX_INSTANCE_ID_LEN = 80;
+
+		static const size_t MAX_OUT_BUFFER_QUEUE_COUNT = 64;
+		
+		static const size_t MAX_OUT_BUFFER_QUEUE_SIZE = 128;
+
+		static PCWSTR _deviceLocation;
+
+		static BOOLEAN USB_BUSIFFN UsbInterfaceIsDeviceHighSpeed(IN PVOID BusContext);
+
+		static NTSTATUS USB_BUSIFFN UsbInterfaceQueryBusInformation(
+			IN PVOID BusContext,
+			IN ULONG Level,
+			IN OUT PVOID BusInformationBuffer,
+			IN OUT PULONG BusInformationBufferLength,
+			OUT PULONG BusInformationActualLength
+		);
+
+		static NTSTATUS USB_BUSIFFN UsbInterfaceSubmitIsoOutUrb(IN PVOID BusContext, IN PURB Urb);
+
+		static NTSTATUS USB_BUSIFFN UsbInterfaceQueryBusTime(IN PVOID BusContext, IN OUT PULONG CurrentUsbFrame);
+
+		static VOID USB_BUSIFFN UsbInterfaceGetUSBDIVersion(
+			IN PVOID BusContext,
+			IN OUT PUSBD_VERSION_INFORMATION VersionInformation,
+			IN OUT PULONG HcdCapabilities
+		);
+
+		static EVT_WDF_DEVICE_PREPARE_HARDWARE EvtDevicePrepareHardware;
+
+		static EVT_WDF_IO_QUEUE_IO_INTERNAL_DEVICE_CONTROL EvtIoInternalDeviceControl;
+
+		static EVT_WDF_IO_QUEUE_STATE EvtWdfIoPendingNotificationQueueState;
+
+		static VOID WaitDeviceReadyCompletionWorkerRoutine(IN PVOID StartContext);
+
+		static VOID DumpAsHex(PCSTR Prefix, PVOID Buffer, ULONG BufferLength);
+		
+		virtual VOID GetConfigurationDescriptorType(PUCHAR Buffer, ULONG Length) = 0;
+
+		virtual NTSTATUS SelectConfiguration(PURB Urb) = 0;
+
+		virtual void AbortPipe() = 0;
+
+		virtual NTSTATUS SubmitReportImpl(PVOID NewReport) = 0;
+
+		virtual VOID ProcessPendingNotification(WDFQUEUE Queue) = 0;
+
+		//
+		// PNP Capabilities may differ from device to device
+		// 
+		WDF_DEVICE_PNP_CAPABILITIES _PnpCapabilities;
+
+		//
+		// Power Capabilities may differ from device to device
+		// 
+		WDF_DEVICE_POWER_CAPABILITIES _PowerCapabilities;
+
+		//
+		// Unique serial number of the device on the bus
+		// 
+		ULONG _SerialNo{};
+
+		// 
+		// PID of the process creating this PDO
+		// 
+		DWORD _OwnerProcessId{};
+
+		//
+		// File object session ID
+		// 
+		LONG _SessionId{};
+
+		//
+		// Device type this PDO is emulating
+		// 
+		VIGEM_TARGET_TYPE _TargetType;
+
+		//
+		// If set, the vendor ID the emulated device is reporting
+		// 
+		USHORT _VendorId{};
+
+		//
+		// If set, the product ID the emulated device is reporting
+		// 
+		USHORT _ProductId{};
+
+		//
+		// Queue for blocking plugin requests
+		// 
+		WDFQUEUE _WaitDeviceReadyRequests{};
+
+		//
+		// Queue for incoming data interrupt transfer
+		//
+		WDFQUEUE _PendingUsbInRequests{};
+
+		//
+		// Queue for inverted calls
+		//
+		WDFQUEUE _PendingNotificationRequests{};
+
+		//
+		// This child objects' device object
+		// 
+		WDFDEVICE _PdoDevice{};
+
+		//
+		// Configuration descriptor size (populated by derived class)
+		// 
+		ULONG _UsbConfigurationDescriptionSize{};
+
+		//
+		// Signals the bus that PDO is ready to receive data
+		// 
+		KEVENT _PdoBootNotificationEvent;
+
+		//
+		// Queue for interrupt out requests delivered to user-land
+		// 
+		DMFMODULE _UsbInterruptOutBufferQueue{};
+	};
+
+	typedef struct _PDO_IDENTIFICATION_DESCRIPTION
+	{
+		//
+		// List entity header
+		// 
+		WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER Header;
+
+		//
+		// Primary key to identify PDO
+		// 
+		ULONG SerialNo;
+
+		//
+		// Session ID
+		// 
+		LONG SessionId;
+
+		//
+		// Context object of PDO
+		// 
+		EmulationTargetPDO* Target;
+	} PDO_IDENTIFICATION_DESCRIPTION, * PPDO_IDENTIFICATION_DESCRIPTION;
+
+	typedef struct _EMULATION_TARGET_PDO_CONTEXT
+	{
+		EmulationTargetPDO* Target;
+	} EMULATION_TARGET_PDO_CONTEXT, * PEMULATION_TARGET_PDO_CONTEXT;
+
+	WDF_DECLARE_CONTEXT_TYPE_WITH_NAME(EMULATION_TARGET_PDO_CONTEXT, EmulationTargetPdoGetContext)
+}

sys/Queue.c

@@ -1,460 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-*
-* MIT License
-*
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-*
-* 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.
-*/
-
-
-#include "busenum.h"
-#include "queue.tmh"
-
-#ifdef ALLOC_PRAGMA
-#pragma alloc_text (PAGE, Bus_EvtIoDefault)
-#endif
-
-//
-// Responds to I/O control requests sent to the FDO.
-// 
-VOID Bus_EvtIoDeviceControl(
-    IN WDFQUEUE Queue,
-    IN WDFREQUEST Request,
-    IN size_t OutputBufferLength,
-    IN size_t InputBufferLength,
-    IN ULONG IoControlCode
-)
-{
-    NTSTATUS                    status = STATUS_INVALID_PARAMETER;
-    WDFDEVICE                   Device;
-    size_t                      length = 0;
-    PXUSB_SUBMIT_REPORT         xusbSubmit = NULL;
-    PXUSB_REQUEST_NOTIFICATION  xusbNotify = NULL;
-    PDS4_SUBMIT_REPORT          ds4Submit = NULL;
-    PDS4_REQUEST_NOTIFICATION   ds4Notify = NULL;
-    PXGIP_SUBMIT_REPORT         xgipSubmit = NULL;
-    PXGIP_SUBMIT_INTERRUPT      xgipInterrupt = NULL;
-    PVIGEM_CHECK_VERSION        pCheckVersion = NULL;
-    PXUSB_GET_USER_INDEX        pXusbGetUserIndex = NULL;
-
-    Device = WdfIoQueueGetDevice(Queue);
-
-    TraceEvents(TRACE_LEVEL_VERBOSE, TRACE_QUEUE, "%!FUNC! Entry (device: 0x%p)", Device);
-
-    switch (IoControlCode)
-    {
-#pragma region IOCTL_VIGEM_CHECK_VERSION
-    case IOCTL_VIGEM_CHECK_VERSION:
-
-        TraceEvents(TRACE_LEVEL_INFORMATION,
-            TRACE_QUEUE,
-            "IOCTL_VIGEM_CHECK_VERSION");
-
-        status = WdfRequestRetrieveInputBuffer(Request, sizeof(VIGEM_CHECK_VERSION), (PVOID)&pCheckVersion, &length);
-
-        if (!NT_SUCCESS(status) || length != sizeof(VIGEM_CHECK_VERSION))
-        {
-            status = STATUS_INVALID_PARAMETER;
-            break;
-        }
-
-        status = (pCheckVersion->Version == VIGEM_COMMON_VERSION) ? STATUS_SUCCESS : STATUS_NOT_SUPPORTED;
-
-        TraceEvents(TRACE_LEVEL_VERBOSE,
-            TRACE_QUEUE,
-            "Requested version: 0x%04X, compiled version: 0x%04X",
-            pCheckVersion->Version, VIGEM_COMMON_VERSION);
-
-        break;
-#pragma endregion 
-
-#pragma region IOCTL_VIGEM_PLUGIN_TARGET
-    case IOCTL_VIGEM_PLUGIN_TARGET:
-
-        TraceEvents(TRACE_LEVEL_INFORMATION,
-            TRACE_QUEUE,
-            "IOCTL_VIGEM_PLUGIN_TARGET");
-
-        status = Bus_PlugInDevice(Device, Request, FALSE, &length);
-
-        break;
-#pragma endregion 
-
-#pragma region IOCTL_VIGEM_UNPLUG_TARGET
-    case IOCTL_VIGEM_UNPLUG_TARGET:
-
-        TraceEvents(TRACE_LEVEL_INFORMATION,
-            TRACE_QUEUE,
-            "IOCTL_VIGEM_UNPLUG_TARGET");
-
-        status = Bus_UnPlugDevice(Device, Request, FALSE, &length);
-
-        break;
-#pragma endregion 
-
-#pragma region IOCTL_XUSB_SUBMIT_REPORT
-    case IOCTL_XUSB_SUBMIT_REPORT:
-
-        TraceEvents(TRACE_LEVEL_VERBOSE,
-            TRACE_QUEUE,
-            "IOCTL_XUSB_SUBMIT_REPORT");
-
-        status = WdfRequestRetrieveInputBuffer(Request, sizeof(XUSB_SUBMIT_REPORT), (PVOID)&xusbSubmit, &length);
-
-        if (!NT_SUCCESS(status))
-        {
-            TraceEvents(TRACE_LEVEL_ERROR,
-                TRACE_QUEUE,
-                "WdfRequestRetrieveInputBuffer failed with status %!STATUS!",
-                status);
-            break;
-        }
-
-        if ((sizeof(XUSB_SUBMIT_REPORT) == xusbSubmit->Size) && (length == InputBufferLength))
-        {
-            // This request only supports a single PDO at a time
-            if (xusbSubmit->SerialNo == 0)
-            {
-                TraceEvents(TRACE_LEVEL_ERROR,
-                    TRACE_QUEUE,
-                    "Invalid serial 0 submitted");
-
-                status = STATUS_INVALID_PARAMETER;
-                break;
-            }
-
-            status = Bus_XusbSubmitReport(Device, xusbSubmit->SerialNo, xusbSubmit, FALSE);
-        }
-
-        break;
-#pragma endregion 
-
-#pragma region IOCTL_XUSB_REQUEST_NOTIFICATION
-    case IOCTL_XUSB_REQUEST_NOTIFICATION:
-
-        TraceEvents(TRACE_LEVEL_INFORMATION,
-            TRACE_QUEUE,
-            "IOCTL_XUSB_REQUEST_NOTIFICATION");
-
-        // Don't accept the request if the output buffer can't hold the results
-        if (OutputBufferLength < sizeof(XUSB_REQUEST_NOTIFICATION))
-        {
-            TraceEvents(TRACE_LEVEL_ERROR,
-                TRACE_QUEUE,
-                "Output buffer %d too small, require at least %d",
-                (int)OutputBufferLength, (int)sizeof(XUSB_REQUEST_NOTIFICATION));
-            break;
-        }
-
-        status = WdfRequestRetrieveInputBuffer(Request, sizeof(XUSB_REQUEST_NOTIFICATION), (PVOID)&xusbNotify, &length);
-
-        if (!NT_SUCCESS(status))
-        {
-            TraceEvents(TRACE_LEVEL_ERROR,
-                TRACE_QUEUE,
-                "WdfRequestRetrieveInputBuffer failed with status %!STATUS!",
-                status);
-            break;
-        }
-
-        if ((sizeof(XUSB_REQUEST_NOTIFICATION) == xusbNotify->Size) && (length == InputBufferLength))
-        {
-            // This request only supports a single PDO at a time
-            if (xusbNotify->SerialNo == 0)
-            {
-                TraceEvents(TRACE_LEVEL_ERROR,
-                    TRACE_QUEUE,
-                    "Invalid serial 0 submitted");
-
-                status = STATUS_INVALID_PARAMETER;
-                break;
-            }
-
-            status = Bus_QueueNotification(Device, xusbNotify->SerialNo, Request);
-        }
-
-        break;
-#pragma endregion 
-
-#pragma region IOCTL_DS4_SUBMIT_REPORT
-    case IOCTL_DS4_SUBMIT_REPORT:
-
-        TraceEvents(TRACE_LEVEL_VERBOSE,
-            TRACE_QUEUE,
-            "IOCTL_DS4_SUBMIT_REPORT");
-
-        status = WdfRequestRetrieveInputBuffer(Request, sizeof(DS4_SUBMIT_REPORT), (PVOID)&ds4Submit, &length);
-
-        if (!NT_SUCCESS(status))
-        {
-            TraceEvents(TRACE_LEVEL_ERROR,
-                TRACE_QUEUE,
-                "WdfRequestRetrieveInputBuffer failed with status %!STATUS!",
-                status);
-            break;
-        }
-
-        if ((sizeof(DS4_SUBMIT_REPORT) == ds4Submit->Size) && (length == InputBufferLength))
-        {
-            // This request only supports a single PDO at a time
-            if (ds4Submit->SerialNo == 0)
-            {
-                TraceEvents(TRACE_LEVEL_ERROR,
-                    TRACE_QUEUE,
-                    "Invalid serial 0 submitted");
-
-                status = STATUS_INVALID_PARAMETER;
-                break;
-            }
-
-            status = Bus_Ds4SubmitReport(Device, ds4Submit->SerialNo, ds4Submit, FALSE);
-        }
-
-        break;
-#pragma endregion 
-
-#pragma region IOCTL_DS4_REQUEST_NOTIFICATION
-    case IOCTL_DS4_REQUEST_NOTIFICATION:
-
-        TraceEvents(TRACE_LEVEL_INFORMATION,
-            TRACE_QUEUE,
-            "IOCTL_DS4_REQUEST_NOTIFICATION");
-
-        // Don't accept the request if the output buffer can't hold the results
-        if (OutputBufferLength < sizeof(DS4_REQUEST_NOTIFICATION))
-        {
-            TraceEvents(TRACE_LEVEL_ERROR,
-                TRACE_QUEUE,
-                "Output buffer %d too small, require at least %d",
-                (int)OutputBufferLength, (int)sizeof(DS4_REQUEST_NOTIFICATION));
-            break;
-        }
-
-        status = WdfRequestRetrieveInputBuffer(Request, sizeof(DS4_REQUEST_NOTIFICATION), (PVOID)&ds4Notify, &length);
-
-        if (!NT_SUCCESS(status))
-        {
-            TraceEvents(TRACE_LEVEL_ERROR,
-                TRACE_QUEUE,
-                "WdfRequestRetrieveInputBuffer failed with status %!STATUS!",
-                status);
-            break;
-        }
-
-        if ((sizeof(DS4_REQUEST_NOTIFICATION) == ds4Notify->Size) && (length == InputBufferLength))
-        {
-            // This request only supports a single PDO at a time
-            if (ds4Notify->SerialNo == 0)
-            {
-                TraceEvents(TRACE_LEVEL_ERROR,
-                    TRACE_QUEUE,
-                    "Invalid serial 0 submitted");
-
-                status = STATUS_INVALID_PARAMETER;
-                break;
-            }
-
-            status = Bus_QueueNotification(Device, ds4Notify->SerialNo, Request);
-        }
-
-        break;
-#pragma endregion 
-
-#pragma region IOCTL_XGIP_SUBMIT_REPORT
-    case IOCTL_XGIP_SUBMIT_REPORT:
-
-        TraceEvents(TRACE_LEVEL_VERBOSE,
-            TRACE_QUEUE,
-            "IOCTL_XGIP_SUBMIT_REPORT");
-
-        status = WdfRequestRetrieveInputBuffer(Request, sizeof(XGIP_SUBMIT_REPORT), (PVOID)&xgipSubmit, &length);
-
-        if (!NT_SUCCESS(status))
-        {
-            KdPrint((DRIVERNAME "WdfRequestRetrieveInputBuffer failed 0x%x\n", status));
-            break;
-        }
-
-        if ((sizeof(XGIP_SUBMIT_REPORT) == xgipSubmit->Size) && (length == InputBufferLength))
-        {
-            // This request only supports a single PDO at a time
-            if (xgipSubmit->SerialNo == 0)
-            {
-                status = STATUS_INVALID_PARAMETER;
-                break;
-            }
-
-            status = Bus_XgipSubmitReport(Device, xgipSubmit->SerialNo, xgipSubmit, FALSE);
-        }
-
-        break;
-#pragma endregion 
-
-#pragma region IOCTL_XGIP_SUBMIT_INTERRUPT
-    case IOCTL_XGIP_SUBMIT_INTERRUPT:
-
-        KdPrint((DRIVERNAME "IOCTL_XGIP_SUBMIT_INTERRUPT\n"));
-
-        status = WdfRequestRetrieveInputBuffer(Request, sizeof(XGIP_SUBMIT_INTERRUPT), (PVOID)&xgipInterrupt, &length);
-
-        if (!NT_SUCCESS(status))
-        {
-            KdPrint((DRIVERNAME "WdfRequestRetrieveInputBuffer failed 0x%x\n", status));
-            break;
-        }
-
-        if ((sizeof(XGIP_SUBMIT_INTERRUPT) == xgipInterrupt->Size) && (length == InputBufferLength))
-        {
-            // This request only supports a single PDO at a time
-            if (xgipInterrupt->SerialNo == 0)
-            {
-                status = STATUS_INVALID_PARAMETER;
-                break;
-            }
-
-            status = Bus_XgipSubmitInterrupt(Device, xgipSubmit->SerialNo, xgipInterrupt, FALSE);
-        }
-
-        break;
-#pragma endregion 
-
-#pragma region IOCTL_XUSB_GET_USER_INDEX
-    case IOCTL_XUSB_GET_USER_INDEX:
-
-        KdPrint((DRIVERNAME "IOCTL_XUSB_GET_USER_INDEX"));
-
-        // Don't accept the request if the output buffer can't hold the results
-        if (OutputBufferLength < sizeof(XUSB_GET_USER_INDEX))
-        {
-            KdPrint((DRIVERNAME "IOCTL_XUSB_GET_USER_INDEX: output buffer too small: %ul\n", OutputBufferLength));
-            break;
-        }
-
-        status = WdfRequestRetrieveInputBuffer(
-            Request, 
-            sizeof(XUSB_GET_USER_INDEX), 
-            (PVOID)&pXusbGetUserIndex, 
-            &length);
-
-        if (!NT_SUCCESS(status))
-        {
-            KdPrint((DRIVERNAME "WdfRequestRetrieveInputBuffer failed 0x%x\n", status));
-            break;
-        }
-
-        if ((sizeof(XUSB_GET_USER_INDEX) == pXusbGetUserIndex->Size) && (length == InputBufferLength))
-        {
-            // This request only supports a single PDO at a time
-            if (pXusbGetUserIndex->SerialNo == 0)
-            {
-                status = STATUS_INVALID_PARAMETER;
-                break;
-            }
-
-            status = Xusb_GetUserIndex(Device, pXusbGetUserIndex);
-        }
-
-        break;
-#pragma endregion
-
-    default:
-
-        TraceEvents(TRACE_LEVEL_WARNING,
-            TRACE_QUEUE,
-            "Unknown I/O control code 0x%X", IoControlCode);
-
-        break; // default status is STATUS_INVALID_PARAMETER
-    }
-
-    if (status != STATUS_PENDING)
-    {
-        WdfRequestCompleteWithInformation(Request, status, length);
-    }
-    
-    TraceEvents(TRACE_LEVEL_VERBOSE, TRACE_QUEUE, "%!FUNC! Exit with status %!STATUS!", status);
-}
-
-//
-// Gets called upon driver-to-driver communication.
-// 
-// TODO: incomplete and unused currently
-// 
-VOID Bus_EvtIoInternalDeviceControl(
-    _In_ WDFQUEUE   Queue,
-    _In_ WDFREQUEST Request,
-    _In_ size_t     OutputBufferLength,
-    _In_ size_t     InputBufferLength,
-    _In_ ULONG      IoControlCode
-)
-{
-    NTSTATUS    status = STATUS_INVALID_PARAMETER;
-    WDFDEVICE   Device;
-    size_t      length = 0;
-
-    UNREFERENCED_PARAMETER(OutputBufferLength);
-    UNREFERENCED_PARAMETER(InputBufferLength);
-
-    Device = WdfIoQueueGetDevice(Queue);
-
-    KdPrint((DRIVERNAME "Bus_EvtIoInternalDeviceControl: 0x%p\n", Device));
-
-    switch (IoControlCode)
-    {
-    case IOCTL_VIGEM_PLUGIN_TARGET:
-
-        KdPrint((DRIVERNAME "IOCTL_VIGEM_PLUGIN_TARGET\n"));
-
-        status = Bus_PlugInDevice(Device, Request, TRUE, &length);
-
-        break;
-
-    case IOCTL_VIGEM_UNPLUG_TARGET:
-
-        KdPrint((DRIVERNAME "IOCTL_VIGEM_UNPLUG_TARGET\n"));
-
-        status = Bus_UnPlugDevice(Device, Request, TRUE, &length);
-
-        break;
-    }
-
-    if (status != STATUS_PENDING)
-    {
-        WdfRequestCompleteWithInformation(Request, status, length);
-    }
-}
-
-//
-// Catches unsupported requests.
-// 
-VOID Bus_EvtIoDefault(
-    _In_ WDFQUEUE Queue,
-    _In_ WDFREQUEST Request
-)
-{
-    UNREFERENCED_PARAMETER(Queue);
-    UNREFERENCED_PARAMETER(Request);
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_QUEUE, "%!FUNC! Entry");
-
-    WdfRequestComplete(Request, STATUS_INVALID_DEVICE_REQUEST);
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_QUEUE, "%!FUNC! Exit");
-}

sys/Queue.cpp

@@ -0,0 +1,480 @@
+/*
+* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
+*
+* BSD 3-Clause License
+*
+* Copyright (c) 2018-2020, Nefarius Software Solutions e.U. and Contributors
+* All rights reserved.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*
+* 1. Redistributions of source code must retain the above copyright notice, this
+*    list of conditions and the following disclaimer.
+*
+* 2. Redistributions in binary form must reproduce the above copyright notice,
+*    this list of conditions and the following disclaimer in the documentation
+*    and/or other materials provided with the distribution.
+*
+* 3. Neither the name of the copyright holder nor the names of its
+*    contributors may be used to endorse or promote products derived from
+*    this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+
+#include "Driver.h"
+#include "trace.h"
+#include "Queue.tmh"
+
+#include "EmulationTargetPDO.hpp"
+#include "XusbPdo.hpp"
+#include "Ds4Pdo.hpp"
+
+#include "Debugging.hpp"
+
+using ViGEm::Bus::Core::PDO_IDENTIFICATION_DESCRIPTION;
+using ViGEm::Bus::Core::EmulationTargetPDO;
+using ViGEm::Bus::Targets::EmulationTargetXUSB;
+using ViGEm::Bus::Targets::EmulationTargetDS4;
+
+
+EXTERN_C_START
+
+//
+// Responds to I/O control requests sent to the FDO.
+// 
+VOID Bus_EvtIoDeviceControl(
+	IN WDFQUEUE Queue,
+	IN WDFREQUEST Request,
+	IN size_t OutputBufferLength,
+	IN size_t InputBufferLength,
+	IN ULONG IoControlCode
+)
+{
+	NTSTATUS status = STATUS_INVALID_PARAMETER;
+	WDFDEVICE Device;
+	size_t length = 0;
+	PXUSB_SUBMIT_REPORT xusbSubmit = nullptr;
+	PXUSB_REQUEST_NOTIFICATION xusbNotify = nullptr;
+	PDS4_SUBMIT_REPORT ds4Submit = nullptr;
+	PDS4_REQUEST_NOTIFICATION ds4Notify = nullptr;
+	PVIGEM_CHECK_VERSION pCheckVersion = nullptr;
+	PVIGEM_WAIT_DEVICE_READY pWaitDeviceReady = nullptr;
+	PXUSB_GET_USER_INDEX pXusbGetUserIndex = nullptr;
+	EmulationTargetPDO* pdo;
+
+	Device = WdfIoQueueGetDevice(Queue);
+
+	TraceDbg(TRACE_QUEUE, "%!FUNC! Entry (device: 0x%p)", Device);
+
+	switch (IoControlCode)
+	{
+#pragma region IOCTL_VIGEM_CHECK_VERSION
+
+	case IOCTL_VIGEM_CHECK_VERSION:
+
+		TraceDbg(TRACE_QUEUE, "IOCTL_VIGEM_CHECK_VERSION");
+
+		status = WdfRequestRetrieveInputBuffer(
+			Request,
+			sizeof(VIGEM_CHECK_VERSION),
+			reinterpret_cast<PVOID*>(&pCheckVersion),
+			&length
+		);
+
+		if (!NT_SUCCESS(status) || length != sizeof(VIGEM_CHECK_VERSION))
+		{
+			status = STATUS_INVALID_PARAMETER;
+			break;
+		}
+
+		status = (pCheckVersion->Version == VIGEM_COMMON_VERSION) ? STATUS_SUCCESS : STATUS_NOT_SUPPORTED;
+
+		TraceEvents(TRACE_LEVEL_VERBOSE,
+		            TRACE_QUEUE,
+		            "Requested version: 0x%04X, compiled version: 0x%04X",
+		            pCheckVersion->Version, VIGEM_COMMON_VERSION);
+
+		break;
+
+#pragma endregion
+
+#pragma region IOCTL_VIGEM_WAIT_DEVICE_READY
+
+	case IOCTL_VIGEM_WAIT_DEVICE_READY:
+
+		TraceDbg(TRACE_QUEUE, "IOCTL_VIGEM_WAIT_DEVICE_READY");
+
+		status = WdfRequestRetrieveInputBuffer(
+			Request,
+			sizeof(VIGEM_WAIT_DEVICE_READY),
+			reinterpret_cast<PVOID*>(&pWaitDeviceReady),
+			&length
+		);
+
+		if (!NT_SUCCESS(status) || length != sizeof(VIGEM_WAIT_DEVICE_READY))
+		{
+			status = STATUS_INVALID_PARAMETER;
+			break;
+		}
+
+		// This request only supports a single PDO at a time
+		if (pWaitDeviceReady->SerialNo == 0)
+		{
+			TraceEvents(TRACE_LEVEL_ERROR,
+				TRACE_QUEUE,
+				"Invalid serial 0 submitted");
+
+			status = STATUS_INVALID_PARAMETER;
+			break;
+		}
+
+		status = EmulationTargetPDO::EnqueueWaitDeviceReady(
+			Device,
+			pWaitDeviceReady->SerialNo,
+			Request
+		);
+
+		status = NT_SUCCESS(status) ? STATUS_PENDING : STATUS_DEVICE_DOES_NOT_EXIST;
+		
+		break;
+
+#pragma endregion
+
+#pragma region IOCTL_VIGEM_PLUGIN_TARGET
+
+	case IOCTL_VIGEM_PLUGIN_TARGET:
+
+		TraceDbg(TRACE_QUEUE, "IOCTL_VIGEM_PLUGIN_TARGET");
+
+		status = Bus_PlugInDevice(Device, Request, FALSE, &length);
+
+		break;
+
+#pragma endregion
+
+#pragma region IOCTL_VIGEM_UNPLUG_TARGET
+
+	case IOCTL_VIGEM_UNPLUG_TARGET:
+
+		TraceDbg(TRACE_QUEUE, "IOCTL_VIGEM_UNPLUG_TARGET");
+
+		status = Bus_UnPlugDevice(Device, Request, FALSE, &length);
+
+		break;
+
+#pragma endregion
+
+#pragma region IOCTL_XUSB_SUBMIT_REPORT
+
+	case IOCTL_XUSB_SUBMIT_REPORT:
+
+		TraceDbg(TRACE_QUEUE, "IOCTL_XUSB_SUBMIT_REPORT");
+
+		status = WdfRequestRetrieveInputBuffer(
+			Request,
+			sizeof(XUSB_SUBMIT_REPORT),
+			reinterpret_cast<PVOID*>(&xusbSubmit),
+			&length
+		);
+
+		if (!NT_SUCCESS(status))
+		{
+			TraceEvents(TRACE_LEVEL_ERROR,
+			            TRACE_QUEUE,
+			            "WdfRequestRetrieveInputBuffer failed with status %!STATUS!",
+			            status);
+			break;
+		}
+
+		if ((sizeof(XUSB_SUBMIT_REPORT) == xusbSubmit->Size) && (length == InputBufferLength))
+		{
+			// This request only supports a single PDO at a time
+			if (xusbSubmit->SerialNo == 0)
+			{
+				TraceEvents(TRACE_LEVEL_ERROR,
+				            TRACE_QUEUE,
+				            "Invalid serial 0 submitted");
+
+				status = STATUS_INVALID_PARAMETER;
+				break;
+			}
+
+			if (!EmulationTargetPDO::GetPdoByTypeAndSerial(Device, Xbox360Wired, xusbSubmit->SerialNo, &pdo))
+				status = STATUS_DEVICE_DOES_NOT_EXIST;
+			else
+				status = pdo->SubmitReport(xusbSubmit);
+		}
+
+		break;
+
+#pragma endregion
+
+#pragma region IOCTL_XUSB_REQUEST_NOTIFICATION
+
+	case IOCTL_XUSB_REQUEST_NOTIFICATION:
+
+		TraceDbg(TRACE_QUEUE, "IOCTL_XUSB_REQUEST_NOTIFICATION");
+
+		// Don't accept the request if the output buffer can't hold the results
+		if (OutputBufferLength < sizeof(XUSB_REQUEST_NOTIFICATION))
+		{
+			TraceEvents(TRACE_LEVEL_ERROR,
+			            TRACE_QUEUE,
+			            "Output buffer %d too small, require at least %d",
+			            static_cast<int>(OutputBufferLength), static_cast<int>(sizeof(XUSB_REQUEST_NOTIFICATION)));
+			break;
+		}
+
+		status = WdfRequestRetrieveInputBuffer(
+			Request,
+			sizeof(XUSB_REQUEST_NOTIFICATION),
+			reinterpret_cast<PVOID*>(&xusbNotify),
+			&length
+		);
+
+		if (!NT_SUCCESS(status))
+		{
+			TraceEvents(TRACE_LEVEL_ERROR,
+			            TRACE_QUEUE,
+			            "WdfRequestRetrieveInputBuffer failed with status %!STATUS!",
+			            status);
+			break;
+		}
+
+		if ((sizeof(XUSB_REQUEST_NOTIFICATION) == xusbNotify->Size) && (length == InputBufferLength))
+		{
+			// This request only supports a single PDO at a time
+			if (xusbNotify->SerialNo == 0)
+			{
+				TraceEvents(TRACE_LEVEL_ERROR,
+				            TRACE_QUEUE,
+				            "Invalid serial 0 submitted");
+
+				status = STATUS_INVALID_PARAMETER;
+				break;
+			}
+
+			if (!EmulationTargetPDO::GetPdoByTypeAndSerial(Device, Xbox360Wired, xusbNotify->SerialNo, &pdo))
+				status = STATUS_DEVICE_DOES_NOT_EXIST;
+			else
+			{
+				status = pdo->EnqueueNotification(Request);
+
+				status = (NT_SUCCESS(status)) ? STATUS_PENDING : status;
+			}
+		}
+
+		break;
+
+#pragma endregion
+
+#pragma region IOCTL_DS4_SUBMIT_REPORT
+
+	case IOCTL_DS4_SUBMIT_REPORT:
+
+		TraceDbg(TRACE_QUEUE, "IOCTL_DS4_SUBMIT_REPORT");
+
+		status = WdfRequestRetrieveInputBuffer(
+			Request,
+			sizeof(DS4_SUBMIT_REPORT),
+			reinterpret_cast<PVOID*>(&ds4Submit),
+			&length
+		);
+
+		if (!NT_SUCCESS(status))
+		{
+			TraceEvents(TRACE_LEVEL_ERROR,
+			            TRACE_QUEUE,
+			            "WdfRequestRetrieveInputBuffer failed with status %!STATUS!",
+			            status);
+			break;
+		}
+
+		//
+		// Check if buffer is within expected bounds
+		// 
+		if (length < sizeof(DS4_SUBMIT_REPORT) || length > sizeof(DS4_SUBMIT_REPORT_EX))
+		{
+			TraceDbg(
+				TRACE_QUEUE,
+				"Unexpected buffer size: %d",
+				static_cast<ULONG>(length)
+			);
+
+			status = STATUS_INVALID_BUFFER_SIZE;
+			break;
+		}
+
+		//
+		// Check if this makes sense before passing it on
+		// 
+		if (length != ds4Submit->Size)
+		{
+			TraceDbg(
+				TRACE_QUEUE,
+				"Invalid buffer size: %d",
+				ds4Submit->Size
+			);
+
+			status = STATUS_INVALID_BUFFER_SIZE;
+			break;
+		}
+
+		// 
+		// This request only supports a single PDO at a time
+		// 
+		if (ds4Submit->SerialNo == 0)
+		{
+			TraceEvents(TRACE_LEVEL_ERROR,
+			            TRACE_QUEUE,
+			            "Invalid serial 0 submitted");
+
+			status = STATUS_INVALID_PARAMETER;
+			break;
+		}
+
+		if (!EmulationTargetPDO::GetPdoByTypeAndSerial(Device, DualShock4Wired, ds4Submit->SerialNo, &pdo))
+			status = STATUS_DEVICE_DOES_NOT_EXIST;
+		else
+			status = pdo->SubmitReport(ds4Submit);
+
+		break;
+
+#pragma endregion
+
+#pragma region IOCTL_DS4_REQUEST_NOTIFICATION
+
+	case IOCTL_DS4_REQUEST_NOTIFICATION:
+
+		TraceDbg(TRACE_QUEUE, "IOCTL_DS4_REQUEST_NOTIFICATION");
+
+		// Don't accept the request if the output buffer can't hold the results
+		if (OutputBufferLength < sizeof(DS4_REQUEST_NOTIFICATION))
+		{
+			TraceEvents(TRACE_LEVEL_ERROR,
+			            TRACE_QUEUE,
+			            "Output buffer %d too small, require at least %d",
+			            static_cast<int>(OutputBufferLength), static_cast<int>(sizeof(DS4_REQUEST_NOTIFICATION)));
+			break;
+		}
+
+		status = WdfRequestRetrieveInputBuffer(
+			Request,
+			sizeof(DS4_REQUEST_NOTIFICATION),
+			reinterpret_cast<PVOID*>(&ds4Notify),
+			&length
+		);
+
+		if (!NT_SUCCESS(status))
+		{
+			TraceEvents(TRACE_LEVEL_ERROR,
+			            TRACE_QUEUE,
+			            "WdfRequestRetrieveInputBuffer failed with status %!STATUS!",
+			            status);
+			break;
+		}
+
+		if ((sizeof(DS4_REQUEST_NOTIFICATION) == ds4Notify->Size) && (length == InputBufferLength))
+		{
+			// This request only supports a single PDO at a time
+			if (ds4Notify->SerialNo == 0)
+			{
+				TraceEvents(TRACE_LEVEL_ERROR,
+				            TRACE_QUEUE,
+				            "Invalid serial 0 submitted");
+
+				status = STATUS_INVALID_PARAMETER;
+				break;
+			}
+
+			if (!EmulationTargetPDO::GetPdoByTypeAndSerial(Device, DualShock4Wired, ds4Notify->SerialNo, &pdo))
+				status = STATUS_DEVICE_DOES_NOT_EXIST;
+			else
+			{
+				status = pdo->EnqueueNotification(Request);
+
+				status = (NT_SUCCESS(status)) ? STATUS_PENDING : status;
+			}
+		}
+
+		break;
+
+#pragma endregion
+
+#pragma region IOCTL_XUSB_GET_USER_INDEX
+
+	case IOCTL_XUSB_GET_USER_INDEX:
+
+		TraceDbg(TRACE_QUEUE, "IOCTL_XUSB_GET_USER_INDEX");
+
+		// Don't accept the request if the output buffer can't hold the results
+		if (OutputBufferLength < sizeof(XUSB_GET_USER_INDEX))
+		{
+			KdPrint((DRIVERNAME "IOCTL_XUSB_GET_USER_INDEX: output buffer too small: %ul\n", OutputBufferLength));
+			break;
+		}
+
+		status = WdfRequestRetrieveInputBuffer(
+			Request,
+			sizeof(XUSB_GET_USER_INDEX),
+			reinterpret_cast<PVOID*>(&pXusbGetUserIndex),
+			&length);
+
+		if (!NT_SUCCESS(status))
+		{
+			KdPrint((DRIVERNAME "WdfRequestRetrieveInputBuffer failed 0x%x\n", status));
+			break;
+		}
+
+		if ((sizeof(XUSB_GET_USER_INDEX) == pXusbGetUserIndex->Size) && (length == InputBufferLength))
+		{
+			// This request only supports a single PDO at a time
+			if (pXusbGetUserIndex->SerialNo == 0)
+			{
+				status = STATUS_INVALID_PARAMETER;
+				break;
+			}
+
+			if (!EmulationTargetPDO::GetPdoByTypeAndSerial(Device, Xbox360Wired, pXusbGetUserIndex->SerialNo, &pdo))
+			{
+				status = STATUS_DEVICE_DOES_NOT_EXIST;
+				break;
+			}
+
+			status = static_cast<EmulationTargetXUSB*>(pdo)->GetUserIndex(&pXusbGetUserIndex->UserIndex);
+		}
+
+		break;
+
+#pragma endregion
+
+	default:
+
+		TraceEvents(TRACE_LEVEL_WARNING,
+		            TRACE_QUEUE,
+		            "Unknown I/O control code 0x%X", IoControlCode);
+
+		break; // default status is STATUS_INVALID_PARAMETER
+	}
+
+	if (status != STATUS_PENDING)
+	{
+		WdfRequestCompleteWithInformation(Request, status, length);
+	}
+
+	TraceDbg(TRACE_QUEUE, "%!FUNC! Exit with status %!STATUS!", status);
+}
+
+EXTERN_C_END

sys/Queue.h

@@ -1,32 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-*
-* MIT License
-*
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-*
-* 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.
-*/
-
-
-#pragma once
-
-EVT_WDF_IO_QUEUE_IO_DEFAULT Bus_EvtIoDefault;
-EVT_WDF_IO_QUEUE_IO_DEVICE_CONTROL Bus_EvtIoDeviceControl;
-EVT_WDF_IO_QUEUE_IO_INTERNAL_DEVICE_CONTROL Bus_EvtIoInternalDeviceControl;

sys/Queue.hpp

@@ -0,0 +1,42 @@
+/*
+* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
+*
+* BSD 3-Clause License
+*
+* Copyright (c) 2018-2020, Nefarius Software Solutions e.U. and Contributors
+* All rights reserved.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*
+* 1. Redistributions of source code must retain the above copyright notice, this
+*    list of conditions and the following disclaimer.
+*
+* 2. Redistributions in binary form must reproduce the above copyright notice,
+*    this list of conditions and the following disclaimer in the documentation
+*    and/or other materials provided with the distribution.
+*
+* 3. Neither the name of the copyright holder nor the names of its
+*    contributors may be used to endorse or promote products derived from
+*    this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+
+#pragma once
+
+EXTERN_C_START
+
+EVT_WDF_IO_QUEUE_IO_DEVICE_CONTROL Bus_EvtIoDeviceControl;
+
+EXTERN_C_END

sys/README.md

@@ -1,17 +0,0 @@
-# ViGEm Bus Driver
-
-Currently supports emulation of the following USB gamepads:
-- [Microsoft Xbox 360 Controller](https://en.wikipedia.org/wiki/Xbox_360_controller)
-- [Sony DualShock 4 Controller](https://en.wikipedia.org/wiki/DualShock#DualShock_4)
-- [Microsoft Xbox One Controller](https://en.wikipedia.org/wiki/Xbox_One_Controller)
-  - Experimental; not ready for stable release yet
-
-## Necessary preparations for Windows 7
-Before installing the bus driver on Windows 7 (x86 or x64) the following 3rd party software has to be installed:
- * [Xbox 360 Accessories Software 1.2](https://www.microsoft.com/accessories/en-us/products/gaming/xbox-360-controller-for-windows/52a-00004#techspecs-connect) (contains the missing device drivers)
- * [Microsoft Security Advisory 3033929 Update](https://technet.microsoft.com/en-us/library/security/3033929) has to be installed to support the drivers signature. Download links:
-   * [Security Update for Windows 7 (KB3033929)](https://www.microsoft.com/en-us/download/details.aspx?id=46078)
-   * [Security Update for Windows 7 for x64-based Systems (KB3033929)](https://www.microsoft.com/en-us/download/details.aspx?id=46148)
-
-## Installation
-[Follow the installation instructions](https://github.com/nefarius/ViGEm/wiki/Driver-Installation).

sys/UsbPdo.h

@@ -1,53 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-*
-* MIT License
-*
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-*
-* 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.
-*/
-
-
-#pragma once
-
-BOOLEAN USB_BUSIFFN UsbPdo_IsDeviceHighSpeed(IN PVOID BusContext);
-NTSTATUS USB_BUSIFFN UsbPdo_QueryBusInformation(
-    IN PVOID BusContext,
-    IN ULONG Level,
-    IN OUT PVOID BusInformationBuffer,
-    IN OUT PULONG BusInformationBufferLength,
-    OUT PULONG BusInformationActualLength
-);
-NTSTATUS USB_BUSIFFN UsbPdo_SubmitIsoOutUrb(IN PVOID BusContext, IN PURB Urb);
-NTSTATUS USB_BUSIFFN UsbPdo_QueryBusTime(IN PVOID BusContext, IN OUT PULONG CurrentUsbFrame);
-VOID USB_BUSIFFN UsbPdo_GetUSBDIVersion(
-    IN PVOID BusContext,
-    IN OUT PUSBD_VERSION_INFORMATION VersionInformation,
-    IN OUT PULONG HcdCapabilities
-);
-NTSTATUS UsbPdo_GetDeviceDescriptorType(PURB urb, PPDO_DEVICE_DATA pCommon);
-NTSTATUS UsbPdo_GetConfigurationDescriptorType(PURB urb, PPDO_DEVICE_DATA pCommon);
-NTSTATUS UsbPdo_GetStringDescriptorType(PURB urb, PPDO_DEVICE_DATA pCommon);
-NTSTATUS UsbPdo_SelectConfiguration(PURB urb, PPDO_DEVICE_DATA pCommon);
-NTSTATUS UsbPdo_SelectInterface(PURB urb, PPDO_DEVICE_DATA pCommon);
-NTSTATUS UsbPdo_BulkOrInterruptTransfer(PURB urb, WDFDEVICE Device, WDFREQUEST Request);
-NTSTATUS UsbPdo_AbortPipe(WDFDEVICE Device);
-NTSTATUS UsbPdo_ClassInterface(PURB urb, WDFDEVICE Device, PPDO_DEVICE_DATA pCommon);
-NTSTATUS UsbPdo_GetDescriptorFromInterface(PURB urb, PPDO_DEVICE_DATA pCommon);

sys/Util.h

@@ -1,52 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-*
-* MIT License
-*
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-*
-* 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.
-*/
-
-
-#pragma once
-
-//
-// Returns the current caller process id.
-// 
-#define CURRENT_PROCESS_ID() ((DWORD)((DWORD_PTR)PsGetCurrentProcessId() & 0xFFFFFFFF))
-
-#define IS_OWNER(_pdo_) (_pdo_->OwnerProcessId == CURRENT_PROCESS_ID())
-
-//
-// Represents a MAC address.
-//
-typedef struct _MAC_ADDRESS
-{
-    UCHAR Vendor0;
-    UCHAR Vendor1;
-    UCHAR Vendor2;
-    UCHAR Nic0;
-    UCHAR Nic1;
-    UCHAR Nic2;
-} MAC_ADDRESS, *PMAC_ADDRESS;
-
-
-VOID ReverseByteArray(PUCHAR Array, INT Length);
-VOID GenerateRandomMacAddress(PMAC_ADDRESS Address);

sys/ViGEmBus.inf

@@ -1,26 +1,34 @@
 ; Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
 ; 
-; MIT License
+; BSD 3-Clause License
 ; 
-; Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
+; Copyright (c) 2018-2020, Nefarius Software Solutions e.U. and Contributors
+; All rights reserved.
 ; 
-; 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:
+; Redistribution and use in source and binary forms, with or without
+; modification, are permitted provided that the following conditions are met:
 ; 
-; The above copyright notice and this permission notice shall be included in all
-; copies or substantial portions of the Software.
+; 1. Redistributions of source code must retain the above copyright notice, this
+;    list of conditions and the following disclaimer.
 ; 
-; 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.
+; 2. Redistributions in binary form must reproduce the above copyright notice,
+;    this list of conditions and the following disclaimer in the documentation
+;    and/or other materials provided with the distribution.
+; 
+; 3. Neither the name of the copyright holder nor the names of its
+;    contributors may be used to endorse or promote products derived from
+;    this software without specific prior written permission.
+; 
+; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+; IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+; DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+; FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+; DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+; SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+; CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+; OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+; OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
 [Version]
@@ -30,18 +38,14 @@ ClassGuid={4D36E97D-E325-11CE-BFC1-08002BE10318}
 Provider=%ManufacturerName%
 CatalogFile=ViGEmBus.cat
 DriverVer= ;
+PnpLockdown=1
 
 [DestinationDirs]
 DefaultDestDir = 12
 ViGEmBus_Device_CoInstaller_CopyFiles = 11
 
-; ================= Class section =====================
-
-[SourceDisksNames.amd64]
-1 = %DiskName%,,,"\x64"
-
-[SourceDisksNames.x86]
-1 = %DiskName%,,,"\x86"
+[SourceDisksNames]
+1 = %DiskName%,,,
 
 [SourceDisksFiles]
 ViGEmBus.sys = 1,,
@@ -74,7 +78,7 @@ AddService = ViGEmBus,%SPSVCINST_ASSOCSERVICE%, ViGEmBus_Service_Inst
 [ViGEmBus_Service_Inst]
 DisplayName    = %ViGEmBus.SVCDESC%
 ServiceType    = 1               ; SERVICE_KERNEL_DRIVER
-StartType      = 3               ; SERVICE_DEMAND_START
+StartType      = 1               ; SERVICE_SYSTEM_START
 ErrorControl   = 1               ; SERVICE_ERROR_NORMAL
 ServiceBinary  = %12%\ViGEmBus.sys
 
@@ -100,6 +104,6 @@ KmdfLibraryVersion = $KMDFVERSION$
 [Strings]
 SPSVCINST_ASSOCSERVICE= 0x00000002
 ManufacturerName="Nefarius Software Solutions e.U."
-DiskName = "ViGEmBus Installation Disk"
-ViGEmBus.DeviceDesc = "Virtual Gamepad Emulation Bus"
-ViGEmBus.SVCDESC = "Virtual Gamepad Emulation Service"
+DiskName = "Nefarius ViGEmBus Installation Disk"
+ViGEmBus.DeviceDesc = "Nefarius Virtual Gamepad Emulation Bus"
+ViGEmBus.SVCDESC = "Nefarius Virtual Gamepad Emulation Service"

sys/ViGEmBus.rc

@@ -1,100 +1,49 @@
-// Microsoft Visual C++ generated resource script.
 //
-#include "resource.h"
-
-#define APSTUDIO_READONLY_SYMBOLS
-/////////////////////////////////////////////////////////////////////////////
+// Include the necessary resources
 //
-// Generated from the TEXTINCLUDE 2 resource.
+#include <winver.h>
+#include <ntdef.h>
+
+#ifdef RC_INVOKED
+
 //
-#include "winres.h"
-
-/////////////////////////////////////////////////////////////////////////////
-#undef APSTUDIO_READONLY_SYMBOLS
-
-/////////////////////////////////////////////////////////////////////////////
-// German (Austria) resources
-
-#if !defined(AFX_RESOURCE_DLL) || defined(AFX_TARG_DEA)
-LANGUAGE LANG_GERMAN, SUBLANG_GERMAN_AUSTRIAN
-#pragma code_page(1252)
-
-#ifdef APSTUDIO_INVOKED
-/////////////////////////////////////////////////////////////////////////////
-//
-// TEXTINCLUDE
+// Set up debug information
 //
+#if DBG
+#define VER_DBG VS_FF_DEBUG
+#else
+#define VER_DBG 0
+#endif
 
-1 TEXTINCLUDE 
-BEGIN
-    "resource.h\0"
-END
-
-2 TEXTINCLUDE 
-BEGIN
-    "#include ""winres.h""\r\n"
-    "\0"
-END
-
-3 TEXTINCLUDE 
-BEGIN
-    "\r\n"
-    "\0"
-END
-
-#endif    // APSTUDIO_INVOKED
-
-
-/////////////////////////////////////////////////////////////////////////////
-//
-// Version
-//
+// ------- version info -------------------------------------------------------
 
 VS_VERSION_INFO VERSIONINFO
- FILEVERSION 1,14,3,0
- PRODUCTVERSION 1,14,3,0
- FILEFLAGSMASK 0x3fL
-#ifdef _DEBUG
- FILEFLAGS 0x1L
-#else
- FILEFLAGS 0x0L
-#endif
- FILEOS 0x40004L
- FILETYPE 0xe9L
- FILESUBTYPE 0x0L
+FILEVERSION             1,16,200,0
+PRODUCTVERSION          1,16,200,0
+FILEFLAGSMASK           VS_FFI_FILEFLAGSMASK
+FILEFLAGS               VER_DBG
+FILEOS                  VOS_NT
+FILETYPE                VFT_DRV
+FILESUBTYPE             VFT2_DRV_SYSTEM
 BEGIN
-    BLOCK "StringFileInfo"
-    BEGIN
-        BLOCK "000904b0"
+	BLOCK "StringFileInfo"
+	BEGIN
+		BLOCK "040904b0"
         BEGIN
-            VALUE "CompanyName", "Benjamin H<>glinger-Stelzer"
-            VALUE "FileDescription", "Virtual Gamepad Emulation Bus Driver"
-VALUE "FileVersion", "1.14.3.0"
-            VALUE "InternalName", "Virtual Gamepad Emulation Bus Driver"
-            VALUE "LegalCopyright", "Copyright (C) Benjamin H<>glinger-Stelzer 2016"
-            VALUE "OriginalFilename", "vigembus.sys"
-            VALUE "ProductName", "Virtual Gamepad Emulation Bus Driver"
-VALUE "ProductVersion", "1.14.3.0"
+		VALUE "Comments",         "Virtual Gamepad Emulation Framework Bus Driver"
+		VALUE "CompanyName",      "Nefarius Software Solutions e.U."
+		VALUE "FileDescription",  "Virtual Gamepad Emulation Framework Bus Driver"
+		VALUE "FileVersion",      "1.16.200.0"
+		VALUE "InternalName",     "Virtual Gamepad Emulation Framework Bus Driver"
+		VALUE "LegalCopyright",   "(C) 2016-2020 Nefarius Software Solutions e.U."
+		VALUE "OriginalFilename", "ViGEmBus.sys"
+		VALUE "ProductName",      "Virtual Gamepad Emulation Framework Bus Driver"
+		VALUE "ProductVersion",	  "1.16.200.0"
         END
-    END
-    BLOCK "VarFileInfo"
-    BEGIN
-        VALUE "Translation", 0x9, 1200
-    END
+	END
+	BLOCK "VarFileInfo"
+	BEGIN
+		VALUE "Translation", 0x0409,1200
+	END
 END
-
-#endif    // German (Austria) resources
-/////////////////////////////////////////////////////////////////////////////
-
-
-
-#ifndef APSTUDIO_INVOKED
-/////////////////////////////////////////////////////////////////////////////
-//
-// Generated from the TEXTINCLUDE 3 resource.
-//
-
-
-/////////////////////////////////////////////////////////////////////////////
-#endif    // not APSTUDIO_INVOKED
-
+#endif

sys/ViGEmBus.vcxproj

@@ -17,10 +17,53 @@
       <Configuration>Release</Configuration>
       <Platform>x64</Platform>
     </ProjectConfiguration>
+    <ProjectConfiguration Include="Debug|ARM">
+      <Configuration>Debug</Configuration>
+      <Platform>ARM</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Release|ARM">
+      <Configuration>Release</Configuration>
+      <Platform>ARM</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Debug|ARM64">
+      <Configuration>Debug</Configuration>
+      <Platform>ARM64</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Release|ARM64">
+      <Configuration>Release</Configuration>
+      <Platform>ARM64</Platform>
+    </ProjectConfiguration>
+  </ItemGroup>
+  <ItemGroup>
+    <Inf Include="ViGEmBus.inf" />
+  </ItemGroup>
+  <ItemGroup>
+    <ClInclude Include="..\sdk\include\ViGEm\km\BusShared.h" />
+    <ClInclude Include="Debugging.hpp" />
+    <ClInclude Include="Driver.h" />
+    <ClInclude Include="CRTCPP.hpp" />
+    <ClInclude Include="Ds4Pdo.hpp" />
+    <ClInclude Include="EmulationTargetPDO.hpp" />
+    <ClInclude Include="Queue.hpp" />
+    <ClInclude Include="resource.h" />
+    <ClInclude Include="trace.h" />
+    <ClInclude Include="XusbPdo.hpp" />
+  </ItemGroup>
+  <ItemGroup>
+    <ResourceCompile Include="ViGEmBus.rc" />
+  </ItemGroup>
+  <ItemGroup>
+    <ClCompile Include="busenum.cpp" />
+    <ClCompile Include="buspdo.cpp" />
+    <ClCompile Include="Driver.cpp" />
+    <ClCompile Include="Ds4Pdo.cpp" />
+    <ClCompile Include="EmulationTargetPDO.cpp" />
+    <ClCompile Include="Queue.cpp" />
+    <ClCompile Include="XusbPdo.cpp" />
   </ItemGroup>
   <PropertyGroup Label="Globals">
     <ProjectGuid>{040101B0-EE5C-4EF1-99EE-9F81C795C001}</ProjectGuid>
-    <TemplateGuid>{1bc93793-694f-48fe-9372-81e2b05556fd}</TemplateGuid>
+    <TemplateGuid>{8c0e3d8b-df43-455b-815a-4a0e72973bc6}</TemplateGuid>
     <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
     <MinimumVisualStudioVersion>12.0</MinimumVisualStudioVersion>
     <Configuration>Debug</Configuration>
@@ -30,52 +73,96 @@
     <AppVeyorBuildVersion Condition=" '$(APPVEYOR_BUILD_VERSION)' == '' ">*</AppVeyorBuildVersion>
     <AppVeyorBuildVersion Condition=" '$(APPVEYOR_BUILD_VERSION)' != '' ">$(APPVEYOR_BUILD_VERSION)</AppVeyorBuildVersion>
   </PropertyGroup>
+  <PropertyGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
+    <PlatformToolset>WindowsKernelModeDriver10.0</PlatformToolset>
+    <ConfigurationType>Driver</ConfigurationType>
+    <DriverType>KMDF</DriverType>
+    <DriverTargetPlatform>Universal</DriverTargetPlatform>
+    <Inf2CatUseLocalTime>true</Inf2CatUseLocalTime>
+  </PropertyGroup>
+  <PropertyGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
+    <PlatformToolset>WindowsKernelModeDriver10.0</PlatformToolset>
+    <ConfigurationType>Driver</ConfigurationType>
+    <DriverType>KMDF</DriverType>
+    <DriverTargetPlatform>Universal</DriverTargetPlatform>
+    <Inf2CatUseLocalTime>true</Inf2CatUseLocalTime>
+    <SignMode>Off</SignMode>
+  </PropertyGroup>
+  <PropertyGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
+    <PlatformToolset>WindowsKernelModeDriver10.0</PlatformToolset>
+    <ConfigurationType>Driver</ConfigurationType>
+    <DriverType>KMDF</DriverType>
+    <DriverTargetPlatform>Universal</DriverTargetPlatform>
+    <Inf2CatUseLocalTime>true</Inf2CatUseLocalTime>
+  </PropertyGroup>
+  <PropertyGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
+    <PlatformToolset>WindowsKernelModeDriver10.0</PlatformToolset>
+    <ConfigurationType>Driver</ConfigurationType>
+    <DriverType>KMDF</DriverType>
+    <DriverTargetPlatform>Universal</DriverTargetPlatform>
+    <Inf2CatUseLocalTime>true</Inf2CatUseLocalTime>
+    <SignMode>Off</SignMode>
+  </PropertyGroup>
+  <PropertyGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|ARM'">
+    <PlatformToolset>WindowsKernelModeDriver10.0</PlatformToolset>
+    <ConfigurationType>Driver</ConfigurationType>
+    <DriverType>KMDF</DriverType>
+    <DriverTargetPlatform>Universal</DriverTargetPlatform>
+    <Inf2CatUseLocalTime>true</Inf2CatUseLocalTime>
+  </PropertyGroup>
+  <PropertyGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|ARM'">
+    <PlatformToolset>WindowsKernelModeDriver10.0</PlatformToolset>
+    <ConfigurationType>Driver</ConfigurationType>
+    <DriverType>KMDF</DriverType>
+    <DriverTargetPlatform>Universal</DriverTargetPlatform>
+    <Inf2CatUseLocalTime>true</Inf2CatUseLocalTime>
+  </PropertyGroup>
+  <PropertyGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|ARM64'">
+    <PlatformToolset>WindowsKernelModeDriver10.0</PlatformToolset>
+    <ConfigurationType>Driver</ConfigurationType>
+    <DriverType>KMDF</DriverType>
+    <DriverTargetPlatform>Universal</DriverTargetPlatform>
+    <Inf2CatUseLocalTime>true</Inf2CatUseLocalTime>
+  </PropertyGroup>
+  <PropertyGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|ARM64'">
+    <PlatformToolset>WindowsKernelModeDriver10.0</PlatformToolset>
+    <ConfigurationType>Driver</ConfigurationType>
+    <DriverType>KMDF</DriverType>
+    <DriverTargetPlatform>Universal</DriverTargetPlatform>
+    <Inf2CatUseLocalTime>true</Inf2CatUseLocalTime>
+  </PropertyGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration">
-    <TargetVersion>Windows7</TargetVersion>
+    <TargetVersion>Windows10</TargetVersion>
     <UseDebugLibraries>true</UseDebugLibraries>
-    <PlatformToolset>WindowsKernelModeDriver10.0</PlatformToolset>
-    <ConfigurationType>Driver</ConfigurationType>
-    <DriverType>KMDF</DriverType>
-    <DriverTargetPlatform>Desktop</DriverTargetPlatform>
-    <KMDF_VERSION_MAJOR>1</KMDF_VERSION_MAJOR>
-    <KMDF_VERSION_MINOR>9</KMDF_VERSION_MINOR>
-    <ALLOW_DATE_TIME>1</ALLOW_DATE_TIME>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">
-    <TargetVersion>Windows7</TargetVersion>
+    <TargetVersion>Windows10</TargetVersion>
     <UseDebugLibraries>false</UseDebugLibraries>
-    <PlatformToolset>WindowsKernelModeDriver10.0</PlatformToolset>
-    <ConfigurationType>Driver</ConfigurationType>
-    <DriverType>KMDF</DriverType>
-    <DriverTargetPlatform>Desktop</DriverTargetPlatform>
-    <KMDF_VERSION_MAJOR>1</KMDF_VERSION_MAJOR>
-    <KMDF_VERSION_MINOR>9</KMDF_VERSION_MINOR>
-    <ALLOW_DATE_TIME>1</ALLOW_DATE_TIME>
-    <SignMode>Off</SignMode>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
-    <TargetVersion>Windows7</TargetVersion>
+    <TargetVersion>Windows10</TargetVersion>
     <UseDebugLibraries>true</UseDebugLibraries>
-    <PlatformToolset>WindowsKernelModeDriver10.0</PlatformToolset>
-    <ConfigurationType>Driver</ConfigurationType>
-    <DriverType>KMDF</DriverType>
-    <DriverTargetPlatform>Desktop</DriverTargetPlatform>
-    <KMDF_VERSION_MAJOR>1</KMDF_VERSION_MAJOR>
-    <KMDF_VERSION_MINOR>9</KMDF_VERSION_MINOR>
-    <ALLOW_DATE_TIME>1</ALLOW_DATE_TIME>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
-    <TargetVersion>Windows7</TargetVersion>
+    <TargetVersion>Windows10</TargetVersion>
+    <UseDebugLibraries>false</UseDebugLibraries>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|ARM'" Label="Configuration">
+    <TargetVersion>Windows10</TargetVersion>
+    <UseDebugLibraries>true</UseDebugLibraries>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|ARM'" Label="Configuration">
+    <TargetVersion>Windows10</TargetVersion>
+    <UseDebugLibraries>false</UseDebugLibraries>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|ARM64'" Label="Configuration">
+    <TargetVersion>Windows10</TargetVersion>
+    <UseDebugLibraries>true</UseDebugLibraries>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|ARM64'" Label="Configuration">
+    <TargetVersion>Windows10</TargetVersion>
     <UseDebugLibraries>false</UseDebugLibraries>
-    <PlatformToolset>WindowsKernelModeDriver10.0</PlatformToolset>
-    <ConfigurationType>Driver</ConfigurationType>
-    <DriverType>KMDF</DriverType>
-    <DriverTargetPlatform>Desktop</DriverTargetPlatform>
-    <KMDF_VERSION_MAJOR>1</KMDF_VERSION_MAJOR>
-    <KMDF_VERSION_MINOR>9</KMDF_VERSION_MINOR>
-    <ALLOW_DATE_TIME>1</ALLOW_DATE_TIME>
-    <SignMode>Off</SignMode>
   </PropertyGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />
   <ImportGroup Label="ExtensionSettings">
@@ -87,128 +174,145 @@
   <PropertyGroup />
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
     <DebuggerFlavor>DbgengKernelDebugger</DebuggerFlavor>
-    <IncludePath>$(SolutionDir)include;$(SolutionDir)client\include;$(IncludePath)</IncludePath>
-    <Inf2CatUseLocalTime>true</Inf2CatUseLocalTime>
-    <EnableInf2cat>false</EnableInf2cat>
+    <IncludePath>$(SolutionDir)include;$(IncludePath);$(KMDF_INC_PATH)$(KMDF_VER_PATH)</IncludePath>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
     <DebuggerFlavor>DbgengKernelDebugger</DebuggerFlavor>
-    <IncludePath>$(SolutionDir)include;$(SolutionDir)client\include;$(IncludePath)</IncludePath>
-    <Inf2CatUseLocalTime>true</Inf2CatUseLocalTime>
+    <IncludePath>$(SolutionDir)include;$(IncludePath);$(KMDF_INC_PATH)$(KMDF_VER_PATH)</IncludePath>
     <OutDir>$(SolutionDir)bin\$(DDKPlatform)\</OutDir>
-    <EnableInf2cat>false</EnableInf2cat>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
     <DebuggerFlavor>DbgengKernelDebugger</DebuggerFlavor>
-    <IncludePath>$(SolutionDir)include;$(SolutionDir)client\include;$(IncludePath)</IncludePath>
-    <Inf2CatUseLocalTime>true</Inf2CatUseLocalTime>
-    <EnableInf2cat>false</EnableInf2cat>
+    <IncludePath>$(SolutionDir)include;$(IncludePath);$(KMDF_INC_PATH)$(KMDF_VER_PATH)</IncludePath>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
     <DebuggerFlavor>DbgengKernelDebugger</DebuggerFlavor>
-    <IncludePath>$(SolutionDir)include;$(SolutionDir)client\include;$(IncludePath)</IncludePath>
-    <Inf2CatUseLocalTime>true</Inf2CatUseLocalTime>
+    <IncludePath>$(SolutionDir)include;$(IncludePath);$(KMDF_INC_PATH)$(KMDF_VER_PATH)</IncludePath>
+    <OutDir>$(SolutionDir)bin\$(DDKPlatform)\</OutDir>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|ARM'">
+    <DebuggerFlavor>DbgengKernelDebugger</DebuggerFlavor>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|ARM'">
+    <DebuggerFlavor>DbgengKernelDebugger</DebuggerFlavor>
+    <OutDir>$(SolutionDir)bin\$(DDKPlatform)\</OutDir>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|ARM64'">
+    <DebuggerFlavor>DbgengKernelDebugger</DebuggerFlavor>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|ARM64'">
+    <DebuggerFlavor>DbgengKernelDebugger</DebuggerFlavor>
     <OutDir>$(SolutionDir)bin\$(DDKPlatform)\</OutDir>
-    <EnableInf2cat>false</EnableInf2cat>
   </PropertyGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
-    <Inf>
-      <TimeStamp>$(AppVeyorBuildVersion)</TimeStamp>
-    </Inf>
-    <Link>
-      <AdditionalDependencies>$(DDK_LIB_PATH)ntstrsafe.lib;$(DDK_LIB_PATH)wdmsec.lib;%(AdditionalDependencies)</AdditionalDependencies>
-    </Link>
     <ClCompile>
-      <WppRecorderEnabled>true</WppRecorderEnabled>
       <WppEnabled>true</WppEnabled>
-      <WppScanConfigurationData>trace.h</WppScanConfigurationData>
+      <WppRecorderEnabled>true</WppRecorderEnabled>
+      <WppScanConfigurationData Condition="'%(ClCompile.ScanConfigurationData)' == ''">trace.h</WppScanConfigurationData>
+      <WppKernelMode>true</WppKernelMode>
+      <PreprocessorDefinitions>_X86_=1;i386=1;STD_CALL;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <LanguageStandard>stdcpp17</LanguageStandard>
+      <AdditionalIncludeDirectories>..\..\DMF\DMF\Modules.Library;..\..\DMF\DMF\Framework;$(SolutionDir)include;$(SolutionDir)sdk\include;$(IntDir);%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
     </ClCompile>
+    <Link>
+      <AdditionalDependencies>..\..\DMF\Debug\Win32\lib\DmfK\DmfK.lib;$(DDK_LIB_PATH)wdmsec.lib;%(AdditionalDependencies);ntstrsafe.lib;usbdex.lib</AdditionalDependencies>
+    </Link>
   </ItemDefinitionGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
-    <Inf>
-      <TimeStamp>$(AppVeyorBuildVersion)</TimeStamp>
-    </Inf>
-    <Link>
-      <AdditionalDependencies>$(DDK_LIB_PATH)ntstrsafe.lib;$(DDK_LIB_PATH)wdmsec.lib;%(AdditionalDependencies)</AdditionalDependencies>
-    </Link>
     <ClCompile>
-      <FavorSizeOrSpeed>Speed</FavorSizeOrSpeed>
-    </ClCompile>
-    <ClCompile>
-      <WholeProgramOptimization>true</WholeProgramOptimization>
-      <WppRecorderEnabled>true</WppRecorderEnabled>
       <WppEnabled>true</WppEnabled>
-      <WppScanConfigurationData>trace.h</WppScanConfigurationData>
+      <WppRecorderEnabled>true</WppRecorderEnabled>
+      <WppScanConfigurationData Condition="'%(ClCompile.ScanConfigurationData)' == ''">trace.h</WppScanConfigurationData>
+      <WppKernelMode>true</WppKernelMode>
+      <PreprocessorDefinitions>_X86_=1;i386=1;STD_CALL;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <LanguageStandard>stdcpp17</LanguageStandard>
+      <AdditionalIncludeDirectories>..\..\DMF\DMF\Modules.Library;..\..\DMF\DMF\Framework;$(SolutionDir)include;$(SolutionDir)sdk\include;$(IntDir);%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
     </ClCompile>
+    <Link>
+      <AdditionalDependencies>..\..\DMF\Release\Win32\lib\DmfK\DmfK.lib;$(DDK_LIB_PATH)wdmsec.lib;%(AdditionalDependencies);ntstrsafe.lib;usbdex.lib</AdditionalDependencies>
+    </Link>
+    <Inf>
+      <TimeStamp>1.0.0.0</TimeStamp>
+    </Inf>
   </ItemDefinitionGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
-    <Inf>
-      <TimeStamp>$(AppVeyorBuildVersion)</TimeStamp>
-    </Inf>
-    <Link>
-      <AdditionalDependencies>$(DDK_LIB_PATH)ntstrsafe.lib;$(DDK_LIB_PATH)wdmsec.lib;%(AdditionalDependencies)</AdditionalDependencies>
-      <LinkTimeCodeGeneration>UseLinkTimeCodeGeneration</LinkTimeCodeGeneration>
-    </Link>
     <ClCompile>
-      <WppRecorderEnabled>true</WppRecorderEnabled>
       <WppEnabled>true</WppEnabled>
-      <WppScanConfigurationData>trace.h</WppScanConfigurationData>
+      <WppRecorderEnabled>true</WppRecorderEnabled>
+      <WppScanConfigurationData Condition="'%(ClCompile.ScanConfigurationData)' == ''">trace.h</WppScanConfigurationData>
+      <WppKernelMode>true</WppKernelMode>
+      <PreprocessorDefinitions>_WIN64;_AMD64_;AMD64;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <LanguageStandard>stdcpp17</LanguageStandard>
+      <AdditionalIncludeDirectories>..\..\DMF\DMF\Modules.Library;..\..\DMF\DMF\Framework;$(SolutionDir)include;$(SolutionDir)sdk\include;$(IntDir);%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
     </ClCompile>
+    <Link>
+      <AdditionalDependencies>..\..\DMF\Debug\x64\lib\DmfK\DmfK.lib;$(DDK_LIB_PATH)wdmsec.lib;%(AdditionalDependencies);ntstrsafe.lib;usbdex.lib</AdditionalDependencies>
+    </Link>
   </ItemDefinitionGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
-    <Inf>
-      <TimeStamp>$(AppVeyorBuildVersion)</TimeStamp>
-    </Inf>
-    <Link>
-      <AdditionalDependencies>$(DDK_LIB_PATH)ntstrsafe.lib;$(DDK_LIB_PATH)wdmsec.lib;%(AdditionalDependencies)</AdditionalDependencies>
-      <LinkTimeCodeGeneration>UseLinkTimeCodeGeneration</LinkTimeCodeGeneration>
-    </Link>
     <ClCompile>
-      <FavorSizeOrSpeed>Speed</FavorSizeOrSpeed>
-    </ClCompile>
-    <ClCompile>
-      <WholeProgramOptimization>true</WholeProgramOptimization>
-      <WppRecorderEnabled>true</WppRecorderEnabled>
       <WppEnabled>true</WppEnabled>
-      <WppScanConfigurationData>trace.h</WppScanConfigurationData>
+      <WppRecorderEnabled>true</WppRecorderEnabled>
+      <WppScanConfigurationData Condition="'%(ClCompile.ScanConfigurationData)' == ''">trace.h</WppScanConfigurationData>
+      <WppKernelMode>true</WppKernelMode>
+      <PreprocessorDefinitions>_WIN64;_AMD64_;AMD64;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <LanguageStandard>stdcpp17</LanguageStandard>
+      <AdditionalIncludeDirectories>..\..\DMF\DMF\Modules.Library;..\..\DMF\DMF\Framework;$(SolutionDir)include;$(SolutionDir)sdk\include;$(IntDir);%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
     </ClCompile>
+    <Link>
+      <AdditionalDependencies>..\..\DMF\Release\x64\lib\DmfK\DmfK.lib;$(DDK_LIB_PATH)wdmsec.lib;%(AdditionalDependencies);ntstrsafe.lib;usbdex.lib</AdditionalDependencies>
+    </Link>
+    <Inf>
+      <TimeStamp>1.0.0.0</TimeStamp>
+    </Inf>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|ARM'">
+    <ClCompile>
+      <WppEnabled>true</WppEnabled>
+      <WppRecorderEnabled>true</WppRecorderEnabled>
+      <WppScanConfigurationData Condition="'%(ClCompile.ScanConfigurationData)' == ''">trace.h</WppScanConfigurationData>
+      <WppKernelMode>true</WppKernelMode>
+    </ClCompile>
+    <Link>
+      <AdditionalDependencies>%(AdditionalDependencies);ntstrsafe.lib</AdditionalDependencies>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|ARM'">
+    <ClCompile>
+      <WppEnabled>true</WppEnabled>
+      <WppRecorderEnabled>true</WppRecorderEnabled>
+      <WppScanConfigurationData Condition="'%(ClCompile.ScanConfigurationData)' == ''">trace.h</WppScanConfigurationData>
+      <WppKernelMode>true</WppKernelMode>
+    </ClCompile>
+    <Link>
+      <AdditionalDependencies>%(AdditionalDependencies);ntstrsafe.lib</AdditionalDependencies>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|ARM64'">
+    <ClCompile>
+      <WppEnabled>true</WppEnabled>
+      <WppRecorderEnabled>true</WppRecorderEnabled>
+      <WppScanConfigurationData Condition="'%(ClCompile.ScanConfigurationData)' == ''">trace.h</WppScanConfigurationData>
+      <WppKernelMode>true</WppKernelMode>
+    </ClCompile>
+    <Link>
+      <AdditionalDependencies>%(AdditionalDependencies);ntstrsafe.lib</AdditionalDependencies>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|ARM64'">
+    <ClCompile>
+      <WppEnabled>true</WppEnabled>
+      <WppRecorderEnabled>true</WppRecorderEnabled>
+      <WppScanConfigurationData Condition="'%(ClCompile.ScanConfigurationData)' == ''">trace.h</WppScanConfigurationData>
+      <WppKernelMode>true</WppKernelMode>
+    </ClCompile>
+    <Link>
+      <AdditionalDependencies>%(AdditionalDependencies);ntstrsafe.lib</AdditionalDependencies>
+    </Link>
   </ItemDefinitionGroup>
-  <ItemGroup>
-    <Inf Include="ViGEmBus.inf" />
-  </ItemGroup>
   <ItemGroup>
     <FilesToPackage Include="$(TargetPath)" />
   </ItemGroup>
-  <ItemGroup>
-    <ClInclude Include="$(SolutionDir)\Include\ViGEmBusDriver.h" />
-    <ClInclude Include="..\client\include\ViGEm\km\BusShared.h" />
-    <ClInclude Include="busenum.h" />
-    <ClInclude Include="ByteArray.h" />
-    <ClInclude Include="Context.h" />
-    <ClInclude Include="Ds4.h" />
-    <ClInclude Include="Queue.h" />
-    <ClInclude Include="resource.h" />
-    <ClInclude Include="trace.h" />
-    <ClInclude Include="UsbPdo.h" />
-    <ClInclude Include="Util.h" />
-    <ClInclude Include="Xgip.h" />
-    <ClInclude Include="Xusb.h" />
-  </ItemGroup>
-  <ItemGroup>
-    <ResourceCompile Include="ViGEmBus.rc" />
-  </ItemGroup>
-  <ItemGroup>
-    <ClCompile Include="busenum.c" />
-    <ClCompile Include="buspdo.c" />
-    <ClCompile Include="ByteArray.c" />
-    <ClCompile Include="Driver.c" />
-    <ClCompile Include="Ds4.c" />
-    <ClCompile Include="Queue.c" />
-    <ClCompile Include="UsbPdo.c" />
-    <ClCompile Include="Util.c" />
-    <ClCompile Include="xgip.c" />
-    <ClCompile Include="xusb.c" />
-  </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
   <ImportGroup Label="ExtensionTargets">
   </ImportGroup>

sys/ViGEmBus.vcxproj.filters

@@ -17,8 +17,11 @@
       <UniqueIdentifier>{8E41214B-6785-4CFE-B992-037D68949A14}</UniqueIdentifier>
       <Extensions>inf;inv;inx;mof;mc;</Extensions>
     </Filter>
-    <Filter Include="Header Files\Common">
-      <UniqueIdentifier>{bbf85b1d-5a75-4302-af4e-46627fcf0d78}</UniqueIdentifier>
+    <Filter Include="Header Files\Targets">
+      <UniqueIdentifier>{b00da32a-ce46-490d-9e77-95bb90925995}</UniqueIdentifier>
+    </Filter>
+    <Filter Include="Source Files\Targets">
+      <UniqueIdentifier>{3a87fd70-9882-47c4-a23b-50dd0b42b0f8}</UniqueIdentifier>
     </Filter>
   </ItemGroup>
   <ItemGroup>
@@ -27,73 +30,63 @@
     </Inf>
   </ItemGroup>
   <ItemGroup>
-    <ClInclude Include="busenum.h">
-      <Filter>Header Files</Filter>
-    </ClInclude>
-    <ClInclude Include="Queue.h">
-      <Filter>Header Files</Filter>
-    </ClInclude>
-    <ClInclude Include="UsbPdo.h">
-      <Filter>Header Files</Filter>
-    </ClInclude>
-    <ClInclude Include="Context.h">
-      <Filter>Header Files</Filter>
-    </ClInclude>
-    <ClInclude Include="Xusb.h">
-      <Filter>Header Files</Filter>
-    </ClInclude>
-    <ClInclude Include="Ds4.h">
-      <Filter>Header Files</Filter>
-    </ClInclude>
-    <ClInclude Include="Util.h">
-      <Filter>Header Files</Filter>
-    </ClInclude>
-    <ClInclude Include="Xgip.h">
-      <Filter>Header Files</Filter>
-    </ClInclude>
-    <ClInclude Include="ByteArray.h">
-      <Filter>Header Files</Filter>
-    </ClInclude>
-    <ClInclude Include="$(SolutionDir)\Include\ViGEmBusDriver.h">
-      <Filter>Header Files\Common</Filter>
-    </ClInclude>
     <ClInclude Include="trace.h">
       <Filter>Header Files</Filter>
     </ClInclude>
-    <ClInclude Include="..\client\include\ViGEm\km\BusShared.h">
+    <ClInclude Include="resource.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+    <ClInclude Include="XusbPdo.hpp">
+      <Filter>Header Files\Targets</Filter>
+    </ClInclude>
+    <ClInclude Include="EmulationTargetPDO.hpp">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+    <ClInclude Include="CRTCPP.hpp">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+    <ClInclude Include="Ds4Pdo.hpp">
+      <Filter>Header Files\Targets</Filter>
+    </ClInclude>
+    <ClInclude Include="Queue.hpp">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+    <ClInclude Include="Driver.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+    <ClInclude Include="..\sdk\include\ViGEm\km\BusShared.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+    <ClInclude Include="Debugging.hpp">
       <Filter>Header Files</Filter>
     </ClInclude>
   </ItemGroup>
   <ItemGroup>
-    <ClCompile Include="busenum.c">
+    <ClCompile Include="XusbPdo.cpp">
+      <Filter>Source Files\Targets</Filter>
+    </ClCompile>
+    <ClCompile Include="EmulationTargetPDO.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
-    <ClCompile Include="buspdo.c">
+    <ClCompile Include="Ds4Pdo.cpp">
+      <Filter>Source Files\Targets</Filter>
+    </ClCompile>
+    <ClCompile Include="buspdo.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
-    <ClCompile Include="xusb.c">
+    <ClCompile Include="busenum.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
-    <ClCompile Include="xgip.c">
+    <ClCompile Include="Queue.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
-    <ClCompile Include="Queue.c">
-      <Filter>Source Files</Filter>
-    </ClCompile>
-    <ClCompile Include="Ds4.c">
-      <Filter>Source Files</Filter>
-    </ClCompile>
-    <ClCompile Include="UsbPdo.c">
-      <Filter>Source Files</Filter>
-    </ClCompile>
-    <ClCompile Include="Util.c">
-      <Filter>Source Files</Filter>
-    </ClCompile>
-    <ClCompile Include="Driver.c">
-      <Filter>Source Files</Filter>
-    </ClCompile>
-    <ClCompile Include="ByteArray.c">
+    <ClCompile Include="Driver.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
   </ItemGroup>
+  <ItemGroup>
+    <ResourceCompile Include="ViGEmBus.rc">
+      <Filter>Resource Files</Filter>
+    </ResourceCompile>
+  </ItemGroup>
 </Project>

sys/Xgip.h

@@ -1,101 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-*
-* MIT License
-*
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-*
-* 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.
-*/
-
-
-// 
-// For children emulating XGIP devices, the following dummy interfaces 
-// have to be exposed by the PDO or else the child devices won't start
-// 
-
-// Below these interfaces are from wdmguid.h being used as dummies
-// {70211B0E-0AFB-47DB-AFC1-410BF842497A} PNP_LOCATION_INTERFACE
-// {B38290E5-3CD0-4F9D-9937-F5FE2B44D47A} D3COLD_SUPPORT_INTERFACE
-// {2AEB0243-6A6E-486B-82FC-D815F6B97006} REENUMERATE_SELF_INTERFACE_STANDARD
-
-// {DC7A8E51-49B3-4A3A-9E81-625205E7D729} Seems to be GUID_POWER_THREAD_INTERFACE
-// Source: https://github.com/microsoft/Windows-Driver-Frameworks/blob/master/src/framework/shared/irphandlers/pnp/fxpkgpnp.cpp#L63
-DEFINE_GUID(GUID_DEVINTERFACE_XGIP_GUID_POWER_THREAD_INTERFACE_DUMMY,
-    0xDC7A8E51, 0x49B3, 0x4A3A, 0x9E, 0x81, 0x62, 0x52, 0x05, 0xE7, 0xD7, 0x29);
-
-// {DEEE98EA-C0A1-42C3-9738-A04606C84E93}
-DEFINE_GUID(GUID_DEVINTERFACE_XGIP_UNKNOWN_4,
-    0xDEEE98EA, 0xC0A1, 0x42C3, 0x97, 0x38, 0xA0, 0x46, 0x06, 0xC8, 0x4E, 0x93);
-
-
-#pragma once
-
-#define XGIP_DESCRIPTOR_SIZE            0x0040
-#define XGIP_CONFIGURATION_SIZE         0x88
-#define XGIP_REPORT_SIZE                0x12
-#define XGIP_SYS_INIT_PACKETS           0x0F
-#define XGIP_SYS_INIT_PERIOD            0x32
-
-typedef struct _XGIP_DEVICE_DATA
-{
-    UCHAR Report[XGIP_REPORT_SIZE];
-
-    //
-    // Queue for incoming interrupt transfer
-    //
-    WDFQUEUE PendingUsbInRequests;
-
-    //
-    // Queue for inverted calls
-    //
-    WDFQUEUE PendingNotificationRequests;
-
-    WDFCOLLECTION XboxgipSysInitCollection;
-
-    BOOLEAN XboxgipSysInitReady;
-
-    WDFTIMER XboxgipSysInitTimer;
-} XGIP_DEVICE_DATA, *PXGIP_DEVICE_DATA;
-
-WDF_DECLARE_CONTEXT_TYPE_WITH_NAME(XGIP_DEVICE_DATA, XgipGetData)
-
-
-NTSTATUS
-Bus_XgipSubmitInterrupt(
-    WDFDEVICE Device,
-    ULONG SerialNo,
-    PXGIP_SUBMIT_INTERRUPT Report,
-    _In_ BOOLEAN FromInterface
-);
-
-//
-// XGIP-specific functions
-// 
-NTSTATUS Xgip_PreparePdo(
-    PWDFDEVICE_INIT DeviceInit,
-    PUNICODE_STRING DeviceId,
-    PUNICODE_STRING DeviceDescription
-);
-NTSTATUS Xgip_PrepareHardware(WDFDEVICE Device);
-NTSTATUS Xgip_AssignPdoContext(WDFDEVICE Device);
-VOID Xgip_GetConfigurationDescriptorType(PUCHAR Buffer, ULONG Length);
-VOID Xgip_GetDeviceDescriptorType(PUSB_DEVICE_DESCRIPTOR pDescriptor, PPDO_DEVICE_DATA pCommon);
-VOID Xgip_SelectConfiguration(PUSBD_INTERFACE_INFORMATION pInfo);
-

sys/Xusb.h

@@ -1,138 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-*
-* MIT License
-*
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-*
-* 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.
-*/
-
-
-// 
-// For children emulating XUSB devices, the following dummy interfaces 
-// have to be exposed by the PDO or else the child devices won't start
-// 
-// TODO: that statement might be obsolete, further testing required
-// 
-
-// Below these interfaces are from wdmguid.h being used as dummies
-// {70211B0E-0AFB-47DB-AFC1-410BF842497A} PNP_LOCATION_INTERFACE
-// {B38290E5-3CD0-4F9D-9937-F5FE2B44D47A} D3COLD_SUPPORT_INTERFACE
-// {2AEB0243-6A6E-486B-82FC-D815F6B97006} REENUMERATE_SELF_INTERFACE_STANDARD
-
-#pragma once
-
-#if defined(_X86_)
-#define XUSB_CONFIGURATION_SIZE         0x00E4
-#else
-#define XUSB_CONFIGURATION_SIZE         0x0130
-#endif
-#define XUSB_DESCRIPTOR_SIZE            0x0099
-#define XUSB_RUMBLE_SIZE                0x08
-#define XUSB_LEDSET_SIZE                0x03
-#define XUSB_LEDNUM_SIZE                0x01
-#define XUSB_INIT_STAGE_SIZE            0x03
-#define XUSB_BLOB_STORAGE_SIZE          0x2A
-
-#define XUSB_BLOB_00_OFFSET             0x00
-#define XUSB_BLOB_01_OFFSET             0x03
-#define XUSB_BLOB_02_OFFSET             0x06
-#define XUSB_BLOB_03_OFFSET             0x09
-#define XUSB_BLOB_04_OFFSET             0x0C
-#define XUSB_BLOB_05_OFFSET             0x20
-#define XUSB_BLOB_06_OFFSET             0x23
-#define XUSB_BLOB_07_OFFSET             0x26
-
-#define XUSB_IS_DATA_PIPE(_x_)          ((BOOLEAN)(_x_->PipeHandle == (USBD_PIPE_HANDLE)0xFFFF0081))
-#define XUSB_IS_CONTROL_PIPE(_x_)       ((BOOLEAN)(_x_->PipeHandle == (USBD_PIPE_HANDLE)0xFFFF0083))
-
-typedef struct _XUSB_INTERRUPT_IN_PACKET
-{
-    UCHAR Id;
-
-    UCHAR Size;
-
-    XUSB_REPORT Report;
-
-} XUSB_INTERRUPT_IN_PACKET, *PXUSB_INTERRUPT_IN_PACKET;
-
-//
-// XUSB-specific device context data.
-// 
-typedef struct _XUSB_DEVICE_DATA
-{
-    //
-    // Rumble buffer
-    //
-    UCHAR Rumble[XUSB_RUMBLE_SIZE];
-
-    //
-    // LED number (represents XInput slot index)
-    //
-    CHAR LedNumber;
-
-    //
-    // Report packet
-    //
-    XUSB_INTERRUPT_IN_PACKET Packet;
-
-    //
-    // Queue for incoming control interrupt transfer
-    //
-    WDFQUEUE HoldingUsbInRequests;
-
-    //
-    // Required for XInputGetCapabilities to work
-    // 
-    BOOLEAN ReportedCapabilities;
-
-    //
-    // Required for XInputGetCapabilities to work
-    // 
-    ULONG InterruptInitStage;
-
-    //
-    // Storage of binary blobs (packets) for PDO initialization
-    // 
-    WDFMEMORY InterruptBlobStorage;
-
-} XUSB_DEVICE_DATA, *PXUSB_DEVICE_DATA;
-
-WDF_DECLARE_CONTEXT_TYPE_WITH_NAME(XUSB_DEVICE_DATA, XusbGetData)
-
-
-NTSTATUS
-Bus_XusbSubmitReport(
-    WDFDEVICE Device,
-    ULONG SerialNo,
-    PXUSB_SUBMIT_REPORT Report,
-    _In_ BOOLEAN FromInterface
-);
-
-//
-// XUSB-specific functions
-// 
-NTSTATUS Xusb_PreparePdo(PWDFDEVICE_INIT DeviceInit, USHORT VendorId, USHORT ProductId, PUNICODE_STRING DeviceId, PUNICODE_STRING DeviceDescription);
-NTSTATUS Xusb_PrepareHardware(WDFDEVICE Device);
-NTSTATUS Xusb_AssignPdoContext(WDFDEVICE Device);
-VOID Xusb_GetConfigurationDescriptorType(PUCHAR Buffer, ULONG Length);
-VOID Xusb_GetDeviceDescriptorType(PUSB_DEVICE_DESCRIPTOR pDescriptor, PPDO_DEVICE_DATA pCommon);
-VOID Xusb_SelectConfiguration(PUSBD_INTERFACE_INFORMATION pInfo);
-NTSTATUS Xusb_GetUserIndex(WDFDEVICE Device, PXUSB_GET_USER_INDEX Request);

sys/XusbPdo.hpp

@@ -0,0 +1,161 @@
+/*
+* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
+*
+* BSD 3-Clause License
+*
+* Copyright (c) 2018-2020, Nefarius Software Solutions e.U. and Contributors
+* All rights reserved.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*
+* 1. Redistributions of source code must retain the above copyright notice, this
+*    list of conditions and the following disclaimer.
+*
+* 2. Redistributions in binary form must reproduce the above copyright notice,
+*    this list of conditions and the following disclaimer in the documentation
+*    and/or other materials provided with the distribution.
+*
+* 3. Neither the name of the copyright holder nor the names of its
+*    contributors may be used to endorse or promote products derived from
+*    this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+
+#pragma once
+
+#include "EmulationTargetPDO.hpp"
+
+namespace ViGEm::Bus::Targets
+{
+	constexpr auto XUSB_POOL_TAG = 'XUiV';
+
+	typedef struct _XUSB_INTERRUPT_IN_PACKET
+	{
+		UCHAR Id;
+
+		UCHAR Size;
+
+		XUSB_REPORT Report;
+	} XUSB_INTERRUPT_IN_PACKET, *PXUSB_INTERRUPT_IN_PACKET;
+
+	constexpr bool xusb_is_data_pipe(_URB_BULK_OR_INTERRUPT_TRANSFER* pTransfer)
+	{
+		return (pTransfer->PipeHandle == reinterpret_cast<USBD_PIPE_HANDLE>(0xFFFF0081));
+	}
+
+	constexpr bool xusb_is_control_pipe(_URB_BULK_OR_INTERRUPT_TRANSFER* pTransfer)
+	{
+		return (pTransfer->PipeHandle == reinterpret_cast<USBD_PIPE_HANDLE>(0xFFFF0083));
+	}
+
+	class EmulationTargetXUSB : public Core::EmulationTargetPDO
+	{
+	public:
+		EmulationTargetXUSB(ULONG Serial, LONG SessionId, USHORT VendorId = 0x045E, USHORT ProductId = 0x028E);
+
+		NTSTATUS PdoPrepareDevice(PWDFDEVICE_INIT DeviceInit,
+		                          PUNICODE_STRING DeviceId,
+		                          PUNICODE_STRING DeviceDescription) override;
+
+		NTSTATUS PdoPrepareHardware() override;
+
+		NTSTATUS PdoInitContext() override;
+
+		VOID GetConfigurationDescriptorType(PUCHAR Buffer, ULONG Length) override;
+
+		NTSTATUS UsbGetDeviceDescriptorType(PUSB_DEVICE_DESCRIPTOR pDescriptor) override;
+
+		NTSTATUS SelectConfiguration(PURB Urb) override;
+
+		void AbortPipe() override;
+
+		NTSTATUS UsbClassInterface(PURB Urb) override;
+		
+		NTSTATUS UsbGetDescriptorFromInterface(PURB Urb) override;
+		
+		NTSTATUS UsbSelectInterface(PURB Urb) override;
+		
+		NTSTATUS UsbGetStringDescriptorType(PURB Urb) override;
+		
+		NTSTATUS UsbBulkOrInterruptTransfer(_URB_BULK_OR_INTERRUPT_TRANSFER* pTransfer, WDFREQUEST Request) override;
+		
+		NTSTATUS UsbControlTransfer(PURB Urb) override;
+		
+		NTSTATUS SubmitReportImpl(PVOID NewReport) override;
+
+		NTSTATUS GetUserIndex(PULONG UserIndex) const;
+
+	protected:
+		void ProcessPendingNotification(WDFQUEUE Queue) override;
+	private:
+		static PCWSTR _deviceDescription;
+
+#if defined(_X86_)
+		static const int XUSB_CONFIGURATION_SIZE = 0x00E4;
+#else
+		static const int XUSB_CONFIGURATION_SIZE = 0x0130;
+#endif
+		static const int XUSB_DESCRIPTOR_SIZE = 0x0099;
+		static const int XUSB_RUMBLE_SIZE = 0x08;
+		static const int XUSB_LEDSET_SIZE = 0x03;
+		static const int XUSB_LEDNUM_SIZE = 0x01;
+		static const int XUSB_INIT_STAGE_SIZE = 0x03;
+		static const int XUSB_BLOB_STORAGE_SIZE = 0x2A;
+
+		static const int XUSB_BLOB_00_OFFSET = 0x00;
+		static const int XUSB_BLOB_01_OFFSET = 0x03;
+		static const int XUSB_BLOB_02_OFFSET = 0x06;
+		static const int XUSB_BLOB_03_OFFSET = 0x09;
+		static const int XUSB_BLOB_04_OFFSET = 0x0C;
+		static const int XUSB_BLOB_05_OFFSET = 0x20;
+		static const int XUSB_BLOB_06_OFFSET = 0x23;
+		static const int XUSB_BLOB_07_OFFSET = 0x26;
+
+		//
+		// Rumble buffer
+		//
+		UCHAR _Rumble[XUSB_RUMBLE_SIZE];
+
+		//
+		// LED number (represents XInput slot index)
+		//
+		CHAR _LedNumber;
+
+		//
+		// Report packet
+		//
+		XUSB_INTERRUPT_IN_PACKET _Packet;
+
+		//
+		// Queue for incoming control interrupt transfer
+		//
+		WDFQUEUE _HoldingUsbInRequests;
+
+		//
+		// Required for XInputGetCapabilities to work
+		// 
+		BOOLEAN _ReportedCapabilities;
+
+		//
+		// Required for XInputGetCapabilities to work
+		// 
+		ULONG _InterruptInitStage;
+
+		//
+		// Storage of binary blobs (packets) for PDO initialization
+		// 
+		WDFMEMORY _InterruptBlobStorage;
+	};
+}

sys/busenum.c

@@ -1,825 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-*
-* MIT License
-*
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-*
-* 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.
-*/
-
-
-#include "busenum.h"
-#include <wdmguid.h>
-#include <usb.h>
-#include "busenum.tmh"
-
-#ifdef ALLOC_PRAGMA
-#pragma alloc_text (PAGE, Bus_PlugInDevice)
-#pragma alloc_text (PAGE, Bus_UnPlugDevice)
-#endif
-
-
-
-//
-// Simulates a device plug-in event.
-// 
-NTSTATUS Bus_PlugInDevice(
-    _In_ WDFDEVICE Device,
-    _In_ WDFREQUEST Request,
-    _In_ BOOLEAN IsInternal,
-    _Out_ size_t* Transferred)
-{
-    PDO_IDENTIFICATION_DESCRIPTION  description;
-    NTSTATUS                        status;
-    PVIGEM_PLUGIN_TARGET            plugIn;
-    WDFFILEOBJECT                   fileObject;
-    PFDO_FILE_DATA                  pFileData;
-    size_t                          length = 0;
-    WDF_OBJECT_ATTRIBUTES           requestAttribs;
-    PFDO_PLUGIN_REQUEST_DATA        pReqData;
-    PFDO_DEVICE_DATA                pFdoData;
-
-    PAGED_CODE();
-
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_BUSENUM, "%!FUNC! Entry");
-
-    pFdoData = FdoGetData(Device);
-
-    status = WdfRequestRetrieveInputBuffer(Request, sizeof(VIGEM_PLUGIN_TARGET), (PVOID)&plugIn, &length);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSENUM,
-            "WdfRequestRetrieveInputBuffer failed with status %!STATUS!", status);
-        return status;
-    }
-
-    if ((sizeof(VIGEM_PLUGIN_TARGET) != plugIn->Size) || (length != plugIn->Size))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSENUM,
-            "sizeof(VIGEM_PLUGIN_TARGET) buffer size mismatch [%d != %d]",
-            sizeof(VIGEM_PLUGIN_TARGET), plugIn->Size);
-        return STATUS_INVALID_PARAMETER;
-    }
-
-    if (plugIn->SerialNo == 0)
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSENUM,
-            "Serial no. 0 not allowed");
-        return STATUS_INVALID_PARAMETER;
-    }
-
-    *Transferred = length;
-
-    fileObject = WdfRequestGetFileObject(Request);
-    if (fileObject == NULL)
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSENUM,
-            "WdfRequestGetFileObject failed to fetch WDFFILEOBJECT from request 0x%p",
-            Request);
-        return STATUS_INVALID_PARAMETER;
-    }
-
-    pFileData = FileObjectGetData(fileObject);
-    if (pFileData == NULL)
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSENUM,
-            "FileObjectGetData failed to get context data for 0x%p",
-            fileObject);
-        return STATUS_INVALID_PARAMETER;
-    }
-
-    //
-    // Initialize the description with the information about the newly
-    // plugged in device.
-    //
-    WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT(&description.Header, sizeof(description));
-
-    description.SerialNo = plugIn->SerialNo;
-    description.TargetType = plugIn->TargetType;
-    description.OwnerProcessId = CURRENT_PROCESS_ID();
-    description.SessionId = pFileData->SessionId;
-    description.OwnerIsDriver = IsInternal;
-
-    // Set default IDs if supplied values are invalid
-    if (plugIn->VendorId == 0 || plugIn->ProductId == 0)
-    {
-        switch (plugIn->TargetType)
-        {
-        case Xbox360Wired:
-
-            description.VendorId = 0x045E;
-            description.ProductId = 0x028E;
-
-            break;
-        case DualShock4Wired:
-
-            description.VendorId = 0x054C;
-            description.ProductId = 0x05C4;
-
-            break;
-        case XboxOneWired:
-
-            description.VendorId = 0x0E6F;
-            description.ProductId = 0x0139;
-
-#if !DBG
-            // TODO: implement and remove!
-            return STATUS_NOT_SUPPORTED;
-#endif
-
-            break;
-        }
-    }
-    else
-    {
-        description.VendorId = plugIn->VendorId;
-        description.ProductId = plugIn->ProductId;
-    }
-
-    TraceEvents(TRACE_LEVEL_VERBOSE,
-        TRACE_BUSENUM,
-        "New PDO properties: serial = %d, type = %d, pid = %d, session = %d, internal = %d, vid = 0x%04X, pid = 0x%04X",
-        description.SerialNo,
-        description.TargetType,
-        description.OwnerProcessId,
-        description.SessionId,
-        description.OwnerIsDriver,
-        description.VendorId,
-        description.ProductId
-    );
-
-    WdfSpinLockAcquire(pFdoData->PendingPluginRequestsLock);
-
-    TraceEvents(TRACE_LEVEL_VERBOSE,
-        TRACE_BUSENUM,
-        "Current pending requests count: %d",
-        WdfCollectionGetCount(pFdoData->PendingPluginRequests));
-
-    status = WdfChildListAddOrUpdateChildDescriptionAsPresent(WdfFdoGetDefaultChildList(Device), &description.Header, NULL);
-
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSENUM,
-            "WdfChildListAddOrUpdateChildDescriptionAsPresent failed with status %!STATUS!",
-            status);
-
-        goto pluginEnd;
-    }
-
-    //
-    // The requested serial number is already in use
-    // 
-    if (status == STATUS_OBJECT_NAME_EXISTS)
-    {
-        status = STATUS_INVALID_PARAMETER;
-
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSENUM,
-            "The described PDO already exists (%!STATUS!)",
-            status);
-
-        goto pluginEnd;
-    }
-
-    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&requestAttribs, FDO_PLUGIN_REQUEST_DATA);
-
-    //
-    // Allocate context data to request
-    // 
-    status = WdfObjectAllocateContext(Request, &requestAttribs, (PVOID)&pReqData);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSENUM,
-            "WdfObjectAllocateContext failed with status %!STATUS!",
-            status);
-
-        goto pluginEnd;
-    }
-
-    //
-    // Glue current serial to request
-    // 
-    pReqData->Serial = plugIn->SerialNo;
-
-    //
-    // Timestamp the request to track its age
-    // 
-    pReqData->Timestamp = KeQueryPerformanceCounter(&pReqData->Frequency);
-
-    //
-    // Keep track of pending request in collection
-    // 
-    status = WdfCollectionAdd(pFdoData->PendingPluginRequests, Request);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSENUM,
-            "WdfCollectionAdd failed with status %!STATUS!",
-            status);
-
-        goto pluginEnd;
-    }
-
-    TraceEvents(TRACE_LEVEL_INFORMATION,
-        TRACE_BUSENUM,
-        "Added item with serial: %d",
-        plugIn->SerialNo);
-
-    //
-    // At least one request present in the collection; start clean-up timer
-    // 
-    WdfTimerStart(
-        pFdoData->PendingPluginRequestsCleanupTimer,
-        WDF_REL_TIMEOUT_IN_MS(ORC_TIMER_PERIODIC_DUE_TIME)
-    );
-    TraceEvents(TRACE_LEVEL_VERBOSE,
-        TRACE_DRIVER,
-        "Started periodic timer");
-
-    status = NT_SUCCESS(status) ? STATUS_PENDING : status;
-
-pluginEnd:
-
-    WdfSpinLockRelease(pFdoData->PendingPluginRequestsLock);
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_BUSENUM, "%!FUNC! Exit with status %!STATUS!", status);
-
-    return status;
-}
-
-//
-// Simulates a device unplug event.
-// 
-NTSTATUS Bus_UnPlugDevice(
-    _In_ WDFDEVICE Device,
-    _In_ WDFREQUEST Request,
-    _In_ BOOLEAN IsInternal,
-    _Out_ size_t* Transferred)
-{
-    NTSTATUS                            status;
-    WDFDEVICE                           hChild;
-    WDFCHILDLIST                        list;
-    WDF_CHILD_LIST_ITERATOR             iterator;
-    WDF_CHILD_RETRIEVE_INFO             childInfo;
-    PDO_IDENTIFICATION_DESCRIPTION      description;
-    BOOLEAN                             unplugAll;
-    PVIGEM_UNPLUG_TARGET                unPlug;
-    WDFFILEOBJECT                       fileObject;
-    PFDO_FILE_DATA                      pFileData = NULL;
-    size_t                              length = 0;
-
-    PAGED_CODE();
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_BUSENUM, "%!FUNC! Entry");
-
-    status = WdfRequestRetrieveInputBuffer(Request, sizeof(VIGEM_UNPLUG_TARGET), (PVOID)&unPlug, &length);
-
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSENUM,
-            "WdfRequestRetrieveInputBuffer failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    if ((sizeof(VIGEM_UNPLUG_TARGET) != unPlug->Size) || (length != unPlug->Size))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSENUM,
-            "sizeof(VIGEM_UNPLUG_TARGET) buffer size mismatch [%d != %d]",
-            sizeof(VIGEM_UNPLUG_TARGET), unPlug->Size);
-        return STATUS_INVALID_PARAMETER;
-    }
-
-    *Transferred = length;
-    unplugAll = (unPlug->SerialNo == 0);
-
-    if (!IsInternal)
-    {
-        fileObject = WdfRequestGetFileObject(Request);
-        if (fileObject == NULL)
-        {
-            TraceEvents(TRACE_LEVEL_ERROR,
-                TRACE_BUSENUM,
-                "WdfRequestGetFileObject failed to fetch WDFFILEOBJECT from request 0x%p",
-                Request);
-            return STATUS_INVALID_PARAMETER;
-        }
-
-        pFileData = FileObjectGetData(fileObject);
-        if (pFileData == NULL)
-        {
-            TraceEvents(TRACE_LEVEL_ERROR,
-                TRACE_BUSENUM,
-                "FileObjectGetData failed to get context data for 0x%p",
-                fileObject);
-            return STATUS_INVALID_PARAMETER;
-        }
-    }
-
-    TraceEvents(TRACE_LEVEL_VERBOSE,
-        TRACE_BUSENUM,
-        "Starting child list traversal");
-
-    list = WdfFdoGetDefaultChildList(Device);
-
-    WDF_CHILD_LIST_ITERATOR_INIT(&iterator, WdfRetrievePresentChildren);
-
-    WdfChildListBeginIteration(list, &iterator);
-
-    for (;;)
-    {
-        WDF_CHILD_RETRIEVE_INFO_INIT(&childInfo, &description.Header);
-        WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT(&description.Header, sizeof(description));
-
-        status = WdfChildListRetrieveNextDevice(list, &iterator, &hChild, &childInfo);
-
-        // Error or no more children, end loop
-        if (!NT_SUCCESS(status) || status == STATUS_NO_MORE_ENTRIES)
-        {
-            TraceEvents(TRACE_LEVEL_VERBOSE,
-                TRACE_BUSENUM,
-                "WdfChildListRetrieveNextDevice returned with status %!STATUS!",
-                status);
-            break;
-        }
-
-        // If unable to retrieve device
-        if (childInfo.Status != WdfChildListRetrieveDeviceSuccess)
-        {
-            TraceEvents(TRACE_LEVEL_VERBOSE,
-                TRACE_BUSENUM,
-                "childInfo.Status = %d",
-                childInfo.Status);
-            continue;
-        }
-
-        // Child isn't the one we looked for, skip
-        if (!unplugAll && description.SerialNo != unPlug->SerialNo)
-        {
-            TraceEvents(TRACE_LEVEL_VERBOSE,
-                TRACE_BUSENUM,
-                "Seeking serial mismatch: %d != %d",
-                description.SerialNo,
-                unPlug->SerialNo);
-            continue;
-        }
-
-        TraceEvents(TRACE_LEVEL_VERBOSE,
-            TRACE_BUSENUM,
-            "description.SessionId = %d, pFileData->SessionId = %d",
-            description.SessionId,
-            pFileData->SessionId);
-
-        // Only unplug owned children
-        if (IsInternal || description.SessionId == pFileData->SessionId)
-        {
-            // Unplug child
-            status = WdfChildListUpdateChildDescriptionAsMissing(list, &description.Header);
-            if (!NT_SUCCESS(status))
-            {
-                TraceEvents(TRACE_LEVEL_ERROR,
-                    TRACE_BUSENUM,
-                    "WdfChildListUpdateChildDescriptionAsMissing failed with status %!STATUS!",
-                    status);
-            }
-        }
-    }
-
-    WdfChildListEndIteration(list, &iterator);
-
-    TraceEvents(TRACE_LEVEL_VERBOSE,
-        TRACE_BUSENUM,
-        "Finished child list traversal");
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_BUSENUM, "%!FUNC! Exit with status %!STATUS!", STATUS_SUCCESS);
-
-    return STATUS_SUCCESS;
-}
-
-//
-// Sends a report update to an XUSB PDO.
-// 
-NTSTATUS Bus_XusbSubmitReport(WDFDEVICE Device, ULONG SerialNo, PXUSB_SUBMIT_REPORT Report, BOOLEAN FromInterface)
-{
-    TraceEvents(TRACE_LEVEL_VERBOSE, TRACE_BUSENUM, "%!FUNC! Entry");
-
-    return Bus_SubmitReport(Device, SerialNo, Report, FromInterface);
-}
-
-//
-// Queues an inverted call to receive XUSB-specific updates.
-// 
-NTSTATUS Bus_QueueNotification(WDFDEVICE Device, ULONG SerialNo, WDFREQUEST Request)
-{
-    NTSTATUS                    status = STATUS_INVALID_PARAMETER;
-    WDFDEVICE                   hChild;
-    PPDO_DEVICE_DATA            pdoData;
-    PXUSB_DEVICE_DATA           xusbData;
-    PDS4_DEVICE_DATA            ds4Data;
-
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_BUSENUM, "%!FUNC! Entry");
-
-    hChild = Bus_GetPdo(Device, SerialNo);
-
-    // Validate child
-    if (hChild == NULL)
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSENUM,
-            "Bus_GetPdo: PDO with serial %d not found",
-            SerialNo);
-        return STATUS_NO_SUCH_DEVICE;
-    }
-
-    // Check common context
-    pdoData = PdoGetData(hChild);
-    if (pdoData == NULL)
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSENUM,
-            "PdoGetData failed");
-        return STATUS_INVALID_PARAMETER;
-    }
-
-    // Check if caller owns this PDO
-    if (!IS_OWNER(pdoData))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSENUM,
-            "PDO & Request ownership mismatch: %d != %d",
-            pdoData->OwnerProcessId,
-            CURRENT_PROCESS_ID());
-        return STATUS_ACCESS_DENIED;
-    }
-
-    // Queue the request for later completion by the PDO and return STATUS_PENDING
-    switch (pdoData->TargetType)
-    {
-    case Xbox360Wired:
-
-        xusbData = XusbGetData(hChild);
-
-        if (xusbData == NULL)
-        {
-            TraceEvents(TRACE_LEVEL_ERROR,
-                TRACE_BUSENUM,
-                "XusbGetData failed");
-            break;
-        }
-
-        status = WdfRequestForwardToIoQueue(Request, pdoData->PendingNotificationRequests);
-
-        break;
-    case DualShock4Wired:
-
-        ds4Data = Ds4GetData(hChild);
-
-        if (ds4Data == NULL)
-        {
-            TraceEvents(TRACE_LEVEL_ERROR,
-                TRACE_BUSENUM,
-                "Ds4GetData failed");
-            break;
-        }
-
-        status = WdfRequestForwardToIoQueue(Request, pdoData->PendingNotificationRequests);
-
-        break;
-    default:
-        status = STATUS_NOT_SUPPORTED;
-        TraceEvents(TRACE_LEVEL_WARNING,
-            TRACE_BUSENUM,
-            "Unknown target type: %d (%!STATUS!)",
-            pdoData->TargetType,
-            status);
-        break;
-    }
-
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSENUM,
-            "WdfRequestForwardToIoQueue failed with status %!STATUS!",
-            status);
-    }
-
-    status = (NT_SUCCESS(status)) ? STATUS_PENDING : status;
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_BUSENUM, "%!FUNC! Exit with status %!STATUS!", status);
-
-    return status;
-}
-
-//
-// Sends a report update to a DS4 PDO.
-// 
-NTSTATUS Bus_Ds4SubmitReport(WDFDEVICE Device, ULONG SerialNo, PDS4_SUBMIT_REPORT Report, BOOLEAN FromInterface)
-{
-    TraceEvents(TRACE_LEVEL_VERBOSE, TRACE_BUSENUM, "%!FUNC! Entry");
-
-    return Bus_SubmitReport(Device, SerialNo, Report, FromInterface);
-}
-
-NTSTATUS Bus_XgipSubmitReport(WDFDEVICE Device, ULONG SerialNo, PXGIP_SUBMIT_REPORT Report, BOOLEAN FromInterface)
-{
-    TraceEvents(TRACE_LEVEL_VERBOSE, TRACE_BUSENUM, "%!FUNC! Entry");
-
-    return Bus_SubmitReport(Device, SerialNo, Report, FromInterface);
-}
-
-NTSTATUS Bus_XgipSubmitInterrupt(WDFDEVICE Device, ULONG SerialNo, PXGIP_SUBMIT_INTERRUPT Report, BOOLEAN FromInterface)
-{
-    TraceEvents(TRACE_LEVEL_VERBOSE, TRACE_BUSENUM, "%!FUNC! Entry");
-
-    return Bus_SubmitReport(Device, SerialNo, Report, FromInterface);
-}
-
-WDFDEVICE Bus_GetPdo(IN WDFDEVICE Device, IN ULONG SerialNo)
-{
-    WDFCHILDLIST                list;
-    WDF_CHILD_RETRIEVE_INFO     info;
-
-    list = WdfFdoGetDefaultChildList(Device);
-
-    PDO_IDENTIFICATION_DESCRIPTION description;
-
-    WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT(&description.Header, sizeof(description));
-
-    description.SerialNo = SerialNo;
-
-    WDF_CHILD_RETRIEVE_INFO_INIT(&info, &description.Header);
-
-    return WdfChildListRetrievePdo(list, &info);
-}
-
-NTSTATUS Bus_SubmitReport(WDFDEVICE Device, ULONG SerialNo, PVOID Report, BOOLEAN FromInterface)
-{
-    NTSTATUS                    status = STATUS_SUCCESS;
-    WDFDEVICE                   hChild;
-    PPDO_DEVICE_DATA            pdoData;
-    WDFREQUEST                  usbRequest;
-    PIRP                        pendingIrp;
-    BOOLEAN                     changed;
-
-
-    TraceEvents(TRACE_LEVEL_VERBOSE, TRACE_BUSENUM, "%!FUNC! Entry");
-
-    hChild = Bus_GetPdo(Device, SerialNo);
-
-    // Validate child
-    if (hChild == NULL)
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSENUM,
-            "Bus_GetPdo: PDO with serial %d not found",
-            SerialNo);
-        return STATUS_NO_SUCH_DEVICE;
-    }
-
-    // Check common context
-    pdoData = PdoGetData(hChild);
-    if (pdoData == NULL)
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSENUM,
-            "PdoGetData failed");
-        return STATUS_INVALID_PARAMETER;
-    }
-
-    // Check if caller owns this PDO
-    if (!FromInterface && !IS_OWNER(pdoData))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSENUM,
-            "PDO & Request ownership mismatch: %d != %d",
-            pdoData->OwnerProcessId,
-            CURRENT_PROCESS_ID());
-        return STATUS_ACCESS_DENIED;
-    }
-
-    // Check if input is different from previous value
-    switch (pdoData->TargetType)
-    {
-    case Xbox360Wired:
-
-        changed = (RtlCompareMemory(&XusbGetData(hChild)->Packet.Report,
-            &((PXUSB_SUBMIT_REPORT)Report)->Report,
-            sizeof(XUSB_REPORT)) != sizeof(XUSB_REPORT));
-
-        break;
-    case DualShock4Wired:
-
-        changed = TRUE;
-
-        break;
-    case XboxOneWired:
-
-        // TODO: necessary?
-        changed = TRUE;
-
-        break;
-    default:
-
-        changed = FALSE;
-
-        break;
-    }
-
-    // Don't waste pending IRP if input hasn't changed
-    if (!changed)
-    {
-        TraceEvents(TRACE_LEVEL_VERBOSE,
-            TRACE_BUSENUM,
-            "Input report hasn't changed since last update, aborting with %!STATUS!",
-            status);
-        return status;
-    }
-
-    TraceEvents(TRACE_LEVEL_VERBOSE,
-        TRACE_BUSENUM,
-        "Received new report, processing");
-
-    // Get pending USB request
-    switch (pdoData->TargetType)
-    {
-    case Xbox360Wired:
-
-        status = WdfIoQueueRetrieveNextRequest(pdoData->PendingUsbInRequests, &usbRequest);
-
-        break;
-    case DualShock4Wired:
-
-        status = WdfIoQueueRetrieveNextRequest(pdoData->PendingUsbInRequests, &usbRequest);
-
-        break;
-    case XboxOneWired:
-
-        // Request is control data
-        if (((PXGIP_SUBMIT_INTERRUPT)Report)->Size == sizeof(XGIP_SUBMIT_INTERRUPT))
-        {
-            PXGIP_DEVICE_DATA xgip = XgipGetData(hChild);
-            PXGIP_SUBMIT_INTERRUPT interrupt = (PXGIP_SUBMIT_INTERRUPT)Report;
-            WDFMEMORY memory;
-            WDF_OBJECT_ATTRIBUTES memAttribs;
-            WDF_OBJECT_ATTRIBUTES_INIT(&memAttribs);
-
-            memAttribs.ParentObject = hChild;
-
-            // Allocate kernel memory
-            status = WdfMemoryCreate(&memAttribs, NonPagedPool, VIGEM_POOL_TAG,
-                interrupt->InterruptLength, &memory, NULL);
-            if (!NT_SUCCESS(status))
-            {
-                KdPrint((DRIVERNAME "WdfMemoryCreate failed with status 0x%X\n", status));
-                goto endSubmitReport;
-            }
-
-            // Copy interrupt buffer to memory object
-            status = WdfMemoryCopyFromBuffer(memory, 0, interrupt->Interrupt, interrupt->InterruptLength);
-            if (!NT_SUCCESS(status))
-            {
-                KdPrint((DRIVERNAME "WdfMemoryCopyFromBuffer failed with status 0x%X\n", status));
-                goto endSubmitReport;
-            }
-
-            // Add memory object to collection
-            status = WdfCollectionAdd(xgip->XboxgipSysInitCollection, memory);
-            if (!NT_SUCCESS(status))
-            {
-                KdPrint((DRIVERNAME "WdfCollectionAdd failed with status 0x%X\n", status));
-                goto endSubmitReport;
-            }
-
-            // Check if all packets have been received
-            xgip->XboxgipSysInitReady =
-                WdfCollectionGetCount(xgip->XboxgipSysInitCollection) == XGIP_SYS_INIT_PACKETS;
-
-            // If all packets are cached, start initialization timer
-            if (xgip->XboxgipSysInitReady)
-            {
-                WdfTimerStart(xgip->XboxgipSysInitTimer, XGIP_SYS_INIT_PERIOD);
-            }
-
-            goto endSubmitReport;
-        }
-
-        status = WdfIoQueueRetrieveNextRequest(XgipGetData(hChild)->PendingUsbInRequests, &usbRequest);
-
-        break;
-    default:
-
-        status = STATUS_NOT_SUPPORTED;
-
-        TraceEvents(TRACE_LEVEL_WARNING,
-            TRACE_BUSENUM,
-            "Unknown target type: %d (%!STATUS!)",
-            pdoData->TargetType,
-            status);
-
-        goto endSubmitReport;
-    }
-
-    if (status == STATUS_PENDING)
-        goto endSubmitReport;
-    else if (!NT_SUCCESS(status))
-        goto endSubmitReport;
-
-    TraceEvents(TRACE_LEVEL_VERBOSE,
-        TRACE_BUSENUM,
-        "Processing pending IRP");
-
-    // Get pending IRP
-    pendingIrp = WdfRequestWdmGetIrp(usbRequest);
-
-    // Get USB request block
-    PURB urb = (PURB)URB_FROM_IRP(pendingIrp);
-
-    // Get transfer buffer
-    PUCHAR Buffer = (PUCHAR)urb->UrbBulkOrInterruptTransfer.TransferBuffer;
-
-    switch (pdoData->TargetType)
-    {
-    case Xbox360Wired:
-
-        urb->UrbBulkOrInterruptTransfer.TransferBufferLength = sizeof(XUSB_INTERRUPT_IN_PACKET);
-
-        // Copy submitted report to cache
-        RtlCopyBytes(&XusbGetData(hChild)->Packet.Report, &((PXUSB_SUBMIT_REPORT)Report)->Report, sizeof(XUSB_REPORT));
-        // Copy cached report to URB transfer buffer
-        RtlCopyBytes(Buffer, &XusbGetData(hChild)->Packet, sizeof(XUSB_INTERRUPT_IN_PACKET));
-
-        break;
-    case DualShock4Wired:
-
-        urb->UrbBulkOrInterruptTransfer.TransferBufferLength = DS4_REPORT_SIZE;
-
-        /* Copy report to cache and transfer buffer
-         * Skip first byte as it contains the never changing report id */
-        RtlCopyBytes(Ds4GetData(hChild)->Report + 1, &((PDS4_SUBMIT_REPORT)Report)->Report, sizeof(DS4_REPORT));
-
-        if (Buffer)
-            RtlCopyBytes(Buffer, Ds4GetData(hChild)->Report, DS4_REPORT_SIZE);
-
-        break;
-    case XboxOneWired:
-
-        // Request is input report
-        if (((PXGIP_SUBMIT_REPORT)Report)->Size == sizeof(XGIP_SUBMIT_REPORT))
-        {
-            urb->UrbBulkOrInterruptTransfer.TransferBufferLength = XGIP_REPORT_SIZE;
-
-            // Increase event counter on every call (can roll-over)
-            XgipGetData(hChild)->Report[2]++;
-
-            /* Copy report to cache and transfer buffer
-             * Skip first four bytes as they are not part of the report */
-            RtlCopyBytes(XgipGetData(hChild)->Report + 4, &((PXGIP_SUBMIT_REPORT)Report)->Report, sizeof(XGIP_REPORT));
-            RtlCopyBytes(Buffer, XgipGetData(hChild)->Report, XGIP_REPORT_SIZE);
-
-            break;
-        }
-
-        break;
-    default:
-        status = STATUS_INVALID_PARAMETER;
-        break;
-    }
-
-    // Complete pending request
-    WdfRequestComplete(usbRequest, status);
-
-endSubmitReport:
-
-    TraceEvents(TRACE_LEVEL_VERBOSE, TRACE_BUSENUM, "%!FUNC! Exit with status %!STATUS!", status);
-
-    return status;
-}
-

sys/busenum.cpp

@@ -0,0 +1,383 @@
+/*
+* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
+*
+* BSD 3-Clause License
+*
+* Copyright (c) 2018-2020, Nefarius Software Solutions e.U. and Contributors
+* All rights reserved.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*
+* 1. Redistributions of source code must retain the above copyright notice, this
+*    list of conditions and the following disclaimer.
+*
+* 2. Redistributions in binary form must reproduce the above copyright notice,
+*    this list of conditions and the following disclaimer in the documentation
+*    and/or other materials provided with the distribution.
+*
+* 3. Neither the name of the copyright holder nor the names of its
+*    contributors may be used to endorse or promote products derived from
+*    this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+
+#include "Driver.h"
+#include "trace.h"
+#include "busenum.tmh"
+
+#include "EmulationTargetPDO.hpp"
+#include "XusbPdo.hpp"
+#include "Ds4Pdo.hpp"
+
+#include "Debugging.hpp"
+
+#ifdef ALLOC_PRAGMA
+#pragma alloc_text (PAGE, Bus_PlugInDevice)
+#pragma alloc_text (PAGE, Bus_UnPlugDevice)
+#endif
+
+using ViGEm::Bus::Core::PDO_IDENTIFICATION_DESCRIPTION;
+using ViGEm::Bus::Core::EmulationTargetPDO;
+using ViGEm::Bus::Targets::EmulationTargetXUSB;
+using ViGEm::Bus::Targets::EmulationTargetDS4;
+
+//
+// Simulates a device plug-in event.
+// 
+EXTERN_C NTSTATUS Bus_PlugInDevice(
+	_In_ WDFDEVICE Device,
+	_In_ WDFREQUEST Request,
+	_In_ BOOLEAN IsInternal,
+	_Out_ size_t* Transferred)
+{
+	PDO_IDENTIFICATION_DESCRIPTION  description;
+	NTSTATUS                        status;
+	PVIGEM_PLUGIN_TARGET            plugIn;
+	WDFFILEOBJECT                   fileObject;
+	PFDO_FILE_DATA                  pFileData;
+	size_t                          length = 0;
+
+	UNREFERENCED_PARAMETER(IsInternal);
+
+	PAGED_CODE();
+
+
+	TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_BUSENUM, "%!FUNC! Entry");
+
+	status = WdfRequestRetrieveInputBuffer(
+		Request,
+		sizeof(VIGEM_PLUGIN_TARGET),
+		reinterpret_cast<PVOID*>(&plugIn),
+		&length
+	);
+	if (!NT_SUCCESS(status))
+	{
+		TraceEvents(TRACE_LEVEL_ERROR,
+			TRACE_BUSENUM,
+			"WdfRequestRetrieveInputBuffer failed with status %!STATUS!", status);
+		return status;
+	}
+
+	if ((sizeof(VIGEM_PLUGIN_TARGET) != plugIn->Size) || (length != plugIn->Size))
+	{
+		TraceEvents(TRACE_LEVEL_ERROR,
+			TRACE_BUSENUM,
+			"sizeof(VIGEM_PLUGIN_TARGET) buffer size mismatch [%d != %d]",
+			sizeof(VIGEM_PLUGIN_TARGET), plugIn->Size);
+		return STATUS_INVALID_PARAMETER;
+	}
+
+	if (plugIn->SerialNo == 0)
+	{
+		TraceEvents(TRACE_LEVEL_ERROR,
+			TRACE_BUSENUM,
+			"Serial no. 0 not allowed");
+		return STATUS_INVALID_PARAMETER;
+	}
+
+	*Transferred = length;
+
+	fileObject = WdfRequestGetFileObject(Request);
+	if (fileObject == NULL)
+	{
+		TraceEvents(TRACE_LEVEL_ERROR,
+			TRACE_BUSENUM,
+			"WdfRequestGetFileObject failed to fetch WDFFILEOBJECT from request 0x%p",
+			Request);
+		return STATUS_INVALID_PARAMETER;
+	}
+
+	pFileData = FileObjectGetData(fileObject);
+	if (pFileData == NULL)
+	{
+		TraceEvents(TRACE_LEVEL_ERROR,
+			TRACE_BUSENUM,
+			"FileObjectGetData failed to get context data for 0x%p",
+			fileObject);
+		return STATUS_INVALID_PARAMETER;
+	}
+
+	//
+	// Initialize the description with the information about the newly
+	// plugged in device.
+	//
+	WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT(&description.Header, sizeof(description));
+
+	description.SerialNo = plugIn->SerialNo;
+	description.SessionId = pFileData->SessionId;
+
+	// Set default IDs if supplied values are invalid
+	if (plugIn->VendorId == 0 || plugIn->ProductId == 0)
+	{
+		switch (plugIn->TargetType)
+		{
+		case Xbox360Wired:
+
+			description.Target = new EmulationTargetXUSB(plugIn->SerialNo, pFileData->SessionId);
+
+			break;
+		case DualShock4Wired:
+
+			description.Target = new EmulationTargetDS4(plugIn->SerialNo, pFileData->SessionId);
+
+			break;
+		default:
+			return STATUS_NOT_SUPPORTED;
+		}
+	}
+	else
+	{
+		switch (plugIn->TargetType)
+		{
+		case Xbox360Wired:
+
+			description.Target = new EmulationTargetXUSB(
+				plugIn->SerialNo,
+				pFileData->SessionId,
+				plugIn->VendorId,
+				plugIn->ProductId
+			);
+
+			break;
+		case DualShock4Wired:
+
+			description.Target = new EmulationTargetDS4(
+				plugIn->SerialNo,
+				pFileData->SessionId,
+				plugIn->VendorId,
+				plugIn->ProductId
+			);
+
+			break;
+		default:
+			return STATUS_NOT_SUPPORTED;
+		}
+	}
+
+	if (!NT_SUCCESS(description.Target->PdoPrepare(Device)))
+	{
+		goto pluginEnd;
+	}
+
+	status = WdfChildListAddOrUpdateChildDescriptionAsPresent(
+		WdfFdoGetDefaultChildList(Device),
+		&description.Header,
+		NULL
+	);
+
+	if (!NT_SUCCESS(status))
+	{
+		TraceEvents(TRACE_LEVEL_ERROR,
+			TRACE_BUSENUM,
+			"WdfChildListAddOrUpdateChildDescriptionAsPresent failed with status %!STATUS!",
+			status);
+
+		goto pluginEnd;
+	}
+
+	//
+	// The requested serial number is already in use
+	// 
+	if (status == STATUS_OBJECT_NAME_EXISTS)
+	{
+		status = STATUS_INVALID_PARAMETER;
+
+		TraceEvents(TRACE_LEVEL_ERROR,
+			TRACE_BUSENUM,
+			"The described PDO already exists (%!STATUS!)",
+			status);
+
+		goto pluginEnd;
+	}
+
+pluginEnd:
+
+	TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_BUSENUM, "%!FUNC! Exit with status %!STATUS!", status);
+
+	return status;
+}
+
+//
+// Simulates a device unplug event.
+// 
+EXTERN_C NTSTATUS Bus_UnPlugDevice(
+	_In_ WDFDEVICE Device,
+	_In_ WDFREQUEST Request,
+	_In_ BOOLEAN IsInternal,
+	_Out_ size_t* Transferred)
+{
+	NTSTATUS                            status;
+	WDFDEVICE                           hChild;
+	WDFCHILDLIST                        list;
+	WDF_CHILD_LIST_ITERATOR             iterator;
+	WDF_CHILD_RETRIEVE_INFO             childInfo;
+	PDO_IDENTIFICATION_DESCRIPTION      description;
+	BOOLEAN                             unplugAll;
+	PVIGEM_UNPLUG_TARGET                unPlug;
+	WDFFILEOBJECT                       fileObject;
+	PFDO_FILE_DATA                      pFileData = NULL;
+	size_t                              length = 0;
+
+	PAGED_CODE();
+
+	TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_BUSENUM, "%!FUNC! Entry");
+
+	status = WdfRequestRetrieveInputBuffer(
+		Request,
+		sizeof(VIGEM_UNPLUG_TARGET),
+		(PVOID*)&unPlug,
+		&length
+	);
+
+	if (!NT_SUCCESS(status))
+	{
+		TraceEvents(TRACE_LEVEL_ERROR,
+			TRACE_BUSENUM,
+			"WdfRequestRetrieveInputBuffer failed with status %!STATUS!",
+			status);
+		return status;
+	}
+
+	if ((sizeof(VIGEM_UNPLUG_TARGET) != unPlug->Size) || (length != unPlug->Size))
+	{
+		TraceEvents(TRACE_LEVEL_ERROR,
+			TRACE_BUSENUM,
+			"sizeof(VIGEM_UNPLUG_TARGET) buffer size mismatch [%d != %d]",
+			sizeof(VIGEM_UNPLUG_TARGET), unPlug->Size);
+		return STATUS_INVALID_PARAMETER;
+	}
+
+	*Transferred = length;
+	unplugAll = (unPlug->SerialNo == 0);
+
+	fileObject = WdfRequestGetFileObject(Request);
+	if (fileObject == NULL)
+	{
+		TraceEvents(TRACE_LEVEL_ERROR,
+			TRACE_BUSENUM,
+			"WdfRequestGetFileObject failed to fetch WDFFILEOBJECT from request 0x%p",
+			Request);
+		return STATUS_INVALID_PARAMETER;
+	}
+
+	pFileData = FileObjectGetData(fileObject);
+	if (pFileData == NULL)
+	{
+		TraceEvents(TRACE_LEVEL_ERROR,
+			TRACE_BUSENUM,
+			"FileObjectGetData failed to get context data for 0x%p",
+			fileObject);
+		return STATUS_INVALID_PARAMETER;
+	}
+
+	TraceEvents(TRACE_LEVEL_VERBOSE,
+		TRACE_BUSENUM,
+		"Starting child list traversal");
+
+	list = WdfFdoGetDefaultChildList(Device);
+
+	WDF_CHILD_LIST_ITERATOR_INIT(&iterator, WdfRetrievePresentChildren);
+
+	WdfChildListBeginIteration(list, &iterator);
+
+	for (;;)
+	{
+		WDF_CHILD_RETRIEVE_INFO_INIT(&childInfo, &description.Header);
+		WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT(&description.Header, sizeof(description));
+
+		status = WdfChildListRetrieveNextDevice(list, &iterator, &hChild, &childInfo);
+
+		// Error or no more children, end loop
+		if (!NT_SUCCESS(status) || status == STATUS_NO_MORE_ENTRIES)
+		{
+			TraceEvents(TRACE_LEVEL_VERBOSE,
+				TRACE_BUSENUM,
+				"WdfChildListRetrieveNextDevice returned with status %!STATUS!",
+				status);
+			break;
+		}
+
+		// If unable to retrieve device
+		if (childInfo.Status != WdfChildListRetrieveDeviceSuccess)
+		{
+			TraceEvents(TRACE_LEVEL_VERBOSE,
+				TRACE_BUSENUM,
+				"childInfo.Status = %d",
+				childInfo.Status);
+			continue;
+		}
+
+		// Child isn't the one we looked for, skip
+		if (!unplugAll && description.SerialNo != unPlug->SerialNo)
+		{
+			TraceEvents(TRACE_LEVEL_VERBOSE,
+				TRACE_BUSENUM,
+				"Seeking serial mismatch: %d != %d",
+				description.SerialNo,
+				unPlug->SerialNo);
+			continue;
+		}
+
+		TraceEvents(TRACE_LEVEL_VERBOSE,
+			TRACE_BUSENUM,
+			"description.SessionId = %d, pFileData->SessionId = %d",
+			description.SessionId,
+			pFileData->SessionId);
+
+		// Only unplug owned children
+		if (IsInternal || description.SessionId == pFileData->SessionId)
+		{
+			// Unplug child
+			status = WdfChildListUpdateChildDescriptionAsMissing(list, &description.Header);
+			if (!NT_SUCCESS(status))
+			{
+				TraceEvents(TRACE_LEVEL_ERROR,
+					TRACE_BUSENUM,
+					"WdfChildListUpdateChildDescriptionAsMissing failed with status %!STATUS!",
+					status);
+			}
+		}
+	}
+
+	WdfChildListEndIteration(list, &iterator);
+
+	TraceEvents(TRACE_LEVEL_VERBOSE,
+		TRACE_BUSENUM,
+		"Finished child list traversal");
+
+	TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_BUSENUM, "%!FUNC! Exit with status %!STATUS!", STATUS_SUCCESS);
+
+	return STATUS_SUCCESS;
+}

sys/busenum.h

@@ -1,179 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-*
-* MIT License
-*
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-*
-* 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.
-*/
-
-
-#pragma once
-
-#include "trace.h"
-#include <ntddk.h>
-#include <wdf.h>
-#define NTSTRSAFE_LIB
-#include <ntstrsafe.h>
-#include <ntintsafe.h>
-#include <initguid.h>
-#include "ViGEmBusDriver.h"
-#include <ViGEm/km/BusShared.h>
-#include "Queue.h"
-#include <usb.h>
-#include <usbbusif.h>
-#include "Context.h"
-#include "Util.h"
-#include "UsbPdo.h"
-#include "Xusb.h"
-#include "Ds4.h"
-#include "Xgip.h"
-
-
-#pragma region Macros
-
-#define MAX_INSTANCE_ID_LEN             80
-#define HID_LANGUAGE_ID_LENGTH          0x04
-
-#define HID_REQUEST_GET_REPORT          0x01
-#define HID_REQUEST_SET_REPORT          0x09
-#define HID_REPORT_TYPE_FEATURE         0x03
-
-#define VIGEM_POOL_TAG                  0x45476956 // "EGiV"
-#define XUSB_POOL_TAG                   'BSUX'
-#define DRIVERNAME                      "ViGEm: "
-#define MAX_HARDWARE_ID_LENGTH          0xFF
-
-#define ORC_PC_FREQUENCY_DIVIDER        1000
-#define ORC_TIMER_START_DELAY           500 // ms
-#define ORC_TIMER_PERIODIC_DUE_TIME     500 // ms
-#define ORC_REQUEST_MAX_AGE             500 // ms
-
-#pragma endregion
-
-#pragma region Helpers
-
-//
-// Extracts the HID Report ID from the supplied class request.
-//
-#define HID_GET_REPORT_ID(_req_) ((_req_->Value) & 0xFF)
-
-//
-// Extracts the HID Report type from the supplied class request.
-//
-#define HID_GET_REPORT_TYPE(_req_) ((_req_->Value >> 8) & 0xFF)
-
-//
-// Some insane macro-magic =3
-// 
-#define P99_PROTECT(...) __VA_ARGS__
-#define COPY_BYTE_ARRAY(_dst_, _bytes_)   do {BYTE b[] = _bytes_; \
-                                            RtlCopyMemory(_dst_, b, RTL_NUMBER_OF_V1(b)); } while (0)
-
-#pragma endregion
-
-
-#pragma region WDF callback prototypes
-
-DRIVER_INITIALIZE DriverEntry;
-
-EVT_WDF_DRIVER_DEVICE_ADD Bus_EvtDeviceAdd;
-EVT_WDF_DEVICE_FILE_CREATE Bus_DeviceFileCreate;
-EVT_WDF_FILE_CLOSE Bus_FileClose;
-
-EVT_WDF_CHILD_LIST_CREATE_DEVICE Bus_EvtDeviceListCreatePdo;
-
-EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COMPARE Bus_EvtChildListIdentificationDescriptionCompare;
-
-EVT_WDF_DEVICE_PREPARE_HARDWARE Pdo_EvtDevicePrepareHardware;
-
-EVT_WDF_IO_QUEUE_IO_INTERNAL_DEVICE_CONTROL Pdo_EvtIoInternalDeviceControl;
-
-EVT_WDF_TIMER Xgip_SysInitTimerFunc;
-
-EVT_WDF_OBJECT_CONTEXT_CLEANUP Bus_EvtDriverContextCleanup;
-
-EVT_WDF_TIMER Bus_PlugInRequestCleanUpEvtTimerFunc;
-
-#pragma endregion
-
-#pragma region Bus enumeration-specific functions
-
-NTSTATUS
-Bus_PlugInDevice(
-    _In_ WDFDEVICE Device,
-    _In_ WDFREQUEST Request,
-    _In_ BOOLEAN IsInternal,
-    _Out_ size_t* Transferred
-);
-
-NTSTATUS
-Bus_UnPlugDevice(
-    _In_ WDFDEVICE Device,
-    _In_ WDFREQUEST Request,
-    _In_ BOOLEAN IsInternal,
-    _Out_ size_t* Transferred
-);
-
-NTSTATUS
-Bus_CreatePdo(
-    _In_ WDFDEVICE Device,
-    _In_ PWDFDEVICE_INIT ChildInit,
-    _In_ PPDO_IDENTIFICATION_DESCRIPTION Description
-);
-
-NTSTATUS
-Bus_QueueNotification(
-    WDFDEVICE Device,
-    ULONG SerialNo,
-    WDFREQUEST Request
-);
-
-NTSTATUS
-Bus_XgipSubmitReport(
-    WDFDEVICE Device,
-    ULONG SerialNo,
-    PXGIP_SUBMIT_REPORT Report,
-    _In_ BOOLEAN FromInterface
-);
-
-NTSTATUS
-Bus_SubmitReport(
-    WDFDEVICE Device,
-    ULONG SerialNo,
-    PVOID Report,
-    _In_ BOOLEAN FromInterface
-);
-
-WDFDEVICE 
-Bus_GetPdo(
-    IN WDFDEVICE Device, 
-    IN ULONG SerialNo);
-
-VOID
-Bus_PdoStageResult(
-    _In_ PINTERFACE InterfaceHeader,
-    _In_ VIGEM_PDO_STAGE Stage,
-    _In_ ULONG Serial,
-    _In_ NTSTATUS Status
-);
-
-#pragma endregion
-

sys/buspdo.c

@@ -1,912 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-*
-* MIT License
-*
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-*
-* 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.
-*/
-
-
-#include "busenum.h"
-#include <wdmsec.h>
-#include <usbioctl.h>
-#include "buspdo.tmh"
-
-#ifdef ALLOC_PRAGMA
-#pragma alloc_text(PAGE, Bus_CreatePdo)
-#pragma alloc_text(PAGE, Bus_EvtDeviceListCreatePdo)
-#pragma alloc_text(PAGE, Pdo_EvtDevicePrepareHardware)
-#endif
-
-NTSTATUS Bus_EvtDeviceListCreatePdo(
-    WDFCHILDLIST DeviceList,
-    PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER IdentificationDescription,
-    PWDFDEVICE_INIT ChildInit)
-{
-    PPDO_IDENTIFICATION_DESCRIPTION pDesc;
-
-    PAGED_CODE();
-
-    pDesc = CONTAINING_RECORD(IdentificationDescription, PDO_IDENTIFICATION_DESCRIPTION, Header);
-
-    return Bus_CreatePdo(WdfChildListGetDevice(DeviceList), ChildInit, pDesc);
-}
-
-//
-// Compares two children on the bus based on their serial numbers.
-// 
-BOOLEAN Bus_EvtChildListIdentificationDescriptionCompare(
-    WDFCHILDLIST DeviceList,
-    PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER FirstIdentificationDescription,
-    PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER SecondIdentificationDescription)
-{
-    PPDO_IDENTIFICATION_DESCRIPTION lhs, rhs;
-
-    UNREFERENCED_PARAMETER(DeviceList);
-
-    lhs = CONTAINING_RECORD(FirstIdentificationDescription,
-        PDO_IDENTIFICATION_DESCRIPTION,
-        Header);
-    rhs = CONTAINING_RECORD(SecondIdentificationDescription,
-        PDO_IDENTIFICATION_DESCRIPTION,
-        Header);
-
-    return (lhs->SerialNo == rhs->SerialNo) ? TRUE : FALSE;
-}
-
-//
-// Creates and initializes a PDO (child).
-// 
-NTSTATUS Bus_CreatePdo(
-    _In_ WDFDEVICE Device,
-    _In_ PWDFDEVICE_INIT DeviceInit,
-    _In_ PPDO_IDENTIFICATION_DESCRIPTION Description)
-{
-    NTSTATUS                        status;
-    PPDO_DEVICE_DATA                pdoData;
-    WDFDEVICE                       hChild = NULL;
-    WDF_DEVICE_PNP_CAPABILITIES     pnpCaps;
-    WDF_DEVICE_POWER_CAPABILITIES   powerCaps;
-    WDF_PNPPOWER_EVENT_CALLBACKS    pnpPowerCallbacks;
-    WDF_OBJECT_ATTRIBUTES           pdoAttributes;
-    WDF_IO_QUEUE_CONFIG             defaultPdoQueueConfig;
-    WDFQUEUE                        defaultPdoQueue;
-    UNICODE_STRING                  deviceDescription;
-    VIGEM_BUS_INTERFACE             busInterface;
-    WDF_OBJECT_ATTRIBUTES           attributes;
-    WDF_IO_QUEUE_CONFIG             usbInQueueConfig;
-    WDF_IO_QUEUE_CONFIG             notificationsQueueConfig;
-
-    DECLARE_CONST_UNICODE_STRING(deviceLocation, L"Virtual Gamepad Emulation Bus");
-    DECLARE_UNICODE_STRING_SIZE(buffer, MAX_INSTANCE_ID_LEN);
-    // reserve space for device id
-    DECLARE_UNICODE_STRING_SIZE(deviceId, MAX_INSTANCE_ID_LEN);
-
-
-    PAGED_CODE();
-
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Entry");
-
-    //
-    // Get the FDO interface ASAP to report progress to bus
-    // 
-    status = WdfFdoQueryForInterface(Device,
-        &GUID_VIGEM_INTERFACE_PDO,
-        (PINTERFACE)&busInterface,
-        sizeof(VIGEM_BUS_INTERFACE),
-        VIGEM_BUS_INTERFACE_VERSION,
-        NULL);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSPDO,
-            "WdfFdoQueryForInterface failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    // set device type
-    WdfDeviceInitSetDeviceType(DeviceInit, FILE_DEVICE_BUS_EXTENDER);
-    // Bus is power policy owner
-    WdfDeviceInitSetPowerPolicyOwnership(DeviceInit, FALSE);
-
-#pragma region Enter RAW device mode
-
-    status = WdfPdoInitAssignRawDevice(DeviceInit, &GUID_DEVCLASS_VIGEM_RAWPDO);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSPDO,
-            "WdfPdoInitAssignRawDevice failed with status %!STATUS!",
-            status);
-        goto endCreatePdo;
-    }
-
-    WdfDeviceInitSetCharacteristics(DeviceInit, FILE_AUTOGENERATED_DEVICE_NAME, TRUE);
-
-    status = WdfDeviceInitAssignSDDLString(DeviceInit, &SDDL_DEVOBJ_SYS_ALL_ADM_RWX_WORLD_RWX_RES_RWX);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSPDO,
-            "WdfDeviceInitAssignSDDLString failed with status %!STATUS!",
-            status);
-        goto endCreatePdo;
-    }
-
-#pragma endregion
-
-#pragma region Prepare PDO
-
-    // set parameters matching desired target device
-    switch (Description->TargetType)
-    {
-        //
-        // A Xbox 360 device was requested
-        // 
-    case Xbox360Wired:
-
-        status = Xusb_PreparePdo(
-            DeviceInit,
-            Description->VendorId,
-            Description->ProductId,
-            &deviceId,
-            &deviceDescription);
-
-        if (!NT_SUCCESS(status))
-            goto endCreatePdo;
-
-        break;
-
-        //
-        // A Sony DualShock 4 device was requested
-        // 
-    case DualShock4Wired:
-
-        status = Ds4_PreparePdo(DeviceInit, &deviceId, &deviceDescription);
-
-        if (!NT_SUCCESS(status))
-            goto endCreatePdo;
-
-        break;
-
-        //
-        // A Xbox One device was requested
-        // 
-    case XboxOneWired:
-
-        status = Xgip_PreparePdo(DeviceInit, &deviceId, &deviceDescription);
-
-        if (!NT_SUCCESS(status))
-            goto endCreatePdo;
-
-        break;
-
-    default:
-
-        status = STATUS_INVALID_PARAMETER;
-
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSPDO,
-            "Unknown target type: %d (%!STATUS!)",
-            Description->TargetType,
-            status);
-
-        goto endCreatePdo;
-    }
-
-    // set device id
-    status = WdfPdoInitAssignDeviceID(DeviceInit, &deviceId);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSPDO,
-            "WdfPdoInitAssignDeviceID failed with status %!STATUS!",
-            status);
-        goto endCreatePdo;
-    }
-
-    // prepare instance id
-    status = RtlUnicodeStringPrintf(&buffer, L"%02d", Description->SerialNo);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSPDO,
-            "RtlUnicodeStringPrintf failed with status %!STATUS!",
-            status);
-        goto endCreatePdo;
-    }
-
-    // set instance id
-    status = WdfPdoInitAssignInstanceID(DeviceInit, &buffer);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSPDO,
-            "WdfPdoInitAssignInstanceID failed with status %!STATUS!",
-            status);
-        goto endCreatePdo;
-    }
-
-    // set device description (for English operating systems)
-    status = WdfPdoInitAddDeviceText(DeviceInit, &deviceDescription, &deviceLocation, 0x409);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSPDO,
-            "WdfPdoInitAddDeviceText failed with status %!STATUS!",
-            status);
-        goto endCreatePdo;
-    }
-
-    // default locale is English
-    // TODO: add more locales
-    WdfPdoInitSetDefaultLocale(DeviceInit, 0x409);
-
-#pragma endregion
-
-#pragma region PNP/Power event callbacks
-
-    WDF_PNPPOWER_EVENT_CALLBACKS_INIT(&pnpPowerCallbacks);
-
-    pnpPowerCallbacks.EvtDevicePrepareHardware = Pdo_EvtDevicePrepareHardware;
-
-    WdfDeviceInitSetPnpPowerEventCallbacks(DeviceInit, &pnpPowerCallbacks);
-
-#pragma endregion
-
-    // NOTE: not utilized at the moment
-    WdfPdoInitAllowForwardingRequestToParent(DeviceInit);
-
-#pragma region Create PDO
-
-    // Add common device data context
-    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&pdoAttributes, PDO_DEVICE_DATA);
-
-    status = WdfDeviceCreate(&DeviceInit, &pdoAttributes, &hChild);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSPDO,
-            "WdfDeviceCreate failed with status %!STATUS!",
-            status);
-        goto endCreatePdo;
-    }
-
-    TraceEvents(TRACE_LEVEL_VERBOSE,
-        TRACE_BUSPDO,
-        "Created PDO 0x%p",
-        hChild);
-
-    switch (Description->TargetType)
-    {
-        // Add XUSB-specific device data context
-    case Xbox360Wired:
-    {
-        PXUSB_DEVICE_DATA xusbData = NULL;
-        WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&pdoAttributes, XUSB_DEVICE_DATA);
-
-        status = WdfObjectAllocateContext(hChild, &pdoAttributes, (PVOID)&xusbData);
-        if (!NT_SUCCESS(status))
-        {
-            TraceEvents(TRACE_LEVEL_ERROR,
-                TRACE_BUSPDO,
-                "WdfObjectAllocateContext failed with status %!STATUS!",
-                status);
-            goto endCreatePdo;
-        }
-
-        break;
-    }
-    case DualShock4Wired:
-    {
-        PDS4_DEVICE_DATA ds4Data = NULL;
-        WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&pdoAttributes, DS4_DEVICE_DATA);
-
-        status = WdfObjectAllocateContext(hChild, &pdoAttributes, (PVOID)&ds4Data);
-        if (!NT_SUCCESS(status))
-        {
-            TraceEvents(TRACE_LEVEL_ERROR,
-                TRACE_BUSPDO,
-                "WdfObjectAllocateContext failed with status %!STATUS!",
-                status);
-            goto endCreatePdo;
-        }
-
-        break;
-    }
-    case XboxOneWired:
-    {
-        PXGIP_DEVICE_DATA xgipData = NULL;
-        WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&pdoAttributes, XGIP_DEVICE_DATA);
-
-        status = WdfObjectAllocateContext(hChild, &pdoAttributes, (PVOID)&xgipData);
-        if (!NT_SUCCESS(status))
-        {
-            TraceEvents(TRACE_LEVEL_ERROR,
-                TRACE_BUSPDO,
-                "WdfObjectAllocateContext failed with status %!STATUS!",
-                status);
-            goto endCreatePdo;
-        }
-
-        break;
-    }
-    default:
-        break;
-    }
-
-#pragma endregion
-
-#pragma region Expose USB Interface
-
-    status = WdfDeviceCreateDeviceInterface(Device, (LPGUID)&GUID_DEVINTERFACE_USB_DEVICE, NULL);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSPDO,
-            "WdfDeviceCreateDeviceInterface failed with status %!STATUS!",
-            status);
-        goto endCreatePdo;
-    }
-
-#pragma endregion
-
-#pragma region Set PDO contexts
-
-    pdoData = PdoGetData(hChild);
-
-    pdoData->BusInterface = busInterface;
-
-    pdoData->SerialNo = Description->SerialNo;
-    pdoData->TargetType = Description->TargetType;
-    pdoData->OwnerProcessId = Description->OwnerProcessId;
-    pdoData->VendorId = Description->VendorId;
-    pdoData->ProductId = Description->ProductId;
-
-    TraceEvents(TRACE_LEVEL_VERBOSE,
-        TRACE_BUSPDO,
-        "PDO Context properties: serial = %d, type = %d, pid = %d, vid = 0x%04X, pid = 0x%04X",
-        pdoData->SerialNo,
-        pdoData->TargetType,
-        pdoData->OwnerProcessId,
-        pdoData->VendorId,
-        pdoData->ProductId);
-
-    // Initialize additional contexts (if available)
-    switch (Description->TargetType)
-    {
-    case Xbox360Wired:
-
-        status = Xusb_AssignPdoContext(hChild);
-
-        break;
-
-    case DualShock4Wired:
-
-        status = Ds4_AssignPdoContext(hChild, Description);
-
-        break;
-
-    case XboxOneWired:
-
-        status = Xgip_AssignPdoContext(hChild);
-
-        break;
-
-    default:
-        break;
-    }
-
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSPDO,
-            "Couldn't initialize additional contexts: %!STATUS!",
-            status);
-
-        goto endCreatePdo;
-    }
-
-#pragma endregion
-
-#pragma region Create Queues & Locks
-
-    WDF_OBJECT_ATTRIBUTES_INIT(&attributes);
-    attributes.ParentObject = hChild;
-
-    // Create and assign queue for incoming interrupt transfer
-    WDF_IO_QUEUE_CONFIG_INIT(&usbInQueueConfig, WdfIoQueueDispatchManual);
-
-    status = WdfIoQueueCreate(hChild, &usbInQueueConfig, WDF_NO_OBJECT_ATTRIBUTES, &pdoData->PendingUsbInRequests);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSPDO,
-            "WdfIoQueueCreate (PendingUsbInRequests) failed with status %!STATUS!",
-            status);
-        goto endCreatePdo;
-    }
-
-    // Create and assign queue for user-land notification requests
-    WDF_IO_QUEUE_CONFIG_INIT(&notificationsQueueConfig, WdfIoQueueDispatchManual);
-
-    status = WdfIoQueueCreate(Device, &notificationsQueueConfig, WDF_NO_OBJECT_ATTRIBUTES, &pdoData->PendingNotificationRequests);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSPDO,
-            "WdfIoQueueCreate (PendingNotificationRequests) failed with status %!STATUS!",
-            status);
-        goto endCreatePdo;
-    }
-
-#pragma endregion 
-
-#pragma region Default I/O queue setup
-
-    WDF_IO_QUEUE_CONFIG_INIT_DEFAULT_QUEUE(&defaultPdoQueueConfig, WdfIoQueueDispatchParallel);
-
-    defaultPdoQueueConfig.EvtIoInternalDeviceControl = Pdo_EvtIoInternalDeviceControl;
-
-    status = WdfIoQueueCreate(hChild, &defaultPdoQueueConfig, WDF_NO_OBJECT_ATTRIBUTES, &defaultPdoQueue);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_BUSPDO,
-            "WdfIoQueueCreate (Default) failed with status %!STATUS!",
-            status);
-        goto endCreatePdo;
-    }
-
-#pragma endregion
-
-#pragma region PNP capabilities
-
-    WDF_DEVICE_PNP_CAPABILITIES_INIT(&pnpCaps);
-
-    pnpCaps.Removable = WdfTrue;
-    pnpCaps.EjectSupported = WdfTrue;
-    pnpCaps.SurpriseRemovalOK = WdfTrue;
-
-    pnpCaps.Address = Description->SerialNo;
-    pnpCaps.UINumber = Description->SerialNo;
-
-    WdfDeviceSetPnpCapabilities(hChild, &pnpCaps);
-
-#pragma endregion
-
-#pragma region Power capabilities
-
-    WDF_DEVICE_POWER_CAPABILITIES_INIT(&powerCaps);
-
-    powerCaps.DeviceD1 = WdfTrue;
-    powerCaps.WakeFromD1 = WdfTrue;
-    powerCaps.DeviceWake = PowerDeviceD1;
-
-    powerCaps.DeviceState[PowerSystemWorking] = PowerDeviceD0;
-    powerCaps.DeviceState[PowerSystemSleeping1] = PowerDeviceD1;
-    powerCaps.DeviceState[PowerSystemSleeping2] = PowerDeviceD3;
-    powerCaps.DeviceState[PowerSystemSleeping3] = PowerDeviceD3;
-    powerCaps.DeviceState[PowerSystemHibernate] = PowerDeviceD3;
-    powerCaps.DeviceState[PowerSystemShutdown] = PowerDeviceD3;
-
-    WdfDeviceSetPowerCapabilities(hChild, &powerCaps);
-
-#pragma endregion
-
-    endCreatePdo:
-                TraceEvents(TRACE_LEVEL_INFORMATION,
-                    TRACE_BUSPDO,
-                    "BUS_PDO_REPORT_STAGE_RESULT Stage: ViGEmPdoCreate  [serial: %d, status: %!STATUS!]",
-                    Description->SerialNo, status);
-
-                BUS_PDO_REPORT_STAGE_RESULT(busInterface, ViGEmPdoCreate, Description->SerialNo, status);
-
-                TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_BUSPDO, "%!FUNC! Exit with status %!STATUS!", status);
-
-                return status;
-}
-
-//
-// PDO power-up.
-// 
-NTSTATUS Pdo_EvtDevicePrepareHardware(
-    _In_ WDFDEVICE Device,
-    _In_ WDFCMRESLIST ResourcesRaw,
-    _In_ WDFCMRESLIST ResourcesTranslated
-)
-{
-    PPDO_DEVICE_DATA    pdoData;
-    NTSTATUS            status = STATUS_UNSUCCESSFUL;
-
-    PAGED_CODE();
-
-    UNREFERENCED_PARAMETER(ResourcesRaw);
-    UNREFERENCED_PARAMETER(ResourcesTranslated);
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_BUSENUM, "%!FUNC! Entry");
-
-    pdoData = PdoGetData(Device);
-
-    switch (pdoData->TargetType)
-    {
-        // Expose XUSB interfaces
-    case Xbox360Wired:
-
-        status = Xusb_PrepareHardware(Device);
-
-        break;
-
-    case DualShock4Wired:
-
-        status = Ds4_PrepareHardware(Device);
-
-        break;
-
-    case XboxOneWired:
-
-        status = Xgip_PrepareHardware(Device);
-
-        break;
-
-    default:
-        break;
-    }
-
-    TraceEvents(TRACE_LEVEL_INFORMATION,
-        TRACE_BUSPDO,
-        "BUS_PDO_REPORT_STAGE_RESULT Stage: ViGEmPdoCreate  [serial: %d, status: %!STATUS!]",
-        pdoData->SerialNo, status);
-
-    BUS_PDO_REPORT_STAGE_RESULT(pdoData->BusInterface, ViGEmPdoPrepareHardware, pdoData->SerialNo, status);
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_BUSPDO, "%!FUNC! Exit with status %!STATUS!", status);
-
-    return status;
-}
-
-//
-// Responds to IRP_MJ_INTERNAL_DEVICE_CONTROL requests sent to PDO.
-// 
-VOID Pdo_EvtIoInternalDeviceControl(
-    _In_ WDFQUEUE Queue,
-    _In_ WDFREQUEST Request,
-    _In_ size_t OutputBufferLength,
-    _In_ size_t InputBufferLength,
-    _In_ ULONG IoControlCode
-)
-{
-    // Regular buffers not used in USB communication
-    UNREFERENCED_PARAMETER(OutputBufferLength);
-    UNREFERENCED_PARAMETER(InputBufferLength);
-
-    NTSTATUS                status = STATUS_INVALID_PARAMETER;
-    WDFDEVICE               hDevice;
-    PIRP                    irp;
-    PURB                    urb;
-    PPDO_DEVICE_DATA        pdoData;
-    PIO_STACK_LOCATION      irpStack;
-    PXUSB_DEVICE_DATA       pXusbData;
-    PUCHAR                  blobBuffer;
-
-
-    TraceEvents(TRACE_LEVEL_VERBOSE, TRACE_BUSPDO, "%!FUNC! Entry");
-
-    hDevice = WdfIoQueueGetDevice(Queue);
-    pdoData = PdoGetData(hDevice);
-    // No help from the framework available from here on
-    irp = WdfRequestWdmGetIrp(Request);
-    irpStack = IoGetCurrentIrpStackLocation(irp);
-
-    switch (IoControlCode)
-    {
-    case IOCTL_INTERNAL_USB_SUBMIT_URB:
-
-        TraceEvents(TRACE_LEVEL_VERBOSE,
-            TRACE_BUSPDO,
-            ">> IOCTL_INTERNAL_USB_SUBMIT_URB");
-
-        urb = (PURB)URB_FROM_IRP(irp);
-
-        switch (urb->UrbHeader.Function)
-        {
-        case URB_FUNCTION_CONTROL_TRANSFER:
-
-            TraceEvents(TRACE_LEVEL_VERBOSE,
-                TRACE_BUSPDO,
-                ">> >> URB_FUNCTION_CONTROL_TRANSFER");
-
-            switch (urb->UrbControlTransfer.SetupPacket[6])
-            {
-            case 0x04:
-                if (pdoData->TargetType == Xbox360Wired)
-                {
-                    pXusbData = XusbGetData(hDevice);
-                    blobBuffer = WdfMemoryGetBuffer(pXusbData->InterruptBlobStorage, NULL);
-                    //
-                    // Xenon magic
-                    // 
-                    RtlCopyMemory(
-                        urb->UrbControlTransfer.TransferBuffer,
-                        &blobBuffer[XUSB_BLOB_07_OFFSET],
-                        0x04
-                    );
-                    status = STATUS_SUCCESS;
-                }
-                break;
-            case 0x14:
-                //
-                // This is some weird USB 1.0 condition and _must fail_
-                // 
-                urb->UrbControlTransfer.Hdr.Status = USBD_STATUS_STALL_PID;
-                status = STATUS_UNSUCCESSFUL;
-                break;
-            case 0x08:
-                //
-                // This is some weird USB 1.0 condition and _must fail_
-                // 
-                urb->UrbControlTransfer.Hdr.Status = USBD_STATUS_STALL_PID;
-                status = STATUS_UNSUCCESSFUL;
-                break;
-            default:
-                status = STATUS_SUCCESS;
-                break;
-            }
-
-            break;
-
-        case URB_FUNCTION_CONTROL_TRANSFER_EX:
-
-            TraceEvents(TRACE_LEVEL_VERBOSE,
-                TRACE_BUSPDO,
-                ">> >> URB_FUNCTION_CONTROL_TRANSFER_EX");
-
-            status = STATUS_UNSUCCESSFUL;
-
-            break;
-
-        case URB_FUNCTION_BULK_OR_INTERRUPT_TRANSFER:
-
-            TraceEvents(TRACE_LEVEL_VERBOSE,
-                TRACE_BUSPDO,
-                ">> >> URB_FUNCTION_BULK_OR_INTERRUPT_TRANSFER");
-
-            status = UsbPdo_BulkOrInterruptTransfer(urb, hDevice, Request);
-
-            break;
-
-        case URB_FUNCTION_SELECT_CONFIGURATION:
-
-            TraceEvents(TRACE_LEVEL_VERBOSE,
-                TRACE_BUSPDO,
-                ">> >> URB_FUNCTION_SELECT_CONFIGURATION");
-
-            status = UsbPdo_SelectConfiguration(urb, pdoData);
-
-            break;
-
-        case URB_FUNCTION_SELECT_INTERFACE:
-
-            TraceEvents(TRACE_LEVEL_VERBOSE,
-                TRACE_BUSPDO,
-                ">> >> URB_FUNCTION_SELECT_INTERFACE");
-
-            status = UsbPdo_SelectInterface(urb, pdoData);
-
-            break;
-
-        case URB_FUNCTION_GET_DESCRIPTOR_FROM_DEVICE:
-
-            TraceEvents(TRACE_LEVEL_VERBOSE,
-                TRACE_BUSPDO,
-                ">> >> URB_FUNCTION_GET_DESCRIPTOR_FROM_DEVICE");
-
-            switch (urb->UrbControlDescriptorRequest.DescriptorType)
-            {
-            case USB_DEVICE_DESCRIPTOR_TYPE:
-
-                TraceEvents(TRACE_LEVEL_VERBOSE,
-                    TRACE_BUSPDO,
-                    ">> >> >> USB_DEVICE_DESCRIPTOR_TYPE");
-
-                status = UsbPdo_GetDeviceDescriptorType(urb, pdoData);
-
-                break;
-
-            case USB_CONFIGURATION_DESCRIPTOR_TYPE:
-
-                TraceEvents(TRACE_LEVEL_VERBOSE,
-                    TRACE_BUSPDO,
-                    ">> >> >> USB_CONFIGURATION_DESCRIPTOR_TYPE");
-
-                status = UsbPdo_GetConfigurationDescriptorType(urb, pdoData);
-
-                break;
-
-            case USB_STRING_DESCRIPTOR_TYPE:
-
-                TraceEvents(TRACE_LEVEL_VERBOSE,
-                    TRACE_BUSPDO,
-                    ">> >> >> USB_STRING_DESCRIPTOR_TYPE");
-
-                status = UsbPdo_GetStringDescriptorType(urb, pdoData);
-
-                break;
-            case USB_INTERFACE_DESCRIPTOR_TYPE:
-
-                TraceEvents(TRACE_LEVEL_VERBOSE,
-                    TRACE_BUSPDO,
-                    ">> >> >> USB_INTERFACE_DESCRIPTOR_TYPE");
-
-                break;
-
-            case USB_ENDPOINT_DESCRIPTOR_TYPE:
-
-                TraceEvents(TRACE_LEVEL_VERBOSE,
-                    TRACE_BUSPDO,
-                    ">> >> >> USB_ENDPOINT_DESCRIPTOR_TYPE");
-
-                break;
-
-            default:
-
-                TraceEvents(TRACE_LEVEL_VERBOSE,
-                    TRACE_BUSPDO,
-                    ">> >> >> Unknown descriptor type");
-
-                break;
-            }
-
-            TraceEvents(TRACE_LEVEL_VERBOSE,
-                TRACE_BUSPDO,
-                "<< <<");
-
-            break;
-
-        case URB_FUNCTION_GET_STATUS_FROM_DEVICE:
-
-            TraceEvents(TRACE_LEVEL_VERBOSE,
-                TRACE_BUSPDO,
-                ">> >> URB_FUNCTION_GET_STATUS_FROM_DEVICE");
-
-            // Defaults always succeed
-            status = STATUS_SUCCESS;
-
-            break;
-
-        case URB_FUNCTION_ABORT_PIPE:
-
-            TraceEvents(TRACE_LEVEL_VERBOSE,
-                TRACE_BUSPDO,
-                ">> >> URB_FUNCTION_ABORT_PIPE");
-
-            status = UsbPdo_AbortPipe(hDevice);
-
-            break;
-
-        case URB_FUNCTION_CLASS_INTERFACE:
-
-            TraceEvents(TRACE_LEVEL_VERBOSE,
-                TRACE_BUSPDO,
-                ">> >> URB_FUNCTION_CLASS_INTERFACE");
-
-            status = UsbPdo_ClassInterface(urb, hDevice, pdoData);
-
-            break;
-
-        case URB_FUNCTION_GET_DESCRIPTOR_FROM_INTERFACE:
-
-            TraceEvents(TRACE_LEVEL_VERBOSE,
-                TRACE_BUSPDO,
-                ">> >> URB_FUNCTION_GET_DESCRIPTOR_FROM_INTERFACE");
-
-            status = UsbPdo_GetDescriptorFromInterface(urb, pdoData);
-
-            //
-            // The DS4 is basically ready to operate at this stage
-            // 
-            if (pdoData->TargetType == DualShock4Wired)
-            {
-                //
-                // Report back to FDO that we are ready to operate
-                // 
-                BUS_PDO_REPORT_STAGE_RESULT(
-                    pdoData->BusInterface,
-                    ViGEmPdoInitFinished,
-                    pdoData->SerialNo,
-                    STATUS_SUCCESS
-                );
-            }
-
-            break;
-
-        default:
-
-            TraceEvents(TRACE_LEVEL_VERBOSE,
-                TRACE_BUSPDO,
-                ">> >>  Unknown function: 0x%X",
-                urb->UrbHeader.Function);
-
-            break;
-        }
-
-        TraceEvents(TRACE_LEVEL_VERBOSE,
-            TRACE_BUSPDO,
-            "<<");
-
-        break;
-
-    case IOCTL_INTERNAL_USB_GET_PORT_STATUS:
-
-        TraceEvents(TRACE_LEVEL_VERBOSE,
-            TRACE_BUSPDO,
-            ">> IOCTL_INTERNAL_USB_GET_PORT_STATUS");
-
-        // We report the (virtual) port as always active
-        *(unsigned long *)irpStack->Parameters.Others.Argument1 = USBD_PORT_ENABLED | USBD_PORT_CONNECTED;
-
-        status = STATUS_SUCCESS;
-
-        break;
-
-    case IOCTL_INTERNAL_USB_RESET_PORT:
-
-        TraceEvents(TRACE_LEVEL_VERBOSE,
-            TRACE_BUSPDO,
-            ">> IOCTL_INTERNAL_USB_RESET_PORT");
-
-        // Sure, why not ;)
-        status = STATUS_SUCCESS;
-
-        break;
-
-    case IOCTL_INTERNAL_USB_SUBMIT_IDLE_NOTIFICATION:
-
-        TraceEvents(TRACE_LEVEL_VERBOSE,
-            TRACE_BUSPDO,
-            ">> IOCTL_INTERNAL_USB_SUBMIT_IDLE_NOTIFICATION");
-
-        // TODO: implement
-        // This happens if the I/O latency is too high so HIDUSB aborts communication.
-        status = STATUS_SUCCESS;
-
-        break;
-
-    default:
-
-        TraceEvents(TRACE_LEVEL_VERBOSE,
-            TRACE_BUSPDO,
-            ">> Unknown I/O control code 0x%X",
-            IoControlCode);
-
-        break;
-    }
-
-    if (status != STATUS_PENDING)
-    {
-        WdfRequestComplete(Request, status);
-    }
-
-    TraceEvents(TRACE_LEVEL_VERBOSE, TRACE_BUSPDO, "%!FUNC! Exit with status %!STATUS!", status);
-}
-

sys/buspdo.cpp

@@ -0,0 +1,57 @@
+/*
+* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
+*
+* BSD 3-Clause License
+*
+* Copyright (c) 2018-2020, Nefarius Software Solutions e.U. and Contributors
+* All rights reserved.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*
+* 1. Redistributions of source code must retain the above copyright notice, this
+*    list of conditions and the following disclaimer.
+*
+* 2. Redistributions in binary form must reproduce the above copyright notice,
+*    this list of conditions and the following disclaimer in the documentation
+*    and/or other materials provided with the distribution.
+*
+* 3. Neither the name of the copyright holder nor the names of its
+*    contributors may be used to endorse or promote products derived from
+*    this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+
+#include "Driver.h"
+#include "EmulationTargetPDO.hpp"
+
+#include "Debugging.hpp"
+
+#ifdef ALLOC_PRAGMA
+#pragma alloc_text(PAGE, Bus_EvtDeviceListCreatePdo)
+#endif
+
+EXTERN_C NTSTATUS Bus_EvtDeviceListCreatePdo(
+    WDFCHILDLIST DeviceList,
+    PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER IdentificationDescription,
+    PWDFDEVICE_INIT ChildInit)
+{
+	ViGEm::Bus::Core::PPDO_IDENTIFICATION_DESCRIPTION pDesc;
+
+    PAGED_CODE();
+
+    pDesc = CONTAINING_RECORD(IdentificationDescription, ViGEm::Bus::Core::PDO_IDENTIFICATION_DESCRIPTION, Header);
+
+    return pDesc->Target->PdoCreateDevice(WdfChildListGetDevice(DeviceList), ChildInit);
+}

sys/trace.h

@@ -1,27 +1,35 @@
 /*
 * Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
 *
-* MIT License
+* BSD 3-Clause License
 *
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
+* Copyright (c) 2018-2020, Nefarius Software Solutions e.U. and Contributors
+* All rights reserved.
 *
-* 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:
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
 *
-* The above copyright notice and this permission notice shall be included in all
-* copies or substantial portions of the Software.
+* 1. Redistributions of source code must retain the above copyright notice, this
+*    list of conditions and the following disclaimer.
 *
-* 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.
+* 2. Redistributions in binary form must reproduce the above copyright notice,
+*    this list of conditions and the following disclaimer in the documentation
+*    and/or other materials provided with the distribution.
+*
+* 3. Neither the name of the copyright holder nor the names of its
+*    contributors may be used to endorse or promote products derived from
+*    this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
 
@@ -68,5 +76,6 @@
 // begin_wpp config
 // FUNC Trace{FLAG=MYDRIVER_ALL_INFO}(LEVEL, MSG, ...);
 // FUNC TraceEvents(LEVEL, FLAGS, MSG, ...);
+// FUNC TraceDbg{LEVEL=TRACE_LEVEL_INFORMATION}(FLAGS, MSG, ...);
 // end_wpp
 //

sys/util.c

@@ -1,62 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-*
-* MIT License
-*
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-*
-* 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.
-*/
-
-
-#include <ntifs.h>
-#include "busenum.h"
-#include "util.tmh"
-
-
-VOID ReverseByteArray(PUCHAR Array, INT Length)
-{
-    PUCHAR s = (PUCHAR)ExAllocatePoolWithTag(NonPagedPool, sizeof(UCHAR) * Length, VIGEM_POOL_TAG);
-    INT c, d;
-
-    if (s == NULL)
-        return;
-
-    for (c = Length - 1, d = 0; c >= 0; c--, d++)
-        *(s + d) = *(Array + c);
-
-    for (c = 0; c < Length; c++)
-        *(Array + c) = *(s + c);
-
-    ExFreePoolWithTag(s, VIGEM_POOL_TAG);
-}
-
-VOID GenerateRandomMacAddress(PMAC_ADDRESS Address)
-{
-    // Vendor "C0:13:37"
-    Address->Vendor0 = 0xC0;
-    Address->Vendor1 = 0x13;
-    Address->Vendor2 = 0x37;
-
-    ULONG seed = KeQueryPerformanceCounter(NULL).LowPart;
-    
-    Address->Nic0 = RtlRandomEx(&seed) % 0xFF;
-    Address->Nic1 = RtlRandomEx(&seed) % 0xFF;
-    Address->Nic2 = RtlRandomEx(&seed) % 0xFF;
-}

sys/xgip.c

@@ -1,409 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-*
-* MIT License
-*
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-*
-* 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.
-*/
-
-
-#include "busenum.h"
-#include <wdmguid.h>
-#include "xgip.tmh"
-
-NTSTATUS Xgip_PreparePdo(PWDFDEVICE_INIT DeviceInit, PUNICODE_STRING DeviceId, PUNICODE_STRING DeviceDescription)
-{
-    NTSTATUS status;
-    UNICODE_STRING buffer;
-
-    // prepare device description
-    status = RtlUnicodeStringInit(DeviceDescription, L"Virtual Xbox One Controller");
-    if (!NT_SUCCESS(status))
-        return status;
-
-    // Set hardware IDs
-    RtlUnicodeStringInit(&buffer, L"USB\\VID_0E6F&PID_0139&REV_0650");
-
-    status = WdfPdoInitAddHardwareID(DeviceInit, &buffer);
-    if (!NT_SUCCESS(status))
-        return status;
-
-    RtlUnicodeStringCopy(DeviceId, &buffer);
-
-    RtlUnicodeStringInit(&buffer, L"USB\\VID_0E6F&PID_0139");
-
-    status = WdfPdoInitAddHardwareID(DeviceInit, &buffer);
-    if (!NT_SUCCESS(status))
-        return status;
-
-    // Set compatible IDs
-    RtlUnicodeStringInit(&buffer, L"USB\\MS_COMP_XGIP10");
-
-    status = WdfPdoInitAddCompatibleID(DeviceInit, &buffer);
-    if (!NT_SUCCESS(status))
-        return status;
-
-    RtlUnicodeStringInit(&buffer, L"USB\\Class_FF&SubClass_47&Prot_D0");
-
-    status = WdfPdoInitAddCompatibleID(DeviceInit, &buffer);
-    if (!NT_SUCCESS(status))
-        return status;
-
-    RtlUnicodeStringInit(&buffer, L"USB\\Class_FF&SubClass_47");
-
-    status = WdfPdoInitAddCompatibleID(DeviceInit, &buffer);
-    if (!NT_SUCCESS(status))
-        return status;
-
-    RtlUnicodeStringInit(&buffer, L"USB\\Class_FF");
-
-    status = WdfPdoInitAddCompatibleID(DeviceInit, &buffer);
-    if (!NT_SUCCESS(status))
-        return status;
-
-    return STATUS_SUCCESS;
-}
-
-NTSTATUS Xgip_PrepareHardware(WDFDEVICE Device)
-{
-    NTSTATUS status;
-    WDF_QUERY_INTERFACE_CONFIG ifaceCfg;
-
-    // Expose USB_BUS_INTERFACE_USBDI_GUID
-    USB_BUS_INTERFACE_USBDI_V1 xgipInterface;
-
-    xgipInterface.Size = sizeof(USB_BUS_INTERFACE_USBDI_V1);
-    xgipInterface.Version = USB_BUSIF_USBDI_VERSION_1;
-    xgipInterface.BusContext = (PVOID)Device;
-
-    xgipInterface.InterfaceReference = WdfDeviceInterfaceReferenceNoOp;
-    xgipInterface.InterfaceDereference = WdfDeviceInterfaceDereferenceNoOp;
-
-    xgipInterface.SubmitIsoOutUrb = UsbPdo_SubmitIsoOutUrb;
-    xgipInterface.GetUSBDIVersion = UsbPdo_GetUSBDIVersion;
-    xgipInterface.QueryBusTime = UsbPdo_QueryBusTime;
-    xgipInterface.QueryBusInformation = UsbPdo_QueryBusInformation;
-    xgipInterface.IsDeviceHighSpeed = UsbPdo_IsDeviceHighSpeed;
-
-    WDF_QUERY_INTERFACE_CONFIG_INIT(&ifaceCfg, (PINTERFACE)&xgipInterface, &USB_BUS_INTERFACE_USBDI_GUID, NULL);
-
-    status = WdfDeviceAddQueryInterface(Device, &ifaceCfg);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR, TRACE_XGIP, "WdfDeviceAddQueryInterface failed with status %!STATUS!", status);
-        return status;
-    }
-
-    // Default button states
-    UCHAR DefaultReport[XGIP_REPORT_SIZE] =
-    {
-        0x20, 0x00, 0x10, 0x0e, 0x00, 0x00, 0x00, 0x00,
-        0x00, 0x00, 0xa3, 0xfd, 0xed, 0x05, 0x5b, 0x03,
-        0x6f, 0x02
-    };
-
-    RtlCopyBytes(XgipGetData(Device)->Report, DefaultReport, XGIP_REPORT_SIZE);
-
-    return STATUS_SUCCESS;
-}
-
-NTSTATUS Xgip_AssignPdoContext(WDFDEVICE Device)
-{
-    NTSTATUS status;
-
-    PXGIP_DEVICE_DATA xgip = XgipGetData(Device);
-
-    TraceEvents(TRACE_LEVEL_VERBOSE, TRACE_XGIP, "Initializing XGIP context...");
-
-    RtlZeroMemory(xgip, sizeof(XGIP_DEVICE_DATA));
-
-    // Set fixed report id
-    xgip->Report[0] = 0x20;
-    xgip->Report[3] = 0x0E;
-
-    // I/O Queue for pending IRPs
-    WDF_IO_QUEUE_CONFIG pendingUsbQueueConfig, notificationsQueueConfig;
-
-    // Create and assign queue for incoming interrupt transfer
-    WDF_IO_QUEUE_CONFIG_INIT(&pendingUsbQueueConfig, WdfIoQueueDispatchManual);
-
-    status = WdfIoQueueCreate(Device, &pendingUsbQueueConfig, WDF_NO_OBJECT_ATTRIBUTES, &xgip->PendingUsbInRequests);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR, TRACE_XGIP, "WdfIoQueueCreate failed with status %!STATUS!", status);
-        return status;
-    }
-
-    // Create and assign queue for user-land notification requests
-    WDF_IO_QUEUE_CONFIG_INIT(&notificationsQueueConfig, WdfIoQueueDispatchManual);
-
-    status = WdfIoQueueCreate(Device, &notificationsQueueConfig, WDF_NO_OBJECT_ATTRIBUTES, &xgip->PendingNotificationRequests);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR, TRACE_XGIP, "WdfIoQueueCreate failed with status %!STATUS!", status);
-        return status;
-    }
-
-    WDF_OBJECT_ATTRIBUTES collectionAttribs;
-    WDF_OBJECT_ATTRIBUTES_INIT(&collectionAttribs);
-
-    collectionAttribs.ParentObject = Device;
-
-    status = WdfCollectionCreate(&collectionAttribs, &xgip->XboxgipSysInitCollection);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR, TRACE_XGIP, "WdfCollectionCreate failed with status %!STATUS!", status);
-        return status;
-    }
-
-    // Initialize periodic timer
-    WDF_TIMER_CONFIG timerConfig;
-    WDF_TIMER_CONFIG_INIT_PERIODIC(&timerConfig, Xgip_SysInitTimerFunc, XGIP_SYS_INIT_PERIOD);
-
-    // Timer object attributes
-    WDF_OBJECT_ATTRIBUTES timerAttribs;
-    WDF_OBJECT_ATTRIBUTES_INIT(&timerAttribs);
-
-    // PDO is parent
-    timerAttribs.ParentObject = Device;
-
-    // Create timer
-    status = WdfTimerCreate(&timerConfig, &timerAttribs, &xgip->XboxgipSysInitTimer);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR, TRACE_XGIP, "WdfTimerCreate failed with status %!STATUS!", status);
-        return status;
-    }
-
-    return STATUS_SUCCESS;
-}
-
-VOID Xgip_GetConfigurationDescriptorType(PUCHAR Buffer, ULONG Length)
-{
-    UCHAR XgipDescriptorData[XGIP_DESCRIPTOR_SIZE] =
-    {
-        0x09,        //   bLength
-        0x02,        //   bDescriptorType (Configuration)
-        0x40, 0x00,  //   wTotalLength 64
-        0x02,        //   bNumInterfaces 2
-        0x01,        //   bConfigurationValue
-        0x00,        //   iConfiguration (String Index)
-        0xC0,        //   bmAttributes
-        0xFA,        //   bMaxPower 500mA
-
-        0x09,        //   bLength
-        0x04,        //   bDescriptorType (Interface)
-        0x00,        //   bInterfaceNumber 0
-        0x00,        //   bAlternateSetting
-        0x02,        //   bNumEndpoints 2
-        0xFF,        //   bInterfaceClass
-        0x47,        //   bInterfaceSubClass
-        0xD0,        //   bInterfaceProtocol
-        0x00,        //   iInterface (String Index)
-
-        0x07,        //   bLength
-        0x05,        //   bDescriptorType (Endpoint)
-        0x81,        //   bEndpointAddress (IN/D2H)
-        0x03,        //   bmAttributes (Interrupt)
-        0x40, 0x00,  //   wMaxPacketSize 64
-        0x04,        //   bInterval 4 (unit depends on device speed)
-
-        0x07,        //   bLength
-        0x05,        //   bDescriptorType (Endpoint)
-        0x01,        //   bEndpointAddress (OUT/H2D)
-        0x03,        //   bmAttributes (Interrupt)
-        0x40, 0x00,  //   wMaxPacketSize 64
-        0x04,        //   bInterval 4 (unit depends on device speed)
-
-        0x09,        //   bLength
-        0x04,        //   bDescriptorType (Interface)
-        0x01,        //   bInterfaceNumber 1
-        0x00,        //   bAlternateSetting
-        0x00,        //   bNumEndpoints 0
-        0xFF,        //   bInterfaceClass
-        0x47,        //   bInterfaceSubClass
-        0xD0,        //   bInterfaceProtocol
-        0x00,        //   iInterface (String Index)
-
-        0x09,        //   bLength
-        0x04,        //   bDescriptorType (Interface)
-        0x01,        //   bInterfaceNumber 1
-        0x01,        //   bAlternateSetting
-        0x02,        //   bNumEndpoints 2
-        0xFF,        //   bInterfaceClass
-        0x47,        //   bInterfaceSubClass
-        0xD0,        //   bInterfaceProtocol
-        0x00,        //   iInterface (String Index)
-
-        0x07,        //   bLength
-        0x05,        //   bDescriptorType (Endpoint)
-        0x02,        //   bEndpointAddress (OUT/H2D)
-        0x01,        //   bmAttributes (Isochronous, No Sync, Data EP)
-        0xE0, 0x00,  //   wMaxPacketSize 224
-        0x01,        //   bInterval 1 (unit depends on device speed)
-
-        0x07,        //   bLength
-        0x05,        //   bDescriptorType (Endpoint)
-        0x83,        //   bEndpointAddress (IN/D2H)
-        0x01,        //   bmAttributes (Isochronous, No Sync, Data EP)
-        0x80, 0x00,  //   wMaxPacketSize 128
-        0x01,        //   bInterval 1 (unit depends on device speed)
-
-                     // 64 bytes
-
-                     // best guess: USB Standard Descriptor
-    };
-
-    RtlCopyBytes(Buffer, XgipDescriptorData, Length);
-}
-
-VOID Xgip_GetDeviceDescriptorType(PUSB_DEVICE_DESCRIPTOR pDescriptor, PPDO_DEVICE_DATA pCommon)
-{
-    pDescriptor->bLength = 0x12;
-    pDescriptor->bDescriptorType = USB_DEVICE_DESCRIPTOR_TYPE;
-    pDescriptor->bcdUSB = 0x0200; // USB v2.0
-    pDescriptor->bDeviceClass = 0xFF;
-    pDescriptor->bDeviceSubClass = 0x47;
-    pDescriptor->bDeviceProtocol = 0xD0;
-    pDescriptor->bMaxPacketSize0 = 0x40;
-    pDescriptor->idVendor = pCommon->VendorId;
-    pDescriptor->idProduct = pCommon->ProductId;
-    pDescriptor->bcdDevice = 0x0650;
-    pDescriptor->iManufacturer = 0x01;
-    pDescriptor->iProduct = 0x02;
-    pDescriptor->iSerialNumber = 0x03;
-    pDescriptor->bNumConfigurations = 0x01;
-}
-
-VOID Xgip_SelectConfiguration(PUSBD_INTERFACE_INFORMATION pInfo)
-{
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_XGIP, ">> >> >> URB_FUNCTION_SELECT_CONFIGURATION: Length %d, Interface %d, Alternate %d, Pipes %d",
-        (int)pInfo->Length,
-        (int)pInfo->InterfaceNumber,
-        (int)pInfo->AlternateSetting,
-        pInfo->NumberOfPipes);
-
-    pInfo->Class = 0xFF;
-    pInfo->SubClass = 0x47;
-    pInfo->Protocol = 0xD0;
-
-    pInfo->InterfaceHandle = (USBD_INTERFACE_HANDLE)0xFFFF0000;
-
-    pInfo->Pipes[0].MaximumTransferSize = 0x00400000;
-    pInfo->Pipes[0].MaximumPacketSize = 0x40;
-    pInfo->Pipes[0].EndpointAddress = 0x81;
-    pInfo->Pipes[0].Interval = 0x04;
-    pInfo->Pipes[0].PipeType = UsbdPipeTypeInterrupt;
-    pInfo->Pipes[0].PipeHandle = (USBD_PIPE_HANDLE)0xFFFF0081;
-    pInfo->Pipes[0].PipeFlags = 0x00;
-
-    pInfo->Pipes[1].MaximumTransferSize = 0x00400000;
-    pInfo->Pipes[1].MaximumPacketSize = 0x40;
-    pInfo->Pipes[1].EndpointAddress = 0x01;
-    pInfo->Pipes[1].Interval = 0x04;
-    pInfo->Pipes[1].PipeType = UsbdPipeTypeInterrupt;
-    pInfo->Pipes[1].PipeHandle = (USBD_PIPE_HANDLE)0xFFFF0001;
-    pInfo->Pipes[1].PipeFlags = 0x00;
-
-    pInfo = (PUSBD_INTERFACE_INFORMATION)((PCHAR)pInfo + pInfo->Length);
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_XGIP, ">> >> >> URB_FUNCTION_SELECT_CONFIGURATION: Length %d, Interface %d, Alternate %d, Pipes %d",
-        (int)pInfo->Length,
-        (int)pInfo->InterfaceNumber,
-        (int)pInfo->AlternateSetting,
-        pInfo->NumberOfPipes);
-
-    pInfo->Class = 0xFF;
-    pInfo->SubClass = 0x47;
-    pInfo->Protocol = 0xD0;
-
-    pInfo->InterfaceHandle = (USBD_INTERFACE_HANDLE)0xFFFF0000;
-}
-
-VOID Xgip_SysInitTimerFunc(
-    _In_ WDFTIMER Timer
-)
-{
-    NTSTATUS status;
-    WDFDEVICE hChild;
-    PXGIP_DEVICE_DATA xgip;
-    WDFREQUEST usbRequest;
-    PIRP pendingIrp;
-    PIO_STACK_LOCATION irpStack;
-    WDFMEMORY mem;
-
-    hChild = WdfTimerGetParentObject(Timer);
-    xgip = XgipGetData(hChild);
-
-    if (xgip == NULL) return;
-
-    // Is TRUE when collection is filled up
-    if (xgip->XboxgipSysInitReady)
-    {
-        TraceEvents(TRACE_LEVEL_VERBOSE, TRACE_XGIP, "XBOXGIP ready, completing requests...");
-
-        // Get pending IN request
-        status = WdfIoQueueRetrieveNextRequest(xgip->PendingUsbInRequests, &usbRequest);
-
-        if (NT_SUCCESS(status))
-        {
-            TraceEvents(TRACE_LEVEL_VERBOSE, TRACE_XGIP, "Request found");
-
-            // Get top memory object
-            mem = (WDFMEMORY)WdfCollectionGetFirstItem(xgip->XboxgipSysInitCollection);
-
-            // Get pending IRP
-            pendingIrp = WdfRequestWdmGetIrp(usbRequest);
-            irpStack = IoGetCurrentIrpStackLocation(pendingIrp);
-
-            // Get USB request block
-            PURB urb = (PURB)irpStack->Parameters.Others.Argument1;
-
-            // Get buffer size and content
-            size_t size;
-            PUCHAR Buffer = WdfMemoryGetBuffer(mem, &size);
-
-            // Assign buffer size and content to URB
-            urb->UrbBulkOrInterruptTransfer.TransferBufferLength = (ULONG)size;
-            RtlCopyBytes(urb->UrbBulkOrInterruptTransfer.TransferBuffer, Buffer, size);
-
-            TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_XGIP, "[%X] Buffer length: %d",
-                ((PUCHAR)urb->UrbBulkOrInterruptTransfer.TransferBuffer)[0],
-                urb->UrbBulkOrInterruptTransfer.TransferBufferLength);
-
-            // Complete pending request
-            WdfRequestComplete(usbRequest, status);
-
-            // Free memory from collection
-            WdfCollectionRemoveItem(xgip->XboxgipSysInitCollection, 0);
-            WdfObjectDelete(mem);
-        }
-
-        // Stop timer when collection is purged
-        if (WdfCollectionGetCount(xgip->XboxgipSysInitCollection) == 0)
-        {
-            TraceEvents(TRACE_LEVEL_VERBOSE, TRACE_XGIP, "Collection finished");
-
-            WdfTimerStop(xgip->XboxgipSysInitTimer, FALSE);
-        }
-    }
-}
-

sys/xusb.c

@@ -1,639 +0,0 @@
-/*
-* Virtual Gamepad Emulation Framework - Windows kernel-mode bus driver
-*
-* MIT License
-*
-* Copyright (c) 2016-2019 Nefarius Software Solutions e.U. and Contributors
-*
-* 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.
-*/
-
-
-#include "busenum.h"
-#include <wdmguid.h>
-#include "xusb.tmh"
-
-NTSTATUS Xusb_PreparePdo(
-    PWDFDEVICE_INIT DeviceInit,
-    USHORT VendorId,
-    USHORT ProductId,
-    PUNICODE_STRING DeviceId,
-    PUNICODE_STRING DeviceDescription)
-{
-    NTSTATUS status;
-    DECLARE_UNICODE_STRING_SIZE(buffer, MAX_HARDWARE_ID_LENGTH);
-
-    // prepare device description
-    status = RtlUnicodeStringInit(DeviceDescription, L"Virtual Xbox 360 Controller");
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_XUSB,
-            "RtlUnicodeStringInit failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    // Set hardware ID
-    RtlUnicodeStringPrintf(&buffer, L"USB\\VID_%04X&PID_%04X", VendorId, ProductId);
-
-    RtlUnicodeStringCopy(DeviceId, &buffer);
-
-    status = WdfPdoInitAddHardwareID(DeviceInit, &buffer);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_XUSB,
-            "WdfPdoInitAddHardwareID failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-
-    // Set compatible IDs
-    RtlUnicodeStringInit(&buffer, L"USB\\MS_COMP_XUSB10");
-
-    status = WdfPdoInitAddCompatibleID(DeviceInit, &buffer);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_XUSB,
-            "WdfPdoInitAddCompatibleID #1 failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    RtlUnicodeStringInit(&buffer, L"USB\\Class_FF&SubClass_5D&Prot_01");
-
-    status = WdfPdoInitAddCompatibleID(DeviceInit, &buffer);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_XUSB,
-            "WdfPdoInitAddCompatibleID #2 failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    RtlUnicodeStringInit(&buffer, L"USB\\Class_FF&SubClass_5D");
-
-    status = WdfPdoInitAddCompatibleID(DeviceInit, &buffer);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_XUSB,
-            "WdfPdoInitAddCompatibleID #3 failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    RtlUnicodeStringInit(&buffer, L"USB\\Class_FF");
-
-    status = WdfPdoInitAddCompatibleID(DeviceInit, &buffer);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_XUSB,
-            "WdfPdoInitAddCompatibleID #4 failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    return STATUS_SUCCESS;
-}
-
-NTSTATUS Xusb_PrepareHardware(WDFDEVICE Device)
-{
-    NTSTATUS status;
-    WDF_QUERY_INTERFACE_CONFIG ifaceCfg;
-
-    INTERFACE dummyIface;
-
-    dummyIface.Size = sizeof(INTERFACE);
-    dummyIface.Version = 1;
-    dummyIface.Context = (PVOID)Device;
-
-    dummyIface.InterfaceReference = WdfDeviceInterfaceReferenceNoOp;
-    dummyIface.InterfaceDereference = WdfDeviceInterfaceDereferenceNoOp;
-
-    /* XUSB.sys will query for the following three "dummy" interfaces
-    * BUT WONT USE IT so we just expose them to satisfy initialization. (TODO: Check if still valid!)
-    */
-
-    // Dummy PNP_LOCATION
-
-    WDF_QUERY_INTERFACE_CONFIG_INIT(&ifaceCfg, (PINTERFACE)&dummyIface, &GUID_PNP_LOCATION_INTERFACE, NULL);
-
-    status = WdfDeviceAddQueryInterface(Device, &ifaceCfg);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_XUSB,
-            "Couldn't register PNP_LOCATION dummy interface %!GUID! (WdfDeviceAddQueryInterface failed with status %!STATUS!)",
-            &GUID_PNP_LOCATION_INTERFACE,
-            status);
-
-        return status;
-    }
-
-    // Dummy D3COLD_SUPPORT
-
-    WDF_QUERY_INTERFACE_CONFIG_INIT(&ifaceCfg, (PINTERFACE)&dummyIface, &GUID_D3COLD_SUPPORT_INTERFACE, NULL);
-
-    status = WdfDeviceAddQueryInterface(Device, &ifaceCfg);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_XUSB,
-            "Couldn't register D3COLD_SUPPORT dummy interface %!GUID! (WdfDeviceAddQueryInterface failed with status %!STATUS!)",
-            &GUID_D3COLD_SUPPORT_INTERFACE,
-            status);
-
-        return status;
-    }
-
-    // Dummy REENUMERATE_SELF_INTERFACE_STANDARD
-
-    WDF_QUERY_INTERFACE_CONFIG_INIT(&ifaceCfg, (PINTERFACE)&dummyIface, &GUID_REENUMERATE_SELF_INTERFACE_STANDARD, NULL);
-
-    status = WdfDeviceAddQueryInterface(Device, &ifaceCfg);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_XUSB,
-            "Couldn't register REENUM_SELF_STD dummy interface %!GUID! (WdfDeviceAddQueryInterface failed with status %!STATUS!)",
-            &GUID_REENUMERATE_SELF_INTERFACE_STANDARD,
-            status);
-
-        return status;
-    }
-
-    // Expose USB_BUS_INTERFACE_USBDI_GUID
-
-    // This interface actually IS used
-    USB_BUS_INTERFACE_USBDI_V1 xusbInterface;
-
-    xusbInterface.Size = sizeof(USB_BUS_INTERFACE_USBDI_V1);
-    xusbInterface.Version = USB_BUSIF_USBDI_VERSION_1;
-    xusbInterface.BusContext = (PVOID)Device;
-
-    xusbInterface.InterfaceReference = WdfDeviceInterfaceReferenceNoOp;
-    xusbInterface.InterfaceDereference = WdfDeviceInterfaceDereferenceNoOp;
-
-    xusbInterface.SubmitIsoOutUrb = UsbPdo_SubmitIsoOutUrb;
-    xusbInterface.GetUSBDIVersion = UsbPdo_GetUSBDIVersion;
-    xusbInterface.QueryBusTime = UsbPdo_QueryBusTime;
-    xusbInterface.QueryBusInformation = UsbPdo_QueryBusInformation;
-    xusbInterface.IsDeviceHighSpeed = UsbPdo_IsDeviceHighSpeed;
-
-    WDF_QUERY_INTERFACE_CONFIG_INIT(&ifaceCfg, (PINTERFACE)&xusbInterface, &USB_BUS_INTERFACE_USBDI_GUID, NULL);
-
-    status = WdfDeviceAddQueryInterface(Device, &ifaceCfg);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_XUSB,
-            "WdfDeviceAddQueryInterface failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    return STATUS_SUCCESS;
-}
-
-NTSTATUS Xusb_AssignPdoContext(WDFDEVICE Device)
-{
-    NTSTATUS                status;
-    WDF_OBJECT_ATTRIBUTES   attributes;
-    PUCHAR                  blobBuffer;
-
-    WDF_OBJECT_ATTRIBUTES_INIT(&attributes);
-    attributes.ParentObject = Device;
-
-    TraceEvents(TRACE_LEVEL_VERBOSE, TRACE_XUSB, "Initializing XUSB context...");
-
-    PXUSB_DEVICE_DATA xusb = XusbGetData(Device);
-
-    RtlZeroMemory(xusb, sizeof(XUSB_DEVICE_DATA));
-
-    // Is later overwritten by actual XInput slot
-    xusb->LedNumber = -1;
-    // Packet size (20 bytes = 0x14)
-    xusb->Packet.Size = 0x14;
-
-    // Allocate blob storage
-    status = WdfMemoryCreate(
-        &attributes,
-        NonPagedPoolNx,
-        XUSB_POOL_TAG,
-        XUSB_BLOB_STORAGE_SIZE,
-        &xusb->InterruptBlobStorage,
-        &blobBuffer
-    );
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_XUSB,
-            "WdfMemoryCreate failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    // Fill blob storage
-    COPY_BYTE_ARRAY(blobBuffer, P99_PROTECT({
-        // 0
-        0x01, 0x03, 0x0E,
-        // 1
-        0x02, 0x03, 0x00,
-        // 2
-        0x03, 0x03, 0x03,
-        // 3
-        0x08, 0x03, 0x00,
-        // 4
-        0x00, 0x14, 0x00, 0x00, 0x00, 0x00, 0xe4, 0xf2,
-        0xb3, 0xf8, 0x49, 0xf3, 0xb0, 0xfc, 0x00, 0x00,
-        0x00, 0x00, 0x00, 0x00,
-        // 5
-        0x01, 0x03, 0x03,
-        // 6
-        0x05, 0x03, 0x00,
-        // 7
-        0x31, 0x3F, 0xCF, 0xDC
-        }));
-
-    // I/O Queue for pending IRPs
-    WDF_IO_QUEUE_CONFIG holdingInQueueConfig;
-
-    // Create and assign queue for unhandled interrupt requests
-    WDF_IO_QUEUE_CONFIG_INIT(&holdingInQueueConfig, WdfIoQueueDispatchManual);
-
-    status = WdfIoQueueCreate(Device, &holdingInQueueConfig, WDF_NO_OBJECT_ATTRIBUTES, &xusb->HoldingUsbInRequests);
-    if (!NT_SUCCESS(status))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_XUSB,
-            "WdfIoQueueCreate (HoldingUsbInRequests) failed with status %!STATUS!",
-            status);
-        return status;
-    }
-
-    return STATUS_SUCCESS;
-}
-
-VOID Xusb_GetConfigurationDescriptorType(PUCHAR Buffer, ULONG Length)
-{
-    UCHAR XusbDescriptorData[XUSB_DESCRIPTOR_SIZE] =
-    {
-        0x09,        //   bLength
-        0x02,        //   bDescriptorType (Configuration)
-        0x99, 0x00,  //   wTotalLength 153
-        0x04,        //   bNumInterfaces 4
-        0x01,        //   bConfigurationValue
-        0x00,        //   iConfiguration (String Index)
-        0xA0,        //   bmAttributes Remote Wakeup
-        0xFA,        //   bMaxPower 500mA
-
-        0x09,        //   bLength
-        0x04,        //   bDescriptorType (Interface)
-        0x00,        //   bInterfaceNumber 0
-        0x00,        //   bAlternateSetting
-        0x02,        //   bNumEndpoints 2
-        0xFF,        //   bInterfaceClass
-        0x5D,        //   bInterfaceSubClass
-        0x01,        //   bInterfaceProtocol
-        0x00,        //   iInterface (String Index)
-
-        0x11,        //   bLength
-        0x21,        //   bDescriptorType (HID)
-        0x00, 0x01,  //   bcdHID 1.00
-        0x01,        //   bCountryCode
-        0x25,        //   bNumDescriptors
-        0x81,        //   bDescriptorType[0] (Unknown 0x81)
-        0x14, 0x00,  //   wDescriptorLength[0] 20
-        0x00,        //   bDescriptorType[1] (Unknown 0x00)
-        0x00, 0x00,  //   wDescriptorLength[1] 0
-        0x13,        //   bDescriptorType[2] (Unknown 0x13)
-        0x01, 0x08,  //   wDescriptorLength[2] 2049
-        0x00,        //   bDescriptorType[3] (Unknown 0x00)
-        0x00,
-        0x07,        //   bLength
-        0x05,        //   bDescriptorType (Endpoint)
-        0x81,        //   bEndpointAddress (IN/D2H)
-        0x03,        //   bmAttributes (Interrupt)
-        0x20, 0x00,  //   wMaxPacketSize 32
-        0x04,        //   bInterval 4 (unit depends on device speed)
-
-        0x07,        //   bLength
-        0x05,        //   bDescriptorType (Endpoint)
-        0x01,        //   bEndpointAddress (OUT/H2D)
-        0x03,        //   bmAttributes (Interrupt)
-        0x20, 0x00,  //   wMaxPacketSize 32
-        0x08,        //   bInterval 8 (unit depends on device speed)
-
-        0x09,        //   bLength
-        0x04,        //   bDescriptorType (Interface)
-        0x01,        //   bInterfaceNumber 1
-        0x00,        //   bAlternateSetting
-        0x04,        //   bNumEndpoints 4
-        0xFF,        //   bInterfaceClass
-        0x5D,        //   bInterfaceSubClass
-        0x03,        //   bInterfaceProtocol
-        0x00,        //   iInterface (String Index)
-
-        0x1B,        //   bLength
-        0x21,        //   bDescriptorType (HID)
-        0x00, 0x01,  //   bcdHID 1.00
-        0x01,        //   bCountryCode
-        0x01,        //   bNumDescriptors
-        0x82,        //   bDescriptorType[0] (Unknown 0x82)
-        0x40, 0x01,  //   wDescriptorLength[0] 320
-        0x02, 0x20, 0x16, 0x83, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x16, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-        0x07,        //   bLength
-        0x05,        //   bDescriptorType (Endpoint)
-        0x82,        //   bEndpointAddress (IN/D2H)
-        0x03,        //   bmAttributes (Interrupt)
-        0x20, 0x00,  //   wMaxPacketSize 32
-        0x02,        //   bInterval 2 (unit depends on device speed)
-
-        0x07,        //   bLength
-        0x05,        //   bDescriptorType (Endpoint)
-        0x02,        //   bEndpointAddress (OUT/H2D)
-        0x03,        //   bmAttributes (Interrupt)
-        0x20, 0x00,  //   wMaxPacketSize 32
-        0x04,        //   bInterval 4 (unit depends on device speed)
-
-        0x07,        //   bLength
-        0x05,        //   bDescriptorType (Endpoint)
-        0x83,        //   bEndpointAddress (IN/D2H)
-        0x03,        //   bmAttributes (Interrupt)
-        0x20, 0x00,  //   wMaxPacketSize 32
-        0x40,        //   bInterval 64 (unit depends on device speed)
-
-        0x07,        //   bLength
-        0x05,        //   bDescriptorType (Endpoint)
-        0x03,        //   bEndpointAddress (OUT/H2D)
-        0x03,        //   bmAttributes (Interrupt)
-        0x20, 0x00,  //   wMaxPacketSize 32
-        0x10,        //   bInterval 16 (unit depends on device speed)
-
-        0x09,        //   bLength
-        0x04,        //   bDescriptorType (Interface)
-        0x02,        //   bInterfaceNumber 2
-        0x00,        //   bAlternateSetting
-        0x01,        //   bNumEndpoints 1
-        0xFF,        //   bInterfaceClass
-        0x5D,        //   bInterfaceSubClass
-        0x02,        //   bInterfaceProtocol
-        0x00,        //   iInterface (String Index)
-
-        0x09,        //   bLength
-        0x21,        //   bDescriptorType (HID)
-        0x00, 0x01,  //   bcdHID 1.00
-        0x01,        //   bCountryCode
-        0x22,        //   bNumDescriptors
-        0x84,        //   bDescriptorType[0] (Unknown 0x84)
-        0x07, 0x00,  //   wDescriptorLength[0] 7
-
-        0x07,        //   bLength
-        0x05,        //   bDescriptorType (Endpoint)
-        0x84,        //   bEndpointAddress (IN/D2H)
-        0x03,        //   bmAttributes (Interrupt)
-        0x20, 0x00,  //   wMaxPacketSize 32
-        0x10,        //   bInterval 16 (unit depends on device speed)
-
-        0x09,        //   bLength
-        0x04,        //   bDescriptorType (Interface)
-        0x03,        //   bInterfaceNumber 3
-        0x00,        //   bAlternateSetting
-        0x00,        //   bNumEndpoints 0
-        0xFF,        //   bInterfaceClass
-        0xFD,        //   bInterfaceSubClass
-        0x13,        //   bInterfaceProtocol
-        0x04,        //   iInterface (String Index)
-
-        0x06,        //   bLength
-        0x41,        //   bDescriptorType (Unknown)
-        0x00, 0x01, 0x01, 0x03,
-        // 153 bytes
-
-        // best guess: USB Standard Descriptor
-    };
-
-    RtlCopyBytes(Buffer, XusbDescriptorData, Length);
-}
-
-VOID Xusb_GetDeviceDescriptorType(PUSB_DEVICE_DESCRIPTOR pDescriptor, PPDO_DEVICE_DATA pCommon)
-{
-    pDescriptor->bLength = 0x12;
-    pDescriptor->bDescriptorType = USB_DEVICE_DESCRIPTOR_TYPE;
-    pDescriptor->bcdUSB = 0x0200; // USB v2.0
-    pDescriptor->bDeviceClass = 0xFF;
-    pDescriptor->bDeviceSubClass = 0xFF;
-    pDescriptor->bDeviceProtocol = 0xFF;
-    pDescriptor->bMaxPacketSize0 = 0x08;
-    pDescriptor->idVendor = pCommon->VendorId;
-    pDescriptor->idProduct = pCommon->ProductId;
-    pDescriptor->bcdDevice = 0x0114;
-    pDescriptor->iManufacturer = 0x01;
-    pDescriptor->iProduct = 0x02;
-    pDescriptor->iSerialNumber = 0x03;
-    pDescriptor->bNumConfigurations = 0x01;
-}
-
-VOID Xusb_SelectConfiguration(PUSBD_INTERFACE_INFORMATION pInfo)
-{
-    TraceEvents(TRACE_LEVEL_VERBOSE,
-        TRACE_XUSB,
-        ">> >> >> URB_FUNCTION_SELECT_CONFIGURATION: Length %d, Interface %d, Alternate %d, Pipes %d",
-        (int)pInfo->Length,
-        (int)pInfo->InterfaceNumber,
-        (int)pInfo->AlternateSetting,
-        pInfo->NumberOfPipes);
-
-    pInfo->Class = 0xFF;
-    pInfo->SubClass = 0x5D;
-    pInfo->Protocol = 0x01;
-
-    pInfo->InterfaceHandle = (USBD_INTERFACE_HANDLE)0xFFFF0000;
-
-    pInfo->Pipes[0].MaximumTransferSize = 0x00400000;
-    pInfo->Pipes[0].MaximumPacketSize = 0x20;
-    pInfo->Pipes[0].EndpointAddress = 0x81;
-    pInfo->Pipes[0].Interval = 0x04;
-    pInfo->Pipes[0].PipeType = 0x03;
-    pInfo->Pipes[0].PipeHandle = (USBD_PIPE_HANDLE)0xFFFF0081;
-    pInfo->Pipes[0].PipeFlags = 0x00;
-
-    pInfo->Pipes[1].MaximumTransferSize = 0x00400000;
-    pInfo->Pipes[1].MaximumPacketSize = 0x20;
-    pInfo->Pipes[1].EndpointAddress = 0x01;
-    pInfo->Pipes[1].Interval = 0x08;
-    pInfo->Pipes[1].PipeType = 0x03;
-    pInfo->Pipes[1].PipeHandle = (USBD_PIPE_HANDLE)0xFFFF0001;
-    pInfo->Pipes[1].PipeFlags = 0x00;
-
-    pInfo = (PUSBD_INTERFACE_INFORMATION)((PCHAR)pInfo + pInfo->Length);
-
-    TraceEvents(TRACE_LEVEL_VERBOSE,
-        TRACE_XUSB,
-        ">> >> >> URB_FUNCTION_SELECT_CONFIGURATION: Length %d, Interface %d, Alternate %d, Pipes %d",
-        (int)pInfo->Length,
-        (int)pInfo->InterfaceNumber,
-        (int)pInfo->AlternateSetting,
-        pInfo->NumberOfPipes);
-
-    pInfo->Class = 0xFF;
-    pInfo->SubClass = 0x5D;
-    pInfo->Protocol = 0x03;
-
-    pInfo->InterfaceHandle = (USBD_INTERFACE_HANDLE)0xFFFF0000;
-
-    pInfo->Pipes[0].MaximumTransferSize = 0x00400000;
-    pInfo->Pipes[0].MaximumPacketSize = 0x20;
-    pInfo->Pipes[0].EndpointAddress = 0x82;
-    pInfo->Pipes[0].Interval = 0x04;
-    pInfo->Pipes[0].PipeType = 0x03;
-    pInfo->Pipes[0].PipeHandle = (USBD_PIPE_HANDLE)0xFFFF0082;
-    pInfo->Pipes[0].PipeFlags = 0x00;
-
-    pInfo->Pipes[1].MaximumTransferSize = 0x00400000;
-    pInfo->Pipes[1].MaximumPacketSize = 0x20;
-    pInfo->Pipes[1].EndpointAddress = 0x02;
-    pInfo->Pipes[1].Interval = 0x08;
-    pInfo->Pipes[1].PipeType = 0x03;
-    pInfo->Pipes[1].PipeHandle = (USBD_PIPE_HANDLE)0xFFFF0002;
-    pInfo->Pipes[1].PipeFlags = 0x00;
-
-    pInfo->Pipes[2].MaximumTransferSize = 0x00400000;
-    pInfo->Pipes[2].MaximumPacketSize = 0x20;
-    pInfo->Pipes[2].EndpointAddress = 0x83;
-    pInfo->Pipes[2].Interval = 0x08;
-    pInfo->Pipes[2].PipeType = 0x03;
-    pInfo->Pipes[2].PipeHandle = (USBD_PIPE_HANDLE)0xFFFF0083;
-    pInfo->Pipes[2].PipeFlags = 0x00;
-
-    pInfo->Pipes[3].MaximumTransferSize = 0x00400000;
-    pInfo->Pipes[3].MaximumPacketSize = 0x20;
-    pInfo->Pipes[3].EndpointAddress = 0x03;
-    pInfo->Pipes[3].Interval = 0x08;
-    pInfo->Pipes[3].PipeType = 0x03;
-    pInfo->Pipes[3].PipeHandle = (USBD_PIPE_HANDLE)0xFFFF0003;
-    pInfo->Pipes[3].PipeFlags = 0x00;
-
-    pInfo = (PUSBD_INTERFACE_INFORMATION)((PCHAR)pInfo + pInfo->Length);
-
-    TraceEvents(TRACE_LEVEL_VERBOSE,
-        TRACE_XUSB,
-        ">> >> >> URB_FUNCTION_SELECT_CONFIGURATION: Length %d, Interface %d, Alternate %d, Pipes %d",
-        (int)pInfo->Length,
-        (int)pInfo->InterfaceNumber,
-        (int)pInfo->AlternateSetting,
-        pInfo->NumberOfPipes);
-
-    pInfo->Class = 0xFF;
-    pInfo->SubClass = 0x5D;
-    pInfo->Protocol = 0x02;
-
-    pInfo->InterfaceHandle = (USBD_INTERFACE_HANDLE)0xFFFF0000;
-
-    pInfo->Pipes[0].MaximumTransferSize = 0x00400000;
-    pInfo->Pipes[0].MaximumPacketSize = 0x20;
-    pInfo->Pipes[0].EndpointAddress = 0x84;
-    pInfo->Pipes[0].Interval = 0x04;
-    pInfo->Pipes[0].PipeType = 0x03;
-    pInfo->Pipes[0].PipeHandle = (USBD_PIPE_HANDLE)0xFFFF0084;
-    pInfo->Pipes[0].PipeFlags = 0x00;
-
-    pInfo = (PUSBD_INTERFACE_INFORMATION)((PCHAR)pInfo + pInfo->Length);
-
-    TraceEvents(TRACE_LEVEL_VERBOSE,
-        TRACE_XUSB,
-        ">> >> >> URB_FUNCTION_SELECT_CONFIGURATION: Length %d, Interface %d, Alternate %d, Pipes %d",
-        (int)pInfo->Length,
-        (int)pInfo->InterfaceNumber,
-        (int)pInfo->AlternateSetting,
-        pInfo->NumberOfPipes);
-
-    pInfo->Class = 0xFF;
-    pInfo->SubClass = 0xFD;
-    pInfo->Protocol = 0x13;
-
-    pInfo->InterfaceHandle = (USBD_INTERFACE_HANDLE)0xFFFF0000;
-}
-
-NTSTATUS Xusb_GetUserIndex(WDFDEVICE Device, PXUSB_GET_USER_INDEX Request)
-{
-    NTSTATUS                    status = STATUS_INVALID_DEVICE_REQUEST;
-    WDFDEVICE                   hChild;
-    PPDO_DEVICE_DATA            pdoData;
-    CHAR                        userIndex;
-
-
-    TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_XUSB, "%!FUNC! Entry");
-
-    hChild = Bus_GetPdo(Device, Request->SerialNo);
-
-    // Validate child
-    if (hChild == NULL)
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_XUSB,
-            "Bus_GetPdo for serial %d failed", Request->SerialNo);
-        return STATUS_NO_SUCH_DEVICE;
-    }
-
-    // Check common context
-    pdoData = PdoGetData(hChild);
-    if (pdoData == NULL)
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_XUSB,
-            "PdoGetData failed");
-        return STATUS_INVALID_PARAMETER;
-    }
-
-    // Check if caller owns this PDO
-    if (!IS_OWNER(pdoData))
-    {
-        TraceEvents(TRACE_LEVEL_ERROR,
-            TRACE_XUSB,
-            "PID mismatch: %d != %d",
-            pdoData->OwnerProcessId,
-            CURRENT_PROCESS_ID());
-        return STATUS_ACCESS_DENIED;
-    }
-
-    userIndex = XusbGetData(hChild)->LedNumber;
-
-    if (userIndex >= 0)
-    {
-        Request->UserIndex = (ULONG)userIndex;
-        status = STATUS_SUCCESS;
-    }
-    else
-    {
-        // If the index is negative at this stage, we've exceeded XUSER_MAX_COUNT
-        // and need to fail this request with a distinct status.
-        status = STATUS_INVALID_DEVICE_OBJECT_PARAMETER;
-    }
-
-    TraceEvents(TRACE_LEVEL_VERBOSE, TRACE_XUSB, "%!FUNC! Exit with status %!STATUS!", status);
-
-    return status;
-}