FxUsbDeviceStringContext Struct Reference

#include <fxusbdevice.hpp>

Inheritance diagram for FxUsbDeviceStringContext:

Collaboration diagram for FxUsbDeviceStringContext:

Public Member Functions
	FxUsbDeviceStringContext (__in FX_URB_TYPE FxUrbType)
	~FxUsbDeviceStringContext (VOID)
__checkReturn NTSTATUS	AllocateUrb (__in USBD_HANDLE USBDHandle)
virtual VOID	Dispose (VOID)
virtual VOID	CopyParameters (__in FxRequestBase *Request)
VOID	SetUrbInfo (__in UCHAR StringIndex, __in USHORT LangID)
USBD_STATUS	GetUsbdStatus (VOID)
_Must_inspect_result_ NTSTATUS	AllocateDescriptor (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in size_t BufferSize)
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_DESCRIPTOR_REQUEST	m_UrbLegacy
_URB_CONTROL_DESCRIPTOR_REQUEST *	m_Urb
PUSB_STRING_DESCRIPTOR	m_StringDescriptor
ULONG	m_StringDescriptorLength
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 93 of file fxusbdevice.hpp.

Constructor & Destructor Documentation

FxUsbDeviceStringContext()

FxUsbDeviceStringContext::FxUsbDeviceStringContext

(

__in FX_URB_TYPE

FxUrbType

)

Definition at line 145 of file fxusbdevice.cpp.

      :
    FxUsbRequestContext(FX_RCT_USB_STRING_REQUEST)
{
    m_USBDHandle = NULL;
    m_StringDescriptor = NULL;
    m_StringDescriptorLength = 0;
    RtlZeroMemory(&m_UrbLegacy, sizeof(m_UrbLegacy));
 
    if (FxUrbType == FxUrbTypeLegacy) {
        m_Urb = &m_UrbLegacy;
        m_Urb->Hdr.Function =  URB_FUNCTION_GET_DESCRIPTOR_FROM_DEVICE;
        m_Urb->Hdr.Length = sizeof(*m_Urb);
        m_Urb->DescriptorType = USB_STRING_DESCRIPTOR_TYPE;
    }
    else {
        m_Urb = NULL;
    }
}

~FxUsbDeviceStringContext()

FxUsbDeviceStringContext::~FxUsbDeviceStringContext

(

VOID

)

Definition at line 166 of file fxusbdevice.cpp.

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

Member Function Documentation

AllocateDescriptor()

_Must_inspect_result_ NTSTATUS FxUsbDeviceStringContext::AllocateDescriptor	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in size_t	BufferSize
	)

Definition at line 303 of file fxusbdevice.cpp.

{
    PUSB_STRING_DESCRIPTOR pDescriptor;
    size_t length;
    NTSTATUS status;
 
    if (BufferSize <= m_StringDescriptorLength) {
        return STATUS_SUCCESS;
    }
 
    length = sizeof(USB_STRING_DESCRIPTOR) - sizeof(pDescriptor->bString[0]) +
             BufferSize;
 
    pDescriptor = (PUSB_STRING_DESCRIPTOR) FxPoolAllocate(
        FxDriverGlobals,
        NonPagedPool,
        length);
 
    if (pDescriptor == NULL) {
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    if (m_StringDescriptor != NULL) {
        FxPoolFree(m_StringDescriptor);
    }
 
    RtlZeroMemory(pDescriptor, length);
 
    m_StringDescriptor = pDescriptor;
 
    status = RtlSizeTToULong(length, &m_StringDescriptorLength);
 
    return status;
}

Referenced by FxUsbDevice::FormatStringRequest().

AllocateUrb()

__checkReturn NTSTATUS FxUsbDeviceStringContext::AllocateUrb

(

__in USBD_HANDLE

USBDHandle

)

Definition at line 184 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;
 
    m_Urb->Hdr.Function =  URB_FUNCTION_GET_DESCRIPTOR_FROM_DEVICE;
    m_Urb->Hdr.Length = sizeof(*m_Urb);
    m_Urb->DescriptorType = USB_STRING_DESCRIPTOR_TYPE;
 
Done:
    return status;
}

Referenced by FxUsbDevice::FormatStringRequest().

CopyParameters()

VOID FxUsbDeviceStringContext::CopyParameters ( __in FxRequestBase *  Request )

virtual

Reimplemented from FxUsbRequestContext.

Definition at line 223 of file fxusbdevice.cpp.

