#include <hubreq.h>

Collaboration diagram for HubControlRequest:

[legend]

Public Member Functions
_Must_inspect_result_ NTSTATUS	Create (_In_ WDFOBJECT Parent, _In_ WDFIOTARGET SizingTarget)

VOID	SetSetup (_In_ UCHAR RequestType, _In_ UCHAR RequestCode, _In_ USHORT Value, _In_ USHORT Index, _In_ USHORT Length)

NTSTATUS	Send (_In_ WDFIOTARGET Target, _In_opt_ UCXUSBDEVICE Device, _In_ PFN_WDF_REQUEST_COMPLETION_ROUTINE Completion, _In_ WDFCONTEXT Context, _In_reads_bytes_opt_(Length) PVOID Buffer, _In_ ULONG Length, _In_ BOOLEAN ShortTransferOk, _In_ BOOLEAN ForwardProgress)

VOID	Reuse ()

Public Attributes
WDFREQUEST	Request

PIRP	Irp

struct _URB_CONTROL_TRANSFER_EX	Urb

ULONG	UsbdFlags

Detailed Description

A WDFREQUEST and the URB it carries, reused for every control transfer of one owner.

Definition at line 17 of file hubreq.h.

Member Function Documentation

◆ Create()

_Must_inspect_result_ NTSTATUS HubControlRequest::Create	(	_In_ WDFOBJECT	Parent,
		_In_ WDFIOTARGET	SizingTarget
	)

Definition at line 22 of file hubreq.cpp.

{
    WDF_OBJECT_ATTRIBUTES Attributes;
    NTSTATUS Status;
 
    WDF_OBJECT_ATTRIBUTES_INIT(&Attributes);
    Attributes.ParentObject = Parent;
 
    Status = WdfRequestCreate(&Attributes, SizingTarget, &Request);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Control request create for %p failed 0x%lx\n", Parent, Status);
        return Status;
    }
 
    Irp = WdfRequestWdmGetIrp(Request);
    UsbdFlags = 0;
    return STATUS_SUCCESS;
}

◆ Reuse()

VOID HubControlRequest::Reuse ( )

Definition at line 45 of file hubreq.cpp.

{
    WDF_REQUEST_REUSE_PARAMS Params;
    NTSTATUS Status;
 
    WDF_REQUEST_REUSE_PARAMS_INIT(&Params, WDF_REQUEST_REUSE_NO_FLAGS, STATUS_SUCCESS);
 
    Status = WdfRequestReuse(Request, &Params);
    if (!NT_SUCCESS(Status))
        DPRINT1("Reusing request %p failed 0x%lx\n", Request, Status);
}

Referenced by HubControlComplete(), HubMailboxComplete(), HubPipeResetComplete(), HubMachine::ResetStatusChangePipe(), and Send().

◆ Send()

NTSTATUS HubControlRequest::Send	(	_In_ WDFIOTARGET	Target,
		_In_opt_ UCXUSBDEVICE	Device,
		_In_ PFN_WDF_REQUEST_COMPLETION_ROUTINE	Completion,
		_In_ WDFCONTEXT	Context,
		_In_reads_bytes_opt_(Length) PVOID	Buffer,
		_In_ ULONG	Length,
		_In_ BOOLEAN	ShortTransferOk,
		_In_ BOOLEAN	ForwardProgress
	)

On failure the request was refused and is ready for reuse; on success the completion owns it.

Definition at line 62 of file hubreq.cpp.

