pofuncs.h File Reference

Go to the source code of this file.

Macros
#define	PoSetDeviceBusy(IdlePointer)   ((void)(*(IdlePointer) = 0))

Functions
	$if (_WDMDDK_) _IRQL_requires_max_(DISPATCH_LEVEL) NTKERNELAPI NTSTATUS NTAPI PoCallDriver(_In_ struct _DEVICE_OBJECT *DeviceObject
	_IRQL_requires_max_ (APC_LEVEL) NTKERNELAPI PULONG NTAPI PoRegisterDeviceForIdleDetection(_In_ struct _DEVICE_OBJECT *DeviceObject
	_IRQL_requires_max_ (DISPATCH_LEVEL) NTKERNELAPI NTSTATUS NTAPI PoRequestPowerIrp(_In_ struct _DEVICE_OBJECT *DeviceObject
NTKERNELAPI NTSTATUS NTAPI	PoRequestShutdownEvent (OUT PVOID *Event)
	$endif (_WDMDDK_) $if(_NTIFS_) _IRQL_requires_max_(APC_LEVEL) NTKERNELAPI NTSTATUS NTAPI PoQueueShutdownWorkItem(_Inout_ __drv_aliasesMem PWORK_QUEUE_ITEM WorkItem)
	$endif (_NTIFS_) $if(_WDMDDK_) _IRQL_requires_max_(DISPATCH_LEVEL) NTKRNLVISTAAPI VOID NTAPI PoSetSystemWake(_Inout_ struct _IRP *Irp)
NTKERNELAPI VOID NTAPI	PoSetDeviceBusyEx (_Inout_ PULONG IdlePointer)
NTKERNELAPI VOID NTAPI	PoStartDeviceBusy (_Inout_ PULONG IdlePointer)
NTKERNELAPI VOID NTAPI	PoEndDeviceBusy (_Inout_ PULONG IdlePointer)

Variables
_Inout_ __drv_aliasesMem struct _IRP *	Irp
_In_ ULONG	ConservationIdleTime
_In_ ULONG _In_ ULONG	PerformanceIdleTime
_In_ ULONG _In_ ULONG _In_ DEVICE_POWER_STATE	State
_In_ EXECUTION_STATE	Flags
_In_ UCHAR	MinorFunction
_In_ UCHAR _In_ POWER_STATE	PowerState
_In_ UCHAR _In_ POWER_STATE _In_opt_ PREQUEST_POWER_COMPLETE	CompletionFunction
_In_ UCHAR _In_ POWER_STATE _In_opt_ PREQUEST_POWER_COMPLETE _In_opt_ __drv_aliasesMem PVOID	Context
_In_ POWER_STATE_TYPE	Type
_In_ LPCGUID	SettingGuid
_In_ LPCGUID _In_ PPOWER_SETTING_CALLBACK	Callback
_In_ LPCGUID _In_ PPOWER_SETTING_CALLBACK _In_opt_ PVOID _Outptr_opt_ PVOID *	Handle
_Out_ PULONG	SecondsRemaining
_In_ PDEVICE_OBJECT	DeviceObject

Macro Definition Documentation

PoSetDeviceBusy

#define PoSetDeviceBusy

(

IdlePointer

)

((void)(*(IdlePointer) = 0))

Function Documentation

$endif() [1/2]

$endif

(

_WDMDDK_

)

Definition at line 202 of file ke.h.

{
    ULONGLONG Low;
    LONGLONG High;
} NEON128, *PNEON128;

$endif() [2/2]

$endif

(

_NTIFS_

)

Definition at line 2827 of file rtlfuncs.h.

{
  LARGE_INTEGER ret;
  ret.QuadPart = SignedInteger;
  return ret;
}

$if()

$if

(

_WDMDDK_

)

Kernel definitions for AMD64

Kernel definitions for ARM

Definition at line 1 of file ke.h.

{
    ULONG Dummy;
} KFLOATING_SAVE, *PKFLOATING_SAVE;

_IRQL_requires_max_() [1/2]

_IRQL_requires_max_

(

APC_LEVEL

)

Definition at line 197 of file cddata.c.

{
    THREAD_CONTEXT ThreadContext = {0};
    PIRP_CONTEXT IrpContext = NULL;
    BOOLEAN Wait;

#ifdef CD_SANITY
    PVOID PreviousTopLevel;
#endif

    NTSTATUS Status;

#if DBG

    KIRQL SaveIrql = KeGetCurrentIrql();

#endif

    ASSERT_OPTIONAL_IRP( Irp );

    UNREFERENCED_PARAMETER( DeviceObject );

    FsRtlEnterFileSystem();

#ifdef CD_SANITY
    PreviousTopLevel = IoGetTopLevelIrp();
#endif

    //
    //  Loop until this request has been completed or posted.
    //

    do {

        //
        //  Use a try-except to handle the exception cases.
        //

        _SEH2_TRY {

            //
            //  If the IrpContext is NULL then this is the first pass through
            //  this loop.
            //

            if (IrpContext == NULL) {

                //
                //  Decide if this request is waitable an allocate the IrpContext.
                //  If the file object in the stack location is NULL then this
                //  is a mount which is always waitable.  Otherwise we look at
                //  the file object flags.
                //

                if (IoGetCurrentIrpStackLocation( Irp )->FileObject == NULL) {

                    Wait = TRUE;

                } else {

                    Wait = CanFsdWait( Irp );
                }

                IrpContext = CdCreateIrpContext( Irp, Wait );

                //
                //  Update the thread context information.
                //

                CdSetThreadContext( IrpContext, &ThreadContext );

#ifdef CD_SANITY
                NT_ASSERT( !CdTestTopLevel ||
                        SafeNodeType( IrpContext->TopLevel ) == CDFS_NTC_IRP_CONTEXT );
#endif

            //
            //  Otherwise cleanup the IrpContext for the retry.
            //

            } else {

                //
                //  Set the MORE_PROCESSING flag to make sure the IrpContext
                //  isn't inadvertently deleted here.  Then cleanup the
                //  IrpContext to perform the retry.
                //

                SetFlag( IrpContext->Flags, IRP_CONTEXT_FLAG_MORE_PROCESSING );
                CdCleanupIrpContext( IrpContext, FALSE );
            }

            //
            //  Case on the major irp code.
            //

            switch (IrpContext->MajorFunction) {

            case IRP_MJ_CREATE :

                Status = CdCommonCreate( IrpContext, Irp );
                break;

            case IRP_MJ_CLOSE :

                Status = CdCommonClose( IrpContext, Irp );
                break;

            case IRP_MJ_READ :

                //
                //  If this is an Mdl complete request, don't go through
                //  common read.
                //

                if (FlagOn( IrpContext->MinorFunction, IRP_MN_COMPLETE )) {

                    Status = CdCompleteMdl( IrpContext, Irp );

                } else {

                    Status = CdCommonRead( IrpContext, Irp );
                }

                break;

            case IRP_MJ_WRITE :

                Status = CdCommonWrite( IrpContext, Irp );
                break;

            case IRP_MJ_QUERY_INFORMATION :

                Status = CdCommonQueryInfo( IrpContext, Irp );
                break;

            case IRP_MJ_SET_INFORMATION :

                Status = CdCommonSetInfo( IrpContext, Irp );
                break;

            case IRP_MJ_QUERY_VOLUME_INFORMATION :

                Status = CdCommonQueryVolInfo( IrpContext, Irp );
                break;

            case IRP_MJ_DIRECTORY_CONTROL :

                Status = CdCommonDirControl( IrpContext, Irp );
                break;

            case IRP_MJ_FILE_SYSTEM_CONTROL :

                Status = CdCommonFsControl( IrpContext, Irp );
                break;

            case IRP_MJ_DEVICE_CONTROL :

                Status = CdCommonDevControl( IrpContext, Irp );
                break;

            case IRP_MJ_LOCK_CONTROL :

                Status = CdCommonLockControl( IrpContext, Irp );
                break;

            case IRP_MJ_CLEANUP :

                Status = CdCommonCleanup( IrpContext, Irp );
                break;

            case IRP_MJ_PNP :

                Status = CdCommonPnp( IrpContext, Irp );
                break;

            case IRP_MJ_SHUTDOWN :
            
                Status = CdCommonShutdown( IrpContext, Irp );
                break;

            default :

                Status = STATUS_INVALID_DEVICE_REQUEST;
                CdCompleteRequest( IrpContext, Irp, Status );
            }

        } _SEH2_EXCEPT( CdExceptionFilter( IrpContext, _SEH2_GetExceptionInformation() )) {

            Status = CdProcessException( IrpContext, Irp, _SEH2_GetExceptionCode() );
        } _SEH2_END;

    } while (Status == STATUS_CANT_WAIT);

#ifdef CD_SANITY
    NT_ASSERT( !CdTestTopLevel ||
            (PreviousTopLevel == IoGetTopLevelIrp()) );
#endif

    FsRtlExitFileSystem();

    NT_ASSERT( SaveIrql == KeGetCurrentIrql( ));

    return Status;
}

_IRQL_requires_max_() [2/2]

_IRQL_requires_max_

(

DISPATCH_LEVEL

)

Definition at line 188 of file autorun.c.

{
    PTARGET_DEVICE_CUSTOM_NOTIFICATION notification;
    ULONG requiredSize;
    NTSTATUS status;

    status = RtlULongAdd((sizeof(TARGET_DEVICE_CUSTOM_NOTIFICATION) - sizeof(UCHAR)),
                         ExtraDataSize,
                         &requiredSize);

    if (!(NT_SUCCESS(status)) || (requiredSize > 0x0000ffff)) {
        // MAX_USHORT, max total size for these events!
        TracePrint((TRACE_LEVEL_WARNING, TRACE_FLAG_MCN,
                   "Error sending event: size too large! (%x)\n",
                   requiredSize));
        return;
    }

    notification = ExAllocatePoolWithTag(NonPagedPoolNx,
                                         requiredSize,
                                         'oNcS');

    //
    // if none allocated, exit
    //

    if (notification == NULL) {
        return;
    }

    //
    // Prepare and send the request!
    //

    RtlZeroMemory(notification, requiredSize);
    notification->Version = 1;
    notification->Size = (USHORT)(requiredSize);
    notification->FileObject = NULL;
    notification->NameBufferOffset = -1;
    notification->Event = *Guid;

    if (ExtraData != NULL && ExtraDataSize != 0) {
        RtlCopyMemory(notification->CustomDataBuffer, ExtraData, ExtraDataSize);
    }

    IoReportTargetDeviceChangeAsynchronous(FdoExtension->LowerPdo,
                                           notification,
                                           NULL, NULL);

    FREE_POOL(notification);
    return;
}

PoEndDeviceBusy()

NTKERNELAPI VOID NTAPI PoEndDeviceBusy

(

_Inout_ PULONG

IdlePointer

)

PoRequestShutdownEvent()

NTKERNELAPI NTSTATUS NTAPI PoRequestShutdownEvent

(

OUT PVOID *

Event

)

Definition at line 399 of file poshtdwn.c.

{
    NTSTATUS Status;
    PAGED_CODE();

    /* Initialize to NULL */
    if (Event) *Event = NULL;

    /* Request a shutdown wait */
    Status = PoRequestShutdownWait(PsGetCurrentThread());
    if (!NT_SUCCESS(Status))
    {
        return Status;
    }

    /* Return the global shutdown event */
    if (Event) *Event = &PopShutdownEvent;
    return STATUS_SUCCESS;
}

Referenced by RawInputThreadMain().

PoSetDeviceBusyEx()

NTKERNELAPI VOID NTAPI PoSetDeviceBusyEx

(

_Inout_ PULONG

IdlePointer

)

PoStartDeviceBusy()

NTKERNELAPI VOID NTAPI PoStartDeviceBusy

(

_Inout_ PULONG

IdlePointer

)

Variable Documentation

Callback

_In_ LPCGUID _In_ PPOWER_SETTING_CALLBACK Callback

Definition at line 120 of file pofuncs.h.

CompletionFunction

_In_ UCHAR _In_ POWER_STATE _In_opt_ PREQUEST_POWER_COMPLETE CompletionFunction

Definition at line 42 of file pofuncs.h.

Referenced by PoRequestPowerIrp().

ConservationIdleTime

_In_ ULONG ConservationIdleTime

Definition at line 24 of file pofuncs.h.

Context

_In_ PDEVICE_OBJECT _In_opt_ PCOUNTED_REASON_CONTEXT Context

Definition at line 42 of file pofuncs.h.

DeviceObject

_In_ PDEVICE_OBJECT DeviceObject

Definition at line 193 of file pofuncs.h.

Flags

_In_ EXECUTION_STATE Flags

Definition at line 34 of file pofuncs.h.

Handle

_In_ LPCGUID _In_ PPOWER_SETTING_CALLBACK _In_opt_ PVOID _Outptr_opt_ PVOID* Handle

Definition at line 120 of file pofuncs.h.

Irp

_In_ UCHAR _In_ POWER_STATE _In_opt_ PREQUEST_POWER_COMPLETE _In_opt_ __drv_aliasesMem PVOID _Outptr_opt_ struct _IRP** Irp

Definition at line 16 of file pofuncs.h.

MinorFunction

_In_ UCHAR MinorFunction

Definition at line 42 of file pofuncs.h.

Referenced by ClassPower(), CmBattSystemControl(), CmBattWaitWakeLoop(), DispCancelRequest(), FdoPnp(), GetIRPMinorFunctionString(), i8042Pnp(), IopInitiatePnpIrp(), KsDefaultDispatchPnp(), main(), PciDebugPnpIrpTypeToText(), PciDebugPoIrpTypeToText(), PciIdeXFdoPnpDispatch(), PciIdeXPdoPnpDispatch(), PnPMinorFunctionString(), PoRequestPowerIrp(), PowerMinorFunctionString(), RequestedPowerCompletion(), RxFsdCommonDispatch(), SerenumFdoPnp(), SerenumPdoPnp(), SerialPnp(), SermousePnp(), UDFCommonFSControl(), and WMIMinorFunctionString().

PerformanceIdleTime

_In_ ULONG _In_ ULONG PerformanceIdleTime

Definition at line 24 of file pofuncs.h.

PowerState

_In_ UCHAR _In_ POWER_STATE PowerState

Definition at line 42 of file pofuncs.h.

Referenced by CmBattWaitWakeLoop(), DECLARE_INTERFACE_(), DisplayPowerStateMappings(), NduNetPnPEvent(), PciPdoIrpStartDevice(), PciSetPowerManagedDevicePowerState(), PciStallForPowerChange(), PcRequestNewPowerState(), PopPerfIdle(), PopPerfIdleDpc(), PopRequestPowerIrpCompletion(), PopSetSystemPowerState(), PoRequestPowerIrp(), PortClsPnp(), PortClsPower(), RequestedPowerCompletion(), TestPoRequestPowerIrp(), USBH_FdoIdleNotificationCallback(), USBH_FdoPower(), USBH_FdoSubmitWaitWakeIrp(), USBH_FdoWWIrpIoCompletion(), USBH_HubSetD0(), and USBH_PowerIrpCompletion().

SecondsRemaining

_Out_ PULONG SecondsRemaining

Definition at line 162 of file pofuncs.h.

SettingGuid

_In_ LPCGUID SettingGuid

Definition at line 120 of file pofuncs.h.

Referenced by _Function_class_().

State

_In_ POWER_STATE_TYPE _In_ POWER_STATE State

Definition at line 24 of file pofuncs.h.

Type

_In_ POWER_REQUEST_TYPE Type

Definition at line 54 of file pofuncs.h.