hubid.cpp File Reference

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

Include dependency graph for hubid.cpp:

Go to the source code of this file.

Classes
struct	HubFailureId
struct	HubIdSink
struct	HubIdText

Macros
#define	NDEBUG
#define	HUB_ID_MAX_CHARS   128
#define	HUB_INSTANCE_ID_CHARS   28
#define	HUB_LOCATION_TEXT_BYTES   42
#define	HUB_DEFAULT_LANGUAGE   0x0409
#define	HUB_FAILURE_ID(Reason, Pid, Text)   { (Reason), (Pid), Text, sizeof(Text) }

Enumerations
enum class	HubIdKind { Device , Hardware , Compatible , Container }

Functions
static const HubFailureId *NTAPI	HubFailureIdFor (_In_ HubChild *Child)
static NTSTATUS NTAPI	HubIdListAppend (_Inout_ PUSB_ID_STRING List, _In_ PCUNICODE_STRING Id)
VOID NTAPI	HubIdListFree (_Inout_ PUSB_ID_STRING Ids)
NTSTATUS NTAPI	HubIdListCopy (_Out_ PUSB_ID_STRING Destination, _In_ const USB_ID_STRING *Source)
static NTSTATUS NTAPI	HubIdEmit (_In_ const HubIdSink *Sink, _In_ PCUNICODE_STRING Id)
static NTSTATUS NTAPI	HubIdEmitText (_In_ const HubIdSink *Sink, _In_ const HubIdText *Text)
static NTSTATUS NTAPI	HubIdEmitCounted (_In_ const HubIdSink *Sink, _In_reads_bytes_(IdBytes) PCWSTR Id, _In_ USHORT IdBytes)
static BOOLEAN NTAPI	HubIdIsKnown (_In_ HubChild *Child)
static BOOLEAN NTAPI	HubIdUsesFailureId (_In_ HubChild *Child)
static BOOLEAN NTAPI	HubIdIsVmReserved (_In_ HubChild *Child)
static VOID NTAPI	HubIdRevisionText (_In_ USHORT BcdUsb, _In_ USHORT BcdDevice, _Out_writes_(5) PWCHAR Text)
static VOID NTAPI	HubIdWidenMsOsField (_In_reads_(8) const UCHAR *Field, _Out_writes_(9) PWCHAR Text)
static NTSTATUS NTAPI	HubIdBuildDeviceId (_In_ HubChild *Child, _In_ PWDFDEVICE_INIT DeviceInit)
NTSTATUS NTAPI	HubIdBuildHardwareIds (_In_ HubChild *Child, _In_opt_ PWDFDEVICE_INIT DeviceInit, _Out_opt_ PUSB_ID_STRING Ids)
static NTSTATUS NTAPI	HubIdBuildCompositeIds (_In_ HubChild *Child, _In_ const HubIdSink *Sink)
static NTSTATUS NTAPI	HubIdEmitMsComp (_In_ const HubIdSink *Sink, _In_reads_(8) const UCHAR *CompatibleId, _In_reads_opt_(8) const UCHAR *SubCompatibleId)
static NTSTATUS NTAPI	HubIdBuildMsOsIds (_In_ HubChild *Child, _In_ const HubIdSink *Sink)
static NTSTATUS NTAPI	HubIdBuildClassIds (_In_ HubChild *Child, _In_ const HubIdSink *Sink)
NTSTATUS NTAPI	HubIdBuildCompatibleIds (_In_ HubChild *Child, _In_opt_ PWDFDEVICE_INIT DeviceInit, _Out_opt_ PUSB_ID_STRING Ids)
static VOID NTAPI	HubIdGenerateContainerId (_In_ HubChild *Child)
static BOOLEAN NTAPI	HubIdHasContainerId (_In_ HubChild *Child)
static VOID NTAPI	HubIdBuildContainerId (_In_ HubChild *Child, _In_ PWDFDEVICE_INIT DeviceInit)
BOOLEAN NTAPI	HubIdGetContainerId (_In_ HubChild *Child, _Out_ GUID *ContainerId)
	_IRQL_requires_ (PASSIVE_LEVEL) static NTSTATUS NTAPI HubIdLoadVmReservedId(_In_ HubChild *Child)
	Sends a synchronous IOCTL to the specified device object.
VOID NTAPI	HubIdFreeDeviceIds (_In_ HubChild *Child)
	if (Child->m_SerialNumber !=NULL)
	if (Port->HasProperty(PortProperty::TypeCWithoutSwitch) &&Port->m_InstancePortNumber !=0 &&HubIdIsKnown(Child))
RtlInitEmptyUnicodeString &	Id (Digits)
	if (NT_SUCCESS(Status)) Status
	if (!NT_SUCCESS(Status)) DPRINT1("Instance id from port %lu for device %p failed 0x%lx\n"
	PAGED_CODE ()
	HubSaveUxdState (Child->m_Hub, Child, NULL)
	if (Child->HasProperty(ChildProperty::UxdReserved))
	HubIdBuildContainerId (Child, DeviceInit)
return	HubIdAssignInstanceId (Child, DeviceInit)
BOOLEAN NTAPI	HubIdLanguageSupported (_In_ HubChild *Child, _In_ USHORT Language)
	if (Text==NULL)
	if (Child->m_DeviceDescriptor.iProduct==0||Child->HasHack(ChildHack::DisableSerialNumber)) return STATUS_NOT_SUPPORTED
	if (Language==0||!HubIdLanguageSupported(Child, Language)) Language
	if (Language !=Child->m_LanguageId)
	if (Child->m_ProductString==NULL)
	RtlCopyMemory (Text, Product->bString,(Characters - 1) *sizeof(WCHAR))
	switch (Stack->Parameters.QueryDeviceText.DeviceTextType)
	IoCompleteRequest (Irp, IO_NO_INCREMENT)
static ULONG NTAPI	HubIdBytesReturned (_In_ HubChild *Child)
static PCWSTR NTAPI	HubIdSerialPrefix (_In_ HubChild *Child)
BOOLEAN NTAPI	HubIdGetSerialNumberText (_In_ HubChild *Child, _Outptr_result_bytebuffer_(*Length) PCWSTR *Text, _Out_ PULONG Length)

Variables
static const GUID	HubContainerIdNamespace
static const HubFailureId	HubFailureIds []
static const HubFailureId	HubUnknownDeviceId
static const WCHAR	HubBillboardId [] = L"USB\\Class_11&SubClass_00&Prot_00"
_In_ PWDFDEVICE_INIT	DeviceInit
WCHAR	Digits [HUB_INSTANCE_ID_CHARS]
UNICODE_STRING	Id
ULONG	Number = Port->Number()
NTSTATUS	Status = RtlIntegerToUnicodeString(Number, 10, &Id)
	Child
_Inout_ PIRP	Irp
	Text = (PWCHAR)ExAllocatePoolWithTag(NonPagedPool, HUB_LOCATION_TEXT_BYTES, HUB_TAG_DEVICE)
Irp IoStatus	Information = (ULONG_PTR)Text
return	STATUS_SUCCESS
_Inout_ PIRP _In_ LCID	Locale
PUSB_STRING_DESCRIPTOR	Product = Child->m_ProductString
ULONG	Characters = (Product->bLength - 2) / sizeof(WCHAR) + 1

Macro Definition Documentation

HUB_DEFAULT_LANGUAGE

#define HUB_DEFAULT_LANGUAGE   0x0409

Definition at line 23 of file hubid.cpp.

HUB_FAILURE_ID

#define HUB_FAILURE_ID	(		Reason,
			Pid,
			Text
	)		{ (Reason), (Pid), Text, sizeof(Text) }

