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

Classes
struct	UcxXrbPreamble

Macros
#define	UCX_XRB_SIGNATURE 0x2E425258

#define	UCX_XRB_KIND_PLAIN 0xAABB0000

#define	UCX_XRB_KIND_CONFIG 0xAABB0001

#define	UCX_XRB_KIND_ALT_SETTING 0xAABB0002

#define	UCX_XRB_KIND_ISO_PACKETS 0xAABB0003

#define	UCX_XRB_IDLE 0xABCD0000

#define	UCX_XRB_IN_FLIGHT 0xABCD0001

#define	UCX_BUGCHECK_USB3 0x144

#define	UCX_USB3_ACTIVE_URB_REUSED 0x1

#define	UCX_USB3_XRB_CORRUPTED 0x3

#define	UCX_USB3_STREAMS_IRQL 0x800

#define	UCX_USB3_STREAMS_NOT_GRANTED 0x801

#define	UCX_USB3_STREAMS_BAD_COUNT 0x802

#define	UCX_USB3_STREAMS_OPEN 0x803

#define	UCX_USB3_HANDLE_LEAKED 0x804

#define	UCX_USB3_CHAINED_MDL 0x806

Functions
	C_ASSERT (sizeof(UcxXrbPreamble)==0x30)

	C_ASSERT (FIELD_OFFSET(UcxXrbPreamble, Signature)==sizeof(UcxXrbPreamble) - sizeof(ULONG))

FORCEINLINE UcxXrbPreamble *NTAPI	UcxXrbFromUrb (_In_ PURB Urb)

FORCEINLINE PURB NTAPI	UcxUrbFromXrb (_In_ UcxXrbPreamble *Xrb)

FORCEINLINE BOOLEAN NTAPI	UcxIsXrbIrp (_In_ PIRP Irp, _In_ PURB Urb)

FORCEINLINE VOID NTAPI	UcxXrbMarkInactive (_In_ PURB Urb)

NTSTATUS NTAPI	UcxProcessSubmitUrb (_In_ WDFDEVICE RootHubPdo, _In_ PIRP Irp)

NTSTATUS NTAPI	UcxCompleteUrb (_In_ PIRP Irp, _In_ PURB Urb, _In_ NTSTATUS Status, _In_ USBD_STATUS UsbdStatus)

VOID NTAPI	UcxCompleteUrbAtDispatch (_In_ PIRP Irp, _In_ PURB Urb, _In_ NTSTATUS Status, _In_ USBD_STATUS UsbdStatus)

VOID NTAPI	UcxCompleteHeldUrbIrp (_In_ PIRP Irp)

NTSTATUS NTAPI	UcxForwardStreamsUrb (_In_ WDFDEVICE RootHubPdo, _In_ PIRP Irp, _In_ PURB Urb, _In_ UcxController *Controller)

Macro Definition Documentation

◆ UCX_BUGCHECK_USB3

#define UCX_BUGCHECK_USB3 0x144

Definition at line 22 of file clientxrb.h.

◆ UCX_USB3_ACTIVE_URB_REUSED

#define UCX_USB3_ACTIVE_URB_REUSED 0x1

Definition at line 23 of file clientxrb.h.

◆ UCX_USB3_CHAINED_MDL

#define UCX_USB3_CHAINED_MDL 0x806

Definition at line 30 of file clientxrb.h.

◆ UCX_USB3_HANDLE_LEAKED

#define UCX_USB3_HANDLE_LEAKED 0x804

Definition at line 29 of file clientxrb.h.

◆ UCX_USB3_STREAMS_BAD_COUNT

#define UCX_USB3_STREAMS_BAD_COUNT 0x802

Definition at line 27 of file clientxrb.h.

◆ UCX_USB3_STREAMS_IRQL

#define UCX_USB3_STREAMS_IRQL 0x800

Definition at line 25 of file clientxrb.h.

◆ UCX_USB3_STREAMS_NOT_GRANTED

#define UCX_USB3_STREAMS_NOT_GRANTED 0x801

Definition at line 26 of file clientxrb.h.

◆ UCX_USB3_STREAMS_OPEN

#define UCX_USB3_STREAMS_OPEN 0x803

Definition at line 28 of file clientxrb.h.

◆ UCX_USB3_XRB_CORRUPTED

#define UCX_USB3_XRB_CORRUPTED 0x3

Definition at line 24 of file clientxrb.h.

◆ UCX_XRB_IDLE

#define UCX_XRB_IDLE 0xABCD0000

Definition at line 18 of file clientxrb.h.

◆ UCX_XRB_IN_FLIGHT

#define UCX_XRB_IN_FLIGHT 0xABCD0001

Definition at line 19 of file clientxrb.h.

◆ UCX_XRB_KIND_ALT_SETTING

