fxusbdeviceapikm.cpp File Reference

#include "fxusbpch.hpp"
#include "FxUsbDeviceApiKm.tmh"

Include dependency graph for fxusbdeviceapikm.cpp:

Go to the source code of this file.

Functions
_Must_inspect_result_	__drv_maxIRQL (DISPATCH_LEVEL) NTSTATUS WDFAPI WDFEXPORT(WdfUsbTargetDeviceRetrieveCurrentFrameNumber)(__in PWDF_DRIVER_GLOBALS DriverGlobals
	FxObjectHandleGetPtrAndGlobals (GetFxDriverGlobals(DriverGlobals), UsbDevice, FX_TYPE_IO_TARGET_USB_DEVICE,(PVOID *) &pUsbDevice, &pFxDriverGlobals)
	FxPointerNotNull (pFxDriverGlobals, CurrentFrameNumber)
return pUsbDevice	GetCurrentFrameNumber (CurrentFrameNumber)
_Must_inspect_result_	__drv_maxIRQL (PASSIVE_LEVEL) NTSTATUS WDFAPI WDFEXPORT(WdfUsbTargetDeviceSendUrbSynchronously)(__in PWDF_DRIVER_GLOBALS DriverGlobals
_Must_inspect_result_ __in WDFUSBDEVICE __in_opt WDFREQUEST __in_opt PWDF_REQUEST_SEND_OPTIONS	__in_xcount ("union bug in SAL") PURB Urb)
	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "WDFUSBDEVICE %p, Request %p, Memory %p", UsbDevice, Request, UrbMemory)
	FxPointerNotNull (pFxDriverGlobals, UrbMemory)
	FxObjectHandleGetPtr (pFxDriverGlobals, UrbMemory, IFX_TYPE_MEMORY,(PVOID *) &pMemory)
	FxObjectHandleGetPtr (pFxDriverGlobals, Request, FX_TYPE_REQUEST,(PVOID *) &pRequest)
	if (!NT_SUCCESS(status))
	if (UrbOffsets !=NULL &&UrbOffsets->BufferOffset > 0)
	if (bufferSize< sizeof(_URB_HEADER))
buf	SetMemory (pMemory, UrbOffsets)
	if (NT_SUCCESS(status))
	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "WDFUSBDEVICE %p, Request %p, Memory %p, %!STATUS!", UsbDevice, Request, UrbMemory, status)
__checkReturn __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES __out WDFMEMORY	__deref_opt_out_bcount (sizeof(URB)) PURB *Urb)

Variables
_Must_inspect_result_ __in WDFUSBDEVICE	UsbDevice
_Must_inspect_result_ __in WDFUSBDEVICE __out PULONG	CurrentFrameNumber
PFX_DRIVER_GLOBALS	pFxDriverGlobals
FxUsbDevice *	pUsbDevice
_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 WDFREQUEST __in WDFMEMORY	UrbMemory
_Must_inspect_result_ __in WDFUSBDEVICE __in WDFREQUEST __in WDFMEMORY __in_opt PWDFMEMORY_OFFSET	UrbOffsets
IFxMemory *	pMemory
FxRequestBuffer	buf
FxRequest *	pRequest
NTSTATUS	status = pMemory->ValidateMemoryOffsets(UrbOffsets)
size_t	bufferSize = pMemory->GetBufferSize()
__checkReturn __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES	Attributes

Function Documentation

__deref_opt_out_bcount()

__checkReturn __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES __out WDFMEMORY __deref_opt_out_bcount

(

sizeof(URB)

)

Definition at line 382 of file fxusbdeviceapikm.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->CreateUrb(Attributes, 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

)

__in_xcount()

_Must_inspect_result_ __in WDFUSBDEVICE __in_opt WDFREQUEST __in_opt PWDF_REQUEST_SEND_OPTIONS __in_xcount

(

"union bug in SAL"

)

Definition at line 75 of file fxusbdeviceapikm.cpp.

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals;
    FxRequestBuffer buf;
    NTSTATUS status;
    FxUsbDevice* pUsbDevice;
 
    FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals),
                                   UsbDevice,
                                   FX_TYPE_IO_TARGET_USB_DEVICE,
                                   (PVOID*) &pUsbDevice,
                                   &pFxDriverGlobals);
 
    FxUsbUrbContext context;
    FxSyncRequest request(pFxDriverGlobals, &context, Request);
 
    //
    // FxSyncRequest always succeesds for KM but can fail for UM.
    //
    status = request.Initialize();
    if (!NT_SUCCESS(status)) {
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                            "Failed to initialize FxSyncRequest");
        return status;
    }
 
    DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
                        "WDFUSBDEVICE %p, Urb %p", UsbDevice, Urb);
 
    FxPointerNotNull(pFxDriverGlobals, Urb);
 
    status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL);
    if (!NT_SUCCESS(status)) {
        return status;
    }
 
    status = FxValidateRequestOptions(pFxDriverGlobals, RequestOptions);
    if (!NT_SUCCESS(status)) {
        return status;
    }
 
    buf.SetBuffer(Urb, 0);
 
    status = FxFormatUrbRequest(pFxDriverGlobals,
                                pUsbDevice,
                                request.m_TrueRequest,
                                &buf,
                                pUsbDevice->GetUrbType(),
                                pUsbDevice->GetUSBDHandle());
 
    if (NT_SUCCESS(status)) {
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
            "WDFUSBDEVICE %p, WDFREQUEST %p being submitted",
            UsbDevice, request.m_TrueRequest->GetTraceObjectHandle());
 
        status = pUsbDevice->SubmitSync(request.m_TrueRequest, RequestOptions);
    }
 
    DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
                        "Device %p, Urb %p, %!STATUS!",
                        UsbDevice, Urb, status);
 
    return status;
}

