#include "../fxtargetsshared.hpp"

Include dependency graph for fxiotargetapi.cpp:

Functions
_Must_inspect_result_	__drv_maxIRQL (DISPATCH_LEVEL) NTSTATUS NTAPI WDFEXPORT(WdfIoTargetStart)(__in PWDF_DRIVER_GLOBALS DriverGlobals

	FxObjectHandleGetPtr (GetFxDriverGlobals(DriverGlobals), IoTarget, FX_TYPE_IO_TARGET,(PVOID *) &pTarget)

return pTarget	Start ()

	__drv_when (Action==3, __drv_maxIRQL(DISPATCH_LEVEL)) __drv_when(Action

	__drv_maxIRQL (PASSIVE_LEVEL)) VOID NTAPI WDFEXPORT(WdfIoTargetStop)(__in PWDF_DRIVER_GLOBALS DriverGlobals

__in WDFIOTARGET __in	__drv_strictTypeMatch (__drv_typeConst) WDF_IO_TARGET_SENT_IO_ACTION Action)

return pTarget	GetState ()

_Must_inspect_result_ NTSTATUS	FxIoTargetValidateOpenParams (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in PWDF_IO_TARGET_OPEN_PARAMS OpenParams)

	FxObjectHandleGetPtrAndGlobals (GetFxDriverGlobals(DriverGlobals), Device, FX_TYPE_DEVICE_BASE,(PWDFOBJECT) &pDevice, &pFxDriverGlobals)

	FxPointerNotNull (pFxDriverGlobals, IoTarget)

	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "WDFDEVICE 0x%p", Device)

	if (!NT_SUCCESS(status))

	if (NT_SUCCESS(status))

	FxObjectHandleGetPtrAndGlobals (GetFxDriverGlobals(DriverGlobals), IoTarget, FX_TYPE_IO_TARGET_REMOTE,(PVOID *) &pTarget, &pFxDriverGlobals)

	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "enter WDFIOTARGET 0x%p", IoTarget)

	FxPointerNotNull (pFxDriverGlobals, OpenParams)

	if (OpenParams->Size !=sizeof(WDF_IO_TARGET_OPEN_PARAMS) &&OpenParams->Size !=sizeof(WDF_IO_TARGET_OPEN_PARAMS_V1_11))

	if (OpenParams->Size< sizeof(WDF_IO_TARGET_OPEN_PARAMS))

	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "exit WDFIOTARGET 0x%p, %!STATUS!", IoTarget, status)

pTarget	Close (FxIoTargetRemoteCloseReasonQueryRemove)

pTarget	Close (FxIoTargetRemoteCloseReasonPlainClose)

	FxObjectHandleGetPtrAndGlobals (GetFxDriverGlobals(DriverGlobals), IoTarget, FX_TYPE_IO_TARGET,(PVOID *) &pTarget, &pFxDriverGlobals)

	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "exit WDFIOTARGET 0x%p, WDFDEVICE 0x%p", IoTarget, device)

static _Must_inspect_result_ NTSTATUS	FxIoTargetSendIo (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in WDFIOTARGET IoTarget, __inout_opt WDFREQUEST Request, __in UCHAR MajorCode, __inout_opt PWDF_MEMORY_DESCRIPTOR IoBuffer, __in_opt PLONGLONG DeviceOffset, __in_opt PWDF_REQUEST_SEND_OPTIONS RequestOptions, __out_opt PULONG_PTR BytesReturned)

static _Must_inspect_result_ NTSTATUS	FxIoTargetFormatIo (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in WDFIOTARGET IoTarget, __inout WDFREQUEST Request, __in UCHAR MajorCode, __inout_opt WDFMEMORY IoBuffer, __in_opt PWDFMEMORY_OFFSET IoBufferOffsets, __in_opt PLONGLONG DeviceOffset)

return	FxIoTargetSendIo (GetFxDriverGlobals(DriverGlobals), IoTarget, Request, IRP_MJ_READ, OutputBuffer, DeviceOffset, RequestOptions, BytesRead)

return	FxIoTargetFormatIo (GetFxDriverGlobals(DriverGlobals), IoTarget, Request, IRP_MJ_READ, OutputBuffer, OutputBufferOffsets, DeviceOffset)

return	FxIoTargetSendIo (GetFxDriverGlobals(DriverGlobals), IoTarget, Request, IRP_MJ_WRITE, InputBuffer, DeviceOffset, RequestOptions, BytesWritten)

return	FxIoTargetFormatIo (GetFxDriverGlobals(DriverGlobals), IoTarget, Request, IRP_MJ_WRITE, InputBuffer, InputBufferOffsets, DeviceOffset)

_Must_inspect_result_ NTSTATUS	FxIoTargetSendIoctl (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in WDFIOTARGET IoTarget, __in_opt WDFREQUEST Request, __in ULONG Ioctl, __in BOOLEAN Internal, __in_opt PWDF_MEMORY_DESCRIPTOR InputBuffer, __in_opt PWDF_MEMORY_DESCRIPTOR OutputBuffer, __in_opt PWDF_REQUEST_SEND_OPTIONS RequestOptions, __out_opt PULONG_PTR BytesReturned)

static _Must_inspect_result_ NTSTATUS	FxIoTargetFormatIoctl (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in WDFIOTARGET IoTarget, __in WDFREQUEST Request, __in ULONG Ioctl, __in BOOLEAN Internal, __in_opt WDFMEMORY InputBuffer, __in_opt PWDFMEMORY_OFFSET InputBufferOffsets, __in_opt WDFMEMORY OutputBuffer, __in_opt PWDFMEMORY_OFFSET OutputBufferOffsets)

return	FxIoTargetSendIoctl (GetFxDriverGlobals(DriverGlobals), IoTarget, Request, Ioctl, FALSE, InputBuffer, OutputBuffer, RequestOptions, BytesReturned)

return	FxIoTargetFormatIoctl (GetFxDriverGlobals(DriverGlobals), IoTarget, Request, Ioctl, FALSE, InputBuffer, InputBufferOffsets, OutputBuffer, OutputBufferOffsets)

return	FxIoTargetSendIoctl (GetFxDriverGlobals(DriverGlobals), IoTarget, Request, Ioctl, TRUE, InputBuffer, OutputBuffer, RequestOptions, BytesReturned)

return	FxIoTargetFormatIoctl (GetFxDriverGlobals(DriverGlobals), IoTarget, Request, Ioctl, TRUE, InputBuffer, InputBufferOffsets, OutputBuffer, OutputBufferOffsets)

FxSyncRequest	request (pFxDriverGlobals, &context, Request)

	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "enter: WDFIOTARGET 0x%p, WDFREQUEST 0x%p, IOCTL 0x%x, Args %p %p %p", IoTarget, Request, Ioctl, OtherArg1, OtherArg2, OtherArg4)

	if (OtherArg1 !=NULL)

	if (OtherArg2 !=NULL)

	if (OtherArg4 !=NULL)

	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "Enter: WDFIOTARGET 0x%p, WDFREQUEST 0x%p, IOCTL 0x%x, " "WDFMEMORY 1 0x%p, 2 0x%p, 3 0x%p", IoTarget, Request, Ioctl, OtherArg1, OtherArg2, OtherArg4)

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

	for (i=0;i< FX_REQUEST_NUM_OTHER_PARAMS;i++)

	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "Exit: WDFIOTARGET %p, WDFREQUEST %p, IOCTL 0x%x, " "Arg Handles %p %p %p, status %!STATUS!", IoTarget, Request, Ioctl, OtherArg1, OtherArg2, OtherArg4, status)

