intr.h

Go to the documentation of this file.

/*
 * PROJECT:     ReactOS xHCI Host Controller Driver
 * LICENSE:     MIT (https://spdx.org/licenses/MIT)
 * PURPOSE:     Interrupts, event rings and event dispatch
 * COPYRIGHT:   Copyright 2026 Justin Miller <justin.miller@reactos.org>
 */
 
#pragma once
 
class XhciController;
 
class XhciInterrupters
{
public:
    NTSTATUS
    Create(
        _In_ XhciController* Controller);
 
    NTSTATUS
    FilterResourceRequirements(
        _In_ WDFIORESREQLIST Requirements);
 
    NTSTATUS
    Prepare(
        _In_ WDFCMRESLIST Raw,
        _In_ WDFCMRESLIST Translated);
    VOID Release();
 
    NTSTATUS
    D0Entry(
        _In_ BOOLEAN StatePreserved);
    VOID D0ExitPreInterruptsDisabled();
    VOID D0Exit();
    VOID PostReset();
 
    ULONG Count() const;
 
    ULONG TargetForCurrentProcessor() const;
 
    ULONG
    TargetForProcessor(
        _In_ ULONG ProcessorIndex) const;
 
 
    NTSTATUS
    AffinitizeResourceRequirements(
        _In_ WDFIORESREQLIST Requirements);
 
    struct Interrupter
    {
        XhciController* Controller;
        WDFINTERRUPT Interrupt;
        ULONG Index;
        ULONG RegisterOffset;       
        USHORT Group;
        KAFFINITY Affinity;
 
        BOOLEAN MessageSignaled;
        BOOLEAN Prepared;
        BOOLEAN Enabled;
        BOOLEAN PendingDisable;     
        BOOLEAN DpcRunning;         
        ULONG SegmentSize;
        ULONG SegmentCount;
        ULONG TrbsPerSegment;
        ULONG CycleState;
        ULONG DequeueIndex;
        ULONG DequeueSegment;
        XhciDmaBuffer* Segment;     
        LIST_ENTRY SegmentList;
        XhciDmaBuffer* Erst;
 
        WDFWORKITEM Requeue;
        KEVENT RequeueIdle;
        KSPIN_LOCK Lock;
        ULONG RingFullCount;
    };
 
private:
    enum class Mechanism : ULONG
    {
        Line,
        Msi,
        MsiX
    };
 
    NTSTATUS
    PrepareOne(
        _Inout_ Interrupter* Entry,
        _In_ WDFINTERRUPT Interrupt,
        _In_ ULONG Index,
        _In_ BOOLEAN MessageSignaled);
 
    VOID
    ReleaseOne(
        _Inout_ Interrupter* Entry);
 
    NTSTATUS
    CreateInterrupt(
        _In_opt_ PCM_PARTIAL_RESOURCE_DESCRIPTOR Raw,
        _In_opt_ PCM_PARTIAL_RESOURCE_DESCRIPTOR Translated,
        _Out_ WDFINTERRUPT* Interrupt);
 
    ULONG
    SecondaryCountFor(
        _In_ ULONG Messages) const;
 
    NTSTATUS BuildLookup();
 
    XhciController* m_Controller;
    WDFINTERRUPT m_PrimaryInterrupt;
    Mechanism m_Mechanism;
    ULONG m_SecondaryCount;
    ULONG m_Count;              
    ULONG m_Capacity;
    Interrupter* m_Table;
    PUSHORT m_Lookup;
    ULONG m_LookupSize;
};