EVT_SERCX2_SYSTEM_DMA_RECEIVE_CLEANUP_TRANSACTION callback function (sercx.h)

The EvtSerCx2SystemDmaReceiveCleanupTransaction event callback function is called by version 2 of the serial framework extension (SerCx2) to clean up the serial controller state after a system-DMA-receive transaction ends.

Syntax

EVT_SERCX2_SYSTEM_DMA_RECEIVE_CLEANUP_TRANSACTION EvtSercx2SystemDmaReceiveCleanupTransaction;

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

Your serial controller driver can, as an option, implement this function. If implemented, the driver registers the function in the SerCx2SystemDmaReceiveCreate call that creates the system-DMA-receive object.

Your serial controller driver should implement an EvtSerCx2SystemDmaReceiveCleanupTransaction function if it needs to clean up the serial controller state at the end of a system-DMA-receive transaction. SerCx2 calls this function, if it is implemented, after a system-DMA-receive transaction ends. In response to the EvtSerCx2SystemDmaReceiveCleanupTransaction call, the serial controller driver must call the SerCx2SystemDmaReceiveCleanupTransactionComplete method to notify SerCx2 after the clean-up work is done.

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

Examples

To define an EvtSerCx2SystemDmaReceiveCleanupTransaction callback function, you must first provide a function declaration that identifies the type of callback function you're defining. Windows provides a set of callback function types for drivers. Declaring a function using the callback function types helps Code Analysis for Drivers, Static Driver Verifier (SDV), and other verification tools find errors, and it's a requirement for writing drivers for the Windows operating system.

For example, to define an EvtSerCx2SystemDmaReceiveCleanupTransaction callback function that is named MySystemDmaReceiveCleanupTransaction, use the EVT_SERCX2_SYSTEM_DMA_RECEIVE_CLEANUP_TRANSACTION function type, as shown in this code example:

EVT_SERCX2_SYSTEM_DMA_RECEIVE_CLEANUP_TRANSACTION  MySystemDmaReceiveCleanupTransaction;

Then, implement your callback function as follows:

_Use_decl_annotations_
VOID
  MySystemDmaReceiveCleanupTransaction(
    SERCX2SYSTEMDMARECEIVE  SystemDmaReceive
    )
  {...}

The EVT_SERCX2_SYSTEM_DMA_RECEIVE_CLEANUP_TRANSACTION function type is defined in the Sercx.h header file. To more accurately identify errors when you run the code analysis tools, be sure to add the Use_decl_annotations annotation to your function definition. The Use_decl_annotations annotation ensures that the annotations that are applied to the EVT_SERCX2_SYSTEM_DMA_RECEIVE_CLEANUP_TRANSACTION function type in the header file are used. For more information about the requirements for function declarations, see Declaring Functions by Using Function Role Types for KMDF Drivers. For more information about Use_decl_annotations, see Annotating Function Behavior.

Requirements

See also

SERCX2SYSTEMDMARECEIVE

SerCx2SystemDmaReceiveCleanupTransactionComplete

SerCx2SystemDmaReceiveCreate