bootdev.cpp File Reference

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

Include dependency graph for bootdev.cpp:

Go to the source code of this file.

Classes
struct	HubBootRegistration

Macros
#define	NDEBUG
#define	HUB_BOOT_REGISTRATION_VERSION   1

Typedefs
typedef BOOLEAN(NTAPI *	PFN_HUB_BOOT_DEVICE_READY) (_In_ PDEVICE_OBJECT Pdo, _In_ PVOID Context)

Functions
	C_ASSERT (sizeof(HubBootRegistration)==0x18)
	_IRQL_requires_ (PASSIVE_LEVEL) static BOOLEAN NTAPI HubBootIsExternal(_In_ WDFDEVICE Device)
	Sends a synchronous IOCTL to the specified device object.
static VOID NTAPI	HubBootRecoveryWorkItem (_In_ WDFWORKITEM WorkItem)
	_IRQL_requires_max_ (DISPATCH_LEVEL) static VOID NTAPI HubBootAfterRecovery(_In_ HubChild *Child)
	UNREFERENCED_PARAMETER (Pdo)
	PAGED_CODE ()
	if (Child->m_Hub->IsHubResetInProgress())
	if (!NT_SUCCESS(ReadStatus))
	if (Child->HasState(ChildState::DifferentDeviceOnBootPort) &&!(Change &PC_CONNECT))
	if (Port->m_ConnectionStatus==DeviceFailedEnumeration)
	if (Status &PS_CONNECTED)
	if ((Child->m_Kind &DSM_KIND_SUPER_SPEED) &&HubLinkState(Status)==LINK_SS_INACTIVE)
Port	ClearFlag (PortFlag::SsInactiveSeenForBoot)
	DPRINT ("Boot device on port %u still missing, status 0x%lx\n", Port->Number(), PortStatus)
	if (Pdo->HasFlag(PdoFlag::InBootPath)) return STATUS_SUCCESS
	if (Child->m_BootControl.Request==NULL)
	if (!Child->m_Port->HasFlag(PortFlag::DeviceConnected))
	if (!WinPe)
	DPRINT ("Port %u device is now in the boot path\n", Pdo->m_PortNumber)
	DPRINT ("Port %u usage notice %d, in path %u\n", Pdo->m_PortNumber,(int) NotificationType, IsInNotificationPath)
	if (!(Child->m_SqmFlags &(LONG) ChildSqm::HoldsPagingFiles))
	switch (NotificationType)

Variables
_In_ PVOID	Context
HubPort *	Port = Child->m_Port
ULONG	PortStatus = 0
USHORT	Status = (USHORT)(PortStatus & 0xFFFF)
USHORT	Change = (USHORT)(PortStatus >> 16)
NTSTATUS	ReadStatus = HubReadPortStatusForBootDevice(Child, &PortStatus)
BOOLEAN	Ready = FALSE
InterlockedExchange &	Child = Pdo->m_Child
Done	__pad0__
_In_ BOOLEAN	WinPe = HubIsWinPe()
_In_ BOOLEAN _In_ BOOLEAN	External
HubFdo *	Hub = Pdo->m_Hub
Child	m_NeedsForwardProgress = TRUE
return	STATUS_SUCCESS
_In_ WDF_SPECIAL_FILE_TYPE	NotificationType
_In_ WDF_SPECIAL_FILE_TYPE _In_ BOOLEAN	IsInNotificationPath

Macro Definition Documentation

HUB_BOOT_REGISTRATION_VERSION

#define HUB_BOOT_REGISTRATION_VERSION   1

Definition at line 38 of file bootdev.cpp.

NDEBUG

#define NDEBUG

Definition at line 10 of file bootdev.cpp.

Typedef Documentation

PFN_HUB_BOOT_DEVICE_READY

typedef BOOLEAN(NTAPI * PFN_HUB_BOOT_DEVICE_READY) (_In_ PDEVICE_OBJECT Pdo, _In_ PVOID Context)

Definition at line 16 of file bootdev.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.

Definition at line 43 of file bootdev.cpp.

