#include <fxusbpipe.hpp>

Inheritance diagram for FxUsbPipeRequestContext:

[legend]

Collaboration diagram for FxUsbPipeRequestContext:

[legend]

Public Member Functions
	FxUsbPipeRequestContext (__in FX_URB_TYPE FxUrbType)

	~FxUsbPipeRequestContext (VOID)

__checkReturn NTSTATUS	AllocateUrb (__in USBD_HANDLE USBDHandle)

virtual VOID	Dispose (VOID)

VOID	SetInfo (__in WDF_USB_REQUEST_TYPE Type, __in USBD_PIPE_HANDLE PipeHandle, __in USHORT Function)

VOID	SetInfo (__in WDF_USB_REQUEST_TYPE Type, __in WINUSB_INTERFACE_HANDLE WinUsbHandle, __in UCHAR PipeId, __in USHORT Function)

USBD_STATUS	GetUsbdStatus (VOID)

Public Member Functions inherited from FxUsbRequestContext
	FxUsbRequestContext (__in FX_REQUEST_CONTEXT_TYPE Type)

virtual USBD_STATUS	GetUsbdStatus (VOID)=0

virtual VOID	CopyParameters (__in FxRequestBase *Request)

VOID	SetUsbType (__in WDF_USB_REQUEST_TYPE Type)

VOID __inline	InitUsbParameters (VOID)

Public Member Functions inherited from FxRequestContext
	FxRequestContext (__in FX_REQUEST_CONTEXT_TYPE Type)

virtual	~FxRequestContext (VOID)

virtual VOID	Dispose (VOID)

virtual VOID	StoreAndReferenceMemory (__in FxRequestBuffer *Buffer)

virtual VOID	ReleaseAndRestore (__in FxRequestBase *Request)

__inline BOOLEAN	IsType (__in FX_REQUEST_CONTEXT_TYPE Type)

virtual VOID	CopyParameters (__in FxRequestBase *Request)

VOID	FormatWriteParams (__in_opt IFxMemory *WriteMemory, __in_opt PWDFMEMORY_OFFSET WriteOffsets)

VOID	FormatReadParams (__in_opt IFxMemory *ReadMemory, __in_opt PWDFMEMORY_OFFSET ReadOffsets)

VOID	FormatOtherParams (__in FxInternalIoctlParams *InternalIoctlParams)

Public Member Functions inherited from FxStump
PVOID	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)

PVOID	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in POOL_TYPE PoolType)

VOID	operator delete (__in PVOID pointer)

PVOID	operator new[] (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)

VOID	operator delete[] (__in PVOID pointer)

Public Attributes
_URB_PIPE_REQUEST	m_UrbLegacy

_URB_PIPE_REQUEST *	m_Urb

Public Attributes inherited from FxUsbRequestContext
WDF_USB_REQUEST_COMPLETION_PARAMS	m_UsbParameters

UMURB	m_UmUrb

Public Attributes inherited from FxRequestContext
WDF_REQUEST_COMPLETION_PARAMS	m_CompletionParams

IFxMemory *	m_RequestMemory

FX_REQUEST_CONTEXT_TYPE	m_RequestType

Private Attributes
USBD_HANDLE	m_USBDHandle

Additional Inherited Members
Protected Member Functions inherited from FxRequestContext
VOID __inline	InitCompletionParams (VOID)

Protected Member Functions inherited from FxStump
	FxStump (VOID)

Static Protected Member Functions inherited from FxRequestContext
static VOID	_StoreAndReferenceMemoryWorker (__in PVOID Tag, __deref_out_opt IFxMemory *PPMemory, __in FxRequestBuffer Buffer)

Detailed Description

Definition at line 123 of file fxusbpipe.hpp.

Constructor & Destructor Documentation

◆ FxUsbPipeRequestContext()

FxUsbPipeRequestContext::FxUsbPipeRequestContext ( __in FX_URB_TYPE FxUrbType )

Definition at line 966 of file fxusbpipe.cpp.

      :
    FxUsbRequestContext(FX_RCT_USB_PIPE_REQUEST)
{
    m_USBDHandle = NULL;
 
    if (FxUrbType == FxUrbTypeLegacy) {
        m_Urb = &m_UrbLegacy;
    }
    else {
        m_Urb = NULL;
    }
}

◆ ~FxUsbPipeRequestContext()

FxUsbPipeRequestContext::~FxUsbPipeRequestContext ( VOID )

Definition at line 981 of file fxusbpipe.cpp.

{
    if (m_Urb && (m_Urb != &m_UrbLegacy)) {
        USBD_UrbFree(m_USBDHandle, (PURB)m_Urb);
    }
    m_Urb = NULL;
    m_USBDHandle = NULL;
}

