fxusbdeviceapi.cpp File Reference

#include "fxusbpch.hpp"
#include "FxUsbDeviceAPI.tmh"

Include dependency graph for fxusbdeviceapi.cpp:

Go to the source code of this file.

Functions
_Must_inspect_result_	__drv_maxIRQL (PASSIVE_LEVEL) NTSTATUS WDFAPI FxUsbTargetDeviceCreate(__in PFX_DRIVER_GLOBALS FxDriverGlobals
	FxPointerNotNull (FxDriverGlobals, UsbDevice)
	if (!NT_SUCCESS(status))
	if (pUsbDevice==NULL)
	if (NT_SUCCESS(status))
	FxObjectHandleGetPtrAndGlobals (GetFxDriverGlobals(DriverGlobals), Device, FX_TYPE_DEVICE_BASE,(PVOID *)&pDevice, &pFxDriverGlobals)
return	FxUsbTargetDeviceCreate (pFxDriverGlobals, pDevice, USBD_CLIENT_CONTRACT_VERSION_INVALID, Attributes, UsbDevice)
	FxPointerNotNull (pFxDriverGlobals, Config)
	if (Config->Size !=sizeof(WDF_USB_DEVICE_CREATE_CONFIG))
return	FxUsbTargetDeviceCreate (pFxDriverGlobals, pDevice, Config->USBDClientContractVersion, Attributes, UsbDevice)
_Must_inspect_result_	__drv_maxIRQL (DISPATCH_LEVEL) NTSTATUS WDFAPI WDFEXPORT(WdfUsbTargetDeviceRetrieveInformation)(__in PWDF_DRIVER_GLOBALS DriverGlobals
	FxObjectHandleGetPtrAndGlobals (GetFxDriverGlobals(DriverGlobals), UsbDevice, FX_TYPE_IO_TARGET_USB_DEVICE,(PVOID *) &pUsbDevice, &pFxDriverGlobals)
	FxPointerNotNull (pFxDriverGlobals, Information)
	if (Information->Size !=sizeof(WDF_USB_DEVICE_INFORMATION))
pUsbDevice	GetInformation (Information)
	FxPointerNotNull (pFxDriverGlobals, UsbDeviceDescriptor)
pUsbDevice	CopyDeviceDescriptor (UsbDeviceDescriptor)
	FxPointerNotNull (pFxDriverGlobals, ConfigDescriptorLength)
return pUsbDevice	GetConfigDescriptor (ConfigDescriptor, ConfigDescriptorLength)
	FxPointerNotNull (pFxDriverGlobals, NumCharacters)
	FxPointerNotNull (pFxDriverGlobals, StringMemory)
	if (NumCharacters !=NULL)
	if (NT_SUCCESS(status) &&numChars > 0)
	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "WDFUSBDEVICE %p, WDFREQUEST %p, WDFMEMORY %p, StringIndex %d, LandID 0x%x", UsbDevice, Request, Memory, StringIndex, LangID)
	FxObjectHandleGetPtr (pFxDriverGlobals, Memory, IFX_TYPE_MEMORY,(PVOID *) &pMemory)
	FxObjectHandleGetPtr (pFxDriverGlobals, Request, FX_TYPE_REQUEST,(PVOID *) &pRequest)
buf	SetMemory (pMemory, Offset)
	if ((bufferSize % sizeof(WCHAR)) !=0)
	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "WDFUSBDEVICE %p, WDFREQUEST %p, WDFMEMORY %p, %!STATUS!", UsbDevice, Request, Memory, status)
	FxPointerNotNull (pFxDriverGlobals, Params)
	if (Params->Size !=sizeof(WDF_USB_DEVICE_SELECT_CONFIG_PARAMS))
	if (Params->Type< WdfUsbTargetDeviceSelectConfigTypeDeconfig||Params->Type > WdfUsbTargetDeviceSelectConfigTypeUrb)
	if ((Params->Type==WdfUsbTargetDeviceSelectConfigTypeDeconfig)||(Params->Type==WdfUsbTargetDeviceSelectConfigTypeUrb)||(Params->Type==WdfUsbTargetDeviceSelectConfigTypeInterfacesDescriptor))
	if (pUsbDevice->HasMismatchedInterfacesInConfigDescriptor())
	switch (Params->Type)
	FxObjectHandleGetPtr (GetFxDriverGlobals(DriverGlobals), UsbDevice, FX_TYPE_IO_TARGET_USB_DEVICE,(PVOID *) &pUsbDevice)
return pUsbDevice	GetNumInterfaces ()
return pUsbDevice	GetConfigHandle ()
FxSyncRequest	request (pFxDriverGlobals, &context, Request)
	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "WDFUSBDEVICE %p control transfer sync", UsbDevice)
	FxPointerNotNull (pFxDriverGlobals, SetupPacket)
	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "WDFUSBDEVICE %p, %!STATUS!", UsbDevice, status)
	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "WDFUSBDEVICE %p, WDFREQUEST %p, WDFMEMORY %p", UsbDevice, Request, TransferMemory)
	if (TransferMemory !=NULL)
	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "format control request WDFUSBDEVICE %p, WDFREQWUEST %p, WDFMEMORY %p, %!STATUS!", UsbDevice, Request, TransferMemory, status)
__checkReturn __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES __in ULONG __out WDFMEMORY	__deref_opt_out_bcount (GET_ISOCH_URB_SIZE(NumberOfIsochPackets)) PURB *Urb)
	if (pUsbInterface !=NULL)
