#include "fxdmapch.hpp"

Include dependency graph for fxdmaenablerapi.cpp:

Functions
_Must_inspect_result_	__drv_maxIRQL (PASSIVE_LEVEL) WDFAPI NTSTATUS NTAPI WDFEXPORT(WdfDmaEnablerCreate)(__in PWDF_DRIVER_GLOBALS DriverGlobals

	FxObjectHandleGetPtrAndGlobals (GetFxDriverGlobals(DriverGlobals), Device, FX_TYPE_DEVICE_BASE,(PVOID *) &pDevice, &pFxDriverGlobals)

	if (!NT_SUCCESS(status))

	FxPointerNotNull (pFxDriverGlobals, DmaEnablerHandle)

	FxPointerNotNull (pFxDriverGlobals, Config)

	if (Attributes !=NULL &&Attributes->ParentObject !=NULL)

	if (Config->Size !=expectedSize)

	if (Config->Size< sizeof(WDF_DMA_ENABLER_CONFIG))

	switch (Config->Profile)

	if (Config->MaximumLength==0)

	if (pDmaEnabler==NULL)

	if (NT_SUCCESS(status))

	__drv_maxIRQL (DISPATCH_LEVEL) WDFAPI size_t NTAPI WDFEXPORT(WdfDmaEnablerGetMaximumLength)(__in PWDF_DRIVER_GLOBALS DriverGlobals

	FxObjectHandleGetPtr (GetFxDriverGlobals(DriverGlobals), DmaEnabler, FX_TYPE_DMA_ENABLER,(PVOID *) &pDmaEnabler)

return pDmaEnabler	GetMaximumLength ()

return pDmaEnabler	GetMaxSGElements ()

__in WDFDMAENABLER __in	__drv_when (MaximumElements==0, __drv_reportError(MaximumElements cannot be zero)) size_t MaximumElements)

	FxObjectHandleGetPtrAndGlobals (GetFxDriverGlobals(DriverGlobals), DmaEnabler, FX_TYPE_DMA_ENABLER,(PVOID *) &pDmaEnabler, &pFxDriverGlobals)

	switch (DmaDirection)

	if (ProfileConfig==NULL)

	if (ProfileConfig->Size !=sizeof(WDF_DMA_SYSTEM_PROFILE_CONFIG))

	if (ProfileConfig->DmaDescriptor==NULL)

	if (ConfigDirection !=WdfDmaDirectionReadFromDevice &&ConfigDirection !=WdfDmaDirectionWriteToDevice)

Variables
_Must_inspect_result_ __in WDFDEVICE	Device

_Must_inspect_result_ __in WDFDEVICE __in WDF_DMA_ENABLER_CONFIG *	Config

_Must_inspect_result_ __in WDFDEVICE __in WDF_DMA_ENABLER_CONFIG __in_opt WDF_OBJECT_ATTRIBUTES *	Attributes

_Must_inspect_result_ __in WDFDEVICE __in WDF_DMA_ENABLER_CONFIG __in_opt WDF_OBJECT_ATTRIBUTES __out WDFDMAENABLER *	DmaEnablerHandle

FxDeviceBase *	pDevice

NTSTATUS	status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL)

WDFDMAENABLER	handle

PFX_DRIVER_GLOBALS	pFxDriverGlobals

FxObject *	pParent

WDF_DMA_ENABLER_CONFIG	dmaConfig

	else

	pDmaEnabler

__in WDFDMAENABLER	DmaEnabler

__in WDFDMAENABLER __in WDF_DMA_DIRECTION	DmaDirection

size_t	length

return	adapter

_Must_inspect_result_ __in WDFDMAENABLER __in PWDF_DMA_SYSTEM_PROFILE_CONFIG	ProfileConfig

_Must_inspect_result_ __in WDFDMAENABLER __in PWDF_DMA_SYSTEM_PROFILE_CONFIG __in WDF_DMA_DIRECTION	ConfigDirection

Function Documentation

◆ __drv_maxIRQL() [1/2]

__drv_maxIRQL ( DISPATCH_LEVEL )

◆ __drv_maxIRQL() [2/2]

_Must_inspect_result_ __drv_maxIRQL ( PASSIVE_LEVEL )

◆ __drv_when()

__in WDFDMAENABLER __in __drv_when	(	MaximumElements	= `= 0`,
		__drv_reportError(MaximumElements cannot be zero)
	)

Definition at line 328 of file fxdmaenablerapi.cpp.

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals;
    FxDmaEnabler * pDmaEnabler;
    NTSTATUS      status;
 
    FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals),
                                   DmaEnabler,
                                   FX_TYPE_DMA_ENABLER,
                                   (PVOID *) &pDmaEnabler,
                                   &pFxDriverGlobals);
 
    status = FxVerifierCheckIrqlLevel(pFxDriverGlobals, PASSIVE_LEVEL);
    if (!NT_SUCCESS(status)) {
        return;
    }
 
    if (MaximumElements == 0) {
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
            "Cannot set MaximumElements of zero on WDFDMAENABLER %p",
            DmaEnabler);
        return;
    }
 
    pDmaEnabler->SetMaxSGElements(MaximumElements);
}

