hostctl.cpp File Reference

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

Include dependency graph for hostctl.cpp:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
static BOOLEAN NTAPI	UcxIsAcceptedConfigSize (_In_ ULONG Size)
static BOOLEAN NTAPI	UcxIsValidIdString (_In_opt_ PCUNICODE_STRING String)
static NTSTATUS NTAPI	UcxCopyIdString (_In_ PCUNICODE_STRING Source, _Out_ PUNICODE_STRING Copy)
static VOID NTAPI	UcxFreeIdString (_Inout_ PUNICODE_STRING String)
	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS UcxController
	Sends a synchronous IOCTL to the specified device object.

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 10 of file hostctl.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 726 of file hostctl.cpp.

{
    PFN_UCX_HCD_ENABLE_FORWARD_PROGRESS HcdEnable;
    UcxUsbDevice* Device;
    NTSTATUS Status;
 
    PAGED_CODE();
 
    KeWaitForSingleObject(&m_ForwardProgressMutex, Executive, KernelMode, FALSE, NULL);
 
    /* The thread stays even when a later step fails */
    Status = (m_WorkerThread == NULL) ? StartWorkerThread() : STATUS_SUCCESS;
 
    if (NT_SUCCESS(Status) && !m_HcdReservedIoReady)
    {
        HcdEnable = HcdEnableForwardProgress();
        if (HcdEnable != NULL)
        {
            Status = HcdEnable(m_Handle);
            if (NT_SUCCESS(Status))
                m_HcdReservedIoReady = TRUE;
            else
                DPRINT1("Controller %p HCD forward progress enable failed 0x%lx\n", this, Status);
        }
    }
 
    if (NT_SUCCESS(Status))
    {
        Device = UcxUsbDevice::FromHandle(Info->Device);
        if (Device->IsRootHub())
            Status = m_RootHub->EnableForwardProgress();
        else
            Status = Device->EnableForwardProgress(Info);
 
        if (!NT_SUCCESS(Status))
            DPRINT1("Controller %p forward progress for device %p failed 0x%lx\n", this, Device, Status);
    }
 
    KeReleaseMutex(&m_ForwardProgressMutex, FALSE);
    return Status;
}

UcxCopyIdString()

static NTSTATUS NTAPI UcxCopyIdString ( _In_ PCUNICODE_STRING  Source, _Out_ PUNICODE_STRING  Copy  )

static

NUL terminated copy owned by the controller.

Definition at line 322 of file hostctl.cpp.

{
    USHORT Size = Source->Length + sizeof(UNICODE_NULL);
 
    Copy->Buffer = (PWCH)ExAllocatePoolWithTag(NonPagedPool, Size, UCX_POOL_TAG);
    if (Copy->Buffer == NULL)
    {
        Copy->Length = 0;
        Copy->MaximumLength = 0;
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    RtlCopyMemory(Copy->Buffer, Source->Buffer, Source->Length);
    Copy->Buffer[Source->Length / sizeof(WCHAR)] = UNICODE_NULL;
    Copy->Length = Source->Length;
    Copy->MaximumLength = Size;
 
    return STATUS_SUCCESS;
}

Referenced by UcxController::SetIdStrings().

UcxFreeIdString()

static VOID NTAPI UcxFreeIdString ( _Inout_ PUNICODE_STRING  String )

static

Definition at line 347 of file hostctl.cpp.

{
    if (String->Buffer != NULL)
        ExFreePoolWithTag(String->Buffer, UCX_POOL_TAG);
 
    RtlZeroMemory(String, sizeof(*String));
}

Referenced by UcxController::Destroy(), and UcxController::SetIdStrings().

UcxIsAcceptedConfigSize()

static BOOLEAN NTAPI UcxIsAcceptedConfigSize ( _In_ ULONG  Size )

static

Config sizes the HCD may pass, one per UCX_CONTROLLER_CONFIG generation.

Definition at line 31 of file hostctl.cpp.

{
    return Size == UCX_CONFIG_SIZE_V1 ||
           Size == UCX_CONFIG_SIZE_V3 ||
           Size == UCX_CONFIG_SIZE_V4;
}

Referenced by UcxController::Create().

UcxIsValidIdString()

static BOOLEAN NTAPI UcxIsValidIdString ( _In_opt_ PCUNICODE_STRING  String )

static

Leaves room for the terminator the copy adds.

Definition at line 306 of file hostctl.cpp.

{
    if (String == NULL || (String->Length % sizeof(WCHAR)) != 0)
        return FALSE;
 
    if (String->Length > MAXUSHORT - sizeof(UNICODE_NULL))
        return FALSE;
 
    return String->Length == 0 || String->Buffer != NULL;
}

Referenced by UcxController::SetIdStrings().