_Must_inspect_result_ __in WDFUSBDEVICE __in CONST GUID __in ULONG	__drv_when (CapabilityBufferLength==0, __out_opt) __drv_when(CapabilityBufferLength !=0 &&ResultLength
_Must_inspect_result_ __in WDFUSBDEVICE __in CONST GUID __in ULONG	__out_bcount (CapabilityBufferLength)) __drv_when(CapabilityBufferLength !=0 &&ResultLength !
_Must_inspect_result_ __in WDFUSBDEVICE __in CONST GUID __in ULONG	__out_bcount_part_opt (CapabilityBufferLength, *ResultLength)) PVOID CapabilityBuffer
_Must_inspect_result_ __in WDFUSBDEVICE __in CONST GUID __in ULONG __out_opt	__drv_when (ResultLength !=NULL, __deref_out_range(<=, CapabilityBufferLength)) PULONG ResultLength)

Variables
_Must_inspect_result_ __in FxDeviceBase *	Device
_Must_inspect_result_ __in FxDeviceBase __in ULONG	USBDClientContractVersion
_Must_inspect_result_ __in FxDeviceBase __in ULONG __in_opt PWDF_OBJECT_ATTRIBUTES	Attributes
_Must_inspect_result_ __in FxDeviceBase __in ULONG __in_opt PWDF_OBJECT_ATTRIBUTES __out WDFUSBDEVICE *	UsbDevice
NTSTATUS	status = FxVerifierCheckIrqlLevel(FxDriverGlobals, PASSIVE_LEVEL)
	pUsbDevice = new(FxDriverGlobals, Attributes) FxUsbDevice(FxDriverGlobals)
PFX_DRIVER_GLOBALS	pFxDriverGlobals
FxDeviceBase *	pDevice
__checkReturn __in WDFDEVICE __in PWDF_USB_DEVICE_CREATE_CONFIG	Config
_Must_inspect_result_ __in WDFUSBDEVICE __out PWDF_USB_DEVICE_INFORMATION	Information
return	STATUS_SUCCESS
__in WDFUSBDEVICE __out PUSB_DEVICE_DESCRIPTOR	UsbDeviceDescriptor
_Must_inspect_result_ __in WDFUSBDEVICE __out_bcount_part_opt ConfigDescriptorLength PVOID	ConfigDescriptor
_Must_inspect_result_ __in WDFUSBDEVICE __out_bcount_part_opt ConfigDescriptorLength PVOID __inout PUSHORT	ConfigDescriptorLength
_Must_inspect_result_ __in WDFUSBDEVICE __in_opt WDFREQUEST	Request
_Must_inspect_result_ __in WDFUSBDEVICE __in_opt WDFREQUEST __in_opt PWDF_REQUEST_SEND_OPTIONS	RequestOptions
_Must_inspect_result_ __in WDFUSBDEVICE __in_opt WDFREQUEST __in_opt PWDF_REQUEST_SEND_OPTIONS __out_ecount_opt NumCharacters PUSHORT	String
_Must_inspect_result_ __in WDFUSBDEVICE __in_opt WDFREQUEST __in_opt PWDF_REQUEST_SEND_OPTIONS __out_ecount_opt NumCharacters PUSHORT __inout PUSHORT	NumCharacters
_Must_inspect_result_ __in WDFUSBDEVICE __in_opt WDFREQUEST __in_opt PWDF_REQUEST_SEND_OPTIONS __out_ecount_opt NumCharacters PUSHORT __inout PUSHORT __in UCHAR	StringIndex
_Must_inspect_result_ __in WDFUSBDEVICE __in_opt WDFREQUEST __in_opt PWDF_REQUEST_SEND_OPTIONS __out_ecount_opt NumCharacters PUSHORT __inout PUSHORT __in UCHAR __in_opt USHORT	LangID
_Must_inspect_result_ __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES	StringMemoryAttributes
_Must_inspect_result_ __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES __out WDFMEMORY *	StringMemory = NULL
WDFMEMORY	hMemory
USHORT	numChars = 0
_Must_inspect_result_ __in WDFUSBDEVICE __in WDFREQUEST __in WDFMEMORY	Memory
_Must_inspect_result_ __in WDFUSBDEVICE __in WDFREQUEST __in WDFMEMORY __in_opt PWDFMEMORY_OFFSET	Offset
IFxMemory *	pMemory
FxRequestBuffer	buf
FxRequest *	pRequest
size_t	bufferSize = buf.GetBufferLength()
_Must_inspect_result_ __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES	PipesAttributes
_Must_inspect_result_ __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES __inout PWDF_USB_DEVICE_SELECT_CONFIG_PARAMS	Params
_Must_inspect_result_ __in WDFUSBDEVICE __in_opt WDFREQUEST __in_opt PWDF_REQUEST_SEND_OPTIONS __in PWDF_USB_CONTROL_SETUP_PACKET	SetupPacket
_Must_inspect_result_ __in WDFUSBDEVICE __in_opt WDFREQUEST __in_opt PWDF_REQUEST_SEND_OPTIONS __in PWDF_USB_CONTROL_SETUP_PACKET __in_opt PWDF_MEMORY_DESCRIPTOR	MemoryDescriptor
_Must_inspect_result_ __in WDFUSBDEVICE __in_opt WDFREQUEST __in_opt PWDF_REQUEST_SEND_OPTIONS __in PWDF_USB_CONTROL_SETUP_PACKET __in_opt PWDF_MEMORY_DESCRIPTOR __out_opt PULONG	BytesTransferred
FxUsbDeviceControlContext	context (FxUrbTypeLegacy)
_Must_inspect_result_ __in WDFUSBDEVICE __in WDFREQUEST __in PWDF_USB_CONTROL_SETUP_PACKET __in_opt WDFMEMORY	TransferMemory
_Must_inspect_result_ __in WDFUSBDEVICE __in WDFREQUEST __in PWDF_USB_CONTROL_SETUP_PACKET __in_opt WDFMEMORY __in_opt PWDFMEMORY_OFFSET	TransferOffset
	else