Member Function Documentation

◆ AllocateUrb()

__checkReturn NTSTATUS FxUsbPipeRequestContext::AllocateUrb ( __in USBD_HANDLE USBDHandle )

Definition at line 994 of file fxusbpipe.cpp.

{
    NTSTATUS status;
 
    if (m_Urb) {
        status = STATUS_INVALID_DEVICE_STATE;
        goto Done;
    }
 
    status = USBD_UrbAllocate(USBDHandle, (PURB*)&m_Urb);
 
    if (!NT_SUCCESS(status)) {
        goto Done;
    }
 
    m_USBDHandle = USBDHandle;
 
Done:
    return status;
}

Referenced by FxUsbPipe::FormatAbortRequest(), and FxUsbPipe::FormatResetRequest().

◆ Dispose()

VOID FxUsbPipeRequestContext::Dispose ( VOID )

virtual

Reimplemented from FxRequestContext.

Definition at line 1018 of file fxusbpipe.cpp.

{
    if (m_Urb && (m_Urb != &m_UrbLegacy)){
        USBD_UrbFree(m_USBDHandle, (PURB) m_Urb);
        m_Urb = NULL;
        m_USBDHandle = NULL;
    }
}

◆ GetUsbdStatus()

USBD_STATUS FxUsbPipeRequestContext::GetUsbdStatus ( VOID )

virtual

Implements FxUsbRequestContext.

Definition at line 1045 of file fxusbpipe.cpp.

{
    return m_Urb->Hdr.Status;
}

◆ SetInfo() [1/2]

VOID FxUsbPipeRequestContext::SetInfo	(	__in WDF_USB_REQUEST_TYPE	Type,
		__in USBD_PIPE_HANDLE	PipeHandle,
		__in USHORT	Function
	)

Definition at line 1030 of file fxusbpipe.cpp.

{
    RtlZeroMemory(m_Urb, sizeof(*m_Urb));
    m_Urb->Hdr.Length = sizeof(*m_Urb);
    m_Urb->Hdr.Function = Function;
    m_Urb->PipeHandle = PipeHandle;
 
    SetUsbType(Type);
}

Referenced by FxUsbPipe::FormatAbortRequest(), and FxUsbPipe::FormatResetRequest().

◆ SetInfo() [2/2]

VOID FxUsbPipeRequestContext::SetInfo	(	__in WDF_USB_REQUEST_TYPE	Type,
		__in WINUSB_INTERFACE_HANDLE	WinUsbHandle,
		__in UCHAR	PipeId,
		__in USHORT	Function
	)

Definition at line 13 of file fxusbpipeum.cpp.

{
    RtlZeroMemory(&m_UmUrb, sizeof(m_UmUrb));
 
    m_UmUrb.UmUrbPipeRequest.Hdr.InterfaceHandle = WinUsbHandle;
    m_UmUrb.UmUrbPipeRequest.Hdr.Function = Function;
    m_UmUrb.UmUrbPipeRequest.Hdr.Length = sizeof(m_UmUrb.UmUrbPipeRequest);
 
    m_UmUrb.UmUrbPipeRequest.PipeID = PipeId;
 
    SetUsbType(Type);
}

Member Data Documentation

◆ m_Urb

_URB_PIPE_REQUEST* FxUsbPipeRequestContext::m_Urb

Definition at line 175 of file fxusbpipe.hpp.

Referenced by AllocateUrb(), Dispose(), FxUsbPipe::FormatAbortRequest(), FxUsbPipe::FormatResetRequest(), FxUsbPipeRequestContext(), GetUsbdStatus(), SetInfo(), and ~FxUsbPipeRequestContext().

◆ m_UrbLegacy

_URB_PIPE_REQUEST FxUsbPipeRequestContext::m_UrbLegacy

Definition at line 170 of file fxusbpipe.hpp.

Referenced by Dispose(), FxUsbPipe::FormatAbortRequest(), FxUsbPipe::FormatResetRequest(), FxUsbPipeRequestContext(), and ~FxUsbPipeRequestContext().

◆ m_USBDHandle

USBD_HANDLE FxUsbPipeRequestContext::m_USBDHandle

private

Definition at line 167 of file fxusbpipe.hpp.

Referenced by AllocateUrb(), Dispose(), FxUsbPipeRequestContext(), and ~FxUsbPipeRequestContext().

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

sdk/lib/drivers/wdf/shared/inc/private/common/fxusbpipe.hpp
sdk/lib/drivers/wdf/shared/targets/usb/fxusbpipe.cpp
sdk/lib/drivers/wdf/shared/targets/usb/um/fxusbpipeum.cpp

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members