FxIrp Class Reference

#include <fxirp.hpp>

Inheritance diagram for FxIrp:

Public Member Functions
	FxIrp ()
	FxIrp (MdIrp irp)
MdIrp	SetIrp (MdIrp irp)
MdIrp	GetIrp (VOID)
VOID	CompleteRequest (__in_opt CCHAR PriorityBoost=IO_NO_INCREMENT)
NTSTATUS	CallDriver (__in MdDeviceObject DeviceObject)
NTSTATUS	PoCallDriver (__in MdDeviceObject DeviceObject)
VOID	StartNextPowerIrp ()
MdCompletionRoutine	GetNextCompletionRoutine (VOID)
VOID	SetCompletionRoutine (__in MdCompletionRoutine CompletionRoutine, __in PVOID Context, __in BOOLEAN InvokeOnSuccess=TRUE, __in BOOLEAN InvokeOnError=TRUE, __in BOOLEAN InvokeOnCancel=TRUE)
VOID	SetCompletionRoutineEx (__in MdDeviceObject DeviceObject, __in MdCompletionRoutine CompletionRoutine, __in PVOID Context, __in BOOLEAN InvokeOnSuccess=TRUE, __in BOOLEAN InvokeOnError=TRUE, __in BOOLEAN InvokeOnCancel=TRUE)
MdCancelRoutine	SetCancelRoutine (__in_opt MdCancelRoutine CancelRoutine)
CHECK_RETURN_IF_USER_MODE NTSTATUS	SendIrpSynchronously (__in MdDeviceObject DeviceObject)
VOID	CopyCurrentIrpStackLocationToNext (VOID)
VOID	CopyToNextIrpStackLocation (__in PIO_STACK_LOCATION Stack)
VOID	SetNextIrpStackLocation (VOID)
UCHAR	GetMajorFunction (VOID)
UCHAR	GetMinorFunction (VOID)
UCHAR	GetCurrentStackFlags (VOID)
MdFileObject	GetCurrentStackFileObject (VOID)
KPROCESSOR_MODE	GetRequestorMode (VOID)
VOID	SetContext (__in ULONG Index, __in PVOID Value)
VOID	SetSystemBuffer (__in PVOID Value)
VOID	SetUserBuffer (__in PVOID Value)
VOID	SetMdlAddress (__in PMDL Value)
VOID	SetFlags (__in ULONG Flags)
PVOID	GetContext (__in ULONG Index)
ULONG	GetFlags (VOID)
PIO_STACK_LOCATION	GetCurrentIrpStackLocation (VOID)
PIO_STACK_LOCATION	GetNextIrpStackLocation (VOID)
VOID	SkipCurrentIrpStackLocation (VOID)
VOID	MarkIrpPending ()
BOOLEAN	PendingReturned ()
VOID	PropagatePendingReturned (VOID)
VOID	SetStatus (__in NTSTATUS Status)
NTSTATUS	GetStatus ()
BOOLEAN	Cancel (VOID)
VOID	SetCancel (__in BOOLEAN Cancel)
BOOLEAN	IsCanceled ()
KIRQL	GetCancelIrql ()
VOID	SetInformation (__in ULONG_PTR Information)
ULONG_PTR	GetInformation ()
CCHAR	GetCurrentIrpStackLocationIndex ()
CCHAR	GetStackCount ()
PLIST_ENTRY	ListEntry ()
PVOID	GetSystemBuffer ()
PVOID	GetOutputBuffer ()
PMDL	GetMdl ()
PMDL *	GetMdlAddressPointer ()
PVOID	GetUserBuffer ()
VOID	Reuse (__in NTSTATUS Status=STATUS_SUCCESS)
VOID	SetMajorFunction (__in UCHAR MajorFunction)
VOID	SetMinorFunction (__in UCHAR MinorFunction)
SYSTEM_POWER_STATE_CONTEXT	GetParameterPowerSystemPowerStateContext ()
POWER_STATE_TYPE	GetParameterPowerType ()
POWER_STATE	GetParameterPowerState ()
DEVICE_POWER_STATE	GetParameterPowerStateDeviceState ()
SYSTEM_POWER_STATE	GetParameterPowerStateSystemState ()
POWER_ACTION	GetParameterPowerShutdownType ()
MdFileObject	GetFileObject (VOID)
DEVICE_RELATION_TYPE	GetParameterQDRType ()
VOID	SetParameterQDRType (__in DEVICE_RELATION_TYPE DeviceRelation)
PDEVICE_CAPABILITIES	GetParameterDeviceCapabilities ()
VOID	SetCurrentDeviceObject (__in MdDeviceObject DeviceObject)
MdDeviceObject	GetDeviceObject (VOID)
VOID	SetParameterDeviceCapabilities (__in PDEVICE_CAPABILITIES DeviceCapabilities)
LONGLONG	GetParameterWriteByteOffsetQuadPart ()
VOID	SetNextParameterWriteByteOffsetQuadPart (__in LONGLONG DeviceOffset)
ULONG	GetCurrentParameterWriteLength ()
VOID	SetNextParameterWriteLength (__in ULONG IoLength)
PVOID *	GetNextStackParameterOthersArgument1Pointer ()
VOID	SetNextStackParameterOthersArgument1 (__in PVOID Argument1)
PVOID *	GetNextStackParameterOthersArgument2Pointer ()
PVOID *	GetNextStackParameterOthersArgument4Pointer ()
PCM_RESOURCE_LIST	GetParameterAllocatedResources ()
VOID	SetParameterAllocatedResources (__in PCM_RESOURCE_LIST AllocatedResources)
PCM_RESOURCE_LIST	GetParameterAllocatedResourcesTranslated ()
VOID	SetParameterAllocatedResourcesTranslated (__in PCM_RESOURCE_LIST AllocatedResourcesTranslated)
LCID	GetParameterQueryDeviceTextLocaleId ()
DEVICE_TEXT_TYPE	GetParameterQueryDeviceTextType ()
BOOLEAN	GetParameterSetLockLock ()
BUS_QUERY_ID_TYPE	GetParameterQueryIdType ()
PINTERFACE	GetParameterQueryInterfaceInterface ()
const GUID *	GetParameterQueryInterfaceType ()
USHORT	GetParameterQueryInterfaceVersion ()
USHORT	GetParameterQueryInterfaceSize ()
PVOID	GetParameterQueryInterfaceInterfaceSpecificData ()
VOID	SetParameterQueryInterfaceInterface (__in PINTERFACE Interface)
VOID	SetParameterQueryInterfaceType (__in const GUID *InterfaceType)
VOID	SetParameterQueryInterfaceVersion (__in USHORT Version)
VOID	SetParameterQueryInterfaceSize (__in USHORT Size)
VOID	SetParameterQueryInterfaceInterfaceSpecificData (__in PVOID InterfaceSpecificData)
DEVICE_USAGE_NOTIFICATION_TYPE	GetParameterUsageNotificationType ()
BOOLEAN	GetParameterUsageNotificationInPath ()
VOID	SetParameterUsageNotificationInPath (__in BOOLEAN InPath)
BOOLEAN	GetNextStackParameterUsageNotificationInPath ()
ULONG	GetParameterIoctlCode (VOID)
ULONG	GetParameterIoctlCodeBufferMethod (VOID)
ULONG	GetParameterIoctlInputBufferLength (VOID)
ULONG	GetParameterIoctlOutputBufferLength (VOID)
PVOID	GetParameterIoctlType3InputBuffer (VOID)
VOID	SetParameterIoctlCode (__in ULONG DeviceIoControlCode)
VOID	SetParameterIoctlInputBufferLength (__in ULONG InputBufferLength)
VOID	SetParameterIoctlOutputBufferLength (__in ULONG OutputBufferLength)
VOID	SetParameterIoctlType3InputBuffer (__in PVOID Type3InputBuffer)
ULONG	GetParameterReadLength (VOID)
ULONG	GetParameterWriteLength (VOID)
VOID	SetNextStackFlags (__in UCHAR Flags)
VOID	SetNextStackFileObject (_In_ MdFileObject FileObject)
PVOID	GetCurrentParametersPointer (VOID)
VOID	ClearNextStack (VOID)
VOID	ClearNextStackLocation (VOID)
VOID	InitNextStackUsingStack (__in FxIrp *Irp)
ULONG	GetCurrentFlags (VOID)
VOID	FreeIrp (VOID)
MdEThread	GetThread (VOID)
BOOLEAN	Is32bitProcess (VOID)
PIO_STATUS_BLOCK	GetStatusBlock (VOID)
PVOID	GetDriverContext ()
ULONG	GetDriverContextSize ()
VOID	CopyParameters (_Out_ PWDF_REQUEST_PARAMETERS Parameters)
VOID	CopyStatus (_Out_ PIO_STATUS_BLOCK StatusBlock)
BOOLEAN	HasStack (_In_ UCHAR StackCount)
BOOLEAN	IsCurrentIrpStackLocationValid (VOID)
IWudfIoIrp *	GetIoIrp (VOID)
IWudfPnpIrp *	GetPnpIrp (VOID)

Static Public Member Functions
static PIO_STACK_LOCATION	_GetAndClearNextStackLocation (__in MdIrp Irp)
static _Must_inspect_result_ MdIrp	AllocateIrp (_In_ CCHAR StackSize, _In_opt_ FxDevice *Device=NULL)
static MdIrp	GetIrpFromListEntry (__in PLIST_ENTRY Ple)
static _Must_inspect_result_ NTSTATUS	RequestPowerIrp (__in MdDeviceObject DeviceObject, __in UCHAR MinorFunction, __in POWER_STATE PowerState, __in MdRequestPowerComplete CompletionFunction, __in PVOID Context)

Static Private Member Functions
static NTSTATUS STDCALL	_IrpSynchronousCompletion (__in MdDeviceObject DeviceObject, __in MdIrp OriginalIrp, __in PVOID Context)

Private Attributes
MdIrp	m_Irp

Friends
struct	FxAutoIrp

Detailed Description

Definition at line 28 of file fxirp.hpp.

Constructor & Destructor Documentation

FxIrp() [1/2]

FxIrp::FxIrp ( )

inline

Definition at line 37 of file fxirp.hpp.

{}

FxIrp() [2/2]

FxIrp::FxIrp ( MdIrp  irp )

inline

Definition at line 39 of file fxirp.hpp.

                     : m_Irp(irp)
    {
    }

Member Function Documentation

_GetAndClearNextStackLocation()

PIO_STACK_LOCATION __inline FxIrp::_GetAndClearNextStackLocation ( __in MdIrp  Irp )

static

Definition at line 371 of file fxirpkm.hpp.