#define UCX_XRB_KIND_ALT_SETTING 0xAABB0002

Definition at line 15 of file clientxrb.h.

◆ UCX_XRB_KIND_CONFIG

#define UCX_XRB_KIND_CONFIG 0xAABB0001

Definition at line 14 of file clientxrb.h.

◆ UCX_XRB_KIND_ISO_PACKETS

#define UCX_XRB_KIND_ISO_PACKETS 0xAABB0003

Definition at line 16 of file clientxrb.h.

◆ UCX_XRB_KIND_PLAIN

#define UCX_XRB_KIND_PLAIN 0xAABB0000

Definition at line 13 of file clientxrb.h.

◆ UCX_XRB_SIGNATURE

#define UCX_XRB_SIGNATURE 0x2E425258

Definition at line 11 of file clientxrb.h.

Function Documentation

◆ C_ASSERT() [1/2]

C_ASSERT ( FIELD_OFFSET(UcxXrbPreamble, Signature) = =sizeof(UcxXrbPreamble) - sizeof(ULONG) )

◆ C_ASSERT() [2/2]

C_ASSERT ( sizeof(UcxXrbPreamble) = =0x30 )

◆ UcxCompleteHeldUrbIrp()

VOID NTAPI UcxCompleteHeldUrbIrp ( _In_ PIRP Irp )

Completes an IRP held after STATUS_MORE_PROCESSING_REQUIRED, statuses as they are.

Definition at line 61 of file clientxrb.cpp.

{
    PURB Urb = (PURB)IoGetCurrentIrpStackLocation(Irp)->Parameters.Others.Argument1;
 
    if (UcxIsXrbIrp(Irp, Urb))
        UcxXrbMarkInactive(Urb);
 
    IoCompleteRequest(Irp, IO_NO_INCREMENT);
}

Referenced by EndpointMachine::FinishStreamsCloseRequest(), EndpointMachine::FinishStreamsOpenRequest(), and UcxEndpoint::OpenStaticStreamsComplete().

◆ UcxCompleteUrb()

NTSTATUS NTAPI UcxCompleteUrb	(	_In_ PIRP	Irp,
		_In_ PURB	Urb,
		_In_ NTSTATUS	Status,
		_In_ USBD_STATUS	UsbdStatus
	)

Sets both statuses and completes at the current IRQL; returns Status.

Definition at line 23 of file clientxrb.cpp.

{
    if (UcxIsXrbIrp(Irp, Urb))
        UcxXrbMarkInactive(Urb);
 
    Urb->UrbHeader.Status = UsbdStatus;
    Irp->IoStatus.Status = Status;
    Irp->IoStatus.Information = 0;
    IoCompleteRequest(Irp, IO_NO_INCREMENT);
 
    return Status;
}

Referenced by UcxEndpoint::AbortPipe(), UcxEndpoint::CloseStaticStreams(), UcxEndpoint::GetIsochPathDelays(), UcxCompleteUrbAtDispatch(), UcxFailStreamsUrb(), UcxHandleGetCurrentFrame(), UcxHandleIsoch(), UcxHandleStandardRequest(), UcxProcessLegacyUrb(), and UcxXrbSubmitChainedMdlTransfer().

◆ UcxCompleteUrbAtDispatch()

VOID NTAPI UcxCompleteUrbAtDispatch	(	_In_ PIRP	Irp,
		_In_ PURB	Urb,
		_In_ NTSTATUS	Status,
		_In_ USBD_STATUS	UsbdStatus
	)

Same, but plain URBs complete at DISPATCH_LEVEL as they did under USBPORT.

Definition at line 42 of file clientxrb.cpp.

{
    if (UcxIsXrbIrp(Irp, Urb))
    {
        UcxCompleteUrb(Irp, Urb, Status, UsbdStatus);
        return;
    }
 
    DispatchLevelGuard Raise;
    UcxCompleteUrb(Irp, Urb, Status, UsbdStatus);
}

Referenced by EndpointMachine::CompleteAbortUrb(), and UcxCsqCompleteCanceledAbortIrp().

◆ UcxForwardStreamsUrb()

NTSTATUS NTAPI UcxForwardStreamsUrb	(	_In_ WDFDEVICE	RootHubPdo,
		_In_ PIRP	Irp,
		_In_ PURB	Urb,
		_In_ UcxController *	Controller
	)

Definition at line 212 of file clientxrb.cpp.

{
    Urb->UrbHeader.Status = USBD_STATUS_PENDING;
 
    return UcxForwardIrpToQueue(RootHubPdo, Irp, UcxXrbStreamsCompletion, Urb, Controller->m_DeviceMgmtQueue);
}

Referenced by UcxEndpoint::CloseStaticStreams(), and UcxEndpoint::OpenStaticStreams().