{
    BOOLEAN InMachine = FALSE;
    DEVPROPTYPE Type;
    ULONG Size;
    NTSTATUS Status;
 
    PAGED_CODE();
 
    Status = IoGetDevicePropertyData(WdfDeviceWdmGetDeviceObject(Device),
                                     &DEVPKEY_Device_InLocalMachineContainer,
                                     LOCALE_NEUTRAL,
                                     0,
                                     sizeof(InMachine),
                                     &InMachine,
                                     &Size,
                                     &Type);
    if (!NT_SUCCESS(Status))
    {
        DPRINT("No container answer for %p (0x%lx), treated as external\n", Device, Status);
        return TRUE;
    }
 
    return InMachine == DEVPROP_FALSE;
}

_IRQL_requires_max_()

_IRQL_requires_max_

(

DISPATCH_LEVEL

)

Definition at line 89 of file bootdev.cpp.

{
    WDF_WORKITEM_CONFIG Config;
    WDF_OBJECT_ATTRIBUTES Attributes;
    WDFWORKITEM WorkItem;
    NTSTATUS Status;
 
    if (!Child->m_Port->HasFlag(PortFlag::PendingRecoveryUpdate))
        return;
 
    Child->m_Port->ClearFlag(PortFlag::PendingRecoveryUpdate);
 
    WDF_WORKITEM_CONFIG_INIT(&Config, HubBootRecoveryWorkItem);
    WDF_OBJECT_ATTRIBUTES_INIT(&Attributes);
    Attributes.ParentObject = Child->m_Pdo->m_Device;
 
    Status = WdfWorkItemCreate(&Config, &Attributes, &WorkItem);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Boot recovery work item failed 0x%lx\n", Status);
        return;
    }
 
    WdfWorkItemEnqueue(WorkItem);
}

C_ASSERT()

C_ASSERT

(

sizeof(HubBootRegistration)

= =0x18

)

ClearFlag()

Port ClearFlag

(

PortFlag::SsInactiveSeenForBoot

)

DPRINT() [1/3]

DPRINT	(	"Boot device on port %u still	missing,
		status 0x%lx\n"	,
		Port->	Number(),
		PortStatus
	)

DPRINT() [2/3]

DPRINT	(	"Port %u device is now in the boot path\n"	,
		Pdo->	m_PortNumber
	)

DPRINT() [3/3]

DPRINT	(	"Port %u usage notice %	d,
		in path %u\n"	,
		Pdo->	m_PortNumber,
		(int)	NotificationType,
		IsInNotificationPath
	)

HubBootRecoveryWorkItem()

static VOID NTAPI HubBootRecoveryWorkItem ( _In_ WDFWORKITEM  WorkItem )

static

Definition at line 78 of file bootdev.cpp.

{
    UNREFERENCED_PARAMETER(WorkItem);
 
    DPRINT("Boot device recovered after a surprise removal\n");
    HubWmiNotifyBootSurpriseRemoval();
    HubBumpBootSurpriseRemovalCount();
}

Referenced by _IRQL_requires_max_().

if() [1/11]

if

(

!

Child->m_SqmFlags &(LONG) ChildSqm::HoldsPagingFiles

)

Definition at line 331 of file bootdev.cpp.

    {
        InterlockedOr(&Child->m_SqmFlags, (LONG)ChildSqm::HoldsPagingFiles);
        HubFlushSqmFlags(Child);
    }

if() [2/11]

if

(

!Child->m_Port->

HasFlagPortFlag::DeviceConnected

)

Definition at line 279 of file bootdev.cpp.

    {
        DPRINT1("Boot device on port %u left before its usage notice\n", Pdo->m_PortNumber);
        return STATUS_NO_SUCH_DEVICE;
    }

if() [3/11]

if

(

!

NT_SUCCESSReadStatus

)

Definition at line 153 of file bootdev.cpp.

    {
        DPRINT1("Boot device port %u status read failed 0x%lx\n", Port->Number(), ReadStatus);
        goto Done;
    }

if() [4/11]

if

(

!

WinPe

)

Definition at line 285 of file bootdev.cpp.

    {
        /* Internal devices are not registered; saves memory where SATA was replaced by USB */
        if (External)
        {
            Status = HubBootRegister(Child);
            if (!NT_SUCCESS(Status))
                DPRINT1("Boot device registration failed 0x%lx\n", Status);
 
            if (!Child->HasProperty(ChildProperty::IsHub))
                HubWmiRegisterBootSurpriseRemoval(Pdo->m_Device);
        }
        else
        {
            DPRINT1("Boot device on port %u is internal, not registered\n", Pdo->m_PortNumber);
        }
 
        Pdo->SetFlag(PdoFlag::InBootPath);
        Child->m_Port->SetFlag(PortFlag::SupportsReattach);
    }