{
    RtlZeroMemory(IoGetNextIrpStackLocation(Irp),
                  FIELD_OFFSET(IO_STACK_LOCATION, CompletionRoutine));
    return IoGetNextIrpStackLocation(Irp);
}

_IrpSynchronousCompletion()

__inline NTSTATUS STDCALL FxIrp::_IrpSynchronousCompletion ( __in MdDeviceObject  DeviceObject, __in MdIrp  OriginalIrp, __in PVOID  Context  )

staticprivate

Definition at line 133 of file fxirpum.cpp.

{
    HANDLE event = (HANDLE) Context;
 
    UNREFERENCED_PARAMETER(DeviceObject);
 
    SetEvent(event);
 
    return STATUS_MORE_PROCESSING_REQUIRED;
}

Referenced by SendIrpSynchronously().

AllocateIrp()

_Must_inspect_result_ __inline MdIrp FxIrp::AllocateIrp ( _In_ CCHAR  StackSize, _In_opt_ FxDevice *  Device = NULL  )

static

Definition at line 1089 of file fxirpum.cpp.

{
    IWudfIoIrp* ioIrp;
    HRESULT hr;
    NTSTATUS status;
 
    ioIrp = NULL;
 
    FX_VERIFY(INTERNAL, CHECK_NOT_NULL(Device));
 
    //
    // UMDF currently support allocating of I/O Irps only
    //
    hr = Device->GetDeviceStack()->AllocateIoIrp(Device->GetDeviceObject(),
                                                 StackSize,
                                                 &ioIrp);
 
    if (FAILED(hr)) {
        status = Device->NtStatusFromHr(hr);
        DoTraceLevelMessage(
            Device->GetDriverGlobals(), TRACE_LEVEL_ERROR, TRACINGIO,
            "WDFDEVICE 0x%p Failed to allocate I/O request %!STATUS!",
            Device->GetHandle(), status);
 
        FX_VERIFY_WITH_NAME(INTERNAL, CHECK_NULL(ioIrp),
            Device->GetDriverGlobals()->Public.DriverName);
    }
    else {
        FX_VERIFY_WITH_NAME(INTERNAL, CHECK_NOT_NULL(ioIrp),
            Device->GetDriverGlobals()->Public.DriverName);
    }
 
    return ioIrp;
}

Referenced by GetStackCapabilities(), FxUsbIdleInfo::Initialize(), FxPkgPnp::PnpDeviceUsageNotification(), PnpPassThroughQI(), FxPkgPnp::QueryForD3ColdInterface(), and FxRequestBase::ValidateTarget().

CallDriver()

__inline NTSTATUS FxIrp::CallDriver

(

__in MdDeviceObject

DeviceObject

)

Definition at line 36 of file fxirpum.cpp.

{
    UNREFERENCED_PARAMETER(DeviceObject);
 
    m_Irp->Forward();
    return STATUS_SUCCESS;
}

Referenced by FxDefaultIrpHandler::Dispatch(), FxPkgIo::DispatchStep1(), FxUsbPipeContinuousReader::FxUsbPipeRequestWorkItemHandler(), FxPkgGeneral::OnCleanup(), FxPkgGeneral::OnClose(), FxPkgGeneral::OnShutdown(), and FxPkgFdo::PnpSendStartDeviceDownTheStackOverload().

Cancel()

__inline BOOLEAN FxIrp::Cancel

(

VOID

)

Definition at line 475 of file fxirpum.cpp.

{
    return (m_Irp->Cancel() ? TRUE: FALSE);
}

Referenced by FxRequestBase::Cancel(), FxPkgPnp::PowerPolicyCancelUsbSS(), FxPkgPnp::PowerPolicyCancelWaitWake(), and SetCancel().

ClearNextStack()

__inline VOID FxIrp::ClearNextStack

(

VOID

)

Definition at line 1183 of file fxirpum.cpp.

{
    m_Irp->ClearNextStackLocation();
}

Referenced by GetStackCapabilities(), and FxPkgPnp::QueryForD3ColdInterface().

ClearNextStackLocation()

__inline VOID FxIrp::ClearNextStackLocation

(

VOID

)

Definition at line 1581 of file fxirpum.cpp.

{
    m_Irp->ClearNextStackLocation();
}

Referenced by FxIoTarget::FormatInternalIoctlOthersRequest(), FxIoTarget::FormatIoctlRequest(), FxIoTarget::FormatIoRequest(), and FxFormatUsbRequest().

CompleteRequest()

__inline VOID FxIrp::CompleteRequest

(

__in_opt CCHAR

PriorityBoost = IO_NO_INCREMENT

)

Definition at line 24 of file fxirpum.cpp.

{
    UNREFERENCED_PARAMETER(PriorityBoost);
 
    m_Irp->CompleteRequest();
    m_Irp = NULL;
}

Referenced by FxIoQueue::CancelIrps(), FxRequest::CompleteInternal(), FxDefaultIrpHandler::Dispatch(), FxPkgGeneral::Dispatch(), FxDevice::DispatchPreprocessedIrp(), FxPkgIo::DispatchStep1(), FxPkgIo::DispatchStep2(), FxDevice::DispatchWithLock(), FxPkgGeneral::OnCleanup(), FxPkgGeneral::OnClose(), FxPkgGeneral::OnCreate(), FxPkgGeneral::OnShutdown(), FxRequest::Release(), and FxIoTargetSelf::Send().

CopyCurrentIrpStackLocationToNext()

__inline VOID FxIrp::CopyCurrentIrpStackLocationToNext

(

VOID

)

Definition at line 209 of file fxirpum.cpp.

{
    m_Irp->CopyCurrentIrpStackLocationToNext();
}

Referenced by FxDevice::_AcquireOptinRemoveLock(), FxRequest::CopyCurrentIrpStackLocationToNext(), FxIoQueue::ForwardRequestToParent(), FxPkgFdo::PnpSendStartDeviceDownTheStackOverload(), and FxIoQueue::QueueDriverCreatedRequest().

CopyParameters()

__inline VOID FxIrp::CopyParameters

(

_Out_ PWDF_REQUEST_PARAMETERS

Parameters

)

Definition at line 1691 of file fxirpum.cpp.

{
    IWudfIoIrp* ioIrp;
    UCHAR majorFunction;
 
    ioIrp = GetIoIrp();
    majorFunction = GetMajorFunction();
 
    switch (majorFunction) {
    case IRP_MJ_CREATE:
        ioIrp->GetCreateParameters(
                                   &Parameters->Parameters.Create.Options,
                                   &Parameters->Parameters.Create.FileAttributes,
                                   &Parameters->Parameters.Create.ShareAccess,
                                   NULL // ACCESS_MASK*
                                   );
        break;
    case IRP_MJ_READ:
        ioIrp->GetReadParameters((ULONG*)&Parameters->Parameters.Read.Length,
                                 &Parameters->Parameters.Read.DeviceOffset,
                                 &Parameters->Parameters.Read.Key);
        break;
    case IRP_MJ_WRITE:
        ioIrp->GetWriteParameters((ULONG*)&Parameters->Parameters.Write.Length,
                                 &Parameters->Parameters.Write.DeviceOffset,
                                 &Parameters->Parameters.Write.Key);
        break;
    case IRP_MJ_DEVICE_CONTROL:
        ioIrp->GetDeviceIoControlParameters(
             &Parameters->Parameters.DeviceIoControl.IoControlCode,
             (ULONG*)&Parameters->Parameters.DeviceIoControl.InputBufferLength,
             (ULONG*)&Parameters->Parameters.DeviceIoControl.OutputBufferLength
             );
        break;
    default:
        FX_VERIFY(INTERNAL, TRAPMSG("Not expected"));
        break;
    }
 
    return;
}

Referenced by FxRequest::GetParameters().

CopyStatus()

__inline VOID FxIrp::CopyStatus

(

_Out_ PIO_STATUS_BLOCK

StatusBlock

)

Definition at line 1736 of file fxirpum.cpp.

{
    StatusBlock->Status = GetStatus();
    StatusBlock->Information = GetInformation();
}

Referenced by FxRequestBase::CompleteSubmitted(), and FxRequestBase::CompleteSubmittedNoContext().

CopyToNextIrpStackLocation()

__inline VOID FxIrp::CopyToNextIrpStackLocation

(

__in PIO_STACK_LOCATION

Stack

)

Definition at line 1216 of file fxirpum.cpp.

{
    UNREFERENCED_PARAMETER(Stack);
 
 
 
 
 
 
 
 
 
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
 
}

FreeIrp()

__inline VOID FxIrp::FreeIrp

(

VOID

)

Definition at line 1648 of file fxirpum.cpp.

{
    //
    // Release the um com irp creation ref
    //
    m_Irp->Release();
 
    //
    // This is equivalent to IoFreeIrp in km.
    //
    GetIoIrp()->Deallocate();
}

Referenced by FxRequest::Reuse(), FxRequestBase::SetSubmitIrp(), FxRequestBase::ValidateTarget(), and FxRequestBase::~FxRequestBase().

GetCancelIrql()

__inline KIRQL FxIrp::GetCancelIrql

(

)

Definition at line 492 of file fxirpum.cpp.

{
    //
    // CancelIrql is used to pass in to IoReleaseCancelSpinLock
    // hence it is not applicable to UMDF.
    //
    return PASSIVE_LEVEL;
}

GetContext()

__inline PVOID FxIrp::GetContext

(

__in ULONG

Index

)

Definition at line 361 of file fxirpum.cpp.

{
    return m_Irp->GetContext(Index);
}

Referenced by FxPkgPdo::_QueryCapsWorkItem(), FxIrpQueue::IsIrpInQueue(), FxIrpQueue::PeekRequest(), FxIrpQueue::RemoveIrpFromQueueByContext(), and FxIrpQueue::RemoveNextIrpFromQueue().

GetCurrentFlags()

__inline ULONG FxIrp::GetCurrentFlags

(

VOID

)

Definition at line 1613 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
    return 0;
}

GetCurrentIrpStackLocation()

__inline PIO_STACK_LOCATION FxIrp::GetCurrentIrpStackLocation

(

VOID

)

Definition at line 370 of file fxirpum.cpp.

{
 
 
 
 
    // The Km implementation does some verifier checks in this function so
    // mode agnostic code uses it and therefore we provide the um version as a
    // stub. The return value is NULL and is not used by the caller.
    //
    return NULL;
}

Referenced by FxIoQueue::DispatchRequestToDriver(), and FxRequest::GetCurrentIrpStackLocation().

GetCurrentIrpStackLocationIndex()

__inline CCHAR FxIrp::GetCurrentIrpStackLocationIndex

(

)