_Must_inspect_result_	_IRQL_requires_max_ (DISPATCH_LEVEL) NTSTATUS NTAPI WDFEXPORT(WdfIoTargetSelfAssignDefaultIoQueue)(_In_ PWDF_DRIVER_GLOBALS DriverGlobals

	FxObjectHandleGetPtrAndGlobals (GetFxDriverGlobals(DriverGlobals), IoTarget, FX_TYPE_IO_TARGET_SELF,(PVOID *) &pTargetSelf, &pGlobals)

	FxObjectHandleGetPtr (pGlobals, Queue, FX_TYPE_QUEUE,(PVOID *)&pFxIoQueue)

	if (pDevice !=pFxIoQueue->GetDevice())

	if (pDevice->IsLegacy())

	DoTraceLevelMessage (pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET, "exit WDFIOTARGET 0x%p, WDM file handle 0x%p", IoTarget, handle)

Variables
_Must_inspect_result_ __in WDFIOTARGET	IoTarget

FxIoTarget *	pTarget

_Must_inspect_result_ __in WDFDEVICE	Device

_Must_inspect_result_ __in WDFDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES	IoTargetAttributes

PFX_DRIVER_GLOBALS	pFxDriverGlobals = GetFxDriverGlobals(DriverGlobals)

FxDeviceBase *	pDevice = NULL

NTSTATUS	status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL)

_Must_inspect_result_ __in WDFIOTARGET __in PWDF_IO_TARGET_OPEN_PARAMS	OpenParams

ULONG	expectedConfigSize

WDF_IO_TARGET_OPEN_PARAMS	openParams

WDFDEVICE	device = pTarget->GetDeviceHandle()

_Must_inspect_result_ __in WDFIOTARGET __in_opt WDFREQUEST	Request

_Must_inspect_result_ __in WDFIOTARGET __in_opt WDFREQUEST __in_opt PWDF_MEMORY_DESCRIPTOR	OutputBuffer

_Must_inspect_result_ __in WDFIOTARGET __in_opt WDFREQUEST __in_opt PWDF_MEMORY_DESCRIPTOR __in_opt PLONGLONG	DeviceOffset

_Must_inspect_result_ __in WDFIOTARGET __in_opt WDFREQUEST __in_opt PWDF_MEMORY_DESCRIPTOR __in_opt PLONGLONG __in_opt PWDF_REQUEST_SEND_OPTIONS	RequestOptions

_Must_inspect_result_ __in WDFIOTARGET __in_opt WDFREQUEST __in_opt PWDF_MEMORY_DESCRIPTOR __in_opt PLONGLONG __in_opt PWDF_REQUEST_SEND_OPTIONS __out_opt PULONG_PTR	BytesRead

_Must_inspect_result_ __in WDFIOTARGET __in WDFREQUEST __in_opt WDFMEMORY __in_opt PWDFMEMORY_OFFSET	OutputBufferOffsets

_Must_inspect_result_ __in WDFIOTARGET __in_opt WDFREQUEST __in_opt PWDF_MEMORY_DESCRIPTOR	InputBuffer

_Must_inspect_result_ __in WDFIOTARGET __in_opt WDFREQUEST __in_opt PWDF_MEMORY_DESCRIPTOR __in_opt PLONGLONG __in_opt PWDF_REQUEST_SEND_OPTIONS __out_opt PULONG_PTR	BytesWritten

_Must_inspect_result_ __in WDFIOTARGET __in WDFREQUEST __in_opt WDFMEMORY __in_opt PWDFMEMORY_OFFSET	InputBufferOffsets

_Must_inspect_result_ __in WDFIOTARGET __in_opt WDFREQUEST __in ULONG	Ioctl

_Must_inspect_result_ __in WDFIOTARGET __in_opt WDFREQUEST __in ULONG __in_opt PWDF_MEMORY_DESCRIPTOR __in_opt PWDF_MEMORY_DESCRIPTOR __in_opt PWDF_REQUEST_SEND_OPTIONS __out_opt PULONG_PTR	BytesReturned

_Must_inspect_result_ __in WDFIOTARGET __in_opt WDFREQUEST __in ULONG __in_opt PWDF_MEMORY_DESCRIPTOR	OtherArg1

_Must_inspect_result_ __in WDFIOTARGET __in_opt WDFREQUEST __in ULONG __in_opt PWDF_MEMORY_DESCRIPTOR __in_opt PWDF_MEMORY_DESCRIPTOR	OtherArg2

_Must_inspect_result_ __in WDFIOTARGET __in_opt WDFREQUEST __in ULONG __in_opt PWDF_MEMORY_DESCRIPTOR __in_opt PWDF_MEMORY_DESCRIPTOR __in_opt PWDF_MEMORY_DESCRIPTOR	OtherArg4

FxRequestBuffer	args [FX_REQUEST_NUM_OTHER_PARAMS]

FxInternalIoctlOthersContext	context

ULONG	i = 0

	else

_Must_inspect_result_ __in WDFIOTARGET __in WDFREQUEST __in ULONG __in_opt WDFMEMORY __in_opt PWDFMEMORY_OFFSET	OtherArg1Offsets

_Must_inspect_result_ __in WDFIOTARGET __in WDFREQUEST __in ULONG __in_opt WDFMEMORY __in_opt PWDFMEMORY_OFFSET __in_opt WDFMEMORY __in_opt PWDFMEMORY_OFFSET	OtherArg2Offsets

_Must_inspect_result_ __in WDFIOTARGET __in WDFREQUEST __in ULONG __in_opt WDFMEMORY __in_opt PWDFMEMORY_OFFSET __in_opt WDFMEMORY __in_opt PWDFMEMORY_OFFSET __in_opt WDFMEMORY __in_opt PWDFMEMORY_OFFSET	OtherArg4Offsets

FxRequest *	pRequest

IFxMemory *	pMemory [FX_REQUEST_NUM_OTHER_PARAMS]

WDFMEMORY	memoryHandles [FX_REQUEST_NUM_OTHER_PARAMS]

PWDFMEMORY_OFFSET	offsets [FX_REQUEST_NUM_OTHER_PARAMS] = OtherArg1Offsets

FxInternalIoctlParams	InternalIoctlParams

InternalIoctlParams	Argument1 = memoryHandles[i] = OtherArg1

InternalIoctlParams	Argument2 = memoryHandles[++i] = OtherArg2

InternalIoctlParams	Argument4 = memoryHandles[++i] = OtherArg4

_Must_inspect_result_ _In_ WDFIOTARGET _In_ WDFQUEUE	Queue

PFX_DRIVER_GLOBALS	pGlobals

FxIoTargetSelf *	pTargetSelf

FxIoQueue *	pFxIoQueue = NULL

return	STATUS_SUCCESS

PVOID	handle = pTarget->GetTargetHandle()

Function Documentation

◆ __drv_maxIRQL() [1/2]

_Must_inspect_result_ __drv_maxIRQL ( DISPATCH_LEVEL )

◆ __drv_maxIRQL() [2/2]

__drv_maxIRQL ( PASSIVE_LEVEL )

◆ __drv_strictTypeMatch()

__in WDFIOTARGET __in __drv_strictTypeMatch ( __drv_typeConst )

Definition at line 80 of file fxiotargetapi.cpp.

{
    DDI_ENTRY();
 
    PFX_DRIVER_GLOBALS pFxDriverGlobals;
    FxIoTarget* pTarget;
    NTSTATUS status;
 
    FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals),
                                   IoTarget,
                                   FX_TYPE_IO_TARGET,
                                   (PVOID*) &pTarget,
                                   &pFxDriverGlobals);
 
    if (Action == WdfIoTargetSentIoUndefined ||
        Action > WdfIoTargetLeaveSentIoPending) {
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                            "Action %d undefined or out of range", Action);
        return;
    }
 
    if (Action == WdfIoTargetCancelSentIo ||
        Action == WdfIoTargetWaitForSentIoToComplete) {
        status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL);
        if (!NT_SUCCESS(status)) {
            return;
        }
    }
 
    pTarget->Stop(Action);
}

◆ __drv_when()