{
    IO_STACK_LOCATION Stack;
    NTSTATUS Status;
 
    Urb.Hdr.Length = sizeof(Urb);
    Urb.Hdr.Function = URB_FUNCTION_CONTROL_TRANSFER_EX;
    Urb.Hdr.UsbdDeviceHandle = Device;
    Urb.Hdr.UsbdFlags = UsbdFlags;
 
    Urb.TransferFlags = USBD_DEFAULT_PIPE_TRANSFER;
    if (ShortTransferOk)
        Urb.TransferFlags |= USBD_SHORT_TRANSFER_OK;
    if (Urb.SetupPacket[0] & 0x80)
        Urb.TransferFlags |= USBD_TRANSFER_DIRECTION_IN;
    if (ForwardProgress)
        Urb.TransferFlags |= USB3_URB_RESERVED_RESOURCES;
 
    Urb.TransferBufferLength = Length;
    Urb.TransferBuffer = Buffer;
    Urb.TransferBufferMDL = NULL;
    Urb.Timeout = HUB_SETUP_REQUEST_TIMEOUT_MS;
 
    RtlZeroMemory(&Stack, sizeof(Stack));
    Stack.MajorFunction = IRP_MJ_INTERNAL_DEVICE_CONTROL;
    Stack.Parameters.DeviceIoControl.IoControlCode = IOCTL_INTERNAL_USB_SUBMIT_URB;
    Stack.Parameters.Others.Argument1 = &Urb;
    WdfRequestWdmFormatUsingStackLocation(Request, &Stack);
 
    WdfRequestSetCompletionRoutine(Request, Completion, Context);
 
    if (WdfRequestSend(Request, Target, WDF_NO_SEND_OPTIONS))
        return STATUS_SUCCESS;
 
    Status = WdfRequestGetStatus(Request);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Control request 0x%x to device %p not sent 0x%lx\n", Urb.SetupPacket[1], Device, Status);
        Reuse();
    }
 
    return Status;
}

Referenced by HubMachine::GetConfigDescriptor(), HubMailboxTransfer(), and HubSendControl().

◆ SetSetup()

VOID HubControlRequest::SetSetup	(	_In_ UCHAR	RequestType,
		_In_ UCHAR	RequestCode,
		_In_ USHORT	Value,
		_In_ USHORT	Index,
		_In_ USHORT	Length
	)

inline

Setup packet fields, little endian as on the wire.

Definition at line 34 of file hubreq.h.

    {
        Urb.SetupPacket[0] = RequestType;
        Urb.SetupPacket[1] = RequestCode;
        Urb.SetupPacket[2] = (UCHAR)(Value & 0xFF);
        Urb.SetupPacket[3] = (UCHAR)(Value >> 8);
        Urb.SetupPacket[4] = (UCHAR)(Index & 0xFF);
        Urb.SetupPacket[5] = (UCHAR)(Index >> 8);
        Urb.SetupPacket[6] = (UCHAR)(Length & 0xFF);
        Urb.SetupPacket[7] = (UCHAR)(Length >> 8);
    }

Referenced by HubMachine::AckHubChange(), HubMachine::GetConfigDescriptor(), HubMachine::GetHubDescriptor(), HubMachine::GetHubStatus(), HubMachine::GetPortStatus(), HubMachine::GetStandardStatus(), HubMailboxTransfer(), and HubMachine::SetHubDepth().

Member Data Documentation

◆ Irp

PIRP HubControlRequest::Irp

Definition at line 20 of file hubreq.h.

◆ Request

WDFREQUEST HubControlRequest::Request

Definition at line 19 of file hubreq.h.

Referenced by DeviceMachine::CancelTransfer(), and HubMachine::ResetStatusChangePipe().

◆ Urb

struct _URB_CONTROL_TRANSFER_EX HubControlRequest::Urb

Definition at line 21 of file hubreq.h.

Referenced by HubMachine::CacheConfigDescriptor(), DeviceMachine::ExtPropertiesHeaderValid(), HubControlComplete(), HubMailboxComplete(), Send(), and SetSetup().

◆ UsbdFlags

ULONG HubControlRequest::UsbdFlags

Definition at line 24 of file hubreq.h.

Referenced by Create(), and Send().

The documentation for this struct was generated from the following files:

drivers/usb/usbhub3/hubreq.h
drivers/usb/usbhub3/hubreq.cpp

Public Member Functions

Public Attributes