devobj.cpp File Reference

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

Include dependency graph for devobj.cpp:

Go to the source code of this file.

Macros
#define	NDEBUG
#define	UCX_COMPOSITE_VERSION   0x100
#define	UCX_MAX_COMPOSITE_FUNCTIONS   255
#define	UCX_MAX_FORWARD_PROGRESS_SIZE   (512 * 1024)

Functions
static ULONG64 NTAPI	UcxSystemTimeNow (VOID)
static NTSTATUS NTAPI	UcxBuildPortPath (_In_ UcxUsbDevice *Hub, _In_ ULONG PortNumber, _Inout_ PUCXUSBDEVICE_INFO Info)
static VOID NTAPI	UcxDisconnectVisitor (_In_ UcxUsbDevice *Device, _In_opt_ PVOID Context)
static BOOLEAN NTAPI	UcxIsValidForwardProgressSize (_In_ ULONG Size)
	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS UcxUsbDevice
	Sends a synchronous IOCTL to the specified device object.

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 10 of file devobj.cpp.

UCX_COMPOSITE_VERSION

#define UCX_COMPOSITE_VERSION   0x100

Definition at line 13 of file devobj.cpp.

UCX_MAX_COMPOSITE_FUNCTIONS

#define UCX_MAX_COMPOSITE_FUNCTIONS   255

Definition at line 14 of file devobj.cpp.

UCX_MAX_FORWARD_PROGRESS_SIZE

#define UCX_MAX_FORWARD_PROGRESS_SIZE   (512 * 1024)

Definition at line 15 of file devobj.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.

Definition at line 543 of file devobj.cpp.

{
    ULONG ControlSize = Info->ControlPipeMaxTransferSize;
    UcxPipe* DefaultPipe = m_DefaultPipe;
    PFN_UCX_HCD_ENDPOINT_ENABLE_FORWARD_PROGRESS Enable;
    UcxPipe* Pipe;
    ULONG Index;
    NTSTATUS Status;
 
    PAGED_CODE();
 
    if (ControlSize > UCX_MAX_FORWARD_PROGRESS_SIZE)
    {
        DPRINT1("UsbDevice %p control forward progress size %lu too large\n", m_Handle, ControlSize);
        return STATUS_INVALID_PARAMETER;
    }
 
    if (ControlSize != 0 && DefaultPipe->ReservedIoActive)
    {
        DPRINT1("UsbDevice %p control pipe forward progress already enabled\n", m_Handle);
        return STATUS_INVALID_PARAMETER;
    }
 
    for (Index = 0; Index < Info->NumberOfPipes; Index++)
    {
        Pipe = UcxPipe::FromHandle(Info->Pipes[Index].PipeHandle);
 
        if (!UcxIsValidForwardProgressSize(Info->Pipes[Index].ReservedTransferLimit) ||
            Pipe->ReservedIoActive)
        {
            DPRINT1("UsbDevice %p pipe %lu bad forward progress size %lu or already enabled\n",
                    m_Handle, Index, Info->Pipes[Index].ReservedTransferLimit);
            return STATUS_INVALID_PARAMETER;
        }
    }
 
    /* The control pipe keeps resources it already got if they are big enough */
    if (ControlSize != 0 &&
        !(DefaultPipe->ForwardProgressAllocatedByHcd &&
          DefaultPipe->ReservedIoMaxBytes >= ControlSize))
    {
        Enable = m_DefaultEndpoint->m_Callbacks.EnableForwardProgress;
        if (Enable == NULL)
        {
            DPRINT1("UsbDevice %p HCD has no forward progress callback for the control pipe\n", m_Handle);
            return STATUS_NOT_SUPPORTED;
        }
 
        Status = Enable(m_DefaultEndpoint->m_Handle, ControlSize);
        if (!NT_SUCCESS(Status))
        {
            DPRINT1("UsbDevice %p control pipe forward progress failed 0x%lx\n", m_Handle, Status);
            return Status;
        }
 
        DefaultPipe->ForwardProgressAllocatedByHcd = TRUE;
        DefaultPipe->ReservedIoMaxBytes = ControlSize;
    }
 
    for (Index = 0; Index < Info->NumberOfPipes; Index++)
    {
        Pipe = UcxPipe::FromHandle(Info->Pipes[Index].PipeHandle);
 
        Enable = Pipe->Endpoint->m_Callbacks.EnableForwardProgress;
        if (Enable == NULL)
        {
            DPRINT1("Endpoint %p HCD has no forward progress callback\n", Pipe->Endpoint->m_Handle);
            return STATUS_NOT_SUPPORTED;
        }
 
        Status = Enable(Pipe->Endpoint->m_Handle, Info->Pipes[Index].ReservedTransferLimit);
        if (!NT_SUCCESS(Status))
        {
            DPRINT1("Endpoint %p forward progress failed 0x%lx\n", Pipe->Endpoint->m_Handle, Status);
            return Status;
        }
 
        Pipe->ForwardProgressAllocatedByHcd = TRUE;
        Pipe->ReservedIoMaxBytes = Info->Pipes[Index].ReservedTransferLimit;
    }
 
    /* Only marked once every pipe got its resources */
    if (ControlSize != 0)
        DefaultPipe->ReservedIoActive = TRUE;
 
    for (Index = 0; Index < Info->NumberOfPipes; Index++)
        UcxPipe::FromHandle(Info->Pipes[Index].PipeHandle)->ReservedIoActive = TRUE;
 
    return STATUS_SUCCESS;
}

