ucxlink.cpp File Reference

#include "usbhub3.h"
#include <debug.h>

Include dependency graph for ucxlink.cpp:

Go to the source code of this file.

Macros
#define	NDEBUG
#define	HUB_ROOT_PORT_MAX_SPEEDS   48
#define	HUB_FORWARD_PROGRESS_CONTROL   4096
#define	HUB_INTERFACE_CLASS   9
#define	HUB_PROTOCOL_MULTI_TT   2

Functions
static VOID NTAPI	HubSendUcxIoctl (_In_ HubFdo *Hub, _In_ WDFIOTARGET Target, _In_ ULONG IoControlCode, _In_ PVOID Payload, _In_ WDFREQUEST Request, _In_ PFN_WDF_REQUEST_COMPLETION_ROUTINE Completion)
static NTSTATUS NTAPI	HubCreateUcxRequest (_In_ HubFdo *Hub, _In_ WDFIOTARGET Target, _Out_ WDFREQUEST *Request)
static VOID NTAPI	HubIoctlComplete (_In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS Params, _In_ WDFCONTEXT Context)
static VOID NTAPI	HubRoot20PortsComplete (_In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS Params, _In_ WDFCONTEXT Context)
static VOID NTAPI	HubRoot30PortsComplete (_In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS Params, _In_ WDFCONTEXT Context)
static VOID NTAPI	HubControllerHubInfoComplete (_In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS Params, _In_ WDFCONTEXT Context)
static VOID NTAPI	HubRootHubInfoComplete (_In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS Params, _In_ WDFCONTEXT Context)
static BOOLEAN NTAPI	HubHasMultiTtInterface (_In_ PUSB_CONFIGURATION_DESCRIPTOR Config)
	_IRQL_requires_ (PASSIVE_LEVEL) VOID NTAPI HubRequestReservedIo(_In_ HubFdo *Hub)
	Sends a synchronous IOCTL to the specified device object.

Variables
static EVT_WDF_REQUEST_COMPLETION_ROUTINE	HubRootHubInfoComplete
static EVT_WDF_REQUEST_COMPLETION_ROUTINE	HubIoctlComplete
static EVT_WDF_REQUEST_COMPLETION_ROUTINE	HubRoot20PortsComplete
static EVT_WDF_REQUEST_COMPLETION_ROUTINE	HubRoot30PortsComplete
static EVT_WDF_REQUEST_COMPLETION_ROUTINE	HubControllerHubInfoComplete

Macro Definition Documentation

HUB_FORWARD_PROGRESS_CONTROL

#define HUB_FORWARD_PROGRESS_CONTROL   4096

Definition at line 17 of file ucxlink.cpp.

HUB_INTERFACE_CLASS

#define HUB_INTERFACE_CLASS   9

Definition at line 20 of file ucxlink.cpp.

HUB_PROTOCOL_MULTI_TT

#define HUB_PROTOCOL_MULTI_TT   2

Definition at line 21 of file ucxlink.cpp.

HUB_ROOT_PORT_MAX_SPEEDS

#define HUB_ROOT_PORT_MAX_SPEEDS   48

Definition at line 14 of file ucxlink.cpp.

NDEBUG

#define NDEBUG

Definition at line 10 of file ucxlink.cpp.

Function Documentation

_IRQL_requires_()

_IRQL_requires_

(

PASSIVE_LEVEL

)

Sends a synchronous IOCTL to the specified device object.

Parameters

[in]	IoControlCode	The IOCTL to send to the device.
[in]	DeviceObject	Pointer to the device object that will handle the IOCTL.
[in]	InputBuffer	Optional pointer to a buffer containing input data for the IOCTL. When specified, the buffer should be at least of InputBufferLength size.
[in]	InputBufferLength	Size in bytes, of the buffer pointed by InputBuffer.
[out]	OutputBuffer	Optional pointer to a buffer that will receive output data from the IOCTL. When specified, the buffer should be at least of OutputBufferLength size.
[in]	OutputBufferLength	Size in bytes, of the buffer pointed by OutputBuffer.
[in]	FileObject	Optional pointer to a file object that may be necessary for the IOCTL.

Returns

An NTSTATUS code indicating success or failure of this function.

Note

Must be called at PASSIVE_LEVEL with all APCs enabled.

Nothing is found unless the PCI bus driver publishes the properties.

The root hub name without its prefix; NULL when the PDO has no name.

Grows a private buffer to what the helper asks for.