Definition at line 38 of file hubid.cpp.

HUB_ID_MAX_CHARS

#define HUB_ID_MAX_CHARS   128

Definition at line 15 of file hubid.cpp.

HUB_INSTANCE_ID_CHARS

#define HUB_INSTANCE_ID_CHARS   28

Definition at line 18 of file hubid.cpp.

HUB_LOCATION_TEXT_BYTES

#define HUB_LOCATION_TEXT_BYTES   42

Definition at line 21 of file hubid.cpp.

NDEBUG

#define NDEBUG

Definition at line 11 of file hubid.cpp.

Enumeration Type Documentation

HubIdKind

enum class HubIdKind

strong

Enumerator
Device
Hardware
Compatible
Container

Definition at line 78 of file hubid.cpp.

{
    Device,
    Hardware,
    Compatible,
    Container
};

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.

Definition at line 765 of file hubid.cpp.

{
    UNICODE_STRING Value;
    WDFSTRING String;
    PWCHAR Buffer;
    NTSTATUS Status;
 
    PAGED_CODE();
 
    if (Child->m_VmReservedId.Buffer != NULL)
        ExFreePoolWithTag(Child->m_VmReservedId.Buffer, HUB_TAG_DEVICE);
    RtlZeroMemory(&Child->m_VmReservedId, sizeof(Child->m_VmReservedId));
 
    Status = WdfStringCreate(NULL, WDF_NO_OBJECT_ATTRIBUTES, &String);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("VM reserved id string for device %p failed 0x%lx\n", Child, Status);
        return Status;
    }
 
    HubQueryUxdDeviceValue(Child, String);
    WdfStringGetUnicodeString(String, &Value);
 
    Buffer = (PWCHAR)ExAllocatePoolZero(NonPagedPool, Value.Length + sizeof(WCHAR), HUB_TAG_DEVICE);
    if (Buffer == NULL)
    {
        DPRINT1("VM reserved id for device %p could not be allocated\n", Child);
        WdfObjectDelete(String);
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    RtlCopyMemory(Buffer, Value.Buffer, Value.Length);
 
    Child->m_VmReservedId.Buffer = Buffer;
    Child->m_VmReservedId.Length = Value.Length + sizeof(WCHAR);
    Child->m_VmReservedId.MaximumLength = Child->m_VmReservedId.Length;
 
    WdfObjectDelete(String);
    return STATUS_SUCCESS;
}

HubFailureIdFor()

static const HubFailureId *NTAPI HubFailureIdFor ( _In_ HubChild *  Child )

static

Definition at line 61 of file hubid.cpp.

{
    ULONG Index;
 
    for (Index = 0; Index < RTL_NUMBER_OF(HubFailureIds); Index++)
    {
        if (HubFailureIds[Index].Reason == Child->m_EnumMessageId)
            return &HubFailureIds[Index];
    }
 
    return &HubUnknownDeviceId;
}

Referenced by HubIdBuildCompatibleIds(), HubIdBuildDeviceId(), and HubIdBuildHardwareIds().

HubIdAssignInstanceId()

return HubIdAssignInstanceId	(	Child	,
		DeviceInit
	)

HubIdBuildClassIds()

static NTSTATUS NTAPI HubIdBuildClassIds ( _In_ HubChild *  Child, _In_ const HubIdSink *  Sink  )

static

Definition at line 541 of file hubid.cpp.

{
    const USB_INTERFACE_DESCRIPTOR* Interface = Child->m_CompatIdInterface;
    USHORT VendorId = Child->m_DeviceDescriptor.idVendor;
    UCHAR Class = 0;
    UCHAR SubClass = 0;
    UCHAR Protocol = 0;
    HubIdText Text;
    NTSTATUS Status;
 
    if (Interface != NULL)
    {
        Class = Interface->bInterfaceClass;
        SubClass = Interface->bInterfaceSubClass;
        Protocol = Interface->bInterfaceProtocol;
    }
 
    Status = HubIdBuildMsOsIds(Child, Sink);
    if (!NT_SUCCESS(Status))
        return Status;
 
    /* COMPAT_VID class ids, between the MS OS ids and the plain class ids */
    Text.Format(L"USB\\COMPAT_VID_%04X&Class_%02X&SubClass_%02X&Prot_%02X", VendorId, Class, SubClass, Protocol);
    Status = HubIdEmitText(Sink, &Text);
    if (!NT_SUCCESS(Status))
        return Status;
 
    Text.Format(L"USB\\COMPAT_VID_%04X&Class_%02X&SubClass_%02X", VendorId, Class, SubClass);
    Status = HubIdEmitText(Sink, &Text);
    if (!NT_SUCCESS(Status))
        return Status;
 
    Text.Format(L"USB\\COMPAT_VID_%04X&Class_%02X", VendorId, Class);
    Status = HubIdEmitText(Sink, &Text);
    if (!NT_SUCCESS(Status))
        return Status;
 
    Text.Format(L"USB\\Class_%02X&SubClass_%02X&Prot_%02X", Class, SubClass, Protocol);
    Status = HubIdEmitText(Sink, &Text);
    if (!NT_SUCCESS(Status))
        return Status;
 
    Text.Format(L"USB\\Class_%02X&SubClass_%02X", Class, SubClass);
    Status = HubIdEmitText(Sink, &Text);
    if (!NT_SUCCESS(Status))
        return Status;
 
    Text.Format(L"USB\\Class_%02X", Class);
    return HubIdEmitText(Sink, &Text);
}