◆ UcxIsXrbIrp()

FORCEINLINE BOOLEAN NTAPI UcxIsXrbIrp	(	_In_ PIRP	Irp,
		_In_ PURB	Urb
	)

Definition at line 79 of file clientxrb.h.

{
    return IoGetCurrentIrpStackLocation(Irp)->FileObject == (PFILE_OBJECT)Urb;
}

Referenced by UcxCompleteHeldUrbIrp(), UcxCompleteUrb(), UcxCompleteUrbAtDispatch(), UcxLegacyTransferCompletion(), and UcxProcessSubmitUrb().

◆ UcxProcessSubmitUrb()

NTSTATUS NTAPI UcxProcessSubmitUrb	(	_In_ WDFDEVICE	RootHubPdo,
		_In_ PIRP	Irp
	)

Definition at line 169 of file clientxrb.cpp.

{
    PURB Urb = (PURB)IoGetCurrentIrpStackLocation(Irp)->Parameters.Others.Argument1;
 
    if (!UcxIsXrbIrp(Irp, Urb))
        return UcxProcessLegacyUrb(RootHubPdo, Irp, Urb);
 
    UcxXrbCheckOnSubmit(Irp, Urb);
 
    /* Older contracts take the legacy path; its completions reset the state */
    if (UcxXrbFromUrb(Urb)->ContractVersion < USBD_CLIENT_CONTRACT_VERSION_602)
        return UcxProcessLegacyUrb(RootHubPdo, Irp, Urb);
 
    switch (Urb->UrbHeader.Function)
    {
        case URB_FUNCTION_BULK_OR_INTERRUPT_TRANSFER:
        case URB_FUNCTION_ISOCH_TRANSFER:
            return UcxXrbSubmitTransfer(RootHubPdo, Irp, Urb);
 
        case URB_FUNCTION_BULK_OR_INTERRUPT_TRANSFER_USING_CHAINED_MDL:
        case URB_FUNCTION_ISOCH_TRANSFER_USING_CHAINED_MDL:
            return UcxXrbSubmitChainedMdlTransfer(RootHubPdo, Irp, Urb);
 
        case URB_FUNCTION_OPEN_STATIC_STREAMS:
            return UcxEndpoint::FromPipe(Urb->UrbOpenStaticStreams.PipeHandle)->OpenStaticStreams(Irp, Urb);
 
        /* The pipe handle sits at the same offset in both stream URBs */
        case URB_FUNCTION_CLOSE_STATIC_STREAMS:
            return UcxEndpoint::FromPipe(Urb->UrbOpenStaticStreams.PipeHandle)->CloseStaticStreams(Irp, Urb);
 
        /* Only XRBs reach this; a plain URB with this function is invalid */
        case URB_FUNCTION_GET_ISOCH_PIPE_TRANSFER_PATH_DELAYS:
            return UcxEndpoint::FromPipe(Urb->UrbGetIsochPipeTransferPathDelays.PipeHandle)->GetIsochPathDelays(Irp, Urb);
 
        default:
            return UcxProcessLegacyUrb(RootHubPdo, Irp, Urb);
    }
}

Referenced by UcxEvtRootHubPreprocessInternalIoctl().

◆ UcxUrbFromXrb()

FORCEINLINE PURB NTAPI UcxUrbFromXrb ( _In_ UcxXrbPreamble * Xrb )

Definition at line 69 of file clientxrb.h.

{
    return (PURB)(Xrb + 1);
}

Referenced by UcxClientAllocIsochUrb(), UcxClientAllocUrb(), UcxClientSelectConfigXrbBuild(), and UcxClientSelectInterfaceXrbBuild().

◆ UcxXrbFromUrb()

FORCEINLINE UcxXrbPreamble *NTAPI UcxXrbFromUrb ( _In_ PURB Urb )

Definition at line 60 of file clientxrb.h.

{
    return (UcxXrbPreamble*)Urb - 1;
}

Referenced by UcxEndpoint::OpenStaticStreams(), UcxClientReleaseUrb(), UcxProcessSubmitUrb(), UcxXrbCheckOnSubmit(), UcxXrbMarkInactive(), UcxXrbSubmitChainedMdlTransfer(), and UcxXrbSubmitTransfer().

◆ UcxXrbMarkInactive()

FORCEINLINE VOID NTAPI UcxXrbMarkInactive ( _In_ PURB Urb )

Definition at line 90 of file clientxrb.h.

{
    UcxXrbFromUrb(Urb)->State = UCX_XRB_IDLE;
}

Referenced by UcxCompleteHeldUrbIrp(), UcxCompleteUrb(), UcxLegacyTransferCompletion(), UcxXrbStreamsCompletion(), and UcxXrbTransferCompletion().

Classes

Macros

Functions