reqctx.h

Go to the documentation of this file.

/*
 * PROJECT:     ReactOS xHCI Host Controller Driver
 * LICENSE:     MIT (https://spdx.org/licenses/MIT)
 * PURPOSE:     Per request context shared by every WDFREQUEST the driver handles
 * COPYRIGHT:   Copyright 2026 Justin Miller <justin.miller@reactos.org>
 */
 
#pragma once
 
/* Control transfers */
 
enum class XhciControlMechanism : ULONG
{
    NoData,
    Immediate,
    DoubleBuffer,
    Dma
};
 
enum class XhciControlCancel : ULONG
{
    Idle,
    Armed,
    CancelRoutinePending,
    Done
};
 
enum class XhciControlTimeout : ULONG
{
    Idle,
    Armed,
    TimerRoutinePending,
    Expired
};
 
struct XhciControlTransfer
{
    LIST_ENTRY Link;
    WDFREQUEST Request;
    PURB Urb;
    XhciTransferRing* Ring;
    XhciControlMechanism Mechanism;
    PMDL Mdl;
    PVOID SystemBuffer;
    XhciDmaBuffer* DoubleBuffer;
    PSCATTER_GATHER_LIST SgList;
    ULONG BytesTotal;
    ULONG BytesTransferred;
    XhciControlCancel CancelState;
    XhciControlTimeout TimeoutState;
    NTSTATUS Status;
    ULONG CompletionCode;
    ULONG TdCount;
    ULONG EventsReceived;
    ULONG FirstIndex;               
    ULONG EndIndex;                 
    ULONG TagIndex;
    BOOLEAN Initialized;
    BOOLEAN TagArmed;
    BOOLEAN DataIn;
};
 
/* Endpoint requests */
 
struct XhciDefaultEndpointUpdate
{
    XhciEndpoint* Endpoint;
    XhciDmaBuffer* InputContext;
    ULONG MaxPacketSize;
    XhciCommand Command;
};
 
struct XhciEndpointReset
{
    XhciEndpoint* Endpoint;
    XhciDmaBuffer* InputContext;
    XhciCommand Command;
};
 
struct XhciStreamsConfigure
{
    XhciStreams* Streams;
};
 
/* Context of every request on the controller WDFDEVICE; one member is in use at a time, owned by the handling module */
union XhciRequestData
{
    UCHAR Raw[1];
 
    struct
    {
        BOOLEAN EnableFailed;
        BOOLEAN FirstCommandFailed;
    } EndpointsConfigure;
 
    XhciDefaultEndpointUpdate DefaultEndpointUpdate;
    XhciEndpointReset EndpointReset;
    XhciStreamsConfigure StreamsConfigure;
 
    XhciControlTransfer Control;
    XhciBulkTransfer Bulk;
    XhciIsochTransfer Isoch;
};
 
WDF_DECLARE_CONTEXT_TYPE_WITH_NAME(XhciRequestData, XhciGetRequestData);