Referenced by HubIdBuildCompatibleIds().

HubIdBuildCompatibleIds()

NTSTATUS NTAPI HubIdBuildCompatibleIds	(	_In_ HubChild *	Child,
		_In_opt_ PWDFDEVICE_INIT	DeviceInit,
		_Out_opt_ PUSB_ID_STRING	Ids
	)

Compatible ids into a PDO init and/or a multi-sz list, which is zeroed first.

Definition at line 597 of file hubid.cpp.

{
    HubIdSink Sink = { HubIdKind::Compatible, DeviceInit, Ids };
    HubIdText Text;
 
    if (Ids != NULL)
        RtlZeroMemory(Ids, sizeof(*Ids));
 
    if (HubIdUsesFailureId(Child))
    {
        const HubFailureId* Failure = HubFailureIdFor(Child);
        return HubIdEmitCounted(&Sink, Failure->Id, Failure->IdBytes);
    }
 
    if (Child->HasProperty(ChildProperty::IsComposite))
        return HubIdBuildCompositeIds(Child, &Sink);
 
    if (Child->HasProperty(ChildProperty::IsHub))
    {
        switch (Child->Speed())
        {
            case UsbHighSpeed:
            case UsbFullSpeed:
                Text.Set(L"USB\\USB20_HUB");
                return HubIdEmitText(&Sink, &Text);
 
            case UsbSuperSpeed:
                Text.Set(L"USB\\USB30_HUB");
                return HubIdEmitText(&Sink, &Text);
 
            default:
                return STATUS_SUCCESS;
        }
    }
 
    if (Child->HasProperty(ChildProperty::HasBillboard))
        return HubIdEmitCounted(&Sink, HubBillboardId, sizeof(HubBillboardId));
 
    return HubIdBuildClassIds(Child, &Sink);
}

HubIdBuildCompositeIds()

static NTSTATUS NTAPI HubIdBuildCompositeIds ( _In_ HubChild *  Child, _In_ const HubIdSink *  Sink  )

static

Definition at line 422 of file hubid.cpp.

{
    static PCWSTR const Plain[] =
    {
        L"USB\\DevClass_00&SubClass_00&Prot_00",
        L"USB\\DevClass_00&SubClass_00",
        L"USB\\DevClass_00",
        L"USB\\COMPOSITE"
    };
    USHORT VendorId = Child->m_DeviceDescriptor.idVendor;
    HubIdText Text;
    NTSTATUS Status;
    ULONG Index;
 
    /* "Prot00" without the underscore is intentional */
    Text.Format(L"USB\\COMPAT_VID_%04X&DevClass_00&SubClass_00&Prot00", VendorId);
    Status = HubIdEmitText(Sink, &Text);
    if (!NT_SUCCESS(Status))
        return Status;
 
    Text.Format(L"USB\\COMPAT_VID_%04X&DevClass_00&SubClass_00", VendorId);
    Status = HubIdEmitText(Sink, &Text);
    if (!NT_SUCCESS(Status))
        return Status;
 
    Text.Format(L"USB\\COMPAT_VID_%04X&DevClass_00", VendorId);
    Status = HubIdEmitText(Sink, &Text);
    if (!NT_SUCCESS(Status))
        return Status;
 
    for (Index = 0; Index < RTL_NUMBER_OF(Plain); Index++)
    {
        Text.Set(Plain[Index]);
        Status = HubIdEmitText(Sink, &Text);
        if (!NT_SUCCESS(Status))
            return Status;
    }
 
    return STATUS_SUCCESS;
}

Referenced by HubIdBuildCompatibleIds().

HubIdBuildContainerId() [1/2]

static VOID NTAPI HubIdBuildContainerId ( _In_ HubChild *  Child, _In_ PWDFDEVICE_INIT  DeviceInit  )

static

Definition at line 719 of file hubid.cpp.

{
    HubIdSink Sink = { HubIdKind::Container, DeviceInit, NULL };
    const GUID* Id = &Child->m_ContainerId;
    HubIdText Text;
    NTSTATUS Status;
 
    if (Child->HasProperty(ChildProperty::NotRemovable))
        return;
 
    if (!HubIdHasContainerId(Child) && Child->m_SerialNumber != NULL)
        HubIdGenerateContainerId(Child);
 
    if (!HubIdHasContainerId(Child))
        return;
 
    Text.Format(L"{%08lX-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X}",
                Id->Data1, Id->Data2, Id->Data3,
                Id->Data4[0], Id->Data4[1], Id->Data4[2], Id->Data4[3],
                Id->Data4[4], Id->Data4[5], Id->Data4[6], Id->Data4[7]);
 
    Status = HubIdEmitText(&Sink, &Text);
    if (!NT_SUCCESS(Status))
        DPRINT1("Container id for device %p not assigned: 0x%lx\n", Child, Status);
}

HubIdBuildContainerId() [2/2]

HubIdBuildContainerId	(	Child	,
		DeviceInit
	)

HubIdBuildDeviceId()

static NTSTATUS NTAPI HubIdBuildDeviceId ( _In_ HubChild *  Child, _In_ PWDFDEVICE_INIT  DeviceInit  )

static

Definition at line 348 of file hubid.cpp.

