hubsvc.h

Go to the documentation of this file.

/*
 * PROJECT:     ReactOS SuperSpeed USB Hub Driver
 * LICENSE:     MIT (https://spdx.org/licenses/MIT)
 * PURPOSE:     Services one module of the driver offers the others
 * COPYRIGHT:   Copyright 2026 Justin Miller <justin.miller@reactos.org>
 */
 
#pragma once
 
/* Hub numbers from usbd.sys, shown to users in the port location string */
 
_IRQL_requires_(PASSIVE_LEVEL)
NTSTATUS
NTAPI
HubAllocateHubNumber(
    _Out_ PULONG HubNumber);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubReleaseHubNumber(
    _In_ ULONG HubNumber);
 
/* Registry module */
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubReadHubRegistryValues(
    _In_ HubFdo* Hub);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubUxdShutdownCleanup(
    _In_ HubFdo* Hub);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubReadUsb4HostName(
    _In_ HubFdo* Hub);
 
/* ACPI, connector map and WMI modules */
 
_IRQL_requires_(PASSIVE_LEVEL)
NTSTATUS
NTAPI
HubAcpiReadPortAttributes(
    _In_ HubFdo* Hub);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubConnectorMapPorts(
    _In_ HubFdo* Hub);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubConnectorUnmapPorts(
    _In_ HubFdo* Hub);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubWmiRegister(
    _In_ HubFdo* Hub);
 
/* USB4 router DROM */
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubDromReportFirmwareUpdateDevice(
    _In_ HubFdo* Hub);
 
/* USB4 host routers */
 
_IRQL_requires_(PASSIVE_LEVEL)
NTSTATUS
NTAPI
HubUsb4Initialize(
    _In_ HubFdo* Hub);
 
_IRQL_requires_(PASSIVE_LEVEL)
NTSTATUS
NTAPI
HubUsb4BindPort(
    _In_ HubFdo* Hub,
    _In_ HubPort* Port,
    _In_ WDFSTRING Name);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubUsb4MapDvsecHosts(
    _In_ HubFdo* Hub);
 
_IRQL_requires_(PASSIVE_LEVEL)
NTSTATUS
NTAPI
HubUsb4AssignPortMappings(
    _In_ HubFdo* Hub);
 
BOOLEAN
NTAPI
HubUsb4NeedsHostPower(
    _In_ HubChild* Child);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubUsb4AcquireHostPower(
    _In_ HubPort* Port);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubUsb4ReleaseHostPower(
    _In_ HubPort* Port);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubUsb4RegisterNotification(
    _In_ HubFdo* Hub);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubUsb4UnregisterNotification(
    _In_ HubFdo* Hub);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubUsb4CloseAllHosts(
    _In_ HubFdo* Hub);
 
/* UCX module */
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubRequestReservedIo(
    _In_ HubFdo* Hub);
 
/* Diagnostics */
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubReportPnpProblem(
    _In_ WDFDEVICE Device,
    _In_ ULONG MessageId);
 
/* Callbacks handed to ucx01000 in the stack interface */
 
VOID
NTAPI
HubClearTtBuffer(
    _In_ UCXHUB_HUB_CONTEXT HubContext,
    _In_ UCXHUB_DEVICE_CONTEXT DeviceContext,
    _In_ UCXENDPOINT Endpoint,
    _In_ ULONG EndpointNumber,
    _In_ ULONG TtPortNumber);
 
VOID
NTAPI
HubNoPingResponse(
    _In_ UCXHUB_HUB_CONTEXT HubContext,
    _In_ UCXHUB_DEVICE_CONTEXT DeviceContext);
 
/* Descriptor validation, with the hub flavored loggers */
 
BOOLEAN
NTAPI
HubValidateHubConfiguration(
    _In_ HubFdo* Hub,
    _In_reads_bytes_(Length) PUSB_CONFIGURATION_DESCRIPTOR Descriptor,
    _In_ ULONG Length);
 
BOOLEAN
NTAPI
HubCheckUsb2HubDescriptor(
    _In_ HubFdo* Hub,
    _In_reads_bytes_(Length) PUSB_HUB_DESCRIPTOR Descriptor,
    _In_ ULONG Length);
 