Lets KMDF handle the IRP, then hands it back here still uncompleted.

Waits for the device machine to answer a PnP or power event; returns the PnP status.

Deletes the UCX endpoints of the disabled pipes, then the interface record.

One 4 byte value; the registry type is not checked.

Reread whenever user experience settings change; the open status is returned.

Sends a synchronous IOCTL to the specified device object.

STATUS_SUCCESS when the caller's token is an administrator's.

Sends a synchronous IOCTL to the specified device object.

Reads one value of a walk. A missing value only clears Present; FALSE means stop.

Reads up to Size bytes of a value into a zeroed buffer; the type is not checked.

Writes a REG_BINARY value into the device's usbflags subkey.

Sets or clears ExtPropertiesInstalled from ExtPropDescSemaphore in the hardware key.

Fails only when a port cannot be bound to the USB4 host router its ACPI node names.

Assigns device, hardware, compatible, container and instance ids to a new child PDO.

Answers IRP_MN_QUERY_DEVICE_TEXT on a child PDO; always completes the IRP.

Takes the connector map lock, needed around HubConnectorFindCompanion.

Device hardware key values read at PDO prepare hardware.

Saves the MS OS 2.0 set info in usbflags when the set asks for alternate enumeration.

MsOs20Flags and EnumerationRetryCount, written at PDO start.

Rereads the UXD record; UpdateRequired says whether the device id changes.

Replacement PnP id of a UXD reserved device, or an empty String. Always succeeds.

Telemetry values under the device's Ceip subkey.

BootPathSurpriseRemovalCount + 1.

This machine's dual role features for a dual role partner.

Tells UCX the WDM PDO of the device; call right after the child PDO was created.

IOCTL_INTERNAL_USB_GET_CONTROLLER_NAME: Argument1 and its length Argument2.

IOCTL_INTERNAL_USB_GET_BUS_INFO for the device: the 16 byte USB_BUS_NOTIFICATION at Argument1.

Registers the GUID_USB_WMI_NODE_INFO instance of a child PDO (not for hubs or composites).

Registers the boot device surprise removal event on an external, non hub boot PDO.

Fires the boot device surprise removal event, if one is registered.

Sends a synchronous IOCTL to the specified device object.

Publishes "<port>#<host>" for every bound port on the hub's PDO. QUIRK: with no bound port an older value is left in place.

Binds USB 3 ports to the host routers named by the USB4 DVSEC; an earlier ACPI mapping wins.

Waits on a PnP handshake event with no timeout, printing a watchdog line every minute so a stuck machine is visible in the debugger.

Copies up to Size bytes of a device property; a failed query leaves the field zero.

Only the controller name length is real; both bandwidth fields read 0.

The answer overlays a USB_HUB_NAME on TotalSize, so TotalSize comes back as the name length + 4.

Evaluates a method without arguments into Output.

Definition at line 481 of file ucxlink.cpp.

{
    UCXHUB_FORWARD_PROGRESS_INFO Info;
    WDF_MEMORY_DESCRIPTOR Argument;
    NTSTATUS Status;
 
    PAGED_CODE();
 
    RtlZeroMemory(&Info, sizeof(Info));
    Info.Version = 1;
    Info.Size = sizeof(Info);
    Info.Device = Hub->UsbDevice();
    Info.ControlPipeMaxTransferSize = HUB_FORWARD_PROGRESS_CONTROL;
    Info.NumberOfPipes = 1;
    Info.Pipes[0].PipeHandle = Hub->m_Interrupt.Pipe;
    Info.Pipes[0].ReservedTransferLimit = Hub->IsRootHub() ? Hub->m_Interrupt.BitmapMaxBytes
                                                           : Hub->m_InterruptMaxPacket;
 
    WDF_MEMORY_DESCRIPTOR_INIT_BUFFER(&Argument, &Info, sizeof(Info));
 
    Status = WdfIoTargetSendInternalIoctlOthersSynchronously(Hub->m_RootHubTarget,
                                                             NULL,
                                                             IOCTL_UCXHUB_NOTIFY_FORWARD_PROGRESS,
                                                             &Argument,
                                                             NULL,
                                                             NULL,
                                                             NULL,
                                                             NULL);
    if (!NT_SUCCESS(Status))
        DPRINT1("Hub %p forward progress notification failed 0x%lx\n", Hub, Status);
}

HubControllerHubInfoComplete()