{
    HubIdSink Sink = { HubIdKind::Device, DeviceInit, NULL };
    HubIdText Text;
    USHORT VendorId = Child->m_DeviceDescriptor.idVendor;
    USHORT ProductId = Child->m_DeviceDescriptor.idProduct;
 
    if (HubIdIsKnown(Child) && HubIdIsVmReserved(Child))
        return HubIdEmit(&Sink, &Child->m_VmReservedId);
 
    if (HubIdUsesFailureId(Child))
    {
        VendorId = 0;
        ProductId = HubFailureIdFor(Child)->ProductId;
    }
 
    Text.Format(L"USB\\VID_%04X&PID_%04X", VendorId, ProductId);
    if (Child->HasHack(ChildHack::NonFunctional))
        Text.Append(L"_NON_FUNCTIONAL");
 
    return HubIdEmitText(&Sink, &Text);
}

HubIdBuildHardwareIds()

NTSTATUS NTAPI HubIdBuildHardwareIds	(	_In_ HubChild *	Child,
		_In_opt_ PWDFDEVICE_INIT	DeviceInit,
		_Out_opt_ PUSB_ID_STRING	Ids
	)

Hardware ids into a PDO init and/or a multi-sz list, which is zeroed first.

Definition at line 381 of file hubid.cpp.

{
    HubIdSink Sink = { HubIdKind::Hardware, DeviceInit, Ids };
    const USB_DEVICE_DESCRIPTOR* Descriptor = &Child->m_DeviceDescriptor;
    HubIdText Text;
    WCHAR Revision[5];
    NTSTATUS Status;
 
    if (Ids != NULL)
        RtlZeroMemory(Ids, sizeof(*Ids));
 
    if (HubIdUsesFailureId(Child))
    {
        const HubFailureId* Failure = HubFailureIdFor(Child);
        return HubIdEmitCounted(&Sink, Failure->Id, Failure->IdBytes);
    }
 
    if (DeviceInit != NULL && HubIdIsVmReserved(Child))
        return HubIdEmit(&Sink, &Child->m_VmReservedId);
 
    HubIdRevisionText(Descriptor->bcdUSB, Descriptor->bcdDevice, Revision);
 
    Text.Format(L"USB\\VID_%04X&PID_%04X&REV_", Descriptor->idVendor, Descriptor->idProduct);
    Text.Append(Revision);
    Status = HubIdEmitText(&Sink, &Text);
    if (!NT_SUCCESS(Status))
        return Status;
 
    Text.Format(L"USB\\VID_%04X&PID_%04X", Descriptor->idVendor, Descriptor->idProduct);
    return HubIdEmitText(&Sink, &Text);
}

HubIdBuildMsOsIds()

static NTSTATUS NTAPI HubIdBuildMsOsIds ( _In_ HubChild *  Child, _In_ const HubIdSink *  Sink  )

static

Definition at line 494 of file hubid.cpp.

{
    const UCHAR* CompatibleId;
    const UCHAR* SubCompatibleId;
    NTSTATUS Status;
 
    if ((Child->m_MsOs20.Flags & HUB_MSOS20_COMPATIBLE_ID) && Child->m_MsOs20.CompatibleId != NULL)
    {
        CompatibleId = Child->m_MsOs20.CompatibleId->CompatibleId;
        SubCompatibleId = Child->m_MsOs20.CompatibleId->SubCompatibleId;
 
        if (SubCompatibleId[0] != 0 && CompatibleId[0] != 0)
        {
            Status = HubIdEmitMsComp(Sink, CompatibleId, SubCompatibleId);
            if (!NT_SUCCESS(Status))
                return Status;
        }
    }
    else if (Child->m_MsOsExtConfig != NULL)
    {
        CompatibleId = Child->m_MsOsExtConfig->Function[0].CompatibleId;
        SubCompatibleId = Child->m_MsOsExtConfig->Function[0].SubCompatibleId;
 
        /* Only the sub compatible id is checked, so the compatible id can come out empty */
        if (SubCompatibleId[0] != 0)
        {
            Status = HubIdEmitMsComp(Sink, CompatibleId, SubCompatibleId);
            if (!NT_SUCCESS(Status))
                return Status;
        }
    }
    else
    {
        return STATUS_SUCCESS;
    }
 
    if (CompatibleId[0] != 0)
        return HubIdEmitMsComp(Sink, CompatibleId, NULL);
 
    return STATUS_SUCCESS;
}

Referenced by HubIdBuildClassIds().

HubIdBytesReturned()

static ULONG NTAPI HubIdBytesReturned ( _In_ HubChild *  Child )

static

Definition at line 1087 of file hubid.cpp.

{
    return min(Child->m_Control.Urb.TransferBufferLength, (ULONG)sizeof(Child->m_ScratchBuffer));
}

Referenced by DeviceMachine::SameSerialNumber(), and DeviceMachine::SerialNumberValid().

HubIdEmit()

static NTSTATUS NTAPI HubIdEmit ( _In_ const HubIdSink *  Sink, _In_ PCUNICODE_STRING  Id  )

static

Definition at line 198 of file hubid.cpp.

{
    NTSTATUS Status = STATUS_SUCCESS;
 
    if (Sink->Init != NULL)
    {
        switch (Sink->Kind)
        {
            case HubIdKind::Device:
                Status = WdfPdoInitAssignDeviceID(Sink->Init, Id);
                break;
 
            case HubIdKind::Hardware:
                Status = WdfPdoInitAddHardwareID(Sink->Init, Id);
                break;
 
            case HubIdKind::Compatible:
                Status = WdfPdoInitAddCompatibleID(Sink->Init, Id);
                break;
 
            case HubIdKind::Container:
                Status = WdfPdoInitAssignContainerID(Sink->Init, Id);
                break;
        }
 
        if (!NT_SUCCESS(Status))
        {
            DPRINT1("Assigning id %wZ (kind %d) failed 0x%lx\n", Id, (int)Sink->Kind, Status);
            return Status;
        }
    }
 
    if (Sink->List != NULL)
        Status = HubIdListAppend(Sink->List, Id);
 
    return Status;
}

Referenced by HubIdBuildDeviceId(), HubIdBuildHardwareIds(), HubIdEmitCounted(), and HubIdEmitText().

HubIdEmitCounted()

static NTSTATUS NTAPI HubIdEmitCounted ( _In_ const HubIdSink *  Sink, _In_reads_bytes_(IdBytes) PCWSTR  Id, _In_ USHORT  IdBytes  )