BOOLEAN
NTAPI
HubCheckUsb3HubDescriptor(
    _In_ HubFdo* Hub,
    _In_reads_bytes_(Length) PUSB_30_HUB_DESCRIPTOR Descriptor,
    _In_ ULONG Length);
 
VOID
NTAPI
HubLogConfigTotalLengthMismatch(
    _In_ HubFdo* Hub);
 
/* WMI module */
 
VOID
NTAPI
HubWmiNotifyOverCurrent(
    _In_ HubFdo* Hub,
    _In_ ULONG PortNumber);
 
/* Child PDO module */
 
EVT_WDF_TIMER HubEvtBandwidthRetryTimer;
 
/* integrator */
 
PVOID
NTAPI
HubConnectorNodeForPort(
    _In_ HubPort* Port);
 
VOID
NTAPI
HubLogDeviceValidationError(
    _In_ HubChild* Child,
    _In_ ULONG Code);
 
/* identity */
 
BOOLEAN
NTAPI
HubIdLanguageSupported(
    _In_ HubChild* Child,
    _In_ USHORT Language);
 
_IRQL_requires_(PASSIVE_LEVEL)
NTSTATUS
NTAPI
HubIdAssignPdoIds(
    _In_ HubChild* Child,
    _In_ PWDFDEVICE_INIT DeviceInit);
 
NTSTATUS
NTAPI
HubIdBuildHardwareIds(
    _In_ HubChild* Child,
    _In_opt_ PWDFDEVICE_INIT DeviceInit,
    _Out_opt_ PUSB_ID_STRING Ids);
 
NTSTATUS
NTAPI
HubIdBuildCompatibleIds(
    _In_ HubChild* Child,
    _In_opt_ PWDFDEVICE_INIT DeviceInit,
    _Out_opt_ PUSB_ID_STRING Ids);
 
NTSTATUS
NTAPI
HubIdListCopy(
    _Out_ PUSB_ID_STRING Destination,
    _In_ const USB_ID_STRING* Source);
 
VOID
NTAPI
HubIdListFree(
    _Inout_ PUSB_ID_STRING Ids);
 
_IRQL_requires_(PASSIVE_LEVEL)
NTSTATUS
NTAPI
HubIdQueryDeviceText(
    _In_ HubChild* Child,
    _Inout_ PIRP Irp);
 
BOOLEAN
NTAPI
HubIdGetContainerId(
    _In_ HubChild* Child,
    _Out_ GUID* ContainerId);
 
BOOLEAN
NTAPI
HubIdGetSerialNumberText(
    _In_ HubChild* Child,
    _Outptr_result_bytebuffer_(*Length) PCWSTR* Text,
    _Out_ PULONG Length);
 
VOID
NTAPI
HubIdFreeDeviceIds(
    _In_ HubChild* Child);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubConnectorLock(VOID);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubConnectorUnlock(VOID);
 
HubPort*
NTAPI
HubConnectorFindCompanion(
    _In_ HubPort* Port,
    _In_ ULONG Index);
 
/* registry */
 
/* Why a device's UXD settings may be deleted */
enum class HubUxdEvent : ULONG
{
    Disable = 1,
    Disconnect = 2
};
 
_IRQL_requires_max_(DISPATCH_LEVEL)
VOID
NTAPI
HubNoteHubOverCurrent(
    _In_ HubFdo* Hub);
 
_IRQL_requires_(PASSIVE_LEVEL)
NTSTATUS
NTAPI
HubReadDeviceHardwareValues(
    _In_ HubChild* Child);
 
_IRQL_requires_(PASSIVE_LEVEL)
NTSTATUS
NTAPI
HubWriteDeviceValue(
    _In_ HubChild* Child,
    _In_ PCUNICODE_STRING Name,
    _In_ ULONG Type,
    _In_ ULONG Length,
    _In_reads_bytes_(Length) PVOID Data);
 