static VOID NTAPI HubControllerHubInfoComplete ( _In_ WDFREQUEST  Request, _In_ WDFIOTARGET  Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS  Params, _In_ WDFCONTEXT  Context  )

static

Definition at line 137 of file ucxlink.cpp.

{
    if (!NT_SUCCESS(Params->IoStatus.Status))
        DPRINT1("Hub %p hub info update in UCX failed 0x%lx\n", Context, Params->IoStatus.Status);
 
    HubIoctlComplete(Request, Target, Params, Context);
}

HubCreateUcxRequest()

static NTSTATUS NTAPI HubCreateUcxRequest ( _In_ HubFdo *  Hub, _In_ WDFIOTARGET  Target, _Out_ WDFREQUEST *  Request  )

static

Definition at line 68 of file ucxlink.cpp.

{
    WDF_OBJECT_ATTRIBUTES Attributes;
    NTSTATUS Status;
 
    WDF_OBJECT_ATTRIBUTES_INIT(&Attributes);
    Attributes.ParentObject = Hub->m_Device;
 
    *Request = NULL;
    Status = WdfRequestCreate(&Attributes, Target, Request);
    if (!NT_SUCCESS(Status))
        DPRINT1("Hub %p UCX request create failed 0x%lx\n", Hub, Status);
 
    return Status;
}

Referenced by HubMachine::GetRootHub20Ports(), HubMachine::GetRootHub30Ports(), HubMachine::GetRootHubInfo(), and HubMachine::UpdateControllerHubInfo().

HubHasMultiTtInterface()

static BOOLEAN NTAPI HubHasMultiTtInterface ( _In_ PUSB_CONFIGURATION_DESCRIPTOR  Config )

static

Definition at line 388 of file ucxlink.cpp.

{
    PUCHAR Current = (PUCHAR)Config;
    PUCHAR End = Current + Config->wTotalLength;
    PUSB_COMMON_DESCRIPTOR Common;
    PUSB_INTERFACE_DESCRIPTOR Interface;
 
    while (Current + sizeof(*Common) <= End)
    {
        Common = (PUSB_COMMON_DESCRIPTOR)Current;
        if (Common->bLength == 0)
            break;
 
        if (Common->bDescriptorType == USB_INTERFACE_DESCRIPTOR_TYPE &&
            Current + sizeof(*Interface) <= End)
        {
            Interface = (PUSB_INTERFACE_DESCRIPTOR)Current;
            if (Interface->bInterfaceClass == HUB_INTERFACE_CLASS &&
                Interface->bInterfaceProtocol == HUB_PROTOCOL_MULTI_TT)
            {
                return TRUE;
            }
        }
 
        Current += Common->bLength;
    }
 
    return FALSE;
}

Referenced by HubMachine::UpdateControllerHubInfo().

HubIoctlComplete()

static VOID NTAPI HubIoctlComplete ( _In_ WDFREQUEST  Request, _In_ WDFIOTARGET  Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS  Params, _In_ WDFCONTEXT  Context  )

static

Definition at line 90 of file ucxlink.cpp.

{
    HubFdo* Hub = (HubFdo*)Context;
 
    UNREFERENCED_PARAMETER(Target);
 
    Hub->Post(NT_SUCCESS(Params->IoStatus.Status) ? HubEvent::IoctlDone : HubEvent::IoctlFailed);
    WdfObjectDelete(Request);
}

HubRoot20PortsComplete()

static VOID NTAPI HubRoot20PortsComplete ( _In_ WDFREQUEST  Request, _In_ WDFIOTARGET  Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS  Params, _In_ WDFCONTEXT  Context  )

static

Definition at line 107 of file ucxlink.cpp.

{
    if (!NT_SUCCESS(Params->IoStatus.Status))
        DPRINT1("Hub %p root hub 2.0 port info failed 0x%lx\n", Context, Params->IoStatus.Status);
 
    HubIoctlComplete(Request, Target, Params, Context);
}

HubRoot30PortsComplete()

static VOID NTAPI HubRoot30PortsComplete ( _In_ WDFREQUEST  Request, _In_ WDFIOTARGET  Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS  Params, _In_ WDFCONTEXT  Context  )

static

Definition at line 122 of file ucxlink.cpp.

{
    if (!NT_SUCCESS(Params->IoStatus.Status))
        DPRINT1("Hub %p root hub 3.0 port info failed 0x%lx\n", Context, Params->IoStatus.Status);
 
    HubIoctlComplete(Request, Target, Params, Context);
}