__checkReturn __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES __in ULONG	NumberOfIsochPackets
__checkReturn __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES __in ULONG __out WDFMEMORY *	UrbMemory
__in WDFUSBDEVICE __in UCHAR	InterfaceIndex
FxUsbInterface *	pUsbInterface = pUsbDevice->GetInterfaceFromIndex(InterfaceIndex)
return	NULL
_Must_inspect_result_ __in WDFUSBDEVICE __in CONST GUID *	CapabilityType
_Must_inspect_result_ __in WDFUSBDEVICE __in CONST GUID __in ULONG	CapabilityBufferLength

Function Documentation

__deref_opt_out_bcount()

__checkReturn __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES __in ULONG __out WDFMEMORY __deref_opt_out_bcount

(

GET_ISOCH_URB_SIZE(NumberOfIsochPackets)

)

Definition at line 1236 of file fxusbdeviceapi.cpp.

{
    DDI_ENTRY();
 
    PFX_DRIVER_GLOBALS pFxDriverGlobals;
    FxUsbDevice* pUsbDevice;
    NTSTATUS status;
 
    FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals),
                                   UsbDevice,
                                   FX_TYPE_IO_TARGET_USB_DEVICE,
                                   (PVOID*) &pUsbDevice,
                                   &pFxDriverGlobals);
 
    //
    // Basic parameter validation
    //
    FxPointerNotNull(pFxDriverGlobals, UrbMemory);
 
    if (pUsbDevice->GetUSBDHandle() == NULL) {
        status = STATUS_INVALID_DEVICE_STATE;
 
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
            "USBDEVICE Must have been created with Client Contract Verion Info, %!STATUS!",
            status);
 
        return status;
    }
 
    status = pUsbDevice->CreateIsochUrb(Attributes,
                                        NumberOfIsochPackets,
                                        UrbMemory,
                                        Urb);
 
    return status;
}

__drv_maxIRQL() [1/2]

_Must_inspect_result_ __drv_maxIRQL

(

DISPATCH_LEVEL

)

__drv_maxIRQL() [2/2]

_Must_inspect_result_ __drv_maxIRQL

(

PASSIVE_LEVEL

)

__drv_when() [1/2]

_Must_inspect_result_ __in WDFUSBDEVICE __in CONST GUID __in ULONG __drv_when ( CapabilityBufferLength  = = 0, __out_opt    ) &&

pure virtual

__drv_when() [2/2]

_Must_inspect_result_ __in WDFUSBDEVICE __in CONST GUID __in ULONG __out_opt __drv_when	(	ResultLength !	= NULL,
		__deref_out_range(<=, CapabilityBufferLength)
	)

Definition at line 1374 of file fxusbdeviceapi.cpp.

{
    DDI_ENTRY();
 
    NTSTATUS status;
    PFX_DRIVER_GLOBALS pFxDriverGlobals;
    FxUsbDevice* pUsbDevice;
 
    FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals),
                                   UsbDevice,
                                   FX_TYPE_IO_TARGET_USB_DEVICE,
                                   (PVOID*) &pUsbDevice,
                                   &pFxDriverGlobals);
 
    if (CapabilityBufferLength > 0) {
        FxPointerNotNull(pFxDriverGlobals, CapabilityBuffer);
    }
 
    status = pUsbDevice->QueryUsbCapability(CapabilityType,
                                            CapabilityBufferLength,
                                            CapabilityBuffer,
                                            ResultLength);
    return status;
}

__out_bcount()

_Must_inspect_result_ __in WDFUSBDEVICE __in CONST GUID __in ULONG __out_bcount ( CapabilityBufferLength  ) &&

pure virtual

__out_bcount_part_opt()

_Must_inspect_result_ __in WDFUSBDEVICE __in CONST GUID __in ULONG __out_bcount_part_opt	(	CapabilityBufferLength	,
		*	ResultLength
	)

CopyDeviceDescriptor()

pUsbDevice CopyDeviceDescriptor

(

UsbDeviceDescriptor

)

DoTraceLevelMessage() [1/6]

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_VERBOSE	,
		TRACINGIOTARGET	,
		"format control request WDFUSBDEVICE %	p,
		WDFREQWUEST %	p,
		WDFMEMORY %	p,
		%!STATUS!"	,
		UsbDevice	,
		Request	,
		TransferMemory	,
		status
	)

DoTraceLevelMessage() [2/6]

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_VERBOSE	,
		TRACINGIOTARGET	,
		"WDFUSBDEVICE %p control transfer sync"	,
		UsbDevice
	)

DoTraceLevelMessage() [3/6]

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_VERBOSE	,
		TRACINGIOTARGET	,
		"WDFUSBDEVICE %	p,
		%!STATUS!"	,
		UsbDevice	,
		status
	)

DoTraceLevelMessage() [4/6]

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_VERBOSE	,
		TRACINGIOTARGET	,
		"WDFUSBDEVICE %	p,
		WDFREQUEST %	p,
		WDFMEMORY %p"	,
		UsbDevice	,
		Request	,
		TransferMemory
	)

DoTraceLevelMessage() [5/6]

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_VERBOSE	,
		TRACINGIOTARGET	,
		"WDFUSBDEVICE %	p,
		WDFREQUEST %	p,
		WDFMEMORY %	p,
		%!STATUS!"	,
		UsbDevice	,
		Request	,
		Memory	,
		status
	)