_IRQL_requires_(PASSIVE_LEVEL)
NTSTATUS
NTAPI
HubWriteDeviceString(
    _In_ HubChild* Child,
    _In_ PCUNICODE_STRING Name,
    _In_ WDFSTRING Value);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubCacheMsOs20SetInfo(
    _In_ HubChild* Child);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubWriteEnumerationData(
    _In_ HubChild* Child);
 
_IRQL_requires_(PASSIVE_LEVEL)
NTSTATUS
NTAPI
HubSaveUxdState(
    _In_ HubFdo* Hub,
    _In_ HubChild* Child,
    _Out_opt_ PBOOLEAN UpdateRequired);
 
_IRQL_requires_(PASSIVE_LEVEL)
NTSTATUS
NTAPI
HubPurgeUxdState(
    _In_ HubChild* Child,
    _In_ HubUxdEvent Event);
 
_IRQL_requires_(PASSIVE_LEVEL)
NTSTATUS
NTAPI
HubQueryUxdDeviceValue(
    _In_ HubChild* Child,
    _In_ WDFSTRING String);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubFlushSqmFlags(
    _In_ HubChild* Child);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubWriteEnumerationFailureCode(
    _In_ HubChild* Child);
 
_IRQL_requires_max_(DISPATCH_LEVEL)
VOID
NTAPI
HubRecordSelectiveSuspend(
    _In_ HubChild* Child);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubBumpBootSurpriseRemovalCount(VOID);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubQueryLocalDualRoleFeatures(
    _Out_ PULONG Features);
 
VOID
NTAPI
HubReleaseRegistryState(
    _In_ HubChild* Child);
 
/* devucx */
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubChildSetPdo(
    _In_ HubChild* Child,
    _In_ PDEVICE_OBJECT Pdo);
 
VOID
NTAPI
HubChildForwardToController(
    _In_ HubChild* Child);
 
_IRQL_requires_(PASSIVE_LEVEL)
NTSTATUS
NTAPI
HubQueryControllerName(
    _In_ HubFdo* Hub,
    _Out_writes_bytes_(Length) PUSB_HUB_NAME Name,
    _In_ ULONG Length);
 
_IRQL_requires_(PASSIVE_LEVEL)
NTSTATUS
NTAPI
HubQueryDeviceBusInfo(
    _In_ HubChild* Child,
    _Out_ PUSB_BUS_NOTIFICATION Notification);
 
/* devxfer */
 
VOID
NTAPI
HubFreeBillboardInfo(
    _In_ HubChild* Child);
 
VOID
NTAPI
HubReleaseTransferState(
    _In_ HubChild* Child);
 
HubPipe*
NTAPI
HubFindPipeByHandle(
    _In_opt_ HubConfiguration* Config,
    _In_ USBD_PIPE_HANDLE Handle);
 
/* wmi */
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubWmiRegisterDevice(
    _In_ WDFDEVICE Pdo);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubWmiRegisterBootSurpriseRemoval(
    _In_ WDFDEVICE Pdo);
 
_IRQL_requires_(PASSIVE_LEVEL)
VOID
NTAPI
HubWmiNotifyBootSurpriseRemoval(VOID);
 
_IRQL_requires_max_(DISPATCH_LEVEL)
VOID
NTAPI
HubWmiNotifyEnumerationFailure(
    _In_ HubFdo* Hub,
    _In_ ULONG PortNumber);
 
_IRQL_requires_max_(DISPATCH_LEVEL)
VOID
NTAPI
HubWmiNotifyHubNestedTooDeeply(
    _In_ HubFdo* Hub,
    _In_ ULONG PortNumber);
 
_IRQL_requires_max_(DISPATCH_LEVEL)
VOID
NTAPI
HubWmiNotifyInsufficientPower(
    _In_ HubFdo* Hub,
    _In_ ULONG PortNumber);
 
_IRQL_requires_max_(DISPATCH_LEVEL)
VOID
NTAPI
HubWmiNotifyInsufficientBandwidth(
    _In_ HubFdo* Hub,
    _In_ ULONG PortNumber);
 
VOID
NTAPI
HubMakeUsb2StyleDescriptor(
    _In_ HubFdo* Hub,
    _Out_ PUSB_HUB_DESCRIPTOR Descriptor);