#include "usbhub3.h"
#include "hubregistry.h"
#include <debug.h>
#include <pshpack1.h>
#include <poppack.h>

Include dependency graph for hubmsos.cpp:

Classes
struct	HubMsOsExtPropHeader

struct	HubMsOsCustomProperty

Macros
#define	NDEBUG

#define	MSOS_FLAG_CONTAINER_ID 0x02

#define	MSOS_EXT_PROPERTIES_INDEX 5

#define	MSOS_EXT_PROPERTIES_VERSION 0x0100

#define	MSOS_EXT_PROPERTIES_MAX 4096

#define	MSOS20_TYPE_REGISTRY_PROPERTY 4

#define	MSOS_CUSTOM_PROPERTY_FIXED (sizeof(HubMsOsCustomProperty) + sizeof(ULONG))

Functions
	C_ASSERT (sizeof(HubMsOsExtPropHeader)==10)

	C_ASSERT (sizeof(HubMsOsCustomProperty)==10)

static BOOLEAN NTAPI	HubMsOsVersionAllowed (_In_ HubChild *Child)

static BOOLEAN NTAPI	HubHasMsOs20SetInfo (_In_ HubChild *Child)

static const HubMsOsExtPropHeader *NTAPI	HubExtPropHeader (_In_ HubChild *Child)

	_IRQL_requires_ (PASSIVE_LEVEL) static NTSTATUS NTAPI HubInstallMsOs20Property(_In_ HubChild *Child
	Sends a synchronous IOCTL to the specified device object.

RtlCopyMemory &	DataLength (DataLength)

	while (ValueName.Length< Property->wPropertyNameLength &&ValueName.Buffer[ValueName.Length/sizeof(WCHAR)] !=UNICODE_NULL)

return	HubWriteDeviceValue (Child, &ValueName, Property->wPropertyDataType, DataLength,(PVOID)(Tail+sizeof(DataLength)))

static BOOLEAN NTAPI	HubCustomPropertyValid (_In_reads_bytes_(Total) const UCHAR *Buffer, _In_ ULONG Total, _In_ ULONG Offset, _Out_ PULONG Size)

Variables
_In_ const HubMsOs20Registry *	Property

const UCHAR *	Tail = Name + Property->wPropertyNameLength

UNICODE_STRING	ValueName

USHORT	DataLength

ValueName	Buffer = (PWCHAR)Name

ValueName	Length = 0

ValueName	MaximumLength = ValueName.Length

Macro Definition Documentation

◆ MSOS20_TYPE_REGISTRY_PROPERTY

#define MSOS20_TYPE_REGISTRY_PROPERTY 4

Definition at line 23 of file hubmsos.cpp.

◆ MSOS_CUSTOM_PROPERTY_FIXED

#define MSOS_CUSTOM_PROPERTY_FIXED (sizeof(HubMsOsCustomProperty) + sizeof(ULONG))

Definition at line 50 of file hubmsos.cpp.

◆ MSOS_EXT_PROPERTIES_INDEX

#define MSOS_EXT_PROPERTIES_INDEX 5

Definition at line 18 of file hubmsos.cpp.

◆ MSOS_EXT_PROPERTIES_MAX

#define MSOS_EXT_PROPERTIES_MAX 4096

Definition at line 20 of file hubmsos.cpp.

◆ MSOS_EXT_PROPERTIES_VERSION

#define MSOS_EXT_PROPERTIES_VERSION 0x0100

Definition at line 19 of file hubmsos.cpp.

◆ MSOS_FLAG_CONTAINER_ID

#define MSOS_FLAG_CONTAINER_ID 0x02

Definition at line 15 of file hubmsos.cpp.

◆ NDEBUG

#define NDEBUG

Definition at line 11 of file hubmsos.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.

Definition at line 2121 of file class.c.

{
    NTSTATUS status = STATUS_SUCCESS;
 
    PAGED_CODE();
 
    TracePrint((TRACE_LEVEL_VERBOSE,
                TRACE_FLAG_PNP,
                "ClassDetermineTokenOperationCommandSupport (%p): Entering function.\n",
                DeviceObject));
 
    //
    // Send down Inquiry for VPD_THIRD_PARTY_COPY_PAGE and cache away the device parameters
    // from WINDOWS_BLOCK_DEVICE_TOKEN_LIMITS_DESCRIPTOR.
    //
    status = ClasspGetBlockDeviceTokenLimitsInfo(DeviceObject);
 
    if (NT_SUCCESS(status)) {
 
        ULONG maxListIdentifier = MaxTokenOperationListIdentifier;
 
        //
        // Query the maximum list identifier to use for TokenOperation commands.
        //
        if (NT_SUCCESS(ClasspGetMaximumTokenListIdentifier(DeviceObject, REG_DISK_CLASS_CONTROL, &maxListIdentifier))) {
            if (maxListIdentifier >= MIN_TOKEN_LIST_IDENTIFIERS) {
 
                NT_ASSERT(maxListIdentifier <= MAX_TOKEN_LIST_IDENTIFIERS);
                MaxTokenOperationListIdentifier = maxListIdentifier;
            }
        }
 
    }
 
    TracePrint((TRACE_LEVEL_VERBOSE,
                TRACE_FLAG_PNP,
                "ClassDetermineTokenOperationCommandSupport (%p): Exiting function with status %x.\n",
                DeviceObject,
                status));
 
    return status;
}

◆ C_ASSERT() [1/2]

C_ASSERT ( sizeof(HubMsOsCustomProperty) = =10 )

◆ C_ASSERT() [2/2]

C_ASSERT ( sizeof(HubMsOsExtPropHeader) = =10 )

◆ DataLength()

RtlCopyMemory & DataLength ( DataLength )

◆ HubCustomPropertyValid()

static BOOLEAN NTAPI HubCustomPropertyValid	(	_In_reads_bytes_(Total) const UCHAR *	Buffer,
		_In_ ULONG	Total,
		_In_ ULONG	Offset,
		_Out_ PULONG	Size
	)

static

Definition at line 433 of file hubmsos.cpp.

{
    const HubMsOsCustomProperty* Property = (const HubMsOsCustomProperty*)(Buffer + Offset);
    ULONG Remaining = Total - Offset;
    ULONG NameLength;
    ULONG DataLength;
    const WCHAR* Name;
 
    if (Remaining < MSOS_CUSTOM_PROPERTY_FIXED)
        return FALSE;
 
    *Size = Property->dwSize;
    if (*Size > Remaining || *Size < MSOS_CUSTOM_PROPERTY_FIXED)
        return FALSE;
 
    if (Property->dwPropertyDataType < REG_SZ || Property->dwPropertyDataType > REG_MULTI_SZ)
        return FALSE;
 
    NameLength = Property->wPropertyNameLength;
    if (NameLength == 0 || (NameLength & 1) || NameLength > *Size - MSOS_CUSTOM_PROPERTY_FIXED)
        return FALSE;
 
    Name = (const WCHAR*)(Property + 1);
    if (Name[0] == UNICODE_NULL || Name[NameLength / sizeof(WCHAR) - 1] != UNICODE_NULL)
        return FALSE;
 
    RtlCopyMemory(&DataLength, (const UCHAR*)Name + NameLength, sizeof(DataLength));
 
    return DataLength <= *Size - MSOS_CUSTOM_PROPERTY_FIXED - NameLength;
}

Referenced by DeviceMachine::ExtPropertiesValid().

◆ HubExtPropHeader()

static const HubMsOsExtPropHeader *NTAPI HubExtPropHeader ( _In_ HubChild * Child )

static

Definition at line 76 of file hubmsos.cpp.

{
    return (const HubMsOsExtPropHeader*)Child->m_ScratchBuffer;
}

Referenced by DeviceMachine::AllocateExtPropertiesBuffer(), DeviceMachine::ExtPropertiesHeaderValid(), and DeviceMachine::ExtPropertiesValid().

◆ HubHasMsOs20SetInfo()

static BOOLEAN NTAPI HubHasMsOs20SetInfo ( _In_ HubChild * Child )

static

Definition at line 67 of file hubmsos.cpp.

{
    return (Child->m_MsOs20.Flags & HUB_MSOS20_SET_INFO) != 0;
}

Referenced by DeviceMachine::ContainerIdWanted(), DeviceMachine::ExtPropertiesWanted(), DeviceMachine::MsOs20Supported(), DeviceMachine::MsOsExtendedConfigSupported(), and DeviceMachine::MsOsQueryWanted().

◆ HubMsOsVersionAllowed()

static BOOLEAN NTAPI HubMsOsVersionAllowed ( _In_ HubChild * Child )

static

Definition at line 56 of file hubmsos.cpp.

{
    USHORT BcdUsb = Child->m_DeviceDescriptor.bcdUSB;
 
    return BcdUsb >= 0x0200 || BcdUsb < 0x0100;
}

Referenced by DeviceMachine::ContainerIdWanted(), DeviceMachine::MsOsExtendedConfigSupported(), and DeviceMachine::MsOsQueryWanted().

◆ HubWriteDeviceValue()

return HubWriteDeviceValue	(	Child	,
		&	ValueName,
		Property->	wPropertyDataType,
		DataLength	,
		(PVOID)(Tail+sizeof(DataLength))
	)

Referenced by DeviceMachine::SetExtPropertiesSemaphore(), and DeviceMachine::WriteCustomProperties().

◆ while()

while ( ValueName.Length< Property->wPropertyNameLength &&ValueName.Buffer ! [ValueName.Length/sizeof(WCHAR)] = UNICODE_NULL )

Definition at line 154 of file hubmsos.cpp.

    {
        ValueName.Length += sizeof(WCHAR);
    }

Variable Documentation

◆ Buffer

ValueName Buffer = (PWCHAR)Name

Definition at line 152 of file hubmsos.cpp.

◆ DataLength

USHORT DataLength

Definition at line 147 of file hubmsos.cpp.

Referenced by HubCustomPropertyValid().

◆ Length

ValueName Length = 0

Definition at line 153 of file hubmsos.cpp.

◆ MaximumLength

ValueName MaximumLength = ValueName.Length

Definition at line 159 of file hubmsos.cpp.

◆ Property

_In_ const HubMsOs20Registry* Property

Initial value:

{

const UCHAR* Name = (const UCHAR*)(Property + 1)

Definition at line 142 of file hubmsos.cpp.

◆ Tail

const UCHAR* Tail = Name + Property->wPropertyNameLength

Definition at line 145 of file hubmsos.cpp.

Referenced by AfdCancelHandler(), AfdCleanupSocket(), AfdDisconnect(), AtaDeviceFlushPowerIrpQueue(), AtaPortDeviceProcessPowerChange(), BeepCleanup(), CaptureAvoidPipeStarvationWorker(), ClasspDequeueIdleRequest(), ClasspRetryRequestDpc(), ClassRemoveCScanList(), ConvertLargeMCBToDataRuns(), CsqPeekNextIrp(), DECLSPEC_ALIGN(), DequeueDeferredClientIrp(), DisconnectComplete(), DiskFlushComplete(), Ext2FirstUnusedMcb(), FDO_HandleResetCyclePort(), FltpGetNextMessageWaiter(), FreeBT_DispatchClean(), FsRtlCancelNotify(), FsRtlCancelOplockIIIrp(), FsRtlNotifyCompleteIrpList(), FsRtlNotifyFilterReportChange(), FsRtlOplockBreakToNone(), FsRtlOplockCleanup(), FsRtlRequestExclusiveOplock(), FsRtlUninitializeOplock(), HidClass_Close(), HidClass_GetIrp(), IoGetNextIrpStackLocation(), IopAbortIrpKernelApc(), IopCompleteRequest(), IopDeleteIoCompletion(), IopFreeIrpKernelApc(), IopStartNextPacket(), IopStartNextPacketByKey(), KsCancelIo(), KsMoveIrpsOnCancelableQueue(), KspCompletePendingIrps(), KsRemoveIrpFromCancelableQueue(), LanCloseProtocol(), XhciIsochRing::LayoutStage(), ListenComplete(), LockPeekNextIrp(), MkFinalize(), MkIndxFixup(), MountMgrCleanup(), MountMgrNotify(), MsfsPeekNextIrp(), NpCancelWaiter(), NpCheckForNotify(), NpCompleteDeferredIrps(), NpSetClosingPipeState(), NpSetConnectedPipeState(), NpSetDisconnectedPipeState(), NtRemoveIoCompletion(), PacketSocketRecvComplete(), PacketSocketSendComplete(), PinCaptureProcess(), PinGetIrpFromReadyList(), PortStarvedCsqPeekNextIrp(), ProcessQueuedRequests(), ProtocolTransferDataComplete(), ReceiveActivity(), ReceiveComplete(), RemoveHeadList_IRP(), RtlExpandEnvironmentStrings(), ScsiPortDispatchScsi(), SendComplete(), SpiGetNextRequestFromLun(), StartCaptureIsocTransfer(), StreamSocketConnectComplete(), StreamSocketConnectSendComplete(), USBPORT_FlushAbortList(), USBPORT_PeekNextBadRequest(), USBPORT_PeekNextIdleIrp(), USBSTOR_RemoveIrp(), VfdDeviceThread(), and DeviceMachine::WriteCustomProperties().

◆ ValueName

UNICODE_STRING ValueName

Definition at line 146 of file hubmsos.cpp.

Classes

Macros

Functions

Variables

Macro Definition Documentation

◆ MSOS20_TYPE_REGISTRY_PROPERTY

◆ MSOS_CUSTOM_PROPERTY_FIXED

◆ MSOS_EXT_PROPERTIES_INDEX

◆ MSOS_EXT_PROPERTIES_MAX

◆ MSOS_EXT_PROPERTIES_VERSION

◆ MSOS_FLAG_CONTAINER_ID

◆ NDEBUG

Function Documentation

◆ _IRQL_requires_()

◆ C_ASSERT() [1/2]

◆ C_ASSERT() [2/2]

◆ DataLength()

◆ HubCustomPropertyValid()

◆ HubExtPropHeader()

◆ HubHasMsOs20SetInfo()

◆ HubMsOsVersionAllowed()

◆ HubWriteDeviceValue()

◆ while()

Variable Documentation

◆ Buffer

◆ DataLength

◆ Length

◆ MaximumLength

◆ Property

◆ Tail

◆ ValueName