DoTraceLevelMessage() [6/6]

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_VERBOSE	,
		TRACINGIOTARGET	,
		"WDFUSBDEVICE %	p,
		WDFREQUEST %	p,
		WDFMEMORY %	p,
		StringIndex %	d,
		LandID 0x%x"	,
		UsbDevice	,
		Request	,
		Memory	,
		StringIndex	,
		LangID
	)

Referenced by __deref_opt_out_bcount(), if(), and switch().

FxObjectHandleGetPtr() [1/3]

FxObjectHandleGetPtr	(	GetFxDriverGlobals(DriverGlobals)	,
		UsbDevice	,
		FX_TYPE_IO_TARGET_USB_DEVICE	,
		(PVOID *) &	pUsbDevice
	)

FxObjectHandleGetPtr() [2/3]

FxObjectHandleGetPtr	(	pFxDriverGlobals	,
		Memory	,
		IFX_TYPE_MEMORY	,
		(PVOID *) &	pMemory
	)

Referenced by if(), and switch().

FxObjectHandleGetPtr() [3/3]

FxObjectHandleGetPtr	(	pFxDriverGlobals	,
		Request	,
		FX_TYPE_REQUEST	,
		(PVOID *) &	pRequest
	)

FxObjectHandleGetPtrAndGlobals() [1/2]

FxObjectHandleGetPtrAndGlobals	(	GetFxDriverGlobals(DriverGlobals)	,
		Device	,
		FX_TYPE_DEVICE_BASE	,
		(PVOID *)&	pDevice,
		&	pFxDriverGlobals
	)

Referenced by __deref_opt_out_bcount(), and __drv_when().

FxObjectHandleGetPtrAndGlobals() [2/2]

FxObjectHandleGetPtrAndGlobals	(	GetFxDriverGlobals(DriverGlobals)	,
		UsbDevice	,
		FX_TYPE_IO_TARGET_USB_DEVICE	,
		(PVOID *) &	pUsbDevice,
		&	pFxDriverGlobals
	)

FxPointerNotNull() [1/9]

FxPointerNotNull	(	FxDriverGlobals	,
		UsbDevice
	)

FxPointerNotNull() [2/9]

FxPointerNotNull	(	pFxDriverGlobals	,
		Config
	)

FxPointerNotNull() [3/9]

FxPointerNotNull	(	pFxDriverGlobals	,
		ConfigDescriptorLength
	)

FxPointerNotNull() [4/9]

FxPointerNotNull	(	pFxDriverGlobals	,
		Information
	)

FxPointerNotNull() [5/9]

FxPointerNotNull	(	pFxDriverGlobals	,
		NumCharacters
	)

FxPointerNotNull() [6/9]

FxPointerNotNull	(	pFxDriverGlobals	,
		Params
	)

FxPointerNotNull() [7/9]

FxPointerNotNull	(	pFxDriverGlobals	,
		SetupPacket
	)

FxPointerNotNull() [8/9]

FxPointerNotNull	(	pFxDriverGlobals	,
		StringMemory
	)

FxPointerNotNull() [9/9]

FxPointerNotNull	(	pFxDriverGlobals	,
		UsbDeviceDescriptor
	)

FxUsbTargetDeviceCreate() [1/2]

return FxUsbTargetDeviceCreate	(	pFxDriverGlobals	,
		pDevice	,
		Config->	USBDClientContractVersion,
		Attributes	,
		UsbDevice
	)

FxUsbTargetDeviceCreate() [2/2]

return FxUsbTargetDeviceCreate	(	pFxDriverGlobals	,
		pDevice	,
		USBD_CLIENT_CONTRACT_VERSION_INVALID	,
		Attributes	,
		UsbDevice
	)

GetConfigDescriptor()

return pUsbDevice GetConfigDescriptor	(	ConfigDescriptor	,
		ConfigDescriptorLength
	)

GetConfigHandle()

return pUsbDevice GetConfigHandle

(

)

GetInformation()

pUsbDevice GetInformation

(

Information

)

GetNumInterfaces()

return pUsbDevice GetNumInterfaces

(

)

Referenced by DECLARE_INTERFACE().

if() [1/14]

if

(

!

NT_SUCCESSstatus

)

Definition at line 80 of file fxusbdeviceapi.cpp.

                             {
        return status;
    }

if() [2/14]

if

(

(bufferSize % sizeof(WCHAR)) !

= 0

)

Definition at line 600 of file fxusbdeviceapi.cpp.

                                           {
        status = STATUS_INVALID_PARAMETER;
 
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
            "WDFMEMORY %p length must be even number of WCHARs, but is %I64d in "
            "length, %!STATUS!",
            Memory, bufferSize, status);
 
        return status;
    }

if() [3/14]

if

(

(Params->Type==WdfUsbTargetDeviceSelectConfigTypeDeconfig)||(Params->Type==WdfUsbTargetDeviceSelectConfigTypeUrb)||(Params->Type==WdfUsbTargetDeviceSelectConfigTypeInterfacesDescriptor)

)

Definition at line 700 of file fxusbdeviceapi.cpp.

                                                                                  {
        status = STATUS_NOT_SUPPORTED;
 
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                            "Params Type %d not supported for UMDF, %!STATUS!",
                            Params->Type, status);
 
        return status;
 
    }

if() [4/14]

if

(

Config->Size !

= sizeof(WDF_USB_DEVICE_CREATE_CONFIG)

)

Definition at line 232 of file fxusbdeviceapi.cpp.

                                                              {
        status = STATUS_INFO_LENGTH_MISMATCH;
 
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
            "WDF_USB_DEVICE_CREATE_CONFIG Size 0x%x, expected 0x%x, %!STATUS!",
            Config->Size, sizeof(WDF_USB_DEVICE_CREATE_CONFIG), status);
 
        return status;
    }