__drv_when	(	Action	= `= 3`,
		__drv_maxIRQL(DISPATCH_LEVEL)
	)

◆ _IRQL_requires_max_()

_Must_inspect_result_ _IRQL_requires_max_ ( DISPATCH_LEVEL )

Definition at line 347 of file common.c.

{
    NTSTATUS                    status;
    BOOLEAN                     requestSent = FALSE;
 
    BOOLEAN                     shouldRetry = TRUE;
    PCDB                        cdb = (PCDB)DeviceExtension->PowerContext.Srb.Cdb;
    ULONG                       timeoutValue = DeviceExtension->TimeOutValue;
    ULONG                       retryCount = 1;
 
    // reset some fields.
    DeviceExtension->PowerContext.RetryIntervalIn100ns = 0;
    status = PowerContextReuseRequest(DeviceExtension);
    RequestClearSendTime(DeviceExtension->PowerContext.PowerRequest);
 
    if (!NT_SUCCESS(status))
    {
        return status;
    }
 
    // set proper timeout value and max retry count.
    switch(DeviceExtension->PowerContext.PowerChangeState.PowerDown)
    {
    case PowerDownDeviceInitial:
    case PowerDownDeviceQuiesced:
    case PowerDownDeviceStopped:
        break;
 
    case PowerDownDeviceLocked:
        // Case of issuing SYNC CACHE command. Do not use power irp timeout remaining time in this case
        // as we want to give best try on SYNC CACHE command.
        retryCount = MAXIMUM_RETRIES;
        timeoutValue = DeviceExtension->TimeOutValue;
        break;
 
    case PowerDownDeviceFlushed:
    {
        // Case of issuing STOP UNIT command
        // As "Imme" bit is set to '1', this command should be completed in short time.
        // This command is at low importance, failure of this command has very small impact.
        ULONG secondsRemaining = 0;
 
#if (WINVER >= 0x0601)
        // this API is introduced in Windows7
        PoQueryWatchdogTime(DeviceExtension->LowerPdo, &secondsRemaining);
#endif
 
        if (secondsRemaining == 0)
        {
            // not able to retrieve remaining time from PoQueryWatchdogTime API, use default values.
            retryCount = MAXIMUM_RETRIES;
            timeoutValue = SCSI_CDROM_TIMEOUT;
        }
        else
        {
            // plan to leave about 30 seconds to lower level drivers if possible.
            if (secondsRemaining >= 32)
            {
                retryCount = (secondsRemaining - 30)/SCSI_CDROM_TIMEOUT + 1;
                timeoutValue = SCSI_CDROM_TIMEOUT;
 
                if (retryCount > MAXIMUM_RETRIES)
                {
                    retryCount = MAXIMUM_RETRIES;
                }
 
                if (retryCount == 1)
                {
                    timeoutValue = secondsRemaining - 30;
                }
            }
            else
            {
                // issue the command with minimal timeout value and do not retry on it.
                retryCount = 1;
                timeoutValue = 2;
            }
        }
    }
        break;
    default:
        NT_ASSERT( FALSE );
        status = STATUS_NOT_IMPLEMENTED;
        return status;
    }
 
    DeviceExtension->PowerContext.RetryCount = retryCount;
 
    // issue command.
    while (shouldRetry)
    {
 
        // set SRB fields.
        DeviceExtension->PowerContext.Srb.SrbFlags = SRB_FLAGS_NO_DATA_TRANSFER |
                                                     SRB_FLAGS_DISABLE_SYNCH_TRANSFER |
                                                     SRB_FLAGS_NO_QUEUE_FREEZE |
                                                     SRB_FLAGS_BYPASS_LOCKED_QUEUE |
                                                     SRB_FLAGS_D3_PROCESSING;
 
        DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_EXECUTE_SCSI;
        DeviceExtension->PowerContext.Srb.TimeOutValue = timeoutValue;
 
        if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceInitial)
        {
            DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_LOCK_QUEUE;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceLocked)
        {
            DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_QUIESCE_DEVICE;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceQuiesced)
        {
            // Case of issuing SYNC CACHE command.
            DeviceExtension->PowerContext.Srb.CdbLength = 10;
            cdb->SYNCHRONIZE_CACHE10.OperationCode = SCSIOP_SYNCHRONIZE_CACHE;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceFlushed)
        {
            // Case of issuing STOP UNIT command.
            DeviceExtension->PowerContext.Srb.CdbLength = 6;
            cdb->START_STOP.OperationCode = SCSIOP_START_STOP_UNIT;
            cdb->START_STOP.Start = 0;
            cdb->START_STOP.Immediate = 1;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceStopped)
        {
            DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_UNLOCK_QUEUE;
        }
 
        // Set up completion routine and context if requested
        if (CompletionRoutine)
        {
            WdfRequestSetCompletionRoutine(DeviceExtension->PowerContext.PowerRequest,
                                           CompletionRoutine,
                                           Context);
        }
 
        status = RequestSend(DeviceExtension,
                             DeviceExtension->PowerContext.PowerRequest,
                             DeviceExtension->IoTarget,
                             CompletionRoutine ? 0 : WDF_REQUEST_SEND_OPTION_SYNCHRONOUS,
                             &requestSent);
 
        if (requestSent)
        {
            if ((CompletionRoutine == NULL) &&
                (SRB_STATUS(DeviceExtension->PowerContext.Srb.SrbStatus) != SRB_STATUS_SUCCESS))
            {
                TracePrint((TRACE_LEVEL_ERROR,
                            TRACE_FLAG_POWER,
                            "%p\tError occured when issuing %s command to device. Srb %p, Status %x\n",
                            DeviceExtension->PowerContext.PowerRequest,
                            (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceQuiesced) ? "SYNC CACHE" : "STOP UNIT",
                            &DeviceExtension->PowerContext.Srb,
                            DeviceExtension->PowerContext.Srb.SrbStatus));
 
                NT_ASSERT(!(TEST_FLAG(DeviceExtension->PowerContext.Srb.SrbStatus, SRB_STATUS_QUEUE_FROZEN)));
 
                shouldRetry = RequestSenseInfoInterpret(DeviceExtension,
                                                        DeviceExtension->PowerContext.PowerRequest,
                                                        &(DeviceExtension->PowerContext.Srb),
                                                        retryCount - DeviceExtension->PowerContext.RetryCount,
                                                        &status,
                                                        &(DeviceExtension->PowerContext.RetryIntervalIn100ns));
 
                if (shouldRetry && (DeviceExtension->PowerContext.RetryCount-- == 0))
                {
                    shouldRetry = FALSE;
                }
            }
            else
            {
                // succeeded, do not need to retry.
                shouldRetry = FALSE;
            }
 
        }
        else
        {
            // request failed to be sent
            shouldRetry = FALSE;
        }
 
        if (shouldRetry)
        {
            LARGE_INTEGER t;
            t.QuadPart = -DeviceExtension->PowerContext.RetryIntervalIn100ns;
            KeDelayExecutionThread(KernelMode, FALSE, &t);
 
            status = PowerContextReuseRequest(DeviceExtension);
            if (!NT_SUCCESS(status))
            {
                shouldRetry = FALSE;
            }
        }
    }
 
    if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceQuiesced)
    {
        // record SYNC CACHE command completion time stamp.
        KeQueryTickCount(&DeviceExtension->PowerContext.Step1CompleteTime);
    }
 
    return status;
}

◆ Close() [1/2]

pTarget Close ( FxIoTargetRemoteCloseReasonPlainClose )

◆ Close() [2/2]

pTarget Close ( FxIoTargetRemoteCloseReasonQueryRemove )

◆ DoTraceLevelMessage() [1/8]

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_VERBOSE	,
		TRACINGIOTARGET	,
		"enter WDFIOTARGET 0x%p"	,
		IoTarget
	)

