wdfdmaenabler.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_WDF_DMA_ENABLER_CONFIG
struct	_WDF_DMA_SYSTEM_PROFILE_CONFIG

Macros
#define	WDF_EXTERN_C
#define	WDF_EXTERN_C_START
#define	WDF_EXTERN_C_END
#define	WDF_DMA_ENABLER_UNLIMITED_FRAGMENTS   ((ULONG) -1)

Typedefs
typedef WDF_EXTERN_C_START enum _WDF_DMA_PROFILE	WDF_DMA_PROFILE
typedef enum _WDF_DMA_DIRECTION	WDF_DMA_DIRECTION
typedef EVT_WDF_DMA_ENABLER_FILL *	PFN_WDF_DMA_ENABLER_FILL
typedef EVT_WDF_DMA_ENABLER_FLUSH *	PFN_WDF_DMA_ENABLER_FLUSH
typedef EVT_WDF_DMA_ENABLER_ENABLE *	PFN_WDF_DMA_ENABLER_ENABLE
typedef EVT_WDF_DMA_ENABLER_DISABLE *	PFN_WDF_DMA_ENABLER_DISABLE
typedef EVT_WDF_DMA_ENABLER_SELFMANAGED_IO_START *	PFN_WDF_DMA_ENABLER_SELFMANAGED_IO_START
typedef EVT_WDF_DMA_ENABLER_SELFMANAGED_IO_STOP *	PFN_WDF_DMA_ENABLER_SELFMANAGED_IO_STOP
typedef enum _WDF_DMA_ENABLER_CONFIG_FLAGS	WDF_DMA_ENABLER_CONFIG_FLAGS
typedef struct _WDF_DMA_ENABLER_CONFIG	WDF_DMA_ENABLER_CONFIG
typedef struct _WDF_DMA_ENABLER_CONFIG *	PWDF_DMA_ENABLER_CONFIG
typedef struct _WDF_DMA_SYSTEM_PROFILE_CONFIG	WDF_DMA_SYSTEM_PROFILE_CONFIG
typedef struct _WDF_DMA_SYSTEM_PROFILE_CONFIG *	PWDF_DMA_SYSTEM_PROFILE_CONFIG
typedef _Must_inspect_result_	_IRQL_requires_max_(PASSIVE_LEVEL) WDFAPI NTSTATUS(STDCALL *PFN_WDFDMAENABLERCREATE) (_In_ PWDF_DRIVER_GLOBALS DriverGlobals
typedef _Must_inspect_result_ _In_ WDFDEVICE	Device
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_DMA_ENABLER_CONFIG	Config
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_DMA_ENABLER_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES	Attributes
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_DMA_ENABLER_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFDMAENABLER *	DmaEnablerHandle
typedef _Must_inspect_result_ _In_ WDFDMAENABLER	DmaEnabler
typedef _Must_inspect_result_ _In_ WDFDMAENABLER _In_ PWDF_DMA_SYSTEM_PROFILE_CONFIG	ProfileConfig
typedef _Must_inspect_result_ _In_ WDFDMAENABLER _In_ PWDF_DMA_SYSTEM_PROFILE_CONFIG _In_ WDF_DMA_DIRECTION	ConfigDirection
typedef _In_ WDFDMAENABLER _In_	_When_(MaximumFragments==0, __drv_reportError(MaximumFragments cannot be zero)) size_t MaximumFragments)
typedef _In_ WDFDMAENABLER _In_ WDF_DMA_DIRECTION	DmaDirection

Enumerations
enum	_WDF_DMA_PROFILE {   WdfDmaProfileInvalid = 0, WdfDmaProfilePacket, WdfDmaProfileScatterGather, WdfDmaProfilePacket64,   WdfDmaProfileScatterGather64, WdfDmaProfileScatterGatherDuplex, WdfDmaProfileScatterGather64Duplex, WdfDmaProfileSystem,   WdfDmaProfileSystemDuplex }
enum	_WDF_DMA_DIRECTION { WdfDmaDirectionReadFromDevice = FALSE, WdfDmaDirectionWriteToDevice = TRUE }
enum	_WDF_DMA_ENABLER_CONFIG_FLAGS { WDF_DMA_ENABLER_CONFIG_NO_SGLIST_PREALLOCATION = 0x00000001 }