static

Emits a fixed id whose byte count is given as is, counted NUL included.

Definition at line 261 of file hubid.cpp.

{
    UNICODE_STRING String;
 
    String.Buffer = (PWCH)Id;
    String.Length = IdBytes;
    String.MaximumLength = IdBytes;
    return HubIdEmit(Sink, &String);
}

Referenced by HubIdBuildCompatibleIds(), and HubIdBuildHardwareIds().

HubIdEmitMsComp()

static NTSTATUS NTAPI HubIdEmitMsComp ( _In_ const HubIdSink *  Sink, _In_reads_(8) const UCHAR *  CompatibleId, _In_reads_opt_(8) const UCHAR *  SubCompatibleId  )

static

Definition at line 468 of file hubid.cpp.

{
    HubIdText Text;
    WCHAR Field[9];
 
    HubIdWidenMsOsField(CompatibleId, Field);
    Text.Set(L"USB\\MS_COMP_");
    Text.Append(Field);
 
    if (SubCompatibleId != NULL)
    {
        HubIdWidenMsOsField(SubCompatibleId, Field);
        Text.Append(L"&MS_SUBCOMP_");
        Text.Append(Field);
    }
 
    return HubIdEmitText(Sink, &Text);
}

Referenced by HubIdBuildMsOsIds().

HubIdEmitText()

static NTSTATUS NTAPI HubIdEmitText ( _In_ const HubIdSink *  Sink, _In_ const HubIdText *  Text  )

static

Definition at line 241 of file hubid.cpp.

{
    UNICODE_STRING Id;
 
    if (!NT_SUCCESS(Text->Status))
    {
        DPRINT1("Formatting an id failed 0x%lx\n", Text->Status);
        return Text->Status;
    }
 
    RtlInitUnicodeString(&Id, Text->Buffer);
    return HubIdEmit(Sink, &Id);
}

Referenced by HubIdBuildClassIds(), HubIdBuildCompatibleIds(), HubIdBuildCompositeIds(), HubIdBuildContainerId(), HubIdBuildDeviceId(), HubIdBuildHardwareIds(), and HubIdEmitMsComp().

HubIdFreeDeviceIds()

VOID NTAPI HubIdFreeDeviceIds

(

_In_ HubChild *

Child

)

Frees the identity buffers of a device; called when the device object is destroyed.

Definition at line 813 of file hubid.cpp.

{
    if (Child->m_VmReservedId.Buffer != NULL)
        ExFreePoolWithTag(Child->m_VmReservedId.Buffer, HUB_TAG_DEVICE);
 
    RtlZeroMemory(&Child->m_VmReservedId, sizeof(Child->m_VmReservedId));
}

HubIdGenerateContainerId()

static VOID NTAPI HubIdGenerateContainerId ( _In_ HubChild *  Child )

static

Definition at line 647 of file hubid.cpp.

{
    const USB_DEVICE_DESCRIPTOR* Descriptor = &Child->m_DeviceDescriptor;
    ULONG NameBytes = Child->m_SerialNumberLength + 28;
    UCHAR Digest[HUB_SHA1_DIGEST_BYTES];
    WCHAR Revision[5];
    HubSha1 Sha;
    PWCHAR Name;
    size_t NameLength;
    NTSTATUS Status;
 
    Name = (PWCHAR)ExAllocatePoolWithTag(NonPagedPool, NameBytes, HUB_TAG_DEVICE);
    if (Name == NULL)
    {
        DPRINT1("Container id name for device %p could not be allocated\n", Child);
        return;
    }
 
    if (Descriptor->bcdUSB > 0x0200)
    {
        /* bcdUSB, not bcdDevice, and space padded */
        Status = RtlStringCbPrintfW(Name, NameBytes, L"%04X%04X.%4X",
                                    Descriptor->idVendor, Descriptor->idProduct, Descriptor->bcdUSB);
    }
    else
    {
        HubIdRevisionText(Descriptor->bcdUSB, Descriptor->bcdDevice, Revision);
        Status = RtlStringCbPrintfW(Name, NameBytes, L"%04X%04X", Descriptor->idVendor, Descriptor->idProduct);
        if (NT_SUCCESS(Status))
            Status = RtlStringCbCatW(Name, NameBytes, Revision);
    }
 
    if (NT_SUCCESS(Status))
        Status = RtlStringCbCatW(Name, NameBytes, Child->m_SerialNumber + Child->m_SerialPrefixLength / sizeof(WCHAR));
 
    if (NT_SUCCESS(Status))
        Status = RtlStringCbLengthW(Name, NameBytes, &NameLength);
 
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Container id name for device %p failed: 0x%lx\n", Child, Status);
        ExFreePoolWithTag(Name, HUB_TAG_DEVICE);
        return;
    }
 
    HubSha1Init(&Sha);
    HubSha1Update(&Sha, &HubContainerIdNamespace, sizeof(HubContainerIdNamespace));
    HubSha1Update(&Sha, Name, NameLength);
    HubSha1Final(&Sha, Digest);
    ExFreePoolWithTag(Name, HUB_TAG_DEVICE);
 
    RtlCopyMemory(&Child->m_ContainerId, Digest, sizeof(Child->m_ContainerId));
    Child->m_ContainerId.Data3 = (Child->m_ContainerId.Data3 & 0x0FFF) | 0x5000;
    Child->m_ContainerId.Data4[0] = (Child->m_ContainerId.Data4[0] & 0x3F) | 0x80;
    Child->SetProperty(ChildProperty::ContainerIdKnown);
}

Referenced by HubIdBuildContainerId().

HubIdGetContainerId()

BOOLEAN NTAPI HubIdGetContainerId	(	_In_ HubChild *	Child,
		_Out_ GUID *	ContainerId
	)

Container id the PDO got; FALSE when it got none.

Definition at line 749 of file hubid.cpp.

{
    RtlZeroMemory(ContainerId, sizeof(*ContainerId));
 
    if (Child->HasProperty(ChildProperty::NotRemovable) || !HubIdHasContainerId(Child))
        return FALSE;
 
    *ContainerId = Child->m_ContainerId;
    return TRUE;
}