Definition at line 521 of file fxirpum.cpp.

{
 
 
 
 
    FX_VERIFY(INTERNAL, TRAPMSG("Not implemented"));
 
    return -1;
}

Referenced by if(), and VerifyWdfRequestForwardToParentDeviceIoQueue().

GetCurrentParametersPointer()

__inline PVOID FxIrp::GetCurrentParametersPointer

(

VOID

)

Definition at line 1622 of file fxirpum.cpp.

{
   FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
   return NULL;
}

GetCurrentParameterWriteLength()

ULONG FxIrp::GetCurrentParameterWriteLength

(

)

GetCurrentStackFileObject()

__inline MdFileObject FxIrp::GetCurrentStackFileObject

(

VOID

)

Definition at line 1258 of file fxirpum.cpp.

{
    return GetIoIrp()->GetFile();
}

Referenced by FxIoTarget::CopyFileObjectAndFlags().

GetCurrentStackFlags()

__inline UCHAR FxIrp::GetCurrentStackFlags

(

VOID

)

Definition at line 1243 of file fxirpum.cpp.

{
 
 
 
 
 
 
 
    return 0;
}

Referenced by FxIoTarget::CopyFileObjectAndFlags().

GetDeviceObject()

__inline MdDeviceObject FxIrp::GetDeviceObject

(

VOID

)

Definition at line 1352 of file fxirpum.cpp.

{
 
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
    return NULL;
}

Referenced by FxIoQueue::ForwardRequestToParent(), FxRequestSystemBuffer::GetBuffer(), and FxRequestSystemBuffer::GetMdl().

GetDriverContext()

__inline PVOID FxIrp::GetDriverContext

(

)

Definition at line 1673 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
    return NULL;
}

GetDriverContextSize()

__inline ULONG FxIrp::GetDriverContextSize

(

)

Definition at line 1682 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
    return 0;
}

GetFileObject()

__inline MdFileObject FxIrp::GetFileObject

(

VOID

)

Definition at line 1460 of file fxirpum.cpp.

{
    IWudfIoIrp * pIoIrp = NULL;
 
    HRESULT hrQI = m_Irp->QueryInterface(IID_IWudfIoIrp, (PVOID*)&pIoIrp);
    FX_VERIFY(INTERNAL, CHECK_QI(hrQI, pIoIrp));
    pIoIrp->Release();
 
    return pIoIrp->GetFile();
}

Referenced by FxRequest::GetFileObject(), FxPkgGeneral::OnCleanup(), FxPkgGeneral::OnClose(), FxPkgGeneral::OnCreate(), FxIrpQueue::PeekNextIrpFromQueue(), and FxIrpQueue::PeekRequest().

GetFlags()

__inline ULONG FxIrp::GetFlags

(

VOID

)

Definition at line 1281 of file fxirpum.cpp.

{
 
 
 
 
 
    return 0;
}

Referenced by FxRequest::CompleteInternal().

GetInformation()

__inline ULONG_PTR FxIrp::GetInformation

(

)

Definition at line 513 of file fxirpum.cpp.

{
    return m_Irp->GetInformation();
}

Referenced by FxRequest::Complete(), FxRequest::CompleteInternal(), FxRequest::CompleteWithPriority(), FxIoContext::CopyParameters(), CopyStatus(), FxRequest::GetInformation(), FxIoTargetRemote::GetTargetDeviceRelations(), and PnpPassThroughQI().

GetIoIrp()

IWudfIoIrp * FxIrp::GetIoIrp

(

VOID

)

Definition at line 1777 of file fxirpum.cpp.

{
    IWudfIoIrp* pIoIrp;
    HRESULT hrQI;
 
    hrQI = m_Irp->QueryInterface(IID_IWudfIoIrp, (PVOID*)&pIoIrp);
    FX_VERIFY(INTERNAL, CHECK_QI(hrQI, pIoIrp));
    pIoIrp->Release();
 
    //
    // Now that we confirmed the irp is an io irp, just return the underlying
    // irp.
    //
    return static_cast<IWudfIoIrp*>(m_Irp);
}

Referenced by CopyParameters(), FreeIrp(), GetCurrentStackFileObject(), GetOutputBuffer(), GetParameterIoctlCode(), GetParameterIoctlInputBufferLength(), GetParameterIoctlOutputBufferLength(), GetParameterReadLength(), GetParameterWriteLength(), GetSystemBuffer(), GetUserBuffer(), Is32bitProcess(), Reuse(), FxRequest::SetImpersonationFlags(), SetNextStackFileObject(), and FxIoContext::SwapIrpBuffer().

GetIrp()

__inline MdIrp FxIrp::GetIrp

(

VOID

)

Definition at line 15 of file fxirpum.cpp.

{
    return m_Irp;
}

Referenced by FxPkgFdo::_PnpPassDown(), FxPkgFdo::_PowerPassDown(), FxPkgGeneral::AcquireRemoveLockForClose(), FxRequestBase::Cancel(), FxRequest::Complete(), FxRequest::CompleteInternal(), FxPkgPnp::CompletePnpRequest(), FxPkgPnp::CompletePowerRequest(), FxRequest::CompleteWithPriority(), FxRequestBase::ContextReleaseAndRestore(), FxPkgPnp::Dispatch(), FxPkgIo::DispatchStep1(), FxRequestBase::Dispose(), FxRequestBase::FreeMdls(), FxRequestBase::FxRequestBase(), FxRequest::GetIrp(), GetStackCapabilities(), FxRequestBase::GetSubmitIrp(), if(), FxRequest::InsertHeadIrpQueue(), FxRequest::InsertTailIrpQueue(), FxPkgPnp::IsDevicePowerUpIrpPending(), FxIrpQueue::IsIrpInQueue(), FxPkgGeneral::OnClose(), FxPkgGeneral::OnCreate(), FxIrpQueue::PeekNextIrpFromQueue(), FxIoTarget::PendRequestLocked(), FxRequest::ProbeAndLockForRead(), FxRequest::ProbeAndLockForWrite(), FxPkgPnp::QueryForD3ColdInterface(), FxRequest::Release(), FxIrpQueue::RemoveNextIrpFromQueue(), FxRequest::Reuse(), FxRequest::SetCompletionState(), FxPkgPnp::SetPendingPnpIrp(), FxIoTarget::SubmitPendedRequest(), VerifyWdfRequestForwardToParentDeviceIoQueue(), and FxRequestBase::~FxRequestBase().

GetIrpFromListEntry()

__inline MdIrp FxIrp::GetIrpFromListEntry ( __in PLIST_ENTRY  Ple )

static

Definition at line 1190 of file fxirpum.cpp.

{
    return g_IWudfHost2->GetIrpFromListEntry(ListEntry);
}

Referenced by FxIoQueue::CancelIrps(), FxIrpQueue::IsIrpInQueue(), FxIrpQueue::PeekNextIrpFromQueue(), FxIrpQueue::PeekRequest(), and FxPkgPnp::PowerCompletePendedWakeIrp().

GetMajorFunction()

__inline UCHAR FxIrp::GetMajorFunction

(

VOID

)

Definition at line 217 of file fxirpum.cpp.

{
    UCHAR majorFunction = IRP_MJ_MAXIMUM_FUNCTION;
    IWudfIoIrp * pIoIrp = NULL;
    IWudfPnpIrp * pPnpIrp = NULL;
 
    //
    // IWudfIrp does not expose a method to get major function code. So we
    // find out if it's an I/O irp or pnp irp. If I/O irp then we use GetType
    // method to retrieve request tyoe and then map it to major function code,
    // otherwise if it is pnp irp then we just use GetMajorFunction method
    // exposed by IWudfPnpIrp.
    //
    HRESULT hrQI = m_Irp->QueryInterface(IID_IWudfIoIrp, (PVOID*)&pIoIrp);
    if (SUCCEEDED(hrQI)) {
        UMINT::WDF_REQUEST_TYPE type;
 
        //
        // for Io irp, map request type to major funcction
        //
        type = (UMINT::WDF_REQUEST_TYPE) pIoIrp->GetType();
        switch(type) {
        case  UMINT::WdfRequestCreate:
            majorFunction = IRP_MJ_CREATE;
            break;
        case  UMINT::WdfRequestCleanup:
            majorFunction = IRP_MJ_CLEANUP;
            break;
        case  UMINT::WdfRequestRead:
            majorFunction = IRP_MJ_READ;
            break;
        case  UMINT::WdfRequestWrite:
            majorFunction = IRP_MJ_WRITE;
            break;
        case  UMINT::WdfRequestDeviceIoControl:
            majorFunction = IRP_MJ_DEVICE_CONTROL;
            break;
        case  UMINT::WdfRequestClose:
            majorFunction = IRP_MJ_CLOSE;
            break;
        case  UMINT::WdfRequestInternalIoctl:
            majorFunction = IRP_MJ_INTERNAL_DEVICE_CONTROL;
            break;
        case UMINT::WdfRequestFlushBuffers:
            majorFunction = IRP_MJ_FLUSH_BUFFERS;
            break;
        case UMINT::WdfRequestQueryInformation:
            majorFunction = IRP_MJ_QUERY_INFORMATION;
            break;
        case UMINT::WdfRequestSetInformation:
            majorFunction = IRP_MJ_SET_INFORMATION;
            break;
        case  UMINT::WdfRequestUsb:
        case  UMINT::WdfRequestOther:
            // fall through
        default:
            FX_VERIFY(INTERNAL, TRAPMSG("The request type is not expected"));
        }
 
        pIoIrp->Release();
    }
    else {
        FX_VERIFY(INTERNAL, CHECK_NULL(pIoIrp));
 
        //
        // see if it is a pnp irp
        //
        hrQI = m_Irp->QueryInterface(IID_IWudfPnpIrp, (PVOID*)&pPnpIrp);
        FX_VERIFY(INTERNAL, CHECK_QI(hrQI, pPnpIrp));
 
        majorFunction = pPnpIrp->GetMajorFunction();
        pPnpIrp->Release();
    }
 
    return majorFunction;
}