if() [5/14]

if

(

Information->Size !

= sizeof(WDF_USB_DEVICE_INFORMATION)

)

Definition at line 277 of file fxusbdeviceapi.cpp.

                                                                 {
        status = STATUS_INFO_LENGTH_MISMATCH;
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                            "Information size %d, expected %d %!STATUS!",
                            Information->Size, sizeof(WDF_USB_DEVICE_INFORMATION),
                            status);
        return status;
    }

if() [6/14]

if	(	NT_SUCCESS(status) &&	numChars,
		0
	)

Definition at line 474 of file fxusbdeviceapi.cpp.

                                            {
        FxMemoryObject* pBuffer;
 
        status = FxMemoryObject::_Create(pFxDriverGlobals,
                                         StringMemoryAttributes,
                                         NonPagedPool,
                                         pFxDriverGlobals->Tag,
                                         numChars * sizeof(WCHAR),
                                         &pBuffer);
 
        if (!NT_SUCCESS(status)) {
            return STATUS_INSUFFICIENT_RESOURCES;
        }
 
        status = pBuffer->Commit(StringMemoryAttributes,
                                 (WDFOBJECT*)&hMemory);
 
        if (NT_SUCCESS(status)) {
            status = pUsbDevice->GetString((PUSHORT) pBuffer->GetBuffer(),
                                           &numChars,
                                           StringIndex,
                                           LangID);
 
            if (NT_SUCCESS(status)) {
                if (NumCharacters != NULL) {
                    *NumCharacters  = numChars;
                }
                *StringMemory = hMemory;
            }
        }
 
        if (!NT_SUCCESS(status)) {
            //
            // There can only be one context on this object right now,
            // so just clear out the one.
            //
            pBuffer->DeleteFromFailedCreate();
        }
    }

if() [7/14]

if

(

NT_SUCCESS(status)

)

Definition at line 102 of file fxusbdeviceapi.cpp.

                            {
        WDFOBJECT device;
 
        device = NULL;
 
        status = pUsbDevice->InitDevice(USBDClientContractVersion);
 
        if (NT_SUCCESS(status)) {
            status = pUsbDevice->CreateInterfaces();
        }
 
        if (NT_SUCCESS(status)) {
            status = Device->AddIoTarget(pUsbDevice);
        }
 
        if (NT_SUCCESS(status)) {
            status = pUsbDevice->Commit(Attributes, &device, Device);
        }
 
        if (NT_SUCCESS(status)) {
            *UsbDevice = (WDFUSBDEVICE) device;
        }
    }

if() [8/14]

if

(

NumCharacters !

= NULL

)

Definition at line 458 of file fxusbdeviceapi.cpp.

                               {
        *NumCharacters = 0;
    }

if() [9/14]

if

(

Params->Size !

= sizeof(WDF_USB_DEVICE_SELECT_CONFIG_PARAMS)

)

Definition at line 674 of file fxusbdeviceapi.cpp.

                                                                     {
        status = STATUS_INFO_LENGTH_MISMATCH;
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                            "Params size %d, expected %d %!STATUS!",
                            Params->Size, sizeof(WDF_USB_DEVICE_SELECT_CONFIG_PARAMS),
                            status);
        return status;
    }

if() [10/14]

if	(	Params->Type< WdfUsbTargetDeviceSelectConfigTypeDeconfig||Params->	Type,
		WdfUsbTargetDeviceSelectConfigTypeUrb
	)

Definition at line 686 of file fxusbdeviceapi.cpp.

                                                              {
 
        status = STATUS_INVALID_PARAMETER;
 
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                            "Params Type %d not a valid value, %!STATUS!",
                            Params->Size, status);
 
        return status;
    }

if() [11/14]

else if

(

pUsbDevice->

HasMismatchedInterfacesInConfigDescriptor() = = 0

)

Definition at line 721 of file fxusbdeviceapi.cpp.

                                                                 {
        //
        // Config descriptor reported zero interfaces, but we found an
        // interface descriptor in it.
        //
        status = STATUS_INVALID_DEVICE_REQUEST;
 
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
            "WDFUSBDEVICE %p number of interfaces found in the config descriptor "
            "does not match bNumInterfaces in config descriptor, failing config "
            "operation %!WdfUsbTargetDeviceSelectConfigType!, %!STATUS!",
            UsbDevice, Params->Type, status);
 
        return status;
    }

if() [12/14]

if

(

pUsbDevice

= = NULL

)

Definition at line 92 of file fxusbdeviceapi.cpp.

                            {
        return STATUS_INSUFFICIENT_RESOURCES;
    }

if() [13/14]

if

(

pUsbInterface !

= NULL

)

Definition at line 1342 of file fxusbdeviceapi.cpp.

                               {
        return pUsbInterface->GetHandle();
    }

if() [14/14]

if

(

TransferMemory !

= NULL

)

Definition at line 1139 of file fxusbdeviceapi.cpp.

                                {
        FxObjectHandleGetPtr(pFxDriverGlobals,
                             TransferMemory,
                             IFX_TYPE_MEMORY,
                             (PVOID*) &pMemory);
 
        status = pMemory->ValidateMemoryOffsets(TransferOffset);
        if (!NT_SUCCESS(status)) {
            return status;
        }
 
        buf.SetMemory(pMemory, TransferOffset);
    }

request()

FxSyncRequest request	(	pFxDriverGlobals	,
		&	context,
		Request
	)

SetMemory()

buf SetMemory	(	pMemory	,
		Offset
	)

switch()

switch

(

Params->

Type

)