if() [5/11]

if

(

(Child->m_Kind &DSM_KIND_SUPER_SPEED) &&HubLinkState(Status)

= = LINK_SS_INACTIVE

)

Definition at line 182 of file bootdev.cpp.

    {
        if (Port->HasFlag(PortFlag::SsInactiveSeenForBoot))
        {
            DPRINT("Boot port %u stayed in SS.Inactive, device counted present\n", Port->Number());
            Ready = TRUE;
            goto Done;
        }
 
        DPRINT("Boot port %u in SS.Inactive for the first time\n", Port->Number());
        Port->SetFlag(PortFlag::SsInactiveSeenForBoot);
        goto Done;
    }

if() [6/11]

if

(

Child->

HasStateChildState::DifferentDeviceOnBootPort) &&!(Change &PC_CONNECT

)

Definition at line 162 of file bootdev.cpp.

    {
        DPRINT("Boot port %u still holds a different device\n", Port->Number());
        goto Done;
    }

if() [7/11]

if

(

Child->m_BootControl.

Request = = NULL

)

Definition at line 269 of file bootdev.cpp.

    {
        Status = Child->m_BootControl.Create(Child->m_Object, WdfDeviceGetIoTarget(Hub->m_Device));
        if (!NT_SUCCESS(Status))
        {
            DPRINT1("Boot request on port %u not created 0x%lx\n", Pdo->m_PortNumber, Status);
            return Status;
        }
    }

if() [8/11]

if

(

Child->m_Hub->

IsHubResetInProgress()

)

Definition at line 142 of file bootdev.cpp.

    {
        DPRINT("Boot device on port %u counted present during a hub reset\n", Port->Number());
        Ready = TRUE;
        goto Done;
    }

if() [9/11]

if

(

Pdo->

HasFlagPdoFlag::InBootPath

)

if() [10/11]

if

(

Port->

m_ConnectionStatus = = DeviceFailedEnumeration

)

Definition at line 168 of file bootdev.cpp.

    {
        DPRINT("Boot device on port %u failed its last enumeration\n", Port->Number());
        goto Done;
    }

if() [11/11]

if

(

Status &

PS_CONNECTED

)

Definition at line 174 of file bootdev.cpp.

    {
        DPRINT("Boot device on port %u is connected\n", Port->Number());
        Ready = TRUE;
        goto Done;
    }

PAGED_CODE()

PAGED_CODE

(

)

Referenced by _IRQL_requires_().

switch()

switch

(

NotificationType

)

Definition at line 337 of file bootdev.cpp.

    {
        /* Paging on an external disk that is not the boot disk is refused */
        case WdfSpecialFilePaging:
            if (!WinPe)
            {
                External = HubBootIsExternal(Device);
                if (External)
                {
                    if (Pdo->HasFlag(PdoFlag::InBootPath))
                        return STATUS_SUCCESS;
 
                    DPRINT1("Paging refused on external port %u device\n", Pdo->m_PortNumber);
                    return STATUS_NOT_SUPPORTED;
                }
            }
            return HubBootAddToPath(Pdo, WinPe, External);
 
        case WdfSpecialFileBoot:
            if (!WinPe && !Pdo->HasFlag(PdoFlag::InBootPath))
                External = HubBootIsExternal(Device);
            return HubBootAddToPath(Pdo, WinPe, External);
 
        case WdfSpecialFileHibernation:
            if (IsInNotificationPath)
                Child->m_NeedsForwardProgress = TRUE;
            return STATUS_SUCCESS;
 
        default:
            return STATUS_SUCCESS;
    }

UNREFERENCED_PARAMETER()

UNREFERENCED_PARAMETER

(

Pdo

)

Variable Documentation

__pad0__

Done __pad0__

Definition at line 199 of file bootdev.cpp.

Change

Change = (USHORT)(PortStatus >> 16)

Definition at line 133 of file bootdev.cpp.