Functions
typedef	_Function_class_ (EVT_WDF_DMA_ENABLER_FILL) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_DMA_ENABLER_FILL(_In_ WDFDMAENABLER DmaEnabler)
typedef	_Function_class_ (EVT_WDF_DMA_ENABLER_FLUSH) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_DMA_ENABLER_FLUSH(_In_ WDFDMAENABLER DmaEnabler)
typedef	_Function_class_ (EVT_WDF_DMA_ENABLER_ENABLE) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_DMA_ENABLER_ENABLE(_In_ WDFDMAENABLER DmaEnabler)
typedef	_Function_class_ (EVT_WDF_DMA_ENABLER_DISABLE) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_DMA_ENABLER_DISABLE(_In_ WDFDMAENABLER DmaEnabler)
typedef	_Function_class_ (EVT_WDF_DMA_ENABLER_SELFMANAGED_IO_START) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_DMA_ENABLER_SELFMANAGED_IO_START(_In_ WDFDMAENABLER DmaEnabler)
typedef	_Function_class_ (EVT_WDF_DMA_ENABLER_SELFMANAGED_IO_STOP) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_DMA_ENABLER_SELFMANAGED_IO_STOP(_In_ WDFDMAENABLER DmaEnabler)
FORCEINLINE VOID	WDF_DMA_ENABLER_CONFIG_INIT (_Out_ PWDF_DMA_ENABLER_CONFIG Config, _In_ WDF_DMA_PROFILE Profile, _In_ size_t MaximumLength)
FORCEINLINE VOID	WDF_DMA_SYSTEM_PROFILE_CONFIG_INIT (_Out_ PWDF_DMA_SYSTEM_PROFILE_CONFIG DmaConfig, _In_ PHYSICAL_ADDRESS Address, _In_ DMA_WIDTH DmaWidth, _In_ PCM_PARTIAL_RESOURCE_DESCRIPTOR DmaDescriptor)
_Must_inspect_result_	_IRQL_requires_max_ (PASSIVE_LEVEL) FORCEINLINE NTSTATUS WdfDmaEnablerCreate(_In_ WDFDEVICE Device
typedef	_IRQL_requires_max_ (DISPATCH_LEVEL) WDFAPI size_t(STDCALL *PFN_WDFDMAENABLERGETMAXIMUMLENGTH)(_In_ PWDF_DRIVER_GLOBALS DriverGlobals
_In_	_When_ (MaximumFragments==0, __drv_reportError(MaximumFragments cannot be zero)) size_t MaximumFragments)

Macro Definition Documentation

WDF_DMA_ENABLER_UNLIMITED_FRAGMENTS

#define WDF_DMA_ENABLER_UNLIMITED_FRAGMENTS   ((ULONG) -1)

Definition at line 153 of file wdfdmaenabler.h.

WDF_EXTERN_C

#define WDF_EXTERN_C

Definition at line 40 of file wdfdmaenabler.h.

WDF_EXTERN_C_END

#define WDF_EXTERN_C_END

Definition at line 42 of file wdfdmaenabler.h.

WDF_EXTERN_C_START

#define WDF_EXTERN_C_START

Definition at line 41 of file wdfdmaenabler.h.

Typedef Documentation

_IRQL_requires_max_

typedef _Must_inspect_result_ _IRQL_requires_max_(PASSIVE_LEVEL) WDFAPI NTSTATUS(STDCALL *PFN_WDFDMAENABLERCONFIGURESYSTEMPROFILE)(_In_ PWDF_DRIVER_GLOBALS DriverGlobals

Definition at line 299 of file wdfdmaenabler.h.

_When_

typedef _In_ WDFDMAENABLER _In_ _When_(MaximumFragments==0, __drv_reportError(MaximumFragments cannot be zero)) size_t MaximumFragments)

Definition at line 431 of file wdfdmaenabler.h.

Attributes

_Must_inspect_result_ _In_ PWDF_DMA_ENABLER_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES Attributes

Definition at line 306 of file wdfdmaenabler.h.

Config

_Must_inspect_result_ _In_ PWDF_DMA_ENABLER_CONFIG Config

Definition at line 306 of file wdfdmaenabler.h.

ConfigDirection

_Must_inspect_result_ _In_ PWDF_DMA_SYSTEM_PROFILE_CONFIG _In_ WDF_DMA_DIRECTION ConfigDirection

Initial value:

{
    return ((PFN_WDFDMAENABLERCONFIGURESYSTEMPROFILE) WdfFunctions[WdfDmaEnablerConfigureSystemProfileTableIndex])(WdfDriverGlobals, DmaEnabler, ProfileConfig, ConfigDirection)

Definition at line 345 of file wdfdmaenabler.h.

Device

typedef _Must_inspect_result_ _In_ WDFDEVICE Device

Definition at line 306 of file wdfdmaenabler.h.

DmaDirection

_In_ WDFDMATRANSACTION _In_ WDF_DMA_DIRECTION DmaDirection

Initial value:

{
    return ((PFN_WDFDMAENABLERGETFRAGMENTLENGTH) WdfFunctions[WdfDmaEnablerGetFragmentLengthTableIndex])(WdfDriverGlobals, DmaEnabler, DmaDirection)

Definition at line 460 of file wdfdmaenabler.h.

DmaEnabler

typedef _In_ WDFDMAENABLER DmaEnabler

Definition at line 345 of file wdfdmaenabler.h.

DmaEnablerHandle

* DmaEnablerHandle

Initial value:

{
    return ((PFN_WDFDMAENABLERCREATE) WdfFunctions[WdfDmaEnablerCreateTableIndex])(WdfDriverGlobals, Device, Config, Attributes, DmaEnablerHandle)

Definition at line 306 of file wdfdmaenabler.h.

PFN_WDF_DMA_ENABLER_DISABLE

typedef EVT_WDF_DMA_ENABLER_DISABLE* PFN_WDF_DMA_ENABLER_DISABLE

Definition at line 124 of file wdfdmaenabler.h.

PFN_WDF_DMA_ENABLER_ENABLE

typedef EVT_WDF_DMA_ENABLER_ENABLE* PFN_WDF_DMA_ENABLER_ENABLE

Definition at line 111 of file wdfdmaenabler.h.

PFN_WDF_DMA_ENABLER_FILL

typedef EVT_WDF_DMA_ENABLER_FILL* PFN_WDF_DMA_ENABLER_FILL

Definition at line 85 of file wdfdmaenabler.h.

PFN_WDF_DMA_ENABLER_FLUSH

typedef EVT_WDF_DMA_ENABLER_FLUSH* PFN_WDF_DMA_ENABLER_FLUSH

Definition at line 98 of file wdfdmaenabler.h.

PFN_WDF_DMA_ENABLER_SELFMANAGED_IO_START

typedef EVT_WDF_DMA_ENABLER_SELFMANAGED_IO_START* PFN_WDF_DMA_ENABLER_SELFMANAGED_IO_START

Definition at line 137 of file wdfdmaenabler.h.

PFN_WDF_DMA_ENABLER_SELFMANAGED_IO_STOP

typedef EVT_WDF_DMA_ENABLER_SELFMANAGED_IO_STOP* PFN_WDF_DMA_ENABLER_SELFMANAGED_IO_STOP

Definition at line 150 of file wdfdmaenabler.h.

ProfileConfig

_Must_inspect_result_ _In_ PWDF_DMA_SYSTEM_PROFILE_CONFIG ProfileConfig

Definition at line 345 of file wdfdmaenabler.h.

PWDF_DMA_ENABLER_CONFIG

typedef struct _WDF_DMA_ENABLER_CONFIG * PWDF_DMA_ENABLER_CONFIG

PWDF_DMA_SYSTEM_PROFILE_CONFIG

typedef struct _WDF_DMA_SYSTEM_PROFILE_CONFIG * PWDF_DMA_SYSTEM_PROFILE_CONFIG

WDF_DMA_DIRECTION

typedef enum _WDF_DMA_DIRECTION WDF_DMA_DIRECTION

WDF_DMA_ENABLER_CONFIG

typedef struct _WDF_DMA_ENABLER_CONFIG WDF_DMA_ENABLER_CONFIG

WDF_DMA_ENABLER_CONFIG_FLAGS

typedef enum _WDF_DMA_ENABLER_CONFIG_FLAGS WDF_DMA_ENABLER_CONFIG_FLAGS

WDF_DMA_PROFILE

typedef WDF_EXTERN_C_START enum _WDF_DMA_PROFILE WDF_DMA_PROFILE

WDF_DMA_SYSTEM_PROFILE_CONFIG

typedef struct _WDF_DMA_SYSTEM_PROFILE_CONFIG WDF_DMA_SYSTEM_PROFILE_CONFIG

Enumeration Type Documentation

_WDF_DMA_DIRECTION

enum _WDF_DMA_DIRECTION

Enumerator
WdfDmaDirectionReadFromDevice
WdfDmaDirectionWriteToDevice

Definition at line 64 of file wdfdmaenabler.h.

                                {
    WdfDmaDirectionReadFromDevice = FALSE,
    WdfDmaDirectionWriteToDevice = TRUE,
} WDF_DMA_DIRECTION;

_WDF_DMA_ENABLER_CONFIG_FLAGS

enum _WDF_DMA_ENABLER_CONFIG_FLAGS

Enumerator
WDF_DMA_ENABLER_CONFIG_NO_SGLIST_PREALLOCATION

Definition at line 155 of file wdfdmaenabler.h.

                                           {
    //
    // This flag only applies to the following DMA profiles:
    //  WdfDmaProfileScatterGather,
    //  WdfDmaProfileScatterGather64,
    //  WdfDmaProfileScatterGatherDuplex and
    //  WdfDmaProfileScatterGather64Duplex
    //
    // When this flag is not set and the profile is one of the above, WDF
    // creates a SGLookasideList used by this DMA adapter's transaction
    // objects. The SGLookasideList is initialized to allow the max specified
    // transfer length. When the transaction is executed, WDF calls the WDM
    // DMA's BuildScatterGatherList entry function. Forward progress drivers
    // must use this option. This is the default option.
    //
    // When this flag is set and the profile is one of the above, WDF
    // does not create a SGLookasideList. When the transaction is executed,
    // WDF calls the WDM DMA's GetScatterGatherList entry function.
    //
    WDF_DMA_ENABLER_CONFIG_NO_SGLIST_PREALLOCATION  = 0x00000001,
} WDF_DMA_ENABLER_CONFIG_FLAGS;

_WDF_DMA_PROFILE

enum _WDF_DMA_PROFILE

Enumerator
WdfDmaProfileInvalid
WdfDmaProfilePacket
WdfDmaProfileScatterGather
WdfDmaProfilePacket64
WdfDmaProfileScatterGather64
WdfDmaProfileScatterGatherDuplex
WdfDmaProfileScatterGather64Duplex
WdfDmaProfileSystem
WdfDmaProfileSystemDuplex

Definition at line 52 of file wdfdmaenabler.h.

                              {
    WdfDmaProfileInvalid = 0,
    WdfDmaProfilePacket,
    WdfDmaProfileScatterGather,
    WdfDmaProfilePacket64,
    WdfDmaProfileScatterGather64,
    WdfDmaProfileScatterGatherDuplex,
    WdfDmaProfileScatterGather64Duplex,
    WdfDmaProfileSystem,
    WdfDmaProfileSystemDuplex,
} WDF_DMA_PROFILE;

Function Documentation

_Function_class_() [1/6]

typedef _Function_class_

(

EVT_WDF_DMA_ENABLER_FILL

)

_Function_class_() [2/6]

typedef _Function_class_

(

EVT_WDF_DMA_ENABLER_FLUSH

)

_Function_class_() [3/6]

typedef _Function_class_

(

EVT_WDF_DMA_ENABLER_ENABLE

)

_Function_class_() [4/6]

typedef _Function_class_

(

EVT_WDF_DMA_ENABLER_DISABLE

)

_Function_class_() [5/6]

typedef _Function_class_

(

EVT_WDF_DMA_ENABLER_SELFMANAGED_IO_START

)

_Function_class_() [6/6]

typedef _Function_class_

(

EVT_WDF_DMA_ENABLER_SELFMANAGED_IO_STOP

)

_IRQL_requires_max_() [1/2]

_Must_inspect_result_ _IRQL_requires_max_

(

PASSIVE_LEVEL

)

Definition at line 64 of file Messaging.c.

{
    PFLT_SERVER_PORT_OBJECT PortObject;
    NTSTATUS Status;

    /* The caller must allow at least one connection */
    if (MaxConnections == 0)
    {
        return STATUS_INVALID_PARAMETER;
    }

    /* The request must be for a kernel handle */
    if (!(ObjectAttributes->Attributes & OBJ_KERNEL_HANDLE))
    {
        return STATUS_INVALID_PARAMETER;
    }

    /*
     * Get rundown protection on the target to stop the owner
     * from unloading whilst this port object is open. It gets
     * removed in the FltpServerPortClose callback
     */
    Status = FltObjectReference(Filter);
    if (!NT_SUCCESS(Status))
    {
        return Status;
    }

    /* Create the server port object for this filter */
    Status = ObCreateObject(KernelMode,
                            ServerPortObjectType,
                            ObjectAttributes,
                            KernelMode,
                            NULL,
                            sizeof(FLT_SERVER_PORT_OBJECT),
                            0,
                            0,
                            (PVOID *)&PortObject);
    if (NT_SUCCESS(Status))
    {
        /* Zero out the struct */
        RtlZeroMemory(PortObject, sizeof(FLT_SERVER_PORT_OBJECT));

        /* Increment the ref count on the target filter */
        FltpObjectPointerReference((PFLT_OBJECT)Filter);

        /* Setup the filter port object */
        PortObject->Filter = Filter;
        PortObject->ConnectNotify = ConnectNotifyCallback;
        PortObject->DisconnectNotify = DisconnectNotifyCallback;
        PortObject->MessageNotify = MessageNotifyCallback;
        PortObject->Cookie = ServerPortCookie;
        PortObject->MaxConnections = MaxConnections;

        /* Insert the object */
        Status = ObInsertObject(PortObject,
                                NULL,
                                STANDARD_RIGHTS_ALL | FILE_READ_DATA,
                                0,
                                NULL,
                                (PHANDLE)ServerPort);
        if (NT_SUCCESS(Status))
        {
            /* Lock the connection list */
            ExAcquireFastMutex(&Filter->ConnectionList.mLock);

            /* Add the new port object to the connection list and increment the count */
            InsertTailList(&Filter->ConnectionList.mList, &PortObject->FilterLink);
            Filter->ConnectionList.mCount++;

            /* Unlock the connection list*/
            ExReleaseFastMutex(&Filter->ConnectionList.mLock);
        }
    }

    if (!NT_SUCCESS(Status))
    {
        /* Allow the filter to be cleaned up */
        FltObjectDereference(Filter);
    }

    return Status;
}

_IRQL_requires_max_() [2/2]

typedef _IRQL_requires_max_

(

DISPATCH_LEVEL

)

Definition at line 382 of file wdfdmaenabler.h.

{
    return ((PFN_WDFDMAENABLERGETMAXIMUMLENGTH) WdfFunctions[WdfDmaEnablerGetMaximumLengthTableIndex])(WdfDriverGlobals, DmaEnabler);
}

_When_()

_In_ _When_	(	MaximumFragments	= = 0,
		__drv_reportError(MaximumFragments cannot be zero)
	)

Definition at line 442 of file wdfdmaenabler.h.

{
    ((PFN_WDFDMAENABLERSETMAXIMUMSCATTERGATHERELEMENTS) WdfFunctions[WdfDmaEnablerSetMaximumScatterGatherElementsTableIndex])(WdfDriverGlobals, DmaEnabler, MaximumFragments);
}

WDF_DMA_ENABLER_CONFIG_INIT()

FORCEINLINE VOID WDF_DMA_ENABLER_CONFIG_INIT	(	_Out_ PWDF_DMA_ENABLER_CONFIG	Config,
		_In_ WDF_DMA_PROFILE	Profile,
		_In_ size_t	MaximumLength
	)

Definition at line 224 of file wdfdmaenabler.h.

{
    RtlZeroMemory(Config, sizeof(WDF_DMA_ENABLER_CONFIG));

    Config->Size = sizeof(WDF_DMA_ENABLER_CONFIG);
    Config->Profile = Profile;
    Config->MaximumLength = MaximumLength;
}

Referenced by if().

WDF_DMA_SYSTEM_PROFILE_CONFIG_INIT()

FORCEINLINE VOID WDF_DMA_SYSTEM_PROFILE_CONFIG_INIT	(	_Out_ PWDF_DMA_SYSTEM_PROFILE_CONFIG	DmaConfig,
		_In_ PHYSICAL_ADDRESS	Address,
		_In_ DMA_WIDTH	DmaWidth,
		_In_ PCM_PARTIAL_RESOURCE_DESCRIPTOR	DmaDescriptor
	)

Definition at line 279 of file wdfdmaenabler.h.

{
    RtlZeroMemory(DmaConfig, sizeof(WDF_DMA_SYSTEM_PROFILE_CONFIG));

    DmaConfig->Size = sizeof(WDF_DMA_SYSTEM_PROFILE_CONFIG);
    DmaConfig->DeviceAddress = Address;
    DmaConfig->DmaWidth = DmaWidth;
    DmaConfig->DmaDescriptor = DmaDescriptor;
}