DMA_ABORT_HANDLER callback function (netdma.h)

Article
02/22/2024

Note The NetDMA interface is not supported

in Windows 8 and later.

The ProviderAbortDma function cancels any DMA transfers that are associated with a DMA channel.

Syntax

DMA_ABORT_HANDLER DmaAbortHandler;

NTSTATUS DmaAbortHandler(
  [in] PVOID ProviderChannelContext
)
{...}

Parameters

[in] ProviderChannelContext

A pointer that identifies a DMA channel's context area. The DMA provider returned this handle to NetDMA at the location that is specified in the pProviderChannelContext parameter of the ProviderAllocateDmaChannel function.

Return value

ProviderAbortDma returns one of the following status values:

Return code	Description
STATUS_SUCCESS	The operation completed successfully.
STATUS_UNSUCCESSFUL	The operation failed for unspecified reasons.

Remarks

The ProviderAbortDma function is an optional function for NetDMA providers. The NetDMA interface can call a DMA provider driver's ProviderAbortDma function, if any, to abort all DMA transfers that have been scheduled on a DMA channel.

In ProviderAbortDma, the DMA provider should terminate the transfer immediately without completing the transfer of the data that is associated with the current DMA descriptor. If completion status reporting is enabled, the DMA engine writes the NetDmaTransferStatusHalted status in the address that is specified in the CompletionVirtualAddress and CompletionPhysicalAddress members in the NET_DMA_CHANNEL_PARAMETERS structure.

After the abort operation completes, the DMA channel must be ready for the NetDMA interface to call the ProviderStartDma function. The NetDMA interface will not call the ProviderAppendDma function until after the transfer is restarted.

NetDMA calls ProviderAbortDma at IRQL <= DISPATCH_LEVEL.

Requirements

Requirement	Value
Minimum supported client	Supported for NetDMA 1.0 drivers in Windows Vista.
Target Platform	Windows
Header	netdma.h (include Netdma.h)
IRQL	<= DISPATCH_LEVEL