◆ DoTraceLevelMessage() [2/8]

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_VERBOSE	,
		TRACINGIOTARGET	,
		"enter: WDFIOTARGET 0x%	p,
		WDFREQUEST 0x%	p,
		IOCTL 0x%	x,
		Args %p %p %p"	,
		IoTarget	,
		Request	,
		Ioctl	,
		OtherArg1	,
		OtherArg2	,
		OtherArg4
	)

◆ DoTraceLevelMessage() [3/8]

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_VERBOSE	,
		TRACINGIOTARGET	,
		"Enter: WDFIOTARGET 0x%	p,
		WDFREQUEST 0x%	p,
		IOCTL 0x%	x,
		" "WDFMEMORY 1 0x%	p,
		2 0x%	p,
		3 0x%p"	,
		IoTarget	,
		Request	,
		Ioctl	,
		OtherArg1	,
		OtherArg2	,
		OtherArg4
	)

◆ DoTraceLevelMessage() [4/8]

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_VERBOSE	,
		TRACINGIOTARGET	,
		"exit WDFIOTARGET 0x%	p,
		%!STATUS!"	,
		IoTarget	,
		status
	)

◆ DoTraceLevelMessage() [5/8]

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_VERBOSE	,
		TRACINGIOTARGET	,
		"exit WDFIOTARGET 0x%	p,
		WDFDEVICE 0x%p"	,
		IoTarget	,
		device
	)

◆ DoTraceLevelMessage() [6/8]

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_VERBOSE	,
		TRACINGIOTARGET	,
		"exit WDFIOTARGET 0x%	p,
		WDM file handle 0x%p"	,
		IoTarget	,
		handle
	)

◆ DoTraceLevelMessage() [7/8]

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_VERBOSE	,
		TRACINGIOTARGET	,
		"Exit: WDFIOTARGET %	p,
		WDFREQUEST %	p,
		IOCTL 0x%	x,
		" "Arg Handles %p %p %	p,
		status %!STATUS!"	,
		IoTarget	,
		Request	,
		Ioctl	,
		OtherArg1	,
		OtherArg2	,
		OtherArg4	,
		status
	)

◆ DoTraceLevelMessage() [8/8]

DoTraceLevelMessage	(	pFxDriverGlobals	,
		TRACE_LEVEL_VERBOSE	,
		TRACINGIOTARGET	,
		"WDFDEVICE 0x%p"	,
		Device
	)

Referenced by __drv_strictTypeMatch(), for(), FxIoTargetFormatIo(), FxIoTargetFormatIoctl(), FxIoTargetSendIo(), FxIoTargetSendIoctl(), FxIoTargetValidateOpenParams(), and if().

◆ for()

for ( )

Definition at line 1829 of file fxiotargetapi.cpp.

                                                      {
        if (memoryHandles[i] != NULL) {
 
            FxObjectHandleGetPtr(pFxDriverGlobals,
                                 memoryHandles[i],
                                 IFX_TYPE_MEMORY,
                                 (PVOID*) &pMemory[i]);
 
            status = pMemory[i]->ValidateMemoryOffsets(offsets[i]);
            if (!NT_SUCCESS(status)) {
                DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                                    "Invalid OtherArg%d memory offsets, %!STATUS!",
                                    i+1, status);
                return status;
            }
 
            //
            // This transcribes the client union into a local structure which we
            // can change w/out altering the client's buffer.
            //
            args[i].SetMemory(pMemory[i], offsets[i]);
        }
    }

◆ FxIoTargetFormatIo() [1/3]

static _Must_inspect_result_ NTSTATUS FxIoTargetFormatIo	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in WDFIOTARGET	IoTarget,
		__inout WDFREQUEST	Request,
		__in UCHAR	MajorCode,
		__inout_opt WDFMEMORY	IoBuffer,
		__in_opt PWDFMEMORY_OFFSET	IoBufferOffsets,
		__in_opt PLONGLONG	DeviceOffset
	)

static

Definition at line 838 of file fxiotargetapi.cpp.

{
    FxIoTarget *pTarget;
    FxRequest *pRequest;
    IFxMemory* pIoMemory;
    FxRequestBuffer ioBuf;
    NTSTATUS status;
 
    FxObjectHandleGetPtrAndGlobals(FxDriverGlobals,
                                   IoTarget,
                                   FX_TYPE_IO_TARGET,
                                   (PVOID*) &pTarget,
                                   &FxDriverGlobals);
 
    DoTraceLevelMessage(FxDriverGlobals,
        TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
        "enter: WDFIOTARGET 0x%p, WDFREQUEST 0x%p, MJ code 0x%x, WDFMEMORY 0x%p",
        IoTarget, Request, MajorCode, IoBuffer);
 
    FxObjectHandleGetPtr(FxDriverGlobals,
                         Request,
                         FX_TYPE_REQUEST,
                         (PVOID*) &pRequest);
 
    if (IoBuffer != NULL) {
        FxObjectHandleGetPtr(FxDriverGlobals,
                             IoBuffer,
                             IFX_TYPE_MEMORY,
                             (PVOID*) &pIoMemory);
 
        status = pIoMemory->ValidateMemoryOffsets(IoBufferOffsets);
        if (!NT_SUCCESS(status)) {
            DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                                "invalid memory offsets, %!STATUS!",
                                status);
            return status;
        }
 
        //
        // This transcribes the client union into a local structure which we
        // can change w/out altering the client's buffer.
        //
        ioBuf.SetMemory(pIoMemory, IoBufferOffsets);
    }
    else {
        pIoMemory = NULL;
    }
 
    //
    // Format the next stack locaiton in the PIRP
    //
    status = pTarget->FormatIoRequest(
        pRequest, MajorCode, &ioBuf, DeviceOffset, NULL);
 
    if (NT_SUCCESS(status)) {
        if (MajorCode == IRP_MJ_WRITE) {
            pRequest->GetContext()->FormatWriteParams(pIoMemory, IoBufferOffsets);
        }
        else if (MajorCode == IRP_MJ_READ) {
            pRequest->GetContext()->FormatReadParams(pIoMemory, IoBufferOffsets);
        }
    }
 
    DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
                        "exit WDFIOTARGET 0x%p, WDFREQUEST 0x%p, %!STATUS!",
                        IoTarget, Request, status);
 
    return status;
}

◆ FxIoTargetFormatIo() [2/3]

return FxIoTargetFormatIo	(	GetFxDriverGlobals(DriverGlobals)	,
		IoTarget	,
		Request	,
		IRP_MJ_READ	,
		OutputBuffer	,
		OutputBufferOffsets	,
		DeviceOffset
	)

◆ FxIoTargetFormatIo() [3/3]

return FxIoTargetFormatIo	(	GetFxDriverGlobals(DriverGlobals)	,
		IoTarget	,
		Request	,
		IRP_MJ_WRITE	,
		InputBuffer	,
		InputBufferOffsets	,
		DeviceOffset
	)

◆ FxIoTargetFormatIoctl() [1/3]

static _Must_inspect_result_ NTSTATUS FxIoTargetFormatIoctl	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in WDFIOTARGET	IoTarget,
		__in WDFREQUEST	Request,
		__in ULONG	Ioctl,
		__in BOOLEAN	Internal,
		__in_opt WDFMEMORY	InputBuffer,
		__in_opt PWDFMEMORY_OFFSET	InputBufferOffsets,
		__in_opt WDFMEMORY	OutputBuffer,
		__in_opt PWDFMEMORY_OFFSET	OutputBufferOffsets
	)

static

Definition at line 1233 of file fxiotargetapi.cpp.