UcxBuildPortPath()

static NTSTATUS NTAPI UcxBuildPortPath ( _In_ UcxUsbDevice *  Hub, _In_ ULONG  PortNumber, _Inout_ PUCXUSBDEVICE_INFO  Info  )

static

Low and full speed devices take the nearest high speed hub as their TT.

Definition at line 249 of file devobj.cpp.

{
    PUSB_DEVICE_PORT_PATH Path = &Info->PortPath;
    ULONG ParentDepth;
 
    if (Hub->IsRootHub())
    {
        Path->Size = sizeof(*Path);
        Path->PortPathDepth = 1;
        Path->PortPath[0] = PortNumber;
        Path->TTHubDepth = 0;
        Info->TtHub = NULL;
        return STATUS_SUCCESS;
    }
 
    ParentDepth = Hub->m_Info.PortPath.PortPathDepth;
    if (ParentDepth + 1 > MAX_USB_DEVICE_DEPTH)
    {
        DPRINT1("Hub %p port %lu is too deep for a device, depth %lu\n", Hub->m_Handle, PortNumber, ParentDepth + 1);
        return STATUS_INVALID_PARAMETER;
    }
 
    *Path = Hub->m_Info.PortPath;
    Path->PortPathDepth = ParentDepth + 1;
    Path->PortPath[ParentDepth] = PortNumber;
 
    if (Info->DeviceSpeed == UsbLowSpeed || Info->DeviceSpeed == UsbFullSpeed)
    {
        if (Hub->Speed() == UsbHighSpeed)
        {
            Path->TTHubDepth = ParentDepth;
            Info->TtHub = Hub->m_Handle;
        }
        else
        {
            Path->TTHubDepth = Hub->m_Info.PortPath.TTHubDepth;
            Info->TtHub = Hub->m_Info.TtHub;
        }
    }
 
    return STATUS_SUCCESS;
}

Referenced by UcxUsbDevice::CreateFromHub().

UcxDisconnectVisitor()

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

static

Definition at line 420 of file devobj.cpp.

{
    PLIST_ENTRY Endpoints = (PLIST_ENTRY)Context;
    PLIST_ENTRY Entry;
    UcxEndpoint* Endpoint;
 
    Device->m_Disconnected = TRUE;
 
    for (Entry = Device->m_EndpointList.Flink; Entry != &Device->m_EndpointList; Entry = Entry->Flink)
    {
        Endpoint = CONTAINING_RECORD(Entry, UcxEndpoint, m_DeviceLink);
 
        WdfObjectReference(Endpoint->m_Handle);
        InsertHeadList(Endpoints, &Endpoint->m_DisconnectLink);
    }
}

Referenced by UcxUsbDevice::DisconnectPort().

UcxIsValidForwardProgressSize()

static BOOLEAN NTAPI UcxIsValidForwardProgressSize ( _In_ ULONG  Size )

static

Validates one forward progress size: non zero and at most 512 KB.

Definition at line 536 of file devobj.cpp.

{
    return Size != 0 && Size <= UCX_MAX_FORWARD_PROGRESS_SIZE;
}

Referenced by _IRQL_requires_().

UcxSystemTimeNow()

static ULONG64 NTAPI UcxSystemTimeNow ( VOID  )

static

Definition at line 27 of file devobj.cpp.

{
    LARGE_INTEGER Now;
 
    KeQuerySystemTime(&Now);
    return (ULONG64)Now.QuadPart;
}

Referenced by UcxUsbDevice::Create().