Definition at line 752 of file fxusbdeviceapi.cpp.

                          {
 
#if (FX_CORE_MODE == FX_CORE_KERNEL_MODE)
 
    case WdfUsbTargetDeviceSelectConfigTypeDeconfig:
        status = pUsbDevice->Deconfig();
        break;
 
    case WdfUsbTargetDeviceSelectConfigTypeInterfacesDescriptor:
        if (Params->Types.Descriptor.InterfaceDescriptors == NULL ||
            Params->Types.Descriptor.NumInterfaceDescriptors == 0) {
            status = STATUS_INVALID_PARAMETER;
            DoTraceLevelMessage(
                pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                "Either  InterfaceDescriptor is NULL or  NumInterfaceDescriptors is zero "
                "WDFUSBDEVICE %p InterfaceDescriptor %p NumInterfaceDescriptors 0x%x"
                "%!WdfUsbTargetDeviceSelectConfigType! %!STATUS!", UsbDevice,
                Params->Types.Descriptor.InterfaceDescriptors,
                Params->Types.Descriptor.NumInterfaceDescriptors,
                Params->Type,
                status);
 
        }
        else {
            status = pUsbDevice->SelectConfigDescriptor(
                PipesAttributes,
                Params);
        }
        break;
 
    case WdfUsbTargetDeviceSelectConfigTypeUrb:
        //
        // Since the USBD macro's dont include the  USBD_PIPE_INFORMATION for 0 EP's,
        // make the length check to use
        // sizeof(struct _URB_SELECT_CONFIGURATION) - sizeof(USBD_PIPE_INFORMATION)
        //
        if (Params->Types.Urb.Urb == NULL ||
            Params->Types.Urb.Urb->UrbHeader.Function != URB_FUNCTION_SELECT_CONFIGURATION ||
            Params->Types.Urb.Urb->UrbHeader.Length <
               (sizeof(struct _URB_SELECT_CONFIGURATION) - sizeof(USBD_PIPE_INFORMATION))) {
            status = STATUS_INVALID_PARAMETER;
            DoTraceLevelMessage(
                pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                "Either URB passed in was NULL or the URB Function or Length was invalid "
                " WDFUSBDEVICE %p Urb 0x%p "
                "%!WdfUsbTargetDeviceSelectConfigType!"
                " %!STATUS!", UsbDevice,
                Params->Types.Urb.Urb,
                Params->Type,
                status);
 
        }
        else {
            status = pUsbDevice->SelectConfig(
                                              PipesAttributes,
                                              Params->Types.Urb.Urb,
                                              FxUrbTypeLegacy,
                                              NULL);
        }
        break;
 
#endif
 
 
 
 
 
    case WdfUsbTargetDeviceSelectConfigTypeInterfacesPairs:
        if (Params->Types.MultiInterface.Pairs == NULL) {
            status = STATUS_INVALID_PARAMETER;
 
            DoTraceLevelMessage(
                pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                "WDFUSBDEVICE %p SettingPairs Array passed is NULL, %!STATUS!",
                pUsbDevice->GetHandle(),status);
 
            break;
        }
        else if (Params->Types.MultiInterface.NumberInterfaces !=
                                        pUsbDevice->GetNumInterfaces()) {
            status = STATUS_INVALID_PARAMETER;
 
            DoTraceLevelMessage(
                pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                "WDFUSBDEVICE %p MultiInterface.NumberInterfaces %d != %d "
                "(reported num interfaces), %!STATUS!",
                pUsbDevice->GetHandle(),
                Params->Types.MultiInterface.NumberInterfaces,
                pUsbDevice->GetNumInterfaces(), status);
 
            break;
        }
 
        //    ||      ||   Fall through     ||        ||
        //    \/      \/                    \/        \/
    case WdfUsbTargetDeviceSelectConfigTypeMultiInterface:
 
        //
        // Validate SettingIndexes passed-in
        //
        for (ULONG i = 0;
             i < Params->Types.MultiInterface.NumberInterfaces;
             i++) {
 
            PWDF_USB_INTERFACE_SETTING_PAIR  pair;
            FxUsbInterface * pUsbInterface;
            UCHAR numSettings;
 
            pair = &(Params->Types.MultiInterface.Pairs[i]);
 
            FxObjectHandleGetPtr(GetFxDriverGlobals(DriverGlobals),
                                 pair->UsbInterface,
                                 FX_TYPE_USB_INTERFACE,
                                 (PVOID*) &pUsbInterface);
 
            numSettings = pUsbInterface->GetNumSettings();
 
            if (pair->SettingIndex >= numSettings) {
                status = STATUS_INVALID_PARAMETER;
 
                DoTraceLevelMessage(
                    pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                    "WDFUSBDEVICE %p SettingPairs contains invalid SettingIndex"
                    " for WDFUSBINTERFACE %p. Setting index passed in: %d, "
                    "max index: %d, returning %!STATUS!",
                    pUsbDevice->GetHandle(),
                    pair->UsbInterface,
                    pair->SettingIndex,
                    pUsbInterface->GetNumSettings() - 1,
                    status);
 
                return status;
            }
        }
 
        status = pUsbDevice->SelectConfigMulti(
            PipesAttributes,
            Params);
        break;
 
    case WdfUsbTargetDeviceSelectConfigTypeSingleInterface:
        status = pUsbDevice->SelectConfigSingle(   //vm changed name from  SelectConfigAuto
            PipesAttributes,
            Params);
        break;
 
    default:
        status = STATUS_INVALID_PARAMETER;
    }

Variable Documentation

Attributes

__checkReturn __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES Attributes

Definition at line 45 of file fxusbdeviceapi.cpp.

buf

FxRequestBuffer buf

Definition at line 561 of file fxusbdeviceapi.cpp.

bufferSize

bufferSize = buf.GetBufferLength()