{
    FxIoTarget *pTarget;
    FxRequest *pRequest;
    IFxMemory *pInputMemory, *pOutputMemory;
    FxRequestBuffer inputBuf, outputBuf;
    NTSTATUS status;
 
    FxObjectHandleGetPtrAndGlobals(FxDriverGlobals,
                                   IoTarget,
                                   FX_TYPE_IO_TARGET,
                                   (PVOID*) &pTarget,
                                   &FxDriverGlobals);
 
    DoTraceLevelMessage(
        FxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
        "enter: WDFIOTARGET 0x%p, WDFREQUEST 0x%p, IOCTL 0x%x, internal %d, input "
        "WDFMEMORY 0x%p, output WDFMEMORY 0x%p",
        IoTarget, Request, Ioctl, Internal, InputBuffer, OutputBuffer);
 
    FxObjectHandleGetPtr(FxDriverGlobals,
                         Request,
                         FX_TYPE_REQUEST,
                         (PVOID*) &pRequest);
 
    if (InputBuffer != NULL) {
        FxObjectHandleGetPtr(FxDriverGlobals,
                             InputBuffer,
                             IFX_TYPE_MEMORY,
                             (PVOID*) &pInputMemory);
 
        status = pInputMemory->ValidateMemoryOffsets(InputBufferOffsets);
        if (!NT_SUCCESS(status)) {
            DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                                "Invalid input memory offsets, %!STATUS!",
                                status);
            return status;
        }
 
        //
        // This transcribes the client union into a local structure which we
        // can change w/out altering the client's buffer.
        //
        inputBuf.SetMemory(pInputMemory, InputBufferOffsets);
    }
 
    if (OutputBuffer != NULL) {
        FxObjectHandleGetPtr(FxDriverGlobals,
                             OutputBuffer,
                             IFX_TYPE_MEMORY,
                             (PVOID*) &pOutputMemory);
 
        status = pOutputMemory->ValidateMemoryOffsets(OutputBufferOffsets);
        if (!NT_SUCCESS(status)) {
            DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                                "Invalid output memory offsets, %!STATUS!",
                                status);
            return status;
        }
 
        //
        // This transcribes the client union into a local structure which we
        // can change w/out altering the client's buffer.
        //
        outputBuf.SetMemory(pOutputMemory, OutputBufferOffsets);
    }
 
    //
    // format the next stack location
    //
    status = pTarget->FormatIoctlRequest(
        pRequest, Ioctl, Internal, &inputBuf, &outputBuf, NULL);
 
    if (NT_SUCCESS(status)) {
        FxRequestContext* pContext;
 
        //
        // Upon a successful format,  a FxRequestContext will have been
        // associated with the FxRequest
        //
        pContext = pRequest->GetContext();
 
        pContext->m_CompletionParams.Parameters.Ioctl.IoControlCode = Ioctl;
 
        if (Internal) {
            pContext->m_CompletionParams.Type = WdfRequestTypeDeviceControlInternal;
        }
        else {
            pContext->m_CompletionParams.Type = WdfRequestTypeDeviceControl;
        }
 
        pContext->m_CompletionParams.Parameters.Ioctl.Input.Buffer = InputBuffer;
        if (InputBufferOffsets != NULL) {
            pContext->m_CompletionParams.Parameters.Ioctl.Input.Offset =
                InputBufferOffsets->BufferOffset;
        }
 
        pContext->m_CompletionParams.Parameters.Ioctl.Output.Buffer = OutputBuffer;
        if (OutputBufferOffsets != NULL) {
            pContext->m_CompletionParams.Parameters.Ioctl.Output.Offset =
                OutputBufferOffsets->BufferOffset;
        }
    }
 
    DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
                        "Exit WDFIOTARGET 0x%p, WDFREQUEST 0x%p, %!STATUS!",
                        IoTarget, Request, status);
 
    return status;
}

◆ FxIoTargetFormatIoctl() [2/3]

return FxIoTargetFormatIoctl	(	GetFxDriverGlobals(DriverGlobals)	,
		IoTarget	,
		Request	,
		Ioctl	,
		FALSE	,
		InputBuffer	,
		InputBufferOffsets	,
		OutputBuffer	,
		OutputBufferOffsets
	)

◆ FxIoTargetFormatIoctl() [3/3]

return FxIoTargetFormatIoctl	(	GetFxDriverGlobals(DriverGlobals)	,
		IoTarget	,
		Request	,
		Ioctl	,
		TRUE	,
		InputBuffer	,
		InputBufferOffsets	,
		OutputBuffer	,
		OutputBufferOffsets
	)

◆ FxIoTargetSendIo() [1/3]

static _Must_inspect_result_ NTSTATUS FxIoTargetSendIo	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in WDFIOTARGET	IoTarget,
		__inout_opt WDFREQUEST	Request,
		__in UCHAR	MajorCode,
		__inout_opt PWDF_MEMORY_DESCRIPTOR	IoBuffer,
		__in_opt PLONGLONG	DeviceOffset,
		__in_opt PWDF_REQUEST_SEND_OPTIONS	RequestOptions,
		__out_opt PULONG_PTR	BytesReturned
	)

static

Definition at line 695 of file fxiotargetapi.cpp.

{
    FxIoTarget* pTarget;
    FxRequestBuffer ioBuf;
    NTSTATUS status;
 
    FxObjectHandleGetPtrAndGlobals(FxDriverGlobals,
                                   IoTarget,
                                   FX_TYPE_IO_TARGET,
                                   (PVOID*) &pTarget,
                                   &FxDriverGlobals);
 
    //
    // Minimize the points of failure by using the stack instead of allocating
    // out of pool. For UMDF, request initialization can fail so we still need
    // to call initialize for FxSyncRequest. Initialization always succeeds for
    // KM.
    //
    FxIoContext context;
    FxSyncRequest request(FxDriverGlobals, &context, Request);
 
    status = request.Initialize();
    if (!NT_SUCCESS(status)) {
        DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                            "Failed to initialize FxSyncRequest for WDFIOTARGET "
                            "0x%p", IoTarget);
        return status;
    }
 
    DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
                        "enter:  WDFIOTARGET 0x%p, WDFREQUEST 0x%p, MJ code 0x%x",
                        IoTarget, Request, MajorCode);
 
    //
    // Since we are synchronously waiting, we must be at passive level
    //
    status = FxVerifierCheckIrqlLevel(FxDriverGlobals, PASSIVE_LEVEL);
    if (!NT_SUCCESS(status)) {
        return status;
    }
 
    status = FxValidateRequestOptions(FxDriverGlobals, RequestOptions);
    if (!NT_SUCCESS(status)) {
        DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                            "invalid options, %!STATUS!", status);
        return status;
    }
 
    if (IoBuffer != NULL) {
        //
        // This transcribes the client union into a local structure which we
        // can change w/out altering the client's buffer.
        //
        status = ioBuf.ValidateMemoryDescriptor(FxDriverGlobals, IoBuffer);
        if (!NT_SUCCESS(status)) {
            DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                                "invalid input buffer descriptor 0x%p, %!STATUS!",
                                IoBuffer, status);
            return status;
        }
    }
 
    //
    // Format the next stack location in the PIRP
    //
    status = pTarget->FormatIoRequest(
        request.m_TrueRequest, MajorCode, &ioBuf, DeviceOffset, NULL);
 
    if (NT_SUCCESS(status)) {
        //
        // And send it
        //
        DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
                            "WDFIOTARGET 0x%p, WDFREQUEST 0x%p being submitted",
                            IoTarget, request.m_TrueRequest->GetTraceObjectHandle());
 
        status = pTarget->SubmitSync(request.m_TrueRequest, RequestOptions);
 
        if (BytesReturned != NULL) {
            *BytesReturned = request.m_TrueRequest->GetSubmitFxIrp()->GetInformation();
 
        }
    }
    else {
        DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                            "could not format MJ 0x%x request, %!STATUS!",
                            MajorCode, status);
    }
 
    return status;
}

◆ FxIoTargetSendIo() [2/3]

