devicemgmt.cpp File Reference

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

Include dependency graph for devicemgmt.cpp:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
static UcxUsbDevice *NTAPI	UcxDeviceFromManagementRequest (_In_ WDFREQUEST Request, _In_ ULONG IoControlCode)
VOID NTAPI	UcxEvtDeviceMgmtIoInternalDeviceControl (_In_ WDFQUEUE Queue, _In_ WDFREQUEST Request, _In_ size_t OutputBufferLength, _In_ size_t InputBufferLength, _In_ ULONG IoControlCode)
VOID NTAPI	UcxEvtPendDuringResetIoInternalDeviceControl (_In_ WDFQUEUE Queue, _In_ WDFREQUEST Request, _In_ size_t OutputBufferLength, _In_ size_t InputBufferLength, _In_ ULONG IoControlCode)
VOID NTAPI	UcxEvtTreePurgeIoInternalDeviceControl (_In_ WDFQUEUE Queue, _In_ WDFREQUEST Request, _In_ size_t OutputBufferLength, _In_ size_t InputBufferLength, _In_ ULONG IoControlCode)
static VOID NTAPI	UcxTreePurgeVisitor (_In_ UcxUsbDevice *Device, _In_opt_ PVOID Context)
static VOID NTAPI	UcxParkDuringReset (_In_ UcxUsbDevice *Device, _In_ WDFREQUEST Request)
static VOID NTAPI	UcxResumeIrpCompletion (_In_ PIRP Irp, _In_ NTSTATUS Status)

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 16 of file devicemgmt.cpp.

Function Documentation

UcxDeviceFromManagementRequest()

static UcxUsbDevice *NTAPI UcxDeviceFromManagementRequest ( _In_ WDFREQUEST  Request, _In_ ULONG  IoControlCode  )

static

The device a device management request is about.

Definition at line 23 of file devicemgmt.cpp.

{
    PVOID Arg1 = UcxRequestArgs(Request).Arg1;
 
    if (IoControlCode == IOCTL_INTERNAL_USB_SUBMIT_URB)
        return UcxUsbDevice::FromHandle((UCXUSBDEVICE)((PURB)Arg1)->UrbHeader.UsbdDeviceHandle);
 
    return UcxUsbDevice::FromHandle(((PUSBDEVICE_MGMT_HEADER)Arg1)->UsbDevice);
}

Referenced by UcxEvtDeviceMgmtIoInternalDeviceControl().

UcxEvtDeviceMgmtIoInternalDeviceControl()

VOID NTAPI UcxEvtDeviceMgmtIoInternalDeviceControl	(	_In_ WDFQUEUE	Queue,
		_In_ WDFREQUEST	Request,
		_In_ size_t	OutputBufferLength,
		_In_ size_t	InputBufferLength,
		_In_ ULONG	IoControlCode
	)

Definition at line 37 of file devicemgmt.cpp.

{
    UcxUsbDevice* Device = UcxDeviceFromManagementRequest(Request, IoControlCode);
    UcxController* Controller = Device->m_Controller;
 
    UNREFERENCED_PARAMETER(Queue);
    UNREFERENCED_PARAMETER(OutputBufferLength);
    UNREFERENCED_PARAMETER(InputBufferLength);
 
    if (!Controller->BlockReset())
    {
        DPRINT("UsbDevice %p IOCTL 0x%lx during controller reset\n", Device->m_Handle, IoControlCode);
        Device->FailManagement(Request, IoControlCode);
        return;
    }
 
    /* Only an enable may bring back a device the last controller reset deprogrammed */
    if (Device->m_DeprogrammedByControllerReset)
    {
        if (IoControlCode != IOCTL_UCXHUB_DEVICE_ENABLE)
        {
            DPRINT("UsbDevice %p IOCTL 0x%lx after a controller reset deprogrammed it\n",
                   Device->m_Handle, IoControlCode);
            Device->FailManagement(Request, IoControlCode);
            Controller->UnblockReset();
            return;
        }
        DPRINT("UsbDevice %p enabled again after a controller reset\n", Device->m_Handle);
        Device->m_DeprogrammedByControllerReset = FALSE;
    }
 
    Device->DispatchManagement(Request, IoControlCode);
 
    /* The operation usually continues; it does not need the reference */
    Controller->UnblockReset();
}

UcxEvtPendDuringResetIoInternalDeviceControl()

VOID NTAPI UcxEvtPendDuringResetIoInternalDeviceControl	(	_In_ WDFQUEUE	Queue,
		_In_ WDFREQUEST	Request,
		_In_ size_t	OutputBufferLength,
		_In_ size_t	InputBufferLength,
		_In_ ULONG	IoControlCode
	)

Definition at line 245 of file devicemgmt.cpp.