Referenced by AdjustHandleCounts(), PortMachine::ConnectChangedOnResume(), PortMachine::DetachThen(), PortMachine::DetachTimed(), PortMachine::ErrorResponseDuringReset(), XhciRootHub::GetPortStatus(), HubUsb4InterfaceChange(), IntMapWindowPoints(), PortMachine::LostChange(), MapWindowPoints(), PortMachine::NextChange(), PortMachine::PendingChange(), PortNextChange20(), PortNextChange30(), PortReportChange(), PortMachine::ReadPortBits(), and User32DefWindowProc().

Child

HubChild* Child = Pdo->m_Child

Definition at line 149 of file bootdev.cpp.

Context

_In_ PVOID Context

Initial value:

{
    HubChild* Child = (HubChild*)Context

Definition at line 127 of file bootdev.cpp.

External

BOOLEAN External

Initial value:

{
    HubChild* Child = Pdo->m_Child

Definition at line 258 of file bootdev.cpp.

Referenced by CmpInitializeHive(), if(), and switch().

Hub

HubFdo * Hub = Pdo->m_Hub

Definition at line 261 of file bootdev.cpp.

Referenced by _IRQL_requires_(), _IRQL_requires_max_(), UcxController::Address0Release(), XhciUsbDevice::BuildAddressContext(), XhciUsbDevice::BuildSlotContext(), DeviceMachine::ComputeExitLatency(), HubChild::Create(), DeviceMachine::CreateDefaultEndpoint(), DeviceMachine::CreateDeviceInController(), DeviceMachine::CreateEndpoints(), UcxUsbDevice::CreateFromHub(), DeviceMachine::DeleteDefaultEndpoint(), DeviceMachine::DeleteDeviceInController(), PortMachine::DisconnectDevice(), for(), HubAcpiAllocate(), HubAddPort(), HubBuildDescContext(), HubCheckUsb2HubDescriptor(), HubCheckUsb3HubDescriptor(), HubClearTtBuffer(), HubConfigurationComplete(), HubConnectorCopyParentId(), HubConnectorSetRootId(), HubControlComplete(), HubCreateParentRequest(), HubCreateUcxRequest(), HubEvtIoDeviceControl(), HubEvtIoInternalDeviceControl(), HubEvtOverCurrentWorkItem(), HubFindHubInterface(), HubInterruptComplete(), HubIoBuild20Descriptor(), HubIoctlComplete(), HubIoCyclePort(), HubIoForward(), HubIoGetConnectionAttributes(), HubIoGetConnectionInformation(), HubIoGetConnectionInformationV2(), HubIoGetConnectionName(), HubIoGetConnectorProperties(), HubIoGetDescriptor(), HubIoGetDriverKeyName(), HubIoGetHubCapabilities(), HubIoGetHubInformationEx(), HubIoGetNodeInformation(), HubIoGetPortStatus(), HubIoLockChild(), HubIoPrepare(), HubIoResetHub(), HubIoUnlockChildren(), HubIoValidate(), HubLogConfigTotalLengthMismatch(), HubMailboxComplete(), HubMailboxTransfer(), HubMakeUsb2StyleDescriptor(), HubParentInfoComplete(), HubPipeResetComplete(), PortMachine::HubPowerTake(), HubResetComplete(), HubRootHubInfoComplete(), HubSendControl(), HubSendToParent(), HubSendUcxIoctl(), HubTakePortStatusRequest(), HubTtClearComplete(), HubUsb4AddPowerRelation(), HubUsb4FindHost(), HubUsb4HostAt(), HubUsb4InterfaceChange(), HubUsb4InvalidatePowerRelations(), HubUsb4OpenWorkItem(), HubUsb4RemovePowerRelation(), HubUsb4TargetRemoveComplete(), HubValidateHubConfiguration(), HubWmiExecuteMethod(), HubWmiFirePortEvent(), HubWmiHubName(), HubWmiHubNameRequest(), HubWmiNotifyOverCurrent(), HubWmiQueryDeviceNode(), HubWmiQueryHubNode(), HubWmiResetOverCurrent(), if(), PortNextChange30(), PortSendControl(), PortTrackPendingOperation(), DeviceMachine::ReleaseAddressZero(), DeviceMachine::SelectConfigValid(), DeviceMachine::SetIsochDelay(), DeviceMachine::SetSel(), UcxBuildPortPath(), UcxEvtQueryStackInterface(), UcxHubAddress0Release(), UcxHubAllowControllerIdle(), UcxHubBlockControllerIdle(), UcxHubClearTtBufferComplete(), UcxHubCreateControlEndpoint(), UcxHubDeviceCreate(), UcxHubDeviceDelete(), UcxHubDeviceDisconnect(), UcxHubDeviceSetPdo(), UcxHubEndpointCreate(), UcxHubEndpointDelete(), UcxHubEndpointSetPriority(), UcxHubQueryControllerBus(), UcxHubStreamsSupported(), and UcxHubWorkItemAllocate().

IsInNotificationPath

_In_ WDF_SPECIAL_FILE_TYPE _In_ BOOLEAN IsInNotificationPath

Initial value:

{
    HubPdo* Pdo = HubGetPdoContext(Device)

Definition at line 318 of file bootdev.cpp.

m_NeedsForwardProgress

Child m_NeedsForwardProgress = TRUE

Definition at line 307 of file bootdev.cpp.

NotificationType

_In_ WDF_SPECIAL_FILE_TYPE NotificationType

Definition at line 317 of file bootdev.cpp.

Port

HubPort* Port = Child->m_Port

Definition at line 130 of file bootdev.cpp.

Referenced by if().

PortStatus

_Outptr_ PUSB_DEVICE_HANDLE _In_ PUSB_DEVICE_HANDLE _In_ USHORT PortStatus = 0

Definition at line 131 of file bootdev.cpp.

Referenced by EHCI_RH_GetPortStatus(), FreeBT_GetPortStatus(), FxUsbDevice::GetPortStatus(), HidUsb_GetPortStatus(), HidUsb_ResetWorkerRoutine(), HubPdoDispatchIoctl(), i8042KbdInterruptService(), i8042MouInterruptService(), i8042ReadData(), OHCI_ResetController(), OHCI_RH_ClearFeaturePortConnectChange(), OHCI_RH_ClearFeaturePortEnable(), OHCI_RH_ClearFeaturePortEnableChange(), OHCI_RH_ClearFeaturePortOvercurrentChange(), OHCI_RH_ClearFeaturePortPower(), OHCI_RH_ClearFeaturePortResetChange(), OHCI_RH_ClearFeaturePortSuspend(), OHCI_RH_ClearFeaturePortSuspendChange(), OHCI_RH_GetPortStatus(), OHCI_RH_SetFeaturePortEnable(), OHCI_RH_SetFeaturePortPower(), OHCI_RH_SetFeaturePortReset(), OHCI_RH_SetFeaturePortSuspend(), PdoWrite(), UhciRHGetPortStatus(), USBH_ChangeIndicationWorker(), USBH_GetPortStatus(), USBH_PdoIoctlGetPortStatus(), USBH_ProcessPortStateChange(), USBH_ResetDevice(), USBH_SyncGetPortStatus(), USBH_SyncPowerOnPort(), USBH_SyncResetPort(), USBHI_CreateUsbDevice(), USBHI_GetExtendedHubInformation(), USBPORT_CreateDevice(), and USBPORT_RootHubSCE().

ReadStatus

ReadStatus = HubReadPortStatusForBootDevice(Child, &PortStatus)

Definition at line 134 of file bootdev.cpp.

Referenced by if(), MiSimpleRead(), HubMachine::OnAwaitingOverCurrentTimer(), HubMachine::OnDevicesAcquiring(), HubMachine::OnListening(), HubMachine::OnPortsAcquiring(), PeekByte(), PitLatchChannelCount(), and PitReadData().

Ready

BOOLEAN Ready = FALSE

Definition at line 135 of file bootdev.cpp.

Referenced by _Requires_lock_held_(), if(), KiDeferredReadyThread(), and KiSetPriorityThread().

Status

NTSTATUS Status = (USHORT)(PortStatus & 0xFFFF)

Definition at line 132 of file bootdev.cpp.

Referenced by _IRQL_requires_(), _IRQL_requires_max_(), and if().

STATUS_SUCCESS

return STATUS_SUCCESS

Definition at line 309 of file bootdev.cpp.

Referenced by switch().

WinPe

BOOLEAN WinPe = HubIsWinPe()

Definition at line 257 of file bootdev.cpp.

Referenced by switch().