Definition at line 564 of file fxusbdeviceapi.cpp.

Referenced by _enumerateContextW(), FxWmiIrpHandler::_QuerySingleInstance(), FxWmiIrpHandler::_RegInfo(), AddListViewItems(), FxRequestBuffer::AssignValues(), CComCatCachedCategory::CacheDSA(), CheckRegScreenSaverIsSecure(), ClassDeviceHwFirmwareDownloadProcess(), ClassSystemControl(), DiskDisableSmart(), DiskDisableSmartAttributeAutosave(), DiskEnableSmart(), DiskEnableSmartAttributeAutosave(), DiskExecuteSmartDiagnostics(), DiskIoctlReassignBlocks(), DiskIoctlReassignBlocksEx(), DiskReadSmartLog(), DiskWriteSmartLog(), FxUsbDevice::FormatControlRequest(), FxUsbPipe::FormatTransferRequest(), FSE_writeNCount(), Region::GetData(), Region::GetDataSize(), if(), InitBackgroundDialog(), InstallOneService(), mswBufferInit(), CMiniportWaveCyclicStream::ResizeBuffer(), FxDevice::RetrieveDeviceInfoRegistrySettings(), StartScreenSaver(), STDMETHODIMP_(), test_events(), test_send(), test_sendto(), tinyxml2::XMLUtil::ToStr(), WlxScreenSaverNotify(), ZSTD_decompressStream(), and ZSTD_sizeof_localDict().

BytesTransferred

_Must_inspect_result_ __in WDFUSBDEVICE __in_opt WDFREQUEST __in_opt PWDF_REQUEST_SEND_OPTIONS __in PWDF_USB_CONTROL_SETUP_PACKET __in_opt PWDF_MEMORY_DESCRIPTOR __out_opt PULONG BytesTransferred

Initial value:

{
    DDI_ENTRY()

Definition at line 968 of file fxusbdeviceapi.cpp.

CapabilityBufferLength

_Must_inspect_result_ __in WDFUSBDEVICE __in CONST GUID __in ULONG CapabilityBufferLength

Definition at line 1368 of file fxusbdeviceapi.cpp.

CapabilityType

_Must_inspect_result_ __in WDFUSBDEVICE __in CONST GUID* CapabilityType

Definition at line 1366 of file fxusbdeviceapi.cpp.

Config

__checkReturn __in WDFDEVICE __in PWDF_USB_DEVICE_CREATE_CONFIG Config

Definition at line 195 of file fxusbdeviceapi.cpp.

ConfigDescriptor

_Must_inspect_result_ __in WDFUSBDEVICE __out_bcount_part_opt ConfigDescriptorLength PVOID ConfigDescriptor

Definition at line 335 of file fxusbdeviceapi.cpp.

ConfigDescriptorLength

_Must_inspect_result_ __in WDFUSBDEVICE __out_bcount_part_opt ConfigDescriptorLength PVOID __inout PUSHORT ConfigDescriptorLength

Initial value:

{
    DDI_ENTRY()

Definition at line 337 of file fxusbdeviceapi.cpp.

context

FxUsbDeviceControlContext context(FxUrbTypeLegacy)

(

FxUrbTypeLegacy

)

Device

__checkReturn __in WDFDEVICE Device

Definition at line 41 of file fxusbdeviceapi.cpp.

else

else

Initial value:

{
        pMemory = NULL

Definition at line 1152 of file fxusbdeviceapi.cpp.

hMemory

WDFMEMORY hMemory

Definition at line 444 of file fxusbdeviceapi.cpp.

Referenced by if().

Information

_Must_inspect_result_ __in WDFUSBDEVICE __out PWDF_USB_DEVICE_INFORMATION Information

Initial value:

{
    DDI_ENTRY()

Definition at line 260 of file fxusbdeviceapi.cpp.

InterfaceIndex

__in WDFUSBDEVICE __in UCHAR InterfaceIndex

Initial value:

{
    DDI_ENTRY()

Definition at line 1313 of file fxusbdeviceapi.cpp.

LangID

_Must_inspect_result_ __in WDFUSBDEVICE __in WDFREQUEST __in WDFMEMORY __in_opt PWDFMEMORY_OFFSET __in UCHAR __in_opt USHORT LangID

Initial value:

{
    DDI_ENTRY()

Definition at line 383 of file fxusbdeviceapi.cpp.

Memory

_Must_inspect_result_ __in WDFUSBDEVICE __in WDFREQUEST __in WDFMEMORY Memory

Definition at line 528 of file fxusbdeviceapi.cpp.

MemoryDescriptor

_Must_inspect_result_ __in WDFUSBDEVICE __in_opt WDFREQUEST __in_opt PWDF_REQUEST_SEND_OPTIONS __in PWDF_USB_CONTROL_SETUP_PACKET __in_opt PWDF_MEMORY_DESCRIPTOR MemoryDescriptor

Definition at line 966 of file fxusbdeviceapi.cpp.

NULL

return NULL

Definition at line 1352 of file fxusbdeviceapi.cpp.

Referenced by __deref_opt_out_bcount(), if(), and switch().

NumberOfIsochPackets

__checkReturn __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES __in ULONG NumberOfIsochPackets

Definition at line 1233 of file fxusbdeviceapi.cpp.

NumCharacters

_Must_inspect_result_ __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES __out WDFMEMORY __out_opt PUSHORT NumCharacters

Definition at line 379 of file fxusbdeviceapi.cpp.

numChars

USHORT numChars = 0

Definition at line 447 of file fxusbdeviceapi.cpp.

Referenced by FxRegKey::_VerifyMultiSzString(), DisplayScreen(), FxUsbDevice::GetString(), hexToInt(), if(), and ProcessKeys().

Offset

_Must_inspect_result_ __in WDFUSBDEVICE __in WDFREQUEST __in WDFMEMORY __in_opt PWDFMEMORY_OFFSET Offset

Definition at line 530 of file fxusbdeviceapi.cpp.

Params

_Must_inspect_result_ __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES __inout PWDF_USB_DEVICE_SELECT_CONFIG_PARAMS Params

Initial value:

{
    DDI_ENTRY()

Definition at line 652 of file fxusbdeviceapi.cpp.

pDevice

FxDeviceBase* pDevice

Definition at line 170 of file fxusbdeviceapi.cpp.

pFxDriverGlobals

PFX_DRIVER_GLOBALS pFxDriverGlobals

Definition at line 169 of file fxusbdeviceapi.cpp.

Referenced by __deref_opt_out_bcount(), __drv_when(), if(), and switch().

PipesAttributes

_Must_inspect_result_ __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES PipesAttributes

Definition at line 650 of file fxusbdeviceapi.cpp.

pMemory

IFxMemory* pMemory

Definition at line 559 of file fxusbdeviceapi.cpp.

Referenced by if().

pRequest

FxRequest* pRequest

Definition at line 562 of file fxusbdeviceapi.cpp.

pUsbDevice

FxUsbDevice * pUsbDevice = new(FxDriverGlobals, Attributes) FxUsbDevice(FxDriverGlobals)

Definition at line 91 of file fxusbdeviceapi.cpp.

Referenced by __deref_opt_out_bcount(), __drv_when(), if(), and switch().

pUsbInterface

FxUsbInterface * pUsbInterface = pUsbDevice->GetInterfaceFromIndex(InterfaceIndex)

Definition at line 1332 of file fxusbdeviceapi.cpp.

Referenced by FxUsbDevice::CancelSentIo(), FxUsbDevice::GetInterfaceNumberFromInterface(), if(), FxUsbDevice::PipesGotoRemoveState(), FxUsbDevice::Purge(), FxUsbDevice::SelectConfig(), FxUsbDevice::Start(), FxUsbDevice::Stop(), and switch().

Request

_Must_inspect_result_ __in WDFUSBDEVICE __in WDFREQUEST Request

Definition at line 373 of file fxusbdeviceapi.cpp.

RequestOptions

_Must_inspect_result_ __in WDFUSBDEVICE __in_opt WDFREQUEST __in_opt PWDF_REQUEST_SEND_OPTIONS RequestOptions

Definition at line 375 of file fxusbdeviceapi.cpp.

SetupPacket

_Must_inspect_result_ __in WDFUSBDEVICE __in WDFREQUEST __in PWDF_USB_CONTROL_SETUP_PACKET SetupPacket

Definition at line 964 of file fxusbdeviceapi.cpp.

status

return status = FxVerifierCheckIrqlLevel(FxDriverGlobals, PASSIVE_LEVEL)

Definition at line 70 of file fxusbdeviceapi.cpp.

Referenced by __deref_opt_out_bcount(), __drv_when(), if(), and switch().

STATUS_SUCCESS

return STATUS_SUCCESS

Definition at line 288 of file fxusbdeviceapi.cpp.

String

_Must_inspect_result_ __in WDFUSBDEVICE __in_opt WDFREQUEST __in_opt PWDF_REQUEST_SEND_OPTIONS __out_ecount_opt NumCharacters PUSHORT String

Definition at line 377 of file fxusbdeviceapi.cpp.

StringIndex

_Must_inspect_result_ __in WDFUSBDEVICE __in WDFREQUEST __in WDFMEMORY __in_opt PWDFMEMORY_OFFSET __in UCHAR StringIndex

Definition at line 381 of file fxusbdeviceapi.cpp.

StringMemory

* StringMemory = NULL

Definition at line 432 of file fxusbdeviceapi.cpp.

StringMemoryAttributes

_Must_inspect_result_ __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES StringMemoryAttributes

Definition at line 430 of file fxusbdeviceapi.cpp.

TransferMemory

_Must_inspect_result_ __in WDFUSBDEVICE __in WDFREQUEST __in PWDF_USB_CONTROL_SETUP_PACKET __in_opt WDFMEMORY TransferMemory

Definition at line 1091 of file fxusbdeviceapi.cpp.

TransferOffset

_Must_inspect_result_ __in WDFUSBDEVICE __in WDFREQUEST __in PWDF_USB_CONTROL_SETUP_PACKET __in_opt WDFMEMORY __in_opt PWDFMEMORY_OFFSET TransferOffset

Initial value:

{
    DDI_ENTRY()

Definition at line 1093 of file fxusbdeviceapi.cpp.

UrbMemory

__checkReturn __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES __in ULONG __out WDFMEMORY* UrbMemory

Definition at line 1235 of file fxusbdeviceapi.cpp.

USBDClientContractVersion

_Must_inspect_result_ __in FxDeviceBase __in ULONG USBDClientContractVersion

Definition at line 43 of file fxusbdeviceapi.cpp.

Referenced by if(), USBD_CreateHandle(), and WDF_USB_DEVICE_CREATE_CONFIG_INIT().

UsbDevice

_Must_inspect_result_ __in WDFUSBDEVICE UsbDevice

Initial value:

{
    FxUsbDevice* pUsbDevice

Definition at line 47 of file fxusbdeviceapi.cpp.

UsbDeviceDescriptor

__in WDFUSBDEVICE __out PUSB_DEVICE_DESCRIPTOR UsbDeviceDescriptor

Initial value:

{
    DDI_ENTRY()

Definition at line 300 of file fxusbdeviceapi.cpp.