DoTraceLevelMessage() [1/2]

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_VERBOSE	,
		TRACINGIOTARGET	,
		"WDFUSBDEVICE %	p,
		Request %	p,
		Memory %p"	,
		UsbDevice	,
		Request	,
		UrbMemory
	)

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

DoTraceLevelMessage() [2/2]

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

FxObjectHandleGetPtr() [1/2]

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

FxObjectHandleGetPtr() [2/2]

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

FxObjectHandleGetPtrAndGlobals()

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

Referenced by __deref_opt_out_bcount(), and __in_xcount().

FxPointerNotNull() [1/2]

FxPointerNotNull	(	pFxDriverGlobals	,
		CurrentFrameNumber
	)

FxPointerNotNull() [2/2]

FxPointerNotNull	(	pFxDriverGlobals	,
		UrbMemory
	)

GetCurrentFrameNumber()

return pUsbDevice GetCurrentFrameNumber

(

CurrentFrameNumber

)

if() [1/4]

if

(

!

NT_SUCCESSstatus

)

Definition at line 193 of file fxusbdeviceapikm.cpp.

                             {
        return status;
    }

if() [2/4]

if

(

)

Definition at line 202 of file fxusbdeviceapikm.cpp.

                                          {
        status = STATUS_INVALID_PARAMETER;
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                            "UrbMemory %p buffer size, %I64d, smaller then"
                            "_URB_HEADER, %!STATUS!",
                             UrbMemory, pMemory->GetBufferSize(), status);
        return status;
    }

if() [3/4]

if

(

NT_SUCCESS(status)

)

Definition at line 220 of file fxusbdeviceapikm.cpp.

                            {
        FxUsbUrbContext* pContext;
        pContext = (FxUsbUrbContext*) pRequest->GetContext();
 
        pContext->SetUsbType(WdfUsbRequestTypeDeviceUrb);
        pContext->m_UsbParameters.Parameters.DeviceUrb.Buffer = UrbMemory;
    }

if() [4/4]

if	(	UrbOffsets !	= NULL && UrbOffsets->BufferOffset,
		0
	)

Definition at line 198 of file fxusbdeviceapikm.cpp.

                                                            {
        bufferSize -= UrbOffsets->BufferOffset;
    }

SetMemory()

buf SetMemory	(	pMemory	,
		UrbOffsets
	)

Variable Documentation

Attributes

__checkReturn __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES Attributes

Definition at line 379 of file fxusbdeviceapikm.cpp.

buf

FxRequestBuffer buf

Definition at line 165 of file fxusbdeviceapikm.cpp.

Referenced by __in_xcount().

bufferSize

bufferSize = pMemory->GetBufferSize()

Definition at line 168 of file fxusbdeviceapikm.cpp.

Referenced by if().

CurrentFrameNumber

_Must_inspect_result_ __in WDFUSBDEVICE __out PULONG CurrentFrameNumber

Initial value:

{
    DDI_ENTRY()

Definition at line 43 of file fxusbdeviceapikm.cpp.

pFxDriverGlobals

PFX_DRIVER_GLOBALS pFxDriverGlobals

Definition at line 48 of file fxusbdeviceapikm.cpp.

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

pMemory

IFxMemory* pMemory

Definition at line 163 of file fxusbdeviceapikm.cpp.

Referenced by if().

pRequest

FxRequest* pRequest

Definition at line 166 of file fxusbdeviceapikm.cpp.

Referenced by if().

pUsbDevice

FxUsbDevice* pUsbDevice

Definition at line 49 of file fxusbdeviceapikm.cpp.

Referenced by __deref_opt_out_bcount(), and __in_xcount().

Request

_Must_inspect_result_ __in WDFUSBDEVICE __in WDFREQUEST Request

Initial value:

{
    DDI_ENTRY()

Definition at line 72 of file fxusbdeviceapikm.cpp.

RequestOptions

_Must_inspect_result_ __in WDFUSBDEVICE __in_opt WDFREQUEST __in_opt PWDF_REQUEST_SEND_OPTIONS RequestOptions

Definition at line 74 of file fxusbdeviceapikm.cpp.

status

return status = pMemory->ValidateMemoryOffsets(UrbOffsets)

Definition at line 167 of file fxusbdeviceapikm.cpp.

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

UrbMemory

__checkReturn __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES __out WDFMEMORY* UrbMemory

Definition at line 155 of file fxusbdeviceapikm.cpp.

Referenced by if().

UrbOffsets

_Must_inspect_result_ __in WDFUSBDEVICE __in WDFREQUEST __in WDFMEMORY __in_opt PWDFMEMORY_OFFSET UrbOffsets

Initial value:

{
    DDI_ENTRY()

Definition at line 157 of file fxusbdeviceapikm.cpp.

Referenced by if().

UsbDevice

__checkReturn __in WDFUSBDEVICE UsbDevice

Initial value:

{
    DDI_ENTRY()

Definition at line 41 of file fxusbdeviceapikm.cpp.