HubIdGetSerialNumberText()

BOOLEAN NTAPI HubIdGetSerialNumberText	(	_In_ HubChild *	Child,
		_Outptr_result_bytebuffer_ *Length PCWSTR *	Text,
		_Out_ PULONG	Length
	)

Cached serial number text without its decoration, for the serial string IOCTL.

Definition at line 1111 of file hubid.cpp.

{
    *Text = NULL;
    *Length = 0;
 
    if (Child->m_SerialNumber == NULL ||
        Child->m_SerialNumberLength < Child->m_SerialPrefixLength + sizeof(WCHAR))
    {
        return FALSE;
    }
 
    *Text = Child->m_SerialNumber + Child->m_SerialPrefixLength / sizeof(WCHAR);
    *Length = Child->m_SerialNumberLength - Child->m_SerialPrefixLength - sizeof(WCHAR);
    return TRUE;
}

Referenced by HubIoGetDescriptor(), and DeviceMachine::SameSerialNumber().

HubIdHasContainerId()

static BOOLEAN NTAPI HubIdHasContainerId ( _In_ HubChild *  Child )

static

Definition at line 708 of file hubid.cpp.

{
    return Child->HasProperty(ChildProperty::ContainerIdKnown) ||
           Child->HasProperty(ChildProperty::ContainerIdFromBos);
}

Referenced by HubIdBuildContainerId(), and HubIdGetContainerId().

HubIdIsKnown()

static BOOLEAN NTAPI HubIdIsKnown ( _In_ HubChild *  Child )

static

Definition at line 279 of file hubid.cpp.

{
    return Child->HasState(ChildState::WorkingDevice);
}

Referenced by HubIdBuildDeviceId(), and HubIdUsesFailureId().

HubIdIsVmReserved()

static BOOLEAN NTAPI HubIdIsVmReserved ( _In_ HubChild *  Child )

static

Definition at line 298 of file hubid.cpp.

{
    return Child->HasProperty(ChildProperty::UxdReserved) &&
           !Child->HasProperty(ChildProperty::IsHub);
}

Referenced by HubIdBuildDeviceId(), and HubIdBuildHardwareIds().

HubIdLanguageSupported()

BOOLEAN NTAPI HubIdLanguageSupported	(	_In_ HubChild *	Child,
		_In_ USHORT	Language
	)

TRUE when the device lists Language among its string languages.

Definition at line 911 of file hubid.cpp.

{
    const USB_STRING_DESCRIPTOR* List = Child->m_LanguageIds;
    ULONG Count;
    ULONG Index;
 
    if (List == NULL || List->bLength <= 2)
        return FALSE;
 
    Count = (List->bLength - 2) / sizeof(WCHAR);
    for (Index = 0; Index < Count && List->bString[Index] != 0; Index++)
    {
        if (List->bString[Index] == Language)
            return TRUE;
    }
 
    return FALSE;
}

Referenced by DeviceMachine::ProductNameWanted().

HubIdListAppend()

static NTSTATUS NTAPI HubIdListAppend ( _Inout_ PUSB_ID_STRING  List, _In_ PCUNICODE_STRING  Id  )

static

Definition at line 130 of file hubid.cpp.

