SerCx2SystemDmaReceiveGetDmaEnabler function (sercx.h)

Article
02/22/2024

The SerCx2SystemDmaReceiveGetDmaEnabler method gets the DMA enabler for the system DMA controller that is used for system-DMA-receive transactions.

Syntax

WDFDMAENABLER SerCx2SystemDmaReceiveGetDmaEnabler(
  [in] SERCX2SYSTEMDMARECEIVE SystemDmaReceive
);

Parameters

[in] SystemDmaReceive

A SERCX2SYSTEMDMARECEIVE handle to a system-DMA-receive object. The serial controller driver previously called the SerCx2SystemDmaReceiveCreate method to create this object.

Return value

This method returns a WDFDMAENABLER handle to the framework DMA enabler object that represents the system DMA controller that is used for system-DMA-receive transactions.

Remarks

If necessary, your serial controller driver can call this method to configure special features in the system DMA controller. The driver can use the DMA enabler returned by this method to specify DMA settings that were not supplied in the SERCX2_SYSTEM_DMA_RECEIVE_CONFIG structure that the driver previously passed as an input parameter to the SerCx2SystemDmaReceiveCreate method. Or, the driver can use the DMA enabler to change the DMA settings that were previously specified in this structure.

For more information about DMA enabler objects, see Enabling DMA Transactions. For more information about system-DMA-receive transactions, see SerCx2 System-DMA-Receive Transactions.

Requirements

Requirement	Value
Minimum supported client	Available starting with Windows 8.1.
Target Platform	Universal
Header	sercx.h
IRQL	<= DISPATCH_LEVEL