mirror of
https://github.com/nefarius/ViGEmBus.git
synced 2025-08-10 00:52:17 +00:00
305 lines
8.1 KiB
C++
305 lines
8.1 KiB
C++
/*
|
|
* 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);
|
|
|
|
static VOID DmfDeviceModulesAdd(_In_ WDFDEVICE Device, _In_ PDMFMODULE_INIT DmfModuleInit);
|
|
|
|
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;
|
|
|
|
virtual void DmfDeviceModulesAdd(_In_ PDMFMODULE_INIT DmfModuleInit) = 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)
|
|
}
|