Referenced by FxRequest::AssignMemoryBuffers(), FxRequest::CompleteInternal(), CopyParameters(), FxDefaultIrpHandler::Dispatch(), FxPkgPnp::Dispatch(), FxPkgGeneral::Dispatch(), FxPkgIo::Dispatch(), FxDevice::DispatchPreprocessedIrp(), FxIoQueue::DispatchRequestToDriver(), FxPkgIo::DispatchStep1(), FxPkgIo::DispatchStep2(), FxDevice::DispatchWithLock(), DispatchWorker(), FxRequestSystemBuffer::GetBuffer(), FxRequestOutputBuffer::GetBuffer(), FxRequestSystemBuffer::GetBufferSize(), FxRequestOutputBuffer::GetBufferSize(), FxRequest::GetDeviceControlOutputMdl(), FxRequest::GetDeviceControlOutputMemoryObject(), FxRequestSystemBuffer::GetFlags(), FxRequestOutputBuffer::GetFlags(), FxRequest::GetMdl(), FxRequestSystemBuffer::GetMdl(), FxRequestOutputBuffer::GetMdl(), FxRequest::GetMemoryObject(), GetOutputBuffer(), GetParameterIoctlCode(), FxRequest::GetParameters(), FxIoQueue::GetRequest(), GetSystemBuffer(), IsPreprocessIrp(), PerfIoComplete(), PerfIoStart(), PreprocessIrp(), FxIoTargetSelf::Send(), and VerifyWdfDeviceWdmDispatchIrpToIoQueue().

GetMdl()

__inline PMDL FxIrp::GetMdl

(

)

Definition at line 625 of file fxirpum.cpp.

{
    return NULL;
}

Referenced by FxRequest::GetDeviceControlOutputMdl(), FxRequest::GetDeviceControlOutputMemoryObject(), FxRequest::GetMdl(), and FxRequest::GetMemoryObject().

GetMdlAddressPointer()

__inline PMDL * FxIrp::GetMdlAddressPointer

(

)

Definition at line 1323 of file fxirpum.cpp.

{
    return NULL;
}

Referenced by FxIoTarget::FormatIoctlRequest(), and FxIoTarget::FormatIoRequest().

GetMinorFunction()

__inline UCHAR FxIrp::GetMinorFunction

(

VOID

)

Definition at line 297 of file fxirpum.cpp.

{
    UCHAR minorFunction;
    IWudfPnpIrp * pPnpIrp = NULL;
    IWudfIoIrp * pIoIrp = NULL;
 
    HRESULT hrQI = m_Irp->QueryInterface(IID_IWudfPnpIrp, (PVOID*)&pPnpIrp);
    if (SUCCEEDED(hrQI)) {
        minorFunction = pPnpIrp->GetMinorFunction();
        pPnpIrp->Release();
    }
    else {
        //
        // If this is not PnP irp then this must be Io irp.
        //
        hrQI = m_Irp->QueryInterface(IID_IWudfIoIrp, (PVOID*)&pIoIrp);
        FX_VERIFY(INTERNAL, CHECK_QI(hrQI, pIoIrp));
        pIoIrp->Release();
 
        //
        // Minor function is 0 for I/O irps (create/cleanup/close/read/write/
        // ioctl).
        //
        minorFunction = 0;
    }
 
    return minorFunction;
}

Referenced by FxDefaultIrpHandler::Dispatch(), FxPkgPnp::Dispatch(), FxPkgIo::Dispatch(), FxDevice::DispatchPreprocessedIrp(), FxPkgIo::DispatchStep1(), FxDevice::DispatchWithLock(), FxRequest::GetParameters(), IsPreprocessIrp(), FxPkgPnp::PnpFinishProcessingIrp(), PreprocessIrp(), FxIoTargetSelf::Send(), FxPkgPnp::SetPendingPnpIrp(), and VerifyWdfDeviceWdmDispatchIrpToIoQueue().

GetNextCompletionRoutine()

__inline MdCompletionRoutine FxIrp::GetNextCompletionRoutine

(

VOID

)

Definition at line 1206 of file fxirpum.cpp.

{
 
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
    return NULL;
}

Referenced by FxIoQueue::QueueDriverCreatedRequest().

GetNextIrpStackLocation()

__inline PIO_STACK_LOCATION FxIrp::GetNextIrpStackLocation

(

VOID

)

Definition at line 387 of file fxirpum.cpp.

{
 
 
 
 
    FX_VERIFY(INTERNAL, TRAPMSG("Common code using io stack location directly"));
    return NULL;
}

Referenced by FxFormatUsbRequest(), FxIoTargetRemote::GetTargetDeviceRelations(), SetParameterQDRType(), SetParameterQueryInterfaceInterface(), SetParameterQueryInterfaceInterfaceSpecificData(), SetParameterQueryInterfaceSize(), SetParameterQueryInterfaceType(), and SetParameterQueryInterfaceVersion().

GetNextStackParameterOthersArgument1Pointer()

__inline PVOID * FxIrp::GetNextStackParameterOthersArgument1Pointer

(

)

Definition at line 1421 of file fxirpum.cpp.

{
 
 
 
 
 
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
    return NULL;
}

Referenced by FxIoTarget::FormatInternalIoctlOthersRequest().

GetNextStackParameterOthersArgument2Pointer()

__inline PVOID * FxIrp::GetNextStackParameterOthersArgument2Pointer

(

)

Definition at line 1434 of file fxirpum.cpp.

{
 
 
 
 
 
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
    return NULL;
}

Referenced by FxIoTarget::FormatInternalIoctlOthersRequest().

GetNextStackParameterOthersArgument4Pointer()

__inline PVOID * FxIrp::GetNextStackParameterOthersArgument4Pointer

(

)

Definition at line 1447 of file fxirpum.cpp.

{
 
 
 
 
 
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
    return NULL;
}

Referenced by FxIoTarget::FormatInternalIoctlOthersRequest().

GetNextStackParameterUsageNotificationInPath()

__inline BOOLEAN FxIrp::GetNextStackParameterUsageNotificationInPath

(

)

Definition at line 830 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
 
    return FALSE;
}

GetOutputBuffer()

__inline PVOID FxIrp::GetOutputBuffer

(

)

Definition at line 594 of file fxirpum.cpp.

{
    IWudfIoIrp * ioIrp = NULL;
    PVOID outputBuffer = NULL;
    HRESULT hr;
 
    ioIrp = GetIoIrp();
 
    switch (GetMajorFunction()) {
    case IRP_MJ_DEVICE_CONTROL:
        hr = ioIrp->RetrieveBuffers(NULL,         // InputBufferCb
                                    NULL,         // InputBuffer
                                    NULL,         // OutputBufferCb
                                    &outputBuffer // OutputBuffer
                                    );
        break;
    default:
        FX_VERIFY(INTERNAL, TRAPMSG("Not implemented"));
        hr = E_NOTIMPL;
        break;
    }
 
    if (FAILED(hr)) {
        outputBuffer = NULL;
    }
 
    return outputBuffer;
}

Referenced by FxRequest::AssignMemoryBuffers().

GetParameterAllocatedResources()

__inline PCM_RESOURCE_LIST FxIrp::GetParameterAllocatedResources

(

)

Definition at line 843 of file fxirpum.cpp.

{
    IWudfPnpIrp * pnpIrp = NULL;
    PCM_RESOURCE_LIST res = NULL;
 
 
 
 
 
 
    pnpIrp = static_cast<IWudfPnpIrp *>(m_Irp);
 
    res = pnpIrp->GetParameterAllocatedResources();
 
    //
    // Release the ref even though we are returning a memory pointer from
    // IWudfIrp object. This is fine because we know irp is valid for the
    // lifetime of the caller who is calling this interface).
    //
 
 
    return res;
}

Referenced by FxPkgPnp::PnpMatchResources(), and FxPkgFdo::PnpSendStartDeviceDownTheStackOverload().

GetParameterAllocatedResourcesTranslated()

__inline PCM_RESOURCE_LIST FxIrp::GetParameterAllocatedResourcesTranslated

(

)

Definition at line 877 of file fxirpum.cpp.

{
    IWudfPnpIrp * pnpIrp = NULL;
    PCM_RESOURCE_LIST res = NULL;
 
 
 
 
 
 
    pnpIrp = static_cast<IWudfPnpIrp *>(m_Irp);
 
    res = pnpIrp->GetParameterAllocatedResourcesTranslated();
 
 
    return res;
}

Referenced by FxPkgPnp::PnpMatchResources(), and FxPkgFdo::PnpSendStartDeviceDownTheStackOverload().

GetParameterDeviceCapabilities()

__inline PDEVICE_CAPABILITIES FxIrp::GetParameterDeviceCapabilities

(

)

Definition at line 1132 of file fxirpum.cpp.

{
    IWudfPnpIrp * pQueryCapsIrp = GetPnpIrp();
    PDEVICE_CAPABILITIES deviceCapabilities;
 
    deviceCapabilities = pQueryCapsIrp->GetDeviceCapabilities();
 
    return deviceCapabilities;
}

Referenced by FxPkgPdo::_QueryCapsWorkItem().

GetParameterIoctlCode()

__inline ULONG FxIrp::GetParameterIoctlCode

(

VOID

)

Definition at line 1474 of file fxirpum.cpp.

{
    IWudfIoIrp * ioIrp = NULL;
    ULONG ioControlCode = 0;
 
    if (GetMajorFunction() == IRP_MJ_DEVICE_CONTROL) {
        ioIrp = GetIoIrp();
        ioIrp->GetDeviceIoControlParameters(&ioControlCode, NULL, NULL);
    }
 
    return ioControlCode;
}

Referenced by FxIoQueue::DispatchRequestToDriver(), FxPkgIo::DispatchStep1(), FxRequest::GetDeviceControlOutputMdl(), FxRequest::GetDeviceControlOutputMemoryObject(), FxRequest::GetMdl(), and FxRequest::GetMemoryObject().

GetParameterIoctlCodeBufferMethod()

__inline ULONG FxIrp::GetParameterIoctlCodeBufferMethod

(

VOID

)

Definition at line 1490 of file fxirpum.cpp.

{
    //
    // For UMDF, always return METHOD_BUFFERED. This is because merged code
    // uses this info to decide how and where to fetch the buffers from, from
    // inside the irp, and for UMDF, the buffers are always fetched from host in
    // same manner irrespective of IOCTL type.
    //
    return METHOD_BUFFERED;
}

Referenced by FxRequest::AssignMemoryBuffers(), FxRequest::CompleteInternal(), FxRequestOutputBuffer::GetBuffer(), FxRequest::GetDeviceControlOutputMdl(), FxRequest::GetDeviceControlOutputMemoryObject(), FxRequestSystemBuffer::GetFlags(), FxRequestOutputBuffer::GetFlags(), FxRequest::GetMdl(), FxRequestOutputBuffer::GetMdl(), FxRequest::GetMemoryObject(), and FxRequest::GetParameters().

GetParameterIoctlInputBufferLength()

__inline ULONG FxIrp::GetParameterIoctlInputBufferLength

(

VOID

)

Definition at line 1518 of file fxirpum.cpp.

