FxUsbPipeTransferContext Struct Reference

#include <fxusbpipe.hpp>

Inheritance diagram for FxUsbPipeTransferContext:

Collaboration diagram for FxUsbPipeTransferContext:

Public Member Functions
	FxUsbPipeTransferContext (__in FX_URB_TYPE UrbType)
	~FxUsbPipeTransferContext (VOID)
__checkReturn NTSTATUS	AllocateUrb (__in USBD_HANDLE USBDHandle)
virtual VOID	Dispose (VOID)
virtual VOID	CopyParameters (__in FxRequestBase *Request)
virtual VOID	StoreAndReferenceMemory (__in FxRequestBuffer *Buffer)
virtual VOID	ReleaseAndRestore (__in FxRequestBase *Request)
VOID	SetUrbInfo (__in USBD_PIPE_HANDLE PipeHandle, __in ULONG TransferFlags)
USBD_STATUS	GetUsbdStatus (VOID)
ULONG	GetUrbTransferLength (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_BULK_OR_INTERRUPT_TRANSFER	m_UrbLegacy
_URB_BULK_OR_INTERRUPT_TRANSFER *	m_Urb
PMDL	m_PartialMdl
BOOLEAN	m_UnlockPages
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 20 of file fxusbpipe.hpp.

Constructor & Destructor Documentation

FxUsbPipeTransferContext()

FxUsbPipeTransferContext::FxUsbPipeTransferContext

(

__in FX_URB_TYPE

UrbType

)

Definition at line 794 of file fxusbpipe.cpp.

      :
    FxUsbRequestContext(FX_RCT_USB_PIPE_XFER)
{
    m_UnlockPages = FALSE;
    m_PartialMdl = NULL;
    m_USBDHandle = NULL;
 
    if (FxUrbType == FxUrbTypeLegacy) {
        m_Urb = &m_UrbLegacy;
    }
    else {
        m_Urb = NULL;
    }
 
}

~FxUsbPipeTransferContext()

FxUsbPipeTransferContext::~FxUsbPipeTransferContext

(

VOID

)

Definition at line 812 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 FxUsbPipeTransferContext::AllocateUrb

(

__in USBD_HANDLE

USBDHandle

)

Definition at line 825 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::FormatTransferRequest().

CopyParameters()

VOID FxUsbPipeTransferContext::CopyParameters ( __in FxRequestBase *  Request )

virtual

Reimplemented from FxUsbRequestContext.

Definition at line 883 of file fxusbpipe.cpp.

{
    m_CompletionParams.IoStatus.Information = GetUrbTransferLength();
 
    //
    // If both are at the same offset, we don't have to compare type for
    // Read or Write
    //
    WDFCASSERT(FIELD_OFFSET(WDF_USB_REQUEST_COMPLETION_PARAMS,
                            Parameters.PipeRead.Length) ==
               FIELD_OFFSET(WDF_USB_REQUEST_COMPLETION_PARAMS,
                            Parameters.PipeWrite.Length));
 
    m_UsbParameters.Parameters.PipeRead.Length = GetUrbTransferLength();
    FxUsbRequestContext::CopyParameters(Request); // __super call
}

Dispose()

VOID FxUsbPipeTransferContext::Dispose ( VOID  )

virtual

Reimplemented from FxRequestContext.

Definition at line 849 of file fxusbpipe.cpp.

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

GetUrbTransferLength()

ULONG FxUsbPipeTransferContext::GetUrbTransferLength ( VOID  )

inline

Definition at line 71 of file fxusbpipe.hpp.

    {
#if (FX_CORE_MODE == FX_CORE_KERNEL_MODE)
        return m_Urb->TransferBufferLength;
#elif (FX_CORE_MODE == FX_CORE_USER_MODE)
        return m_UmUrb.UmUrbBulkOrInterruptTransfer.TransferBufferLength;
#endif
    }

Referenced by CopyParameters().

GetUsbdStatus()

USBD_STATUS FxUsbPipeTransferContext::GetUsbdStatus ( VOID  )

virtual

Implements FxUsbRequestContext.

Definition at line 913 of file fxusbpipe.cpp.

{
    return m_Urb->Hdr.Status;
}

ReleaseAndRestore()

VOID FxUsbPipeTransferContext::ReleaseAndRestore ( __in FxRequestBase *  Request )

virtual

Reimplemented from FxRequestContext.

Definition at line 861 of file fxusbpipe.cpp.

{
#if (FX_CORE_MODE == FX_CORE_KERNEL_MODE)
    //
    // Check now because Init will NULL out the field
    //
    if (m_PartialMdl != NULL) {
        if (m_UnlockPages) {
            MmUnlockPages(m_PartialMdl);
            m_UnlockPages = FALSE;
        }
 
        FxMdlFree(Request->GetDriverGlobals(), m_PartialMdl);
        m_PartialMdl = NULL;
    }
#endif
    FxUsbRequestContext::ReleaseAndRestore(Request); // __super call
}

SetUrbInfo()

VOID FxUsbPipeTransferContext::SetUrbInfo	(	__in USBD_PIPE_HANDLE	PipeHandle,
		__in ULONG	TransferFlags
	)

Definition at line 903 of file fxusbpipe.cpp.

{
    m_Urb->TransferFlags = TransferFlags;
    m_Urb->PipeHandle = PipeHandle;
}

Referenced by FxUsbPipe::FormatTransferRequest().

StoreAndReferenceMemory()

VOID FxUsbPipeTransferContext::StoreAndReferenceMemory ( __in FxRequestBuffer *  Buffer )

virtual

Reimplemented from FxRequestContext.

Definition at line 13 of file fxusbpipekm.cpp.

{
    RtlZeroMemory(m_Urb, sizeof(*m_Urb));
 
    m_Urb->Hdr.Function = URB_FUNCTION_BULK_OR_INTERRUPT_TRANSFER;
    m_Urb->Hdr.Length = sizeof(*m_Urb);
 
    FxUsbRequestContext::StoreAndReferenceMemory(Buffer); // __super call
 
    Buffer->AssignValues(&m_Urb->TransferBuffer,
                         &m_Urb->TransferBufferMDL,
                         &m_Urb->TransferBufferLength);
 
    //
    // If we have built a partial MDL, use that instead.  TransferBufferLength
    // is still valid because the Offsets or length in Buffer will have been
    // used to create this PartialMdl by the caller.
    //
    if (m_PartialMdl != NULL) {
        m_Urb->TransferBufferMDL = m_PartialMdl;
    }
}

Referenced by FxUsbPipe::FormatTransferRequest().

Member Data Documentation

m_PartialMdl

PMDL FxUsbPipeTransferContext::m_PartialMdl

Definition at line 93 of file fxusbpipe.hpp.

Referenced by FxUsbPipe::FormatTransferRequest(), FxUsbPipeTransferContext(), ReleaseAndRestore(), and StoreAndReferenceMemory().

m_UnlockPages

BOOLEAN FxUsbPipeTransferContext::m_UnlockPages

Definition at line 95 of file fxusbpipe.hpp.

Referenced by FxUsbPipe::FormatTransferRequest(), FxUsbPipeTransferContext(), and ReleaseAndRestore().

m_Urb

_URB_BULK_OR_INTERRUPT_TRANSFER* FxUsbPipeTransferContext::m_Urb

Definition at line 91 of file fxusbpipe.hpp.

Referenced by AllocateUrb(), Dispose(), FxUsbPipe::FormatTransferRequest(), FxUsbPipeTransferContext(), GetUrbTransferLength(), GetUsbdStatus(), SetUrbInfo(), StoreAndReferenceMemory(), and ~FxUsbPipeTransferContext().

m_UrbLegacy

_URB_BULK_OR_INTERRUPT_TRANSFER FxUsbPipeTransferContext::m_UrbLegacy

Definition at line 86 of file fxusbpipe.hpp.

Referenced by Dispose(), FxUsbPipe::FormatTransferRequest(), FxUsbPipeTransferContext(), and ~FxUsbPipeTransferContext().

m_USBDHandle

USBD_HANDLE FxUsbPipeTransferContext::m_USBDHandle

private

Definition at line 83 of file fxusbpipe.hpp.

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

---

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/km/fxusbpipekm.cpp
• sdk/lib/drivers/wdf/shared/targets/usb/um/fxusbpipeum.cpp