cmdring.cpp File Reference

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

Include dependency graph for cmdring.cpp:

Go to the source code of this file.

Classes
struct	_XHCI_COMMAND_TIMER_CONTEXT

Macros
#define	NDEBUG

Typedefs
typedef struct _XHCI_COMMAND_TIMER_CONTEXT	XHCI_COMMAND_TIMER_CONTEXT
typedef struct _XHCI_COMMAND_TIMER_CONTEXT *	PXHCI_COMMAND_TIMER_CONTEXT

Functions
	WDF_DECLARE_CONTEXT_TYPE_WITH_NAME (XHCI_COMMAND_TIMER_CONTEXT, XhciGetCommandTimerContext)
static NTSTATUS NTAPI	XhciCmdStatusFromCode (_In_ XhciCompletionCode Code)
static XhciCommand *NTAPI	XhciCmdFromLink (_In_ PLIST_ENTRY Entry)
static VOID NTAPI	XhciCmdCompleteList (_Inout_ PLIST_ENTRY Finished)
static VOID NTAPI	XhciCmdWaiterDone (_In_ XhciCommand *Command)

Variables
static const ULONG	XhciCmdTrbCount = 32
static const ULONG	XhciCmdUsable = XhciCmdTrbCount - 1
static const LONG	XhciCmdTicksInitial = 10
static const LONG	XhciCmdTicksFirstAbort = 5
static const LONG	XhciCmdTicksAbortWait = 5
static const ULONG	XhciCmdTickMs = 1000
static const ULONG	XhciCmdTickSlackMs = 500
static const ULONG	XhciCmdReasonAbortFailed = 0x1009
static const ULONG	XhciCmdReasonOutOfOrder = 0x1012
static const ULONG	XhciCmdReasonDequeueMismatch = 0x1013
static const ULONG	XhciCmdBlockSetAddress = 0x00000200

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 10 of file cmdring.cpp.

Typedef Documentation

PXHCI_COMMAND_TIMER_CONTEXT

typedef struct _XHCI_COMMAND_TIMER_CONTEXT * PXHCI_COMMAND_TIMER_CONTEXT

XHCI_COMMAND_TIMER_CONTEXT

typedef struct _XHCI_COMMAND_TIMER_CONTEXT XHCI_COMMAND_TIMER_CONTEXT

Function Documentation

WDF_DECLARE_CONTEXT_TYPE_WITH_NAME()

WDF_DECLARE_CONTEXT_TYPE_WITH_NAME	(	XHCI_COMMAND_TIMER_CONTEXT	,
		XhciGetCommandTimerContext
	)

XhciCmdCompleteList()

static VOID NTAPI XhciCmdCompleteList ( _Inout_ PLIST_ENTRY  Finished )

static

Calls Done for every command on the list, in order. No ring lock may be held.

Definition at line 67 of file cmdring.cpp.

{
    XhciCommand* Command;
 
    while (!IsListEmpty(Finished))
    {
        Command = XhciCmdFromLink(RemoveHeadList(Finished));
        XhciClearListEntry(&Command->Link);
        Command->Done(Command);
    }
}

Referenced by XhciCommandRing::FailEverything(), XhciCommandRing::HandleRingStopped(), XhciCommandRing::OnCompletionEvent(), XhciCommandRing::OnTimer(), XhciCommandRing::PostReset(), XhciCommandRing::PostResetSuccess(), and XhciCommandRing::Release().

XhciCmdFromLink()

static XhciCommand *NTAPI XhciCmdFromLink ( _In_ PLIST_ENTRY  Entry )

static

Definition at line 57 of file cmdring.cpp.

{
    return CONTAINING_RECORD(Entry, XhciCommand, Link);
}

Referenced by XhciCommandRing::DrainAllLocked(), XhciCommandRing::OnCompletionEvent(), XhciCommandRing::OnTimer(), XhciCommandRing::PostResetSuccess(), XhciCommandRing::RestartStoppedRingLocked(), and XhciCmdCompleteList().

