Files
LookingGlass/idd/LGIdd/Device.cpp
Geoffrey McRae 1de52f6e8a [idd] project: organize source layout
Move cadence and pipeline declarations under capture, and move local
named-pipe handling under ipc.

Flatten display contexts and rename files after their contained classes.
Keep transport headers limited to transport contracts and capabilities.

Consolidate CSwapChainProcessor definitions so each source file matches
the class it implements.
2026-08-07 18:16:18 +10:00

366 lines
12 KiB
C++

/**
* Looking Glass
* Copyright © 2017-2026 The Looking Glass Authors
* https://looking-glass.io
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 2 of the License, or (at your option)
* any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc., 59
* Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#include "driver.h"
#include "device.tmh"
#include <windows.h>
#include <bugcodes.h>
#include <wudfwdm.h>
#include <wdf.h>
#include <IddCx.h>
#include <avrt.h>
#include <wrl.h>
#include <memory>
#include <utility>
#include "CDebug.h"
#include "display/CDisplayConfiguration.h"
#include "display/IddCxCompat.h"
#include "display/CDeviceContext.h"
#include "display/CMonitorContext.h"
#include "transport/IControlTransport.h"
#include "ipc/CPipeServer.h"
#include "config/CSettings.h"
WDFDEVICE l_wdfDevice = nullptr;
static const UINT IDDCX_VERSION_1_10 = 0x1A00;
static bool LGIddCanUseIddCx110DDIs(UINT iddCxVersion)
{
#ifdef HAS_IDDCX_110
return iddCxVersion >= IDDCX_VERSION_1_10 &&
!!IDD_IS_FUNCTION_AVAILABLE(IddCxSwapChainReleaseAndAcquireBuffer2) &&
!!IDD_IS_FUNCTION_AVAILABLE(IddCxMonitorQueryHardwareCursor3) &&
!!IDD_IS_FUNCTION_AVAILABLE(IddCxMonitorUpdateModes2) &&
IDD_IS_FIELD_AVAILABLE(IDD_CX_CLIENT_CONFIG, EvtIddCxAdapterQueryTargetInfo) &&
IDD_IS_FIELD_AVAILABLE(IDD_CX_CLIENT_CONFIG, EvtIddCxAdapterCommitModes2) &&
IDD_IS_FIELD_AVAILABLE(IDD_CX_CLIENT_CONFIG, EvtIddCxParseMonitorDescription2) &&
IDD_IS_FIELD_AVAILABLE(IDD_CX_CLIENT_CONFIG, EvtIddCxMonitorQueryTargetModes2) &&
IDD_IS_FIELD_AVAILABLE(IDD_CX_CLIENT_CONFIG, EvtIddCxMonitorSetDefaultHdrMetaData) &&
IDD_IS_FIELD_AVAILABLE(IDD_CX_CLIENT_CONFIG, EvtIddCxMonitorSetGammaRamp);
#else
UNREFERENCED_PARAMETER(iddCxVersion);
return false;
#endif
}
NTSTATUS LGIddDeviceD0Entry(WDFDEVICE device, WDF_POWER_DEVICE_STATE previousState)
{
UNREFERENCED_PARAMETER(previousState);
DEBUG_INFO("Device entered D0, starting adapter initialization");
auto * wrapper = WdfObjectGet_CDeviceContextWrapper(device);
wrapper->context->InitAdapter();
DEBUG_INFO("Device D0 entry completed");
return STATUS_SUCCESS;
}
NTSTATUS LGIddAdapterInitFinished(IDDCX_ADAPTER adapter, const IDARG_IN_ADAPTER_INIT_FINISHED * args)
{
DEBUG_INFO("Adapter initialization callback completed with status 0x%08x",
args->AdapterInitStatus);
auto * wrapper = WdfObjectGet_CDeviceContextWrapper(adapter);
if (!NT_SUCCESS(args->AdapterInitStatus))
{
DEBUG_ERROR_HR(args->AdapterInitStatus,
"IddCx adapter initialization failed asynchronously");
return STATUS_SUCCESS;
}
if (!wrapper->context)
{
DEBUG_ERROR("Adapter initialization completed before its context was attached");
return STATUS_INVALID_DEVICE_STATE;
}
DEBUG_INFO("Adapter initialized, creating monitor");
wrapper->context->FinishAdapterInit(0);
return STATUS_SUCCESS;
}
NTSTATUS LGIddAdapterCommitModes(IDDCX_ADAPTER adapter, const IDARG_IN_COMMITMODES* args)
{
UNREFERENCED_PARAMETER(adapter);
UNREFERENCED_PARAMETER(args);
DEBUG_INFO("Display modes committed");
return STATUS_SUCCESS;
}
NTSTATUS LGIddParseMonitorDescription(const IDARG_IN_PARSEMONITORDESCRIPTION* inArgs,
IDARG_OUT_PARSEMONITORDESCRIPTION* outArgs)
{
if (!l_wdfDevice)
return STATUS_INVALID_PARAMETER;
auto * wrapper = WdfObjectGet_CDeviceContextWrapper(l_wdfDevice);
return wrapper->context->GetDisplayConfiguration().ParseMonitorDescription(
inArgs, outArgs);
}
NTSTATUS LGIddMonitorGetDefaultModes(IDDCX_MONITOR monitor, const IDARG_IN_GETDEFAULTDESCRIPTIONMODES * inArgs,
IDARG_OUT_GETDEFAULTDESCRIPTIONMODES * outArgs)
{
auto * wrapper = WdfObjectGet_CMonitorContextWrapper(monitor);
auto * context = wrapper->context->GetDeviceContext();
return context->GetDisplayConfiguration().MonitorGetDefaultModes(
inArgs, outArgs);
}
NTSTATUS LGIddMonitorQueryTargetModes(IDDCX_MONITOR monitor, const IDARG_IN_QUERYTARGETMODES * inArgs,
IDARG_OUT_QUERYTARGETMODES * outArgs)
{
auto * wrapper = WdfObjectGet_CMonitorContextWrapper(monitor);
auto * context = wrapper->context->GetDeviceContext();
return context->GetDisplayConfiguration().MonitorQueryTargetModes(
inArgs, outArgs);
}
#ifdef HAS_IDDCX_110
NTSTATUS LGIddParseMonitorDescription2(const IDARG_IN_PARSEMONITORDESCRIPTION2* inArgs,
IDARG_OUT_PARSEMONITORDESCRIPTION* outArgs)
{
if (!l_wdfDevice)
return STATUS_INVALID_PARAMETER;
auto * wrapper = WdfObjectGet_CDeviceContextWrapper(l_wdfDevice);
return wrapper->context->GetDisplayConfiguration().ParseMonitorDescription2(
inArgs, outArgs);
}
NTSTATUS LGIddAdapterQueryTargetInfo(IDDCX_ADAPTER adapter,
IDARG_IN_QUERYTARGET_INFO* inArgs, IDARG_OUT_QUERYTARGET_INFO* outArgs)
{
UNREFERENCED_PARAMETER(inArgs);
auto * wrapper = WdfObjectGet_CDeviceContextWrapper(adapter);
const bool hdr = wrapper && wrapper->context &&
wrapper->context->CanProcessFP16();
outArgs->TargetCaps = hdr ?
(IDDCX_TARGET_CAPS)(IDDCX_TARGET_CAPS_WIDE_COLOR_SPACE |
IDDCX_TARGET_CAPS_HIGH_COLOR_SPACE) :
(IDDCX_TARGET_CAPS)0;
outArgs->DitheringSupport.Rgb = IDDCX_BITS_PER_COMPONENT_NONE;
outArgs->DitheringSupport.YCbCr444 = IDDCX_BITS_PER_COMPONENT_NONE;
outArgs->DitheringSupport.YCbCr422 = IDDCX_BITS_PER_COMPONENT_NONE;
outArgs->DitheringSupport.YCbCr420 = IDDCX_BITS_PER_COMPONENT_NONE;
return STATUS_SUCCESS;
}
NTSTATUS LGIddAdapterCommitModes2(IDDCX_ADAPTER adapter, const IDARG_IN_COMMITMODES2* args)
{
UNREFERENCED_PARAMETER(adapter);
UNREFERENCED_PARAMETER(args);
DEBUG_INFO("Display modes committed through IddCx 1.10");
return STATUS_SUCCESS;
}
NTSTATUS LGIddMonitorSetDefaultHdrMetadata(IDDCX_MONITOR monitor,
const IDARG_IN_MONITOR_SET_DEFAULT_HDR_METADATA* inArgs)
{
UNREFERENCED_PARAMETER(monitor);
UNREFERENCED_PARAMETER(inArgs);
// This metadata describes the virtual monitor. Explicit per-content HDR10
// metadata is obtained from the swap chain and forwarded separately.
return STATUS_SUCCESS;
}
NTSTATUS LGIddMonitorSetGammaRamp(IDDCX_MONITOR monitor, const IDARG_IN_SET_GAMMARAMP* inArgs)
{
auto * wrapper = WdfObjectGet_CMonitorContextWrapper(monitor);
auto * ctx = wrapper->context->GetDeviceContext();
auto & control = ctx->GetTransport().Control();
if (ctx->IsSoftwareMode())
{
control.SetColorTransform(nullptr);
DEBUG_INFO("Ignoring display color transform in software mode");
return STATUS_SUCCESS;
}
if (inArgs->Type == IDDCX_GAMMARAMP_TYPE_DEFAULT)
{
control.SetColorTransform(nullptr);
DEBUG_INFO("Display color transform reset to default");
return STATUS_SUCCESS;
}
if (inArgs->Type != IDDCX_GAMMARAMP_TYPE_3x4_COLORSPACE_TRANSFORM)
{
DEBUG_WARN("Unsupported gamma ramp type %u", inArgs->Type);
return STATUS_NOT_SUPPORTED;
}
if (!inArgs->pGammaRampData ||
inArgs->GammaRampSizeInBytes <
sizeof(IDDCX_GAMMARAMP_3X4_COLORSPACE_TRANSFORM))
{
DEBUG_ERROR("Invalid 3x4 color transform buffer (%u bytes)",
inArgs->GammaRampSizeInBytes);
return STATUS_INVALID_PARAMETER;
}
const auto * input = static_cast<
const IDDCX_GAMMARAMP_3X4_COLORSPACE_TRANSFORM*>(
inArgs->pGammaRampData);
auto transform = std::make_shared<D12ColorTransform>();
transform->matrixEnabled = !!input->MatrixEnabled;
transform->scalar = input->ScalarMultiplier;
transform->lutEnabled = !!input->LutEnabled;
memcpy(transform->matrix, input->ColorMatrix3x4,
sizeof(transform->matrix));
for (unsigned i = 0; i < 4096; ++i)
{
transform->lut[i][0] = input->LookupTable1D[i].Red;
transform->lut[i][1] = input->LookupTable1D[i].Green;
transform->lut[i][2] = input->LookupTable1D[i].Blue;
transform->lut[i][3] = 1.0f;
}
if (IsIdentityColorTransform(*transform))
{
control.SetColorTransform(nullptr);
return STATUS_SUCCESS;
}
control.SetColorTransform(std::move(transform));
DEBUG_INFO("Display color transform updated (matrix:%d lut:%d)",
input->MatrixEnabled, input->LutEnabled);
return STATUS_SUCCESS;
}
NTSTATUS LGIddMonitorQueryTargetModes2(IDDCX_MONITOR monitor, const IDARG_IN_QUERYTARGETMODES2* inArgs,
IDARG_OUT_QUERYTARGETMODES* outArgs)
{
auto * wrapper = WdfObjectGet_CMonitorContextWrapper(monitor);
auto * context = wrapper->context->GetDeviceContext();
return context->GetDisplayConfiguration().MonitorQueryTargetModes2(
inArgs, outArgs);
}
#endif
NTSTATUS LGIddMonitorAssignSwapChain(IDDCX_MONITOR monitor, const IDARG_IN_SETSWAPCHAIN* inArgs)
{
DEBUG_INFO("Swap chain assigned to monitor %p", monitor);
auto * wrapper = WdfObjectGet_CMonitorContextWrapper(monitor);
return wrapper->context->AssignSwapChain(
inArgs->hSwapChain, inArgs->RenderAdapterLuid, inArgs->hNextSurfaceAvailable);
}
NTSTATUS LGIddMonitorUnassignSwapChain(IDDCX_MONITOR monitor)
{
DEBUG_INFO("Swap chain unassigned from monitor %p", monitor);
auto * wrapper = WdfObjectGet_CMonitorContextWrapper(monitor);
wrapper->context->UnassignSwapChain();
return STATUS_SUCCESS;
}
NTSTATUS LGIddCreateDevice(_Inout_ PWDFDEVICE_INIT deviceInit)
{
NTSTATUS status;
IDARG_OUT_GETVERSION ver;
status = IddCxGetVersion(&ver);
if (FAILED(status))
{
DEBUG_ERROR("IddCxGetVersion Failed");
return status;
}
const bool hasIddCx110DDIs = LGIddCanUseIddCx110DDIs(ver.IddCxVersion);
DEBUG_INFO("Version: 0x%04x", ver.IddCxVersion);
DEBUG_INFO("IddCx 1.10 HDR/WCG DDIs: %s", hasIddCx110DDIs ? "available" : "unavailable");
WDF_PNPPOWER_EVENT_CALLBACKS pnpPowerCallbacks;
WDF_PNPPOWER_EVENT_CALLBACKS_INIT(&pnpPowerCallbacks);
pnpPowerCallbacks.EvtDeviceD0Entry = LGIddDeviceD0Entry;
WdfDeviceInitSetPnpPowerEventCallbacks(deviceInit, &pnpPowerCallbacks);
IDD_CX_CLIENT_CONFIG config;
IDD_CX_CLIENT_CONFIG_INIT(&config);
config.EvtIddCxAdapterInitFinished = LGIddAdapterInitFinished;
config.EvtIddCxMonitorGetDefaultDescriptionModes = LGIddMonitorGetDefaultModes;
config.EvtIddCxMonitorAssignSwapChain = LGIddMonitorAssignSwapChain;
config.EvtIddCxMonitorUnassignSwapChain = LGIddMonitorUnassignSwapChain;
#ifdef HAS_IDDCX_110
if (hasIddCx110DDIs)
{
config.EvtIddCxParseMonitorDescription2 = LGIddParseMonitorDescription2;
config.EvtIddCxMonitorQueryTargetModes2 = LGIddMonitorQueryTargetModes2;
config.EvtIddCxAdapterCommitModes2 = LGIddAdapterCommitModes2;
config.EvtIddCxAdapterQueryTargetInfo = LGIddAdapterQueryTargetInfo;
config.EvtIddCxMonitorSetDefaultHdrMetaData = LGIddMonitorSetDefaultHdrMetadata;
config.EvtIddCxMonitorSetGammaRamp = LGIddMonitorSetGammaRamp;
}
else
#endif
{
config.EvtIddCxAdapterCommitModes = LGIddAdapterCommitModes;
config.EvtIddCxParseMonitorDescription = LGIddParseMonitorDescription;
config.EvtIddCxMonitorQueryTargetModes = LGIddMonitorQueryTargetModes;
}
status = IddCxDeviceInitConfig(deviceInit, &config);
if (!NT_SUCCESS(status))
return status;
WDF_OBJECT_ATTRIBUTES deviceAttributes;
WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&deviceAttributes, CDeviceContextWrapper);
deviceAttributes.EvtCleanupCallback = [](WDFOBJECT object)
{
auto * wrapper = WdfObjectGet_CDeviceContextWrapper(object);
if (wrapper)
{
g_pipe.SetDeviceContext(nullptr);
wrapper->Cleanup();
}
l_wdfDevice = nullptr;
};
WDFDEVICE device = nullptr;
status = WdfDeviceCreate(&deviceInit, &deviceAttributes, &device);
if (!NT_SUCCESS(status))
return status;
/*
* Construct the device context and cache the WDF device BEFORE calling
* IddCxDeviceInitialize. IddCxDeviceInitialize arms the IddCx callbacks, and
* callbacks that resolve the context via l_wdfDevice (down-level IddCx that
* provides no adapter/monitor context) must never observe a null context.
*/
auto wrapper = WdfObjectGet_CDeviceContextWrapper(device);
wrapper->context = new CDeviceContext(device);
l_wdfDevice = device;
status = IddCxDeviceInitialize(device);
if (!NT_SUCCESS(status))
DEBUG_ERROR_HR(status, "IddCxDeviceInitialize Failed");
else
DEBUG_INFO("IddCx device initialized");
return status;
}