◆ FxObjectHandleGetPtr()

FxObjectHandleGetPtr	(	GetFxDriverGlobals(DriverGlobals)	,
		DmaEnabler	,
		FX_TYPE_DMA_ENABLER	,
		(PVOID *) &	pDmaEnabler
	)

Referenced by if().

◆ FxObjectHandleGetPtrAndGlobals() [1/2]

FxObjectHandleGetPtrAndGlobals	(	GetFxDriverGlobals(DriverGlobals)	,
		Device	,
		FX_TYPE_DEVICE_BASE	,
		(PVOID *) &	pDevice,
		&	pFxDriverGlobals
	)

Referenced by __drv_when().

◆ FxObjectHandleGetPtrAndGlobals() [2/2]

FxObjectHandleGetPtrAndGlobals	(	GetFxDriverGlobals(DriverGlobals)	,
		DmaEnabler	,
		FX_TYPE_DMA_ENABLER	,
		(PVOID *) &	pDmaEnabler,
		&	pFxDriverGlobals
	)

◆ FxPointerNotNull() [1/2]

FxPointerNotNull	(	pFxDriverGlobals	,
		Config
	)

◆ FxPointerNotNull() [2/2]

FxPointerNotNull	(	pFxDriverGlobals	,
		DmaEnablerHandle
	)

◆ GetMaximumLength()

return pDmaEnabler GetMaximumLength ( )

◆ GetMaxSGElements()

return pDmaEnabler GetMaxSGElements ( )

◆ if() [1/11]

if ( ! NT_SUCCESSstatus )

Definition at line 71 of file fxdmaenablerapi.cpp.

                             {
        return status;
    }

◆ if() [2/11]

if ( Attributes ! = NULL && Attributes->ParentObject != NULL )

Definition at line 86 of file fxdmaenablerapi.cpp.

                                                                {
        FxObjectHandleGetPtr(pFxDriverGlobals,
                             Attributes->ParentObject,
                             FX_TYPE_OBJECT,
                             (PVOID*)&pParent);
 
        if (pFxDriverGlobals->IsVersionGreaterThanOrEqualTo(1,11)) {
            FxDeviceBase * pSearchDevice;
 
            //
            // If a parent object is passed-in it must be descendent of device.
            // DmaEnabler stores device and uses it during dispose
            // (to remove it from dmaenabler list maintained at device level),
            // so DmaEnabler cannot outlive device.
            //
 
            pSearchDevice = FxDeviceBase::_SearchForDevice(pParent, NULL);
 
            if (pSearchDevice == NULL) {
                status = STATUS_WDF_OBJECT_ATTRIBUTES_INVALID;
 
                DoTraceLevelMessage(
                    pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                    "Attributes->ParentObject 0x%p must have WDFDEVICE as an "
                    "eventual ancestor, %!STATUS!",
                    Attributes->ParentObject, status);
 
                return status;
            }
            else if (pSearchDevice != pDevice) {
                status = STATUS_WDF_OBJECT_ATTRIBUTES_INVALID;
 
                DoTraceLevelMessage(
                    pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                    "Attributes->ParentObject 0x%p ancestor is WDFDEVICE %p, but "
                    "not the same WDFDEVICE 0x%p passed to WdfDmaEnablerCreate, "
                    "%!STATUS!",
                    Attributes->ParentObject, pSearchDevice->GetHandle(),
                    Device, status);
 
                return status;
            }
        }
        else {
            //
            // For < 1.11 drivers we only allow pDevice to be the parent
            // since that is what we were blindly setting the parent to.
            //
            // Using the passed-in parent for such drivers could cause
            // side-effects such as earlier deletion of DmaEnabler object. So
            // we don't do that.
            //
            // We cause this verifier breakpoint to warn downlevel drivers
            // that the parent they passed in gets ignored.
            //
            if (pParent != pDevice) {
                DoTraceLevelMessage(
                    pFxDriverGlobals, TRACE_LEVEL_WARNING, TRACINGDMA,
                    "For drivers bound to version <= 1.9 "
                    "WdfDmaEnablerCreate uses WDFDEVICE as the "
                    "parent object for the dma enabler object. "
                    "Attributes->ParentObject 0x%p, which is different from "
                    "WDFDEVICE 0x%p, gets ignored. Please note that DmaEnabler "
                    "would be disposed only when device is disposed.",
                    Attributes->ParentObject, Device);
 
                if (pFxDriverGlobals->IsDownlevelVerificationEnabled()) {
                    FxVerifierDbgBreakPoint(pFxDriverGlobals);
                }
            }
 
            pParent = pDevice;
        }
    }

◆ if() [3/11]

if ( Config-> MaximumLength = = 0 )

Definition at line 223 of file fxdmaenablerapi.cpp.

                                    {
        status = STATUS_INVALID_PARAMETER;
 
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
            "Config MaximumLength of zero is invalid, %!STATUS!",
            status);
 
        return status;
    }