return FxIoTargetSendIo	(	GetFxDriverGlobals(DriverGlobals)	,
		IoTarget	,
		Request	,
		IRP_MJ_READ	,
		OutputBuffer	,
		DeviceOffset	,
		RequestOptions	,
		BytesRead
	)

◆ FxIoTargetSendIo() [3/3]

return FxIoTargetSendIo	(	GetFxDriverGlobals(DriverGlobals)	,
		IoTarget	,
		Request	,
		IRP_MJ_WRITE	,
		InputBuffer	,
		DeviceOffset	,
		RequestOptions	,
		BytesWritten
	)

◆ FxIoTargetSendIoctl() [1/3]

_Must_inspect_result_ NTSTATUS FxIoTargetSendIoctl	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in WDFIOTARGET	IoTarget,
		__in_opt WDFREQUEST	Request,
		__in ULONG	Ioctl,
		__in BOOLEAN	Internal,
		__in_opt PWDF_MEMORY_DESCRIPTOR	InputBuffer,
		__in_opt PWDF_MEMORY_DESCRIPTOR	OutputBuffer,
		__in_opt PWDF_REQUEST_SEND_OPTIONS	RequestOptions,
		__out_opt PULONG_PTR	BytesReturned
	)

Definition at line 1081 of file fxiotargetapi.cpp.

{
    FxIoTarget* pTarget;
    FxRequestBuffer inputBuf, outputBuf;
    NTSTATUS status;
 
    FxObjectHandleGetPtrAndGlobals(FxDriverGlobals,
                                   IoTarget,
                                   FX_TYPE_IO_TARGET,
                                   (PVOID*) &pTarget,
                                   &FxDriverGlobals);
 
    //
    // Minimize the points of failure by using the stack instead of allocating
    // out of pool. For UMDF, request initialization can fail so we still need
    // to call initialize for FxSyncRequest. Initialization always succeeds for
    // KM.
    //
    FxIoContext context;
    FxSyncRequest request(FxDriverGlobals, &context, Request);
 
    status = request.Initialize();
    if (!NT_SUCCESS(status)) {
        DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                            "Failed to initialize FxSyncRequest for WDFIOTARGET "
                            "0x%p", IoTarget);
        return status;
    }
 
    DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
                        "enter:  WDFIOTARGET 0x%p, WDFREQUEST 0x%p, IOCTL 0x%x, "
                        "internal %d", IoTarget, Request, Ioctl, Internal);
 
    //
    // Since we are synchronously waiting, we must be at passive
    //
    status = FxVerifierCheckIrqlLevel(FxDriverGlobals, PASSIVE_LEVEL);
    if (!NT_SUCCESS(status)) {
        return status;
    }
 
    status = FxValidateRequestOptions(FxDriverGlobals, RequestOptions);
    if (!NT_SUCCESS(status)) {
        DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                            "invalid options, %!STATUS!", status);
        return status;
    }
 
    if (InputBuffer != NULL) {
        //
        // This transcribes the client union into a local structure which we
        // can change w/out altering the client's buffer.
        //
        status = inputBuf.ValidateMemoryDescriptor(FxDriverGlobals, InputBuffer);
        if (!NT_SUCCESS(status)) {
            DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                                "invalid input buffer descriptor 0x%p, %!STATUS!",
                                InputBuffer, status);
            return status;
        }
    }
 
    if (OutputBuffer != NULL) {
        //
        // This transcribes the client union into a local structure which we
        // can change w/out altering the client's buffer.
        //
        status = outputBuf.ValidateMemoryDescriptor(FxDriverGlobals, OutputBuffer);
        if (!NT_SUCCESS(status)) {
            DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                                "invalid output buffer descriptor 0x%p, %!STATUS!",
                                OutputBuffer, status);
            return status;
        }
    }
 
    //
    // Format the next stack location
    //
    status = pTarget->FormatIoctlRequest(
        request.m_TrueRequest, Ioctl, Internal, &inputBuf, &outputBuf, NULL);
 
    if (NT_SUCCESS(status)) {
        DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
                            "WDFIOTARGET 0x%p, WDFREQUEST 0x%p being submitted",
                            IoTarget,
                            request.m_TrueRequest->GetTraceObjectHandle());
 
        status = pTarget->SubmitSync(request.m_TrueRequest, RequestOptions);
 
        if (BytesReturned != NULL) {
            *BytesReturned = request.m_TrueRequest->GetSubmitFxIrp()->GetInformation();
        }
    }
    else {
        DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                            "could not format IOCTL 0x%x request, %!STATUS!",
                            Ioctl, status);
    }
 
    return status;
}

◆ FxIoTargetSendIoctl() [2/3]

return FxIoTargetSendIoctl	(	GetFxDriverGlobals(DriverGlobals)	,
		IoTarget	,
		Request	,
		Ioctl	,
		FALSE	,
		InputBuffer	,
		OutputBuffer	,
		RequestOptions	,
		BytesReturned
	)

◆ FxIoTargetSendIoctl() [3/3]

return FxIoTargetSendIoctl	(	GetFxDriverGlobals(DriverGlobals)	,
		IoTarget	,
		Request	,
		Ioctl	,
		TRUE	,
		InputBuffer	,
		OutputBuffer	,
		RequestOptions	,
		BytesReturned
	)

◆ FxIoTargetValidateOpenParams()

_Must_inspect_result_ NTSTATUS FxIoTargetValidateOpenParams	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in PWDF_IO_TARGET_OPEN_PARAMS	OpenParams
	)

Definition at line 225 of file fxiotargetapi.cpp.

{
    NTSTATUS status;
 
    //
    // Check specific fields based on Type
    //
    switch (OpenParams->Type) {
    case WdfIoTargetOpenUseExistingDevice:
        if (OpenParams->TargetDeviceObject == NULL) {
            status = STATUS_INVALID_PARAMETER;
            DoTraceLevelMessage(
                FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                "Expected non NULL TargetDeviceObject in OpenParams, %!STATUS!",
                status);
            return status;
        }
 
        //
        // This type is supported only in KMDF.
        //
        if (FxDriverGlobals->IsUserModeDriver) {
            status = STATUS_INVALID_PARAMETER;
            DoTraceLevelMessage(
                FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                "The open type WdfIoTargetOpenUseExistingDevice is not "
                "supported in UMDF drivers. It is supported in KMDF "
                "drivers only, %!STATUS!",
                status);
            return status;
        }
 
        if (OpenParams->TargetFileObject == NULL &&
            (OpenParams->EvtIoTargetQueryRemove != NULL ||
             OpenParams->EvtIoTargetRemoveCanceled != NULL ||
             OpenParams->EvtIoTargetRemoveComplete != NULL)) {
            status = STATUS_INVALID_PARAMETER;
 
            DoTraceLevelMessage(
                FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                "OpenParams %p TargetFileObject is NULL but a state callback "
                "(query remove %p, remove canceled %p, remove complete %p)"
                " was specified, %!STATUS!",
                OpenParams, OpenParams->EvtIoTargetQueryRemove,
                OpenParams->EvtIoTargetRemoveCanceled,
                OpenParams->EvtIoTargetRemoveComplete, status);
 
            return status;
        }
        break;
 
    case WdfIoTargetOpenByName:
        if (OpenParams->TargetDeviceName.Buffer == NULL ||
            OpenParams->TargetDeviceName.Length == 0 ||
            OpenParams->TargetDeviceName.MaximumLength == 0) {
            status = STATUS_INVALID_PARAMETER;
            DoTraceLevelMessage(
                FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                "Expected valid OpenParams TargetDeviceName string, %!STATUS!",
                status);
            return status;
        }
        break;
 
    case WdfIoTargetOpenLocalTargetByFile:
        //
        // This type is supported only in UMDF.
        //
        if (FxDriverGlobals->IsUserModeDriver == FALSE) {
            status = STATUS_INVALID_PARAMETER;
            DoTraceLevelMessage(
                FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                "The open type WdfIoTargetOpenLocalTargetByFile is not "
                "supported in KMDF drivers. It is supported in UMDF "
                "drivers only, %!STATUS!",
                status);
            return status;
        }
 
        if ((OpenParams->EvtIoTargetQueryRemove != NULL ||
             OpenParams->EvtIoTargetRemoveCanceled != NULL ||
             OpenParams->EvtIoTargetRemoveComplete != NULL)) {
            status = STATUS_INVALID_PARAMETER;
 
            DoTraceLevelMessage(
                FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                "The open type is WdfIoTargetOpenLocalTargetByFile but a state"
                " callback (query remove %p, remove canceled %p, remove"
                " complete %p) was specified, %!STATUS!",
                OpenParams->EvtIoTargetQueryRemove,
                OpenParams->EvtIoTargetRemoveCanceled,
                OpenParams->EvtIoTargetRemoveComplete, status);
 
            return status;
        }
 
        if (OpenParams->FileName.Buffer != NULL ||
            OpenParams->FileName.Length != 0 ||
            OpenParams->FileName.MaximumLength != 0) {
            status = FxValidateUnicodeString(FxDriverGlobals,
                                             &OpenParams->FileName);
            if (!NT_SUCCESS(status)) {
                return status;
            }
        }
 
 
        break;
 
    case WdfIoTargetOpenReopen:
        break;
 
    default:
        status = STATUS_INVALID_PARAMETER;
        DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                            "OpenParams Type (%d) incorrect, %!STATUS!",
                            OpenParams->Type, status);
 
        return status;
    }
 
    return STATUS_SUCCESS;
}

