Skip to content

Latest commit

 

History

History
95 lines (67 loc) · 3.72 KB

nf-wdfdmaenabler-wdfdmaenablersetmaximumscattergatherelements.md

File metadata and controls

95 lines (67 loc) · 3.72 KB
Raw
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:wdfdmaenabler.WdfDmaEnablerSetMaximumScatterGatherElements
WdfDmaEnablerSetMaximumScatterGatherElements function (wdfdmaenabler.h)
The WdfDmaEnablerSetMaximumScatterGatherElements method sets the maximum number of scatter/gather elements that a device supports, for a specified DMA enabler object.
wdf\wdfdmaenablersetmaximumscattergatherelements.htm
wdf
02/26/2018
WdfDmaEnablerSetMaximumScatterGatherElements function
DFDmaObjectRef_d9f2c46d-5981-4997-96b6-5a9db0dbfd8d.xml, WdfDmaEnablerSetMaximumScatterGatherElements, WdfDmaEnablerSetMaximumScatterGatherElements method, kmdf.wdfdmaenablersetmaximumscattergatherelements, wdf.wdfdmaenablersetmaximumscattergatherelements, wdfdmaenabler/WdfDmaEnablerSetMaximumScatterGatherElements
wdfdmaenabler.h
Wdf.h
Universal
1.0
DriverCreate, KmdfIrql, KmdfIrql2
Wdf01000.sys (see Framework Library Versioning.)
PASSIVE_LEVEL
Windows
WdfDmaEnablerSetMaximumScatterGatherElements
wdfdmaenabler/WdfDmaEnablerSetMaximumScatterGatherElements
APIRef
kbSyntax
LibDef
Wdf01000.sys
Wdf01000.sys.dll
WdfDmaEnablerSetMaximumScatterGatherElements

WdfDmaEnablerSetMaximumScatterGatherElements function

-description

[Applies to KMDF only]

The WdfDmaEnablerSetMaximumScatterGatherElements method sets the maximum number of scatter/gather elements that a device supports, for a specified DMA enabler object.

-parameters

-param DmaEnabler [in]

A handle to a DMA enabler object that the driver obtained from a previous call to WdfDmaEnablerCreate.

-param MaximumFragments [in]

The maximum number of scatter/gather elements that the driver and device can support.

-remarks

A bug check occurs if the driver supplies an invalid object handle.

If your driver calls WdfDmaEnablerSetMaximumScatterGatherElements, it must do so within the EvtDriverDeviceAdd or EvtDevicePrepareHardware callback function.

If your driver does not call WdfDmaEnablerSetMaximumScatterGatherElements, the framework uses a default value of WDF_DMA_ENABLER_UNLIMITED_FRAGMENTS, which means that there is no limit to the number of scatter/gather elements.

For more information about this method, see Enabling DMA Transactions.

Examples

The following code example sets the maximum number of scatter/gather elements for a specified DMA enabler object.

WdfDmaEnablerSetMaximumScatterGatherElements(
                                             DmaEnabler, 
                                             NIC_MAX_PHYS_BUF_COUNT
                                             );

-see-also

WdfDmaEnablerCreate

WdfDmaEnablerGetMaximumScatterGatherElements