{
    PVOID Arg1 = UcxRequestArgs(Request).Arg1;
    NTSTATUS Status;
    UcxUsbDevice* Device;
    PURB Urb;
 
    UNREFERENCED_PARAMETER(Queue);
    UNREFERENCED_PARAMETER(OutputBufferLength);
    UNREFERENCED_PARAMETER(InputBufferLength);
 
    switch (IoControlCode)
    {
        case IOCTL_UCXHUB_DEVICE_RESET:
        case IOCTL_UCXHUB_DEVICE_DISABLE:
            Status = STATUS_SUCCESS;
            break;
 
        case IOCTL_UCXHUB_ENDPOINTS_CONFIGURE:
            Status = (((PENDPOINTS_CONFIGURE)Arg1)->EndpointsToEnableCount != 0) ? STATUS_NO_SUCH_DEVICE
                                                                                 : STATUS_SUCCESS;
            break;
 
        case IOCTL_INTERNAL_USB_SUBMIT_URB:
            Urb = (PURB)Arg1;
            if (Urb->UrbHeader.Function != URB_FUNCTION_CLOSE_STATIC_STREAMS)
            {
                DPRINT1("Parked request %p has unexpected URB function 0x%x\n", Request, Urb->UrbHeader.Function);
                NT_ASSERT(FALSE);
                Status = STATUS_NO_SUCH_DEVICE;
                break;
            }
 
            Device = UcxUsbDevice::FromHandle((UCXUSBDEVICE)Urb->UrbHeader.UsbdDeviceHandle);
            if (Device->m_FailNextStreamClose)
            {
                Device->m_FailNextStreamClose = FALSE;
                Status = STATUS_NO_SUCH_DEVICE;
            }
            else
            {
                Status = STATUS_SUCCESS;
            }
            break;
 
        default:
            DPRINT1("Parked request %p has unexpected IOCTL 0x%lx\n", Request, IoControlCode);
            NT_ASSERT(FALSE);
            Status = STATUS_INVALID_DEVICE_REQUEST;
            break;
    }
 
    DPRINT("Parked request %p IOCTL 0x%lx released 0x%lx\n", Request, IoControlCode, Status);
    WdfRequestComplete(Request, Status);
}

UcxEvtTreePurgeIoInternalDeviceControl()

VOID NTAPI UcxEvtTreePurgeIoInternalDeviceControl	(	_In_ WDFQUEUE	Queue,
		_In_ WDFREQUEST	Request,
		_In_ size_t	OutputBufferLength,
		_In_ size_t	InputBufferLength,
		_In_ ULONG	IoControlCode
	)

Definition at line 309 of file devicemgmt.cpp.

{
    UcxController* Controller = UcxController::FromFdo(WdfIoQueueGetDevice(Queue));
    NTSTATUS Status;
 
    UNREFERENCED_PARAMETER(OutputBufferLength);
    UNREFERENCED_PARAMETER(InputBufferLength);
 
    if (IoControlCode != IOCTL_UCXHUB_DEVICE_TREE_PURGE_IO)
    {
        DPRINT1("Tree purge queue got unexpected IOCTL 0x%lx\n", IoControlCode);
        WdfRequestComplete(Request, STATUS_INVALID_DEVICE_REQUEST);
        return;
    }
 
    WdfIoQueueStop(Queue, NULL, NULL);
 
    /* This IOCTL must not fail */
    Status = WdfRequestForwardToIoQueue(Request, Controller->m_DeviceMgmtQueue);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Tree purge request %p forward failed 0x%lx, completed anyway\n", Request, Status);
        WdfRequestComplete(Request, STATUS_SUCCESS);
        WdfIoQueueStart(Queue);
    }
}

UcxParkDuringReset()

static VOID NTAPI UcxParkDuringReset ( _In_ UcxUsbDevice *  Device, _In_ WDFREQUEST  Request  )

static

Definition at line 624 of file devicemgmt.cpp.

{
    NTSTATUS Status;
 
    Status = WdfRequestForwardToIoQueue(Request, Device->m_Controller->m_PendDuringResetQueue);
    if (!NT_SUCCESS(Status))
        DPRINT1("UsbDevice %p could not park request %p 0x%lx\n", Device->m_Handle, Request, Status);
}

Referenced by UcxUsbDevice::PendDisable(), UcxUsbDevice::PendEndpointsConfigure(), and UcxUsbDevice::PendReset().

UcxResumeIrpCompletion()

static VOID NTAPI UcxResumeIrpCompletion ( _In_ PIRP  Irp, _In_ NTSTATUS  Status  )

static

Definition at line 662 of file devicemgmt.cpp.

{
    Irp->IoStatus.Status = Status;
    Irp->IoStatus.Information = 0;
    IoCompleteRequest(Irp, IO_NO_INCREMENT);
}

Referenced by UcxUsbDevice::CompleteEnableIrp(), UcxUsbDevice::CompleteEndpointsConfigureIrp(), UcxUsbDevice::FinishEndpointResetRequest(), and UcxUsbDevice::OnHcdEndpointsConfigureDone().

UcxTreePurgeVisitor()

static VOID NTAPI UcxTreePurgeVisitor ( _In_ UcxUsbDevice *  Device, _In_opt_ PVOID  Context  )

static

Definition at line 444 of file devicemgmt.cpp.

{
    PLIST_ENTRY Endpoints = (PLIST_ENTRY)Context;
    PLIST_ENTRY Entry;
    UcxEndpoint* Endpoint;
 
    Device->m_ChildrenMayLeavePurge = FALSE;
    Device->m_EndpointsMayLeavePurge = FALSE;
 
    for (Entry = Device->m_EndpointList.Flink; Entry != &Device->m_EndpointList; Entry = Entry->Flink)
    {
        Endpoint = CONTAINING_RECORD(Entry, UcxEndpoint, m_DeviceLink);
 
        WdfObjectReference(Endpoint->m_Handle);
        InsertTailList(Endpoints, &Endpoint->m_TreePurgeLink);
    }
}

Referenced by UcxUsbDevice::HandleHubTreePurge().