◆ if() [4/11]

if ( Config->Size ! = expectedSize )

Definition at line 169 of file fxdmaenablerapi.cpp.

                                          {
            status = STATUS_INFO_LENGTH_MISMATCH;
 
            DoTraceLevelMessage(
                pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                "WDF_DMA_ENABLER_CONFIG Size 0x%x, expected 0x%x, %!STATUS!",
                Config->Size, expectedSize, status);
 
            return status;
        }

◆ if() [5/11]

if ( )

Definition at line 184 of file fxdmaenablerapi.cpp.

                                                           {
            //
            // Init new fields to default values.
            //
            WDF_DMA_ENABLER_CONFIG_INIT(&dmaConfig,
                                        Config->Profile,
                                        Config->MaximumLength);
            //
            // Copy over existing fields and readjust the struct size.
            //
            RtlCopyMemory(&dmaConfig, Config, Config->Size);
            dmaConfig.Size = sizeof(dmaConfig);
 
            //
            // Use new config structure from now on.
            //
            Config = &dmaConfig;
        }

◆ if() [6/11]

if ( ConfigDirection ! = WdfDmaDirectionReadFromDevice && ConfigDirection != WdfDmaDirectionWriteToDevice )

Definition at line 515 of file fxdmaenablerapi.cpp.

                                                         {
        status = STATUS_INVALID_PARAMETER;
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
            "ConfigDirection 0x%x is an invalid value, %!STATUS!",
            ConfigDirection, status);
        return status;
    }

◆ if() [7/11]

if ( NT_SUCCESS(status) )

Definition at line 255 of file fxdmaenablerapi.cpp.

                            {
        //
        // Ok: start this DmaEnabler.
        //
        status = pDmaEnabler->Initialize( Config, pDevice );
    }

◆ if() [8/11]

if ( pDmaEnabler = = NULL )

Definition at line 240 of file fxdmaenablerapi.cpp.

                             {
        status = STATUS_INSUFFICIENT_RESOURCES;
 
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                            "Could not allocate memory for a WDFDMAENABLER, "
                            "%!STATUS!", status);
 
        return status;
    }

◆ if() [9/11]

if ( ProfileConfig-> DmaDescriptor = = NULL )

Definition at line 502 of file fxdmaenablerapi.cpp.

    {
        status = STATUS_INVALID_PARAMETER;
 
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                            "ProfileConfig (%p) may not have NULL DmaDescriptor, %!STATUS!",
                            ProfileConfig, status);
 
        FxVerifierDbgBreakPoint(pFxDriverGlobals);
 
        return status;
    }

◆ if() [10/11]

if ( ProfileConfig->Size ! = sizeof(WDF_DMA_SYSTEM_PROFILE_CONFIG) )

Definition at line 489 of file fxdmaenablerapi.cpp.

    {
        status = STATUS_INFO_LENGTH_MISMATCH;
 
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                            "WDF_DMA_SYSTEM_PROFILE_CONFIG Size 0x%x, expected 0x%x, %!STATUS!",
                            ProfileConfig->Size, sizeof(WDF_DMA_SYSTEM_PROFILE_CONFIG), status);
 
        FxVerifierDbgBreakPoint(pFxDriverGlobals);
 
        return status;
    }

◆ if() [11/11]

if ( ProfileConfig = = NULL )

Definition at line 479 of file fxdmaenablerapi.cpp.

    {
        status = STATUS_INVALID_PARAMETER;
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                            "ProfileConfig must be non-null, %!STATUS!",
                            status);
        FxVerifierDbgBreakPoint(pFxDriverGlobals);
        return status;
    }

◆ switch() [1/2]

switch ( Config-> Profile )

Definition at line 204 of file fxdmaenablerapi.cpp.

                             {
        case WdfDmaProfilePacket:
        case WdfDmaProfileScatterGather:
        case WdfDmaProfilePacket64:
        case WdfDmaProfileScatterGather64:
        case WdfDmaProfileScatterGather64Duplex:
        case WdfDmaProfileScatterGatherDuplex:
        case WdfDmaProfileSystem:
        case WdfDmaProfileSystemDuplex:
            break;
        default:
            status = STATUS_INVALID_PARAMETER;
            DoTraceLevelMessage(
                pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                "DMA Profile value %d is unknown, %!STATUS!",
                Config->Profile, status);
            return status;
    }

◆ switch() [2/2]

switch ( DmaDirection )

Definition at line 381 of file fxdmaenablerapi.cpp.

                          {
 
    case WdfDmaDirectionReadFromDevice:
        length = pDmaEnabler->GetReadDmaDescription()->MaximumFragmentLength;
        break;
 
    case WdfDmaDirectionWriteToDevice:
        length = pDmaEnabler->GetWriteDmaDescription()->MaximumFragmentLength;
        break;
 
    default:
        length = 0;
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                            "Invalid value for Dma direction %d, %p",
                            DmaDirection, DmaEnabler);
        FxVerifierDbgBreakPoint(pFxDriverGlobals);
        break;
    }