pipe.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	UcxPipe
struct	UcxEndpointCallbacks
struct	_UCXENDPOINT_INIT
struct	_UCXSSTREAMS_INIT
class	UcxEndpoint
struct	UcxStream
class	UcxStaticStreams

Typedefs
typedef _In_ ULONG	MaxTransferSize
typedef struct _UCXENDPOINT_INIT	UcxEndpointInit
typedef struct _UCXSSTREAMS_INIT	UcxStaticStreamsInit

Enumerations
enum class	UcxEndpointKind : ULONG { Generic = 0 , ZeroBandwidth = 1 , Default = 2 }
enum class	UcxTransferType : ULONG {   Unknown = 0 , Control = 1 , Bulk = 2 , Isochronous = 3 ,   Interrupt = 4 }

Functions
typedef	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS(NTAPI *PFN_UCX_HCD_ENDPOINT_ENABLE_FORWARD_PROGRESS)(_In_ UCXENDPOINT Endpoint
	Sends a synchronous IOCTL to the specified device object.
	WDF_DECLARE_CONTEXT_TYPE_WITH_NAME (UcxEndpoint, UcxGetEndpointContext)
	WDF_DECLARE_CONTEXT_TYPE_WITH_NAME (UcxStaticStreams, UcxGetStaticStreamsContext)
ULONG NTAPI	UcxComputeMaxTransferSize (_In_ USB_DEVICE_SPEED Speed, _In_ USHORT BcdUsb, _In_ const UcxEndpointInit *Init)

Typedef Documentation

MaxTransferSize

typedef _In_ ULONG MaxTransferSize

Definition at line 72 of file pipe.h.

UcxEndpointInit

typedef _In_ UCXUSBDEVICE _In_ ULONG _In_opt_ PUSB_SUPERSPEED_ENDPOINT_COMPANION_DESCRIPTOR _In_ PUCXENDPOINT_INIT UcxEndpointInit

Definition at line 107 of file pipe.h.

UcxStaticStreamsInit

typedef struct _UCXSSTREAMS_INIT UcxStaticStreamsInit

Definition at line 119 of file pipe.h.

Enumeration Type Documentation

UcxEndpointKind

enum class UcxEndpointKind : ULONG

strong

Enumerator
Generic
ZeroBandwidth
Default

Definition at line 12 of file pipe.h.

{
    Generic = 0,
    ZeroBandwidth = 1,
    Default = 2
};

UcxTransferType

enum class UcxTransferType : ULONG

strong

Enumerator
Unknown
Control
Bulk
Isochronous
Interrupt

Definition at line 19 of file pipe.h.

{
    Unknown = 0,
    Control = 1,
    Bulk = 2,
    Isochronous = 3,
    Interrupt = 4
};

Function Documentation

_IRQL_requires_()

typedef _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 2121 of file class.c.

{
    NTSTATUS status = STATUS_SUCCESS;
 
    PAGED_CODE();
 
    TracePrint((TRACE_LEVEL_VERBOSE,
                TRACE_FLAG_PNP,
                "ClassDetermineTokenOperationCommandSupport (%p): Entering function.\n",
                DeviceObject));
 
    //
    // Send down Inquiry for VPD_THIRD_PARTY_COPY_PAGE and cache away the device parameters
    // from WINDOWS_BLOCK_DEVICE_TOKEN_LIMITS_DESCRIPTOR.
    //
    status = ClasspGetBlockDeviceTokenLimitsInfo(DeviceObject);
 
    if (NT_SUCCESS(status)) {
 
        ULONG maxListIdentifier = MaxTokenOperationListIdentifier;
 
        //
        // Query the maximum list identifier to use for TokenOperation commands.
        //
        if (NT_SUCCESS(ClasspGetMaximumTokenListIdentifier(DeviceObject, REG_DISK_CLASS_CONTROL, &maxListIdentifier))) {
            if (maxListIdentifier >= MIN_TOKEN_LIST_IDENTIFIERS) {
 
                NT_ASSERT(maxListIdentifier <= MAX_TOKEN_LIST_IDENTIFIERS);
                MaxTokenOperationListIdentifier = maxListIdentifier;
            }
        }
 
    }
 
    TracePrint((TRACE_LEVEL_VERBOSE,
                TRACE_FLAG_PNP,
                "ClassDetermineTokenOperationCommandSupport (%p): Exiting function with status %x.\n",
                DeviceObject,
                status));
 
    return status;
}

UcxComputeMaxTransferSize()

ULONG NTAPI UcxComputeMaxTransferSize	(	_In_ USB_DEVICE_SPEED	Speed,
		_In_ USHORT	BcdUsb,
		_In_ const UcxEndpointInit *	Init
	)

Definition at line 49 of file pipe.cpp.

{
    ULONG Row = UcxSpeedRow(Speed);
    USHORT MaxPacket;
    ULONG PacketBytes;
 
    if (Init->TransferType != UcxTransferType::Isochronous)
    {
        if (Init->TransferType == UcxTransferType::Control &&
            UcxIsSlowSpeed(Speed) &&
            UcxDriver.Allow64KLowOrFullSpeedControl)
        {
            return UCX_KB(64);
        }
 
        return UcxMaxTransferTable[Row][(ULONG)Init->TransferType];
    }
 
    if (Row == (ULONG)UsbSuperSpeed)
    {
        if (Init->Companion.bmAttributes.Isochronous.SspCompanion)
            return 1024 * Init->IsochCompanion.dwBytesPerInterval;
 
        return 1024 * Init->Companion.wBytesPerInterval;
    }
 
    /* Before USB 2.5 the top bits carry the additional transactions per microframe */
    MaxPacket = Init->Descriptor.wMaxPacketSize;
    if (BcdUsb < 0x0250)
        PacketBytes = (MaxPacket & 0x7FF) * (((MaxPacket >> 11) & 0x3) + 1);
    else
        PacketBytes = MaxPacket;
 
    return ((Row == (ULONG)UsbHighSpeed) ? 1024 : 256) * PacketBytes;
}

Referenced by UcxEndpoint::Initialize().

WDF_DECLARE_CONTEXT_TYPE_WITH_NAME() [1/2]

WDF_DECLARE_CONTEXT_TYPE_WITH_NAME	(	UcxEndpoint	,
		UcxGetEndpointContext
	)

WDF_DECLARE_CONTEXT_TYPE_WITH_NAME() [2/2]

WDF_DECLARE_CONTEXT_TYPE_WITH_NAME	(	UcxStaticStreams	,
		UcxGetStaticStreamsContext
	)