#include <pipe.h>

Collaboration diagram for UcxStaticStreams:

[legend]

Public Member Functions
VOID	SetStreamInfo (_In_ PSTREAM_INFO StreamInfo)

UcxStream *	Stream (_In_ ULONG Index)

Static Public Member Functions
static _Must_inspect_result_ NTSTATUS	Create (_In_ UCXENDPOINT Endpoint, _Inout_ PUCXSSTREAMS_INIT Init, _In_opt_ PWDF_OBJECT_ATTRIBUTES Attributes, _Out_ UCXSSTREAMS StaticStreams)

static UcxStaticStreams *	FromHandle (_In_ UCXSSTREAMS Handle)

Public Attributes
UCXSSTREAMS	m_Handle

ULONG	m_StreamCount

UcxEndpoint *	m_Endpoint

UcxStaticStreamsInit *	m_Init

Static Private Attributes
static EVT_WDF_OBJECT_CONTEXT_DESTROY	EvtDestroy

Detailed Description

Definition at line 351 of file pipe.h.

Member Function Documentation

◆ Create()

_Must_inspect_result_ NTSTATUS UcxStaticStreams::Create	(	_In_ UCXENDPOINT	Endpoint,
		_Inout_ PUCXSSTREAMS_INIT *	Init,
		_In_opt_ PWDF_OBJECT_ATTRIBUTES	Attributes,
		_Out_ UCXSSTREAMS *	StaticStreams
	)

static

Definition at line 531 of file pipe.cpp.

{
    UcxStaticStreamsInit* StreamsInit = *Init;
    WDF_OBJECT_ATTRIBUTES Primary;
    UcxStaticStreams* Context;
    WDFOBJECT Object;
    NTSTATUS Status;
 
    *StaticStreams = NULL;
 
    /* The stream entries follow the context in the same allocation */
    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&Primary, UcxStaticStreams);
    Primary.ContextSizeOverride = sizeof(UcxStaticStreams) + StreamsInit->StreamCount * sizeof(UcxStream);
    Primary.ParentObject = StreamsInit->Endpoint;
    Primary.EvtDestroyCallback = EvtDestroy;
 
    Status = UcxCreateObjectWithTwoContexts(&Primary, Attributes, &Object);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Streams object create failed for endpoint %p 0x%lx\n", Endpoint, Status);
        return Status;
    }
 
    Context = new (UcxGetStaticStreamsContext(Object)) UcxStaticStreams();
    Context->m_Handle = (UCXSSTREAMS)Object;
    Context->m_StreamCount = StreamsInit->StreamCount;
    Context->m_Endpoint = UcxEndpoint::FromHandle(Endpoint);
    Context->m_Init = StreamsInit;
 
    StreamsInit->Created = Context->m_Handle;
    *StaticStreams = Context->m_Handle;
    *Init = NULL;
 
    return STATUS_SUCCESS;
}

Referenced by Create().

◆ FromHandle()

UcxStaticStreams * UcxStaticStreams::FromHandle ( _In_ UCXSSTREAMS Handle )

static

Definition at line 523 of file pipe.cpp.

{
    return UcxGetStaticStreamsContext(Handle);
}

Referenced by FromHandle().

◆ SetStreamInfo()

VOID UcxStaticStreams::SetStreamInfo ( _In_ PSTREAM_INFO StreamInfo )

Called per stream with IDs counting up from 1; a bad call fails the whole set.

Definition at line 573 of file pipe.cpp.

{
    BOOLEAN Verifying = m_Endpoint->m_Controller->m_DriverVerifierEnabled;
    UcxStaticStreamsInit* Init = m_Init;
    UcxPipe* EndpointPipe = &m_Endpoint->m_Pipe;
    UcxStream* Entry;
    ULONG Index;
 
    if (Init == NULL)
    {
        DPRINT1("Streams %p stream info set outside the add callback\n", m_Handle);
        UcxVerifierBreak(Verifying);
        return;
    }
 
    if (StreamInfo->Size != sizeof(*StreamInfo))
    {
        DPRINT1("Streams %p stream info has bad size %lu\n", m_Handle, StreamInfo->Size);
        Init->Failed = TRUE;
        UcxVerifierBreak(Verifying);
        return;
    }
 
    /* Counted even when this call then fails */
    Index = Init->SetInfoCalls++;
 
    if (Index >= m_StreamCount || StreamInfo->StreamId != Index + 1 || StreamInfo->WdfQueue == NULL)
    {
        DPRINT1("Streams %p bad stream info at call %lu, stream ID %lu, queue %p\n",
                m_Handle, Index, StreamInfo->StreamId, StreamInfo->WdfQueue);
        Init->Failed = TRUE;
        UcxVerifierBreak(Verifying);
        return;
    }
 
    WdfObjectReference(StreamInfo->WdfQueue);
 
    Entry = Stream(Index);
    Entry->Filled = TRUE;
    Entry->Index = Index;
    Entry->Streams = this;
    Entry->StreamId = StreamInfo->StreamId;
    Entry->Pipe.Queue = StreamInfo->WdfQueue;
    Entry->Pipe.Endpoint = m_Endpoint;
    Entry->Pipe.TransferType = UcxTransferType::Bulk;
    Entry->Pipe.Kind = UcxEndpointKind::Generic;
    Entry->Pipe.BelongsToStream = TRUE;
    Entry->Pipe.DirectionIn = EndpointPipe->DirectionIn;
    Entry->Pipe.MaximumTransferSize = EndpointPipe->MaximumTransferSize;
    Entry->Pipe.Self = &Entry->Pipe;
}

Referenced by SetStreamInfo(), and UcxApiStaticStreamsSetStreamInfo().

◆ Stream()

UcxStream * UcxStaticStreams::Stream ( _In_ ULONG Index )

inline

Definition at line 373 of file pipe.h.

    {
        return &((UcxStream*)(this + 1))[Index];
    }

Referenced by UcxEndpoint::OpenStaticStreamsComplete(), and UcxCreateStaticStreams().

Member Data Documentation

◆ EvtDestroy

VOID NTAPI UcxStaticStreams::EvtDestroy

staticprivate

Definition at line 389 of file pipe.h.

Referenced by Create().

◆ m_Endpoint

UcxEndpoint* UcxStaticStreams::m_Endpoint

Definition at line 382 of file pipe.h.

Referenced by SetStreamInfo().

◆ m_Handle

UCXSSTREAMS UcxStaticStreams::m_Handle

Definition at line 380 of file pipe.h.

Referenced by Create(), EndpointMachine::FinishStreamsCloseRequest(), EndpointMachine::ForwardStreamsDisableRequest(), EndpointMachine::ForwardStreamsEnableRequest(), UcxEndpoint::GetStaticStreamsReferenced(), UcxEndpoint::OpenStaticStreamsComplete(), and SetStreamInfo().

◆ m_Init

UcxStaticStreamsInit* UcxStaticStreams::m_Init

Definition at line 385 of file pipe.h.

Referenced by SetStreamInfo(), and UcxCreateStaticStreams().

◆ m_StreamCount

ULONG UcxStaticStreams::m_StreamCount

Definition at line 381 of file pipe.h.

Referenced by UcxEndpoint::OpenStaticStreamsComplete(), and SetStreamInfo().

The documentation for this class was generated from the following files:

drivers/usb/ucx01000/pipe.h
drivers/usb/ucx01000/pipe.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Static Private Attributes