{
    ULONG Kept = (List->Buffer != NULL) ? List->LengthInBytes - sizeof(WCHAR) : 0;
    ULONG Total = Kept + Id->Length + 2 * sizeof(WCHAR);
    PWCHAR Buffer;
 
    Buffer = (PWCHAR)ExAllocatePoolZero(NonPagedPool, Total, HUB_TAG_DEVICE);
    if (Buffer == NULL)
    {
        DPRINT1("Id list of %lu bytes could not be allocated\n", Total);
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    if (Kept != 0)
        RtlCopyMemory(Buffer, List->Buffer, Kept);
    RtlCopyMemory((PUCHAR)Buffer + Kept, Id->Buffer, Id->Length);
 
    if (List->Buffer != NULL)
        ExFreePoolWithTag(List->Buffer, HUB_TAG_DEVICE);
 
    List->Buffer = Buffer;
    List->LengthInBytes = Total;
    return STATUS_SUCCESS;
}

Referenced by HubIdEmit().

HubIdListCopy()

NTSTATUS NTAPI HubIdListCopy	(	_Out_ PUSB_ID_STRING	Destination,
		_In_ const USB_ID_STRING *	Source
	)

Duplicates a multi-sz id list into nonpaged pool.

Definition at line 173 of file hubid.cpp.

{
    RtlZeroMemory(Destination, sizeof(*Destination));
 
    if (Source->Buffer == NULL || Source->LengthInBytes == 0)
        return STATUS_SUCCESS;
 
    *Destination = *Source;
    Destination->Buffer = (PWCHAR)ExAllocatePoolWithTag(NonPagedPool, Source->LengthInBytes, HUB_TAG_DEVICE);
    if (Destination->Buffer == NULL)
    {
        DPRINT1("Id list copy of %lu bytes could not be allocated\n", Source->LengthInBytes);
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    RtlCopyMemory(Destination->Buffer, Source->Buffer, Source->LengthInBytes);
    return STATUS_SUCCESS;
}

Referenced by if().

HubIdListFree()

VOID NTAPI HubIdListFree

(

_Inout_ PUSB_ID_STRING

Ids

)

Frees a multi-sz id list; an empty list is fine.

Definition at line 159 of file hubid.cpp.

{
    if (Ids->Buffer == NULL)
        return;
 
    ExFreePoolWithTag(Ids->Buffer, HUB_TAG_DEVICE);
    Ids->Buffer = NULL;
    Ids->LengthInBytes = 0;
}

HubIdRevisionText()

static VOID NTAPI HubIdRevisionText ( _In_ USHORT  BcdUsb, _In_ USHORT  BcdDevice, _Out_writes_(5) PWCHAR  Text  )

static

Definition at line 309 of file hubid.cpp.

{
    static const WCHAR HexDigits[] = L"0123456789ABCDEF";
    ULONG Index;
    ULONG Nibble;
 
    for (Index = 0; Index < 4; Index++)
    {
        Nibble = (BcdDevice >> (12 - Index * 4)) & 0xF;
        Text[Index] = (BcdUsb > 0x0200) ? HexDigits[Nibble] : (WCHAR)(L'0' + Nibble);
    }
 
    Text[4] = UNICODE_NULL;
}

Referenced by HubIdBuildHardwareIds(), and HubIdGenerateContainerId().

HubIdSerialPrefix()

static PCWSTR NTAPI HubIdSerialPrefix ( _In_ HubChild *  Child )

static

Definition at line 1097 of file hubid.cpp.

{
    if (Child->HasProperty(ChildProperty::IsHub))
        return (Child->m_DeviceDescriptor.bcdUSB >= 0x0300) ? L"MSFT30" : L"MSFT20";
 
    if (Child->HasState(ChildState::PrefixedSerial))
        return L"MSFT30";
 
    return NULL;
}

Referenced by DeviceMachine::SerialNumberValid().

HubIdUsesFailureId()

static BOOLEAN NTAPI HubIdUsesFailureId ( _In_ HubChild *  Child )

static

Definition at line 289 of file hubid.cpp.

{
    return !HubIdIsKnown(Child) && !Child->HasState(ChildState::ConfigurationValid);
}

Referenced by HubIdBuildCompatibleIds(), HubIdBuildDeviceId(), and HubIdBuildHardwareIds().

HubIdWidenMsOsField()

static VOID NTAPI HubIdWidenMsOsField ( _In_reads_(8) const UCHAR *  Field, _Out_writes_(9) PWCHAR  Text  )

static

Definition at line 331 of file hubid.cpp.

{
    ULONG Index;
 
    for (Index = 0; Index < 8 && Field[Index] != 0; Index++)
        Text[Index] = Field[Index];
 
    Text[Index] = UNICODE_NULL;
}

Referenced by HubIdEmitMsComp().

HubSaveUxdState()

HubSaveUxdState	(	Child->	m_Hub,
		Child	,
		NULL
	)

Referenced by HubIoCyclePort().

Id()

RtlInitEmptyUnicodeString & Id

(

Digits

)

if() [1/10]

if

(

!

NT_SUCCESSStatus

)

Definition at line 965 of file hubid.cpp.

    {
        DPRINT1("Location text for device %p failed 0x%lx\n", Child, Status);
        ExFreePoolWithTag(Text, HUB_TAG_DEVICE);
        return Status;
    }

if() [2/10]

if

(

Child->

HasPropertyChildProperty::UxdReserved

)

Definition at line 882 of file hubid.cpp.

    {
        Status = HubIdLoadVmReservedId(Child);
        if (!NT_SUCCESS(Status))
            return Status;
    }

if() [3/10]

if

(

Child->m_DeviceDescriptor.

iProduct = =0||Child->HasHack(ChildHack::DisableSerialNumber)

)

if() [4/10]

if

(

Child->

m_ProductString = = NULL

)

Definition at line 1014 of file hubid.cpp.

    {
        if (Language == HUB_DEFAULT_LANGUAGE)
        {
            DPRINT("Device %p has no product string\n", Child);
            return STATUS_NOT_SUPPORTED;
        }
 
        Child->m_LanguageId = HUB_DEFAULT_LANGUAGE;
        HubIdReadProductString(Child);
 
        if (Child->m_ProductString == NULL)
        {
            DPRINT("Device %p has no product string\n", Child);
            return STATUS_NOT_SUPPORTED;
        }
    }

if() [5/10]

if

(

Child->m_SerialNumber !

= NULL

)

Definition at line 839 of file hubid.cpp.

    {
        RtlInitUnicodeString(&Id, Child->m_SerialNumber);
        Status = WdfPdoInitAssignInstanceID(DeviceInit, &Id);
        if (!NT_SUCCESS(Status))
            DPRINT1("Instance id %wZ for device %p failed 0x%lx\n", &Id, Child, Status);
 
        return Status;
    }

if() [6/10]

if

(

Language !

= Child->m_LanguageId

)

Definition at line 1002 of file hubid.cpp.

    {
        Child->m_LanguageId = Language;
        if (Child->m_ProductString != NULL)
        {
            ExFreePoolWithTag(Child->m_ProductString, HUB_TAG_DEVICE);
            Child->m_ProductString = NULL;
        }
 
        HubIdReadProductString(Child);
    }

if() [7/10]

if

(

Language

= =0||!HubIdLanguageSupported(Child, Language)

)

if() [8/10]

if

(

NT_SUCCESS(Status)

)

Definition at line 169 of file userreq.cpp.

    {
        User.SetStatus(UsbUserSuccess);
        Name->Length = ResultLength + sizeof(WCHAR);
    }

if() [9/10]

if

(

Port->HasProperty(PortProperty::TypeCWithoutSwitch) &&Port->m_InstancePortNumber !

= 0 && HubIdIsKnown(Child)

)

Definition at line 850 of file hubid.cpp.

    {
        Number = Port->m_InstancePortNumber;
    }

if() [10/10]

if

(

Text

= = NULL

)

Definition at line 957 of file hubid.cpp.

    {
        DPRINT1("Location text for device %p could not be allocated\n", Child);
        return STATUS_INSUFFICIENT_RESOURCES;
    }

IoCompleteRequest()

IoCompleteRequest	(	Irp	,
		IO_NO_INCREMENT
	)

PAGED_CODE()

PAGED_CODE

(

)

Referenced by _IRQL_requires_().

RtlCopyMemory()

RtlCopyMemory	(	Text	,
		Product->	bString,
		(Characters - 1) *sizeof(WCHAR)
	)

switch()

switch

(

Stack->Parameters.QueryDeviceText.

DeviceTextType

)

Definition at line 1061 of file hubid.cpp.

    {
        case DeviceTextLocationInformation:
            Status = HubIdLocationText(Child, Irp);
            break;
 
        case DeviceTextDescription:
            Status = HubIdDescriptionText(Child, Irp, Stack->Parameters.QueryDeviceText.LocaleId);
            break;
 
        default:
            Status = STATUS_NOT_SUPPORTED;
            break;
    }

Variable Documentation

Characters

Characters = (Product->bLength - 2) / sizeof(WCHAR) + 1

Definition at line 991 of file hubid.cpp.

Child

Child

Definition at line 864 of file hubid.cpp.

DeviceInit

_In_ PWDFDEVICE_INIT DeviceInit

Initial value:

{
    HubPort* Port = Child->m_Port

Definition at line 831 of file hubid.cpp.

Referenced by HubIdBuildCompatibleIds(), HubIdBuildContainerId(), HubIdBuildDeviceId(), and HubIdBuildHardwareIds().

Digits

WCHAR Digits[HUB_INSTANCE_ID_CHARS]

Definition at line 834 of file hubid.cpp.

Referenced by AcpiUtPutNumber(), and GetDigitCount().

HubBillboardId

const WCHAR HubBillboardId[] = L"USB\\Class_11&SubClass_00&Prot_00"

static

Definition at line 56 of file hubid.cpp.

Referenced by HubIdBuildCompatibleIds().

HubContainerIdNamespace

const GUID HubContainerIdNamespace

static

Initial value:

=
    { 0x4B06FD46, 0xC84E, 0x4664, { 0x9C, 0x65, 0x0C, 0x86, 0xD9, 0x04, 0x7A, 0x0C } }

Definition at line 26 of file hubid.cpp.

Referenced by HubIdGenerateContainerId().

HubFailureIds

const HubFailureId HubFailureIds[]

static

Initial value:

=
{
    HUB_FAILURE_ID(HUB_ENUM_DEVICE_DESCRIPTOR_FAILED, 0x0002, L"USB\\DEVICE_DESCRIPTOR_FAILURE"),
    HUB_FAILURE_ID(HUB_ENUM_SET_ADDRESS_FAILED,       0x0004, L"USB\\SET_ADDRESS_FAILURE"),
    HUB_FAILURE_ID(HUB_ENUM_PORT_RESET_FAILED,        0x0001, L"USB\\RESET_FAILURE"),
    HUB_FAILURE_ID(HUB_ENUM_BAD_CONFIG_DESCRIPTOR,    0x0006, L"USB\\CONFIGURATION_DESCRIPTOR_VALIDATION_FAILURE"),
    HUB_FAILURE_ID(HUB_ENUM_BAD_DEVICE_DESCRIPTOR,    0x0005, L"USB\\DEVICE_DESCRIPTOR_VALIDATION_FAILURE"),
    HUB_FAILURE_ID(HUB_ENUM_CONFIG_DESCRIPTOR_FAILED, 0x0003, L"USB\\CONFIG_DESCRIPTOR_FAILURE"),
    HUB_FAILURE_ID(HUB_ENUM_LINK_SS_INACTIVE,         0x0007, L"USB\\PORT_LINK_SSINACTIVE"),
    HUB_FAILURE_ID(HUB_ENUM_LINK_COMPLIANCE,          0x0008, L"USB\\PORT_LINK_COMPLIANCE_MODE"),
}

Definition at line 40 of file hubid.cpp.

Referenced by HubFailureIdFor().

HubUnknownDeviceId

const HubFailureId HubUnknownDeviceId

static

Initial value:

=
    HUB_FAILURE_ID(0, 0x0000, L"USB\\UNKNOWN_DEVICE")

Definition at line 52 of file hubid.cpp.

Referenced by HubFailureIdFor().

Id

UNICODE_STRING Id

Definition at line 835 of file hubid.cpp.

Referenced by HubIdBuildContainerId(), HubIdEmit(), HubIdEmitCounted(), HubIdEmitText(), HubIdListAppend(), and if().

Information

Irp IoStatus Information = (ULONG_PTR)Text

Definition at line 972 of file hubid.cpp.

Irp

_Inout_ PIRP Irp

Initial value:

{
    PWCHAR Text

Definition at line 951 of file hubid.cpp.

Locale

_Inout_ PIRP _In_ LCID Locale

Initial value:

{
    USHORT Language = LANGIDFROMLCID(Locale)

Definition at line 987 of file hubid.cpp.

Referenced by co_IntGetCharsetInfo(), CreateLanguagesList(), fnIMultiLanguage3_GetRfc1766Info(), fnIMultiLanguage_GetRfc1766Info(), GetCalendarInfoW(), GetLocaleName(), LCIDToLocaleName(), LoadLocalizedResourcesFromINI(), PciQueryDeviceText(), RtlLcidToLocaleName(), SetCalendarInfoA(), SetCalendarInfoW(), wbem_locator_ConnectServer(), and WriteUserLocale().

Number

Number = Port->Number()

Definition at line 836 of file hubid.cpp.

Product

Product = Child->m_ProductString

Definition at line 990 of file hubid.cpp.

Referenced by AcpiUtInsertDigit(), AcpiUtShortMultiply(), AcpiUtStrtoulMultiply64(), FAST486_OPCODE_HANDLER(), and IsVesaBiosOk().

Status

return Status = RtlIntegerToUnicodeString(Number, 10, &Id)

Definition at line 837 of file hubid.cpp.

Referenced by _IRQL_requires_(), HubIdBuildClassIds(), HubIdBuildCompositeIds(), HubIdBuildContainerId(), HubIdBuildHardwareIds(), HubIdBuildMsOsIds(), HubIdEmit(), HubIdGenerateContainerId(), and if().

STATUS_SUCCESS

return STATUS_SUCCESS

Definition at line 973 of file hubid.cpp.

Referenced by _IRQL_requires_(), HubIdBuildCompatibleIds(), HubIdBuildCompositeIds(), HubIdBuildMsOsIds(), HubIdEmit(), HubIdListAppend(), and HubIdListCopy().

Text

Text[Characters - 1] = (PWCHAR)ExAllocatePoolWithTag(NonPagedPool, HUB_LOCATION_TEXT_BYTES, HUB_TAG_DEVICE)

Definition at line 956 of file hubid.cpp.

Referenced by HubIdText::Append(), HubIdBuildClassIds(), HubIdBuildCompatibleIds(), HubIdBuildCompositeIds(), HubIdBuildContainerId(), HubIdBuildDeviceId(), HubIdBuildHardwareIds(), HubIdEmitMsComp(), HubIdEmitText(), HubIdGetSerialNumberText(), HubIdRevisionText(), HubIdWidenMsOsField(), if(), and HubIdText::Set().