{
    IWudfIoIrp * ioIrp = NULL;
    ULONG inputBufferLength;
 
    ioIrp = GetIoIrp();
    ioIrp->GetDeviceIoControlParameters(NULL, &inputBufferLength, NULL);
 
    return inputBufferLength;
}

Referenced by FxIoQueue::DispatchRequestToDriver(), FxRequestSystemBuffer::GetBufferSize(), FxRequest::GetMdl(), and FxRequest::GetMemoryObject().

GetParameterIoctlOutputBufferLength()

__inline ULONG FxIrp::GetParameterIoctlOutputBufferLength

(

VOID

)

Definition at line 1504 of file fxirpum.cpp.

{
    IWudfIoIrp * ioIrp = NULL;
    ULONG outputBufferLength;
 
    ioIrp = GetIoIrp();
    ioIrp->GetDeviceIoControlParameters(NULL, NULL, &outputBufferLength);
 
    return outputBufferLength;
}

Referenced by FxRequest::CompleteInternal(), FxIoQueue::DispatchRequestToDriver(), FxRequestOutputBuffer::GetBufferSize(), FxRequest::GetDeviceControlOutputMdl(), and FxRequest::GetDeviceControlOutputMemoryObject().

GetParameterIoctlType3InputBuffer()

__inline PVOID FxIrp::GetParameterIoctlType3InputBuffer

(

VOID

)

Definition at line 1542 of file fxirpum.cpp.

{
 
 
 
 
 
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
    return NULL;
}

Referenced by FxRequest::AssignMemoryBuffers().

GetParameterPowerShutdownType()

__inline POWER_ACTION FxIrp::GetParameterPowerShutdownType

(

)

Definition at line 719 of file fxirpum.cpp.

{
    POWER_ACTION powerAction;
 
    powerAction = GetPnpIrp()->GetPowerAction();
 
    return powerAction;
}

Referenced by FxPkgPnp::PowerGotoDxIoStopped(), and FxPkgPnp::PowerGotoDxIoStoppedNP().

GetParameterPowerState()

__inline POWER_STATE FxIrp::GetParameterPowerState

(

)

Definition at line 1015 of file fxirpum.cpp.

{
    IWudfPnpIrp * pnpIrp = NULL;
    POWER_STATE powerState;
 
 
 
 
 
 
    pnpIrp = static_cast<IWudfPnpIrp *>(m_Irp);
 
    powerState = pnpIrp->GetPowerState();
 
 
    return powerState;
}

GetParameterPowerStateDeviceState()

__inline DEVICE_POWER_STATE FxIrp::GetParameterPowerStateDeviceState

(

)

Definition at line 695 of file fxirpum.cpp.

{
    DEVICE_POWER_STATE devicePowerState;
 
    devicePowerState = GetPnpIrp()->GetPowerStateDeviceState();
 
    return devicePowerState;
}

Referenced by FxPkgPnp::Dispatch(), FxPkgPnp::IsDevicePowerUpIrpPending(), FxPkgPnp::PowerGotoDxIoStopped(), FxPkgPnp::PowerGotoDxIoStoppedNP(), and FxPkgFdo::PowerReleasePendingDeviceIrp().

GetParameterPowerStateSystemState()

__inline SYSTEM_POWER_STATE FxIrp::GetParameterPowerStateSystemState

(

)

Definition at line 707 of file fxirpum.cpp.

{
    SYSTEM_POWER_STATE systemPowerState;
 
    systemPowerState = GetPnpIrp()->GetPowerStateSystemState();
 
    return systemPowerState;
}

Referenced by FxPkgPnp::Dispatch(), and FxPkgPnp::PowerPolicyCompleteSystemPowerIrp().

GetParameterPowerSystemPowerStateContext()

__inline SYSTEM_POWER_STATE_CONTEXT FxIrp::GetParameterPowerSystemPowerStateContext

(

)

Definition at line 671 of file fxirpum.cpp.

{
    SYSTEM_POWER_STATE_CONTEXT systemPwrStateContext = {0};
 
    systemPwrStateContext.ContextAsUlong = GetPnpIrp()->GetSystemPowerStateContext();
 
    return systemPwrStateContext;
}

Referenced by FxPkgPnp::PowerPolicyGetPendingSystemState().

GetParameterPowerType()

__inline POWER_STATE_TYPE FxIrp::GetParameterPowerType

(

)

Definition at line 683 of file fxirpum.cpp.

{
    POWER_STATE_TYPE powerType;
 
    powerType = GetPnpIrp()->GetPowerType();
 
    return powerType;
}

Referenced by FxPkgPnp::Dispatch().

GetParameterQDRType()

__inline DEVICE_RELATION_TYPE FxIrp::GetParameterQDRType

(

)

Definition at line 731 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
 
    return BusRelations;
}

Referenced by FxPkgPnp::Dispatch().

GetParameterQueryDeviceTextLocaleId()

__inline LCID FxIrp::GetParameterQueryDeviceTextLocaleId

(

)

Definition at line 975 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("Not implemented"));
 
    return (LCID)(-1);
}

GetParameterQueryDeviceTextType()

__inline DEVICE_TEXT_TYPE FxIrp::GetParameterQueryDeviceTextType

(

)

Definition at line 984 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("Not implemented"));
 
    return (DEVICE_TEXT_TYPE)(-1);
}

GetParameterQueryIdType()

__inline BUS_QUERY_ID_TYPE FxIrp::GetParameterQueryIdType

(

)

Definition at line 1006 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("Not implemented"));
 
    return (BUS_QUERY_ID_TYPE)(-1);
}

GetParameterQueryInterfaceInterface()

__inline PINTERFACE FxIrp::GetParameterQueryInterfaceInterface

(

)

Definition at line 746 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
 
    return NULL;
}

GetParameterQueryInterfaceInterfaceSpecificData()

__inline PVOID FxIrp::GetParameterQueryInterfaceInterfaceSpecificData

(

)

Definition at line 785 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
 
    return NULL;
}

GetParameterQueryInterfaceSize()

__inline USHORT FxIrp::GetParameterQueryInterfaceSize

(

)

Definition at line 775 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
 
    return 0;
}

GetParameterQueryInterfaceType()

__inline const GUID * FxIrp::GetParameterQueryInterfaceType

(

)

Definition at line 755 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
 
    return NULL;
}

GetParameterQueryInterfaceVersion()

__inline USHORT FxIrp::GetParameterQueryInterfaceVersion

(

)

Definition at line 765 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
 
    return 0;
}

GetParameterReadLength()

__inline ULONG FxIrp::GetParameterReadLength

(

VOID

)

Definition at line 1589 of file fxirpum.cpp.

{
    ULONG length;
 
    GetIoIrp()->GetReadParameters(&length, NULL, NULL);
 
    return length;
}

Referenced by FxIoQueue::DispatchRequestToDriver(), FxRequestSystemBuffer::GetBufferSize(), FxRequest::GetMdl(), FxRequest::GetMemoryObject(), and FxIoQueue::GetRequest().

GetParameterSetLockLock()

__inline BOOLEAN FxIrp::GetParameterSetLockLock

(

)

Definition at line 993 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("Not implemented"));
 
    return FALSE;
}

GetParameterUsageNotificationInPath()

__inline BOOLEAN FxIrp::GetParameterUsageNotificationInPath

(

)

Definition at line 811 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
 
    return FALSE;
}

GetParameterUsageNotificationType()

__inline DEVICE_USAGE_NOTIFICATION_TYPE FxIrp::GetParameterUsageNotificationType

(

)

Definition at line 801 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
 
    return DeviceUsageTypeUndefined;
}

GetParameterWriteByteOffsetQuadPart()

__inline LONGLONG FxIrp::GetParameterWriteByteOffsetQuadPart

(

)

Definition at line 1373 of file fxirpum.cpp.

{
 
 
 
 
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
    return 0;
}

GetParameterWriteLength()

__inline ULONG FxIrp::GetParameterWriteLength

(

VOID

)

Definition at line 1601 of file fxirpum.cpp.

{
    ULONG length;
 
    GetIoIrp()->GetWriteParameters(&length, NULL, NULL);
 
    return length;
}

Referenced by FxIoQueue::DispatchRequestToDriver(), FxRequestSystemBuffer::GetBufferSize(), FxRequest::GetMdl(), FxRequest::GetMemoryObject(), and FxIoQueue::GetRequest().

GetPnpIrp()

IWudfPnpIrp * FxIrp::GetPnpIrp

(

VOID

)

Definition at line 1797 of file fxirpum.cpp.

{
    IWudfPnpIrp* pPnpIrp;
    HRESULT hrQI;
 
    hrQI = m_Irp->QueryInterface(IID_IWudfPnpIrp, (PVOID*)&pPnpIrp);
    FX_VERIFY(INTERNAL, CHECK_QI(hrQI, pPnpIrp));
    pPnpIrp->Release();
 
    //
    // Now that we confirmed the irp is a pnp irp, just return the underlying
    // irp.
    //
    return static_cast<IWudfPnpIrp*>(m_Irp);
}

Referenced by GetParameterDeviceCapabilities(), GetParameterPowerShutdownType(), GetParameterPowerStateDeviceState(), GetParameterPowerStateSystemState(), GetParameterPowerSystemPowerStateContext(), and GetParameterPowerType().

GetRequestorMode()

__inline KPROCESSOR_MODE FxIrp::GetRequestorMode

(

VOID

)

Definition at line 329 of file fxirpum.cpp.

{
    IWudfIoIrp * pIoIrp = NULL;
 
    HRESULT hrQI = m_Irp->QueryInterface(IID_IWudfIoIrp, (PVOID*)&pIoIrp);
 
    if (SUCCEEDED(hrQI)) {
        KPROCESSOR_MODE requestorMode;
 
        requestorMode = pIoIrp->GetRequestorMode();
        pIoIrp->Release();
 
        return requestorMode;
    }
    else {
        return KernelMode;
    }
}

Referenced by FxRequest::AssignMemoryBuffers(), FxRequest::CompleteInternal(), FxRequest::GetDeviceControlOutputMemoryObject(), FxRequest::GetMemoryObject(), and FxRequest::GetRequestorMode().

GetStackCount()

__inline CCHAR FxIrp::GetStackCount

(

)

Definition at line 1304 of file fxirpum.cpp.

{
 
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
    return 0;
}

GetStatus()

__inline NTSTATUS FxIrp::GetStatus

(

)

Definition at line 466 of file fxirpum.cpp.

{
    return m_Irp->GetStatus();
}

Referenced by FxPkgFdo::_PnpStartDeviceCompletionRoutine(), CopyStatus(), FxRequest::GetStatus(), FxPkgPnp::PnpFinishProcessingIrp(), PnpPassThroughQI(), FxPkgPnp::PowerCompletePendedWakeIrp(), FxPkgPnp::PowerPolicyCancelWaitWake(), SendIrpSynchronously(), and FxIoTarget::SubmitPendedRequest().