{
    //
    // Make sure we got an even number of bytes and that we got a header
    //
    if ((m_StringDescriptor->bLength & 0x1) ||
        m_StringDescriptor->bLength < sizeof(USB_COMMON_DESCRIPTOR)) {
        m_CompletionParams.IoStatus.Status = STATUS_DEVICE_DATA_ERROR;
    }
    else if (NT_SUCCESS(Request->GetSubmitFxIrp()->GetStatus())) {
        //
        // No matter what, indicate the required size to the caller
        //
        m_UsbParameters.Parameters.DeviceString.RequiredSize =
            m_StringDescriptor->bLength - sizeof(USB_COMMON_DESCRIPTOR);
 
        if (m_UsbParameters.Parameters.DeviceString.RequiredSize >
                                            m_RequestMemory->GetBufferSize()) {
            //
            // Too much string to fit into the buffer supplied by the client.
            // Morph the status into a warning.  Copy as much as we can.
            //
            m_CompletionParams.IoStatus.Status = STATUS_BUFFER_OVERFLOW;
            RtlCopyMemory(m_RequestMemory->GetBuffer(),
                          &m_StringDescriptor->bString[0],
                          m_RequestMemory->GetBufferSize());
        }
        else {
            //
            // Everything fits, copy it over
            //
            m_CompletionParams.IoStatus.Information =
                m_UsbParameters.Parameters.DeviceString.RequiredSize;
 
            RtlCopyMemory(m_RequestMemory->GetBuffer(),
                          &m_StringDescriptor->bString[0],
                          m_UsbParameters.Parameters.DeviceString.RequiredSize);
        }
    }
 
    FxUsbRequestContext::CopyParameters(Request); // __super call
}

Dispose()

VOID FxUsbDeviceStringContext::Dispose ( VOID  )

virtual

Reimplemented from FxRequestContext.

Definition at line 210 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 FxUsbDeviceStringContext::GetUsbdStatus ( VOID  )

virtual

Implements FxUsbRequestContext.

Definition at line 294 of file fxusbdevice.cpp.

{
    return m_Urb->Hdr.Status;
}

SetUrbInfo()

VOID FxUsbDeviceStringContext::SetUrbInfo	(	__in UCHAR	StringIndex,
		__in USHORT	LangID
	)

Definition at line 269 of file fxusbdevice.cpp.

{
    SetUsbType(WdfUsbRequestTypeDeviceString);
 
    ASSERT(m_StringDescriptor != NULL && m_StringDescriptorLength != 0);
 
#if (FX_CORE_MODE == FX_CORE_KERNEL_MODE)
    m_Urb->TransferBuffer = m_StringDescriptor;
    m_Urb->TransferBufferLength = m_StringDescriptorLength;
 
    m_Urb->Index = StringIndex;
    m_Urb->LanguageId = LangID;
#elif (FX_CORE_MODE == FX_CORE_USER_MODE)
    m_UmUrb.UmUrbDescriptorRequest.Buffer = m_StringDescriptor;
    m_UmUrb.UmUrbDescriptorRequest.BufferLength = m_StringDescriptorLength;
 
    m_UmUrb.UmUrbDescriptorRequest.Index = StringIndex;
    m_UmUrb.UmUrbDescriptorRequest.LanguageID = LangID;
#endif
}

Referenced by FxUsbDevice::FormatStringRequest().

Member Data Documentation

m_StringDescriptor

PUSB_STRING_DESCRIPTOR FxUsbDeviceStringContext::m_StringDescriptor

Definition at line 150 of file fxusbdevice.hpp.

Referenced by AllocateDescriptor(), CopyParameters(), FxUsbDeviceStringContext(), SetUrbInfo(), and ~FxUsbDeviceStringContext().

m_StringDescriptorLength

ULONG FxUsbDeviceStringContext::m_StringDescriptorLength

Definition at line 152 of file fxusbdevice.hpp.

Referenced by AllocateDescriptor(), FxUsbDeviceStringContext(), and SetUrbInfo().

m_Urb

_URB_CONTROL_DESCRIPTOR_REQUEST* FxUsbDeviceStringContext::m_Urb

Definition at line 148 of file fxusbdevice.hpp.

Referenced by AllocateUrb(), Dispose(), FxUsbDevice::FormatStringRequest(), FxUsbDeviceStringContext(), GetUsbdStatus(), SetUrbInfo(), and ~FxUsbDeviceStringContext().

m_UrbLegacy

_URB_CONTROL_DESCRIPTOR_REQUEST FxUsbDeviceStringContext::m_UrbLegacy

Definition at line 143 of file fxusbdevice.hpp.

Referenced by Dispose(), FxUsbDevice::FormatStringRequest(), FxUsbDeviceStringContext(), and ~FxUsbDeviceStringContext().

m_USBDHandle

USBD_HANDLE FxUsbDeviceStringContext::m_USBDHandle

private

Definition at line 139 of file fxusbdevice.hpp.

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

---

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