◆ FxObjectHandleGetPtr() [1/3]

FxObjectHandleGetPtr	(	GetFxDriverGlobals(DriverGlobals)	,
		IoTarget	,
		FX_TYPE_IO_TARGET	,
		(PVOID *) &	pTarget
	)

Referenced by for(), FxIoTargetFormatIo(), and FxIoTargetFormatIoctl().

◆ FxObjectHandleGetPtr() [2/3]

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

◆ FxObjectHandleGetPtr() [3/3]

FxObjectHandleGetPtr	(	pGlobals	,
		Queue	,
		FX_TYPE_QUEUE	,
		(PVOID *)&	pFxIoQueue
	)

◆ FxObjectHandleGetPtrAndGlobals() [1/4]

FxObjectHandleGetPtrAndGlobals	(	GetFxDriverGlobals(DriverGlobals)	,
		Device	,
		FX_TYPE_DEVICE_BASE	,
		(PWDFOBJECT) &	pDevice,
		&	pFxDriverGlobals
	)

Referenced by __drv_strictTypeMatch(), FxIoTargetFormatIo(), FxIoTargetFormatIoctl(), FxIoTargetSendIo(), and FxIoTargetSendIoctl().

◆ FxObjectHandleGetPtrAndGlobals() [2/4]

FxObjectHandleGetPtrAndGlobals	(	GetFxDriverGlobals(DriverGlobals)	,
		IoTarget	,
		FX_TYPE_IO_TARGET	,
		(PVOID *) &	pTarget,
		&	pFxDriverGlobals
	)

◆ FxObjectHandleGetPtrAndGlobals() [3/4]

FxObjectHandleGetPtrAndGlobals	(	GetFxDriverGlobals(DriverGlobals)	,
		IoTarget	,
		FX_TYPE_IO_TARGET_REMOTE	,
		(PVOID *) &	pTarget,
		&	pFxDriverGlobals
	)

◆ FxObjectHandleGetPtrAndGlobals() [4/4]

FxObjectHandleGetPtrAndGlobals	(	GetFxDriverGlobals(DriverGlobals)	,
		IoTarget	,
		FX_TYPE_IO_TARGET_SELF	,
		(PVOID *) &	pTargetSelf,
		&	pGlobals
	)

◆ FxPointerNotNull() [1/2]

FxPointerNotNull	(	pFxDriverGlobals	,
		IoTarget
	)

◆ FxPointerNotNull() [2/2]

FxPointerNotNull	(	pFxDriverGlobals	,
		OpenParams
	)

◆ GetState()

return pTarget GetState ( )

Referenced by DECLARE_INTERFACE_().

◆ if() [1/9]

if ( ! NT_SUCCESSstatus )

Definition at line 419 of file fxiotargetapi.cpp.

                             {
        return status;
    }

◆ if() [2/9]

if ( NT_SUCCESS(status) )

Definition at line 435 of file fxiotargetapi.cpp.

                            {
        *IoTarget = pTarget->GetHandle();
    }

◆ if() [3/9]

if ( OpenParams->Size ! = sizeof(WDF_IO_TARGET_OPEN_PARAMS) && OpenParams->Size != sizeof(WDF_IO_TARGET_OPEN_PARAMS_V1_11) )

Definition at line 507 of file fxiotargetapi.cpp.

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

◆ if() [4/9]

if ( )

Definition at line 519 of file fxiotargetapi.cpp.

                                                              {
        RtlZeroMemory(&openParams, sizeof(WDF_IO_TARGET_OPEN_PARAMS));
 
        //
        // Copy over existing fields and readjust the struct size.
        //
        RtlCopyMemory(&openParams, OpenParams, OpenParams->Size);
        openParams.Size = sizeof(openParams);
 
        //
        // Use new open params structure from now on.
        //
        OpenParams = &openParams;
    }

◆ if() [5/9]

if ( OtherArg1 ! = NULL )

Definition at line 1654 of file fxiotargetapi.cpp.

                           {
        //
        // This transcribes the client union into a local structure which we
        // can change w/out altering the client's buffer.
        //
        status = args[i].ValidateMemoryDescriptor(pFxDriverGlobals, OtherArg1);
        if (!NT_SUCCESS(status)) {
            DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                                "invalid OtherArg1 buffer descriptor 0x%p, %!STATUS!",
                                OtherArg1, status);
            return status;
        }
    }

◆ if() [6/9]

if ( OtherArg2 ! = NULL )

Definition at line 1669 of file fxiotargetapi.cpp.

                           {
        //
        // This transcribes the client union into a local structure which we
        // can change w/out altering the client's buffer.
        //
        status = args[i].ValidateMemoryDescriptor(pFxDriverGlobals, OtherArg2);
        if (!NT_SUCCESS(status)) {
            DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                                "invalid OtherArg2 buffer descriptor 0x%p, %!STATUS!",
                                OtherArg2, status);
            return status;
        }
    }

◆ if() [7/9]

if ( OtherArg4 ! = NULL )

Definition at line 1684 of file fxiotargetapi.cpp.

                           {
        //
        // This transcribes the client union into a local structure which we
        // can change w/out altering the client's buffer.
        //
        status = args[i].ValidateMemoryDescriptor(pFxDriverGlobals, OtherArg4);
        if (!NT_SUCCESS(status)) {
            DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                                "invalid OtherArg4 buffer descriptor 0x%p, %!STATUS!",
                                OtherArg4, status);
            return status;
        }
    }

◆ if() [8/9]

if ( pDevice ! = pFxIoQueue->GetDevice() )

Definition at line 1933 of file fxiotargetapi.cpp.

                                            {
        status = STATUS_INVALID_DEVICE_REQUEST;
 
        DoTraceLevelMessage(
            pGlobals, TRACE_LEVEL_ERROR, TRACINGIO,
            "Input WDFQUEUE 0x%p belongs to WDFDEVICE 0x%p, but "
            "Self Io Target 0x%p corresponds to the WDFDEVICE 0x%p, %!STATUS!",
            Queue, pFxIoQueue->GetDevice()->GetHandle(), IoTarget,
            pDevice->GetHandle(), status);
 
        return status;
    }

◆ if() [9/9]

if ( pDevice-> IsLegacy() )