XhciCmdStatusFromCode()

static NTSTATUS NTAPI XhciCmdStatusFromCode ( _In_ XhciCompletionCode  Code )

static

Definition at line 42 of file cmdring.cpp.

{
    if (Code == XhciCompletionCode::Success)
        return STATUS_SUCCESS;
 
    if (Code == XhciCompletionCode::CommandAborted)
        return STATUS_IO_TIMEOUT;
 
    return STATUS_UNSUCCESSFUL;
}

Referenced by XhciCommandRing::OnCompletionEvent().

XhciCmdWaiterDone()

static VOID NTAPI XhciCmdWaiterDone ( _In_ XhciCommand *  Command )

static

Definition at line 83 of file cmdring.cpp.

{
    PKEVENT Event = Command->WaiterEvent;
 
    if (Command->WaiterDone)
        Command->WaiterDone(Command);
 
    KeSetEvent(Event, IO_NO_INCREMENT, FALSE);
}

Variable Documentation

XhciCmdBlockSetAddress

const ULONG XhciCmdBlockSetAddress = 0x00000200

static

Definition at line 30 of file cmdring.cpp.

Referenced by XhciCommandRing::OnTimer().

XhciCmdReasonAbortFailed

const ULONG XhciCmdReasonAbortFailed = 0x1009

static

Definition at line 25 of file cmdring.cpp.

Referenced by XhciCommandRing::OnTimer().

XhciCmdReasonDequeueMismatch

const ULONG XhciCmdReasonDequeueMismatch = 0x1013

static

Definition at line 27 of file cmdring.cpp.

Referenced by XhciCommandRing::HandleRingStopped().

XhciCmdReasonOutOfOrder

const ULONG XhciCmdReasonOutOfOrder = 0x1012

static

Definition at line 26 of file cmdring.cpp.

Referenced by XhciCommandRing::OnCompletionEvent().

XhciCmdTickMs

const ULONG XhciCmdTickMs = 1000

static

Definition at line 21 of file cmdring.cpp.

Referenced by XhciCommandRing::Create(), and XhciCommandRing::PutOnRingLocked().

XhciCmdTicksAbortWait

const LONG XhciCmdTicksAbortWait = 5

static

Definition at line 20 of file cmdring.cpp.

Referenced by XhciCommandRing::OnTimer().

XhciCmdTicksFirstAbort

const LONG XhciCmdTicksFirstAbort = 5

static

Definition at line 19 of file cmdring.cpp.

Referenced by XhciCommandRing::OnTimer(), and XhciCommandRing::RestartStoppedRingLocked().

XhciCmdTicksInitial

const LONG XhciCmdTicksInitial = 10

static

Definition at line 18 of file cmdring.cpp.

Referenced by XhciCommandRing::OnTimer(), XhciCommandRing::PlaceLocked(), XhciCommandRing::PutOnRingLocked(), and XhciCommandRing::RestartStoppedRingLocked().

XhciCmdTickSlackMs

const ULONG XhciCmdTickSlackMs = 500

static

Definition at line 22 of file cmdring.cpp.

Referenced by XhciCommandRing::Create().

XhciCmdTrbCount

const ULONG XhciCmdTrbCount = 32

static

Definition at line 14 of file cmdring.cpp.

Referenced by XhciCommandRing::InitializeRing(), and XhciCommandRing::Prepare().

XhciCmdUsable

const ULONG XhciCmdUsable = XhciCmdTrbCount - 1

static

Definition at line 15 of file cmdring.cpp.

Referenced by XhciCommandRing::InitializeRing(), XhciCommandRing::OnCompletionEvent(), XhciCommandRing::PlaceLocked(), XhciCommandRing::Prepare(), XhciCommandRing::PutOnRingLocked(), and XhciCommandRing::RestartStoppedRingLocked().