WDF_DMA_SYSTEM_PROFILE_CONFIG_INIT function

[Applies to KMDF only]

The WDF_DMA_SYSTEM_PROFILE_CONFIG_INIT function initializes a driver's WDF_DMA_SYSTEM_PROFILE_CONFIG structure.

Syntax

__inline
void WDF_DMA_SYSTEM_PROFILE_CONFIG_INIT(
  _Out_ PWDF_DMA_SYSTEM_PROFILE_CONFIG  Config,
  _In_  PHYSICAL_ADDRESS                Address,
  _In_  DMA_WIDTH                       DmaWidth,
  _In_  PCM_PARTIAL_RESOURCE_DESCRIPTOR DmaDescriptor
);

Parameters

DmaConfig

TBD

Address

The translated address of the register to target for DMA. For more information, see Remarks.

DmaWidth

The width of the register specified by Address.

DmaDescriptor

The translated resource descriptor for the DMA channel assigned the device during EvtDevicePrepareHardware.

Return Value

This function does not return a value.

Remarks

Typically, a driver calls WDF_DMA_SYSTEM_PROFILE_CONFIG_INIT from within its EvtDevicePrepareHardware callback function. A driver must call the WDF_DMA_SYSTEM_PROFILE_CONFIG_INIT function before calling WdfDmaEnablerConfigureSystemProfile.

Depending on the System on a Chip (SoC) design, the Address parameter might have a different meaning. For example if DMA uses dedicated transfer ports on the device, Address might indicate the port to which DMA writes occur.

For more information about creating a system-mode DMA enabler, see Supporting System-Mode DMA.

Examples

For a code example that uses WDF_DMA_SYSTEM_PROFILE_CONFIG_INIT, see WdfDmaEnablerConfigureSystemProfile.

Requirements

   
Windows version Windows 8
Target Platform Universal
Minimum KMDF version 1.11
Header wdfdmaenabler.h (include Wdf.h)
Library NtosKrnl.exe

See Also

WdfDmaEnablerConfigureSystemProfile

WDF_DMA_SYSTEM_PROFILE_CONFIG

WdfDmaEnablerConfigureSystemProfile

Send comments about this topic to Microsoft