GetStatusBlock()

__inline PIO_STATUS_BLOCK FxIrp::GetStatusBlock

(

VOID

)

Definition at line 1664 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
    return NULL;
}

GetSystemBuffer()

__inline PVOID FxIrp::GetSystemBuffer

(

)

Definition at line 543 of file fxirpum.cpp.

{
    IWudfIoIrp * ioIrp = NULL;
    PVOID systemBuffer = NULL;
    HRESULT hr;
 
    ioIrp = GetIoIrp();
 
    switch (GetMajorFunction()) {
    case IRP_MJ_WRITE:
        //
        // For write host provides the buffer as input buffer
        //
        hr = ioIrp->RetrieveBuffers(NULL,         // InputBufferCb
                                    &systemBuffer,// InputBuffer
                                    NULL,         // OutputBufferCb
                                    NULL          // OutputBuffer
                                    );
        break;
    case IRP_MJ_READ:
        //
        // For read host provides the buffer as output buffer
        //
        hr = ioIrp->RetrieveBuffers(NULL,         // InputBufferCb
                                    NULL,         // InputBuffer
                                    NULL,         // OutputBufferCb
                                    &systemBuffer // OutputBuffer
                                    );
        break;
    case IRP_MJ_DEVICE_CONTROL:
        hr = ioIrp->RetrieveBuffers(NULL,         // InputBufferCb
                                    &systemBuffer,// InputBuffer
                                    NULL,         // OutputBufferCb
                                    NULL          // OutputBuffer
                                    );
        break;
    default:
        FX_VERIFY(INTERNAL, TRAPMSG("Not implemented"));
        hr = E_NOTIMPL;
        break;
    }
 
    if (FAILED(hr)) {
        systemBuffer = NULL;
    }
 
    return systemBuffer;
}

Referenced by FxRequest::AssignMemoryBuffers(), FxIoTarget::FormatIoctlRequest(), FxIoTarget::FormatIoRequest(), FxRequest::GetDeviceControlOutputMdl(), and FxRequest::GetMdl().

GetThread()

__inline MdEThread FxIrp::GetThread

(

VOID

)

Definition at line 1631 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
    return  NULL;
}

GetUserBuffer()

__inline PVOID FxIrp::GetUserBuffer

(

)

Definition at line 633 of file fxirpum.cpp.

{
    //
    // UserBuffer is used with METHOD_NEITHER
    // For METHOD_NEITHER reflector still makes a copy of the buffer
    // in common buffer (if METHOD_NEITHER is enabled via regkey)
    //
 
    IWudfIoIrp * ioIrp = GetIoIrp();
    PVOID userBuffer;
    HRESULT hr;
 
    hr = ioIrp->RetrieveBuffers(NULL,         // InputBufferCb
                                NULL,         // InputBuffer
                                NULL,         // OutputBufferCb
                                &userBuffer   // OutputBuffer
                                );
    if (FAILED(hr))
    {
        userBuffer = NULL;
    }
 
    return userBuffer;
}

Referenced by FxRequest::AssignMemoryBuffers(), and FxIoContext::CopyParameters().

HasStack()

__inline BOOLEAN FxIrp::HasStack

(

_In_ UCHAR

StackCount

)

Definition at line 1745 of file fxirpum.cpp.

{
    UNREFERENCED_PARAMETER(StackCount);
 
 
 
 
 
 
 
    return TRUE;
}

InitNextStackUsingStack()

__inline VOID FxIrp::InitNextStackUsingStack

(

__in FxIrp *

Irp

)

Definition at line 1035 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("Not implemented"));
}

Is32bitProcess()

__inline BOOLEAN FxIrp::Is32bitProcess

(

VOID

)

Definition at line 1640 of file fxirpum.cpp.

{
    return (GetIoIrp()->IsFrom32BitProcess() ? TRUE : FALSE);
}

IsCanceled()

__inline BOOLEAN FxIrp::IsCanceled

(

)

Definition at line 484 of file fxirpum.cpp.

{
    return (m_Irp->IsCanceled() ? TRUE: FALSE);
}

Referenced by FxIrpQueue::InsertIrpInQueue(), FxRequest::IsCancelled(), FxIrpQueue::PeekRequest(), and FxPkgPnp::PowerMakeWakeRequestNonCancelable().

IsCurrentIrpStackLocationValid()

__inline BOOLEAN FxIrp::IsCurrentIrpStackLocationValid

(

VOID

)

Definition at line 1761 of file fxirpum.cpp.

{
 
 
 
 
 
 
 
 
    return TRUE;
}

Referenced by FxIoTarget::PendRequestLocked(), and FxRequest::Reuse().

ListEntry()

__inline PLIST_ENTRY FxIrp::ListEntry

(

)

Definition at line 535 of file fxirpum.cpp.

{
    return m_Irp->GetListEntry();
}

Referenced by ClasspDequeueIdleRequest(), DequeueDeferredClientIrp(), GetIrpFromListEntry(), FxIrpQueue::InsertIrpInQueue(), FxIrpQueue::PeekNextIrpFromQueue(), and FxPkgPnp::PowerMakeWakeRequestNonCancelable().

MarkIrpPending()

__inline VOID FxIrp::MarkIrpPending

(

)

Definition at line 415 of file fxirpum.cpp.

{
 
 
 
 
 
    m_Irp->MarkIrpPending();
}

Referenced by FxPkgIo::DispathToInCallerContextCallback(), FxIrpQueue::InsertIrpInQueue(), and FxIoQueue::QueueRequest().

PendingReturned()

__inline BOOLEAN FxIrp::PendingReturned

(

)

Definition at line 429 of file fxirpum.cpp.

{
 
 
 
 
 
    return m_Irp->PendingReturned();
}

PoCallDriver()

__inline NTSTATUS FxIrp::PoCallDriver

(

__in MdDeviceObject

DeviceObject

)

Definition at line 48 of file fxirpum.cpp.

{
    UNREFERENCED_PARAMETER(DeviceObject);
 
    m_Irp->Forward();
    return STATUS_SUCCESS;
}

PropagatePendingReturned()

__inline VOID FxIrp::PropagatePendingReturned

(

VOID

)

Definition at line 443 of file fxirpum.cpp.

{
 
 
 
 
 
    m_Irp->PropagatePendingReturned();
}

RequestPowerIrp()

_Must_inspect_result_ __inline NTSTATUS FxIrp::RequestPowerIrp ( __in MdDeviceObject  DeviceObject, __in UCHAR  MinorFunction, __in POWER_STATE  PowerState, __in MdRequestPowerComplete  CompletionFunction, __in PVOID  Context  )

static

Definition at line 1047 of file fxirpum.cpp.

{
    HRESULT hr;
    IWudfDevice* deviceObject;
    IWudfDeviceStack *deviceStack;
 
    deviceObject = DeviceObject;
    deviceStack = deviceObject->GetDeviceStackInterface();
 
    hr = deviceStack->RequestPowerIrp(MinorFunction,
                                      PowerState,
                                      CompletionFunction,
                                      Context);
 
    if (S_OK == hr)
    {
        return STATUS_SUCCESS;
    }
    else
    {
        PUMDF_VERSION_DATA driverVersion = deviceStack->GetMinDriverVersion();
 
        BOOL preserveCompat =
             deviceStack->ShouldPreserveIrpCompletionStatusCompatibility();
 
        return CHostFxUtil::NtStatusFromHr(
                                        hr,
                                        driverVersion->MajorNumber,
                                        driverVersion->MinorNumber,
                                        preserveCompat
                                        );
    }
}

Referenced by FxPkgPnp::PowerPolicySendDevicePowerRequest(), and FxPkgPnp::PowerPolicySendWaitWakeRequest().

Reuse()

__inline VOID FxIrp::Reuse

(

__in NTSTATUS

Status = STATUS_SUCCESS

)

Definition at line 661 of file fxirpum.cpp.

{
    GetIoIrp()->Reuse(Status);
    return;
}

Referenced by FxUsbUmFormatRequest(), FxRequest::Reuse(), and FxUsbDevice::SelectConfig().

SendIrpSynchronously()

__inline NTSTATUS FxIrp::SendIrpSynchronously

(

__in MdDeviceObject

DeviceObject

)

Definition at line 151 of file fxirpum.cpp.

{
    NTSTATUS status = STATUS_SUCCESS;
    HANDLE event;
 
    UNREFERENCED_PARAMETER(DeviceObject);
 
    event = CreateEvent(
                    NULL,
                    TRUE,  //bManualReset
                    FALSE, //bInitialState
                    NULL   //Name
                    );
 
    if (NULL == event)
    {
#pragma prefast(suppress:__WARNING_MUST_USE, "we convert all Win32 errors into a generic failure currently")
        DWORD err = GetLastError();
 
        //
        // As such event creation would fail only for resource reasons if we pass
        // correct parameters
        //
 
        status = STATUS_INSUFFICIENT_RESOURCES;
 
        TraceEvents( TRACE_LEVEL_ERROR,
                    FX_TRACE_IO,
                    "Failed to create event, error: %!WINERROR!, "
                    "returning %!STATUS!",
                    err, status);
 
    }
 
    if (NT_SUCCESS(status))
    {
        SetCompletionRoutine(_IrpSynchronousCompletion,
                             event,
                             TRUE,
                             TRUE,
                             TRUE);
 
        m_Irp->Forward();
 
        DWORD retval = WaitForSingleObject(event, INFINITE);
        FX_VERIFY(INTERNAL, CHECK("INFNITE wait failed",
                                (retval == WAIT_OBJECT_0)));
 
        status = this->GetStatus();
    }
 
    return status;
}

Referenced by FxQueryInterface::_QueryForInterface(), GetStackCapabilities(), FxIoTargetRemote::GetTargetDeviceRelations(), and FxPkgPnp::QueryForD3ColdInterface().

SetCancel()

__inline VOID FxIrp::SetCancel

(

__in BOOLEAN

Cancel

)

Definition at line 1294 of file fxirpum.cpp.

{
    UNREFERENCED_PARAMETER(Cancel);
 
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
}

Referenced by FxRequest::Reuse().

SetCancelRoutine()

__inline MdCancelRoutine FxIrp::SetCancelRoutine

(

__in_opt MdCancelRoutine

CancelRoutine

)

Definition at line 124 of file fxirpum.cpp.

{
    return m_Irp->SetCancelRoutine(CancelRoutine);
}

