FxUsbDeviceControlContext Struct Reference

#include <fxusbdevice.hpp>

Inheritance diagram for FxUsbDeviceControlContext:

Collaboration diagram for FxUsbDeviceControlContext:

Public Member Functions
	FxUsbDeviceControlContext (__in FX_URB_TYPE FxUrbType)
	~FxUsbDeviceControlContext (VOID)
__checkReturn NTSTATUS	AllocateUrb (__in USBD_HANDLE USBDHandle)
virtual VOID	Dispose (VOID)
virtual VOID	CopyParameters (__in FxRequestBase *Request)
VOID	StoreAndReferenceMemory (__in FxUsbDevice *Device, __in FxRequestBuffer *Buffer, __in PWDF_USB_CONTROL_SETUP_PACKET SetupPacket)
virtual VOID	ReleaseAndRestore (__in FxRequestBase *Request)
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_CONTROL_TRANSFER	m_UrbLegacy
_URB_CONTROL_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 31 of file fxusbdevice.hpp.

Constructor & Destructor Documentation

FxUsbDeviceControlContext()

FxUsbDeviceControlContext::FxUsbDeviceControlContext

(

__in FX_URB_TYPE

FxUrbType

)

Definition at line 40 of file fxusbdevice.cpp.

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

~FxUsbDeviceControlContext()

FxUsbDeviceControlContext::~FxUsbDeviceControlContext

(

VOID

)

Definition at line 57 of file fxusbdevice.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 FxUsbDeviceControlContext::AllocateUrb

(

__in USBD_HANDLE

USBDHandle

)

Definition at line 70 of file fxusbdevice.cpp.

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

Referenced by FxUsbDevice::FormatControlRequest().

CopyParameters()

VOID FxUsbDeviceControlContext::CopyParameters ( __in FxRequestBase *  Request )

virtual

Reimplemented from FxUsbRequestContext.

Definition at line 104 of file fxusbdevice.cpp.

{
#if (FX_CORE_MODE == FX_CORE_KERNEL_MODE)
    m_CompletionParams.IoStatus.Information = m_Urb->TransferBufferLength;
    m_UsbParameters.Parameters.DeviceControlTransfer.Length = m_Urb->TransferBufferLength;
#elif (FX_CORE_MODE == FX_CORE_USER_MODE)
    m_CompletionParams.IoStatus.Information = m_UmUrb.UmUrbControlTransfer.TransferBufferLength;
    m_UsbParameters.Parameters.DeviceControlTransfer.Length = m_UmUrb.UmUrbControlTransfer.TransferBufferLength;
#endif
    FxUsbRequestContext::CopyParameters(Request); // __super call
}

Dispose()

VOID FxUsbDeviceControlContext::Dispose ( VOID  )

virtual

Reimplemented from FxRequestContext.

Definition at line 92 of file fxusbdevice.cpp.

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

GetUsbdStatus()

USBD_STATUS FxUsbDeviceControlContext::GetUsbdStatus ( VOID  )

virtual

Implements FxUsbRequestContext.

Definition at line 142 of file fxusbdevice.cpp.

{
    return m_Urb->Hdr.Status;
}

ReleaseAndRestore()

VOID FxUsbDeviceControlContext::ReleaseAndRestore ( __in FxRequestBase *  Request )

virtual

Reimplemented from FxRequestContext.

Definition at line 119 of file fxusbdevice.cpp.

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

StoreAndReferenceMemory()

VOID FxUsbDeviceControlContext::StoreAndReferenceMemory	(	__in FxUsbDevice *	Device,
		__in FxRequestBuffer *	Buffer,
		__in PWDF_USB_CONTROL_SETUP_PACKET	SetupPacket
	)

Definition at line 691 of file fxusbdevicekm.cpp.

{
    SetUsbType(WdfUsbRequestTypeDeviceControlTransfer);
 
    RtlZeroMemory(m_Urb, sizeof(*m_Urb));
 
    m_Urb->Hdr.Function = URB_FUNCTION_CONTROL_TRANSFER;
    m_Urb->Hdr.Length = sizeof(*m_Urb);
 
    FxUsbRequestContext::StoreAndReferenceMemory(Buffer); // __super call
 
    //
    // Set the values using what is stored in the buffer
    //
    Buffer->AssignValues(&m_Urb->TransferBuffer,
                         &m_Urb->TransferBufferMDL,
                         &m_Urb->TransferBufferLength);
 
    RtlCopyMemory(&m_Urb->SetupPacket[0],
                  &SetupPacket->Generic.Bytes[0],
                  sizeof(m_Urb->SetupPacket));
 
    //
    // also indicate the length of the buffer in the header
    //
    ((PWDF_USB_CONTROL_SETUP_PACKET) &m_Urb->SetupPacket[0])->Packet.wLength =
        (USHORT) m_Urb->TransferBufferLength;
 
    //
    // Control transfers are always short OK.  USBD_TRANSFER_DIRECTION_IN may
    // be OR'ed in later.
    //
    m_Urb->TransferFlags = USBD_SHORT_TRANSFER_OK;
 
    //
    // Get the direction out of the setup packet
    //
    if (SetupPacket->Packet.bm.Request.Dir == BMREQUEST_DEVICE_TO_HOST) {
        m_Urb->TransferFlags |= USBD_TRANSFER_DIRECTION_IN;
    }
 
    if (Device->OnUSBD()) {
        m_Urb->PipeHandle = Device->GetControlPipeHandle();
    }
    else {
        //
        // USBPORT supports this flag
        //
        m_Urb->TransferFlags |= USBD_DEFAULT_PIPE_TRANSFER;
    }
 
    //
    // 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 FxUsbDevice::FormatControlRequest().

Member Data Documentation

m_PartialMdl

PMDL FxUsbDeviceControlContext::m_PartialMdl

Definition at line 88 of file fxusbdevice.hpp.

Referenced by FxUsbDevice::FormatControlRequest(), FxUsbDeviceControlContext(), ReleaseAndRestore(), and StoreAndReferenceMemory().

m_UnlockPages

BOOLEAN FxUsbDeviceControlContext::m_UnlockPages

Definition at line 90 of file fxusbdevice.hpp.

Referenced by FxUsbDevice::FormatControlRequest(), FxUsbDeviceControlContext(), and ReleaseAndRestore().

m_Urb

_URB_CONTROL_TRANSFER* FxUsbDeviceControlContext::m_Urb

Definition at line 86 of file fxusbdevice.hpp.

Referenced by AllocateUrb(), CopyParameters(), Dispose(), FxUsbDevice::FormatControlRequest(), FxUsbDeviceControlContext(), GetUsbdStatus(), StoreAndReferenceMemory(), and ~FxUsbDeviceControlContext().

m_UrbLegacy

_URB_CONTROL_TRANSFER FxUsbDeviceControlContext::m_UrbLegacy

Definition at line 81 of file fxusbdevice.hpp.

Referenced by Dispose(), FxUsbDevice::FormatControlRequest(), FxUsbDeviceControlContext(), and ~FxUsbDeviceControlContext().

m_USBDHandle

USBD_HANDLE FxUsbDeviceControlContext::m_USBDHandle

private

Definition at line 77 of file fxusbdevice.hpp.

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

---

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

• sdk/lib/drivers/wdf/shared/inc/private/common/fxusbdevice.hpp
• sdk/lib/drivers/wdf/shared/targets/usb/fxusbdevice.cpp
• sdk/lib/drivers/wdf/shared/targets/usb/km/fxusbdevicekm.cpp
• sdk/lib/drivers/wdf/shared/targets/usb/um/fxusbdeviceum.cpp