WDF_DMA_SYSTEM_PROFILE_CONFIG_INIT function (wdfdmaenabler.h)

[Applies to KMDF only]

The WDF_DMA_SYSTEM_PROFILE_CONFIG_INIT function initializes a driver's WDF_DMA_SYSTEM_PROFILE_CONFIG structure.

Syntax

void WDF_DMA_SYSTEM_PROFILE_CONFIG_INIT(
       PWDF_DMA_SYSTEM_PROFILE_CONFIG  DmaConfig,
  [in] PHYSICAL_ADDRESS                Address,
  [in] DMA_WIDTH                       DmaWidth,
  [in] PCM_PARTIAL_RESOURCE_DESCRIPTOR DmaDescriptor
);

Parameters

DmaConfig

A pointer to a driver-allocated WDF_DMA_SYSTEM_PROFILE_CONFIG structure.

[in] Address

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

[in] DmaWidth

The width of the register specified by Address.

[in] DmaDescriptor

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

Return value

None

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

See also

WDF_DMA_SYSTEM_PROFILE_CONFIG

WdfDmaEnablerConfigureSystemProfile

WdfDmaEnablerCreate