controller.cpp File Reference

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

Include dependency graph for controller.cpp:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
	_IRQL_requires_ (PASSIVE_LEVEL) static NTSTATUS NTAPI XhciCreateUcxController(_In_ PXHCI_CONTROLLER Controller)
	Sends a synchronous IOCTL to the specified device object.
NTSTATUS NTAPI	XhciEvtDeviceAdd (_In_ WDFDRIVER Driver, _Inout_ PWDFDEVICE_INIT DeviceInit)
NTSTATUS NTAPI	XhciEvtDevicePrepareHardware (_In_ WDFDEVICE Device, _In_ WDFCMRESLIST ResourcesRaw, _In_ WDFCMRESLIST ResourcesTranslated)
NTSTATUS NTAPI	XhciEvtDeviceReleaseHardware (_In_ WDFDEVICE Device, _In_ WDFCMRESLIST ResourcesTranslated)
NTSTATUS NTAPI	XhciEvtDeviceD0Entry (_In_ WDFDEVICE Device, _In_ WDF_POWER_DEVICE_STATE PreviousState)
NTSTATUS NTAPI	XhciEvtDeviceD0Exit (_In_ WDFDEVICE Device, _In_ WDF_POWER_DEVICE_STATE TargetState)
VOID NTAPI	XhciEvtIoDeviceControl (_In_ WDFQUEUE Queue, _In_ WDFREQUEST Request, _In_ size_t OutputBufferLength, _In_ size_t InputBufferLength, _In_ ULONG IoControlCode)
NTSTATUS NTAPI	XhciEvtControllerQueryUsbCapability (_In_ UCXCONTROLLER UcxController, _In_ PGUID CapabilityType, _In_ ULONG OutputBufferLength, _Out_writes_bytes_opt_(OutputBufferLength) PVOID OutputBuffer, _Out_ PULONG ResultLength)
NTSTATUS NTAPI	XhciEvtControllerGetCurrentFrameNumber (_In_ UCXCONTROLLER UcxController, _Out_ PULONG FrameNumber)
VOID NTAPI	XhciEvtControllerReset (_In_ UCXCONTROLLER UcxController)

Macro Definition Documentation

NDEBUG

#define NDEBUG

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

{
    UCX_CONTROLLER_CONFIG Config;
    WDF_OBJECT_ATTRIBUTES Attributes;
    NTSTATUS Status;
 
    UCX_CONTROLLER_CONFIG_INIT(&Config, "ReactOS xHCI Host Controller");
    Config.EvtControllerQueryUsbCapability = XhciEvtControllerQueryUsbCapability;
    Config.EvtControllerGetCurrentFrameNumber = XhciEvtControllerGetCurrentFrameNumber;
    Config.EvtControllerUsbDeviceAdd = XhciEvtControllerUsbDeviceAdd;
    Config.EvtControllerReset = XhciEvtControllerReset;
 
    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&Attributes, XHCI_UCX_CONTROLLER_CONTEXT);
 
    Status = UcxControllerCreate(Controller->Device, &Config, &Attributes, &Controller->UcxController);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("UcxControllerCreate failed 0x%lx\n", Status);
        return Status;
    }
 
    XhciGetUcxControllerContext(Controller->UcxController)->Controller = Controller;
    return STATUS_SUCCESS;
}

XhciEvtControllerGetCurrentFrameNumber()

NTSTATUS NTAPI XhciEvtControllerGetCurrentFrameNumber	(	_In_ UCXCONTROLLER	UcxController,
		_Out_ PULONG	FrameNumber
	)

Definition at line 196 of file controller.cpp.