Referenced by FxIrpQueue::InsertIrpInQueue(), FxPkgPnp::PowerMakeWakeRequestNonCancelable(), FxIrpQueue::RemoveIrpFromQueueByContext(), and FxIrpQueue::RemoveNextIrpFromQueue().

SetCompletionRoutine()

__inline VOID FxIrp::SetCompletionRoutine	(	__in MdCompletionRoutine	CompletionRoutine,
		__in PVOID	Context,
		__in BOOLEAN	InvokeOnSuccess = TRUE,
		__in BOOLEAN	InvokeOnError = TRUE,
		__in BOOLEAN	InvokeOnCancel = TRUE
	)

Definition at line 72 of file fxirpum.cpp.

{
    UNREFERENCED_PARAMETER(InvokeOnSuccess);
    UNREFERENCED_PARAMETER(InvokeOnError);
    UNREFERENCED_PARAMETER(InvokeOnCancel);
 
    //
    // In UMDF completion callback is invoked in all three cases, there isn't an option
    // to invoke it selectively
 
 
 
 
    FX_VERIFY(INTERNAL, CHECK(
        "UMDF completion routine can't be invoked selectively on Success/Error/Cancel",
        (TRUE == InvokeOnSuccess) &&
        (TRUE == InvokeOnError) &&
        (TRUE == InvokeOnCancel)));
 
    m_Irp->SetCompletionRoutine(
        CompletionRoutine,
        Context
        );
}

Referenced by SendIrpSynchronously(), and SetCompletionRoutineEx().

SetCompletionRoutineEx()

__inline VOID FxIrp::SetCompletionRoutineEx	(	__in MdDeviceObject	DeviceObject,
		__in MdCompletionRoutine	CompletionRoutine,
		__in PVOID	Context,
		__in BOOLEAN	InvokeOnSuccess = TRUE,
		__in BOOLEAN	InvokeOnError = TRUE,
		__in BOOLEAN	InvokeOnCancel = TRUE
	)

Definition at line 104 of file fxirpum.cpp.

{
    UNREFERENCED_PARAMETER(DeviceObject);
 
    SetCompletionRoutine(
        CompletionRoutine,
        Context,
        InvokeOnSuccess,
        InvokeOnError,
        InvokeOnCancel);
}

Referenced by FxDevice::_AcquireOptinRemoveLock(), FxPkgFdo::PnpSendStartDeviceDownTheStackOverload(), and FxIoTarget::SetCompletionRoutine().

SetContext()

__inline VOID FxIrp::SetContext	(	__in ULONG	Index,
		__in PVOID	Value
	)

Definition at line 351 of file fxirpum.cpp.

{
    m_Irp->SetContext(Index, Value);
}

Referenced by FxIrpQueue::InsertIrpInQueue(), FxIrpQueue::RemoveIrpFromQueueByContext(), FxIrpQueue::RemoveNextIrpFromQueue(), and FxRequestBase::ZeroOutDriverContext().

SetCurrentDeviceObject()

__inline VOID FxIrp::SetCurrentDeviceObject

(

__in MdDeviceObject

DeviceObject

)

Definition at line 1362 of file fxirpum.cpp.

{
    UNREFERENCED_PARAMETER(DeviceObject);
 
 
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
}

Referenced by FxIoQueue::ForwardRequestToParent(), FxIoQueue::QueueDriverCreatedRequest(), and FxIoTargetSelf::Send().

SetFlags()

__inline VOID FxIrp::SetFlags

(

__in ULONG

Flags

)

Definition at line 1266 of file fxirpum.cpp.

{
    UNREFERENCED_PARAMETER(Flags);
 
 
 
 
 
 
    FX_VERIFY(INTERNAL, CHECK_TODO(Flags == 0));
}

Referenced by FxRequest::CompleteInternal(), and FxIoContext::ReleaseAndRestore().

SetInformation()

__inline VOID FxIrp::SetInformation

(

__in ULONG_PTR

Information

)

Definition at line 504 of file fxirpum.cpp.

{
    m_Irp->SetInformation(Information);
}

Referenced by FxIoQueue::CancelIrps(), FxRequest::CompleteWithInformation(), FxDefaultIrpHandler::Dispatch(), FxDevice::DispatchPreprocessedIrp(), FxPkgIo::DispatchStep1(), FxPkgIo::DispatchStep2(), FxIoTarget::FailPendedRequest(), FxPkgGeneral::OnCleanup(), FxPkgGeneral::OnClose(), FxPkgGeneral::OnCreate(), FxPkgGeneral::OnShutdown(), FxIoTargetSelf::Send(), FxRequest::SetInformation(), and FxIoTarget::SubmitPendedRequest().

SetIrp()

__inline MdIrp FxIrp::SetIrp

(

MdIrp

irp

)

Definition at line 71 of file fxirpkm.hpp.

{
    MdIrp old = m_Irp;
    m_Irp = irp;
    return old;
}

Referenced by FxPkgPdo::_QueryCapsWorkItem(), FxIoTarget::_RequestCancelled(), FxIoQueue::CancelIrps(), FxRequest::CompleteInternal(), GetStackCapabilities(), FxIoTargetRemote::GetTargetDeviceRelations(), FxUsbIdleInfo::Initialize(), FxIrpQueue::IsIrpInQueue(), FxIrpQueue::PeekNextIrpFromQueue(), FxIrpQueue::PeekRequest(), FxPkgPnp::PnpDeviceUsageNotification(), FxPkgPnp::PnpEventQueryRemovePending(), FxPkgPnp::PnpEventQueryStopPending(), FxPkgPnp::PnpFinishProcessingIrp(), FxPkgPnp::PnpMatchResources(), FxRequest::PostProcessSendAndForget(), FxPkgPnp::PowerGotoDxIoStopped(), FxPkgPnp::PowerGotoDxIoStoppedNP(), FxPkgPnp::PowerMakeWakeRequestNonCancelable(), FxPkgPnp::QueryForD3ColdInterface(), FxRequest::Release(), FxIrpQueue::RemoveNextIrpFromQueue(), FxRequest::Reuse(), FxRequestBase::SetSubmitIrp(), and FxRequestBase::ValidateTarget().

SetMajorFunction()

__inline VOID FxIrp::SetMajorFunction

(

__in UCHAR

MajorFunction

)

Definition at line 905 of file fxirpum.cpp.

{
    IWudfIoIrp * pIoIrp = NULL;
 
    //
    // IWudfIrp does not expose a method to set major function code directly so
    // map it to WdfRequestType.
    //
    HRESULT hrQI = m_Irp->QueryInterface(IID_IWudfIoIrp, (PVOID*)&pIoIrp);
    if (SUCCEEDED(hrQI)) {
        UMINT::WDF_REQUEST_TYPE type;
 
        //
        // for Io irp, map major function to request type
        //
        switch(MajorFunction) {
        case IRP_MJ_CREATE:
            type = UMINT::WdfRequestCreate;
            break;
        case IRP_MJ_CLEANUP:
            type = UMINT::WdfRequestCleanup;
            break;
        case IRP_MJ_READ:
            type = UMINT::WdfRequestRead;
            break;
        case IRP_MJ_WRITE:
            type = UMINT::WdfRequestWrite;
            break;
        case IRP_MJ_DEVICE_CONTROL:
            type = UMINT::WdfRequestDeviceIoControl;
            break;
        case IRP_MJ_CLOSE:
            type = UMINT::WdfRequestClose;
            break;
        case IRP_MJ_INTERNAL_DEVICE_CONTROL:
            type = UMINT::WdfRequestInternalIoctl;
            break;
        case IRP_MJ_FLUSH_BUFFERS:
            type = UMINT::WdfRequestFlushBuffers;
            break;
        case IRP_MJ_QUERY_INFORMATION:
            type = UMINT::WdfRequestQueryInformation;
            break;
        case IRP_MJ_SET_INFORMATION:
            type = UMINT::WdfRequestSetInformation;
            break;
        default:
            FX_VERIFY(INTERNAL, TRAPMSG("The request type is not expected"));
            type = UMINT::WdfRequestUndefined;
        }
 
        pIoIrp->SetTypeForNextStackLocation(type);
        pIoIrp->Release();
    }
    else {
        FX_VERIFY(INTERNAL, TRAPMSG("Not expected"));
    }
}

Referenced by FxIoTarget::FormatInternalIoctlOthersRequest(), FxIoTarget::FormatIoctlRequest(), FxIoTarget::FormatIoRequest(), FxFormatUsbRequest(), GetStackCapabilities(), and FxPkgPnp::QueryForD3ColdInterface().

SetMdlAddress()

__inline VOID FxIrp::SetMdlAddress

(

__in PMDL

Value

)

Definition at line 1330 of file fxirpum.cpp.

{
    //
    // MDL is not supported in UMDF so must be NULL.
    //
    FX_VERIFY(INTERNAL, CHECK_NULL(Value));
}

Referenced by FxIoContext::ReleaseAndRestore().

SetMinorFunction()

__inline VOID FxIrp::SetMinorFunction

(

__in UCHAR

MinorFunction

)

Definition at line 967 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("Not supported"));
}

Referenced by GetStackCapabilities(), and FxPkgPnp::QueryForD3ColdInterface().

SetNextIrpStackLocation()

__inline VOID FxIrp::SetNextIrpStackLocation

(

VOID

)

Definition at line 1235 of file fxirpum.cpp.

{
    m_Irp->SetNextIrpStackLocation();
}

Referenced by FxDevice::_AcquireOptinRemoveLock(), FxDevice::DispatchPreprocessedIrp(), FxIoQueue::ForwardRequestToParent(), FxIoTarget::PendRequestLocked(), FxIoQueue::QueueDriverCreatedRequest(), and FxIoTargetSelf::Send().

SetNextParameterWriteByteOffsetQuadPart()

__inline VOID FxIrp::SetNextParameterWriteByteOffsetQuadPart

(

__in LONGLONG

DeviceOffset

)

Definition at line 1385 of file fxirpum.cpp.

{
    UNREFERENCED_PARAMETER(DeviceOffset);
 
 
 
 
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
}

Referenced by FxIoTarget::FormatIoRequest().

SetNextParameterWriteLength()

__inline VOID FxIrp::SetNextParameterWriteLength

(

__in ULONG

IoLength

)

Definition at line 1398 of file fxirpum.cpp.

{
    UNREFERENCED_PARAMETER(IoLength);
 
 
 
 
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
}

Referenced by FxIoTarget::FormatIoRequest().

SetNextStackFileObject()

__inline VOID FxIrp::SetNextStackFileObject

(

_In_ MdFileObject

FileObject

)

Definition at line 1573 of file fxirpum.cpp.

{
    GetIoIrp()->SetFileForNextIrpStackLocation(FileObject);
}