Definition at line 1946 of file fxiotargetapi.cpp.

                             {
        //
        // This is a controldevice. Make sure the create is called after the device
        // is initialized and ready to accept I/O.
        //
        MxDeviceObject deviceObject(pDevice->GetDeviceObject());
        if ((deviceObject.GetFlags() & DO_DEVICE_INITIALIZING) == 0x0) {
 
            status = STATUS_INVALID_DEVICE_STATE;
            DoTraceLevelMessage(
                pGlobals, TRACE_LEVEL_ERROR, TRACINGPNP,
                "Queue cannot be configured for automatic dispatching"
                " after WdfControlDeviceFinishInitializing"
                "is called on the WDFDEVICE %p is called %!STATUS!",
                pDevice->GetHandle(),
                status);
            return status;
        }
    }

◆ request()

FxSyncRequest request	(	pFxDriverGlobals	,
		&	context,
		Request
	)

◆ Start()

return pTarget Start ( )

Referenced by AcpiPsGetNextNamepath(), AcpiPsGetNextNamestring(), AcpiPsGetNextPackageEnd(), FxResourceCollection::AddAt(), BSTR_UserSize(), CcpDereferenceCache(), CcpMarkForExclusive(), CcpReferenceCache(), CcpReferenceCacheExclusive(), CLEANLOCALSTORAGE_UserSize(), ConioComputeUpdateRect(), ConvertConfigToVA(), FxCmResList::CreateWdmList(), FxIoResReqList::CreateWdmList(), DECLARE_INTERFACE_(), EnumNameServers(), Ext2AddBlockExtent(), Ext2BuildExtents(), Ext2ExpandBlock(), Ext2ExpandExtent(), Ext2ExpandFile(), Ext2ExpandIndirect(), Ext2GetBlock(), Ext2InitializeZone(), Ext2LookupBlockExtent(), Ext2LookupFile(), Ext2RemoveBlockExtent(), Ext2TruncateBlock(), Ext2ZeroData(), FatIsIoRangeValid(), FileAsyncReader_Request(), FindVerbInDefaultVerbList(), ForDir(), ForF(), ForLoop(), FsRtlTest_FillBuffer(), FsVolCommitOpsQueue(), FxUsbFindDescriptorType(), FxUsbValidateDescriptorType(), GetAdapterResources(), FxCmResList::GetResourceLength(), GuiPaintTextModeBuffer(), HTMLTxtRange_collapse(), InitRomRange(), IntDrawArc(), interface_variant_size(), IntExtTextOutW(), IntFillArc(), IntSetPaletteEntries(), IntValidateParents(), IopArbBusNumberPackResource(), IopArbBusNumberUnpackResource(), IopArbDmaPackResource(), IopArbDmaUnpackResource(), IopArbIrqPackResource(), IopArbIrqUnpackResource(), IopArbMemPackResource(), IopArbMemUnpackResource(), IopFindBusNumberResource(), IopFindMemoryResource(), IopFindPortResource(), IopPortMemPackResource(), IopPortMemUnpackResource(), Is1On(), Is24On(), KdbpGetNextBreakPointNr(), CKsInterfaceHandler::KsCompleteIo(), LdrpNameToOrdinal(), CDowloadingAppsListView::LoadList(), main(), Open(), otv_ClassDef_validate(), otv_Coverage_get_count(), otv_Coverage_validate(), PALOBJ_cGetColors(), PciBuildDefaultExclusionLists(), Protocol_Start(), ProtocolEmul_Continue(), ProtocolEmul_Start(), ReadVolumeLabel(), RtlAddRange(), RtlDeleteRange(), RtlFindRange(), RtlIsDosDeviceName_Ustr(), RtlIsRangeAvailable(), RtlpDphIsPageHeapBlock(), RtlSeekMemoryStream(), ScControl(), Set1(), CRichEdit::SetRangeFormatting(), SHELL32_EnumDefaultVerbList(), _MdTimer::StartWithReturn(), StringHashTableInit(), SubstituteVar(), test_binding(), test_BindToObject(), test_BindToStorage(), test_CreateBinding(), test_download(), test_ReportResult(), test_submit(), Test_SyscallPerformance(), test_URLDownloadToFile(), TestIsAvailable(), TestSharedFlag(), TestStartEqualsEnd(), UmaMgrInitialize(), USBPORT_SynchronizeControllersStart(), VARIANT_UserSize(), VGADDI_InitializeOffScreenMem(), and wire_extra_user_size().

Variable Documentation

◆ args

FxRequestBuffer args[FX_REQUEST_NUM_OTHER_PARAMS]

Definition at line 1606 of file fxiotargetapi.cpp.

◆ Argument1

InternalIoctlParams Argument1 = memoryHandles[i] = OtherArg1

Definition at line 1820 of file fxiotargetapi.cpp.

◆ Argument2

InternalIoctlParams Argument2 = memoryHandles[++i] = OtherArg2

Definition at line 1823 of file fxiotargetapi.cpp.

◆ Argument4

InternalIoctlParams Argument4 = memoryHandles[++i] = OtherArg4

Definition at line 1826 of file fxiotargetapi.cpp.

Referenced by BlTblFindEntry(), FileTableCompareWithSameAttributes(), and FileTableCompareWithSubsetAttributes().

◆ BytesRead

_Must_inspect_result_ __in WDFIOTARGET __in_opt WDFREQUEST __in_opt PWDF_MEMORY_DESCRIPTOR __in_opt PLONGLONG __in_opt PWDF_REQUEST_SEND_OPTIONS __out_opt PULONG_PTR BytesRead

Initial value:

{

DDI_ENTRY()

Definition at line 970 of file fxiotargetapi.cpp.

◆ BytesReturned

_Must_inspect_result_ __in WDFIOTARGET __in_opt WDFREQUEST __in ULONG __in_opt PWDF_MEMORY_DESCRIPTOR __in_opt PWDF_MEMORY_DESCRIPTOR __in_opt PWDF_MEMORY_DESCRIPTOR __in_opt PWDF_REQUEST_SEND_OPTIONS __out_opt PULONG_PTR BytesReturned

Initial value:

{

DDI_ENTRY()

Definition at line 1419 of file fxiotargetapi.cpp.

◆ BytesWritten

_Must_inspect_result_ __in WDFIOTARGET __in_opt WDFREQUEST __in_opt PWDF_MEMORY_DESCRIPTOR __in_opt PLONGLONG __in_opt PWDF_REQUEST_SEND_OPTIONS __out_opt PULONG_PTR BytesWritten

Initial value:

{

DDI_ENTRY()

Definition at line 1034 of file fxiotargetapi.cpp.

◆ context

FxInternalIoctlOthersContext context

Definition at line 1621 of file fxiotargetapi.cpp.

Referenced by FxIoTargetSendIo(), and FxIoTargetSendIoctl().

◆ Device

_Must_inspect_result_ __in WDFDEVICE Device

Definition at line 376 of file fxiotargetapi.cpp.

◆ device

return device = pTarget->GetDeviceHandle()

Definition at line 673 of file fxiotargetapi.cpp.

◆ DeviceOffset

_Must_inspect_result_ __in WDFIOTARGET __in WDFREQUEST __in_opt WDFMEMORY __in_opt PWDFMEMORY_OFFSET __in_opt PLONGLONG DeviceOffset

Initial value:

{

DDI_ENTRY()

Definition at line 966 of file fxiotargetapi.cpp.

◆ else

else

Initial value:

{
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIOTARGET,
                            "Could not format IOCTL 0x%x request, %!STATUS!",
                            Ioctl, status)

Definition at line 1717 of file fxiotargetapi.cpp.

◆ expectedConfigSize

expectedConfigSize

Initial value:

= pFxDriverGlobals->IsVersionGreaterThanOrEqualTo(1,13) ?
                            sizeof(WDF_IO_TARGET_OPEN_PARAMS) :
                            sizeof(WDF_IO_TARGET_OPEN_PARAMS_V1_11)