{
    UNREFERENCED_PARAMETER(UcxController);
 
    /* MFINDEX >> 3 once the runtime registers are mapped */
    *FrameNumber = 0;
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

XhciEvtControllerQueryUsbCapability()

NTSTATUS NTAPI XhciEvtControllerQueryUsbCapability	(	_In_ UCXCONTROLLER	UcxController,
		_In_ PGUID	CapabilityType,
		_In_ ULONG	OutputBufferLength,
		_Out_writes_bytes_opt_(OutputBufferLength) PVOID	OutputBuffer,
		_Out_ PULONG	ResultLength
	)

Definition at line 178 of file controller.cpp.

{
    UNREFERENCED_PARAMETER(UcxController);
    UNREFERENCED_PARAMETER(CapabilityType);
    UNREFERENCED_PARAMETER(OutputBufferLength);
    UNREFERENCED_PARAMETER(OutputBuffer);
 
    *ResultLength = 0;
    return STATUS_NOT_SUPPORTED;
}

XhciEvtControllerReset()

VOID NTAPI XhciEvtControllerReset

(

_In_ UCXCONTROLLER

UcxController

)

Definition at line 210 of file controller.cpp.

{
    UCX_CONTROLLER_RESET_COMPLETE_INFO Info;
 
    UNIMPLEMENTED;
 
    UCX_CONTROLLER_RESET_COMPLETE_INFO_INIT(&Info, UcxControllerStateLost, TRUE);
    UcxControllerResetComplete(UcxController, &Info);
}

XhciEvtDeviceAdd()

NTSTATUS NTAPI XhciEvtDeviceAdd	(	_In_ WDFDRIVER	Driver,
		_Inout_ PWDFDEVICE_INIT	DeviceInit
	)

Definition at line 45 of file controller.cpp.

{
    WDF_PNPPOWER_EVENT_CALLBACKS PnpPower;
    WDF_OBJECT_ATTRIBUTES Attributes;
    WDF_IO_QUEUE_CONFIG QueueConfig;
    PXHCI_CONTROLLER Controller;
    WDFDEVICE Device;
    NTSTATUS Status;
 
    UNREFERENCED_PARAMETER(Driver);
    PAGED_CODE();
 
    WDF_PNPPOWER_EVENT_CALLBACKS_INIT(&PnpPower);
    PnpPower.EvtDevicePrepareHardware = XhciEvtDevicePrepareHardware;
    PnpPower.EvtDeviceReleaseHardware = XhciEvtDeviceReleaseHardware;
    PnpPower.EvtDeviceD0Entry = XhciEvtDeviceD0Entry;
    PnpPower.EvtDeviceD0Exit = XhciEvtDeviceD0Exit;
    WdfDeviceInitSetPnpPowerEventCallbacks(DeviceInit, &PnpPower);
 
    Status = UcxInitializeDeviceInit(DeviceInit);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("UcxInitializeDeviceInit failed 0x%lx\n", Status);
        return Status;
    }
 
    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&Attributes, XHCI_CONTROLLER);
 
    Status = WdfDeviceCreate(&DeviceInit, &Attributes, &Device);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("WdfDeviceCreate failed 0x%lx\n", Status);
        return Status;
    }
 
    Controller = XhciGetController(Device);
    Controller->Device = Device;
 
    /* UCX gets first look at every IOCTL sent to the controller */
    WDF_IO_QUEUE_CONFIG_INIT_DEFAULT_QUEUE(&QueueConfig, WdfIoQueueDispatchParallel);
    QueueConfig.EvtIoDeviceControl = XhciEvtIoDeviceControl;
 
    Status = WdfIoQueueCreate(Device, &QueueConfig, WDF_NO_OBJECT_ATTRIBUTES, WDF_NO_HANDLE);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("WdfIoQueueCreate failed 0x%lx\n", Status);
        return Status;
    }
 
    Status = XhciCreateUcxController(Controller);
    if (!NT_SUCCESS(Status))
        return Status;
 
    return XhciRootHubCreate(Controller);
}

XhciEvtDeviceD0Entry()

NTSTATUS NTAPI XhciEvtDeviceD0Entry	(	_In_ WDFDEVICE	Device,
		_In_ WDF_POWER_DEVICE_STATE	PreviousState
	)

Definition at line 134 of file controller.cpp.

{
    UNREFERENCED_PARAMETER(Device);
    UNREFERENCED_PARAMETER(PreviousState);
 
    /* Reset and start the controller */
    UNIMPLEMENTED;
    return STATUS_SUCCESS;
}

XhciEvtDeviceD0Exit()

NTSTATUS NTAPI XhciEvtDeviceD0Exit	(	_In_ WDFDEVICE	Device,
		_In_ WDF_POWER_DEVICE_STATE	TargetState
	)

Definition at line 148 of file controller.cpp.

{
    UNREFERENCED_PARAMETER(Device);
    UNREFERENCED_PARAMETER(TargetState);
 
    UNIMPLEMENTED;
    return STATUS_SUCCESS;
}

XhciEvtDevicePrepareHardware()

NTSTATUS NTAPI XhciEvtDevicePrepareHardware	(	_In_ WDFDEVICE	Device,
		_In_ WDFCMRESLIST	ResourcesRaw,
		_In_ WDFCMRESLIST	ResourcesTranslated
	)

Definition at line 105 of file controller.cpp.

{
    UNREFERENCED_PARAMETER(Device);
    UNREFERENCED_PARAMETER(ResourcesRaw);
    UNREFERENCED_PARAMETER(ResourcesTranslated);
 
    /* Map the MMIO BAR, read capability registers, connect the interrupt */
    UNIMPLEMENTED;
    return STATUS_SUCCESS;
}

XhciEvtDeviceReleaseHardware()

NTSTATUS NTAPI XhciEvtDeviceReleaseHardware	(	_In_ WDFDEVICE	Device,
		_In_ WDFCMRESLIST	ResourcesTranslated
	)

Definition at line 121 of file controller.cpp.

{
    UNREFERENCED_PARAMETER(Device);
    UNREFERENCED_PARAMETER(ResourcesTranslated);
 
    UNIMPLEMENTED;
    return STATUS_SUCCESS;
}

XhciEvtIoDeviceControl()

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

Definition at line 161 of file controller.cpp.

{
    WDFDEVICE Device = WdfIoQueueGetDevice(Queue);
 
    if (UcxIoDeviceControl(Device, Request, OutputBufferLength, InputBufferLength, IoControlCode))
        return;
 
    WdfRequestComplete(Request, STATUS_INVALID_DEVICE_REQUEST);
}