Referenced by FxIoTarget::CopyFileObjectAndFlags().

SetNextStackFlags()

__inline VOID FxIrp::SetNextStackFlags

(

__in UCHAR

Flags

)

Definition at line 1556 of file fxirpum.cpp.

{
    UNREFERENCED_PARAMETER(Flags);
 
 
 
 
 
 
 
 
    DO_NOTHING();
}

Referenced by FxIoTarget::CopyFileObjectAndFlags().

SetNextStackParameterOthersArgument1()

__inline VOID FxIrp::SetNextStackParameterOthersArgument1

(

__in PVOID

Argument1

)

Definition at line 1411 of file fxirpum.cpp.

{
    UNREFERENCED_PARAMETER(Argument1);
 
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
}

Referenced by FxFormatUsbRequest().

SetParameterAllocatedResources()

__inline VOID FxIrp::SetParameterAllocatedResources

(

__in PCM_RESOURCE_LIST

AllocatedResources

)

Definition at line 869 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("Not implemented"));
}

Referenced by FxPkgFdo::PnpSendStartDeviceDownTheStackOverload().

SetParameterAllocatedResourcesTranslated()

__inline VOID FxIrp::SetParameterAllocatedResourcesTranslated

(

__in PCM_RESOURCE_LIST

AllocatedResourcesTranslated

)

Definition at line 897 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("Not implemented"));
}

Referenced by FxPkgFdo::PnpSendStartDeviceDownTheStackOverload().

SetParameterDeviceCapabilities()

__inline VOID FxIrp::SetParameterDeviceCapabilities

(

__in PDEVICE_CAPABILITIES

DeviceCapabilities

)

Definition at line 1145 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("Not implemented"));
}

Referenced by GetStackCapabilities().

SetParameterIoctlCode()

__inline VOID FxIrp::SetParameterIoctlCode

(

__in ULONG

DeviceIoControlCode

)

Definition at line 1157 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
}

Referenced by FxIoTarget::FormatInternalIoctlOthersRequest(), FxIoTarget::FormatIoctlRequest(), and FxFormatUsbRequest().

SetParameterIoctlInputBufferLength()

__inline VOID FxIrp::SetParameterIoctlInputBufferLength

(

__in ULONG

InputBufferLength

)

Definition at line 1166 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
}

Referenced by FxIoTarget::FormatIoctlRequest().

SetParameterIoctlOutputBufferLength()

__inline VOID FxIrp::SetParameterIoctlOutputBufferLength

(

__in ULONG

OutputBufferLength

)

Definition at line 1532 of file fxirpum.cpp.

{
    UNREFERENCED_PARAMETER(OutputBufferLength);
 
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
}

Referenced by FxIoTarget::FormatIoctlRequest().

SetParameterIoctlType3InputBuffer()

__inline VOID FxIrp::SetParameterIoctlType3InputBuffer

(

__in PVOID

Type3InputBuffer

)

Definition at line 1175 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
}

Referenced by FxIoTarget::FormatIoctlRequest().

SetParameterQDRType()

__inline VOID FxIrp::SetParameterQDRType

(

__in DEVICE_RELATION_TYPE

DeviceRelation

)

Definition at line 678 of file fxirpkm.hpp.

{
     this->GetNextIrpStackLocation()->
        Parameters.QueryDeviceRelations.Type = DeviceRelation;
}

SetParameterQueryInterfaceInterface()

__inline VOID FxIrp::SetParameterQueryInterfaceInterface

(

__in PINTERFACE

Interface

)

Definition at line 1053 of file fxirpkm.hpp.

{
    this->GetNextIrpStackLocation()->
        Parameters.QueryInterface.Interface = Interface;
}

Referenced by FxPkgPnp::QueryForD3ColdInterface().

SetParameterQueryInterfaceInterfaceSpecificData()

__inline VOID FxIrp::SetParameterQueryInterfaceInterfaceSpecificData

(

__in PVOID

InterfaceSpecificData

)

Definition at line 1091 of file fxirpkm.hpp.

{
    this->GetNextIrpStackLocation()->
        Parameters.QueryInterface.InterfaceSpecificData = InterfaceSpecificData;
}

Referenced by FxPkgPnp::QueryForD3ColdInterface().

SetParameterQueryInterfaceSize()

__inline VOID FxIrp::SetParameterQueryInterfaceSize

(

__in USHORT

Size

)

Definition at line 1082 of file fxirpkm.hpp.

{
    this->GetNextIrpStackLocation()->Parameters.QueryInterface.Size = Size;
}

Referenced by FxPkgPnp::QueryForD3ColdInterface().

SetParameterQueryInterfaceType()

__inline VOID FxIrp::SetParameterQueryInterfaceType

(

__in const GUID *

InterfaceType

)

Definition at line 1063 of file fxirpkm.hpp.

{
    this->GetNextIrpStackLocation()->
        Parameters.QueryInterface.InterfaceType = InterfaceType;
}

Referenced by FxPkgPnp::QueryForD3ColdInterface().

SetParameterQueryInterfaceVersion()

__inline VOID FxIrp::SetParameterQueryInterfaceVersion

(

__in USHORT

Version

)

Definition at line 1073 of file fxirpkm.hpp.

{
    this->GetNextIrpStackLocation()->Parameters.QueryInterface.Version = Version;
}

Referenced by FxPkgPnp::QueryForD3ColdInterface().

SetParameterUsageNotificationInPath()

__inline VOID FxIrp::SetParameterUsageNotificationInPath

(

__in BOOLEAN

InPath

)

Definition at line 821 of file fxirpum.cpp.

{
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
}

SetStatus()

__inline VOID FxIrp::SetStatus

(

__in NTSTATUS

Status

)

Definition at line 457 of file fxirpum.cpp.

{
    m_Irp->SetStatus(Status);
}

Referenced by FxIoQueue::CancelIrps(), FxRequest::CompleteInternal(), FxDefaultIrpHandler::Dispatch(), FxPkgGeneral::Dispatch(), FxDevice::DispatchPreprocessedIrp(), FxPkgIo::DispatchStep1(), FxPkgIo::DispatchStep2(), FxDevice::DispatchWithLock(), FxIoTarget::DrainPendedRequestsLocked(), FxIoTarget::FailPendedRequest(), GetStackCapabilities(), FxIoTargetRemote::GetTargetDeviceRelations(), FxPkgGeneral::OnCleanup(), FxPkgGeneral::OnClose(), FxPkgGeneral::OnCreate(), FxPkgGeneral::OnShutdown(), FxPkgPnp::PnpEventInitQueryRemove(), FxPkgPnp::PowerMakeWakeRequestNonCancelable(), FxPkgFdo::PowerReleasePendingDeviceIrp(), FxPkgPnp::QueryForD3ColdInterface(), FxRequest::Reuse(), FxIoTargetSelf::Send(), FxPkgPnp::SetPendingPnpIrpStatus(), FxRequest::SetStatus(), and FxIoTarget::SubmitLocked().

SetSystemBuffer()

__inline VOID FxIrp::SetSystemBuffer

(

__in PVOID

Value

)

Definition at line 1313 of file fxirpum.cpp.

{
    UNREFERENCED_PARAMETER(Value);
 
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
}

Referenced by FxIoTarget::FormatIoctlRequest(), FxIoTarget::FormatIoRequest(), and FxIoContext::ReleaseAndRestore().

SetUserBuffer()

__inline VOID FxIrp::SetUserBuffer

(

__in PVOID

Value

)

Definition at line 1341 of file fxirpum.cpp.

{
    UNREFERENCED_PARAMETER(Value);
 
 
    FX_VERIFY(INTERNAL, TRAPMSG("To be implemented"));
}

Referenced by FxIoTarget::FormatIoctlRequest(), FxIoTarget::FormatIoRequest(), and FxIoContext::ReleaseAndRestore().

SkipCurrentIrpStackLocation()

__inline VOID FxIrp::SkipCurrentIrpStackLocation

(

VOID

)

Definition at line 400 of file fxirpum.cpp.

{
    //
    // Earler we always used to copy because the framework always set a
    // completion routine to notify other packages that we completed. However,
    // since some I/O paths relied on Skip to revert the action taken by
    // SetNextStackLocation in failure paths, we now skip instead of copy. The
    // same behavior applies to KMDF as well.
    //
    m_Irp->SkipCurrentIrpStackLocation();
}

Referenced by FxIoTarget::_RequestCancelled(), FxDefaultIrpHandler::Dispatch(), FxPkgIo::DispatchStep1(), FxIoTarget::DrainPendedRequestsLocked(), FxIoQueue::ForwardRequestToParent(), FxPkgGeneral::OnCleanup(), FxPkgGeneral::OnClose(), FxPkgGeneral::OnShutdown(), FxIoTarget::PendRequestLocked(), FxRequest::PreProcessSendAndForget(), and FxIoQueue::QueueDriverCreatedRequest().

StartNextPowerIrp()

__inline VOID FxIrp::StartNextPowerIrp

(

)

Definition at line 61 of file fxirpum.cpp.

{
 
 
 
    DO_NOTHING();
}

Referenced by FxDefaultIrpHandler::Dispatch().

Friends And Related Function Documentation

FxAutoIrp

friend struct FxAutoIrp

friend

Definition at line 30 of file fxirp.hpp.

Member Data Documentation

m_Irp

MdIrp FxIrp::m_Irp

private

Definition at line 33 of file fxirp.hpp.

Referenced by CallDriver(), Cancel(), ClearNextStack(), ClearNextStackLocation(), CompleteRequest(), CopyCurrentIrpStackLocationToNext(), FreeIrp(), GetContext(), GetFileObject(), GetInformation(), GetIoIrp(), GetIrp(), GetMajorFunction(), GetMinorFunction(), GetParameterAllocatedResources(), GetParameterAllocatedResourcesTranslated(), GetParameterPowerState(), GetPnpIrp(), GetRequestorMode(), GetStatus(), IsCanceled(), ListEntry(), MarkIrpPending(), PendingReturned(), PoCallDriver(), PropagatePendingReturned(), SendIrpSynchronously(), SetCancelRoutine(), SetCompletionRoutine(), SetContext(), SetInformation(), SetIrp(), SetMajorFunction(), SetNextIrpStackLocation(), SetStatus(), SkipCurrentIrpStackLocation(), and FxAutoIrp::~FxAutoIrp().

---

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

• sdk/lib/drivers/wdf/shared/inc/private/common/fxirp.hpp
• sdk/lib/drivers/wdf/shared/core/um/fxirpum.cpp
• sdk/lib/drivers/wdf/shared/inc/private/km/fxirpkm.hpp