NdisMFreeNetBufferSGList function

Bus-master miniport drivers call the NdisMFreeNetBufferSGList function to free scatter/gather list resources that were allocated by calling the NdisMAllocateNetBufferSGList function.

Syntax


VOID NdisMFreeNetBufferSGList(
  _In_  NDIS_HANDLE NdisMiniportDmaHandle,
  _In_  PSCATTER_GATHER_LIST pSGL,
  _In_  PNET_BUFFER NetBuffer
);

Parameters

NdisMiniportDmaHandle [in]

A handle to a context area that NDIS uses to manage a DMA resource. The caller obtained this handle by calling the NdisMRegisterScatterGatherDma function.

pSGL [in]

A pointer to a miniport driver scatter/gather list buffer.

NetBuffer [in]

A pointer to the NET_BUFFER structure associated with the specified scatter/gather list buffer.

Return value

None

Remarks

Bus-master miniport drivers must call the NdisMFreeNetBufferSGList function to free a scatter/gather list. A miniport driver typically calls NdisMFreeNetBufferSGList from its MiniportInterruptDPC function while it is handling a send complete interrupt or at any time that the driver no longer requires the scatter/gather list. Do not call NdisMFreeNetBufferSGList while the driver or hardware is still accessing the memory that is described by the NET_BUFFER structure that is associated with the scatter/gather list.

Miniport drivers can free the buffer that was specified in the ScatterGatherListBuffer parameter of the NdisMAllocateNetBufferSGList function after NdisMFreeNetBufferSGList returns.

Before accessing received data, miniport drivers must call NdisMFreeNetBufferSGList to flush the memory cache.

Requirements

Version

Supported in NDIS 6.0 and later.

Header

Ndis.h (include Ndis.h)

IRQL

DISPATCH_LEVEL

DDI compliance rules

Irql_Gather_DMA_Function

See also

MiniportInterruptDPC
NET_BUFFER
NdisMAllocateNetBufferSGList
NdisMRegisterScatterGatherDma
Allocating and Freeing Scatter/Gather Lists
Miniport Driver Scatter/Gather DMA
NDIS Scatter/Gather DMA
Registering and Deregistering DMA Channels

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft