devreq.cpp File Reference

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

Include dependency graph for devreq.cpp:

Go to the source code of this file.

Macros
#define	NDEBUG
#define	XFER_STD_TO_DEVICE   0x00
#define	XFER_STD_TO_INTERFACE   0x01
#define	XFER_STD_TO_ENDPOINT   0x02
#define	XFER_STD_FROM_DEVICE   0x80
#define	XFER_VENDOR_TO_DEVICE   0x40
#define	XFER_VENDOR_FROM_DEVICE   0xC0
#define	XFER_VENDOR_FROM_INTERFACE   0xC1
#define	XFER_CLASS_FROM_PORT   0xA3
#define	XFER_TYPE(RequestType)   (((RequestType) >> 5) & 3)
#define	XFER_TYPE_STANDARD   0
#define	XFER_TYPE_VENDOR   2
#define	XFER_HEADER_READ   255
#define	XFER_EXT_PROPERTIES_HEADER   10
#define	XFER_SERIAL_LANGUAGE   0x0409
#define	XFER_FUNCTION_SUSPEND_WAKE   0x0300
#define	XFER_LOW_POWER_PORT   100

Functions
	C_ASSERT (sizeof(((HubChild *) 0) ->m_Sel)==6)
	C_ASSERT (sizeof(((HubChild *) 0) ->m_Qualifier)==10)
static VOID NTAPI	HubDeviceStringFailed (_In_ HubChild *Child, _In_ UCHAR Index)
static BOOLEAN NTAPI	HubDeviceFailureExpected (_In_ UCHAR Type, _In_ UCHAR Request, _In_ USHORT Value, _In_ USHORT Index)
static DsmEvent NTAPI	HubDeviceTransferFailed (_In_ HubChild *Child, _In_ NTSTATUS Status)
static VOID NTAPI	HubDeviceControlComplete (_In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS Params, _In_ WDFCONTEXT Context)
BOOLEAN NTAPI	HubDeviceSend (_In_ HubChild *Child, _In_reads_bytes_opt_(Length) PVOID Buffer, _In_ ULONG Length, _In_ BOOLEAN ShortTransferOk)
static BOOLEAN NTAPI	HubDeviceTrySend (_In_ HubChild *Child, _In_ UCHAR RequestType, _In_ UCHAR Request, _In_ USHORT Value, _In_ USHORT Index, _In_reads_bytes_opt_(Length) PVOID Buffer, _In_ ULONG Length, _In_ BOOLEAN ShortTransferOk)
static BOOLEAN NTAPI	HubDeviceRequest (_In_ HubChild *Child, _In_ UCHAR RequestType, _In_ UCHAR Request, _In_ USHORT Value, _In_ USHORT Index, _In_reads_bytes_opt_(Length) PVOID Buffer, _In_ ULONG Length, _In_ BOOLEAN ShortTransferOk)
static VOID NTAPI	HubDeviceGetDescriptor (_In_ HubChild *Child, _In_ UCHAR Type, _In_ UCHAR Index, _In_ USHORT LanguageId, _Out_writes_bytes_(Length) PVOID Buffer, _In_ ULONG Length)
static VOID NTAPI	HubDeviceGetString (_In_ HubChild *Child, _In_ UCHAR Index, _In_ USHORT LanguageId)
static VOID NTAPI	HubDeviceMsOsRead (_In_ HubChild *Child, _In_ UCHAR RequestType, _In_ USHORT Index, _Out_writes_bytes_(Length) PVOID Buffer, _In_ ULONG Length)
static VOID NTAPI	HubDeviceFeature (_In_ HubChild *Child, _In_ BOOLEAN Set, _In_ USHORT Feature)
static VOID NTAPI	HubFreeDevicePool (_Inout_ PVOID *Buffer)
HubPipe *NTAPI	HubFindPipeByHandle (_In_opt_ HubConfiguration *Config, _In_ USBD_PIPE_HANDLE Handle)
static USHORT NTAPI	HubSelPathLatency (_In_ USHORT DeviceLatency, _In_ USHORT UpstreamLatency, _In_ USHORT SlowestLatency, _In_ UCHAR SlowestDepth, _In_ LONG Depth, _Out_ PUSHORT Link, _Inout_ PBOOLEAN Slowest)
static VOID NTAPI	HubFdoDescriptorComplete (_In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS Params, _In_ WDFCONTEXT Context)
static VOID NTAPI	HubBootStatusComplete (_In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS Params, _In_ WDFCONTEXT Context)
	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS NTAPI HubReadPortStatusForBootDevice(_In_ HubChild *Child
	Sends a synchronous IOCTL to the specified device object.
	PAGED_CODE ()
	if (Control->Request==NULL)
Control	SetSetup (XFER_CLASS_FROM_PORT, HUB_REQUEST_GET_STATUS, 0, Child->m_Port->Number(), sizeof(*PortStatus))
	if (!NT_SUCCESS(Status))
Child m_Port	Number ()

Variables
static EVT_WDF_REQUEST_COMPLETION_ROUTINE	HubDeviceControlComplete
static EVT_WDF_REQUEST_COMPLETION_ROUTINE	HubFdoDescriptorComplete
static EVT_WDF_REQUEST_COMPLETION_ROUTINE	HubBootStatusComplete
_Out_ PULONG	PortStatus
HubControlRequest *	Control = &Child->m_BootControl
KEVENT	Done
NTSTATUS	Status
	else

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 11 of file devreq.cpp.

XFER_CLASS_FROM_PORT

#define XFER_CLASS_FROM_PORT   0xA3

Definition at line 22 of file devreq.cpp.

XFER_EXT_PROPERTIES_HEADER

#define XFER_EXT_PROPERTIES_HEADER   10

Definition at line 33 of file devreq.cpp.

XFER_FUNCTION_SUSPEND_WAKE

#define XFER_FUNCTION_SUSPEND_WAKE   0x0300

Definition at line 39 of file devreq.cpp.

XFER_HEADER_READ

#define XFER_HEADER_READ   255

Definition at line 30 of file devreq.cpp.

XFER_LOW_POWER_PORT

#define XFER_LOW_POWER_PORT   100

Definition at line 42 of file devreq.cpp.

XFER_SERIAL_LANGUAGE

#define XFER_SERIAL_LANGUAGE   0x0409

Definition at line 36 of file devreq.cpp.

XFER_STD_FROM_DEVICE

#define XFER_STD_FROM_DEVICE   0x80

Definition at line 18 of file devreq.cpp.

XFER_STD_TO_DEVICE

#define XFER_STD_TO_DEVICE   0x00

Definition at line 15 of file devreq.cpp.

XFER_STD_TO_ENDPOINT

#define XFER_STD_TO_ENDPOINT   0x02

Definition at line 17 of file devreq.cpp.

XFER_STD_TO_INTERFACE

#define XFER_STD_TO_INTERFACE   0x01

Definition at line 16 of file devreq.cpp.

XFER_TYPE

#define XFER_TYPE

(

RequestType

)

(((RequestType) >> 5) & 3)

Definition at line 25 of file devreq.cpp.

XFER_TYPE_STANDARD

#define XFER_TYPE_STANDARD   0

Definition at line 26 of file devreq.cpp.

XFER_TYPE_VENDOR

#define XFER_TYPE_VENDOR   2

Definition at line 27 of file devreq.cpp.

XFER_VENDOR_FROM_DEVICE

#define XFER_VENDOR_FROM_DEVICE   0xC0

Definition at line 20 of file devreq.cpp.

XFER_VENDOR_FROM_INTERFACE

#define XFER_VENDOR_FROM_INTERFACE   0xC1

Definition at line 21 of file devreq.cpp.

XFER_VENDOR_TO_DEVICE

#define XFER_VENDOR_TO_DEVICE   0x40

Definition at line 19 of file devreq.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.

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(((HubChild *) 0) ->m_Qualifier)

= =10

)

C_ASSERT() [2/2]

C_ASSERT

(

sizeof(((HubChild *) 0) ->m_Sel)

= =6

)

HubBootStatusComplete()

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

static

Definition at line 1136 of file devreq.cpp.

{
    UNREFERENCED_PARAMETER(Request);
    UNREFERENCED_PARAMETER(Target);
    UNREFERENCED_PARAMETER(Params);
 
    KeSetEvent((PKEVENT)Context, IO_NO_INCREMENT, FALSE);
}

HubDeviceControlComplete()

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

static

Definition at line 236 of file devreq.cpp.

{
    HubChild* Child = (HubChild*)Context;
    NTSTATUS Status = Params->IoStatus.Status;
    DsmEvent Event = DsmEvent::TransferDone;
 
    UNREFERENCED_PARAMETER(Request);
    UNREFERENCED_PARAMETER(Target);
 
    Child->m_Control.UsbdFlags = 0;
 
    if (!NT_SUCCESS(Status))
        Event = HubDeviceTransferFailed(Child, Status);
 
    Child->m_Control.Reuse();
    Child->Post(Event);
}

HubDeviceFailureExpected()

static BOOLEAN NTAPI HubDeviceFailureExpected ( _In_ UCHAR  Type, _In_ UCHAR  Request, _In_ USHORT  Value, _In_ USHORT  Index  )

static

Requests a device may refuse without anything being wrong with it.

Definition at line 105 of file devreq.cpp.

{
    if (Type != XFER_TYPE_STANDARD)
        return FALSE;
 
    if (Request == USB_REQUEST_CLEAR_FEATURE && Value == USB_FEATURE_REMOTE_WAKEUP)
        return TRUE;
 
    if (Request == USB_REQUEST_SET_FEATURE && Value == USB_FEATURE_FUNCTION_SUSPEND && Index == 0)
        return TRUE;
 
    if (Request != USB_REQUEST_GET_DESCRIPTOR)
        return FALSE;
 
    return Value == ((USB_STRING_DESCRIPTOR_TYPE << 8) | HUB_MSOS_STRING_INDEX) ||
           (Value >> 8) == USB_DEVICE_QUALIFIER_DESCRIPTOR_TYPE;
}

Referenced by HubDeviceTransferFailed().

HubDeviceFeature()

static VOID NTAPI HubDeviceFeature ( _In_ HubChild *  Child, _In_ BOOLEAN  Set, _In_ USHORT  Feature  )

static

Definition at line 377 of file devreq.cpp.

{
    HubDeviceRequest(Child,
                     XFER_STD_TO_DEVICE,
                     Set ? USB_REQUEST_SET_FEATURE : USB_REQUEST_CLEAR_FEATURE,
                     Feature,
                     0,
                     NULL,
                     0,
                     TRUE);
}

Referenced by DeviceMachine::ArmForWake(), DeviceMachine::DisableU1(), DeviceMachine::DisableU2(), DeviceMachine::DisarmWake(), DeviceMachine::EnableLtm(), DeviceMachine::EnableU1(), and DeviceMachine::EnableU2().

HubDeviceGetDescriptor()

static VOID NTAPI HubDeviceGetDescriptor ( _In_ HubChild *  Child, _In_ UCHAR  Type, _In_ UCHAR  Index, _In_ USHORT  LanguageId, _Out_writes_bytes_(Length) PVOID  Buffer, _In_ ULONG  Length  )

static

Definition at line 327 of file devreq.cpp.

{
    HubDeviceRequest(Child,
                     XFER_STD_FROM_DEVICE,
                     USB_REQUEST_GET_DESCRIPTOR,
                     (USHORT)((Type << 8) | Index),
                     LanguageId,
                     Buffer,
                     Length,
                     TRUE);
}

Referenced by HubDeviceGetString(), DeviceMachine::ReadBos(), DeviceMachine::ReadBosHeader(), DeviceMachine::ReadConfigDescriptorHeader(), DeviceMachine::ReadDeviceDescriptor(), DeviceMachine::ReadFirstDescriptor(), DeviceMachine::ReadFullConfigDescriptor(), DeviceMachine::ReadMsOsDescriptor(), and DeviceMachine::ReadQualifier().

HubDeviceGetString()

static VOID NTAPI HubDeviceGetString ( _In_ HubChild *  Child, _In_ UCHAR  Index, _In_ USHORT  LanguageId  )

static

Definition at line 348 of file devreq.cpp.

{
    HubDeviceGetDescriptor(Child,
                           USB_STRING_DESCRIPTOR_TYPE,
                           Index,
                           LanguageId,
                           Child->m_ScratchBuffer,
                           MAXIMUM_USB_STRING_LENGTH);
}

Referenced by DeviceMachine::ReadBillboardString(), DeviceMachine::ReadLanguageIds(), DeviceMachine::ReadProductName(), and DeviceMachine::ReadSerialNumber().

HubDeviceMsOsRead()

static VOID NTAPI HubDeviceMsOsRead ( _In_ HubChild *  Child, _In_ UCHAR  RequestType, _In_ USHORT  Index, _Out_writes_bytes_(Length) PVOID  Buffer, _In_ ULONG  Length  )

static

Definition at line 364 of file devreq.cpp.

{
    HubDeviceRequest(Child, RequestType, Child->m_MsOsVendorCode, 0, Index, Buffer, Length, TRUE);
}

Referenced by DeviceMachine::ReadContainerId(), DeviceMachine::ReadContainerIdHeader(), DeviceMachine::ReadExtendedConfig(), DeviceMachine::ReadExtendedConfigHeader(), DeviceMachine::ReadExtProperties(), DeviceMachine::ReadExtPropertiesHeader(), and DeviceMachine::ReadMsOs20Set().

HubDeviceRequest()

static BOOLEAN NTAPI HubDeviceRequest ( _In_ HubChild *  Child, _In_ UCHAR  RequestType, _In_ UCHAR  Request, _In_ USHORT  Value, _In_ USHORT  Index, _In_reads_bytes_opt_(Length) PVOID  Buffer, _In_ ULONG  Length, _In_ BOOLEAN  ShortTransferOk  )

static

Definition at line 307 of file devreq.cpp.

{
    if (HubDeviceTrySend(Child, RequestType, Request, Value, Index, Buffer, Length, ShortTransferOk))
        return TRUE;
 
    Child->Post(DsmEvent::TransferFailed);
    return FALSE;
}

Referenced by DeviceMachine::ArmForWake(), DeviceMachine::ClearEndpointHalt(), DeviceMachine::DisarmWake(), HubDeviceFeature(), HubDeviceGetDescriptor(), HubDeviceMsOsRead(), DeviceMachine::SendAltEnumCommand(), DeviceMachine::SendUsbFeatures(), DeviceMachine::SetConfiguration(), DeviceMachine::SetIsochDelay(), DeviceMachine::SetNullConfiguration(), DeviceMachine::SetPdChargingPolicy(), and DeviceMachine::SetSel().

HubDeviceSend()

BOOLEAN NTAPI HubDeviceSend	(	_In_ HubChild *	Child,
		_In_reads_bytes_opt_(Length) PVOID	Buffer,
		_In_ ULONG	Length,
		_In_ BOOLEAN	ShortTransferOk
	)

Sends the setup packet in Child->m_Control; on FALSE the caller posts TransferFailed.

Definition at line 262 of file devreq.cpp.

{
    NTSTATUS Status;
 
    Status = Child->m_Control.Send(Child->m_Hub->m_RootHubTarget,
                                   Child->m_UsbDevice,
                                   HubDeviceControlComplete,
                                   Child,
                                   Buffer,
                                   Length,
                                   ShortTransferOk,
                                   Child->m_NeedsForwardProgress);
    if (NT_SUCCESS(Status))
        return TRUE;
 
    Child->m_Control.UsbdFlags = 0;
    DPRINT1("Device %p transfer refused 0x%lx\n", Child, Status);
    return FALSE;
}

Referenced by HubDeviceTrySend(), DeviceMachine::ReadAltModeString(), and DeviceMachine::SetInterface().

HubDeviceStringFailed()

static VOID NTAPI HubDeviceStringFailed ( _In_ HubChild *  Child, _In_ UCHAR  Index  )

static

Definition at line 57 of file devreq.cpp.

{
    const USB_DEVICE_DESCRIPTOR* Device = &Child->m_DeviceDescriptor;
    HubBillboardInfo* Billboard = Child->m_Billboard;
    PUSB_DEVICE_CAPABILITY_BILLBOARD_DESCRIPTOR Caps;
 
    if (Device->iSerialNumber != 0 && Index == Device->iSerialNumber)
    {
        Child->m_EnumMessageId = HUB_ENUM_SERIAL_NUMBER_FAILED;
        return;
    }
 
    if (Index == 0)
    {
        Child->m_EnumMessageId = HUB_ENUM_LANGUAGE_IDS_FAILED;
        return;
    }
 
    if (Device->iProduct != 0 && Index == Device->iProduct)
    {
        Child->m_EnumMessageId = HUB_ENUM_PRODUCT_STRING_FAILED;
        return;
    }
 
    if (Billboard == NULL)
        return;
 
    Caps = Billboard->Descriptor;
    if (Caps->iAddtionalInfoURL != 0 && Index == Caps->iAddtionalInfoURL)
    {
        Child->m_EnumMessageId = HUB_ENUM_PRODUCT_STRING_FAILED;
        return;
    }
 
    if (Billboard->CurrentMode != HUB_BILLBOARD_NO_MODE &&
        Caps->AlternateMode[Billboard->CurrentMode].iAlternateModeSetting != 0 &&
        Index == Caps->AlternateMode[Billboard->CurrentMode].iAlternateModeSetting)
    {
        Child->m_EnumMessageId = HUB_ENUM_PRODUCT_STRING_FAILED;
    }
}

Referenced by HubDeviceTransferFailed().

HubDeviceTransferFailed()

static DsmEvent NTAPI HubDeviceTransferFailed ( _In_ HubChild *  Child, _In_ NTSTATUS  Status  )

static

Records why the transfer failed and picks the event to post.

Definition at line 131 of file devreq.cpp.

{
    const UCHAR* Setup = Child->m_Control.Urb.SetupPacket;
    USBD_STATUS UrbStatus = Child->m_Control.Urb.Hdr.Status;
    UCHAR Type = XFER_TYPE(Setup[0]);
    UCHAR Request = Setup[1];
    USHORT Value = Setup[2] | (Setup[3] << 8);
    USHORT Index = Setup[4] | (Setup[5] << 8);
 
    if (HubDeviceFailureExpected(Type, Request, Value, Index))
    {
        DPRINT("Device %p port %u request 0x%02x/0x%02x value 0x%04x failed 0x%lx usbd 0x%lx\n",
               Child, Child->m_Port->Number(), Setup[0], Request, Value, Status, UrbStatus);
    }
    else
    {
        DPRINT1("Device %p port %u request 0x%02x/0x%02x value 0x%04x index 0x%04x failed 0x%lx usbd 0x%lx\n",
                Child, Child->m_Port->Number(), Setup[0], Request, Value, Index, Status, UrbStatus);
    }
 
    /* Every failed nonzero SET_CONFIGURATION reports the same codes */
    if (Request == USB_REQUEST_SET_CONFIGURATION && Value != 0)
    {
        Child->m_LastNtStatus = STATUS_UNSUCCESSFUL;
        Child->m_LastUsbdStatus = USBD_STATUS_SET_CONFIG_FAILED;
    }
    else
    {
        Child->m_LastNtStatus = Status;
        Child->m_LastUsbdStatus = UrbStatus;
    }
 
    if (Request == USB_REQUEST_SET_SEL && Type == XFER_TYPE_STANDARD)
    {
        Child->m_EnumMessageId = HUB_ENUM_SET_SEL_FAILED;
        return (UrbStatus == USBD_STATUS_STALL_PID) ? DsmEvent::TransferStalled : DsmEvent::TransferFailed;
    }
 
    if (Request == USB_REQUEST_SET_FEATURE && (Value == USB_FEATURE_U1_ENABLE || Value == USB_FEATURE_U2_ENABLE))
        return DsmEvent::TransferFailed;
 
    if (Request == USB_REQUEST_GET_DESCRIPTOR && Type == XFER_TYPE_STANDARD)
    {
        switch (Setup[3])
        {
            case USB_DEVICE_DESCRIPTOR_TYPE:
                Child->m_EnumMessageId = HUB_ENUM_DEVICE_DESCRIPTOR_FAILED;
                break;
 
            case USB_CONFIGURATION_DESCRIPTOR_TYPE:
                Child->m_EnumMessageId = HUB_ENUM_CONFIG_DESCRIPTOR_FAILED;
                break;
 
            case USB_BOS_DESCRIPTOR_TYPE:
                Child->m_EnumMessageId = HUB_ENUM_BOS_FAILED;
                break;
 
            case USB_DEVICE_QUALIFIER_DESCRIPTOR_TYPE:
                Child->m_EnumMessageId = HUB_ENUM_QUALIFIER_FAILED;
                break;
 
            case USB_STRING_DESCRIPTOR_TYPE:
                HubDeviceStringFailed(Child, Setup[2]);
                break;
 
            default:
                break;
        }
        return DsmEvent::TransferFailed;
    }
 
    if (Type == XFER_TYPE_VENDOR && Request == Child->m_MsOsVendorCode)
    {
        switch (Index)
        {
            case HUB_MSOS_INDEX_EXT_CONFIG:
                Child->m_EnumMessageId = HUB_ENUM_MSOS_EXT_CONFIG_FAILED;
                break;
 
            case HUB_MSOS_INDEX_CONTAINER_ID:
                Child->m_EnumMessageId = HUB_ENUM_MSOS_CONTAINER_ID_FAILED;
                break;
 
            case HUB_MSOS20_INDEX_SET:
                Child->m_EnumMessageId = HUB_ENUM_MSOS20_SET_FAILED;
                break;
 
            case HUB_MSOS20_INDEX_ALT_ENUM:
                Child->m_EnumMessageId = HUB_ENUM_ALT_ENUM_FAILED;
                break;
 
            default:
                break;
        }
        return DsmEvent::TransferFailed;
    }
 
    return DsmEvent::TransferFailed;
}

Referenced by HubDeviceControlComplete().

HubDeviceTrySend()

static BOOLEAN NTAPI HubDeviceTrySend ( _In_ HubChild *  Child, _In_ UCHAR  RequestType, _In_ UCHAR  Request, _In_ USHORT  Value, _In_ USHORT  Index, _In_reads_bytes_opt_(Length) PVOID  Buffer, _In_ ULONG  Length, _In_ BOOLEAN  ShortTransferOk  )

static

Definition at line 290 of file devreq.cpp.

{
    Child->m_Control.SetSetup(RequestType, Request, Value, Index, (USHORT)Length);
    return HubDeviceSend(Child, Buffer, Length, ShortTransferOk);
}

Referenced by HubDeviceRequest().

HubFdoDescriptorComplete()

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

static

Definition at line 1087 of file devreq.cpp.

{
    HubChild* Child = (HubChild*)Context;
    HubQueueContext* Queue = HubGetQueueContext(WdfRequestGetIoQueue(Request));
    ULONG Size = Queue->Urb.TransferBufferLength;
 
    UNREFERENCED_PARAMETER(Target);
 
    if (!NT_SUCCESS(Params->IoStatus.Status))
        DPRINT1("Device %p descriptor read for the hub failed 0x%lx\n", Child, Params->IoStatus.Status);
 
    Child->Post(NT_SUCCESS(Params->IoStatus.Status) ? DsmEvent::TransferDone : DsmEvent::TransferFailed);
    HubCompleteFdoDescriptorRequest(Child, Request, WdfRequestGetStatus(Request), Size);
}

HubFindPipeByHandle()

HubPipe *NTAPI HubFindPipeByHandle	(	_In_opt_ HubConfiguration *	Config,
		_In_ USBD_PIPE_HANDLE	Handle
	)

Pipe of Config whose USBD pipe handle is Handle, or NULL. The caller protects Config.

Definition at line 858 of file devreq.cpp.

{
    HubInterface* Interface;
    PLIST_ENTRY Entry;
    ULONG Index;
 
    if (Config == NULL)
        return NULL;
 
    for (Entry = Config->Interfaces.Flink; Entry != &Config->Interfaces; Entry = Entry->Flink)
    {
        Interface = CONTAINING_RECORD(Entry, HubInterface, Link);
 
        for (Index = 0; Index < Interface->PipeCount; Index++)
        {
            if (Interface->Pipes[Index].PipeHandle == Handle)
                return &Interface->Pipes[Index];
        }
    }
 
    return NULL;
}

Referenced by DeviceMachine::FindClientPipe().

HubFreeDevicePool()

static VOID NTAPI HubFreeDevicePool ( _Inout_ PVOID *  Buffer )

static

Definition at line 395 of file devreq.cpp.

{
    if (*Buffer == NULL)
        return;
 
    ExFreePoolWithTag(*Buffer, HUB_TAG_DEVICE);
    *Buffer = NULL;
}

Referenced by DeviceMachine::ReadBosHeader(), DeviceMachine::ReadConfigDescriptorHeader(), DeviceMachine::ReadExtendedConfigHeader(), DeviceMachine::ReadLanguageIds(), DeviceMachine::ReadMsOs20Set(), and DeviceMachine::ReadProductName().

HubSelPathLatency()

static USHORT NTAPI HubSelPathLatency ( _In_ USHORT  DeviceLatency, _In_ USHORT  UpstreamLatency, _In_ USHORT  SlowestLatency, _In_ UCHAR  SlowestDepth, _In_ LONG  Depth, _Out_ PUSHORT  Link, _Inout_ PBOOLEAN  Slowest  )

static

Path exit latency for one link state; Slowest is set when Link exceeds it.

Definition at line 988 of file devreq.cpp.

{
    USHORT Path;
 
    *Link = max(DeviceLatency, UpstreamLatency);
    Path = (USHORT)(SlowestLatency + ((Depth - SlowestDepth) * 1000 + 500) / 1000);
 
    if (*Link <= Path)
        return Path;
 
    *Slowest = TRUE;
    return *Link;
}

Referenced by DeviceMachine::SetSel().

if() [1/2]

if

(

!

NT_SUCCESSStatus

)

Definition at line 1199 of file devreq.cpp.

    {
        DPRINT1("Port %u boot status read not sent 0x%lx\n", Child->m_Port->Number(), Status);
        return Status;
    }

if() [2/2]

if

(

Control->

Request = = NULL

)

Definition at line 1169 of file devreq.cpp.

    {
        Status = Control->Create(Child->m_Object, WdfDeviceGetIoTarget(Hub->m_Device));
        if (!NT_SUCCESS(Status))
        {
            DPRINT1("Device %p boot status request not created 0x%lx\n", Child, Status);
            return Status;
        }
    }

Number()

Child m_Port Number

(

)

PAGED_CODE()

PAGED_CODE

(

)

SetSetup()

Control SetSetup	(	XFER_CLASS_FROM_PORT	,
		HUB_REQUEST_GET_STATUS	,
		0	,
		Child->m_Port->	Number(),
		sizeof *	PortStatus
	)

Variable Documentation

Control

HubControlRequest* Control = &Child->m_BootControl

Definition at line 1161 of file devreq.cpp.

Done

HubWaitForPnpEvent & Done

Definition at line 1162 of file devreq.cpp.

Referenced by FxIoQueue::_Create(), FxDevice::_Create(), FxMessageDispatch::_CreateAndInitialize(), FxWmiIrpHandler::_EnableDisableEventsAndCollection(), FxUsbPipe::_FormatTransfer(), _IRQL_requires_(), FxWmiIrpHandler::_QueryAllData(), FxWmiIrpHandler::_RegInfo(), _Releases_lock_(), acpi_bus_match(), FxPkgGeneral::AcquireRemoveLockForClose(), AddInputEvents(), FxWmiIrpHandler::AddPowerPolicyProviderAndInstance(), FxDeviceBase::AllocateTarget(), FxUsbDeviceControlContext::AllocateUrb(), FxUsbDeviceStringContext::AllocateUrb(), FxUsbPipeTransferContext::AllocateUrb(), FxUsbPipeRequestContext::AllocateUrb(), ApplyConsoleInfo(), ArcOpen(), AtaAhciHandleFatalError(), AtaAhciPostRequestPolled(), BT958HwResetBus(), XhciEndpoint::BuildEndpointConfigure(), XhciEndpoint::BuildSetDequeue(), BusLogic_Command(), BusLogic_SendBusDeviceReset(), CM_Get_Device_ID_List_ExA(), CM_Get_Device_Interface_Alias_ExA(), CM_Get_Device_Interface_List_ExA(), CM_Register_Device_Interface_ExA(), UcxUsbDevice::CompleteHubOperation(), ConDrvCreateController(), FxPkgGeneral::ConfigureConstraints(), FxDeviceBase::ConfigureConstraints(), FxPkgIo::ConfigureDynamicDispatching(), FxPkgGeneral::ConfigureFileObjectClass(), FxUsbDevice::CreateInterfaces(), FxUsbDevice::CreateIsochUrb(), FxUsbDevice::CreateUrb(), DcResetWorker(), DirPrintf(), FxWmiIrpHandler::Dispatch(), FxDevice::DispatchPreprocessedIrp(), DosAllocateMemory(), DosResizeMemory(), DosTerminateProcess(), DrvCopyBits(), ElfCreateBackupLogHandle(), ElfCreateEventLogHandle(), ElfrReportEventA(), FX_VF_METHOD(), FxCacheBugCheckDriverInfo(), FxInitializeBugCheckDriverInfo(), FxLibraryCommonRegisterClient(), FxObjectAllocateContext(), FxpLibraryBugCheckCallback(), FxPurgeBugCheckDriverInfo(), FxRegisterBugCheckCallback(), FxUninitializeBugCheckDriverInfo(), FxUnregisterBugCheckCallback(), FxRequest::GetDeviceControlOutputMemoryObject(), FxRequest::GetMemoryObject(), FxChildList::GetNextDevice(), FxChildList::GetNextStaticDevice(), GetServiceInstanceList(), GetServiceInstanceListSize(), GetStackCapabilities(), FxUsbDevice::GetString(), GetSystemUserInfo(), FxPkgPnp::HandleQueryDeviceRelations(), FxPkgPnp::HandleQueryInterface(), HubClearTtBuffer(), if(), FxUsbDevice::InitDevice(), FxPkgGeneral::Initialize(), FxNPagedLookasideList::Initialize(), KdbpDoCommand(), LsapCreateDatabaseKeys(), LsapGetObjectAttribute(), LsarQueryAccountDomain(), LsarQueryPrimaryDomain(), FxUsbInterface::MakeAndConfigurePipes(), MmUnloadSystemImage(), NtfsCachedRead(), FxIoTargetRemote::Open(), PagePrompt(), PNP_AddID(), PNP_GetRootDeviceInstance(), PNP_ValidateDeviceInstance(), FxPkgPnp::PnpMatchResources(), FxRequest::ProbeAndLockForRead(), FxRequest::ProbeAndLockForWrite(), FxChildList::ProcessBusRelations(), PS2PortQueueRead(), PS2QueuePush(), RDeleteService(), _FX_DRIVER_TRACKER_CACHE_AWARE::Register(), REnumDependentServicesA(), REnumDependentServicesW(), REnumServiceGroupW(), REnumServicesStatusA(), REnumServicesStatusExA(), REnumServicesStatusExW(), ROpenServiceW(), RQueryServiceConfigA(), RQueryServiceConfigW(), RSetServiceObjectSecurity(), ScmSendControlPacket(), FxTransactionedList::SearchForAndRemove(), FxUsbDevice::SelectConfig(), FxUsbDevice::SelectConfigMulti(), FxUsbInterface::SelectSetting(), FxUsbDevice::SendSyncRequest(), SRomReadSRom(), START_TEST(), UcxUsbDevice::StartOperation(), FxIoTarget::SubmitLocked(), switch(), UsbdexCallAndWait(), FxPkgPnp::ValidateCmResource(), FxPkgPnp::ValidateInterruptResourceCm(), VerifyWdfDeviceWdmDispatchIrpToIoQueue(), and VerifyWdfRequestForwardToParentDeviceIoQueue().

else

else

Initial value:

{
        Control->Reuse()

Definition at line 1178 of file devreq.cpp.

HubBootStatusComplete

EVT_WDF_REQUEST_COMPLETION_ROUTINE HubBootStatusComplete

static

Definition at line 49 of file devreq.cpp.

HubDeviceControlComplete

EVT_WDF_REQUEST_COMPLETION_ROUTINE HubDeviceControlComplete

static

Definition at line 47 of file devreq.cpp.

Referenced by HubDeviceSend().

HubFdoDescriptorComplete

EVT_WDF_REQUEST_COMPLETION_ROUTINE HubFdoDescriptorComplete

static

Definition at line 48 of file devreq.cpp.

Referenced by DeviceMachine::GetDescriptorForHub().

PortStatus

* PortStatus

Initial value:

{
    HubFdo* Hub = Child->m_Hub

Definition at line 1158 of file devreq.cpp.

Status

return Status

Initial value:

= Control->Send(Hub->m_RootHubTarget,
                           Hub->UsbDevice(),
                           HubBootStatusComplete,
                           &Done,
                           PortStatus,
                           sizeof(*PortStatus),
                           FALSE,
                           TRUE)

Definition at line 1163 of file devreq.cpp.

Referenced by HubDeviceSend(), HubDeviceTransferFailed(), and if().