SerCx2SystemDmaReceiveCleanupTransactionComplete function (sercx.h)

Article
02/22/2024

The SerCx2SystemDmaReceiveCleanupTransactionComplete method notifies version 2 of the serial framework extension (SerCx2) that the serial controller driver has finished cleaning up the serial controller's hardware state after a system-DMA-receive transaction.

Syntax

void SerCx2SystemDmaReceiveCleanupTransactionComplete(
  [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

None

Remarks

After a system-DMA-receive transaction ends, SerCx2 calls the EvtSerCx2SystemDmaReceiveCleanupTransaction event callback function, if it is implemented, to clean up the serial controller state. In response to this call, the driver should do any clean-up work that is needed; then the driver must call SerCx2SystemDmaReceiveCleanupTransactionComplete to notify SerCx2. SerCx2 expects this notification and does not start the next transaction until it is notified.

The serial controller driver must call SerCx2SystemDmaReceiveCleanupTransactionComplete only in response to a call to the EvtSerCx2SystemDmaReceiveCleanupTransaction function.

For more information, see SerCx2 System-DMA-Receive Transaction.

Requirements

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