HubRootHubInfoComplete()

static VOID NTAPI HubRootHubInfoComplete ( _In_ WDFREQUEST  Request, _In_ WDFIOTARGET  Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS  Params, _In_ WDFCONTEXT  Context  )

static

Definition at line 160 of file ucxlink.cpp.

{
    HubFdo* Hub = (HubFdo*)Context;
    BOOLEAN Succeeded = NT_SUCCESS(Params->IoStatus.Status);
 
    UNREFERENCED_PARAMETER(Target);
 
    if (Succeeded)
    {
        Hub->m_Interrupt.Pipe = Hub->m_RootHubInfo.InterruptPipe;
        Hub->m_ParentInfo.U1ExitLatency = Hub->m_RootHubInfo.Info.MaxU1ExitLatency;
        Hub->m_ParentInfo.U2ExitLatency = Hub->m_RootHubInfo.Info.MaxU2ExitLatency;
        DPRINT("Hub %p root hub has %u 2.0 and %u 3.0 ports\n",
               Hub, Hub->m_RootHubInfo.Info.NumberOf20Ports, Hub->m_RootHubInfo.Info.NumberOf30Ports);
    }
    else
    {
        DPRINT1("Hub %p root hub info failed 0x%lx\n", Hub, Params->IoStatus.Status);
    }
 
    Hub->Post(Succeeded ? HubEvent::IoctlDone : HubEvent::IoctlFailed);
    WdfObjectDelete(Request);
}

HubSendUcxIoctl()

static VOID NTAPI HubSendUcxIoctl ( _In_ HubFdo *  Hub, _In_ WDFIOTARGET  Target, _In_ ULONG  IoControlCode, _In_ PVOID  Payload, _In_ WDFREQUEST  Request, _In_ PFN_WDF_REQUEST_COMPLETION_ROUTINE  Completion  )

static

Definition at line 36 of file ucxlink.cpp.

{
    IO_STACK_LOCATION Stack;
    NTSTATUS Status;
 
    RtlZeroMemory(&Stack, sizeof(Stack));
    Stack.MajorFunction = IRP_MJ_INTERNAL_DEVICE_CONTROL;
    Stack.Parameters.DeviceIoControl.IoControlCode = IoControlCode;
    Stack.Parameters.Others.Argument1 = Payload;
    WdfRequestWdmFormatUsingStackLocation(Request, &Stack);
 
    WdfRequestSetCompletionRoutine(Request, Completion, Hub);
 
    if (WdfRequestSend(Request, Target, WDF_NO_SEND_OPTIONS))
        return;
 
    Status = WdfRequestGetStatus(Request);
    DPRINT1("Hub %p UCX request 0x%lx not sent 0x%lx\n", Hub, IoControlCode, Status);
 
    WdfObjectDelete(Request);
    Hub->Post(HubEvent::IoctlFailed);
}

Referenced by HubMachine::GetRootHub20Ports(), HubMachine::GetRootHub30Ports(), HubMachine::GetRootHubInfo(), and HubMachine::UpdateControllerHubInfo().

Variable Documentation

HubControllerHubInfoComplete

EVT_WDF_REQUEST_COMPLETION_ROUTINE HubControllerHubInfoComplete

static

Definition at line 27 of file ucxlink.cpp.

Referenced by HubMachine::UpdateControllerHubInfo().

HubIoctlComplete

EVT_WDF_REQUEST_COMPLETION_ROUTINE HubIoctlComplete

static

Definition at line 24 of file ucxlink.cpp.

Referenced by HubControllerHubInfoComplete(), HubRoot20PortsComplete(), and HubRoot30PortsComplete().

HubRoot20PortsComplete

EVT_WDF_REQUEST_COMPLETION_ROUTINE HubRoot20PortsComplete

static

Definition at line 25 of file ucxlink.cpp.

Referenced by HubMachine::GetRootHub20Ports().

HubRoot30PortsComplete

EVT_WDF_REQUEST_COMPLETION_ROUTINE HubRoot30PortsComplete

static

Definition at line 26 of file ucxlink.cpp.

Referenced by HubMachine::GetRootHub30Ports().

HubRootHubInfoComplete

EVT_WDF_REQUEST_COMPLETION_ROUTINE HubRootHubInfoComplete

static

Definition at line 23 of file ucxlink.cpp.

Referenced by HubMachine::GetRootHubInfo().